AJA NTV2 SDK  17.1.1.1245
NTV2 SDK 17.1.1.1245
CNTV2Caption708ServiceInfo Class Reference

I am a container for all of the CEA-708 "Service Information" that a decoder or encoder needs to keep track of. This typically means a database containing the current status of up 63 "services", as defined in CEA-708 and SMPTE-334. More...

#include <ntv2caption708serviceinfo.h>

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

Public Member Functions

 CNTV2Caption708ServiceInfo ()
 
virtual ~CNTV2Caption708ServiceInfo ()
 
virtual bool InitAllServiceInfo (void)
 
virtual bool InitCCServiceInfo (const int inServiceIndex)
 
virtual bool CopyAllServiceInfo (const NTV2_CC708ServiceData &inSrcSvcInfo)
 
virtual const NTV2_CC708ServiceDataGetAllServiceInfoPtr (void) const
 
virtual bool CompareAllServiceInfo (const NTV2_CC708ServiceData &inSrcSvcData) const
 
virtual bool CopyOneServiceInfo (const int inServiceIndex, const NTV2_CC708ServiceInfo &inSrcSvcInfo)
 
virtual const NTV2_CC708ServiceInfoGetOneServiceInfoPtr (const int inServiceIndex) const
 
virtual bool CompareOneServiceInfo (const int inServiceIndex, const NTV2_CC708ServiceInfo &inSrcSvcInfo) const
 
virtual int NumActiveCDPServiceInfo (const int startIndex=0)
 
virtual bool ResetStartIndex (void)
 
virtual int GetStartIndex (void) const
 
virtual int AdvanceToNextStartIndex (const bool bIncludeCurrentIndex)
 
virtual bool SetServiceInfoActive (const int inServiceIndex, const bool inIsActive)
 
virtual bool GetServiceInfoActive (const int inServiceIndex) const
 
virtual int GetCaptionServiceNumber (const int inServiceIndex) const
 
virtual bool SetServiceInfoLanguage (const int inServiceIndex, const NTV2_CC708ServiceLanguage &inNewLang)
 
virtual bool GetServiceInfoLanguage (const int inServiceIndex, NTV2_CC708ServiceLanguage &outNewLang) const
 
virtual bool SetServiceInfoEasyReader (const int inServiceIndex, const bool inIsEasyReader)
 
virtual bool GetServiceInfoEasyReader (const int inServiceIndex)
 
virtual bool SetServiceInfoWideAspect (const int inServiceIndex, const bool inIsWideAspect)
 
virtual bool GetServiceInfoWideAspect (const int inServiceIndex) const
 
virtual bool SetServiceInfoDigitalCC (const int inServiceIndex, const bool inIsDigitalCC)
 
virtual bool GetServiceInfoDigitalCC (const int inServiceIndex) const
 
virtual bool SetServiceInfoChangeFlag (const bool inChangeFlag)
 
virtual bool GetServiceInfoChangeFlag (void) const
 
virtual std::ostream & Print (std::ostream &inOutStream) 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 container for all of the CEA-708 "Service Information" that a decoder or encoder needs to keep track of. This typically means a database containing the current status of up 63 "services", as defined in CEA-708 and SMPTE-334.

Note
By CEA-708 rules, the information for ALL services may be updated in a single CDP, or the updates can be spread out across multiple CDPs. This may require using two of these objects: one to hold the "current" service information status; and another to accumulate the updates as they trickle in. After the last CDP containing service info updates has been received, all of the info may be copied at once to update the "current" status.

Definition at line 115 of file ntv2caption708serviceinfo.h.

Constructor & Destructor Documentation

◆ CNTV2Caption708ServiceInfo()

CNTV2Caption708ServiceInfo::CNTV2Caption708ServiceInfo ( )

◆ ~CNTV2Caption708ServiceInfo()

virtual CNTV2Caption708ServiceInfo::~CNTV2Caption708ServiceInfo ( )
virtual

Member Function Documentation

◆ AdvanceToNextStartIndex()

virtual int CNTV2Caption708ServiceInfo::AdvanceToNextStartIndex ( const bool  bIncludeCurrentIndex)
virtual

