From e2b98c2dec1248f5000a9291bd6f1177de2a4d0f Mon Sep 17 00:00:00 2001 From: nilfm Date: Fri, 8 Dec 2023 14:28:12 +0000 Subject: [PATCH] doc/filters: expand documentation on libvmaf filter Signed-off-by: nilfm --- doc/filters.texi | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/doc/filters.texi b/doc/filters.texi index 6d00ba2c3f..232bd6405b 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -16929,19 +16929,33 @@ The first input is the distorted video, and the second input is the reference vi The obtained VMAF score is printed through the logging system. -It requires Netflix's vmaf library (libvmaf) as a pre-requisite. +It requires Netflix's VMAF library (libvmaf) as a pre-requisite. After installing the library it can be enabled using: @code{./configure --enable-libvmaf}. -The filter has following options: +The filter has the following options: @table @option @item model -A `|` delimited list of vmaf models. Each model can be configured with a number of parameters. +A `|` delimited list of VMAF models. Each model can be configured with the following parameters: +@table @option +@item version +Built-in model version. Example: @code{vmaf_v0.6.1}. +@item name +Name that will be associated with this model in the output logs. +@item path +Path to a model in the local filesystem. +@item enable_transform +If true, a model-defined transform will be applied to the final score. Default value: @code{false}. +@item disable_clip +If true, model-defined score clipping will be disabled. Default value: @code{false}. +@end table Default value: @code{"version=vmaf_v0.6.1"} @item feature -A `|` delimited list of features. Each feature can be configured with a number of parameters. +A `|` delimited list of features. Each feature can be configured with a number +of parameters. The parameter @code{name} should be set to the name of the +feature. Other key-value parameter pairs will be passed in to the feature extractor. @item log_path Set the file path to be used to store log files. @@ -16982,9 +16996,9 @@ ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf='model=version=vmaf_v0.6 @end example @item -Example with multiple additional features: +Example with multiple additional features and feature options: @example -ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf='feature=name=psnr|name=ciede' -f null - +ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf='feature=name=psnr\\:enable_mse=true|name=ciede' -f null - @end example @item -- 2.37.1 (Apple Git-137.1)