diff options
| -rw-r--r-- | ChangeLog | 10 | ||||
| -rw-r--r-- | docs/plugins/Makefile.am | 3 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-docs.sgml | 4 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-sections.txt | 42 | ||||
| -rw-r--r-- | ext/amrwb/gstamrwbdec.c | 17 | ||||
| -rw-r--r-- | ext/amrwb/gstamrwbenc.c | 20 | ||||
| -rw-r--r-- | ext/amrwb/gstamrwbparse.c | 17 |
7 files changed, 109 insertions, 4 deletions
@@ -3,6 +3,16 @@ * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-bad-plugins-docs.sgml: * docs/plugins/gst-plugins-bad-plugins-sections.txt: + * ext/amrwb/gstamrwbdec.c: + * ext/amrwb/gstamrwbenc.c: + * ext/amrwb/gstamrwbparse.c: + Also document AMR-WB elements. + +2007-07-03 Stefan Kost <ensonic@users.sf.net> + + * docs/plugins/Makefile.am: + * docs/plugins/gst-plugins-bad-plugins-docs.sgml: + * docs/plugins/gst-plugins-bad-plugins-sections.txt: * docs/plugins/gst-plugins-bad-plugins.args: Cleanup the section file so that -unused is empty again (and useful to spot new docs). Add not yet added docs to sgml file. Add more header diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 35c93602..887efc34 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -89,6 +89,9 @@ EXAMPLE_CFILES = \ $(top_srcdir)/ext/directfb/dfb-example.c EXTRA_HFILES = \ + $(top_srcdir)/ext/amrwb/gstamrwbdec.h \ + $(top_srcdir)/ext/amrwb/gstamrwbenc.h \ + $(top_srcdir)/ext/amrwb/gstamrwbparse.h \ $(top_srcdir)/ext/directfb/dfbvideosink.h \ $(top_srcdir)/ext/jack/gstjackaudiosink.h \ $(top_srcdir)/ext/musicbrainz/gsttrm.h \ diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index 6975ba5f..bcc5f43f 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -12,9 +12,9 @@ <chapter> <title>gst-plugins-bad Elements</title> - <!--xi:include href="xml/element-amrwbdec.xml" /> + <xi:include href="xml/element-amrwbdec.xml" /> <xi:include href="xml/element-amrwbenc.xml" /> - <xi:include href="xml/element-amrwbparse.xml" /--> + <xi:include href="xml/element-amrwbparse.xml" /> <xi:include href="xml/element-dfbvideosink.xml" /> <xi:include href="xml/element-equalizer-3bands.xml" /> <xi:include href="xml/element-equalizer-10bands.xml" /> diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 715dc653..68fd5bfd 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -1,4 +1,46 @@ <SECTION> +<FILE>element-amrwbdec</FILE> +<TITLE>amrwbdec</TITLE> +GstAmrwbDec +<SUBSECTION Standard> +GstAmrwbDecClass +GST_AMRWBDEC +GST_AMRWBDEC_CLASS +GST_IS_AMRWBDEC +GST_IS_AMRWBDEC_CLASS +GST_TYPE_AMRWBDEC +gst_amrwbdec_get_type +</SECTION> + +<SECTION> +<FILE>element-amrwbenc</FILE> +<TITLE>amrwbenc</TITLE> +GstAmrwbEnc +<SUBSECTION Standard> +GstAmrwbEncClass +GST_AMRWBENC +GST_AMRWBENC_CLASS +GST_IS_AMRWBENC +GST_IS_AMRWBENC_CLASS +GST_TYPE_AMRWBENC +gst_amrwbenc_get_type +</SECTION> + +<SECTION> +<FILE>element-amrwbparse</FILE> +<TITLE>amrwbparse</TITLE> +GstAmrwbParse +<SUBSECTION Standard> +GstAmrwbParseClass +GST_AMRWBPARSE +GST_AMRWBPARSE_CLASS +GST_IS_AMRWBPARSE +GST_IS_AMRWBPARSE_CLASS +GST_TYPE_AMRWBPARSE +gst_amrwbparse_get_type +</SECTION> + +<SECTION> <FILE>element-dfbvideosink</FILE> <TITLE>dfbvideosink</TITLE> GstDfbVideoSink diff --git a/ext/amrwb/gstamrwbdec.c b/ext/amrwb/gstamrwbdec.c index 57de2c7a..9324fad5 100644 --- a/ext/amrwb/gstamrwbdec.c +++ b/ext/amrwb/gstamrwbdec.c @@ -17,9 +17,22 @@ * Boston, MA 02111-1307, USA. */ -/* - * library can be found at http://www.penguin.cz/~utx/amr +/** + * SECTION:element-amrwbdec + * @see_also: #GstAmrwbEnc, #GstAmrwbParse + * + * <refsect2> + * <para> + * This is an AMR wideband decoder based on the + * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * </programlisting> + * </para> + * </refsect2> */ #ifdef HAVE_CONFIG_H diff --git a/ext/amrwb/gstamrwbenc.c b/ext/amrwb/gstamrwbenc.c index 52f303cd..2e342d30 100644 --- a/ext/amrwb/gstamrwbenc.c +++ b/ext/amrwb/gstamrwbenc.c @@ -17,6 +17,26 @@ * Boston, MA 02111-1307, USA. */ + /** + * SECTION:element-amrwbenc + * @see_also: #GstAmrwbDec, #GstAmrwbParse + * + * <refsect2> + * <para> + * This is an AMR wideband encoder based on the + * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch filesrc location=abc.wav ! wavparse ! audioresample ! audioconvert ! amrwbenc ! filesink location=abc.amr + * </programlisting> + * </para> + * Please not that the above stream misses the header, that is needed to play + * the stream. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/ext/amrwb/gstamrwbparse.c b/ext/amrwb/gstamrwbparse.c index d5afc6df..2054fc25 100644 --- a/ext/amrwb/gstamrwbparse.c +++ b/ext/amrwb/gstamrwbparse.c @@ -17,6 +17,23 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-amrwbparse + * @see_also: #GstAmrwbDec, #GstAmrwbEnc + * + * <refsect2> + * <para> + * This is an AMR wideband parser. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * </programlisting> + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |