ntv2captiondecoder708.h

Go to the documentation of this file.

#ifndef __NTV2_CEA708_DECODER_
#define __NTV2_CEA708_DECODER_

#include "ntv2caption708service.h"
#include "ntv2caption608dataqueue.h"
#include "ajaanc/includes/ancillarydata_cea708.h"

#ifdef MSWindows
    #include "windows.h"
    #include "stdio.h"
#endif

class CNTV2CaptionDecoder708;
typedef AJARefPtr <CNTV2CaptionDecoder708>  CNTV2CaptionDecoder708Ptr;


const int kMaxNumCaptionChannelPacketInfo = 25;     

enum    //  The three "states" of a Caption Channel Packet:
{
    kCaptionChannelPacketClear,     
    kCaptionChannelPacketStarted,   
    kCaptionChannelPacketComplete   
};


typedef struct CaptionChannelPacketInfo
{
    int     ccpStatus;          
    int     ccpSize;            
    int     ccpSequenceNum;     
    int     ccpCurrentSize;     

    UByte   ccpData [NTV2_CC708_MaxCaptionChannelPacketSize];   

} CaptionChannelPacketInfo, * CaptionChannelPacketInfoPtr;


class AJAExport CNTV2CaptionDecoder708 : public CNTV2CaptionLogConfig
{
    //  Class Methods
    public:
        static bool         Create (CNTV2CaptionDecoder708Ptr & outDecoder);


    //  Instance Methods
    public:
        virtual             ~CNTV2CaptionDecoder708 ();

        virtual void        Reset (void);

        virtual bool        SetDisplayChannel (const NTV2Line21Channel inChan);

        virtual inline NTV2Line21Channel    GetDisplayChannel (void) const      {return mLine21DisplayChannel;}

        virtual inline bool SetSMPTE334AncData (const AJAAncillaryData_Cea708 & inPacket)
                                    {return SetSMPTE334AncData(inPacket.GetPayloadData(), inPacket.GetPayloadByteCount());}
        virtual inline bool SetSMPTE334AncData (const AJAAncillaryData_Cea708 * pInPacket)
                                    {return pInPacket ? SetSMPTE334AncData(pInPacket->GetPayloadData(), pInPacket->GetPayloadByteCount()) : false;}

        virtual bool        SetSMPTE334AncData (const UByte * pInAncData, const size_t inByteCount);

        virtual bool        SetSMPTE334AncData (const UWord * pInAncData, const size_t inWordCount);

        virtual bool        GetSMPTE334AncData (const UByte ** ppAncData, size_t & outAncSize) const;

        virtual bool        ParseSMPTE334AncPacket (bool & outHasParityErrors);


        virtual bool        ParseSMPTE334AncPacket (void);
        virtual bool        ParseSMPTE334CCTimeCodeSection (size_t & index);
        virtual bool        ParseSMPTE334CCDataSection (size_t & index);
        virtual bool        ParseSMPTE334CCServiceInfoSection (size_t & index);
        virtual bool        UpdateServiceInfo (void);

        virtual bool        Clear608CaptionData (void);

        virtual inline const CaptionData &  GetCurrentFrameCC608Data (void) const                           {return mCC608FrameData;}

        virtual CaptionData GetCC608CaptionData (void);

        virtual bool        GetCaptionChannelPacket (UBytePtr & outDataPtr, size_t & outSize);

        virtual inline const NTV2_CC708ServiceData &    GetAllServiceInfoPtr (void) const                   {return mCurrentServiceInfo.GetAllServiceInfoPtr();}

        virtual bool        GetNextServiceBlockInfoFromQueue (const size_t svcIndex, size_t & outBlockSize, size_t & outDataSize, int & outServiceNum, bool & outIsExtended) const;
        virtual size_t      GetNextServiceBlockFromQueue (const size_t svcIndex, std::vector<UByte> & outData);
        virtual size_t      GetNextServiceBlockDataFromQueue (const size_t svcIndex, std::vector<UByte> & outData);
        virtual size_t      GetNextServiceBlockFromQueue (const size_t svcIndex, UByte * pOutDataBuffer);       
        virtual size_t      GetNextServiceBlockDataFromQueue (const size_t svcIndex, UByte * pOutDataBuffer);   

        virtual inline void GetCDPData (NTV2_CC708CDPPtr pCDP) const                                        {*pCDP = mParsedCDPData;}

        virtual void        ClearAllCaptionChannelPacketInfo (void);
        virtual void        ClearCaptionChannelPacketInfo (CaptionChannelPacketInfoPtr pCCPInfo);
        virtual int         GetNumCompleteCaptionChannelPacketInfo (int * pCompleteCount = NULL, int * pStartedCount = NULL);
        virtual void        ResetCaptionChannelPacketInfoForNewCDP (void);
        virtual void        CloseCurrentCaptionChannelPacketInfo (void);
        virtual bool        AddCaptionChannelPacketInfoData (UByte newData);
        virtual bool        GetCaptionChannelPacketInfoData (int index, UByte ** ppData, int * pSize);

