Declares the AJAAncillaryData class. More...

#include "ajatypes.h"
#include "ntv2version.h"
#include "ajabase/common/types.h"
#include "ntv2publicinterface.h"
#include <sstream>
#include <vector>

Include dependency graph for ancillarydata.h:

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

Go to the source code of this file.

Classes
struct	AJAAncDataLoc
	Defines where the ancillary data can be found within a video stream. More...

class	AJAAncillaryData
	I am the principal class that stores a single SMPTE-291 SDI ancillary data packet OR the digitized contents of one "analog" raster line (e.g. line 21 captions or VITC). Since I'm payload-agnostic, I serve as the generic base class for more specific objects that know how to decode/parse specific types of ancillary data. More...

class	AJARTPAncPayloadHeader
	I represent the header of a SMPTE 2110 compliant RTP Anc network packet. More...

class	AJARTPAncPacketHeader
	I represent the 4-byte header of an anc packet that's inside an RTP packet. More...

Macros
#define	ToAJAAncPktDIDSID(_d_, _s_) (uint16_t((_d_) << 8) \| uint16_t(_s_))

#define	FromAJAAncPktDIDSID(_k_, _d_, _s_) (_d_) = uint8_t(((_k_) & 0xFF00) >> 8); (_d_) = uint8_t(_k_ & 0x00FF);

#define	IS_VALID_AJAAncDataType(_x_) ((_x_) >= AJAAncDataType_Unknown && (_x_) < AJAAncDataType_Size)

#define	IS_KNOWN_AJAAncDataType(_x_) ((_x_) > AJAAncDataType_Unknown && (_x_) < AJAAncDataType_Size)

#define	IS_VALID_AJAAncDataLink(_x_) ((_x_) >= AJAAncDataLink_A && (_x_) < AJAAncDataLink_Unknown)

#define	IS_VALID_AJAAncDataStream(_x_) ((_x_) >= AJAAncDataStream_1 && (_x_) < AJAAncDataStream_Unknown)

#define	IS_LINKA_AJAAncDataStream(_x_) ((_x_) == AJAAncDataStream_1)

#define	IS_LINKB_AJAAncDataStream(_x_) ((_x_) == AJAAncDataStream_2)

#define	IS_VALID_AJAAncDataChannel(_x_) ((_x_) >= AJAAncDataChannel_C && (_x_) < AJAAncDataChannel_Unknown)

#define	IS_VALID_AncChannelSearchSelect(_x_) ((_x_) >= AncChannelSearch_Y && (_x_) < AncChannelSearch_Invalid)

#define	IS_VALID_AJAAncDataSpace(_x_) ((_x_) >= AJAAncDataSpace_VANC && (_x_) < AJAAncDataSpace_Unknown)

#define	IS_HANC_AJAAncDataSpace(_x_) ((_x_) == AJAAncDataSpace_HANC)

#define	IS_VANC_AJAAncDataSpace(_x_) ((_x_) == AJAAncDataSpace_VANC)

#define	AJAAncDataLineNumber_Unknown uint16_t(0x0000)
	Packet line number is unknown. More...

#define	AJAAncDataLineNumber_DontCare uint16_t(0x07FF)
	Packet placed/found on any legal line number (in field or frame). More...

#define	AJAAncDataLineNumber_Anywhere (AJAAncDataLineNumber_DontCare)

#define	AJAAncDataLineNumber_AnyVanc uint16_t(0x07FE)
	Packet placed/found on any line past RP168 switch line and before SAV. More...

#define	AJAAncDataLineNumber_Future uint16_t(0x07FD)
	Line number exceeds 11 bits (future). More...

#define	IS_UNKNOWN_AJAAncDataLineNumber(_x_) ((_x_) == AJAAncDataLineNumber_Unknown)

#define	IS_IRRELEVANT_AJAAncDataLineNumber(_x_) ((_x_) == AJAAncDataLineNumber_DontCare)

#define	IS_GOOD_AJAAncDataLineNumber(_x_) ((_x_) > 0 && (_x_) < AJAAncDataLineNumber_DontCare)

#define	AJAAncDataHorizOffset_Unknown uint16_t(0x0000)
	Unknown. More...

#define	AJAAncDataHorizOffset_Anywhere uint16_t(0x0FFF)
	Unspecified – Packet placed/found in any legal area of raster line. More...

#define	AJAAncDataHorizOffset_AnyHanc uint16_t(0x0FFE)
	HANC – Packet placed/found in any legal area of raster line after EAV. More...

#define	AJAAncDataHorizOffset_AnyVanc uint16_t(0x0FFD)
	VANC – Packet placed/found in any legal area of raster line after SAV, but before EAV. More...

#define	AJAAncDataHorizOffset_Future uint16_t(0x0FFC)
	Offset exceeds 12 bits (future). More...

#define	IS_VALID_AJAAncDataCoding(_x_) ((_x_) >= AJAAncDataCoding_Digital && (_x_) < AJAAncDataCoding_Size)

#define	IS_VALID_AJAAncBufferFormat(_x_) ((_x_) >= AJAAncBufferFormat_Unknown && (_x_) < AJAAncBufferFormat_Size)

#define	IS_KNOWN_AJAAncBufferFormat(_x_) ((_x_) > AJAAncBufferFormat_Unknown && (_x_) < AJAAncBufferFormat_Size)

#define	AJAAncillaryDataChannel_C AJAAncDataChannel_C

#define	AJAAncillaryDataChannel_Both AJAAncDataChannel_Both

#define	AJAAncillaryDataChannel_Y AJAAncDataChannel_Y

#define	AJAAncillaryDataChannel_Unknown AJAAncDataChannel_Unknown

#define	AJAAncillaryDataChannel_Size AJAAncDataChannel_Size

#define	IS_VALID_AJAAncillaryDataVideoStream(_x_) (IS_VALID_AJAAncDataChannel(_x_))

#define	AJAAncillaryDataVideoStream_C AJAAncillaryDataChannel_C

#define	AJAAncillaryDataVideoStream_Y AJAAncillaryDataChannel_Y

#define	AJAAncillaryDataVideoStream_Unknown AJAAncillaryDataChannel_Unknown

#define	AJAAncillaryDataVideoStream_Size AJAAncillaryDataChannel_Size

#define	IS_VALID_AJAAncillaryDataChannel IS_VALID_AJAAncDataChannel

#define	AJAAncillaryDataChannelToString AJAAncDataChannelToString

#define	AJAAncillaryDataSpace_VANC AJAAncDataSpace_VANC

#define	AJAAncillaryDataSpace_HANC AJAAncDataSpace_HANC

#define	AJAAncillaryDataSpace_Unknown AJAAncDataSpace_Unknown

#define	AJAAncillaryDataSpace_Size AJAAncDataSpace_Size

#define	IS_VALID_AJAAncillaryDataSpace IS_VALID_AJAAncDataSpace

#define	IS_HANC_AJAAncillaryDataSpace IS_HANC_AJAAncDataSpace

#define	IS_VANC_AJAAncillaryDataSpace IS_VANC_AJAAncDataSpace

#define	AJAAncillaryDataSpaceToString AJAAncDataSpaceToString

#define	AJAAncillaryDataStream_1 AJAAncDataStream_1

#define	AJAAncillaryDataStream_2 AJAAncDataStream_2

