projects / platform / upstream / gstreamer.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: e067c55)
docs: add audioparsers to docs
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Thu, 7 Apr 2011 14:20:19 +0000 (15:20 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Fri, 8 Apr 2011 17:07:17 +0000 (18:07 +0100)
docs/plugins/Makefile.am patch | blob | history
docs/plugins/gst-plugins-good-plugins-docs.sgml patch | blob | history
docs/plugins/gst-plugins-good-plugins-sections.txt patch | blob | history
docs/plugins/inspect/plugin-audioparsers.xml [new file with mode: 0644] patch | blob

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 4910349..1ac1ebf 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -132,6 +132,12 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/audiofx/audiowsincband.h \
        $(top_srcdir)/gst/audiofx/audiowsinclimit.h \
        $(top_srcdir)/gst/audiofx/audiofirfilter.h \
+       $(top_srcdir)/gst/audioparsers/gstaacparse.h \
+       $(top_srcdir)/gst/audioparsers/gstac3parse.h \
+       $(top_srcdir)/gst/audioparsers/gstamrparse.h \
+       $(top_srcdir)/gst/audioparsers/gstflacparse.h \
+       $(top_srcdir)/gst/audioparsers/gstdcaparse.h \
+       $(top_srcdir)/gst/audioparsers/gstmpegaudioparse.h \
        $(top_srcdir)/gst/auparse/gstauparse.h \
        $(top_srcdir)/gst/autodetect/gstautoaudiosink.h \
        $(top_srcdir)/gst/autodetect/gstautoaudiosrc.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 988bba3..65da14b 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -18,12 +18,15 @@
 
   <chapter>
     <title>gst-plugins-good Elements</title>
+    <xi:include href="xml/element-aacparse.xml" />
     <xi:include href="xml/element-aasink.xml" />
+    <xi:include href="xml/element-ac3parse.xml" />
     <xi:include href="xml/element-agingtv.xml" />
     <xi:include href="xml/element-alpha.xml" />
     <xi:include href="xml/element-alphacolor.xml" />
     <xi:include href="xml/element-alawdec.xml" />
     <xi:include href="xml/element-alawenc.xml" />
+    <xi:include href="xml/element-amrparse.xml" />
     <xi:include href="xml/element-apedemux.xml" />
     <xi:include href="xml/element-apev2mux.xml" />
     <xi:include href="xml/element-aspectratiocrop.xml" />
@@ -56,6 +59,7 @@
     <xi:include href="xml/element-cmmldec.xml" />
     <xi:include href="xml/element-cmmlenc.xml" />
     <xi:include href="xml/element-cutter.xml" />
+    <xi:include href="xml/element-dcaparse.xml" />
     <xi:include href="xml/element-deinterlace.xml" />
     <xi:include href="xml/element-deinterleave.xml" />
     <xi:include href="xml/element-dicetv.xml" />
@@ -70,6 +74,7 @@
     <xi:include href="xml/element-esdsink.xml" />
     <xi:include href="xml/element-flacdec.xml" />
     <xi:include href="xml/element-flacenc.xml" />
+    <xi:include href="xml/element-flacparse.xml" />
     <xi:include href="xml/element-flactag.xml" />
     <xi:include href="xml/element-flvdemux.xml" />
     <xi:include href="xml/element-flvmux.xml" />
@@ -103,6 +108,7 @@
     <xi:include href="xml/element-matroskamux.xml" />
     <xi:include href="xml/element-matroskademux.xml" />
     <xi:include href="xml/element-monoscope.xml" />
+    <xi:include href="xml/element-mpegaudioparse.xml" />
     <xi:include href="xml/element-mulawdec.xml" />
     <xi:include href="xml/element-mulawenc.xml" />
     <xi:include href="xml/element-multifilesink.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index b2e6de6..107969f 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -1,4 +1,18 @@
 <SECTION>
+<FILE>element-aacparse</FILE>
+<TITLE>aacparse</TITLE>
+GstAacParse
+<SUBSECTION Standard>
+GstAacParseClass
+GST_AAC_PARSE
+GST_AAC_PARSE_CLASS
+GST_IS_AAC_PARSE
+GST_IS_AAC_PARSE_CLASS
+GST_TYPE_AAC_PARSE
+gst_aac_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-aasink</FILE>
 <TITLE>aasink</TITLE>
 GstAASink
@@ -13,6 +27,20 @@ gst_aasink_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-ac3parse</FILE>
+<TITLE>ac3parse</TITLE>
+GstAc3Parse
+<SUBSECTION Standard>
+GstAc3ParseClass
+GST_AC3_PARSE
+GST_AC3_PARSE_CLASS
+GST_IS_AC3_PARSE
+GST_IS_AC3_PARSE_CLASS
+GST_TYPE_AC3_PARSE
+gst_ac3_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-alawdec</FILE>
 <TITLE>alawdec</TITLE>
 GstALawDec
@@ -69,6 +97,20 @@ GST_IS_ALPHA_COLOR_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>element-amrparse</FILE>
+<TITLE>amrparse</TITLE>
+GstAmrParse
+<SUBSECTION Standard>
+GstAmrParseClass
+GST_AMR_PARSE
+GST_AMR_PARSE_CLASS
+GST_IS_AMR_PARSE
+GST_IS_AMR_PARSE_CLASS
+GST_TYPE_AMR_PARSE
+gst_amr_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-apedemux</FILE>
 <TITLE>apedemux</TITLE>
 GstApeDemux
@@ -538,6 +580,21 @@ gst_cutter_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-dcaparse</FILE>
+<TITLE>dcaparse</TITLE>
+GstDcaParse
+<SUBSECTION Standard>
+GstDcaParseClass
+GST_DCA_PARSE
+GST_DCA_PARSE_CLASS
+GST_IS_DCA_PARSE
+GST_IS_DCA_PARSE_CLASS
+GST_TYPE_DCA_PARSE
+gst_dca_parse_get_type
+</SECTION>
+
+
+<SECTION>
 <FILE>element-deinterlace</FILE>
 <TITLE>deinterlace</TITLE>
 GstDeinterlace
@@ -777,6 +834,20 @@ gst_flac_enc_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-flacparse</FILE>
+<TITLE>flacparse</TITLE>
+GstFlacParse
+<SUBSECTION Standard>
+GstFlacParseClass
+GST_FLAC_PARSE
+GST_FLAC_PARSE_CLASS
+GST_IS_FLAC_PARSE
+GST_IS_FLAC_PARSE_CLASS
+GST_TYPE_FLAC_PARSE
+gst_flac_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-flactag</FILE>
 <TITLE>flactag</TITLE>
 GstFlacTag
@@ -1244,6 +1315,20 @@ gst_monoscope_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-mpegaudioparse</FILE>
+<TITLE>mpegaudioparse</TITLE>
+GstMpegAudioParse
+<SUBSECTION Standard>
+GstMpegAudioParseClass
+GST_MPEG_AUDIO_PARSE
+GST_MPEG_AUDIO_PARSE_CLASS
+GST_IS_MPEG_AUDIO_PARSE
+GST_IS_MPEG_AUDIO_PARSE_CLASS
+GST_TYPE_MPEG_AUDIO_PARSE
+gst_mpeg_audio_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-mulawdec</FILE>
 <TITLE>mulawdec</TITLE>
 GstMuLawDec
diff --git a/docs/plugins/inspect/plugin-audioparsers.xml b/docs/plugins/inspect/plugin-audioparsers.xml
new file mode 100644 (file)
index 0000000..a2d9033
--- /dev/null
+++ b/docs/plugins/inspect/plugin-audioparsers.xml
@@ -0,0 +1,139 @@
+<plugin>
+  <name>audioparsers</name>
+  <description>Parsers for various audio formats</description>
+  <filename>../../gst/audioparsers/.libs/libgstaudioparsers.so</filename>
+  <basename>libgstaudioparsers.so</basename>
+  <version>0.10.28.1</version>
+  <license>LGPL</license>
+  <source>gst-plugins-good</source>
+  <package>GStreamer Good Plug-ins git</package>
+  <origin>Unknown package origin</origin>
+  <elements>
+    <element>
+      <name>aacparse</name>
+      <longname>AAC audio stream parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>Advanced Audio Coding parser</description>
+      <author>Stefan Kost &lt;stefan.kost@nokia.com&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/mpeg, framed=(boolean)false, mpegversion=(int){ 2, 4 }</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/mpeg, framed=(boolean)true, mpegversion=(int){ 2, 4 }, stream-format=(string){ raw, adts, adif }</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>ac3parse</name>
+      <longname>AC3 audio stream parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>AC3 parser</description>
+      <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/x-ac3, framed=(boolean)false; audio/x-eac3, framed=(boolean)false; audio/ac3, framed=(boolean)false</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/x-ac3, framed=(boolean)true, channels=(int)[ 1, 6 ], rate=(int)[ 32000, 48000 ]; audio/x-eac3, framed=(boolean)true, channels=(int)[ 1, 6 ], rate=(int)[ 32000, 48000 ]</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>amrparse</name>
+      <longname>AMR audio stream parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>Adaptive Multi-Rate audio parser</description>
+      <author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/x-amr-nb-sh; audio/x-amr-wb-sh</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/AMR, rate=(int)8000, channels=(int)1; audio/AMR-WB, rate=(int)16000, channels=(int)1</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>dcaparse</name>
+      <longname>DTS Coherent Acoustics audio stream parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>DCA parser</description>
+      <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/x-dts, framed=(boolean)false</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/x-dts, framed=(boolean)true, channels=(int)[ 1, 8 ], rate=(int)[ 8000, 192000 ], depth=(int){ 14, 16 }, endianness=(int){ 1234, 4321 }</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>flacparse</name>
+      <longname>FLAC audio parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>Parses audio with the FLAC lossless audio codec</description>
+      <author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/x-flac, framed=(boolean)false</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/x-flac, framed=(boolean)true, channels=(int)[ 1, 8 ], rate=(int)[ 1, 655350 ]</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>mpegaudioparse</name>
+      <longname>MPEG1 Audio Parser</longname>
+      <class>Codec/Parser/Audio</class>
+      <description>Parses and frames mpeg1 audio streams (levels 1-3), provides seek</description>
+      <author>Jan Schmidt &lt;thaytan@mad.scientist.com&gt;,Mark Nauwelaerts &lt;mark.nauwelaerts@collabora.co.uk&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/mpeg, mpegversion=(int)1, parsed=(boolean)false</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/mpeg, mpegversion=(int)1, layer=(int)[ 1, 3 ], rate=(int)[ 8000, 48000 ], channels=(int)[ 1, 2 ], parsed=(boolean)true</details>
+        </caps>
+      </pads>
+    </element>
+  </elements>
+</plugin>
\ No newline at end of file
Domain: Multimedia / Media Common;