Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
CConvertMatrix Class Reference

Helper class used for YUV to RGB conversions. This class can take into account different source/destination primaries and various other parameters. More...

#include <ConversionMatrix.h>

Public Member Functions

 CConvertMatrix ()=default
 
 ~CConvertMatrix ()=default
 
CConvertMatrix & SetSourceColorSpace (AVColorSpace colorSpace)
 Set the source color space.
 
CConvertMatrix & SetSourceBitDepth (int bits)
 Set the source bit depth.
 
CConvertMatrix & SetSourceLimitedRange (bool limited)
 Set the source limited range boolean.
 
CConvertMatrix & SetSourceTextureBitDepth (int textureBits)
 Set the source texture bit depth. This is need to normalize values when using > 8 bit texture formats in OpenGL/DirectX. For example GL_R16 is a 16 bit texture which needs to normalize the 10 bit format.
 
CConvertMatrix & SetSourceColorPrimaries (AVColorPrimaries src)
 Set the source color primaries.
 
CConvertMatrix & SetDestinationColorPrimaries (AVColorPrimaries dst)
 Set the destination color primaries.
 
CConvertMatrix & SetDestinationContrast (float contrast)
 Set the destination contrast.
 
CConvertMatrix & SetDestinationBlack (float black)
 Set the destination black level.
 
CConvertMatrix & SetDestinationHue (float hue)
 Set the hue rotation in degrees.
 
CConvertMatrix & SetDestinationSaturation (float saturation)
 Set the saturation (chroma gain).
 
CConvertMatrix & SetDestinationLimitedRange (bool limited)
 Set the destination limited range boolean.
 
Matrix4 GetYuvMat ()
 Get the YUV Matrix for the YUV to RGB conversion.
 
Matrix3 GetPrimMat ()
 Get the Primaries Matrix for the primaries conversion.
 
float GetGammaSrc ()
 Get the gamma source value. Used for color primary conversion..
 
float GetGammaDst ()
 Get the gamma destination value. Used for color primary conversion.
 

Static Public Member Functions

static Matrix3x1 GetRGBYuvCoefs (AVColorSpace colspace)
 Get the YUV coeffecients used for tonemapping.
 
static Matrix3 GetLinearHueSatMat (AVColorSpace colspace, float hue, float saturation)
 Get the matrix rotating hue and scaling saturation of linear RGB around the luminance axis, transposed like GetPrimMat().
 
static float GetGammaExponent (float gamma)
 Get the gamma exponent for a gamma setting of 0..100, 50 is neutral. The adjusted signal is signal^(1 / exponent).
 

Detailed Description

Helper class used for YUV to RGB conversions. This class can take into account different source/destination primaries and various other parameters.

Constructor & Destructor Documentation

◆ CConvertMatrix()

CConvertMatrix::CConvertMatrix ( )
default

◆ ~CConvertMatrix()

CConvertMatrix::~CConvertMatrix ( )
default

Member Function Documentation

◆ GetGammaDst()

float CConvertMatrix::GetGammaDst ( )

Get the gamma destination value. Used for color primary conversion.

◆ GetGammaExponent()

float CConvertMatrix::GetGammaExponent ( float gamma)
static

Get the gamma exponent for a gamma setting of 0..100, 50 is neutral. The adjusted signal is signal^(1 / exponent).

◆ GetGammaSrc()

float CConvertMatrix::GetGammaSrc ( )

Get the gamma source value. Used for color primary conversion..

◆ GetLinearHueSatMat()

Matrix3 CConvertMatrix::GetLinearHueSatMat ( AVColorSpace colspace,
float hue,
float saturation )
static

Get the matrix rotating hue and scaling saturation of linear RGB around the luminance axis, transposed like GetPrimMat().

◆ GetPrimMat()

Matrix3 CConvertMatrix::GetPrimMat ( )

Get the Primaries Matrix for the primaries conversion.

◆ GetRGBYuvCoefs()

Matrix3x1 CConvertMatrix::GetRGBYuvCoefs ( AVColorSpace colspace)
static

Get the YUV coeffecients used for tonemapping.

◆ GetYuvMat()

Matrix4 CConvertMatrix::GetYuvMat ( )

Get the YUV Matrix for the YUV to RGB conversion.

◆ SetDestinationBlack()

CConvertMatrix & CConvertMatrix::SetDestinationBlack ( float black)

Set the destination black level.

◆ SetDestinationColorPrimaries()

CConvertMatrix & CConvertMatrix::SetDestinationColorPrimaries ( AVColorPrimaries dst)

Set the destination color primaries.

◆ SetDestinationContrast()

CConvertMatrix & CConvertMatrix::SetDestinationContrast ( float contrast)

Set the destination contrast.

◆ SetDestinationHue()

CConvertMatrix & CConvertMatrix::SetDestinationHue ( float hue)

Set the hue rotation in degrees.

◆ SetDestinationLimitedRange()

CConvertMatrix & CConvertMatrix::SetDestinationLimitedRange ( bool limited)

Set the destination limited range boolean.

◆ SetDestinationSaturation()

CConvertMatrix & CConvertMatrix::SetDestinationSaturation ( float saturation)

Set the saturation (chroma gain).

◆ SetSourceBitDepth()

CConvertMatrix & CConvertMatrix::SetSourceBitDepth ( int bits)

Set the source bit depth.

◆ SetSourceColorPrimaries()

CConvertMatrix & CConvertMatrix::SetSourceColorPrimaries ( AVColorPrimaries src)

Set the source color primaries.

◆ SetSourceColorSpace()

CConvertMatrix & CConvertMatrix::SetSourceColorSpace ( AVColorSpace colorSpace)

Set the source color space.

◆ SetSourceLimitedRange()

CConvertMatrix & CConvertMatrix::SetSourceLimitedRange ( bool limited)

Set the source limited range boolean.

◆ SetSourceTextureBitDepth()

CConvertMatrix & CConvertMatrix::SetSourceTextureBitDepth ( int textureBits)

Set the source texture bit depth. This is need to normalize values when using > 8 bit texture formats in OpenGL/DirectX. For example GL_R16 is a 16 bit texture which needs to normalize the 10 bit format.

The documentation for this class was generated from the following files: