AJA NTV2 SDK  18.0.0.2122
NTV2 SDK 18.0.0.2122
ntv2card.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
8 #ifndef NTV2CARD_H
9 #define NTV2CARD_H
10 
11 #if defined (MSWindows)
12  #include "ntv2windriverinterface.h"
13 #elif defined (AJAMac)
14  #include "ntv2macdriverinterface.h"
15 #elif defined (AJALinux)
17 #elif defined (AJABareMetal)
19 #endif
20 #include "ntv2signalrouter.h"
21 #include "ntv2utils.h"
22 #include "ntv2devicecapabilities.h"
23 
24 
29 #if defined (MSWindows)
31 #elif defined (AJAMac)
33 #elif defined (AJALinux)
35 #elif defined (AJABareMetal)
37 #endif
38 {
39 public:
43 
47  CNTV2Card ();
48 
57  explicit CNTV2Card ( const UWord inDeviceIndex,
58  const std::string & inHostName = std::string());
59 
63  virtual ~CNTV2Card();
65 
66 
70 
75  AJA_VIRTUAL std::string GetDisplayName (void);
76 
81  AJA_VIRTUAL std::string GetModelName (void);
82 
87  AJA_VIRTUAL Word GetDeviceVersion (void);
88 
93  AJA_VIRTUAL std::string GetDeviceVersionString (void);
94 
99  AJA_VIRTUAL std::string GetDriverVersionString (void);
100 
101  AJA_VIRTUAL std::string GetDescription (void) const;
102 
111  AJA_VIRTUAL bool GetDriverVersionComponents (UWord & outMajor, UWord & outMinor, UWord & outPoint, UWord & outBuild);
112 
118  AJA_VIRTUAL uint64_t GetSerialNumber (void); // From CNTV2Status
119 
124  AJA_VIRTUAL bool GetSerialNumberString (std::string & outSerialNumberString); // From CNTV2Status
125 
131  AJA_VIRTUAL bool GetPCIDeviceID (ULWord & outPCIDeviceID);
132 
136  AJA_VIRTUAL NTV2BreakoutType GetBreakoutHardware (void);
137 
141  AJA_VIRTUAL bool GetLPExternalConfigurationURLString (std::string & outURLString);
142  AJA_VIRTUAL bool GetLPTunnelConfigurationURLString (std::string & outURLString);
143  AJA_VIRTUAL int GetSFPConfigurationURLStrings(std::vector<std::string> & sfpURLStrings);
144 
148  AJA_VIRTUAL inline class DeviceCapabilities & features (void) {return mDevCap;} // New in SDK 17.0
149 #if !defined(NTV2_DEPRECATE_16_3)
150  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoFormat (const NTV2FrameRate inFR, const NTV2FrameGeometry inFG, const NTV2Standard inStd));
151  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetFrameBufferSize(void));
152  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetAudioFrameBuffer(void));
153  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetAudioFrameBuffer2(void));
154  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetFrameBufferSize (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
155  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetNumberFrameBuffers (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
156  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetAudioFrameBuffer (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
157  AJA_VIRTUAL NTV2_DEPRECATED_16_3(ULWord DeviceGetAudioFrameBuffer2 (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
158  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoVideoFormat (const NTV2VideoFormat inVF));
159  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoFrameBufferFormat (const NTV2PixelFormat inPF));
160  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoWidget (const NTV2WidgetID inWgtID));
161  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoConversionMode (const NTV2ConversionMode inCM));
162  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoDSKMode (const NTV2DSKMode inDSKM));
163  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool DeviceCanDoInputSource (const NTV2InputSource inSrc));
167 #endif // defined(NTV2_DEPRECATE_16_3)
168  AJA_VIRTUAL ULWord DeviceGetNumberFrameBuffers(void);
170 
171 
175 
189  AJA_VIRTUAL bool DMARead (const ULWord inFrameNumber, ULWord * pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount);
190 
204  AJA_VIRTUAL bool DMAWrite (const ULWord inFrameNumber, const ULWord * pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount);
205 
206 
219  AJA_VIRTUAL bool DMAReadFrame (const ULWord inFrameNumber, ULWord * pOutFrameBuffer, const ULWord inByteCount);
220 
238  AJA_VIRTUAL bool DMAReadFrame (const ULWord inFrameNumber, ULWord * pHostBuffer, const ULWord inByteCount, const NTV2Channel inChannel);
239 
252  AJA_VIRTUAL bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord * pInFrameBuffer, const ULWord inByteCount);
253 
271  AJA_VIRTUAL bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord * pInFrameBuffer, const ULWord inByteCount, const NTV2Channel inChannel);
272 
288  AJA_VIRTUAL bool DMAReadSegments ( const ULWord inFrameNumber,
289  ULWord * pFrameBuffer,
290  const ULWord inCardOffsetBytes,
291  const ULWord inSegmentByteCount,
292  const ULWord inNumSegments,
293  const ULWord inSegmentHostPitch,
294  const ULWord inSegmentCardPitch);
295 
311  AJA_VIRTUAL bool DMAWriteSegments ( const ULWord inFrameNumber,
312  const ULWord * pFrameBuffer,
313  const ULWord inOffsetBytes,
314  const ULWord inSegmentByteCount,
315  const ULWord inNumSegments,
316  const ULWord inSegmentHostPitch,
317  const ULWord inSegmentCardPitch);
318 
322  AJA_VIRTUAL bool DmaP2PTargetFrame (NTV2Channel channel, // frame buffer channel output frame to update on completion
323  ULWord frameNumber, // frame number to target
324  ULWord frameOffset, // frame buffer offset (bytes)
325  PCHANNEL_P2P_STRUCT pP2PData); // p2p target data (output)
326 
327  AJA_VIRTUAL bool DmaP2PTransferFrame (NTV2DMAEngine DMAEngine, // dma engine for transfer
328  ULWord frameNumber, // source frame number
329  ULWord frameOffset, // source frame buffer offset (bytes)
330  ULWord transferSize, // transfer size (bytes)
331  ULWord numSegments, // number of segments (0 if not a segmented transfer)
332  ULWord segmentTargetPitch, // target frame pitch (0 if not a segmented transfer)
333  ULWord segmentCardPitch, // source frame pitch (0 if not a segmented transfer)
334  PCHANNEL_P2P_STRUCT pP2PData); // p2p target data
335 
351  AJA_VIRTUAL bool DMAReadAudio ( const NTV2AudioSystem inAudioSystem,
352  ULWord * pOutAudioBuffer,
353  const ULWord inOffsetBytes,
354  const ULWord inByteCount);
355 
371  AJA_VIRTUAL bool DMAWriteAudio ( const NTV2AudioSystem inAudioSystem,
372  const ULWord * pInAudioBuffer,
373  const ULWord inOffsetBytes,
374  const ULWord inByteCount);
375 
398  AJA_VIRTUAL bool DMAReadAnc ( const ULWord inFrameNumber,
399  NTV2Buffer & outAncF1Buffer,
400  NTV2Buffer & outAncF2Buffer = NULL_POINTER,
401  const NTV2Channel inChannel = NTV2_CHANNEL1);
402 
431  AJA_VIRTUAL bool DMAWriteAnc ( const ULWord inFrameNumber,
432  NTV2Buffer & inAncF1Buffer,
433  NTV2Buffer & inAncF2Buffer = NULL_POINTER,
434  const NTV2Channel inChannel = NTV2_CHANNEL1);
435 
436 
447  AJA_VIRTUAL bool DMAWriteLUTTable ( const ULWord inFrameNumber, const ULWord * pInLUTBuffer, const ULWord inLUTIndex,const ULWord inByteCount = LUTTablePartitionSize);
448 
457  AJA_VIRTUAL bool DMABufferLock (const NTV2Buffer & inBuffer, bool inMap = false, bool inRDMA = false); // New in SDK 15.5
458 
471  AJA_VIRTUAL inline bool DMABufferLock (const ULWord * pInBuffer, const ULWord inByteCount, bool inMap = false, bool inRDMA = false)
472  {
473  return DMABufferLock(NTV2Buffer(pInBuffer, inByteCount), inMap, inRDMA);
474  }
475 
476 
483  AJA_VIRTUAL bool DMABufferUnlock (const NTV2Buffer & inBuffer);
484 
492  AJA_VIRTUAL inline bool DMABufferUnlock (const ULWord * pInBuffer, const ULWord inByteCount)
493  {
494  return DMABufferUnlock(NTV2Buffer(pInBuffer, inByteCount));
495  }
496 
502  AJA_VIRTUAL bool DMABufferUnlockAll ();
503 
512  AJA_VIRTUAL bool DMABufferAutoLock (const bool inEnable, const bool inMap = false, const ULWord64 inMaxLockSize = 0);
513 
514 
525  AJA_VIRTUAL bool DMAClearAncRegion ( const UWord inStartFrameNumber,
526  const UWord inEndFrameNumber,
527  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All,
528  const NTV2Channel inChannel = NTV2_CHANNEL1);
529 
540  AJA_VIRTUAL bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel,
541  uint64_t & outAddress, uint64_t & outLength);
542 
543  AJA_VIRTUAL bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, ULWord & outIntrinsicSize,
544  bool & outMultiFmt, bool & outQuad, bool & outQuadQuad, bool & outSquares, bool & outTSI,
545  uint64_t & outAddress, uint64_t & outLength); // New in SDK 16.2
546 
555  AJA_VIRTUAL bool DeviceAddressToFrameNumber (const uint64_t inAddress, UWord & outFrameNumber, const NTV2Channel inChannel = NTV2_CHANNEL1);
556 
570  AJA_VIRTUAL bool GetAncRegionOffsetAndSize (ULWord & outByteOffset, ULWord & outByteCount,
571  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All);
572 
584  AJA_VIRTUAL bool GetAncRegionOffsetFromBottom (ULWord & outByteOffsetFromBottom,
585  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All);
587 
588 //
589 // Set/Get Parameter routines
590 //
591  #if defined (AJAMac)
592  #define AJA_RETAIL_DEFAULT true
593  #else // else !defined (AJAMac)
594  #define AJA_RETAIL_DEFAULT false
595  #endif // !defined (AJAMac)
596 
613  AJA_VIRTUAL bool SetVideoFormat (const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail = AJA_RETAIL_DEFAULT, const bool inKeepVancSettings = false, const NTV2Channel inChannel = NTV2_CHANNEL1);
614 
626  AJA_VIRTUAL bool SetVideoFormat (const NTV2ChannelSet & inFrameStores, const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail = AJA_RETAIL_DEFAULT);
627 
635  AJA_VIRTUAL bool SetFrameGeometry (NTV2FrameGeometry inGeometry, bool inIsRetail = AJA_RETAIL_DEFAULT, NTV2Channel inChannel = NTV2_CHANNEL1);
636 
652  AJA_VIRTUAL bool SetFrameBufferFormat (NTV2Channel inChannel,
653  NTV2FrameBufferFormat inNewFormat,
654  bool inIsAJARetail = AJA_RETAIL_DEFAULT,
658 
674  AJA_VIRTUAL bool SetFrameBufferFormat (const NTV2ChannelSet & inFrameStores,
675  const NTV2FrameBufferFormat inNewFormat,
676  const bool inIsAJARetail = AJA_RETAIL_DEFAULT,
677  const NTV2HDRXferChars inXferChars = NTV2_VPID_TC_SDR_TV,
678  const NTV2HDRColorimetry inColorimetry = NTV2_VPID_Color_Rec709,
679  const NTV2HDRLuminance inLuminance = NTV2_VPID_Luminance_YCbCr);
680 
689  AJA_VIRTUAL bool SetReference (const NTV2ReferenceSource inRefSource, const bool inKeepFramePulseSelect = false);
690 
697  AJA_VIRTUAL bool GetReference (NTV2ReferenceSource & outRefSource);
698 
705  AJA_VIRTUAL bool EnableFramePulseReference (const bool inEnable); // New in SDK 15.5
706 
714  AJA_VIRTUAL bool GetEnableFramePulseReference (bool & outEnabled); // New in SDK 15.5
715 
722  AJA_VIRTUAL bool SetFramePulseReference (const NTV2ReferenceSource inRefSource); // New in SDK 15.5
723 
730  AJA_VIRTUAL bool GetFramePulseReference (NTV2ReferenceSource & outRefSource); // New in SDK 15.5
731 
738  AJA_VIRTUAL bool GetTaskMode (NTV2TaskMode & outMode); // New in SDK 18.0
739 
749  AJA_VIRTUAL bool SetTaskMode (const NTV2TaskMode inMode); // New in SDK 18.0
750 
761  AJA_VIRTUAL bool SetMode (const NTV2Channel inChannel, const NTV2Mode inNewValue, const bool inIsRetail = AJA_RETAIL_DEFAULT);
762 
772  AJA_VIRTUAL bool SetMode (const NTV2ChannelSet & inChannels, const NTV2Mode inMode);
773 
782  AJA_VIRTUAL bool GetMode (const NTV2Channel inChannel, NTV2Mode & outValue);
783 
784  AJA_VIRTUAL bool GetFrameGeometry (NTV2FrameGeometry & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
785 
796  AJA_VIRTUAL bool GetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat & outValue);
797 
798 
799  // The rest of the routines
800  AJA_VIRTUAL bool GetVideoFormat (NTV2VideoFormat & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
801 
802  AJA_VIRTUAL bool SetStandard (NTV2Standard inValue, NTV2Channel inChannel = NTV2_CHANNEL1);
803  AJA_VIRTUAL bool GetStandard (NTV2Standard & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
804 
805  AJA_VIRTUAL bool IsProgressiveStandard (bool & outIsProgressive, NTV2Channel inChannel = NTV2_CHANNEL1);
806 
807  AJA_VIRTUAL bool IsSDStandard (bool & outIsStandardDef, NTV2Channel inChannel = NTV2_CHANNEL1);
808 
817  AJA_VIRTUAL bool SetFrameRate (NTV2FrameRate inNewValue, NTV2Channel inChannel = NTV2_CHANNEL1);
818 
827  AJA_VIRTUAL bool GetFrameRate (NTV2FrameRate & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
828 
839  AJA_VIRTUAL bool SetSmpte372 (ULWord inValue, NTV2Channel inChannel = NTV2_CHANNEL1);
840 
850  AJA_VIRTUAL bool GetSmpte372 (ULWord & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
851 
852  AJA_VIRTUAL bool SetProgressivePicture (ULWord value);
853  AJA_VIRTUAL bool GetProgressivePicture (ULWord & outValue);
854 
865  AJA_VIRTUAL bool SetQuadFrameEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
866 
874  AJA_VIRTUAL bool GetQuadFrameEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
875 
886  AJA_VIRTUAL bool SetQuadQuadFrameEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
887 
895  AJA_VIRTUAL bool GetQuadQuadFrameEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
896 
905  AJA_VIRTUAL bool SetQuadQuadSquaresEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
906 
915  AJA_VIRTUAL bool GetQuadQuadSquaresEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
916 
928  AJA_VIRTUAL bool Set4kSquaresEnable (const bool inIsEnabled, const NTV2Channel inChannel);
929 
939  AJA_VIRTUAL bool Get4kSquaresEnable (bool & outIsEnabled, const NTV2Channel inChannel);
940 
951  AJA_VIRTUAL bool SetTsiFrameEnable (const bool inIsEnabled, const NTV2Channel inChannel);
952 
961  AJA_VIRTUAL bool GetTsiFrameEnable (bool & outIsEnabled, const NTV2Channel inChannel);
962 
969  AJA_VIRTUAL bool GetTsiMuxSyncFail (bool & outSyncFailed, const NTV2Channel inWhichTsiMux);
970 
971  AJA_VIRTUAL bool SetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode inValue);
972  AJA_VIRTUAL bool GetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode & outValue);
973 
974  AJA_VIRTUAL bool SetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality inValue);
975  AJA_VIRTUAL bool GetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality & outValue);
976 
977  AJA_VIRTUAL bool SetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF inValue);
978  AJA_VIRTUAL bool GetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF & outValue);
979 
991  AJA_VIRTUAL bool SetFrameBufferOrientation (const NTV2Channel inChannel, const NTV2FBOrientation inValue);
992 
1003  AJA_VIRTUAL bool GetFrameBufferOrientation (const NTV2Channel inChannel, NTV2FBOrientation & outValue);
1004 
1005  AJA_VIRTUAL bool SetAlphaFromInput2Bit (ULWord inValue);
1006  AJA_VIRTUAL bool GetAlphaFromInput2Bit (ULWord & outValue);
1007 
1033  AJA_VIRTUAL bool SetOutputFrame (const NTV2Channel inChannel, const ULWord inValue);
1034 
1043  AJA_VIRTUAL bool GetOutputFrame (const NTV2Channel inChannel, ULWord & outValue);
1044 
1071  AJA_VIRTUAL bool SetInputFrame (const NTV2Channel inChannel, const ULWord inValue);
1072 
1083  AJA_VIRTUAL bool GetInputFrame (const NTV2Channel inChannel, ULWord & outValue);
1084 
1085  AJA_VIRTUAL bool SetDualLinkOutputEnable (const bool inIsEnabled);
1086  AJA_VIRTUAL bool GetDualLinkOutputEnable (bool & outIsEnabled);
1087 
1088  AJA_VIRTUAL bool SetDualLinkInputEnable (const bool inIsEnabled);
1089  AJA_VIRTUAL bool GetDualLinkInputEnable (bool & outIsEnabled);
1090 
1097  AJA_VIRTUAL bool SetVideoLimiting (const NTV2VideoLimiting inValue);
1098 
1105  AJA_VIRTUAL bool GetVideoLimiting (NTV2VideoLimiting & outValue);
1106 
1107  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC, const NTV2Standard inStandard, const NTV2FrameGeometry inGeometry, const NTV2Channel inChannel = NTV2_CHANNEL1);
1108  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC = false, const NTV2Channel inChannel = NTV2_CHANNEL1);
1109 
1118  AJA_VIRTUAL bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1119 
1127  AJA_VIRTUAL bool SetVANCMode (const NTV2ChannelSet & inChannels, const NTV2VANCMode inVancMode);
1128 
1137  AJA_VIRTUAL bool GetVANCMode (NTV2VANCMode & outVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1138 
1151  AJA_VIRTUAL bool SetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode inMode);
1152 
1165  AJA_VIRTUAL bool SetVANCShiftMode (NTV2ChannelSet & inChannels, const NTV2VANCDataShiftMode inMode); // New in SDK 16.2
1166 
1180  AJA_VIRTUAL bool GetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode & outValue);
1181 
1182  AJA_VIRTUAL bool SetPulldownMode (NTV2Channel inChannel, bool inValue);
1183  AJA_VIRTUAL bool GetPulldownMode (NTV2Channel inChannel, bool & outValue);
1184 
1191  AJA_VIRTUAL bool ReadLineCount (ULWord & outValue);
1192 
1193 #if !defined(NTV2_DEPRECATE_18_0)
1194  AJA_VIRTUAL inline NTV2_DEPRECATED_18_0(bool GetEveryFrameServices(NTV2TaskMode & m)) {return GetTaskMode(m);}
1195  AJA_VIRTUAL inline NTV2_DEPRECATED_18_0(bool SetEveryFrameServices(const NTV2TaskMode m)) {return SetTaskMode(m);}
1196 #endif // defined(NTV2_DEPRECATE_18_0)
1197 #if !defined(NTV2_DEPRECATE_16_3)
1198  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool SetDefaultVideoOutMode(ULWord mode));
1199  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool GetDefaultVideoOutMode(ULWord & outMode));
1200 #endif // defined(NTV2_DEPRECATE_16_3)
1201 #if !defined(NTV2_DEPRECATE_16_2)
1202  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetActiveFrameDimensions (NTV2FrameDimensions & outFrameDimensions, const NTV2Channel inChannel = NTV2_CHANNEL1));
1203  AJA_VIRTUAL NTV2_DEPRECATED_16_2(NTV2FrameDimensions GetActiveFrameDimensions (const NTV2Channel inChannel = NTV2_CHANNEL1));
1204  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetNumberActiveLines (ULWord & outNumActiveLines));
1205  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool FlipFlopPage (const NTV2Channel inChannel));
1206  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool SetPCIAccessFrame (const NTV2Channel inChannel, const ULWord inValue, const bool inWaitForVBI = true));
1207  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetPCIAccessFrame (const NTV2Channel inChannel, ULWord & outValue));
1208 #endif // !defined(NTV2_DEPRECATE_16_2)
1209 #if !defined(NTV2_DEPRECATE_16_0)
1210  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetEnableVANCData (const NTV2ChannelSet & inChannels, const bool inVANCenable, const bool inTallerVANC = false)) {return SetVANCMode(inChannels, NTV2VANCModeFromBools(inVANCenable, inTallerVANC));}
1211  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetVANCMode (const NTV2VANCMode m, const NTV2Standard st, const NTV2FrameGeometry fg,
1212  const NTV2Channel ch = NTV2_CHANNEL1)) {(void) st; (void) fg; return SetVANCMode(m, ch);}
1213  #define Set425FrameEnable SetTsiFrameEnable // Replace calls to Set425FrameEnable with calls to SetTsiFrameEnable instead
1214  #define Get425FrameEnable GetTsiFrameEnable // Replace calls to Get425FrameEnable with calls to GetTsiFrameEnable instead
1215 #endif // NTV2_DEPRECATE_16_0
1216 
1217 
1221 
1232  AJA_VIRTUAL bool SetMixerVancOutputFromForeground (const UWord inWhichMixer, const bool inFromForegroundSource = true);
1233 
1243  AJA_VIRTUAL bool GetMixerVancOutputFromForeground (const UWord inWhichMixer, bool & outIsFromForegroundSource);
1244 
1245 
1253  AJA_VIRTUAL bool SetMixerFGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1254 
1262  AJA_VIRTUAL bool GetMixerFGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1263 
1271  AJA_VIRTUAL bool SetMixerBGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1272 
1280  AJA_VIRTUAL bool GetMixerBGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1281 
1289  AJA_VIRTUAL bool SetMixerMode (const UWord inWhichMixer, const NTV2MixerKeyerMode inMode);
1290 
1298  AJA_VIRTUAL bool GetMixerMode (const UWord inWhichMixer, NTV2MixerKeyerMode & outMode);
1299 
1307  AJA_VIRTUAL bool SetMixerCoefficient (const UWord inWhichMixer, const ULWord inMixCoefficient);
1308 
1316  AJA_VIRTUAL bool GetMixerCoefficient (const UWord inWhichMixer, ULWord & outMixCoefficient);
1317 
1326  AJA_VIRTUAL bool GetMixerSyncStatus (const UWord inWhichMixer, bool & outIsSyncOK);
1327 
1335  AJA_VIRTUAL bool GetMixerFGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1336 
1344  AJA_VIRTUAL bool SetMixerFGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1345 
1353  AJA_VIRTUAL bool GetMixerBGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1354 
1362  AJA_VIRTUAL bool SetMixerBGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1363 
1371  AJA_VIRTUAL bool GetMixerMatteColor (const UWord inWhichMixer, YCbCr10BitPixel & outYCbCrValue);
1372 
1380  AJA_VIRTUAL bool SetMixerMatteColor (const UWord inWhichMixer, const YCbCr10BitPixel inYCbCrValue);
1381 
1388  AJA_VIRTUAL bool MixerHasRGBModeSupport (const UWord inWhichMixer, bool & outIsSupported);
1389 
1396  AJA_VIRTUAL bool SetMixerRGBRange (const UWord inWhichMixer, const NTV2MixerRGBRange inRGBRange);
1397 
1404  AJA_VIRTUAL bool GetMixerRGBRange (const UWord inWhichMixer, NTV2MixerRGBRange & outRGBRange);
1406 
1407 
1411 
1422  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1423 
1432  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1433 
1444  AJA_VIRTUAL bool GetNumberAudioChannels (ULWord & outNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1445 
1453  AJA_VIRTUAL bool SetAudioRate (const NTV2AudioRate inRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1454 
1462  AJA_VIRTUAL bool GetAudioRate (NTV2AudioRate & outRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1463 
1472  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1473 
1482  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inSize, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1483 
1491  AJA_VIRTUAL bool GetAudioBufferSize (NTV2AudioBufferSize & outSize, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1492 
1500  AJA_VIRTUAL bool SetAudio20BitMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 13.0
1501 
1511  AJA_VIRTUAL bool GetAudio20BitMode (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 13.0
1512 
1522  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1523 
1532  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1533 
1543  AJA_VIRTUAL bool GetAudioLoopBack (NTV2AudioLoopBack & outMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1544 
1545 
1546  AJA_VIRTUAL bool SetAudioAnalogLevel (const NTV2AudioLevel value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1547  AJA_VIRTUAL bool GetAudioAnalogLevel (NTV2AudioLevel & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1548  AJA_VIRTUAL bool SetEncodedAudioMode (const NTV2EncodedAudioMode value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1549  AJA_VIRTUAL bool GetEncodedAudioMode (NTV2EncodedAudioMode & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1550 
1558  AJA_VIRTUAL bool SetEmbeddedAudioClock (const NTV2EmbeddedAudioClock inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1559 
1567  AJA_VIRTUAL bool GetEmbeddedAudioClock (NTV2EmbeddedAudioClock & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1568 
1582  AJA_VIRTUAL bool GetAudioWrapAddress (ULWord & outWrapAddress, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1583 
1593  AJA_VIRTUAL bool GetAudioReadOffset (ULWord & outReadOffset, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1594 
1607  AJA_VIRTUAL bool GetAudioMemoryOffset (const ULWord inOffsetBytes, ULWord & outAbsByteOffset,
1608  const NTV2AudioSystem inAudioSystem, const bool inCaptureBuffer = false); // New in SDK 13.0
1609 
1621  AJA_VIRTUAL bool ReadAudioLastOut (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1622 
1633  AJA_VIRTUAL bool ReadAudioLastIn (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1634 
1649  AJA_VIRTUAL bool StartAudioOutput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1650 
1661  AJA_VIRTUAL bool StopAudioOutput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1662 
1672  AJA_VIRTUAL bool IsAudioOutputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1673 
1685  AJA_VIRTUAL bool SetAudioOutputPause (const NTV2AudioSystem inAudioSystem, const bool inPausePlayout); // New in SDK 12.3
1686 
1695  AJA_VIRTUAL bool GetAudioOutputPause (const NTV2AudioSystem inAudioSystem, bool & outIsPaused); // New in SDK 12.3
1696 
1711  AJA_VIRTUAL bool StartAudioInput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1712 
1724  AJA_VIRTUAL bool StopAudioInput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1725 
1734  AJA_VIRTUAL bool IsAudioInputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1735 
1747  AJA_VIRTUAL bool SetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 12.3
1748 
1759  AJA_VIRTUAL bool GetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 12.3
1760 
1769  AJA_VIRTUAL bool SetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable);
1770 
1781  AJA_VIRTUAL bool GetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable);
1782 
1794  AJA_VIRTUAL bool SetAudioInputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1795 
1806  AJA_VIRTUAL bool GetAudioInputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1807 
1808 
1819  AJA_VIRTUAL bool SetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1820 
1831  AJA_VIRTUAL bool GetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1832 
1833 
1845  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const bool inIsNonPCM); // New in SDK 12.1
1846 
1847 
1857  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, bool & outIsNonPCM); // New in SDK 12.1
1858 
1859 
1873  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, const bool inIsNonPCM); // New in SDK 12.2
1874 
1875 
1884  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPairs & inNonPCMChannelPairs); // New in SDK 12.4
1885 
1886 
1900  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsNonPCM); // New in SDK 12.2
1901 
1902 
1912  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outNonPCMChannelPairs); // New in SDK 12.4
1913 
1914 
1923  AJA_VIRTUAL bool IsAudioChannelPairPresent (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsPresent); // New in SDK 12.5
1924 
1925 
1936  AJA_VIRTUAL bool GetDetectedAudioChannelPairs (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 12.5
1937 
1938 
1945  AJA_VIRTUAL bool GetDetectedAESChannelPairs (NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 13.0
1946 
1947 
1961  AJA_VIRTUAL bool SetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, const NTV2AudioSource inAudioSource, const NTV2EmbeddedAudioInput inEmbeddedInput);
1962 
1974  AJA_VIRTUAL bool GetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, NTV2AudioSource & outAudioSource, NTV2EmbeddedAudioInput & outEmbeddedSource);
1975 
1989  AJA_VIRTUAL bool SetEmbeddedAudioInput (const NTV2EmbeddedAudioInput inEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1990 
2001  AJA_VIRTUAL bool GetEmbeddedAudioInput (NTV2EmbeddedAudioInput & outEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
2002 
2010  virtual bool InputAudioChannelPairHasPCM (const NTV2Channel inSDIInputConnector, const NTV2AudioChannelPair inAudioChannelPair, bool & outIsPCM); // New in SDK 12.3
2011 
2022  virtual bool GetInputAudioChannelPairsWithPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2023 
2030  virtual bool GetInputAudioChannelPairsWithoutPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2031 
2039  AJA_VIRTUAL bool GetSuspendHostAudio (bool & outIsSuspended); // New in SDK 12.1
2040 
2049  AJA_VIRTUAL bool SetSuspendHostAudio (const bool inSuspend); // New in SDK 12.1
2050 
2061  AJA_VIRTUAL bool GetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, NTV2AudioSystem & outSrcAudioSystem, NTV2Audio4ChannelSelect & outSrcAudioChannels); // New in SDK 12.5
2062 
2073  AJA_VIRTUAL bool SetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, const NTV2AudioSystem inSrcAudioSystem, const NTV2Audio4ChannelSelect inSrcAudioChannels); // New in SDK 12.5
2074 
2083  AJA_VIRTUAL bool SetAudioOutputMonitorSource (const NTV2AudioChannelPair inChannelPair, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
2084 
2093  AJA_VIRTUAL bool GetAudioOutputMonitorSource (NTV2AudioChannelPair & outChannelPair, NTV2AudioSystem & outAudioSystem);
2094 
2103  AJA_VIRTUAL bool GetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, bool & outEraseModeEnabled); // New in SDK 13.0
2104 
2113  AJA_VIRTUAL bool SetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, const bool & inEraseModeEnabled); // New in SDK 13.0
2114 
2122  AJA_VIRTUAL bool GetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, bool & outAESSyncModeBitSet); // New in SDK 15.2
2123 
2131  AJA_VIRTUAL bool SetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, const bool & inAESSyncModeBitSet); // New in SDK 15.2
2132 
2141  AJA_VIRTUAL bool SetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, const bool inEnable); // New in SDK 16.1
2142 
2151  AJA_VIRTUAL bool GetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, bool & outEnabled); // New in SDK 16.1
2152 
2162  AJA_VIRTUAL bool GetRawAudioTimer (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1); // New in SDK 15.5
2163 
2171  AJA_VIRTUAL bool EnableBOBAnalogAudioIn (bool inEnable); // New in SDK 17.0
2172 
2180  AJA_VIRTUAL bool SetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 16.2
2181 
2189  AJA_VIRTUAL bool GetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, bool & outEnabled); // New in SDK 16.2
2190 
2191 #if !defined(NTV2_DEPRECATE_16_0)
2192  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool WriteAudioSource (const ULWord inValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2193  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool ReadAudioSource (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2194  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetAudioOutputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioOutput(inAudioSystem) : StartAudioOutput(inAudioSystem);}
2195  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetAudioOutputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioOutputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2196  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetAudioInputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioInput(inAudioSystem) : StartAudioInput(inAudioSystem);}
2197  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetAudioInputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioInputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2198 #endif // !defined(NTV2_DEPRECATE_16_0)
2199 #if !defined(NTV2_DEPRECATE_16_1)
2200  AJA_VIRTUAL NTV2_DEPRECATED_16_1(bool SetAnalogAudioIOConfiguration (const NTV2AnalogAudioIO inConfig));
2201  AJA_VIRTUAL NTV2_DEPRECATED_16_1(bool GetAnalogAudioIOConfiguration (NTV2AnalogAudioIO & outConfig));
2202  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool ReadAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastOut(outValue, NTV2AudioSystem(inChannel));}
2203  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool ReadAudioLastIn (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastIn(outValue, NTV2AudioSystem(inChannel));}
2204  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool WriteAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {(void)outValue;(void)inChannel; return false;}
2205 #endif // !defined(NTV2_DEPRECATE_16_1)
2206 #if !defined(NTV2_DEPRECATE_16_3)
2207  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool WriteAudioLastOut (const ULWord inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1)) {(void)inValue;(void)inAudioSystem; return false;}
2208 #endif // !defined(NTV2_DEPRECATE_16_3)
2209 #if !defined(NTV2_DEPRECATE_17_0)
2211 #endif // !defined(NTV2_DEPRECATE_17_0)
2212 #if !defined(NTV2_DEPRECATE_17_5)
2213  AJA_VIRTUAL inline NTV2_DEPRECATED_17_5(bool GetAudioOutputEmbedderState (const NTV2Channel sdi, bool & enb)) {return GetSDIOutputAudioEnabled(sdi,enb);}
2214  AJA_VIRTUAL inline NTV2_DEPRECATED_17_5(bool SetAudioOutputEmbedderState (const NTV2Channel sdi, const bool & enb)) {return SetSDIOutputAudioEnabled(sdi,enb);}
2215 #endif // defined(NTV2_DEPRECATE_17_5)
2216 
2221 
2230  AJA_VIRTUAL bool GetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, NTV2AudioSystem & outAudioSystem); // New in SDK 15.5
2231 
2239  AJA_VIRTUAL bool SetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, const NTV2AudioSystem inAudioSystem); // New in SDK 15.5
2240 
2249  AJA_VIRTUAL bool GetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelPair & outChannelPair); // New in SDK 15.5
2250 
2259  AJA_VIRTUAL bool SetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPair inChannelPair); // New in SDK 15.5
2260 
2272  AJA_VIRTUAL bool GetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, ULWord & outGainValue); // New in SDK 15.5
2273 
2285  AJA_VIRTUAL bool SetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, const ULWord inGainValue); // New in SDK 15.5
2286 
2294  AJA_VIRTUAL bool GetAudioMixerOutputGain (ULWord & outGainValue); // New in SDK 15.5
2295 
2303  AJA_VIRTUAL bool SetAudioMixerOutputGain (const ULWord inGainValue); // New in SDK 15.5
2304 
2314  AJA_VIRTUAL bool GetAudioMixerOutputLevels (const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2315 
2323  AJA_VIRTUAL bool GetHeadphoneOutputGain (ULWord & outGainValue);
2324 
2332  AJA_VIRTUAL bool SetHeadphoneOutputGain (const ULWord inGainValue);
2333 
2343  AJA_VIRTUAL bool GetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2344 
2355  AJA_VIRTUAL bool SetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2356 
2367  AJA_VIRTUAL bool GetAudioMixerInputLevels (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2368 
2375  AJA_VIRTUAL bool GetAudioMixerLevelsSampleCount (ULWord & outSampleCount); // New in SDK 15.5
2376 
2384  AJA_VIRTUAL bool SetAudioMixerLevelsSampleCount (const ULWord inSampleCount); // New in SDK 15.5
2385 
2393  AJA_VIRTUAL bool GetAudioMixerOutputChannelsMute (NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2394 
2403  AJA_VIRTUAL bool SetAudioMixerOutputChannelsMute (const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2405 
2406  #if !defined(NTV2_DEPRECATE_16_3)
2408  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool ReadGlobalControl(ULWord * pOutVal)) {return pOutVal ? ReadRegister(kRegGlobalControl, *pOutVal) : false;}
2409  #endif // !defined(NTV2_DEPRECATE_16_3)
2410 
2411 
2415  AJA_VIRTUAL bool ReadFlashProgramControl(ULWord & outValue);
2417  AJA_VIRTUAL bool IsXilinxProgrammed();
2418  AJA_VIRTUAL bool ProgramMainFlash(const std::string & inFileName, const bool bInForceUpdate = false, const bool bInQuiet = false); // inFileName became const std::string& in SDK 16.2
2419  AJA_VIRTUAL bool GetProgramStatus(SSC_GET_FIRMWARE_PROGRESS_STRUCT *statusStruct);
2420 
2429  AJA_VIRTUAL bool GetRunningFirmwarePackageRevision (ULWord & outRevision);
2430 
2431 
2440  AJA_VIRTUAL bool GetRunningFirmwareRevision (UWord & outRevision);
2441 
2456  AJA_VIRTUAL bool GetRunningFirmwareDate (UWord & outYear, UWord & outMonth, UWord & outDay);
2457 
2472  AJA_VIRTUAL bool GetRunningFirmwareTime (UWord & outHours, UWord & outMinutes, UWord & outSeconds);
2473 
2488  AJA_VIRTUAL bool GetRunningFirmwareDate (std::string & outDate, std::string & outTime);
2489 
2496  AJA_VIRTUAL bool GetRunningFirmwareUserID (ULWord & outUserID); // New in SDK 16.1
2498 
2499 #if !defined(NTV2_DEPRECATE_16_0)
2500  // OEM Mapping to Userspace Functions
2501  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBaseAddress(NTV2Channel channel, ULWord **pBaseAddress));
2502  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBaseAddress(ULWord **pBaseAddress));
2503  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetRegisterBaseAddress(ULWord regNumber, ULWord ** pRegAddress));
2504  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetXena2FlashBaseAddress(ULWord ** pXena2FlashAddress));
2505 #endif // !defined(NTV2_DEPRECATE_16_0)
2506 
2507 #if !defined(NTV2_DEPRECATE_17_0)
2508  // Read-Only Status Registers
2509  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus, *pVal) : false;}
2510  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus2, *pVal) : false;}
2511  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInputStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus, *pVal) : false;}
2512  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInputStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus2, *pVal) : false;}
2513  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInput56StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput56Status, *pVal) : false;}
2514  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInput78StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput78Status, *pVal) : false;}
2518 #endif // !defined(NTV2_DEPRECATE_17_0)
2519 
2520  AJA_VIRTUAL bool SupportsP2PTransfer (void);
2521  AJA_VIRTUAL bool SupportsP2PTarget (void);
2522 
2523 
2527 
2534  AJA_VIRTUAL bool SetLEDState (ULWord inValue);
2535 
2542  AJA_VIRTUAL bool GetLEDState (ULWord & outValue);
2544 
2545 
2549 
2558  AJA_VIRTUAL bool SetRP188Mode (const NTV2Channel inChannel, const NTV2_RP188Mode inMode);
2559 
2567  AJA_VIRTUAL bool GetRP188Mode (const NTV2Channel inChannel, NTV2_RP188Mode & outMode);
2568 
2577  AJA_VIRTUAL bool SetRP188Data (const NTV2Channel inSDIOutput, const NTV2_RP188 & inRP188Data);
2578 
2593  AJA_VIRTUAL bool GetRP188Data (const NTV2Channel inSDIInput, NTV2_RP188 & outRP188Data);
2594 
2603  AJA_VIRTUAL bool SetRP188SourceFilter (const NTV2Channel inSDIInput, const UWord inFilterValue);
2604 
2615  AJA_VIRTUAL bool GetRP188SourceFilter (const NTV2Channel inSDIInput, UWord & outFilterValue);
2616 
2627  AJA_VIRTUAL bool IsRP188BypassEnabled (const NTV2Channel inSDIOutput, bool & outIsBypassEnabled);
2628 
2636  AJA_VIRTUAL bool DisableRP188Bypass (const NTV2Channel inSDIOutput);
2637 
2645  AJA_VIRTUAL bool EnableRP188Bypass (const NTV2Channel inSDIOutput);
2646 
2655  AJA_VIRTUAL bool SetRP188BypassSource (const NTV2Channel inSDIOutput, const UWord inSDIInput);
2656 
2665  AJA_VIRTUAL bool GetRP188BypassSource (const NTV2Channel inSDIOutput, UWord & outSDIInput);
2667 
2668 
2672  //
2674  // Enable Interrupt/Event
2675  //
2676  AJA_VIRTUAL bool EnableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2677 
2684  AJA_VIRTUAL bool EnableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2685 
2692  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2693 
2700  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2701 
2702 
2703  //
2704  // Disable Interrupt/Event
2705  //
2706  AJA_VIRTUAL bool DisableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2707 
2714  AJA_VIRTUAL bool DisableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2715 
2722  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2723 
2730  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2731 
2732  AJA_VIRTUAL bool GetCurrentInterruptMasks (NTV2InterruptMask & outIntMask1, NTV2Interrupt2Mask & outIntMask2);
2733 
2734 
2735  //
2736  // Subscribe to events
2737  //
2745  AJA_VIRTUAL bool SubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2746 
2756  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2757 
2767  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2768 
2769 
2779  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2780 
2790  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2791 
2792 
2793  //
2794  // Unsubscribe from events
2795  //
2802  AJA_VIRTUAL bool UnsubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2803 
2811  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2812 
2820  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2821 
2829  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2830 
2838  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2839 
2840 
2841  //
2842  // Get interrupt counts
2843  //
2851  AJA_VIRTUAL bool GetOutputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2852 
2860  AJA_VIRTUAL bool GetInputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2861 
2869  AJA_VIRTUAL bool GetOutputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2870 
2878  AJA_VIRTUAL bool GetInputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2879 
2887  AJA_VIRTUAL bool SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2888 
2896  AJA_VIRTUAL bool SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2897 
2898  //
2899  // Current field ID
2900  //
2901 
2908  AJA_VIRTUAL bool GetOutputFieldID (const NTV2Channel inChannel, NTV2FieldID & outFieldID);
2909 
2916  AJA_VIRTUAL bool GetInputFieldID (const NTV2Channel inChannel, NTV2FieldID & outFieldID);
2917 
2918  //
2919  // Wait for event
2920  //
2942  AJA_VIRTUAL bool WaitForOutputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2943 
2965  AJA_VIRTUAL bool WaitForOutputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
2966 
2985  AJA_VIRTUAL bool WaitForInputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2986 
3007  AJA_VIRTUAL bool WaitForInputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
3008 
3009  //
3010  // RegisterAccess Control
3011  //
3020  AJA_VIRTUAL bool SetRegisterWriteMode (const NTV2RegisterWriteMode inValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3021 
3030  AJA_VIRTUAL bool GetRegisterWriteMode (NTV2RegisterWriteMode & outValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3031 
3032  #if !defined (NTV2_DEPRECATE_16_0)
3033  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetRegisterWritemode(NTV2RegisterWriteMode inVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(inVal,inChan);}
3034  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetRegisterWritemode(NTV2RegisterWriteMode & outVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(outVal,inChan);}
3035  #endif // NTV2_DEPRECATE_16_0
3036 
3038  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetForce64(ULWord force64));
3039  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetForce64(ULWord* force64));
3040  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool Get64BitAutodetect(ULWord* autodetect64));
3041 
3045  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetFrameStamp (NTV2Crosspoint channelSpec, ULWord frameNum, FRAME_STAMP_STRUCT* pFrameStamp));
3047  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetAutoCirculate (NTV2Crosspoint channelSpec, AUTOCIRCULATE_STATUS_STRUCT* autoCirculateStatus));
3048 
3049 
3092  AJA_VIRTUAL bool AutoCirculateInitForInput ( const NTV2Channel inChannel,
3093  const UWord inFrameCount = 7,
3094  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3095  const ULWord inOptionFlags = 0,
3096  const UByte inNumChannels = 1,
3097  const UWord inStartFrameNumber = 0,
3098  const UWord inEndFrameNumber = 0);
3099 
3128  AJA_VIRTUAL bool AutoCirculateInitForInput ( const NTV2Channel inChannel,
3129  const NTV2ACFrameRange & inFrameRange,
3130  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3131  const ULWord inOptionFlags = 0,
3132  const UByte inNumChannels = 1);
3133 
3175  AJA_VIRTUAL bool AutoCirculateInitForOutput (const NTV2Channel inChannel,
3176  const UWord inFrameCount = 7,
3177  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3178  const ULWord inOptionFlags = 0,
3179  const UByte inNumChannels = 1,
3180  const UWord inStartFrameNumber = 0,
3181  const UWord inEndFrameNumber = 0);
3182 
3211  AJA_VIRTUAL bool AutoCirculateInitForOutput (const NTV2Channel inChannel,
3212  const NTV2ACFrameRange & inFrameRange,
3213  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3214  const ULWord inOptionFlags = 0,
3215  const UByte inNumChannels = 1);
3216 
3248  AJA_VIRTUAL bool AutoCirculateStart (const NTV2Channel inChannel, const ULWord64 inStartTime = 0);
3249 
3265  AJA_VIRTUAL bool AutoCirculateStop (const NTV2Channel inChannel, const bool inAbort = false);
3266 
3275  AJA_VIRTUAL bool AutoCirculateStop (const NTV2ChannelSet & inChannels, const bool inAbort = false); // New in SDK 17.0
3276 
3288  AJA_VIRTUAL bool AutoCirculatePause (const NTV2Channel inChannel, const UWord inAtFrameNum = 0xFFFF); // Added inAtFrameNum in SDK 16.2
3289 
3301  AJA_VIRTUAL bool AutoCirculateResume (const NTV2Channel inChannel, const bool inClearDropCount = false);
3302 
3318  AJA_VIRTUAL bool AutoCirculateFlush (const NTV2Channel inChannel, const bool inClearDropCount = false);
3319 
3336  AJA_VIRTUAL bool AutoCirculatePreRoll (const NTV2Channel inChannel, const ULWord inPreRollFrames);
3337 
3349  AJA_VIRTUAL bool AutoCirculateGetStatus (const NTV2Channel inChannel, AUTOCIRCULATE_STATUS & outStatus);
3350 
3351 
3368  AJA_VIRTUAL bool AutoCirculateGetFrameStamp (const NTV2Channel inChannel, const ULWord inFrameNumber, FRAME_STAMP & outFrameInfo);
3369 
3385  AJA_VIRTUAL bool AutoCirculateSetActiveFrame (const NTV2Channel inChannel, const ULWord inNewActiveFrame);
3386 
3423  AJA_VIRTUAL bool AutoCirculateTransfer (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & transferInfo);
3424 
3443  AJA_VIRTUAL bool FindUnallocatedFrames (const UWord inFrameCount, LWord & outStartFrame, LWord & outEndFrame,
3444  const NTV2Channel inFrameStore = NTV2_CHANNEL_INVALID);
3446 
3450 #define NTV2_STREAM_SUCCESS(__status__) (__status__ == NTV2_STREAM_SUCCESS)
3452 #define NTV2_STREAM_FAIL(__status__) (__status__ != NTV2_STREAM_SUCCESS)
3453 
3459  AJA_VIRTUAL ULWord StreamChannelInitialize (const NTV2Channel inChannel);
3460 
3465  AJA_VIRTUAL ULWord StreamChannelRelease (const NTV2Channel inChannel);
3466 
3473  AJA_VIRTUAL ULWord StreamChannelStart (const NTV2Channel inChannel,
3474  NTV2StreamChannel& status);
3475 
3482  AJA_VIRTUAL ULWord StreamChannelStop (const NTV2Channel inChannel,
3483  NTV2StreamChannel& status);
3484 
3491  AJA_VIRTUAL ULWord StreamChannelFlush (const NTV2Channel inChannel,
3492  NTV2StreamChannel& status);
3493 
3499  AJA_VIRTUAL ULWord StreamChannelStatus (const NTV2Channel inChannel,
3500  NTV2StreamChannel& status);
3501 
3507  AJA_VIRTUAL ULWord StreamChannelWait (const NTV2Channel inChannel,
3508  NTV2StreamChannel& status);
3509 
3516  AJA_VIRTUAL ULWord StreamBufferQueue (const NTV2Channel inChannel,
3517  NTV2Buffer& inBuffer,
3518  ULWord64 bufferCookie,
3519  NTV2StreamBuffer& status);
3520 
3526  AJA_VIRTUAL ULWord StreamBufferRelease (const NTV2Channel inChannel,
3527  NTV2StreamBuffer& status);
3528 
3534  AJA_VIRTUAL ULWord StreamBufferStatus (const NTV2Channel inChannel,
3535  ULWord64 bufferCookie,
3536  NTV2StreamBuffer& status);
3538 
3539 
3540 #if defined(READREGMULTICHANGE)
3541 
3551  AJA_VIRTUAL bool ReadRegisters (const NTV2RegNumSet & inRegNums, NTV2RegisterValueMap & outValues);
3552 #endif // defined(READREGMULTICHANGE)
3553 
3561  AJA_VIRTUAL bool BankSelectReadRegister (const NTV2RegInfo & inBankSelect, NTV2RegInfo & inOutRegInfo);
3562 
3569  AJA_VIRTUAL bool WriteRegisters (const NTV2RegisterWrites & inRegWrites);
3570 
3578  AJA_VIRTUAL bool BankSelectWriteRegister (const NTV2RegInfo & inBankSelect, const NTV2RegInfo & inRegInfo);
3579 
3588  AJA_VIRTUAL bool WriteVirtualData (const ULWord inTag, const void* inVirtualData, const ULWord inVirtualDataSize);
3589 
3598  AJA_VIRTUAL bool ReadVirtualData (const ULWord inTag, void* outVirtualData, const ULWord inVirtualDataSize);
3599 
3606  AJA_VIRTUAL bool ReadSDIStatistics (NTV2SDIInStatistics & outStats);
3607 
3615  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Framesize inSize);
3616 
3624  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Channel inChannel, const NTV2Framesize inValue);
3625 
3633  AJA_VIRTUAL bool GetFrameBufferSize (const NTV2Channel inChannel, NTV2Framesize & outValue);
3634 #if !defined(NTV2_DEPRECATE_17_2)
3635  using CNTV2DriverInterface::GetFrameBufferSize; // Keep CNTV2DriverInterface::GetFrameBufferSize visible after being shadowed by CNTV2Card::GetFrameBufferSize
3636 #endif
3637 
3638 
3643  AJA_VIRTUAL bool IsBufferSizeSetBySW (void);
3644 
3652  AJA_VIRTUAL bool DisableChannel (const NTV2Channel inChannel);
3653 
3661  AJA_VIRTUAL bool DisableChannels (const NTV2ChannelSet & inChannels);
3662 
3670  AJA_VIRTUAL bool EnableChannel (const NTV2Channel inChannel);
3671 
3682  AJA_VIRTUAL bool EnableChannels (const NTV2ChannelSet & inChannels, const bool inDisableOthers = false);
3683 
3691  AJA_VIRTUAL bool IsChannelEnabled (const NTV2Channel inChannel, bool & outEnabled);
3692 
3699  AJA_VIRTUAL bool GetEnabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3700 
3707  AJA_VIRTUAL bool GetDisabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3708 
3709  AJA_VIRTUAL bool SetVideoDACMode (NTV2VideoDACMode inValue);
3710  AJA_VIRTUAL bool GetVideoDACMode (NTV2VideoDACMode & outValue);
3711 
3712 
3716  AJA_VIRTUAL bool GetNominalMinMaxHV (int & outNominalH, int & outMinH, int & outMaxH, int & outNominalV, int & outMinV, int & outMaxV);
3718 
3730  AJA_VIRTUAL bool SetVideoHOffset (const int inHOffset, const UWord inOutputSpigot = 0);
3731 
3742  AJA_VIRTUAL bool GetVideoHOffset (int & outHOffset, const UWord inOutputSpigot = 0);
3743 
3755  AJA_VIRTUAL bool SetVideoVOffset (const int inVOffset, const UWord inOutputSpigot = 0);
3756 
3767  AJA_VIRTUAL bool GetVideoVOffset (int & outVOffset, const UWord inOutputSpigot = 0);
3768 
3769  AJA_VIRTUAL bool SetAnalogOutHTiming (ULWord inValue);
3770  AJA_VIRTUAL bool GetAnalogOutHTiming (ULWord & outValue);
3771 
3786  AJA_VIRTUAL bool WriteOutputTimingControl (const ULWord inValue, const UWord inOutputSpigot = 0);
3787 
3798  AJA_VIRTUAL bool ReadOutputTimingControl (ULWord & outValue, const UWord inOutputSpigot = 0);
3799 
3800  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI1OutHTiming (ULWord value));
3801  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI1OutHTiming(ULWord* value));
3802  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI2OutHTiming (ULWord value));
3803  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI2OutHTiming(ULWord* value));
3805 
3809  /*
3811  @brief Sets the VPID payload value(s) for each link of the given 3G SDI output.
3812  @param[in] inValueA Specifies the "Link A" VPID value to be embedded in the "A" link output signal.
3813  @param[in] inValueB Specifies the "Link B" VPID value to be embedded in the "B" link output signal.
3814  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3815  Defaults to zero, the first SDI output connector.
3816  @return True if successful; otherwise false.
3817  */
3818  AJA_VIRTUAL bool SetSDIOutVPID (const ULWord inValueA, const ULWord inValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3819 
3820  /*
3821  @brief Answers with the VPID payload value(s) that are currently being embedded for each link of the given 3G SDI output.
3822  @param[out] outValueA Receives the VPID payload value currently being embedded in the "A" link output signal.
3823  @param[out] outValueB Receives the VPID payload value currently being embedded in the "B" link output signal.
3824  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3825  Defaults to zero, the first SDI output connector.
3826  @return True if successful; otherwise false.
3827  */
3828  AJA_VIRTUAL bool GetSDIOutVPID (ULWord & outValueA, ULWord & outValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3829 
3830  /*
3831  @brief Reads the latest received VPID payload value(s) for each link of the given SDI input.
3832  @param[in] inSDIInput Specifies the 3G SDI input connector as an ::NTV2Channel, a zero-based index value.
3833  @param[out] outValueA Receives the "Link A" VPID payload value -- or zero if VPID was not present.
3834  @param[out] outValueB Receives the "Link B" VPID payload value -- or zero if VPID was not present.
3835  @return True if successful; otherwise false.
3836  */
3837  AJA_VIRTUAL bool ReadSDIInVPID (const NTV2Channel inSDIInput, ULWord & outValueA, ULWord & outValueB);
3838 
3843  AJA_VIRTUAL bool GetVPIDValidA (const NTV2Channel inChannel);
3844 
3849  AJA_VIRTUAL bool GetVPIDValidB (const NTV2Channel inChannel);
3851 
3858  AJA_VIRTUAL bool SetSDIOutputStandard (const UWord inOutputSpigot, const NTV2Standard inValue);
3859 
3867  AJA_VIRTUAL bool SetSDIOutputStandard (const NTV2ChannelSet & inSDIOutputs, const NTV2Standard inValue); // New in SDK v16.0
3868 
3875  AJA_VIRTUAL bool GetSDIOutputStandard (const UWord inOutputSpigot, NTV2Standard & outValue);
3876 
3877 
3881  AJA_VIRTUAL bool SetUpConvertMode (const NTV2UpConvertMode inValue);
3883  AJA_VIRTUAL bool GetUpConvertMode (NTV2UpConvertMode & outValue);
3884  AJA_VIRTUAL bool SetConverterOutStandard (const NTV2Standard inValue);
3885  AJA_VIRTUAL bool GetConverterOutStandard (NTV2Standard & outValue);
3886  AJA_VIRTUAL bool SetConverterOutRate (const NTV2FrameRate inValue);
3887  AJA_VIRTUAL bool GetConverterOutRate (NTV2FrameRate & outValue);
3888  AJA_VIRTUAL bool SetConverterInStandard (const NTV2Standard inValue);
3889  AJA_VIRTUAL bool GetConverterInStandard (NTV2Standard & outValue);
3890  AJA_VIRTUAL bool SetConverterInRate (const NTV2FrameRate inValue);
3891  AJA_VIRTUAL bool GetConverterInRate (NTV2FrameRate & outValue);
3892  AJA_VIRTUAL bool SetConverterPulldown (const ULWord inValue);
3893  AJA_VIRTUAL bool GetConverterPulldown (ULWord & outValue);
3894  AJA_VIRTUAL bool SetUCPassLine21 (const ULWord inValue);
3895  AJA_VIRTUAL bool GetUCPassLine21 (ULWord & outValue);
3896  AJA_VIRTUAL bool SetUCAutoLine21 (const ULWord inValue);
3897  AJA_VIRTUAL bool GetUCAutoLine21 (ULWord & outValue);
3898 
3899  AJA_VIRTUAL bool SetDownConvertMode (const NTV2DownConvertMode inValue);
3900  AJA_VIRTUAL bool GetDownConvertMode (NTV2DownConvertMode & outValue);
3901  AJA_VIRTUAL bool SetIsoConvertMode (const NTV2IsoConvertMode inValue);
3902  AJA_VIRTUAL bool GetIsoConvertMode (NTV2IsoConvertMode & outValue);
3903  AJA_VIRTUAL bool SetEnableConverter (const bool inValue);
3904  AJA_VIRTUAL bool GetEnableConverter (bool & outValue);
3905  AJA_VIRTUAL bool SetDeinterlaceMode (const ULWord inValue);
3906  AJA_VIRTUAL bool GetDeinterlaceMode (ULWord & outValue);
3907 
3908  AJA_VIRTUAL bool SetConversionMode (const NTV2ConversionMode inConversionMode);
3909  AJA_VIRTUAL bool GetConversionMode (NTV2ConversionMode & outConversionMode);
3911 
3915 
3925  AJA_VIRTUAL bool SetColorSpaceMethod (const NTV2ColorSpaceMethod inCSCMethod, const NTV2Channel inChannel);
3926 
3935  AJA_VIRTUAL bool GetColorSpaceMethod (NTV2ColorSpaceMethod & outMethod, const NTV2Channel inChannel = NTV2_CHANNEL1);
3936 
3945  AJA_VIRTUAL bool SetColorSpaceMatrixSelect (const NTV2ColorSpaceMatrixType inType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3946 
3955  AJA_VIRTUAL bool GetColorSpaceMatrixSelect (NTV2ColorSpaceMatrixType & outType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3956 
3966  AJA_VIRTUAL bool DownloadLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3967  const NTV2Channel inLUT, const int inBank);
3968  AJA_VIRTUAL bool Download12BitLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3969  const NTV2Channel inLUT, const int inBank);
3970 
3980  AJA_VIRTUAL bool DownloadLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3981  const NTV2Channel inLUT, const int inBank);
3982  AJA_VIRTUAL bool Download12BitLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3983  const NTV2Channel inLUT, const int inBank);
3984 
3992  AJA_VIRTUAL bool SetLUTEnable (const bool inEnable, const NTV2Channel inLUT);
3993 
3994  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, NTV2DoubleArray & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
3995  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, UWordSequence & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
3996 
4006  AJA_VIRTUAL bool LoadLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
4007  AJA_VIRTUAL bool Load12BitLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
4008 
4018  AJA_VIRTUAL bool WriteLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
4019  AJA_VIRTUAL bool Write12BitLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
4020 
4030  AJA_VIRTUAL bool GetLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
4031  AJA_VIRTUAL bool Get12BitLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
4032 
4042  AJA_VIRTUAL bool ReadLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
4043  AJA_VIRTUAL bool Read12BitLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
4044 
4045  AJA_VIRTUAL bool SetLUTV2HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4046  AJA_VIRTUAL bool GetLUTV2HostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel);
4047 
4048  AJA_VIRTUAL bool SetLUTV3HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4049  AJA_VIRTUAL bool GetLUTV3HostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel);
4050 
4051  AJA_VIRTUAL bool SetLUTV2OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4052  AJA_VIRTUAL bool GetLUTV2OutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4053 
4054  AJA_VIRTUAL bool SetLUTV3OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4055  AJA_VIRTUAL bool GetLUTV3OutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4056 
4057  AJA_VIRTUAL bool Has12BitLUTSupport (const NTV2Channel inChannel = NTV2_CHANNEL1);
4058 
4064  AJA_VIRTUAL bool Set12BitLUTPlaneSelect (const NTV2LUTPlaneSelect inLUTPlane, const NTV2Channel inChannel = NTV2_MAX_NUM_CHANNELS);
4065 
4071  AJA_VIRTUAL bool Get12BitLUTPlaneSelect (NTV2LUTPlaneSelect & outLUTPlane, const NTV2Channel inChannel = NTV2_MAX_NUM_CHANNELS);
4072 
4082  AJA_VIRTUAL bool SetColorSpaceRGBBlackRange (const NTV2_CSC_RGB_Range inRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4083 
4093  AJA_VIRTUAL bool GetColorSpaceRGBBlackRange (NTV2_CSC_RGB_Range & outRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4094 
4095  AJA_VIRTUAL bool SetColorSpaceUseCustomCoefficient (const ULWord inUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4096  AJA_VIRTUAL bool GetColorSpaceUseCustomCoefficient (ULWord & outUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4097 
4108  AJA_VIRTUAL bool SetColorSpaceMakeAlphaFromKey (const bool inMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4109 
4120  AJA_VIRTUAL bool GetColorSpaceMakeAlphaFromKey (ULWord & outMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4121 
4137  AJA_VIRTUAL bool GetColorSpaceVideoKeySyncFail (bool & outVideoKeySyncFail, const NTV2Channel inChannel = NTV2_CHANNEL1);
4138 
4139  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4140  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4141 
4142  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients12Bit (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4143  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients12Bit (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4144 
4145  AJA_VIRTUAL bool SetLUTControlSelect (const NTV2LUTControlSelect inLUTSelect);
4146  AJA_VIRTUAL bool GetLUTControlSelect (NTV2LUTControlSelect & outLUTSelect);
4147 
4148  //
4149  // Color Correction Functions (KHD only )
4150  //
4151  AJA_VIRTUAL bool SetColorCorrectionMode(const NTV2Channel inChannel, const NTV2ColorCorrectionMode inMode);
4152  AJA_VIRTUAL bool GetColorCorrectionMode(const NTV2Channel inChannel, NTV2ColorCorrectionMode & outMode);
4153 
4161  AJA_VIRTUAL bool SetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4162 
4170  AJA_VIRTUAL bool GetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4171 
4172  AJA_VIRTUAL bool SetColorCorrectionHostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4173  AJA_VIRTUAL bool GetColorCorrectionHostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4174 
4175  AJA_VIRTUAL bool SetColorCorrectionSaturation (const NTV2Channel inChannel, const ULWord inValue);
4176  AJA_VIRTUAL bool GetColorCorrectionSaturation (const NTV2Channel inChannel, ULWord & outValue);
4177 
4178  AJA_VIRTUAL bool SetDitherFor8BitInputs (const NTV2Channel inChannel, const ULWord inDither);
4179  AJA_VIRTUAL bool GetDitherFor8BitInputs (const NTV2Channel inChannel, ULWord & outDither);
4180 
4181  // Old APIs
4182  static NTV2_SHOULD_BE_DEPRECATED(bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, double * pOutTable));
4183  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(NTV2ColorSpaceMethod GetColorSpaceMethod (const NTV2Channel inChannel));
4184  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool DownloadLUTToHW(const double * pInTable, const NTV2Channel inChannel, const int inBank));
4185  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool LoadLUTTable (const double * pInTable));
4187 
4188 
4189  AJA_VIRTUAL bool SetSecondaryVideoFormat(NTV2VideoFormat inFormat); // RETAIL USE ONLY
4190  AJA_VIRTUAL bool GetSecondaryVideoFormat(NTV2VideoFormat & outFormat); // RETAIL USE ONLY
4191 
4192  #if !defined(R2_DEPRECATE)
4193  AJA_VIRTUAL bool SetInputVideoSelect (NTV2InputVideoSelect inInputSelect); // RETAIL USE ONLY
4194  AJA_VIRTUAL bool GetInputVideoSelect(NTV2InputVideoSelect & outInputSelect); // RETAIL USE ONLY
4195  #endif
4196 
4197  // --------------------------------------------
4198  // GetNTV2VideoFormat functions
4199  // @deprecated These static functions don't work correctly, and will be deprecated.
4200  // For a given frame rate, geometry and transport, there may be 2 (or more!) possible matching video formats.
4201  // The improved GetNTV2VideoFormat function may return a new CNTV2SDIVideoInfo object that can be interrogated about many things.
4202  // @note This function originated in CNTV2Status.
4203  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, UByte inputGeometry, bool progressiveTransport, bool isThreeG, bool progressivePicture=false);
4204  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=false, bool isSquareDivision = true);
4205  // --------------------------------------------
4206 
4207 public:
4219  AJA_VIRTUAL NTV2VideoFormat GetInputVideoFormat (const NTV2InputSource inVideoSource = NTV2_INPUTSOURCE_SDI1, const bool inIsProgressive = false);
4220 
4232  AJA_VIRTUAL NTV2VideoFormat GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive = false);
4233 
4239  AJA_VIRTUAL NTV2VideoFormat GetHDMIInputVideoFormat (NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4240 
4245  AJA_VIRTUAL NTV2VideoFormat GetAnalogInputVideoFormat (void);
4246 
4251  AJA_VIRTUAL NTV2VideoFormat GetAnalogCompositeInputVideoFormat (void);
4252 
4262  AJA_VIRTUAL NTV2VideoFormat GetReferenceVideoFormat (void);
4263 
4264  AJA_VIRTUAL NTV2FrameRate GetSDIInputRate (const NTV2Channel channel);
4265  AJA_VIRTUAL NTV2FrameGeometry GetSDIInputGeometry (const NTV2Channel channel);
4266  AJA_VIRTUAL bool GetSDIInputIsProgressive (const NTV2Channel channel);
4267 
4268  AJA_VIRTUAL bool GetSDIInput3GPresent (bool & outValue, const NTV2Channel channel);
4269  AJA_VIRTUAL bool GetSDIInput3GbPresent (bool & outValue, const NTV2Channel channel);
4270  AJA_VIRTUAL bool GetSDIInput6GPresent (bool & outValue, const NTV2Channel channel);
4271  AJA_VIRTUAL bool GetSDIInput12GPresent (bool & outValue, const NTV2Channel channel);
4272 
4276 
4286  AJA_VIRTUAL bool GetConnectedOutput (const NTV2InputCrosspointID inInputXpt, NTV2OutputCrosspointID & outOutputXpt);
4287 
4297  AJA_VIRTUAL bool GetConnectedInput (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointID & outInputXpt);
4298 
4307  AJA_VIRTUAL bool GetConnectedInputs (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointIDSet & outInputXpts); // New in SDK 15.5
4308 
4320  AJA_VIRTUAL bool Connect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, const bool inValidate = false);
4321 
4331  AJA_VIRTUAL bool Connect (const NTV2XptConnection & inConnection, const bool inValidate = false);
4332 
4339  AJA_VIRTUAL bool Disconnect (const NTV2InputCrosspointID inInputXpt);
4340 
4349  AJA_VIRTUAL bool IsConnected (const NTV2InputCrosspointID inInputXpt, bool & outIsConnected);
4350 
4360  AJA_VIRTUAL bool IsConnected (const NTV2XptConnection inConnection, bool & outIsConnected);
4361 
4370  AJA_VIRTUAL bool IsConnectedTo (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outIsConnected);
4371 
4381  AJA_VIRTUAL bool CanConnect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outCanConnect);
4382 
4391  AJA_VIRTUAL bool CanConnect (const NTV2XptConnection & inConnection, bool & outCanConnect);
4392 
4401  AJA_VIRTUAL bool SupportedOutputXptsForInputXpt (const NTV2InputXptID inInputXptID, NTV2OutputXptIDSet & outOutputXpts);
4402 
4403 
4422  AJA_VIRTUAL bool ApplySignalRoute (const CNTV2SignalRouter & inRouter, const bool inReplace = false);
4423 
4424 
4443  AJA_VIRTUAL bool ApplySignalRoute (const NTV2XptConnections & inConnections, const bool inReplace = false);
4444 
4451  AJA_VIRTUAL bool RemoveConnections (const NTV2XptConnections & inConnections);
4452 
4460  AJA_VIRTUAL bool ClearRouting (void);
4461 
4468  AJA_VIRTUAL bool GetRouting (CNTV2SignalRouter & outRouting);
4469 
4476  AJA_VIRTUAL bool GetConnections (NTV2XptConnections & outConnections); // New in SDK 16.0
4477 
4485  AJA_VIRTUAL bool GetRoutingForChannel (const NTV2Channel inChannel, CNTV2SignalRouter & outRouting);
4486 
4487 #if !defined(NTV2_DEPRECATE_17_0)
4489 #endif // !defined(NTV2_DEPRECATE_17_0)
4490 
4495  AJA_VIRTUAL bool GetPossibleConnections (NTV2PossibleConnections & outConnections);
4496 
4502  AJA_VIRTUAL bool GetAllWidgetInputs (NTV2InputXptIDSet & outInputs); // New in SDK 17.6
4503 
4509  AJA_VIRTUAL bool GetAllWidgetOutputs (NTV2OutputXptIDSet & outOutputs); // New in SDK 17.6
4511 
4512 
4517  AJA_VIRTUAL bool WriteSDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4519  AJA_VIRTUAL bool WriteSDBrightnessAdjustment (const ULWord inNewValue);
4520  AJA_VIRTUAL bool WriteSDContrastAdjustment (const ULWord inNewValue);
4521  AJA_VIRTUAL bool WriteSDSaturationAdjustment (const ULWord inNewValue);
4522  AJA_VIRTUAL bool WriteSDHueAdjustment (const ULWord inNewValue);
4523  AJA_VIRTUAL bool WriteSDCbOffsetAdjustment (const ULWord inNewValue);
4524  AJA_VIRTUAL bool WriteSDCrOffsetAdjustment (const ULWord inNewValue);
4525  AJA_VIRTUAL bool WriteHDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4526  AJA_VIRTUAL bool WriteHDBrightnessAdjustment (const ULWord inNewValue);
4527  AJA_VIRTUAL bool WriteHDContrastAdjustment (const ULWord inNewValue);
4528  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCb (const ULWord inNewValue);
4529  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCr (const ULWord inNewValue);
4530  AJA_VIRTUAL bool WriteHDCbOffsetAdjustment (const ULWord inNewValue);
4531  AJA_VIRTUAL bool WriteHDCrOffsetAdjustment (const ULWord inNewValue);
4532 
4533  AJA_VIRTUAL bool ReadSDProcAmpControlsInitialized (ULWord & outValue);
4534  AJA_VIRTUAL bool ReadSDBrightnessAdjustment (ULWord & outValue);
4535  AJA_VIRTUAL bool ReadSDContrastAdjustment (ULWord & outValue);
4536  AJA_VIRTUAL bool ReadSDSaturationAdjustment (ULWord & outValue);
4537  AJA_VIRTUAL bool ReadSDHueAdjustment (ULWord & outValue);
4538  AJA_VIRTUAL bool ReadSDCbOffsetAdjustment (ULWord & outValue);
4539  AJA_VIRTUAL bool ReadSDCrOffsetAdjustment (ULWord & outValue);
4540  AJA_VIRTUAL bool ReadHDProcAmpControlsInitialized (ULWord & outValue);
4541  AJA_VIRTUAL bool ReadHDBrightnessAdjustment (ULWord & outValue);
4542  AJA_VIRTUAL bool ReadHDContrastAdjustment (ULWord & outValue);
4543  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCb (ULWord & outValue);
4544  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCr (ULWord & outValue);
4545  AJA_VIRTUAL bool ReadHDCbOffsetAdjustment (ULWord & outValue);
4546  AJA_VIRTUAL bool ReadHDCrOffsetAdjustment (ULWord & outValue);
4547 
4548  // FS1 (and other?) ProcAmp methods
4549  AJA_VIRTUAL bool WriteProcAmpC1YAdjustment (const ULWord inNewValue);
4550  AJA_VIRTUAL bool WriteProcAmpC1CBAdjustment (const ULWord inNewValue);
4551  AJA_VIRTUAL bool WriteProcAmpC1CRAdjustment (const ULWord inNewValue);
4552  AJA_VIRTUAL bool WriteProcAmpC2CBAdjustment (const ULWord inNewValue);
4553  AJA_VIRTUAL bool WriteProcAmpC2CRAdjustment (const ULWord inNewValue);
4554  AJA_VIRTUAL bool WriteProcAmpOffsetYAdjustment (const ULWord inNewValue);
4555  AJA_VIRTUAL bool ReadProcAmpC1YAdjustment (ULWord & outValue);
4556  AJA_VIRTUAL bool ReadProcAmpC1CBAdjustment (ULWord & outValue);
4557  AJA_VIRTUAL bool ReadProcAmpC1CRAdjustment (ULWord & outValue);
4558  AJA_VIRTUAL bool ReadProcAmpC2CBAdjustment (ULWord & outValue);
4559  AJA_VIRTUAL bool ReadProcAmpC2CRAdjustment (ULWord & outValue);
4560  AJA_VIRTUAL bool ReadProcAmpOffsetYAdjustment (ULWord & outValue);
4561 
4562  #if !defined(R2_DEPRECATE)
4563  AJA_VIRTUAL bool SetAnalogInputADCMode (const NTV2LSVideoADCMode inValue);
4564  AJA_VIRTUAL bool GetAnalogInputADCMode (NTV2LSVideoADCMode & outValue);
4565  #endif
4566 
4568 
4572 
4579  AJA_VIRTUAL bool GetHDMIInputColor (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4580 
4587  AJA_VIRTUAL bool SetHDMIInputRange (const NTV2HDMIRange inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4588 
4595  AJA_VIRTUAL bool GetHDMIInputRange (NTV2HDMIRange & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4596 
4603  AJA_VIRTUAL bool GetHDMIInputAudioChannels (NTV2HDMIAudioChannels & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4604 
4611  AJA_VIRTUAL bool SetHDMIInColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4612 
4619  AJA_VIRTUAL bool GetHDMIInColorSpace (NTV2HDMIColorSpace & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4620 
4627  AJA_VIRTUAL bool GetHDMIInProtocol (NTV2HDMIProtocol & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4628 
4635  AJA_VIRTUAL bool GetHDMIInIsLocked (bool & outIsLocked, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4636 
4637  AJA_VIRTUAL bool SetHDMIInAudioSampleRateConverterEnable (const bool inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4638  AJA_VIRTUAL bool GetHDMIInAudioSampleRateConverterEnable (bool & outIsEnabled, const NTV2Channel inChannel = NTV2_CHANNEL1);
4639 
4646  AJA_VIRTUAL bool SetHDMIInBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4647 
4654  AJA_VIRTUAL bool GetHDMIInBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4655 
4663  AJA_VIRTUAL bool GetHDMIInAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4664 
4672  AJA_VIRTUAL bool SetHDMIInAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4673 
4674 
4681  AJA_VIRTUAL bool GetHDMIInVideoRange (NTV2HDMIRange & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4682 
4689  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRRegValues & outRegValues, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4690 
4697  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRFloatValues & outFloatValues, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4698 
4705  AJA_VIRTUAL bool GetHDMIInColorimetry (NTV2HDMIColorimetry & outColorimetry, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4706 
4713  AJA_VIRTUAL bool GetHDMIInDolbyVision (bool & outIsDetected, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4714 
4715  AJA_VIRTUAL bool SetHDMIOut3DPresent (const bool inIs3DPresent);
4716  AJA_VIRTUAL bool GetHDMIOut3DPresent (bool & outIs3DPresent);
4717 
4718  AJA_VIRTUAL bool SetHDMIOut3DMode (const NTV2HDMIOut3DMode inValue);
4719  AJA_VIRTUAL bool GetHDMIOut3DMode (NTV2HDMIOut3DMode & outValue);
4720 
4721  AJA_VIRTUAL bool SetHDMIV2TxBypass (const bool inBypass);
4722 
4730  AJA_VIRTUAL bool SetHDMIOutVideoStandard (const NTV2Standard inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4738  AJA_VIRTUAL bool GetHDMIOutVideoStandard (NTV2Standard & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4739 
4747  AJA_VIRTUAL bool SetHDMIOutSampleStructure (const NTV2HDMISampleStructure inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4755  AJA_VIRTUAL bool GetHDMIOutSampleStructure (NTV2HDMISampleStructure & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4756 
4764  AJA_VIRTUAL bool SetHDMIOutVideoFPS (const NTV2FrameRate inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4772  AJA_VIRTUAL bool GetHDMIOutVideoFPS (NTV2FrameRate & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4773 
4781  AJA_VIRTUAL bool SetHDMIOutRange (const NTV2HDMIRange inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4789  AJA_VIRTUAL bool GetHDMIOutRange (NTV2HDMIRange & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4790 
4798  AJA_VIRTUAL bool SetHDMIOutAudioChannels (const NTV2HDMIAudioChannels inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4806  AJA_VIRTUAL bool GetHDMIOutAudioChannels (NTV2HDMIAudioChannels & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4807 
4808  AJA_VIRTUAL bool SetHDMIOutColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4809  AJA_VIRTUAL bool GetHDMIOutColorSpace (NTV2HDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4817  AJA_VIRTUAL bool SetLHIHDMIOutColorSpace (const NTV2LHIHDMIColorSpace inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4825  AJA_VIRTUAL bool GetLHIHDMIOutColorSpace (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4826 
4834  AJA_VIRTUAL bool SetHDMIOutBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4842  AJA_VIRTUAL bool GetHDMIOutBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4843 
4851  AJA_VIRTUAL bool SetHDMIOutProtocol (const NTV2HDMIProtocol inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4859  AJA_VIRTUAL bool GetHDMIOutProtocol (NTV2HDMIProtocol & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4860 
4861  AJA_VIRTUAL bool SetHDMIOutForceConfig (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4862  AJA_VIRTUAL bool GetHDMIOutForceConfig (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4863  AJA_VIRTUAL bool SetHDMIOutDisable (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4864  AJA_VIRTUAL bool GetHDMIOutDisable (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4865 
4873  AJA_VIRTUAL bool SetHDMIOutPrefer420 (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4881  AJA_VIRTUAL bool GetHDMIOutPrefer420 (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4882 
4890  AJA_VIRTUAL bool GetHDMIOutDownstreamBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4891 
4899  AJA_VIRTUAL bool GetHDMIOutDownstreamColorSpace (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4900 
4909  AJA_VIRTUAL bool SetHDMIOutAudioSource2Channel (const NTV2AudioChannelPair inNewValue,
4910  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1,
4911  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4912 
4921  AJA_VIRTUAL bool GetHDMIOutAudioSource2Channel (NTV2AudioChannelPair & outValue,
4922  NTV2AudioSystem & outAudioSystem,
4923  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4924 
4933  AJA_VIRTUAL bool SetHDMIOutAudioSource8Channel (const NTV2Audio8ChannelSelect inNewValue,
4934  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1,
4935  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4936 
4945  AJA_VIRTUAL bool GetHDMIOutAudioSource8Channel (NTV2Audio8ChannelSelect & outValue,
4946  NTV2AudioSystem & outAudioSystem,
4947  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4948 
4957  AJA_VIRTUAL bool GetHDMIOutAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
4958 
4967  AJA_VIRTUAL bool SetHDMIOutAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
4968 
4976  AJA_VIRTUAL bool SetHDMIOutAudioRate (const NTV2AudioRate inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4977 
4985  AJA_VIRTUAL bool GetHDMIOutAudioRate (NTV2AudioRate & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4986 
4994  AJA_VIRTUAL bool SetHDMIOutAudioFormat (const NTV2AudioFormat inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4995 
5003  AJA_VIRTUAL bool GetHDMIOutAudioFormat (NTV2AudioFormat & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5004 
5012  AJA_VIRTUAL bool EnableHDMIOutUserOverride (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5013 
5021  AJA_VIRTUAL bool GetEnableHDMIOutUserOverride (bool & outIsEnabled, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5022 
5030  AJA_VIRTUAL bool EnableHDMIOutCenterCrop (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5031 
5039  AJA_VIRTUAL bool GetEnableHDMIOutCenterCrop (bool & outIsEnabled, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5040 
5048  AJA_VIRTUAL bool SetHDMIOutDecimateMode (const bool inEnable);
5049 
5050  AJA_VIRTUAL bool GetHDMIOutDecimateMode (bool & outIsEnabled);
5051 
5057  AJA_VIRTUAL bool SetHDMIOutTsiIO (const bool inTsiEnable);
5058 
5059  AJA_VIRTUAL bool GetHDMIOutTsiIO (bool & tsiEnabled);
5060 
5066  AJA_VIRTUAL bool SetHDMIOutLevelBMode (const bool inEnable);
5067 
5068  AJA_VIRTUAL bool GetHDMIOutLevelBMode (bool & outIsEnabled);
5069 
5079  AJA_VIRTUAL bool SetHDMIV2Mode (const NTV2HDMIV2Mode inMode);
5080 
5086  AJA_VIRTUAL bool GetHDMIV2Mode (NTV2HDMIV2Mode & outMode);
5087 
5088 
5096  AJA_VIRTUAL bool GetHDMIOutStatus (NTV2HDMIOutputStatus & outStatus, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 16.1
5097 
5098  //protected: SHOULD BE PROTECTED/PRIVATE:
5099  AJA_VIRTUAL bool GetHDMIInputStatus (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
5100  protected:
5101  AJA_VIRTUAL bool GetHDMIInputStatusRegNum (ULWord & outRegNum, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
5102 
5104  public:
5105  AJA_VIRTUAL bool SetLHIVideoDACStandard (const NTV2Standard inValue);
5106  AJA_VIRTUAL bool GetLHIVideoDACStandard (NTV2Standard & outValue);
5107  AJA_VIRTUAL bool SetLHIVideoDACMode (NTV2LHIVideoDACMode value);
5108  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2LHIVideoDACMode & outValue);
5109  AJA_VIRTUAL bool SetLHIVideoDACMode (const NTV2VideoDACMode inValue); // overloaded
5110  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2VideoDACMode & outValue); // overloaded
5111 
5115 
5126  AJA_VIRTUAL bool SetLTCInputEnable (const bool inEnable);
5127 
5138  AJA_VIRTUAL bool GetLTCInputEnable (bool & outIsEnabled);
5139 
5150  AJA_VIRTUAL bool GetLTCInputPresent (bool & outIsPresent, const UWord inLTCInputNdx = 0);
5151 
5161  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, RP188_STRUCT & outRP188Data);
5162 
5172  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, NTV2_RP188 & outRP188Data);
5173 
5184  AJA_VIRTUAL bool GetAnalogLTCInClockChannel (const UWord inLTCInput, NTV2Channel & outChannel);
5185 
5196  AJA_VIRTUAL bool SetAnalogLTCInClockChannel (const UWord inLTCInput, const NTV2Channel inChannel);
5197 
5207  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const RP188_STRUCT & inRP188Data);
5208 
5218  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const NTV2_RP188 & inRP188Data);
5219 
5230  AJA_VIRTUAL bool GetAnalogLTCOutClockChannel (const UWord inLTCOutput, NTV2Channel & outChannel);
5231 
5242  AJA_VIRTUAL bool SetAnalogLTCOutClockChannel (const UWord inLTCOutput, const NTV2Channel inChannel);
5243 
5244 #if !defined(NTV2_DEPRECATE_16_3)
5245  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool SetLTCOnReference(bool val)) {return SetLTCInputEnable(val);}
5246  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool GetLTCOnReference(bool & outVal)) {return GetLTCInputEnable(outVal);}
5247  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool SetLTCEmbeddedOutEnable (const bool inNewValue));
5248  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool GetLTCEmbeddedOutEnable (bool & outValue));
5249 #endif // !defined(NTV2_DEPRECATE_16_3)
5250 
5255  AJA_VIRTUAL bool SetStereoCompressorOutputMode (const NTV2StereoCompressorOutputMode inNewValue);
5257  AJA_VIRTUAL bool GetStereoCompressorOutputMode (NTV2StereoCompressorOutputMode & outValue);
5258  AJA_VIRTUAL bool SetStereoCompressorFlipMode (const ULWord inNewValue);
5259  AJA_VIRTUAL bool GetStereoCompressorFlipMode (ULWord & outValue);
5260  AJA_VIRTUAL bool SetStereoCompressorFlipLeftHorz (const ULWord inNewValue);
5261  AJA_VIRTUAL bool GetStereoCompressorFlipLeftHorz (ULWord & outValue);
5262  AJA_VIRTUAL bool SetStereoCompressorFlipLeftVert (const ULWord inNewValue);
5263  AJA_VIRTUAL bool GetStereoCompressorFlipLeftVert (ULWord & outValue);
5264  AJA_VIRTUAL bool SetStereoCompressorFlipRightHorz (const ULWord inNewValue);
5265  AJA_VIRTUAL bool GetStereoCompressorFlipRightHorz (ULWord & outValue);
5266  AJA_VIRTUAL bool SetStereoCompressorFlipRightVert (const ULWord inNewValue);
5267  AJA_VIRTUAL bool GetStereoCompressorFlipRightVert (ULWord & outValue);
5268  AJA_VIRTUAL bool SetStereoCompressorStandard (const NTV2Standard inNewValue);
5269  AJA_VIRTUAL bool GetStereoCompressorStandard (NTV2Standard & outValue);
5270  AJA_VIRTUAL bool SetStereoCompressorLeftSource (const NTV2OutputCrosspointID inNewValue);
5271  AJA_VIRTUAL bool GetStereoCompressorLeftSource (NTV2OutputCrosspointID & outValue);
5272  AJA_VIRTUAL bool SetStereoCompressorRightSource (const NTV2OutputCrosspointID inNewValue);
5273  AJA_VIRTUAL bool GetStereoCompressorRightSource (NTV2OutputCrosspointID & outValue);
5275 
5279 
5292  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2Channel inChannel, const bool inEnable);
5293 
5306  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2ChannelSet & inSDIConnectors, const bool inEnable);
5307 
5317  AJA_VIRTUAL bool GetSDITransmitEnable (const NTV2Channel inChannel, bool & outEnabled);
5318 
5328  AJA_VIRTUAL bool GetTransmitSDIs (NTV2ChannelSet & outXmitSDIs); // New in SDK 17.0
5330 
5331  AJA_VIRTUAL bool SetSDIOut2Kx1080Enable (const NTV2Channel inChannel, const bool inIsEnabled);
5332  AJA_VIRTUAL bool GetSDIOut2Kx1080Enable (const NTV2Channel inChannel, bool & outIsEnabled);
5333 
5334  AJA_VIRTUAL bool SetSDIOut3GEnable (const NTV2Channel inChannel,const bool inEnable);
5335  AJA_VIRTUAL bool GetSDIOut3GEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5336 
5337  AJA_VIRTUAL bool SetSDIOut3GbEnable (const NTV2Channel inChannel, const bool inEnable);
5338  AJA_VIRTUAL bool GetSDIOut3GbEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5339 
5340  AJA_VIRTUAL bool SetSDIOut6GEnable(const NTV2Channel inChannel, const bool inEnable);
5341  AJA_VIRTUAL bool GetSDIOut6GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5342 
5343  AJA_VIRTUAL bool SetSDIOut12GEnable(const NTV2Channel inChannel, const bool inEnable);
5344  AJA_VIRTUAL bool GetSDIOut12GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5345 
5358  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5359 
5373  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2ChannelSet & inSDIOutputs, const NTV2AudioSystem inAudioSystem, const bool inDS2 = false); // New in SDK 16.2
5374 
5385  AJA_VIRTUAL bool GetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5386 
5398  AJA_VIRTUAL bool SetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5399 
5411  AJA_VIRTUAL bool GetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5412 
5422  AJA_VIRTUAL bool GetSDIOutputAudioEnabled (const NTV2Channel inSDIOutput, bool & outIsEnabled); // New in SDK 17.5
5423 
5434  AJA_VIRTUAL bool SetSDIOutputAudioEnabled (const NTV2Channel inSDIOutput, const bool & inEnable); // New in SDK 17.5
5435 
5436 
5440 
5450  AJA_VIRTUAL bool GetSDIRelayPosition (NTV2RelayState & outValue, const UWord inIndex0);
5451 
5462  AJA_VIRTUAL bool GetSDIRelayManualControl (NTV2RelayState & outValue, const UWord inIndex0);
5463 
5475  AJA_VIRTUAL bool SetSDIRelayManualControl (const NTV2RelayState inValue, const UWord inIndex0);
5476 
5486  AJA_VIRTUAL bool GetSDIWatchdogEnable (bool & outIsEnabled, const UWord inIndex0);
5487 
5501  AJA_VIRTUAL bool SetSDIWatchdogEnable (const bool inEnable, const UWord inIndex0);
5502 
5510  AJA_VIRTUAL bool GetSDIWatchdogStatus (NTV2RelayState & outValue);
5511 
5518  AJA_VIRTUAL bool GetSDIWatchdogTimeout (ULWord & outValue);
5519 
5528  AJA_VIRTUAL bool SetSDIWatchdogTimeout (const ULWord inValue);
5529 
5534  AJA_VIRTUAL bool KickSDIWatchdog (void);
5536 
5540 
5547  AJA_VIRTUAL bool Enable4KDCRGBMode(bool inEnable);
5548 
5549  AJA_VIRTUAL bool GetEnable4KDCRGBMode(bool & outIsEnabled);
5550 
5557  AJA_VIRTUAL bool Enable4KDCYCC444Mode(bool inEnable);
5558 
5559  AJA_VIRTUAL bool GetEnable4KDCYCC444Mode(bool & outIsEnabled);
5560 
5567  AJA_VIRTUAL bool Enable4KDCPSFInMode(bool inEnable);
5568 
5569  AJA_VIRTUAL bool GetEnable4KDCPSFInMode(bool & outIsEnabled);
5570 
5577  AJA_VIRTUAL bool Enable4KPSFOutMode(bool inEnable);
5578 
5579  AJA_VIRTUAL bool GetEnable4KPSFOutMode(bool & outIsEnabled);
5581 
5582 
5591  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const NTV2ChannelSet & inSDIInputs, const bool inEnable);
5592 
5600  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, const bool inEnable);
5601 
5608  AJA_VIRTUAL bool GetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, bool & outIsEnabled);
5609 
5617  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, const bool inEnable);
5618 
5627  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5628 
5635  AJA_VIRTUAL bool GetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5636 
5643  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, const bool inEnable);
5644 
5653  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5654 
5661  AJA_VIRTUAL bool GetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5662 
5663 
5667 
5672  AJA_VIRTUAL bool GetSDITRSError (const NTV2Channel inChannel);
5673 
5679  AJA_VIRTUAL bool GetSDILock (const NTV2Channel inChannel);
5680 
5686  AJA_VIRTUAL ULWord GetSDIUnlockCount (const NTV2Channel inChannel);
5687 
5693  AJA_VIRTUAL ULWord GetCRCErrorCountA (const NTV2Channel inChannel);
5694 
5700  AJA_VIRTUAL ULWord GetCRCErrorCountB (const NTV2Channel inChannel);
5702 
5715  AJA_VIRTUAL NTV2_WILL_BE_DEPRECATED(bool SetMultiFormatMode (const bool inEnable));
5716 
5728  AJA_VIRTUAL NTV2_WILL_BE_DEPRECATED(bool GetMultiFormatMode (bool & outIsEnabled));
5729 
5730 
5731 public:
5735 
5747  AJA_VIRTUAL bool SetRS422Parity (const NTV2Channel inSerialPort, const NTV2_RS422_PARITY inParity);
5748 
5759  AJA_VIRTUAL bool GetRS422Parity (const NTV2Channel inSerialPort, NTV2_RS422_PARITY & outParity);
5760 
5773  AJA_VIRTUAL bool SetRS422BaudRate (const NTV2Channel inSerialPort, const NTV2_RS422_BAUD_RATE inBaudRate);
5774 
5785  AJA_VIRTUAL bool GetRS422BaudRate (const NTV2Channel inSerialPort, NTV2_RS422_BAUD_RATE & outBaudRate);
5787 
5791 
5805  AJA_VIRTUAL bool AncSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size); // New in SDK 16.0
5806 
5807 
5821  AJA_VIRTUAL bool AncInsertInit (const UWord inSDIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5822  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5823 
5836  AJA_VIRTUAL bool AncInsertSetComponents (const UWord inSDIOutput,
5837  const bool inVancY, const bool inVancC,
5838  const bool inHancY, const bool inHancC); // New in SDK 16.0
5839 
5849  AJA_VIRTUAL bool AncInsertSetEnable (const UWord inSDIOutput, const bool inIsEnabled); // New in SDK 15.0
5850 
5858  AJA_VIRTUAL bool AncInsertIsEnabled (const UWord inSDIOutput, bool & outIsEnabled); // New in SDK 15.0
5859 
5876  AJA_VIRTUAL bool AncInsertSetReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
5877  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5878  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5879 
5896  AJA_VIRTUAL bool AncInsertSetField2ReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
5897  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5898  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5899 
5908  AJA_VIRTUAL bool AncInsertSetIPParams (const UWord inSDIOutput, const UWord ancChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 15.2
5909 
5917  AJA_VIRTUAL bool AncInsertGetReadInfo (const UWord inSDIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK v16.2
5918 
5919 
5935  AJA_VIRTUAL bool AncExtractInit (const UWord inSDIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5936  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5937 
5950  AJA_VIRTUAL bool AncExtractSetComponents (const UWord inSDIInput,
5951  const bool inVancY, const bool inVancC,
5952  const bool inHancY, const bool inHancC); // New in SDK 16.0
5953 
5964  AJA_VIRTUAL bool AncExtractSetEnable (const UWord inSDIInput, const bool inIsEnabled); // New in SDK 15.0
5965 
5974  AJA_VIRTUAL bool AncExtractIsEnabled (const UWord inSDIInput, bool & outIsEnabled); // New in SDK 15.0
5975 
5992  AJA_VIRTUAL bool AncExtractSetWriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
5993  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5994  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5995 
6012  AJA_VIRTUAL bool AncExtractSetField2WriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
6013  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6014  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
6015 
6027  AJA_VIRTUAL bool AncExtractGetWriteInfo (const UWord inSDIInput,
6028  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
6029  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK v16.2
6030 
6040  AJA_VIRTUAL bool AncExtractGetFilterDIDs (const UWord inSDIInput, NTV2DIDSet & outDIDs); // New in SDK 15.0
6041 
6052  AJA_VIRTUAL bool AncExtractSetFilterDIDs (const UWord inSDIInput, const NTV2DIDSet & inDIDs); // New in SDK 15.0
6053 
6061  AJA_VIRTUAL bool AncExtractGetField1Size (const UWord inSDIInput, ULWord & outF1Size); // New in SDK 16.0
6062 
6070  AJA_VIRTUAL bool AncExtractGetField2Size (const UWord inSDIInput, ULWord & outF2Size); // New in SDK 16.0
6071 
6085  AJA_VIRTUAL bool AncExtractGetBufferOverrun (const UWord inSDIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 15.0
6086 
6094  AJA_VIRTUAL bool AncExtractIsProgressive (const UWord inSDIInput, bool & outIsProgressive); // New in SDK 17.1
6095 
6100  static UWord AncExtractGetMaxNumFilterDIDs (void); // New in SDK 15.0
6101 
6109  static NTV2DIDSet AncExtractGetDefaultDIDs (const bool inHDAudio = true); // New in SDK 13.0
6111 
6115 
6125  AJA_VIRTUAL bool AuxSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size) // New in SDK 17.1
6126  {return IsSupported(kDeviceCanDoHDMIAuxCapture) && AncSetFrameBufferSize(inF1Size,inF2Size);}
6127 
6128 
6141  AJA_VIRTUAL bool AuxInsertInit (const UWord inHDMIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6142  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
6143 
6155  AJA_VIRTUAL bool AuxInsertSetComponents (const UWord inHDMIOutput,
6156  const bool inVauxY, const bool inVauxC,
6157  const bool inHauxY, const bool inHauxC); // New in SDK 17.1
6158 
6167  AJA_VIRTUAL bool AuxInsertSetEnable (const UWord inHDMIOutput, const bool inIsEnabled); // New in SDK 17.1
6168 
6175  AJA_VIRTUAL bool AuxInsertIsEnabled (const UWord inHDMIOutput, bool & outIsEnabled); // New in SDK 17.1
6176 
6192  AJA_VIRTUAL bool AuxInsertSetReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
6193  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6194  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6195 
6211  AJA_VIRTUAL bool AuxInsertSetField2ReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
6212  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6213  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6214 
6223  AJA_VIRTUAL bool AuxInsertSetIPParams (const UWord inHDMIOutput, const UWord auxChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 17.1
6224 
6232  AJA_VIRTUAL bool AuxInsertGetReadInfo (const UWord inHDMIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK 17.1
6233 
6234 
6249  AJA_VIRTUAL bool AuxExtractInit (const UWord inHDMIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6250  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
6260  AJA_VIRTUAL bool AuxExtractSetEnable (const UWord inHDMIInput, const bool inIsEnabled); // New in SDK 17.1
6261 
6269  AJA_VIRTUAL bool AuxExtractIsEnabled (const UWord inHDMIInput, bool & outIsEnabled); // New in SDK 17.1
6270 
6286  AJA_VIRTUAL bool AuxExtractSetWriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
6287  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6288  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6289 
6305  AJA_VIRTUAL bool AuxExtractSetField2WriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
6306  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6307  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6308 
6319  AJA_VIRTUAL bool AuxExtractGetWriteInfo (const UWord inHDMIInput,
6320  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
6321  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK 17.1
6322 
6330  AJA_VIRTUAL bool AuxExtractGetField1Size (const UWord inHDMIInput, ULWord & outF1Size); // New in SDK 17.1
6331 
6339  AJA_VIRTUAL bool AuxExtractGetField2Size (const UWord inHDMIInput, ULWord & outF2Size); // New in SDK 17.1
6340 
6349  AJA_VIRTUAL bool AuxExtractGetPacketFilters (const UWord inHDMIInput, NTV2DIDSet & outDIDs); // New in SDK 17.1
6350 
6360  AJA_VIRTUAL bool AuxExtractSetPacketFilters (const UWord inHDMIInput, const NTV2DIDSet & inDIDs); // New in SDK 17.1
6361 
6369  AJA_VIRTUAL bool AuxExtractSetFilterInclusionMode (const UWord inHDMIInput, const bool inEnable); // New in SDK 17.1
6370 
6378  AJA_VIRTUAL bool AuxExtractGetFilterInclusionMode (const UWord inHDMIInput, bool & outEnabled); // New in SDK 17.1
6379 
6392  AJA_VIRTUAL bool AuxExtractGetBufferOverrun (const UWord inHDMIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 17.1
6393 
6400  AJA_VIRTUAL bool AuxExtractIsProgressive (const UWord inHDMIInput, bool & outIsProgressive); // New in SDK 17.1
6401 
6406  static UWord AuxExtractGetMaxNumPacketFilters (void); // New in SDK 17.1
6407 
6412  static NTV2DIDSet AuxExtractGetDefaultPacketFilters (void); // New in SDK 17.1
6414 
6415 
6419  AJA_VIRTUAL bool AcquireMailBoxLock (void);
6421  AJA_VIRTUAL bool ReleaseMailBoxLock (void);
6422  AJA_VIRTUAL bool AbortMailBoxLock (void);
6424 
6428 
6435  AJA_VIRTUAL bool GetDieTemperature (double & outTemp, const NTV2DieTempScale inTempScale = NTV2DieTempScale_Celsius);
6436 
6442  AJA_VIRTUAL bool GetDieVoltage (double & outVoltage);
6444 
6445 public:
6449  AJA_VIRTUAL inline CNTV2DriverInterface & driverInterface (void) {return *this;} // New in SDK 17.1
6450 
6451  AJA_VIRTUAL std::string GetFPGAVersionString (const NTV2XilinxFPGA inFPGA = eFPGAVideoProc);
6452  AJA_VIRTUAL Word GetPCIFPGAVersion (void); // From CNTV2Status
6453  AJA_VIRTUAL std::string GetPCIFPGAVersionString (void);
6454 
6472  AJA_VIRTUAL bool GetInstalledBitfileInfo (ULWord & outNumBytes, std::string & outDateStr, std::string & outTimeStr);
6473 
6479  AJA_VIRTUAL std::string GetBitfileInfoString (const BITFILE_INFO_STRUCT & inBitFileInfo);
6480 
6490  AJA_VIRTUAL bool IsFailSafeBitfileLoaded (bool & outIsFailSafe);
6491 
6499  AJA_VIRTUAL bool CanWarmBootFPGA (bool & outCanWarmBoot);
6500 
6501  AJA_VIRTUAL bool IsDynamicDevice (void);
6502  AJA_VIRTUAL bool IsDynamicFirmwareLoaded(void);
6503  AJA_VIRTUAL NTV2DeviceID GetBaseDeviceID();
6504  AJA_VIRTUAL NTV2DeviceIDList GetDynamicDeviceList (void);
6505  AJA_VIRTUAL NTV2DeviceIDSet GetDynamicDeviceIDs (void);
6506 
6511  AJA_VIRTUAL bool CanLoadDynamicDevice (const NTV2DeviceID inDeviceID);
6512 
6521  AJA_VIRTUAL bool LoadDynamicDevice (const NTV2DeviceID inDeviceID);
6522 
6528  AJA_VIRTUAL bool AddDynamicBitfile (const std::string & inBitfilePath);
6529 
6536  AJA_VIRTUAL bool AddDynamicDirectory (const std::string & inDirectory);
6537 
6543  static std::string SerialNum64ToString (const uint64_t inSerialNumber);
6544 
6545  typedef enum
6546  {
6550  NUM_COLORS
6551  } ColorCorrectionColor; // From CNTV2ColorCorrection
6552 
6553 protected:
6555 
6556 public:
6557 #if !defined(NTV2_DEPRECATE_17_6)
6558  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcGetDeviceInfo (HevcDeviceInfo* pInfo)) {(void)pInfo; return false;}
6559  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcWriteRegister (ULWord addr, ULWord val, ULWord mask = 0xffffffff, ULWord shift = 0)) {(void)addr; (void)val; (void)mask; (void)shift; return false;}
6560  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcReadRegister (ULWord addr, ULWord* pVal, ULWord mask = 0xffffffff, ULWord shift = 0)) {(void)addr; (void)pVal; (void)mask; (void)shift; return false;}
6561  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcSendCommand (HevcDeviceCommand* pCmd)) {(void)pCmd; return false;}
6562  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcVideoTransfer (HevcDeviceTransfer* pXfer)) {(void)pXfer; return false;}
6563  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcGetStatus (HevcDeviceStatus* pStat)) {(void)pStat; return false;}
6564  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcDebugInfo (HevcDeviceDebug* pDbg)) {(void)pDbg; return false;}
6565 #endif//defined(NTV2_DEPRECATE_17_6)
6566 
6570 
6576  AJA_VIRTUAL bool EnableHDMIHDR (const bool inEnableHDMIHDR, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6577  AJA_VIRTUAL bool GetHDMIHDREnabled (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6578 
6587  AJA_VIRTUAL bool EnableHDMIHDRDolbyVision (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 13.0
6588  AJA_VIRTUAL bool GetHDMIHDRDolbyVisionEnabled (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6589 
6590 
6596  AJA_VIRTUAL bool SetHDMIHDRConstantLuminance (const bool inEnableConstantLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6597  AJA_VIRTUAL bool GetHDMIHDRConstantLuminance (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6598 
6604  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryX (const uint16_t inGreenPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6610  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryX (uint16_t & outGreenPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6611 
6617  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryY (const uint16_t inGreenPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6623  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryY (uint16_t & outGreenPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6624 
6630  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryX (const uint16_t inBluePrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6636  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryX (uint16_t & outBluePrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6637 
6643  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryY (const uint16_t inBluePrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6649  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryY (uint16_t & outBluePrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6650 
6656  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryX (const uint16_t inRedPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6662  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryX (uint16_t & outRedPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6663 
6669  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryY (const uint16_t inRedPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6675  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryY (uint16_t & outRedPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6676 
6682  AJA_VIRTUAL bool SetHDMIHDRWhitePointX (const uint16_t inWhitePointX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6688  AJA_VIRTUAL bool GetHDMIHDRWhitePointX (uint16_t & outWhitePointX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6689 
6695  AJA_VIRTUAL bool SetHDMIHDRWhitePointY (const uint16_t inWhitePointY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6701  AJA_VIRTUAL bool GetHDMIHDRWhitePointY (uint16_t & outWhitePointY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6702 
6708  AJA_VIRTUAL bool SetHDMIHDRMaxMasteringLuminance (const uint16_t inMaxMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6714  AJA_VIRTUAL bool GetHDMIHDRMaxMasteringLuminance (uint16_t & outMaxMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6715 
6721  AJA_VIRTUAL bool SetHDMIHDRMinMasteringLuminance (const uint16_t inMinMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6727  AJA_VIRTUAL bool GetHDMIHDRMinMasteringLuminance (uint16_t & outMinMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6728 
6734  AJA_VIRTUAL bool SetHDMIHDRMaxContentLightLevel (const uint16_t inMaxContentLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6740  AJA_VIRTUAL bool GetHDMIHDRMaxContentLightLevel (uint16_t & outMaxContentLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6741 
6747  AJA_VIRTUAL bool SetHDMIHDRMaxFrameAverageLightLevel (const uint16_t inMaxFrameAverageLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6753  AJA_VIRTUAL bool GetHDMIHDRMaxFrameAverageLightLevel (uint16_t & outMaxFrameAverageLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6754 
6755 
6756  AJA_VIRTUAL bool SetHDMIHDRElectroOpticalTransferFunction (const uint8_t inEOTFByte, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6757  AJA_VIRTUAL bool GetHDMIHDRElectroOpticalTransferFunction (uint8_t & outEOTFByte, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6758  AJA_VIRTUAL bool SetHDMIHDRStaticMetadataDescriptorID (const uint8_t inSMDId, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6759  AJA_VIRTUAL bool GetHDMIHDRStaticMetadataDescriptorID (uint8_t & outSMDId, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6760 
6761  AJA_VIRTUAL bool SetHDRData (const HDRFloatValues & inFloatValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6762  AJA_VIRTUAL bool SetHDRData (const HDRRegValues & inRegisterValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6763  AJA_VIRTUAL bool GetHDRData (HDRFloatValues & outFloatValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6764  AJA_VIRTUAL bool GetHDRData (HDRRegValues & outRegisterValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6765  AJA_VIRTUAL bool SetHDMIHDRBT2020 (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6766  AJA_VIRTUAL bool SetHDMIHDRDCIP3 (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6767 
6768  // default channel VPID parameters (frame stores)
6769  AJA_VIRTUAL bool SetVPIDTransferCharacteristics (const NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel); // New in SDK 15.2
6770  AJA_VIRTUAL bool GetVPIDTransferCharacteristics (NTV2VPIDTransferCharacteristics & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6771  AJA_VIRTUAL bool SetVPIDColorimetry (const NTV2VPIDColorimetry inValue, const NTV2Channel inChannel); // New in SDK 15.2
6772  AJA_VIRTUAL bool GetVPIDColorimetry (NTV2VPIDColorimetry & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6773  AJA_VIRTUAL bool SetVPIDLuminance (const NTV2VPIDLuminance inValue, const NTV2Channel inChannel); // New in SDK 15.2
6774  AJA_VIRTUAL bool GetVPIDLuminance (NTV2VPIDLuminance & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6775  AJA_VIRTUAL bool SetVPIDRGBRange (const NTV2VPIDRGBRange inValue, const NTV2Channel inChannel); // New in SDK 16.0
6776  AJA_VIRTUAL bool GetVPIDRGBRange (NTV2VPIDRGBRange & outValue, const NTV2Channel inChannel); // New in SDK 16.0
6777 
6778  // default channel key signal
6779  AJA_VIRTUAL bool SetKeySignal(bool inValue, const NTV2Channel inChannel);
6780  AJA_VIRTUAL bool GetKeySignal(bool & outValue, const NTV2Channel inChannel);
6781 
6782  // sdi output VPID parameter overrides
6783  AJA_VIRTUAL bool SetSDIOutVPIDTransferCharacteristics(bool enable, NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel);
6784  AJA_VIRTUAL bool GetSDIOutVPIDTransferCharacteristics(bool & enable, NTV2VPIDTransferCharacteristics & outValue, const NTV2Channel inChannel);
6785  AJA_VIRTUAL bool SetSDIOutVPIDColorimetry(bool enable, NTV2VPIDColorimetry inValue, const NTV2Channel inChannel);
6786  AJA_VIRTUAL bool GetSDIOutVPIDColorimetry(bool & enable, NTV2VPIDColorimetry & outValue, const NTV2Channel inChannel);
6787  AJA_VIRTUAL bool SetSDIOutVPIDLuminance(bool enable, NTV2VPIDLuminance inValue, const NTV2Channel inChannel);
6788  AJA_VIRTUAL bool GetSDIOutVPIDLuminance(bool & enable, NTV2VPIDLuminance & outValue, const NTV2Channel inChannel);
6789  AJA_VIRTUAL bool SetSDIOutVPIDRGBRange(bool enable, NTV2VPIDRGBRange inValue, const NTV2Channel inChannel);
6790  AJA_VIRTUAL bool GetSDIOutVPIDRGBRange(bool & enable, NTV2VPIDRGBRange & outValue, const NTV2Channel inChannel);
6791 
6792  // sdi output key signal override
6793  AJA_VIRTUAL bool SetSDIOutKeySignal(bool enable, bool inValue, const NTV2Channel inChannel);
6794  AJA_VIRTUAL bool GetSDIOutKeySignal(bool & enable, bool & outValue, const NTV2Channel inChannel);
6795 
6796  AJA_VIRTUAL bool Set3DLUTTableLocation (const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6797  AJA_VIRTUAL bool Load3DLUTTable (void); // New in SDK 16.0
6798  AJA_VIRTUAL bool Set1DLUTTableLocation (const NTV2Channel inChannel, const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6799  AJA_VIRTUAL bool Load1DLUTTable (const NTV2Channel inChannel); // New in SDK 16.0
6800 
6801  // MultiViewer/MultiRasterizer
6802  AJA_VIRTUAL inline bool HasMultiRasterWidget (void) {return IsSupported(kDeviceCanDoHDMIMultiView);} // New in SDK 16.1
6803  AJA_VIRTUAL bool SetMultiRasterBypassEnable (const bool inEnable); // New in SDK 16.1
6804  AJA_VIRTUAL bool GetMultiRasterBypassEnable (bool & outEnabled); // New in SDK 16.1
6805  AJA_VIRTUAL bool IsMultiRasterWidgetChannel (const NTV2Channel inChannel); // New in SDK 16.2
6807 
6808 #if !defined(NTV2_DEPRECATE_17_5)
6809  AJA_VIRTUAL inline bool NTV2_DEPRECATED_17_5(IsBreakoutBoardConnected (void)) {return IsSupported(kDeviceHasBreakoutBoard);}
6810 #endif // NTV2_DEPRECATE_17_5
6811 
6812 #if !defined(NTV2_DEPRECATE_16_1)
6813  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool SetAudioOutputMonitorSource (const NTV2AudioMonitorSelect inChannelPair, const NTV2Channel inAudioSystem = NTV2_CHANNEL1)) {return SetAudioOutputMonitorSource(inChannelPair, NTV2AudioSystem(inAudioSystem));}
6814  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool GetAudioOutputMonitorSource (NTV2AudioMonitorSelect & chp, NTV2Channel & ch)) {NTV2AudioSystem sys; if (GetAudioOutputMonitorSource(chp, sys)) {ch = NTV2Channel(sys); return true;} return false;}
6815 #endif // NTV2_DEPRECATE_16_1
6816 
6817 protected:
6818  AJA_VIRTUAL ULWord GetSerialNumberLow (void); // From CNTV2Status
6819  AJA_VIRTUAL ULWord GetSerialNumberHigh (void); // From CNTV2Status
6820  AJA_VIRTUAL inline bool IS_CHANNEL_VALID (const NTV2Channel inChannel) const {return !IS_CHANNEL_INVALID(inChannel);} // New in SDK 16.2
6821  AJA_VIRTUAL bool IS_CHANNEL_INVALID (const NTV2Channel inChannel) const;
6822  AJA_VIRTUAL bool IS_OUTPUT_SPIGOT_INVALID (const UWord inOutputSpigot);
6823  AJA_VIRTUAL bool IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot);
6824  AJA_VIRTUAL bool IS_HDMI_INPUT_SPIGOT_INVALID (const UWord inInputHDMIPort);
6825  AJA_VIRTUAL bool SetWarmBootFirmwareReload(bool enable);
6826 
6827  AJA_VIRTUAL bool GetHDMIOutControlReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6828  AJA_VIRTUAL bool GetHDMIOutInputStatusRegNum (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6829  AJA_VIRTUAL bool GetHDMIOutInputControlRegNum (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6830  AJA_VIRTUAL bool GetHDMIOutStatusReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6831  AJA_VIRTUAL bool GetHDMIOutHDRGreenPrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6832  AJA_VIRTUAL bool GetHDMIOutHDRBluePrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6833  AJA_VIRTUAL bool GetHDMIOutHDRRedPrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6834  AJA_VIRTUAL bool GetHDMIOutHDRWhitePointReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6835  AJA_VIRTUAL bool GetHDMIOutHDRMasterLuminanceReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6836  AJA_VIRTUAL bool GetHDMIOutHDRLightLevelReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6837  AJA_VIRTUAL bool GetHDMIOutHDRControlReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6838 
6839  // Seamless Anc Playout & Capture
6840  // For AutoCirculate Playout
6841  AJA_VIRTUAL bool S2110DeviceAncToXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6842  // For Non-AutoCirculate Playout
6843  AJA_VIRTUAL bool S2110DeviceAncToBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6844  // For AutoCirculate Capture
6845  AJA_VIRTUAL bool S2110DeviceAncFromXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6846  // For Non-AutoCirculate Capture
6847  AJA_VIRTUAL bool S2110DeviceAncFromBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6848  AJA_VIRTUAL bool WriteSDIInVPID (const NTV2Channel inChannel, const ULWord inValA, const ULWord inValB);
6849 
6850 private:
6851  // frame buffer sizing helpers
6852  AJA_VIRTUAL bool GetLargestFrameBufferFormatInUse(NTV2FrameBufferFormat & outFBF);
6853  AJA_VIRTUAL bool GetFrameInfo(const NTV2Channel inChannel, NTV2FrameGeometry & outGeometry, NTV2FrameBufferFormat & outFBF);
6854  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry currentGeometry, NTV2FrameGeometry newGeometry,
6855  NTV2FrameBufferFormat format);
6856  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry geometry,
6857  NTV2FrameBufferFormat currentFormat, NTV2FrameBufferFormat newFormat);
6858 #if !defined(NTV2_DEPRECATE_17_2)
6859  AJA_VIRTUAL NTV2_DEPRECATED_17_2(bool GetFBSizeAndCountFromHW(ULWord & outSize, ULWord & outCount));
6860 #endif
6861 
6862  AJA_VIRTUAL bool IsMultiFormatActive (void);
6863  AJA_VIRTUAL bool CopyVideoFormat(const NTV2Channel inSrc, const NTV2Channel inFirst, const NTV2Channel inLast);
6864  class DeviceCapabilities mDevCap;
6865  friend class CNTV2DeviceScanner; // Device scanner needs access to my private methods & vars
6866 }; // CNTV2Card
6867 
6868 
6870 #if !defined(NTV2_DEPRECATE_16_2)
6877 #endif // !defined(NTV2_DEPRECATE_16_2)
6878 
6879 #define SetTablesToHardware LoadLUTTables
6880 #define GetTablesFromHardware GetLUTTables
6881 
6883 
6884 
6909 {
6910  public:
6914  explicit SDRAMAuditor ()
6915  : mDeviceID (DEVICE_ID_INVALID),
6916  mFrameTags (),
6917  m8MB (0x00800000),
6918  mNumFrames (0),
6919  mIntrinsicSize (0)
6920  {
6921  }
6922 
6927  explicit SDRAMAuditor (CNTV2Card & inDevice)
6928  : mDeviceID (DEVICE_ID_INVALID),
6929  mFrameTags (),
6930  m8MB (0x00800000),
6931  mNumFrames (0),
6932  mIntrinsicSize (0)
6933  {
6934  AssessDevice(inDevice);
6935  }
6936 
6946  bool AssessDevice (CNTV2Card & inDevice, const bool inIgnoreStoppedAudioBuffers = false);
6947 
6957  bool GetRegions (ULWordSequence & outFree, ULWordSequence & outUsed, ULWordSequence & outBad) const;
6958 
6963  inline bool GetFreeRegions (ULWordSequence & outBlks) const
6964  {
6965  ULWordSequence used, bad;
6966  return GetRegions (outBlks, used, bad);
6967  }
6968 
6973  inline bool GetBadRegions (ULWordSequence & outBlks) const
6974  {
6975  ULWordSequence used, free;
6976  return GetRegions (free, used, outBlks);
6977  }
6978 
6983  inline bool GetUsedRegions (ULWordSequence & outBlks) const
6984  {
6985  ULWordSequence bad, free;
6986  return GetRegions (free, outBlks, bad);
6987  }
6988 
6995  bool GetTagsForFrameIndex (const UWord inIndex, NTV2StringSet & outTags) const;
6996 
6997  bool HasFrameIndex (const UWord inIndex) const {return mFrameTags.find(inIndex) != mFrameTags.end();}
6998 
6999  size_t GetTagCount (const UWord inIndex) const;
7000 
7001  inline bool HasTag (const UWord inIndex) const {return GetTagCount(inIndex) > 0;}
7002  inline bool HasConflicts (const UWord inIndex) const {return GetTagCount(inIndex) > 1;}
7003  inline ULWord GetIntrinsicFrameByteCount (void) const {return mIntrinsicSize;}
7004 
7015  bool TranslateRegions (ULWordSequence & outRgns, const ULWordSequence & inRgns, const bool inIsQuad, const bool inIsQuadQuad) const;
7016 
7022  std::ostream & RawDump (std::ostream & oss) const;
7023 
7029  std::ostream & DumpBlocks (std::ostream & oss) const;
7030 
7031  // Static/Class Methods
7032  public:
7036  static ULWordSet CoalesceRegions (const ULWordSequence & inRgn1, const ULWordSequence & inRgn2, const ULWordSequence & inRgn3);
7037 
7038  protected:
7039  bool TagAudioBuffers (CNTV2Card & inDevice, const bool inMarkStoppedAudioBuffersFree);
7040  bool TagVideoFrames (CNTV2Card & inDevice);
7041  bool TagMemoryBlock (const ULWord inStartAddr, const ULWord inByteLength, const std::string & inTag);
7042  bool TagMemoryBlock (const uint64_t inStartAddr, const uint64_t inByteLength, const std::string & inTag)
7043  {
7044  return TagMemoryBlock (ULWord(inStartAddr), ULWord(inByteLength), inTag);
7045  }
7046 
7047  private:
7048  typedef std::pair<UWord, NTV2StringSet> FrameTag;
7049  typedef std::map<UWord, NTV2StringSet> FrameTags;
7050  typedef FrameTags::const_iterator FrameTagsConstIter;
7051 
7052  NTV2DeviceID mDeviceID;
7053  FrameTags mFrameTags;
7054  const ULWord m8MB;
7055  UWord mNumFrames;
7056  ULWord mIntrinsicSize;
7057 }; // SDRAMAuditor
7058 
7059 #endif // NTV2CARD_H
SDRAMAuditor()
My default constructor. I am not ready for use until my SDRAMAuditor::Assess method has been called...
Definition: ntv2card.h:6914
Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.
#define NTV2_DEPRECATED_18_0(__f__)
Definition: ajatypes.h:573
size_t GetTagCount(const UWord inIndex) const
Definition: ntv2card.cpp:754
NTV2VideoDACMode
Definition: ntv2enums.h:2142
NTV2LutBitDepth
This specifies the LUT bit depth.
Definition: ntv2enums.h:3583
virtual bool IsSupported(const NTV2BoolParamID inParamID)
NTV2AudioSystem
Used to identify an Audio System on an NTV2 device. See Audio System Operation for more information...
Definition: ntv2enums.h:3895
bool GetBadRegions(ULWordSequence &outBlks) const
Answers with the list of colliding and illegal memory regions.
Definition: ntv2card.h:6973
#define NTV2_DEPRECATED_17_2(__f__)
Definition: ajatypes.h:558
static NTV2Buffer NULL_POINTER
Used for default empty NTV2Buffer parameters – do not modify.
Definition: ntv2card.h:6554
NTV2Crosspoint
Logically, these are an NTV2Channel combined with an NTV2Mode.
Definition: ntv2enums.h:1700
#define NTV2VANCModeFromBools(_tall_, _taller_)
Definition: ntv2enums.h:3810
std::vector< double > NTV2DoubleArray
An array of double-precision floating-point values.
NTV2AudioBufferSize
Represents the size of the audio buffer used by a device audio system for storing captured samples or...
Definition: ntv2enums.h:1914
NTV2HDMIColorSpace
Indicates or specifies HDMI Color Space.
Definition: ntv2enums.h:3605
SDRAMAuditor(CNTV2Card &inDevice)
Constructs me and automatically assesses the given device.
Definition: ntv2card.h:6927
This class is used to enumerate AJA devices that are attached and known to the local host computer...
Declares CNTV2SignalRouter class.
I interrogate and control an AJA video/audio capture/playout device.
Definition: ntv2card.h:28
NTV2FieldID
These values are used to identify fields for interlaced video. See Field/Frame Interrupts and CNTV2Ca...
Definition: ntv2enums.h:1840
NTV2FrameBufferFormat
Identifies a particular video frame buffer pixel format. See Device Frame Buffer Formats for details...
Definition: ntv2enums.h:219
#define NTV2_DEPRECATED_16_3(__f__)
Definition: ajatypes.h:543
defined(NTV2_DEPRECATE_17_6)
NTV2TaskMode
Describes the task mode state. See also: Sharing AJA Devices With Other Applications.
virtual bool ReadAudioLastIn(ULWord &outValue, const NTV2Channel inChannel)
Definition: ntv2card.h:2203
bool AssessDevice(CNTV2Card &inDevice, const bool inIgnoreStoppedAudioBuffers=(0))
Assesses the given device.
Definition: ntv2card.cpp:610
NTV2_RP188Mode
Definition: ntv2enums.h:2095
NTV2InputVideoSelect
Definition: ntv2enums.h:2296
bool HasFrameIndex(const UWord inIndex) const
Definition: ntv2card.h:6997
enum _NTV2VideoFormat NTV2VideoFormat
Identifies a particular video format.
Audits an NTV2 device&#39;s SDRAM utilization, and can report contiguous regions of SDRAM, whether unused/free, those being read/written by AutoCirculate, those being read/written by non-AutoCirculating FrameStores, those that are in conflict (AutoCirculate, FrameStore and/or Audio collisions), plus invalid/out-of-bounds regions being accessed.
Definition: ntv2card.h:6908
enum NTV2VPIDLuminance NTV2HDRLuminance
bool TranslateRegions(ULWordSequence &outRgns, const ULWordSequence &inRgns, const bool inIsQuad, const bool inIsQuadQuad) const
Translates an 8MB-chunked list of regions into another list of regions with frame indexes and sizes e...
Definition: ntv2card.cpp:762
enum NTV2VideoFrameBufferOrientation NTV2FBOrientation
NTV2AnalogAudioIO
Definition: ntv2enums.h:2232
enum NTV2VPIDColorimetry NTV2HDRColorimetry
NTV2VPIDLuminance
Definition: ntv2enums.h:4262
virtual bool Read3GInput5678StatusRegister(ULWord *pVal)
Definition: ntv2card.h:2517
#define NTV2_DEPRECATED_17_6(__f__)
Definition: ajatypes.h:568
std::map< ULWord, ULWord > NTV2RegisterValueMap
A mapping of distinct NTV2RegisterNumbers to their corresponding ULWord values.
NTV2InterruptMask
Definition: ntv2enums.h:1527
virtual bool ReadGlobalControl(ULWord *pOutVal)
Definition: ntv2card.h:2408
int32_t LWord
Definition: ajatypes.h:222
std::bitset< 16 > NTV2AudioChannelsMuted16
Per-audio-channel mute state for up to 16 audio channels.
NTV2EmbeddedAudioClock
This enum value determines/states the device audio clock reference source. It was important to set th...
Definition: ntv2enums.h:1990
if(!(riid==IID_IUnknown) &&!(riid==IID_IClassFactory))
Definition: dllentry.cpp:196
NTV2HDMIAudioChannels
Indicates or specifies the HDMI audio channel count.
Definition: ntv2enums.h:3667
NTV2RelayState
This enumerated data type identifies the two possible states of the bypass relays. See CNTV2Card::GetSDIRelayPosition, CNTV2Card::GetSDIRelayManualControl, CNTV2Card::GetSDIWatchdogStatus, etc.
Definition: ntv2enums.h:3936
NTV2LutType
This specifies what function(s) are currently loaded into the LUTs.
Definition: ntv2enums.h:3564
virtual ULWord GetFrameBufferSize(void) const
std::ostream & RawDump(std::ostream &oss) const
Dumps a human-readable list of regions into the given stream.
Definition: ntv2card.cpp:630
NTV2HDMIRange
Indicates or specifies the HDMI RGB range.
Definition: ntv2enums.h:3635
uint32_t ULWord
Definition: ajatypes.h:223
NTV2AudioFormat
Definition: ntv2enums.h:1951
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They&#39;re also commonly use...
Definition: ntv2enums.h:1357
This class is a collection of widget input-to-output connections that can be applied all-at-once to a...
virtual class DeviceCapabilities & features(void)
Definition: ntv2card.h:148
std::set< NTV2AudioChannelPair > NTV2AudioChannelPairs
A set of distinct NTV2AudioChannelPair values.
NTV2LHIVideoDACMode
Definition: ntv2enums.h:2173
virtual bool ReadRegister(const ULWord inRegNum, ULWord &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
Reads all or part of the 32-bit contents of a specific register (real or virtual) on the AJA device...
This struct replaces the old RP188_STRUCT.
bool HasTag(const UWord inIndex) const
Definition: ntv2card.h:7001
NTV2XilinxFPGA
Definition: ntv2enums.h:3846
virtual bool HasMultiRasterWidget(void)
Definition: ntv2card.h:6802
AutoCirculate Frame Range.
Definition: ntv2utils.h:971
bool HasConflicts(const UWord inIndex) const
Definition: ntv2card.h:7002
CNTV2Card CNTV2Status
Definition: ntv2card.h:6871
I&#39;m the base class that undergirds the platform-specific derived classes (from which CNTV2Card is ult...
NTV2FrameRate
Identifies a particular video frame rate.
Definition: ntv2enums.h:412
virtual CNTV2DriverInterface & driverInterface(void)
Definition: ntv2card.h:6449
virtual bool DMABufferUnlock(const ULWord *pInBuffer, const ULWord inByteCount)
Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.
Definition: ntv2card.h:492
NTV2Standard
Identifies a particular video standard.
Definition: ntv2enums.h:165
NTV2DeviceID
Identifies a specific AJA NTV2 device model number. The NTV2DeviceID is actually the PROM part number...
Definition: ntv2enums.h:20
static ULWordSet CoalesceRegions(const ULWordSequence &inRgn1, const ULWordSequence &inRgn2, const ULWordSequence &inRgn3)
Definition: ntv2card.cpp:640
enum NTV2VPIDTransferCharacteristics NTV2HDRXferChars
int16_t Word
Definition: ajatypes.h:220
NTV2_RS422_PARITY
These enum values identify RS-422 serial port parity configuration.
Definition: ntv2enums.h:4162
virtual bool DeviceCanDoAudioMixer(void)
Definition: ntv2card.h:164
NTV2ReferenceSource
These enum values identify a specific source for the device&#39;s (output) reference clock.
Definition: ntv2enums.h:1454
NTV2BreakoutType
Identifies the Breakout Boxes and Cables that may be attached to an AJA NTV2 device.
Definition: ntv2enums.h:3103
Identifies "all" ancillary data regions.
Definition: ntv2enums.h:4237
virtual bool ReadRegisters(NTV2RegisterReads &inOutValues)
Reads the register(s) specified by the given NTV2RegInfo sequence.
CNTV2Card CXena2VidProc
Definition: ntv2card.h:6876
#define AJA_VIRTUAL
Definition: ajatypes.h:130
NTV2ColorSpaceMethod
Definition: ntv2enums.h:3447
NTV2DMAEngine
Definition: ntv2enums.h:1856
True if device has attached breakout board. (New in SDK 17.0)
bool TagMemoryBlock(const uint64_t inStartAddr, const uint64_t inByteLength, const std::string &inTag)
Definition: ntv2card.h:7042
bool GetFreeRegions(ULWordSequence &outBlks) const
Answers with the list of free memory regions.
Definition: ntv2card.h:6963
virtual bool ReadAudioLastOut(ULWord &outValue, const NTV2Channel inChannel)
Definition: ntv2card.h:2202
Reports HDMI output status information.
NTV2AudioLoopBack
This enum value determines/states if an audio output embedder will embed silence (zeroes) or de-embed...
Definition: ntv2enums.h:2028
virtual bool SetEveryFrameServices(const NTV2TaskMode m)
Definition: ntv2card.h:1195
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
NTV2ColorCorrectionMode
Definition: ntv2enums.h:2079
NTV2QuarterSizeExpandMode
Definition: ntv2enums.h:2486
NTV2RegisterNumberSet NTV2RegNumSet
A set of distinct NTV2RegisterNumbers.
NTV2AudioChannelPair
Identifies a pair of audio channels.
Definition: ntv2enums.h:3131
std::set< ULWord > ULWordSet
A collection of unique ULWord (uint32_t) values.
NTV2MixerKeyerInputControl
These enum values identify the Mixer/Keyer foreground and background input control values...
Definition: ntv2enums.h:1776
#define NTV2_SHOULD_BE_DEPRECATED(__f__)
Definition: ajatypes.h:491
std::vector< uint16_t > UWordSequence
An ordered sequence of UWord (uint16_t) values.
NTV2UpConvertMode
Definition: ntv2enums.h:2219
std::set< NTV2AudioSystem > NTV2AudioSystemSet
A set of distinct NTV2AudioSystem values. New in SDK 16.2.
NTV2HDMIProtocol
Indicates or specifies the HDMI protocol.
Definition: ntv2enums.h:3621
bool GetRegions(ULWordSequence &outFree, ULWordSequence &outUsed, ULWordSequence &outBad) const
Answers with the lists of free, in-use and conflicting 8MB memory blocks. Each ULWord represents a re...
Definition: ntv2card.cpp:680
NTV2VPIDColorimetry
Definition: ntv2enums.h:4254
True if device can rasterize 4 HD signals into a single HDMI output.
#define NTV2_WILL_BE_DEPRECATED(__f__)
Definition: ajatypes.h:494
virtual bool HasCanConnectROM(void)
Definition: ntv2card.h:4488
NTV2HDMIV2Mode
Definition: ntv2enums.h:4000
virtual bool IS_CHANNEL_VALID(const NTV2Channel inChannel) const
Definition: ntv2card.h:6820
NTV2DownConvertMode
Definition: ntv2enums.h:2242
CNTV2Card CNTV2Device
Instances of this class are able to interrogate and control an NTV2 AJA video/audio capture/playout d...
Definition: ntv2card.h:6869
uint64_t ULWord64
Definition: ajatypes.h:226
NTV2LUTPlaneSelect
Definition: ntv2enums.h:3883
uint8_t UByte
Definition: ajatypes.h:218
NTV2AudioLevel
Definition: ntv2enums.h:2313
virtual bool DeviceIsDNxIV(void)
Definition: ntv2card.h:165
virtual std::string GetDescription(void) const
NTV2Framesize
Kona2/Xena2 specific enums.
Definition: ntv2enums.h:2116
virtual bool GetLTCOnReference(bool &outVal)
Definition: ntv2card.h:5246
virtual bool Read3GInputStatus2Register(ULWord *pVal)
Definition: ntv2card.h:2516
Describes a user-space buffer on the host computer. I have an address and a length, plus some optional attributes (allocated by SDK?, page-aligned? etc.).
virtual bool AuxSetFrameBufferSize(const ULWord inF1Size, const ULWord inF2Size)
Sets the capacity of the HDMI AUX buffers in device frame memory.
Definition: ntv2card.h:6125
NTV2Mode
Used to identify the mode of a widget_framestore, or the direction of an AutoCirculate stream: either...
Definition: ntv2enums.h:1239
Declares the MSWindows-specific flavor of CNTV2DriverInterface.
NTV2InputSource
Identifies a specific video input source.
Definition: ntv2enums.h:1262
NTV2HDMIColorimetry
Indicates or specifies the HDMI colorimetry.
Definition: ntv2enums.h:3649
const ULWord LUTTablePartitionSize
True if device has a crosspoint connection ROM (New in SDK 17.0)
This object specifies the information that will be transferred to or from the AJA device in the CNTV2...
bool TagVideoFrames(CNTV2Card &inDevice)
Definition: ntv2card.cpp:804
NTV2FrameBufferQuality
Definition: ntv2enums.h:2497
virtual bool GetEveryFrameServices(NTV2TaskMode &m)
Definition: ntv2card.h:1194
CNTV2Card CNTV2VidProc
Definition: ntv2card.h:6873
#define AJAExport
Definition: export.h:33
NTV2VPIDTransferCharacteristics
Definition: ntv2enums.h:4246
NTV2FrameGeometry
Identifies a particular video frame geometry.
Definition: ntv2enums.h:348
NTV2_CSC_RGB_Range
Definition: ntv2enums.h:3759
std::set< NTV2Channel > NTV2ChannelSet
A set of distinct NTV2Channel values.
This identifies the first Audio System.
Definition: ntv2enums.h:3897
#define AJA_RETAIL_DEFAULT
Definition: ntv2card.h:592
Declares numerous NTV2 utility functions.
virtual bool DMABufferLock(const ULWord *pInBuffer, const ULWord inByteCount, bool inMap=(0), bool inRDMA=(0))
Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers.
Definition: ntv2card.h:471
bool TagAudioBuffers(CNTV2Card &inDevice, const bool inMarkStoppedAudioBuffersFree)
Definition: ntv2card.cpp:786
Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image...
std::set< NTV2InputXptID > NTV2InputXptIDSet
A collection of distinct NTV2InputXptID values.
NTV2OutputCrosspointID
Identifies a widget output, a signal source, that potentially can drive another widget&#39;s input (ident...
Definition: ntv2enums.h:2527
NTV2InputCrosspointID
Identifies a widget input that potentially can accept a signal emitted from another widget&#39;s output (...
Definition: ntv2enums.h:2752
NTV2IsoConvertMode
Definition: ntv2enums.h:2253
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
NTV2WidgetID
Definition: ntv2enums.h:2909
CNTV2Card CNTV2ColorCorrection
Definition: ntv2card.h:6874
NTV2EncodeAsPSF
Definition: ntv2enums.h:2512
uint16_t UWord
Definition: ajatypes.h:221
Specifies channel or FrameStore 1 (or the first item).
Definition: ntv2enums.h:1359
virtual bool WriteGlobalControl(const ULWord inVal)
Definition: ntv2card.h:2407
virtual bool SetLTCOnReference(bool val)
Definition: ntv2card.h:5245
NTV2VideoLimiting
These enum values identify the available SDI video output limiting modes.
Definition: ntv2enums.h:3778
virtual bool CanDoAudioWaitForVBI(void)
Definition: ntv2card.h:2210
Declares the CNTV2BareMetalDriverInterface class.
NTV2AncillaryDataRegion
These enumerations identify the various ancillary data regions located at the bottom of each frame bu...
Definition: ntv2enums.h:4227
NTV2VANCMode
These enum values identify the available VANC modes.
Definition: ntv2enums.h:3797
NTV2ColorSpaceMatrixType
Definition: ntv2enums.h:3458
NTV2DSKMode
Definition: ntv2enums.h:3499
NTV2RegisterWriteMode
These values are used to determine when certain register writes actually take effect. See CNTV2Card::SetRegisterWriteMode or Field/Frame Interrupts.
Definition: ntv2enums.h:1679
virtual bool GetRegisterWritemode(NTV2RegisterWriteMode &outVal, const NTV2Channel inChan=NTV2_CHANNEL1)
Definition: ntv2card.h:3034
virtual bool SetRegisterWritemode(NTV2RegisterWriteMode inVal, const NTV2Channel inChan=NTV2_CHANNEL1)
Definition: ntv2card.h:3033
mDevice DMABufferLock(mVideoBuffer,(!(0)))
True if device has HDMI AUX data extractor(s).
bool GetTagsForFrameIndex(const UWord inIndex, NTV2StringSet &outTags) const
Answers with the list of tags for the given frame number.
Definition: ntv2card.cpp:744
virtual bool SetAudioOutputMonitorSource(const NTV2AudioMonitorSelect inChannelPair, const NTV2Channel inAudioSystem=NTV2_CHANNEL1)
Definition: ntv2card.h:6813
Declares the CNTV2LinuxDriverInterface class.
NTV2AudioSource
This enum value determines/states where an audio system will obtain its audio samples.
Definition: ntv2enums.h:2005
virtual bool Read3GInputStatusRegister(ULWord *pVal)
Definition: ntv2card.h:2515
virtual bool GetAudioOutputMonitorSource(NTV2AudioMonitorSelect &chp, NTV2Channel &ch)
Definition: ntv2card.h:6814
NTV2VANCDataShiftMode
Definition: ntv2enums.h:3813
std::pair< NTV2InputXptID, NTV2OutputXptID > NTV2XptConnection
#define NTV2_DEPRECATED_17_5(__f__)
Definition: ajatypes.h:563
enum NTV2InputCrosspointID NTV2InputXptID
Convenience class/API for inquiring about device capabilities of physical and virtual devices...
NTV2LSVideoADCMode
Definition: ntv2enums.h:2195
std::multimap< NTV2InputXptID, NTV2OutputXptID > NTV2PossibleConnections
A map of zero or more one-to-many possible NTV2InputXptID to NTV2OutputXptID connections.
This class/object reports information about the current and/or requested AutoCirculate frame...
True if device audio systems can wait for VBI before starting. (New in SDK 17.0)
NTV2AudioRate
Definition: ntv2enums.h:1928
std::vector< uint32_t > ULWordSequence
An ordered sequence of ULWord (uint32_t) values.
#define NTV2_DEPRECATED_16_0(__f__)
Definition: ajatypes.h:529
std::set< NTV2InputXptID > NTV2InputCrosspointIDSet
bool TagMemoryBlock(const ULWord inStartAddr, const ULWord inByteLength, const std::string &inTag)
True if device has a microphone input connector.
std::string SerialNum64ToString(const uint64_t &inSerNum)
Definition: ntv2utils.cpp:8243
NTV2MixerRGBRange
Definition: ntv2enums.h:2274
NTV2ConversionMode
Definition: ntv2enums.h:3714
#define NTV2_DEPRECATED_17_0(__f__)
Definition: ajatypes.h:548
NTV2AudioMixerChannel
Definition: ntv2enums.h:3225
NTV2LUTControlSelect
Definition: ntv2enums.h:3876
std::set< NTV2DeviceID > NTV2DeviceIDSet
A set of NTV2DeviceIDs.
Definition: ntv2utils.h:1044
NTV2ConversionMode GetConversionMode(const NTV2VideoFormat inFormat, const NTV2VideoFormat outFormat)
Definition: ntv2utils.cpp:5475
CNTV2Card CNTV2TestPattern
Definition: ntv2card.h:6872
True if device has a firmware audio mixer.
CNTV2Card CNTV2ProcAmp
Definition: ntv2card.h:6875
std::map< NTV2InputXptID, NTV2OutputXptID > NTV2XptConnections
This is used by the CNTV2Card::ReadSDIStatistics function.
std::ostream & DumpBlocks(std::ostream &oss) const
Dumps all 8MB blocks/frames and their tags, if any, into the given stream.
Definition: ntv2card.cpp:655
NTV2Audio4ChannelSelect
Identifies a contiguous, adjacent group of four audio channels.
Definition: ntv2enums.h:3271
bool GetUsedRegions(ULWordSequence &outBlks) const
Answers with the list of used memory regions.
Definition: ntv2card.h:6983
ULWord GetIntrinsicFrameByteCount(void) const
Definition: ntv2card.h:7003
NTV2VPIDRGBRange
Definition: ntv2enums.h:4268
A Mac-specific implementation of CNTV2DriverInterface.
std::vector< NTV2RegInfo > NTV2RegisterWrites
NTV2Interrupt2Mask
Definition: ntv2enums.h:1600
NTV2_RS422_BAUD_RATE
These enum values identify RS-422 serial port baud rate configuration.
Definition: ntv2enums.h:4177
Identifies the 1st SDI video input.
Definition: ntv2enums.h:1269
std::vector< NTV2DeviceID > NTV2DeviceIDList
An ordered list of NTV2DeviceIDs.
Definition: ntv2utils.h:1037
virtual bool SetVANCMode(const NTV2VANCMode m, const NTV2Standard st, const NTV2FrameGeometry fg, const NTV2Channel ch=NTV2_CHANNEL1)
Definition: ntv2card.h:1212
NTV2HDMISampleStructure
Definition: ntv2enums.h:4187
Physical device implementations of CNTV2DriverInterface methods through AJA Windows driver...
std::set< NTV2OutputXptID > NTV2OutputXptIDSet
A collection of distinct NTV2OutputXptID values.
NTV2EmbeddedAudioInput
This enum value determines/states which SDI video input will be used to supply audio samples to an au...
Definition: ntv2enums.h:1967
Implements the MacOS-specific flavor of CNTV2DriverInterface.
NTV2HDMIBitDepth
Indicates or specifies the HDMI video bit depth.
Definition: ntv2enums.h:3692
#define NTV2_DEPRECATED_16_2(__f__)
Definition: ajatypes.h:538
NTV2StereoCompressorOutputMode
Definition: ntv2enums.h:3856
#define NTV2_DEPRECATED_16_1(__f__)
Definition: ajatypes.h:533
Linux implementation of CNTV2DriverInterface.
BareMetal implementation of CNTV2DriverInterface.
NTV2HDMIOut3DMode
This specifies the HDMI Out Stereo 3D Mode.
Definition: ntv2enums.h:3593
NTV2MixerKeyerMode
These enum values identify the mixer mode.
Definition: ntv2enums.h:1791
NTV2Audio8ChannelSelect
Identifies a contiguous, adjacent group of eight audio channels.
Definition: ntv2enums.h:3320
Declares the DeviceCapabilities class.
std::set< UByte > NTV2DIDSet
A set of distinct NTV2DID values.
NTV2LHIHDMIColorSpace
Definition: ntv2enums.h:3678
std::set< std::string > NTV2StringSet
Definition: ntv2utils.h:1158
NTV2EncodedAudioMode
Definition: ntv2enums.h:1940
virtual bool WriteRegister(const ULWord inRegNum, const ULWord inValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
Updates or replaces all or part of the 32-bit contents of a specific register (real or virtual) on th...
NTV2AudioMixerInput
Identifies the Audio Mixer&#39;s audio inputs.
Definition: ntv2enums.h:3254
virtual bool DeviceHasMicInput(void)
Definition: ntv2card.h:166
NTV2DieTempScale
Definition: ntv2enums.h:4210
NTV2ColorCorrectionHostAccessBank
Definition: ntv2enums.h:2058