[FFmpeg-cvslog] doc/encoders: reformat libmp3lame doc

Timothy Gu git at videolan.org
Fri Oct 11 15:35:14 CEST 2013


ffmpeg | branch: release/1.1 | Timothy Gu <timothygu99 at gmail.com> | Sat Aug  3 16:51:26 2013 -0700| [4ad0330b3dd185708656b85b1740e7b066f002ca] | committer: Timothy Gu

doc/encoders: reformat libmp3lame doc

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
Signed-off-by: Stefano Sabatini <stefasab at gmail.com>
(cherry picked from commit 40b8350b57adaa9aaf6731bac5130d4fec1639c3)

Conflicts:
	doc/encoders.texi

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=4ad0330b3dd185708656b85b1740e7b066f002ca
---

 doc/encoders.texi |   48 +++++++++++++++++++++++++++++-------------------
 1 file changed, 29 insertions(+), 19 deletions(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 1f06dee..f2ff004 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -420,26 +420,36 @@ Requires the presence of the libmp3lame headers and library during
 configuration. You need to explicitly configure the build with
 @code{--enable-libmp3lame}.
 
- at subsection Option Mapping
+ at subsection Options
+
+The following options are supported by the libmp3lame wrapper. The
+ at command{lame}-equivalent of the options are listed in parentheses.
+
+ at table @option
+ at item b (@emph{-b})
+Set bitrate expressed in bits/s for CBR. LAME @code{bitrate} is
+expressed in kilobits/s.
 
-The following options are supported by the libmp3lame wrapper,
-the LAME-equivalent options follow the FFmpeg ones.
-
- at multitable @columnfractions .2 .2
- at item FFmpeg            @tab LAME
- at item b                 @tab b
-FFmpeg @code{b} option is expressed in bits/s, lame @code{bitrate}
-in kilobits/s.
- at item q                 @tab V
-Quality setting for VBR.
- at item compression_level @tab q
-Algorithm quality. Valid options are integers from 0-9.
- at item reservoir         @tab N.A.
-Enable use of bit reservoir. LAME has this enabled by default.
- at item joint_stereo      @tab -m j
-Enables the the encoder to use (on a frame by frame basis) either L/R
-stereo or mid/side stereo.
- at end multitable
+ at item q (@emph{-V})
+Set constant quality setting for VBR. This option is valid only
+using the @command{ffmpeg} command-line tool. For library interface
+users, use @option{global_quality}.
+
+ at item compression_level (@emph{-q})
+Set algorithm quality. Valid arguments are integers in the 0-9 range,
+with 0 meaning highest quality but slowest, and 9 meaning fastest
+while producing the worst quality.
+
+ at item reservoir
+Enable use of bit reservoir when set to 1. Default value is 1. LAME
+has this enabled by default, but can be overriden by use
+ at option{--nores} option.
+
+ at item joint_stereo (@emph{-m j})
+Enable the encoder to use (on a frame by frame basis) either L/R
+stereo or mid/side stereo. Default value is 1.
+
+ at end table
 
 @section libopencore-amrnb
 



More information about the ffmpeg-cvslog mailing list