ntv2captiondecodechannel608.h

Go to the documentation of this file.

#ifndef __NTV2_CEA608_DECODECHANNEL_
#define __NTV2_CEA608_DECODECHANNEL_

#include "ntv2captionlogging.h"
#include "ntv2caption608types.h"
#include "ajabase/common/ajarefptr.h"
#include "ajabase/system/lock.h"
#include <vector>

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


typedef enum _CaptionDecode608Stats
{
    kParsedOKTally      = 0,    
    kParseFailTally     = 1,    
    kTotalTabOffsetCmds = 2,    
    kTotalCharSetCmds   = 3,    
    kTotalAttribCmds    = 4,    
    kTotalMiscCmds      = 5,    
    kTotalPACCmds       = 6,    
    kTotalMidRowCmds    = 7,    
    kTotalSpecialChars  = 8,    
    kTotalCharData      = 9,    
    kMaxTallies         = 16
} CaptionDecode608Stats;



class CNTV2CaptionDecodeChannel608;
typedef AJARefPtr <CNTV2CaptionDecodeChannel608>    CNTV2CaptionDecodeChannel608Ptr;

class AJAExport CNTV2CaptionDecodeChannel608 : public CNTV2CaptionLogConfig
{
    //  CLASS METHODS
    public:
        static bool                     Create (CNTV2CaptionDecodeChannel608Ptr & outInstance);


    //  INSTANCE METHODS
    public:

        virtual void                    Reset (void);

        virtual bool                    SetChannel (const NTV2Line21Channel inNewChannel);

        virtual inline bool             IsTextChannel (void) const                                      {return IsLine21TextChannel (mChannel);}

        virtual inline NTV2Line21CharacterSet   GetCurrentCharacterSet (void) const                     {return mCharacterSet;}

        virtual NTV2Line21Channel       GetCurrentChannel (UByte char608_1, UByte char608_2, NTV2Line21Field field);


        virtual bool                    Parse608Data (const UByte inByte1, const UByte inByte2, std::string & outDebugStr);

        virtual inline UWord            GetRow (void) const                                             {return mRow;}

        virtual inline UWord            GetColumn (void) const                                          {return mCol;}


        virtual UByte                   GetOnAirCharacter (const UWord inRow, const UWord inCol, NTV2Line21Attrs & outAttr) const;

        virtual std::string             GetOnAirCharacter (const UWord inRow, const UWord inCol) const;

        virtual std::string             GetOnAirCharacterWithAttributes (const UWord inRow, const UWord inCol, NTV2Line21Attrs & outAttr) const;

        virtual UWord                   GetOnAirUTF16CharacterWithAttributes (const UWord inRow, const UWord inCol, NTV2Line21Attrs & outAttr) const;

        virtual NTV2Line21CharacterSet  GetOnAirCharacterSet (const UWord inRow, const UWord inCol) const;

        virtual bool                    GetCharacterAttributes (const UWord screen, const UWord inRow, const UWord inCol, NTV2Line21Attrs & outAttr) const;


        virtual inline UWord            GetTextModeDisplayRowCount (void) const                                     {return mTextRows;}

        virtual bool                    SetTextModeDisplayRowCount (const UWord inNumRows);

        virtual inline const NTV2Line21Attrs &      GetTextModeDisplayAttributes (void) const                       {return mTextModeStyle;}

        virtual inline void             SetTextModeDisplayAttributes (const NTV2Line21Attrs & inAttributes)         {mTextModeStyle = inAttributes;}

        virtual std::string             GetDebugPrintRow (const UWord inRow, const bool inShowChars = true) const;
        virtual std::string             GetDebugPrintScreen (const bool inShowChars = true) const;
        virtual void                    SetDebugRowsOfInterest (const UWord inFromRow, const UWord inToRow, const bool inAdd = false);
        virtual void                    SetDebugColumnsOfInterest (const UWord inFromCol, const UWord inToCol, const bool inAdd = false);

        virtual                         ~CNTV2CaptionDecodeChannel608 ();

        virtual std::vector<uint32_t>   GetStats(void) const;
        static std::string              GetStatTitle(const CaptionDecode608Stats inStat);
        virtual bool                    SubscribeChangeNotification (NTV2Caption608Changed * pInCallback, void * pInUserData = NULL);
        virtual bool                    UnsubscribeChangeNotification (NTV2Caption608Changed *  pInCallback, void * pInUserData = NULL);


