mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-09 19:09:41 +00:00
Code Issues 1 Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Sebastian Dröge 2009-04-30 10:13:05 +02:00
parent 78e2da1dfd
commit fb8e3c8c07
23 changed files with 194 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/plugins/Makefile.am
View file

@ -89,6 +89,7 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/amrnb/amrnbparse.h \
$(top_srcdir)/ext/cdio/gstcdiocddasrc.h \
$(top_srcdir)/ext/lame/gstlame.h \
$(top_srcdir)/ext/lame/gstlamemp3enc.h \
$(top_srcdir)/ext/mad/gstmad.h \
$(top_srcdir)/ext/sidplay/gstsiddec.h \
$(top_srcdir)/ext/twolame/gsttwolame.h \

1
docs/plugins/gst-plugins-ugly-plugins-docs.sgml
View file

@ -23,6 +23,7 @@
<xi:include href="xml/element-amrnbparse.xml" />
<xi:include href="xml/element-cdiocddasrc.xml" />
<xi:include href="xml/element-lame.xml" />
<xi:include href="xml/element-lamemp3enc.xml" />
<xi:include href="xml/element-mad.xml" />
<xi:include href="xml/element-rademux.xml" />
<xi:include href="xml/element-rdtmanager.xml" />

14
docs/plugins/gst-plugins-ugly-plugins-sections.txt
View file

@ -82,6 +82,20 @@ GST_TYPE_LAME
gst_lame_get_type
</SECTION>
<SECTION>
<FILE>element-lamemp3enc</FILE>
<TITLE>lamemp3enc</TITLE>
GstLameMP3Enc
<SUBSECTION Standard>
GstLameMP3EncClass
GST_LAMEMP3ENC
GST_LAMEMP3ENC_CLASS
GST_IS_LAMEMP3ENC
GST_IS_LAMEMP3ENC_CLASS
GST_TYPE_LAMEMP3ENC
gst_lamemp3enc_get_type
</SECTION>
<SECTION>
<FILE>element-mad</FILE>
<TITLE>mad</TITLE>

90
docs/plugins/gst-plugins-ugly-plugins.args
View file

@ -151,7 +151,7 @@
<ARG>
<NAME>GstLame::highpass-width</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Highpass width</NICK>
<BLURB>frequency(kHz) - default 15% of highpass freq.</BLURB>
@ -171,7 +171,7 @@
<ARG>
<NAME>GstLame::lowpass-width</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Lowpass width</NICK>
<BLURB>frequency(kHz) - default 15% of lowpass freq.</BLURB>
@ -601,7 +601,7 @@
<ARG>
<NAME>GstMPEGParse::max-scr-gap</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max SCR gap</NICK>
<BLURB>Maximum allowed gap between expected and actual SCR values. -1 means never adjust.</BLURB>
@ -681,7 +681,7 @@
<ARG>
<NAME>GstCdioCddaSrc::read-speed</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,100]</RANGE>
<RANGE>[G_MAXULONG,100]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Read speed</NICK>
<BLURB>Read from device at the specified speed (-1 = default).</BLURB>
@ -791,7 +791,7 @@
<ARG>
<NAME>GstTwoLame::psymodel</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,4]</RANGE>
<RANGE>[G_MAXULONG,4]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Psychoacoustic Model</NICK>
<BLURB>Psychoacoustic model used to encode the audio.</BLURB>
@ -848,3 +848,83 @@
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[8,320]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Bitrate (kb/s)</NICK>
<BLURB>Bitrate in kbit/sec (8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 or 320).</BLURB>
<DEFAULT>128</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::cbr</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>CBR</NICK>
<BLURB>Enforce constant bitrate encoding.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::encoding-engine-quality</NAME>
<TYPE>GstLameMP3EncEncodingEngineQuality</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Encoding Engine Quality</NICK>
<BLURB>Quality/speed of the encoding engine.</BLURB>
<DEFAULT>Standard</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::fast-vbr</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Fast VBR</NICK>
<BLURB>Use fast VBR encoding.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::mono</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Mono</NICK>
<BLURB>Enforce mono encoding.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::target</NAME>
<TYPE>GstLameMP3EncTarget</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Target</NICK>
<BLURB>Optimize for quality or bitrate.</BLURB>
<DEFAULT>Quality</DEFAULT>
</ARG>
<ARG>
<NAME>GstLameMP3Enc::vbr-quality</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,9.999]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>VBR Quality</NICK>
<BLURB>VBR Quality from 0 to 10, 0 being the best.</BLURB>
<DEFAULT>4</DEFAULT>
</ARG>
<ARG>
<NAME>GstAmrnbDec::variant</NAME>
<TYPE>GstAmrnbVariant</TYPE>
<RANGE></RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Variant</NICK>
<BLURB>The decoder variant.</BLURB>
<DEFAULT>IF1</DEFAULT>
</ARG>

