[FFmpeg-devel] [PATCH] doc/codecs: Add missing documentation for apply_cropping

[James Almer]

On 5/9/2017 12:23 PM, Michael Niedermayer wrote:
> Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
> ---
>  doc/codecs.texi | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/doc/codecs.texi b/doc/codecs.texi
> index 1f74c83554..1d8a4e38a4 100644
> --- a/doc/codecs.texi
> +++ b/doc/codecs.texi
> @@ -1279,6 +1279,16 @@ ffprobe -dump_separator "
>  Maximum number of pixels per image. This value can be used to avoid out of
>  memory failures due to large images.
>  
> + at item apply_cropping @var{integer} (@emph{decoding,video})

This option (as well as others like skip_alpha, or refcounted_frames
which is also missing in this file) are boolean, not int.
In practice it makes no difference i guess, since the actual
AVCodecContext fields are all int anyway, but maybe it could be
reflected here. I'm not sure if the difference between AV_OPT_TYPE_BOOL
and AV_OPT_TYPE_INT has any implications for API users, though.

> +Enable cropping if cropping parameters are a multiply of the required
> +alignment for the left and top parameters. If the alignment is not met the
> +cropping will be partially applied to maintain alignment.
> +1(Enabled) by default.
> +Note: The required alignment depends on if CODEC_FLAG_UNALIGNED is set and the
> +CPU. CODEC_FLAG_UNALIGNED cannot be chanaged from the command line. Also hw

AV_CODEC_FLAG_UNALIGNED, and "changed".

> +decoders will not apply left/top croping.

Cropping.

> +
> +
>  @end table
>  
>  @c man end CODEC OPTIONS
>