        virtual bool        ParseAllCaptionChannelPackets (void);
        virtual bool        ParseCaptionChannelPacket (CaptionChannelPacketInfoPtr pCCPInfo);

        virtual bool        FindSMPTE334AncPacketInVideoFrame (const UByte * pInVideoFrame, const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inPixelFormat, bool & outHasParityErrors);
        virtual bool        FindSMPTE334AncPacketInVideoFrame (const UByte * pInVideoFrame, const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inPixelFormat);

        #if defined (_DEBUG)
            //  Debugging Methods
            virtual bool        DebugParseSMPTE334AncPacket (bool & outHasErrors);
            virtual bool        DebugParseCDPHeader         (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex, NTV2_CC708CDPHeaderPtr               pHdr,   bool & outHasErrors);
            virtual bool        DebugParseCDPTimecode       (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex, NTV2_CC708CDPTimecodeSectionPtr      pTC,    bool & outHasErrors);
            virtual bool        DebugParseCDPData           (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex, NTV2_CC708CDPDataSectionPtr          pCC,    bool & outHasErrors);
            virtual bool        DebugParseCDPServiceInfo    (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex, NTV2_CC708CDPServiceInfoSectionPtr   pSvc,   bool & outHasErrors);
            virtual bool        DebugParseCDPFutureSection  (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex,                                              bool & outHasErrors);
            virtual bool        DebugParseCDPFooter         (const UByte * pInData, size_t pktIndex, size_t maxPacketSize, size_t * pNewIndex, NTV2_CC708CDPFooterPtr               pFtr,   bool & outHasErrors);

            virtual bool        DebugParse608CaptionData            (UByte inChar1, UByte inChar2, const int inFieldNum);
            virtual bool        DebugParse708CaptionData            (const UByte * pInData, const size_t byteCount, const bool bHexDump = false) const;
            virtual size_t      DebugParse708CaptionChannelPacket   (const UByte * pInData, const size_t byteCount, size_t currIndex) const;
            virtual size_t      DebugParse708ServiceBlock           (const UByte * pInData, const size_t byteCount, size_t currIndex) const;
        //  virtual int         DebugParse708Data                   (const UByte * pInData, const size_t byteCount, size_t currIndex);
            virtual inline int  GetDebugFrameNum (void) const       {return mDebugFrameNumber;}
        #endif  //  _DEBUG
    public:
        virtual NTV2CaptionLogMask  SetLogMask (const NTV2CaptionLogMask inLogMask);


    private:
        explicit                                CNTV2CaptionDecoder708 ();
        explicit                                CNTV2CaptionDecoder708 (const CNTV2CaptionDecoder708 & inDecoderToCopy);
        virtual CNTV2CaptionDecoder708 &        operator = (const CNTV2CaptionDecoder708 & inDecoderToCopy);

        virtual void        StartNewCaptionChannelPacketInfo (int seqNum, int expectedSize);


    //  Instance Data
    private:
        UByte                           mRawVancDataBuffer [256];   
        size_t                          mRawVancByteCount;          

        CaptionData                     mCC608FrameData;            

        UByte                           mCC708FrameData [256];      
        size_t                          mCC708FrameDataByteCount;   

        // debug stuff
        int                             mDebugFrameNumber;
        NTV2_CC708CDP                   mParsedCDPData;             
        UWord                           mPreviousSequenceCount;     
        bool                            mIsNonContiguousFrame;      

        NTV2Line21Channel               mLine21DisplayChannel;      

        CaptionChannelPacketInfo        mCCPInfoArray [kMaxNumCaptionChannelPacketInfo];    
        size_t                          mCurrentCCPIndex;                                   

        //NTV2_CC708CDPTimecodeSection  mLastCDPTimecode;           ///< @brief The timecode info received in the last CDP

        //  The service_info data has to be double-buffered because new data can trickle in over the course of multiple CDPs.
        //  "mCurrentServiceInfo" is a copy of the most recent "good" data. "mNewServiceInfo" is used to accumulate the new service_info
        //  data as it comes in. When a full set has been successfully received, it is copied into mCurrentServiceInfo".
        CNTV2Caption708ServiceInfo      mCurrentServiceInfo;        
        CNTV2Caption708ServiceInfo      mNewServiceInfo;            

        CNTV2Caption708Service          mAvailableServices [NTV2_CC708MaxNumServices];  

        CNTV2Caption608DataQueue        mCC608QueueField1;          
        CNTV2Caption608DataQueue        mCC608QueueField2;          

        int                             mDebugPrintOffset;          
};  //  CNTV2CaptionDecoder708

#endif  // __NTV2_CEA708_DECODER_