ntv2captionlogging.h File Reference

Declares the NTV2CaptionLogMask, and the CNTV2CaptionLogConfig class. More...

#include "ajatypes.h"
#include "ntv2publicinterface.h"
#include <stdint.h>
#include <string>
#include <iostream>
#include <set>

Include dependency graph for ntv2captionlogging.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CNTV2CaptionLogConfig

Macros
#define	NULL   0
#define	AJACC_ASSERT   NTV2_ASSERT
#define	UHEX2(_c_)   HEX0N(uint16_t(_c_),2)
#define	HEX4(_uword_)   HEX0N((_uword_),4)
#define	Line21ColumnSetToString   Line21RowSetToString

Typedefs
typedef uint64_t	NTV2CaptionLogMask
	Selectors to control what information is logged. More...
typedef std::set< int >	Line21RowSet
	A set of caption row numbers. More...
typedef Line21RowSet	Line21ColumnSet
	A set of caption column numbers. More...
typedef Line21RowSet::const_iterator	Line21RowSetConstIter
	A const iterator for a Line21RowSet. More...
typedef Line21RowSetConstIter	Line21ColumnSetConstIter
	A const iterator for a Line21ColumnSet. More...

Functions
const uint64_t	kCaptionLog_All (0xFFFFFFFFFFFFFFFF)
	Log everything possible. More...
const uint64_t	kCaptionLog_Off (0x0000000000000000)
	Don't log anything. More...
const uint64_t	kCaptionLog_Decode608 (0x0000000000000001)
	Log decode (input) 608 events. More...
const uint64_t	kCaptionLog_DecodeXDS (0x0000000000000002)
	Log decode (input) XDS info. More...
const uint64_t	kCaptionLog_Line21DetectSuccess (0x0000000000000100)
	Log line 21 waveform detect successes. More...
const uint64_t	kCaptionLog_Line21DetectFail (0x0000000000000200)
	Log line 21 waveform detect failures. More...
const uint64_t	kCaptionLog_Line21DecodeSuccess (0x0000000000000400)
	Log line 21 waveform decode successes. More...
const uint64_t	kCaptionLog_Line21DecodeFail (0x0000000000000800)
	Log line 21 waveform decode failures. More...
const uint64_t	kCaptionLog_608ShowScreen (0x0000000000008000)
	Log screen for 608 channel of interest. More...
const uint64_t	kCaptionLog_608ShowAllScreens (0x0000000000010000)
	Log screens for all 608 channels. More...
const uint64_t	kCaptionLog_608ShowScreenAttrs (0x0000000000020000)
	Log screen attributes for 608 channel of interest. More...
const uint64_t	kCaptionLog_DecodeVANC (0x0000000000100000)
	Log decode (input) VANC data. More...
const uint64_t	kCaptionLog_DecodeCDP (0x0000000000200000)
	Log decode (input) CDP data. More...
std::string	Line21RowSetToString (const Line21RowSet &inRowSet)
void	SetDefaultCaptionLogMask (const NTV2CaptionLogMask inMask)
	Sets the default log mask that will be used by newly-created objects in the caption library. More...
NTV2CaptionLogMask	GetDefaultCaptionLogMask (void)
	Answers with the default log mask used when creating new objects in the caption library. More...
void	SetDefaultCaptionLogOutputStream (std::ostream &inOutputStream)
std::ostream &	GetDefaultCaptionLogOutputStream (void)

Detailed Description

Declares the NTV2CaptionLogMask, and the CNTV2CaptionLogConfig class.

Copyright

(C) 2015-2022 AJA Video Systems, Inc. All rights reserved.

Definition in file ntv2captionlogging.h.

Macro Definition Documentation

AJACC_ASSERT

#define AJACC_ASSERT   NTV2_ASSERT

Definition at line 28 of file ntv2captionlogging.h.

HEX4

#define HEX4

(

_uword_

)

HEX0N((_uword_),4)

Definition at line 32 of file ntv2captionlogging.h.

Line21ColumnSetToString

#define Line21ColumnSetToString   Line21RowSetToString

Definition at line 61 of file ntv2captionlogging.h.

NULL

#define NULL   0

Definition at line 23 of file ntv2captionlogging.h.

UHEX2

#define UHEX2

(

_c_

)

