[FFmpeg-devel] doc/filters: document max luma and chroma matrix size

Submitted by Lou Logan on Dec. 7, 2017, 2:03 a.m.

Details

Message ID 20171207020310.3839-1-lou@lrcd.com
State New
Headers show

Commit Message

Lou Logan Dec. 7, 2017, 2:03 a.m.
Addresses ticket #6033.

Also document valid value ranges for luma_amount and chroma_amount.

Signed-off-by: Lou Logan <lou@lrcd.com>
---
 doc/filters.texi | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

Comments

Moritz Barsnick Dec. 7, 2017, 8:37 p.m.
On Wed, Dec 06, 2017 at 17:03:10 -0900, Lou Logan wrote:

> doc/filters: document max luma and chroma matrix size

You might want to mention that it's for the unsharp filter.

> +Note that the sum of @code{lx}+@code{ly} or @code{cx}+@code{cy} must
> +not exceed a value equal to or greater than 26.

"not exceed" and "greater than" - one of the terms is obsolete.

Thanks for improving the docs,
Moritz

Patch hide | download patch | download mbox

diff --git a/doc/filters.texi b/doc/filters.texi
index 0ec7d652a3..83a6823f52 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -15236,14 +15236,13 @@  Set the luma matrix vertical size. It must be an odd integer between 3
 and 23. The default value is 5.
 
 @item luma_amount, la
-Set the luma effect strength. It must be a floating point number, reasonable
-values lay between -1.5 and 1.5.
+Set the luma effect strength. It must be a floating point number between
+-2.0 and 5.0. Reasonable values lay between -1.5 and 1.5. Default value
+is 1.0.
 
 Negative values will blur the input video, while positive values will
 sharpen it, a value of zero will disable the effect.
 
-Default value is 1.0.
-
 @item chroma_msize_x, cx
 Set the chroma matrix horizontal size. It must be an odd integer
 between 3 and 23. The default value is 5.
@@ -15253,18 +15252,20 @@  Set the chroma matrix vertical size. It must be an odd integer
 between 3 and 23. The default value is 5.
 
 @item chroma_amount, ca
-Set the chroma effect strength. It must be a floating point number, reasonable
-values lay between -1.5 and 1.5.
+Set the chroma effect strength. It must be a floating point number between
+-2.0 and 5.0. Reasonable values lay between -1.5 and 1.5. Default value
+is 0.0.
 
 Negative values will blur the input video, while positive values will
 sharpen it, a value of zero will disable the effect.
 
-Default value is 0.0.
-
 @end table
 
 All parameters are optional and default to the equivalent of the
-string '5:5:1.0:5:5:0.0'.
+string @samp{5:5:1.0:5:5:0.0}.
+
+Note that the sum of @code{lx}+@code{ly} or @code{cx}+@code{cy} must
+not exceed a value equal to or greater than 26.
 
 @subsection Examples