#define	AJAAncillaryDataStream_3 AJAAncDataStream_3

#define	AJAAncillaryDataStream_4 AJAAncDataStream_4

#define	AJAAncillaryDataStream_Unknown AJAAncDataStream_Unknown

#define	AJAAncillaryDataStream_Size AJAAncDataStream_Size

#define	IS_VALID_AJAAncillaryDataStream IS_VALID_AJAAncDataStream

#define	IS_LINKA_AJAAncillaryDataStream IS_LINKA_AJAAncDataStream

#define	IS_LINKB_AJAAncillaryDataStream IS_LINKB_AJAAncDataStream

#define	AJAAncillaryDataStreamToString AJAAncDataStreamToString

#define	AJAAncillaryDataLink_A AJAAncDataLink_A

#define	AJAAncillaryDataLink_B AJAAncDataLink_B

#define	AJAAncillaryDataLink_LeftEye AJAAncDataLink_LeftEye

#define	AJAAncillaryDataLink_RightEye AJAAncDataLink_RightEye

#define	AJAAncillaryDataLink_Unknown AJAAncDataLink_Unknown

#define	AJAAncillaryDataLink_Size AJAAncDataLink_Size

#define	IS_VALID_AJAAncillaryDataLink IS_VALID_AJAAncDataLink

#define	AJAAncillaryDataLinkToString AJAAncDataLinkToString

#define	AJAAncillaryDataType_Unknown AJAAncDataType_Unknown

#define	AJAAncillaryDataType_Smpte2016_3 AJAAncDataType_Smpte2016_3

#define	AJAAncillaryDataType_Timecode_ATC AJAAncDataType_Timecode_ATC

#define	AJAAncillaryDataType_Timecode_VITC AJAAncDataType_Timecode_VITC

#define	AJAAncillaryDataType_Cea708 AJAAncDataType_Cea708

#define	AJAAncillaryDataType_Cea608_Vanc AJAAncDataType_Cea608_Vanc

#define	AJAAncillaryDataType_Cea608_Line21 AJAAncDataType_Cea608_Line21

#define	AJAAncillaryDataType_Smpte352 AJAAncDataType_Smpte352

#define	AJAAncillaryDataType_Smpte2051 AJAAncDataType_Smpte2051

#define	AJAAncillaryDataType_FrameStatusInfo524D AJAAncDataType_FrameStatusInfo524D

#define	AJAAncillaryDataType_FrameStatusInfo5251 AJAAncDataType_FrameStatusInfo5251

#define	AJAAncillaryDataType_HDR_SDR AJAAncDataType_HDR_SDR

#define	AJAAncillaryDataType_HDR_HDR10 AJAAncDataType_HDR_HDR10

#define	AJAAncillaryDataType_HDR_HLG AJAAncDataType_HDR_HLG

#define	AJAAncillaryDataType_Size AJAAncDataType_Size

#define	IS_VALID_AJAAncillaryDataType IS_VALID_AJAAncDataType

#define	IS_KNOWN_AJAAncillaryDataType IS_KNOWN_AJAAncDataType

#define	AJAAncillaryDataTypeToString AJAAncDataTypeToString

#define	AJAAncillaryData_AnalogDID AJAAncData_AnalogDID

#define	AJAAncillaryData_AnalogSID AJAAncData_AnalogSID

#define	AJAAncillaryDataCoding_Digital AJAAncDataCoding_Digital

#define	AJAAncillaryDataCoding_Raw AJAAncDataCoding_Raw

#define	AJAAncillaryDataCoding_Analog AJAAncDataCoding_Raw

#define	AJAAncillaryDataCoding_Unknown AJAAncDataCoding_Unknown

#define	AJAAncillaryDataCoding_Size AJAAncDataCoding_Size

#define	IS_VALID_AJAAncillaryDataCoding(_x_) IS_VALID_AJAAncDataCoding(_x_)

#define	AJAAncillaryDataCodingToString AJAAncDataCodingToString

#define	AJAAncillaryBufferFormat_Unknown AJAAncBufferFormat_Unknown

#define	AJAAncillaryBufferFormat_FBVANC AJAAncBufferFormat_FBVANC

#define	AJAAncillaryBufferFormat_SDI AJAAncBufferFormat_SDI

#define	AJAAncillaryBufferFormat_RTP AJAAncBufferFormat_RTP

#define	AJAAncillaryBufferFormat_Invalid AJAAncBufferFormat_Invalid

#define	AJAAncillaryBufferFormat_Size AJAAncBufferFormat_Invalid

#define	IS_VALID_AJAAncillaryBufferFormat(_x_) IS_VALID_AJAAncBufferFormat(_x_)

#define	IS_KNOWN_AJAAncillaryBufferFormat(_x_) IS_KNOWN_AJAAncBufferFormat(_x_)

#define	AJAAncillaryBufferFormatToString AJAAncBufferFormatToString

Typedefs
typedef std::pair< uint8_t, uint8_t >	AJAAncDIDSIDPair

typedef std::pair< uint8_t, uint8_t >	AJAAncillaryDIDSIDPair
	A DID/SID pair, typically used as an indexing key. More...

typedef uint16_t	AJAAncPktDIDSID
	Packet DID/SID pair: DID (MS 8 bits) and SID (LS 8 bits) More...

typedef enum AJAAncDataStream	AJAAncillaryDataStream

typedef struct AJAAncDataLoc	AJAAncDataLoc
	Defines where the ancillary data can be found within a video stream. More...

typedef AJAAncDataLoc	AJAAncillaryDataLocation

typedef AJAAncDataLoc *	AJAAncDataLocPtr

typedef AJAAncillaryData	AJAAncPacket

typedef AJAAncillaryData	AJAAncData

typedef AJAAncDataSpace	AJAAncillaryDataSpace

typedef AJAAncDataLink	AJAAncillaryDataLink

typedef AJAAncDataType	AJAAncillaryDataType

typedef AJAAncillaryDataLocation *	AJAAncillaryDataLocationPtr

typedef AJAAncDataCoding	AJAAncillaryDataCoding

typedef AJAAncBufferFormat	AJAAncillaryBufferFormat

typedef AJAAncDataChannel	AJAAncillaryDataChannel

typedef AJAAncillaryDataChannel	AJAAncillaryDataVideoStream

Enumerations
enum	AJAAncDataType { AJAAncDataType_Unknown, AJAAncDataType_Smpte2016_3, AJAAncDataType_Timecode_ATC, AJAAncDataType_Timecode_VITC, AJAAncDataType_Cea708, AJAAncDataType_Cea608_Vanc, AJAAncDataType_Cea608_Line21, AJAAncDataType_Smpte352, AJAAncDataType_Smpte2051, AJAAncDataType_FrameStatusInfo524D, AJAAncDataType_FrameStatusInfo5251, AJAAncDataType_HDR_SDR, AJAAncDataType_HDR_HDR10, AJAAncDataType_HDR_HLG, AJAAncDataType_Size }
	Identifies the ancillary data types that are known to this module. More...

enum	AJAAncDataLink { AJAAncDataLink_A, AJAAncDataLink_B, AJAAncDataLink_LeftEye = AJAAncDataLink_A, AJAAncDataLink_RightEye = AJAAncDataLink_B, AJAAncDataLink_Unknown, AJAAncDataLink_Size }
	Identifies which link of a video stream the ancillary data is associated with. More...

