StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Property::DOVI Class Referencefinal

Dolby Vision configuration, decoded metadata and owned raw RPU bytes. More...

#include <StormByte/multimedia/property/dovi.hxx>

Public Member Functions

 DOVI () noexcept
 Constructs absent Dolby Vision properties.
 DOVI (const DOVI &other)
 Copies Dolby Vision properties and owned RPU bytes.
 DOVI (DOVI &&other) noexcept
 Moves Dolby Vision properties.
 ~DOVI () noexcept
 Releases owned RPU storage through its provider.
DOVI & operator= (const DOVI &other)
 Copies Dolby Vision properties.
DOVI & operator= (DOVI &&other) noexcept
 Moves Dolby Vision properties.
bool LoadConfiguration (std::span< const std::byte > bytes) noexcept
 Loads native AVDOVIDecoderConfigurationRecord side data.
bool LoadMetadata (std::span< const std::byte > bytes) noexcept
 Loads native AVDOVIMetadata after checking its dynamic offsets.
bool LoadRpu (std::span< const std::byte > bytes)
 Copies raw RPU side data into owned Safe binary storage.
bool Present () const noexcept
 Reports Dolby Vision detected by any loader.
bool ConfigurationPresent () const noexcept
 Reports native stream configuration availability.
bool MetadataPresent () const noexcept
 Reports decoded metadata availability.
std::uint8_t Profile () const noexcept
 Returns the stream configuration profile.
std::uint8_t Level () const noexcept
 Returns the stream configuration level.
std::uint8_t VersionMajor () const noexcept
 Returns the configuration major version.
std::uint8_t VersionMinor () const noexcept
 Returns the configuration minor version.
std::uint8_t CompatibilityId () const noexcept
 Returns base-layer signal compatibility.
bool RpuPresent () const noexcept
 Reports signaled or decoded RPU presence.
bool ElPresent () const noexcept
 Reports configuration enhancement-layer presence.
bool BlPresent () const noexcept
 Reports configuration base-layer presence.
std::uint8_t Compression () const noexcept
 Returns the metadata compression method.
const StormByte::Safe::Binary & Rpu () const noexcept
 Returns owned raw RPU bytes.
std::uint8_t BlBitDepth () const noexcept
 Returns decoded base-layer bit depth.
std::uint8_t ElBitDepth () const noexcept
 Returns decoded enhancement-layer bit depth.
std::uint8_t VdrBitDepth () const noexcept
 Returns decoded VDR bit depth.
std::uint8_t MappingColorSpace () const noexcept
 Returns decoded mapping color space.
std::uint8_t MappingChromaFormat () const noexcept
 Returns decoded mapping chroma format.
std::uint8_t SignalBitDepth () const noexcept
 Returns decoded signal bit depth.
std::uint8_t SignalColorSpace () const noexcept
 Returns decoded signal color space.
std::uint8_t SignalChromaFormat () const noexcept
 Returns decoded signal chroma format.
std::uint8_t SignalFullRange () const noexcept
 Returns decoded signal range flags.
std::uint16_t SignalEotf () const noexcept
 Returns decoded signal EOTF.
std::uint16_t SourceMinPq () const noexcept
 Returns decoded source minimum PQ code value.
std::uint16_t SourceMaxPq () const noexcept
 Returns decoded source maximum PQ code value.

Detailed Description

Dolby Vision configuration, decoded metadata and owned raw RPU bytes.

Note
Loaders accept native FFmpeg side data, not serialized configuration records. Compatible provider ABIs and live Base and Multimedia providers are required.

Constructor & Destructor Documentation

◆ DOVI() [1/3]

StormByte::Multimedia::Property::DOVI::DOVI ( )
noexcept

Constructs absent Dolby Vision properties.

◆ DOVI() [2/3]

StormByte::Multimedia::Property::DOVI::DOVI ( const DOVI & other)

Copies Dolby Vision properties and owned RPU bytes.

Parameters
otherProperties to copy.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ DOVI() [3/3]

StormByte::Multimedia::Property::DOVI::DOVI ( DOVI && other)
noexcept

Moves Dolby Vision properties.

Parameters
otherProperties to move.

◆ ~DOVI()

StormByte::Multimedia::Property::DOVI::~DOVI ( )
noexcept

Releases owned RPU storage through its provider.

Member Function Documentation

◆ BlBitDepth()

std::uint8_t StormByte::Multimedia::Property::DOVI::BlBitDepth ( ) const
noexcept

Returns decoded base-layer bit depth.

Returns
Bit depth, or zero without metadata.

◆ BlPresent()

bool StormByte::Multimedia::Property::DOVI::BlPresent ( ) const
noexcept

Reports configuration base-layer presence.

Returns
Base-layer flag, or false without configuration.

◆ CompatibilityId()

std::uint8_t StormByte::Multimedia::Property::DOVI::CompatibilityId ( ) const
noexcept

Returns base-layer signal compatibility.

Returns
Native compatibility identifier, or zero without configuration.

◆ Compression()

std::uint8_t StormByte::Multimedia::Property::DOVI::Compression ( ) const
noexcept

Returns the metadata compression method.

Returns
Native compression identifier, or zero without configuration.

◆ ConfigurationPresent()

bool StormByte::Multimedia::Property::DOVI::ConfigurationPresent ( ) const
noexcept

Reports native stream configuration availability.

Returns
Whether configuration was loaded.

◆ ElBitDepth()

std::uint8_t StormByte::Multimedia::Property::DOVI::ElBitDepth ( ) const
noexcept

Returns decoded enhancement-layer bit depth.

Returns
Bit depth, or zero without metadata.

◆ ElPresent()

bool StormByte::Multimedia::Property::DOVI::ElPresent ( ) const
noexcept

Reports configuration enhancement-layer presence.

