summaryrefslogtreecommitdiffstats
path: root/ext/wavpack/gstwavpackenc.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/wavpack/gstwavpackenc.c')
-rw-r--r--ext/wavpack/gstwavpackenc.c31
1 files changed, 31 insertions, 0 deletions
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