enum	AJAAncDataStream { AJAAncDataStream_1, AJAAncDataStream_2, AJAAncDataStream_3, AJAAncDataStream_4, AJAAncDataStream_Unknown, AJAAncDataStream_Size }
	Identifies which data stream the ancillary data is associated with. More...

enum	AJAAncDataChannel { AJAAncDataChannel_C, AJAAncDataChannel_Both = AJAAncDataChannel_C, AJAAncDataChannel_Y, AJAAncDataChannel_Unknown, AJAAncDataChannel_Size }
	Identifies which component of a video stream in which the ancillary data is placed or found. More...

enum	AncChannelSearchSelect { AncChannelSearch_Y, AncChannelSearch_C, AncChannelSearch_Both, AncChannelSearch_Invalid }
	Specifies which channel of a video stream in which to look for Anc data. More...

enum	AJAAncDataSpace { AJAAncDataSpace_VANC, AJAAncDataSpace_HANC, AJAAncDataSpace_Unknown, AJAAncDataSpace_Size }
	Identified the raster section of a video stream that contains the ancillary data. Deprecated in favor of Horizontal Offset – AJAAncDataHorizOffset_AnyVanc and AJAAncDataHorizOffset_AnyHanc. More...

enum	AJAAncDataCoding { AJAAncDataCoding_Digital, AJAAncDataCoding_Raw, AJAAncDataCoding_Unknown, AJAAncDataCoding_Size }
	Identifies the ancillary data coding type: digital or non-digital (analog/raw). More...

enum	AJAAncBufferFormat { AJAAncBufferFormat_Unknown, AJAAncBufferFormat_FBVANC, AJAAncBufferFormat_SDI, AJAAncBufferFormat_RTP, AJAAncBufferFormat_Invalid, AJAAncBufferFormat_Size = AJAAncBufferFormat_Invalid }
	Identifies the type of anc buffer the packet originated from: GUMP, RTP, VANC, or unknown. More...

Functions
std::ostream &	operator<< (std::ostream &inOutStream, const AJAAncDIDSIDPair &inData)
	Writes a human-readable rendition of the given AJAAncDIDSIDPair into the given output stream. More...

const std::string &	AJAAncDataTypeToString (const AJAAncDataType inValue, const bool inCompact=true)

const std::string &	AJAAncDataLinkToString (const AJAAncDataLink inValue, const bool inCompact=true)

const std::string &	AJAAncDataStreamToString (const AJAAncDataStream inValue, const bool inCompact=true)

const std::string &	AJAAncDataChannelToString (const AJAAncDataChannel inValue, const bool inCompact=true)

std::string	AncChannelSearchSelectToString (const AncChannelSearchSelect inSelect, const bool inCompact=true)

const std::string &	AJAAncDataSpaceToString (const AJAAncDataSpace inValue, const bool inCompact=true)

std::string	AJAAncLineNumberToString (const uint16_t inValue)

std::string	AJAAncHorizOffsetToString (const uint16_t inValue)

std::string	AJAAncDataLocToString (const AJAAncDataLoc &inValue, const bool inCompact=true)

std::ostream &	operator<< (std::ostream &inOutStream, const AJAAncDataLoc &inData)
	Writes a human-readable rendition of the given AJAAncDataLoc into the given output stream. More...

const std::string &	AJAAncDataCodingToString (const AJAAncDataCoding inValue, const bool inCompact=true)

const std::string &	AJAAncBufferFormatToString (const AJAAncBufferFormat inValue, const bool inCompact=true)

static std::ostream &	operator<< (std::ostream &inOutStream, const AJAAncillaryData &inAncData)
	Writes a human-readable rendition of the given AJAAncillaryData into the given output stream. More...

static std::ostream &	operator<< (std::ostream &inOutStrm, const AJARTPAncPayloadHeader &inObj)
	Streams a human-readable representation of the given AJARTPAncPayloadHeader to the given output stream. More...

static std::ostream &	operator<< (std::ostream &inOutStrm, const AJARTPAncPacketHeader &inObj)
	Streams a human-readable representation of the given AJARTPAncPacketHeader to the given output stream. More...

const std::string &	AJAAncillaryDataVideoStreamToString (const AJAAncillaryDataVideoStream inValue, const bool inCompact=true)

Variables
const uint8_t	AJAAncData_AnalogDID = 0x00

const uint8_t	AJAAncData_AnalogSID = 0x00

Detailed Description

Declares the AJAAncillaryData class.

Copyright: (C) 2010-2022 AJA Video Systems, Inc.

Definition in file ancillarydata.h.

Macro Definition Documentation

◆ AJAAncDataHorizOffset_AnyHanc

#define AJAAncDataHorizOffset_AnyHanc uint16_t(0x0FFE)

HANC – Packet placed/found in any legal area of raster line after EAV.

Definition at line 210 of file ancillarydata.h.

◆ AJAAncDataHorizOffset_AnyVanc

#define AJAAncDataHorizOffset_AnyVanc uint16_t(0x0FFD)

VANC – Packet placed/found in any legal area of raster line after SAV, but before EAV.

Definition at line 211 of file ancillarydata.h.

◆ AJAAncDataHorizOffset_Anywhere

#define AJAAncDataHorizOffset_Anywhere uint16_t(0x0FFF)

Unspecified – Packet placed/found in any legal area of raster line.

Definition at line 209 of file ancillarydata.h.

◆ AJAAncDataHorizOffset_Future

#define AJAAncDataHorizOffset_Future uint16_t(0x0FFC)

Offset exceeds 12 bits (future).

Definition at line 212 of file ancillarydata.h.

◆ AJAAncDataHorizOffset_Unknown

#define AJAAncDataHorizOffset_Unknown uint16_t(0x0000)

Unknown.

Definition at line 208 of file ancillarydata.h.

◆ AJAAncDataLineNumber_AnyVanc

#define AJAAncDataLineNumber_AnyVanc uint16_t(0x07FE)

Packet placed/found on any line past RP168 switch line and before SAV.

Definition at line 198 of file ancillarydata.h.

◆ AJAAncDataLineNumber_Anywhere

#define AJAAncDataLineNumber_Anywhere (AJAAncDataLineNumber_DontCare)

Definition at line 197 of file ancillarydata.h.

◆ AJAAncDataLineNumber_DontCare

#define AJAAncDataLineNumber_DontCare uint16_t(0x07FF)

Packet placed/found on any legal line number (in field or frame).

Definition at line 196 of file ancillarydata.h.

◆ AJAAncDataLineNumber_Future

#define AJAAncDataLineNumber_Future uint16_t(0x07FD)

Line number exceeds 11 bits (future).

Definition at line 199 of file ancillarydata.h.

◆ AJAAncDataLineNumber_Unknown

#define AJAAncDataLineNumber_Unknown uint16_t(0x0000)

Packet line number is unknown.

Definition at line 195 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_FBVANC

#define AJAAncillaryBufferFormat_FBVANC AJAAncBufferFormat_FBVANC

Definition at line 1593 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_Invalid

#define AJAAncillaryBufferFormat_Invalid AJAAncBufferFormat_Invalid

Definition at line 1596 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_RTP

