kiteffmpeg/io.github.yuroyami.kiteffmpeg/DolbyVisionMetadata

DolbyVisionMetadata

data class DolbyVisionMetadata(val baseLayerBitDepth: Int, val usesEnhancementLayer: Boolean, val sourceMinPq: Int, val sourceMaxPq: Int, val sceneBrightness: DolbyVisionBrightness?)

The Dolby Vision metadata of one decoded frame, read from the RPU that FFmpeg's decoder parsed and attached to it.

Brightness is given as FFmpeg gives it, as a 12-bit PQ code from 0 to 4095, which is how Dolby Vision writes it. nitsOfPq turns a code into candelas per square metre.

Constructors

DolbyVisionMetadata

constructor(baseLayerBitDepth: Int, usesEnhancementLayer: Boolean, sourceMinPq: Int, sourceMaxPq: Int, sceneBrightness: DolbyVisionBrightness?)

Types

Companion

object Companion

Properties

baseLayerBitDepth

val baseLayerBitDepth: Int

The bit depth of the base layer the RPU's reshaping curves were written for.

sceneBrightness

val sceneBrightness: DolbyVisionBrightness?

The brightness of the frame's scene, the RPU's level 1 metadata, or null when the frame carries none. Built against an FFmpeg older than 7.1 it is always null, because FFmpeg exports the RPU's extension blocks from 7.1 on.

sourceMaxPq

val sourceMaxPq: Int

The brightest level the content was graded for, as a PQ code.

sourceMinPq

val sourceMinPq: Int

The darkest level the content was graded for, as a PQ code.

usesEnhancementLayer

val usesEnhancementLayer: Boolean

Whether the frame's composition adds a residual from an enhancement layer, as a profile 7 stream with a full enhancement layer does. FFmpeg does not decode that layer, so a composition of such a frame is the base layer's part of the picture only.