ntv2dolbyplayer.h

Go to the documentation of this file.

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


#include "ntv2democommon.h"
#include "ajabase/system/thread.h"
#include "ajabase/common/timecodeburn.h"
#include "ajabase/system/file_io.h"


#define DOLBY_FULL_PARSER   //  If defined, parse EC3 files with multiple sync frames per HDMI burst;  otherwise parse with single sync frame per HDMI burst.


typedef struct DolbyPlayerConfig : public PlayerConfig
{
    public:
        bool        fDoRamp;        
        std::string fDolbyFilePath; 

        inline explicit DolbyPlayerConfig (const std::string & inDeviceSpecifier = "0")
            :   PlayerConfig    (inDeviceSpecifier),
                fDoRamp         (false)
        {
        }

        AJALabelValuePairs Get (const bool inCompact = false) const;

}   DolbyPlayerConfig;

// Takes DolbyPlayerConfig << operator overload takes precedence over the PlayConfig one declared in ntv2democommon.h
AJAExport std::ostream & operator << (std::ostream & ioStrm, const DolbyPlayerConfig & inObj);

class NTV2DolbyPlayer
{
    //  Public Instance Methods
    public:

                                NTV2DolbyPlayer (const DolbyPlayerConfig & inConfigData);

        virtual                 ~NTV2DolbyPlayer (void);

        virtual AJAStatus   Init (void);                    

        virtual AJAStatus   Run (void);

        virtual void        Quit (void);                    

        virtual bool        IsRunning (void) const  {return !mGlobalQuit;}  

        virtual void        GetACStatus (AUTOCIRCULATE_STATUS & outStatus);


    //  Protected Instance Methods
    protected:
        struct NTV2DolbyBSI
        {
            uint32_t strmtyp;
            uint32_t substreamid;
            uint32_t frmsiz;
            uint32_t fscod;
            uint32_t numblkscod;
            uint32_t acmod;
            uint32_t lfeon;
            uint32_t bsid;
            uint32_t dialnorm;
            uint32_t compre;
            uint32_t compr;
            uint32_t dialnorm2;
            uint32_t compr2e;
            uint32_t compr2;
            uint32_t chanmape;
            uint32_t chanmap;
            uint32_t mixmdate;
            uint32_t dmixmod;
            uint32_t ltrtcmixlev;
            uint32_t lorocmixlev;
            uint32_t ltrtsurmixlev;
            uint32_t lorosurmixlev;
            uint32_t lfemixlevcode;
            uint32_t lfemixlevcod;
            uint32_t pgmscle;
            uint32_t pgmscl;
            uint32_t pgmscl2e;
            uint32_t pgmscl2;
            uint32_t extpgmscle;
            uint32_t extpgmscl;
            uint32_t mixdef;
            uint32_t premixcmpsel;
            uint32_t drcsrc;
            uint32_t premixcmpscl;
            uint32_t mixdata;
            uint32_t mixdeflen;
            uint32_t mixdata2e;
            uint32_t extpgmlscle;
            uint32_t extpgmlscl;
            uint32_t extpgmcscle;
            uint32_t extpgmcscl;
            uint32_t extpgmrscle;
            uint32_t extpgmrscl;
            uint32_t extpgmlsscle;
            uint32_t extpgmlsscl;
            uint32_t extpgmrsscle;
            uint32_t extpgmrsscl;
            uint32_t extpgmlfescle;
            uint32_t extpgmlfescl;
            uint32_t dmixscle;
            uint32_t dmixscl;
            uint32_t addche;
            uint32_t extpgmaux1scle;
            uint32_t extpgmaux1scl;
            uint32_t extpgmaux2scle;
            uint32_t extpgmaux2scl;
            uint32_t mixdata3e;
            uint32_t spchdat;
            uint32_t addspchdate;
            uint32_t spchdat1;
            uint32_t spchan1att;
            uint32_t addspchdat1e;
            uint32_t addspdat1e;
            uint32_t spchdat2;
            uint32_t spchan2att;
            uint8_t mixdatabuffer[64];
            uint32_t paninfoe;
            uint32_t panmean;
            uint32_t paninfo;
            uint32_t paninfo2e;
            uint32_t panmean2;
            uint32_t paninfo2;
            uint32_t frmmixcfginfoe;
            uint32_t blkmixcfginfo[6];
            uint32_t blkmixcfginfoe;
            uint32_t infomdate;
            uint32_t bsmod;
            uint32_t copyrightb;
            uint32_t origbs;
            uint32_t dsurmod;
            uint32_t dheadphonmod;
            uint32_t dsurexmod;
            uint32_t audprodie;
            uint32_t mixlevel;
            uint32_t roomtyp;
            uint32_t adconvtyp;
            uint32_t audprodi2e;
            uint32_t mixlevel2;
            uint32_t roomtyp2;
            uint32_t adconvtyp2;
            uint32_t sourcefscod;
            uint32_t convsync;
            uint32_t blkid;
            uint32_t frmsizecod;
            uint32_t addbsie;
            uint32_t addbsil;
            uint8_t addbsibuffer[64];
        };

