Calculate quality metrics with FFmpeg (SSIM, PSNR, VMAF)
Project description
Simple script for calculating quality metrics with FFmpeg.
Currently supports PSNR, SSIM and VMAF. It will output:
the per-frame metrics
metrics for each component (Y, U, V)
global statistics (min/max/average/standard deviation)
Author: Werner Robitza werner.robitza@gmail.com
Contents:
Requirements
Python 3.6 or higher
FFmpeg:
Put the ffmpeg executable in your $PATH.
FFmpeg can be installed using Homebrew, but it is recommended that you use one of the FFmpeg builds linked above, otherwise libvmaf <v2.0.0 will be used, which is ~2x slower (source).
Installation
pip3 install ffmpeg_quality_metrics
Or clone this repository, then run the tool with python3 -m ffmpeg_quality_metrics
Usage
In the simplest case, if you have a distorted (encoded, maybe scaled) version and the reference:
ffmpeg_quality_metrics distorted.mp4 reference.avi
The distorted file will be automatically scaled to the resolution of the reference.
Extended Options
See ffmpeg_quality_metrics -h:
usage: ffmpeg_quality_metrics [-h] [-n] [-v] [-dp] [-s {fast_bilinear,bilinear,bicubic,experimental,neighbor,area,bicublin,gauss,sinc,lanczos,spline}] [-r FRAMERATE] [-t THREADS] [-of {json,csv}] [-ev] [-m MODEL_PATH] [-p] [-nt N_THREADS] dist ref positional arguments: dist input file, distorted ref input file, reference optional arguments: -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) FFmpeg options: -dp, --disable-psnr-ssim Disable PSNR/SSIM computation. Use VMAF to get YUV estimate. (default: False) -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) -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: -ev, --enable-vmaf Enable VMAF computation; calculates VMAF as well as SSIM and PSNR (default: False) -m MODEL_PATH, --model-path 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: vmaf_v0.6.1.json) -p, --phone-model Enable VMAF phone model (default: False) -nt N_THREADS, --n-threads N_THREADS Set the value of libvmaf's n_threads option. This determines the number of threads that are used for VMAF calculation (default: number of CPUs)
Specifying VMAF Model
Use the -m/--model-path option to set the path to a different VMAF model file.
This program supplies the following models:
vmaf_4k_v0.6.1.json vmaf_v0.6.1.json vmaf_v0.6.1neg.json
You can either specify an absolute path to an existing model, e.g.:
/usr/local/opt/libvmaf/share/model/vmaf_v0.6.1neg.json
Or pass the file name to the built-in model. So both of these are equivalent:
ffmpeg_quality_metrics dist.mkv ref.mkv -m vmaf_v0.6.1neg.json ffmpeg_quality_metrics dist.mkv ref.mkv -m /usr/local/opt/libvmaf/share/model/vmaf_v0.6.1neg.json
Running with Docker
If 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 latest ffmpeg as a static build with libvmaf 2.x.
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.sh for more help.
For example, to run the tool with the bundled test videos and enable VMAF calculation:
./docker_run.sh test/dist-854x480.mkv test/ref-1280x720.mkv -ev
For Homebrew ffmpeg, a Dockerfile-legacy is provided.
Output
JSON or CSV, including individual fields for Y, U, V, and averages, as well as frame numbers.
JSON example:
➜ ffmpeg_quality_metrics test/dist-854x480.mkv test/ref-1280x720.mkv --enable-vmaf { "vmaf": [ { "adm2": 0.69908, "motion2": 0.0, "ms_ssim": 0.89698, "psnr": 18.58731, "ssim": 0.92415, "vif_scale0": 0.53962, "vif_scale1": 0.71805, "vif_scale2": 0.75205, "vif_scale3": 0.77367, "vmaf": 14.07074, "n": 1 }, { "adm2": 0.69846, "motion2": 0.35975, "ms_ssim": 0.89806, "psnr": 18.60299, "ssim": 0.9247, "vif_scale0": 0.54025, "vif_scale1": 0.71961, "vif_scale2": 0.75369, "vif_scale3": 0.77607, "vmaf": 14.48034, "n": 2 }, { "adm2": 0.69715, "motion2": 0.35975, "ms_ssim": 0.89879, "psnr": 18.6131, "ssim": 0.92466, "vif_scale0": 0.5391, "vif_scale1": 0.71869, "vif_scale2": 0.75344, "vif_scale3": 0.77616, "vmaf": 14.27326, "n": 3 } ], "psnr": [ { "n": 1, "mse_avg": 536.71, "mse_y": 900.22, "mse_u": 234.48, "mse_v": 475.43, "psnr_avg": 20.83, "psnr_y": 18.59, "psnr_u": 24.43, "psnr_v": 21.36 }, { "n": 2, "mse_avg": 535.29, "mse_y": 896.98, "mse_u": 239.4, "mse_v": 469.49, "psnr_avg": 20.84, "psnr_y": 18.6, "psnr_u": 24.34, "psnr_v": 21.41 }, { "n": 3, "mse_avg": 535.04, "mse_y": 894.89, "mse_u": 245.8, "mse_v": 464.43, "psnr_avg": 20.85, "psnr_y": 18.61, "psnr_u": 24.22, "psnr_v": 21.46 } ], "ssim": [ { "n": 1, "ssim_y": 0.934, "ssim_u": 0.96, "ssim_v": 0.942, "ssim_avg": 0.945 }, { "n": 2, "ssim_y": 0.934, "ssim_u": 0.96, "ssim_v": 0.943, "ssim_avg": 0.946 }, { "n": 3, "ssim_y": 0.934, "ssim_u": 0.959, "ssim_v": 0.943, "ssim_avg": 0.945 } ], "global": { "ssim": { "average": 0.9453333333333332, "stdev": 0.00047140452079103207, "min": 0.945, "max": 0.946 }, "psnr": { "average": 20.84, "stdev": 0.008164965809278536, "min": 20.83, "max": 20.85 }, "vmaf": { "average": 14.27478, "stdev": 0.16722195390159322, "min": 14.07074, "max": 14.48034 } }, "input_file_dist": "test/dist-854x480.mkv", "input_file_ref": "test/ref-1280x720.mkv" }
CSV example:
➜ ffmpeg_quality_metrics test/dist-854x480.mkv test/ref-1280x720.mkv --enable-vmaf -of csv 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.mkv
API
The program exposes an API that you can use yourself:
from ffmpeg_quality_metrics.ffmpeg_quality_metrics import FfmpegQualityMetrics as ffqm
ffqm("path/to/ref", "path/to/dist").calc_ssim_psnr()
For more usage please read the docs.
License
ffmpeg_quality_metrics, Copyright (c) 2019 Werner Robitza
Permission 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ffmpeg_quality_metrics-0.12.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8384c76e451aa956eec106712d97a9098d7dbef231acd9c7a1a7978ae92fa71 |
|
MD5 | 84d38d86061351fe56df5991565ab40b |
|
BLAKE2b-256 | 836826e4bf694b5d64dcd42977d677899da9f26fd6b84ee14f3ad33fc3f6a30e |
Hashes for ffmpeg_quality_metrics-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad45c5498d806acfd1917c0a32dfd157f40ae71bf1ec39f8bc5a59bb6ee06958 |
|
MD5 | 6542877d696bb1a78b51187ccd588faf |
|
BLAKE2b-256 | 68c7a434961a442b8b05baab702d4065ac57809c0537c79e125b92a590d1633d |