    //  PROTECTED INSTANCE METHODS
    protected:
        virtual bool                    Parse608CharacterData       (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608TabOffsetCommand    (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608CharacterSetCommand (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608AttributeCommand    (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608PACCommand          (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608MidRowCommand       (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608SpecialCharacter    (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        virtual bool                    Parse608MiscCommand         (UByte char608_1, UByte char608_2, std::string & outDebugStr);
        
        virtual bool                    DoResumeCaptionLoading      (void);
        virtual bool                    DoBackspace                 (void);
        virtual bool                    DoDeleteToEndOfRow          (void);
        virtual bool                    DoRollUpCaption             (const UWord inRows);
        virtual bool                    DoFlashOn                   (void);
        virtual bool                    DoResumeDirectCaptioning    (void);
        virtual bool                    DoTextRestart               (void);
        virtual bool                    DoResumeTextDisplay         (void);
        virtual bool                    DoEraseDisplayedMemory      (void);
        virtual bool                    DoCarriageReturn            (void);
        virtual bool                    DoEraseNonDisplayedMemory   (void);
        virtual bool                    DoEndOfCaption              (void);

    private:
        //  Low-level back buffer accessors
        virtual bool                    SetScreenCharacter          (const UWord inScreenNum, const UWord inRow, const UWord inCol, const NTV2_CC608_CodePoint inNewCodePoint);
        virtual NTV2_CC608_CodePoint    GetScreenCharacter          (const UWord inScreenNum, const UWord inRow, const UWord inCol) const;
        virtual bool                    SetScreenAttributes         (const UWord inScreenNum, const UWord inRow, const UWord inCol, const NTV2Line21Attrs inAttr);
        virtual NTV2Line21Attrs         GetScreenAttributes         (const UWord inScreenNum, const UWord inRow, const UWord inCol) const;

    protected:
        //  Higher-level accessors
        virtual void                    SetAttributes               (const UWord inRow, const UWord inCol, const NTV2Line21Attrs inAttr);
        virtual bool                    EraseScreen                 (const UWord screen);

        virtual bool                    SetRow                      (const UWord inNewRow);
        virtual bool                    IncrementRow                (const int inDelta = 1);

        virtual bool                    SetColumn                   (const UWord inNewCol);
        virtual bool                    IncrementColumn             (const int inDelta = 1);
        
        virtual bool                    SetCaptionMode              (const NTV2Line21Mode inNewCaptionMode);
        virtual inline NTV2Line21Mode   GetCaptionMode              (void) const                    {return mCaptionMode;}

        virtual inline UWord            GetCurrentScreen            (void) const                    {return mCurrScreen;}
        virtual bool                    SetCurrentScreen            (const UWord inNewScreen);

        virtual void                    MoveRollUpWindow            (const UWord inNewBaseRow);

        virtual void                    InsertCharacter             (const UByte char608_1, const UByte char608_2, const NTV2Line21Attrs inAttr);
        virtual void                    InsertCharacter             (const UByte char608_1, const UByte char608_2);
        virtual void                    InsertTextCharacter         (const UByte inASCIIChar);

        //  Someday we may want to signal interested third parties when my state changes:
        virtual void                    Notify_ChannelChanged       (const NTV2Line21Channel inOldChannel, const NTV2Line21Channel inNewChannel) const;
        virtual void                    Notify_CurrentRowChanged    (const UWord inOldRow, const UWord inNewRow) const;
        virtual void                    Notify_CurrentColumnChanged (const UWord inOldCol, const UWord inNewCol) const;
        virtual void                    Notify_CurrentScreenChanged (const UWord inOldScreen, const UWord inNewScreen) const;
        virtual void                    Notify_CaptionModeChanged   (const NTV2Line21Mode inOldMode, const NTV2Line21Mode inNewMode) const;
        virtual void                    Notify_ScreenCharChanged    (const UWord inScreenNum, const UWord inRow, const UWord inCol,
                                                                     const NTV2_CC608_CodePoint inOldCodePoint, const NTV2_CC608_CodePoint inNewCodePoint) const;
        virtual void                    Notify_ScreenAttrChanged    (const UWord inScreenNum, const UWord inRow, const UWord inCol,
                                                                     const NTV2Line21Attrs & inOldAttr, const NTV2Line21Attrs & inNewAttr) const;


    //  PRIVATE INSTANCE METHODS
    protected:
        typedef NTV2_CC608_CodePoint    NTV2CC608CodePoint;
        explicit                                CNTV2CaptionDecodeChannel608 ();    //  Hidden constructor
    private:
        explicit                                CNTV2CaptionDecodeChannel608 (const CNTV2CaptionDecodeChannel608 & inObj);
        virtual CNTV2CaptionDecodeChannel608 &  operator = (const CNTV2CaptionDecodeChannel608 & inObj);


    //  INSTANCE DATA
    private:
        NTV2CC608CodePoint  mScreen [2][NTV2_CC608_MaxRow+1][NTV2_CC608_MaxCol+1];  
        NTV2Line21Attrs     mAttrs  [2][NTV2_CC608_MaxRow+1][NTV2_CC608_MaxCol+1];  
        mutable void *      mpScreenLock;       
        UWord               mCurrScreen;        
        UWord               mRow;               
        UWord               mCol;               
        UWord               mRollBaseRow;       
        UWord               mTextRows;          
        NTV2Line21Attrs     mTextModeStyle;     
        NTV2Line21Mode      mCaptionMode;       
        NTV2Line21Channel   mChannel;           
        NTV2Line21CharSet   mCharacterSet;      

        //  Debugging/logging:
        Line21RowSet            mDebugRows;     
        Line21ColumnSet         mDebugCols;     

        NTV2Caption608Changed * mpCallback;     
        void *                  mpUserData;     

        //  Stats
        std::vector<uint32_t>   mStats;         
        mutable AJALock         mStatsLock;     

    public:                                         //  BACK-BUFFER TEST MODE
        static bool     sStaticBackBufferTestMode;  //  Defaults to false.
                                                    //  To test me with static back-buffers, set sStaticBackBufferTestMode
                                                    //  true, then call Reset, then operate me normally.
                                                    //  In this mode, GetScreenCharacter and GetScreenAttributes will always
                                                    //  return the fixed test pattern that's set in my constructor.

#if defined(AJA_DEBUG)                              //  DEBUG BUILDS ONLY:  ClassTest and InstanceTest
        static  bool    ClassTest (void);           //  ClassTest:      Implementation in libajacc/test/main.cpp
        bool            InstanceTest (void);        //  InstanceTest:   Implementation in libajacc/test/main.cpp
#endif  //  AJA_DEBUG

};  //  CNTV2CaptionDecodeChannel608


AJA_EXPORT bool     Check608Parity (UByte char608_1, UByte char608_2, std::string & outDebugStr);
AJA_EXPORT UByte    Add608OddParity (UByte ch);

#endif  // __NTV2_CEA608_DECODECHANNEL_