aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2013-08-03 16:51:26 -0700
committerTimothy Gu <timothygu99@gmail.com>2013-09-22 14:58:21 -0700
commit82cfb8c2db6c6ec4818fec1e56050e69caa11ac5 (patch)
tree176fce5d6a1b7efb533ccff22d3b030a3198b74a
parent0a55c882cb6bef5617ea7150c61889272aa08e5e (diff)
downloadffmpeg-82cfb8c2db6c6ec4818fec1e56050e69caa11ac5.tar.gz
doc/encoders: reformat libmp3lame doc
Signed-off-by: Timothy Gu <timothygu99@gmail.com> Signed-off-by: Stefano Sabatini <stefasab@gmail.com> (cherry picked from commit 40b8350b57adaa9aaf6731bac5130d4fec1639c3) Conflicts: doc/encoders.texi
-rw-r--r--doc/encoders.texi48
1 files changed, 29 insertions, 19 deletions
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 121e865556..f14e16367c 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}.
-@subsection Option Mapping
+@subsection Options
+
+The following options are supported by the libmp3lame wrapper. The
+@command{lame}-equivalent of the options are listed in parentheses.
+
+@table @option
+@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.
-
-@multitable @columnfractions .2 .2
-@item FFmpeg @tab LAME
-@item b @tab b
-FFmpeg @code{b} option is expressed in bits/s, lame @code{bitrate}
-in kilobits/s.
-@item q @tab V
-Quality setting for VBR.
-@item compression_level @tab q
-Algorithm quality. Valid options are integers from 0-9.
-@item reservoir @tab N.A.
-Enable use of bit reservoir. LAME has this enabled by default.
-@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.
-@end multitable
+@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}.
+
+@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.
+
+@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
+@option{--nores} option.
+
+@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.
+
+@end table
@section libopencore-amrnb