◆ CompareAllServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::CompareAllServiceInfo ( const NTV2_CC708ServiceData inSrcSvcData) const
virtual

◆ CompareOneServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::CompareOneServiceInfo ( const int  inServiceIndex,
const NTV2_CC708ServiceInfo inSrcSvcInfo 
) const
virtual

◆ CopyAllServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::CopyAllServiceInfo ( const NTV2_CC708ServiceData inSrcSvcInfo)
virtual

◆ CopyOneServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::CopyOneServiceInfo ( const int  inServiceIndex,
const NTV2_CC708ServiceInfo inSrcSvcInfo 
)
virtual

◆ GetAllServiceInfoPtr()

virtual const NTV2_CC708ServiceData& CNTV2Caption708ServiceInfo::GetAllServiceInfoPtr ( void  ) const
inlinevirtual

Definition at line 126 of file ntv2caption708serviceinfo.h.

◆ GetCaptionServiceNumber()

virtual int CNTV2Caption708ServiceInfo::GetCaptionServiceNumber ( const int  inServiceIndex) const
inlinevirtual

Definition at line 147 of file ntv2caption708serviceinfo.h.

◆ GetOneServiceInfoPtr()

virtual const NTV2_CC708ServiceInfo& CNTV2Caption708ServiceInfo::GetOneServiceInfoPtr ( const int  inServiceIndex) const
virtual

◆ GetServiceInfoActive()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoActive ( const int  inServiceIndex) const
inlinevirtual

Definition at line 142 of file ntv2caption708serviceinfo.h.

◆ GetServiceInfoChangeFlag()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoChangeFlag ( void  ) const
inlinevirtual

Definition at line 179 of file ntv2caption708serviceinfo.h.

◆ GetServiceInfoDigitalCC()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoDigitalCC ( const int  inServiceIndex) const
inlinevirtual

Definition at line 172 of file ntv2caption708serviceinfo.h.

◆ GetServiceInfoEasyReader()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoEasyReader ( const int  inServiceIndex)
inlinevirtual

Definition at line 158 of file ntv2caption708serviceinfo.h.

◆ GetServiceInfoLanguage()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoLanguage ( const int  inServiceIndex,
NTV2_CC708ServiceLanguage outNewLang 
) const
virtual

◆ GetServiceInfoWideAspect()

virtual bool CNTV2Caption708ServiceInfo::GetServiceInfoWideAspect ( const int  inServiceIndex) const
inlinevirtual

Definition at line 165 of file ntv2caption708serviceinfo.h.

◆ GetStartIndex()

virtual int CNTV2Caption708ServiceInfo::GetStartIndex ( void  ) const
inlinevirtual

Definition at line 136 of file ntv2caption708serviceinfo.h.

◆ InitAllServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::InitAllServiceInfo ( void  )
virtual

◆ InitCCServiceInfo()

virtual bool CNTV2Caption708ServiceInfo::InitCCServiceInfo ( const int  inServiceIndex)
virtual

◆ NumActiveCDPServiceInfo()

virtual int CNTV2Caption708ServiceInfo::NumActiveCDPServiceInfo ( const int  startIndex = 0)
virtual

◆ Print()

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

◆ ResetStartIndex()

virtual bool CNTV2Caption708ServiceInfo::ResetStartIndex ( void  )
virtual

◆ SetServiceInfoActive()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoActive ( const int  inServiceIndex,
const bool  inIsActive 
)
virtual

◆ SetServiceInfoChangeFlag()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoChangeFlag ( const bool  inChangeFlag)
virtual

◆ SetServiceInfoDigitalCC()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoDigitalCC ( const int  inServiceIndex,
const bool  inIsDigitalCC 
)
virtual

◆ SetServiceInfoEasyReader()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoEasyReader ( const int  inServiceIndex,
const bool  inIsEasyReader 
)
virtual

◆ SetServiceInfoLanguage()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoLanguage ( const int  inServiceIndex,
const NTV2_CC708ServiceLanguage inNewLang 
)
virtual

◆ SetServiceInfoWideAspect()

virtual bool CNTV2Caption708ServiceInfo::SetServiceInfoWideAspect ( const int  inServiceIndex,
const bool  inIsWideAspect 
)
virtual

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