AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
CNTV2Caption608Message Class Reference

#include <ntv2caption608message.h>

Inheritance diagram for CNTV2Caption608Message:
[legend]
Collaboration diagram for CNTV2Caption608Message:
[legend]

Public Member Functions

virtual ~CNTV2Caption608Message ()
 
virtual std::ostream & Print (std::ostream &inOutStream) const
 Prints a human-readable representation of me to the given output stream. More...
 
- Public Member Functions inherited from CNTV2CaptionLogConfig
 CNTV2CaptionLogConfig (const std::string inLogLabel=std::string())
 Default constructor. More...
 
virtual ~CNTV2CaptionLogConfig ()
 
virtual NTV2CaptionLogMask SetLogMask (const NTV2CaptionLogMask inLogMask)
 Specifies what, if any, debug information I will write to my log stream. More...
 
virtual NTV2CaptionLogMask GetLogMask (void) const
 Answers with my current caption logging bit mask. More...
 
virtual bool TestLogMask (const NTV2CaptionLogMask inLogMask, const bool inExact=false) const
 Answers true if the given log mask bits are set in my current log mask. More...
 
virtual void SetLogLabel (const std::string &inNewLabel)
 Specifies my logging label. More...
 
virtual void AppendToLogLabel (const std::string &inString)
 Appends the given string to my current log label. More...
 
virtual const std::string & GetLogLabel (void) const
 Answers with my current logging label. More...
 
virtual void SetLogStream (std::ostream &inOutputStream)
 
virtual std::ostream & LogIf (const NTV2CaptionLogMask inLogMask) const
 
virtual std::ostream & Log (void) const
 

Protected Member Functions

 CNTV2Caption608Message (const NTV2Line21Channel inChannel, const NTV2_CC608_CaptionMessageType inType=NTV2_CC608_CaptionMsgType_Data)
 
virtual NTV2_CC608_CaptionMessageType GetType (void) const
 
virtual NTV2Line21Channel GetChannel (void) const
 
virtual bool HasData (void) const
 
virtual bool IsData (void) const
 
virtual bool IsDelay (void) const
 
virtual bool IsLowPriority (void) const
 
virtual bool IsHighPriority (void) const
 
virtual UWord GetLength (void) const
 
virtual UWord GetBytesRemaining (void) const
 
virtual UWord GetRemainingByteCapacity (void) const
 
virtual UByte ReadNext (void)
 Returns the next data byte from my buffer. If my read position is past the end, I return zero. More...
 
virtual void SkipNext (void)
 Increments my internal read position (if not already past end). More...
 
virtual UWord GetReadPosition (void) const
 Returns my internal read position. More...
 
virtual bool IsPastEnd (void) const
 Returns "true" if my internal read position is past the end; otherwise returns "false". More...
 
virtual bool Add608Command (const UWord inCommand)
 Adds the given CEA-608 command to my internal buffer. More...
 
virtual bool Add608String (const std::string &inMessageStr)
 Adds the contents of the given message string to my internal buffer. More...
 
virtual bool AddBytePair (const UByte inByte1, const UByte inByte2)
 Adds the given pair of bytes into my internal buffer. More...
 

Static Protected Member Functions

static bool Create (CNTV2Caption608MessagePtr &outNewInstance, const NTV2Line21Channel inChannel, const NTV2_CC608_CaptionMessageType inType=NTV2_CC608_CaptionMsgType_Data)
 The maximum number of bytes we can handle in one "message". More...
 

Static Protected Attributes

static const UWord NTV2_CC608_CaptionMsgMaxBytes = 256
 

Friends

class CNTV2CaptionEncoder608
 
class CNTV2Caption608MessageQueue
 For internal use by NTV2CaptionEncoder608 only. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CNTV2CaptionLogConfig
static std::ostream & DumpMemory (const void *pInStartAddress, const size_t inByteCount, std::ostream &inOutputStream=std::cout, const size_t inRadix=16, const size_t inBytesPerGroup=4, const size_t inGroupsPerLine=8, const size_t inAddressRadix=16, const bool inShowAscii=true, const size_t inAddrOffset=0)
 Dumps a contiguous chunk of memory in hex, octal, decimal, with or without ascii, to the given output stream. More...
 
static std::string HexDump32Bytes (const void *pInStartAddress, const size_t inByteCount, const size_t inLimitBytes=32)
 
static std::ostream & DumpYBytes_2vuy (const UByte *pInVideoLine, std::ostream &inOutputStream, const unsigned inFromPixel=0, const unsigned inToPixel=719, const bool inShowRuler=true, const unsigned inHiliteRangeFrom=9999, const unsigned inHiliteRangeTo=9999)
 Dumps the luma values in hexadecimal from the given line of '2vuy' video to the given output stream. More...
 
static std::ostream & DumpYBytes_2vuy (const std::vector< uint8_t > &inVideoLine, std::ostream &inOutputStream, const size_t inFromPixel=0, const size_t inToPixel=719, const bool inShowRuler=true, const size_t inHiliteRangeFrom=9999, const size_t inHiliteRangeTo=9999)
 Dumps the luma values in hexadecimal from the given line of '2vuy' video to the given output stream. More...
 
static std::string GetSeverityLabel (const unsigned inSeverity)
 
- Protected Attributes inherited from CNTV2CaptionLogConfig
NTV2CaptionLogMask mLogMask
 Determines what messages are logged. More...
 
std::string mLogLabel
 My debug label. More...
 
void * mpLabelLock
 Protects my debug label from simultaneous access by more than one thread. More...
 

Detailed Description

Definition at line 36 of file ntv2caption608message.h.

Constructor & Destructor Documentation

◆ CNTV2Caption608Message()

