summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorXuewei Meng <xwmeng96@gmail.com>2021-06-14 10:08:01 +0800
committerSteven Liu <liuqi05@kuaishou.com>2021-06-29 16:05:31 +0800
commit9ca88b3befef5608dd2a58d08f3aabcd0b475f95 (patch)
treeff2ded849beac9dec4a959246c8600e46d196150 /doc
parent49e3a8165c940b0e4b6c39b2e316065c56084fea (diff)
avfilter/vf_guided: support single input
Support single input for guided filter by adding guidance mode. If the guidance mode is off, single input is required. And edge-preserving smoothing is conducted. If the mode is on, two inputs are needed. The second input serves as the guidance. For this mode, more tasks are supported, such as detail enhancement, dehazing and so on. Signed-off-by: Xuewei Meng <xwmeng96@gmail.com> Reviewed-by: Steven Liu <lq@chinaffmpeg.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index bbd0a3d14d..67ad228d8b 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -12995,8 +12995,6 @@ greyedge=difford=1:minknorm=0:sigma=2
@section guided
Apply guided filter for edge-preserving smoothing, dehazing and so on.
-This filter requires two inputs of same resolution and pixel format.
-The second input serves as the reference.
The filter accepts the following options:
@table @option
@@ -13017,6 +13015,12 @@ Set subsampling ratio for @code{fast} mode.
Range is 2 to 64. Default is 4.
No subsampling occurs in @code{basic} mode.
+@item guidance
+Set guidance mode. Can be @code{off} or @code{on}. Default is @code{off}.
+If @code{off}, single input is required.
+If @code{on}, two inputs of the same resolution and pixel format are required.
+The second input serves as the guidance.
+
@item planes
Set planes to filter. Default is first only.
@end table
@@ -13029,7 +13033,7 @@ This filter supports the all above options as @ref{commands}.
@item
Edge-preserving smoothing with guided filter:
@example
-ffmpeg -i in.png -i in.png -filter_complex guided out.png
+ffmpeg -i in.png -vf guided out.png
@end example
@item
@@ -13037,7 +13041,7 @@ Dehazing, structure-transferring filtering, detail enhancement with guided filte
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
+ffmpeg -i in.png -i guidance.png -filter_complex guided=guidance=on out.png
@end example
@end itemize