diff options
author | Stefano Sabatini <stefasab@gmail.com> | 2011-08-13 01:08:48 +0200 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2013-02-16 00:08:31 +0100 |
commit | fbcc584d3abba475c49091ea304222a92b626026 (patch) | |
tree | affddc8c404f9b85340a0dbc5899f97bbc9bb9f5 /doc | |
parent | 5e947aeb5945efb34757103f32726041646f4a4d (diff) | |
download | ffmpeg-fbcc584d3abba475c49091ea304222a92b626026.tar.gz |
lavfi/unsharp: use named options, and add missing checks on matrix size values
In particular, avoid out-of-buffer access and crashes with too big
values, and rework documentation accordingly.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/filters.texi | 53 |
1 files changed, 24 insertions, 29 deletions
diff --git a/doc/filters.texi b/doc/filters.texi index 841d904f36..0253530ed2 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -4914,39 +4914,34 @@ transpose=1:portrait Sharpen or blur the input video. -It accepts the following parameters: +This filter accepts parameters as a list of @var{key}=@var{value} pairs, +separated by ":". + +If the key of the first options is omitted, the arguments are +interpreted according to the syntax: @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount} -Negative values for the amount will blur the input video, while positive -values will sharpen. All parameters are optional and default to the -equivalent of the string '5:5:1.0:5:5:0.0'. +A description of the accepted options follows. @table @option - -@item luma_msize_x -Set the luma matrix horizontal size. It can be an integer between 3 -and 63, default value is 5. - -@item luma_msize_y -Set the luma matrix vertical size. It can be an integer between 3 -and 63, default value is 5. - -@item luma_amount -Set the luma effect strength. It can be a float number between -2.0 -and 5.0, default value is 1.0. - -@item chroma_msize_x -Set the chroma matrix horizontal size. It can be an integer between 3 -and 63, default value is 5. - -@item chroma_msize_y -Set the chroma matrix vertical size. It can be an integer between 3 -and 63, default value is 5. - -@item chroma_amount -Set the chroma effect strength. It can be a float number between -2.0 -and 5.0, default value is 0.0. - +@item luma_msize_x, lx +@item chroma_msize_x, cx +Set the luma/chroma matrix horizontal size. It can be an integer +between 3 and 63, default value is 5. + +@item luma_msize_y, ly +@item chroma_msize_y, cy +Set the luma/chroma matrix vertical size. It can be an integer between +3 and 63, default value is 5. + +@item luma_amount, la +@item chroma_amount, ca +Set the luma/chroma effect strength. It can be a float number between +-2.0 and 5.0. Default value is 1.0 for @option{luma_amount}, 0.0 for +@option{chroma_amount}. + +Negative values will blur the input video, while positive values will +sharpen. @end table @example |