summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul B Mahol <onemda@gmail.com>2019-10-23 20:43:26 +0200
committerPaul B Mahol <onemda@gmail.com>2020-01-30 16:35:33 +0100
commit863accbefa2b433adbdfe189438adb11abc276c6 (patch)
treead326ef97734a2e5c7ddfbc9674579e3902d3307 /doc
parent6087692a60699a5eac5b061dd458e5a856e0662f (diff)
avfilter: add xfade filter
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi80
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 3f40af8439..412894f1be 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -20033,6 +20033,86 @@ If number of inputs is even number, than result will be mean value between two m
Set which planes to filter. Default value is @code{15}, by which all planes are processed.
@end table
+@section xfade
+
+Apply cross fade from one input video stream to another input video stream.
+The cross fade is applied for specified duration.
+
+The filter accepts the following options:
+
+@table @option
+@item transition
+Set one of available transition effects:
+
+@table @samp
+@item custom
+@item fade
+@item wipeleft
+@item wiperight
+@item wipeup
+@item wipedown
+@item slideleft
+@item slideright
+@item slideup
+@item slidedown
+@item circlecrop
+@item rectcrop
+@item distance
+@item fadeblack
+@item fadewhite
+@end table
+Default transition effect is fade.
+
+@item duration
+Set cross fade duration in seconds.
+Default duration is 1 second.
+
+@item offset
+Set cross fade start relative to first input stream.
+Default offset it 0.
+
+@item expr
+Set expression for custom transition effect.
+
+The expressions can use the following variables and functions:
+
+@table @option
+@item X
+@item Y
+The coordinates of the current sample.
+
+@item W
+@item H
+The width and height of the image.
+
+@item P
+Progress of transition effect.
+
+@item PLANE
+Currently processed plane.
+
+@item A
+Return value of first input at current location and plane.
+
+@item B
+Return value of second input at current location and plane.
+
+@item a0(x, y)
+@item a1(x, y)
+@item a2(x, y)
+@item a3(x, y)
+Return the value of the pixel at location (@var{x},@var{y}) of the
+first/second/third/fourth component of first input.
+
+@item b0(x, y)
+@item b1(x, y)
+@item b2(x, y)
+@item b3(x, y)
+Return the value of the pixel at location (@var{x},@var{y}) of the
+first/second/third/fourth component of second input.
+@end table
+@end table
+
@section xstack
Stack video inputs into custom layout.