audioparsers: update some documentation
authorMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
Fri, 3 Dec 2010 17:11:56 +0000 (18:11 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Fri, 8 Apr 2011 17:07:13 +0000 (18:07 +0100)
gst/audioparsers/gstaacparse.c
gst/audioparsers/gstac3parse.c
gst/audioparsers/gstamrparse.c

index 005f1bd..4dd2dc7 100644 (file)
  * @short_description: AAC parser
  * @see_also: #GstAmrParse
  *
+ * This is an AAC parser which handles both ADIF and ADTS stream formats.
+ *
+ * As ADIF format is not framed, it is not seekable and stream duration cannot
+ * be determined either. However, ADTS format AAC clips can be seeked, and parser
+ * can also estimate playback position and clip duration.
+ *
  * <refsect2>
- * <para>
- * This is an AAC parser. It can handle both ADIF and ADTS stream formats.
- * The parser inherits from #GstBaseParse and therefore in only needs to
- * implement AAC-specific functionality.
- * </para>
- * <para>
- * As ADIF format is not framed, it is not seekable. From the same reason
- * stream duration cannot be calculated either. Instead, AAC clips that are
- * in ADTS format can be seeked, and parser also is able to calculate their
- * playback position and clip duration.
- * </para>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch filesrc location=abc.aac ! aacparse ! faad ! audioresample ! audioconvert ! alsasink
- * </programlisting>
- * </para>
+ * ]|
  * </refsect2>
  */
 
index 2ce112b..96e9a91 100644 (file)
  * @short_description: AC3 parser
  * @see_also: #GstAmrParse, #GstAACParse
  *
- * <refsect2>
- * <para>
  * This is an AC3 parser.
- * </para>
+ *
+ * <refsect2>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch filesrc location=abc.ac3 ! ac3parse ! a52dec ! audioresample ! audioconvert ! autoaudiosink
- * </programlisting>
- * </para>
+ * ]|
  * </refsect2>
  */
 
index 6fb797e..a182e76 100644 (file)
  * @short_description: AMR parser
  * @see_also: #GstAmrnbDec, #GstAmrnbEnc
  *
- * <refsect2>
- * <para>
  * This is an AMR parser capable of handling both narrow-band and wideband
  * formats.
- * </para>
+ *
+ * <refsect2>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch filesrc location=abc.amr ! amrparse ! amrdec ! audioresample ! audioconvert ! alsasink
- * </programlisting>
- * </para>
+ * ]|
  * </refsect2>
  */