Add docs for wavpack elements (#352476).

Original commit message from CVS:
Patch by: Sebastian Dröge <slomo at circular-chaos.org>
* 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).

diff --git a/ChangeLog b/ChangeLog
index af60d66526b7ccc8dc3a6513f42cf2a9dbb79ec9..b3305438282c654d7bca56688e8ea4a53327ac1c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2006-08-23  Tim-Philipp Müller  <tim at centricular dot net>
+
+       Patch by: Sebastian Dröge <slomo at circular-chaos.org>
+
+       * 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 <edgard.lima@indt.org.br>
 
        * sys/v4l2/gstv4l2src.c: (gst_v4l2src_get_size_limits)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 28ce143554c7f92ae7cc943231ad30bf69aab0d3..ec51befa1c59491a10e853e5a3bf9aa242f1682f 100644 (file)
--- 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 d4ae3d01c02425d60446d50c8cf8c638f835b01d..d16b1964ea1bd08bb149b4bcf70e5b3b13d47b02 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -15,6 +15,9 @@
 
     <xi:include href="xml/element-dfbvideosink.xml" />
     <xi:include href="xml/element-trm.xml" />
+    <xi:include href="xml/element-wavpackdec.xml" />
+    <xi:include href="xml/element-wavpackenc.xml" />
+    <xi:include href="xml/element-wavpackparse.xml" />
   </chapter>
 
   <chapter>
@@ -39,6 +42,7 @@
     <xi:include href="xml/plugin-speed.xml" />
     <xi:include href="xml/plugin-tta.xml" />
     <xi:include href="xml/plugin-video4linux2.xml" />
+    <xi:include href="xml/plugin-wavpack.xml" />
     <xi:include href="xml/plugin-xingheader.xml" />
 
   </chapter>

diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index ed069cab67356b6c9582b4c0847d5300d08d27a7..1f7f857883e35e94fef04b193c194f6acfdde3a3 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -13,3 +13,29 @@ GstTRM
 <SUBSECTION Standard>
 GstTRMClass
 </SECTION>
+
+<SECTION>
+<FILE>element-wavpackdec</FILE>
+GstWavpackDec
+<TITLE>wavpackdec</TITLE>
+<SUBSECTION Standard>
+GstWavpackDecClass
+
+</SECTION>
+
+<SECTION>
+<FILE>element-wavpackenc</FILE>
+GstWavpackEnc
+<TITLE>wavpackenc</TITLE>
+<SUBSECTION Standard>
+GstWavpackEncClass
+</SECTION>
+
+<SECTION>
+<FILE>element-wavpackparse</FILE>
+GstWavpackParse
+<TITLE>wavpackparse</TITLE>
+<SUBSECTION Standard>
+GstWavpackParseClass
+</SECTION>
+

diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy
index bf1d5f68b4cdd2a39ad2d48569c2de4e3a8f3030..b08127291b2d228ef967b9c9c4dff549c48d8cbb 100644 (file)
--- 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 60c1d4b914c00bde685209b9bd7c9a4ee609b0d3..645d02f378b4e731b3dabae25cd914a934ecdb98 100644 (file)
--- a/docs/plugins/inspect/plugin-wavpack.xml
+++ b/docs/plugins/inspect/plugin-wavpack.xml
@@ -14,7 +14,7 @@
       <longname>WavePack audio decoder</longname>
       <class>Codec/Decoder/Audio</class>
       <description>Decode Wavpack audio data</description>
-      <author>Arwed v. Merkatz &lt;v.merkatz@gmx.net&gt;</author>
+      <author>Arwed v. Merkatz &lt;v.merkatz@gmx.net&gt;, Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</author>
     </element>
     <element>
       <name>wavpackenc</name>
@@ -28,7 +28,7 @@
       <longname>WavePack parser</longname>
       <class>Codec/Demuxer/Audio</class>
       <description>Parses Wavpack files</description>
