ntv2publicinterface.cpp File Reference

Implementations of methods declared in 'ntv2publicinterface.h'. More...

#include "ntv2publicinterface.h"
#include "ntv2devicefeatures.h"
#include "ntv2utils.h"
#include "ntv2endian.h"
#include "ajabase/system/memory.h"
#include "ajabase/system/debug.h"
#include "ajabase/common/common.h"
#include "ntv2registerexpert.h"
#include "ntv2nubtypes.h"
#include "ntv2version.h"
#include <iomanip>
#include <locale>
#include <string.h>
#include <algorithm>
#include <iterator>
#include "ntv2rp188.h"
#include <unistd.h>

Include dependency graph for ntv2publicinterface.cpp:

Go to the source code of this file.

Classes
struct	ThousandsSeparator

Macros
#define	AsU8Ref(_x_)   reinterpret_cast<uint8_t&>(_x_)
#define	AsU16Ref(_x_)   reinterpret_cast<uint16_t&>(_x_)
#define	AsU32Ref(_x_)   reinterpret_cast<uint32_t&>(_x_)
#define	AsU64Ref(_x_)   reinterpret_cast<uint64_t&>(_x_)

Functions
ostream &	operator<< (ostream &inOutStr, const NTV2AudioChannelPairs &inSet)
ostream &	operator<< (ostream &inOutStr, const NTV2AudioChannelQuads &inSet)
ostream &	operator<< (ostream &inOutStr, const NTV2AudioChannelOctets &inSet)
ostream &	operator<< (ostream &inOutStr, const NTV2DoubleArray &inVector)
ostream &	operator<< (ostream &inOutStr, const NTV2DIDSet &inDIDs)
ostream &	operator<< (ostream &inOutStream, const UWordSequence &inData)
ostream &	operator<< (ostream &inOutStream, const ULWordSequence &inData)
ostream &	operator<< (ostream &inOutStream, const ULWord64Sequence &inData)
ostream &	operator<< (ostream &inOutStream, const NTV2_HEADER &inObj)
ostream &	operator<< (ostream &inOutStream, const NTV2_TRAILER &inObj)
ostream &	operator<< (ostream &inOutStream, const NTV2Buffer &inObj)
static string	print_address_offset (const size_t inRadix, const ULWord64 inOffset)
ostream &	operator<< (ostream &inOutStream, const NTV2_RP188 &inObj)
NTV2TimeCodeList &	operator<< (NTV2TimeCodeList &inOutList, const NTV2_RP188 &inRP188)
	Appends the given NTV2_RP188 struct to the specified NTV2TimeCodeList. More...
ostream &	operator<< (ostream &inOutStream, const NTV2TimeCodeList &inObj)
ostream &	operator<< (std::ostream &inOutStream, const NTV2TimeCodes &inObj)
	Streams the given NTV2TimeCodes map to the specified ostream in a human-readable format. More...
ostream &	operator<< (std::ostream &inOutStream, const NTV2TCIndexes &inObj)
	Streams the given NTV2TCIndexes to the specified ostream in a human-readable format. More...
NTV2TCIndexes &	operator+= (NTV2TCIndexes &inOutSet, const NTV2TCIndexes &inSet)
	Appends the given NTV2TCIndexes contents into the given set. More...
ostream &	operator<< (ostream &inOutStream, const FRAME_STAMP &inObj)
ostream &	operator<< (ostream &inOutStream, const NTV2SegmentedDMAInfo &inObj)
ostream &	operator<< (ostream &inOutStream, const AUTOCIRCULATE_TRANSFER &inObj)
ostream &	operator<< (ostream &inOutStream, const AUTOCIRCULATE_TRANSFER_STATUS &inObj)
ostream &	operator<< (ostream &inOutStream, const NTV2RegisterValueMap &inObj)
ostream &	operator<< (ostream &inOutStream, const AutoCircVidProcInfo &inObj)
ostream &	operator<< (ostream &inOutStream, const NTV2ColorCorrectionData &inObj)
ostream &	operator<< (ostream &inOStream, const NTV2VideoFormatSet &inFormats)
ostream &	operator<< (ostream &inOStream, const NTV2PixelFormats &inFormats)
NTV2PixelFormats &	operator+= (NTV2PixelFormats &inOutSet, const NTV2PixelFormats inFBFs)
	Appends the given NTV2FrameBufferFormatSet contents into the given set. More...
