History

doc/encoders: add documentation for libtwolame

Timothy Gu committed 13 years ago

Commit ea038b91 parent 32896701 file · +63 −0Browse files

Unified · Split

doc/encoders.texi+63−0
@@ -441,6 +441,69 @@ Enables the encoder to use (on a frame by frame basis) either L/R · 440 unmodified lines
441441 stereo or mid/side stereo.
442442 @end multitable
443443
444+@section libtwolame
445+
446+TwoLAME MP2 encoder wrapper
447+
448+Requires the presence of the libtwolame headers and library during
449+configuration. You need to explicitly configure the build with
450+@code{--enable-libtwolame}.
451+
452+@subsection Options Mapping
453+
454+The following options are supported by the libtwolame wrapper. The
455+TwoLAME-equivalent options follow the FFmpeg ones and are in
456+parentheses.
457+
458+@table @option
459+@item b
460+(b) Set bitrate in bits/s. Note that FFmpeg @code{b} option is
461+expressed in bits/s, twolame @code{b} in kilobits/s. The default
462+value is 128k.
463+
464+@item q
465+(V) Set quality for experimental VBR support. Maximum value range is
466+from -50 to 50, useful range is from -10 to 10.
467+
468+@item mode
469+(mode) Set MPEG mode. Possible values:
470+
471+@table @samp
472+@item auto
473+Choose mode automatically based on the input. This is the default.
474+@item stereo
475+Stereo
476+@item joint_stereo
477+Joint stereo
478+@item dual_channel
479+Dual channel
480+@item mono
481+Mono
482+@end table
483+
484+@item psymodel
485+(psyc-mode) Set psychoacoustic model to use in encoding. The argument
486+must be an integer between -1 and 4, inclusive. The higher the value,
487+the better the quality. The default value is 3.
488+
489+@item energy_levels
490+(energy) Enable energy levels extensions when set to 1. The default
491+value is 0 (disabled).
492+
493+@item error_protection
494+(protect) Enable CRC error protection when set to 1. The default value
495+is 0 (disabled).
496+
497+@item copyright
498+(copyright) Set MPEG audio copyright flag when set to 1. The default
499+value is 0 (disabled).
500+
501+@item original
502+(original) Set MPEG audio original flag when set to 1. The default
503+value is 0 (disabled).
504+
505+@end table
506+
444507 @c man end AUDIO ENCODERS
445508
446509 @chapter Video Encoders

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t