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

[James Almer]

On 19/05/15 9:31 PM, Michael Niedermayer wrote:
> If someone wants to cleanup spelling and grammer and push this, do not
> hesitate!
> I just wanted to document the 2 newly added options and then realized
> that flac enc is missig from the docs ...
> 
> Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
> ---
>  doc/encoders.texi |   76 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 76 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index a6cdd99..d147f10 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -494,6 +494,82 @@ Selected by Encoder (default)
>  
>  @end table
>  
> + at anchor{flac}
> + at section flac
> +
> +FLAC (Free Lossless Audio Codec) Encoder
> +
> + at subsection Options
> +
> +The following options are supported by FFmpegs flac encoder.

FFmpeg's.

> +
> + at table @option
> + at item compression_level
> +Sets the compression level, which chooses defaults for many other options
> +if they are not set explicitly.
> +
> + at item frame_size
> +Sets the size of the frames in samples per channel.
> +
> + at item lpc_coeff_precision
> +Sets the LPC coefficient precission, valid values are from 1 to 15, 15 is the

Precision.

> +default.
> +
> + at item lpc_type
> +Sets the first stage LPC algorithm
> + at table @samp
> + at item none
> +LPC is not used
> +
> + at item fixed
> +fixed LPC coefficients
> +
> + at item levinson
> +
> + at item cholesky
> + at end table
> +
> + at item lpc_passes
> +Number of passes to use for Cholesky factorization during LPC analysis
> +
> + at item min_partition_order, max_partition_order
> +The minimum and maximum partition orders

Nit: These could be separated into two items.

> +
> + at item prediction_order_method
> + at table @samp
> + at item estimation
> + at item 2level
> + at item 4level
> + at item 8level
> + at item search
> +Bruteforce search
> + at item log
> + at end table
> +
> + at item ch_mode
> +Channel mode
> + at table @samp
> + at item auto
> +The mode is choosen automatically for each frame

Chosen.

> + at item indep
> +Channls are independantly coded

Channels, independently.

> + at item left_side
> + at item right_side
> + at item mid_side
> + at end table
> +
> + at item exact_rice_parameters
> +Chooses if rice parameters are calculated exactly or approximatly.

Approximately

> +if set to 1 then they are choosen exactly, which slows the code down slightly and

Chosen

> +improves compression slighty

slightly

> +
> + at item multi_dim_quant
> +Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is
> +applied after the first stage to finetune the coefficients. This is quite slow
> +and slightly improves compression.
> +
> + at end table
> +
>  @anchor{libfaac}
>  @section libfaac
>  
> 

LGTM spelling aside.