mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-11 09:55:36 +00:00
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).
This commit is contained in:
parent
dddd1369b8
commit
d1c828f845
6 changed files with 71 additions and 3 deletions
|
@ -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>
|
||||
|
||||
|
|
|
@ -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;
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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;
|
||||
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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;
|
||||
|
||||
|
|
Loading…
Reference in a new issue