ostream &	operator<< (ostream &inOStream, const NTV2StandardSet &inStandards)
NTV2StandardSet &	operator+= (NTV2StandardSet &inOutSet, const NTV2StandardSet inSet)
	Appends the given NTV2StandardSet contents into the given set. More...
ostream &	operator<< (ostream &inOStream, const NTV2GeometrySet &inGeometries)
NTV2GeometrySet &	operator+= (NTV2GeometrySet &inOutSet, const NTV2GeometrySet inSet)
	Appends the given NTV2GeometrySet contents into the given set. More...
ostream &	operator<< (ostream &inOStream, const NTV2InputSourceSet &inSet)
NTV2InputSourceSet &	operator+= (NTV2InputSourceSet &inOutSet, const NTV2InputSourceSet &inSet)
	Appends the given NTV2InputSourceSet's contents into the given set. More...
ostream &	operator<< (ostream &inOStream, const NTV2OutputDestinations &inSet)
NTV2OutputDestinations &	operator+= (NTV2OutputDestinations &inOutSet, const NTV2OutputDestinations &inSet)
	Appends the given NTV2OutputDestinations' contents into the given set. More...
bool	NTV2GetSupportedPixelFormats (NTV2PixelFormats &outFormats)
	Returns a set of all NTV2PixelFormat values supported (used) by any/all supported NTV2 devices. More...
bool	NTV2GetUnsupportedPixelFormats (NTV2PixelFormats &outFormats)
	Returns a set of NTV2PixelFormat values not suported by any NTV2 device. More...
bool	NTV2GetSupportedStandards (NTV2StandardSet &outStandards)
	Returns a set of all NTV2Standard values supported (used) by any/all supported NTV2 devices. More...
bool	NTV2GetUnsupportedStandards (NTV2StandardSet &outStandards)
	Returns a set of NTV2Standard values not suported by any NTV2 device. More...
bool	NTV2DeviceGetSupportedVideoFormats (const NTV2DeviceID inDeviceID, NTV2VideoFormatSet &outFormats)
	Returns a set of distinct NTV2VideoFormat values supported on the given device. More...
bool	NTV2DeviceGetSupportedPixelFormats (const NTV2DeviceID inDeviceID, NTV2PixelFormats &outFormats)
	Returns a set of distinct NTV2FrameBufferFormat values supported on the given device. More...
bool	NTV2DeviceGetSupportedStandards (const NTV2DeviceID inDeviceID, NTV2StandardSet &outStandards)
	Returns a set of distinct NTV2Standard values supported on the given device. More...
bool	NTV2DeviceGetSupportedGeometries (const NTV2DeviceID inDeviceID, NTV2GeometrySet &outGeometries)
	Returns a set of distinct NTV2FrameGeometry values supported on the given device. More...
bool	NTV2DeviceGetSupportedInputSources (const NTV2DeviceID inDeviceID, NTV2InputSourceSet &outInputSources, const NTV2IOKinds inKinds)
	Returns a set of distinct NTV2InputSource values supported on the given device. More...
bool	NTV2DeviceGetSupportedOutputDests (const NTV2DeviceID inDeviceID, NTV2OutputDestinations &outOutputDests, const NTV2IOKinds inKinds)
	Returns a set of distinct NTV2OutputDest values supported on the given device. More...
ostream &	operator<< (ostream &oss, const NTV2FrameRateSet &inSet)
NTV2FrameRateSet &	operator+= (NTV2FrameRateSet &inOutSet, const NTV2FrameRateSet &inSet)
	Appends the given NTV2FrameRateSet into the given set. More...
bool	NTV2DeviceGetSupportedFrameRates (const NTV2DeviceID inDeviceID, NTV2FrameRateSet &outRates)
	Returns a set of distinct NTV2FrameRate values supported on the given device. More...
