ntv2devicefeatures.h File Reference

Declares device capability functions. More...

#include "ajaexport.h"
#include "ajatypes.h"
#include "ntv2enums.h"
#include "ntv2devicefeatures.hh"

Include dependency graph for ntv2devicefeatures.h:

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

Go to the source code of this file.

Macros
#define	false   (0)
#define	true   (!false)
#define	NTV2_IS_VALID_BOOLPARAMID(__x__)   ((__x__) >= kNTV2BoolParam_FIRST && (__x__) < kNTV2BoolParam_LAST)
#define	NTV2_IS_VALID_NUMPARAMID(__x__)   ((__x__) >= kNTV2NumericParam_FIRST && (__x__) < kNTV2NumericParam_LAST)
#define	NTV2_IS_VALID_ENUMSID(__x__)   ((__x__) >= kNTV2EnumsID_FIRST && (__x__) < kNTV2EnumsID_LAST)

Typedefs
typedef enum _NTV2BoolParamID	NTV2BoolParamID
	Used with CNTV2DriverInterface::GetBoolParam to determine device capabilities. More...
typedef enum _NTV2NumericParamID	NTV2NumericParamID
	Used with CNTV2DriverInterface::GetNumericParam to determine device capabilities. More...
typedef enum _NTV2EnumsID	NTV2EnumsID
	Identifies NTV2 enumerated types, used in CNTV2DriverInterface::GetSupportedItems. More...