#define AJAAncillaryBufferFormat_RTP AJAAncBufferFormat_RTP

Definition at line 1595 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_SDI

#define AJAAncillaryBufferFormat_SDI AJAAncBufferFormat_SDI

Definition at line 1594 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_Size

#define AJAAncillaryBufferFormat_Size AJAAncBufferFormat_Invalid

Definition at line 1597 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat_Unknown

#define AJAAncillaryBufferFormat_Unknown AJAAncBufferFormat_Unknown

Definition at line 1592 of file ancillarydata.h.

◆ AJAAncillaryBufferFormatToString

#define AJAAncillaryBufferFormatToString AJAAncBufferFormatToString

Definition at line 1600 of file ancillarydata.h.

◆ AJAAncillaryData_AnalogDID

#define AJAAncillaryData_AnalogDID AJAAncData_AnalogDID

Definition at line 1581 of file ancillarydata.h.

◆ AJAAncillaryData_AnalogSID

#define AJAAncillaryData_AnalogSID AJAAncData_AnalogSID

Definition at line 1582 of file ancillarydata.h.

◆ AJAAncillaryDataChannel_Both

#define AJAAncillaryDataChannel_Both AJAAncDataChannel_Both

Definition at line 1522 of file ancillarydata.h.

◆ AJAAncillaryDataChannel_C

#define AJAAncillaryDataChannel_C AJAAncDataChannel_C

Definition at line 1521 of file ancillarydata.h.

◆ AJAAncillaryDataChannel_Size

#define AJAAncillaryDataChannel_Size AJAAncDataChannel_Size

Definition at line 1525 of file ancillarydata.h.

◆ AJAAncillaryDataChannel_Unknown

#define AJAAncillaryDataChannel_Unknown AJAAncDataChannel_Unknown

Definition at line 1524 of file ancillarydata.h.

◆ AJAAncillaryDataChannel_Y

#define AJAAncillaryDataChannel_Y AJAAncDataChannel_Y

Definition at line 1523 of file ancillarydata.h.

◆ AJAAncillaryDataChannelToString

#define AJAAncillaryDataChannelToString AJAAncDataChannelToString

Definition at line 1532 of file ancillarydata.h.

◆ AJAAncillaryDataCoding_Analog

#define AJAAncillaryDataCoding_Analog AJAAncDataCoding_Raw

Definition at line 1586 of file ancillarydata.h.

◆ AJAAncillaryDataCoding_Digital

#define AJAAncillaryDataCoding_Digital AJAAncDataCoding_Digital

Definition at line 1584 of file ancillarydata.h.

◆ AJAAncillaryDataCoding_Raw

#define AJAAncillaryDataCoding_Raw AJAAncDataCoding_Raw

Definition at line 1585 of file ancillarydata.h.

◆ AJAAncillaryDataCoding_Size

#define AJAAncillaryDataCoding_Size AJAAncDataCoding_Size

Definition at line 1588 of file ancillarydata.h.

◆ AJAAncillaryDataCoding_Unknown

#define AJAAncillaryDataCoding_Unknown AJAAncDataCoding_Unknown

Definition at line 1587 of file ancillarydata.h.

◆ AJAAncillaryDataCodingToString

#define AJAAncillaryDataCodingToString AJAAncDataCodingToString

Definition at line 1590 of file ancillarydata.h.

◆ AJAAncillaryDataLink_A

#define AJAAncillaryDataLink_A AJAAncDataLink_A

Definition at line 1554 of file ancillarydata.h.

◆ AJAAncillaryDataLink_B

#define AJAAncillaryDataLink_B AJAAncDataLink_B

Definition at line 1555 of file ancillarydata.h.

◆ AJAAncillaryDataLink_LeftEye

#define AJAAncillaryDataLink_LeftEye AJAAncDataLink_LeftEye

Definition at line 1556 of file ancillarydata.h.

◆ AJAAncillaryDataLink_RightEye

#define AJAAncillaryDataLink_RightEye AJAAncDataLink_RightEye

Definition at line 1557 of file ancillarydata.h.

◆ AJAAncillaryDataLink_Size

#define AJAAncillaryDataLink_Size AJAAncDataLink_Size

Definition at line 1559 of file ancillarydata.h.

◆ AJAAncillaryDataLink_Unknown

#define AJAAncillaryDataLink_Unknown AJAAncDataLink_Unknown

Definition at line 1558 of file ancillarydata.h.

◆ AJAAncillaryDataLinkToString

#define AJAAncillaryDataLinkToString AJAAncDataLinkToString

Definition at line 1561 of file ancillarydata.h.

◆ AJAAncillaryDataSpace_HANC

#define AJAAncillaryDataSpace_HANC AJAAncDataSpace_HANC

Definition at line 1535 of file ancillarydata.h.

◆ AJAAncillaryDataSpace_Size

#define AJAAncillaryDataSpace_Size AJAAncDataSpace_Size

Definition at line 1537 of file ancillarydata.h.

◆ AJAAncillaryDataSpace_Unknown

#define AJAAncillaryDataSpace_Unknown AJAAncDataSpace_Unknown

Definition at line 1536 of file ancillarydata.h.

◆ AJAAncillaryDataSpace_VANC

#define AJAAncillaryDataSpace_VANC AJAAncDataSpace_VANC

Definition at line 1534 of file ancillarydata.h.

◆ AJAAncillaryDataSpaceToString

#define AJAAncillaryDataSpaceToString AJAAncDataSpaceToString

Definition at line 1541 of file ancillarydata.h.

◆ AJAAncillaryDataStream_1

#define AJAAncillaryDataStream_1 AJAAncDataStream_1

Definition at line 1543 of file ancillarydata.h.

◆ AJAAncillaryDataStream_2

#define AJAAncillaryDataStream_2 AJAAncDataStream_2

Definition at line 1544 of file ancillarydata.h.

◆ AJAAncillaryDataStream_3

#define AJAAncillaryDataStream_3 AJAAncDataStream_3

Definition at line 1545 of file ancillarydata.h.

◆ AJAAncillaryDataStream_4

#define AJAAncillaryDataStream_4 AJAAncDataStream_4

Definition at line 1546 of file ancillarydata.h.

◆ AJAAncillaryDataStream_Size

#define AJAAncillaryDataStream_Size AJAAncDataStream_Size

Definition at line 1548 of file ancillarydata.h.

◆ AJAAncillaryDataStream_Unknown

#define AJAAncillaryDataStream_Unknown AJAAncDataStream_Unknown

Definition at line 1547 of file ancillarydata.h.

◆ AJAAncillaryDataStreamToString

#define AJAAncillaryDataStreamToString AJAAncDataStreamToString

Definition at line 1552 of file ancillarydata.h.

◆ AJAAncillaryDataType_Cea608_Line21

#define AJAAncillaryDataType_Cea608_Line21 AJAAncDataType_Cea608_Line21

Definition at line 1569 of file ancillarydata.h.

◆ AJAAncillaryDataType_Cea608_Vanc

#define AJAAncillaryDataType_Cea608_Vanc AJAAncDataType_Cea608_Vanc

Definition at line 1568 of file ancillarydata.h.

◆ AJAAncillaryDataType_Cea708

#define AJAAncillaryDataType_Cea708 AJAAncDataType_Cea708