ostream &	operator<< (ostream &inOutStrm, const NTV2SegmentedXferInfo &inRun)
string	NTV2AutoCirculateStateToString (const NTV2AutoCirculateState inState)
static size_t	gDefaultPageSize (AJA_PAGE_SIZE)
template<class T >
string	CommaStr (const T &inNum)
ostream &	operator<< (ostream &oss, const AUTOCIRCULATE_STATUS &inObj)
ostream &	NTV2PrintULWordVector (const NTV2ULWordVector &inObj, ostream &inOutStream)
ostream &	NTV2PrintChannelList (const NTV2ChannelList &inObj, const bool inCompact, ostream &inOutStream)
string	NTV2ChannelListToStr (const NTV2ChannelList &inObj, const bool inCompact)
ostream &	NTV2PrintChannelSet (const NTV2ChannelSet &inObj, const bool inCompact, ostream &inOutStream)
string	NTV2ChannelSetToStr (const NTV2ChannelSet &inObj, const bool inCompact)
NTV2ChannelSet	NTV2MakeChannelSet (const NTV2Channel inFirstChannel, const UWord inNumChannels)
NTV2ChannelSet	NTV2MakeChannelSet (const NTV2ChannelList inChannels)
NTV2ChannelList	NTV2MakeChannelList (const NTV2Channel inFirstChannel, const UWord inNumChannels)
NTV2ChannelList	NTV2MakeChannelList (const NTV2ChannelSet inChannels)
ostream &	NTV2PrintAudioSystemSet (const NTV2AudioSystemSet &inObj, const bool inCompact, std::ostream &inOutStream)
	Streams a human-readable dump of the given NTV2AudioSystemSet into the specified output stream. More...
string	NTV2AudioSystemSetToStr (const NTV2AudioSystemSet &inObj, const bool inCompact)
NTV2AudioSystemSet	NTV2MakeAudioSystemSet (const NTV2AudioSystem inFirstAudioSystem, const UWord inCount)
NTV2RegNumSet	GetRegisterNumbers (const NTV2RegReads &inRegInfos)
NTV2RegisterReadsConstIter	FindFirstMatchingRegisterNumber (const uint32_t inRegNum, const NTV2RegisterReads &inRegInfos)
	Returns a const iterator to the first entry in the NTV2RegInfo collection with a matching register number. More...
ostream &	operator<< (std::ostream &inOutStream, const NTV2RegInfo &inObj)
	Writes the given NTV2RegInfo to the specified output stream. More...
ostream &	operator<< (ostream &inOutStream, const NTV2RegisterWrites &inObj)

Variables
static const string	sSegXferUnits [] = {"", " U8", " U16", "", " U32", "", "", "", " U64", ""}
static const NTV2_RP188	INVALID_TIMECODE_VALUE

Detailed Description

Implementations of methods declared in 'ntv2publicinterface.h'.

Copyright

(C) 2016-2022 AJA Video Systems, Inc.

Definition in file ntv2publicinterface.cpp.

Macro Definition Documentation

AsU16Ref

#define AsU16Ref

(

_x_

)

reinterpret_cast<uint16_t&>(_x_)

Definition at line 3521 of file ntv2publicinterface.cpp.

AsU32Ref

#define AsU32Ref

(

_x_

)

reinterpret_cast<uint32_t&>(_x_)

Definition at line 3522 of file ntv2publicinterface.cpp.

AsU64Ref

#define AsU64Ref

(

_x_

)

reinterpret_cast<uint64_t&>(_x_)

Definition at line 3523 of file ntv2publicinterface.cpp.

AsU8Ref

#define AsU8Ref

(

_x_

)

reinterpret_cast<uint8_t&>(_x_)

Definition at line 3520 of file ntv2publicinterface.cpp.

Function Documentation

CommaStr()

template<class T >

string CommaStr

(

const T &

inNum

)

Definition at line 2496 of file ntv2publicinterface.cpp.

FindFirstMatchingRegisterNumber()

NTV2RegisterReadsConstIter FindFirstMatchingRegisterNumber	(	const uint32_t	inRegNum,
		const NTV2RegReads &	inRegInfos
	)

Returns a const iterator to the first entry in the NTV2RegInfo collection with a matching register number.

Parameters

[in]	inRegNum	Specifies the register number of interest.
[in]	inRegInfos	Specifies the NTV2RegInfo collection to search.

Returns

A const_iterator that references the entry in the NTV2RegInfo collection, or "end()" if not found.

Definition at line 3430 of file ntv2publicinterface.cpp.

gDefaultPageSize()

