Commit 9cf73bdd authored by Stefan Kost's avatar Stefan Kost
Browse files

Update and add documentation for plugins with deps (ext).

Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
parent 1f323694
......@@ -78,6 +78,7 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/aalib/gstaasink.h \
$(top_srcdir)/ext/annodex/gstcmmldec.h \
$(top_srcdir)/ext/annodex/gstcmmlenc.h \
$(top_srcdir)/ext/cairo/gsttextoverlay.h \
$(top_srcdir)/ext/cairo/gsttimeoverlay.h \
$(top_srcdir)/ext/dv/gstdvdec.h \
$(top_srcdir)/ext/dv/gstdvdemux.h \
......@@ -85,6 +86,10 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/flac/gstflacdec.h \
$(top_srcdir)/ext/flac/gstflacenc.h \
$(top_srcdir)/ext/flac/gstflactag.h \
$(top_srcdir)/ext/gconf/gstgconfaudiosrc.h \
$(top_srcdir)/ext/gconf/gstgconfaudiosink.h \
$(top_srcdir)/ext/gconf/gstgconfvideosrc.h \
$(top_srcdir)/ext/gconf/gstgconfvideosink.h \
$(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \
$(top_srcdir)/ext/hal/gsthalaudiosink.h \
$(top_srcdir)/ext/hal/gsthalaudiosrc.h \
......@@ -103,6 +108,8 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/pulse/pulsesink.h \
$(top_srcdir)/ext/pulse/pulsesrc.h \
$(top_srcdir)/ext/pulse/pulsemixer.h \
$(top_srcdir)/ext/speex/gstspeexenc.h \
$(top_srcdir)/ext/speex/gstspeexdec.h \
$(top_srcdir)/ext/wavpack/gstwavpackdec.h \
$(top_srcdir)/ext/wavpack/gstwavpackenc.h \
$(top_srcdir)/ext/wavpack/gstwavpackparse.h \
......
......@@ -40,6 +40,7 @@
<xi:include href="xml/element-avimux.xml" />
<xi:include href="xml/element-avisubtitle.xml" />
<xi:include href="xml/element-cacasink.xml" />
<xi:include href="xml/element-cairotextoverlay.xml" />
<xi:include href="xml/element-cairotimeoverlay.xml" />
<xi:include href="xml/element-cmmldec.xml" />
<xi:include href="xml/element-cmmlenc.xml" />
......@@ -48,7 +49,6 @@
<xi:include href="xml/element-directdrawsink.xml" />
<xi:include href="xml/element-directsoundsink.xml" />
<xi:include href="xml/element-dv1394src.xml" />
<xi:include href="xml/element-hdv1394src.xml" />
<xi:include href="xml/element-dvdec.xml" />
<xi:include href="xml/element-dvdemux.xml" />
<xi:include href="xml/element-equalizer-10bands.xml" />
......@@ -59,11 +59,16 @@
<xi:include href="xml/element-flacenc.xml" />
<xi:include href="xml/element-flactag.xml" />
<xi:include href="xml/element-gamma.xml" />
<xi:include href="xml/element-gconfaudiosrc.xml" />
<xi:include href="xml/element-gconfaudiosink.xml" />
<xi:include href="xml/element-gconfvideosrc.xml" />
<xi:include href="xml/element-gconfvideosink.xml" />
<xi:include href="xml/element-gdkpixbufsink.xml" />
<xi:include href="xml/element-goom.xml" />
<xi:include href="xml/element-goom2k1.xml" />
<xi:include href="xml/element-halaudiosink.xml" />
<xi:include href="xml/element-halaudiosrc.xml" />
<xi:include href="xml/element-hdv1394src.xml" />
<xi:include href="xml/element-icydemux.xml" />
<xi:include href="xml/element-id3demux.xml" />
<xi:include href="xml/element-id3v2mux.xml" />
......@@ -106,6 +111,8 @@
<xi:include href="xml/element-smptealpha.xml" />
<xi:include href="xml/element-souphttpsrc.xml" />
<xi:include href="xml/element-spectrum.xml" />
<xi:include href="xml/element-speexenc.xml" />
<xi:include href="xml/element-speexdec.xml" />
<xi:include href="xml/element-taginject.xml" />
<xi:include href="xml/element-udpsrc.xml" />
<xi:include href="xml/element-udpsink.xml" />
......
......@@ -103,7 +103,6 @@ gst_audio_amplify_get_type
GstAudioChebBand
<SUBSECTION Standard>
GstAudioChebBandClass
GstAudioChebBandProcessFunc
GST_AUDIO_CHEB_BAND
GST_AUDIO_CHEB_BAND_CLASS
GST_AUDIO_CHEB_BAND_GET_CLASS
......@@ -119,7 +118,6 @@ gst_audio_cheb_band_get_type
GstAudioChebLimit
<SUBSECTION Standard>
GstAudioChebLimitClass
GstAudioChebLimitProcessFunc
GST_AUDIO_CHEB_LIMIT
GST_AUDIO_CHEB_LIMIT_CLASS
GST_AUDIO_CHEB_LIMIT_GET_CLASS
......@@ -243,7 +241,6 @@ gst_audio_panorama_get_type
GstAudioWSincBand
<SUBSECTION Standard>
GstAudioWSincBandClass
GstAudioWSincBandProcessFunc
GST_AUDIO_WSINC_BAND
GST_AUDIO_WSINC_BAND_CLASS
GST_IS_AUDIO_WSINC_BAND
......@@ -258,7 +255,6 @@ gst_audio_wsincband_get_type
GstAudioWSincLimit
<SUBSECTION Standard>
GstAudioWSincLimitClass
GstAudioWSincLimitProcessFunc
GST_AUDIO_WSINC_LIMIT
GST_AUDIO_WSINC_LIMIT_CLASS
GST_IS_AUDIO_WSINC_LIMIT
......@@ -396,6 +392,20 @@ GST_IS_CACASINK_CLASS
gst_cacasink_get_type
</SECTION>
<SECTION>
<FILE>element-cairotextoverlay</FILE>
<TITLE>cairotextoverlay</TITLE>
GstCairoTextOverlay
<SUBSECTION Standard>
GstCairoTextOverlayClass
GST_TYPE_CAIRO_TEXT_OVERLAY
GST_CAIRO_TEXT_OVERLAY
GST_CAIRO_TEXT_OVERLAY_CLASS
GST_IS_CAIRO_TEXT_OVERLAY
GST_IS_CAIRO_TEXT_OVERLAY_CLASS
gst_text_overlay_get_type
</SECTION>
<SECTION>
<FILE>element-cairotimeoverlay</FILE>
<TITLE>cairotimeoverlay</TITLE>
......@@ -447,7 +457,6 @@ GstCutter
<SUBSECTION Standard>
GST_CUTTER
GST_CUTTER_CLASS
GST_CUTTER_GET_CLASS
GST_IS_CUTTER
GST_IS_CUTTER_CLASS
GST_TYPE_CUTTER
......@@ -697,6 +706,62 @@ GST_IS_GAMMA_CLASS
gst_gamma_get_type
</SECTION>
<SECTION>
<FILE>element-gconfaudiosrc</FILE>
<TITLE>gconfaudiosrc</TITLE>
GstGConfAudioSrc
<SUBSECTION Standard>
GstGConfAudioSrcClass
GST_GCONF_AUDIO_SRC
GST_IS_GCONF_AUDIO_SRC
GST_TYPE_GCONF_AUDIO_SRC
GST_GCONF_AUDIO_SRC_CLASS
GST_IS_GCONF_AUDIO_SRC_CLASS
gst_gconf_audio_src_get_type
</SECTION>
<SECTION>
<FILE>element-gconfaudiosink</FILE>
<TITLE>gconfaudiosink</TITLE>
GstGConfAudioSink
<SUBSECTION Standard>
GstGConfAudioSinkClass
GST_GCONF_AUDIO_SINK
GST_IS_GCONF_AUDIO_SINK
GST_TYPE_GCONF_AUDIO_SINK
GST_GCONF_AUDIO_SINK_CLASS
GST_IS_GCONF_AUDIO_SINK_CLASS
gst_gconf_audio_sink_get_type
</SECTION>
<SECTION>
<FILE>element-gconfvideosrc</FILE>
<TITLE>gconfvideosrc</TITLE>
GstGConfVideoSrc
<SUBSECTION Standard>
GstGConfVideoSrcClass
GST_GCONF_VIDEO_SRC
GST_IS_GCONF_VIDEO_SRC
GST_TYPE_GCONF_VIDEO_SRC
GST_GCONF_VIDEO_SRC_CLASS
GST_IS_GCONF_VIDEO_SRC_CLASS
gst_gconf_video_src_get_type
</SECTION>
<SECTION>
<FILE>element-gconfvideosink</FILE>
<TITLE>gconfvideosink</TITLE>
GstGConfVideoSink
<SUBSECTION Standard>
GstGConfVideoSinkClass
GST_GCONF_VIDEO_SINK
GST_IS_GCONF_VIDEO_SINK
GST_TYPE_GCONF_VIDEO_SINK
GST_GCONF_VIDEO_SINK_CLASS
GST_IS_GCONF_VIDEO_SINK_CLASS
gst_gconf_video_sink_get_type
</SECTION>
<SECTION>
<FILE>element-gdkpixbufsink</FILE>
<TITLE>gdkpixbufsink</TITLE>
......@@ -881,7 +946,6 @@ GST_MATROSKA_MUX
GST_MATROSKA_MUX_CLASS
GST_IS_MATROSKA_MUX
GST_IS_MATROSKA_MUX_CLASS
gst_matroska_mux_get_type
gst_matroska_mux_plugin_init
</SECTION>
......@@ -897,7 +961,6 @@ GST_MATROSKA_DEMUX
GST_MATROSKA_DEMUX_CLASS
GST_IS_MATROSKA_DEMUX
GST_IS_MATROSKA_DEMUX_CLASS
gst_matroska_demux_get_type
gst_matroska_demux_plugin_init
</SECTION>
......@@ -1271,7 +1334,7 @@ GST_IS_RTP_JPEG_PAY
GST_TYPE_RTP_JPEG_PAY
GST_RTP_JPEG_PAY_CLASS
GST_IS_RTP_JPEG_PAY_CLASS
gst_rtp_jpeg_pay_get_type
gst_rtp_jpeg_pay_plugin_init
</SECTION>
<SECTION>
......@@ -1375,8 +1438,6 @@ GST_IS_SMOKEENC_CLASS
GstSpectrum
<SUBSECTION Standard>
GstSpectrumClass
GstSpectrumFFTFreeFunc
GstSpectrumProcessFunc
GST_SPECTRUM
GST_SPECTRUM_CLASS
GST_IS_SPECTRUM
......@@ -1385,6 +1446,34 @@ GST_TYPE_SPECTRUM
gst_spectrum_get_type
</SECTION>
<SECTION>
<FILE>element-speexdec</FILE>
<TITLE>speexdec</TITLE>
GstSpeexDec
<SUBSECTION Standard>
GstSpeexDecClass
GST_TYPE_SPEEX_DEC
GST_SPEEX_DEC
GST_SPEEX_DEC_CLASS
GST_IS_SPEEX_DEC
GST_IS_SPEEX_DEC_CLASS
gst_speex_dec_get_type
</SECTION>
<SECTION>
<FILE>element-speexenc</FILE>
<TITLE>speexenc</TITLE>
GstSpeexEnc
<SUBSECTION Standard>
GstSpeexEncClass
GST_TYPE_SPEEX_ENC
GST_SPEEX_ENC
GST_SPEEX_ENC_CLASS
GST_IS_SPEEX_ENC
GST_IS_SPEEX_ENC_CLASS
gst_speex_enc_get_type
</SECTION>
<SECTION>
<FILE>element-taginject</FILE>
<TITLE>taginject</TITLE>
......@@ -1446,12 +1535,6 @@ gst_udpsink_get_type
<TITLE>videobox</TITLE>
GstVideoBox
<SUBSECTION Standard>
GstVideoBoxClass
GST_IS_VIDEO_BOX
GST_IS_VIDEO_BOX_CLASS
GST_VIDEO_BOX
GST_VIDEO_BOX_CLASS
GST_TYPE_VIDEO_BOX
</SECTION>
<SECTION>
......@@ -1474,9 +1557,7 @@ GST_TYPE_VIDEO_CROP
<TITLE>aspectratiocrop</TITLE>
GstAspectRatioCrop
<SUBSECTION Standard>
GstAspectRatioCropClass
AspectRatioCropPixelFormat
GstAspectRatioCropImageDetails
GstAspectRatioCropClass
GST_IS_ASPECT_RATIO_CROP
GST_IS_ASPECT_RATIO_CROP_CLASS
GST_ASPECT_RATIO_CROP
......@@ -1552,7 +1633,6 @@ GST_V4L2_MIN_BUFFERS
GST_V4L2_MAX_SIZE
GstV4l2BufferPool
GstV4l2Buffer
GstV4l2Src
GstV4l2SrcClass
GST_V4L2SRC
GST_IS_V4L2SRC
......@@ -1594,7 +1674,6 @@ GST_IS_WAVENC
GST_TYPE_WAVENC
GST_WAVENC_CLASS
GST_IS_WAVENC_CLASS
gst_wavenc_get_type
</SECTION>
<SECTION>
......
......@@ -20,23 +20,16 @@
* SECTION:element-aasink
* @see_also: #GstCACASink
*
* <refsect2>
* <para>
* Displays video as b/w ascii art.
* </para>
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* |[
* gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink
* </programlisting>
* This pipeline renders a video to ascii art into a separate window.
* </para>
* <para>
* <programlisting>
* ]| This pipeline renders a video to ascii art into a separate window.
* |[
* gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink driver=curses
* </programlisting>
* This pipeline renders a video to ascii art into the current terminal.
* </para>
* ]| This pipeline renders a video to ascii art into the current terminal.
* </refsect2>
*/
......
......@@ -25,17 +25,16 @@
* SECTION:element-cmmldec
* @see_also: cmmlenc, oggdemux
*
* <refsect2>
* <para>
* Cmmldec extracts a CMML document from a CMML bitstream.<ulink
* url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is
* an XML markup language for time-continuous data maintained by the <ulink
* url="http:/www.annodex.org/">Annodex Foundation</ulink>.
* </para>
*
* <refsect2>
* <title>Example pipeline</title>
* <programlisting>
* |[
* gst-launch -v filesrc location=annotated.ogg ! oggdemux ! cmmldec ! filesink location=annotations.cmml
* </programlisting>
* ]|
* </refsect2>
*/
......
......@@ -25,16 +25,16 @@
* SECTION:element-cmmlenc
* @see_also: cmmldec, oggmux
*
* <refsect2>
* <para> Cmmlenc encodes a CMML document into a CMML stream. <ulink
* Cmmlenc encodes a CMML document into a CMML stream. <ulink
* url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is
* an XML markup language for time-continuous data maintained by the <ulink
* url="http:/www.annodex.org/">Annodex Foundation</ulink>.
* </para>
*
* <refsect2>
* <title>Example pipeline</title>
* <programlisting>
* |[
* gst-launch -v filesrc location=annotations.cmml ! cmmlenc ! oggmux name=mux ! filesink location=annotated.ogg
* </programlisting>
* ]|
* </refsect2>
*/
......
......@@ -17,6 +17,18 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-cairotextoverlay
*
* cairotextoverlay renders the text on top of the video frames.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch videotestsrc ! cairotextoverlay text="hello" ! autovideosink
* ]|
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
......
......@@ -21,17 +21,14 @@
/**
* SECTION:element-cairotimeoverlay
*
* <refsect2>
* <para>
* cairotimeoverlay renders the buffer timestamp for each frame on top of
* the frame.
* </para>
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v -m videotestsrc ! cairotimeoverlay ! autovideosink
* </programlisting>
* </para>
* |[
* gst-launch videotestsrc ! cairotimeoverlay ! autovideosink
* ]|
* </refsect2>
*/
......
......@@ -21,25 +21,21 @@
/**
* SECTION:element-dvdec
*
* <refsect2>
* <para>
* dvdec decodes DV video into raw video. The element expects a full DV frame
* as input, which is 120000 bytes for NTSC and 144000 for PAL video.
* </para>
* <para>
* This element can perform simple frame dropping with the drop-factor
*
* This element can perform simple frame dropping with the #GstDVDec:drop-factor
* property. Setting this property to a value N > 1 will only decode every
* Nth frame.
* </para>
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* |[
* gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink
* </programlisting>
* This pipeline decodes and renders the raw DV stream to a videosink.
* </para>
* Last reviewed on 2006-02-28 (0.10.3)
* ]| This pipeline decodes and renders the raw DV stream to a videosink.
* </refsect2>
*
* Last reviewed on 2006-02-28 (0.10.3)
*/
#ifdef HAVE_CONFIG_H
......
......@@ -30,24 +30,20 @@
/**
* SECTION:element-dvdemux
*
* <refsect2>
* <para>
* dvdemux splits raw DV into its audio and video components. The audio will be
* decoded raw samples and the video will be encoded DV video.
* </para>
* <para>
* This element can operate in both push and pull mode depending on the capabilities
* of the upstream peer.
* </para>
*
* This element can operate in both push and pull mode depending on the
* capabilities of the upstream peer.
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* |[
* gst-launch filesrc location=test.dv ! dvdemux name=demux ! queue ! audioconvert ! alsasink demux. ! queue ! dvdec ! xvimagesink
* </programlisting>
* This pipeline decodes and renders the raw DV stream to an audio and a videosink.
* </para>
* Last reviewed on 2006-02-27 (0.10.3)
* ]| This pipeline decodes and renders the raw DV stream to an audio and a videosink.
* </refsect2>
*
* Last reviewed on 2006-02-27 (0.10.3)
*/
/* DV output has two modes, normal and wide. The resolution is the same in both
......
......@@ -20,9 +20,10 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-esdmod
* SECTION:element-esdmon
* @see_also: #GstAlsaSrc, #GstAutoAudioSrc
*
* This element outputs sound to an already-running Enlightened Sound Daemon
* This element records sound from an already-running Enlightened Sound Daemon
* (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned
* through this element (regardless of the system configuration), since this
* is actively prevented by the element. If you must use esd, you need to
......@@ -38,6 +39,7 @@
* ]| Record from audioinput
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
......
......@@ -26,24 +26,20 @@
* SECTION:element-esdsink
* @see_also: #GstAlsaSink, #GstAutoAudioSink
*
* <refsect2>
* <para>
* This element outputs sound to an already-running Enlightened Sound Daemon
* (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned
* through this element (regardless of the system configuration), since this
* is actively prevented by the element. If you must use esd, you need to
* make sure it is started automatically with your session or otherwise.
* </para>
* <para>
*
* TODO: insert some comments about how sucky esd is and that all the cool
* kids use pulseaudio or whatever these days.
* </para>
* <para>
* Simple example pipeline that plays an Ogg/Vorbis file via esd:
* <programlisting>
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! esdsink
* </programlisting>
* </para>
* ]| play an Ogg/Vorbis audio file via esd
* </refsect2>
*/
......
......@@ -21,26 +21,20 @@
/**
* SECTION:element-flacdec
* @seealso: flacenc
* @see_also: #GstFlacEnc
*
* <refsect2>
* <para>
* flacdec decodes FLAC streams.
* <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
* is a Free Lossless Audio Codec.
* </para>
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* <programlisting>
* |[
* gst-launch filesrc location=media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! autoaudiosink
* </programlisting>
* </para>
* <title>Another example launch line</title>
* <para>
* <programlisting>
* ]|
* |[
* gst-launch gnomevfssrc location=http://gstreamer.freedesktop.org/media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! queue min-threshold-buffers=10 ! autoaudiosink
* </programlisting>
* </para>
* ]|
* </refsect2>
*/
......
......@@ -16,6 +16,21 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-flacenc
* @see_also: #GstFlacDec
*
* flacenc encodes FLAC streams.
* <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
* is a Free Lossless Audio Codec.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch audiotestsrc num-buffers=100 ! flacenc ! filesink location=beep.flac
* ]|
* </refsect2>
*/
/* TODO: - We currently don't handle discontinuities in the stream in a useful
* way and instead rely on the developer plugging in audiorate if
......
......@@ -17,6 +17,19 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-gconfaudiosink
*
* This element outputs sound to the audiosink that has been configured in
* GConf by the user.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! gconfaudiosink
* ]| Play on configured audiosink
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......
......@@ -17,6 +17,20 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-gconfaudiosrc
* @see_also: #GstAlsaSrc, #GstAutoAudioSrc
*
* This element records sound from the audiosink that has been configured in
* GConf by the user.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch gconfaudiosrc ! audioconvert ! wavenc ! filesink location=record.wav
* ]| Record from configured audioinput
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......