summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorXuewei Meng <xwmeng96@gmail.com>2021-05-10 21:42:31 +0800
committerSteven Liu <liuqi05@kuaishou.com>2021-05-13 11:59:11 +0800
commit43d70feb788318b124418c5c666f2120ee5ca930 (patch)
tree3514a1f05abba2a701eb3b92f6bee43fa41823cd /doc
parentb5ea0980c5c78df25277f9a1baf640b60184ab61 (diff)
downloadffmpeg-43d70feb788318b124418c5c666f2120ee5ca930.tar.gz
GSoC: Support fast guided filter.
Two modes are supported in guided filter, basic mode and fast mode. Basic mode is the initial pushed guided filter without optimization. Fast mode is implemented based on the basic one by sub-sampling method. The sub-sampling ratio which can be defined by users controls the algorithm complexity. The larger the sub-sampling ratio, the lower the algorithm complexity. Signed-off-by: Xuewei Meng <xwmeng96@gmail.com> Reviewed-by: Steven Liu <liuqi05@kuaishou.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi20
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 22d02c38f7..b574334bea 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -12963,12 +12963,22 @@ Apply guided filter for edge-preserving smoothing, dehazing and so on.
The filter accepts the following options:
@table @option
@item radius
-Set the radius in pixels.
+Set the box radius in pixels.
Allowed range is 1 to 20. Default is 3.
@item eps
-Set regularization parameter.
-Allowed range is 0 to 1. Default is 0.1.
+Set regularization parameter (with square).
+Allowed range is 0 to 1. Default is 0.01.
+
+@item mode
+Set filter mode. Can be @code{basic} or @code{fast}.
+Default is @code{basic}.
+
+@item sub
+Set subsampling ratio.
+Allowed range is 1 to 64.
+Default is always 1 for @code{basic} value of @var{mode} option,
+and 4 for @code{fast} value of @var{mode} option.
@item planes
Set planes to filter. Default is first only.
@@ -12987,8 +12997,8 @@ ffmpeg -i in.png -i in.png -filter_complex guided out.png
@item
Dehazing, structure-transferring filtering, detail enhancement with guided filter.
-For the generation of guidance image,
-see @url{http://kaiminghe.com/publications/pami12guidedfilter.pdf}.
+For the generation of guidance image, refer to paper "Guided Image Filtering".
+See: @url{http://kaiminghe.com/publications/pami12guidedfilter.pdf}.
@example
ffmpeg -i in.png -i guidance.png -filter_complex guided out.png
@end example