static size_t gDefaultPageSize ( AJA_PAGE_SIZE  )

static

GetRegisterNumbers()

NTV2RegNumSet GetRegisterNumbers

(

const NTV2RegReads &

inRegInfos

)

Parameters

[in]

inRegInfos

Specifies the NTV2RegInfo collection.

Returns

A set of unique register numbers contained in the NTV2RegInfo collection.

Definition at line 3421 of file ntv2publicinterface.cpp.

NTV2AudioSystemSetToStr()

string NTV2AudioSystemSetToStr	(	const NTV2AudioSystemSet &	inObj,
		const bool	inCompact = true
	)

Returns

A human-readable string containing a dump of the NTV2AudioSystemSet.

Parameters

[in]	inObj	Specifies the NTV2AudioSystemSet to be render.
	inCompact	Use 'true' for a compact display (the default); otherwise use 'false' for a long-format.

Definition at line 3406 of file ntv2publicinterface.cpp.

NTV2AutoCirculateStateToString()

string NTV2AutoCirculateStateToString

(

const NTV2AutoCirculateState

inState

)

Returns

A string that contains the human-readable representation of the given NTV2AutoCirculateState value.

Parameters

[in]

inState

Specifies the NTV2AutoCirculateState of interest.

Definition at line 1356 of file ntv2publicinterface.cpp.

NTV2ChannelListToStr()

string NTV2ChannelListToStr	(	const NTV2ChannelList &	inObj,
		const bool	inCompact = true
	)

Returns

A human-readable string containing a dump of the channel list.

Parameters

[in]	inObj	Specifies the NTV2ChannelList to be converted.
	inCompact	Use 'true' for a compact display (the default); otherwise use 'false' for a long-format.

Definition at line 3330 of file ntv2publicinterface.cpp.

NTV2ChannelSetToStr()

string NTV2ChannelSetToStr	(	const NTV2ChannelSet &	inObj,
		const bool	inCompact = true
	)

Returns

A human-readable string containing a dump of the channel set.

Parameters

[in]	inObj	Specifies the NTV2ChannelSet to be converted.
	inCompact	Use 'true' for a compact display (the default); otherwise use 'false' for a long-format.

Definition at line 3351 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedFrameRates()

bool NTV2DeviceGetSupportedFrameRates	(	const NTV2DeviceID	inDeviceID,
		NTV2FrameRateSet &	outRates
	)

Returns a set of distinct NTV2FrameRate values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest. Specify DEVICE_ID_INVALID to disable the "is supported" check.
[out]	outRates	Receives the requested NTV2FrameRateSet.

Returns

True if successful; otherwise false.

Todo:

Needs to be moved to a C++ compatible "device features" module.

Definition at line 1334 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedGeometries()

bool NTV2DeviceGetSupportedGeometries	(	const NTV2DeviceID	inDeviceID,
		NTV2GeometrySet &	outGeometries
	)

Returns a set of distinct NTV2FrameGeometry values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest.
[out]	outGeometries	Receives the set of distinct NTV2FrameGeometry values supported by the device.

Returns

True if successful; otherwise false.

Todo:

Needs to be moved to a C++ compatible "device features" module.

Definition at line 1262 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedInputSources()

bool NTV2DeviceGetSupportedInputSources	(	const NTV2DeviceID	inDeviceID,
		NTV2InputSourceSet &	outInputSources,
		const NTV2IOKinds	inKinds = NTV2_IOKINDS_ALL
	)

Returns a set of distinct NTV2InputSource values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest. Specify DEVICE_ID_INVALID to disable the "is supported" check.
[out]	outInputSources	Receives the set of distinct NTV2InputSource values supported by the device.
[in]	inKinds	Specifies the kinds of inputs of interest. Defaults to ALL.

Returns

True if successful; otherwise false.

Todo:

Needs to be moved to a C++ compatible "device features" module.

Definition at line 1277 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedOutputDests()

bool NTV2DeviceGetSupportedOutputDests	(	const NTV2DeviceID	inDeviceID,
		NTV2OutputDestinations &	outOutputDests,
		const NTV2IOKinds	inKinds = NTV2_IOKINDS_ALL
	)

