ntv2caption608message.h

Go to the documentation of this file.

#ifndef __NTV2_CAPTION608MESSAGE__
#define __NTV2_CAPTION608MESSAGE__

#include "ntv2captionlogging.h"
#include "ntv2caption608types.h"
#include "ajabase/common/ajarefptr.h"
#include <string>
#include <iostream>


typedef enum NTV2_CC608_CaptionMessageType
{
    NTV2_CC608_CaptionMsgType_Data  = 0,    // message contains data to be transmitted
    NTV2_CC608_CaptionMsgType_Delay = 1     // message contains frame count

} NTV2_CC608_CaptionMessageType;


class CNTV2Caption608Message;
typedef AJARefPtr<CNTV2Caption608Message>   CNTV2Caption608MessagePtr;
typedef CNTV2Caption608MessagePtr   CNTV2608MsgPtr;

class AJAExport CNTV2Caption608Message : public CNTV2CaptionLogConfig
{
    friend class CNTV2CaptionEncoder608;        
    friend class CNTV2Caption608MessageQueue;

    //  Class Data
    protected:
        static const UWord NTV2_CC608_CaptionMsgMaxBytes = 256;     


    //  Class Methods
    protected:
        static bool                                     Create (CNTV2Caption608MessagePtr &         outNewInstance,
                                                                const NTV2Line21Channel             inChannel,
                                                                const NTV2_CC608_CaptionMessageType inType      = NTV2_CC608_CaptionMsgType_Data);


    //  Instance Methods
    protected:
        //  Construction & Destruction
        explicit                                        CNTV2Caption608Message (const NTV2Line21Channel             inChannel,
                                                                                const NTV2_CC608_CaptionMessageType inType  = NTV2_CC608_CaptionMsgType_Data);
        public: virtual inline                          ~CNTV2Caption608Message ()              {}

    public:
        virtual std::ostream &                          Print (std::ostream & inOutStream) const;

    protected:
        //  Inquiry
        virtual inline NTV2_CC608_CaptionMessageType    GetType (void) const                    {return mType;}
        virtual inline NTV2Line21Channel                GetChannel (void) const                 {return mChannel;}
        virtual inline bool                             HasData (void) const                    {return GetLength () > 0;}
        virtual inline bool                             IsData (void) const                     {return GetType () == NTV2_CC608_CaptionMsgType_Data;}
        virtual inline bool                             IsDelay (void) const                    {return GetType () == NTV2_CC608_CaptionMsgType_Delay;}
        virtual inline bool                             IsLowPriority (void) const              {return !IsLine21CaptionChannel (GetChannel ());}
        virtual inline bool                             IsHighPriority (void) const             {return IsLine21CaptionChannel (GetChannel ());}
        virtual inline UWord                            GetLength (void) const                  {return mLength;}
        virtual inline UWord                            GetBytesRemaining (void) const          {return IsPastEnd () ? 0 : GetLength () - GetReadPosition ();}
        virtual inline UWord                            GetRemainingByteCapacity (void) const   {return NTV2_CC608_CaptionMsgMaxBytes - GetLength ();}


        //  Readers

        virtual UByte                                   ReadNext (void);


        virtual inline void                             SkipNext (void)                     {if (mReadPosition < mLength) mReadPosition++;}


        virtual inline UWord                            GetReadPosition (void) const        {return mReadPosition;}


        virtual inline bool                             IsPastEnd (void) const              {return GetReadPosition () >= GetLength ();}


        //  Writers

        virtual bool                                    Add608Command (const UWord inCommand);

        virtual bool                                    Add608String (const std::string & inMessageStr);

        virtual bool                                    AddBytePair (const UByte inByte1, const UByte inByte2);


    private:
        virtual CNTV2Caption608Message &                operator = (const CNTV2Caption608Message & inRHS);


    //  Instance Data
    private:
        NTV2_CC608_CaptionMessageType   mType;                                  
        UWord                           mLength;                                
        UWord                           mReadPosition;                          
        UByte                           mData [NTV2_CC608_CaptionMsgMaxBytes];  
        const NTV2Line21Channel         mChannel;                               

};  //  CNTV2Caption608Message


//  Output stream operators:
inline std::ostream & operator << (std::ostream & inOutStream, const CNTV2Caption608Message & inMsg)    {return inMsg.Print (inOutStream);}
std::ostream & operator << (std::ostream & inOutStream, CNTV2Caption608MessagePtr inMsgPtr);


//  Backward compatibility
typedef CNTV2Caption608Message      NTV2CaptionMessage;
typedef CNTV2Caption608MessagePtr   NTV2CaptionMessagePtr;


#endif  //  __NTV2_CAPTION608MESSAGE__