ntv2captiontranslatorchannel608to708.h

Go to the documentation of this file.

#ifndef __NTV2_CEA608to708_TRANSLATORCHANNEL_
#define __NTV2_CEA608to708_TRANSLATORCHANNEL_

#include "ntv2captiondecodechannel608.h"
#include "ntv2captionencoder708.h"
#include "ntv2caption708serviceblockqueue.h"


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


//  Number of 708 screen coordinate "cells" per 608 text row (i.e. 5)
const int NTV2_CC608_TextRowHeight  = (NTV2_CC708ScreenCellHeight / NTV2_CC608_MaxRow);


const int NTV2_CC708DefaultPopOnWindowID   = 0;     //  The first of NTV2_CC708NumPopOnWindows consecutive indices alternately used for PopOn mode
const int NTV2_CC708NumPopOnWindows        = 2;

const int NTV2_CC708DefaultRollUpWindowID  = 0;
const int NTV2_CC708DefaultPaintOnWindowID = 0;
const int NTV2_CC708DefaultTextWindowID    = 2;


//  Default 608 Window Parms
const int NTV2_CC708Default608WindowPriority      = 3;
const int NTV2_CC708DefaultRollUpAnchorH          =  0;
const int NTV2_CC708DefaultRollUpAnchorV          = 85;

const int NTV2_CC708Default608PopOnWindowStyleID  = 2;  //  Window Styles depend on mode
const int NTV2_CC708Default608RollUpWindowStyleID = 2;
const int NTV2_CC708Default608TextWindowStyleID   = 4;

const int NTV2_CC708Default608PopOnPenStyleID     = 4;  //  Pen Styles depend on mode
const int NTV2_CC708Default608RollUpPenStyleID    = 0;
const int NTV2_CC708Default608TextPenStyleID      = 4;


//  Default 608 Window Attributes
const int NTV2_CC708Default608Justify         = NTV2_CC708JustifyLeft;
const int NTV2_CC708Default608PrintDir        = NTV2_CC708PrintDirLtoR;
const int NTV2_CC708Default608ScrollDir       = NTV2_CC708ScrollDirBtoT;
const int NTV2_CC708Default608WordWrap        = NTV2_CC708NoWordWrap;
const int NTV2_CC708Default608DisplayEffect   = NTV2_CC708DispEffectSnap;
const int NTV2_CC708Default608EffectDir       = NTV2_CC708EffectDirLtoR;
const int NTV2_CC708Default608EffectSpeed     = 2;
const int NTV2_CC708Default608TextEffectSpeed = 1;
const int NTV2_CC708Default608BorderType      = NTV2_CC708BorderTypeNone;


//  Default 608 Pen Attributes
const int NTV2_CC708Default608PenSize       = NTV2_CC708PenSizeStandard;
const int NTV2_CC708Default608FontStyle     = NTV2_CC708FontStyleMonoSansSerif;
const int NTV2_CC708Default608TextTag       = NTV2_CC708TextTagDialog;
const int NTV2_CC708Default608PenOffset     = NTV2_CC708PenOffsetNormal;
const int NTV2_CC708Default608Italics       = NTV2_CC708NoItalics;
const int NTV2_CC708Default608Underline     = NTV2_CC708NoUnderline;
const int NTV2_CC708Default608PenEdgeType   = NTV2_CC708PenEdgeTypeNone;


const int NTV2_CC708Default608Opacity       = NTV2_CC708OpacitySolid;



//  composite struct to hold status for each window
//
typedef struct CC708WindowStatus
{
    bool                bDefined;       
    bool                bDirty;         
    CC708WindowParms    windowParms;    
    CC708WindowAttr     windowAttr;
    CC708PenAttr        penAttr;
    CC708PenColor       penColor;
    CC708PenLocation    penLoc;

} CC708WindowStatus;    //  , *CC708WindowStatusPtr;



class CNTV2CaptionTranslatorChannel608to708;
typedef AJARefPtr <CNTV2CaptionTranslatorChannel608to708>   CNTV2CaptionTranslatorChannel608to708Ptr;

class CNTV2CaptionTranslatorChannel608to708 : public CNTV2CaptionDecodeChannel608
{
    //  CLASS METHODS
    public:
        static bool     Create (CNTV2CaptionTranslatorChannel608to708Ptr & outInstance);


    //  INSTANCE METHODS
    public:
        virtual                 ~CNTV2CaptionTranslatorChannel608to708 ();

        virtual void            Reset (void);

        virtual void            Set708ServiceNumber (int serviceNum);
        virtual inline int      Get708ServiceNumber (void) const                {return m_708ServiceNum;}

        virtual void            Set708TranslateEnable (bool enable);
        virtual inline bool     Get708TranslateEnable (void) const              {return m_708TranslateEnable;}

        virtual bool            SetChannel (const NTV2Line21Channel inChannel);     //  Override