Definition at line 1567 of file ancillarydata.h.

◆ AJAAncillaryDataType_FrameStatusInfo524D

#define AJAAncillaryDataType_FrameStatusInfo524D AJAAncDataType_FrameStatusInfo524D

Definition at line 1572 of file ancillarydata.h.

◆ AJAAncillaryDataType_FrameStatusInfo5251

#define AJAAncillaryDataType_FrameStatusInfo5251 AJAAncDataType_FrameStatusInfo5251

Definition at line 1573 of file ancillarydata.h.

◆ AJAAncillaryDataType_HDR_HDR10

#define AJAAncillaryDataType_HDR_HDR10 AJAAncDataType_HDR_HDR10

Definition at line 1575 of file ancillarydata.h.

◆ AJAAncillaryDataType_HDR_HLG

#define AJAAncillaryDataType_HDR_HLG AJAAncDataType_HDR_HLG

Definition at line 1576 of file ancillarydata.h.

◆ AJAAncillaryDataType_HDR_SDR

#define AJAAncillaryDataType_HDR_SDR AJAAncDataType_HDR_SDR

Definition at line 1574 of file ancillarydata.h.

◆ AJAAncillaryDataType_Size

#define AJAAncillaryDataType_Size AJAAncDataType_Size

Definition at line 1577 of file ancillarydata.h.

◆ AJAAncillaryDataType_Smpte2016_3

#define AJAAncillaryDataType_Smpte2016_3 AJAAncDataType_Smpte2016_3

Definition at line 1564 of file ancillarydata.h.

◆ AJAAncillaryDataType_Smpte2051

#define AJAAncillaryDataType_Smpte2051 AJAAncDataType_Smpte2051

Definition at line 1571 of file ancillarydata.h.

◆ AJAAncillaryDataType_Smpte352

#define AJAAncillaryDataType_Smpte352 AJAAncDataType_Smpte352

Definition at line 1570 of file ancillarydata.h.

◆ AJAAncillaryDataType_Timecode_ATC

#define AJAAncillaryDataType_Timecode_ATC AJAAncDataType_Timecode_ATC

Definition at line 1565 of file ancillarydata.h.

◆ AJAAncillaryDataType_Timecode_VITC

#define AJAAncillaryDataType_Timecode_VITC AJAAncDataType_Timecode_VITC

Definition at line 1566 of file ancillarydata.h.

◆ AJAAncillaryDataType_Unknown

#define AJAAncillaryDataType_Unknown AJAAncDataType_Unknown

Definition at line 1563 of file ancillarydata.h.

◆ AJAAncillaryDataTypeToString

#define AJAAncillaryDataTypeToString AJAAncDataTypeToString

Definition at line 1580 of file ancillarydata.h.

◆ AJAAncillaryDataVideoStream_C

#define AJAAncillaryDataVideoStream_C AJAAncillaryDataChannel_C

Definition at line 1527 of file ancillarydata.h.

◆ AJAAncillaryDataVideoStream_Size

#define AJAAncillaryDataVideoStream_Size AJAAncillaryDataChannel_Size

Definition at line 1530 of file ancillarydata.h.

◆ AJAAncillaryDataVideoStream_Unknown

#define AJAAncillaryDataVideoStream_Unknown AJAAncillaryDataChannel_Unknown

Definition at line 1529 of file ancillarydata.h.

◆ AJAAncillaryDataVideoStream_Y

#define AJAAncillaryDataVideoStream_Y AJAAncillaryDataChannel_Y

Definition at line 1528 of file ancillarydata.h.

◆ FromAJAAncPktDIDSID

#define FromAJAAncPktDIDSID	(	_k_,
		_d_,
		_s_
	)	(_d_) = uint8_t(((_k_) & 0xFF00) >> 8); (_d_) = uint8_t(_k_ & 0x00FF);

Definition at line 30 of file ancillarydata.h.

◆ IS_GOOD_AJAAncDataLineNumber

#define IS_GOOD_AJAAncDataLineNumber ( _x_ ) ((_x_) > 0 && (_x_) < AJAAncDataLineNumber_DontCare)

Definition at line 203 of file ancillarydata.h.

◆ IS_HANC_AJAAncDataSpace

#define IS_HANC_AJAAncDataSpace ( _x_ ) ((_x_) == AJAAncDataSpace_HANC)

Definition at line 183 of file ancillarydata.h.

◆ IS_HANC_AJAAncillaryDataSpace

#define IS_HANC_AJAAncillaryDataSpace IS_HANC_AJAAncDataSpace

Definition at line 1539 of file ancillarydata.h.

◆ IS_IRRELEVANT_AJAAncDataLineNumber

#define IS_IRRELEVANT_AJAAncDataLineNumber ( _x_ ) ((_x_) == AJAAncDataLineNumber_DontCare)

Definition at line 202 of file ancillarydata.h.

◆ IS_KNOWN_AJAAncBufferFormat

#define IS_KNOWN_AJAAncBufferFormat ( _x_ ) ((_x_) > AJAAncBufferFormat_Unknown && (_x_) < AJAAncBufferFormat_Size)

Definition at line 507 of file ancillarydata.h.

◆ IS_KNOWN_AJAAncDataType

#define IS_KNOWN_AJAAncDataType ( _x_ ) ((_x_) > AJAAncDataType_Unknown && (_x_) < AJAAncDataType_Size)

Definition at line 64 of file ancillarydata.h.

◆ IS_KNOWN_AJAAncillaryBufferFormat

#define IS_KNOWN_AJAAncillaryBufferFormat ( _x_ ) IS_KNOWN_AJAAncBufferFormat(_x_)

Definition at line 1599 of file ancillarydata.h.

◆ IS_KNOWN_AJAAncillaryDataType

#define IS_KNOWN_AJAAncillaryDataType IS_KNOWN_AJAAncDataType

Definition at line 1579 of file ancillarydata.h.

◆ IS_LINKA_AJAAncDataStream

#define IS_LINKA_AJAAncDataStream ( _x_ ) ((_x_) == AJAAncDataStream_1)

Definition at line 113 of file ancillarydata.h.

◆ IS_LINKA_AJAAncillaryDataStream

#define IS_LINKA_AJAAncillaryDataStream IS_LINKA_AJAAncDataStream

Definition at line 1550 of file ancillarydata.h.

◆ IS_LINKB_AJAAncDataStream

#define IS_LINKB_AJAAncDataStream ( _x_ ) ((_x_) == AJAAncDataStream_2)

Definition at line 114 of file ancillarydata.h.

◆ IS_LINKB_AJAAncillaryDataStream

#define IS_LINKB_AJAAncillaryDataStream IS_LINKB_AJAAncDataStream

Definition at line 1551 of file ancillarydata.h.

◆ IS_UNKNOWN_AJAAncDataLineNumber

#define IS_UNKNOWN_AJAAncDataLineNumber ( _x_ ) ((_x_) == AJAAncDataLineNumber_Unknown)

Definition at line 201 of file ancillarydata.h.

◆ IS_VALID_AJAAncBufferFormat

#define IS_VALID_AJAAncBufferFormat ( _x_ ) ((_x_) >= AJAAncBufferFormat_Unknown && (_x_) < AJAAncBufferFormat_Size)

Definition at line 506 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataChannel

