docs/gst/gstreamer-sections.txt: More doc hacking.
[platform/upstream/gstreamer.git] / plugins / elements / gstfakesrc.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstfakesrc.h: 
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_FAKESRC_H__
25 #define __GST_FAKESRC_H__
26
27 #include <gst/gst.h>
28
29 G_BEGIN_DECLS
30
31
32 typedef enum {
33   FAKESRC_FIRST_LAST_LOOP = 1,
34   FAKESRC_LAST_FIRST_LOOP,
35   FAKESRC_PING_PONG,
36   FAKESRC_ORDERED_RANDOM,
37   FAKESRC_RANDOM,
38   FAKESRC_PATTERN_LOOP,
39   FAKESRC_PING_PONG_PATTERN,
40   FAKESRC_GET_ALWAYS_SUCEEDS
41 } GstFakeSrcOutputType;
42
43 typedef enum {
44   FAKESRC_DATA_ALLOCATE = 1,
45   FAKESRC_DATA_SUBBUFFER,
46 } GstFakeSrcDataType;
47
48 typedef enum {
49   FAKESRC_SIZETYPE_NULL = 1,
50   FAKESRC_SIZETYPE_FIXED,
51   FAKESRC_SIZETYPE_RANDOM
52 } GstFakeSrcSizeType;
53
54 typedef enum {
55   FAKESRC_FILLTYPE_NOTHING = 1,
56   FAKESRC_FILLTYPE_NULL,
57   FAKESRC_FILLTYPE_RANDOM,
58   FAKESRC_FILLTYPE_PATTERN,
59   FAKESRC_FILLTYPE_PATTERN_CONT
60 } GstFakeSrcFillType;
61
62 #define GST_TYPE_FAKESRC \
63   (gst_fakesrc_get_type())
64 #define GST_FAKESRC(obj) \
65   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FAKESRC,GstFakeSrc))
66 #define GST_FAKESRC_CLASS(klass) \
67   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FAKESRC,GstFakeSrcClass))
68 #define GST_IS_FAKESRC(obj) \
69   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FAKESRC))
70 #define GST_IS_FAKESRC_CLASS(obj) \
71   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FAKESRC))
72
73 typedef struct _GstFakeSrc GstFakeSrc;
74 typedef struct _GstFakeSrcClass GstFakeSrcClass;
75
76 struct _GstFakeSrc {
77   GstElement     element;
78
79   gboolean       loop_based;
80   gboolean       eos;
81
82   GstFakeSrcOutputType output;
83   GstFakeSrcDataType   data;
84   GstFakeSrcSizeType   sizetype;
85   GstFakeSrcFillType   filltype;
86
87   guint          sizemin;
88   guint          sizemax;
89   GstBuffer     *parent;
90   guint          parentsize;
91   guint          parentoffset;
92   guint8         pattern_byte;
93   gchar         *pattern;
94   GList         *patternlist;
95   gint64         segment_start;
96   gint64         segment_end;
97   gboolean       segment_loop;
98   gint           num_buffers;
99   gint           rt_num_buffers; /* we are going to change this at runtime */
100   guint64        buffer_count;
101   gboolean       silent;
102   gboolean       signal_handoffs;
103   gboolean       dump;
104   gboolean       need_flush;
105
106   gchar         *last_message;
107 };
108
109 struct _GstFakeSrcClass {
110   GstElementClass parent_class;
111
112   /* signals */
113   void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
114 };
115
116 GType gst_fakesrc_get_type(void);
117
118 G_END_DECLS
119
120 #endif /* __GST_FAKESRC_H__ */