From 2c7dbc3ba73dcdbf21ea23480e99f6c62327aceb Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 13 Jun 2008 06:57:21 +0000 Subject: [PATCH] Add missing elements to docs. Restore alphabetical order in section file. Document mad (it was included in docs alrea... Original commit message from CVS: * docs/plugins/gst-plugins-ugly-plugins-docs.sgml: * docs/plugins/gst-plugins-ugly-plugins-sections.txt: * ext/a52dec/gsta52dec.c: * ext/amrnb/amrnbdec.c: * ext/amrnb/amrnbenc.c: * ext/amrnb/amrnbparse.c: * ext/lame/gstlame.c: * ext/mad/gstmad.c: * ext/sidplay/gstsiddec.cc: * gst/asfdemux/gstrtspwms.c: * gst/mpegaudioparse/gstxingmux.c: * gst/realmedia/rademux.c: * gst/realmedia/rdtmanager.c: * gst/realmedia/rtspreal.c: * gst/synaesthesia/gstsynaesthesia.c: Add missing elements to docs. Restore alphabetical order in section file. Document mad (it was included in docs already). Fix doc-markup: use convinience syntax for examples (produces valid docbook), add several refsec2 when we have several titles. Fix some types. --- ext/lame/gstlame.c | 48 ++++++++++++++++-------------------------------- 1 file changed, 16 insertions(+), 32 deletions(-) diff --git a/ext/lame/gstlame.c b/ext/lame/gstlame.c index 99d6ea4..abcef00 100644 --- a/ext/lame/gstlame.c +++ b/ext/lame/gstlame.c @@ -23,61 +23,45 @@ * SECTION:element-lame * @see_also: mad, vorbisenc * - * - * * This element encodes raw integer audio into an MPEG-1 layer 3 (MP3) stream. * Note that MP3 is not * a free format, there are licensing and patent issues to take into * consideration. See Ogg/Vorbis * for a royalty free (and often higher quality) alternative. - * + * + * * Output sample rate - * * If no fixed output sample rate is negotiated on the element's src pad, * the element will choose an optimal sample rate to resample to internally. * For example, a 16-bit 44.1 KHz mono audio stream encoded at 48 kbit will * get resampled to 32 KHz. Use filter caps on the src pad to force a * particular sample rate. - * + * + * * Writing metadata (tags) - * * Whilst the lame encoder element does claim to implement the GstTagSetter * interface, it does so only for backwards compatibility reasons. Tag writing * has been removed from lame. Use external elements like id3v2mux or apev2mux * to add tags to your MP3 streams. The same goes for XING headers: use the * xingmux element to add XING headers to your VBR mp3 file. - * + * + * * Example pipelines - * - * Encode a test sine signal to MP3. - * - * + * |[ * gst-launch -v audiotestsrc wave=sine num-buffers=100 ! audioconvert ! lame ! filesink location=sine.mp3 - * - * - * Record from a sound card using ALSA and encode to MP3 - * - * + * ]| Encode a test sine signal to MP3. + * |[ * gst-launch -v alsasrc ! audioconvert ! lame bitrate=192 ! filesink location=alsasrc.mp3 - * - * - * Transcode from a .wav file to MP3 (the id3v2mux element is optional): - * - * + * ]| Record from a sound card using ALSA and encode to MP3 + * |[ * gst-launch -v filesrc location=music.wav ! decodebin ! audioconvert ! audioresample ! lame bitrate=192 ! id3v2mux ! filesink location=music.mp3 - * - * - * Encode Audio CD track 5 to MP3: - * - * + * ]| Transcode from a .wav file to MP3 (the id3v2mux element is optional) + * |[ * gst-launch -v cdda://5 ! audioconvert ! lame bitrate=192 ! filesink location=track5.mp3 - * - * - * Encode to a fixed sample rate: - * - * + * ]| Encode Audio CD track 5 to MP3 + * |[ * gst-launch -v audiotestsrc num-buffers=10 ! audio/x-raw-int,rate=44100,channels=1 ! lame bitrate=48 mode=3 ! filesink location=test.mp3 - * + * ]| Encode to a fixed sample rate * * * Last reviewed on 2007-07-24 (0.10.7) -- 2.7.4