aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-04-08 12:22:48 +0200
committerStefano Sabatini <stefasab@gmail.com>2013-04-10 13:11:27 +0200
commit006e20bd3655443e2d709dfbee468af2805a994a (patch)
treeb5528eebdf3d61a5fc236b56ec22716c7be401d5 /doc
parentcc3edd99a678b9ecfe70cb3632029cb8db40e7f9 (diff)
downloadffmpeg-006e20bd3655443e2d709dfbee468af2805a994a.tar.gz
lavfi/overlay: add enable expression
This expression is useful to enable/disable overlaying on the fly. Note that this can't be easily done relying on the filtergraph structure, since this implies caching issues or a null frame overlaying in the best case, which is better avoided for performance and convenience reasons.
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 4668b7fc53..215e4387a2 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -4267,8 +4267,14 @@ on the main video. Default value is "0" for both expressions. In case
the expression is invalid, it is set to a huge value (meaning that the
overlay will not be displayed within the output visible area).
+@item enable
+Set the expression which enables the overlay. If the evaluation is
+different from 0, the overlay is displayed on top of the input
+frame. By default it is "1".
+
@item eval
-Set when the expressions for @option{x} and @option{y} are evaluated.
+Set when the expressions for @option{x}, @option{y}, and
+@option{enable} are evaluated.
It accepts the following values:
@table @samp
@@ -4308,8 +4314,8 @@ color space. Default value is 0. This option is deprecated, use
@option{format} instead.
@end table
-The @option{x}, and @option{y} expressions can contain the following
-parameters.
+The @option{x}, @option{y}, and @option{enable} expressions can
+contain the following parameters.
@table @option
@item main_w, W