[FFmpeg-devel] [PATCH 1/6] doc/encoders: Add libopencore-amrnb doc

[Stefano Sabatini]

On date Saturday 2013-06-15 16:09:59 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 37 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 0245693..ea9ae0e 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -592,6 +592,43 @@ default value is 0 (disabled).
>  
>  @end table
>  
> + at section libopencore-amrnb
> +

> +OpenCORE Adaptive Multi-Rate Narrowband encoder

Missing final dot.

> +
> +Requires the presence of the libopencore-amrnb headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libopencore-amrnb --enable-version3}.
> +
> +This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
> +but you can override it by setting @option{strict} to @samp{unofficial} or
> +lower.
> +
> + at subsection Options
> +
> + at table @option
> +

> + at item b
> +Bitrate. Only the following bitrates are supported, otherwise libavcodec
> +will round to the nearest valid bitrate.

Set bitrate in bits per second (or the relevant unit).

> +
> + at table @option
> + at item 4750
> + at item 5150
> + at item 5900
> + at item 6700
> + at item 7400
> + at item 7950
> + at item 10200
> + at item 12200
> + 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

LGTM otherwise, thanks.