Browse code

doc/filters: document framesync options.

Nicolas George authored on 2017/08/10 20:32:19
Showing 2 changed files
... ...
@@ -35,6 +35,9 @@ version <next>:
35 35
 - pseudocolor video filter
36 36
 - raw G.726 muxer and demuxer, left- and right-justified
37 37
 - NewTek NDI input/output device
38
+- Some video filters with several inputs now use a common set of options:
39
+  blend, libvmaf, lut3d, overlay, psnr, ssim.
40
+  They must always be used by name.
38 41
 
39 42
 version 3.3:
40 43
 - CrystalHD decoder moved to new decode API
... ...
@@ -311,6 +311,39 @@ See @code{ffmpeg -filters} to view which filters have timeline support.
311 311
 
312 312
 @c man end FILTERGRAPH DESCRIPTION
313 313
 
314
+@anchor{framesync}
315
+@chapter Options for filters with several inputs (framesync)
316
+@c man begin OPTIONS FOR FILTERS WITH SEVERAL INPUTS
317
+
318
+Some filters with several inputs support a common set of options.
319
+These options can only be set by name, not with the short notation.
320
+
321
+@table @option
322
+@item eof_action
323
+The action to take when EOF is encountered on the secondary input; it accepts
324
+one of the following values:
325
+
326
+@table @option
327
+@item repeat
328
+Repeat the last frame (the default).
329
+@item endall
330
+End both streams.
331
+@item pass
332
+Pass the main input through.
333
+@end table
334
+
335
+@item shortest
336
+If set to 1, force the output to terminate when the shortest input
337
+terminates. Default value is 0.
338
+
339
+@item repeatlast
340
+If set to 1, force the filter to draw the last overlay frame over the
341
+main input until the end of the stream. A value of 0 disables this
342
+behavior. Default value is 1.
343
+@end table
344
+
345
+@c man end OPTIONS FOR FILTERS WITH SEVERAL INPUTS
346
+
314 347
 @chapter Audio Filters
315 348
 @c man begin AUDIO FILTERS
316 349
 
... ...
@@ -4949,17 +4982,10 @@ Value of pixel component at current location for first video frame (top layer).
4949 4949
 @item BOTTOM, B
4950 4950
 Value of pixel component at current location for second video frame (bottom layer).
4951 4951
 @end table
4952
-
4953
-@item shortest
4954
-Force termination when the shortest input terminates. Default is
4955
-@code{0}. This option is only defined for the @code{blend} filter.
4956
-
4957
-@item repeatlast
4958
-Continue applying the last bottom frame after the end of the stream. A value of
4959
-@code{0} disable the filter after the last frame of the bottom layer is reached.
4960
-Default is @code{1}. This option is only defined for the @code{blend} filter.
4961 4952
 @end table
4962 4953
 
4954
+The @code{blend} filter also supports the @ref{framesync} options.
4955
+
4963 4956
 @subsection Examples
4964 4957
 
4965 4958
 @itemize
... ...
@@ -9757,6 +9783,8 @@ Enables computing ms_ssim along with vmaf.
9757 9757
 Set the pool method to be used for computing vmaf.
9758 9758
 @end table
9759 9759
 
9760
+This filter also supports the @ref{framesync} options.
9761
+
9760 9762
 For example:
9761 9763
 @example
9762 9764
 ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
... ...
@@ -9838,6 +9866,8 @@ Interpolate values using a tetrahedron.
9838 9838
 @end table
9839 9839
 @end table
9840 9840
 
9841
+This filter also supports the @ref{framesync} options.
9842
+
9841 9843
 @section lumakey
9842 9844
 
9843 9845
 Turn certain luma values into transparency.
... ...
@@ -10866,19 +10896,6 @@ on the main video. Default value is "0" for both expressions. In case
10866 10866
 the expression is invalid, it is set to a huge value (meaning that the
10867 10867
 overlay will not be displayed within the output visible area).
10868 10868
 
10869
-@item eof_action
10870
-The action to take when EOF is encountered on the secondary input; it accepts
10871
-one of the following values:
10872
-
10873
-@table @option
10874
-@item repeat
10875
-Repeat the last frame (the default).
10876
-@item endall
10877
-End both streams.
10878
-@item pass
10879
-Pass the main input through.
10880
-@end table
10881
-
10882 10869
 @item eval
10883 10870
 Set when the expressions for @option{x}, and @option{y} are evaluated.
10884 10871
 
... ...
@@ -10894,10 +10911,6 @@ evaluate expressions for each incoming frame
10894 10894
 
10895 10895
 Default value is @samp{frame}.
10896 10896
 
10897
-@item shortest
10898
-If set to 1, force the output to terminate when the shortest input
10899
-terminates. Default value is 0.
10900
-
10901 10897
 @item format
10902 10898
 Set the format for the output video.
10903 10899
 
... ...
@@ -10923,11 +10936,6 @@ automatically pick format
10923 10923
 @end table
10924 10924
 
10925 10925
 Default value is @samp{yuv420}.
10926
-
10927
-@item repeatlast
10928
-If set to 1, force the filter to draw the last overlay frame over the
10929
-main input until the end of the stream. A value of 0 disables this
10930
-behavior. Default value is 1.
10931 10926
 @end table
10932 10927
 
10933 10928
 The @option{x}, and @option{y} expressions can contain the following
... ...
@@ -10964,6 +10972,8 @@ The timestamp, expressed in seconds. It's NAN if the input timestamp is unknown.
10964 10964
 
10965 10965
 @end table
10966 10966
 
10967
+This filter also supports the @ref{framesync} options.
10968
+
10967 10969
 Note that the @var{n}, @var{pos}, @var{t} variables are available only
10968 10970
 when evaluation is done @emph{per frame}, and will evaluate to NAN
10969 10971
 when @option{eval} is set to @samp{init}.
... ...
@@ -11902,6 +11912,8 @@ Requires stats_version >= 2. If this is set and stats_version < 2,
11902 11902
 the filter will return an error.
11903 11903
 @end table
11904 11904
 
11905
+This filter also supports the @ref{framesync} options.
11906
+
11905 11907
 The file printed if @var{stats_file} is selected, contains a sequence of
11906 11908
 key/value pairs of the form @var{key}:@var{value} for each compared
11907 11909
 couple of frames.
... ...
@@ -13655,6 +13667,8 @@ SSIM of the compared frames for the whole frame.
13655 13655
 Same as above but in dB representation.
13656 13656
 @end table
13657 13657
 
13658
+This filter also supports the @ref{framesync} options.
13659
+
13658 13660
 For example:
13659 13661
 @example
13660 13662
 movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];