-      <author>Arwed v. Merkatz &lt;v.merkatz@gmx.net&gt;</author>
+      <author>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</author>
     </element>
   </elements>
 </plugin>
\ No newline at end of file

diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c
index 3e61c9a1e23d00e889942bb75878b0e0e498c980..1962c9b9a7de9ef1ac5bd8d2e412bea984544820 100644 (file)
--- a/ext/wavpack/gstwavpackdec.c
+++ b/ext/wavpack/gstwavpackdec.c
@@ -21,6 +21,25 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-wavpackdec
+ *
+ * <refsect2>
+ * wavpackdec decodes framed (for example by the wavpackparse element)
+ * Wavpack streams and decodes them to raw audio.
+ * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
+ * audio codec that features both lossless and lossy encoding.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink
+ * </programlisting>
+ * This pipeline decodes the Wavpack file test.wv into raw audio buffers and
+ * tries to play it back using an automatically found audio sink.
+ * </para>
+ * </refsect2>
+ */
+
 #include <gst/gst.h>
 #include <gst/audio/audio.h>
 

diff --git a/ext/wavpack/gstwavpackdec.h b/ext/wavpack/gstwavpackdec.h
index d2e66d95ffd846c934b977eec7562581869ee576..dcae0a87ff328ccc49dd860dfe1e214a8adbf26b 100644 (file)
--- 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 9eaf45c6eb4c475d57f4ce02d5e4a3fff1504bb2..19ad09236c03427cd368af25ee7cb0f26b10c856 100644 (file)
--- a/ext/wavpack/gstwavpackenc.c
+++ b/ext/wavpack/gstwavpackenc.c
@@ -19,6 +19,37 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-wavpackenc
+ *
+ * <refsect2>
+ * Wavpackenc encodes raw audio into a framed Wavpack stream.
+ * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
+ * audio codec that features both lossless and lossy encoding.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch audiotestsrc num-buffers=500 ! wavpackenc ! filesink location=sinewave.wv
+ * </programlisting>
+ * This pipeline encodes audio from audiotestsrc into a Wavpack file.
+ * </para>
+ * <para>
+ * <programlisting>
+ * gst-launch cdda://1 ! wavpackenc ! filesink location=track1.wv
+ * </programlisting>
+ * This pipeline encodes audio from an audio CD into a Wavpack file using
+ * lossless encoding (the file output will be fairly large).
+ * </para>
+ * <para>
+ * <programlisting>
+ * gst-launch cdda://1 ! wavpackenc bitrate=128000 ! filesink location=track1.wv
+ * </programlisting>
+ * 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).
+ * </para>
+ * </refsect2>
+ */
+
 /*
  * TODO: - add multichannel handling. channel_mask is:
  *                  front left

diff --git a/ext/wavpack/gstwavpackenc.h b/ext/wavpack/gstwavpackenc.h
index 2777007a4603db447b7448732af94a1a77000316..0925b08aebd8e3abde5c16e046d32810b48b733d 100644 (file)
--- 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 af46f7a78c25145729a28ec745f8ad8423753c91..ca894ec9df7ea91d66c80ad2eba2ea04e78159aa 100644 (file)
--- a/ext/wavpack/gstwavpackparse.c
+++ b/ext/wavpack/gstwavpackparse.c
@@ -21,6 +21,23 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-wavpackparse
+ *
+ * <refsect2>
+ * Wavpackparse takes raw, unframed Wavpack streams and splits them into
+ * single Wavpack chunks with information like bit depth and the position
+ * in the stream.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! fakesink
+ * </programlisting>
+ * This pipeline decodes the Wavpack file test.wv into raw audio buffers.
+ * </para>
+ * </refsect2>
+ */
+
 #include <gst/gst.h>
 
 #include <math.h>

diff --git a/ext/wavpack/gstwavpackparse.h b/ext/wavpack/gstwavpackparse.h
index d849da7418e35f1977dab9a03f83a7a6480bdf91..ed7db73ae59843815454f77c7f115c409eb8135d 100644 (file)
--- 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;