Package: ffmpeg-quality-metrics
FFmpeg Quality MetricsCalculate various video quality metrics with FFmpeg.Currently supports PSNR, SSIM, VMAF and VIF. It will output:the per-frame metricsmetrics for each plane (Y, U, V) or components/submetrics (in the case of VIF, VMAF)global statistics (min/max/average/standard deviation)Author: Werner Robitzawerner.robitza@gmail.comNote:Previous versions installed affmpeg_quality_metricsexecutable. To harmonize it with other tools, now the executable is calledffmpeg-quality-metrics. Please ensure you remove the old executable (e.g. runwhich ffmpeg_quality_metricsand remove the file).Contents:RequirementsInstallationUsageMetricsExtended OptionsVMAF-specific SettingsExamplesRunning with DockerOutputJSON OutputCSV OutputAPIContributorsLicenseRequirementsWhat you need:OS: Linux, macOS, WindowsPython 3.8 or higherFFmpeg:Linux:Download the git master build fromhere. Installation instructions, as well as how to add FFmpeg and FFprobe to your PATH, can be foundhere.macOS:Download thesnapshotbuild fromhereor install viabrew install ffmpeg.Windows:Download an FFmpeg binary fromhere. Thegit essentialsbuild will suffice.Put theffmpegexecutable in your$PATH.If you want to calculate VMAF, your ffmpeg build should includelibvmaf 2.3.1or higher. This is the case with the static builds listed above or the Homebrewffmpegv5.1 package.InstallationUsing pip:pip3installffmpeg-quality-metricsOr clone this repository, then run the tool withpython3 -m ffmpeg_quality_metrics.UsageIn the simplest case, if you have a distorted (encoded, maybe scaled) version and the reference:ffmpeg-quality-metrics distorted.mp4 reference.aviThe distorted file will be automatically scaled to the resolution of the reference, and the default metrics (PSNR, SSIM) will be computed.Note that if your distorted file is not in time sync with the reference, you can use the--dist-delayoption to delay the distorted file by a certain amount of seconds (positive or negative).MetricsThe following metrics are available in this tool:MetricDescriptionScaleComponents/SubmetricsCalculated by default?PSNRPeak Signal to Noise RatiodBmse_avg,mse_y,mse_u,mse_v,psnr_avg,psnr_y,psnr_u,psnr_v✔️SSIMStructural Similarity0-100 (higher is better)ssim_y,ssim_u,ssim_v,ssim_avg✔️VMAFVideo Multi-Method Assessment Fusion0-100 (higher is better)vmaf,integer_adm2,integer_adm_scale0,integer_adm_scale1,integer_adm_scale2,integer_adm_scale3,integer_motion2,integer_motion,integer_vif_scale0,integer_vif_scale1,integer_vif_scale2,integer_vif_scale3NoVIFVisual Information Fidelity0-100 (higher is better)scale_0,scale_1,scale_2,scale_3NoAs shown in the table, every metric can have more than one submetric computed, and they will be printed in the output.If you want to calculate additional metrics, enable them with the--metricsoption:ffmpeg-quality-metrics distorted.mp4 reference.avi --metrics psnr ssim vmafSpecify multiple metrics by separating them with a space (e.g., in the above example,psnr ssim vmaf).Here, VMAF uses the default model. You can specify a different model with the--vmaf-modeloption. VMAF also allows you to calculate evenmore additional featuresas submetrics. You can enable these with the--vmaf-featuresoption.Extended OptionsYou can configure additional options related to scaling, speed etc.Seeffmpeg-quality-metrics -h:usage: ffmpeg-quality-metrics [-h] [-n] [-v] [-p] [-k] [--tmp-dir TMP_DIR]
                              [-m {vmaf,psnr,ssim,vif} [{vmaf,psnr,ssim,vif} ...]]
                              [-s {fast_bilinear,bilinear,bicubic,experimental,neighbor,area,bicublin,gauss,sinc,lanczos,spline}]
                              [-r FRAMERATE] [--dist-delay DIST_DELAY] [-t THREADS] [-of {json,csv}]
                              [--vmaf-model-path VMAF_MODEL_PATH]
                              [--vmaf-model-params VMAF_MODEL_PARAMS [VMAF_MODEL_PARAMS ...]]
                              [--vmaf-threads VMAF_THREADS] [--vmaf-subsample VMAF_SUBSAMPLE]
                              [--vmaf-features VMAF_FEATURES [VMAF_FEATURES ...]]
                              dist ref