CNTV2Caption608Message::CNTV2Caption608Message ( const NTV2Line21Channel  inChannel,
const NTV2_CC608_CaptionMessageType  inType = NTV2_CC608_CaptionMsgType_Data 
)
explicitprotected

◆ ~CNTV2Caption608Message()

virtual CNTV2Caption608Message::~CNTV2Caption608Message ( )
inlinevirtual

Definition at line 58 of file ntv2caption608message.h.

Member Function Documentation

◆ Add608Command()

virtual bool CNTV2Caption608Message::Add608Command ( const UWord  inCommand)
protectedvirtual

Adds the given CEA-608 command to my internal buffer.

Parameters
[in]inCommandSpecifies the CEA-608 command to be added to my internal buffer.
Returns
True if successful; otherwise False.

◆ Add608String()

virtual bool CNTV2Caption608Message::Add608String ( const std::string &  inMessageStr)
protectedvirtual

Adds the contents of the given message string to my internal buffer.

Parameters
[in]inMessageStrSpecifies the message character data to be added to my internal buffer.
Returns
True if successful; otherwise False.
Note
If the entire message string won't fit into my buffer, none of its characters will be added.

◆ AddBytePair()

virtual bool CNTV2Caption608Message::AddBytePair ( const UByte  inByte1,
const UByte  inByte2 
)
protectedvirtual

Adds the given pair of bytes into my internal buffer.

Parameters
[in]inByte1Specifies the first byte to add to my internal buffer.
[in]inByte2Specifies the second byte to add to my internal buffer.
Returns
True if successful; otherwise False.

◆ Create()

static bool CNTV2Caption608Message::Create ( CNTV2Caption608MessagePtr outNewInstance,
const NTV2Line21Channel  inChannel,
const NTV2_CC608_CaptionMessageType  inType = NTV2_CC608_CaptionMsgType_Data 
)
staticprotected

The maximum number of bytes we can handle in one "message".

◆ GetBytesRemaining()

virtual UWord CNTV2Caption608Message::GetBytesRemaining ( void  ) const
inlineprotectedvirtual

Definition at line 78 of file ntv2caption608message.h.

◆ GetChannel()

virtual NTV2Line21Channel CNTV2Caption608Message::GetChannel ( void  ) const
inlineprotectedvirtual

Definition at line 71 of file ntv2caption608message.h.

◆ GetLength()

virtual UWord CNTV2Caption608Message::GetLength ( void  ) const
inlineprotectedvirtual

Definition at line 77 of file ntv2caption608message.h.

◆ GetReadPosition()

virtual UWord CNTV2Caption608Message::GetReadPosition ( void  ) const
inlineprotectedvirtual

Returns my internal read position.

Definition at line 100 of file ntv2caption608message.h.

◆ GetRemainingByteCapacity()

virtual UWord CNTV2Caption608Message::GetRemainingByteCapacity ( void  ) const
inlineprotectedvirtual

Definition at line 79 of file ntv2caption608message.h.

◆ GetType()

virtual NTV2_CC608_CaptionMessageType CNTV2Caption608Message::GetType ( void  ) const
inlineprotectedvirtual

Definition at line 70 of file ntv2caption608message.h.

◆ HasData()

virtual bool CNTV2Caption608Message::HasData ( void  ) const
inlineprotectedvirtual

Definition at line 72 of file ntv2caption608message.h.

◆ IsData()

virtual bool CNTV2Caption608Message::IsData ( void  ) const
inlineprotectedvirtual

Definition at line 73 of file ntv2caption608message.h.

◆ IsDelay()

virtual bool CNTV2Caption608Message::IsDelay ( void  ) const
inlineprotectedvirtual

Definition at line 74 of file ntv2caption608message.h.

◆ IsHighPriority()

virtual bool CNTV2Caption608Message::IsHighPriority ( void  ) const
inlineprotectedvirtual

Definition at line 76 of file ntv2caption608message.h.

◆ IsLowPriority()

virtual bool CNTV2Caption608Message::IsLowPriority ( void  ) const
inlineprotectedvirtual

Definition at line 75 of file ntv2caption608message.h.

◆ IsPastEnd()

virtual bool CNTV2Caption608Message::IsPastEnd ( void  ) const
inlineprotectedvirtual

Returns "true" if my internal read position is past the end; otherwise returns "false".

Definition at line 106 of file ntv2caption608message.h.

◆ Print()

virtual std::ostream& CNTV2Caption608Message::Print ( std::ostream &  inOutStream) const
virtual

Prints a human-readable representation of me to the given output stream.

Parameters
[in]inOutStreamSpecifies the output stream to receive my human-readable representation.
Returns
The output stream that received my human-readable representation.

◆ ReadNext()

virtual UByte CNTV2Caption608Message::ReadNext ( void  )
protectedvirtual

Returns the next data byte from my buffer. If my read position is past the end, I return zero.

◆ SkipNext()

virtual void CNTV2Caption608Message::SkipNext ( void  )
inlineprotectedvirtual

Increments my internal read position (if not already past end).

Definition at line 94 of file ntv2caption608message.h.

Friends And Related Function Documentation

◆ CNTV2Caption608MessageQueue

friend class CNTV2Caption608MessageQueue
friend

For internal use by NTV2CaptionEncoder608 only.

Definition at line 39 of file ntv2caption608message.h.

◆ CNTV2CaptionEncoder608

friend class CNTV2CaptionEncoder608
friend

Definition at line 38 of file ntv2caption608message.h.

Member Data Documentation

◆ NTV2_CC608_CaptionMsgMaxBytes

const UWord CNTV2Caption608Message::NTV2_CC608_CaptionMsgMaxBytes = 256
staticprotected

Definition at line 43 of file ntv2caption608message.h.


The documentation for this class was generated from the following file: