AJA NTV2 SDK  18.1.0.2262
NTV2 SDK 18.1.0.2262
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 inline bool GetPCIDeviceID (ULWord & outPCIDeviceID) {return ReadRegister (kVRegPCIDeviceID, 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 
1030  AJA_VIRTUAL bool SetOutputFrame (const NTV2Channel inChannel, const ULWord inValue);
1031 
1040  AJA_VIRTUAL bool GetOutputFrame (const NTV2Channel inChannel, ULWord & outValue);
1041 
1068  AJA_VIRTUAL bool SetInputFrame (const NTV2Channel inChannel, const ULWord inValue);
1069 
1080  AJA_VIRTUAL bool GetInputFrame (const NTV2Channel inChannel, ULWord & outValue);
1081 
1082  AJA_VIRTUAL bool SetDualLinkOutputEnable (const bool inIsEnabled);
1083  AJA_VIRTUAL bool GetDualLinkOutputEnable (bool & outIsEnabled);
1084 
1085  AJA_VIRTUAL bool SetDualLinkInputEnable (const bool inIsEnabled);
1086  AJA_VIRTUAL bool GetDualLinkInputEnable (bool & outIsEnabled);
1087 
1094  AJA_VIRTUAL bool SetVideoLimiting (const NTV2VideoLimiting inValue);
1095 
1102  AJA_VIRTUAL bool GetVideoLimiting (NTV2VideoLimiting & outValue);
1103 
1104  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC, const NTV2Standard inStandard, const NTV2FrameGeometry inGeometry, const NTV2Channel inChannel = NTV2_CHANNEL1);
1105  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC = false, const NTV2Channel inChannel = NTV2_CHANNEL1);
1106 
1115  AJA_VIRTUAL bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1116 
1124  AJA_VIRTUAL bool SetVANCMode (const NTV2ChannelSet & inChannels, const NTV2VANCMode inVancMode);
1125 
1134  AJA_VIRTUAL bool GetVANCMode (NTV2VANCMode & outVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1135 
1148  AJA_VIRTUAL bool SetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode inMode);
1149 
1162  AJA_VIRTUAL bool SetVANCShiftMode (NTV2ChannelSet & inChannels, const NTV2VANCDataShiftMode inMode); // New in SDK 16.2
1163 
1177  AJA_VIRTUAL bool GetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode & outValue);
1178 
1179  AJA_VIRTUAL bool SetPulldownMode (NTV2Channel inChannel, bool inValue);
1180  AJA_VIRTUAL bool GetPulldownMode (NTV2Channel inChannel, bool & outValue);
1181 
1192  AJA_VIRTUAL bool ReadLineCount (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
1193 
1194 #if !defined(NTV2_DEPRECATE_18_1)
1196  AJA_VIRTUAL inline NTV2_DEPRECATED_18_1(bool GetAlphaFromInput2Bit (ULWord & outVal)) {return ReadRegister (kRegCh1Control, outVal, kRegMaskAlphaFromInput2, kRegShiftAlphaFromInput2);}
1197 #endif
1198 #if !defined(NTV2_DEPRECATE_18_0)
1199  AJA_VIRTUAL inline NTV2_DEPRECATED_18_0(bool GetEveryFrameServices(NTV2TaskMode & m)) {return GetTaskMode(m);}
1200  AJA_VIRTUAL inline NTV2_DEPRECATED_18_0(bool SetEveryFrameServices(const NTV2TaskMode m)) {return SetTaskMode(m);}
1201 #endif // defined(NTV2_DEPRECATE_18_0)
1202 #if !defined(NTV2_DEPRECATE_16_3)
1203  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool SetDefaultVideoOutMode(ULWord mode));
1204  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool GetDefaultVideoOutMode(ULWord & outMode));
1205 #endif // defined(NTV2_DEPRECATE_16_3)
1206 #if !defined(NTV2_DEPRECATE_16_2)
1207  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetActiveFrameDimensions (NTV2FrameDimensions & outFrameDimensions, const NTV2Channel inChannel = NTV2_CHANNEL1));
1208  AJA_VIRTUAL NTV2_DEPRECATED_16_2(NTV2FrameDimensions GetActiveFrameDimensions (const NTV2Channel inChannel = NTV2_CHANNEL1));
1209  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetNumberActiveLines (ULWord & outNumActiveLines));
1210  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool FlipFlopPage (const NTV2Channel inChannel));
1211  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool SetPCIAccessFrame (const NTV2Channel inChannel, const ULWord inValue, const bool inWaitForVBI = true));
1212  AJA_VIRTUAL NTV2_DEPRECATED_16_2(bool GetPCIAccessFrame (const NTV2Channel inChannel, ULWord & outValue));
1213 #endif // !defined(NTV2_DEPRECATE_16_2)
1214 #if !defined(NTV2_DEPRECATE_16_0)
1215  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));}
1216  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetVANCMode (const NTV2VANCMode m, const NTV2Standard st, const NTV2FrameGeometry fg,
1217  const NTV2Channel ch = NTV2_CHANNEL1)) {(void) st; (void) fg; return SetVANCMode(m, ch);}
1218  #define Set425FrameEnable SetTsiFrameEnable // Replace calls to Set425FrameEnable with calls to SetTsiFrameEnable instead
1219  #define Get425FrameEnable GetTsiFrameEnable // Replace calls to Get425FrameEnable with calls to GetTsiFrameEnable instead
1220 #endif // NTV2_DEPRECATE_16_0
1221 
1222 
1226 
1237  AJA_VIRTUAL bool SetMixerVancOutputFromForeground (const UWord inWhichMixer, const bool inFromForegroundSource = true);
1238 
1248  AJA_VIRTUAL bool GetMixerVancOutputFromForeground (const UWord inWhichMixer, bool & outIsFromForegroundSource);
1249 
1250 
1258  AJA_VIRTUAL bool SetMixerFGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1259 
1267  AJA_VIRTUAL bool GetMixerFGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1268 
1276  AJA_VIRTUAL bool SetMixerBGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1277 
1285  AJA_VIRTUAL bool GetMixerBGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1286 
1294  AJA_VIRTUAL bool SetMixerMode (const UWord inWhichMixer, const NTV2MixerKeyerMode inMode);
1295 
1303  AJA_VIRTUAL bool GetMixerMode (const UWord inWhichMixer, NTV2MixerKeyerMode & outMode);
1304 
1312  AJA_VIRTUAL bool SetMixerCoefficient (const UWord inWhichMixer, const ULWord inMixCoefficient);
1313 
1321  AJA_VIRTUAL bool GetMixerCoefficient (const UWord inWhichMixer, ULWord & outMixCoefficient);
1322 
1331  AJA_VIRTUAL bool GetMixerSyncStatus (const UWord inWhichMixer, bool & outIsSyncOK);
1332 
1340  AJA_VIRTUAL bool GetMixerFGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1341 
1349  AJA_VIRTUAL bool SetMixerFGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1350 
1358  AJA_VIRTUAL bool GetMixerBGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1359 
1367  AJA_VIRTUAL bool SetMixerBGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1368 
1376  AJA_VIRTUAL bool GetMixerMatteColor (const UWord inWhichMixer, YCbCr10BitPixel & outYCbCrValue);
1377 
1385  AJA_VIRTUAL bool SetMixerMatteColor (const UWord inWhichMixer, const YCbCr10BitPixel inYCbCrValue);
1386 
1393  AJA_VIRTUAL bool MixerHasRGBModeSupport (const UWord inWhichMixer, bool & outIsSupported);
1394 
1401  AJA_VIRTUAL bool SetMixerRGBRange (const UWord inWhichMixer, const NTV2MixerRGBRange inRGBRange);
1402 
1409  AJA_VIRTUAL bool GetMixerRGBRange (const UWord inWhichMixer, NTV2MixerRGBRange & outRGBRange);
1411 
1412 
1416 
1427  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1428 
1437  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1438 
1449  AJA_VIRTUAL bool GetNumberAudioChannels (ULWord & outNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1450 
1458  AJA_VIRTUAL bool SetAudioRate (const NTV2AudioRate inRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1459 
1467  AJA_VIRTUAL bool GetAudioRate (NTV2AudioRate & outRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1468 
1477  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1478 
1487  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inSize, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1488 
1496  AJA_VIRTUAL bool GetAudioBufferSize (NTV2AudioBufferSize & outSize, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1497 
1505  AJA_VIRTUAL bool SetAudio20BitMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 13.0
1506 
1516  AJA_VIRTUAL bool GetAudio20BitMode (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 13.0
1517 
1527  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1528 
1537  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1538 
1548  AJA_VIRTUAL bool GetAudioLoopBack (NTV2AudioLoopBack & outMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1549 
1550 
1551  AJA_VIRTUAL bool SetAudioAnalogLevel (const NTV2AudioLevel value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1552  AJA_VIRTUAL bool GetAudioAnalogLevel (NTV2AudioLevel & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1553  AJA_VIRTUAL bool SetEncodedAudioMode (const NTV2EncodedAudioMode value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1554  AJA_VIRTUAL bool GetEncodedAudioMode (NTV2EncodedAudioMode & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1555 
1563  AJA_VIRTUAL bool SetEmbeddedAudioClock (const NTV2EmbeddedAudioClock inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1564 
1572  AJA_VIRTUAL bool GetEmbeddedAudioClock (NTV2EmbeddedAudioClock & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1573 
1587  AJA_VIRTUAL bool GetAudioWrapAddress (ULWord & outWrapAddress, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1588 
1598  AJA_VIRTUAL bool GetAudioReadOffset (ULWord & outReadOffset, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1599 
1612  AJA_VIRTUAL bool GetAudioMemoryOffset (const ULWord inOffsetBytes, ULWord & outAbsByteOffset,
1613  const NTV2AudioSystem inAudioSystem, const bool inCaptureBuffer = false); // New in SDK 13.0
1614 
1626  AJA_VIRTUAL bool ReadAudioLastOut (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1627 
1638  AJA_VIRTUAL bool ReadAudioLastIn (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1639 
1654  AJA_VIRTUAL bool StartAudioOutput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1655 
1666  AJA_VIRTUAL bool StopAudioOutput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1667 
1677  AJA_VIRTUAL bool IsAudioOutputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1678 
1690  AJA_VIRTUAL bool SetAudioOutputPause (const NTV2AudioSystem inAudioSystem, const bool inPausePlayout); // New in SDK 12.3
1691 
1700  AJA_VIRTUAL bool GetAudioOutputPause (const NTV2AudioSystem inAudioSystem, bool & outIsPaused); // New in SDK 12.3
1701 
1716  AJA_VIRTUAL bool StartAudioInput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1717 
1729  AJA_VIRTUAL bool StopAudioInput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1730 
1739  AJA_VIRTUAL bool IsAudioInputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1740 
1752  AJA_VIRTUAL bool SetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 12.3
1753 
1764  AJA_VIRTUAL bool GetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 12.3
1765 
1774  AJA_VIRTUAL bool SetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable);
1775 
1786  AJA_VIRTUAL bool GetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable);
1787 
1799  AJA_VIRTUAL bool SetAudioInputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1800 
1811  AJA_VIRTUAL bool GetAudioInputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1812 
1813 
1824  AJA_VIRTUAL bool SetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1825 
1836  AJA_VIRTUAL bool GetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1837 
1838 
1850  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const bool inIsNonPCM); // New in SDK 12.1
1851 
1852 
1862  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, bool & outIsNonPCM); // New in SDK 12.1
1863 
1864 
1878  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, const bool inIsNonPCM); // New in SDK 12.2
1879 
1880 
1889  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPairs & inNonPCMChannelPairs); // New in SDK 12.4
1890 
1891 
1905  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsNonPCM); // New in SDK 12.2
1906 
1907 
1917  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outNonPCMChannelPairs); // New in SDK 12.4
1918 
1919 
1928  AJA_VIRTUAL bool IsAudioChannelPairPresent (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsPresent); // New in SDK 12.5
1929 
1930 
1941  AJA_VIRTUAL bool GetDetectedAudioChannelPairs (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 12.5
1942 
1943 
1950  AJA_VIRTUAL bool GetDetectedAESChannelPairs (NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 13.0
1951 
1952 
1966  AJA_VIRTUAL bool SetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, const NTV2AudioSource inAudioSource, const NTV2EmbeddedAudioInput inEmbeddedInput);
1967 
1979  AJA_VIRTUAL bool GetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, NTV2AudioSource & outAudioSource, NTV2EmbeddedAudioInput & outEmbeddedSource);
1980 
1994  AJA_VIRTUAL bool SetEmbeddedAudioInput (const NTV2EmbeddedAudioInput inEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1995 
2006  AJA_VIRTUAL bool GetEmbeddedAudioInput (NTV2EmbeddedAudioInput & outEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
2007 
2015  virtual bool InputAudioChannelPairHasPCM (const NTV2Channel inSDIInputConnector, const NTV2AudioChannelPair inAudioChannelPair, bool & outIsPCM); // New in SDK 12.3
2016 
2027  virtual bool GetInputAudioChannelPairsWithPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2028 
2035  virtual bool GetInputAudioChannelPairsWithoutPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2036 
2044  AJA_VIRTUAL bool GetSuspendHostAudio (bool & outIsSuspended); // New in SDK 12.1
2045 
2054  AJA_VIRTUAL bool SetSuspendHostAudio (const bool inSuspend); // New in SDK 12.1
2055 
2066  AJA_VIRTUAL bool GetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, NTV2AudioSystem & outSrcAudioSystem, NTV2Audio4ChannelSelect & outSrcAudioChannels); // New in SDK 12.5
2067 
2078  AJA_VIRTUAL bool SetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, const NTV2AudioSystem inSrcAudioSystem, const NTV2Audio4ChannelSelect inSrcAudioChannels); // New in SDK 12.5
2079 
2088  AJA_VIRTUAL bool SetAudioOutputMonitorSource (const NTV2AudioChannelPair inChannelPair, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
2089 
2098  AJA_VIRTUAL bool GetAudioOutputMonitorSource (NTV2AudioChannelPair & outChannelPair, NTV2AudioSystem & outAudioSystem);
2099 
2108  AJA_VIRTUAL bool GetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, bool & outEraseModeEnabled); // New in SDK 13.0
2109 
2118  AJA_VIRTUAL bool SetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, const bool & inEraseModeEnabled); // New in SDK 13.0
2119 
2127  AJA_VIRTUAL bool GetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, bool & outAESSyncModeBitSet); // New in SDK 15.2
2128 
2136  AJA_VIRTUAL bool SetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, const bool & inAESSyncModeBitSet); // New in SDK 15.2
2137 
2146  AJA_VIRTUAL bool SetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, const bool inEnable); // New in SDK 16.1
2147 
2156  AJA_VIRTUAL bool GetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, bool & outEnabled); // New in SDK 16.1
2157 
2167  AJA_VIRTUAL bool GetRawAudioTimer (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1); // New in SDK 15.5
2168 
2176  AJA_VIRTUAL bool EnableBOBAnalogAudioIn (bool inEnable); // New in SDK 17.0
2177 
2185  AJA_VIRTUAL bool SetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 16.2
2186 
2194  AJA_VIRTUAL bool GetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, bool & outEnabled); // New in SDK 16.2
2195 
2196 #if !defined(NTV2_DEPRECATE_16_0)
2197  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool WriteAudioSource (const ULWord inValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2198  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool ReadAudioSource (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2199  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetAudioOutputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioOutput(inAudioSystem) : StartAudioOutput(inAudioSystem);}
2200  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetAudioOutputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioOutputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2201  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetAudioInputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioInput(inAudioSystem) : StartAudioInput(inAudioSystem);}
2202  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetAudioInputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioInputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2203 #endif // !defined(NTV2_DEPRECATE_16_0)
2204 #if !defined(NTV2_DEPRECATE_16_1)
2205  AJA_VIRTUAL NTV2_DEPRECATED_16_1(bool SetAnalogAudioIOConfiguration (const NTV2AnalogAudioIO inConfig));
2206  AJA_VIRTUAL NTV2_DEPRECATED_16_1(bool GetAnalogAudioIOConfiguration (NTV2AnalogAudioIO & outConfig));
2207  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool ReadAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastOut(outValue, NTV2AudioSystem(inChannel));}
2208  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool ReadAudioLastIn (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastIn(outValue, NTV2AudioSystem(inChannel));}
2209  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool WriteAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {(void)outValue;(void)inChannel; return false;}
2210 #endif // !defined(NTV2_DEPRECATE_16_1)
2211 #if !defined(NTV2_DEPRECATE_16_3)
2212  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool WriteAudioLastOut (const ULWord inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1)) {(void)inValue;(void)inAudioSystem; return false;}
2213 #endif // !defined(NTV2_DEPRECATE_16_3)
2214 #if !defined(NTV2_DEPRECATE_17_0)
2216 #endif // !defined(NTV2_DEPRECATE_17_0)
2217 #if !defined(NTV2_DEPRECATE_17_5)
2218  AJA_VIRTUAL inline NTV2_DEPRECATED_17_5(bool GetAudioOutputEmbedderState (const NTV2Channel sdi, bool & enb)) {return GetSDIOutputAudioEnabled(sdi,enb);}
2219  AJA_VIRTUAL inline NTV2_DEPRECATED_17_5(bool SetAudioOutputEmbedderState (const NTV2Channel sdi, const bool & enb)) {return SetSDIOutputAudioEnabled(sdi,enb);}
2220 #endif // defined(NTV2_DEPRECATE_17_5)
2221 
2226 
2235  AJA_VIRTUAL bool GetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, NTV2AudioSystem & outAudioSystem); // New in SDK 15.5
2236 
2244  AJA_VIRTUAL bool SetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, const NTV2AudioSystem inAudioSystem); // New in SDK 15.5
2245 
2254  AJA_VIRTUAL bool GetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelPair & outChannelPair); // New in SDK 15.5
2255 
2264  AJA_VIRTUAL bool SetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPair inChannelPair); // New in SDK 15.5
2265 
2277  AJA_VIRTUAL bool GetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, ULWord & outGainValue); // New in SDK 15.5
2278 
2290  AJA_VIRTUAL bool SetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, const ULWord inGainValue); // New in SDK 15.5
2291 
2299  AJA_VIRTUAL bool GetAudioMixerOutputGain (ULWord & outGainValue); // New in SDK 15.5
2300 
2308  AJA_VIRTUAL bool SetAudioMixerOutputGain (const ULWord inGainValue); // New in SDK 15.5
2309 
2319  AJA_VIRTUAL bool GetAudioMixerOutputLevels (const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2320 
2328  AJA_VIRTUAL bool GetHeadphoneOutputGain (ULWord & outGainValue);
2329 
2337  AJA_VIRTUAL bool SetHeadphoneOutputGain (const ULWord inGainValue);
2338 
2348  AJA_VIRTUAL bool GetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2349 
2360  AJA_VIRTUAL bool SetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2361 
2372  AJA_VIRTUAL bool GetAudioMixerInputLevels (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2373 
2380  AJA_VIRTUAL bool GetAudioMixerLevelsSampleCount (ULWord & outSampleCount); // New in SDK 15.5
2381 
2389  AJA_VIRTUAL bool SetAudioMixerLevelsSampleCount (const ULWord inSampleCount); // New in SDK 15.5
2390 
2398  AJA_VIRTUAL bool GetAudioMixerOutputChannelsMute (NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2399 
2408  AJA_VIRTUAL bool SetAudioMixerOutputChannelsMute (const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2410 
2411  #if !defined(NTV2_DEPRECATE_16_3)
2413  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool ReadGlobalControl(ULWord * pOutVal)) {return pOutVal ? ReadRegister(kRegGlobalControl, *pOutVal) : false;}
2414  #endif // !defined(NTV2_DEPRECATE_16_3)
2415 
2416 
2420  AJA_VIRTUAL bool IsXilinxProgrammed (void);
2422  AJA_VIRTUAL bool GetProgramStatus (SSC_GET_FIRMWARE_PROGRESS_STRUCT * statusStruct);
2423 
2432  AJA_VIRTUAL bool GetRunningFirmwarePackageRevision (ULWord & outRevision);
2433 
2434 
2443  AJA_VIRTUAL bool GetRunningFirmwareRevision (UWord & outRevision);
2444 
2459  AJA_VIRTUAL bool GetRunningFirmwareDate (UWord & outYear, UWord & outMonth, UWord & outDay);
2460 
2475  AJA_VIRTUAL bool GetRunningFirmwareTime (UWord & outHours, UWord & outMinutes, UWord & outSeconds);
2476 
2491  AJA_VIRTUAL bool GetRunningFirmwareDate (std::string & outDate, std::string & outTime);
2492 
2499  AJA_VIRTUAL bool GetRunningFirmwareUserID (ULWord & outUserID); // New in SDK 16.1
2501 
2502 #if !defined(NTV2_DEPRECATE_16_0)
2503  // OEM Mapping to Userspace Functions
2504  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBaseAddress(NTV2Channel channel, ULWord **pBaseAddress));
2505  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBaseAddress(ULWord **pBaseAddress));
2506  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetRegisterBaseAddress(ULWord regNumber, ULWord ** pRegAddress));
2507  AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetXena2FlashBaseAddress(ULWord ** pXena2FlashAddress));
2508 #endif // !defined(NTV2_DEPRECATE_16_0)
2509 #if !defined(NTV2_DEPRECATE_17_0)
2510  // Read-Only Status Registers
2511  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus, *pVal) : false;}
2512  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus2, *pVal) : false;}
2513  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInputStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus, *pVal) : false;}
2514  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInputStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus2, *pVal) : false;}
2515  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInput56StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput56Status, *pVal) : false;}
2516  AJA_VIRTUAL inline NTV2_DEPRECATED_17_0(bool ReadInput78StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput78Status, *pVal) : false;}
2520 #endif // !defined(NTV2_DEPRECATE_17_0)
2521 #if !defined(NTV2_DEPRECATE_18_1)
2525  AJA_VIRTUAL NTV2_DEPRECATED_18_1(bool ProgramMainFlash (const std::string & filePath, const bool forceUpdate = false, const bool quiet = false));
2526 #endif // !defined(NTV2_DEPRECATE_18_1)
2527 
2528 
2532 
2539  AJA_VIRTUAL inline bool SetLEDState (const ULWord inValue) {return WriteRegister (kRegGlobalControl, inValue, kRegMaskLED, kRegShiftLED);}
2540 
2547  AJA_VIRTUAL inline bool GetLEDState (ULWord & outValue) {return ReadRegister (kRegGlobalControl, outValue, kRegMaskLED, kRegShiftLED);}
2549 
2550 
2554 
2563  AJA_VIRTUAL bool SetRP188Mode (const NTV2Channel inChannel, const NTV2_RP188Mode inMode);
2564 
2572  AJA_VIRTUAL bool GetRP188Mode (const NTV2Channel inChannel, NTV2_RP188Mode & outMode);
2573 
2582  AJA_VIRTUAL bool SetRP188Data (const NTV2Channel inSDIOutput, const NTV2_RP188 & inRP188Data);
2583 
2598  AJA_VIRTUAL bool GetRP188Data (const NTV2Channel inSDIInput, NTV2_RP188 & outRP188Data);
2599 
2608  AJA_VIRTUAL bool SetRP188SourceFilter (const NTV2Channel inSDIInput, const UWord inFilterValue);
2609 
2620  AJA_VIRTUAL bool GetRP188SourceFilter (const NTV2Channel inSDIInput, UWord & outFilterValue);
2621 
2632  AJA_VIRTUAL bool IsRP188BypassEnabled (const NTV2Channel inSDIOutput, bool & outIsBypassEnabled);
2633 
2641  AJA_VIRTUAL bool DisableRP188Bypass (const NTV2Channel inSDIOutput);
2642 
2650  AJA_VIRTUAL bool EnableRP188Bypass (const NTV2Channel inSDIOutput);
2651 
2660  AJA_VIRTUAL bool SetRP188BypassSource (const NTV2Channel inSDIOutput, const UWord inSDIInput);
2661 
2670  AJA_VIRTUAL bool GetRP188BypassSource (const NTV2Channel inSDIOutput, UWord & outSDIInput);
2672 
2673 
2677  //
2679  // Enable Interrupt/Event
2680  //
2681  AJA_VIRTUAL bool EnableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2682 
2689  AJA_VIRTUAL bool EnableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2690 
2697  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2698 
2705  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2706 
2707 
2708  //
2709  // Disable Interrupt/Event
2710  //
2711  AJA_VIRTUAL bool DisableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2712 
2719  AJA_VIRTUAL bool DisableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2720 
2727  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2728 
2735  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2736 
2737  AJA_VIRTUAL bool GetCurrentInterruptMasks (NTV2InterruptMask & outIntMask1, NTV2Interrupt2Mask & outIntMask2);
2738 
2739 
2740  //
2741  // Subscribe to events
2742  //
2750  AJA_VIRTUAL bool SubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2751 
2761  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2762 
2772  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2773 
2774 
2784  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2785 
2795  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2796 
2797 
2798  //
2799  // Unsubscribe from events
2800  //
2807  AJA_VIRTUAL bool UnsubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2808 
2816  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2817 
2825  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2826 
2834  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2835 
2843  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2844 
2845 
2846  //
2847  // Get interrupt counts
2848  //
2856  AJA_VIRTUAL bool GetOutputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2857 
2865  AJA_VIRTUAL bool GetInputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2866 
2874  AJA_VIRTUAL bool GetOutputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2875 
2883  AJA_VIRTUAL bool GetInputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2884 
2892  AJA_VIRTUAL bool SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2893 
2901  AJA_VIRTUAL bool SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2902 
2903  //
2904  // Current field ID
2905  //
2906 
2913  AJA_VIRTUAL bool GetOutputFieldID (const NTV2Channel inChannel, NTV2FieldID & outFieldID);
2914 
2921  AJA_VIRTUAL bool GetInputFieldID (const NTV2Channel inChannel, NTV2FieldID & outFieldID);
2922 
2923  //
2924  // Wait for event
2925  //
2947  AJA_VIRTUAL bool WaitForOutputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2948 
2970  AJA_VIRTUAL bool WaitForOutputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
2971 
2990  AJA_VIRTUAL bool WaitForInputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2991 
3012  AJA_VIRTUAL bool WaitForInputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
3013 
3014  //
3015  // RegisterAccess Control
3016  //
3025  AJA_VIRTUAL bool SetRegisterWriteMode (const NTV2RegisterWriteMode inValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3026 
3035  AJA_VIRTUAL bool GetRegisterWriteMode (NTV2RegisterWriteMode & outValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3036 
3037  #if !defined (NTV2_DEPRECATE_16_0)
3038  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetRegisterWritemode(NTV2RegisterWriteMode inVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(inVal,inChan);}
3039  AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetRegisterWritemode(NTV2RegisterWriteMode & outVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(outVal,inChan);}
3040  #endif // NTV2_DEPRECATE_16_0
3041 
3043  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetForce64(ULWord force64));
3044  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetForce64(ULWord* force64));
3045  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool Get64BitAutodetect(ULWord* autodetect64));
3046 
3050  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetFrameStamp (NTV2Crosspoint channelSpec, ULWord frameNum, FRAME_STAMP_STRUCT* pFrameStamp));
3052  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetAutoCirculate (NTV2Crosspoint channelSpec, AUTOCIRCULATE_STATUS_STRUCT* autoCirculateStatus));
3053 
3054 
3097  AJA_VIRTUAL bool AutoCirculateInitForInput ( const NTV2Channel inChannel,
3098  const UWord inFrameCount = 7,
3099  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3100  const ULWord inOptionFlags = 0,
3101  const UByte inNumChannels = 1,
3102  const UWord inStartFrameNumber = 0,
3103  const UWord inEndFrameNumber = 0);
3104 
3133  AJA_VIRTUAL bool AutoCirculateInitForInput ( const NTV2Channel inChannel,
3134  const NTV2ACFrameRange & inFrameRange,
3135  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3136  const ULWord inOptionFlags = 0,
3137  const UByte inNumChannels = 1);
3138 
3180  AJA_VIRTUAL bool AutoCirculateInitForOutput (const NTV2Channel inChannel,
3181  const UWord inFrameCount = 7,
3182  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3183  const ULWord inOptionFlags = 0,
3184  const UByte inNumChannels = 1,
3185  const UWord inStartFrameNumber = 0,
3186  const UWord inEndFrameNumber = 0);
3187 
3216  AJA_VIRTUAL bool AutoCirculateInitForOutput (const NTV2Channel inChannel,
3217  const NTV2ACFrameRange & inFrameRange,
3218  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3219  const ULWord inOptionFlags = 0,
3220  const UByte inNumChannels = 1);
3221 
3253  AJA_VIRTUAL bool AutoCirculateStart (const NTV2Channel inChannel, const ULWord64 inStartTime = 0);
3254 
3270  AJA_VIRTUAL bool AutoCirculateStop (const NTV2Channel inChannel, const bool inAbort = false);
3271 
3280  AJA_VIRTUAL bool AutoCirculateStop (const NTV2ChannelSet & inChannels, const bool inAbort = false); // New in SDK 17.0
3281 
3293  AJA_VIRTUAL bool AutoCirculatePause (const NTV2Channel inChannel, const UWord inAtFrameNum = 0xFFFF); // Added inAtFrameNum in SDK 16.2
3294 
3306  AJA_VIRTUAL bool AutoCirculateResume (const NTV2Channel inChannel, const bool inClearDropCount = false);
3307 
3323  AJA_VIRTUAL bool AutoCirculateFlush (const NTV2Channel inChannel, const bool inClearDropCount = false);
3324 
3341  AJA_VIRTUAL bool AutoCirculatePreRoll (const NTV2Channel inChannel, const ULWord inPreRollFrames);
3342 
3354  AJA_VIRTUAL bool AutoCirculateGetStatus (const NTV2Channel inChannel, AUTOCIRCULATE_STATUS & outStatus);
3355 
3356 
3373  AJA_VIRTUAL bool AutoCirculateGetFrameStamp (const NTV2Channel inChannel, const ULWord inFrameNumber, FRAME_STAMP & outFrameInfo);
3374 
3390  AJA_VIRTUAL bool AutoCirculateSetActiveFrame (const NTV2Channel inChannel, const ULWord inNewActiveFrame);
3391 
3428  AJA_VIRTUAL bool AutoCirculateTransfer (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & transferInfo);
3429 
3448  AJA_VIRTUAL bool FindUnallocatedFrames (const UWord inFrameCount, LWord & outStartFrame, LWord & outEndFrame,
3449  const NTV2Channel inFrameStore = NTV2_CHANNEL_INVALID);
3451 
3455 #define NTV2_STREAM_SUCCESS(__status__) (__status__ == NTV2_STREAM_SUCCESS)
3457 #define NTV2_STREAM_FAIL(__status__) (__status__ != NTV2_STREAM_SUCCESS)
3458 
3464  AJA_VIRTUAL ULWord StreamChannelInitialize (const NTV2Channel inChannel);
3465 
3470  AJA_VIRTUAL ULWord StreamChannelRelease (const NTV2Channel inChannel);
3471 
3478  AJA_VIRTUAL ULWord StreamChannelStart (const NTV2Channel inChannel,
3479  NTV2StreamChannel& status);
3480 
3487  AJA_VIRTUAL ULWord StreamChannelStop (const NTV2Channel inChannel,
3488  NTV2StreamChannel& status);
3489 
3496  AJA_VIRTUAL ULWord StreamChannelFlush (const NTV2Channel inChannel,
3497  NTV2StreamChannel& status);
3498 
3504  AJA_VIRTUAL ULWord StreamChannelStatus (const NTV2Channel inChannel,
3505  NTV2StreamChannel& status);
3506 
3512  AJA_VIRTUAL ULWord StreamChannelWait (const NTV2Channel inChannel,
3513  NTV2StreamChannel& status);
3514 
3521  AJA_VIRTUAL ULWord StreamBufferQueue (const NTV2Channel inChannel,
3522  NTV2Buffer& inBuffer,
3523  ULWord64 bufferCookie,
3524  NTV2StreamBuffer& status);
3525 
3531  AJA_VIRTUAL ULWord StreamBufferRelease (const NTV2Channel inChannel,
3532  NTV2StreamBuffer& status);
3533 
3539  AJA_VIRTUAL ULWord StreamBufferStatus (const NTV2Channel inChannel,
3540  ULWord64 bufferCookie,
3541  NTV2StreamBuffer& status);
3543 
3544 
3545 #if defined(READREGMULTICHANGE)
3546 
3556  AJA_VIRTUAL bool ReadRegisters (const NTV2RegNumSet & inRegNums, NTV2RegisterValueMap & outValues);
3557 #endif // defined(READREGMULTICHANGE)
3558 
3566  AJA_VIRTUAL bool BankSelectReadRegister (const NTV2RegInfo & inBankSelect, NTV2RegInfo & inOutRegInfo);
3567 
3574  AJA_VIRTUAL bool WriteRegisters (const NTV2RegisterWrites & inRegWrites);
3575 
3583  AJA_VIRTUAL bool BankSelectWriteRegister (const NTV2RegInfo & inBankSelect, const NTV2RegInfo & inRegInfo);
3584 
3593  AJA_VIRTUAL bool WriteVirtualData (const ULWord inTag, const void* inVirtualData, const ULWord inVirtualDataSize);
3594 
3603  AJA_VIRTUAL bool ReadVirtualData (const ULWord inTag, void* outVirtualData, const ULWord inVirtualDataSize);
3604 
3611  AJA_VIRTUAL bool ReadSDIStatistics (NTV2SDIInStatistics & outStats);
3612 
3620  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Framesize inSize);
3621 
3629  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Channel inChannel, const NTV2Framesize inValue);
3630 
3638  AJA_VIRTUAL bool GetFrameBufferSize (const NTV2Channel inChannel, NTV2Framesize & outValue);
3639 #if !defined(NTV2_DEPRECATE_17_2)
3640  using CNTV2DriverInterface::GetFrameBufferSize; // Keep CNTV2DriverInterface::GetFrameBufferSize visible after being shadowed by CNTV2Card::GetFrameBufferSize
3641 #endif
3642 
3643 
3648  AJA_VIRTUAL bool IsBufferSizeSetBySW (void);
3649 
3657  AJA_VIRTUAL bool DisableChannel (const NTV2Channel inChannel);
3658 
3666  AJA_VIRTUAL bool DisableChannels (const NTV2ChannelSet & inChannels);
3667 
3675  AJA_VIRTUAL bool EnableChannel (const NTV2Channel inChannel);
3676 
3687  AJA_VIRTUAL bool EnableChannels (const NTV2ChannelSet & inChannels, const bool inDisableOthers = false);
3688 
3696  AJA_VIRTUAL bool IsChannelEnabled (const NTV2Channel inChannel, bool & outEnabled);
3697 
3704  AJA_VIRTUAL bool GetEnabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3705 
3712  AJA_VIRTUAL bool GetDisabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3713 
3714  AJA_VIRTUAL bool SetVideoDACMode (NTV2VideoDACMode inValue);
3715  AJA_VIRTUAL bool GetVideoDACMode (NTV2VideoDACMode & outValue);
3716 
3717 
3721  AJA_VIRTUAL bool GetNominalMinMaxHV (int & outNominalH, int & outMinH, int & outMaxH, int & outNominalV, int & outMinV, int & outMaxV);
3723 
3735  AJA_VIRTUAL bool SetVideoHOffset (const int inHOffset, const UWord inOutputSpigot = 0);
3736 
3747  AJA_VIRTUAL bool GetVideoHOffset (int & outHOffset, const UWord inOutputSpigot = 0);
3748 
3760  AJA_VIRTUAL bool SetVideoVOffset (const int inVOffset, const UWord inOutputSpigot = 0);
3761 
3772  AJA_VIRTUAL bool GetVideoVOffset (int & outVOffset, const UWord inOutputSpigot = 0);
3773 
3774  AJA_VIRTUAL bool SetAnalogOutHTiming (ULWord inValue);
3775  AJA_VIRTUAL bool GetAnalogOutHTiming (ULWord & outValue);
3776 
3791  AJA_VIRTUAL bool WriteOutputTimingControl (const ULWord inValue, const UWord inOutputSpigot = 0);
3792 
3803  AJA_VIRTUAL bool ReadOutputTimingControl (ULWord & outValue, const UWord inOutputSpigot = 0);
3804 
3805  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI1OutHTiming (ULWord value));
3806  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI1OutHTiming(ULWord* value));
3807  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI2OutHTiming (ULWord value));
3808  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI2OutHTiming(ULWord* value));
3810 
3814  /*
3816  @brief Sets the VPID payload value(s) for each link of the given 3G SDI output.
3817  @param[in] inValueA Specifies the "Link A" VPID value to be embedded in the "A" link output signal.
3818  @param[in] inValueB Specifies the "Link B" VPID value to be embedded in the "B" link output signal.
3819  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3820  Defaults to zero, the first SDI output connector.
3821  @return True if successful; otherwise false.
3822  */
3823  AJA_VIRTUAL bool SetSDIOutVPID (const ULWord inValueA, const ULWord inValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3824 
3825  /*
3826  @brief Answers with the VPID payload value(s) that are currently being embedded for each link of the given 3G SDI output.
3827  @param[out] outValueA Receives the VPID payload value currently being embedded in the "A" link output signal.
3828  @param[out] outValueB Receives the VPID payload value currently being embedded in the "B" link output signal.
3829  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3830  Defaults to zero, the first SDI output connector.
3831  @return True if successful; otherwise false.
3832  */
3833  AJA_VIRTUAL bool GetSDIOutVPID (ULWord & outValueA, ULWord & outValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3834 
3835  /*
3836  @brief Reads the latest received VPID payload value(s) for each link of the given SDI input.
3837  @param[in] inSDIInput Specifies the 3G SDI input connector as an ::NTV2Channel, a zero-based index value.
3838  @param[out] outValueA Receives the "Link A" VPID payload value -- or zero if VPID was not present.
3839  @param[out] outValueB Receives the "Link B" VPID payload value -- or zero if VPID was not present.
3840  @return True if successful; otherwise false.
3841  */
3842  AJA_VIRTUAL bool ReadSDIInVPID (const NTV2Channel inSDIInput, ULWord & outValueA, ULWord & outValueB);
3843 
3848  AJA_VIRTUAL bool GetVPIDValidA (const NTV2Channel inChannel);
3849 
3854  AJA_VIRTUAL bool GetVPIDValidB (const NTV2Channel inChannel);
3856 
3863  AJA_VIRTUAL bool SetSDIOutputStandard (const UWord inOutputSpigot, const NTV2Standard inValue);
3864 
3872  AJA_VIRTUAL bool SetSDIOutputStandard (const NTV2ChannelSet & inSDIOutputs, const NTV2Standard inValue); // New in SDK v16.0
3873 
3880  AJA_VIRTUAL bool GetSDIOutputStandard (const UWord inOutputSpigot, NTV2Standard & outValue);
3881 
3882 
3886  AJA_VIRTUAL bool SetUpConvertMode (const NTV2UpConvertMode inValue);
3888  AJA_VIRTUAL bool GetUpConvertMode (NTV2UpConvertMode & outValue);
3889  AJA_VIRTUAL bool SetConverterOutStandard (const NTV2Standard inValue);
3890  AJA_VIRTUAL bool GetConverterOutStandard (NTV2Standard & outValue);
3891  AJA_VIRTUAL bool SetConverterOutRate (const NTV2FrameRate inValue);
3892  AJA_VIRTUAL bool GetConverterOutRate (NTV2FrameRate & outValue);
3893  AJA_VIRTUAL bool SetConverterInStandard (const NTV2Standard inValue);
3894  AJA_VIRTUAL bool GetConverterInStandard (NTV2Standard & outValue);
3895  AJA_VIRTUAL bool SetConverterInRate (const NTV2FrameRate inValue);
3896  AJA_VIRTUAL bool GetConverterInRate (NTV2FrameRate & outValue);
3897  AJA_VIRTUAL bool SetConverterPulldown (const ULWord inValue);
3898  AJA_VIRTUAL bool GetConverterPulldown (ULWord & outValue);
3899  AJA_VIRTUAL bool SetUCPassLine21 (const ULWord inValue);
3900  AJA_VIRTUAL bool GetUCPassLine21 (ULWord & outValue);
3901  AJA_VIRTUAL bool SetUCAutoLine21 (const ULWord inValue);
3902  AJA_VIRTUAL bool GetUCAutoLine21 (ULWord & outValue);
3903 
3904  AJA_VIRTUAL bool SetDownConvertMode (const NTV2DownConvertMode inValue);
3905  AJA_VIRTUAL bool GetDownConvertMode (NTV2DownConvertMode & outValue);
3906  AJA_VIRTUAL bool SetIsoConvertMode (const NTV2IsoConvertMode inValue);
3907  AJA_VIRTUAL bool GetIsoConvertMode (NTV2IsoConvertMode & outValue);
3908  AJA_VIRTUAL bool SetEnableConverter (const bool inValue);
3909  AJA_VIRTUAL bool GetEnableConverter (bool & outValue);
3910  AJA_VIRTUAL bool SetDeinterlaceMode (const ULWord inValue);
3911  AJA_VIRTUAL bool GetDeinterlaceMode (ULWord & outValue);
3912 
3913  AJA_VIRTUAL bool SetConversionMode (const NTV2ConversionMode inConversionMode);
3914  AJA_VIRTUAL bool GetConversionMode (NTV2ConversionMode & outConversionMode);
3916 
3920 
3930  AJA_VIRTUAL bool SetColorSpaceMethod (const NTV2ColorSpaceMethod inCSCMethod, const NTV2Channel inChannel);
3931 
3940  AJA_VIRTUAL bool GetColorSpaceMethod (NTV2ColorSpaceMethod & outMethod, const NTV2Channel inChannel = NTV2_CHANNEL1);
3941 
3950  AJA_VIRTUAL bool SetColorSpaceMatrixSelect (const NTV2ColorSpaceMatrixType inType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3951 
3960  AJA_VIRTUAL bool GetColorSpaceMatrixSelect (NTV2ColorSpaceMatrixType & outType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3961 
3971  AJA_VIRTUAL bool DownloadLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3972  const NTV2Channel inLUT, const int inBank);
3973  AJA_VIRTUAL bool Download12BitLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3974  const NTV2Channel inLUT, const int inBank);
3975 
3985  AJA_VIRTUAL bool DownloadLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3986  const NTV2Channel inLUT, const int inBank);
3987  AJA_VIRTUAL bool Download12BitLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3988  const NTV2Channel inLUT, const int inBank);
3989 
3997  AJA_VIRTUAL bool SetLUTEnable (const bool inEnable, const NTV2Channel inLUT);
3998 
3999  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, NTV2DoubleArray & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
4000  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, UWordSequence & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
4001 
4011  AJA_VIRTUAL bool LoadLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
4012  AJA_VIRTUAL bool Load12BitLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
4013 
4023  AJA_VIRTUAL bool WriteLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
4024  AJA_VIRTUAL bool Write12BitLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
4025 
4035  AJA_VIRTUAL bool GetLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
4036  AJA_VIRTUAL bool Get12BitLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
4037 
4047  AJA_VIRTUAL bool ReadLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
4048  AJA_VIRTUAL bool Read12BitLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
4049 
4050  AJA_VIRTUAL bool SetLUTV2HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4051  AJA_VIRTUAL bool GetLUTV2HostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel);
4052 
4053  AJA_VIRTUAL bool SetLUTV3HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4054  AJA_VIRTUAL bool GetLUTV3HostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel);
4055 
4056  AJA_VIRTUAL bool SetLUTV2OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4057  AJA_VIRTUAL bool GetLUTV2OutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4058 
4059  AJA_VIRTUAL bool SetLUTV3OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4060  AJA_VIRTUAL bool GetLUTV3OutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4061 
4062  AJA_VIRTUAL bool Has12BitLUTSupport (const NTV2Channel inChannel = NTV2_CHANNEL1);
4063 
4069  AJA_VIRTUAL bool Set12BitLUTPlaneSelect (const NTV2LUTPlaneSelect inLUTPlane, const NTV2Channel inChannel = NTV2_MAX_NUM_CHANNELS);
4070 
4076  AJA_VIRTUAL bool Get12BitLUTPlaneSelect (NTV2LUTPlaneSelect & outLUTPlane, const NTV2Channel inChannel = NTV2_MAX_NUM_CHANNELS);
4077 
4087  AJA_VIRTUAL bool SetColorSpaceRGBBlackRange (const NTV2_CSC_RGB_Range inRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4088 
4098  AJA_VIRTUAL bool GetColorSpaceRGBBlackRange (NTV2_CSC_RGB_Range & outRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4099 
4100  AJA_VIRTUAL bool SetColorSpaceUseCustomCoefficient (const ULWord inUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4101  AJA_VIRTUAL bool GetColorSpaceUseCustomCoefficient (ULWord & outUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4102 
4113  AJA_VIRTUAL bool SetColorSpaceMakeAlphaFromKey (const bool inMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4114 
4125  AJA_VIRTUAL bool GetColorSpaceMakeAlphaFromKey (ULWord & outMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4126 
4142  AJA_VIRTUAL bool GetColorSpaceVideoKeySyncFail (bool & outVideoKeySyncFail, const NTV2Channel inChannel = NTV2_CHANNEL1);
4143 
4144  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4145  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4146 
4147  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients12Bit (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4148  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients12Bit (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4149 
4150  AJA_VIRTUAL bool SetLUTControlSelect (const NTV2LUTControlSelect inLUTSelect);
4151  AJA_VIRTUAL bool GetLUTControlSelect (NTV2LUTControlSelect & outLUTSelect);
4152 
4153  //
4154  // Color Correction Functions (KHD only )
4155  //
4156  AJA_VIRTUAL bool SetColorCorrectionMode(const NTV2Channel inChannel, const NTV2ColorCorrectionMode inMode);
4157  AJA_VIRTUAL bool GetColorCorrectionMode(const NTV2Channel inChannel, NTV2ColorCorrectionMode & outMode);
4158 
4166  AJA_VIRTUAL bool SetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4167 
4175  AJA_VIRTUAL bool GetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4176 
4177  AJA_VIRTUAL bool SetColorCorrectionHostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4178  AJA_VIRTUAL bool GetColorCorrectionHostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4179 
4180  AJA_VIRTUAL bool SetColorCorrectionSaturation (const NTV2Channel inChannel, const ULWord inValue);
4181  AJA_VIRTUAL bool GetColorCorrectionSaturation (const NTV2Channel inChannel, ULWord & outValue);
4182 
4183  AJA_VIRTUAL bool SetDitherFor8BitInputs (const NTV2Channel inChannel, const ULWord inDither);
4184  AJA_VIRTUAL bool GetDitherFor8BitInputs (const NTV2Channel inChannel, ULWord & outDither);
4185 
4186  // Old APIs
4187  static NTV2_SHOULD_BE_DEPRECATED(bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, double * pOutTable));
4188  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(NTV2ColorSpaceMethod GetColorSpaceMethod (const NTV2Channel inChannel));
4189  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool DownloadLUTToHW(const double * pInTable, const NTV2Channel inChannel, const int inBank));
4190  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool LoadLUTTable (const double * pInTable));
4192 
4193 
4194  AJA_VIRTUAL bool SetSecondaryVideoFormat(NTV2VideoFormat inFormat); // RETAIL USE ONLY
4195  AJA_VIRTUAL bool GetSecondaryVideoFormat(NTV2VideoFormat & outFormat); // RETAIL USE ONLY
4196 
4197  #if !defined(R2_DEPRECATE)
4198  AJA_VIRTUAL bool SetInputVideoSelect (NTV2InputVideoSelect inInputSelect); // RETAIL USE ONLY
4199  AJA_VIRTUAL bool GetInputVideoSelect(NTV2InputVideoSelect & outInputSelect); // RETAIL USE ONLY
4200  #endif
4201 
4202  // --------------------------------------------
4203  // GetNTV2VideoFormat functions
4204  // @deprecated These static functions don't work correctly, and will be deprecated.
4205  // For a given frame rate, geometry and transport, there may be 2 (or more!) possible matching video formats.
4206  // The improved GetNTV2VideoFormat function may return a new CNTV2SDIVideoInfo object that can be interrogated about many things.
4207  // @note This function originated in CNTV2Status.
4208  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, UByte inputGeometry, bool progressiveTransport, bool isThreeG, bool progressivePicture=false);
4209  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=false, bool isSquareDivision = true);
4210  // --------------------------------------------
4211 
4212 public:
4224  AJA_VIRTUAL NTV2VideoFormat GetInputVideoFormat (const NTV2InputSource inVideoSource = NTV2_INPUTSOURCE_SDI1, const bool inIsProgressive = false);
4225 
4237  AJA_VIRTUAL NTV2VideoFormat GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive = false);
4238 
4244  AJA_VIRTUAL NTV2VideoFormat GetHDMIInputVideoFormat (NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4245 
4250  AJA_VIRTUAL NTV2VideoFormat GetAnalogInputVideoFormat (void);
4251 
4256  AJA_VIRTUAL NTV2VideoFormat GetAnalogCompositeInputVideoFormat (void);
4257 
4267  AJA_VIRTUAL NTV2VideoFormat GetReferenceVideoFormat (void);
4268 
4269  AJA_VIRTUAL NTV2FrameRate GetSDIInputRate (const NTV2Channel channel);
4270  AJA_VIRTUAL NTV2FrameGeometry GetSDIInputGeometry (const NTV2Channel channel);
4271  AJA_VIRTUAL bool GetSDIInputIsProgressive (const NTV2Channel channel);
4272 
4273  AJA_VIRTUAL bool GetSDIInput3GPresent (bool & outValue, const NTV2Channel channel);
4274  AJA_VIRTUAL bool GetSDIInput3GbPresent (bool & outValue, const NTV2Channel channel);
4275  AJA_VIRTUAL bool GetSDIInput6GPresent (bool & outValue, const NTV2Channel channel);
4276  AJA_VIRTUAL bool GetSDIInput12GPresent (bool & outValue, const NTV2Channel channel);
4277 
4281 
4291  AJA_VIRTUAL bool GetConnectedOutput (const NTV2InputCrosspointID inInputXpt, NTV2OutputCrosspointID & outOutputXpt);
4292 
4302  AJA_VIRTUAL bool GetConnectedInput (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointID & outInputXpt);
4303 
4312  AJA_VIRTUAL bool GetConnectedInputs (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointIDSet & outInputXpts); // New in SDK 15.5
4313 
4325  AJA_VIRTUAL bool Connect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, const bool inValidate = false);
4326 
4336  AJA_VIRTUAL bool Connect (const NTV2XptConnection & inConnection, const bool inValidate = false);
4337 
4344  AJA_VIRTUAL bool Disconnect (const NTV2InputCrosspointID inInputXpt);
4345 
4354  AJA_VIRTUAL bool IsConnected (const NTV2InputCrosspointID inInputXpt, bool & outIsConnected);
4355 
4365  AJA_VIRTUAL bool IsConnected (const NTV2XptConnection inConnection, bool & outIsConnected);
4366 
4375  AJA_VIRTUAL bool IsConnectedTo (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outIsConnected);
4376 
4386  AJA_VIRTUAL bool CanConnect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outCanConnect);
4387 
4396  AJA_VIRTUAL bool CanConnect (const NTV2XptConnection & inConnection, bool & outCanConnect);
4397 
4406  AJA_VIRTUAL bool SupportedOutputXptsForInputXpt (const NTV2InputXptID inInputXptID, NTV2OutputXptIDSet & outOutputXpts);
4407 
4408 
4427  AJA_VIRTUAL bool ApplySignalRoute (const CNTV2SignalRouter & inRouter, const bool inReplace = false);
4428 
4429 
4448  AJA_VIRTUAL bool ApplySignalRoute (const NTV2XptConnections & inConnections, const bool inReplace = false);
4449 
4456  AJA_VIRTUAL bool RemoveConnections (const NTV2XptConnections & inConnections);
4457 
4465  AJA_VIRTUAL bool ClearRouting (void);
4466 
4473  AJA_VIRTUAL bool GetRouting (CNTV2SignalRouter & outRouting);
4474 
4481  AJA_VIRTUAL bool GetConnections (NTV2XptConnections & outConnections); // New in SDK 16.0
4482 
4490  AJA_VIRTUAL bool GetRoutingForChannel (const NTV2Channel inChannel, CNTV2SignalRouter & outRouting);
4491 
4492 #if !defined(NTV2_DEPRECATE_17_0)
4494 #endif // !defined(NTV2_DEPRECATE_17_0)
4495 
4500  AJA_VIRTUAL bool GetPossibleConnections (NTV2PossibleConnections & outConnections);
4501 
4507  AJA_VIRTUAL bool GetAllWidgetInputs (NTV2InputXptIDSet & outInputs); // New in SDK 17.6
4508 
4514  AJA_VIRTUAL bool GetAllWidgetOutputs (NTV2OutputXptIDSet & outOutputs); // New in SDK 17.6
4516 
4517 
4522  AJA_VIRTUAL bool WriteSDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4524  AJA_VIRTUAL bool WriteSDBrightnessAdjustment (const ULWord inNewValue);
4525  AJA_VIRTUAL bool WriteSDContrastAdjustment (const ULWord inNewValue);
4526  AJA_VIRTUAL bool WriteSDSaturationAdjustment (const ULWord inNewValue);
4527  AJA_VIRTUAL bool WriteSDHueAdjustment (const ULWord inNewValue);
4528  AJA_VIRTUAL bool WriteSDCbOffsetAdjustment (const ULWord inNewValue);
4529  AJA_VIRTUAL bool WriteSDCrOffsetAdjustment (const ULWord inNewValue);
4530  AJA_VIRTUAL bool WriteHDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4531  AJA_VIRTUAL bool WriteHDBrightnessAdjustment (const ULWord inNewValue);
4532  AJA_VIRTUAL bool WriteHDContrastAdjustment (const ULWord inNewValue);
4533  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCb (const ULWord inNewValue);
4534  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCr (const ULWord inNewValue);
4535  AJA_VIRTUAL bool WriteHDCbOffsetAdjustment (const ULWord inNewValue);
4536  AJA_VIRTUAL bool WriteHDCrOffsetAdjustment (const ULWord inNewValue);
4537 
4538  AJA_VIRTUAL bool ReadSDProcAmpControlsInitialized (ULWord & outValue);
4539  AJA_VIRTUAL bool ReadSDBrightnessAdjustment (ULWord & outValue);
4540  AJA_VIRTUAL bool ReadSDContrastAdjustment (ULWord & outValue);
4541  AJA_VIRTUAL bool ReadSDSaturationAdjustment (ULWord & outValue);
4542  AJA_VIRTUAL bool ReadSDHueAdjustment (ULWord & outValue);
4543  AJA_VIRTUAL bool ReadSDCbOffsetAdjustment (ULWord & outValue);
4544  AJA_VIRTUAL bool ReadSDCrOffsetAdjustment (ULWord & outValue);
4545  AJA_VIRTUAL bool ReadHDProcAmpControlsInitialized (ULWord & outValue);
4546  AJA_VIRTUAL bool ReadHDBrightnessAdjustment (ULWord & outValue);
4547  AJA_VIRTUAL bool ReadHDContrastAdjustment (ULWord & outValue);
4548  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCb (ULWord & outValue);
4549  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCr (ULWord & outValue);
4550  AJA_VIRTUAL bool ReadHDCbOffsetAdjustment (ULWord & outValue);
4551  AJA_VIRTUAL bool ReadHDCrOffsetAdjustment (ULWord & outValue);
4552 
4553  // FS1 (and other?) ProcAmp methods
4554  AJA_VIRTUAL bool WriteProcAmpC1YAdjustment (const ULWord inNewValue);
4555  AJA_VIRTUAL bool WriteProcAmpC1CBAdjustment (const ULWord inNewValue);
4556  AJA_VIRTUAL bool WriteProcAmpC1CRAdjustment (const ULWord inNewValue);
4557  AJA_VIRTUAL bool WriteProcAmpC2CBAdjustment (const ULWord inNewValue);
4558  AJA_VIRTUAL bool WriteProcAmpC2CRAdjustment (const ULWord inNewValue);
4559  AJA_VIRTUAL bool WriteProcAmpOffsetYAdjustment (const ULWord inNewValue);
4560  AJA_VIRTUAL bool ReadProcAmpC1YAdjustment (ULWord & outValue);
4561  AJA_VIRTUAL bool ReadProcAmpC1CBAdjustment (ULWord & outValue);
4562  AJA_VIRTUAL bool ReadProcAmpC1CRAdjustment (ULWord & outValue);
4563  AJA_VIRTUAL bool ReadProcAmpC2CBAdjustment (ULWord & outValue);
4564  AJA_VIRTUAL bool ReadProcAmpC2CRAdjustment (ULWord & outValue);
4565  AJA_VIRTUAL bool ReadProcAmpOffsetYAdjustment (ULWord & outValue);
4566 
4567  #if !defined(R2_DEPRECATE)
4568  AJA_VIRTUAL bool SetAnalogInputADCMode (const NTV2LSVideoADCMode inValue);
4569  AJA_VIRTUAL bool GetAnalogInputADCMode (NTV2LSVideoADCMode & outValue);
4570  #endif
4571 
4573 
4577 
4584  AJA_VIRTUAL bool GetHDMIInputColor (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4585 
4592  AJA_VIRTUAL bool SetHDMIInputRange (const NTV2HDMIRange inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4593 
4600  AJA_VIRTUAL bool GetHDMIInputRange (NTV2HDMIRange & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4601 
4608  AJA_VIRTUAL bool GetHDMIInputAudioChannels (NTV2HDMIAudioChannels & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4609 
4616  AJA_VIRTUAL bool SetHDMIInColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4617 
4624  AJA_VIRTUAL bool GetHDMIInColorSpace (NTV2HDMIColorSpace & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4625 
4632  AJA_VIRTUAL bool GetHDMIInProtocol (NTV2HDMIProtocol & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4633 
4640  AJA_VIRTUAL bool GetHDMIInIsLocked (bool & outIsLocked, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4641 
4642  AJA_VIRTUAL bool SetHDMIInAudioSampleRateConverterEnable (const bool inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4643  AJA_VIRTUAL bool GetHDMIInAudioSampleRateConverterEnable (bool & outIsEnabled, const NTV2Channel inChannel = NTV2_CHANNEL1);
4644 
4651  AJA_VIRTUAL bool SetHDMIInBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4652 
4659  AJA_VIRTUAL bool GetHDMIInBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4660 
4668  AJA_VIRTUAL bool GetHDMIInAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4669 
4677  AJA_VIRTUAL bool SetHDMIInAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4678 
4679 
4686  AJA_VIRTUAL bool GetHDMIInVideoRange (NTV2HDMIRange & outValue, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4687 
4694  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRRegValues & outRegValues, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4695 
4702  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRFloatValues & outFloatValues, const NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4703 
4710  AJA_VIRTUAL bool GetHDMIInColorimetry (NTV2HDMIColorimetry & outColorimetry, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4711 
4718  AJA_VIRTUAL bool GetHDMIInDolbyVision (bool & outIsDetected, const NTV2Channel inHDMIInput = NTV2_CHANNEL1); // New in SDK v16.0
4719 
4720  AJA_VIRTUAL bool SetHDMIOut3DPresent (const bool inIs3DPresent);
4721  AJA_VIRTUAL bool GetHDMIOut3DPresent (bool & outIs3DPresent);
4722 
4723  AJA_VIRTUAL bool SetHDMIOut3DMode (const NTV2HDMIOut3DMode inValue);
4724  AJA_VIRTUAL bool GetHDMIOut3DMode (NTV2HDMIOut3DMode & outValue);
4725 
4726  AJA_VIRTUAL bool SetHDMIV2TxBypass (const bool inBypass);
4727 
4735  AJA_VIRTUAL bool SetHDMIOutVideoStandard (const NTV2Standard inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4743  AJA_VIRTUAL bool GetHDMIOutVideoStandard (NTV2Standard & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4744 
4752  AJA_VIRTUAL bool SetHDMIOutSampleStructure (const NTV2HDMISampleStructure inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4760  AJA_VIRTUAL bool GetHDMIOutSampleStructure (NTV2HDMISampleStructure & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4761 
4769  AJA_VIRTUAL bool SetHDMIOutVideoFPS (const NTV2FrameRate inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4777  AJA_VIRTUAL bool GetHDMIOutVideoFPS (NTV2FrameRate & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4778 
4786  AJA_VIRTUAL bool SetHDMIOutRange (const NTV2HDMIRange inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4794  AJA_VIRTUAL bool GetHDMIOutRange (NTV2HDMIRange & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4795 
4803  AJA_VIRTUAL bool SetHDMIOutAudioChannels (const NTV2HDMIAudioChannels inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4811  AJA_VIRTUAL bool GetHDMIOutAudioChannels (NTV2HDMIAudioChannels & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4812 
4813  AJA_VIRTUAL bool SetHDMIOutColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4814  AJA_VIRTUAL bool GetHDMIOutColorSpace (NTV2HDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4822  AJA_VIRTUAL bool SetLHIHDMIOutColorSpace (const NTV2LHIHDMIColorSpace inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4830  AJA_VIRTUAL bool GetLHIHDMIOutColorSpace (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4831 
4839  AJA_VIRTUAL bool SetHDMIOutBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4847  AJA_VIRTUAL bool GetHDMIOutBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4848 
4856  AJA_VIRTUAL bool SetHDMIOutProtocol (const NTV2HDMIProtocol inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4864  AJA_VIRTUAL bool GetHDMIOutProtocol (NTV2HDMIProtocol & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4865 
4866  AJA_VIRTUAL bool SetHDMIOutForceConfig (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4867  AJA_VIRTUAL bool GetHDMIOutForceConfig (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4868  AJA_VIRTUAL bool SetHDMIOutDisable (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4869  AJA_VIRTUAL bool GetHDMIOutDisable (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4870 
4878  AJA_VIRTUAL bool SetHDMIOutPrefer420 (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4886  AJA_VIRTUAL bool GetHDMIOutPrefer420 (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4887 
4895  AJA_VIRTUAL bool SetHDMIOutForceYUV (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4903  AJA_VIRTUAL bool GetHDMIOutForceYUV (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4904 
4912  AJA_VIRTUAL bool SetHDMIOutForceRGB (const bool inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4920  AJA_VIRTUAL bool GetHDMIOutForceRGB (bool & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4921 
4929  AJA_VIRTUAL bool GetHDMIOutDownstreamBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4930 
4938  AJA_VIRTUAL bool GetHDMIOutDownstreamColorSpace (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4939 
4948  AJA_VIRTUAL bool SetHDMIOutAudioSource2Channel (const NTV2AudioChannelPair inNewValue,
4949  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1,
4950  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4951 
4960  AJA_VIRTUAL bool GetHDMIOutAudioSource2Channel (NTV2AudioChannelPair & outValue,
4961  NTV2AudioSystem & outAudioSystem,
4962  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4963 
4972  AJA_VIRTUAL bool SetHDMIOutAudioSource8Channel (const NTV2Audio8ChannelSelect inNewValue,
4973  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1,
4974  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4975 
4984  AJA_VIRTUAL bool GetHDMIOutAudioSource8Channel (NTV2Audio8ChannelSelect & outValue,
4985  NTV2AudioSystem & outAudioSystem,
4986  const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
4987 
4996  AJA_VIRTUAL bool GetHDMIOutAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
4997 
5006  AJA_VIRTUAL bool SetHDMIOutAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
5007 
5015  AJA_VIRTUAL bool SetHDMIOutAudioRate (const NTV2AudioRate inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5016 
5024  AJA_VIRTUAL bool GetHDMIOutAudioRate (NTV2AudioRate & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5025 
5033  AJA_VIRTUAL bool SetHDMIOutAudioFormat (const NTV2AudioFormat inNewValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5034 
5042  AJA_VIRTUAL bool GetHDMIOutAudioFormat (NTV2AudioFormat & outValue, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5043 
5051  AJA_VIRTUAL bool EnableHDMIOutUserOverride (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5052 
5060  AJA_VIRTUAL bool GetEnableHDMIOutUserOverride (bool & outIsEnabled, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5061 
5069  AJA_VIRTUAL bool EnableHDMIOutCenterCrop (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5070 
5078  AJA_VIRTUAL bool GetEnableHDMIOutCenterCrop (bool & outIsEnabled, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
5079 
5087  AJA_VIRTUAL bool SetHDMIOutDecimateMode (const bool inEnable);
5088 
5089  AJA_VIRTUAL bool GetHDMIOutDecimateMode (bool & outIsEnabled);
5090 
5096  AJA_VIRTUAL bool SetHDMIOutTsiIO (const bool inTsiEnable);
5097 
5098  AJA_VIRTUAL bool GetHDMIOutTsiIO (bool & tsiEnabled);
5099 
5105  AJA_VIRTUAL bool SetHDMIOutLevelBMode (const bool inEnable);
5106 
5107  AJA_VIRTUAL bool GetHDMIOutLevelBMode (bool & outIsEnabled);
5108 
5118  AJA_VIRTUAL bool SetHDMIV2Mode (const NTV2HDMIV2Mode inMode);
5119 
5125  AJA_VIRTUAL bool GetHDMIV2Mode (NTV2HDMIV2Mode & outMode);
5126 
5127 
5135  AJA_VIRTUAL bool GetHDMIOutStatus (NTV2HDMIOutputStatus & outStatus, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 16.1
5136 
5137  //protected: SHOULD BE PROTECTED/PRIVATE:
5138  AJA_VIRTUAL bool GetHDMIInputStatus (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
5139  protected:
5140  AJA_VIRTUAL bool GetHDMIInputStatusRegNum (ULWord & outRegNum, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
5141 
5143  public:
5144  AJA_VIRTUAL bool SetLHIVideoDACStandard (const NTV2Standard inValue);
5145  AJA_VIRTUAL bool GetLHIVideoDACStandard (NTV2Standard & outValue);
5146  AJA_VIRTUAL bool SetLHIVideoDACMode (NTV2LHIVideoDACMode value);
5147  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2LHIVideoDACMode & outValue);
5148  AJA_VIRTUAL bool SetLHIVideoDACMode (const NTV2VideoDACMode inValue); // overloaded
5149  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2VideoDACMode & outValue); // overloaded
5150 
5154 
5165  AJA_VIRTUAL bool SetLTCInputEnable (const bool inEnable);
5166 
5177  AJA_VIRTUAL bool GetLTCInputEnable (bool & outIsEnabled);
5178 
5189  AJA_VIRTUAL bool GetLTCInputPresent (bool & outIsPresent, const UWord inLTCInputNdx = 0);
5190 
5200  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, RP188_STRUCT & outRP188Data);
5201 
5211  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, NTV2_RP188 & outRP188Data);
5212 
5223  AJA_VIRTUAL bool GetAnalogLTCInClockChannel (const UWord inLTCInput, NTV2Channel & outChannel);
5224 
5235  AJA_VIRTUAL bool SetAnalogLTCInClockChannel (const UWord inLTCInput, const NTV2Channel inChannel);
5236 
5246  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const RP188_STRUCT & inRP188Data);
5247 
5257  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const NTV2_RP188 & inRP188Data);
5258 
5269  AJA_VIRTUAL bool GetAnalogLTCOutClockChannel (const UWord inLTCOutput, NTV2Channel & outChannel);
5270 
5281  AJA_VIRTUAL bool SetAnalogLTCOutClockChannel (const UWord inLTCOutput, const NTV2Channel inChannel);
5282 
5283 #if !defined(NTV2_DEPRECATE_16_3)
5284  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool SetLTCOnReference(bool val)) {return SetLTCInputEnable(val);}
5285  AJA_VIRTUAL inline NTV2_DEPRECATED_16_3(bool GetLTCOnReference(bool & outVal)) {return GetLTCInputEnable(outVal);}
5286  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool SetLTCEmbeddedOutEnable (const bool inNewValue));
5287  AJA_VIRTUAL NTV2_DEPRECATED_16_3(bool GetLTCEmbeddedOutEnable (bool & outValue));
5288 #endif // !defined(NTV2_DEPRECATE_16_3)
5289 
5294  AJA_VIRTUAL bool SetStereoCompressorOutputMode (const NTV2StereoCompressorOutputMode inNewValue);
5296  AJA_VIRTUAL bool GetStereoCompressorOutputMode (NTV2StereoCompressorOutputMode & outValue);
5297  AJA_VIRTUAL bool SetStereoCompressorFlipMode (const ULWord inNewValue);
5298  AJA_VIRTUAL bool GetStereoCompressorFlipMode (ULWord & outValue);
5299  AJA_VIRTUAL bool SetStereoCompressorFlipLeftHorz (const ULWord inNewValue);
5300  AJA_VIRTUAL bool GetStereoCompressorFlipLeftHorz (ULWord & outValue);
5301  AJA_VIRTUAL bool SetStereoCompressorFlipLeftVert (const ULWord inNewValue);
5302  AJA_VIRTUAL bool GetStereoCompressorFlipLeftVert (ULWord & outValue);
5303  AJA_VIRTUAL bool SetStereoCompressorFlipRightHorz (const ULWord inNewValue);
5304  AJA_VIRTUAL bool GetStereoCompressorFlipRightHorz (ULWord & outValue);
5305  AJA_VIRTUAL bool SetStereoCompressorFlipRightVert (const ULWord inNewValue);
5306  AJA_VIRTUAL bool GetStereoCompressorFlipRightVert (ULWord & outValue);
5307  AJA_VIRTUAL bool SetStereoCompressorStandard (const NTV2Standard inNewValue);
5308  AJA_VIRTUAL bool GetStereoCompressorStandard (NTV2Standard & outValue);
5309  AJA_VIRTUAL bool SetStereoCompressorLeftSource (const NTV2OutputCrosspointID inNewValue);
5310  AJA_VIRTUAL bool GetStereoCompressorLeftSource (NTV2OutputCrosspointID & outValue);
5311  AJA_VIRTUAL bool SetStereoCompressorRightSource (const NTV2OutputCrosspointID inNewValue);
5312  AJA_VIRTUAL bool GetStereoCompressorRightSource (NTV2OutputCrosspointID & outValue);
5314 
5318 
5331  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2Channel inChannel, const bool inEnable);
5332 
5345  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2ChannelSet & inSDIConnectors, const bool inEnable);
5346 
5356  AJA_VIRTUAL bool GetSDITransmitEnable (const NTV2Channel inChannel, bool & outEnabled);
5357 
5367  AJA_VIRTUAL bool GetTransmitSDIs (NTV2ChannelSet & outXmitSDIs); // New in SDK 17.0
5369 
5370  AJA_VIRTUAL bool SetSDIOut2Kx1080Enable (const NTV2Channel inChannel, const bool inIsEnabled);
5371  AJA_VIRTUAL bool GetSDIOut2Kx1080Enable (const NTV2Channel inChannel, bool & outIsEnabled);
5372 
5373  AJA_VIRTUAL bool SetSDIOut3GEnable (const NTV2Channel inChannel,const bool inEnable);
5374  AJA_VIRTUAL bool GetSDIOut3GEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5375 
5376  AJA_VIRTUAL bool SetSDIOut3GbEnable (const NTV2Channel inChannel, const bool inEnable);
5377  AJA_VIRTUAL bool GetSDIOut3GbEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5378 
5379  AJA_VIRTUAL bool SetSDIOut6GEnable(const NTV2Channel inChannel, const bool inEnable);
5380  AJA_VIRTUAL bool GetSDIOut6GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5381 
5382  AJA_VIRTUAL bool SetSDIOut12GEnable(const NTV2Channel inChannel, const bool inEnable);
5383  AJA_VIRTUAL bool GetSDIOut12GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5384 
5397  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5398 
5412  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2ChannelSet & inSDIOutputs, const NTV2AudioSystem inAudioSystem, const bool inDS2 = false); // New in SDK 16.2
5413 
5424  AJA_VIRTUAL bool GetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5425 
5437  AJA_VIRTUAL bool SetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5438 
5450  AJA_VIRTUAL bool GetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5451 
5461  AJA_VIRTUAL bool GetSDIOutputAudioEnabled (const NTV2Channel inSDIOutput, bool & outIsEnabled); // New in SDK 17.5
5462 
5473  AJA_VIRTUAL bool SetSDIOutputAudioEnabled (const NTV2Channel inSDIOutput, const bool & inEnable); // New in SDK 17.5
5474 
5475 
5479 
5489  AJA_VIRTUAL bool GetSDIRelayPosition (NTV2RelayState & outValue, const UWord inIndex0);
5490 
5501  AJA_VIRTUAL bool GetSDIRelayManualControl (NTV2RelayState & outValue, const UWord inIndex0);
5502 
5514  AJA_VIRTUAL bool SetSDIRelayManualControl (const NTV2RelayState inValue, const UWord inIndex0);
5515 
5525  AJA_VIRTUAL bool GetSDIWatchdogEnable (bool & outIsEnabled, const UWord inIndex0);
5526 
5540  AJA_VIRTUAL bool SetSDIWatchdogEnable (const bool inEnable, const UWord inIndex0);
5541 
5549  AJA_VIRTUAL bool GetSDIWatchdogStatus (NTV2RelayState & outValue);
5550 
5557  AJA_VIRTUAL bool GetSDIWatchdogTimeout (ULWord & outValue);
5558 
5567  AJA_VIRTUAL bool SetSDIWatchdogTimeout (const ULWord inValue);
5568 
5573  AJA_VIRTUAL bool KickSDIWatchdog (void);
5575 
5579 
5586  AJA_VIRTUAL bool Enable4KDCRGBMode(bool inEnable);
5587 
5588  AJA_VIRTUAL bool GetEnable4KDCRGBMode(bool & outIsEnabled);
5589 
5596  AJA_VIRTUAL bool Enable4KDCYCC444Mode(bool inEnable);
5597 
5598  AJA_VIRTUAL bool GetEnable4KDCYCC444Mode(bool & outIsEnabled);
5599 
5606  AJA_VIRTUAL bool Enable4KDCPSFInMode(bool inEnable);
5607 
5608  AJA_VIRTUAL bool GetEnable4KDCPSFInMode(bool & outIsEnabled);
5609 
5616  AJA_VIRTUAL bool Enable4KPSFOutMode(bool inEnable);
5617 
5618  AJA_VIRTUAL bool GetEnable4KPSFOutMode(bool & outIsEnabled);
5620 
5621 
5630  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const NTV2ChannelSet & inSDIInputs, const bool inEnable);
5631 
5639  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, const bool inEnable);
5640 
5647  AJA_VIRTUAL bool GetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, bool & outIsEnabled);
5648 
5656  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, const bool inEnable);
5657 
5666  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5667 
5674  AJA_VIRTUAL bool GetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5675 
5682  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, const bool inEnable);
5683 
5692  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5693 
5700  AJA_VIRTUAL bool GetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5701 
5702 
5706 
5711  AJA_VIRTUAL bool GetSDITRSError (const NTV2Channel inChannel);
5712 
5718  AJA_VIRTUAL bool GetSDILock (const NTV2Channel inChannel);
5719 
5725  AJA_VIRTUAL ULWord GetSDIUnlockCount (const NTV2Channel inChannel);
5726 
5732  AJA_VIRTUAL ULWord GetCRCErrorCountA (const NTV2Channel inChannel);
5733 
5739  AJA_VIRTUAL ULWord GetCRCErrorCountB (const NTV2Channel inChannel);
5741 
5754  AJA_VIRTUAL NTV2_WILL_BE_DEPRECATED(bool SetMultiFormatMode (const bool inEnable));
5755 
5767  AJA_VIRTUAL NTV2_WILL_BE_DEPRECATED(bool GetMultiFormatMode (bool & outIsEnabled));
5768 
5769 
5770 public:
5774 
5786  AJA_VIRTUAL bool SetRS422Parity (const NTV2Channel inSerialPort, const NTV2_RS422_PARITY inParity);
5787 
5798  AJA_VIRTUAL bool GetRS422Parity (const NTV2Channel inSerialPort, NTV2_RS422_PARITY & outParity);
5799 
5812  AJA_VIRTUAL bool SetRS422BaudRate (const NTV2Channel inSerialPort, const NTV2_RS422_BAUD_RATE inBaudRate);
5813 
5824  AJA_VIRTUAL bool GetRS422BaudRate (const NTV2Channel inSerialPort, NTV2_RS422_BAUD_RATE & outBaudRate);
5826 
5830 
5844  AJA_VIRTUAL bool AncSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size); // New in SDK 16.0
5845 
5846 
5860  AJA_VIRTUAL bool AncInsertInit (const UWord inSDIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5861  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5862 
5875  AJA_VIRTUAL bool AncInsertSetComponents (const UWord inSDIOutput,
5876  const bool inVancY, const bool inVancC,
5877  const bool inHancY, const bool inHancC); // New in SDK 16.0
5878 
5888  AJA_VIRTUAL bool AncInsertSetEnable (const UWord inSDIOutput, const bool inIsEnabled); // New in SDK 15.0
5889 
5897  AJA_VIRTUAL bool AncInsertIsEnabled (const UWord inSDIOutput, bool & outIsEnabled); // New in SDK 15.0
5898 
5915  AJA_VIRTUAL bool AncInsertSetReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
5916  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5917  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5918 
5935  AJA_VIRTUAL bool AncInsertSetField2ReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
5936  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5937  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5938 
5947  AJA_VIRTUAL bool AncInsertSetIPParams (const UWord inSDIOutput, const UWord ancChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 15.2
5948 
5956  AJA_VIRTUAL bool AncInsertGetReadInfo (const UWord inSDIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK v16.2
5957 
5958 
5974  AJA_VIRTUAL bool AncExtractInit (const UWord inSDIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5975  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5976 
5989  AJA_VIRTUAL bool AncExtractSetComponents (const UWord inSDIInput,
5990  const bool inVancY, const bool inVancC,
5991  const bool inHancY, const bool inHancC); // New in SDK 16.0
5992 
6003  AJA_VIRTUAL bool AncExtractSetEnable (const UWord inSDIInput, const bool inIsEnabled); // New in SDK 15.0
6004 
6013  AJA_VIRTUAL bool AncExtractIsEnabled (const UWord inSDIInput, bool & outIsEnabled); // New in SDK 15.0
6014 
6031  AJA_VIRTUAL bool AncExtractSetWriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
6032  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6033  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
6034 
6051  AJA_VIRTUAL bool AncExtractSetField2WriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
6052  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6053  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
6054 
6066  AJA_VIRTUAL bool AncExtractGetWriteInfo (const UWord inSDIInput,
6067  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
6068  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK v16.2
6069 
6079  AJA_VIRTUAL bool AncExtractGetFilterDIDs (const UWord inSDIInput, NTV2DIDSet & outDIDs); // New in SDK 15.0
6080 
6091  AJA_VIRTUAL bool AncExtractSetFilterDIDs (const UWord inSDIInput, const NTV2DIDSet & inDIDs); // New in SDK 15.0
6092 
6100  AJA_VIRTUAL bool AncExtractGetField1Size (const UWord inSDIInput, ULWord & outF1Size); // New in SDK 16.0
6101 
6109  AJA_VIRTUAL bool AncExtractGetField2Size (const UWord inSDIInput, ULWord & outF2Size); // New in SDK 16.0
6110 
6124  AJA_VIRTUAL bool AncExtractGetBufferOverrun (const UWord inSDIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 15.0
6125 
6133  AJA_VIRTUAL bool AncExtractIsProgressive (const UWord inSDIInput, bool & outIsProgressive); // New in SDK 17.1
6134 
6139  static UWord AncExtractGetMaxNumFilterDIDs (void); // New in SDK 15.0
6140 
6148  static NTV2DIDSet AncExtractGetDefaultDIDs (const bool inHDAudio = true); // New in SDK 13.0
6150 
6154 
6164  AJA_VIRTUAL bool AuxSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size) // New in SDK 17.1
6165  {return IsSupported(kDeviceCanDoHDMIAuxCapture) && AncSetFrameBufferSize(inF1Size,inF2Size);}
6166 
6167 
6180  AJA_VIRTUAL bool AuxInsertInit (const UWord inHDMIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6181  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
6182 
6194  AJA_VIRTUAL bool AuxInsertSetComponents (const UWord inHDMIOutput,
6195  const bool inVauxY, const bool inVauxC,
6196  const bool inHauxY, const bool inHauxC); // New in SDK 17.1
6197 
6206  AJA_VIRTUAL bool AuxInsertSetEnable (const UWord inHDMIOutput, const bool inIsEnabled); // New in SDK 17.1
6207 
6214  AJA_VIRTUAL bool AuxInsertIsEnabled (const UWord inHDMIOutput, bool & outIsEnabled); // New in SDK 17.1
6215 
6231  AJA_VIRTUAL bool AuxInsertSetReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
6232  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6233  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6234 
6250  AJA_VIRTUAL bool AuxInsertSetField2ReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
6251  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6252  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6253 
6262  AJA_VIRTUAL bool AuxInsertSetIPParams (const UWord inHDMIOutput, const UWord auxChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 17.1
6263 
6271  AJA_VIRTUAL bool AuxInsertGetReadInfo (const UWord inHDMIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK 17.1
6272 
6273 
6288  AJA_VIRTUAL bool AuxExtractInit (const UWord inHDMIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6289  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
6299  AJA_VIRTUAL bool AuxExtractSetEnable (const UWord inHDMIInput, const bool inIsEnabled); // New in SDK 17.1
6300 
6308  AJA_VIRTUAL bool AuxExtractIsEnabled (const UWord inHDMIInput, bool & outIsEnabled); // New in SDK 17.1
6309 
6325  AJA_VIRTUAL bool AuxExtractSetWriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
6326  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6327  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6328 
6344  AJA_VIRTUAL bool AuxExtractSetField2WriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
6345  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
6346  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
6347 
6358  AJA_VIRTUAL bool AuxExtractGetWriteInfo (const UWord inHDMIInput,
6359  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
6360  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK 17.1
6361 
6369  AJA_VIRTUAL bool AuxExtractGetField1Size (const UWord inHDMIInput, ULWord & outF1Size); // New in SDK 17.1
6370 
6378  AJA_VIRTUAL bool AuxExtractGetField2Size (const UWord inHDMIInput, ULWord & outF2Size); // New in SDK 17.1
6379 
6388  AJA_VIRTUAL bool AuxExtractGetPacketFilters (const UWord inHDMIInput, NTV2DIDSet & outDIDs); // New in SDK 17.1
6389 
6399  AJA_VIRTUAL bool AuxExtractSetPacketFilters (const UWord inHDMIInput, const NTV2DIDSet & inDIDs); // New in SDK 17.1
6400 
6408  AJA_VIRTUAL bool AuxExtractSetFilterInclusionMode (const UWord inHDMIInput, const bool inEnable); // New in SDK 17.1
6409 
6417  AJA_VIRTUAL bool AuxExtractGetFilterInclusionMode (const UWord inHDMIInput, bool & outEnabled); // New in SDK 17.1
6418 
6431  AJA_VIRTUAL bool AuxExtractGetBufferOverrun (const UWord inHDMIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 17.1
6432 
6439  AJA_VIRTUAL bool AuxExtractIsProgressive (const UWord inHDMIInput, bool & outIsProgressive); // New in SDK 17.1
6440 
6445  static UWord AuxExtractGetMaxNumPacketFilters (void); // New in SDK 17.1
6446 
6451  static NTV2DIDSet AuxExtractGetDefaultPacketFilters (void); // New in SDK 17.1
6453 
6454 
6458  AJA_VIRTUAL bool AcquireMailBoxLock (void);
6460  AJA_VIRTUAL bool ReleaseMailBoxLock (void);
6461  AJA_VIRTUAL bool AbortMailBoxLock (void);
6463 
6467 
6474  AJA_VIRTUAL bool GetDieTemperature (double & outTemp, const NTV2DieTempScale inTempScale = NTV2DieTempScale_Celsius);
6475 
6481  AJA_VIRTUAL bool GetDieVoltage (double & outVoltage);
6483 
6484 public:
6488  AJA_VIRTUAL inline CNTV2DriverInterface & driverInterface (void) {return *this;} // New in SDK 17.1
6489 
6490  AJA_VIRTUAL std::string GetFPGAVersionString (const NTV2XilinxFPGA inFPGA = eFPGAVideoProc);
6491  AJA_VIRTUAL Word GetPCIFPGAVersion (void); // From CNTV2Status
6492  AJA_VIRTUAL std::string GetPCIFPGAVersionString (void);
6493 
6511  AJA_VIRTUAL bool GetInstalledBitfileInfo (ULWord & outNumBytes, std::string & outDateStr, std::string & outTimeStr);
6512 
6518  AJA_VIRTUAL std::string GetBitfileInfoString (const BITFILE_INFO_STRUCT & inBitFileInfo);
6519 
6529  AJA_VIRTUAL bool IsFailSafeBitfileLoaded (bool & outIsFailSafe);
6530 
6538  AJA_VIRTUAL bool CanWarmBootFPGA (bool & outCanWarmBoot);
6539 
6540  AJA_VIRTUAL bool IsDynamicDevice (void);
6541  AJA_VIRTUAL bool IsDynamicFirmwareLoaded(void);
6542  AJA_VIRTUAL NTV2DeviceID GetBaseDeviceID();
6543  AJA_VIRTUAL NTV2DeviceIDList GetDynamicDeviceList (void);
6544  AJA_VIRTUAL NTV2DeviceIDSet GetDynamicDeviceIDs (void);
6545 
6550  AJA_VIRTUAL bool CanLoadDynamicDevice (const NTV2DeviceID inDeviceID);
6551 
6560  AJA_VIRTUAL bool LoadDynamicDevice (const NTV2DeviceID inDeviceID);
6561 
6567  AJA_VIRTUAL bool AddDynamicBitfile (const std::string & inBitfilePath);
6568 
6575  AJA_VIRTUAL bool AddDynamicDirectory (const std::string & inDirectory);
6576 
6582  static std::string SerialNum64ToString (const uint64_t inSerialNumber);
6583 
6584  typedef enum
6585  {
6589  NUM_COLORS
6590  } ColorCorrectionColor; // From CNTV2ColorCorrection
6591 
6592 protected:
6594 
6595 public:
6596 #if !defined(NTV2_DEPRECATE_17_6)
6597  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcGetDeviceInfo (HevcDeviceInfo* pInfo)) {(void)pInfo; return false;}
6598  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;}
6599  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;}
6600  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcSendCommand (HevcDeviceCommand* pCmd)) {(void)pCmd; return false;}
6601  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcVideoTransfer (HevcDeviceTransfer* pXfer)) {(void)pXfer; return false;}
6602  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcGetStatus (HevcDeviceStatus* pStat)) {(void)pStat; return false;}
6603  AJA_VIRTUAL bool NTV2_DEPRECATED_17_6(HevcDebugInfo (HevcDeviceDebug* pDbg)) {(void)pDbg; return false;}
6604 #endif//defined(NTV2_DEPRECATE_17_6)
6605 
6609 
6615  AJA_VIRTUAL bool EnableHDMIHDR (const bool inEnableHDMIHDR, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6616  AJA_VIRTUAL bool GetHDMIHDREnabled (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6617 
6626  AJA_VIRTUAL bool EnableHDMIHDRDolbyVision (const bool inEnable, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 13.0
6627  AJA_VIRTUAL bool GetHDMIHDRDolbyVisionEnabled (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6628 
6629 
6635  AJA_VIRTUAL bool SetHDMIHDRConstantLuminance (const bool inEnableConstantLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6636  AJA_VIRTUAL bool GetHDMIHDRConstantLuminance (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1);
6637 
6643  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryX (const uint16_t inGreenPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6649  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryX (uint16_t & outGreenPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6650 
6656  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryY (const uint16_t inGreenPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6662  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryY (uint16_t & outGreenPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6663 
6669  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryX (const uint16_t inBluePrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6675  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryX (uint16_t & outBluePrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6676 
6682  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryY (const uint16_t inBluePrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6688  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryY (uint16_t & outBluePrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6689 
6695  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryX (const uint16_t inRedPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6701  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryX (uint16_t & outRedPrimaryX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6702 
6708  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryY (const uint16_t inRedPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6714  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryY (uint16_t & outRedPrimaryY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6715 
6721  AJA_VIRTUAL bool SetHDMIHDRWhitePointX (const uint16_t inWhitePointX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6727  AJA_VIRTUAL bool GetHDMIHDRWhitePointX (uint16_t & outWhitePointX, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6728 
6734  AJA_VIRTUAL bool SetHDMIHDRWhitePointY (const uint16_t inWhitePointY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6740  AJA_VIRTUAL bool GetHDMIHDRWhitePointY (uint16_t & outWhitePointY, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6741 
6747  AJA_VIRTUAL bool SetHDMIHDRMaxMasteringLuminance (const uint16_t inMaxMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6753  AJA_VIRTUAL bool GetHDMIHDRMaxMasteringLuminance (uint16_t & outMaxMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6754 
6760  AJA_VIRTUAL bool SetHDMIHDRMinMasteringLuminance (const uint16_t inMinMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6766  AJA_VIRTUAL bool GetHDMIHDRMinMasteringLuminance (uint16_t & outMinMasteringLuminance, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6767 
6773  AJA_VIRTUAL bool SetHDMIHDRMaxContentLightLevel (const uint16_t inMaxContentLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6779  AJA_VIRTUAL bool GetHDMIHDRMaxContentLightLevel (uint16_t & outMaxContentLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6780 
6786  AJA_VIRTUAL bool SetHDMIHDRMaxFrameAverageLightLevel (const uint16_t inMaxFrameAverageLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6792  AJA_VIRTUAL bool GetHDMIHDRMaxFrameAverageLightLevel (uint16_t & outMaxFrameAverageLightLevel, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6793 
6794 
6795  AJA_VIRTUAL bool SetHDMIHDRElectroOpticalTransferFunction (const uint8_t inEOTFByte, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6796  AJA_VIRTUAL bool GetHDMIHDRElectroOpticalTransferFunction (uint8_t & outEOTFByte, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6797  AJA_VIRTUAL bool SetHDMIHDRStaticMetadataDescriptorID (const uint8_t inSMDId, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6798  AJA_VIRTUAL bool GetHDMIHDRStaticMetadataDescriptorID (uint8_t & outSMDId, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6799 
6800  AJA_VIRTUAL bool SetHDRData (const HDRFloatValues & inFloatValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6801  AJA_VIRTUAL bool SetHDRData (const HDRRegValues & inRegisterValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6802  AJA_VIRTUAL bool GetHDRData (HDRFloatValues & outFloatValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6803  AJA_VIRTUAL bool GetHDRData (HDRRegValues & outRegisterValues, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6804  AJA_VIRTUAL bool SetHDMIHDRBT2020 (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6805  AJA_VIRTUAL bool SetHDMIHDRDCIP3 (const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK 12.5
6806 
6807  // default channel VPID parameters (frame stores)
6808  AJA_VIRTUAL bool SetVPIDTransferCharacteristics (const NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel); // New in SDK 15.2
6809  AJA_VIRTUAL bool GetVPIDTransferCharacteristics (NTV2VPIDTransferCharacteristics & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6810  AJA_VIRTUAL bool SetVPIDColorimetry (const NTV2VPIDColorimetry inValue, const NTV2Channel inChannel); // New in SDK 15.2
6811  AJA_VIRTUAL bool GetVPIDColorimetry (NTV2VPIDColorimetry & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6812  AJA_VIRTUAL bool SetVPIDLuminance (const NTV2VPIDLuminance inValue, const NTV2Channel inChannel); // New in SDK 15.2
6813  AJA_VIRTUAL bool GetVPIDLuminance (NTV2VPIDLuminance & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6814  AJA_VIRTUAL bool SetVPIDRGBRange (const NTV2VPIDRGBRange inValue, const NTV2Channel inChannel); // New in SDK 16.0
6815  AJA_VIRTUAL bool GetVPIDRGBRange (NTV2VPIDRGBRange & outValue, const NTV2Channel inChannel); // New in SDK 16.0
6816 
6817  // default channel key signal
6818  AJA_VIRTUAL bool SetKeySignal(bool inValue, const NTV2Channel inChannel);
6819  AJA_VIRTUAL bool GetKeySignal(bool & outValue, const NTV2Channel inChannel);
6820 
6821  // sdi output VPID parameter overrides
6822  AJA_VIRTUAL bool SetSDIOutVPIDTransferCharacteristics(bool enable, NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel);
6823  AJA_VIRTUAL bool GetSDIOutVPIDTransferCharacteristics(bool & enable, NTV2VPIDTransferCharacteristics & outValue, const NTV2Channel inChannel);
6824  AJA_VIRTUAL bool SetSDIOutVPIDColorimetry(bool enable, NTV2VPIDColorimetry inValue, const NTV2Channel inChannel);
6825  AJA_VIRTUAL bool GetSDIOutVPIDColorimetry(bool & enable, NTV2VPIDColorimetry & outValue, const NTV2Channel inChannel);
6826  AJA_VIRTUAL bool SetSDIOutVPIDLuminance(bool enable, NTV2VPIDLuminance inValue, const NTV2Channel inChannel);
6827  AJA_VIRTUAL bool GetSDIOutVPIDLuminance(bool & enable, NTV2VPIDLuminance & outValue, const NTV2Channel inChannel);
6828  AJA_VIRTUAL bool SetSDIOutVPIDRGBRange(bool enable, NTV2VPIDRGBRange inValue, const NTV2Channel inChannel);
6829  AJA_VIRTUAL bool GetSDIOutVPIDRGBRange(bool & enable, NTV2VPIDRGBRange & outValue, const NTV2Channel inChannel);
6830 
6831  // sdi output key signal override
6832  AJA_VIRTUAL bool SetSDIOutKeySignal(bool enable, bool inValue, const NTV2Channel inChannel);
6833  AJA_VIRTUAL bool GetSDIOutKeySignal(bool & enable, bool & outValue, const NTV2Channel inChannel);
6834 
6835  AJA_VIRTUAL bool Set3DLUTTableLocation (const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6836  AJA_VIRTUAL bool Load3DLUTTable (void); // New in SDK 16.0
6837  AJA_VIRTUAL bool Set1DLUTTableLocation (const NTV2Channel inChannel, const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6838  AJA_VIRTUAL bool Load1DLUTTable (const NTV2Channel inChannel); // New in SDK 16.0
6839 
6840  // MultiViewer/MultiRasterizer
6841  AJA_VIRTUAL inline bool HasMultiRasterWidget (void) {return IsSupported(kDeviceCanDoHDMIMultiView);} // New in SDK 16.1
6842  AJA_VIRTUAL bool SetMultiRasterBypassEnable (const bool inEnable); // New in SDK 16.1
6843  AJA_VIRTUAL bool GetMultiRasterBypassEnable (bool & outEnabled); // New in SDK 16.1
6844  AJA_VIRTUAL bool IsMultiRasterWidgetChannel (const NTV2Channel inChannel); // New in SDK 16.2
6846 
6847 #if !defined(NTV2_DEPRECATE_17_5)
6848  AJA_VIRTUAL inline bool NTV2_DEPRECATED_17_5(IsBreakoutBoardConnected (void)) {return IsSupported(kDeviceHasBreakoutBoard);}
6849 #endif // NTV2_DEPRECATE_17_5
6850 
6851 #if !defined(NTV2_DEPRECATE_16_1)
6852  AJA_VIRTUAL inline NTV2_DEPRECATED_16_1(bool SetAudioOutputMonitorSource (const NTV2AudioMonitorSelect inChannelPair, const NTV2Channel inAudioSystem = NTV2_CHANNEL1)) {return SetAudioOutputMonitorSource(inChannelPair, NTV2AudioSystem(inAudioSystem));}
6853  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;}
6854 #endif // NTV2_DEPRECATE_16_1
6855 
6856 protected:
6857  AJA_VIRTUAL ULWord GetSerialNumberLow (void); // From CNTV2Status
6858  AJA_VIRTUAL ULWord GetSerialNumberHigh (void); // From CNTV2Status
6859  AJA_VIRTUAL inline bool IS_CHANNEL_VALID (const NTV2Channel inChannel) const {return !IS_CHANNEL_INVALID(inChannel);} // New in SDK 16.2
6860  AJA_VIRTUAL bool IS_CHANNEL_INVALID (const NTV2Channel inChannel) const;
6861  AJA_VIRTUAL bool IS_OUTPUT_SPIGOT_INVALID (const UWord inOutputSpigot);
6862  AJA_VIRTUAL bool IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot);
6863  AJA_VIRTUAL bool IS_HDMI_INPUT_SPIGOT_INVALID (const UWord inInputHDMIPort);
6864 
6865  AJA_VIRTUAL bool GetHDMIOutControlReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6866  AJA_VIRTUAL bool GetHDMIOutInputStatusRegNum (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6867  AJA_VIRTUAL bool GetHDMIOutInputControlRegNum (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6868  AJA_VIRTUAL bool GetHDMIOutStatusReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6869  AJA_VIRTUAL bool GetHDMIOutHDRGreenPrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6870  AJA_VIRTUAL bool GetHDMIOutHDRBluePrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6871  AJA_VIRTUAL bool GetHDMIOutHDRRedPrimaryReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6872  AJA_VIRTUAL bool GetHDMIOutHDRWhitePointReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6873  AJA_VIRTUAL bool GetHDMIOutHDRMasterLuminanceReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6874  AJA_VIRTUAL bool GetHDMIOutHDRLightLevelReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6875  AJA_VIRTUAL bool GetHDMIOutHDRControlReg (ULWord & outRegNum, const NTV2Channel inWhichHDMIOut);
6876 
6877  // Seamless Anc Playout & Capture
6878  // For AutoCirculate Playout
6879  AJA_VIRTUAL bool S2110DeviceAncToXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6880  // For Non-AutoCirculate Playout
6881  AJA_VIRTUAL bool S2110DeviceAncToBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6882  // For AutoCirculate Capture
6883  AJA_VIRTUAL bool S2110DeviceAncFromXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6884  // For Non-AutoCirculate Capture
6885  AJA_VIRTUAL bool S2110DeviceAncFromBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6886  AJA_VIRTUAL bool WriteSDIInVPID (const NTV2Channel inChannel, const ULWord inValA, const ULWord inValB);
6887 
6888 private:
6889  // frame buffer sizing helpers
6890  AJA_VIRTUAL bool GetLargestFrameBufferFormatInUse(NTV2FrameBufferFormat & outFBF);
6891  AJA_VIRTUAL bool GetFrameInfo(const NTV2Channel inChannel, NTV2FrameGeometry & outGeometry, NTV2FrameBufferFormat & outFBF);
6892  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry currentGeometry, NTV2FrameGeometry newGeometry,
6893  NTV2FrameBufferFormat format);
6894  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry geometry,
6895  NTV2FrameBufferFormat currentFormat, NTV2FrameBufferFormat newFormat);
6896 #if !defined(NTV2_DEPRECATE_17_2)
6897  AJA_VIRTUAL NTV2_DEPRECATED_17_2(bool GetFBSizeAndCountFromHW(ULWord & outSize, ULWord & outCount));
6898 #endif
6899 
6900  AJA_VIRTUAL bool IsMultiFormatActive (void);
6901  AJA_VIRTUAL bool CopyVideoFormat(const NTV2Channel inSrc, const NTV2Channel inFirst, const NTV2Channel inLast);
6902  class DeviceCapabilities mDevCap;
6903  friend class CNTV2DeviceScanner; // Device scanner needs access to my private methods & vars
6904 }; // CNTV2Card
6905 
6906 
6908 #if !defined(NTV2_DEPRECATE_16_2)
6915 #endif // !defined(NTV2_DEPRECATE_16_2)
6916 
6917 #define SetTablesToHardware LoadLUTTables
6918 #define GetTablesFromHardware GetLUTTables
6919 
6921 
6922 
6947 {
6948  public:
6952  explicit SDRAMAuditor ()
6953  : mDeviceID (DEVICE_ID_INVALID),
6954  mFrameTags (),
6955  m8MB (0x00800000),
6956  mNumFrames (0),
6957  mIntrinsicSize (0)
6958  {
6959  }
6960 
6965  explicit SDRAMAuditor (CNTV2Card & inDevice)
6966  : mDeviceID (DEVICE_ID_INVALID),
6967  mFrameTags (),
6968  m8MB (0x00800000),
6969  mNumFrames (0),
6970  mIntrinsicSize (0)
6971  {
6972  AssessDevice(inDevice);
6973  }
6974 
6984  bool AssessDevice (CNTV2Card & inDevice, const bool inIgnoreStoppedAudioBuffers = false);
6985 
6995  bool GetRegions (ULWordSequence & outFree, ULWordSequence & outUsed, ULWordSequence & outBad) const;
6996 
7001  inline bool GetFreeRegions (ULWordSequence & outBlks) const
7002  {
7003  ULWordSequence used, bad;
7004  return GetRegions (outBlks, used, bad);
7005  }
7006 
7011  inline bool GetBadRegions (ULWordSequence & outBlks) const
7012  {
7013  ULWordSequence used, free;
7014  return GetRegions (free, used, outBlks);
7015  }
7016 
7021  inline bool GetUsedRegions (ULWordSequence & outBlks) const
7022  {
7023  ULWordSequence bad, free;
7024  return GetRegions (free, outBlks, bad);
7025  }
7026 
7033  bool GetTagsForFrameIndex (const UWord inIndex, NTV2StringSet & outTags) const;
7034 
7035  bool HasFrameIndex (const UWord inIndex) const {return mFrameTags.find(inIndex) != mFrameTags.end();}
7036 
7037  size_t GetTagCount (const UWord inIndex) const;
7038 
7039  inline bool HasTag (const UWord inIndex) const {return GetTagCount(inIndex) > 0;}
7040  inline bool HasConflicts (const UWord inIndex) const {return GetTagCount(inIndex) > 1;}
7041  inline ULWord GetIntrinsicFrameByteCount (void) const {return mIntrinsicSize;}
7042 
7053  bool TranslateRegions (ULWordSequence & outRgns, const ULWordSequence & inRgns, const bool inIsQuad, const bool inIsQuadQuad) const;
7054 
7060  std::ostream & RawDump (std::ostream & oss) const;
7061 
7067  std::ostream & DumpBlocks (std::ostream & oss) const;
7068 
7069  // Static/Class Methods
7070  public:
7074  static ULWordSet CoalesceRegions (const ULWordSequence & inRgn1, const ULWordSequence & inRgn2, const ULWordSequence & inRgn3);
7075 
7076  protected:
7077  bool TagAudioBuffers (CNTV2Card & inDevice, const bool inMarkStoppedAudioBuffersFree);
7078  bool TagVideoFrames (CNTV2Card & inDevice);
7079  bool TagMemoryBlock (const ULWord inStartAddr, const ULWord inByteLength, const std::string & inTag);
7080  bool TagMemoryBlock (const uint64_t inStartAddr, const uint64_t inByteLength, const std::string & inTag)
7081  {
7082  return TagMemoryBlock (ULWord(inStartAddr), ULWord(inByteLength), inTag);
7083  }
7084 
7085  private:
7086  typedef std::pair<UWord, NTV2StringSet> FrameTag;
7087  typedef std::map<UWord, NTV2StringSet> FrameTags;
7088  typedef FrameTags::const_iterator FrameTagsConstIter;
7089 
7090  NTV2DeviceID mDeviceID;
7091  FrameTags mFrameTags;
7092  const ULWord m8MB;
7093  UWord mNumFrames;
7094  ULWord mIntrinsicSize;
7095 }; // SDRAMAuditor
7096 
7097 #endif // NTV2CARD_H
SDRAMAuditor()
My default constructor. I am not ready for use until my SDRAMAuditor::Assess method has been called...
Definition: ntv2card.h:6952
Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.
#define NTV2_DEPRECATED_18_0(__f__)
Definition: ajatypes.h:586
size_t GetTagCount(const UWord inIndex) const
Definition: ntv2card.cpp:751
NTV2VideoDACMode
Definition: ntv2enums.h:2145
NTV2LutBitDepth
This specifies the LUT bit depth.
Definition: ntv2enums.h:3586
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:3898
bool GetBadRegions(ULWordSequence &outBlks) const
Answers with the list of colliding and illegal memory regions.
Definition: ntv2card.h:7011
#define NTV2_DEPRECATED_17_2(__f__)
Definition: ajatypes.h:571
static NTV2Buffer NULL_POINTER
Used for default empty NTV2Buffer parameters – do not modify.
Definition: ntv2card.h:6593
NTV2Crosspoint
Logically, these are an NTV2Channel combined with an NTV2Mode.
Definition: ntv2enums.h:1703
#define NTV2VANCModeFromBools(_tall_, _taller_)
Definition: ntv2enums.h:3813
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:1917
NTV2HDMIColorSpace
Indicates or specifies HDMI Color Space.
Definition: ntv2enums.h:3608
SDRAMAuditor(CNTV2Card &inDevice)
Constructs me and automatically assesses the given device.
Definition: ntv2card.h:6965
virtual bool ReadFlashProgramControl(ULWord &outVal)
Definition: ntv2card.h:2522
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:1843
NTV2FrameBufferFormat
Identifies a particular video frame buffer pixel format. See Device Frame Buffer Formats for details...
Definition: ntv2enums.h:221
#define NTV2_DEPRECATED_16_3(__f__)
Definition: ajatypes.h:556
defined(NTV2_DEPRECATE_17_6)
NTV2TaskMode
Describes the task mode state. See also: NTV2 Device Sharing.
virtual bool ReadAudioLastIn(ULWord &outValue, const NTV2Channel inChannel)
Definition: ntv2card.h:2208
bool AssessDevice(CNTV2Card &inDevice, const bool inIgnoreStoppedAudioBuffers=(0))
Assesses the given device.
Definition: ntv2card.cpp:607
NTV2_RP188Mode
Definition: ntv2enums.h:2098
NTV2InputVideoSelect
Definition: ntv2enums.h:2299
bool HasFrameIndex(const UWord inIndex) const
Definition: ntv2card.h:7035
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:6946
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:759
enum NTV2VideoFrameBufferOrientation NTV2FBOrientation
NTV2AnalogAudioIO
Definition: ntv2enums.h:2235
enum NTV2VPIDColorimetry NTV2HDRColorimetry
NTV2VPIDLuminance
Definition: ntv2enums.h:4265
virtual bool Read3GInput5678StatusRegister(ULWord *pVal)
Definition: ntv2card.h:2519
#define NTV2_DEPRECATED_17_6(__f__)
Definition: ajatypes.h:581
std::map< ULWord, ULWord > NTV2RegisterValueMap
A mapping of distinct NTV2RegisterNumbers to their corresponding ULWord values.
NTV2InterruptMask
Definition: ntv2enums.h:1530
virtual bool ReadGlobalControl(ULWord *pOutVal)
Definition: ntv2card.h:2413
int32_t LWord
Definition: ajatypes.h:235
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:1993
if(!(riid==IID_IUnknown) &&!(riid==IID_IClassFactory))
Definition: dllentry.cpp:196
virtual bool GetLEDState(ULWord &outValue)
Answers with the current state of the four on-board LEDs.
Definition: ntv2card.h:2547
virtual bool SupportsP2PTransfer(void)
Definition: ntv2card.h:2523
NTV2HDMIAudioChannels
Indicates or specifies the HDMI audio channel count.
Definition: ntv2enums.h:3670
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:3939
NTV2LutType
This specifies what function(s) are currently loaded into the LUTs.
Definition: ntv2enums.h:3567
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:627
NTV2HDMIRange
Indicates or specifies the HDMI RGB range.
Definition: ntv2enums.h:3638
uint32_t ULWord
Definition: ajatypes.h:236
NTV2AudioFormat
Definition: ntv2enums.h:1954
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They&#39;re also commonly use...
Definition: ntv2enums.h:1359
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
True if device can directly transmit data to another PCIe device via peer-to-peer DMA...
std::set< NTV2AudioChannelPair > NTV2AudioChannelPairs
A set of distinct NTV2AudioChannelPair values.
NTV2LHIVideoDACMode
Definition: ntv2enums.h:2176
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...
virtual bool SupportsP2PTarget(void)
Definition: ntv2card.h:2524
This struct replaces the old RP188_STRUCT.
bool HasTag(const UWord inIndex) const
Definition: ntv2card.h:7039
NTV2XilinxFPGA
Definition: ntv2enums.h:3849
virtual bool HasMultiRasterWidget(void)
Definition: ntv2card.h:6841
AutoCirculate Frame Range.
Definition: ntv2utils.h:970
bool HasConflicts(const UWord inIndex) const
Definition: ntv2card.h:7040
CNTV2Card CNTV2Status
Definition: ntv2card.h:6909
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:414
virtual CNTV2DriverInterface & driverInterface(void)
Definition: ntv2card.h:6488
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:167
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:637
enum NTV2VPIDTransferCharacteristics NTV2HDRXferChars
int16_t Word
Definition: ajatypes.h:233
NTV2_RS422_PARITY
These enum values identify RS-422 serial port parity configuration.
Definition: ntv2enums.h:4165
virtual bool DeviceCanDoAudioMixer(void)
Definition: ntv2card.h:164
std::set< std::string > NTV2StringSet
NTV2ReferenceSource
These enum values identify a specific source for the device&#39;s (output) reference clock.
Definition: ntv2enums.h:1457
NTV2BreakoutType
Identifies the Breakout Boxes and Cables that may be attached to an AJA NTV2 device.
Definition: ntv2enums.h:3106
Identifies "all" ancillary data regions.
Definition: ntv2enums.h:4240
virtual bool ReadRegisters(NTV2RegisterReads &inOutValues)
Reads the register(s) specified by the given NTV2RegInfo sequence.
CNTV2Card CXena2VidProc
Definition: ntv2card.h:6914
#define AJA_VIRTUAL
Definition: ajatypes.h:143
NTV2ColorSpaceMethod
Definition: ntv2enums.h:3450
NTV2DMAEngine
Definition: ntv2enums.h:1859
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:7080
bool GetFreeRegions(ULWordSequence &outBlks) const
Answers with the list of free memory regions.
Definition: ntv2card.h:7001
virtual bool ReadAudioLastOut(ULWord &outValue, const NTV2Channel inChannel)
Definition: ntv2card.h:2207
#define NTV2_DEPRECATED_18_1(__f__)
Definition: ajatypes.h:591
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:2031
virtual bool SetEveryFrameServices(const NTV2TaskMode m)
Definition: ntv2card.h:1200
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
NTV2ColorCorrectionMode
Definition: ntv2enums.h:2082
NTV2QuarterSizeExpandMode
Definition: ntv2enums.h:2489
NTV2RegisterNumberSet NTV2RegNumSet
A set of distinct NTV2RegisterNumbers.
NTV2AudioChannelPair
Identifies a pair of audio channels.
Definition: ntv2enums.h:3134
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:1779
#define NTV2_SHOULD_BE_DEPRECATED(__f__)
Definition: ajatypes.h:504
std::vector< uint16_t > UWordSequence
An ordered sequence of UWord (uint16_t) values.
NTV2UpConvertMode
Definition: ntv2enums.h:2222
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:3624
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:677
NTV2VPIDColorimetry
Definition: ntv2enums.h:4257
True if device can rasterize 4 HD signals into a single HDMI output.
#define NTV2_WILL_BE_DEPRECATED(__f__)
Definition: ajatypes.h:507
virtual bool HasCanConnectROM(void)
Definition: ntv2card.h:4493
NTV2HDMIV2Mode
Definition: ntv2enums.h:4003
virtual bool IS_CHANNEL_VALID(const NTV2Channel inChannel) const
Definition: ntv2card.h:6859
NTV2DownConvertMode
Definition: ntv2enums.h:2245
CNTV2Card CNTV2Device
Instances of this class are able to interrogate and control an NTV2 AJA video/audio capture/playout d...
Definition: ntv2card.h:6907
uint64_t ULWord64
Definition: ajatypes.h:239
NTV2LUTPlaneSelect
Definition: ntv2enums.h:3886
uint8_t UByte
Definition: ajatypes.h:231
NTV2AudioLevel
Definition: ntv2enums.h:2316
virtual bool DeviceIsDNxIV(void)
Definition: ntv2card.h:165
virtual std::string GetDescription(void) const
NTV2Framesize
Kona2/Xena2 specific enums.
Definition: ntv2enums.h:2119
virtual bool GetLTCOnReference(bool &outVal)
Definition: ntv2card.h:5285
virtual bool Read3GInputStatus2Register(ULWord *pVal)
Definition: ntv2card.h:2518
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:6164
NTV2Mode
Used to identify the mode of a widget_framestore, or the direction of an AutoCirculate stream: either...
Definition: ntv2enums.h:1241
Declares the MSWindows-specific flavor of CNTV2DriverInterface.
NTV2InputSource
Identifies a specific video input source.
Definition: ntv2enums.h:1264
NTV2HDMIColorimetry
Indicates or specifies the HDMI colorimetry.
Definition: ntv2enums.h:3652
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:801
NTV2FrameBufferQuality
Definition: ntv2enums.h:2500
virtual bool GetEveryFrameServices(NTV2TaskMode &m)
defined(NTV2_DEPRECATE_18_1)
Definition: ntv2card.h:1199
True if device can directly receive data from another PCIe device via peer-to-peer DMA...
CNTV2Card CNTV2VidProc
Definition: ntv2card.h:6911
#define AJAExport
Definition: export.h:33
NTV2VPIDTransferCharacteristics
Definition: ntv2enums.h:4249
NTV2FrameGeometry
Identifies a particular video frame geometry.
Definition: ntv2enums.h:350
NTV2_CSC_RGB_Range
Definition: ntv2enums.h:3762
std::set< NTV2Channel > NTV2ChannelSet
A set of distinct NTV2Channel values.
This identifies the first Audio System.
Definition: ntv2enums.h:3900
#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:783
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:2530
NTV2InputCrosspointID
Identifies a widget input that potentially can accept a signal emitted from another widget&#39;s output (...
Definition: ntv2enums.h:2755
NTV2IsoConvertMode
Definition: ntv2enums.h:2256
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
NTV2WidgetID
Definition: ntv2enums.h:2912
CNTV2Card CNTV2ColorCorrection
Definition: ntv2card.h:6912
NTV2EncodeAsPSF
Definition: ntv2enums.h:2515
uint16_t UWord
Definition: ajatypes.h:234
Specifies channel or FrameStore 1 (or the first item).
Definition: ntv2enums.h:1361
virtual bool WriteGlobalControl(const ULWord inVal)
Definition: ntv2card.h:2412
virtual bool SetLTCOnReference(bool val)
Definition: ntv2card.h:5284
NTV2VideoLimiting
These enum values identify the available SDI video output limiting modes.
Definition: ntv2enums.h:3781
virtual bool CanDoAudioWaitForVBI(void)
Definition: ntv2card.h:2215
Declares the CNTV2BareMetalDriverInterface class.
NTV2AncillaryDataRegion
These enumerations identify the various ancillary data regions located at the bottom of each frame bu...
Definition: ntv2enums.h:4230
NTV2VANCMode
These enum values identify the available VANC modes.
Definition: ntv2enums.h:3800
NTV2ColorSpaceMatrixType
Definition: ntv2enums.h:3461
NTV2DSKMode
Definition: ntv2enums.h:3502
NTV2RegisterWriteMode
These values are used to determine when certain register writes actually take effect. See CNTV2Card::SetRegisterWriteMode or Field/Frame Interrupts.
Definition: ntv2enums.h:1682
virtual bool GetRegisterWritemode(NTV2RegisterWriteMode &outVal, const NTV2Channel inChan=NTV2_CHANNEL1)
Definition: ntv2card.h:3039
virtual bool SetRegisterWritemode(NTV2RegisterWriteMode inVal, const NTV2Channel inChan=NTV2_CHANNEL1)
Definition: ntv2card.h:3038
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:741
virtual bool SetAudioOutputMonitorSource(const NTV2AudioMonitorSelect inChannelPair, const NTV2Channel inAudioSystem=NTV2_CHANNEL1)
Definition: ntv2card.h:6852
Declares the CNTV2LinuxDriverInterface class.
NTV2AudioSource
This enum value determines/states where an audio system will obtain its audio samples.
Definition: ntv2enums.h:2008
virtual bool Read3GInputStatusRegister(ULWord *pVal)
Definition: ntv2card.h:2517
virtual bool GetAudioOutputMonitorSource(NTV2AudioMonitorSelect &chp, NTV2Channel &ch)
Definition: ntv2card.h:6853
NTV2VANCDataShiftMode
Definition: ntv2enums.h:3816
std::pair< NTV2InputXptID, NTV2OutputXptID > NTV2XptConnection
#define NTV2_DEPRECATED_17_5(__f__)
Definition: ajatypes.h:576
enum NTV2InputCrosspointID NTV2InputXptID
Convenience class/API for inquiring about device capabilities of physical and virtual devices...
NTV2LSVideoADCMode
Definition: ntv2enums.h:2198
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...
virtual bool GetPCIDeviceID(ULWord &outPCIDeviceID)
Answers with my PCI device ID.
Definition: ntv2card.h:131
True if device audio systems can wait for VBI before starting. (New in SDK 17.0)
NTV2AudioRate
Definition: ntv2enums.h:1931
std::vector< uint32_t > ULWordSequence
An ordered sequence of ULWord (uint32_t) values.
#define NTV2_DEPRECATED_16_0(__f__)
Definition: ajatypes.h:542
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:7891
NTV2MixerRGBRange
Definition: ntv2enums.h:2277
NTV2ConversionMode
Definition: ntv2enums.h:3717
#define NTV2_DEPRECATED_17_0(__f__)
Definition: ajatypes.h:561
virtual bool SetLEDState(const ULWord inValue)
The four on-board LEDs can be set by writing 0-15.
Definition: ntv2card.h:2539
NTV2AudioMixerChannel
Definition: ntv2enums.h:3228
NTV2LUTControlSelect
Definition: ntv2enums.h:3879
std::set< NTV2DeviceID > NTV2DeviceIDSet
A set of NTV2DeviceIDs.
Definition: ntv2utils.h:1043
NTV2ConversionMode GetConversionMode(const NTV2VideoFormat inFormat, const NTV2VideoFormat outFormat)
Definition: ntv2utils.cpp:5478
CNTV2Card CNTV2TestPattern
Definition: ntv2card.h:6910
True if device has a firmware audio mixer.
CNTV2Card CNTV2ProcAmp
Definition: ntv2card.h:6913
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:652
NTV2Audio4ChannelSelect
Identifies a contiguous, adjacent group of four audio channels.
Definition: ntv2enums.h:3274
bool GetUsedRegions(ULWordSequence &outBlks) const
Answers with the list of used memory regions.
Definition: ntv2card.h:7021
ULWord GetIntrinsicFrameByteCount(void) const
Definition: ntv2card.h:7041
NTV2VPIDRGBRange
Definition: ntv2enums.h:4271
A Mac-specific implementation of CNTV2DriverInterface.
std::vector< NTV2RegInfo > NTV2RegisterWrites
NTV2Interrupt2Mask
Definition: ntv2enums.h:1603
NTV2_RS422_BAUD_RATE
These enum values identify RS-422 serial port baud rate configuration.
Definition: ntv2enums.h:4180
Identifies the 1st SDI video input.
Definition: ntv2enums.h:1271
std::vector< NTV2DeviceID > NTV2DeviceIDList
An ordered list of NTV2DeviceIDs.
Definition: ntv2utils.h:1036
virtual bool SetVANCMode(const NTV2VANCMode m, const NTV2Standard st, const NTV2FrameGeometry fg, const NTV2Channel ch=NTV2_CHANNEL1)
Definition: ntv2card.h:1217
NTV2HDMISampleStructure
Definition: ntv2enums.h:4190
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:1970
Implements the MacOS-specific flavor of CNTV2DriverInterface.
NTV2HDMIBitDepth
Indicates or specifies the HDMI video bit depth.
Definition: ntv2enums.h:3695
#define NTV2_DEPRECATED_16_2(__f__)
Definition: ajatypes.h:551
NTV2StereoCompressorOutputMode
Definition: ntv2enums.h:3859
#define NTV2_DEPRECATED_16_1(__f__)
Definition: ajatypes.h:546
Linux implementation of CNTV2DriverInterface.
BareMetal implementation of CNTV2DriverInterface.
NTV2HDMIOut3DMode
This specifies the HDMI Out Stereo 3D Mode.
Definition: ntv2enums.h:3596
NTV2MixerKeyerMode
These enum values identify the mixer mode.
Definition: ntv2enums.h:1794
NTV2Audio8ChannelSelect
Identifies a contiguous, adjacent group of eight audio channels.
Definition: ntv2enums.h:3323
Declares the DeviceCapabilities class.
std::set< UByte > NTV2DIDSet
A set of distinct NTV2DID values.
NTV2LHIHDMIColorSpace
Definition: ntv2enums.h:3681
NTV2EncodedAudioMode
Definition: ntv2enums.h:1943
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:3257
virtual bool DeviceHasMicInput(void)
Definition: ntv2card.h:166
NTV2DieTempScale
Definition: ntv2enums.h:4213
NTV2ColorCorrectionHostAccessBank
Definition: ntv2enums.h:2061