ffmpeg-quality-metrics v3.2.1

positional arguments:
  dist                                  input file, distorted
  ref                                   input file, reference

options:
  -h, --help                            show this help message and exit

General options:
  -n, --dry-run                         Do not run commands, just show what would be done (default:
                                        False)
  -v, --verbose                         Show verbose output (default: False)
  -p, --progress                        Show a progress bar (default: False)
  -k, --keep-tmp                        Keep temporary files for debugging purposes (default: False)
  --tmp-dir TMP_DIR                     Directory to store temporary files in (will use system
                                        default if not specified) (default: None)

Metric options:
  -m {vmaf,psnr,ssim,vif} [{vmaf,psnr,ssim,vif} ...], --metrics {vmaf,psnr,ssim,vif} [{vmaf,psnr,ssim,vif} ...]
                                        Metrics to calculate. Specify multiple metrics like '--
                                        metrics ssim vmaf' (default: ['psnr', 'ssim'])

FFmpeg options:
  -s {fast_bilinear,bilinear,bicubic,experimental,neighbor,area,bicublin,gauss,sinc,lanczos,spline}, --scaling-algorithm {fast_bilinear,bilinear,bicubic,experimental,neighbor,area,bicublin,gauss,sinc,lanczos,spline}
                                        Scaling algorithm for ffmpeg (default: bicubic)
  -r FRAMERATE, --framerate FRAMERATE   Force an input framerate (default: None)
  --dist-delay DIST_DELAY               Delay the distorted video against the reference by this many
                                        seconds (default: 0.0)
  -t THREADS, --threads THREADS         Number of threads to do the calculations (default: 0)

Output options:
  -of {json,csv}, --output-format {json,csv}
                                        Output format for the metrics (default: json)

VMAF options:
  --vmaf-model-path VMAF_MODEL_PATH     Use a specific VMAF model file. If none is chosen, picks a
                                        default model. You can also specify one of the following
                                        built-in models: ['vmaf_v0.6.1.json', 'vmaf_4k_v0.6.1.json',
                                        'vmaf_v0.6.1neg.json'] (default: /opt/homebrew/opt/libvmaf/s
                                        hare/libvmaf/model/vmaf_v0.6.1.json)
  --vmaf-model-params VMAF_MODEL_PARAMS [VMAF_MODEL_PARAMS ...]
                                        A list of params to pass to the VMAF model, specified as
                                        key=value. Specify multiple params like '--vmaf-model-params
                                        enable_transform=true enable_conf_interval=true' (default:
                                        None)
  --vmaf-threads VMAF_THREADS           Set the value of libvmaf's n_threads option. This determines
                                        the number of threads that are used for VMAF calculation.
                                        Set to 0 for auto. (default: 0)
  --vmaf-subsample VMAF_SUBSAMPLE       Set the value of libvmaf's n_subsample option. This is the
                                        subsampling interval, so set to 1 for default behavior.
                                        (default: 1)
  --vmaf-features VMAF_FEATURES [VMAF_FEATURES ...]
                                        A list of feature to enable. Pass the names of the features
                                        and any optional params. See https://github.com/Netflix/vmaf
                                        /blob/master/resource/doc/features.md for a list of
                                        available features. Params must be specified as 'key=value'.
                                        Multiple params must be separated by ':'. Specify multiple
                                        features like '--vmaf-features cambi:full_ref=true ciede'
                                        (default: None)VMAF-specific SettingsAs VMAF is more complex than the other metrics, it has a few more options.Specifying VMAF ModelUse the--vmaf-model-pathoption to set the path to a different VMAF model file. The default isvmaf_v0.6.1.json.libvmafversion 2.x supports JSON-based model files only. This program has built-in support for the following models:vmaf_v0.6.1.json