Returns a set of distinct NTV2OutputDest values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest. Specify DEVICE_ID_INVALID to disable the "is supported" check.
[out]	outOutputSources	Receives the set of distinct NTV2OutputDest values supported by the device.
[in]	inKinds	Specifies the kinds of outputs of interest. Defaults to ALL.

Returns

True if successful; otherwise false.

Todo:

Needs to be moved to a C++ compatible "device features" module.

Definition at line 1293 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedPixelFormats()

bool NTV2DeviceGetSupportedPixelFormats	(	const NTV2DeviceID	inDeviceID,
		NTV2PixelFormats &	outFormats
	)

Returns a set of distinct NTV2FrameBufferFormat values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest.
[out]	outFormats	Receives the set of distinct NTV2FrameBufferFormat values supported by the device.

Returns

True if successful; otherwise false.

Todo:

This needs to be moved to a C++ compatible "device features" module.

Definition at line 1222 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedStandards()

bool NTV2DeviceGetSupportedStandards	(	const NTV2DeviceID	inDeviceID,
		NTV2StandardSet &	outStandards
	)

Returns a set of distinct NTV2Standard values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest.
[out]	outStandards	Receives the set of distinct NTV2Standard values supported by the device.

Returns

True if successful; otherwise false.

Todo:

This needs to be moved to a C++ compatible "device features" module.

Definition at line 1246 of file ntv2publicinterface.cpp.

NTV2DeviceGetSupportedVideoFormats()

bool NTV2DeviceGetSupportedVideoFormats	(	const NTV2DeviceID	inDeviceID,
		NTV2VideoFormatSet &	outFormats
	)

Returns a set of distinct NTV2VideoFormat values supported on the given device.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest. Specify DEVICE_ID_INVALID to return ALL known video formats.
[out]	outFormats	Receives the set of requested distinct NTV2VideoFormat values.

Returns

True if successful; otherwise false.

Todo:

This needs to be moved to a C++ compatible "device features" module.

Definition at line 1193 of file ntv2publicinterface.cpp.

NTV2GetSupportedPixelFormats()

bool NTV2GetSupportedPixelFormats

(

NTV2PixelFormats &

outFormats

)

Returns a set of all NTV2PixelFormat values supported (used) by any/all supported NTV2 devices.

Parameters

[out]

outFormats

Receives the set of NTV2PixelFormats supported by any/all NTV2 devices.

Returns

True if successful; otherwise false.

Definition at line 1141 of file ntv2publicinterface.cpp.

NTV2GetSupportedStandards()

bool NTV2GetSupportedStandards

(

NTV2StandardSet &

outStandards

)

Returns a set of all NTV2Standard values supported (used) by any/all supported NTV2 devices.

Parameters

[out]

outStandards

Receives the set of NTV2Standards supported by any/all NTV2 devices.

Returns

True if successful; otherwise false.

Definition at line 1166 of file ntv2publicinterface.cpp.

NTV2GetUnsupportedPixelFormats()

bool NTV2GetUnsupportedPixelFormats

(

NTV2PixelFormats &

outFormats

)

Returns a set of NTV2PixelFormat values not suported by any NTV2 device.

Parameters

[out]

outFormats

Receives the set of NTV2PixelFormats not supported by any NTV2 device.

Returns

True if successful; otherwise false.

Definition at line 1156 of file ntv2publicinterface.cpp.

NTV2GetUnsupportedStandards()

bool NTV2GetUnsupportedStandards

(

NTV2StandardSet &

outStandards

)

Returns a set of NTV2Standard values not suported by any NTV2 device.

Parameters

[out]

outStandards

Receives the set of NTV2Standards not supported by any NTV2 device.

Returns

True if successful; otherwise false.

Definition at line 1181 of file ntv2publicinterface.cpp.

NTV2MakeAudioSystemSet()

NTV2AudioSystemSet NTV2MakeAudioSystemSet	(	const NTV2AudioSystem	inFirstAudioSystem,
		const UWord	inCount = 1
	)

Parameters

[in]	inFirstAudioSystem	Specifies the first NTV2AudioSystem.
	inCount	Specifies the number of audio systems.

Returns

An NTV2AudioSystemSet having the specified contiguous range of NTV2AudioSystems.

Definition at line 3412 of file ntv2publicinterface.cpp.

NTV2MakeChannelList() [1/2]

