diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c index 3e61c9a1e2..1962c9b9a7 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 d2e66d95ff..dcae0a87ff 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 9eaf45c6eb..19ad09236c 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 2777007a46..0925b08aeb 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 af46f7a78c..ca894ec9df 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 d849da7418..ed7db73ae5 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;