Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Topics | Classes | Functions
class InputstreamMasteringMetadata
C++ » Interface - kodi::addon » Addon type instances » Inputstream » Definitions, structures and enumerators » 1. Interface

Mastering metadata.
Describes the metadata for HDR10. More...

Topics

 Value Help
 

Classes

class  kodi::addon::InputstreamMasteringMetadata
 

Functions

bool kodi::addon::InputstreamMasteringMetadata::operator== (const kodi::addon::InputstreamMasteringMetadata &right) const
 Metadata class compare.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryR_ChromaticityX (double value)
 Set the chromaticity coordinates of the red value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryR_ChromaticityX ()
 Get the chromaticity X coordinates of the red value.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryR_ChromaticityY (double value)
 The chromaticity coordinates of the red value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryR_ChromaticityY ()
 Get the chromaticity Y coordinates of the red value.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryG_ChromaticityX (double value)
 Set the chromaticity coordinates of the green value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryG_ChromaticityX ()
 Get the chromaticity X coordinates of the green value.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryG_ChromaticityY (double value)
 Set the chromaticity coordinates of the green value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryG_ChromaticityY ()
 Get the chromaticity Y coordinates of the green value.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryB_ChromaticityX (double value)
 The chromaticity coordinates of the blue value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryB_ChromaticityX ()
 Get the chromaticity X coordinates of the blue value.
 
void kodi::addon::InputstreamMasteringMetadata::SetPrimaryB_ChromaticityY (double value)
 The chromaticity coordinates of the blue value in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetPrimaryB_ChromaticityY ()
 Get the chromaticity Y coordinates of the blue value.
 
void kodi::addon::InputstreamMasteringMetadata::SetWhitePoint_ChromaticityX (double value)
 Set the chromaticity coordinates of the white point in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetWhitePoint_ChromaticityX ()
 Get the chromaticity X coordinates of the white point.
 
void kodi::addon::InputstreamMasteringMetadata::SetWhitePoint_ChromaticityY (double value)
 Set the chromaticity coordinates of the white point in the CIE1931 color space.
 
double kodi::addon::InputstreamMasteringMetadata::GetWhitePoint_ChromaticityY ()
 Get the chromaticity Y coordinates of the white point.
 
void kodi::addon::InputstreamMasteringMetadata::SetLuminanceMax (double value)
 Set the maximum number of bits of the display used to master the content.
 
double kodi::addon::InputstreamMasteringMetadata::GetLuminanceMax ()
 Get the maximum number of bits of the display.
 
void kodi::addon::InputstreamMasteringMetadata::SetLuminanceMin (double value)
 Set the minimum number of bits of the display used to master the content.
 
double kodi::addon::InputstreamMasteringMetadata::GetLuminanceMin ()
 Get the minimum number of bits of the display.
 

Detailed Description

Mastering metadata.
Describes the metadata for HDR10.

Used when video is compressed using High Efficiency Video Coding (HEVC). This is used to describe the capabilities of the display used to master the content and the luminance values of the content.

Used on kodi::addon::InputstreamInfo::SetMasteringMetadata and kodi::addon::InputstreamInfo::GetMasteringMetadata.

The following table contains values that can be set with class InputstreamMasteringMetadata :

Name Type Set call Get call
Chromaticity X coordinates of the red double SetPrimaryR_ChromaticityX GetPrimaryR_ChromaticityX
Chromaticity Y coordinates of the red double SetPrimaryR_ChromaticityY GetPrimaryR_ChromaticityY
Chromaticity X coordinates of the green double SetPrimaryG_ChromaticityX GetPrimaryG_ChromaticityX
Chromaticity Y coordinates of the green double SetPrimaryG_ChromaticityY GetPrimaryG_ChromaticityY
Chromaticity X coordinates of the blue double SetPrimaryB_ChromaticityX GetPrimaryB_ChromaticityX
Chromaticity Y coordinates of the blue double SetPrimaryB_ChromaticityY GetPrimaryB_ChromaticityY
Chromaticity X coordinates of the white point double SetWhitePoint_ChromaticityX GetWhitePoint_ChromaticityX
Chromaticity Y coordinates of the white point double SetWhitePoint_ChromaticityY GetWhitePoint_ChromaticityY
Maximum number of bits of the display double SetLuminanceMax GetLuminanceMax
Minimum number of bits of the display double SetLuminanceMin GetLuminanceMin

