aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAshish Pratap Singh <ashk43712@gmail.com>2017-11-06 07:49:33 -0500
committerRonald S. Bultje <rsbultje@gmail.com>2017-11-06 07:50:34 -0500
commit7b7037e5b035d8805972982d54441663a25bb016 (patch)
tree35cfad6a662265f5824cd634bf835eab2223c9bb
parent4c38aa79ece4fa0ea7533774197d6408d7d3b9e5 (diff)
downloadffmpeg-7b7037e5b035d8805972982d54441663a25bb016.tar.gz
avfilter:vf_libvmaf: improve docs.
Signed-off-by: Ronald S. Bultje <rsbultje@gmail.com>
-rw-r--r--doc/filters.texi19
1 files changed, 6 insertions, 13 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 6f6dfcff48..2ba6e04166 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -9885,25 +9885,16 @@ distances from the focal point in the source and target images, respectively.
@section libvmaf
-Obtain the average VMAF (Video Multi-Method Assessment Fusion)
+Obtain the VMAF (Video Multi-Method Assessment Fusion)
score between two input videos.
-This filter takes two input videos.
-
-Both video inputs must have the same resolution and pixel format for
-this filter to work correctly. Also it assumes that both inputs
-have the same number of frames, which are compared one by one.
-
-The obtained average VMAF score is printed through the logging system.
+The obtained VMAF score is printed through the logging system.
It requires Netflix's vmaf library (libvmaf) as a pre-requisite.
After installing the library it can be enabled using:
@code{./configure --enable-libvmaf}.
If no model path is specified it uses the default model: @code{vmaf_v0.6.1.pkl}.
-On the below examples the input file @file{main.mpg} being processed is
-compared with the reference file @file{ref.mpg}.
-
The filter has following options:
@table @option
@@ -9934,12 +9925,14 @@ Enables computing ssim along with vmaf.
Enables computing ms_ssim along with vmaf.
@item pool
-Set the pool method to be used for computing vmaf.
+Set the pool method (mean, min or harmonic mean) to be used for computing vmaf.
@end table
This filter also supports the @ref{framesync} options.
-For example:
+On the below examples the input file @file{main.mpg} being processed is
+compared with the reference file @file{ref.mpg}.
+
@example
ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
@end example