ntv2devicefeatures.cpp File Reference

Implementations of non-auto-generated device capability functions. More...

#include "ntv2devicefeatures.h"
#include "ntv2devicefeatures.hpp"

Include dependency graph for ntv2devicefeatures.cpp:

Go to the source code of this file.

Macros
#define	MAX_OF(__a__, __b__)   ((__a__) > (__b__) ? (__a__) : (__b__))

Functions
bool	NTV2DeviceCanDoAudioOut (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceCanDoAudioIn (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceCanDo292Out (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDo3GOut (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDo12GOut (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDo292In (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDo3GIn (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDo12GIn (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDoLTCEmbeddedN (NTV2DeviceID boardID, UWord index0)
bool	NTV2DeviceCanDoOutputDestination (const NTV2DeviceID inDeviceID, const NTV2OutputDestination inOutputDest)
UWord	Get8MBFrameSizeFactor (const NTV2FrameGeometry inFG, const NTV2FrameBufferFormat inFBF)
ULWord	NTV2DeviceGetFrameBufferSize_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetFrameBufferSize (NTV2DeviceID boardID, NTV2FrameGeometry inFrameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetNumberVideoFrameBuffers (NTV2DeviceID inDeviceID, NTV2FrameGeometry inFrameGeometry, NTV2Framesize inFrameSize)
ULWord	NTV2DeviceGetNumberFrameBuffers_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetNumberFrameBuffers (NTV2DeviceID boardID, NTV2FrameGeometry inFrameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetAudioFrameBuffer_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetAudioFrameBuffer2_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetAudioFrameBuffer (NTV2DeviceID boardID, NTV2FrameGeometry inFrameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetAudioFrameBuffer2 (NTV2DeviceID boardID, NTV2FrameGeometry inFrameGeometry, NTV2FrameBufferFormat frameFormat)
bool	NTV2DeviceGetVideoFormatFromState (NTV2VideoFormat *pOutValue, const NTV2FrameRate inFrameRate, const NTV2FrameGeometry inFrameGeometry, const NTV2Standard inStandard, const ULWord inIsSMPTE372Enabled)
bool	NTV2DeviceGetVideoFormatFromState_Ex (NTV2VideoFormat *pOutValue, const NTV2FrameRate inFrameRate, const NTV2FrameGeometry inFrameGeometry, const NTV2Standard inStandard, const ULWord inIsSMPTE372Enabled, const bool inIsProgressivePicture)
bool	NTV2DeviceGetVideoFormatFromState_Ex2 (NTV2VideoFormat *pOutValue, const NTV2FrameRate inFrameRate, const NTV2FrameGeometry inFrameGeometry, const NTV2Standard inStandard, const ULWord inIsSMPTE372Enabled, const bool inIsProgressivePicture, const bool inIsSquareDivision)
bool	NTV2DeviceCanDoTCIndex (const NTV2DeviceID inDeviceID, const NTV2TCIndex inTCIndex)
bool	NTV2DeviceCanDoInputTCIndex (const NTV2DeviceID inDeviceID, const NTV2TCIndex inTCIndex)
NTV2AudioSystem	NTV2DeviceGetAudioMixerSystem (const NTV2DeviceID inDeviceID)
NTV2AudioSystem	NTV2DeviceGetHostAudioSystem (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceROMHasBankSelect (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceCanDoColorCorrection (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceCanDoProgrammableCSC (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceHasSPIv2 (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceHasSPIv3 (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceHasSPIv4 (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceHasSPIv5 (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceHasGenlockv2 (const NTV2DeviceID devID)
bool	NTV2DeviceHasGenlockv3 (const NTV2DeviceID devID)
bool	NTV2DeviceHasColorSpaceConverterOnChannel2 (const NTV2DeviceID devID)
bool	NTV2DeviceCanDoAudio2Channels (const NTV2DeviceID devID)
bool	NTV2DeviceCanDoAudio6Channels (const NTV2DeviceID devID)
bool	NTV2DeviceCanDoAudio8Channels (const NTV2DeviceID devID)
UWord	NTV2DeviceGetNumAudioStreams (const NTV2DeviceID devID)
bool	NTV2DeviceCanDoAudioN (const NTV2DeviceID devID, UWord index0)
bool	NTV2DeviceCanDoLTCOutN (const NTV2DeviceID devID, UWord index0)
bool	NTV2DeviceCanDoLTCInN (const NTV2DeviceID devID, UWord index0)
bool	NTV2DeviceCanDoRS422N (const NTV2DeviceID devID, const NTV2Channel ch)
bool	work_around_erroneous_compiler_warning (void)

Detailed Description

Implementations of non-auto-generated device capability functions.

Copyright

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

Note

The functions in this module are those that aren't auto-generated by a Python script from CSV files that were exported from a spreadsheet. The mechanically-generated functions are placed in the 'ntv2devicefeatures.hpp' file that's included below. See the README in 'ntv2projects/sdkgen' for more details.

Definition in file ntv2devicefeatures.cpp.

Macro Definition Documentation

MAX_OF

#define MAX_OF	(		__a__,
			__b__
	)		((__a__) > (__b__) ? (__a__) : (__b__))

Definition at line 1006 of file ntv2devicefeatures.cpp.

Function Documentation

Get8MBFrameSizeFactor()

UWord Get8MBFrameSizeFactor	(	const NTV2FrameGeometry	inFG,
		const NTV2FrameBufferFormat	inFBF
	)

Returns

The minimum number of 8MB chunks that will accommodate a raster having the given frame geometry and pixel format.

Parameters

[in]	inFG	A valid frame geometry.
[in]	inFBF	A valid frame buffer format.

Definition at line 155 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo12GIn()

bool NTV2DeviceCanDo12GIn	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 106 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo12GOut()

bool NTV2DeviceCanDo12GOut	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 68 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo292In()

bool NTV2DeviceCanDo292In	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 80 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo292Out()

bool NTV2DeviceCanDo292Out	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 40 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo3GIn()

bool NTV2DeviceCanDo3GIn	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 90 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDo3GOut()

bool NTV2DeviceCanDo3GOut	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 52 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudio2Channels()

bool NTV2DeviceCanDoAudio2Channels

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetMaxAudioChannels instead.

Definition at line 1156 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudio6Channels()

bool NTV2DeviceCanDoAudio6Channels

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetMaxAudioChannels instead.

Definition at line 1157 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudio8Channels()

bool NTV2DeviceCanDoAudio8Channels

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetMaxAudioChannels instead.

Definition at line 1158 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudioIn()

bool NTV2DeviceCanDoAudioIn

(

const NTV2DeviceID

inDeviceID

)

Definition at line 31 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudioN()

bool NTV2DeviceCanDoAudioN	(	const NTV2DeviceID	devID,
		UWord	index0
	)

Deprecated:

Use NTV2DeviceGetNumAudioSystems instead.

Definition at line 1161 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoAudioOut()

bool NTV2DeviceCanDoAudioOut

(

const NTV2DeviceID

inDeviceID

)

Definition at line 22 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoColorCorrection()

bool NTV2DeviceCanDoColorCorrection

(

const NTV2DeviceID

inDeviceID

)

Returns

True if the device having the given ID has at least one programmable LUT.

Parameters

[in]

inDeviceID

Specifies the NTV2DeviceID of interest.

Definition at line 1131 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoInputTCIndex()

bool NTV2DeviceCanDoInputTCIndex	(	const NTV2DeviceID	inDeviceID,
		const NTV2TCIndex	inTCIndex
	)

Returns

True if the device having the given ID supports the specified NTV2TCIndex for input.

Definition at line 1058 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoLTCEmbeddedN()

bool NTV2DeviceCanDoLTCEmbeddedN	(	NTV2DeviceID	boardID,
		UWord	index0
	)

Definition at line 118 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoLTCInN()

bool NTV2DeviceCanDoLTCInN	(	const NTV2DeviceID	devID,
		UWord	index0
	)

Deprecated:

Use NTV2DeviceGetNumLTCInputs instead.

Definition at line 1163 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoLTCOutN()

bool NTV2DeviceCanDoLTCOutN	(	const NTV2DeviceID	devID,
		UWord	index0
	)

Deprecated:

Use NTV2DeviceGetNumLTCOutputs instead.

Definition at line 1162 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoOutputDestination()

bool NTV2DeviceCanDoOutputDestination	(	const NTV2DeviceID	inDeviceID,
		const NTV2OutputDestination	inOutputDest
	)

Returns

True if the device having the given ID supports the given output destination connector; otherwise false.

Parameters

[in]	inDeviceID	Specifies the NTV2DeviceID of the device of interest.
[in]	inOutputDest	Specifies the NTV2OutputDestination of interest.

Definition at line 134 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoProgrammableCSC()

bool NTV2DeviceCanDoProgrammableCSC

(

const NTV2DeviceID

inDeviceID

)

Returns

True if the device having the given ID has at least one color space converter widget - all CSCs are programable.

Parameters

[in]

inDeviceID

Specifies the NTV2DeviceID of interest.

Definition at line 1138 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoRS422N()

bool NTV2DeviceCanDoRS422N	(	const NTV2DeviceID	devID,
		const NTV2Channel	ch
	)

Deprecated:

Use NTV2DeviceGetNumSerialPorts instead.

Definition at line 1164 of file ntv2devicefeatures.cpp.

NTV2DeviceCanDoTCIndex()

bool NTV2DeviceCanDoTCIndex	(	const NTV2DeviceID	inDeviceID,
		const NTV2TCIndex	inTCIndex
	)

Returns

True if the device having the given ID supports the specified NTV2TCIndex.

Definition at line 1008 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioFrameBuffer()

ULWord NTV2DeviceGetAudioFrameBuffer	(	NTV2DeviceID	boardID,
		NTV2FrameGeometry	inFrameGeometry,
		NTV2FrameBufferFormat	frameFormat
	)

Definition at line 677 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioFrameBuffer2()

ULWord NTV2DeviceGetAudioFrameBuffer2	(	NTV2DeviceID	boardID,
		NTV2FrameGeometry	inFrameGeometry,
		NTV2FrameBufferFormat	frameFormat
	)

Definition at line 683 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioFrameBuffer2_Ex()

ULWord NTV2DeviceGetAudioFrameBuffer2_Ex

(

NTV2DeviceID

boardID

)

Definition at line 664 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioFrameBuffer_Ex()

ULWord NTV2DeviceGetAudioFrameBuffer_Ex

(

NTV2DeviceID

boardID

)

Definition at line 646 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioMixerSystem()

NTV2AudioSystem NTV2DeviceGetAudioMixerSystem

(

const NTV2DeviceID

inDeviceID

)

Returns

The NTV2AudioSystem used by the audio mixer for the given device (or NTV2_AUDIOSYSTEM_INVALID if there is no mixer).

Definition at line 1108 of file ntv2devicefeatures.cpp.

NTV2DeviceGetFrameBufferSize()

ULWord NTV2DeviceGetFrameBufferSize	(	NTV2DeviceID	boardID,
		NTV2FrameGeometry	inFrameGeometry,
		NTV2FrameBufferFormat	frameFormat
	)

Definition at line 245 of file ntv2devicefeatures.cpp.

NTV2DeviceGetFrameBufferSize_Ex()

ULWord NTV2DeviceGetFrameBufferSize_Ex

(

NTV2DeviceID

boardID

)

Definition at line 237 of file ntv2devicefeatures.cpp.

NTV2DeviceGetHostAudioSystem()

NTV2AudioSystem NTV2DeviceGetHostAudioSystem

(

const NTV2DeviceID

inDeviceID

)

Returns

The NTV2AudioSystem used for host audio support for the given device (or NTV2_AUDIOSYSTEM_INVALID if there is no host audio system).

Definition at line 1115 of file ntv2devicefeatures.cpp.

NTV2DeviceGetNumAudioStreams()

UWord NTV2DeviceGetNumAudioStreams

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetNumAudioSystems instead.

Definition at line 1160 of file ntv2devicefeatures.cpp.

NTV2DeviceGetNumberFrameBuffers()

ULWord NTV2DeviceGetNumberFrameBuffers	(	NTV2DeviceID	boardID,
		NTV2FrameGeometry	inFrameGeometry,
		NTV2FrameBufferFormat	frameFormat
	)

Definition at line 510 of file ntv2devicefeatures.cpp.

NTV2DeviceGetNumberFrameBuffers_Ex()

ULWord NTV2DeviceGetNumberFrameBuffers_Ex

(

NTV2DeviceID

boardID

)

Definition at line 447 of file ntv2devicefeatures.cpp.

NTV2DeviceGetNumberVideoFrameBuffers()

ULWord NTV2DeviceGetNumberVideoFrameBuffers	(	NTV2DeviceID	inDeviceID,
		NTV2FrameGeometry	inFrameGeometry,
		NTV2Framesize	inFrameSize
	)

Definition at line 419 of file ntv2devicefeatures.cpp.

NTV2DeviceGetVideoFormatFromState()

bool NTV2DeviceGetVideoFormatFromState	(	NTV2VideoFormat *	pOutValue,
		const NTV2FrameRate	inFrameRate,
		const NTV2FrameGeometry	inFrameGeometry,
		const NTV2Standard	inStandard,
		const ULWord	inIsSMPTE372Enabled
	)

Definition at line 689 of file ntv2devicefeatures.cpp.

NTV2DeviceGetVideoFormatFromState_Ex()

bool NTV2DeviceGetVideoFormatFromState_Ex	(	NTV2VideoFormat *	pOutValue,
		const NTV2FrameRate	inFrameRate,
		const NTV2FrameGeometry	inFrameGeometry,
		const NTV2Standard	inStandard,
		const ULWord	inIsSMPTE372Enabled,
		const bool	inIsProgressivePicture
	)

Definition at line 698 of file ntv2devicefeatures.cpp.

NTV2DeviceGetVideoFormatFromState_Ex2()

bool NTV2DeviceGetVideoFormatFromState_Ex2	(	NTV2VideoFormat *	pOutValue,
		const NTV2FrameRate	inFrameRate,
		const NTV2FrameGeometry	inFrameGeometry,
		const NTV2Standard	inStandard,
		const ULWord	inIsSMPTE372Enabled,
		const bool	inIsProgressivePicture,
		const bool	inIsSquareDivision
	)

Definition at line 708 of file ntv2devicefeatures.cpp.

NTV2DeviceHasColorSpaceConverterOnChannel2()

bool NTV2DeviceHasColorSpaceConverterOnChannel2

(

const NTV2DeviceID

devID

)

Deprecated:

Call NTV2DeviceCanDoWidget with NTV2_WgtCSC2 instead.

Definition at line 1154 of file ntv2devicefeatures.cpp.

NTV2DeviceHasGenlockv2()

bool NTV2DeviceHasGenlockv2

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetGenlockVersion instead.

Definition at line 1151 of file ntv2devicefeatures.cpp.

NTV2DeviceHasGenlockv3()

bool NTV2DeviceHasGenlockv3

(

const NTV2DeviceID

devID

)

Deprecated:

Use NTV2DeviceGetGenlockVersion instead.

Definition at line 1152 of file ntv2devicefeatures.cpp.

NTV2DeviceHasSPIv2()

bool NTV2DeviceHasSPIv2

(

const NTV2DeviceID

inDeviceID

)

Deprecated:

Call NTV2DeviceGetSPIFlashVersion instead.

Definition at line 1146 of file ntv2devicefeatures.cpp.

NTV2DeviceHasSPIv3()

bool NTV2DeviceHasSPIv3

(

const NTV2DeviceID

inDeviceID

)

Deprecated:

Call NTV2DeviceGetSPIFlashVersion instead.

Definition at line 1147 of file ntv2devicefeatures.cpp.

NTV2DeviceHasSPIv4()

bool NTV2DeviceHasSPIv4

(

const NTV2DeviceID

inDeviceID

)

Deprecated:

Call NTV2DeviceGetSPIFlashVersion instead.

Definition at line 1148 of file ntv2devicefeatures.cpp.

NTV2DeviceHasSPIv5()

bool NTV2DeviceHasSPIv5

(

const NTV2DeviceID

inDeviceID

)

Deprecated:

Call NTV2DeviceGetSPIFlashVersion instead.

Definition at line 1149 of file ntv2devicefeatures.cpp.

NTV2DeviceROMHasBankSelect()

bool NTV2DeviceROMHasBankSelect

(

const NTV2DeviceID

inDeviceID

)

Returns

True if the device has SPI flash that incorporates bank selection.

Definition at line 1123 of file ntv2devicefeatures.cpp.

work_around_erroneous_compiler_warning()

bool work_around_erroneous_compiler_warning

(

void

)

Definition at line 1167 of file ntv2devicefeatures.cpp.