mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-27 09:38:17 +00:00
Code Issues 1 Projects Releases Wiki Activity

Add docs for wavpack elements (#352476).

Browse source 
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:
Sebastian Dröge 2006-08-23 08:52:50 +00:00 committed by Tim-Philipp Müller
parent d3c716b694
commit 7381b4940c
12 changed files with 127 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
ChangeLog
View file

@ -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)

5
docs/plugins/Makefile.am
View file

@ -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 =

4
docs/plugins/gst-plugins-bad-plugins-docs.sgml
View file

@ -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>

26
docs/plugins/gst-plugins-bad-plugins-sections.txt
View file

@ -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>

3
docs/plugins/gst-plugins-bad-plugins.hierarchy
View file

@ -13,6 +13,9 @@ GObject
GstVideoSink
GstDfbVideoSink
GstTRM
GstWavpackDec
GstWavpackEnc
GstWavpackParse
GstPlugin
GstRegistry
GstPadTemplate

4
docs/plugins/inspect/plugin-wavpack.xml
View file

@ -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>

19
ext/wavpack/gstwavpackdec.c
View file

@ -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>

3
ext/wavpack/gstwavpackdec.h
View file

@ -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;

31
ext/wavpack/gstwavpackenc.c
View file

@ -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

2
ext/wavpack/gstwavpackenc.h
View file

@ -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;

17
ext/wavpack/gstwavpackparse.c
View file

@ -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>

2
ext/wavpack/gstwavpackparse.h
View file

@ -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;