From 10574b5d4c0a2919811b35efd7cde866905308ee Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 13 Jun 2008 14:33:52 +0000 Subject: gst/replaygain/: More doc updates. Original commit message from CVS: * gst/replaygain/gstrganalysis.c: * gst/replaygain/gstrglimiter.c: * gst/replaygain/gstrgvolume.c: More doc updates. --- ChangeLog | 7 +++++++ gst/replaygain/gstrganalysis.c | 34 +++++++++++++++------------------- gst/replaygain/gstrglimiter.c | 14 ++++++-------- gst/replaygain/gstrgvolume.c | 18 +++++++----------- 4 files changed, 35 insertions(+), 38 deletions(-) diff --git a/ChangeLog b/ChangeLog index dd6f9bff..f9bdd6ad 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2008-06-13 Stefan Kost + + * gst/replaygain/gstrganalysis.c: + * gst/replaygain/gstrglimiter.c: + * gst/replaygain/gstrgvolume.c: + More doc updates. + 2008-06-13 Stefan Kost * docs/plugins/Makefile.am: diff --git a/gst/replaygain/gstrganalysis.c b/gst/replaygain/gstrganalysis.c index 613c0876..982c8a7f 100644 --- a/gst/replaygain/gstrganalysis.c +++ b/gst/replaygain/gstrganalysis.c @@ -22,10 +22,8 @@ /** * SECTION:element-rganalysis - * @see_also: rgvolume + * @see_also: #GstRgVolume * - * - * * This element analyzes raw audio sample data in accordance with the proposed * ReplayGain standard for * calculating the ideal replay gain for music tracks and albums. The element @@ -35,8 +33,7 @@ * posted on the message bus with a tag message. The EOS event is forwarded as * normal afterwards. Result tag lists at least contain the tags * #GST_TAG_TRACK_GAIN, #GST_TAG_TRACK_PEAK and #GST_TAG_REFERENCE_LEVEL. - * - * + * * Because the generated metadata tags become available at the end of streams, * downstream muxer and encoder elements are normally unable to save them in * their output since they generally save metadata in the file header. @@ -45,28 +42,27 @@ * needed for album processing * since the album gain and peak values need to be associated with all tracks of * an album, not just the last one. - * + * + * * Example launch lines - * Analyze a simple test waveform: - * + * |[ * gst-launch -t audiotestsrc wave=sine num-buffers=512 ! rganalysis ! fakesink - * - * Analyze a given file: - * - * gst-launch -t filesrc location="Some file.ogg" ! decodebin \ + * ]| Analyze a simple test waveform + * |[ + * gst-launch -t filesrc location=filename.ext ! decodebin \ * ! audioconvert ! audioresample ! rganalysis ! fakesink - * - * Analyze the pink noise reference file: - * + * ]| Analyze a given file + * |[ * gst-launch -t gnomevfssrc location=http://replaygain.hydrogenaudio.org/ref_pink.wav \ * ! wavparse ! rganalysis ! fakesink - * + * ]| Analyze the pink noise reference file * * The above launch line yields a result gain of +6 dB (instead of the expected - * +0 dB). This is not in error, refer to the reference-level property - * documentation for more information. + * +0 dB). This is not in error, refer to the #GstRgAnalysis:reference-level + * property documentation for more information. * + * + * * Acknowledgements * * This element is based on code used in the rgvolume + * @see_also: #GstRgVolume * - * - * * This element applies signal compression/limiting to raw audio data. It * performs strict hard limiting with soft-knee characteristics, using a * threshold of -6 dB. This type of filter is mentioned in the proposed ReplayGain standard. - * + * + * * Example launch line - * Playback of a file: - * - * gst-launch filesrc location="Filename.ext" ! decodebin ! audioconvert \ + * |[ + * gst-launch filesrc location=filename.ext ! decodebin ! audioconvert \ * ! rgvolume pre-amp=6.0 headroom=10.0 ! rglimiter \ * ! audioconvert ! audioresample ! alsasink - * + * ]|Playback of a file * */ diff --git a/gst/replaygain/gstrgvolume.c b/gst/replaygain/gstrgvolume.c index dbcfaf5d..41fe441d 100644 --- a/gst/replaygain/gstrgvolume.c +++ b/gst/replaygain/gstrgvolume.c @@ -22,11 +22,8 @@ /** * SECTION:element-rgvolume - * @see_also: rglimiter, - * rganalysis + * @see_also: #GstRgLimiter, #GstRgAnalysis * - * - * * This element applies volume changes to streams as lined out in the proposed * ReplayGain standard. It * interprets the ReplayGain meta data tags and carries out the adjustment (by @@ -41,21 +38,20 @@ * The information carried by these tags must have been calculated beforehand by * performing the ReplayGain analysis. This is implemented by the rganalysis element. - * - * + * * The signal compression/limiting recommendations outlined in the proposed * standard are not implemented by this element. This has to be handled by * separate elements because applications might want to have additional filters * between the volume adjustment and the limiting stage. A basic limiter is * included with this plugin: The rglimiter * element applies -6 dB hard limiting as mentioned in the ReplayGain standard. - * + * + * * Example launch line - * Playback of a file: - * - * gst-launch filesrc location="Filename.ext" ! decodebin ! audioconvert \ + * |[ + * gst-launch filesrc location=filename.ext ! decodebin ! audioconvert \ * ! rgvolume ! audioconvert ! audioresample ! alsasink - * + * ]| Playback of a file * */ -- cgit v1.2.1