NTV2ChannelList NTV2MakeChannelList	(	const NTV2Channel	inFirstChannel,
		const UWord	inNumChannels = 1
	)

Parameters

[in]	inFirstChannel	Specifies the first NTV2Channel.
	inNumChannels	Specifies the number of channels.

Returns

An NTV2ChannelList having the specified contiguous range of channels.

Definition at line 3374 of file ntv2publicinterface.cpp.

NTV2MakeChannelList() [2/2]

NTV2ChannelList NTV2MakeChannelList

(

const NTV2ChannelSet

inChannels

)

Parameters

[in]

inChannels

Specifies the NTV2Channels that should go into the NTV2ChannelList.

Returns

An NTV2ChannelList having the same channels as contained in the specified set.

Definition at line 3383 of file ntv2publicinterface.cpp.

NTV2MakeChannelSet() [1/2]

NTV2ChannelSet NTV2MakeChannelSet	(	const NTV2Channel	inFirstChannel,
		const UWord	inNumChannels = 1
	)

Parameters

[in]	inFirstChannel	Specifies the first NTV2Channel.
	inNumChannels	Specifies the number of channels.

Returns

An NTV2ChannelSet having the specified contiguous range of channels.

Definition at line 3357 of file ntv2publicinterface.cpp.

NTV2MakeChannelSet() [2/2]

NTV2ChannelSet NTV2MakeChannelSet

(

const NTV2ChannelList

inChannels

)

Parameters

[in]

inChannels

Specifies the NTV2Channels that should go into the NTV2ChannelSet.

Returns

An NTV2ChannelSet having the same channels as contained in the specified list.

Definition at line 3366 of file ntv2publicinterface.cpp.

NTV2PrintAudioSystemSet()

ostream& NTV2PrintAudioSystemSet	(	const NTV2AudioSystemSet &	inObj,
		const bool	inCompact = true,
		std::ostream &	inOutStream = std::cout
	)

Streams a human-readable dump of the given NTV2AudioSystemSet into the specified output stream.

Parameters

[in]	inObj	Specifies the NTV2AudioSystemSet to be streamed to the output stream.
	inCompact	Use 'true' for a compact display (the default); otherwise use 'false' for a long-format.
	inOutStream	Specifies the output stream to receive the dump. Defaults to std::cout.

Returns

A non-constant reference to the given output stream.

Definition at line 3391 of file ntv2publicinterface.cpp.

NTV2PrintChannelList()

ostream& NTV2PrintChannelList	(	const NTV2ChannelList &	inObj,
		const bool	inCompact,
		ostream &	inOutStream
	)

Definition at line 3315 of file ntv2publicinterface.cpp.

NTV2PrintChannelSet()

ostream& NTV2PrintChannelSet	(	const NTV2ChannelSet &	inObj,
		const bool	inCompact,
		ostream &	inOutStream
	)

Definition at line 3336 of file ntv2publicinterface.cpp.

NTV2PrintULWordVector()

ostream& NTV2PrintULWordVector	(	const NTV2ULWordVector &	inObj,
		ostream &	inOutStream
	)

Definition at line 3307 of file ntv2publicinterface.cpp.

operator+=() [1/7]

NTV2FrameRateSet& operator+=	(	NTV2FrameRateSet &	inOutSet,
		const NTV2FrameRateSet &	inSet
	)

Appends the given NTV2FrameRateSet into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1326 of file ntv2publicinterface.cpp.

operator+=() [2/7]

NTV2GeometrySet& operator+=	(	NTV2GeometrySet &	inOutSet,
		const NTV2GeometrySet	inSet
	)

Appends the given NTV2GeometrySet contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1089 of file ntv2publicinterface.cpp.

operator+=() [3/7]

NTV2InputSourceSet& operator+=	(	NTV2InputSourceSet &	inOutSet,
		const NTV2InputSourceSet &	inSet
	)

Appends the given NTV2InputSourceSet's contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1112 of file ntv2publicinterface.cpp.

operator+=() [4/7]

NTV2OutputDestinations& operator+=	(	NTV2OutputDestinations &	inOutSet,
		const NTV2OutputDestinations &	inSet
	)

Appends the given NTV2OutputDestinations' contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1134 of file ntv2publicinterface.cpp.

