13 May 2021

Video Quality Metrics Report

Within a <metrics_report> job request, the source asset is used as a reference file to quantitatively compare VQ using 4 industry-standard perceptual quality tools VMAF, PSNR, SSIM, and MS_SSIM for each output format. Comparing the report metrics of outputs with different codecs or encoding parameters can be an invaluable tool to help improve the playback experience. The output of this job request is an HTML report that includes comparative tables and charts for reference and analysis. Example VQ Metric Report

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required -->
    <action>AddMedia</action> <!-- required -->
    <source>[SourceURL]</source> <!-- required -->
    <metrics_report>
        <metrics>vmaf</metrics>
        <metrics>psnr</metrics>
        <metrics>ssim</metrics>
        <metrics>ms_ssim</metrics>
        <metrics>bitrate</metrics>
        <destination>[MetricsReportDestinationDir]</destination>
    </metrics_report>
    <format>
        <output>[OutputFormat]</output> <!-- required -->
        <metrics_report_sample_name>[SampleName]</metrics_report_sample_name>
        <!-- Format params -->
    </format>
    <format>
        <output>[OutputFormat]</output> <!-- required -->
        <metrics_report_sample_name>[SampleName]</metrics_report_sample_name>
        <!-- Format params -->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "AddMedia", // required
        "source": "[SourceURL]", // required
        "metrics_report": {
            "metrics": [
                "vmaf",
                "psnr",
                "ssim",
                "ms_ssim",
                "bitrate"
            ],
            "destination": "[MetricsReportDestinationDir]"
        },
        "format": [
            {
                "output": "[OutputFormat]", // required
                "metrics_report_sample_name": "[SampleName]"
                // Format params
            },
            {
                "output": "[OutputFormat]", // required
                "metrics_report_sample_name": "[SampleName]"
                // Format params
            }
        ]
    }
}

Metrics report parameters

Parameter	Description	Allowed Values
metrics	Array of metrics names	vmaf* – Video Multimethod Assessment Fusion psnr* – Peak signal-to-noise ratio ssim* – Structural similarity ms_ssim– Multiscale structural similarity bitrate*
destination	Directory where we will upload metrics reports	Valid Directory URL

🚧
For destination
The <destination /> parameter value has to be a directory because we upload multiple files to this destination.

Format parameters

Parameter	Description	Allowed Values
metrics_report_sample_name	Output sample name in the report	String

Metrics Report Statistics

Added new resource to the GetBandwidthStat response.

<?xml version="1.0"?>
<response>
    <action>getbandwidthstat</action>
    <status>Success</status>
    <result>
        <user_id><<id>></user_id>
        <date_from>[Date from]</date_from>
        <date_to>[Date to]</date_to>
        <metrics_report_out>
            <bytes>[amount in bytes]</bytes>
            <gb>[amount in gigabytes]</gb>
        </metrics_report_out>
        <cloud_metrics_report_out>
            <bytes>[amount in bytes]</bytes>
            <gb>[amount in gigabytes]</gb>
        </cloud_metrics_report_out>
        <!-- resources data -->
    </result>
</response>

{
    "response": {
        "action": "getbandwidthstat",
        "status": "Success",
        "result": {
            "user_id": "<<id>>",
            "date_from": "[Date from]",
            "date_to": "[Date to]",
            "metrics_report_out": {
                "bytes": "[amount in bytes]",
                "gb": "[amount in gigabytes]"
            },
            "cloud_metrics_report_out": {
                "bytes": "[amount in bytes]",
                "gb": "[amount in gigabytes]"
            }
            // resorces data
        }
    }
}