/dovi_tool

dovi_tool is a CLI tool combining multiple utilities for working with Dolby Vision.

Primary LanguageRustMIT LicenseMIT

dovi_tool Tests Artifacts

dovi_tool is a CLI tool combining multiple utilities for working with Dolby Vision.

The dolby_vision crate is also hosted in this repo, see README for use as a Rust/C lib.

 

Toolchain

The minimum Rust version to build dovi_tool is 1.56.0.

 

Dolby Vision metadata utilities

dovi_tool provides an important set of tools for analyzing, editing and generating Dolby Vision metadata.

Commands

  • info

    Prints the parsed RPU data as JSON for a specific frame.
    Frame indices start at 0.

    • Example to get metadata for frame 124: dovi_tool info -i RPU.bin -f 123
       

  • generate

    Allows generating a binary RPU from different sources.

    From an exported CMv2.9 or CMv4.0 Dolby Vision XML metadata file

    • The binary RPU can be created with support for the following metadata levels:

      • CMv2.9: L1, L2, L5, L6
      • CMv4.0: CMv2.9 + L3, L8, L9, L10, L11

      Level 5 metadata requires both canvas-width and canvas-height to be set.

      Both per-shot and per-frame trims are supported.

    • Example: dovi_tool generate --xml dolbyvision_metadata.xml -o RPU_from_xml.bin
       

    From a generic profile 8.1 configuration JSON file
    • See documentation: generator.md or examples
    • Example: dovi_tool generate -j assets/generator_examples/default_cmv40.json -o RPU_generated.bin
       
    From an existing HDR10+ metadata JSON file

    The metadata is generated from a configuration JSON file, and the L1 metadata is derived from HDR10+ metadata.

    • The HDR10+ metadata has to contain scene information for proper scene cuts.
    • Example: dovi_tool generate -j assets/generator_examples/default_cmv40.json --hdr10plus-json hdr10plus_metadata.json -o RPU_from_hdr10plus.bin
       
    From a madVR HDR measurement file

    The metadata is generated from a configuration JSON file, and the L1 metadata is derived from the madVR measurements.
    Supports using custom targets nits from Soulnight's madMeasureHDR Optimizer, with flag --use-custom-targets.

    • Example: dovi_tool generate -j assets/generator_examples/default_cmv40.json --madvr-file madmeasure-output.bin -o RPU_from_madVR.bin
       

  • editor

    Allows editing a binary RPU according to a JSON config.
    See documentation: editor.md or examples.
    All indices start at 0, and are inclusive. For example, using "0-39" edits the first 40 frames.

    • Example: dovi_tool editor -i RPU.bin -j assets/editor_examples/mode.json -o RPU_mode2.bin
       

  • export

    Allows exporting a binary RPU file to JSON for simpler analysis.

    • Example: dovi_tool export -i RPU.bin -o RPU_export.json

 

HEVC parsing & handling

For working with an HEVC source file, there are multiple options that apply to most commands:

  • -m, --mode Sets the mode for RPU processing.
    • Default (no mode) - Copies the RPU untouched.
    • 0 - Parses the RPU, rewrites it untouched.
    • 1 - Converts the RPU to be MEL compatible.
    • 2 - Converts the RPU to be profile 8.1 compatible.
    • 3 - Converts profile 5 to 8.
  • -c, --crop Set active area offsets to 0 (meaning no letterbox bars).
  • --drop-hdr10plus Ignore HDR10+ metadata when writing the output HEVC.

Commands

  • convert

    Converts RPU within a single layer HEVC file.
    The enhancement layer can be discarded using --discard.

    Examples to convert to profile 8.1 and discard EL:

    • dovi_tool -m 2 convert --discard file.hevc
    • ffmpeg -i input.mkv -c:v copy -vbsf hevc_mp4toannexb -f hevc - | dovi_tool -m 2 convert --discard -
       

  • demux

    Rust port of yusesope's python tool. Credits goes to them.
    Demuxes single track dual layer Dolby Vision into Base layer and Enhancement layer files.
    Also can be used to remove the RPUs from an HEVC file.

    Flags:

    • --el-only Output the EL file only.

     

    Examples:

    • dovi_tool demux file.hevc
    • ffmpeg -i input.mkv -c:v copy -vbsf hevc_mp4toannexb -f hevc - | dovi_tool demux -
    • Convert RPU to profile 8.1 while demuxing: dovi_tool -m 2 demux file.hevc
       

  • extract-rpu

    Extracts Dolby Vision RPU from an HEVC file.
    This can be either a single track (BL + RPU), single track dual layer (BL+EL+RPU) or an enhancement layer (EL+RPU) video file.

    Supports profiles 4, 5, 7, and 8.

    Examples:

    • dovi_tool extract-rpu video.hevc
    • ffmpeg -i input.mkv -c:v copy -vbsf hevc_mp4toannexb -f hevc - | dovi_tool extract-rpu - -o RPU.bin
    • FEL to MEL example: dovi_tool -m 1 extract-rpu video.hevc
       

  • inject-rpu

    Interleaves RPU NAL units between slices in an HEVC encoded bitstream.
    Global options have no effect when injecting.

    • Example: dovi_tool inject-rpu -i video.hevc --rpu-in RPU.bin -o injected_output.hevc

 

Build artifacts can be found in the Github Actions.
More features may or may not be added in the future.