ntv2captionencoder608.h

Go to the documentation of this file.

#ifndef __NTV2_CEA608_ENCODER_
#define __NTV2_CEA608_ENCODER_

#include "ntv2line21captioner.h"
#include "ntv2caption608types.h"
#include "ntv2caption608messagequeue.h"
#include "ajabase/common/ajarefptr.h"
#include <string>
#include <deque>


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

#ifdef AJALinux
    #include <stdio.h>
#endif


class CNTV2CaptionEncoder608;
typedef AJARefPtr <CNTV2CaptionEncoder608>  CNTV2CaptionEncoder608Ptr;

class AJAExport CNTV2CaptionEncoder608 : public CNTV2CaptionLogConfig
{
    //  CLASS METHODS
    public:
        static bool             Create (CNTV2CaptionEncoder608Ptr & outEncoder);


    //  INSTANCE METHODS
    public:

        virtual bool            EnqueuePopOnMessage     (const std::string &    inMessageStr,
                                                        const NTV2Line21Channel inChannel           = NTV2_CC608_CC1,
                                                        const UWord             inRowNumber         = 0,
                                                        const UWord             inColumnNumber      = 0,
                                                        const NTV2Line21Attrs & inDisplayAttribs    = NTV2Line21Attrs());


        virtual bool            EnqueuePaintOnMessage   (const std::string &    inMessageStr,
                                                        const bool              inEraseFirst        = false,
                                                        const NTV2Line21Channel inChannel           = NTV2_CC608_CC1,
                                                        const UWord             inRowNumber         = 0,
                                                        const UWord             inColumnNumber      = 0,
                                                        const NTV2Line21Attrs & inDisplayAttribs    = NTV2Line21Attrs());

        virtual bool            EnqueueRollUpMessage    (const std::string &    inMessageStr,
                                                        const NTV2Line21Mode    inRollMode          = NTV2_CC608_CapModeRollUp4,
                                                        const NTV2Line21Channel inChannel           = NTV2_CC608_CC1,
                                                        const UWord             inRowNumber         = NTV2_CC608_MaxRow,
                                                        const UWord             inColumnNumber      = NTV2_CC608_MinCol,
                                                        const NTV2Line21Attrs & inDisplayAttribs    = NTV2Line21Attrs());

        virtual bool            EnqueueTextMessage      (const std::string &        inMessageStr,
                                                        const bool                  inEraseFirst    = false,
                                                        const NTV2Line21Channel     inChannel       = NTV2_CC608_Text1);

        virtual bool            EnqueueCaptionData      (const CaptionData &        inCaptionData);

        virtual bool            EnqueueDelay        (const uint32_t inFrameCount, const NTV2Line21Channel inChannel = NTV2_CC608_CC1);


        virtual bool            EncodeNextCaptionBytesIntoLine21 (void *                    pFrameBuffer,
                                                                    const NTV2PixelFormat   inPixelFormat,
                                                                    const NTV2VideoFormat   inVideoFormat,
                                                                    const NTV2Line21Field   inFieldNum);


        virtual bool            GetNextCaptionData (CaptionData & outCaptionData);

        virtual UByte *         GetNextLine21TransmitCaptions (const NTV2Line21Field inFieldNum);


        virtual bool            GetNextTransmitCaptionBytes (const NTV2Line21Field inFieldNum, UByte & outChar1, UByte & outChar2);



        virtual size_t          GetQueuedMessageCount (const NTV2Line21Field inFieldNum = NTV2_CC608_Field1) const;

        virtual size_t          GetQueuedByteCount (const NTV2Line21Field inFieldNum = NTV2_CC608_Field1) const;

        virtual void            Flush (const NTV2Line21Field inFieldNum = NTV2_CC608_Field1, const bool inAlsoInProgress = true);

        virtual void            FlushChannel (const NTV2Line21Channel inChannel, const bool inAlsoInProgress = true);


        virtual bool            Erase (const NTV2Line21Channel  inChannel   = NTV2_CC608_CC1);


        virtual void            GetQueueInfoForChannel (const NTV2Line21Channel inChannel, size_t & outBytesQueued, size_t & outMessagesQueued) const;


        //  Stats

        virtual inline size_t   GetEnqueueByteTally (void) const            {return mXmitMsgQueueF1.GetEnqueueByteTally () + mXmitMsgQueueF2.GetEnqueueByteTally ();}

        virtual inline size_t   GetDequeueByteTally (void) const            {return mXmitMsgQueueF1.GetDequeueByteTally () + mXmitMsgQueueF2.GetDequeueByteTally ();}

        virtual inline size_t   GetEnqueueMessageTally (void) const         {return mXmitMsgQueueF1.GetEnqueueMessageTally () + mXmitMsgQueueF2.GetEnqueueMessageTally ();}

        virtual inline size_t   GetDequeueMessageTally (void) const         {return mXmitMsgQueueF1.GetDequeueMessageTally () + mXmitMsgQueueF2.GetDequeueMessageTally ();}

