Dolby
  • Up and Running
  • Amazon Web Services
  • Sources
  • Hybrik JSON
  • Video Filters
  • Audio Filters
  • Working with Audio
  • Task Modifiers
  • Package Task
  • Analysis & Quality Control
  • Analysis Task Overview
  • Dolby Atmos Mezzanine Analysis
  • Analysis Reports
  • Video VMAF
  • Black Video Analysis
  • Video Interlacing Analysis
  • Video Complexity Analysis
  • Video Blockiness Analysis
  • Video Compressed Stats Analysis
  • Video PSNR Analysis
  • Video SSIM Analysis
  • Video Photo-Sensitive Epilepsy Analysis
  • Audio Deep Properties Analysis
  • Audio PSNR
  • Audio Silence Analysis
  • Dolby Technologies
  • Additional Tasks
  • Hybrik Versions
  • QC Player
  • Machine Performance Analysis

    Analysis Reports

    Some Hybrik analyzers can generate a PDF report or may be able to generate their results as a machine readable json file. For example, the VMAF analysis will give you the VMAF scores in the task result JSON, but you can also output per-frame analysis results as a separate file to storage.

    NOTE: In Hybrik version 1.217, we introduced a new report version (v3.0) and a change to the structure of the analyzer results that have timed events. The new analyzer result version can be activated by setting "response_version": 2 in your analyzer's options. The default version will become version 2 in a future release. For using the new PDF generator, please use these latest versions. The sample jobs at the bottom of this page reflect these changes. If you need the documentation for the legacy version of this tutorial, please visit the legacy link.

            
    {
        "uid": "analyze_task",
        "kind": "analyze",
        "payload": {
            "options": {
                "response_version": 2 
            },
        ...
    }
    
    
    "report": {
        "create_condition": "always",
        "file_pattern": "{source_basename}_analyze_report.pdf",
        "location": {
            "storage_provider": "s3",
            "path": "{{destination_path}}"
        },
        "options": {
            "report_version": "v3.0"
        }
    }
        

    Usage

    Results from an analyzer task can be accessed in a few different ways:

    • JSON results file written to storage
    • PDF report file written to storage
    • JSON results retrieved via API
    • JSON results viewed via web console

    PDF Report Files

    Hybrik can generate PDF reports containing the results of the analyze task. Generating a report will provide the results from all analysis types in the task, with the exception of some comparative types (VMAF, SSIM, MS_SSIM). This option can be added to an Analyze task by including the following in the payload as shown below. Read our API Docs on reports for more info.

    
    {
      "uid": "analyze_task",
      "kind": "analyze",
      "payload": {
        "options": {
            "report_metadata": {
                "location": {
                    "storage_provider": "s3",
                    "path": "{{destination_path}}/hybrik_temp"
                },
                "thumbnail_width": 1024
            },
            "response_version": 2
        },
        "report": {
            "create_condition": "always",
            "file_pattern": "{source_basename}_analyze.pdf",
            "location": {
                "storage_provider": "s3",
                "path": "{{destination_path}}"
            },
            "options": {
                "report_version": "v3.0"
            }
        },
        "general_properties": {
          "enabled": true
        },
        "deep_properties": {
          "audio": [
            {
              "track_selector": {
                "index": 0
              },
              "volume": {
                "enabled": true
              }
            }
          ]
        }
      }
    }
    
    

    JSON Results File

    The comparative analysis types VMAF, SSIM and MS_SSIM have the option to generate a results file, which provides detailed data on a per-frame level, as well as calculated averages and other statistics. You can read more in our Analyze Task Documentation.

    Analyzer Results via API and web console

    The results of any analysis performed in a job can be found in the job summary json, which is available via the API or the Hybrik Web Console.

    Web Console

    Select a job on the Completed Jobs page that contains an analysis task. Click the More Actions button and then choose Export Job Summary from the drop-down options. This will automatically download the job summary json to your local system. Open the json file and search for the text analyzer to find the relevant section. There, you can scroll down to see the analysis results.

    API

    You can retrieve the job summary for a completed job using the REST API, which is explained in detail here: https://docs.hybrik.com/api/v1/HybrikAPI.html?#get-job-result

    Example Jobs

    • See the VMAF Tutorial for an example job with the analysis results JSON file
    • Example job with pdf Analysis Report