review some docs

[platform/upstream/gstreamer.git] / gst / gstformat.h

diff --git a/gst/gstformat.h b/gst/gstformat.h
index 1c1c97a..13dad03 100644 (file)
--- a/gst/gstformat.h
+++ b/gst/gstformat.h
@@ -34,21 +34,28 @@ G_BEGIN_DECLS
 /**
  * GstFormat:
  * @GST_FORMAT_UNDEFINED: undefined format
- * @GST_FORMAT_DEFAULT: the default format of the pad/element
+ * @GST_FORMAT_DEFAULT: the default format of the pad/element. This can be
+ *    samples for raw audio, frames/fields for raw video (some, but not all,
+ *    elements support this; use @GST_FORMAT_TIME if you don't have a good
+ *    reason to query for samples/frames)
  * @GST_FORMAT_BYTES: bytes
  * @GST_FORMAT_TIME: time in nanoseconds
- * @GST_FORMAT_BUFFERS: buffers
- * @GST_FORMAT_PERCENT: percentage of stream
+ * @GST_FORMAT_BUFFERS: buffers (few, if any, elements implement this as of
+ *     May 2009)
+ * @GST_FORMAT_PERCENT: percentage of stream (few, if any, elements implement
+ *     this as of May 2009)
  *
  * Standard predefined formats
  */
+/* NOTE: don't forget to update the table in gstformat.c when changing
+ * this enum */
 typedef enum {
-  GST_FORMAT_UNDEFINED         =  0, /* must be first in list */
-  GST_FORMAT_DEFAULT           =  1, /* samples for raw audio, frames/fields for raw video */
-  GST_FORMAT_BYTES     =  2,
-  GST_FORMAT_TIME      =  3,
-  GST_FORMAT_BUFFERS   =  4,
-  GST_FORMAT_PERCENT   =  5
+  GST_FORMAT_UNDEFINED  =  0, /* must be first in list */
+  GST_FORMAT_DEFAULT    =  1,
+  GST_FORMAT_BYTES      =  2,
+  GST_FORMAT_TIME       =  3,
+  GST_FORMAT_BUFFERS    =  4,
+  GST_FORMAT_PERCENT    =  5
 } GstFormat;
 
 /* a percentage is always relative to 1000000 */
@@ -57,14 +64,14 @@ typedef enum {
  *
  * The PERCENT format is between 0 and this value
  */
-#define        GST_FORMAT_PERCENT_MAX          G_GINT64_CONSTANT (1000000)
+#define GST_FORMAT_PERCENT_MAX          G_GINT64_CONSTANT (1000000)
 /**
  * GST_FORMAT_PERCENT_SCALE:
  *
  * The value used to scale down the reported PERCENT format value to
  * its real value.
  */
-#define        GST_FORMAT_PERCENT_SCALE        G_GINT64_CONSTANT (10000)
+#define GST_FORMAT_PERCENT_SCALE        G_GINT64_CONSTANT (10000)
 
 typedef struct _GstFormatDefinition GstFormatDefinition;
 
@@ -73,30 +80,33 @@ typedef struct _GstFormatDefinition GstFormatDefinition;
  * @value: The unique id of this format
  * @nick: A short nick of the format
  * @description: A longer description of the format
+ * @quark: A quark for the nick
  *
  * A format definition
  */
-struct _GstFormatDefinition 
+struct _GstFormatDefinition
 {
-  GstFormat  value;
-  gchar     *nick;
-  gchar     *description;
+  GstFormat    value;
+  const gchar *nick;
+  const gchar *description;
+  GQuark       quark;
 };
 
-void           _gst_format_initialize          (void);
+const gchar*    gst_format_get_name             (GstFormat format);
+GQuark          gst_format_to_quark             (GstFormat format);
 
 /* register a new format */
-GstFormat      gst_format_register             (const gchar *nick, 
-                                                const gchar *description);
-GstFormat      gst_format_get_by_nick          (const gchar *nick);
+GstFormat       gst_format_register             (const gchar *nick,
+                                                 const gchar *description);
+GstFormat       gst_format_get_by_nick          (const gchar *nick);
 
 /* check if a format is in an array of formats */
-gboolean       gst_formats_contains            (const GstFormat *formats, GstFormat format);
+gboolean        gst_formats_contains            (const GstFormat *formats, GstFormat format);
 
 /* query for format details */
-G_CONST_RETURN GstFormatDefinition*    
-               gst_format_get_details          (GstFormat format);
-GstIterator*   gst_format_iterate_definitions  (void);
+const GstFormatDefinition*
+                gst_format_get_details          (GstFormat format);
+GstIterator*    gst_format_iterate_definitions  (void);
 
 G_END_DECLS