gst_plugins_base/gst-libs/gst/audio/audio.h
changeset 8 4a7fac7dd34a
parent 0 0e761a78d257
child 30 7e817e7e631c
--- a/gst_plugins_base/gst-libs/gst/audio/audio.h	Fri Mar 19 09:35:09 2010 +0200
+++ b/gst_plugins_base/gst-libs/gst/audio/audio.h	Fri Apr 16 15:15:52 2010 +0300
@@ -77,6 +77,12 @@
  */
 #define GST_AUDIO_DEF_RATE 44100
 
+/**
+ * GST_AUDIO_INT_PAD_TEMPLATE_CAPS:
+ * 
+ * Template caps for integer audio. Can be used when defining a 
+ * #GstStaticPadTemplate
+ */
 #define GST_AUDIO_INT_PAD_TEMPLATE_CAPS \
   "audio/x-raw-int, " \
   "rate = (int) [ 1, MAX ], " \
@@ -86,7 +92,12 @@
   "depth = (int) [ 1, 32 ], " \
   "signed = (boolean) { true, false }"
 
-/* "standard" int audio is native order, 16 bit stereo. */
+/**
+ * GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS:
+ * 
+ * Template caps for 16bit integer stereo audio in native byte-order.
+ * Can be used when defining a #GstStaticPadTemplate
+ */
 #define GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS \
   "audio/x-raw-int, " \
   "rate = (int) [ 1, MAX ], " \
@@ -96,6 +107,12 @@
   "depth = (int) 16, " \
   "signed = (boolean) true"
 
+/**
+ * GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS:
+ * 
+ * Template caps for float audio. Can be used when defining a 
+ * #GstStaticPadTemplate
+ */
 #define GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS \
   "audio/x-raw-float, " \
   "rate = (int) [ 1, MAX ], " \
@@ -103,7 +120,12 @@
   "endianness = (int) { LITTLE_ENDIAN , BIG_ENDIAN }, " \
   "width = (int) { 32, 64 }"
 
-/* "standard" float audio is native order, 32 bit mono. */
+/**
+ * GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS:
+ * 
+ * Template caps for 32bit float mono audio in native byte-order.
+ * Can be used when defining a #GstStaticPadTemplate
+ */
 #define GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS \
   "audio/x-raw-float, " \
   "width = (int) 32, " \
@@ -158,7 +180,7 @@
   GST_AUDIO_FIELD_ENDIANNESS    = (1 << 2),
   GST_AUDIO_FIELD_WIDTH         = (1 << 3),
   GST_AUDIO_FIELD_DEPTH         = (1 << 4),
-  GST_AUDIO_FIELD_SIGNED        = (1 << 5),
+  GST_AUDIO_FIELD_SIGNED        = (1 << 5)
 } GstAudioFieldFlag;
 #endif