Enumerations
enum	_NTV2BoolParamID {   kNTV2BoolParam_FIRST = 0, kDeviceCanChangeEmbeddedAudioClock = kNTV2BoolParam_FIRST, kDeviceCanChangeFrameBufferSize, kDeviceCanDisableUFC,   kDeviceCanDo2KVideo, kDeviceCanDo3GLevelConversion, kDeviceCanDoRGBLevelAConversion, kDeviceCanDo425Mux,   kDeviceCanDo4KVideo, kDeviceCanDoAESAudioIn, kDeviceCanDoAnalogAudio, kDeviceCanDoAnalogVideoIn,   kDeviceCanDoAnalogVideoOut, kDeviceCanDoAudio2Channels, kDeviceCanDoAudio6Channels, kDeviceCanDoAudio8Channels,   kDeviceCanDoAudio96K, kDeviceCanDoAudioDelay, kDeviceCanDoBreakoutBox, kDeviceCanDoCapture,   kDeviceCanDoColorCorrection, kDeviceCanDoCustomAnc, kDeviceCanDoDSKOpacity, kDeviceCanDoDualLink,   kDeviceCanDoDVCProHD, kDeviceCanDoEnhancedCSC, kDeviceCanDoFrameStore1Display, kDeviceCanDoFreezeOutput,   kDeviceCanDoHDMIOutStereo, kDeviceCanDoHDV, kDeviceCanDoHDVideo, kDeviceCanDoIsoConvert,   kDeviceCanDoLTC, kDeviceCanDoLTCInOnRefPort, kDeviceCanDoMSI, kDeviceCanDoMultiFormat,   kDeviceCanDoPCMControl, kDeviceCanDoPCMDetection, kDeviceCanDoPIO, kDeviceCanDoPlayback,   kDeviceCanDoProgrammableCSC, kDeviceCanDoProgrammableRS422, kDeviceCanDoProRes, kDeviceCanDoQREZ,   kDeviceCanDoQuarterExpand, kDeviceCanDoRateConvert, kDeviceCanDoRGBPlusAlphaOut, kDeviceCanDoRP188,   kDeviceCanDoSDVideo, kDeviceCanDoSDIErrorChecks, kDeviceCanDoStackedAudio, kDeviceCanDoStereoIn,   kDeviceCanDoStereoOut, kDeviceCanDoThunderbolt, kDeviceCanDoVideoProcessing, kDeviceCanMeasureTemperature,   kDeviceCanReportFrameSize, kDeviceHasBiDirectionalSDI, kDeviceHasColorSpaceConverterOnChannel2, kDeviceHasNWL,   kDeviceHasPCIeGen2, kDeviceHasRetailSupport, kDeviceHasSDIRelays, kDeviceHasSPIFlash,   kDeviceHasSPIFlashSerial, kDeviceHasSPIv2, kDeviceHasSPIv3, kDeviceHasSPIv4,   kDeviceIs64Bit, kDeviceIsDirectAddressable, kDeviceIsExternalToHost, kDeviceIsSupported,   kDeviceNeedsRoutingSetup, kDeviceSoftwareCanChangeFrameBufferSize, kDeviceCanThermostat, kDeviceHasHEVCM31,   kDeviceHasHEVCM30, kDeviceCanDoVITC2, kDeviceCanDoHDMIHDROut, kDeviceCanDoJ2K,   kDeviceCanDo12gRouting, kDeviceCanDo12GSDI, kDeviceCanDo2110, kDeviceCanDo8KVideo,   kDeviceCanDoAudio192K, kDeviceCanDoAudioMixer, kDeviceCanDoCustomAux, kDeviceCanDoFramePulseSelect,   kDeviceCanDoHDMIMultiView, kDeviceHasMultiRasterWidget, kDeviceCanDoHFRRGB, kDeviceCanDoIP,   kDeviceCanDoMultiLinkAudio, kDeviceCanDoWarmBootFPGA, kDeviceCanReportFailSafeLoaded, kDeviceCanReportRunningFirmwareDate,   kDeviceHasAudioMonitorRCAJacks, kDeviceHasBiDirectionalAnalogAudio, kDeviceHasGenlockv2, kDeviceHasGenlockv3,   kDeviceHasHeadphoneJack, kDeviceHasLEDAudioMeters, kDeviceHasRotaryEncoder, kDeviceHasSPIv5,   kDeviceHasXilinxDMA, kDeviceHasMicrophoneInput, kDeviceCanDoBreakoutBoard, kDeviceHasBreakoutBoard,   kDeviceAudioCanWaitForVBI, kDeviceHasNTV4FrameStores, kDeviceHasXptConnectROM, kNTV2BoolParam_LAST,   kNTV2BoolParam_COUNT = kNTV2BoolParam_LAST-kNTV2BoolParam_FIRST, kDeviceCanDo_INVALID = kNTV2BoolParam_LAST }
	Used with CNTV2DriverInterface::GetBoolParam to determine device capabilities. More...
enum	_NTV2NumericParamID {   kNTV2NumericParam_FIRST = 2000, kDeviceGetActiveMemorySize = kNTV2NumericParam_FIRST, kDeviceGetDACVersion, kDeviceGetDownConverterDelay,   kDeviceGetHDMIVersion, kDeviceGetLUTVersion, kDeviceGetMaxAudioChannels, kDeviceGetMaxRegisterNumber,   kDeviceGetMaxTransferCount, kDeviceGetNumDMAEngines, kDeviceGetNumVideoChannels, kDeviceGetPingLED,   kDeviceGetUFCVersion, kDeviceGetNum4kQuarterSizeConverters, kDeviceGetNumAESAudioInputChannels, kDeviceGetNumAESAudioOutputChannels,   kDeviceGetNumAnalogAudioInputChannels, kDeviceGetNumAnalogAudioOutputChannels, kDeviceGetNumAnalogVideoInputs, kDeviceGetNumAnalogVideoOutputs,   kDeviceGetNumAudioSystems, kDeviceGetNumCrossConverters, kDeviceGetNumCSCs, kDeviceGetNumDownConverters,   kDeviceGetNumEmbeddedAudioInputChannels, kDeviceGetNumEmbeddedAudioOutputChannels, kDeviceGetNumFrameStores, kDeviceGetNumFrameSyncs,   kDeviceGetNumHDMIAudioInputChannels, kDeviceGetNumHDMIAudioOutputChannels, kDeviceGetNumHDMIVideoInputs, kDeviceGetNumHDMIVideoOutputs,   kDeviceGetNumInputConverters, kDeviceGetNumLUTs, kDeviceGetNumMixers, kDeviceGetNumOutputConverters,   kDeviceGetNumReferenceVideoInputs, kDeviceGetNumSerialPorts, kDeviceGetNumUpConverters, kDeviceGetNumVideoInputs,   kDeviceGetNumVideoOutputs, kDeviceGetNum2022ChannelsSFP1, kDeviceGetNum2022ChannelsSFP2, kDeviceGetNumLTCInputs,   kDeviceGetNumLTCOutputs, kDeviceGetNumMicInputs, kDeviceGetNumLUTBanks, kDeviceGetTotalNumAudioSystems,   kDeviceGetNumBufferedAudioSystems, kDeviceGetNumTSIMuxers, kNTV2NumericParam_LAST, kNTV2NumericParam_COUNT = kNTV2NumericParam_LAST-kNTV2NumericParam_FIRST,   kDeviceGetNum_INVALID = kNTV2NumericParam_LAST }
	Used with CNTV2DriverInterface::GetNumericParam to determine device capabilities. More...