32
docs/plugins/gst-plugins-ugly-plugins.hierarchy
View file

@ -9,39 +9,43 @@ GObject
GstElement
GstBin
GstPipeline
GstMpeg2dec
GstA52Dec
GstMad
GstID3TagBase
GstID3Tag
GstBaseSrc
GstPushSrc
GstCddaBaseSrc
GstCdioCddaSrc
GstDvdReadSrc
GstPNMSrc
GstAmrnbDec
GstAmrnbParse
GstAmrnbEnc
GstMad
GstID3TagBase
GstID3Tag
GstMpeg2dec
GstSidDec
GstTwoLame
GstLameMP3Enc
GstLame
GstA52Dec
GstSynaesthesia
GstDvdLpcmDec
GstXingMux
GstMPEGAudioParse
GstRMDemux
GstRealAudioDemux
GstRDTDepay
GstRDTManager
GstRTSPReal
GstDvdLpcmDec
GstDvdSubDec
GstDvdSubParse
AC3IEC
GstMPEGParse
GstMPEGDemux
GstDVDDemux
GstXingMux
GstMPEGAudioParse
GstASFDemux
GstRTSPWMS
GstBaseRTPDepayload
GstRtpAsfDepay
GstSynaesthesia
GstDvdSubDec
GstDvdSubParse
GstMPEGParse
GstMPEGDemux
GstDVDDemux
GstBus
GstTask
GstClock

2
docs/plugins/gst-plugins-ugly-plugins.interfaces
View file

@ -1,10 +1,10 @@
GstBin GstChildProxy
GstPipeline GstChildProxy
GstID3Tag GstTagSetter
GstCddaBaseSrc GstURIHandler
GstCdioCddaSrc GstURIHandler
GstDvdReadSrc GstURIHandler
GstPNMSrc GstURIHandler
GstID3Tag GstTagSetter
GstLame GstTagSetter
GstRTSPReal GstRTSPExtension
GstRTSPWMS GstRTSPExtension

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

@ -3,10 +3,10 @@
<description>Decodes ATSC A/52 encoded audio streams</description>
<filename>../../ext/a52dec/.libs/libgsta52dec.so</filename>
<basename>libgsta52dec.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

40
docs/plugins/inspect/plugin-amrnb.xml
View file

@ -3,11 +3,11 @@
<description>Adaptive Multi-Rate Narrow-Band</description>
<filename>../../ext/amrnb/.libs/libgstamrnb.so</filename>
<basename>libgstamrnb.so</basename>
<version>0.10.8.1</version>
<version>0.10.11.1</version>
<license>unknown</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>http://gstreamer.freedesktop.org</origin>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>amrnbdec</name>
@ -16,18 +16,18 @@
<description>Adaptive Multi-Rate Narrow-Band audio decoder</description>
<author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/AMR, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/AMR, rate=(int)8000, channels=(int)1</details>
</caps>
</pads>
</element>
<element>
@ -37,18 +37,18 @@
<description>Adaptive Multi-Rate Narrow-Band audio encoder</description>
<author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;, Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/AMR, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1</details>
</caps>
</pads>
</element>
<element>
@ -58,18 +58,18 @@
<description>Adaptive Multi-Rate Narrow-Band audio parser</description>
<author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-amr-nb-sh</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/AMR, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-amr-nb-sh</details>
</caps>
</pads>
</element>
</elements>

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

