From fb8e3c8c07654d79da2c2e496560eddbce30e74b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Thu, 30 Apr 2009 10:13:05 +0200 Subject: [PATCH] Update docs --- docs/plugins/Makefile.am | 1 + .../gst-plugins-ugly-plugins-docs.sgml | 1 + .../gst-plugins-ugly-plugins-sections.txt | 14 +++ docs/plugins/gst-plugins-ugly-plugins.args | 90 +++++++++++++++++-- .../gst-plugins-ugly-plugins.hierarchy | 32 ++++--- .../gst-plugins-ugly-plugins.interfaces | 2 +- docs/plugins/inspect/plugin-a52dec.xml | 4 +- docs/plugins/inspect/plugin-amrnb.xml | 40 ++++----- docs/plugins/inspect/plugin-asf.xml | 4 +- docs/plugins/inspect/plugin-cdio.xml | 4 +- docs/plugins/inspect/plugin-dvdlpcmdec.xml | 6 +- docs/plugins/inspect/plugin-dvdread.xml | 4 +- docs/plugins/inspect/plugin-dvdsub.xml | 4 +- docs/plugins/inspect/plugin-iec958.xml | 4 +- docs/plugins/inspect/plugin-lame.xml | 27 +++++- docs/plugins/inspect/plugin-mad.xml | 4 +- docs/plugins/inspect/plugin-mpeg2dec.xml | 4 +- .../plugins/inspect/plugin-mpegaudioparse.xml | 4 +- docs/plugins/inspect/plugin-mpegstream.xml | 4 +- docs/plugins/inspect/plugin-realmedia.xml | 4 +- docs/plugins/inspect/plugin-siddec.xml | 4 +- docs/plugins/inspect/plugin-synaesthesia.xml | 2 +- docs/plugins/inspect/plugin-twolame.xml | 4 +- 23 files changed, 194 insertions(+), 73 deletions(-) diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 8022df53c8..094edbf355 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -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 \ diff --git a/docs/plugins/gst-plugins-ugly-plugins-docs.sgml b/docs/plugins/gst-plugins-ugly-plugins-docs.sgml index bdf4504490..5917986b7f 100644 --- a/docs/plugins/gst-plugins-ugly-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-ugly-plugins-docs.sgml @@ -23,6 +23,7 @@ + diff --git a/docs/plugins/gst-plugins-ugly-plugins-sections.txt b/docs/plugins/gst-plugins-ugly-plugins-sections.txt index cc5c5d81a1..0bf6288534 100644 --- a/docs/plugins/gst-plugins-ugly-plugins-sections.txt +++ b/docs/plugins/gst-plugins-ugly-plugins-sections.txt @@ -82,6 +82,20 @@ GST_TYPE_LAME gst_lame_get_type +
+element-lamemp3enc +lamemp3enc +GstLameMP3Enc + +GstLameMP3EncClass +GST_LAMEMP3ENC +GST_LAMEMP3ENC_CLASS +GST_IS_LAMEMP3ENC +GST_IS_LAMEMP3ENC_CLASS +GST_TYPE_LAMEMP3ENC +gst_lamemp3enc_get_type +
+
element-mad mad diff --git a/docs/plugins/gst-plugins-ugly-plugins.args b/docs/plugins/gst-plugins-ugly-plugins.args index 8e6dd1bd07..d2bfcba4a0 100644 --- a/docs/plugins/gst-plugins-ugly-plugins.args +++ b/docs/plugins/gst-plugins-ugly-plugins.args @@ -151,7 +151,7 @@ GstLame::highpass-width gint ->= -1 +>= G_MAXULONG rw Highpass width frequency(kHz) - default 15% of highpass freq. @@ -171,7 +171,7 @@ GstLame::lowpass-width gint ->= -1 +>= G_MAXULONG rw Lowpass width frequency(kHz) - default 15% of lowpass freq. @@ -601,7 +601,7 @@ GstMPEGParse::max-scr-gap gint ->= -1 +>= G_MAXULONG rw Max SCR gap Maximum allowed gap between expected and actual SCR values. -1 means never adjust. @@ -681,7 +681,7 @@ GstCdioCddaSrc::read-speed gint -[-1,100] +[G_MAXULONG,100] rw Read speed Read from device at the specified speed (-1 = default). @@ -791,7 +791,7 @@ GstTwoLame::psymodel gint -[-1,4] +[G_MAXULONG,4] rw Psychoacoustic Model Psychoacoustic model used to encode the audio. @@ -848,3 +848,83 @@ 0 + +GstLameMP3Enc::bitrate +gint +[8,320] +rw +Bitrate (kb/s) +Bitrate in kbit/sec (8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 or 320). +128 + + + +GstLameMP3Enc::cbr +gboolean + +rw +CBR +Enforce constant bitrate encoding. +FALSE + + + +GstLameMP3Enc::encoding-engine-quality +GstLameMP3EncEncodingEngineQuality + +rw +Encoding Engine Quality +Quality/speed of the encoding engine. +Standard + + + +GstLameMP3Enc::fast-vbr +gboolean + +rw +Fast VBR +Use fast VBR encoding. +FALSE + + + +GstLameMP3Enc::mono +gboolean + +rw +Mono +Enforce mono encoding. +FALSE + + + +GstLameMP3Enc::target +GstLameMP3EncTarget + +rw +Target +Optimize for quality or bitrate. +Quality + + + +GstLameMP3Enc::vbr-quality +gfloat +[0,9.999] +rw +VBR Quality +VBR Quality from 0 to 10, 0 being the best. +4 + + + +GstAmrnbDec::variant +GstAmrnbVariant + +rwx +Variant +The decoder variant. +IF1 + + diff --git a/docs/plugins/gst-plugins-ugly-plugins.hierarchy b/docs/plugins/gst-plugins-ugly-plugins.hierarchy index 24b607708d..64ad6289f6 100644 --- a/docs/plugins/gst-plugins-ugly-plugins.hierarchy +++ b/docs/plugins/gst-plugins-ugly-plugins.hierarchy @@ -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 diff --git a/docs/plugins/gst-plugins-ugly-plugins.interfaces b/docs/plugins/gst-plugins-ugly-plugins.interfaces index 33ee1c86c0..5461c35e8f 100644 --- a/docs/plugins/gst-plugins-ugly-plugins.interfaces +++ b/docs/plugins/gst-plugins-ugly-plugins.interfaces @@ -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 diff --git a/docs/plugins/inspect/plugin-a52dec.xml b/docs/plugins/inspect/plugin-a52dec.xml index 0c3d5b3cd5..04423a5995 100644 --- a/docs/plugins/inspect/plugin-a52dec.xml +++ b/docs/plugins/inspect/plugin-a52dec.xml @@ -3,10 +3,10 @@ Decodes ATSC A/52 encoded audio streams ../../ext/a52dec/.libs/libgsta52dec.so libgsta52dec.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-amrnb.xml b/docs/plugins/inspect/plugin-amrnb.xml index 1cd03aa6aa..47cce27fd8 100644 --- a/docs/plugins/inspect/plugin-amrnb.xml +++ b/docs/plugins/inspect/plugin-amrnb.xml @@ -3,11 +3,11 @@ Adaptive Multi-Rate Narrow-Band ../../ext/amrnb/.libs/libgstamrnb.so libgstamrnb.so - 0.10.8.1 + 0.10.11.1 unknown gst-plugins-ugly GStreamer Ugly Plug-ins CVS/prerelease - http://gstreamer.freedesktop.org + Unknown package origin amrnbdec @@ -16,18 +16,18 @@ Adaptive Multi-Rate Narrow-Band audio decoder Ronald Bultje <rbultje@ronald.bitfreak.net> - - sink - sink - always -
audio/AMR, rate=(int)8000, channels=(int)1
- src source always
audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1
 + + sink + sink + always +
