[FFmpeg-devel] [PATCH] doc/encoders: add libvorbis doc

[Timothy Gu]

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 doc/encoders.texi | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index a96c1fc..ed61516 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -771,6 +771,56 @@ respectively. The default is 0 (cutoff disabled).
 
 @end table
 
+ at section libvorbis
+
+libvorbis encoder wrapper.
+
+Requires the presence of the libvorbisenc headers and library during
+configuration. You need to explicitly configure the build with
+ at code{--enable-libvorbis}.
+
+ at subsection Options
+
+The following is an option mapping table describing options supported
+by the libvorbis wrapper, and their @command{oggenc}-equivalent
+in parentheses.
+
+To get a more accurate and extensive documentation of the libvorbis
+options, consult the libvorbisenc's and @command{oggenc}'s documentations.
+
+ at table @option
+ at item b (@emph{-b})
+Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
+expressed in kilobits/s.
+
+ at item q (@emph{-q})
+Set constant quality setting for VBR. The value should be a float
+number in the range of -1.0 to 10.0. The higher the value, the better
+the quality. The default value is @samp{3.0}.
+
+This option is valid only using the @command{ffmpeg} command-line tool.
+For library interface users, use @option{global_quality}.
+
+ at item cutoff (@emph{--advanced-encode-option lowpass_frequency=@var{N}})
+Set cutoff bandwidth in Hz. @command{oggenc}'s related option is
+expressed in kHz.The default value is @samp{0} (cutoff disabled).
+
+ at item minrate (@emph{-m})
+Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
+expressed in kilobits/s.
+
+ at item maxrate (@emph{-M})
+Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
+expressed in kilobits/s. This only has effect on ABR mode.
+
+ at item iblock (@emph{--advanced-encode-option impulse_noisetune=@var{N}})
+Set noise floor bias for impulse blocks. The value is a float number from
+-15.0 to 0.0. A negative bias instructs the encoder to pay special attention
+to the crispness of transients in the encoded audio. The tradeoff for better
+transient response is a higher bitrate.
+
+ at end table
+
 @section libwavpack
 
 A wrapper providing WavPack encoding through libwavpack.
-- 
1.8.1.2