[FFmpeg-devel] [PATCH 1/2] docs/filters: add documentation to all existing OpenCL filters

[Gyan Doshi]

On 20-07-2018 10:01 PM, Danil Iashchenko wrote:

> + at section avgblur_opencl
> +
> +Apply average blur filter.
> +
> +The filter accepts the following options:
> +
> + at table @option
> + at item sizeX
> +Set horizontal radius size. By default value is @code{1}.

State range as well for all options, e.g.

     Range is @code{[1, 1024]} and default value is @code{1}.


> +Insert a JPG logo in the bottom left corner of the input

Shouldn't this be top-left?

> + at example
> +-i INPUT -i LOGO -filter_complex "[0:v]hwupload[a],[1:v]hwupload[b],[a][b]overlay_opencl[out],[out]hwdownload" OUTPUT

Prefer this in recommended syntax:

     "[0:v]hwupload[a];[1:v]hwupload[b];[a][b]overlay_opencl,hwdownload"

> + at section tonemap_opencl
> +Tone map colors from different dynamic ranges.
> +
> +Supported output formats: NV12/P010.
> +
> + at subsection Options
> +The filter accepts the following options.
> +
> + at table @option
> + at item tonemap
> +Set the tone map algorithm to use.
> +
> +Possible values are:
> + at table @var
> + at item none
> +Do not apply any tone map, only desaturate overbright pixels.
> +
> + at item linear
> +Stretch the entire reference gamut to a linear multiple of the display.
> +
> + at end table
> +
> +Default is none.
> +
> + at item param
> +Tune the tone mapping algorithm.
> +
> +This affects the following algorithms:
> + at table @var
> + at item none
> +Ignored.
> +
> + at item linear
> +Specifies the scale factor to use while stretching.
> +Default to 1.0.


The filer source has many more options defined.

In addition, there are many missing values for the tonemap algo; it 
appears not all are effected. If that's the case, remove or note that in 
the AVOptions table.

Please document all effective options and their values.

> +This filter does HDR(HDR10/HLG) to SDR conversion with tone-mapping with vaapi codecs.
> + at example
> +-init_hw_device vaapi=va:/dev/dri/renderD128 -init_hw_device opencl=ocl@@va -hwaccel vaapi -hwaccel_device va -hwaccel_output_format vaapi -i  INPUT -filter_hw_device ocl -filter_complex '[0:v]hwmap,tonemap_opencl=t=bt2020:tonemap=linear:format=p010[x1]  [x1]hwmap=derive_device=vaapi:reverse=1' -c:v hevc_vaapi -profile 2 OUTPUT

hwmap doc says reverse is a "dangerous" option and should be used with 
care. Can you convert this example to one which doesn't use it?

---

There are 4 whitespace errors reported when applying the mbox. Doesn't 
matter much in docs/* but do remove them during revision.

Please remember to state range/default for all options. If an option has 
an alias, mention it, like in unsharp_opencl.

Thanks,
Gyan