audio/AMR, rate=(int)8000, channels=(int)1
+ @@ -37,18 +37,18 @@ Adaptive Multi-Rate Narrow-Band audio encoder Ronald Bultje <rbultje@ronald.bitfreak.net>, Wim Taymans <wim.taymans@gmail.com> - - sink - sink - always -
audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1
- src source always
audio/AMR, rate=(int)8000, channels=(int)1
 + + sink + sink + always +
audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1
+ @@ -58,18 +58,18 @@ Adaptive Multi-Rate Narrow-Band audio parser Ronald Bultje <rbultje@ronald.bitfreak.net> - - sink - sink - always -
audio/x-amr-nb-sh
- src source always
audio/AMR, rate=(int)8000, channels=(int)1
 + + sink + sink + always +
audio/x-amr-nb-sh
+ diff --git a/docs/plugins/inspect/plugin-asf.xml b/docs/plugins/inspect/plugin-asf.xml index 3ede519d1d..53a1fa0452 100644 --- a/docs/plugins/inspect/plugin-asf.xml +++ b/docs/plugins/inspect/plugin-asf.xml @@ -3,10 +3,10 @@ Demuxes and muxes audio and video in Microsofts ASF format ../../gst/asfdemux/.libs/libgstasf.so libgstasf.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-cdio.xml b/docs/plugins/inspect/plugin-cdio.xml index bdfffb5702..d2a38e09b0 100644 --- a/docs/plugins/inspect/plugin-cdio.xml +++ b/docs/plugins/inspect/plugin-cdio.xml @@ -3,10 +3,10 @@ Read audio from audio CDs ../../ext/cdio/.libs/libgstcdio.so libgstcdio.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-dvdlpcmdec.xml b/docs/plugins/inspect/plugin-dvdlpcmdec.xml index bb67473062..893dde3ae0 100644 --- a/docs/plugins/inspect/plugin-dvdlpcmdec.xml +++ b/docs/plugins/inspect/plugin-dvdlpcmdec.xml @@ -3,16 +3,16 @@ Decode DVD LPCM frames into standard PCM ../../gst/dvdlpcmdec/.libs/libgstdvdlpcmdec.so libgstdvdlpcmdec.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin dvdlpcmdec DVD LPCM Audio decoder - Codec/Demuxer/Audio + Codec/Decoder/Audio Decode DVD LPCM frames into standard PCM audio Jan Schmidt <jan@noraisin.net> Michael Smith <msmith@fluendo.com> diff --git a/docs/plugins/inspect/plugin-dvdread.xml b/docs/plugins/inspect/plugin-dvdread.xml index 463f20bc8a..1f1e3f0fc3 100644 --- a/docs/plugins/inspect/plugin-dvdread.xml +++ b/docs/plugins/inspect/plugin-dvdread.xml @@ -3,10 +3,10 @@ Access a DVD with dvdread ../../ext/dvdread/.libs/libgstdvdread.so libgstdvdread.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-dvdsub.xml b/docs/plugins/inspect/plugin-dvdsub.xml index 1f9c3e6901..15a8feefab 100644 --- a/docs/plugins/inspect/plugin-dvdsub.xml +++ b/docs/plugins/inspect/plugin-dvdsub.xml @@ -3,10 +3,10 @@ DVD subtitle parser and decoder ../../gst/dvdsub/.libs/libgstdvdsub.so libgstdvdsub.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-iec958.xml b/docs/plugins/inspect/plugin-iec958.xml index 473d93e8a4..d8edb5fa7c 100644 --- a/docs/plugins/inspect/plugin-iec958.xml +++ b/docs/plugins/inspect/plugin-iec958.xml @@ -3,10 +3,10 @@ Convert raw AC3 into IEC958 (S/PDIF) frames ../../gst/iec958/.libs/libgstiec958.so libgstiec958.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-lame.xml b/docs/plugins/inspect/plugin-lame.xml index 517f416886..9cd75d7cc9 100644 --- a/docs/plugins/inspect/plugin-lame.xml +++ b/docs/plugins/inspect/plugin-lame.xml @@ -3,17 +3,17 @@ Encode MP3s with LAME ../../ext/lame/.libs/libgstlame.so libgstlame.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin lame L.A.M.E. mp3 encoder Codec/Encoder/Audio - High-quality free MP3 encoder + High-quality free MP3 encoder (deprecated) Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com> @@ -30,5 +30,26 @@ + + lamemp3enc + L.A.M.E. mp3 encoder + Codec/Encoder/Audio + High-quality free MP3 encoder + Sebastian Dröge <sebastian.droege@collabora.co.uk> + + + sink + sink + always +
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 ]
+ + + src + source + always +
audio/mpeg, mpegversion=(int)1, layer=(int)3, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]
+ + + \ No newline at end of file diff --git a/docs/plugins/inspect/plugin-mad.xml b/docs/plugins/inspect/plugin-mad.xml index 0dd9029fce..5162c36575 100644 --- a/docs/plugins/inspect/plugin-mad.xml +++ b/docs/plugins/inspect/plugin-mad.xml @@ -3,10 +3,10 @@ id3 tag manipulation and mp3 decoding based on the mad library ../../ext/mad/.libs/libgstmad.so libgstmad.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-mpeg2dec.xml b/docs/plugins/inspect/plugin-mpeg2dec.xml index 3ed2c8cdb7..3501d73b4b 100644 --- a/docs/plugins/inspect/plugin-mpeg2dec.xml +++ b/docs/plugins/inspect/plugin-mpeg2dec.xml @@ -3,10 +3,10 @@ LibMpeg2 decoder ../../ext/mpeg2dec/.libs/libgstmpeg2dec.so libgstmpeg2dec.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-mpegaudioparse.xml b/docs/plugins/inspect/plugin-mpegaudioparse.xml index 4922fd9929..e80a17f27c 100644 --- a/docs/plugins/inspect/plugin-mpegaudioparse.xml +++ b/docs/plugins/inspect/plugin-mpegaudioparse.xml @@ -3,10 +3,10 @@ MPEG-1 layer 1/2/3 audio stream elements ../../gst/mpegaudioparse/.libs/libgstmpegaudioparse.so libgstmpegaudioparse.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-mpegstream.xml b/docs/plugins/inspect/plugin-mpegstream.xml index 922760bee0..942fd88269 100644 --- a/docs/plugins/inspect/plugin-mpegstream.xml +++ b/docs/plugins/inspect/plugin-mpegstream.xml @@ -3,10 +3,10 @@ MPEG system stream parser ../../gst/mpegstream/.libs/libgstmpegstream.so libgstmpegstream.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-realmedia.xml b/docs/plugins/inspect/plugin-realmedia.xml index a09659e378..58a377a330 100644 --- a/docs/plugins/inspect/plugin-realmedia.xml +++ b/docs/plugins/inspect/plugin-realmedia.xml @@ -3,10 +3,10 @@ RealMedia support plugins ../../gst/realmedia/.libs/libgstrmdemux.so libgstrmdemux.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-siddec.xml b/docs/plugins/inspect/plugin-siddec.xml index 435d109683..3a64dbbd4b 100644 --- a/docs/plugins/inspect/plugin-siddec.xml +++ b/docs/plugins/inspect/plugin-siddec.xml @@ -3,10 +3,10 @@ Uses libsidplay to decode .sid files ../../ext/sidplay/.libs/libgstsid.so libgstsid.so - 0.10.11 + 0.10.11.1 GPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin diff --git a/docs/plugins/inspect/plugin-synaesthesia.xml b/docs/plugins/inspect/plugin-synaesthesia.xml index c1f90399b2..1a5e9edc37 100644 --- a/docs/plugins/inspect/plugin-synaesthesia.xml +++ b/docs/plugins/inspect/plugin-synaesthesia.xml @@ -3,7 +3,7 @@ Creates video visualizations of audio input, using stereo and pitch information ../../gst/synaesthesia/.libs/libgstsynaesthesia.so libgstsynaesthesia.so - 0.10.10.1 + 0.10.11.1 GPL gst-plugins-ugly GStreamer Ugly Plug-ins CVS/prerelease diff --git a/docs/plugins/inspect/plugin-twolame.xml b/docs/plugins/inspect/plugin-twolame.xml index e0a4087b3d..a123438496 100644 --- a/docs/plugins/inspect/plugin-twolame.xml +++ b/docs/plugins/inspect/plugin-twolame.xml @@ -3,10 +3,10 @@ Encode MP2s with TwoLAME ../../ext/twolame/.libs/libgsttwolame.so libgsttwolame.so - 0.10.11 + 0.10.11.1 LGPL gst-plugins-ugly - GStreamer Ugly Plug-ins source release + GStreamer Ugly Plug-ins CVS/prerelease Unknown package origin