Commit 55535c7f authored by Sebastian Dröge's avatar Sebastian Dröge

effectv: Add basic documentation for the effectv elements

parent 757f80b2
......@@ -138,6 +138,14 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/debugutils/gsttaginject.h \
$(top_srcdir)/gst/debugutils/progressreport.h \
$(top_srcdir)/gst/deinterlace/gstdeinterlace.h \
$(top_srcdir)/gst/effectv/gstaging.h \
$(top_srcdir)/gst/effectv/gstdice.h \
$(top_srcdir)/gst/effectv/gstedge.h \
$(top_srcdir)/gst/effectv/gstquark.h \
$(top_srcdir)/gst/effectv/gstrev.h \
$(top_srcdir)/gst/effectv/gstshagadelic.h \
$(top_srcdir)/gst/effectv/gstvertigo.h \
$(top_srcdir)/gst/effectv/gstwarp.h \
$(top_srcdir)/gst/equalizer/gstiirequalizer.h \
$(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \
$(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \
......
......@@ -19,6 +19,7 @@
<chapter>
<title>gst-plugins-good Elements</title>
<xi:include href="xml/element-aasink.xml" />
<xi:include href="xml/element-agingtv.xml" />
<xi:include href="xml/element-alphacolor.xml" />
<xi:include href="xml/element-alawdec.xml" />
<xi:include href="xml/element-alawenc.xml" />
......@@ -52,10 +53,12 @@
<xi:include href="xml/element-cutter.xml" />
<xi:include href="xml/element-deinterlace.xml" />
<xi:include href="xml/element-deinterleave.xml" />
<xi:include href="xml/element-dicetv.xml" />
<xi:include href="xml/element-directsoundsink.xml" />
<xi:include href="xml/element-dv1394src.xml" />
<xi:include href="xml/element-dvdec.xml" />
<xi:include href="xml/element-dvdemux.xml" />
<xi:include href="xml/element-edgetv.xml" />
<xi:include href="xml/element-equalizer-10bands.xml" />
<xi:include href="xml/element-equalizer-3bands.xml" />
<xi:include href="xml/element-equalizer-nbands.xml" />
......@@ -105,13 +108,16 @@
<xi:include href="xml/element-pulsesink.xml" />
<xi:include href="xml/element-pulsesrc.xml" />
<xi:include href="xml/element-pulsemixer.xml" />
<xi:include href="xml/element-quarktv.xml" />
<xi:include href="xml/element-qtdemux.xml" />
<xi:include href="xml/element-revtv.xml" />
<xi:include href="xml/element-rganalysis.xml" />
<xi:include href="xml/element-rglimiter.xml" />
<xi:include href="xml/element-rgvolume.xml" />
<xi:include href="xml/element-rtpdec.xml" />
<xi:include href="xml/element-rtpjpegpay.xml" />
<xi:include href="xml/element-rtspsrc.xml" />
<xi:include href="xml/element-shagadelictv.xml" />
<xi:include href="xml/element-smokedec.xml" />
<xi:include href="xml/element-smokeenc.xml" />
<xi:include href="xml/element-smpte.xml" />
......@@ -124,11 +130,13 @@
<xi:include href="xml/element-udpsrc.xml" />
<xi:include href="xml/element-udpsink.xml" />
<xi:include href="xml/element-v4l2src.xml" />
<xi:include href="xml/element-vertigotv.xml" />
<xi:include href="xml/element-videobalance.xml" />
<xi:include href="xml/element-videobox.xml" />
<xi:include href="xml/element-videocrop.xml" />
<xi:include href="xml/element-videoflip.xml" />
<xi:include href="xml/element-videomixer.xml" />
<xi:include href="xml/element-warptv.xml" />
<xi:include href="xml/element-wavenc.xml" />
<xi:include href="xml/element-waveformsink.xml" />
<xi:include href="xml/element-wavpackdec.xml" />
......
......@@ -1790,3 +1790,115 @@ GST_TYPE_Y4M_ENCODE
gst_y4m_encode_get_type
</SECTION>
<SECTION>
<FILE>element-agingtv</FILE>
<TITLE>agingtv</TITLE>
GstAgingTV
<SUBSECTION Standard>
GstAgingTVClass
GST_AGINGTV
GST_AGINGTV_CLASS
GST_IS_AGINGTV
GST_IS_AGINGTV_CLASS
GST_TYPE_AGINGTV
gst_agingtv_get_type
</SECTION>
<SECTION>
<FILE>element-dicetv</FILE>
<TITLE>dicetv</TITLE>
GstDiceTV
<SUBSECTION Standard>
GstDiceTVClass
GST_DICETV
GST_DICETV_CLASS
GST_IS_DICETV
GST_IS_DICETV_CLASS
GST_TYPE_DICETV
gst_dicetv_get_type
</SECTION>
<SECTION>
<FILE>element-edgetv</FILE>
<TITLE>edgetv</TITLE>
GstEdgeTV
<SUBSECTION Standard>
GstEdgeTVClass
GST_EDGETV
GST_EDGETV_CLASS
GST_IS_EDGETV
GST_IS_EDGETV_CLASS
GST_TYPE_EDGETV
gst_edgetv_get_type
</SECTION>
<SECTION>
<FILE>element-quarktv</FILE>
<TITLE>quarktv</TITLE>
GstQuarkTV
<SUBSECTION Standard>
GstQuarkTVClass
GST_QUARKTV
GST_QUARKTV_CLASS
GST_IS_QUARKTV
GST_IS_QUARKTV_CLASS
GST_TYPE_QUARKTV
gst_quarktv_get_type
</SECTION>
<SECTION>
<FILE>element-revtv</FILE>
<TITLE>revtv</TITLE>
GstRevTV
<SUBSECTION Standard>
GstRevTVClass
GST_REVTV
GST_REVTV_CLASS
GST_IS_REVTV
GST_IS_REVTV_CLASS
GST_TYPE_REVTV
gst_revtv_get_type
</SECTION>
<SECTION>
<FILE>element-shagadelictv</FILE>
<TITLE>shagadelictv</TITLE>
GstShagadelicTV
<SUBSECTION Standard>
GstShagadelicTVClass
GST_SHAGADELICTV
GST_SHAGADELICTV_CLASS
GST_IS_SHAGADELICTV
GST_IS_SHAGADELICTV_CLASS
GST_TYPE_SHAGADELICTV
gst_shagadelictv_get_type
</SECTION>
<SECTION>
<FILE>element-vertigotv</FILE>
<TITLE>vertigotv</TITLE>
GstVertigoTV
<SUBSECTION Standard>
GstVertigoTVClass
GST_VERTIGOTV
GST_VERTIGOTV_CLASS
GST_IS_VERTIGOTV
GST_IS_VERTIGOTV_CLASS
GST_TYPE_VERTIGOTV
gst_vertigotv_get_type
</SECTION>
<SECTION>
<FILE>element-warptv</FILE>
<TITLE>warptv</TITLE>
GstWarpTV
<SUBSECTION Standard>
GstWarpTVClass
GST_WARPTV
GST_WARPTV_CLASS
GST_IS_WARPTV
GST_IS_WARPTV_CLASS
GST_TYPE_WARPTV
gst_warptv_get_type
</SECTION>
......@@ -411,7 +411,7 @@
<ARG>
<NAME>GstUDPSrc::sockfd</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Socket Handle</NICK>
<BLURB>Socket to use for UDP reception. (-1 == allocate).</BLURB>
......@@ -461,7 +461,7 @@
<ARG>
<NAME>GstUDPSrc::sock</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>Socket Handle</NICK>
<BLURB>Socket currently in use for UDP reception. (-1 = no socket).</BLURB>
......@@ -771,10 +771,10 @@
<ARG>
<NAME>GstQuarkTV::planes</NAME>
<TYPE>gint</TYPE>
<RANGE>[1,32]</RANGE>
<RANGE>[0,64]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Planes</NICK>
<BLURB>Number of frames in the buffer.</BLURB>
<BLURB>Number of planes.</BLURB>
<DEFAULT>16</DEFAULT>
</ARG>
......@@ -1491,7 +1491,7 @@
<ARG>
<NAME>GstDV1394Src::port</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,16]</RANGE>
<RANGE>[G_MAXULONG,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Port</NICK>
<BLURB>Port number (-1 automatic).</BLURB>
......@@ -1701,7 +1701,7 @@
<ARG>
<NAME>GstTest::allowed-timestamp-deviation</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>allowed timestamp deviation</NICK>
<BLURB>allowed average difference in usec between timestamp of next buffer and expected timestamp from analyzing last buffer.</BLURB>
......@@ -1711,7 +1711,7 @@
<ARG>
<NAME>GstTest::buffer-count</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>buffer count</NICK>
<BLURB>number of buffers in stream.</BLURB>
......@@ -1721,7 +1721,7 @@
<ARG>
<NAME>GstTest::expected-buffer-count</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>expected buffer count</NICK>
<BLURB>expected number of buffers in stream.</BLURB>
......@@ -1731,7 +1731,7 @@
<ARG>
<NAME>GstTest::expected-length</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>expected length</NICK>
<BLURB>expected length of stream.</BLURB>
......@@ -1751,7 +1751,7 @@
<ARG>
<NAME>GstTest::length</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>length</NICK>
<BLURB>length of stream.</BLURB>
......@@ -1771,7 +1771,7 @@
<ARG>
<NAME>GstTest::timestamp-deviation</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>timestamp deviation</NICK>
<BLURB>average difference in usec between timestamp of next buffer and expected timestamp from analyzing last buffer.</BLURB>
......@@ -1841,7 +1841,7 @@
<ARG>
<NAME>GstBreakMyData::set-to</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,255]</RANGE>
<RANGE>[G_MAXULONG,255]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>set-to</NICK>
<BLURB>set changed bytes to this value (-1 means random value.</BLURB>
......@@ -2161,7 +2161,7 @@
<ARG>
<NAME>GstDynUDPSink::sockfd</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,32767]</RANGE>
<RANGE>[G_MAXULONG,32767]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>socket handle</NICK>
<BLURB>Socket to use for UDP sending. (-1 == allocate).</BLURB>
......@@ -2231,7 +2231,7 @@
<ARG>
<NAME>GstMultiUDPSink::sock</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>Socket Handle</NICK>
<BLURB>Socket currently in use for UDP sending. (-1 == no socket).</BLURB>
......@@ -2241,7 +2241,7 @@
<ARG>
<NAME>GstMultiUDPSink::sockfd</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Socket Handle</NICK>
<BLURB>Socket to use for UDP sending. (-1 == allocate).</BLURB>
......@@ -2271,7 +2271,7 @@
<ARG>
<NAME>GstMultiUDPSink::qos-dscp</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,63]</RANGE>
<RANGE>[G_MAXULONG,63]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>QoS diff srv code point</NICK>
<BLURB>Quality of Service, differentiated services code point (-1 default).</BLURB>
......@@ -2821,10 +2821,10 @@
<ARG>
<NAME>GstV4l2Src::queue-size</NAME>
<TYPE>guint</TYPE>
<RANGE>[2,16]</RANGE>
<RANGE>[1,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Queue size</NICK>
<BLURB>Number of buffers to be enqueud in the driver.</BLURB>
<BLURB>Number of buffers to be enqueud in the driver in streaming mode.</BLURB>
<DEFAULT>2</DEFAULT>
</ARG>
......@@ -2841,7 +2841,7 @@
<ARG>
<NAME>GstV4l2Src::device-fd</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>File descriptor</NICK>
<BLURB>File descriptor of the device.</BLURB>
......@@ -3061,7 +3061,7 @@
<ARG>
<NAME>GstRndBufferSize::max</NAME>
<TYPE>glong</TYPE>
<RANGE>>= 1</RANGE>
<RANGE>[1,G_MAXINT]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>maximum</NICK>
<BLURB>maximum buffer size.</BLURB>
......@@ -3071,7 +3071,7 @@
<ARG>
<NAME>GstRndBufferSize::min</NAME>
<TYPE>glong</TYPE>
<RANGE>>= 0</RANGE>
<RANGE>[0,G_MAXINT]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>mininum</NICK>
<BLURB>mininum buffer size.</BLURB>
......@@ -3081,7 +3081,7 @@
<ARG>
<NAME>GstRndBufferSize::seed</NAME>
<TYPE>gulong</TYPE>
<RANGE></RANGE>
<RANGE><= G_MAXUINT</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>random number seed</NICK>
<BLURB>seed for randomness (initialized when going from READY to PAUSED).</BLURB>
......@@ -19681,7 +19681,7 @@
<ARG>
<NAME>GstHDV1394Src::port</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,16]</RANGE>
<RANGE>[G_MAXULONG,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Port</NICK>
<BLURB>Port number (-1 automatic).</BLURB>
......@@ -19915,7 +19915,7 @@
<FLAGS>rw</FLAGS>
<NICK>Fragment packets in mode A Only</NICK>
<BLURB>Disable packetization modes B and C.</BLURB>
<DEFAULT>TRUE</DEFAULT>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
......@@ -19958,3 +19958,43 @@
<DEFAULT>Auto detection</DEFAULT>
</ARG>
<ARG>
<NAME>GstAgingTV::color-aging</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Color Aging</NICK>
<BLURB>Color Aging.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG>
<NAME>GstAgingTV::dusts</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Dusts</NICK>
<BLURB>Dusts.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG>
<NAME>GstAgingTV::pits</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Pits</NICK>
<BLURB>Pits.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG>
<NAME>GstAgingTV::scratch-lines</NAME>
<TYPE>guint</TYPE>
<RANGE><= 20</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Scratch Lines</NICK>
<BLURB>Number of scratch lines.</BLURB>
<DEFAULT>7</DEFAULT>
</ARG>
......@@ -18,59 +18,24 @@ GObject
GstSwitchSink
GstGConfAudioSink
GstGConfAudioSrc
GstRTSPSrc
GstAutoVideoSink
GstAutoVideoSrc
GstAutoAudioSink
GstAutoAudioSrc
GstRgVolume
GstRTSPSrc
GstAspectRatioCrop
GstBaseSink
GstBaseAudioSink
GstAudioSink
GstEsdSink
GstOssSink
GstPulseSink
GstShout2send
GstCACASink
GstVideoSink
GstGdkPixbufSink
GstAASink
GstMultiUDPSink
GstUDPSink
GstDynUDPSink
GstMultiFileSink
GstTest
GstJpegEnc
GstJpegDec
GstSmokeEnc
GstSmokeDec
GstBaseSrc
GstPushSrc
GstBaseAudioSrc
GstAudioSrc
GstPulseSrc
GstOssSrc
GstSoupHTTPSrc
GstDV1394Src
GstHDV1394Src
GstV4l2Src
GstXImageSrc
GstUDPSrc
GstMultiFileSrc
GstPulseMixer
GstFlacEnc
GstFlacDec
GstFlacTag
GstTagLibMux
GstId3v2Mux
GstApev2Mux
GstCairoTextOverlay
GstBaseTransform
GstCairoTimeOverlay
GstPixbufScale
GstLevel
GstVideoBox
GstVideoFilter
GstNavigationtest
GstVideoBalance
GstVideoFlip
GstGamma
GstSMPTEAlpha
GstEdgeTV
GstAgingTV
GstDiceTV
......@@ -79,19 +44,15 @@ GObject
GstVertigoTV
GstRevTV
GstQuarkTV
GstVideoBalance
GstVideoFlip
GstGamma
GstSMPTEAlpha
GstNavigationtest
GstRgAnalysis
GstRgLimiter
GstBreakMyData
GstNavSeek
GstProgressReport
GstTagInject
GstAlpha
GstAlphaColor
GstLevel
GstAudioFilter
GstSpectrum
GstIirEqualizer
GstIirEqualizerNBands
GstIirEqualizer3Bands
GstIirEqualizer10Bands
GstAudioInvert
GstAudioKaraoke
GstAudioAmplify
......@@ -105,32 +66,96 @@ GObject
GstAudioWSincBand
GstAudioFIRFilter
GstAudioEcho
GstAlpha
GstAlphaColor
GstIirEqualizer
GstIirEqualizerNBands
GstIirEqualizer3Bands
GstIirEqualizer10Bands
GstAudioPanorama
GstVideoBox
GstBreakMyData
GstNavSeek
GstProgressReport
GstTagInject
GstRgAnalysis
GstRgLimiter
GstVideoCrop
GstBaseSrc
GstPushSrc
GstSoupHTTPSrc
GstBaseAudioSrc
GstAudioSrc
GstPulseSrc
GstOssSrc
GstDV1394Src
GstHDV1394Src
GstXImageSrc
GstV4l2Src
GstUDPSrc
GstMultiFileSrc
GstBaseSink
GstCACASink
GstBaseAudioSink
GstPulseSink
GstAudioSink
GstEsdSink
GstOssSink
GstAASink
GstVideoSink
GstGdkPixbufSink
GstShout2send
GstTest
GstMultiUDPSink
GstUDPSink
GstDynUDPSink
GstMultiFileSink
GstPulseMixer
GstTagLibMux
GstId3v2Mux
GstApev2Mux
GstJpegEnc
GstJpegDec
GstSmokeEnc
GstSmokeDec
GstDVDemux
GstDVDec
GstCmmlEnc
GstCmmlDec
GstFlacEnc
GstFlacDec
GstFlacTag
GstPngDec
GstPngEnc
GstGdkPixbuf
GstWavpackParse
GstWavpackDec
GstWavpackEnc
GstGdkPixbuf
GstCmmlEnc
GstCmmlDec
GstSpeexEnc
GstSpeexDec
GstDVDemux
GstDVDec
GstOssMixerElement
GstWavEnc
GstRTPDepay
GstRTPDec
GstICYDemux
GstWavParse
GstEbmlRead
GstMatroskaDemux
GstMatroskaMux
GstRndBufferSize
GstEFence
GstFlxDec
GstVideoMixer
GstTagDemux
GstApeDemux
GstID3Demux
GstGoom
GstGoom2k1
GstFLVDemux
GstFlvMux
GstMultipartDemux
GstMultipartMux
GstMuLawEnc
GstMuLawDec
GstALawEnc
GstALawDec
GstCutter
GstQTDemux
GstBaseRTPDepayload
GstRtpXQTDepay
GstRtpAC3Depay
GstRtpCELTDepay
GstRTPDVDepay
GstRTPiLBCDepay
GstRtpG726Depay
......@@ -158,8 +183,20 @@ GObject
GstRtpTheoraDepay
GstRtpVorbisDepay