#define IS_VALID_AJAAncDataChannel ( _x_ ) ((_x_) >= AJAAncDataChannel_C && (_x_) < AJAAncDataChannel_Unknown)

Definition at line 137 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataCoding

#define IS_VALID_AJAAncDataCoding ( _x_ ) ((_x_) >= AJAAncDataCoding_Digital && (_x_) < AJAAncDataCoding_Size)

Definition at line 481 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataLink

#define IS_VALID_AJAAncDataLink ( _x_ ) ((_x_) >= AJAAncDataLink_A && (_x_) < AJAAncDataLink_Unknown)

Definition at line 88 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataSpace

#define IS_VALID_AJAAncDataSpace ( _x_ ) ((_x_) >= AJAAncDataSpace_VANC && (_x_) < AJAAncDataSpace_Unknown)

Definition at line 182 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataStream

#define IS_VALID_AJAAncDataStream ( _x_ ) ((_x_) >= AJAAncDataStream_1 && (_x_) < AJAAncDataStream_Unknown)

Definition at line 112 of file ancillarydata.h.

◆ IS_VALID_AJAAncDataType

#define IS_VALID_AJAAncDataType ( _x_ ) ((_x_) >= AJAAncDataType_Unknown && (_x_) < AJAAncDataType_Size)

Definition at line 63 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryBufferFormat

#define IS_VALID_AJAAncillaryBufferFormat ( _x_ ) IS_VALID_AJAAncBufferFormat(_x_)

Definition at line 1598 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataChannel

#define IS_VALID_AJAAncillaryDataChannel IS_VALID_AJAAncDataChannel

Definition at line 1531 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataCoding

#define IS_VALID_AJAAncillaryDataCoding ( _x_ ) IS_VALID_AJAAncDataCoding(_x_)

Definition at line 1589 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataLink

#define IS_VALID_AJAAncillaryDataLink IS_VALID_AJAAncDataLink

Definition at line 1560 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataSpace

#define IS_VALID_AJAAncillaryDataSpace IS_VALID_AJAAncDataSpace

Definition at line 1538 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataStream

#define IS_VALID_AJAAncillaryDataStream IS_VALID_AJAAncDataStream

Definition at line 1549 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataType

#define IS_VALID_AJAAncillaryDataType IS_VALID_AJAAncDataType

Definition at line 1578 of file ancillarydata.h.

◆ IS_VALID_AJAAncillaryDataVideoStream

#define IS_VALID_AJAAncillaryDataVideoStream ( _x_ ) (IS_VALID_AJAAncDataChannel(_x_))

Definition at line 1526 of file ancillarydata.h.

◆ IS_VALID_AncChannelSearchSelect

#define IS_VALID_AncChannelSearchSelect ( _x_ ) ((_x_) >= AncChannelSearch_Y && (_x_) < AncChannelSearch_Invalid)

Definition at line 159 of file ancillarydata.h.

◆ IS_VANC_AJAAncDataSpace

#define IS_VANC_AJAAncDataSpace ( _x_ ) ((_x_) == AJAAncDataSpace_VANC)

Definition at line 184 of file ancillarydata.h.

◆ IS_VANC_AJAAncillaryDataSpace

#define IS_VANC_AJAAncillaryDataSpace IS_VANC_AJAAncDataSpace

Definition at line 1540 of file ancillarydata.h.

◆ ToAJAAncPktDIDSID

#define ToAJAAncPktDIDSID	(	_d_,
		_s_
	)	(uint16_t((_d_) << 8) \| uint16_t(_s_))

Definition at line 29 of file ancillarydata.h.

Typedef Documentation

◆ AJAAncData

typedef AJAAncillaryData AJAAncData

Definition at line 1098 of file ancillarydata.h.

◆ AJAAncDataLoc

typedef struct AJAAncDataLoc AJAAncDataLoc

Defines where the ancillary data can be found within a video stream.

◆ AJAAncDataLocPtr

typedef AJAAncDataLoc* AJAAncDataLocPtr

Definition at line 451 of file ancillarydata.h.

◆ AJAAncDIDSIDPair

typedef std::pair<uint8_t, uint8_t> AJAAncDIDSIDPair

Definition at line 27 of file ancillarydata.h.

◆ AJAAncillaryBufferFormat

typedef AJAAncBufferFormat AJAAncillaryBufferFormat

Definition at line 1511 of file ancillarydata.h.

◆ AJAAncillaryDataChannel

typedef AJAAncDataChannel AJAAncillaryDataChannel

Definition at line 1512 of file ancillarydata.h.

◆ AJAAncillaryDataCoding

typedef AJAAncDataCoding AJAAncillaryDataCoding

Definition at line 1510 of file ancillarydata.h.

◆ AJAAncillaryDataLink

typedef AJAAncDataLink AJAAncillaryDataLink

Definition at line 1506 of file ancillarydata.h.

◆ AJAAncillaryDataLocation

typedef AJAAncDataLoc AJAAncillaryDataLocation

Definition at line 450 of file ancillarydata.h.

◆ AJAAncillaryDataLocationPtr

typedef AJAAncillaryDataLocation* AJAAncillaryDataLocationPtr

Definition at line 1509 of file ancillarydata.h.

◆ AJAAncillaryDataSpace

typedef AJAAncDataSpace AJAAncillaryDataSpace

Definition at line 1504 of file ancillarydata.h.

◆ AJAAncillaryDataStream

typedef AJAAncDataStream AJAAncillaryDataStream

Definition at line 1505 of file ancillarydata.h.

◆ AJAAncillaryDataType

typedef AJAAncDataType AJAAncillaryDataType

Definition at line 1507 of file ancillarydata.h.

◆ AJAAncillaryDataVideoStream

typedef AJAAncillaryDataChannel AJAAncillaryDataVideoStream

Definition at line 1514 of file ancillarydata.h.

◆ AJAAncillaryDIDSIDPair

typedef std::pair<uint8_t, uint8_t> AJAAncillaryDIDSIDPair

A DID/SID pair, typically used as an indexing key.

Definition at line 27 of file ancillarydata.h.

◆ AJAAncPacket

typedef AJAAncillaryData AJAAncPacket

Definition at line 1098 of file ancillarydata.h.

◆ AJAAncPktDIDSID

typedef uint16_t AJAAncPktDIDSID

Packet DID/SID pair: DID (MS 8 bits) and SID (LS 8 bits)

Definition at line 28 of file ancillarydata.h.

Enumeration Type Documentation

◆ AJAAncBufferFormat

enum AJAAncBufferFormat

Identifies the type of anc buffer the packet originated from: GUMP, RTP, VANC, or unknown.

Enumerator
AJAAncBufferFormat_Unknown	Unknown or "don't care".
AJAAncBufferFormat_FBVANC	Frame buffer VANC line.
AJAAncBufferFormat_SDI	SDI ("GUMP").
AJAAncBufferFormat_RTP	RTP/IP.
AJAAncBufferFormat_Invalid	Invalid.
AJAAncBufferFormat_Size

Definition at line 495 of file ancillarydata.h.

◆ AJAAncDataChannel

enum AJAAncDataChannel

Identifies which component of a video stream in which the ancillary data is placed or found.

