From 7381b4940caefc0335f14478a34f2faf979131df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Wed, 23 Aug 2006 08:52:50 +0000 Subject: Add docs for wavpack elements (#352476). MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Original commit message from CVS: Patch by: Sebastian Dröge * 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.hierarchy: * docs/plugins/inspect/plugin-wavpack.xml: * ext/wavpack/gstwavpackdec.c: * ext/wavpack/gstwavpackdec.h: * ext/wavpack/gstwavpackenc.c: * ext/wavpack/gstwavpackenc.h: * ext/wavpack/gstwavpackparse.c: * ext/wavpack/gstwavpackparse.h: Add docs for wavpack elements (#352476). --- ChangeLog | 17 +++++++++++++ docs/plugins/Makefile.am | 5 +++- docs/plugins/gst-plugins-bad-plugins-docs.sgml | 4 +++ docs/plugins/gst-plugins-bad-plugins-sections.txt | 26 +++++++++++++++++++ docs/plugins/gst-plugins-bad-plugins.hierarchy | 3 +++ docs/plugins/inspect/plugin-wavpack.xml | 4 +-- ext/wavpack/gstwavpackdec.c | 19 ++++++++++++++ ext/wavpack/gstwavpackdec.h | 3 ++- ext/wavpack/gstwavpackenc.c | 31 +++++++++++++++++++++++ ext/wavpack/gstwavpackenc.h | 2 +- ext/wavpack/gstwavpackparse.c | 17 +++++++++++++ ext/wavpack/gstwavpackparse.h | 2 +- 12 files changed, 127 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index af60d665..b3305438 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,20 @@ +2006-08-23 Tim-Philipp Müller + + Patch by: Sebastian Dröge + + * 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.hierarchy: + * docs/plugins/inspect/plugin-wavpack.xml: + * ext/wavpack/gstwavpackdec.c: + * ext/wavpack/gstwavpackdec.h: + * ext/wavpack/gstwavpackenc.c: + * ext/wavpack/gstwavpackenc.h: + * ext/wavpack/gstwavpackparse.c: + * ext/wavpack/gstwavpackparse.h: + Add docs for wavpack elements (#352476). + 2006-08-22 Edgard Lima * sys/v4l2/gstv4l2src.c: (gst_v4l2src_get_size_limits) diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 28ce1435..ec51befa 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -87,7 +87,10 @@ EXAMPLE_CFILES = \ EXTRA_HFILES = \ $(top_srcdir)/ext/directfb/dfbvideosink.h \ - $(top_srcdir)/ext/musicbrainz/gsttrm.h + $(top_srcdir)/ext/musicbrainz/gsttrm.h \ + $(top_srcdir)/ext/wavpack/gstwavpackdec.h \ + $(top_srcdir)/ext/wavpack/gstwavpackenc.h \ + $(top_srcdir)/ext/wavpack/gstwavpackparse.h # Images to copy into HTML directory. HTML_IMAGES = diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index d4ae3d01..d16b1964 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -15,6 +15,9 @@ + + + @@ -39,6 +42,7 @@ + diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index ed069cab..1f7f8578 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -13,3 +13,29 @@ GstTRM GstTRMClass + +
+element-wavpackdec +GstWavpackDec +wavpackdec + +GstWavpackDecClass + +
+ +
+element-wavpackenc +GstWavpackEnc +wavpackenc + +GstWavpackEncClass +
+ +
+element-wavpackparse +GstWavpackParse +wavpackparse + +GstWavpackParseClass +
+ diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy index bf1d5f68..b0812729 100644 --- a/docs/plugins/gst-plugins-bad-plugins.hierarchy +++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy @@ -13,6 +13,9 @@ GObject GstVideoSink GstDfbVideoSink GstTRM + GstWavpackDec + GstWavpackEnc + GstWavpackParse GstPlugin GstRegistry GstPadTemplate diff --git a/docs/plugins/inspect/plugin-wavpack.xml b/docs/plugins/inspect/plugin-wavpack.xml index 60c1d4b9..645d02f3 100644 --- a/docs/plugins/inspect/plugin-wavpack.xml +++ b/docs/plugins/inspect/plugin-wavpack.xml @@ -14,7 +14,7 @@ WavePack audio decoder Codec/Decoder/Audio Decode Wavpack audio data - Arwed v. Merkatz <v.merkatz@gmx.net> + Arwed v. Merkatz <v.merkatz@gmx.net>, Sebastian Dröge <slomo@circular-chaos.org> wavpackenc @@ -28,7 +28,7 @@ WavePack parser Codec/Demuxer/Audio Parses Wavpack files - Arwed v. Merkatz <v.merkatz@gmx.net> + Sebastian Dröge <slomo@circular-chaos.org> \ No newline at end of file diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c index 3e61c9a1..1962c9b9 100644 --- a/ext/wavpack/gstwavpackdec.c +++ b/ext/wavpack/gstwavpackdec.c @@ -21,6 +21,25 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-wavpackdec + * + * + * wavpackdec decodes framed (for example by the wavpackparse element) + * Wavpack streams and decodes them to raw audio. + * Wavpack is an open-source + * audio codec that features both lossless and lossy encoding. + * Example launch line + * + * + * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink + * + * This pipeline decodes the Wavpack file test.wv into raw audio buffers and + * tries to play it back using an automatically found audio sink. + * + * + */ + #include #include diff --git a/ext/wavpack/gstwavpackdec.h b/ext/wavpack/gstwavpackdec.h index d2e66d95..dcae0a87 100644 --- a/ext/wavpack/gstwavpackdec.h +++ b/ext/wavpack/gstwavpackdec.h @@ -30,7 +30,7 @@ #include "gstwavpackstreamreader.h" G_BEGIN_DECLS -/* #define's don't like whitespacey bits */ + #define GST_TYPE_WAVPACK_DEC \ (gst_wavpack_dec_get_type()) #define GST_WAVPACK_DEC(obj) \ @@ -48,6 +48,7 @@ struct _GstWavpackDec { GstElement element; + /*< private >*/ GstPad *sinkpad; GstPad *srcpad; diff --git a/ext/wavpack/gstwavpackenc.c b/ext/wavpack/gstwavpackenc.c index 9eaf45c6..19ad0923 100644 --- a/ext/wavpack/gstwavpackenc.c +++ b/ext/wavpack/gstwavpackenc.c @@ -19,6 +19,37 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-wavpackenc + * + * + * Wavpackenc encodes raw audio into a framed Wavpack stream. + * Wavpack is an open-source + * audio codec that features both lossless and lossy encoding. + * Example launch line + * + * + * gst-launch audiotestsrc num-buffers=500 ! wavpackenc ! filesink location=sinewave.wv + * + * This pipeline encodes audio from audiotestsrc into a Wavpack file. + * + * + * + * gst-launch cdda://1 ! wavpackenc ! filesink location=track1.wv + * + * This pipeline encodes audio from an audio CD into a Wavpack file using + * lossless encoding (the file output will be fairly large). + * + * + * + * gst-launch cdda://1 ! wavpackenc bitrate=128000 ! filesink location=track1.wv + * + * This pipeline encodes audio from an audio CD into a Wavpack file using + * lossy encoding at a certain bitrate (the file will be fairly small). + * + * + */ + /* * TODO: - add multichannel handling. channel_mask is: * front left diff --git a/ext/wavpack/gstwavpackenc.h b/ext/wavpack/gstwavpackenc.h index 2777007a..0925b08a 100644 --- a/ext/wavpack/gstwavpackenc.h +++ b/ext/wavpack/gstwavpackenc.h @@ -29,7 +29,6 @@ G_BEGIN_DECLS -/* defines don't like whitespacey bits */ #define GST_TYPE_WAVPACK_ENC \ (gst_wavpack_enc_get_type()) #define GST_WAVPACK_ENC(obj) \ @@ -55,6 +54,7 @@ struct _GstWavpackEnc { GstElement element; + /*< private >*/ GstPad *sinkpad, *srcpad; GstPad *wvcsrcpad; diff --git a/ext/wavpack/gstwavpackparse.c b/ext/wavpack/gstwavpackparse.c index af46f7a7..ca894ec9 100644 --- a/ext/wavpack/gstwavpackparse.c +++ b/ext/wavpack/gstwavpackparse.c @@ -21,6 +21,23 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-wavpackparse + * + * + * Wavpackparse takes raw, unframed Wavpack streams and splits them into + * single Wavpack chunks with information like bit depth and the position + * in the stream. + * Example launch line + * + * + * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! fakesink + * + * This pipeline decodes the Wavpack file test.wv into raw audio buffers. + * + * + */ + #include #include diff --git a/ext/wavpack/gstwavpackparse.h b/ext/wavpack/gstwavpackparse.h index d849da74..ed7db73a 100644 --- a/ext/wavpack/gstwavpackparse.h +++ b/ext/wavpack/gstwavpackparse.h @@ -27,7 +27,6 @@ G_BEGIN_DECLS -/* #define's don't like whitespacey bits */ #define GST_TYPE_WAVPACK_PARSE \ (gst_wavpack_parse_get_type()) #define GST_WAVPACK_PARSE(obj) \ @@ -53,6 +52,7 @@ struct _GstWavpackParse { GstElement element; + /*< private >*/ GstPad *sinkpad; GstPad *srcpad; -- cgit v1.2.1