typefind: Use gst_query_has_scheduling_mode_with_flags() convenience function

[platform/upstream/gstreamer.git] / plugins / elements / gstfakesrc.h

diff --git a/plugins/elements/gstfakesrc.h b/plugins/elements/gstfakesrc.h
index 84fb0cc..5190ee8 100644 (file)
--- a/plugins/elements/gstfakesrc.h
+++ b/plugins/elements/gstfakesrc.h
@@ -16,8 +16,8 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 
@@ -29,6 +29,19 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GstFakeSrcOutputType:
+ * @FAKE_SRC_FIRST_LAST_LOOP: first pad then last pad
+ * @FAKE_SRC_LAST_FIRST_LOOP: last pad then first pad
+ * @FAKE_SRC_PING_PONG: ping pong between pads
+ * @FAKE_SRC_ORDERED_RANDOM: ordered random pad
+ * @FAKE_SRC_RANDOM: random pad
+ * @FAKE_SRC_PATTERN_LOOP: loop between pads in a particular pattern
+ * @FAKE_SRC_PING_PONG_PATTERN: ping pong based on a pattern
+ * @FAKE_SRC_GET_ALWAYS_SUCEEDS: a get always succeeds on a pad
+ *
+ * The different output types. Unused currently.
+ */
 typedef enum {
   FAKE_SRC_FIRST_LAST_LOOP = 1,
   FAKE_SRC_LAST_FIRST_LOOP,
@@ -40,20 +53,45 @@ typedef enum {
   FAKE_SRC_GET_ALWAYS_SUCEEDS
 } GstFakeSrcOutputType;
 
+/**
+ * GstFakeSrcDataType:
+ * @FAKE_SRC_DATA_ALLOCATE: allocate buffers
+ * @FAKE_SRC_DATA_SUBBUFFER: subbuffer each buffer
+ *
+ * The different ways buffers are allocated.
+ */
 typedef enum {
   FAKE_SRC_DATA_ALLOCATE = 1,
   FAKE_SRC_DATA_SUBBUFFER
 } GstFakeSrcDataType;
 
+/**
+ * GstFakeSrcSizeType:
+ * @FAKE_SRC_SIZETYPE_EMPTY: create empty buffers
+ * @FAKE_SRC_SIZETYPE_FIXED: fixed buffer size (sizemax sized)
+ * @FAKE_SRC_SIZETYPE_RANDOM: random buffer size (sizemin <= size <= sizemax)
+ *
+ * The different size of the allocated buffers.
+ */
 typedef enum {
-  FAKE_SRC_SIZETYPE_NULL = 1,
+  FAKE_SRC_SIZETYPE_EMPTY = 1,
   FAKE_SRC_SIZETYPE_FIXED,
   FAKE_SRC_SIZETYPE_RANDOM
 } GstFakeSrcSizeType;
 
+/**
+ * GstFakeSrcFillType:
+ * @FAKE_SRC_FILLTYPE_NOTHING: do not fill buffers 
+ * @FAKE_SRC_FILLTYPE_ZERO: fill buffers with 0
+ * @FAKE_SRC_FILLTYPE_RANDOM: fill buffers with random bytes
+ * @FAKE_SRC_FILLTYPE_PATTERN: fill buffers with a pattern
+ * @FAKE_SRC_FILLTYPE_PATTERN_CONT: fill buffers with a continuous pattern
+ *
+ * The different ways of filling the buffers.
+ */
 typedef enum {
   FAKE_SRC_FILLTYPE_NOTHING = 1,
-  FAKE_SRC_FILLTYPE_NULL,
+  FAKE_SRC_FILLTYPE_ZERO,
   FAKE_SRC_FILLTYPE_RANDOM,
   FAKE_SRC_FILLTYPE_PATTERN,
   FAKE_SRC_FILLTYPE_PATTERN_CONT
@@ -67,12 +105,17 @@ typedef enum {
   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FAKE_SRC,GstFakeSrcClass))
 #define GST_IS_FAKE_SRC(obj) \
   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FAKE_SRC))
-#define GST_IS_FAKE_SRC_CLASS(obj) \
+#define GST_IS_FAKE_SRC_CLASS(klass) \
   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FAKE_SRC))
 
 typedef struct _GstFakeSrc GstFakeSrc;
 typedef struct _GstFakeSrcClass GstFakeSrcClass;
 
+/**
+ * GstFakeSrc:
+ *
+ * Opaque #GstFakeSrc data structure.
+ */
 struct _GstFakeSrc {
   GstBaseSrc     element;
 
@@ -91,21 +134,16 @@ struct _GstFakeSrc {
   guint                parentsize;
   guint                parentoffset;
   guint8        pattern_byte;
-  gchar                *pattern;
   GList                *patternlist;
   gint          datarate;
   gboolean      sync;
   GstClock     *clock;
-  gint64        segment_start;
-  gint64        segment_end;
-  gboolean      segment_loop;
-  gint          num_buffers;
-  gint          rt_num_buffers; /* we are going to change this at runtime */
-  guint64       buffer_count;
+
   gboolean      silent;
   gboolean      signal_handoffs;
   gboolean      dump;
   gboolean      can_activate_pull;
+  GstFormat      format;
 
   guint64        bytes_sent;
 
@@ -120,7 +158,7 @@ struct _GstFakeSrcClass {
   void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
 };
 
-GType gst_fake_src_get_type (void);
+G_GNUC_INTERNAL GType gst_fake_src_get_type (void);
 
 G_END_DECLS