Enumerator
AJAAncDataChannel_C	The ancillary data is associated with the chrominance (C) channel of the video stream.
AJAAncDataChannel_Both	SD ONLY – The ancillary data is associated with both the chroma and luma channels.
AJAAncDataChannel_Y	The ancillary data is associated with the luminance (Y) channel of the video stream.
AJAAncDataChannel_Unknown	It is not known which channel of the video stream the ancillary data is associated with.
AJAAncDataChannel_Size

Definition at line 128 of file ancillarydata.h.

◆ AJAAncDataCoding

enum AJAAncDataCoding

Identifies the ancillary data coding type: digital or non-digital (analog/raw).

Enumerator
AJAAncDataCoding_Digital	The ancillary data is in the form of a SMPTE-291 Ancillary Packet.
AJAAncDataCoding_Raw	The ancillary data is in the form of a digitized waveform (e.g. CEA-608 captions, VITC, etc.).
AJAAncDataCoding_Unknown	It is not known which coding type the ancillary data is using.
AJAAncDataCoding_Size

Definition at line 473 of file ancillarydata.h.

◆ AJAAncDataLink

enum AJAAncDataLink

Identifies which link of a video stream the ancillary data is associated with.

Enumerator
AJAAncDataLink_A	The ancillary data is associated with Link A of the video stream.
AJAAncDataLink_B	The ancillary data is associated with Link B of the video stream.
AJAAncDataLink_LeftEye	The ancillary data is associated with the Left Eye stereoscopic video stream.
AJAAncDataLink_RightEye	The ancillary data is associated with the Right Eye stereoscopic video stream.
AJAAncDataLink_Unknown	It is not known which link of the video stream the ancillary data is associated with.
AJAAncDataLink_Size

Definition at line 78 of file ancillarydata.h.

◆ AJAAncDataSpace

enum AJAAncDataSpace

Identified the raster section of a video stream that contains the ancillary data. Deprecated in favor of Horizontal Offset – AJAAncDataHorizOffset_AnyVanc and AJAAncDataHorizOffset_AnyHanc.

Enumerator
AJAAncDataSpace_VANC	Ancillary data found between SAV and EAV (. See also AJAAncDataHorizOffset_AnyVanc).
AJAAncDataSpace_HANC	Ancillary data found between EAV and SAV (. See also AJAAncDataHorizOffset_AnyHanc).
AJAAncDataSpace_Unknown	It's unknown which raster section contains the ancillary data (. See also AJAAncDataHorizOffset_Unknown).
AJAAncDataSpace_Size

Definition at line 174 of file ancillarydata.h.

◆ AJAAncDataStream

enum AJAAncDataStream

Identifies which data stream the ancillary data is associated with.

Enumerator
AJAAncDataStream_1	The ancillary data is associated with DS1 of the video stream (Link A).
AJAAncDataStream_2	The ancillary data is associated with DS2 of the video stream (Link A).
AJAAncDataStream_3	The ancillary data is associated with DS3 of the video stream (Link B).
AJAAncDataStream_4	The ancillary data is associated with DS4 of the video stream (Link B).
AJAAncDataStream_Unknown	It is not known which data stream the ancillary data is associated with.
AJAAncDataStream_Size

Definition at line 102 of file ancillarydata.h.

◆ AJAAncDataType

enum AJAAncDataType

Identifies the ancillary data types that are known to this module.

Enumerator
AJAAncDataType_Unknown	Includes data that is valid, but we don't recognize.
AJAAncDataType_Smpte2016_3	SMPTE 2016-3 VANC Aspect Format Description (AFD) metadata.
AJAAncDataType_Timecode_ATC	SMPTE 12-M Ancillary Timecode (formerly known as "RP-188")
AJAAncDataType_Timecode_VITC	SMPTE 12-M Vertical Interval Timecode (aka "VITC")
AJAAncDataType_Cea708	CEA708 (SMPTE 334) HD Closed Captioning.
AJAAncDataType_Cea608_Vanc	CEA608 SD Closed Captioning (SMPTE 334 VANC packet)
AJAAncDataType_Cea608_Line21	CEA608 SD Closed Captioning ("Line 21" waveform)
AJAAncDataType_Smpte352	SMPTE 352 "Payload ID".
AJAAncDataType_Smpte2051	SMPTE 2051 "Two Frame Marker".
AJAAncDataType_FrameStatusInfo524D	Frame Status Information, such as Active Frame flag.
AJAAncDataType_FrameStatusInfo5251	Frame Status Information, such as Active Frame flag.
AJAAncDataType_HDR_SDR
AJAAncDataType_HDR_HDR10
AJAAncDataType_HDR_HLG
AJAAncDataType_Size

Definition at line 44 of file ancillarydata.h.

◆ AncChannelSearchSelect

enum AncChannelSearchSelect

Specifies which channel of a video stream in which to look for Anc data.

Enumerator
AncChannelSearch_Y	Only look in luma samples.
AncChannelSearch_C	Only look in chroma samples.
AncChannelSearch_Both	Look both luma and chroma samples (SD only)
AncChannelSearch_Invalid	Invalid.

Definition at line 151 of file ancillarydata.h.

Function Documentation

◆ AJAAncBufferFormatToString()

