[FFmpeg-devel] [PATCH] doc/filters: apply various general fixes to vidstabdetect docs

[Clément Bœsch]

On Thu, Apr 25, 2013 at 12:02:05PM +0200, Stefano Sabatini wrote:
> Adopt generally used conventions, extend and clarify explanations.
> 
> stepsize and micontrast options need to be better explained.
> ---
>  doc/filters.texi |   69 +++++++++++++++++++++++++++---------------------------
>  1 file changed, 35 insertions(+), 34 deletions(-)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 9456aa4..40c5875 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -6221,11 +6221,12 @@ unsharp=7:7:-2:7:7:-2
>  @anchor{vidstabdetect}
>  @section vidstabdetect
>  
> -Video stabilization/deshaking: pass 1 of 2, see @ref{vidstabtransform}
> -for pass 2.
> +Analyze video stabilization/deshaking. Perform pass 1 of 2, see
> + at ref{vidstabtransform} for pass 2.
>  
> -Generates a file with relative transform information translation,
> -rotation about subsequent frames.
> +This filter generates a file with relative translation and rotation
> +transform information about subsequent frames, which is then used by
> +the @ref{vidstabtransform} filter.
>  
>  To enable compilation of this filter you need to configure FFmpeg with
>  @code{--enable-libvidstab}.
> @@ -6234,69 +6235,69 @@ This filter accepts the following options:
>  
>  @table @option
>  @item result
> -path to the file used to write the transforms (default:@file{transforms.trf})
> +Set the path to the file used to write the transforms information,
> +default is @file{transforms.trf}.
>  
>  @item shakiness
> -how shaky is the video and how quick is the camera? (default: 5)
> - at table @samp
> - at item 1
> - little (fast)
> - at item ...
> - at item 10
> - very strong/quick (slow)
> - at end table

> +Set how shaky the video is and how quick the camera is. It accepts in

It accepts *an*

> +integer in the range 1-10, a value of 1 means little shakyness, a
> +value of 10 means strong shakyness. Default value is 5.
>  

shakiness* ?

>  @item accuracy
> -accuracy of detection process (>=shakiness) (default: 9)
> - at table @samp
> - at item 1
> - low (fast)
> - at item 15
> - high (slow)
> - at end table
> +Set the accuracy of the detection process. It must be a value in the
> +range 1-15. A value of 1 means low accuracy, a value of 15 means high
> +accuracy. Default value is 9.
>  
>  @item stepsize
> -stepsize of search process, region around minimum is scanned with 1 pixel
> -resolution (default: 6)
> +Set stepsize of the search process. The region around minimum is
> +scanned with 1 pixel resolution. Default value is 6.
>  
>  @item mincontrast
> -below this contrast a local measurement field is discarded (0-1) (default: 0.3)
> +Set minimum contrast. Below this value a local measurement field is

> +discarded. Must be a floating point value in the range [0-1]. Default

In the documentation of the filter ranges seem to be written differently;
some consistency between them wouldn't hurt.

[...]
>  @item
> -visualize some internals in the resulting video
> +Visualize the result of internal transformations in the resulting
> +video:
>  @example
>  vidstabdetect=show=1
>  @end example
>  
>  @item
> -Typical call with visualization

> +Use @command{ffmpeg} to analyze a video with medium shakiness:

"Analyze a video with medium shakiness using @command{ffmpeg}:" sounds
better to me

>  @example
>  ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
>  @end example

LGTM otherwise, feel free to push.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130427/a6463dd6/attachment.asc>