[FFmpeg-devel] [PATCH] doc/encoders: Add all options for JPEG2000 encoder

[Gyan Doshi]

On 09-08-2020 11:13 pm, gautamramk at gmail.com wrote:
> From: Gautam Ramakrishnan <gautamramk at gmail.com>
>
> This patch updates the documentation by adding all options
> for JPEG2000 encoder.
> ---
>   doc/encoders.texi | 20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index de0472e225..aaac026709 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1369,6 +1369,26 @@ can be selected with @code{-pred 1}.
>   Can be set to either @code{j2k} or @code{jp2} (the default) that
>   makes it possible to store non-rgb pix_fmts.
>   
> + at item tile_width/tile_height
> +Allows setting of tile width and height.

Make these separate items.

> +
> + at item pred
> +Allows setting the DWT type, i.e lossy
> +DWT 97 (@code{dwt97int}) or lossless DWT 53 (@code{dwt53}).
> +
> + at item sop
> +Setting this to 1 will make the encoder to use SOP marker at the
> +start of every packet. Set to 0 by default.

Not related to this patch, but make these boolean options 
AV_OPT_TYPE_BOOL. It allows users to also set them to string values 
true/false or on/off.

> + at item eph
> +Setting this to 1 will make the encoder to use the EPH flag at the
> +end of every packet header. Set to 0 by default.
> +
> + at item prog
> +Sets the progression order to be used by the encoder.
> +Possible values are @code{lrcp}, @code{rlcp}, @code{rpcl},
> + at code{pcrl} and @code{cprl}. Set to @code{lrcp} by default.

One value per line, please. Also add option type for each option. See 
Hap encoder entry above this one. Some elaboration will be nice as well 
unless users are expected to know what the differences are between these 
values.

Thanks,
Gyan