        virtual AJAStatus   SetUpVideo (void);              
        virtual AJAStatus   SetUpAudio (void);              
        virtual bool        RouteOutputSignal (void);       
        virtual AJAStatus   SetUpHostBuffers (void);        
        virtual AJAStatus   SetUpTestPatternBuffers (void); 
        virtual void        StartConsumerThread (void);     
        virtual void        ConsumeFrames (void);           
        virtual void        StartProducerThread (void);     
        virtual void        ProduceFrames (void);           

        virtual uint32_t    AddTone (NTV2FrameData & inFrameData);

        virtual uint32_t    AddRamp (NTV2FrameData & inFrameData);

        virtual uint32_t    AddDolby (NTV2FrameData & inFrameData);

#ifdef DOLBY_FULL_PARSER

        virtual bool GetDolbyFrame (uint16_t * pInDolbyBuffer, uint32_t & numSamples);

        virtual bool ParseBSI (uint16_t * pInDolbyBuffer, uint32_t numSamples, NTV2DolbyBSI * pBsi);


        virtual void SetBitBuffer (uint8_t * pBuffer, uint32_t size);

        virtual bool GetBits (uint32_t & data, uint32_t inBitCount);
#endif

    //  Protected Class Methods
    protected:
        static void             ConsumerThreadStatic (AJAThread * pThread, void * pContext);

        static void             ProducerThreadStatic (AJAThread * pThread, void * pContext);


    //  Private Member Data
    private:
        //typedef AJACircularBuffer <AVDataBuffer *>        MyCirculateBuffer;
        typedef std::vector<NTV2Buffer> NTV2Buffers;

        DolbyPlayerConfig   mConfig;            
        AJAThread           mConsumerThread;    
        AJAThread           mProducerThread;    
        CNTV2Card           mDevice;            
        NTV2TaskMode        mSavedTaskMode;     
        ULWord              mCurrentFrame;      
        ULWord              mCurrentSample;     
        double              mToneFrequency;     
        NTV2AudioSystem     mAudioSystem;       
        NTV2FormatDesc      mFormatDesc;        
        NTV2TCIndexes       mTCIndexes;         
        bool                mGlobalQuit;        
        AJATimeCodeBurn     mTCBurner;          
        NTV2FrameDataArray  mHostBuffers;       
        FrameDataRingBuffer mFrameDataRing;     
        NTV2Buffers         mTestPatRasters;    
        AJAFileIO           mDolbyFileIO;       
        NTV2AudioRate       mAudioRate;         
        uint16_t            mRampSample;        
        uint32_t            mBurstIndex;        
        uint32_t            mBurstSamples;      
        uint16_t *          mBurstBuffer;       
        uint32_t            mBurstSize;         
        uint32_t            mBurstOffset;       
        uint32_t            mBurstMax;          
        uint16_t *          mDolbyBuffer;       
        uint32_t            mDolbySize;         
        uint32_t            mDolbyBlocks;       
        uint8_t *           mBitBuffer;
        ULWord              mBitSize;
        ULWord              mBitIndex;
};  //  NTV2DolbyPlayer

#endif  //  _NTV2DOLBY_H