operator+=() [5/7]

NTV2PixelFormats& operator+=	(	NTV2PixelFormats &	inOutSet,
		const NTV2PixelFormats	inSet
	)

Appends the given NTV2FrameBufferFormatSet contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1040 of file ntv2publicinterface.cpp.

operator+=() [6/7]

NTV2StandardSet& operator+=	(	NTV2StandardSet &	inOutSet,
		const NTV2StandardSet	inSet
	)

Appends the given NTV2StandardSet contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 1066 of file ntv2publicinterface.cpp.

operator+=() [7/7]

NTV2TCIndexes& operator+=	(	NTV2TCIndexes &	inOutSet,
		const NTV2TCIndexes &	inSet
	)

Appends the given NTV2TCIndexes contents into the given set.

Parameters

	inOutSet	The set to which the other set will be appended.
[in]	inSet	Specifies the set whose contents will be appended.

Returns

A reference to the modified set.

Definition at line 871 of file ntv2publicinterface.cpp.

operator<<() [1/34]

NTV2TimeCodeList& operator<<	(	NTV2TimeCodeList &	inOutList,
		const NTV2_RP188 &	inRP188
	)

Appends the given NTV2_RP188 struct to the specified NTV2TimeCodeList.

Parameters

	inOutList	Specifies the NTV2TimeCodeList to be appended to.
[in]	inRP188	Specifies the NTV2_RP188 to append to the list.

Returns

A non-constant reference to the specified NTV2TimeCodeList.

Definition at line 826 of file ntv2publicinterface.cpp.

operator<<() [2/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2GeometrySet &	inGeometries
	)

Definition at line 1075 of file ntv2publicinterface.cpp.

operator<<() [3/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2InputSourceSet &	inSet
	)

Definition at line 1098 of file ntv2publicinterface.cpp.

operator<<() [4/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2OutputDestinations &	inSet
	)

Definition at line 1120 of file ntv2publicinterface.cpp.

operator<<() [5/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2PixelFormats &	inFormats
	)

Definition at line 1024 of file ntv2publicinterface.cpp.

operator<<() [6/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2StandardSet &	inStandards
	)

Definition at line 1049 of file ntv2publicinterface.cpp.

operator<<() [7/34]

ostream& operator<<	(	ostream &	inOStream,
		const NTV2VideoFormatSet &	inFormats
	)

Definition at line 1005 of file ntv2publicinterface.cpp.

operator<<() [8/34]

ostream& operator<<	(	ostream &	inOutStr,
		const NTV2AudioChannelOctets &	inSet
	)

Definition at line 50 of file ntv2publicinterface.cpp.

operator<<() [9/34]

ostream& operator<<	(	ostream &	inOutStr,
		const NTV2AudioChannelPairs &	inSet
	)

Definition at line 33 of file ntv2publicinterface.cpp.

operator<<() [10/34]

ostream& operator<<	(	ostream &	inOutStr,
		const NTV2AudioChannelQuads &	inSet
	)

Definition at line 43 of file ntv2publicinterface.cpp.

operator<<() [11/34]

ostream& operator<<	(	ostream &	inOutStr,
		const NTV2DIDSet &	inDIDs
	)

Definition at line 64 of file ntv2publicinterface.cpp.

operator<<() [12/34]

ostream& operator<<	(	ostream &	inOutStr,
		const NTV2DoubleArray &	inVector
	)

Definition at line 57 of file ntv2publicinterface.cpp.

operator<<() [13/34]

ostream& operator<<	(	ostream &	inOutStream,
		const AUTOCIRCULATE_TRANSFER &	inObj
	)

Definition at line 919 of file ntv2publicinterface.cpp.

operator<<() [14/34]

ostream& operator<<	(	ostream &	inOutStream,
		const AUTOCIRCULATE_TRANSFER_STATUS &	inObj
	)

Definition at line 951 of file ntv2publicinterface.cpp.

operator<<() [15/34]

ostream& operator<<	(	ostream &	inOutStream,
		const AutoCircVidProcInfo &	inObj
	)

Definition at line 984 of file ntv2publicinterface.cpp.

operator<<() [16/34]

ostream& operator<<	(	ostream &	inOutStream,
		const FRAME_STAMP &	inObj
	)