        virtual bool    Init608CCWindowStatus     (int winID,  NTV2Line21Mode mode = NTV2_CC608_CapModePopOn);
        virtual bool    Init608CCWindowParms      (CC708WindowParms & outParms, const NTV2Line21Mode inMode = NTV2_CC608_CapModePopOn) const;
        virtual bool    Init608CCWindowAttributes (CC708WindowAttr & outAttr,   const NTV2Line21Mode inMode = NTV2_CC608_CapModePopOn) const;
        virtual bool    Init608CCPenAttributes    (CC708PenAttr & outAttr,      const NTV2Line21Mode inMode = NTV2_CC608_CapModePopOn) const;
        virtual bool    Init608CCPenColor         (CC708PenColor & outColor,    const NTV2Line21Mode inMode = NTV2_CC608_CapModePopOn) const;
        virtual bool    Init608CCPenLocation      (CC708PenLocation & outLoc,   const NTV2Line21Mode inMode = NTV2_CC608_CapModePopOn) const;

        virtual bool    DeleteWindow (int winID);
        virtual bool    IsWindowDefined (const int winID) const;
        virtual bool    IsWindowDirty (const int winID) const;

        virtual bool    GetCurrentEditWindowID (int * pWindowID = NULL, NTV2Line21Mode mode = NTV2_CC608_CapModeUnknown, bool * pbNewWindow = NULL);
        virtual int     GetCurrentModeWindowID (void);

        virtual bool    GetNextServiceBlockInfoFromQueue (size_t & outBlockSize, size_t & outDataSize, int & outServiceNum, bool & outIsExtended);
        virtual size_t  GetNextServiceBlockFromQueue (UByte * pOutDataBuffer);
        virtual size_t  GetNextServiceBlockDataFromQueue (UByte * pOutDataBuffer);


    //  PROTECTED 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    DoBackspace (void);
        virtual bool    DoDeleteToEndOfRow (void);
        virtual bool    DoRollUpCaption (const UWord inRowCount);
        virtual bool    DoFlashOn (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);

        virtual bool    GetCurrentPenLocation (CC708PenLocation & outLoc, int inWindowID = NTV2_CC708WindowIDMin - 1) const;
        virtual UWord   GetWindowRowOffset (int windowID) const;
        virtual bool    GetCurrentPenColor (CC708PenColor & outColor) const;
        virtual bool    GetCurrentPenAttributes (CC708PenAttr & outAttr) const;

        static bool     Convert608CharacterTo708 (const UByte inChar608, UByte & outChar708_1, UByte & outChar708_2);

        virtual bool    QueueServiceBlock_CharacterData (int serviceNum, UByte ccChar);
        virtual bool    QueueServiceBlock_TwoByteData (int serviceNum, UByte ccChar1, UByte ccChar2);
        virtual bool    QueueServiceBlock_SetCurrentWindow (int serviceNum, int windowID);
        virtual bool    QueueServiceBlock_DefineWindow (const int inServiceNum, const int inWindowID, const CC708WindowParms & inParms);
        virtual bool    QueueServiceBlock_ClearWindows (int serviceNum, UByte windowMap);
        virtual bool    QueueServiceBlock_DeleteWindows (int serviceNum, UByte windowEnables);
        virtual bool    QueueServiceBlock_DisplayWindows (int serviceNum, UByte windowMap);
        virtual bool    QueueServiceBlock_HideWindows (int serviceNum, UByte windowMap);
        virtual bool    QueueServiceBlock_ToggleWindows (int serviceNum, UByte windowMap);
        virtual bool    QueueServiceBlock_SetWindowAttributes (const int inServiceNum, const CC708WindowAttr & inAttr);
        virtual bool    QueueServiceBlock_SetPenAttributes (const int inServiceNum, const CC708PenAttr & inAttr);
        virtual bool    QueueServiceBlock_SetPenColor (const int inServiceNum, const CC708PenColor & inColor);
        virtual bool    QueueServiceBlock_SetPenLocation (const int inServiceNum, const CC708PenLocation & pLoc);
        virtual bool    QueueServiceBlock_Delay (int serviceNum, const UByte delay);
        virtual bool    QueueServiceBlock_DelayCancel (int serviceNum);
        virtual bool    QueueServiceBlock_Reset (int serviceNum);


    //  PRIVATE METHODS
    private:
        //  Hidden constructor, copy constructor, and assignment operator
        explicit        CNTV2CaptionTranslatorChannel608to708 ();
        explicit        CNTV2CaptionTranslatorChannel608to708 (const CNTV2CaptionTranslatorChannel608to708 & inObj);
        virtual CNTV2CaptionTranslatorChannel608to708 & operator = (const CNTV2CaptionTranslatorChannel608to708 & inObj);


    //  INSTANCE DATA
    private:
        int     m_708ServiceNum;                    
        int     m_608PopOn_OnScreenWindowID;        
        int     m_608PopOn_OffScreenWindowID;       
        int     m_608RollUp_WindowID;               
        int     m_608PaintOn_WindowID;              
        int     m_608Text_WindowID;                 
        int     m_lastUsedWindowID;                 
        bool    m_708TranslateEnable;               

        CC708WindowStatus                   m_windowStatus [NTV2_CC708NumWindows];  
        CNTV2CaptionEncoder708Ptr           m_708Encoder;                           
        CNTV2Caption708ServiceBlockQueue    m_SvcBlockQueue;                        

};  //  CNTV2CaptionTranslatorChannel608to708

#endif  // __NTV2_CEA608to708_TRANSLATORCHANNEL_