enum	_NTV2EnumsID {   kNTV2EnumsID_FIRST, kNTV2EnumsID_DeviceID = kNTV2EnumsID_FIRST, kNTV2EnumsID_Standard, kNTV2EnumsID_PixelFormat,   kNTV2EnumsID_FrameGeometry, kNTV2EnumsID_FrameRate, kNTV2EnumsID_ScanGeometry, kNTV2EnumsID_VideoFormat,   kNTV2EnumsID_Mode, kNTV2EnumsID_InputSource, kNTV2EnumsID_OutputDest, kNTV2EnumsID_Channel,   kNTV2EnumsID_RefSource, kNTV2EnumsID_AudioRate, kNTV2EnumsID_AudioSource, kNTV2EnumsID_WidgetID,   kNTV2EnumsID_ConversionMode, kNTV2EnumsID_DSKMode, kNTV2EnumsID_LAST, kNTV2EnumsID_COUNT = kNTV2EnumsID_LAST-kNTV2EnumsID_FIRST,   kNTV2EnumsID_INVALID = kNTV2EnumsID_LAST }
	Identifies NTV2 enumerated types, used in CNTV2DriverInterface::GetSupportedItems. More...

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)
bool	NTV2DeviceCanDoColorCorrection (const NTV2DeviceID inDeviceID)
bool	NTV2DeviceCanDoProgrammableCSC (const NTV2DeviceID inDeviceID)
ULWord	NTV2DeviceGetFrameBufferSize_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetNumberFrameBuffers_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetAudioFrameBuffer_Ex (NTV2DeviceID boardID)
ULWord	NTV2DeviceGetNumberVideoFrameBuffers (NTV2DeviceID inDeviceID, NTV2FrameGeometry inFrameGeometry, NTV2Framesize inFramesize)
ULWord	NTV2DeviceGetFrameBufferSize (NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetNumberFrameBuffers (NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetAudioFrameBuffer (NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat)
ULWord	NTV2DeviceGetAudioFrameBuffer2 (NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, 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	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)
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)

Detailed Description

Declares device capability functions.

Note

Although this is a .cpp file, it must be compilable for Lin/Mac/Win kernel device drivers.

Copyright

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

Definition in file ntv2devicefeatures.h.

Macro Definition Documentation

false

#define false   (0)

Definition at line 25 of file ntv2devicefeatures.h.

NTV2_IS_VALID_BOOLPARAMID

#define NTV2_IS_VALID_BOOLPARAMID

(

__x__

)

((__x__) >= kNTV2BoolParam_FIRST && (__x__) < kNTV2BoolParam_LAST)

Definition at line 150 of file ntv2devicefeatures.h.

NTV2_IS_VALID_ENUMSID

#define NTV2_IS_VALID_ENUMSID

(

__x__

)

((__x__) >= kNTV2EnumsID_FIRST && (__x__) < kNTV2EnumsID_LAST)

Definition at line 242 of file ntv2devicefeatures.h.

NTV2_IS_VALID_NUMPARAMID

#define NTV2_IS_VALID_NUMPARAMID

(

__x__

)

((__x__) >= kNTV2NumericParam_FIRST && (__x__) < kNTV2NumericParam_LAST)

Definition at line 212 of file ntv2devicefeatures.h.

true

#define true   (!false)

Definition at line 26 of file ntv2devicefeatures.h.

Typedef Documentation

NTV2BoolParamID

typedef enum _NTV2BoolParamID NTV2BoolParamID

Used with CNTV2DriverInterface::GetBoolParam to determine device capabilities.

NTV2EnumsID

typedef enum _NTV2EnumsID NTV2EnumsID

Identifies NTV2 enumerated types, used in CNTV2DriverInterface::GetSupportedItems.

NTV2NumericParamID

typedef enum _NTV2NumericParamID NTV2NumericParamID

Used with CNTV2DriverInterface::GetNumericParam to determine device capabilities.

Enumeration Type Documentation

_NTV2BoolParamID

enum _NTV2BoolParamID

Used with CNTV2DriverInterface::GetBoolParam to determine device capabilities.

Enumerator
kNTV2BoolParam_FIRST
kDeviceCanChangeEmbeddedAudioClock
kDeviceCanChangeFrameBufferSize	True if frame buffer sizes are not fixed.
kDeviceCanDisableUFC	True if there's at least one UFC, and it can be disabled.
kDeviceCanDo2KVideo	True if device can handle 2Kx1556 (film) video.
kDeviceCanDo3GLevelConversion	True if device can do 3G level B to 3G level A conversion.
kDeviceCanDoRGBLevelAConversion	True if the device can do RGB over 3G Level A.
kDeviceCanDo425Mux	True if the device supports SMPTE 425 mux control.
kDeviceCanDo4KVideo	True if the device can handle 4K/UHD video.
kDeviceCanDoAESAudioIn	Note Calculate based on kDeviceGetNumAESAudioInputChannels
kDeviceCanDoAnalogAudio	Note Calculate based on kDeviceGetNumAnalogAudioInputChannels and kDeviceGetNumAnalogAudioOutputChannels
kDeviceCanDoAnalogVideoIn	Note Calculate based on kDeviceGetNumAnalogVideoInputs
kDeviceCanDoAnalogVideoOut	Note Calculate based on kDeviceGetNumAnalogVideoOutputs
kDeviceCanDoAudio2Channels	Note Calculate based on kDeviceGetMaxAudioChannels
kDeviceCanDoAudio6Channels	Note Calculate based on kDeviceGetMaxAudioChannels
kDeviceCanDoAudio8Channels	Note Calculate based on kDeviceGetMaxAudioChannels
kDeviceCanDoAudio96K	True if Audio System(s) support a 96kHz sample rate.
kDeviceCanDoAudioDelay	True if Audio System(s) support an adjustable delay.
kDeviceCanDoBreakoutBox	True if device supports an AJA breakout box.
kDeviceCanDoCapture	Note Calculate based on kDeviceGetNumVideoInputs and kDeviceGetNumHDMIVideoInputs and kDeviceGetNumAnalogVideoInputs
kDeviceCanDoColorCorrection	Note Calculate based on kDeviceGetNumLUTs
kDeviceCanDoCustomAnc	True if device has ANC inserter/extractor firmware.
kDeviceCanDoDSKOpacity	True if device mixer/keyer supports adjustable opacity.
kDeviceCanDoDualLink	True if device supports 10-bit RGB input/output over 2-wire SDI.
kDeviceCanDoDVCProHD	True if device can squeeze/stretch between 1920x1080/1280x1080 and 1280x720/960x720.
kDeviceCanDoEnhancedCSC	True if device has enhanced CSCs.
kDeviceCanDoFrameStore1Display	True if device can display/output video from FrameStore 1.
kDeviceCanDoFreezeOutput	True if device can freeze output video.
kDeviceCanDoHDMIOutStereo	True if device supports 3D/stereo HDMI video output.
kDeviceCanDoHDV	True if device can squeeze/stretch between 1920x1080 and 1440x1080.
kDeviceCanDoHDVideo	True if device can handle HD (High Definition) video.
kDeviceCanDoIsoConvert	True if device can do ISO conversion.
kDeviceCanDoLTC	True if device can read LTC (Linear TimeCode) from one of its inputs.
kDeviceCanDoLTCInOnRefPort	True if device can read LTC (Linear TimeCode) from its reference input.
kDeviceCanDoMSI	True if device DMA hardware supports MSI (Message Signaled Interrupts).
kDeviceCanDoMultiFormat	True if device can simultaneously handle different video formats on more than one SDI input or output.
kDeviceCanDoPCMControl	True if device can mark specific audio channel pairs as not carrying PCM (Pulse Code Modulation) audio.
kDeviceCanDoPCMDetection	True if device can detect which audio channel pairs are not carrying PCM (Pulse Code Modulation) audio.
kDeviceCanDoPIO	True if device supports Programmed I/O.
kDeviceCanDoPlayback	Note Calculate based on kDeviceGetNumVideoOutputs and kDeviceGetNumHDMIVideoOutputs and kDeviceGetNumAnalogVideoOutputs
kDeviceCanDoProgrammableCSC	True if device has at least one programmable color space converter widget.
kDeviceCanDoProgrammableRS422	True if device has at least one RS-422 serial port, and it (they) can be programmed (for baud rate, parity, etc.).
kDeviceCanDoProRes	True if device can can accommodate Apple ProRes-compressed video in its frame buffers.
kDeviceCanDoQREZ	True if device can handle QRez.
kDeviceCanDoQuarterExpand	True if device can handle quarter-sized frames (pixel-halving and line-halving during input, pixel-double and line-double during output).
kDeviceCanDoRateConvert	True if device can do frame rate conversion.
kDeviceCanDoRGBPlusAlphaOut	True if device has CSCs capable of splitting the key (alpha) and YCbCr (fill) from RGB frame buffers that include alpha. (Has nothing to do with RGB wire formats.)
kDeviceCanDoRP188	True if device can insert and/or extract RP-188/VITC.
kDeviceCanDoSDVideo	True if device can handle SD (Standard Definition) video.
kDeviceCanDoSDIErrorChecks	True if device can perform SDI error checking.
kDeviceCanDoStackedAudio	True if device uses a "stacked" arrangement of its audio buffers.
kDeviceCanDoStereoIn	True if device supports 3D video input over dual-stream SDI.
kDeviceCanDoStereoOut	True if device supports 3D video output over dual-stream SDI.
kDeviceCanDoThunderbolt	True if device connects to the host using a Thunderbolt cable.
kDeviceCanDoVideoProcessing	True if device can do video processing.
kDeviceCanMeasureTemperature	True if device can measure its FPGA die temperature.
kDeviceCanReportFrameSize	True if device can report its frame size.
kDeviceHasBiDirectionalSDI	True if device SDI connectors are bi-directional.
kDeviceHasColorSpaceConverterOnChannel2	Calculate based on if NTV2_WgtCSC2 is present.
kDeviceHasNWL	True if device has NorthWest Logic DMA hardware.
kDeviceHasPCIeGen2	True if device supports 2nd-generation PCIe.
kDeviceHasRetailSupport	True if device is supported by AJA "retail" software (AJA ControlPanel & ControlRoom).
kDeviceHasSDIRelays	True if device has bypass relays on its SDI connectors.
kDeviceHasSPIFlash	True if device has SPI flash hardware.
kDeviceHasSPIFlashSerial	True if device has serial SPI flash hardware.
kDeviceHasSPIv2	Use kDeviceGetSPIVersion instead.
kDeviceHasSPIv3	Use kDeviceGetSPIVersion instead.
kDeviceHasSPIv4	Use kDeviceGetSPIVersion instead.
kDeviceIs64Bit	True if device is 64-bit addressable.
kDeviceIsDirectAddressable	True if device is direct addressable.
kDeviceIsExternalToHost	True if device connects to the host with a cable.
kDeviceIsSupported	True if device is supported by this SDK.
kDeviceNeedsRoutingSetup	True if device widget routing can be queried or changed.
kDeviceSoftwareCanChangeFrameBufferSize	True if device frame buffer size can be changed.
kDeviceCanThermostat	True if device fan can be thermostatically controlled.
kDeviceHasHEVCM31	True if device has an HEVC M31 encoder.
kDeviceHasHEVCM30	True if device has an HEVC M30 encoder/decoder.
kDeviceCanDoVITC2	True if device can insert or extract RP-188/VITC2.
kDeviceCanDoHDMIHDROut	True if device supports HDMI HDR output.
kDeviceCanDoJ2K	True if device supports JPEG 2000 codec.
kDeviceCanDo12gRouting	True if device supports 12G routing crosspoints.
kDeviceCanDo12GSDI	True if device has 12G SDI connectors.
kDeviceCanDo2110	True if device supports SMPTE ST2110.
kDeviceCanDo8KVideo	True if device supports 8K video formats.
kDeviceCanDoAudio192K	True if Audio System(s) support a 192kHz sample rate.
kDeviceCanDoAudioMixer	True if device has a firmware audio mixer.
kDeviceCanDoCustomAux	True if device supports HDMI AUX data insertion/extraction.
kDeviceCanDoFramePulseSelect	True if device supports frame pulse source independent of reference source.
kDeviceCanDoHDMIMultiView	True if device can rasterize 4 HD signals into a single HDMI output.
kDeviceHasMultiRasterWidget	True if device can rasterize 4 HD signals into a single HDMI output.
kDeviceCanDoHFRRGB	True if device supports 1080p RGB at more than 50Hz frame rates.
kDeviceCanDoIP	True if device has SFP connectors.
kDeviceCanDoMultiLinkAudio	True if device supports grouped audio system control.
kDeviceCanDoWarmBootFPGA	True if device can warm-boot to load updated firmware.
kDeviceCanReportFailSafeLoaded	True if device can report if its "fail-safe" firmware is loaded/running.
kDeviceCanReportRunningFirmwareDate	True if device can report its running (and not necessarily installed) firmware date.
kDeviceHasAudioMonitorRCAJacks	True if device has a pair of unbalanced RCA audio monitor output connectors.
kDeviceHasBiDirectionalAnalogAudio	True if device has a bi-directional analog audio connector.
kDeviceHasGenlockv2	True if device has version 2 genlock hardware and/or firmware.
kDeviceHasGenlockv3	True if device has version 3 genlock hardware and/or firmware.
kDeviceHasHeadphoneJack	True if device has a headphone jack.
kDeviceHasLEDAudioMeters	True if device has LED audio meters.
kDeviceHasRotaryEncoder	True if device has a rotary encoder volume control.
kDeviceHasSPIv5	Use kDeviceGetSPIVersion instead.
kDeviceHasXilinxDMA	True if device has Xilinx DMA hardware.
kDeviceHasMicrophoneInput	True if device has a microphone input connector.
kDeviceCanDoBreakoutBoard	True if device supports an AJA breakout board. (New in SDK 17.0)
kDeviceHasBreakoutBoard	True if device has attached breakout board. (New in SDK 17.0)
kDeviceAudioCanWaitForVBI	True if device audio systems can wait for VBI before starting. (New in SDK 17.0)
kDeviceHasNTV4FrameStores	True if device has NTV4 FrameStores. (New in SDK 17.0)
kDeviceHasXptConnectROM	True if device has a crosspoint connection ROM (New in SDK 17.0)
kNTV2BoolParam_LAST
kNTV2BoolParam_COUNT
kDeviceCanDo_INVALID

Definition at line 32 of file ntv2devicefeatures.h.

_NTV2EnumsID

enum _NTV2EnumsID

Identifies NTV2 enumerated types, used in CNTV2DriverInterface::GetSupportedItems.

Enumerator
kNTV2EnumsID_FIRST
kNTV2EnumsID_DeviceID	Identifies the NTV2DeviceID enumerated type.
kNTV2EnumsID_Standard	Identifies the NTV2Standard enumerated type.
kNTV2EnumsID_PixelFormat	Identifies the NTV2PixelFormat enumerated type.
kNTV2EnumsID_FrameGeometry	Identifies the NTV2FrameGeometry enumerated type.
kNTV2EnumsID_FrameRate	Identifies the NTV2FrameRate enumerated type.
kNTV2EnumsID_ScanGeometry	Identifies the NTV2ScanGeometry enumerated type.
kNTV2EnumsID_VideoFormat	Identifies the NTV2VideoFormat enumerated type.
kNTV2EnumsID_Mode	Identifies the NTV2Mode enumerated type.
kNTV2EnumsID_InputSource	Identifies the NTV2InputSource enumerated type.
kNTV2EnumsID_OutputDest	Identifies the NTV2OutputDest enumerated type.
kNTV2EnumsID_Channel	Identifies the NTV2Channel enumerated type.
kNTV2EnumsID_RefSource	Identifies the NTV2RefSource enumerated type.
kNTV2EnumsID_AudioRate	Identifies the NTV2AudioRate enumerated type.
kNTV2EnumsID_AudioSource	Identifies the NTV2AudioSource enumerated type.
kNTV2EnumsID_WidgetID	Identifies the NTV2AudioWidgetID enumerated type.
kNTV2EnumsID_ConversionMode	Identifies the NTV2ConversionMode enumerated type.
kNTV2EnumsID_DSKMode	Identifies the NTV2DSKMode enumerated type.
kNTV2EnumsID_LAST
kNTV2EnumsID_COUNT
kNTV2EnumsID_INVALID

Definition at line 217 of file ntv2devicefeatures.h.

_NTV2NumericParamID

enum _NTV2NumericParamID

Used with CNTV2DriverInterface::GetNumericParam to determine device capabilities.

Enumerator
kNTV2NumericParam_FIRST
kDeviceGetActiveMemorySize	The size, in bytes, of the device's active RAM available for video and audio.
kDeviceGetDACVersion	The version number of the DAC on the device.
kDeviceGetDownConverterDelay	The down-converter delay on the device.
kDeviceGetHDMIVersion	The HDMI input(s) and/or output(s) on the device.
kDeviceGetLUTVersion	The version number of the LUT(s) on the device.
kDeviceGetMaxAudioChannels	The maximum number of audio channels that a single Audio System can support on the device.
kDeviceGetMaxRegisterNumber	The highest register number for the device.
kDeviceGetMaxTransferCount	The maximum number of 32-bit words that the DMA engine can move at a time on the device.
kDeviceGetNumDMAEngines	The number of DMA engines on the device.
kDeviceGetNumVideoChannels	The number of video channels supported on the device.
kDeviceGetPingLED	The highest bit number of the LED bits in the Global Control Register on the device.
kDeviceGetUFCVersion	The version number of the UFC on the device.
kDeviceGetNum4kQuarterSizeConverters	The number of quarter-size 4K/UHD down-converters on the device.
kDeviceGetNumAESAudioInputChannels	The number of AES/EBU audio input channels on the device.
kDeviceGetNumAESAudioOutputChannels	The number of AES/EBU audio output channels on the device.
kDeviceGetNumAnalogAudioInputChannels	The number of analog audio input channels on the device.
kDeviceGetNumAnalogAudioOutputChannels	The number of analog audio output channels on the device.
kDeviceGetNumAnalogVideoInputs	The number of analog video inputs on the device.
kDeviceGetNumAnalogVideoOutputs	The number of analog video outputs on the device.
kDeviceGetNumAudioSystems	The number of independent Audio Systems on the device.
kDeviceGetNumCrossConverters	The number of cross-converters on the device.
kDeviceGetNumCSCs	The number of colorspace converter widgets on the device.
kDeviceGetNumDownConverters	The number of down-converters on the device.
kDeviceGetNumEmbeddedAudioInputChannels	The number of SDI-embedded input audio channels supported by the device.
kDeviceGetNumEmbeddedAudioOutputChannels	The number of SDI-embedded output audio channels supported by the device.
kDeviceGetNumFrameStores	The number of FrameStores on the device.
kDeviceGetNumFrameSyncs	The number of frame sync widgets on the device.
kDeviceGetNumHDMIAudioInputChannels	The number of HDMI audio input channels on the device.
kDeviceGetNumHDMIAudioOutputChannels	The number of HDMI audio output channels on the device.
kDeviceGetNumHDMIVideoInputs	The number of HDMI video inputs on the device.
kDeviceGetNumHDMIVideoOutputs	The number of HDMI video outputs on the device.
kDeviceGetNumInputConverters	The number of input converter widgets on the device.
kDeviceGetNumLUTs	The number of LUT widgets on the device.
kDeviceGetNumMixers	The number of mixer/keyer widgets on the device.
kDeviceGetNumOutputConverters	The number of output converter widgets on the device.
kDeviceGetNumReferenceVideoInputs	The number of external reference video inputs on the device.
kDeviceGetNumSerialPorts	The number of RS-422 serial ports on the device.
kDeviceGetNumUpConverters	The number of up-converters on the device.
kDeviceGetNumVideoInputs	The number of SDI video inputs on the device.
kDeviceGetNumVideoOutputs	The number of SDI video outputs on the device.
kDeviceGetNum2022ChannelsSFP1	The number of 2022 channels configured on SFP 1 on the device.
kDeviceGetNum2022ChannelsSFP2	The number of 2022 channels configured on SFP 2 on the device.
kDeviceGetNumLTCInputs	The number of analog LTC inputs on the device.
kDeviceGetNumLTCOutputs	The number of analog LTC outputs on the device.
kDeviceGetNumMicInputs	The number of microphone inputs on the device.
kDeviceGetNumLUTBanks	The number of LUT banks on the device. (New in SDK 17.0)
kDeviceGetTotalNumAudioSystems	The total number of audio systems on the device, including host audio and mixer audio systems, if present. (New in SDK 17.0)
kDeviceGetNumBufferedAudioSystems	The total number of audio systems on the device that can read/write audio buffer memory. Includes host audio system, if present. (New in SDK 17.0)
kDeviceGetNumTSIMuxers	The number of TSI muxers on the device. (New in SDK 17.0)
kNTV2NumericParam_LAST
kNTV2NumericParam_COUNT
kDeviceGetNum_INVALID

Definition at line 155 of file ntv2devicefeatures.h.

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	frameGeometry,
		NTV2FrameBufferFormat	frameFormat
	)

Definition at line 677 of file ntv2devicefeatures.cpp.

NTV2DeviceGetAudioFrameBuffer2()

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

Definition at line 683 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	frameGeometry,
		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	frameGeometry,
		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.