@ -3,10 +3,10 @@
<description>Demuxes and muxes audio and video in Microsofts ASF format</description>
<filename>../../gst/asfdemux/.libs/libgstasf.so</filename>
<basename>libgstasf.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>Read audio from audio CDs</description>
<filename>../../ext/cdio/.libs/libgstcdio.so</filename>
<basename>libgstcdio.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

6
docs/plugins/inspect/plugin-dvdlpcmdec.xml
View file

@ -3,16 +3,16 @@
<description>Decode DVD LPCM frames into standard PCM</description>
<filename>../../gst/dvdlpcmdec/.libs/libgstdvdlpcmdec.so</filename>
<basename>libgstdvdlpcmdec.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>dvdlpcmdec</name>
<longname>DVD LPCM Audio decoder</longname>
<class>Codec/Demuxer/Audio</class>
<class>Codec/Decoder/Audio</class>
<description>Decode DVD LPCM frames into standard PCM audio</description>
<author>Jan Schmidt &lt;jan@noraisin.net&gt;
Michael Smith &lt;msmith@fluendo.com&gt;</author>

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

@ -3,10 +3,10 @@
<description>Access a DVD with dvdread</description>
<filename>../../ext/dvdread/.libs/libgstdvdread.so</filename>
<basename>libgstdvdread.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>DVD subtitle parser and decoder</description>
<filename>../../gst/dvdsub/.libs/libgstdvdsub.so</filename>
<basename>libgstdvdsub.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>Convert raw AC3 into IEC958 (S/PDIF) frames</description>
<filename>../../gst/iec958/.libs/libgstiec958.so</filename>
<basename>libgstiec958.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

27
docs/plugins/inspect/plugin-lame.xml
View file

@ -3,17 +3,17 @@
<description>Encode MP3s with LAME</description>
<filename>../../ext/lame/.libs/libgstlame.so</filename>
<basename>libgstlame.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>lame</name>
<longname>L.A.M.E. mp3 encoder</longname>
<class>Codec/Encoder/Audio</class>
<description>High-quality free MP3 encoder</description>
<description>High-quality free MP3 encoder (deprecated)</description>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads>
<caps>
@ -30,5 +30,26 @@
</caps>
</pads>
</element>
<element>
<name>lamemp3enc</name>
<longname>L.A.M.E. mp3 encoder</longname>
<class>Codec/Encoder/Audio</class>
<description>High-quality free MP3 encoder</description>
<author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/mpeg, mpegversion=(int)1, layer=(int)3, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
</pads>
</element>
</elements>
</plugin>

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

@ -3,10 +3,10 @@
<description>id3 tag manipulation and mp3 decoding based on the mad library</description>
<filename>../../ext/mad/.libs/libgstmad.so</filename>
<basename>libgstmad.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>LibMpeg2 decoder</description>
<filename>../../ext/mpeg2dec/.libs/libgstmpeg2dec.so</filename>
<basename>libgstmpeg2dec.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>MPEG-1 layer 1/2/3 audio stream elements</description>
<filename>../../gst/mpegaudioparse/.libs/libgstmpegaudioparse.so</filename>
<basename>libgstmpegaudioparse.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>MPEG system stream parser</description>
<filename>../../gst/mpegstream/.libs/libgstmpegstream.so</filename>
<basename>libgstmpegstream.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>RealMedia support plugins</description>
<filename>../../gst/realmedia/.libs/libgstrmdemux.so</filename>
<basename>libgstrmdemux.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

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

@ -3,10 +3,10 @@
<description>Uses libsidplay to decode .sid files</description>
<filename>../../ext/sidplay/.libs/libgstsid.so</filename>
<basename>libgstsid.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>

2
docs/plugins/inspect/plugin-synaesthesia.xml
View file

@ -3,7 +3,7 @@
<description>Creates video visualizations of audio input, using stereo and pitch information</description>
<filename>../../gst/synaesthesia/.libs/libgstsynaesthesia.so</filename>
<basename>libgstsynaesthesia.so</basename>
<version>0.10.10.1</version>
<version>0.10.11.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>

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

@ -3,10 +3,10 @@
<description>Encode MP2s with TwoLAME</description>
<filename>../../ext/twolame/.libs/libgsttwolame.so</filename>
<basename>libgsttwolame.so</basename>
<version>0.10.11</version>
<version>0.10.11.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>