AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
CNTV2Caption608DataQueue Class Reference

I am a simple, thread-safe queue of CEA-608 caption byte pairs. More...

#include <ntv2caption608dataqueue.h>

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

Public Member Functions

 CNTV2Caption608DataQueue (const NTV2Line21Field inFieldOfInterest=NTV2_CC608_Field_Invalid)
 
virtual ~CNTV2Caption608DataQueue ()
 
virtual void Flush (void)
 
virtual void SetField (const NTV2Line21Field inField)
 
virtual bool Push608Data (const UByte char1, const UByte char2, const bool bGotData)
 
virtual bool Pop608Data (UByte &outChar1, UByte &outChar2, bool &outGotData)
 
virtual bool IsEmpty (void) const
 
virtual size_t GetCurrentDepth (void) const
 
virtual size_t GetMaximumDepth (void) const
 
virtual size_t GetEnqueueTally (void) const
 
virtual size_t GetDequeueTally (void) const
 
- 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
 

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

I am a simple, thread-safe queue of CEA-608 caption byte pairs.

Definition at line 34 of file ntv2caption608dataqueue.h.

Constructor & Destructor Documentation

◆ CNTV2Caption608DataQueue()

CNTV2Caption608DataQueue::CNTV2Caption608DataQueue ( const NTV2Line21Field  inFieldOfInterest = NTV2_CC608_Field_Invalid)

◆ ~CNTV2Caption608DataQueue()

virtual CNTV2Caption608DataQueue::~CNTV2Caption608DataQueue ( )
virtual

Member Function Documentation

◆ Flush()

virtual void CNTV2Caption608DataQueue::Flush ( void  )
virtual

◆ GetCurrentDepth()

virtual size_t CNTV2Caption608DataQueue::GetCurrentDepth ( void  ) const
virtual

◆ GetDequeueTally()

virtual size_t CNTV2Caption608DataQueue::GetDequeueTally ( void  ) const
virtual

◆ GetEnqueueTally()

virtual size_t CNTV2Caption608DataQueue::GetEnqueueTally ( void  ) const
virtual

◆ GetMaximumDepth()

virtual size_t CNTV2Caption608DataQueue::GetMaximumDepth ( void  ) const
virtual

◆ IsEmpty()

virtual bool CNTV2Caption608DataQueue::IsEmpty ( void  ) const
virtual

◆ Pop608Data()

virtual bool CNTV2Caption608DataQueue::Pop608Data ( UByte outChar1,
UByte outChar2,
bool &  outGotData 
)
virtual

◆ Push608Data()

virtual bool CNTV2Caption608DataQueue::Push608Data ( const UByte  char1,
const UByte  char2,
const bool  bGotData 
)
virtual

◆ SetField()

virtual void CNTV2Caption608DataQueue::SetField ( const NTV2Line21Field  inField)
inlinevirtual

Definition at line 42 of file ntv2caption608dataqueue.h.


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