HEX0N(uint16_t(_c_),2)

Definition at line 31 of file ntv2captionlogging.h.

Typedef Documentation

Line21ColumnSet

typedef Line21RowSet Line21ColumnSet

A set of caption column numbers.

Definition at line 56 of file ntv2captionlogging.h.

Line21ColumnSetConstIter

typedef Line21RowSetConstIter Line21ColumnSetConstIter

A const iterator for a Line21ColumnSet.

Definition at line 58 of file ntv2captionlogging.h.

Line21RowSet

typedef std::set<int> Line21RowSet

A set of caption row numbers.

Definition at line 55 of file ntv2captionlogging.h.

Line21RowSetConstIter

typedef Line21RowSet::const_iterator Line21RowSetConstIter

A const iterator for a Line21RowSet.

Definition at line 57 of file ntv2captionlogging.h.

NTV2CaptionLogMask

typedef uint64_t NTV2CaptionLogMask

Selectors to control what information is logged.

Definition at line 38 of file ntv2captionlogging.h.

Function Documentation

GetDefaultCaptionLogMask()

NTV2CaptionLogMask GetDefaultCaptionLogMask

(

void

)

Answers with the default log mask used when creating new objects in the caption library.

Returns

The default log mask used for newly-created objects in the caption library.

GetDefaultCaptionLogOutputStream()

std::ostream& GetDefaultCaptionLogOutputStream

(

void

)

Deprecated:

Obsolete – now uses the AJALogger

kCaptionLog_608ShowAllScreens()

const uint64_t kCaptionLog_608ShowAllScreens

(

0x0000000000010000

)

Log screens for all 608 channels.

kCaptionLog_608ShowScreen()

const uint64_t kCaptionLog_608ShowScreen

(

0x0000000000008000

)

Log screen for 608 channel of interest.

kCaptionLog_608ShowScreenAttrs()

const uint64_t kCaptionLog_608ShowScreenAttrs

(

0x0000000000020000

)

Log screen attributes for 608 channel of interest.

kCaptionLog_All()

const uint64_t kCaptionLog_All

(

0xFFFFFFFFFFFFFFFF

)

Log everything possible.

kCaptionLog_Decode608()

const uint64_t kCaptionLog_Decode608

(

0x0000000000000001

)

Log decode (input) 608 events.

kCaptionLog_DecodeCDP()

const uint64_t kCaptionLog_DecodeCDP

(

0x0000000000200000

)

Log decode (input) CDP data.

kCaptionLog_DecodeVANC()

const uint64_t kCaptionLog_DecodeVANC

(

0x0000000000100000

)

Log decode (input) VANC data.

kCaptionLog_DecodeXDS()

const uint64_t kCaptionLog_DecodeXDS

(

0x0000000000000002

)

Log decode (input) XDS info.

kCaptionLog_Line21DecodeFail()

const uint64_t kCaptionLog_Line21DecodeFail

(

0x0000000000000800

)

Log line 21 waveform decode failures.

kCaptionLog_Line21DecodeSuccess()

const uint64_t kCaptionLog_Line21DecodeSuccess

(

0x0000000000000400

)

Log line 21 waveform decode successes.

kCaptionLog_Line21DetectFail()

const uint64_t kCaptionLog_Line21DetectFail

(

0x0000000000000200

)

Log line 21 waveform detect failures.

kCaptionLog_Line21DetectSuccess()

const uint64_t kCaptionLog_Line21DetectSuccess

(

0x0000000000000100

)

Log line 21 waveform detect successes.

kCaptionLog_Off()

const uint64_t kCaptionLog_Off

(

0x0000000000000000

)

Don't log anything.

Line21RowSetToString()

std::string Line21RowSetToString

(

const Line21RowSet &

inRowSet

)

SetDefaultCaptionLogMask()

void SetDefaultCaptionLogMask

(

const NTV2CaptionLogMask

inMask

)

Sets the default log mask that will be used by newly-created objects in the caption library.

Parameters

[in]

inMask

A non-constant reference to an output stream that will be used in newly-created objects in the caption library.

SetDefaultCaptionLogOutputStream()

void SetDefaultCaptionLogOutputStream

(

std::ostream &

inOutputStream

)

Deprecated:

Obsolete – now uses the AJALogger