const std::string& AJAAncBufferFormatToString	(	const AJAAncBufferFormat	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncBufferFormat value (or empty if invalid).

Parameters

[in]	inValue	Specifies the AJAAncBufferFormat to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1279 of file ancillarydata.cpp.

◆ AJAAncDataChannelToString()

const std::string& AJAAncDataChannelToString	(	const AJAAncDataChannel	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataChannel value (or empty if not possible).

Parameters

[in]	inValue	Specifies the AJAAncDataChannel value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1151 of file ancillarydata.cpp.

◆ AJAAncDataCodingToString()

const std::string& AJAAncDataCodingToString	(	const AJAAncDataCoding	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataCoding value (or empty if invalid).

Parameters

[in]	inValue	Specifies the AJAAncDataCoding to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1270 of file ancillarydata.cpp.

◆ AJAAncDataLinkToString()

const std::string& AJAAncDataLinkToString	(	const AJAAncDataLink	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataLink value (or empty if not possible).

Parameters

[in]	inValue	Specifies the AJAAncDataLink value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1132 of file ancillarydata.cpp.

◆ AJAAncDataLocToString()

std::string AJAAncDataLocToString	(	const AJAAncDataLoc &	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataLoc value (or empty if invalid).

Parameters

[in]	inValue	Specifies the AJAAncDataLoc to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1257 of file ancillarydata.cpp.

◆ AJAAncDataSpaceToString()

const std::string& AJAAncDataSpaceToString	(	const AJAAncDataSpace	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataSpace value (or empty if not possible).

Parameters

[in]	inValue	Specifies the AJAAncDataSpace value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1160 of file ancillarydata.cpp.

◆ AJAAncDataStreamToString()

const std::string& AJAAncDataStreamToString	(	const AJAAncDataStream	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataStream value (or empty if not possible).

Parameters

[in]	inValue	Specifies the AJAAncDataStream value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1141 of file ancillarydata.cpp.

◆ AJAAncDataTypeToString()

const std::string& AJAAncDataTypeToString	(	const AJAAncDataType	inValue,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AJAAncDataType value (or empty if not possible).

Parameters

[in]	inValue	Specifies the AJAAncDataType value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise use the longer symbolic format.

Definition at line 1289 of file ancillarydata.cpp.

◆ AJAAncHorizOffsetToString()

std::string AJAAncHorizOffsetToString ( const uint16_t inValue )

Returns: A string containing a human-readable representation of the given horizontal offset location value.

Parameters

[in] inValue Specifies the horizontal offset location value to be converted.

Definition at line 1186 of file ancillarydata.cpp.

◆ AJAAncillaryDataVideoStreamToString()

const std::string& AJAAncillaryDataVideoStreamToString	(	const AJAAncillaryDataVideoStream	inValue,
		const bool	inCompact = `true`
	)

inline

Definition at line 1516 of file ancillarydata.h.

◆ AJAAncLineNumberToString()

std::string AJAAncLineNumberToString ( const uint16_t inValue )

Definition at line 1169 of file ancillarydata.cpp.

◆ AncChannelSearchSelectToString()

std::string AncChannelSearchSelectToString	(	const AncChannelSearchSelect	inSelect,
		const bool	inCompact = `true`
	)

Returns: A string containing a human-readable representation of the given AncChannelSearchSelect value (or empty if not possible).

Parameters

[in]	inSelect	Specifies the AncChannelSearchSelect value to be converted.
[in]	inCompact	If true (the default), returns the compact representation; otherwise returns the longer symbolic format.

Definition at line 1533 of file ancillarydata.cpp.

◆ operator<<() [1/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAAncDataLoc &	inData
	)

Writes a human-readable rendition of the given AJAAncDataLoc into the given output stream.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inData	Specifies the AJAAncDataLoc to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

◆ operator<<() [2/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAAncDIDSIDPair &	inData
	)

Writes a human-readable rendition of the given AJAAncDIDSIDPair into the given output stream.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inData	Specifies the AJAAncDIDSIDPair to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

◆ operator<<() [3/5]

static std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAAncillaryData &	inAncData
	)

inlinestatic

Writes a human-readable rendition of the given AJAAncillaryData into the given output stream.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inAncData	Specifies the AJAAncillaryData to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

Definition at line 1107 of file ancillarydata.h.

◆ operator<<() [4/5]

static std::ostream& operator<<	(	std::ostream &	inOutStrm,
		const AJARTPAncPacketHeader &	inObj
	)

inlinestatic

Streams a human-readable representation of the given AJARTPAncPacketHeader to the given output stream.

Parameters

[in]	inOutStrm	Specifies the output stream to receive my state information.
[in]	inObj	Specifies the AJARTPAncPacketHeader of interest.

Returns: A non-constant reference to the given output stream.

Definition at line 1499 of file ancillarydata.h.

◆ operator<<() [5/5]

static std::ostream& operator<<	(	std::ostream &	inOutStrm,
		const AJARTPAncPayloadHeader &	inObj
	)

inlinestatic

Streams a human-readable representation of the given AJARTPAncPayloadHeader to the given output stream.

Parameters

[in]	inOutStrm	Specifies the output stream to receive the payload header's state information.
[in]	inObj	Specifies the AJARTPAncPayloadHeader of interest.

Returns: A non-constant reference to the given output stream.

Definition at line 1356 of file ancillarydata.h.

Variable Documentation

◆ AJAAncData_AnalogDID

const uint8_t AJAAncData_AnalogDID = 0x00

Definition at line 24 of file ancillarydata.h.

◆ AJAAncData_AnalogSID

const uint8_t AJAAncData_AnalogSID = 0x00

Definition at line 25 of file ancillarydata.h.

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ AJAAncDataHorizOffset_AnyHanc

◆ AJAAncDataHorizOffset_AnyVanc

◆ AJAAncDataHorizOffset_Anywhere

◆ AJAAncDataHorizOffset_Future

◆ AJAAncDataHorizOffset_Unknown

◆ AJAAncDataLineNumber_AnyVanc

◆ AJAAncDataLineNumber_Anywhere

◆ AJAAncDataLineNumber_DontCare

◆ AJAAncDataLineNumber_Future

◆ AJAAncDataLineNumber_Unknown

◆ AJAAncillaryBufferFormat_FBVANC

◆ AJAAncillaryBufferFormat_Invalid

◆ AJAAncillaryBufferFormat_RTP

◆ AJAAncillaryBufferFormat_SDI

◆ AJAAncillaryBufferFormat_Size

◆ AJAAncillaryBufferFormat_Unknown

◆ AJAAncillaryBufferFormatToString

◆ AJAAncillaryData_AnalogDID

◆ AJAAncillaryData_AnalogSID

◆ AJAAncillaryDataChannel_Both

◆ AJAAncillaryDataChannel_C

◆ AJAAncillaryDataChannel_Size

◆ AJAAncillaryDataChannel_Unknown

◆ AJAAncillaryDataChannel_Y

◆ AJAAncillaryDataChannelToString

◆ AJAAncillaryDataCoding_Analog

◆ AJAAncillaryDataCoding_Digital

◆ AJAAncillaryDataCoding_Raw

◆ AJAAncillaryDataCoding_Size

◆ AJAAncillaryDataCoding_Unknown

◆ AJAAncillaryDataCodingToString

◆ AJAAncillaryDataLink_A

◆ AJAAncillaryDataLink_B

◆ AJAAncillaryDataLink_LeftEye

◆ AJAAncillaryDataLink_RightEye

◆ AJAAncillaryDataLink_Size

◆ AJAAncillaryDataLink_Unknown

◆ AJAAncillaryDataLinkToString

◆ AJAAncillaryDataSpace_HANC

◆ AJAAncillaryDataSpace_Size

◆ AJAAncillaryDataSpace_Unknown

◆ AJAAncillaryDataSpace_VANC

◆ AJAAncillaryDataSpaceToString

◆ AJAAncillaryDataStream_1

◆ AJAAncillaryDataStream_2

◆ AJAAncillaryDataStream_3

◆ AJAAncillaryDataStream_4

◆ AJAAncillaryDataStream_Size

◆ AJAAncillaryDataStream_Unknown

◆ AJAAncillaryDataStreamToString

◆ AJAAncillaryDataType_Cea608_Line21

◆ AJAAncillaryDataType_Cea608_Vanc

◆ AJAAncillaryDataType_Cea708

◆ AJAAncillaryDataType_FrameStatusInfo524D

◆ AJAAncillaryDataType_FrameStatusInfo5251

◆ AJAAncillaryDataType_HDR_HDR10

◆ AJAAncillaryDataType_HDR_HLG

◆ AJAAncillaryDataType_HDR_SDR

◆ AJAAncillaryDataType_Size

◆ AJAAncillaryDataType_Smpte2016_3

◆ AJAAncillaryDataType_Smpte2051

◆ AJAAncillaryDataType_Smpte352

◆ AJAAncillaryDataType_Timecode_ATC

◆ AJAAncillaryDataType_Timecode_VITC

◆ AJAAncillaryDataType_Unknown

◆ AJAAncillaryDataTypeToString

◆ AJAAncillaryDataVideoStream_C

◆ AJAAncillaryDataVideoStream_Size

◆ AJAAncillaryDataVideoStream_Unknown

◆ AJAAncillaryDataVideoStream_Y

◆ FromAJAAncPktDIDSID

◆ IS_GOOD_AJAAncDataLineNumber