Returns
Enhancement-layer flag, or false without configuration.

◆ Level()

std::uint8_t StormByte::Multimedia::Property::DOVI::Level ( ) const
noexcept

Returns the stream configuration level.

Returns
Level, or zero without configuration.

◆ LoadConfiguration()

bool StormByte::Multimedia::Property::DOVI::LoadConfiguration ( std::span< const std::byte > bytes)
noexcept

Loads native AVDOVIDecoderConfigurationRecord side data.

Parameters
bytesNative configuration bytes.
Returns
True on success; truncated input leaves properties unchanged.

◆ LoadMetadata()

bool StormByte::Multimedia::Property::DOVI::LoadMetadata ( std::span< const std::byte > bytes)
noexcept

Loads native AVDOVIMetadata after checking its dynamic offsets.

Parameters
bytesNative decoded metadata bytes.
Returns
True on success; invalid ranges leave properties unchanged.
Note
Stream configuration profile and level are never replaced by RPU identifiers.

◆ LoadRpu()

bool StormByte::Multimedia::Property::DOVI::LoadRpu ( std::span< const std::byte > bytes)

Copies raw RPU side data into owned Safe binary storage.

Parameters
bytesRaw RPU bytes.
Returns
True on success; empty input leaves properties unchanged.
Exceptions
StormByte::ExceptionSafe storage allocation failed.

◆ MappingChromaFormat()

std::uint8_t StormByte::Multimedia::Property::DOVI::MappingChromaFormat ( ) const
noexcept

Returns decoded mapping chroma format.

Returns
Native mapping chroma-format identifier, or zero without metadata.

◆ MappingColorSpace()

std::uint8_t StormByte::Multimedia::Property::DOVI::MappingColorSpace ( ) const
noexcept

Returns decoded mapping color space.

Returns
Native mapping color-space identifier, or zero without metadata.

◆ MetadataPresent()

bool StormByte::Multimedia::Property::DOVI::MetadataPresent ( ) const
noexcept

Reports decoded metadata availability.

Returns
Whether parsed fields are available.

◆ operator=() [1/2]

DOVI & StormByte::Multimedia::Property::DOVI::operator= ( const DOVI & other)

Copies Dolby Vision properties.

Parameters
otherProperties to copy.
Returns
This object.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ operator=() [2/2]

DOVI & StormByte::Multimedia::Property::DOVI::operator= ( DOVI && other)
noexcept

Moves Dolby Vision properties.

Parameters
otherProperties to move.
Returns
This object.

◆ Present()

bool StormByte::Multimedia::Property::DOVI::Present ( ) const
noexcept

Reports Dolby Vision detected by any loader.

Returns
Whether configuration, parsed metadata or raw RPU is present.

◆ Profile()

std::uint8_t StormByte::Multimedia::Property::DOVI::Profile ( ) const
noexcept

Returns the stream configuration profile.

Returns
Profile, or zero without configuration.

◆ Rpu()

const StormByte::Safe::Binary & StormByte::Multimedia::Property::DOVI::Rpu ( ) const
noexcept

Returns owned raw RPU bytes.

Returns
Borrowed binary valid while this object is alive; empty if unavailable.

◆ RpuPresent()

bool StormByte::Multimedia::Property::DOVI::RpuPresent ( ) const
noexcept

Reports signaled or decoded RPU presence.

Returns
Whether an RPU is signaled or was loaded.

◆ SignalBitDepth()

std::uint8_t StormByte::Multimedia::Property::DOVI::SignalBitDepth ( ) const
noexcept

Returns decoded signal bit depth.

Returns
Bit depth, or zero without metadata.

◆ SignalChromaFormat()

std::uint8_t StormByte::Multimedia::Property::DOVI::SignalChromaFormat ( ) const
noexcept

Returns decoded signal chroma format.

Returns
Native signal chroma-format identifier, or zero without metadata.

◆ SignalColorSpace()

std::uint8_t StormByte::Multimedia::Property::DOVI::SignalColorSpace ( ) const
noexcept

Returns decoded signal color space.

Returns
Native signal color-space identifier, or zero without metadata.

◆ SignalEotf()

std::uint16_t StormByte::Multimedia::Property::DOVI::SignalEotf ( ) const
noexcept

Returns decoded signal EOTF.

Returns
Native EOTF identifier, or zero without metadata.

◆ SignalFullRange()

std::uint8_t StormByte::Multimedia::Property::DOVI::SignalFullRange ( ) const
noexcept

Returns decoded signal range flags.

Returns
Native range flags, or zero without metadata.

◆ SourceMaxPq()

std::uint16_t StormByte::Multimedia::Property::DOVI::SourceMaxPq ( ) const
noexcept

Returns decoded source maximum PQ code value.

Returns
Maximum PQ, or zero without metadata.

◆ SourceMinPq()

std::uint16_t StormByte::Multimedia::Property::DOVI::SourceMinPq ( ) const
noexcept

Returns decoded source minimum PQ code value.

Returns
Minimum PQ, or zero without metadata.

◆ VdrBitDepth()

std::uint8_t StormByte::Multimedia::Property::DOVI::VdrBitDepth ( ) const
noexcept

Returns decoded VDR bit depth.

Returns
Bit depth, or zero without metadata.

◆ VersionMajor()

std::uint8_t StormByte::Multimedia::Property::DOVI::VersionMajor ( ) const
noexcept

Returns the configuration major version.

Returns
Major version, or zero without configuration.

◆ VersionMinor()

std::uint8_t StormByte::Multimedia::Property::DOVI::VersionMinor ( ) const
noexcept

Returns the configuration minor version.

Returns
Minor version, or zero without configuration.

The documentation for this class was generated from the following file:
  • lib/public/StormByte/multimedia/property/dovi.hxx