From 2aa5ce3111f28f30498c223eb2e8996bfe6e61c3 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 3 Jul 2007 09:18:22 +0000 Subject: [PATCH] Also document AMR-WB elements. Original commit message from CVS: * 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. --- ChangeLog | 10 +++++ docs/plugins/Makefile.am | 3 ++ .../plugins/gst-plugins-bad-plugins-docs.sgml | 4 +- .../gst-plugins-bad-plugins-sections.txt | 42 +++++++++++++++++++ ext/amrwb/gstamrwbdec.c | 17 +++++++- ext/amrwb/gstamrwbenc.c | 20 +++++++++ ext/amrwb/gstamrwbparse.c | 17 ++++++++ 7 files changed, 109 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6659288a5e..034615e5a2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2007-07-03 Stefan Kost + + * 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 * docs/plugins/Makefile.am: diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 35c93602bb..887efc3441 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 6975ba5f33..bcc5f43fea 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -12,9 +12,9 @@ gst-plugins-bad Elements - + diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 715dc65335..68fd5bfd31 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -1,3 +1,45 @@ +
+element-amrwbdec +amrwbdec +GstAmrwbDec + +GstAmrwbDecClass +GST_AMRWBDEC +GST_AMRWBDEC_CLASS +GST_IS_AMRWBDEC +GST_IS_AMRWBDEC_CLASS +GST_TYPE_AMRWBDEC +gst_amrwbdec_get_type +
+ +
+element-amrwbenc +amrwbenc +GstAmrwbEnc + +GstAmrwbEncClass +GST_AMRWBENC +GST_AMRWBENC_CLASS +GST_IS_AMRWBENC +GST_IS_AMRWBENC_CLASS +GST_TYPE_AMRWBENC +gst_amrwbenc_get_type +
+ +
+element-amrwbparse +amrwbparse +GstAmrwbParse + +GstAmrwbParseClass +GST_AMRWBPARSE +GST_AMRWBPARSE_CLASS +GST_IS_AMRWBPARSE +GST_IS_AMRWBPARSE_CLASS +GST_TYPE_AMRWBPARSE +gst_amrwbparse_get_type +
+
element-dfbvideosink dfbvideosink diff --git a/ext/amrwb/gstamrwbdec.c b/ext/amrwb/gstamrwbdec.c index 57de2c7a1c..9324fad530 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 + * + * + * + * This is an AMR wideband decoder based on the + * reference codec implementation. + * + * Example launch line + * + * * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * + * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/amrwb/gstamrwbenc.c b/ext/amrwb/gstamrwbenc.c index 52f303cdba..2e342d30f2 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 + * + * + * + * This is an AMR wideband encoder based on the + * reference codec implementation. + * + * Example launch line + * + * + * gst-launch filesrc location=abc.wav ! wavparse ! audioresample ! audioconvert ! amrwbenc ! filesink location=abc.amr + * + * + * Please not that the above stream misses the header, that is needed to play + * the stream. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/ext/amrwb/gstamrwbparse.c b/ext/amrwb/gstamrwbparse.c index d5afc6dfa5..2054fc2556 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 + * + * + * + * This is an AMR wideband parser. + * + * Example launch line + * + * + * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif