ntv2cscmatrix.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef NTV2_CSCMATRIX_H
#define NTV2_CSCMATRIX_H


#include "ajatypes.h"
#include "ajaexport.h"
#include "ntv2enums.h"
#include "ntv2card.h"


const int16_t NTV2_CSCMatrix_ZeroOffset   = 0x0000;
const int16_t NTV2_CSCMatrix_SMPTEYOffset = 0x0800; // 0x10 with added ms sign bit and ls-padded to 16 bits
const int16_t NTV2_CSCMatrix_SMPTECOffset = 0x4000; // 0x80 with added ms sign bit and ls-padded to 16 bits


typedef enum NTV2CSCCoeff
{
    NTV2CSCCoeffIndex_A0,       
    NTV2CSCCoeffIndex_A1,       
    NTV2CSCCoeffIndex_A2,       

    NTV2CSCCoeffIndex_B0,       
    NTV2CSCCoeffIndex_B1,       
    NTV2CSCCoeffIndex_B2,       

    NTV2CSCCoeffIndex_C0,       
    NTV2CSCCoeffIndex_C1,       
    NTV2CSCCoeffIndex_C2        
} NTV2CSCCoeffIndex;


typedef enum NTV2CSCOffset
{
    NTV2CSCOffsetIndex_Pre0,
    NTV2CSCOffsetIndex_Pre1,
    NTV2CSCOffsetIndex_Pre2,

    NTV2CSCOffsetIndex_PostA,
    NTV2CSCOffsetIndex_PostB,
    NTV2CSCOffsetIndex_PostC
} NTV2CSCOffsetIndex;


const double NTV2CSCMatrix_MaxCoeffDiff = (1.0 / 4096.0);


class AJAExport CNTV2CSCMatrix
{
public:
    explicit                    CNTV2CSCMatrix (const NTV2ColorSpaceMatrixType inPreset = NTV2_Unity_Matrix);


    virtual inline              ~CNTV2CSCMatrix ()  {};


    virtual void                InitMatrix (const NTV2ColorSpaceMatrixType inPreset);


    virtual double              GetCoefficient (const NTV2CSCCoeffIndex inCoeffIndex) const;


    virtual void                SetCoefficient (const NTV2CSCCoeffIndex inCoeffIndex, const double inCoefficient);


    virtual int16_t             GetOffset (const NTV2CSCOffsetIndex inOffsetIndex) const;


    virtual void                SetOffset (const NTV2CSCOffsetIndex inOffsetIndex, const int16_t inOffset);


    virtual void                PreMultiply (const CNTV2CSCMatrix & inPreInstance);


    virtual void                PostMultiply (const CNTV2CSCMatrix & inPostInstance);


    virtual void                SetGain (const double inGain0, const double inGain1, const double inGain2);


    virtual void                SetHueRotate (const double inDegrees);


    virtual void                SetPreOffsets (const int16_t inOffset0, const int16_t inOffset1, const int16_t inOffset2);


    virtual void                AddPreOffsets (const int16_t inIncrement0, const int16_t inIncrement1, const int16_t inIncrement2);


    virtual void                SetPostOffsets (const int16_t inOffsetA, const int16_t inOffsetB, const int16_t inOffsetC);


    virtual void                AddPostOffsets (const int16_t inIncrementA, const int16_t inIncrementB, const int16_t inIncrementC);


    virtual bool                IsUnityMatrix (void);


    virtual bool                operator == (const CNTV2CSCMatrix & rhs) const;


    virtual inline bool         operator != (const CNTV2CSCMatrix & rhs) const                          {return !(*this == rhs);}


    virtual bool                IsEqual (const CNTV2CSCMatrix & inCSCMatrix, const double inMaxDiff = NTV2CSCMatrix_MaxCoeffDiff);


    virtual bool                CoeffEqual (const double inCoeff1, const double inCoeff2, const double inMaxDiff);


    //  Instance Data
    private:
        double mA0;                         
        double mA1;                         
        double mA2;                         

        double mB0;                         
        double mB1;                         
        double mB2;                         

        double mC0;                         
        double mC1;                         
        double mC2;                         

        int16_t mPreOffset0;                
        int16_t mPreOffset1;                
        int16_t mPreOffset2;                

        int16_t mPostOffsetA;               
        int16_t mPostOffsetB;               
        int16_t mPostOffsetC;               

        NTV2ColorSpaceMatrixType mPreset;   

};  //  CNTV2CSCMatrix

#endif  //  NTV2_CSCMATRIX_H