Definition at line 879 of file ntv2publicinterface.cpp.

operator<<() [17/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2_HEADER &	inObj
	)

Definition at line 252 of file ntv2publicinterface.cpp.

operator<<() [18/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2_RP188 &	inObj
	)

Definition at line 817 of file ntv2publicinterface.cpp.

operator<<() [19/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2_TRAILER &	inObj
	)

Definition at line 298 of file ntv2publicinterface.cpp.

operator<<() [20/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2Buffer &	inObj
	)

Definition at line 313 of file ntv2publicinterface.cpp.

operator<<() [21/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2ColorCorrectionData &	inObj
	)

Definition at line 996 of file ntv2publicinterface.cpp.

operator<<() [22/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2RegisterValueMap &	inObj
	)

Definition at line 968 of file ntv2publicinterface.cpp.

operator<<() [23/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2RegisterWrites &	inObj
	)

Definition at line 3445 of file ntv2publicinterface.cpp.

operator<<() [24/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2SegmentedDMAInfo &	inObj
	)

Definition at line 908 of file ntv2publicinterface.cpp.

operator<<() [25/34]

ostream& operator<<	(	ostream &	inOutStream,
		const NTV2TimeCodeList &	inObj
	)

Definition at line 833 of file ntv2publicinterface.cpp.

operator<<() [26/34]

ostream& operator<<	(	ostream &	inOutStream,
		const ULWord64Sequence &	inData
	)

Definition at line 99 of file ntv2publicinterface.cpp.

operator<<() [27/34]

ostream& operator<<	(	ostream &	inOutStream,
		const ULWordSequence &	inData
	)

Definition at line 87 of file ntv2publicinterface.cpp.

operator<<() [28/34]

ostream& operator<<	(	ostream &	inOutStream,
		const UWordSequence &	inData
	)

Definition at line 75 of file ntv2publicinterface.cpp.

operator<<() [29/34]

ostream& operator<<	(	ostream &	inOutStrm,
		const NTV2SegmentedXferInfo &	inRun
	)

Definition at line 1349 of file ntv2publicinterface.cpp.

operator<<() [30/34]

ostream& operator<<	(	ostream &	oss,
		const AUTOCIRCULATE_STATUS &	inObj
	)

Definition at line 2543 of file ntv2publicinterface.cpp.

operator<<() [31/34]

ostream& operator<<	(	ostream &	oss,
		const NTV2FrameRateSet &	inSet
	)

Definition at line 1313 of file ntv2publicinterface.cpp.

operator<<() [32/34]

ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2RegInfo &	inObj
	)

Writes the given NTV2RegInfo to the specified output stream.

Parameters

	inOutStream	Specifies the output stream to receive the human-readable representation of the NTV2RegInfo instance.
[in]	inObj	Specifies the NTV2RegInfo instance to print to the output stream.

Returns

A non-constant reference to the specified output stream.

Definition at line 3439 of file ntv2publicinterface.cpp.

operator<<() [33/34]

ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2TCIndexes &	inObj
	)

Streams the given NTV2TCIndexes to the specified ostream in a human-readable format.

Parameters

	inOutStream	Specifies the ostream to use.
[in]	inObj	Specifies the NTV2TCIndexes set to be streamed.

Returns

The ostream being used.

Definition at line 859 of file ntv2publicinterface.cpp.

operator<<() [34/34]

ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2TimeCodes &	inObj
	)

Streams the given NTV2TimeCodes map to the specified ostream in a human-readable format.

Parameters

	inOutStream	Specifies the ostream to use.
[in]	inObj	Specifies the NTV2TimeCodes map to be streamed.

Returns

The ostream being used.

Definition at line 846 of file ntv2publicinterface.cpp.

print_address_offset()

static string print_address_offset ( const size_t  inRadix, const ULWord64  inOffset  )

static

Definition at line 359 of file ntv2publicinterface.cpp.

Variable Documentation

INVALID_TIMECODE_VALUE

const NTV2_RP188 INVALID_TIMECODE_VALUE

static

Definition at line 2732 of file ntv2publicinterface.cpp.

sSegXferUnits

const string sSegXferUnits[] = {"", " U8", " U16", "", " U32", "", "", "", " U64", ""}

static

Definition at line 1374 of file ntv2publicinterface.cpp.