Function Documentation

◆ GetLuminanceMax()

double kodi::addon::InputstreamMasteringMetadata::GetLuminanceMax ( )
inline

Get the maximum number of bits of the display.

◆ GetLuminanceMin()

double kodi::addon::InputstreamMasteringMetadata::GetLuminanceMin ( )
inline

Get the minimum number of bits of the display.

◆ GetPrimaryB_ChromaticityX()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryB_ChromaticityX ( )
inline

Get the chromaticity X coordinates of the blue value.

◆ GetPrimaryB_ChromaticityY()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryB_ChromaticityY ( )
inline

Get the chromaticity Y coordinates of the blue value.

◆ GetPrimaryG_ChromaticityX()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryG_ChromaticityX ( )
inline

Get the chromaticity X coordinates of the green value.

◆ GetPrimaryG_ChromaticityY()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryG_ChromaticityY ( )
inline

Get the chromaticity Y coordinates of the green value.

◆ GetPrimaryR_ChromaticityX()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryR_ChromaticityX ( )
inline

Get the chromaticity X coordinates of the red value.

◆ GetPrimaryR_ChromaticityY()

double kodi::addon::InputstreamMasteringMetadata::GetPrimaryR_ChromaticityY ( )
inline

Get the chromaticity Y coordinates of the red value.

◆ GetWhitePoint_ChromaticityX()

double kodi::addon::InputstreamMasteringMetadata::GetWhitePoint_ChromaticityX ( )
inline

Get the chromaticity X coordinates of the white point.

◆ GetWhitePoint_ChromaticityY()

double kodi::addon::InputstreamMasteringMetadata::GetWhitePoint_ChromaticityY ( )
inline

Get the chromaticity Y coordinates of the white point.

◆ operator==()

bool kodi::addon::InputstreamMasteringMetadata::operator== ( const kodi::addon::InputstreamMasteringMetadata & right) const
inline

Metadata class compare.

To compare the metadata with another one.

Returns
true if they equal, false otherwise

◆ SetLuminanceMax()

void kodi::addon::InputstreamMasteringMetadata::SetLuminanceMax ( double value)
inline

Set the maximum number of bits of the display used to master the content.

Values are normalized to 10,000.

◆ SetLuminanceMin()

void kodi::addon::InputstreamMasteringMetadata::SetLuminanceMin ( double value)
inline

Set the minimum number of bits of the display used to master the content.

Values are normalized to 10,000.

◆ SetPrimaryB_ChromaticityX()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryB_ChromaticityX ( double value)
inline

The chromaticity coordinates of the blue value in the CIE1931 color space.

X coordinate. The values are normalized to 50,000.

◆ SetPrimaryB_ChromaticityY()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryB_ChromaticityY ( double value)
inline

The chromaticity coordinates of the blue value in the CIE1931 color space.

Y coordinate. The values are normalized to 50,000.

◆ SetPrimaryG_ChromaticityX()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryG_ChromaticityX ( double value)
inline

Set the chromaticity coordinates of the green value in the CIE1931 color space.

X coordinate. The values are normalized to 50,000.

◆ SetPrimaryG_ChromaticityY()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryG_ChromaticityY ( double value)
inline

Set the chromaticity coordinates of the green value in the CIE1931 color space.

Y coordinate. The values are normalized to 50,000.

◆ SetPrimaryR_ChromaticityX()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryR_ChromaticityX ( double value)
inline

Set the chromaticity coordinates of the red value in the CIE1931 color space.

X coordinate. The values are normalized to 50,000.

◆ SetPrimaryR_ChromaticityY()

void kodi::addon::InputstreamMasteringMetadata::SetPrimaryR_ChromaticityY ( double value)
inline

The chromaticity coordinates of the red value in the CIE1931 color space.

Y coordinate. The values are normalized to 50,000.

◆ SetWhitePoint_ChromaticityX()

void kodi::addon::InputstreamMasteringMetadata::SetWhitePoint_ChromaticityX ( double value)
inline

Set the chromaticity coordinates of the white point in the CIE1931 color space.

X coordinate. The values are normalized to 50,000.

◆ SetWhitePoint_ChromaticityY()

void kodi::addon::InputstreamMasteringMetadata::SetWhitePoint_ChromaticityY ( double value)
inline

Set the chromaticity coordinates of the white point in the CIE1931 color space.

Y coordinate. The values are normalized to 50,000.