[FFmpeg-devel] [PATCH] doc/encoders: Add libvo-amrwbenc doc

[Stefano Sabatini]

On date Monday 2013-06-10 19:45:55 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 38 ++++++++++++++++++++++++++++++++++++++
>  1 file changed, 38 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index c55ca35..09f95b8 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -525,6 +525,44 @@ Bitrate.
>  
>  @end table
>  
> + at section libvo-amrwbenc
> +
> +VisualOn Adaptive Multi-Rate Wideband encoder
> +
> +Requires the presence of the libvo-amrwbenc headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libvo-amrwbenc --enable-version3}.
> +

> +This is a mono-only encoder. Officially it only supports 16000Hz sample
> +rate, but you can override it by adding @option{strict unofficial} or
> +lower to your command line.

by setting @option{strict} to @samp{unofficial}.

This because the documentation is geared towards library as well
tool users.

> +
> + at subsection Options
> +
> + at table @option
> +
> + at item b

> +Bitrate. Only the following bitrates are supported, otherwise ffmpeg

Set bitrate in bits/s... or whatever the unit is.

> +will round to the nearest valid bitrate.
> +
> + at table @samp
> + at item 6600
> + at item 8850
> + at item 12650
> + at item 14250
> + at item 15850
> + at item 18250
> + at item 19850
> + at item 23050
> + at item 23850
> + at end table
> +
> + at item dtx
> +Allow discontinuous transmission (generate comfort noise) when set to 1. The
> +default value is 0 (disabled).
> +
> + at end table
> +
>  @c man end AUDIO ENCODERS
>  
>  @chapter Video Encoders

LGTM otherwise, thanks.
-- 
FFmpeg = Funny Frightening Miracolous Programmable Ermetic Guide