summaryrefslogtreecommitdiffstats
path: root/ext/wavpack
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2006-08-23 08:52:50 +0000
committerTim-Philipp Müller <tim@centricular.net>2006-08-23 08:52:50 +0000
commit7381b4940caefc0335f14478a34f2faf979131df (patch)
tree17b286ef713b6a3507129f5d193c34ff967a00ab /ext/wavpack
parentd3c716b694b065ca6884499cb75f808f21a07f26 (diff)
downloadgst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.tar.gz
gst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.tar.bz2
gst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.zip
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).
Diffstat (limited to 'ext/wavpack')
-rw-r--r--ext/wavpack/gstwavpackdec.c19
-rw-r--r--ext/wavpack/gstwavpackdec.h3
-rw-r--r--ext/wavpack/gstwavpackenc.c31
-rw-r--r--ext/wavpack/gstwavpackenc.h2
-rw-r--r--ext/wavpack/gstwavpackparse.c17
-rw-r--r--ext/wavpack/gstwavpackparse.h2
6 files changed, 71 insertions, 3 deletions
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
+ *
+ * <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 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
+ *
+ * <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 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
+ *
+ * <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 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;