vmaf_4k_v0.6.1.json
vmaf_v0.6.1neg.jsonUse the4kversion if you have a 4K reference sample. Thenegversionis explained here.You can either specify an absolute path to an existing model, e.g.:/usr/local/opt/libvmaf/share/model/vmaf_v0.6.1neg.jsonOr pass the file name to the built-in model. So all of these work:# use a downloaded JSON model for libvmaf 2.xffmpeg-quality-metricsdist.mkvref.mkv-mvmaf--vmaf-model-pathvmaf_v0.6.1neg.json# use a different path for models on your systemffmpeg-quality-metricsdist.mkvref.mkv-mvmaf--vmaf-model-path/usr/local/opt/libvmaf/share/model/vmaf_v0.6.1neg.jsonSpecifying VMAF FeaturesVMAF includes several metrics, each of which correspond to a feature name. By default, only three core features are used. Use the--vmaf-featuresoption to enable additional features on top of the core features.The following table shows the available features:MetricFeature nameCore feature in VMAF?PSNRpsnrPSNR-HVSpsnr_hvsCIEDE2000ciedeCAMBIcambiVIFvif✔️ADMadm✔️Motionmotion✔️SSIMfloat_ssimMS-SSIMfloat_ms_ssimTo find out more about the features, check out theVMAF documentation.For example, to enable the CAMBI feature, use:ffmpeg-quality-metricsdist.mkvref.mkv-mvmaf--vmaf-featurescambiVMAF Feature ParametersSome features additionally take a number of optional parameters. The following table shows the available parameters for each feature:FeatureParameterDefaultDescriptionadmadm_csf_mode0Contrast sensitivity functionadmadm_enhn_gain_limit100.0Enhancement gain imposed on adm, must be >= 1.0, where 1.0 means the gain is completely disabledadmadm_norm_view_dist3.0Normalized viewing distance = viewing distance / ref display's physical heightadmadm_ref_display_height1080Reference display height in pixelsadmdebugfalseDebug mode: enable additional outputcambienc_bitdepthEncoding bitdepth.cambienc_heightEncoding height.cambienc_widthEncoding width.cambieotfbt1886Determines the EOTF used to compute the visibility thresholds.cambifull_reffalseSet totrueto enable full-reference CAMBI calculation.cambiheatmaps_pathSet to a target folder where the CAMBI heatmaps will be stored as.grayfilescambimax_log_contrast2Maximum contrast in log luma level (2^max_log_contrast) at 10-bits.cambisrc_heightSource height. Only used when full_ref=true.cambisrc_widthSource width. Only used when full_ref=true.cambitopk0.2Ratio of pixels for the spatial pooling computation.cambitvi_threshold0.75Visibility threshold for luminance ΔL < tvi_threshold*L_mean.cambiwindow_size63Window size to compute CAMBI: 63 corresponds to ~1 degree at 4k.motiondebugtrueEnable additional output for debugging.motionmotion_force_zerofalseForce the motion score to be zero. This parameter is a feature-specific parameter.ms_ssimclip_dbfalseClip dB scoresms_ssimenable_dbfalseWrite MS-SSIM values as dBms_ssimenable_lcsfalseEnable luminance, contrast and structure intermediate outputssimclip_dbfalseClip dB scoresssimenable_dbfalseWrite SSIM values as dBssimenable_lcsfalseEnable luminance, contrast and structure intermediate outputvifdebugfalseDebug mode: enable additional outputvifvif_enhn_gain_limit100.0Enhancement gain imposed on vif, must be >= 1.0, where 1.0 means the gain is completely disabledvifvif_kernelscale1.0Scaling factor for the gaussian kernel (2.0 means multiplying the standard deviation by 2 and enlarge the kernel size accordingly)The parameters are specified askey=valuepairs, separated by:. For example, to enable the full-reference CAMBI calculation, use:ffmpeg-quality-metricsdist.mkvref.mkv-mvmaf--vmaf-featurescambi:full_ref=trueTo generate the CAMBI heatmaps, use:ffmpeg-quality-metricsdist.mkvref.mkv-mvmaf--vmaf-featurescambi:heatmaps_path=/tmp/cambiExamplesRun PSNR, SSIM, VMAF and VIF at the same time:ffmpeg-quality-metricsdist.mkvref.mkv\-mpsnrssimvmafvifRun VMAF with all the features:ffmpeg-quality-metricsdist.mkvref.mkv\-mvmaf\--vmaf-featuresciedecambipsnrpsnr_hvsmotionadmvifEnable feature options for CAMBI full-reference calculation:ffmpeg-quality-metricsdist.mkvref.mkv\-mvmaf\--vmaf-featurescambi:full_ref=trueRunning with DockerIf you don't want to deal with dependencies, build the image with Docker:docker build -t ffmpeg-quality-metrics .This takes a few minutes and installs the latestffmpegas a static build.You can then run the container, which basically calls the Python script. To help you with mounting the volumes (since your videos are not stored in the container), you can run a helper script:./docker_run.sh<dist><ref>[OPTIONS]Check the output of./docker_run.shfor more help.For example, to run the tool with the bundled test videos and enable VMAF calculation:./docker_run.shtest/dist-854x480.mkvtest/ref-1280x720.mkv-mvmafOutputThis tool supports JSON or CSV output, including individual fields for planes/components/submetrics, and global statistics, as well as frame numbers (n).JSON OutputThe JSON output will include a key for each metric, and the value will be a list of values for each frame. Each frame is a dictionary with individual metrics per frame.For instance, PSNR and SSIM output averages as well as per-component metrics. VMAF outputs different metrics depending on the enabled features.Theglobalkey contains global statistics for each metric and its submetrics.See theexample.jsonfile for an example of the output.CSV OutputCSV output is using thetidy dataprinciple, using one column per feature and one line per frame (observation).Example:n,adm2,motion2,ms_ssim,psnr,ssim,vif_scale0,vif_scale1,vif_scale2,vif_scale3,vmaf,mse_avg,mse_u,mse_v,mse_y,psnr_avg,psnr_u,psnr_v,psnr_y,ssim_avg,ssim_u,ssim_v,ssim_y,input_file_dist,input_file_ref
1,0.70704,0.0,0.89698,18.58731,0.92415,0.53962,0.71805,0.75205,0.77367,15.44212,536.71,234.48,475.43,900.22,20.83,24.43,21.36,18.59,0.945,0.96,0.942,0.934,test/dist-854x480.mkv,test/ref-1280x720.mkv
2,0.7064,0.35975,0.89806,18.60299,0.9247,0.54025,0.71961,0.75369,0.77607,15.85038,535.29,239.4,469.49,896.98,20.84,24.34,21.41,18.6,0.946,0.96,0.943,0.934,test/dist-854x480.mkv,test/ref-1280x720.mkv
3,0.70505,0.35975,0.89879,18.6131,0.92466,0.5391,0.71869,0.75344,0.77616,15.63546,535.04,245.8,464.43,894.89,20.85,24.22,21.46,18.61,0.945,0.959,0.943,0.934,test/dist-854x480.mkv,test/ref-1280x720.mkvAs there is no tidy way to represent global data in the same CSV file, you can use other tools to aggregate the data.APIThe program exposes an API that you can use yourself:fromffmpeg_quality_metricsimportFfmpegQualityMetricsffqm=FfmpegQualityMetrics("path/to/reference-video.mp4","path/to/distorted-video.mp4")metrics=ffqm.calculate(["ssim","psnr"])# check the available metricsprint(metrics.keys())# ['ssim', 'psnr']# get the SSIM values for the first frameprint(metrics["ssim"][0])# {'n': 1, 'ssim_y': 0.934, 'ssim_u': 0.96, 'ssim_v': 0.942, 'ssim_avg': 0.945}# average the ssim_y values over all framesprint(sum([frame["ssim_y"]forframeinmetrics["ssim"]])/len(metrics["ssim"]))# or just get the global statsprint(ffqm.get_global_stats()["ssim"]["ssim_y"]["average"])For more usage please readthe docs.ContributorsOrkun Koçyiğit💻Hamas Shafiq💻Chris Griffith💻Ignacio Peletier💻Nav🐛Licenseffmpeg-quality-metrics, Copyright (c) 2019-2023 Werner RobitzaPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.For VMAF models, seeffmpeg_quality_metrics/vmaf_models/LICENSE.