        virtual inline size_t   GetHighestQueueDepth (void) const           {return mXmitMsgQueueF1.GetHighestQueueDepth () + mXmitMsgQueueF2.GetHighestQueueDepth ();}


        virtual void            GetQueueStatsForChannel (const NTV2Line21Channel inChannel,
                                                        size_t & outEnqueueBytes,   size_t & outEnqueueMsgs,
                                                        size_t & outDequeueBytes,   size_t & outDequeueMsgs) const;

        virtual                 ~CNTV2CaptionEncoder608 ();

        virtual NTV2CaptionLogMask  SetLogMask (const NTV2CaptionLogMask inLogMask);

#if !defined(NTV2_DEPRECATE_17_0)
        virtual inline NTV2_DEPRECATED_17_0(bool EnqueuePopOnMessage (const std::string & str, const NTV2Line21Channel ch, const UWord row, const UWord col, const NTV2Line21AttrsPtr pAttrs))  {NTV2Line21Attrs tmp; return EnqueuePopOnMessage(str, ch, row, col, pAttrs ? *pAttrs : tmp);}   
        virtual inline NTV2_DEPRECATED_17_0(bool EnqueuePaintOnMessage (const std::string & str, const bool erase, const NTV2Line21Channel ch, const UWord row, const UWord col, const NTV2Line21AttrsPtr pAttrs))  {NTV2Line21Attrs tmp; return EnqueuePaintOnMessage(str, erase, ch, row, col, pAttrs ? *pAttrs : tmp);}  
        virtual inline NTV2_DEPRECATED_17_0(bool EnqueueRollUpMessage (const std::string & str, const NTV2Line21Mode mode, const NTV2Line21Channel ch, const UWord row, const UWord col, const NTV2Line21AttrsPtr pAttrs))  {NTV2Line21Attrs tmp; return EnqueueRollUpMessage(str, mode, ch, row, col, pAttrs ? *pAttrs : tmp);}    
#endif  //  defined(NTV2_DEPRECATE_17_0)


    //  Private Instance Methods
    private:
        virtual CNTV2608MsgPtr  GetNextCaptionMessage (const NTV2Line21Field inFieldNum);
        virtual bool            EnqueueCaptionMessage (const NTV2Line21Field inFieldNum, CNTV2608MsgPtr pInMsg);

        virtual bool            InsertPACAndPenModeCommands (const NTV2Line21Channel    inChannel,
                                                            const UWord             inRowNumber,
                                                            const UWord             inColumnNumber,
                                                            const NTV2Line21Attrs & inDisplayAttribs,
                                                            CNTV2608MsgPtr          pCapMsg);

        virtual UWord           GetWhitePACCommand (const NTV2Line21Channel inChannel,
                                                    const UWord             inRowNumber,
                                                    const UWord             inColumnNumber,
                                                    const NTV2Line21Attrs & inDisplayAttribs,
                                                    UWord &                 outExtraColumn);

        virtual UWord           GetColorPACCommand (const NTV2Line21Channel inChannel,
                                                    const UWord             inRowNumber,
                                                    const NTV2Line21Attrs & inDisplayAttribs);

        virtual UWord           GetMidRowCommand (const NTV2Line21Channel   inChannel,
                                                    const NTV2Line21Attrs & inDisplayAttribs);

        //  Hidden constructors & assignment operators
        explicit                CNTV2CaptionEncoder608 ();
        explicit inline         CNTV2CaptionEncoder608 (const CNTV2CaptionEncoder608 & inEncoderToCopy) :   CNTV2CaptionLogConfig() {(void) inEncoderToCopy;}
        virtual inline CNTV2CaptionEncoder608 & operator = (const CNTV2CaptionEncoder608 & inEncoderToCopy)                 {(void) inEncoderToCopy; return *this;}


    //  Private Class Methods
    private:
        static UByte        CC608OddParity (const UByte inByte);


    //  INSTANCE DATA
    private:
        CNTV2Line21Captioner        mLine21Encoder;         

        CNTV2Caption608MessageQueue mXmitMsgQueueF1;        
        CNTV2Caption608MessageQueue mXmitMsgQueueF2;        

        CNTV2608MsgPtr  mpXmitCurrentF1Msg;     
        CNTV2608MsgPtr  mpXmitCurrentF2Msg;     

};  //  CNTV2CaptionEncoder608


class AJAExport CUtf8Helpers
{
    public:
        static std::string      Utf8ToCEA608String (const std::string & inUtf8Str, const NTV2Line21Channel inChannel = NTV2_CC608_CC1);

        static std::string      UnicodeCodePointToCEA608Sequence (const ULWord inUnicodeCodePoint, const NTV2Line21Channel inChannel = NTV2_CC608_CC1);

        static size_t           Utf8LengthInChars (const std::string & inUtf8Str);

        static std::string      Utf8GetCharacter (const std::string & inUtf8Str, const size_t inCharOffset);

};  //  CUtf8Helper

#endif  // __NTV2_CEA608_ENCODER_