ntv2captiondecoder608.h

Go to the documentation of this file.

 
#ifndef __NTV2_CEA608_DECODER_
#define __NTV2_CEA608_DECODER_
 
#include "ntv2captiondecodechannel608.h"
#include "ntv2xdscaptiondecodechannel608.h"
#include "ntv2formatdescriptor.h"
#include "ajabase/common/ajarefptr.h"
#include <string>
#include <vector>
 
#ifdef AJAMac
    #define odprintf    printf
#endif  //  AJAMac
 
#ifdef MSWindows
    #include "windows.h"
    #include "stdio.h"
#endif
 
 
class CNTV2CaptionDecoder608;
typedef AJARefPtr <CNTV2CaptionDecoder608>  CNTV2CaptionDecoder608Ptr;
 
class AJAExport CNTV2CaptionDecoder608 : public CNTV2CaptionLogConfig
{
    //  Class Methods
    public:
        static bool             Create (CNTV2CaptionDecoder608Ptr & outEncoder);
 
        static const int        CharacterFlashCycleFrames       = 30;
 
    //  Instance Methods
    public:
 
        virtual void                        Reset (void);
 
        virtual bool                        SetDisplayChannel (const NTV2Line21Channel inChannel);
 
        virtual inline NTV2Line21Channel    GetDisplayChannel (void) const      {return mDisplayChannel;}
 
 
        virtual void                        IdleFrame (void);
 
 
        virtual bool                        ProcessNew608FrameData (const CaptionData & inCC608Data);
 
 
        virtual UByte                       GetOnAirCharacterWithAttributes (const UWord inRow,
                                                                            const UWord inCol,
                                                                            NTV2Line21Attrs & outAttrs) const;
 
        virtual UWord                       GetOnAirUTF16CharacterWithAttributes (const UWord inRow,
                                                                                    const UWord inCol,
                                                                                    NTV2Line21Attrs & outAttrs) const;
 
 
        virtual std::string                 GetOnAirCharacter (const UWord inRow,
                                                                const UWord inCol,
                                                                NTV2Line21Attrs & outAttrs) const;
 
        virtual inline std::string          GetOnAirCharacter (const UWord inRow, const UWord inCol) const
                                                    {NTV2Line21Attrs atrs; return GetOnAirCharacter(inRow, inCol, atrs);}
 
        virtual std::string                 GetOnAirCharacters (const UWord inRowNumber = 0) const;
 
 
        virtual bool                        BurnCaptions (NTV2Buffer & inFB, const NTV2FormatDesc & inFD);  //  New in SDK 16.0
 
 
        virtual UWord                       GetTextModeDisplayRowCount (const NTV2Line21Channel inChannel);
 
        virtual bool                        SetTextModeDisplayRowCount (const NTV2Line21Channel inChannel, const UWord inNumRows);
 
        virtual const NTV2Line21Attrs &     GetTextModeDisplayAttributes (const NTV2Line21Channel inChannel) const;
 
        virtual bool                        SetTextModeDisplayAttributes (const NTV2Line21Channel inChannel,
                                                                            const NTV2Line21Attrs & inAttrs);
 
 
 
        virtual bool                        SubscribeChangeNotification (NTV2Caption608Changed * pInCallback,
                                                                        void * pInUserData = AJA_NULL);
 
        virtual bool                        UnsubscribeChangeNotification (NTV2Caption608Changed *  pInCallback,
                                                                            void * pInUserData = AJA_NULL);
 
        virtual inline bool                 IsFlashCycleOff (void) const            {return mFlashCount > CharacterFlashCycleFrames / 2;}
 
        virtual                             ~CNTV2CaptionDecoder608 ();
 
        virtual NTV2CaptionLogMask          SetLogMask (const NTV2CaptionLogMask inLogMask);
 
 
#if !defined(NTV2_DEPRECATE_16_0)
        virtual NTV2_DEPRECATED_f(bool BurnCaptions (UByte* pBuf, const NTV2FrameDimensions fd, const NTV2PixelFormat pf, const UWord rb)); 
#endif  //  !defined(NTV2_DEPRECATE_16_0)
#if !defined(NTV2_DEPRECATE_16_2)
        static NTV2_DEPRECATED_f(CaptionData DecodeCaptionData (const UByte* pFB, const NTV2PixelFormat pf, const NTV2VideoFormat vf, const NTV2FrameGeometry fg = NTV2_FG_720x486));   
#endif  //  !defined(NTV2_DEPRECATE_16_2)
 
 
    //  PRIVATE INSTANCE METHODS
    private:
        virtual bool                        New608FieldData (const UByte inCharP1, const UByte inCharP2, const NTV2Line21Field inField);
        virtual bool                        ParseCaptionData (const UByte inCharP1, const UByte inCharP2, const NTV2Line21Field inField, const NTV2Line21Channel inChannel);
        virtual bool                        ParseXDSData (const UByte inCharP1, const UByte inCharP2, const NTV2Line21Field inField, const NTV2Line21Channel inChannel);
 
        virtual NTV2Line21Channel           GetCaptionChannel (const UByte inCharP1, const UByte inCharP2, const NTV2Line21Field inField);
 
        //  Hidden constructors & assignment operators
        explicit                            CNTV2CaptionDecoder608 ();
        explicit inline                     CNTV2CaptionDecoder608 (const CNTV2CaptionDecoder608 & inDecoderToCopy);
        virtual CNTV2CaptionDecoder608 &    operator = (const CNTV2CaptionDecoder608 & inDecoderToCopy);
    public:
        virtual void                        DebugPrintCurrentScreen (const bool inAllChannels = false, const bool inShowChars = true, const bool inShowTextChannels = false);
        virtual void                        SetDebugRowsOfInterest (const NTV2Line21Channel inChannel, const UWord inFromRow, const UWord inToRow, const bool inAdd = false);
        virtual void                        SetDebugColumnsOfInterest (const NTV2Line21Channel inChannel, const UWord inFromCol, const UWord inToCol, const bool inAdd = false);
        virtual CNTV2CaptionDecodeChannel608Ptr Get608ChannelDecoder (const NTV2Line21Channel inChannel) const;
 
        static bool                         UseNewBurnCaptionsMethod;   
        static bool                         RenderPrePostSpaces;        
        static bool                         AutoCallIdleFrame;          
        static bool                         AutoFlashOnAirChars;        
 
    private:
        virtual void                        Handle608ChangeNotification (const NTV2Caption608ChangeInfo & inChangeInfo) const;
        static void                         NTV2Caption608ChangeHandler (void * pInstance, const NTV2Caption608ChangeInfo & inChangeInfo);
 
 
    //  INSTANCE DATA
    private:
        typedef std::vector <CNTV2CaptionDecodeChannel608Ptr>   ChannelDecoderArray;    
 
        NTV2Line21Channel           mDisplayChannel;        
        NTV2Line21Channel           mCurrXmitChannel [2];   
 
        ChannelDecoderArray         mChannelDecoders;       
 
        CNTV2XDSDecodeChannel608Ptr mXDSDecode;             
 
        unsigned short              mLastControlCode [2];   
        UWord                       mRollOffset;            
        UWord                       mFlashCount;            
        NTV2Caption608Changed *     mpChangeSubscriber;     
        void *                      mpSubscriberData;       
    #if defined (AJA_DEBUG)
        public:
            static bool                 ClassTest (void);
        protected:
            bool                        InstanceTest (void);
    #endif  //  AJA_DEBUG
 
};  //  CNTV2CaptionDecoder608
 
#endif  // __NTV2_CEA608_DECODER_