AJA NTV2 SDK  17.1.1.1245
NTV2 SDK 17.1.1.1245
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)
16  #include "ntv2linuxdriverinterface.h"
17 #elif defined (AJABareMetal)
18  #include "ntv2baremetaldriverinterface.h"
19 #endif
20 #include "ntv2signalrouter.h"
21 #include "ntv2utils.h"
22 #include "ntv2devicecapabilities.h"
23 
24 
28 class AJAExport CNTV2Card
29 #if defined (MSWindows)
30  : public CNTV2WinDriverInterface
31 #elif defined (AJAMac)
32  : public CNTV2MacDriverInterface
33 #elif defined (AJALinux)
34  : public CNTV2LinuxDriverInterface
35 #elif defined (AJABareMetal)
36  : public CNTV2BareMetalDriverInterface
37 #endif
38 {
39 public:
43 
47  CNTV2Card ();
48 
57  explicit CNTV2Card ( const UWord inDeviceIndex,
58  const std::string & inHostName = std::string());
59 
63  virtual ~CNTV2Card();
65 
66 
70 
75  AJA_VIRTUAL std::string GetDisplayName (void);
76 
81  AJA_VIRTUAL std::string GetModelName (void);
82 
87  AJA_VIRTUAL Word GetDeviceVersion (void);
88 
93  AJA_VIRTUAL std::string GetDeviceVersionString (void);
94 
99  AJA_VIRTUAL std::string GetDriverVersionString (void);
100 
101  AJA_VIRTUAL std::string GetDescription (void) const;
102 
111  AJA_VIRTUAL bool GetDriverVersionComponents (UWord & outMajor, UWord & outMinor, UWord & outPoint, UWord & outBuild);
112 
118  AJA_VIRTUAL uint64_t GetSerialNumber (void); // From CNTV2Status
119 
124  AJA_VIRTUAL bool GetSerialNumberString (std::string & outSerialNumberString); // From CNTV2Status
125 
131  AJA_VIRTUAL bool GetPCIDeviceID (ULWord & outPCIDeviceID);
132 
136  AJA_VIRTUAL NTV2BreakoutType GetBreakoutHardware (void);
137 
141  AJA_VIRTUAL inline class DeviceCapabilities & features (void) {return mDevCap;} // New in SDK 17.0
142 #if !defined(NTV2_DEPRECATE_16_3)
143  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoFormat (const NTV2FrameRate inFR,
144  const NTV2FrameGeometry inFG,
145  const NTV2Standard inStd));
146  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetFrameBufferSize(void));
147  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetAudioFrameBuffer(void));
148  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetAudioFrameBuffer2(void));
149  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetFrameBufferSize (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
150  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetNumberFrameBuffers (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
151  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetAudioFrameBuffer (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
152  AJA_VIRTUAL NTV2_DEPRECATED_f(ULWord DeviceGetAudioFrameBuffer2 (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat));
153  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoVideoFormat (const NTV2VideoFormat inVF));
154  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoFrameBufferFormat (const NTV2PixelFormat inPF));
155  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoWidget (const NTV2WidgetID inWgtID));
156  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoConversionMode (const NTV2ConversionMode inCM));
157  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoDSKMode (const NTV2DSKMode inDSKM));
158  AJA_VIRTUAL NTV2_DEPRECATED_f(bool DeviceCanDoInputSource (const NTV2InputSource inSrc));
159  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool DeviceCanDoAudioMixer(void)) {return IsSupported(kDeviceCanDoAudioMixer);}
160  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool DeviceIsDNxIV(void)) {return IsSupported(kDeviceHasMicrophoneInput);}
161  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool DeviceHasMicInput(void)) {return IsSupported(kDeviceHasMicrophoneInput);}
162 #endif // defined(NTV2_DEPRECATE_16_3)
163  AJA_VIRTUAL ULWord DeviceGetNumberFrameBuffers(void);
165 
166 
170 
184  AJA_VIRTUAL bool DMARead (const ULWord inFrameNumber, ULWord * pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount);
185 
199  AJA_VIRTUAL bool DMAWrite (const ULWord inFrameNumber, const ULWord * pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount);
200 
201 
214  AJA_VIRTUAL bool DMAReadFrame (const ULWord inFrameNumber, ULWord * pOutFrameBuffer, const ULWord inByteCount);
215 
233  AJA_VIRTUAL bool DMAReadFrame (const ULWord inFrameNumber, ULWord * pHostBuffer, const ULWord inByteCount, const NTV2Channel inChannel);
234 
247  AJA_VIRTUAL bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord * pInFrameBuffer, const ULWord inByteCount);
248 
266  AJA_VIRTUAL bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord * pInFrameBuffer, const ULWord inByteCount, const NTV2Channel inChannel);
267 
283  AJA_VIRTUAL bool DMAReadSegments ( const ULWord inFrameNumber,
284  ULWord * pFrameBuffer,
285  const ULWord inCardOffsetBytes,
286  const ULWord inSegmentByteCount,
287  const ULWord inNumSegments,
288  const ULWord inSegmentHostPitch,
289  const ULWord inSegmentCardPitch);
290 
306  AJA_VIRTUAL bool DMAWriteSegments ( const ULWord inFrameNumber,
307  const ULWord * pFrameBuffer,
308  const ULWord inOffsetBytes,
309  const ULWord inSegmentByteCount,
310  const ULWord inNumSegments,
311  const ULWord inSegmentHostPitch,
312  const ULWord inSegmentCardPitch);
313 
317  AJA_VIRTUAL bool DmaP2PTargetFrame (NTV2Channel channel, // frame buffer channel output frame to update on completion
318  ULWord frameNumber, // frame number to target
319  ULWord frameOffset, // frame buffer offset (bytes)
320  PCHANNEL_P2P_STRUCT pP2PData); // p2p target data (output)
321 
322  AJA_VIRTUAL bool DmaP2PTransferFrame (NTV2DMAEngine DMAEngine, // dma engine for transfer
323  ULWord frameNumber, // source frame number
324  ULWord frameOffset, // source frame buffer offset (bytes)
325  ULWord transferSize, // transfer size (bytes)
326  ULWord numSegments, // number of segments (0 if not a segmented transfer)
327  ULWord segmentTargetPitch, // target frame pitch (0 if not a segmented transfer)
328  ULWord segmentCardPitch, // source frame pitch (0 if not a segmented transfer)
329  PCHANNEL_P2P_STRUCT pP2PData); // p2p target data
330 
346  AJA_VIRTUAL bool DMAReadAudio ( const NTV2AudioSystem inAudioSystem,
347  ULWord * pOutAudioBuffer,
348  const ULWord inOffsetBytes,
349  const ULWord inByteCount);
350 
366  AJA_VIRTUAL bool DMAWriteAudio ( const NTV2AudioSystem inAudioSystem,
367  const ULWord * pInAudioBuffer,
368  const ULWord inOffsetBytes,
369  const ULWord inByteCount);
370 
393  AJA_VIRTUAL bool DMAReadAnc ( const ULWord inFrameNumber,
394  NTV2Buffer & outAncF1Buffer,
395  NTV2Buffer & outAncF2Buffer = NULL_POINTER,
396  const NTV2Channel inChannel = NTV2_CHANNEL1);
397 
426  AJA_VIRTUAL bool DMAWriteAnc ( const ULWord inFrameNumber,
427  NTV2Buffer & inAncF1Buffer,
428  NTV2Buffer & inAncF2Buffer = NULL_POINTER,
429  const NTV2Channel inChannel = NTV2_CHANNEL1);
430 
431 
442  AJA_VIRTUAL bool DMAWriteLUTTable ( const ULWord inFrameNumber, const ULWord * pInLUTBuffer, const ULWord inLUTIndex,const ULWord inByteCount = LUTTablePartitionSize);
443 
452  AJA_VIRTUAL bool DMABufferLock (const NTV2Buffer & inBuffer, bool inMap = false, bool inRDMA = false); // New in SDK 15.5
453 
466  AJA_VIRTUAL inline bool DMABufferLock (const ULWord * pInBuffer, const ULWord inByteCount, bool inMap = false, bool inRDMA = false)
467  {
468  return DMABufferLock(NTV2Buffer(pInBuffer, inByteCount), inMap, inRDMA);
469  }
470 
471 
478  AJA_VIRTUAL bool DMABufferUnlock (const NTV2Buffer & inBuffer);
479 
487  AJA_VIRTUAL inline bool DMABufferUnlock (const ULWord * pInBuffer, const ULWord inByteCount)
488  {
489  return DMABufferUnlock(NTV2Buffer(pInBuffer, inByteCount));
490  }
491 
497  AJA_VIRTUAL bool DMABufferUnlockAll ();
498 
507  AJA_VIRTUAL bool DMABufferAutoLock (const bool inEnable, const bool inMap = false, const ULWord64 inMaxLockSize = 0);
508 
509 
520  AJA_VIRTUAL bool DMAClearAncRegion ( const UWord inStartFrameNumber,
521  const UWord inEndFrameNumber,
522  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All,
523  const NTV2Channel = NTV2_CHANNEL1);
524 
535  AJA_VIRTUAL bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel,
536  uint64_t & outAddress, uint64_t & outLength);
537 
538  AJA_VIRTUAL bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, ULWord & outIntrinsicSize,
539  bool & outMultiFmt, bool & outQuad, bool & outQuadQuad, bool & outSquares, bool & outTSI,
540  uint64_t & outAddress, uint64_t & outLength); // New in SDK 16.2
541 
550  AJA_VIRTUAL bool DeviceAddressToFrameNumber (const uint64_t inAddress, UWord & outFrameNumber, const NTV2Channel inChannel = NTV2_CHANNEL1);
551 
565  AJA_VIRTUAL bool GetAncRegionOffsetAndSize (ULWord & outByteOffset, ULWord & outByteCount,
566  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All);
567 
579  AJA_VIRTUAL bool GetAncRegionOffsetFromBottom (ULWord & outByteOffsetFromBottom,
580  const NTV2AncillaryDataRegion inAncRegion = NTV2_AncRgn_All);
582 
583 //
584 // Set/Get Parameter routines
585 //
586  #if defined (AJAMac)
587  #define AJA_RETAIL_DEFAULT true
588  #else // else !defined (AJAMac)
589  #define AJA_RETAIL_DEFAULT false
590  #endif // !defined (AJAMac)
591 
608  AJA_VIRTUAL bool SetVideoFormat (const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail = AJA_RETAIL_DEFAULT, const bool inKeepVancSettings = false, const NTV2Channel inChannel = NTV2_CHANNEL1);
609 
621  AJA_VIRTUAL bool SetVideoFormat (const NTV2ChannelSet & inFrameStores, const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail = AJA_RETAIL_DEFAULT);
622 
630  AJA_VIRTUAL bool SetFrameGeometry (NTV2FrameGeometry inGeometry, bool inIsRetail = AJA_RETAIL_DEFAULT, NTV2Channel inChannel = NTV2_CHANNEL1);
631 
647  AJA_VIRTUAL bool SetFrameBufferFormat (NTV2Channel inChannel,
648  NTV2FrameBufferFormat inNewFormat,
649  bool inIsAJARetail = AJA_RETAIL_DEFAULT,
650  NTV2HDRXferChars inXferChars = NTV2_VPID_TC_SDR_TV,
651  NTV2HDRColorimetry inColorimetry = NTV2_VPID_Color_Rec709,
652  NTV2HDRLuminance inLuminance = NTV2_VPID_Luminance_YCbCr);
653 
669  AJA_VIRTUAL bool SetFrameBufferFormat (const NTV2ChannelSet & inFrameStores,
670  const NTV2FrameBufferFormat inNewFormat,
671  const bool inIsAJARetail = AJA_RETAIL_DEFAULT,
672  const NTV2HDRXferChars inXferChars = NTV2_VPID_TC_SDR_TV,
673  const NTV2HDRColorimetry inColorimetry = NTV2_VPID_Color_Rec709,
674  const NTV2HDRLuminance inLuminance = NTV2_VPID_Luminance_YCbCr);
675 
684  AJA_VIRTUAL bool SetReference (const NTV2ReferenceSource inRefSource, const bool inKeepFramePulseSelect = false);
685 
692  AJA_VIRTUAL bool GetReference (NTV2ReferenceSource & outRefSource);
693 
700  AJA_VIRTUAL bool EnableFramePulseReference (const bool inEnable); // New in SDK 15.5
701 
709  AJA_VIRTUAL bool GetEnableFramePulseReference (bool & outEnabled); // New in SDK 15.5
710 
717  AJA_VIRTUAL bool SetFramePulseReference (const NTV2ReferenceSource inRefSource); // New in SDK 15.5
718 
725  AJA_VIRTUAL bool GetFramePulseReference (NTV2ReferenceSource & outRefSource); // New in SDK 15.5
726 
734  AJA_VIRTUAL bool GetEveryFrameServices (NTV2EveryFrameTaskMode & outMode);
735 
744  AJA_VIRTUAL bool SetEveryFrameServices (const NTV2EveryFrameTaskMode inMode);
745 
756  AJA_VIRTUAL bool SetMode (const NTV2Channel inChannel, const NTV2Mode inNewValue, const bool inIsRetail = AJA_RETAIL_DEFAULT);
757 
767  AJA_VIRTUAL bool SetMode (const NTV2ChannelSet & inChannels, const NTV2Mode inMode);
768 
777  AJA_VIRTUAL bool GetMode (const NTV2Channel inChannel, NTV2Mode & outValue);
778 
779  AJA_VIRTUAL bool GetFrameGeometry (NTV2FrameGeometry & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
780 
791  AJA_VIRTUAL bool GetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat & outValue);
792 
793 
794  // The rest of the routines
795  AJA_VIRTUAL bool GetVideoFormat (NTV2VideoFormat & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
796 
797  AJA_VIRTUAL bool SetStandard (NTV2Standard inValue, NTV2Channel inChannel = NTV2_CHANNEL1);
798  AJA_VIRTUAL bool GetStandard (NTV2Standard & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
799 
800  AJA_VIRTUAL bool IsProgressiveStandard (bool & outIsProgressive, NTV2Channel inChannel = NTV2_CHANNEL1);
801 
802  AJA_VIRTUAL bool IsSDStandard (bool & outIsStandardDef, NTV2Channel inChannel = NTV2_CHANNEL1);
803 
812  AJA_VIRTUAL bool SetFrameRate (NTV2FrameRate inNewValue, NTV2Channel inChannel = NTV2_CHANNEL1);
813 
822  AJA_VIRTUAL bool GetFrameRate (NTV2FrameRate & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
823 
834  AJA_VIRTUAL bool SetSmpte372 (ULWord inValue, NTV2Channel inChannel = NTV2_CHANNEL1);
835 
845  AJA_VIRTUAL bool GetSmpte372 (ULWord & outValue, NTV2Channel inChannel = NTV2_CHANNEL1);
846 
847  AJA_VIRTUAL bool SetProgressivePicture (ULWord value);
848  AJA_VIRTUAL bool GetProgressivePicture (ULWord & outValue);
849 
860  AJA_VIRTUAL bool SetQuadFrameEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
861 
869  AJA_VIRTUAL bool GetQuadFrameEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
870 
881  AJA_VIRTUAL bool SetQuadQuadFrameEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
882 
890  AJA_VIRTUAL bool GetQuadQuadFrameEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
891 
900  AJA_VIRTUAL bool SetQuadQuadSquaresEnable (const bool inValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
901 
910  AJA_VIRTUAL bool GetQuadQuadSquaresEnable (bool & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
911 
923  AJA_VIRTUAL bool Set4kSquaresEnable (const bool inIsEnabled, const NTV2Channel inChannel);
924 
934  AJA_VIRTUAL bool Get4kSquaresEnable (bool & outIsEnabled, const NTV2Channel inChannel);
935 
946  AJA_VIRTUAL bool SetTsiFrameEnable (const bool inIsEnabled, const NTV2Channel inChannel);
947 
956  AJA_VIRTUAL bool GetTsiFrameEnable (bool & outIsEnabled, const NTV2Channel inChannel);
957 
964  AJA_VIRTUAL bool GetTsiMuxSyncFail (bool & outSyncFailed, const NTV2Channel inWhichTsiMux);
965 
966  AJA_VIRTUAL bool SetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode inValue);
967  AJA_VIRTUAL bool GetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode & outValue);
968 
969  AJA_VIRTUAL bool SetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality inValue);
970  AJA_VIRTUAL bool GetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality & outValue);
971 
972  AJA_VIRTUAL bool SetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF inValue);
973  AJA_VIRTUAL bool GetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF & outValue);
974 
986  AJA_VIRTUAL bool SetFrameBufferOrientation (const NTV2Channel inChannel, const NTV2FBOrientation inValue);
987 
998  AJA_VIRTUAL bool GetFrameBufferOrientation (const NTV2Channel inChannel, NTV2FBOrientation & outValue);
999 
1000  AJA_VIRTUAL bool SetAlphaFromInput2Bit (ULWord inValue);
1001  AJA_VIRTUAL bool GetAlphaFromInput2Bit (ULWord & outValue);
1002 
1028  AJA_VIRTUAL bool SetOutputFrame (const NTV2Channel inChannel, const ULWord inValue);
1029 
1038  AJA_VIRTUAL bool GetOutputFrame (const NTV2Channel inChannel, ULWord & outValue);
1039 
1066  AJA_VIRTUAL bool SetInputFrame (const NTV2Channel inChannel, const ULWord inValue);
1067 
1078  AJA_VIRTUAL bool GetInputFrame (const NTV2Channel inChannel, ULWord & outValue);
1079 
1080  AJA_VIRTUAL bool SetDualLinkOutputEnable (const bool inIsEnabled);
1081  AJA_VIRTUAL bool GetDualLinkOutputEnable (bool & outIsEnabled);
1082 
1083  AJA_VIRTUAL bool SetDualLinkInputEnable (const bool inIsEnabled);
1084  AJA_VIRTUAL bool GetDualLinkInputEnable (bool & outIsEnabled);
1085 
1092  AJA_VIRTUAL bool SetVideoLimiting (const NTV2VideoLimiting inValue);
1093 
1100  AJA_VIRTUAL bool GetVideoLimiting (NTV2VideoLimiting & outValue);
1101 
1102  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC, const NTV2Standard inStandard, const NTV2FrameGeometry inGeometry, const NTV2Channel inChannel = NTV2_CHANNEL1);
1103  AJA_VIRTUAL bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC = false, const NTV2Channel inChannel = NTV2_CHANNEL1);
1104 
1113  AJA_VIRTUAL bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1114 
1122  AJA_VIRTUAL bool SetVANCMode (const NTV2ChannelSet & inChannels, const NTV2VANCMode inVancMode);
1123 
1132  AJA_VIRTUAL bool GetVANCMode (NTV2VANCMode & outVancMode, const NTV2Channel inChannel = NTV2_CHANNEL1);
1133 
1146  AJA_VIRTUAL bool SetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode inMode);
1147 
1160  AJA_VIRTUAL bool SetVANCShiftMode (NTV2ChannelSet & inChannels, const NTV2VANCDataShiftMode inMode); // New in SDK 16.2
1161 
1175  AJA_VIRTUAL bool GetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode & outValue);
1176 
1177  AJA_VIRTUAL bool SetPulldownMode (NTV2Channel inChannel, bool inValue);
1178  AJA_VIRTUAL bool GetPulldownMode (NTV2Channel inChannel, bool & outValue);
1179 
1186  AJA_VIRTUAL bool ReadLineCount (ULWord & outValue);
1187 
1188 #if !defined(NTV2_DEPRECATE_16_3)
1189  AJA_VIRTUAL NTV2_DEPRECATED_f(bool SetDefaultVideoOutMode(ULWord mode));
1190  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetDefaultVideoOutMode(ULWord & outMode));
1191 #endif // defined(NTV2_DEPRECATE_16_3)
1192 #if !defined(NTV2_DEPRECATE_16_2)
1193  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetActiveFrameDimensions (NTV2FrameDimensions & outFrameDimensions, const NTV2Channel inChannel = NTV2_CHANNEL1));
1194  AJA_VIRTUAL NTV2_DEPRECATED_f(NTV2FrameDimensions GetActiveFrameDimensions (const NTV2Channel inChannel = NTV2_CHANNEL1));
1195  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetNumberActiveLines (ULWord & outNumActiveLines));
1196  AJA_VIRTUAL NTV2_DEPRECATED_f(bool FlipFlopPage (const NTV2Channel inChannel));
1197  AJA_VIRTUAL NTV2_DEPRECATED_f(bool SetPCIAccessFrame (const NTV2Channel inChannel, const ULWord inValue, const bool inWaitForVBI = true));
1198  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetPCIAccessFrame (const NTV2Channel inChannel, ULWord & outValue));
1199 #endif // !defined(NTV2_DEPRECATE_16_2)
1200 #if !defined(NTV2_DEPRECATE_16_0)
1201  AJA_VIRTUAL inline NTV2_SHOULD_BE_DEPRECATED(bool SetEnableVANCData (const NTV2ChannelSet & inChannels, const bool inVANCenable, const bool inTallerVANC = false)) {return SetVANCMode(inChannels, NTV2VANCModeFromBools(inVANCenable, inTallerVANC));}
1202  AJA_VIRTUAL inline NTV2_SHOULD_BE_DEPRECATED(bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Standard st, const NTV2FrameGeometry fg,
1203  const NTV2Channel inChannel = NTV2_CHANNEL1)) {(void) st; (void) fg; return SetVANCMode(inVancMode, inChannel);}
1204  #define Set425FrameEnable SetTsiFrameEnable // Replace calls to Set425FrameEnable with calls to SetTsiFrameEnable instead
1205  #define Get425FrameEnable GetTsiFrameEnable // Replace calls to Get425FrameEnable with calls to GetTsiFrameEnable instead
1206 #endif // NTV2_DEPRECATE_16_0
1207 
1208 
1212 
1223  AJA_VIRTUAL bool SetMixerVancOutputFromForeground (const UWord inWhichMixer, const bool inFromForegroundSource = true);
1224 
1234  AJA_VIRTUAL bool GetMixerVancOutputFromForeground (const UWord inWhichMixer, bool & outIsFromForegroundSource);
1235 
1236 
1244  AJA_VIRTUAL bool SetMixerFGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1245 
1253  AJA_VIRTUAL bool GetMixerFGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1254 
1262  AJA_VIRTUAL bool SetMixerBGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl);
1263 
1271  AJA_VIRTUAL bool GetMixerBGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl & outInputControl);
1272 
1280  AJA_VIRTUAL bool SetMixerMode (const UWord inWhichMixer, const NTV2MixerKeyerMode inMode);
1281 
1289  AJA_VIRTUAL bool GetMixerMode (const UWord inWhichMixer, NTV2MixerKeyerMode & outMode);
1290 
1298  AJA_VIRTUAL bool SetMixerCoefficient (const UWord inWhichMixer, const ULWord inMixCoefficient);
1299 
1307  AJA_VIRTUAL bool GetMixerCoefficient (const UWord inWhichMixer, ULWord & outMixCoefficient);
1308 
1317  AJA_VIRTUAL bool GetMixerSyncStatus (const UWord inWhichMixer, bool & outIsSyncOK);
1318 
1326  AJA_VIRTUAL bool GetMixerFGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1327 
1335  AJA_VIRTUAL bool SetMixerFGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1336 
1344  AJA_VIRTUAL bool GetMixerBGMatteEnabled (const UWord inWhichMixer, bool & outIsEnabled);
1345 
1353  AJA_VIRTUAL bool SetMixerBGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled);
1354 
1362  AJA_VIRTUAL bool GetMixerMatteColor (const UWord inWhichMixer, YCbCr10BitPixel & outYCbCrValue);
1363 
1371  AJA_VIRTUAL bool SetMixerMatteColor (const UWord inWhichMixer, const YCbCr10BitPixel inYCbCrValue);
1372 
1379  AJA_VIRTUAL bool MixerHasRGBModeSupport (const UWord inWhichMixer, bool & outIsSupported);
1380 
1387  AJA_VIRTUAL bool SetMixerRGBRange (const UWord inWhichMixer, const NTV2MixerRGBRange inRGBRange);
1388 
1395  AJA_VIRTUAL bool GetMixerRGBRange (const UWord inWhichMixer, NTV2MixerRGBRange & outRGBRange);
1397 
1398 
1402 
1413  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1414 
1423  AJA_VIRTUAL bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1424 
1435  AJA_VIRTUAL bool GetNumberAudioChannels (ULWord & outNumChannels, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1436 
1444  AJA_VIRTUAL bool SetAudioRate (const NTV2AudioRate inRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1445 
1453  AJA_VIRTUAL bool GetAudioRate (NTV2AudioRate & outRate, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1454 
1463  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1464 
1473  AJA_VIRTUAL bool SetAudioBufferSize (const NTV2AudioBufferSize inMode, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1474 
1482  AJA_VIRTUAL bool GetAudioBufferSize (NTV2AudioBufferSize & outSize, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1483 
1491  AJA_VIRTUAL bool SetAudio20BitMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 13.0
1492 
1502  AJA_VIRTUAL bool GetAudio20BitMode (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 13.0
1503 
1513  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1514 
1523  AJA_VIRTUAL bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystemSet & inAudioSystems); // New in SDK 16.2
1524 
1534  AJA_VIRTUAL bool GetAudioLoopBack (NTV2AudioLoopBack & outMode, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1535 
1536 
1537  AJA_VIRTUAL bool SetAudioAnalogLevel (const NTV2AudioLevel value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1538  AJA_VIRTUAL bool GetAudioAnalogLevel (NTV2AudioLevel & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1539  AJA_VIRTUAL bool SetEncodedAudioMode (const NTV2EncodedAudioMode value, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1540  AJA_VIRTUAL bool GetEncodedAudioMode (NTV2EncodedAudioMode & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1541 
1549  AJA_VIRTUAL bool SetEmbeddedAudioClock (const NTV2EmbeddedAudioClock inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1550 
1558  AJA_VIRTUAL bool GetEmbeddedAudioClock (NTV2EmbeddedAudioClock & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1559 
1573  AJA_VIRTUAL bool GetAudioWrapAddress (ULWord & outWrapAddress, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1574 
1584  AJA_VIRTUAL bool GetAudioReadOffset (ULWord & outReadOffset, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1585 
1598  AJA_VIRTUAL bool GetAudioMemoryOffset (const ULWord inOffsetBytes, ULWord & outAbsByteOffset,
1599  const NTV2AudioSystem inAudioSystem, const bool inCaptureBuffer = false); // New in SDK 13.0
1600 
1612  AJA_VIRTUAL bool ReadAudioLastOut (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1613 
1624  AJA_VIRTUAL bool ReadAudioLastIn (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1625 
1640  AJA_VIRTUAL bool StartAudioOutput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1641 
1652  AJA_VIRTUAL bool StopAudioOutput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1653 
1663  AJA_VIRTUAL bool IsAudioOutputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1664 
1676  AJA_VIRTUAL bool SetAudioOutputPause (const NTV2AudioSystem inAudioSystem, const bool inPausePlayout); // New in SDK 12.3
1677 
1686  AJA_VIRTUAL bool GetAudioOutputPause (const NTV2AudioSystem inAudioSystem, bool & outIsPaused); // New in SDK 12.3
1687 
1702  AJA_VIRTUAL bool StartAudioInput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI = false); // New in SDK 14.3
1703 
1715  AJA_VIRTUAL bool StopAudioInput (const NTV2AudioSystem inAudioSystem); // New in SDK 14.3
1716 
1725  AJA_VIRTUAL bool IsAudioInputRunning (const NTV2AudioSystem inAudioSystem, bool & outIsRunning); // New in SDK 14.3
1726 
1738  AJA_VIRTUAL bool SetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 12.3
1739 
1750  AJA_VIRTUAL bool GetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable); // New in SDK 12.3
1751 
1760  AJA_VIRTUAL bool SetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable);
1761 
1772  AJA_VIRTUAL bool GetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, bool & outEnable);
1773 
1785  AJA_VIRTUAL bool SetAudioInputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1786 
1797  AJA_VIRTUAL bool GetAudioInputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1798 
1799 
1810  AJA_VIRTUAL bool SetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay);
1811 
1822  AJA_VIRTUAL bool GetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, ULWord & outDelay);
1823 
1824 
1836  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const bool inIsNonPCM); // New in SDK 12.1
1837 
1838 
1848  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, bool & outIsNonPCM); // New in SDK 12.1
1849 
1850 
1864  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, const bool inIsNonPCM); // New in SDK 12.2
1865 
1866 
1875  AJA_VIRTUAL bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPairs & inNonPCMChannelPairs); // New in SDK 12.4
1876 
1877 
1891  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsNonPCM); // New in SDK 12.2
1892 
1893 
1903  AJA_VIRTUAL bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outNonPCMChannelPairs); // New in SDK 12.4
1904 
1905 
1914  AJA_VIRTUAL bool IsAudioChannelPairPresent (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool & outIsPresent); // New in SDK 12.5
1915 
1916 
1927  AJA_VIRTUAL bool GetDetectedAudioChannelPairs (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 12.5
1928 
1929 
1936  AJA_VIRTUAL bool GetDetectedAESChannelPairs (NTV2AudioChannelPairs & outDetectedChannelPairs); // New in SDK 13.0
1937 
1938 
1952  AJA_VIRTUAL bool SetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, const NTV2AudioSource inAudioSource, const NTV2EmbeddedAudioInput inEmbeddedInput);
1953 
1965  AJA_VIRTUAL bool GetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, NTV2AudioSource & outAudioSource, NTV2EmbeddedAudioInput & outEmbeddedSource);
1966 
1980  AJA_VIRTUAL bool SetEmbeddedAudioInput (const NTV2EmbeddedAudioInput inEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1981 
1992  AJA_VIRTUAL bool GetEmbeddedAudioInput (NTV2EmbeddedAudioInput & outEmbeddedSource, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
1993 
2001  virtual bool InputAudioChannelPairHasPCM (const NTV2Channel inSDIInputConnector, const NTV2AudioChannelPair inAudioChannelPair, bool & outIsPCM); // New in SDK 12.3
2002 
2013  virtual bool GetInputAudioChannelPairsWithPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2014 
2021  virtual bool GetInputAudioChannelPairsWithoutPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs & outChannelPairs); // New in SDK 12.3
2022 
2030  AJA_VIRTUAL bool GetSuspendHostAudio (bool & outIsSuspended); // New in SDK 12.1
2031 
2040  AJA_VIRTUAL bool SetSuspendHostAudio (const bool inSuspend); // New in SDK 12.1
2041 
2052  AJA_VIRTUAL bool GetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, NTV2AudioSystem & outSrcAudioSystem, NTV2Audio4ChannelSelect & outSrcAudioChannels); // New in SDK 12.5
2053 
2064  AJA_VIRTUAL bool SetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, const NTV2AudioSystem inSrcAudioSystem, const NTV2Audio4ChannelSelect inSrcAudioChannels); // New in SDK 12.5
2065 
2074  AJA_VIRTUAL bool SetAudioOutputMonitorSource (const NTV2AudioChannelPair inChannelPair, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
2075 
2084  AJA_VIRTUAL bool GetAudioOutputMonitorSource (NTV2AudioChannelPair & outChannelPair, NTV2AudioSystem & outAudioSystem);
2085 
2094  AJA_VIRTUAL bool GetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, bool & outIsEnabled); // New in SDK 13.0
2095 
2105  AJA_VIRTUAL bool SetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, const bool & inEnable); // New in SDK 13.0
2106 
2115  AJA_VIRTUAL bool GetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, bool & outEraseModeEnabled); // New in SDK 13.0
2116 
2125  AJA_VIRTUAL bool SetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, const bool & inEraseModeEnabled); // New in SDK 13.0
2126 
2134  AJA_VIRTUAL bool GetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, bool & outAESSyncModeBitSet); // New in SDK 15.2
2135 
2143  AJA_VIRTUAL bool SetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, const bool & inAESSyncModeBitSet); // New in SDK 15.2
2144 
2153  AJA_VIRTUAL bool SetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, const bool inEnable); // New in SDK 16.1
2154 
2163  AJA_VIRTUAL bool GetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, bool & outEnabled); // New in SDK 16.1
2164 
2174  AJA_VIRTUAL bool GetRawAudioTimer (ULWord & outValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1); // New in SDK 15.5
2175 
2183  AJA_VIRTUAL bool EnableBOBAnalogAudioIn (bool inEnable); // New in SDK 17.0
2184 
2192  AJA_VIRTUAL bool SetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, const bool inEnable); // New in SDK 16.2
2193 
2201  AJA_VIRTUAL bool GetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, bool & outEnabled); // New in SDK 16.2
2202 
2203 #if !defined(NTV2_DEPRECATE_16_0)
2204  AJA_VIRTUAL NTV2_DEPRECATED_f(bool WriteAudioSource (const ULWord inValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2205  AJA_VIRTUAL NTV2_DEPRECATED_f(bool ReadAudioSource (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1));
2206  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool SetAudioOutputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioOutput(inAudioSystem) : StartAudioOutput(inAudioSystem);}
2207  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool GetAudioOutputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioOutputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2208  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool SetAudioInputReset (const NTV2AudioSystem inAudioSystem, const bool inIsReset)) {return inIsReset ? StopAudioInput(inAudioSystem) : StartAudioInput(inAudioSystem);}
2209  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool GetAudioInputReset (const NTV2AudioSystem inAudioSystem, bool & outIsReset)) {if(!IsAudioInputRunning(inAudioSystem, outIsReset)) return false; outIsReset = !outIsReset; return true; }
2210 #endif // !defined(NTV2_DEPRECATE_16_0)
2211 #if !defined(NTV2_DEPRECATE_16_1)
2212  AJA_VIRTUAL NTV2_DEPRECATED_f(bool SetAnalogAudioIOConfiguration (const NTV2AnalogAudioIO inConfig));
2213  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetAnalogAudioIOConfiguration (NTV2AnalogAudioIO & outConfig));
2214  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastOut(outValue, NTV2AudioSystem(inChannel));}
2215  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadAudioLastIn (ULWord & outValue, const NTV2Channel inChannel)) {return ReadAudioLastIn(outValue, NTV2AudioSystem(inChannel));}
2216  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool WriteAudioLastOut (ULWord & outValue, const NTV2Channel inChannel)) {(void)outValue;(void)inChannel; return false;}
2217 #endif // !defined(NTV2_DEPRECATE_16_1)
2218 #if !defined(NTV2_DEPRECATE_16_3)
2219  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool WriteAudioLastOut (const ULWord inValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1)) {(void)inValue;(void)inAudioSystem; return false;}
2220 #endif // !defined(NTV2_DEPRECATE_16_1)
2221 #if !defined(NTV2_DEPRECATE_17_0)
2222  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool CanDoAudioWaitForVBI(void)) {return IsSupported(kDeviceAudioCanWaitForVBI);}
2223 #endif // !defined(NTV2_DEPRECATE_17_0)
2224 
2229 
2238  AJA_VIRTUAL bool GetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, NTV2AudioSystem & outAudioSystem); // New in SDK 15.5
2239 
2247  AJA_VIRTUAL bool SetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, const NTV2AudioSystem inAudioSystem); // New in SDK 15.5
2248 
2257  AJA_VIRTUAL bool GetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelPair & outChannelPair); // New in SDK 15.5
2258 
2267  AJA_VIRTUAL bool SetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPair inChannelPair); // New in SDK 15.5
2268 
2280  AJA_VIRTUAL bool GetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, ULWord & outGainValue); // New in SDK 15.5
2281 
2293  AJA_VIRTUAL bool SetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, const ULWord inGainValue); // New in SDK 15.5
2294 
2302  AJA_VIRTUAL bool GetAudioMixerOutputGain (ULWord & outGainValue); // New in SDK 15.5
2303 
2311  AJA_VIRTUAL bool SetAudioMixerOutputGain (const ULWord inGainValue); // New in SDK 15.5
2312 
2322  AJA_VIRTUAL bool GetAudioMixerOutputLevels (const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2323 
2331  AJA_VIRTUAL bool GetHeadphoneOutputGain (ULWord & outGainValue);
2332 
2340  AJA_VIRTUAL bool SetHeadphoneOutputGain (const ULWord inGainValue);
2341 
2351  AJA_VIRTUAL bool GetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2352 
2363  AJA_VIRTUAL bool SetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2364 
2375  AJA_VIRTUAL bool GetAudioMixerInputLevels (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPairs & inChannelPairs, std::vector<uint32_t> & outLevels); // New in SDK 15.5
2376 
2383  AJA_VIRTUAL bool GetAudioMixerLevelsSampleCount (ULWord & outSampleCount); // New in SDK 15.5
2384 
2392  AJA_VIRTUAL bool SetAudioMixerLevelsSampleCount (const ULWord inSampleCount); // New in SDK 15.5
2393 
2401  AJA_VIRTUAL bool GetAudioMixerOutputChannelsMute (NTV2AudioChannelsMuted16 & outMutes); // New in SDK 15.5
2402 
2411  AJA_VIRTUAL bool SetAudioMixerOutputChannelsMute (const NTV2AudioChannelsMuted16 inMutes); // New in SDK 15.5
2413 
2414  #if !defined(NTV2_DEPRECATE_16_3)
2415  AJA_VIRTUAL NTV2_DEPRECATED_f(bool WriteGlobalControl(const ULWord inVal)) {return WriteRegister(kRegGlobalControl, inVal);}
2416  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadGlobalControl(ULWord * pOutVal)) {return pOutVal ? ReadRegister(kRegGlobalControl, *pOutVal) : false;}
2417  #endif // !defined(NTV2_DEPRECATE_16_3)
2418 
2419 
2423  AJA_VIRTUAL bool ReadFlashProgramControl(ULWord & outValue);
2425  AJA_VIRTUAL bool IsXilinxProgrammed();
2426  AJA_VIRTUAL bool ProgramMainFlash(const std::string & inFileName, const bool bInForceUpdate = false, const bool bInQuiet = false); // inFileName became const std::string& in SDK 16.2
2427  AJA_VIRTUAL bool GetProgramStatus(SSC_GET_FIRMWARE_PROGRESS_STRUCT *statusStruct);
2428 
2437  AJA_VIRTUAL bool GetRunningFirmwarePackageRevision (ULWord & outRevision);
2438 
2439 
2448  AJA_VIRTUAL bool GetRunningFirmwareRevision (UWord & outRevision);
2449 
2463  AJA_VIRTUAL bool GetRunningFirmwareDate (UWord & outYear, UWord & outMonth, UWord & outDay);
2464 
2478  AJA_VIRTUAL bool GetRunningFirmwareTime (UWord & outHours, UWord & outMinutes, UWord & outSeconds);
2479 
2494  AJA_VIRTUAL bool GetRunningFirmwareDate (std::string & outDate, std::string & outTime);
2495 
2502  AJA_VIRTUAL bool GetRunningFirmwareUserID (ULWord & outUserID); // New in SDK 16.1
2504 
2505 #if !defined(NTV2_DEPRECATE_16_0)
2506  // OEM Mapping to Userspace Functions
2507  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetBaseAddress(NTV2Channel channel, ULWord **pBaseAddress));
2508  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetBaseAddress(ULWord **pBaseAddress));
2509  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetRegisterBaseAddress(ULWord regNumber, ULWord ** pRegAddress));
2510  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetXena2FlashBaseAddress(ULWord ** pXena2FlashAddress));
2511 #endif // !defined(NTV2_DEPRECATE_16_0)
2512 
2513 #if !defined(NTV2_DEPRECATE_17_0)
2514  // Read-Only Status Registers
2515  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus, *pVal) : false;}
2516  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegStatus2, *pVal) : false;}
2517  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadInputStatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus, *pVal) : false;}
2518  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadInputStatus2Register (ULWord *pVal)) {return pVal ? ReadRegister(kRegInputStatus2, *pVal) : false;}
2519  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadInput56StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput56Status, *pVal) : false;}
2520  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool ReadInput78StatusRegister (ULWord *pVal)) {return pVal ? ReadRegister(kRegInput78Status, *pVal) : false;}
2521  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool Read3GInputStatusRegister(ULWord *pVal)) {return pVal ? ReadRegister(kRegSDIInput3GStatus, *pVal) : false;}
2522  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool Read3GInputStatus2Register(ULWord *pVal)) {return pVal ? ReadRegister(kRegSDIInput3GStatus2, *pVal) : false;}
2523  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool Read3GInput5678StatusRegister(ULWord *pVal)) {return pVal ? ReadRegister(kRegSDI5678Input3GStatus, *pVal) : false;}
2524 #endif // !defined(NTV2_DEPRECATE_17_0)
2525 
2526  AJA_VIRTUAL bool SupportsP2PTransfer (void);
2527  AJA_VIRTUAL bool SupportsP2PTarget (void);
2528 
2529 
2533 
2540  AJA_VIRTUAL bool SetLEDState (ULWord inValue);
2541 
2548  AJA_VIRTUAL bool GetLEDState (ULWord & outValue);
2550 
2551 
2555 
2564  AJA_VIRTUAL bool SetRP188Mode (const NTV2Channel inChannel, const NTV2_RP188Mode inMode);
2565 
2573  AJA_VIRTUAL bool GetRP188Mode (const NTV2Channel inChannel, NTV2_RP188Mode & outMode);
2574 
2583  AJA_VIRTUAL bool SetRP188Data (const NTV2Channel inSDIOutput, const NTV2_RP188 & inRP188Data);
2584 
2599  AJA_VIRTUAL bool GetRP188Data (const NTV2Channel inSDIInput, NTV2_RP188 & outRP188Data);
2600 
2609  AJA_VIRTUAL bool SetRP188SourceFilter (const NTV2Channel inSDIInput, const UWord inFilterValue);
2610 
2621  AJA_VIRTUAL bool GetRP188SourceFilter (const NTV2Channel inSDIInput, UWord & outFilterValue);
2622 
2633  AJA_VIRTUAL bool IsRP188BypassEnabled (const NTV2Channel inSDIOutput, bool & outIsBypassEnabled);
2634 
2642  AJA_VIRTUAL bool DisableRP188Bypass (const NTV2Channel inSDIOutput);
2643 
2651  AJA_VIRTUAL bool EnableRP188Bypass (const NTV2Channel inSDIOutput);
2652 
2661  AJA_VIRTUAL bool SetRP188BypassSource (const NTV2Channel inSDIOutput, const UWord inSDIInput);
2662 
2671  AJA_VIRTUAL bool GetRP188BypassSource (const NTV2Channel inSDIOutput, UWord & outSDIInput);
2673 
2674 
2678  //
2680  // Enable Interrupt/Event
2681  //
2682  AJA_VIRTUAL bool EnableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2683 
2690  AJA_VIRTUAL bool EnableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2691 
2698  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2699 
2706  AJA_VIRTUAL bool EnableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2707 
2708 
2709  //
2710  // Disable Interrupt/Event
2711  //
2712  AJA_VIRTUAL bool DisableInterrupt (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2713 
2720  AJA_VIRTUAL bool DisableOutputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2721 
2728  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2Channel channel = NTV2_CHANNEL1);
2729 
2736  AJA_VIRTUAL bool DisableInputInterrupt (const NTV2ChannelSet & inFrameStores);
2737 
2738  AJA_VIRTUAL bool GetCurrentInterruptMasks (NTV2InterruptMask & outIntMask1, NTV2Interrupt2Mask & outIntMask2);
2739 
2740 
2741  //
2742  // Subscribe to events
2743  //
2751  AJA_VIRTUAL bool SubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2752 
2762  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2763 
2773  AJA_VIRTUAL bool SubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2774 
2775 
2785  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2786 
2796  AJA_VIRTUAL bool SubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2797 
2798 
2799  //
2800  // Unsubscribe from events
2801  //
2808  AJA_VIRTUAL bool UnsubscribeEvent (const INTERRUPT_ENUMS inEventCode); // GENERIC!
2809 
2817  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2Channel inChannel);
2818 
2826  AJA_VIRTUAL bool UnsubscribeOutputVerticalEvent (const NTV2ChannelSet & inChannels);
2827 
2835  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2Channel inChannel = NTV2_CHANNEL1);
2836 
2844  AJA_VIRTUAL bool UnsubscribeInputVerticalEvent (const NTV2ChannelSet & inChannels);
2845 
2846 
2847  //
2848  // Get interrupt counts
2849  //
2857  AJA_VIRTUAL bool GetOutputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2858 
2866  AJA_VIRTUAL bool GetInputVerticalInterruptCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2867 
2875  AJA_VIRTUAL bool GetOutputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2876 
2884  AJA_VIRTUAL bool GetInputVerticalEventCount (ULWord & outCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2885 
2893  AJA_VIRTUAL bool SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2894 
2902  AJA_VIRTUAL bool SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel = NTV2_CHANNEL1);
2903 
2904  //
2905  // Current field ID
2906  //
2907 
2914  AJA_VIRTUAL bool GetOutputFieldID (const NTV2Channel channel, NTV2FieldID & outFieldID);
2915 
2922  AJA_VIRTUAL bool GetInputFieldID (const NTV2Channel channel, NTV2FieldID & outFieldID);
2923 
2924  //
2925  // Wait for event
2926  //
2948  AJA_VIRTUAL bool WaitForOutputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2949 
2971  AJA_VIRTUAL bool WaitForOutputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
2972 
2991  AJA_VIRTUAL bool WaitForInputVerticalInterrupt (const NTV2Channel inChannel = NTV2_CHANNEL1, UWord inRepeatCount = 1);
2992 
3013  AJA_VIRTUAL bool WaitForInputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel = NTV2_CHANNEL1);
3014 
3015  //
3016  // RegisterAccess Control
3017  //
3026  AJA_VIRTUAL bool SetRegisterWriteMode (const NTV2RegisterWriteMode inValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3027 
3036  AJA_VIRTUAL bool GetRegisterWriteMode (NTV2RegisterWriteMode & outValue, const NTV2Channel inFrameStore = NTV2_CHANNEL1);
3037 
3038  #if !defined (NTV2_DEPRECATE_16_0)
3039  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool SetRegisterWritemode(NTV2RegisterWriteMode inVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(inVal,inChan);}
3040  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool GetRegisterWritemode(NTV2RegisterWriteMode & outVal, const NTV2Channel inChan=NTV2_CHANNEL1)) {return SetRegisterWriteMode(outVal,inChan);}
3041  #endif // NTV2_DEPRECATE_16_0
3042 
3044  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetForce64(ULWord force64));
3045  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetForce64(ULWord* force64));
3046  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool Get64BitAutodetect(ULWord* autodetect64));
3047 
3051  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetFrameStamp (NTV2Crosspoint channelSpec, ULWord frameNum, FRAME_STAMP_STRUCT* pFrameStamp));
3053  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetAutoCirculate (NTV2Crosspoint channelSpec, AUTOCIRCULATE_STATUS_STRUCT* autoCirculateStatus));
3054 
3055 
3099  AJA_VIRTUAL bool AutoCirculateInitForInput ( const NTV2Channel inChannel,
3100  const UWord inFrameCount = 7,
3101  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3102  const ULWord inOptionFlags = 0,
3103  const UByte inNumChannels = 1,
3104  const UWord inStartFrameNumber = 0,
3105  const UWord inEndFrameNumber = 0);
3106 
3149  AJA_VIRTUAL bool AutoCirculateInitForOutput (const NTV2Channel inChannel,
3150  const UWord inFrameCount = 7,
3151  const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_INVALID,
3152  const ULWord inOptionFlags = 0,
3153  const UByte inNumChannels = 1,
3154  const UWord inStartFrameNumber = 0,
3155  const UWord inEndFrameNumber = 0);
3156 
3188  AJA_VIRTUAL bool AutoCirculateStart (const NTV2Channel inChannel, const ULWord64 inStartTime = 0);
3189 
3205  AJA_VIRTUAL bool AutoCirculateStop (const NTV2Channel inChannel, const bool inAbort = false);
3206 
3215  AJA_VIRTUAL bool AutoCirculateStop (const NTV2ChannelSet & inChannels, const bool inAbort = false); // New in SDK 17.0
3216 
3228  AJA_VIRTUAL bool AutoCirculatePause (const NTV2Channel inChannel, const UWord inAtFrameNum = 0xFFFF); // Added inAtFrameNum in SDK 16.2
3229 
3241  AJA_VIRTUAL bool AutoCirculateResume (const NTV2Channel inChannel, const bool inClearDropCount = false);
3242 
3258  AJA_VIRTUAL bool AutoCirculateFlush (const NTV2Channel inChannel, const bool inClearDropCount = false);
3259 
3276  AJA_VIRTUAL bool AutoCirculatePreRoll (const NTV2Channel inChannel, const ULWord inPreRollFrames);
3277 
3289  AJA_VIRTUAL bool AutoCirculateGetStatus (const NTV2Channel inChannel, AUTOCIRCULATE_STATUS & outStatus);
3290 
3291 
3308  AJA_VIRTUAL bool AutoCirculateGetFrameStamp (const NTV2Channel inChannel, const ULWord inFrameNumber, FRAME_STAMP & outFrameInfo);
3309 
3325  AJA_VIRTUAL bool AutoCirculateSetActiveFrame (const NTV2Channel inChannel, const ULWord inNewActiveFrame);
3326 
3363  AJA_VIRTUAL bool AutoCirculateTransfer (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & transferInfo);
3364 
3383  AJA_VIRTUAL bool FindUnallocatedFrames (const UWord inFrameCount, LWord & outStartFrame, LWord & outEndFrame,
3384  const NTV2Channel inFrameStore = NTV2_CHANNEL_INVALID);
3386 
3390 #define NTV2_STREAM_SUCCESS(__status__) (__status__ == NTV2_STREAM_SUCCESS)
3392 #define NTV2_STREAM_FAIL(__status__) (__status__ != NTV2_STREAM_SUCCESS)
3393 
3398  AJA_VIRTUAL ULWord StreamChannelInitialize (const NTV2Channel inChannel);
3399 
3403  AJA_VIRTUAL ULWord StreamChannelRelease (const NTV2Channel inChannel);
3404 
3410  AJA_VIRTUAL ULWord StreamChannelStart (const NTV2Channel inChannel,
3411  NTV2StreamChannel& status);
3412 
3418  AJA_VIRTUAL ULWord StreamChannelStop (const NTV2Channel inChannel,
3419  NTV2StreamChannel& status);
3420 
3426  AJA_VIRTUAL ULWord StreamChannelFlush (const NTV2Channel inChannel,
3427  NTV2StreamChannel& status);
3428 
3433  AJA_VIRTUAL ULWord StreamChannelStatus (const NTV2Channel inChannel,
3434  NTV2StreamChannel& status);
3435 
3440  AJA_VIRTUAL ULWord StreamChannelWait (const NTV2Channel inChannel,
3441  NTV2StreamChannel& status);
3442 
3448  AJA_VIRTUAL ULWord StreamBufferQueue (const NTV2Channel inChannel,
3449  NTV2Buffer& inBuffer,
3450  ULWord64 bufferCookie,
3451  NTV2StreamBuffer& status);
3452 
3457  AJA_VIRTUAL ULWord StreamBufferRelease (const NTV2Channel inChannel,
3458  NTV2StreamBuffer& status);
3459 
3464  AJA_VIRTUAL ULWord StreamBufferStatus (const NTV2Channel inChannel,
3465  ULWord64 bufferCookie,
3466  NTV2StreamBuffer& status);
3468 
3469 
3470 #if defined(READREGMULTICHANGE)
3471 
3481  AJA_VIRTUAL bool ReadRegisters (const NTV2RegNumSet & inRegNums, NTV2RegisterValueMap & outValues);
3482 #endif // defined(READREGMULTICHANGE)
3483 
3491  AJA_VIRTUAL bool BankSelectReadRegister (const NTV2RegInfo & inBankSelect, NTV2RegInfo & inOutRegInfo);
3492 
3499  AJA_VIRTUAL bool WriteRegisters (const NTV2RegisterWrites & inRegWrites);
3500 
3508  AJA_VIRTUAL bool BankSelectWriteRegister (const NTV2RegInfo & inBankSelect, const NTV2RegInfo & inRegInfo);
3509 
3518  AJA_VIRTUAL bool WriteVirtualData (const ULWord inTag, const void* inVirtualData, const ULWord inVirtualDataSize);
3519 
3528  AJA_VIRTUAL bool ReadVirtualData (const ULWord inTag, void* outVirtualData, const ULWord inVirtualDataSize);
3529 
3536  AJA_VIRTUAL bool ReadSDIStatistics (NTV2SDIInStatistics & outStats);
3537 
3545  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Framesize inSize);
3546 
3554  AJA_VIRTUAL bool SetFrameBufferSize (const NTV2Channel inChannel, const NTV2Framesize inValue);
3555 
3563  AJA_VIRTUAL bool GetFrameBufferSize (const NTV2Channel inChannel, NTV2Framesize & outValue);
3564  using CNTV2DriverInterface::GetFrameBufferSize; // Keep CNTV2DriverInterface::GetFrameBufferSize visible after being shadowed by CNTV2Card::GetFrameBufferSize
3565 
3571  AJA_VIRTUAL bool IsBufferSizeSetBySW (void);
3572 
3580  AJA_VIRTUAL bool DisableChannel (const NTV2Channel inChannel);
3581 
3589  AJA_VIRTUAL bool DisableChannels (const NTV2ChannelSet & inChannels);
3590 
3598  AJA_VIRTUAL bool EnableChannel (const NTV2Channel inChannel);
3599 
3610  AJA_VIRTUAL bool EnableChannels (const NTV2ChannelSet & inChannels, const bool inDisableOthers = false);
3611 
3619  AJA_VIRTUAL bool IsChannelEnabled (const NTV2Channel inChannel, bool & outEnabled);
3620 
3627  AJA_VIRTUAL bool GetEnabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3628 
3635  AJA_VIRTUAL bool GetDisabledChannels (NTV2ChannelSet & outChannels); // New in SDK 16.3
3636 
3637  AJA_VIRTUAL bool SetVideoDACMode (NTV2VideoDACMode inValue);
3638  AJA_VIRTUAL bool GetVideoDACMode (NTV2VideoDACMode & outValue);
3639 
3640 
3644  AJA_VIRTUAL bool GetNominalMinMaxHV (int & outNominalH, int & outMinH, int & outMaxH, int & outNominalV, int & outMinV, int & outMaxV);
3646 
3658  AJA_VIRTUAL bool SetVideoHOffset (const int inHOffset, const UWord inOutputSpigot = 0);
3659 
3670  AJA_VIRTUAL bool GetVideoHOffset (int & outHOffset, const UWord inOutputSpigot = 0);
3671 
3683  AJA_VIRTUAL bool SetVideoVOffset (const int inVOffset, const UWord inOutputSpigot = 0);
3684 
3695  AJA_VIRTUAL bool GetVideoVOffset (int & outVOffset, const UWord inOutputSpigot = 0);
3696 
3697  AJA_VIRTUAL bool SetAnalogOutHTiming (ULWord inValue);
3698  AJA_VIRTUAL bool GetAnalogOutHTiming (ULWord & outValue);
3699 
3714  AJA_VIRTUAL bool WriteOutputTimingControl (const ULWord inValue, const UWord inOutputSpigot = 0);
3715 
3726  AJA_VIRTUAL bool ReadOutputTimingControl (ULWord & outValue, const UWord inOutputSpigot = 0);
3727 
3728  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI1OutHTiming (ULWord value));
3729  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI1OutHTiming(ULWord* value));
3730  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool SetSDI2OutHTiming (ULWord value));
3731  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool GetSDI2OutHTiming(ULWord* value));
3733 
3737  /*
3739  @brief Sets the VPID payload value(s) for each link of the given 3G SDI output.
3740  @param[in] inValueA Specifies the "Link A" VPID value to be embedded in the "A" link output signal.
3741  @param[in] inValueB Specifies the "Link B" VPID value to be embedded in the "B" link output signal.
3742  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3743  Defaults to zero, the first SDI output connector.
3744  @return True if successful; otherwise false.
3745  */
3746  AJA_VIRTUAL bool SetSDIOutVPID (const ULWord inValueA, const ULWord inValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3747 
3748  /*
3749  @brief Answers with the VPID payload value(s) that are currently being embedded for each link of the given 3G SDI output.
3750  @param[out] outValueA Receives the VPID payload value currently being embedded in the "A" link output signal.
3751  @param[out] outValueB Receives the VPID payload value currently being embedded in the "B" link output signal.
3752  @param[in] inOutputSpigot Specifies the SDI output connector of interest as a zero-based index value.
3753  Defaults to zero, the first SDI output connector.
3754  @return True if successful; otherwise false.
3755  */
3756  AJA_VIRTUAL bool GetSDIOutVPID (ULWord & outValueA, ULWord & outValueB, const UWord inOutputSpigot = NTV2_CHANNEL1);
3757 
3758  /*
3759  @brief Reads the latest received VPID payload value(s) for each link of the given SDI input.
3760  @param[in] inSDIInput Specifies the 3G SDI input connector as an ::NTV2Channel, a zero-based index value.
3761  @param[out] outValueA Receives the "Link A" VPID payload value -- or zero if VPID was not present.
3762  @param[out] outValueB Receives the "Link B" VPID payload value -- or zero if VPID was not present.
3763  @return True if successful; otherwise false.
3764  */
3765  AJA_VIRTUAL bool ReadSDIInVPID (const NTV2Channel inSDIInput, ULWord & outValueA, ULWord & outValueB);
3766 
3771  AJA_VIRTUAL bool GetVPIDValidA (const NTV2Channel inChannel);
3772 
3777  AJA_VIRTUAL bool GetVPIDValidB (const NTV2Channel inChannel);
3779 
3786  AJA_VIRTUAL bool SetSDIOutputStandard (const UWord inOutputSpigot, const NTV2Standard inValue);
3787 
3795  AJA_VIRTUAL bool SetSDIOutputStandard (const NTV2ChannelSet & inSDIOutputs, const NTV2Standard inValue); // New in SDK v16.0
3796 
3803  AJA_VIRTUAL bool GetSDIOutputStandard (const UWord inOutputSpigot, NTV2Standard & outValue);
3804 
3805 
3809  AJA_VIRTUAL bool SetUpConvertMode (const NTV2UpConvertMode inValue);
3811  AJA_VIRTUAL bool GetUpConvertMode (NTV2UpConvertMode & outValue);
3812  AJA_VIRTUAL bool SetConverterOutStandard (const NTV2Standard inValue);
3813  AJA_VIRTUAL bool GetConverterOutStandard (NTV2Standard & outValue);
3814  AJA_VIRTUAL bool SetConverterOutRate (const NTV2FrameRate inValue);
3815  AJA_VIRTUAL bool GetConverterOutRate (NTV2FrameRate & outValue);
3816  AJA_VIRTUAL bool SetConverterInStandard (const NTV2Standard inValue);
3817  AJA_VIRTUAL bool GetConverterInStandard (NTV2Standard & outValue);
3818  AJA_VIRTUAL bool SetConverterInRate (const NTV2FrameRate inValue);
3819  AJA_VIRTUAL bool GetConverterInRate (NTV2FrameRate & outValue);
3820  AJA_VIRTUAL bool SetConverterPulldown (const ULWord inValue);
3821  AJA_VIRTUAL bool GetConverterPulldown (ULWord & outValue);
3822  AJA_VIRTUAL bool SetUCPassLine21 (const ULWord inValue);
3823  AJA_VIRTUAL bool GetUCPassLine21 (ULWord & outValue);
3824  AJA_VIRTUAL bool SetUCAutoLine21 (const ULWord inValue);
3825  AJA_VIRTUAL bool GetUCAutoLine21 (ULWord & outValue);
3826 
3827  AJA_VIRTUAL bool SetDownConvertMode (const NTV2DownConvertMode inValue);
3828  AJA_VIRTUAL bool GetDownConvertMode (NTV2DownConvertMode & outValue);
3829  AJA_VIRTUAL bool SetIsoConvertMode (const NTV2IsoConvertMode inValue);
3830  AJA_VIRTUAL bool GetIsoConvertMode (NTV2IsoConvertMode & outValue);
3831  AJA_VIRTUAL bool SetEnableConverter (const bool inValue);
3832  AJA_VIRTUAL bool GetEnableConverter (bool & outValue);
3833  AJA_VIRTUAL bool SetDeinterlaceMode (const ULWord inValue);
3834  AJA_VIRTUAL bool GetDeinterlaceMode (ULWord & outValue);
3835 
3836  AJA_VIRTUAL bool SetConversionMode (const NTV2ConversionMode inConversionMode);
3837  AJA_VIRTUAL bool GetConversionMode (NTV2ConversionMode & outConversionMode);
3839 
3843 
3853  AJA_VIRTUAL bool SetColorSpaceMethod (const NTV2ColorSpaceMethod inCSCMethod, const NTV2Channel inChannel);
3854 
3863  AJA_VIRTUAL bool GetColorSpaceMethod (NTV2ColorSpaceMethod & outMethod, const NTV2Channel inChannel = NTV2_CHANNEL1);
3864 
3873  AJA_VIRTUAL bool SetColorSpaceMatrixSelect (const NTV2ColorSpaceMatrixType inType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3874 
3883  AJA_VIRTUAL bool GetColorSpaceMatrixSelect (NTV2ColorSpaceMatrixType & outType, const NTV2Channel inChannel = NTV2_CHANNEL1);
3884 
3894  AJA_VIRTUAL bool DownloadLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3895  const NTV2Channel inLUT, const int inBank);
3896  AJA_VIRTUAL bool Download12BitLUTToHW (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT,
3897  const NTV2Channel inLUT, const int inBank);
3898 
3908  AJA_VIRTUAL bool DownloadLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3909  const NTV2Channel inLUT, const int inBank);
3910  AJA_VIRTUAL bool Download12BitLUTToHW (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT,
3911  const NTV2Channel inLUT, const int inBank);
3912 
3920  AJA_VIRTUAL bool SetLUTEnable (const bool inEnable, const NTV2Channel inLUT);
3921 
3922  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, NTV2DoubleArray & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
3923  static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, UWordSequence & outTable, const NTV2LutBitDepth inBitDepth = NTV2_LUT10Bit);
3924 
3934  AJA_VIRTUAL bool LoadLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
3935  AJA_VIRTUAL bool Load12BitLUTTables (const NTV2DoubleArray & inRedLUT, const NTV2DoubleArray & inGreenLUT, const NTV2DoubleArray & inBlueLUT);
3936 
3946  AJA_VIRTUAL bool WriteLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
3947  AJA_VIRTUAL bool Write12BitLUTTables (const UWordSequence & inRedLUT, const UWordSequence & inGreenLUT, const UWordSequence & inBlueLUT);
3948 
3958  AJA_VIRTUAL bool GetLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
3959  AJA_VIRTUAL bool Get12BitLUTTables (NTV2DoubleArray & outRedLUT, NTV2DoubleArray & outGreenLUT, NTV2DoubleArray & outBlueLUT);
3960 
3970  AJA_VIRTUAL bool ReadLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
3971  AJA_VIRTUAL bool Read12BitLUTTables (UWordSequence & outRedLUT, UWordSequence & outGreenLUT, UWordSequence & outBlueLUT);
3972 
3973  AJA_VIRTUAL bool SetLUTV2HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
3974  AJA_VIRTUAL bool GetLUTV2HostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel);
3975 
3976  AJA_VIRTUAL bool SetLUTV2OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
3977  AJA_VIRTUAL bool GetLUTV2OutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
3978 
3979  AJA_VIRTUAL bool Has12BitLUTSupport (void);
3980 
3986  AJA_VIRTUAL bool Set12BitLUTPlaneSelect (const NTV2LUTPlaneSelect inLUTPlane);
3987 
3993  AJA_VIRTUAL bool Get12BitLUTPlaneSelect (NTV2LUTPlaneSelect & outLUTPlane);
3994 
4004  AJA_VIRTUAL bool SetColorSpaceRGBBlackRange (const NTV2_CSC_RGB_Range inRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4005 
4015  AJA_VIRTUAL bool GetColorSpaceRGBBlackRange (NTV2_CSC_RGB_Range & outRange, const NTV2Channel inChannel = NTV2_CHANNEL1);
4016 
4017  AJA_VIRTUAL bool SetColorSpaceUseCustomCoefficient (const ULWord inUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4018  AJA_VIRTUAL bool GetColorSpaceUseCustomCoefficient (ULWord & outUseCustomCoefficient, const NTV2Channel inChannel = NTV2_CHANNEL1);
4019 
4030  AJA_VIRTUAL bool SetColorSpaceMakeAlphaFromKey (const bool inMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4031 
4042  AJA_VIRTUAL bool GetColorSpaceMakeAlphaFromKey (ULWord & outMakeAlphaFromKey, const NTV2Channel inChannel = NTV2_CHANNEL1);
4043 
4059  AJA_VIRTUAL bool GetColorSpaceVideoKeySyncFail (bool & outVideoKeySyncFail, const NTV2Channel inChannel = NTV2_CHANNEL1);
4060 
4061  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4062  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4063 
4064  AJA_VIRTUAL bool SetColorSpaceCustomCoefficients12Bit (const NTV2CSCCustomCoeffs & inCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4065  AJA_VIRTUAL bool GetColorSpaceCustomCoefficients12Bit (NTV2CSCCustomCoeffs & outCustomCoefficients, const NTV2Channel inChannel = NTV2_CHANNEL1);
4066 
4067  AJA_VIRTUAL bool SetLUTControlSelect (const NTV2LUTControlSelect inLUTSelect);
4068  AJA_VIRTUAL bool GetLUTControlSelect (NTV2LUTControlSelect & outLUTSelect);
4069 
4070  //
4071  // Color Correction Functions (KHD only )
4072  //
4073  AJA_VIRTUAL bool SetColorCorrectionMode(const NTV2Channel inChannel, const NTV2ColorCorrectionMode inMode);
4074  AJA_VIRTUAL bool GetColorCorrectionMode(const NTV2Channel inChannel, NTV2ColorCorrectionMode & outMode);
4075 
4083  AJA_VIRTUAL bool SetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, const ULWord inBank);
4084 
4092  AJA_VIRTUAL bool GetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, ULWord & outBank);
4093 
4094  AJA_VIRTUAL bool SetColorCorrectionHostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue);
4095  AJA_VIRTUAL bool GetColorCorrectionHostAccessBank (NTV2ColorCorrectionHostAccessBank & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4096 
4097  AJA_VIRTUAL bool SetColorCorrectionSaturation (const NTV2Channel inChannel, const ULWord inValue);
4098  AJA_VIRTUAL bool GetColorCorrectionSaturation (const NTV2Channel inChannel, ULWord & outValue);
4099 
4100  AJA_VIRTUAL bool SetDitherFor8BitInputs (const NTV2Channel inChannel, const ULWord inDither);
4101  AJA_VIRTUAL bool GetDitherFor8BitInputs (const NTV2Channel inChannel, ULWord & outDither);
4102 
4103  // Old APIs
4104  static NTV2_SHOULD_BE_DEPRECATED(bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, double * pOutTable));
4105  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(NTV2ColorSpaceMethod GetColorSpaceMethod (const NTV2Channel inChannel));
4106  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool DownloadLUTToHW(const double * pInTable, const NTV2Channel inChannel, const int inBank));
4107  AJA_VIRTUAL NTV2_SHOULD_BE_DEPRECATED(bool LoadLUTTable (const double * pInTable));
4109 
4110 
4111  AJA_VIRTUAL bool SetSecondaryVideoFormat(NTV2VideoFormat inFormat); // RETAIL USE ONLY
4112  AJA_VIRTUAL bool GetSecondaryVideoFormat(NTV2VideoFormat & outFormat); // RETAIL USE ONLY
4113 
4114  #if !defined(R2_DEPRECATE)
4115  AJA_VIRTUAL bool SetInputVideoSelect (NTV2InputVideoSelect inInputSelect); // RETAIL USE ONLY
4116  AJA_VIRTUAL bool GetInputVideoSelect(NTV2InputVideoSelect & outInputSelect); // RETAIL USE ONLY
4117  #endif
4118 
4119  // --------------------------------------------
4120  // GetNTV2VideoFormat functions
4121  // @deprecated These static functions don't work correctly, and will be deprecated.
4122  // For a given frame rate, geometry and transport, there may be 2 (or more!) possible matching video formats.
4123  // The improved GetNTV2VideoFormat function may return a new CNTV2SDIVideoInfo object that can be interrogated about many things.
4124  // @note This function originated in CNTV2Status.
4125  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, UByte inputGeometry, bool progressiveTransport, bool isThreeG, bool progressivePicture=false);
4126  static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=false, bool isSquareDivision = true);
4127  // --------------------------------------------
4128 
4129 public:
4141  AJA_VIRTUAL NTV2VideoFormat GetInputVideoFormat (const NTV2InputSource inVideoSource = NTV2_INPUTSOURCE_SDI1, const bool inIsProgressive = false);
4142 
4154  AJA_VIRTUAL NTV2VideoFormat GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive = false);
4155 
4161  AJA_VIRTUAL NTV2VideoFormat GetHDMIInputVideoFormat (NTV2Channel inHDMIInput = NTV2_CHANNEL1);
4162 
4167  AJA_VIRTUAL NTV2VideoFormat GetAnalogInputVideoFormat (void);
4168 
4173  AJA_VIRTUAL NTV2VideoFormat GetAnalogCompositeInputVideoFormat (void);
4174 
4184  AJA_VIRTUAL NTV2VideoFormat GetReferenceVideoFormat (void);
4185 
4186  AJA_VIRTUAL NTV2FrameRate GetSDIInputRate (const NTV2Channel channel);
4187  AJA_VIRTUAL NTV2FrameGeometry GetSDIInputGeometry (const NTV2Channel channel);
4188  AJA_VIRTUAL bool GetSDIInputIsProgressive (const NTV2Channel channel);
4189 
4190  AJA_VIRTUAL bool GetSDIInput3GPresent (bool & outValue, const NTV2Channel channel);
4191  AJA_VIRTUAL bool GetSDIInput3GbPresent (bool & outValue, const NTV2Channel channel);
4192  AJA_VIRTUAL bool GetSDIInput6GPresent (bool & outValue, const NTV2Channel channel);
4193  AJA_VIRTUAL bool GetSDIInput12GPresent (bool & outValue, const NTV2Channel channel);
4194 
4198 
4208  AJA_VIRTUAL bool GetConnectedOutput (const NTV2InputCrosspointID inInputXpt, NTV2OutputCrosspointID & outOutputXpt);
4209 
4219  AJA_VIRTUAL bool GetConnectedInput (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointID & outInputXpt);
4220 
4229  AJA_VIRTUAL bool GetConnectedInputs (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointIDSet & outInputXpts); // New in SDK 15.5
4230 
4242  AJA_VIRTUAL bool Connect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, const bool inValidate = false);
4243 
4250  AJA_VIRTUAL bool Disconnect (const NTV2InputCrosspointID inInputXpt);
4251 
4260  AJA_VIRTUAL bool IsConnected (const NTV2InputCrosspointID inInputXpt, bool & outIsConnected);
4261 
4270  AJA_VIRTUAL bool IsConnectedTo (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outIsConnected);
4271 
4272 
4282  AJA_VIRTUAL bool CanConnect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool & outCanConnect);
4283 
4284 
4303  AJA_VIRTUAL bool ApplySignalRoute (const CNTV2SignalRouter & inRouter, const bool inReplace = false);
4304 
4305 
4324  AJA_VIRTUAL bool ApplySignalRoute (const NTV2XptConnections & inConnections, const bool inReplace = false);
4325 
4332  AJA_VIRTUAL bool RemoveConnections (const NTV2XptConnections & inConnections);
4333 
4341  AJA_VIRTUAL bool ClearRouting (void);
4342 
4349  AJA_VIRTUAL bool GetRouting (CNTV2SignalRouter & outRouting);
4350 
4357  AJA_VIRTUAL bool GetConnections (NTV2XptConnections & outConnections); // New in SDK 16.0
4358 
4366  AJA_VIRTUAL bool GetRoutingForChannel (const NTV2Channel inChannel, CNTV2SignalRouter & outRouting);
4367 
4368 #if !defined(NTV2_DEPRECATE_17_0)
4369  AJA_VIRTUAL inline NTV2_SHOULD_BE_DEPRECATED(bool HasCanConnectROM(void)) {return IsSupported(kDeviceHasXptConnectROM);}
4370 #endif // !defined(NTV2_DEPRECATE_17_0)
4371 
4376  AJA_VIRTUAL bool GetPossibleConnections (NTV2PossibleConnections & outConnections);
4378 
4379 
4384  AJA_VIRTUAL bool WriteSDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4386  AJA_VIRTUAL bool WriteSDBrightnessAdjustment (const ULWord inNewValue);
4387  AJA_VIRTUAL bool WriteSDContrastAdjustment (const ULWord inNewValue);
4388  AJA_VIRTUAL bool WriteSDSaturationAdjustment (const ULWord inNewValue);
4389  AJA_VIRTUAL bool WriteSDHueAdjustment (const ULWord inNewValue);
4390  AJA_VIRTUAL bool WriteSDCbOffsetAdjustment (const ULWord inNewValue);
4391  AJA_VIRTUAL bool WriteSDCrOffsetAdjustment (const ULWord inNewValue);
4392  AJA_VIRTUAL bool WriteHDProcAmpControlsInitialized (const ULWord inNewValue = 1);
4393  AJA_VIRTUAL bool WriteHDBrightnessAdjustment (const ULWord inNewValue);
4394  AJA_VIRTUAL bool WriteHDContrastAdjustment (const ULWord inNewValue);
4395  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCb (const ULWord inNewValue);
4396  AJA_VIRTUAL bool WriteHDSaturationAdjustmentCr (const ULWord inNewValue);
4397  AJA_VIRTUAL bool WriteHDCbOffsetAdjustment (const ULWord inNewValue);
4398  AJA_VIRTUAL bool WriteHDCrOffsetAdjustment (const ULWord inNewValue);
4399 
4400  AJA_VIRTUAL bool ReadSDProcAmpControlsInitialized (ULWord & outValue);
4401  AJA_VIRTUAL bool ReadSDBrightnessAdjustment (ULWord & outValue);
4402  AJA_VIRTUAL bool ReadSDContrastAdjustment (ULWord & outValue);
4403  AJA_VIRTUAL bool ReadSDSaturationAdjustment (ULWord & outValue);
4404  AJA_VIRTUAL bool ReadSDHueAdjustment (ULWord & outValue);
4405  AJA_VIRTUAL bool ReadSDCbOffsetAdjustment (ULWord & outValue);
4406  AJA_VIRTUAL bool ReadSDCrOffsetAdjustment (ULWord & outValue);
4407  AJA_VIRTUAL bool ReadHDProcAmpControlsInitialized (ULWord & outValue);
4408  AJA_VIRTUAL bool ReadHDBrightnessAdjustment (ULWord & outValue);
4409  AJA_VIRTUAL bool ReadHDContrastAdjustment (ULWord & outValue);
4410  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCb (ULWord & outValue);
4411  AJA_VIRTUAL bool ReadHDSaturationAdjustmentCr (ULWord & outValue);
4412  AJA_VIRTUAL bool ReadHDCbOffsetAdjustment (ULWord & outValue);
4413  AJA_VIRTUAL bool ReadHDCrOffsetAdjustment (ULWord & outValue);
4414 
4415  // FS1 (and other?) ProcAmp methods
4416  AJA_VIRTUAL bool WriteProcAmpC1YAdjustment (const ULWord inNewValue);
4417  AJA_VIRTUAL bool WriteProcAmpC1CBAdjustment (const ULWord inNewValue);
4418  AJA_VIRTUAL bool WriteProcAmpC1CRAdjustment (const ULWord inNewValue);
4419  AJA_VIRTUAL bool WriteProcAmpC2CBAdjustment (const ULWord inNewValue);
4420  AJA_VIRTUAL bool WriteProcAmpC2CRAdjustment (const ULWord inNewValue);
4421  AJA_VIRTUAL bool WriteProcAmpOffsetYAdjustment (const ULWord inNewValue);
4422  AJA_VIRTUAL bool ReadProcAmpC1YAdjustment (ULWord & outValue);
4423  AJA_VIRTUAL bool ReadProcAmpC1CBAdjustment (ULWord & outValue);
4424  AJA_VIRTUAL bool ReadProcAmpC1CRAdjustment (ULWord & outValue);
4425  AJA_VIRTUAL bool ReadProcAmpC2CBAdjustment (ULWord & outValue);
4426  AJA_VIRTUAL bool ReadProcAmpC2CRAdjustment (ULWord & outValue);
4427  AJA_VIRTUAL bool ReadProcAmpOffsetYAdjustment (ULWord & outValue);
4428 
4429  #if !defined(R2_DEPRECATE)
4430  AJA_VIRTUAL bool SetAnalogInputADCMode (const NTV2LSVideoADCMode inValue);
4431  AJA_VIRTUAL bool GetAnalogInputADCMode (NTV2LSVideoADCMode & outValue);
4432  #endif
4433 
4435 
4439 
4446  AJA_VIRTUAL bool GetHDMIInputColor (NTV2LHIHDMIColorSpace & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4447 
4454  AJA_VIRTUAL bool SetHDMIInputRange (const NTV2HDMIRange inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4455 
4462  AJA_VIRTUAL bool GetHDMIInputRange (NTV2HDMIRange & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4463 
4470  AJA_VIRTUAL bool GetHDMIInputAudioChannels (NTV2HDMIAudioChannels & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4471 
4478  AJA_VIRTUAL bool SetHDMIInColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4479 
4486  AJA_VIRTUAL bool GetHDMIInColorSpace (NTV2HDMIColorSpace & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4487 
4494  AJA_VIRTUAL bool GetHDMIInProtocol (NTV2HDMIProtocol & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4495 
4502  AJA_VIRTUAL bool GetHDMIInIsLocked (bool & outIsLocked, const NTV2Channel inChannel = NTV2_CHANNEL1);
4503 
4504  AJA_VIRTUAL bool SetHDMIInAudioSampleRateConverterEnable (const bool inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4505  AJA_VIRTUAL bool GetHDMIInAudioSampleRateConverterEnable (bool & outIsEnabled, const NTV2Channel inChannel = NTV2_CHANNEL1);
4506 
4513  AJA_VIRTUAL bool SetHDMIInBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4514 
4521  AJA_VIRTUAL bool GetHDMIInBitDepth (NTV2HDMIBitDepth & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4522 
4530  AJA_VIRTUAL bool GetHDMIInAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inChannel = NTV2_CHANNEL1); // New in SDK v16.0
4531 
4539  AJA_VIRTUAL bool SetHDMIInAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inChannel = NTV2_CHANNEL1); // New in SDK v16.0
4540 
4541 
4548  AJA_VIRTUAL bool GetHDMIInVideoRange (NTV2HDMIRange & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1);
4549 
4556  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRRegValues & outRegValues, const NTV2Channel inChannel = NTV2_CHANNEL1);
4557 
4564  AJA_VIRTUAL bool GetHDMIInDynamicRange (HDRFloatValues & outFloatValues, const NTV2Channel inChannel = NTV2_CHANNEL1);
4565 
4573  AJA_VIRTUAL bool GetHDMIInColorimetry (NTV2HDMIColorimetry & outColorimetry, const NTV2Channel inChannel = NTV2_CHANNEL1); // New in SDK v16.0
4574 
4582  AJA_VIRTUAL bool GetHDMIInDolbyVision (bool & outIsDolbyVision, const NTV2Channel inChannel = NTV2_CHANNEL1); // New in SDK v16.0
4583 
4584  AJA_VIRTUAL bool SetHDMIOut3DPresent (const bool inIs3DPresent);
4585  AJA_VIRTUAL bool GetHDMIOut3DPresent (bool & outIs3DPresent);
4586 
4587  AJA_VIRTUAL bool SetHDMIOut3DMode (const NTV2HDMIOut3DMode inValue);
4588  AJA_VIRTUAL bool GetHDMIOut3DMode (NTV2HDMIOut3DMode & outValue);
4589 
4590  AJA_VIRTUAL bool SetHDMIV2TxBypass (const bool inBypass);
4591 
4592  AJA_VIRTUAL bool SetHDMIOutVideoStandard (const NTV2Standard inNewValue);
4593  AJA_VIRTUAL bool GetHDMIOutVideoStandard (NTV2Standard & outValue);
4594 
4595  AJA_VIRTUAL bool SetHDMIOutSampleStructure (const NTV2HDMISampleStructure inNewValue);
4596  AJA_VIRTUAL bool GetHDMIOutSampleStructure (NTV2HDMISampleStructure & outValue);
4597 
4598  AJA_VIRTUAL bool SetHDMIOutVideoFPS (const NTV2FrameRate inNewValue);
4599  AJA_VIRTUAL bool GetHDMIOutVideoFPS (NTV2FrameRate & outValue);
4600 
4601  AJA_VIRTUAL bool SetHDMIOutRange (const NTV2HDMIRange inNewValue);
4602  AJA_VIRTUAL bool GetHDMIOutRange (NTV2HDMIRange & outValue);
4603 
4604  AJA_VIRTUAL bool SetHDMIOutAudioChannels (const NTV2HDMIAudioChannels inNewValue);
4605  AJA_VIRTUAL bool GetHDMIOutAudioChannels (NTV2HDMIAudioChannels & outValue);
4606 
4607  AJA_VIRTUAL bool SetHDMIOutColorSpace (const NTV2HDMIColorSpace inNewValue);
4608  AJA_VIRTUAL bool GetHDMIOutColorSpace (NTV2HDMIColorSpace & outValue);
4609  AJA_VIRTUAL bool SetLHIHDMIOutColorSpace (const NTV2LHIHDMIColorSpace inNewValue);
4610  AJA_VIRTUAL bool GetLHIHDMIOutColorSpace (NTV2LHIHDMIColorSpace & outValue);
4611 
4612  AJA_VIRTUAL bool SetHDMIOutBitDepth (const NTV2HDMIBitDepth inNewValue);
4613  AJA_VIRTUAL bool GetHDMIOutBitDepth (NTV2HDMIBitDepth & outValue);
4614 
4615  AJA_VIRTUAL bool SetHDMIOutProtocol (const NTV2HDMIProtocol inNewValue);
4616  AJA_VIRTUAL bool GetHDMIOutProtocol (NTV2HDMIProtocol & outValue);
4617 
4618  AJA_VIRTUAL bool SetHDMIOutForceConfig (const bool inNewValue);
4619  AJA_VIRTUAL bool GetHDMIOutForceConfig (bool & outValue);
4620 
4621  AJA_VIRTUAL bool SetHDMIOutPrefer420 (const bool inNewValue);
4622  AJA_VIRTUAL bool GetHDMIOutPrefer420 (bool & outValue);
4623 
4624  AJA_VIRTUAL bool GetHDMIOutDownstreamBitDepth (NTV2HDMIBitDepth & outValue);
4625 
4626  AJA_VIRTUAL bool GetHDMIOutDownstreamColorSpace (NTV2LHIHDMIColorSpace & outValue);
4627 
4634  AJA_VIRTUAL bool SetHDMIOutAudioSource2Channel (const NTV2AudioChannelPair inNewValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
4635 
4642  AJA_VIRTUAL bool GetHDMIOutAudioSource2Channel (NTV2AudioChannelPair & outValue, NTV2AudioSystem & outAudioSystem);
4643 
4650  AJA_VIRTUAL bool SetHDMIOutAudioSource8Channel (const NTV2Audio8ChannelSelect inNewValue, const NTV2AudioSystem inAudioSystem = NTV2_AUDIOSYSTEM_1);
4651 
4658  AJA_VIRTUAL bool GetHDMIOutAudioSource8Channel (NTV2Audio8ChannelSelect & outValue, NTV2AudioSystem & outAudioSystem);
4659 
4668  AJA_VIRTUAL bool GetHDMIOutAudioChannel34Swap (bool & outIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
4669 
4678  AJA_VIRTUAL bool SetHDMIOutAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inWhichHDMIOut = NTV2_CHANNEL1); // New in SDK v16.0
4679 
4685  AJA_VIRTUAL bool SetHDMIOutAudioRate (const NTV2AudioRate inNewValue);
4686 
4692  AJA_VIRTUAL bool GetHDMIOutAudioRate (NTV2AudioRate & outValue);
4693 
4699  AJA_VIRTUAL bool SetHDMIOutAudioFormat (const NTV2AudioFormat inNewValue);
4700 
4706  AJA_VIRTUAL bool GetHDMIOutAudioFormat (NTV2AudioFormat & outValue);
4707 
4713  AJA_VIRTUAL bool EnableHDMIOutUserOverride (const bool inEnable);
4714 
4720  AJA_VIRTUAL bool GetEnableHDMIOutUserOverride (bool & outIsEnabled);
4721 
4727  AJA_VIRTUAL bool EnableHDMIOutCenterCrop (const bool inEnable);
4728 
4734  AJA_VIRTUAL bool GetEnableHDMIOutCenterCrop (bool & outIsEnabled);
4735 
4743  AJA_VIRTUAL bool SetHDMIOutDecimateMode (const bool inEnable);
4744 
4745  AJA_VIRTUAL bool GetHDMIOutDecimateMode (bool & outIsEnabled);
4746 
4752  AJA_VIRTUAL bool SetHDMIOutTsiIO (const bool inTsiEnable);
4753 
4754  AJA_VIRTUAL bool GetHDMIOutTsiIO (bool & tsiEnabled);
4755 
4761  AJA_VIRTUAL bool SetHDMIOutLevelBMode (const bool inEnable);
4762 
4763  AJA_VIRTUAL bool GetHDMIOutLevelBMode (bool & outIsEnabled);
4764 
4774  AJA_VIRTUAL bool SetHDMIV2Mode (const NTV2HDMIV2Mode inMode);
4775 
4781  AJA_VIRTUAL bool GetHDMIV2Mode (NTV2HDMIV2Mode & outMode);
4782 
4783 
4789  AJA_VIRTUAL bool GetHDMIOutStatus (NTV2HDMIOutputStatus & outStatus); // New in SDK 16.1
4790 
4791  //protected: SHOULD BE PROTECTED/PRIVATE:
4792  AJA_VIRTUAL bool GetHDMIInputStatus (ULWord & outValue, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
4793  protected:
4794  AJA_VIRTUAL bool GetHDMIInputStatusRegNum (ULWord & outRegNum, const NTV2Channel inChannel = NTV2_CHANNEL1, const bool in12BitDetection = false);
4795 
4797  public:
4798  AJA_VIRTUAL bool SetLHIVideoDACStandard (const NTV2Standard inValue);
4799  AJA_VIRTUAL bool GetLHIVideoDACStandard (NTV2Standard & outValue);
4800  AJA_VIRTUAL bool SetLHIVideoDACMode (NTV2LHIVideoDACMode value);
4801  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2LHIVideoDACMode & outValue);
4802  AJA_VIRTUAL bool SetLHIVideoDACMode (const NTV2VideoDACMode inValue); // overloaded
4803  AJA_VIRTUAL bool GetLHIVideoDACMode (NTV2VideoDACMode & outValue); // overloaded
4804 
4808 
4819  AJA_VIRTUAL bool SetLTCInputEnable (const bool inEnable);
4820 
4831  AJA_VIRTUAL bool GetLTCInputEnable (bool & outIsEnabled);
4832 
4843  AJA_VIRTUAL bool GetLTCInputPresent (bool & outIsPresent, const UWord inLTCInputNdx = 0);
4844 
4854  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, RP188_STRUCT & outRP188Data);
4855 
4865  AJA_VIRTUAL bool ReadAnalogLTCInput (const UWord inLTCInput, NTV2_RP188 & outRP188Data);
4866 
4877  AJA_VIRTUAL bool GetAnalogLTCInClockChannel (const UWord inLTCInput, NTV2Channel & outChannel);
4878 
4889  AJA_VIRTUAL bool SetAnalogLTCInClockChannel (const UWord inLTCInput, const NTV2Channel inChannel);
4890 
4900  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const RP188_STRUCT & inRP188Data);
4901 
4911  AJA_VIRTUAL bool WriteAnalogLTCOutput (const UWord inLTCOutput, const NTV2_RP188 & inRP188Data);
4912 
4923  AJA_VIRTUAL bool GetAnalogLTCOutClockChannel (const UWord inLTCOutput, NTV2Channel & outChannel);
4924 
4935  AJA_VIRTUAL bool SetAnalogLTCOutClockChannel (const UWord inLTCOutput, const NTV2Channel inChannel);
4936 
4937 #if !defined(NTV2_DEPRECATE_16_3)
4938  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool SetLTCOnReference(bool val)) {return SetLTCInputEnable(val);}
4939  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool GetLTCOnReference(bool & outVal)) {return GetLTCInputEnable(outVal);}
4940  AJA_VIRTUAL NTV2_DEPRECATED_f(bool SetLTCEmbeddedOutEnable (const bool inNewValue));
4941  AJA_VIRTUAL NTV2_DEPRECATED_f(bool GetLTCEmbeddedOutEnable (bool & outValue));
4942 #endif // !defined(NTV2_DEPRECATE_16_3)
4943 
4948  AJA_VIRTUAL bool SetStereoCompressorOutputMode (const NTV2StereoCompressorOutputMode inNewValue);
4950  AJA_VIRTUAL bool GetStereoCompressorOutputMode (NTV2StereoCompressorOutputMode & outValue);
4951  AJA_VIRTUAL bool SetStereoCompressorFlipMode (const ULWord inNewValue);
4952  AJA_VIRTUAL bool GetStereoCompressorFlipMode (ULWord & outValue);
4953  AJA_VIRTUAL bool SetStereoCompressorFlipLeftHorz (const ULWord inNewValue);
4954  AJA_VIRTUAL bool GetStereoCompressorFlipLeftHorz (ULWord & outValue);
4955  AJA_VIRTUAL bool SetStereoCompressorFlipLeftVert (const ULWord inNewValue);
4956  AJA_VIRTUAL bool GetStereoCompressorFlipLeftVert (ULWord & outValue);
4957  AJA_VIRTUAL bool SetStereoCompressorFlipRightHorz (const ULWord inNewValue);
4958  AJA_VIRTUAL bool GetStereoCompressorFlipRightHorz (ULWord & outValue);
4959  AJA_VIRTUAL bool SetStereoCompressorFlipRightVert (const ULWord inNewValue);
4960  AJA_VIRTUAL bool GetStereoCompressorFlipRightVert (ULWord & outValue);
4961  AJA_VIRTUAL bool SetStereoCompressorStandard (const NTV2Standard inNewValue);
4962  AJA_VIRTUAL bool GetStereoCompressorStandard (NTV2Standard & outValue);
4963  AJA_VIRTUAL bool SetStereoCompressorLeftSource (const NTV2OutputCrosspointID inNewValue);
4964  AJA_VIRTUAL bool GetStereoCompressorLeftSource (NTV2OutputCrosspointID & outValue);
4965  AJA_VIRTUAL bool SetStereoCompressorRightSource (const NTV2OutputCrosspointID inNewValue);
4966  AJA_VIRTUAL bool GetStereoCompressorRightSource (NTV2OutputCrosspointID & outValue);
4968 
4972 
4985  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2Channel inChannel, const bool inEnable);
4986 
4999  AJA_VIRTUAL bool SetSDITransmitEnable (const NTV2ChannelSet & inSDIConnectors, const bool inEnable);
5000 
5010  AJA_VIRTUAL bool GetSDITransmitEnable (const NTV2Channel inChannel, bool & outEnabled);
5011 
5021  AJA_VIRTUAL bool GetTransmitSDIs (NTV2ChannelSet & outXmitSDIs); // New in SDK 17.0
5023 
5024  AJA_VIRTUAL bool SetSDIOut2Kx1080Enable (const NTV2Channel inChannel, const bool inIsEnabled);
5025  AJA_VIRTUAL bool GetSDIOut2Kx1080Enable (const NTV2Channel inChannel, bool & outIsEnabled);
5026 
5027  AJA_VIRTUAL bool SetSDIOut3GEnable (const NTV2Channel inChannel,const bool inEnable);
5028  AJA_VIRTUAL bool GetSDIOut3GEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5029 
5030  AJA_VIRTUAL bool SetSDIOut3GbEnable (const NTV2Channel inChannel, const bool inEnable);
5031  AJA_VIRTUAL bool GetSDIOut3GbEnable (const NTV2Channel inChannel, bool & outIsEnabled);
5032 
5033  AJA_VIRTUAL bool SetSDIOut6GEnable(const NTV2Channel inChannel, const bool inEnable);
5034  AJA_VIRTUAL bool GetSDIOut6GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5035 
5036  AJA_VIRTUAL bool SetSDIOut12GEnable(const NTV2Channel inChannel, const bool inEnable);
5037  AJA_VIRTUAL bool GetSDIOut12GEnable(const NTV2Channel inChannel, bool & outIsEnabled);
5038 
5051  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5052 
5066  AJA_VIRTUAL bool SetSDIOutputAudioSystem (const NTV2ChannelSet & inSDIOutputs, const NTV2AudioSystem inAudioSystem, const bool inDS2 = false); // New in SDK 16.2
5067 
5078  AJA_VIRTUAL bool GetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5079 
5091  AJA_VIRTUAL bool SetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem);
5092 
5104  AJA_VIRTUAL bool GetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem & outAudioSystem);
5105 
5106 
5110 
5120  AJA_VIRTUAL bool GetSDIRelayPosition (NTV2RelayState & outValue, const UWord inIndex0);
5121 
5132  AJA_VIRTUAL bool GetSDIRelayManualControl (NTV2RelayState & outValue, const UWord inIndex0);
5133 
5145  AJA_VIRTUAL bool SetSDIRelayManualControl (const NTV2RelayState inValue, const UWord inIndex0);
5146 
5156  AJA_VIRTUAL bool GetSDIWatchdogEnable (bool & outIsEnabled, const UWord inIndex0);
5157 
5171  AJA_VIRTUAL bool SetSDIWatchdogEnable (const bool inEnable, const UWord inIndex0);
5172 
5180  AJA_VIRTUAL bool GetSDIWatchdogStatus (NTV2RelayState & outValue);
5181 
5188  AJA_VIRTUAL bool GetSDIWatchdogTimeout (ULWord & outValue);
5189 
5198  AJA_VIRTUAL bool SetSDIWatchdogTimeout (const ULWord inValue);
5199 
5204  AJA_VIRTUAL bool KickSDIWatchdog (void);
5206 
5210 
5217  AJA_VIRTUAL bool Enable4KDCRGBMode(bool inEnable);
5218 
5219  AJA_VIRTUAL bool GetEnable4KDCRGBMode(bool & outIsEnabled);
5220 
5227  AJA_VIRTUAL bool Enable4KDCYCC444Mode(bool inEnable);
5228 
5229  AJA_VIRTUAL bool GetEnable4KDCYCC444Mode(bool & outIsEnabled);
5230 
5237  AJA_VIRTUAL bool Enable4KDCPSFInMode(bool inEnable);
5238 
5239  AJA_VIRTUAL bool GetEnable4KDCPSFInMode(bool & outIsEnabled);
5240 
5247  AJA_VIRTUAL bool Enable4KPSFOutMode(bool inEnable);
5248 
5249  AJA_VIRTUAL bool GetEnable4KPSFOutMode(bool & outIsEnabled);
5251 
5252 
5261  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const NTV2ChannelSet & inSDIInputs, const bool inEnable);
5262 
5270  AJA_VIRTUAL bool SetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, const bool inEnable);
5271 
5278  AJA_VIRTUAL bool GetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, bool & outIsEnabled);
5279 
5287  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, const bool inEnable);
5288 
5297  AJA_VIRTUAL bool SetSDIOutLevelAtoLevelBConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5298 
5305  AJA_VIRTUAL bool GetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5306 
5313  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, const bool inEnable);
5314 
5323  AJA_VIRTUAL bool SetSDIOutRGBLevelAConversion (const NTV2ChannelSet & inSDIOutputs, const bool inEnable); // New in SDK v16.0
5324 
5331  AJA_VIRTUAL bool GetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, bool & outIsEnabled);
5332 
5333 
5337 
5342  AJA_VIRTUAL bool GetSDITRSError (const NTV2Channel inChannel);
5343 
5349  AJA_VIRTUAL bool GetSDILock (const NTV2Channel inChannel);
5350 
5356  AJA_VIRTUAL ULWord GetSDIUnlockCount (const NTV2Channel inChannel);
5357 
5363  AJA_VIRTUAL ULWord GetCRCErrorCountA (const NTV2Channel inChannel);
5364 
5370  AJA_VIRTUAL ULWord GetCRCErrorCountB (const NTV2Channel inChannel);
5372 
5385  AJA_VIRTUAL bool SetMultiFormatMode (const bool inEnable);
5386 
5398  AJA_VIRTUAL bool GetMultiFormatMode (bool & outIsEnabled);
5399 
5400 
5401 public:
5405 
5417  AJA_VIRTUAL bool SetRS422Parity (const NTV2Channel inSerialPort, const NTV2_RS422_PARITY inParity);
5418 
5429  AJA_VIRTUAL bool GetRS422Parity (const NTV2Channel inSerialPort, NTV2_RS422_PARITY & outParity);
5430 
5443  AJA_VIRTUAL bool SetRS422BaudRate (const NTV2Channel inSerialPort, const NTV2_RS422_BAUD_RATE inBaudRate);
5444 
5455  AJA_VIRTUAL bool GetRS422BaudRate (const NTV2Channel inSerialPort, NTV2_RS422_BAUD_RATE & outBaudRate);
5457 
5461 
5475  AJA_VIRTUAL bool AncSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size); // New in SDK 16.0
5476 
5477 
5491  AJA_VIRTUAL bool AncInsertInit (const UWord inSDIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5492  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5493 
5506  AJA_VIRTUAL bool AncInsertSetComponents (const UWord inSDIOutput,
5507  const bool inVancY, const bool inVancC,
5508  const bool inHancY, const bool inHancC); // New in SDK 16.0
5509 
5519  AJA_VIRTUAL bool AncInsertSetEnable (const UWord inSDIOutput, const bool inIsEnabled); // New in SDK 15.0
5520 
5528  AJA_VIRTUAL bool AncInsertIsEnabled (const UWord inSDIOutput, bool & outIsEnabled); // New in SDK 15.0
5529 
5546  AJA_VIRTUAL bool AncInsertSetReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
5547  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5548  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5549 
5566  AJA_VIRTUAL bool AncInsertSetField2ReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
5567  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5568  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5569 
5578  AJA_VIRTUAL bool AncInsertSetIPParams (const UWord inSDIOutput, const UWord ancChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 15.2
5579 
5587  AJA_VIRTUAL bool AncInsertGetReadInfo (const UWord inSDIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK v16.2
5588 
5589 
5605  AJA_VIRTUAL bool AncExtractInit (const UWord inSDIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5606  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 15.0
5607 
5620  AJA_VIRTUAL bool AncExtractSetComponents (const UWord inSDIInput,
5621  const bool inVancY, const bool inVancC,
5622  const bool inHancY, const bool inHancC); // New in SDK 16.0
5623 
5634  AJA_VIRTUAL bool AncExtractSetEnable (const UWord inSDIInput, const bool inIsEnabled); // New in SDK 15.0
5635 
5644  AJA_VIRTUAL bool AncExtractIsEnabled (const UWord inSDIInput, bool & outIsEnabled); // New in SDK 15.0
5645 
5662  AJA_VIRTUAL bool AncExtractSetWriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
5663  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5664  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5665 
5682  AJA_VIRTUAL bool AncExtractSetField2WriteParams (const UWord inSDIInput, const ULWord inFrameNumber,
5683  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5684  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 15.0
5685 
5697  AJA_VIRTUAL bool AncExtractGetWriteInfo (const UWord inSDIInput,
5698  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
5699  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK v16.2
5700 
5710  AJA_VIRTUAL bool AncExtractGetFilterDIDs (const UWord inSDIInput, NTV2DIDSet & outDIDs); // New in SDK 15.0
5711 
5722  AJA_VIRTUAL bool AncExtractSetFilterDIDs (const UWord inSDIInput, const NTV2DIDSet & inDIDs); // New in SDK 15.0
5723 
5731  AJA_VIRTUAL bool AncExtractGetField1Size (const UWord inSDIInput, ULWord & outF1Size); // New in SDK 16.0
5732 
5740  AJA_VIRTUAL bool AncExtractGetField2Size (const UWord inSDIInput, ULWord & outF2Size); // New in SDK 16.0
5741 
5755  AJA_VIRTUAL bool AncExtractGetBufferOverrun (const UWord inSDIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 15.0
5756 
5764  AJA_VIRTUAL bool AncExtractIsProgressive (const UWord inSDIInput, bool & outIsProgressive); // New in SDK 17.1
5765 
5770  static UWord AncExtractGetMaxNumFilterDIDs (void); // New in SDK 15.0
5771 
5779  static NTV2DIDSet AncExtractGetDefaultDIDs (const bool inHDAudio = true); // New in SDK 13.0
5781 
5785 
5795  AJA_VIRTUAL bool AuxSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size) // New in SDK 17.1
5796  {return IsSupported(kDeviceCanDoHDMIAuxCapture) && AncSetFrameBufferSize(inF1Size,inF2Size);}
5797 
5798 
5811  AJA_VIRTUAL bool AuxInsertInit (const UWord inHDMIOutput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5812  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
5813 
5825  AJA_VIRTUAL bool AuxInsertSetComponents (const UWord inHDMIOutput,
5826  const bool inVauxY, const bool inVauxC,
5827  const bool inHauxY, const bool inHauxC); // New in SDK 17.1
5828 
5837  AJA_VIRTUAL bool AuxInsertSetEnable (const UWord inHDMIOutput, const bool inIsEnabled); // New in SDK 17.1
5838 
5845  AJA_VIRTUAL bool AuxInsertIsEnabled (const UWord inHDMIOutput, bool & outIsEnabled); // New in SDK 17.1
5846 
5862  AJA_VIRTUAL bool AuxInsertSetReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF1Size,
5863  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5864  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
5865 
5881  AJA_VIRTUAL bool AuxInsertSetField2ReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF2Size,
5882  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5883  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
5884 
5893  AJA_VIRTUAL bool AuxInsertSetIPParams (const UWord inHDMIOutput, const UWord auxChannel, const ULWord payloadID, const ULWord ssrc); // New in SDK 17.1
5894 
5902  AJA_VIRTUAL bool AuxInsertGetReadInfo (const UWord inHDMIOutput, uint64_t & outF1StartAddr, uint64_t & outF2StartAddr); // New in SDK 17.1
5903 
5904 
5919  AJA_VIRTUAL bool AuxExtractInit (const UWord inHDMIInput, const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5920  const NTV2Standard inStandard = NTV2_STANDARD_INVALID); // New in SDK 17.1
5930  AJA_VIRTUAL bool AuxExtractSetEnable (const UWord inHDMIInput, const bool inIsEnabled); // New in SDK 17.1
5931 
5939  AJA_VIRTUAL bool AuxExtractIsEnabled (const UWord inHDMIInput, bool & outIsEnabled); // New in SDK 17.1
5940 
5957  AJA_VIRTUAL bool AuxExtractSetWriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
5958  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5959  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
5960 
5977  AJA_VIRTUAL bool AuxExtractSetField2WriteParams (const UWord inHDMIInput, const ULWord inFrameNumber,
5978  const NTV2Channel inChannel = NTV2_CHANNEL_INVALID,
5979  const NTV2Framesize inFrameSize = NTV2_FRAMESIZE_INVALID); // New in SDK 17.1
5980 
5991  AJA_VIRTUAL bool AuxExtractGetWriteInfo (const UWord inHDMIInput,
5992  uint64_t & outF1StartAddr, uint64_t & outF1EndAddr,
5993  uint64_t & outF2StartAddr, uint64_t & outF2EndAddr); // New in SDK 17.1
5994 
6002  AJA_VIRTUAL bool AuxExtractGetField1Size (const UWord inHDMIInput, ULWord & outF1Size); // New in SDK 17.1
6003 
6011  AJA_VIRTUAL bool AuxExtractGetField2Size (const UWord inHDMIInput, ULWord & outF2Size); // New in SDK 17.1
6012 
6021  AJA_VIRTUAL bool AuxExtractGetPacketFilters (const UWord inHDMIInput, NTV2DIDSet & outDIDs); // New in SDK 17.1
6022 
6032  AJA_VIRTUAL bool AuxExtractSetPacketFilters (const UWord inHDMIInput, const NTV2DIDSet & inDIDs); // New in SDK 17.1
6033 
6041  AJA_VIRTUAL bool AuxExtractSetFilterInclusionMode (const UWord inHDMIInput, const bool inEnable); // New in SDK 17.1
6042 
6050  AJA_VIRTUAL bool AuxExtractGetFilterInclusionMode (const UWord inHDMIInput, bool & outEnabled); // New in SDK 17.1
6051 
6064  AJA_VIRTUAL bool AuxExtractGetBufferOverrun (const UWord inHDMIInput, bool & outIsOverrun, const UWord inField = 0); // New in SDK 17.1
6065 
6072  AJA_VIRTUAL bool AuxExtractIsProgressive (const UWord inHDMIInput, bool & outIsProgressive); // New in SDK 17.1
6073 
6078  static UWord AuxExtractGetMaxNumPacketFilters (void); // New in SDK 17.1
6079 
6084  static NTV2DIDSet AuxExtractGetDefaultPacketFilters (void); // New in SDK 17.1
6086 
6087 
6091  AJA_VIRTUAL bool AcquireMailBoxLock (void);
6093  AJA_VIRTUAL bool ReleaseMailBoxLock (void);
6094  AJA_VIRTUAL bool AbortMailBoxLock (void);
6096 
6100 
6107  AJA_VIRTUAL bool GetDieTemperature (double & outTemp, const NTV2DieTempScale inTempScale = NTV2DieTempScale_Celsius);
6108 
6114  AJA_VIRTUAL bool GetDieVoltage (double & outVoltage);
6116 
6117 public:
6121  AJA_VIRTUAL inline CNTV2DriverInterface & driverInterface (void) {return *this;} // New in SDK 17.1
6122 
6123  AJA_VIRTUAL std::string GetFPGAVersionString (const NTV2XilinxFPGA inFPGA = eFPGAVideoProc);
6124  AJA_VIRTUAL Word GetPCIFPGAVersion (void); // From CNTV2Status
6125  AJA_VIRTUAL std::string GetPCIFPGAVersionString (void);
6126 
6139  AJA_VIRTUAL bool GetInstalledBitfileInfo (ULWord & outNumBytes, std::string & outDateStr, std::string & outTimeStr);
6140 
6146  AJA_VIRTUAL std::string GetBitfileInfoString (const BITFILE_INFO_STRUCT & inBitFileInfo);
6147 
6157  AJA_VIRTUAL bool IsFailSafeBitfileLoaded (bool & outIsFailSafe);
6158 
6166  AJA_VIRTUAL bool CanWarmBootFPGA (bool & outCanWarmBoot);
6167 
6168  AJA_VIRTUAL bool IsDynamicDevice (void);
6169  AJA_VIRTUAL bool IsDynamicFirmwareLoaded(void);
6170  AJA_VIRTUAL NTV2DeviceID GetBaseDeviceID();
6171  AJA_VIRTUAL NTV2DeviceIDList GetDynamicDeviceList (void);
6172  AJA_VIRTUAL NTV2DeviceIDSet GetDynamicDeviceIDs (void);
6173 
6178  AJA_VIRTUAL bool CanLoadDynamicDevice (const NTV2DeviceID inDeviceID);
6179 
6188  AJA_VIRTUAL bool LoadDynamicDevice (const NTV2DeviceID inDeviceID);
6189 
6195  AJA_VIRTUAL bool AddDynamicBitfile (const std::string & inBitfilePath);
6196 
6203  AJA_VIRTUAL bool AddDynamicDirectory (const std::string & inDirectory);
6204 
6210  static std::string SerialNum64ToString (const uint64_t inSerialNumber);
6211 
6212  typedef enum
6213  {
6214  RED,
6215  GREEN,
6216  BLUE,
6217  NUM_COLORS
6218  } ColorCorrectionColor; // From CNTV2ColorCorrection
6219 
6220 protected:
6221  static NTV2Buffer NULL_POINTER;
6222 
6223 public:
6227 
6233  AJA_VIRTUAL bool HevcGetDeviceInfo (HevcDeviceInfo* pInfo);
6234 
6243  AJA_VIRTUAL bool HevcWriteRegister (ULWord address, ULWord value, ULWord mask = 0xffffffff, ULWord shift = 0);
6244 
6253  AJA_VIRTUAL bool HevcReadRegister (ULWord address, ULWord* pValue, ULWord mask = 0xffffffff, ULWord shift = 0);
6254 
6260  AJA_VIRTUAL bool HevcSendCommand (HevcDeviceCommand* pCommand);
6261 
6267  AJA_VIRTUAL bool HevcVideoTransfer (HevcDeviceTransfer* pTransfer);
6268 
6274  AJA_VIRTUAL bool HevcGetStatus (HevcDeviceStatus* pStatus);
6275 
6283  AJA_VIRTUAL bool HevcDebugInfo (HevcDeviceDebug* pDebug);
6285 
6289 
6295  AJA_VIRTUAL bool EnableHDMIHDR (const bool inEnableHDMIHDR); // New in SDK 12.5
6296  AJA_VIRTUAL bool GetHDMIHDREnabled (void);
6297 
6306  AJA_VIRTUAL bool EnableHDMIHDRDolbyVision (const bool inEnable); // New in SDK 13.0
6307  AJA_VIRTUAL bool GetHDMIHDRDolbyVisionEnabled (void);
6308 
6309 
6315  AJA_VIRTUAL bool SetHDMIHDRConstantLuminance (const bool inEnableConstantLuminance); // New in SDK 12.5
6316  AJA_VIRTUAL bool GetHDMIHDRConstantLuminance (void);
6317 
6323  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryX (const uint16_t inGreenPrimaryX); // New in SDK 12.5
6329  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryX (uint16_t & outGreenPrimaryX); // New in SDK 12.5
6330 
6336  AJA_VIRTUAL bool SetHDMIHDRGreenPrimaryY (const uint16_t inGreenPrimaryY); // New in SDK 12.5
6342  AJA_VIRTUAL bool GetHDMIHDRGreenPrimaryY (uint16_t & outGreenPrimaryY); // New in SDK 12.5
6343 
6349  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryX (const uint16_t inBluePrimaryX); // New in SDK 12.5
6355  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryX (uint16_t & outBluePrimaryX); // New in SDK 12.5
6356 
6362  AJA_VIRTUAL bool SetHDMIHDRBluePrimaryY (const uint16_t inBluePrimaryY); // New in SDK 12.5
6368  AJA_VIRTUAL bool GetHDMIHDRBluePrimaryY (uint16_t & outBluePrimaryY); // New in SDK 12.5
6369 
6375  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryX (const uint16_t inRedPrimaryX); // New in SDK 12.5
6381  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryX (uint16_t & outRedPrimaryX); // New in SDK 12.5
6382 
6388  AJA_VIRTUAL bool SetHDMIHDRRedPrimaryY (const uint16_t inRedPrimaryY); // New in SDK 12.5
6394  AJA_VIRTUAL bool GetHDMIHDRRedPrimaryY (uint16_t & outRedPrimaryY); // New in SDK 12.5
6395 
6401  AJA_VIRTUAL bool SetHDMIHDRWhitePointX (const uint16_t inWhitePointX); // New in SDK 12.5
6407  AJA_VIRTUAL bool GetHDMIHDRWhitePointX (uint16_t & outWhitePointX); // New in SDK 12.5
6408 
6414  AJA_VIRTUAL bool SetHDMIHDRWhitePointY (const uint16_t inWhitePointY); // New in SDK 12.5
6420  AJA_VIRTUAL bool GetHDMIHDRWhitePointY (uint16_t & outWhitePointY); // New in SDK 12.5
6421 
6427  AJA_VIRTUAL bool SetHDMIHDRMaxMasteringLuminance (const uint16_t inMaxMasteringLuminance); // New in SDK 12.5
6433  AJA_VIRTUAL bool GetHDMIHDRMaxMasteringLuminance (uint16_t & outMaxMasteringLuminance); // New in SDK 12.5
6434 
6440  AJA_VIRTUAL bool SetHDMIHDRMinMasteringLuminance (const uint16_t inMinMasteringLuminance); // New in SDK 12.5
6446  AJA_VIRTUAL bool GetHDMIHDRMinMasteringLuminance (uint16_t & outMinMasteringLuminance); // New in SDK 12.5
6447 
6453  AJA_VIRTUAL bool SetHDMIHDRMaxContentLightLevel (const uint16_t inMaxContentLightLevel); // New in SDK 12.5
6459  AJA_VIRTUAL bool GetHDMIHDRMaxContentLightLevel (uint16_t & outMaxContentLightLevel); // New in SDK 12.5
6460 
6466  AJA_VIRTUAL bool SetHDMIHDRMaxFrameAverageLightLevel (const uint16_t inMaxFrameAverageLightLevel); // New in SDK 12.5
6472  AJA_VIRTUAL bool GetHDMIHDRMaxFrameAverageLightLevel (uint16_t & outMaxFrameAverageLightLevel); // New in SDK 12.5
6473 
6474 
6475  AJA_VIRTUAL bool SetHDMIHDRElectroOpticalTransferFunction (const uint8_t inEOTFByte); // New in SDK 12.5
6476  AJA_VIRTUAL bool GetHDMIHDRElectroOpticalTransferFunction (uint8_t & outEOTFByte); // New in SDK 12.5
6477  AJA_VIRTUAL bool SetHDMIHDRStaticMetadataDescriptorID (const uint8_t inSMDId); // New in SDK 12.5
6478  AJA_VIRTUAL bool GetHDMIHDRStaticMetadataDescriptorID (uint8_t & outSMDId); // New in SDK 12.5
6479 
6480  AJA_VIRTUAL bool SetHDRData (const HDRFloatValues & inFloatValues); // New in SDK 12.5
6481  AJA_VIRTUAL bool SetHDRData (const HDRRegValues & inRegisterValues); // New in SDK 12.5
6482  AJA_VIRTUAL bool GetHDRData (HDRFloatValues & outFloatValues); // New in SDK 12.5
6483  AJA_VIRTUAL bool GetHDRData (HDRRegValues & outRegisterValues); // New in SDK 12.5
6484  AJA_VIRTUAL bool SetHDMIHDRBT2020 (void); // New in SDK 12.5
6485  AJA_VIRTUAL bool SetHDMIHDRDCIP3 (void); // New in SDK 12.5
6486 
6487  AJA_VIRTUAL bool SetVPIDTransferCharacteristics (const NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel); // New in SDK 15.2
6488  AJA_VIRTUAL bool GetVPIDTransferCharacteristics (NTV2VPIDTransferCharacteristics & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6489  AJA_VIRTUAL bool SetVPIDColorimetry (const NTV2VPIDColorimetry inValue, const NTV2Channel inChannel); // New in SDK 15.2
6490  AJA_VIRTUAL bool GetVPIDColorimetry (NTV2VPIDColorimetry & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6491  AJA_VIRTUAL bool SetVPIDLuminance (const NTV2VPIDLuminance inValue, const NTV2Channel inChannel); // New in SDK 15.2
6492  AJA_VIRTUAL bool GetVPIDLuminance (NTV2VPIDLuminance & outValue, const NTV2Channel inChannel); // New in SDK 15.2
6493  AJA_VIRTUAL bool SetVPIDRGBRange (const NTV2VPIDRGBRange inValue, const NTV2Channel inChannel); // New in SDK 16.0
6494  AJA_VIRTUAL bool GetVPIDRGBRange (NTV2VPIDRGBRange & outValue, const NTV2Channel inChannel); // New in SDK 16.0
6495 
6496  AJA_VIRTUAL bool Set3DLUTTableLocation (const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6497  AJA_VIRTUAL bool Load3DLUTTable (void); // New in SDK 16.0
6498  AJA_VIRTUAL bool Set1DLUTTableLocation (const NTV2Channel inChannel, const ULWord inFrameNumber, ULWord inLUTIndex = 0); // New in SDK 16.0
6499  AJA_VIRTUAL bool Load1DLUTTable (const NTV2Channel inChannel); // New in SDK 16.0
6500 
6501  // MultiViewer/MultiRasterizer
6502  AJA_VIRTUAL bool HasMultiRasterWidget (void); // New in SDK 16.1
6503  AJA_VIRTUAL bool SetMultiRasterBypassEnable (const bool inEnable); // New in SDK 16.1
6504  AJA_VIRTUAL bool GetMultiRasterBypassEnable (bool & outEnabled); // New in SDK 16.1
6505  AJA_VIRTUAL bool IsMultiRasterWidgetChannel (const NTV2Channel inChannel); // New in SDK 16.2
6507 
6508  AJA_VIRTUAL bool IsBreakoutBoardConnected (void); // New in SDK 17.0
6509 
6510 #if !defined(NTV2_DEPRECATE_16_1)
6511  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool SetAudioOutputMonitorSource (const NTV2AudioMonitorSelect inChannelPair, const NTV2Channel inAudioSystem = NTV2_CHANNEL1)) {return SetAudioOutputMonitorSource(inChannelPair, NTV2AudioSystem(inAudioSystem));}
6512  AJA_VIRTUAL inline NTV2_DEPRECATED_f(bool GetAudioOutputMonitorSource (NTV2AudioMonitorSelect & chp, NTV2Channel & ch)) {NTV2AudioSystem sys; if (GetAudioOutputMonitorSource(chp, sys)) {ch = NTV2Channel(sys); return true;} return false;}
6513 #endif // NTV2_DEPRECATE_16_1
6514 
6515 protected:
6516  AJA_VIRTUAL ULWord GetSerialNumberLow (void); // From CNTV2Status
6517  AJA_VIRTUAL ULWord GetSerialNumberHigh (void); // From CNTV2Status
6518  AJA_VIRTUAL inline bool IS_CHANNEL_VALID (const NTV2Channel inChannel) const {return !IS_CHANNEL_INVALID(inChannel);} // New in SDK 16.2
6519  AJA_VIRTUAL bool IS_CHANNEL_INVALID (const NTV2Channel inChannel) const;
6520  AJA_VIRTUAL bool IS_OUTPUT_SPIGOT_INVALID (const UWord inOutputSpigot);
6521  AJA_VIRTUAL bool IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot);
6522  AJA_VIRTUAL bool IS_HDMI_INPUT_SPIGOT_INVALID (const UWord inInputHDMIPort);
6523  AJA_VIRTUAL bool SetWarmBootFirmwareReload(bool enable);
6524 
6525  // Seamless Anc Playout & Capture
6526  // For AutoCirculate Playout
6527  AJA_VIRTUAL bool S2110DeviceAncToXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6528  // For Non-AutoCirculate Playout
6529  AJA_VIRTUAL bool S2110DeviceAncToBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6530  // For AutoCirculate Capture
6531  AJA_VIRTUAL bool S2110DeviceAncFromXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER & inOutXferInfo);
6532  // For Non-AutoCirculate Capture
6533  AJA_VIRTUAL bool S2110DeviceAncFromBuffers (const NTV2Channel inChannel, NTV2Buffer & ancF1, NTV2Buffer & ancF2);
6534  AJA_VIRTUAL bool WriteSDIInVPID (const NTV2Channel inChannel, const ULWord inValA, const ULWord inValB);
6535 
6536 private:
6537  // frame buffer sizing helpers
6538  AJA_VIRTUAL bool GetLargestFrameBufferFormatInUse(NTV2FrameBufferFormat & outFBF);
6539  AJA_VIRTUAL bool GetFrameInfo(const NTV2Channel inChannel, NTV2FrameGeometry & outGeometry, NTV2FrameBufferFormat & outFBF);
6540  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry currentGeometry, NTV2FrameGeometry newGeometry,
6541  NTV2FrameBufferFormat format);
6542  AJA_VIRTUAL bool IsBufferSizeChangeRequired(NTV2Channel channel, NTV2FrameGeometry geometry,
6543  NTV2FrameBufferFormat currentFormat, NTV2FrameBufferFormat newFormat);
6544  AJA_VIRTUAL bool GetFBSizeAndCountFromHW(ULWord & outSize, ULWord & outCount);
6545 
6546  AJA_VIRTUAL bool IsMultiFormatActive (void);
6547  AJA_VIRTUAL bool CopyVideoFormat(const NTV2Channel inSrc, const NTV2Channel inFirst, const NTV2Channel inLast);
6548  class DeviceCapabilities mDevCap;
6549 }; // CNTV2Card
6550 
6551 
6552 typedef CNTV2Card CNTV2Device;
6553 #if !defined(NTV2_DEPRECATE_16_2)
6554  typedef CNTV2Card CNTV2Status;
6555  typedef CNTV2Card CNTV2TestPattern;
6556  typedef CNTV2Card CNTV2VidProc;
6557  typedef CNTV2Card CNTV2ColorCorrection;
6558  typedef CNTV2Card CNTV2ProcAmp;
6559  typedef CNTV2Card CXena2VidProc;
6560 #endif // !defined(NTV2_DEPRECATE_16_2)
6561 
6562 #define SetTablesToHardware LoadLUTTables
6563 #define GetTablesFromHardware GetLUTTables
6564 
6566 
6567 
6591 class SDRAMAuditor
6592 {
6593  public:
6597  explicit SDRAMAuditor ()
6598  : mDeviceID (DEVICE_ID_INVALID),
6599  mFrameTags (),
6600  m8MB (0x00800000),
6601  mNumFrames (0),
6602  mIntrinsicSize (0)
6603  {
6604  }
6605 
6610  explicit SDRAMAuditor (CNTV2Card & inDevice)
6611  : mDeviceID (DEVICE_ID_INVALID),
6612  mFrameTags (),
6613  m8MB (0x00800000),
6614  mNumFrames (0),
6615  mIntrinsicSize (0)
6616  {
6617  AssessDevice(inDevice);
6618  }
6619 
6629  bool AssessDevice (CNTV2Card & inDevice, const bool inIgnoreStoppedAudioBuffers = false);
6630 
6640  bool GetRegions (ULWordSequence & outFree, ULWordSequence & outUsed, ULWordSequence & outBad) const;
6641 
6646  inline bool GetFreeRegions (ULWordSequence & outBlks) const
6647  {
6648  ULWordSequence used, bad;
6649  return GetRegions (outBlks, used, bad);
6650  }
6651 
6656  inline bool GetBadRegions (ULWordSequence & outBlks) const
6657  {
6658  ULWordSequence used, free;
6659  return GetRegions (free, used, outBlks);
6660  }
6661 
6666  inline bool GetUsedRegions (ULWordSequence & outBlks) const
6667  {
6668  ULWordSequence bad, free;
6669  return GetRegions (free, outBlks, bad);
6670  }
6671 
6678  bool GetTagsForFrameIndex (const UWord inIndex, NTV2StringSet & outTags) const;
6679 
6680  bool HasFrameIndex (const UWord inIndex) const {return mFrameTags.find(inIndex) != mFrameTags.end();}
6681 
6682  size_t GetTagCount (const UWord inIndex) const;
6683 
6684  inline bool HasTag (const UWord inIndex) const {return GetTagCount(inIndex) > 0;}
6685  inline bool HasConflicts (const UWord inIndex) const {return GetTagCount(inIndex) > 1;}
6686  inline ULWord GetIntrinsicFrameByteCount (void) const {return mIntrinsicSize;}
6687 
6698  bool TranslateRegions (ULWordSequence & outRgns, const ULWordSequence & inRgns, const bool inIsQuad, const bool inIsQuadQuad) const;
6699 
6705  std::ostream & RawDump (std::ostream & oss) const;
6706 
6712  std::ostream & DumpBlocks (std::ostream & oss) const;
6713 
6714  // Static/Class Methods
6715  public:
6719  static ULWordSet CoalesceRegions (const ULWordSequence & inRgn1, const ULWordSequence & inRgn2, const ULWordSequence & inRgn3);
6720 
6721  protected:
6722  bool TagAudioBuffers (CNTV2Card & inDevice, const bool inMarkStoppedAudioBuffersFree);
6723  bool TagVideoFrames (CNTV2Card & inDevice);
6724  bool TagMemoryBlock (const ULWord inStartAddr, const ULWord inByteLength, const std::string & inTag);
6725  bool TagMemoryBlock (const uint64_t inStartAddr, const uint64_t inByteLength, const std::string & inTag)
6726  {
6727  return TagMemoryBlock (ULWord(inStartAddr), ULWord(inByteLength), inTag);
6728  }
6729 
6730  private:
6731  typedef std::pair<UWord, NTV2StringSet> FrameTag;
6732  typedef std::map<UWord, NTV2StringSet> FrameTags;
6733  typedef FrameTags::const_iterator FrameTagsConstIter;
6734 
6735  NTV2DeviceID mDeviceID;
6736  FrameTags mFrameTags;
6737  const ULWord m8MB;
6738  UWord mNumFrames;
6739  ULWord mIntrinsicSize;
6740 }; // SDRAMAuditor
6741 
6742 #endif // NTV2CARD_H
HevcDeviceStatus
Definition: ntv2publicinterface.h:9697
kRegSDIInput3GStatus
@ kRegSDIInput3GStatus
Definition: ntv2publicinterface.h:355
CNTV2TestPattern
CNTV2Card CNTV2TestPattern
Definition: ntv2card.h:6555
NTV2AnalogAudioIO
NTV2AnalogAudioIO
Definition: ntv2enums.h:2177
SDRAMAuditor::TagMemoryBlock
bool TagMemoryBlock(const ULWord inStartAddr, const ULWord inByteLength, const std::string &inTag)
NTV2VANCModeFromBools
#define NTV2VANCModeFromBools(_tall_, _taller_)
Definition: ntv2enums.h:3729
HevcDeviceCommand
Definition: ntv2publicinterface.h:9489
NTV2ColorCorrectionHostAccessBank
NTV2ColorCorrectionHostAccessBank
Definition: ntv2enums.h:2003
NTV2DoubleArray
std::vector< double > NTV2DoubleArray
An array of double-precision floating-point values.
Definition: ntv2publicinterface.h:70
LWord
int32_t LWord
Definition: ajatypes.h:252
NTV2RegisterValueMap
std::map< ULWord, ULWord > NTV2RegisterValueMap
A mapping of distinct NTV2RegisterNumbers to their corresponding ULWord values.
Definition: ntv2publicinterface.h:7400
ntv2windriverinterface.h
Declares the MSWindows-specific flavor of CNTV2DriverInterface.
NTV2InputCrosspointIDSet
std::set< NTV2InputXptID > NTV2InputCrosspointIDSet
Definition: ntv2signalrouter.h:26
CNTV2DriverInterface::ReadRegisters
virtual bool ReadRegisters(NTV2RegisterReads &inOutValues)
Reads the register(s) specified by the given NTV2RegInfo sequence.
Definition: ntv2driverinterface.cpp:414
CNTV2Card::GREEN
@ GREEN
Definition: ntv2card.h:6215
NTV2LutBitDepth
NTV2LutBitDepth
This specifies the LUT bit depth.
Definition: ntv2enums.h:3503
NTV2StreamChannel
Definition: ntv2publicinterface.h:8669
HevcDeviceDebug
Definition: ntv2publicinterface.h:9718
NTV2HDMIBitDepth
NTV2HDMIBitDepth
Indicates or specifies the HDMI video bit depth.
Definition: ntv2enums.h:3611
INTERRUPT_ENUMS
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
NTV2FrameDimensions
Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image.
Definition: ntv2publicinterface.h:5658
NTV2LHIHDMIColorSpace
NTV2LHIHDMIColorSpace
Definition: ntv2enums.h:3597
SDRAMAuditor::TagAudioBuffers
bool TagAudioBuffers(CNTV2Card &inDevice, const bool inMarkStoppedAudioBuffersFree)
Definition: ntv2card.cpp:684
NTV2StringSet
std::set< std::string > NTV2StringSet
Definition: ntv2utils.h:1137
kDeviceHasXptConnectROM
@ kDeviceHasXptConnectROM
True if device has a crosspoint connection ROM (New in SDK 17.0)
Definition: ntv2devicefeatures.h:146
HDRFloatValues
Definition: ntv2publicinterface.h:9841
NTV2AudioChannelPairs
std::set< NTV2AudioChannelPair > NTV2AudioChannelPairs
A set of distinct NTV2AudioChannelPair values.
Definition: ntv2publicinterface.h:58
kRegInput78Status
@ kRegInput78Status
Definition: ntv2publicinterface.h:626
NTV2AudioFormat
NTV2AudioFormat
Definition: ntv2enums.h:1896
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1305
NTV2HDMIColorSpace
NTV2HDMIColorSpace
Indicates or specifies HDMI Color Space.
Definition: ntv2enums.h:3525
NTV2Buffer
A generic user-space buffer object that has an address and a length. Used most often to share an arbi...
Definition: ntv2publicinterface.h:5993
NTV2AudioMixerInput
NTV2AudioMixerInput
Identifies the Audio Mixer's audio inputs.
Definition: ntv2enums.h:3179
NTV2_STANDARD_INVALID
@ NTV2_STANDARD_INVALID
Definition: ntv2enums.h:173
NTV2InterruptMask
NTV2InterruptMask
Definition: ntv2enums.h:1472
CNTV2BareMetalDriverInterface
BareMetal implementation of CNTV2DriverInterface.
Definition: ntv2baremetaldriverinterface.h:25
ColorSpaceConverterCustomCoefficients
Definition: ntv2publicinterface.h:4065
ntv2baremetaldriverinterface.h
Declares the CNTV2BareMetalDriverInterface class.
ntv2macdriverinterface.h
Implements the MacOS-specific flavor of CNTV2DriverInterface.
CNTV2Card::SetVANCMode
virtual bool SetVANCMode(const NTV2VANCMode inVancMode, const NTV2Standard st, const NTV2FrameGeometry fg, const NTV2Channel inChannel=NTV2_CHANNEL1)
Definition: ntv2card.h:1203
NTV2HDMIAudioChannels
NTV2HDMIAudioChannels
Indicates or specifies the HDMI audio channel count.
Definition: ntv2enums.h:3586
CNTV2ColorCorrection
CNTV2Card CNTV2ColorCorrection
Definition: ntv2card.h:6557
SDRAMAuditor::GetTagsForFrameIndex
bool GetTagsForFrameIndex(const UWord inIndex, NTV2StringSet &outTags) const
Answers with the list of tags for the given frame number.
Definition: ntv2card.cpp:642
NTV2_AUDIOSYSTEM_1
@ NTV2_AUDIOSYSTEM_1
This identifies the first Audio System.
Definition: ntv2enums.h:3816
NTV2LutType
NTV2LutType
This specifies what function(s) are currently loaded into the LUTs.
Definition: ntv2enums.h:3484
NTV2VPIDLuminance
NTV2VPIDLuminance
Definition: ntv2enums.h:4178
SDRAMAuditor::GetFreeRegions
bool GetFreeRegions(ULWordSequence &outBlks) const
Answers with the list of free memory regions.
Definition: ntv2card.h:6646
SSC_GET_FIRMWARE_PROGRESS_STRUCT
Definition: ntv2publicinterface.h:4892
NTV2DeviceID
NTV2DeviceID
Identifies a specific AJA NTV2 device model number. The NTV2DeviceID is actually the PROM part number...
Definition: ntv2enums.h:20
NTV2FieldID
NTV2FieldID
These values are used to identify fields for interlaced video. See Field/Frame Interrupts and CNTV2Ca...
Definition: ntv2enums.h:1785
NTV2FrameBufferFormat
NTV2FrameBufferFormat
Identifies a particular video frame buffer format. See Device Frame Buffer Formats for details.
Definition: ntv2enums.h:207
DeviceCapabilities
Convenience class/API for inquiring about device capabilities of physical and virtual devices....
Definition: ntv2devicecapabilities.h:20
NTV2AudioChannelsMuted16
std::bitset< 16 > NTV2AudioChannelsMuted16
Per-audio-channel mute state for up to 16 audio channels.
Definition: ntv2publicinterface.h:81
kDeviceCanDoAudioMixer
@ kDeviceCanDoAudioMixer
True if device has a firmware audio mixer.
Definition: ntv2devicefeatures.h:120
NTV2ColorSpaceMethod
NTV2ColorSpaceMethod
Definition: ntv2enums.h:3368
NTV2_CHANNEL1
@ NTV2_CHANNEL1
Specifies channel or Frame Store 1 (or the first item).
Definition: ntv2enums.h:1307
NTV2RelayState
NTV2RelayState
This enumerated data type identifies the two possible states of the bypass relays....
Definition: ntv2enums.h:3855
SDRAMAuditor
Audits an NTV2 device's SDRAM utilization, and can report contiguous regions of SDRAM,...
Definition: ntv2card.h:6591
nlohmann::json_abiNLOHMANN_JSON_ABI_TAG_LEGACY_DISCARDED_VALUE_COMPARISON_v3_11_NLOHMANN_JSON_VERSION_PATCH::detail::void
j template void())
Definition: json.hpp:4893
NTV2HDMIRange
NTV2HDMIRange
Indicates or specifies the HDMI RGB range.
Definition: ntv2enums.h:3554
NTV2HDMIOutputStatus
Reports HDMI output status information.
Definition: ntv2publicinterface.h:6907
ntv2linuxdriverinterface.h
Declares the CNTV2LinuxDriverInterface class.
NTV2FrameRate
NTV2FrameRate
Identifies a particular video frame rate.
Definition: ntv2enums.h:396
NTV2ColorCorrectionMode
NTV2ColorCorrectionMode
Definition: ntv2enums.h:2024
NTV2_CHANNEL_INVALID
@ NTV2_CHANNEL_INVALID
Definition: ntv2enums.h:1316
FRAME_STAMP
This is returned by the CNTV2Card::AutoCirculateGetFrameStamp function, and is also embedded in the A...
Definition: ntv2publicinterface.h:7729
NTV2RegNumSet
NTV2RegisterNumberSet NTV2RegNumSet
A set of distinct NTV2RegisterNumbers.
Definition: ntv2publicinterface.h:7382
ntv2signalrouter.h
Declares CNTV2SignalRouter class.
NTV2LHIVideoDACMode
NTV2LHIVideoDACMode
Definition: ntv2enums.h:2118
NTV2MixerKeyerInputControl
NTV2MixerKeyerInputControl
These enum values identify the Mixer/Keyer foreground and background input control values.
Definition: ntv2enums.h:1721
CNTV2Card::AuxSetFrameBufferSize
virtual bool AuxSetFrameBufferSize(const ULWord inF1Size, const ULWord inF2Size)
Sets the capacity of the HDMI AUX buffers in device frame memory.
Definition: ntv2card.h:5795
NTV2HDRXferChars
enum NTV2VPIDTransferCharacteristics NTV2HDRXferChars
NTV2_RS422_PARITY
NTV2_RS422_PARITY
These enum values identify RS-422 serial port parity configuration.
Definition: ntv2enums.h:4078
CNTV2DriverInterface::IsSupported
virtual bool IsSupported(const NTV2BoolParamID inParamID)
Definition: ntv2driverinterface.h:422
NTV2EmbeddedAudioClock
NTV2EmbeddedAudioClock
This enum value determines/states the device audio clock reference source. It was important to set th...
Definition: ntv2enums.h:1935
CNTV2Card::features
virtual class DeviceCapabilities & features(void)
Definition: ntv2card.h:141
HevcDeviceInfo
Definition: ntv2publicinterface.h:9332
NTV2_INPUTSOURCE_SDI1
@ NTV2_INPUTSOURCE_SDI1
Identifies the 1st SDI video input.
Definition: ntv2enums.h:1228
SDRAMAuditor::DumpBlocks
std::ostream & DumpBlocks(std::ostream &oss) const
Dumps all 8MB blocks/frames and their tags, if any, into the given stream.
Definition: ntv2card.cpp:553
NTV2DMAEngine
NTV2DMAEngine
Definition: ntv2enums.h:1801
NTV2XilinxFPGA
NTV2XilinxFPGA
Definition: ntv2enums.h:3765
YCbCr10BitPixel
Definition: ntv2videodefines.h:200
CNTV2VidProc
CNTV2Card CNTV2VidProc
Definition: ntv2card.h:6556
NTV2DownConvertMode
NTV2DownConvertMode
Definition: ntv2enums.h:2187
FRAME_STAMP_STRUCT
Definition: ntv2publicinterface.h:4436
NTV2Standard
NTV2Standard
Identifies a particular video standard.
Definition: ntv2enums.h:153
ULWordSet
std::set< ULWord > ULWordSet
A collection of unique ULWord (uint32_t) values.
Definition: ntv2publicinterface.h:54
CNTV2Card::DMABufferUnlock
virtual bool DMABufferUnlock(const ULWord *pInBuffer, const ULWord inByteCount)
Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.
Definition: ntv2card.h:487
ULWord
uint32_t ULWord
Definition: ajatypes.h:253
CNTV2Card::NULL_POINTER
static NTV2Buffer NULL_POINTER
Used for default empty NTV2Buffer parameters – do not modify.
Definition: ntv2card.h:6221
CNTV2Card::DMABufferLock
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:466
AUTOCIRCULATE_STATUS
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
Definition: ntv2publicinterface.h:7160
NTV2ReferenceSource
NTV2ReferenceSource
These enum values identify a specific source for the device's (output) reference clock.
Definition: ntv2enums.h:1399
UWordSequence
std::vector< uint16_t > UWordSequence
An ordered sequence of UWord (uint16_t) values.
Definition: ntv2publicinterface.h:42
NTV2Mode
NTV2Mode
Used to identify the mode of a widget_framestore, or the direction of an AutoCirculate stream: either...
Definition: ntv2enums.h:1198
NTV2HDMIProtocol
NTV2HDMIProtocol
Indicates or specifies the HDMI protocol.
Definition: ntv2enums.h:3540
SDRAMAuditor::RawDump
std::ostream & RawDump(std::ostream &oss) const
Dumps a human-readable list of regions into the given stream.
Definition: ntv2card.cpp:528
NTV2AudioSystemSet
std::set< NTV2AudioSystem > NTV2AudioSystemSet
A set of distinct NTV2AudioSystem values. New in SDK 16.2.
Definition: ntv2publicinterface.h:3900
CNTV2Device
CNTV2Card CNTV2Device
Instances of this class are able to interrogate and control an NTV2 AJA video/audio capture/playout d...
Definition: ntv2card.h:6552
kDeviceAudioCanWaitForVBI
@ kDeviceAudioCanWaitForVBI
True if device audio systems can wait for VBI before starting. (New in SDK 17.0)
Definition: ntv2devicefeatures.h:144
SDRAMAuditor::GetTagCount
size_t GetTagCount(const UWord inIndex) const
Definition: ntv2card.cpp:652
CNTV2LinuxDriverInterface
Linux implementation of CNTV2DriverInterface.
Definition: ntv2linuxdriverinterface.h:25
NTV2_LUT10Bit
@ NTV2_LUT10Bit
Definition: ntv2enums.h:3505
CNTV2Card::RED
@ RED
Definition: ntv2card.h:6214
NTV2LUTPlaneSelect
NTV2LUTPlaneSelect
Definition: ntv2enums.h:3802
NTV2AudioChannelPair
NTV2AudioChannelPair
Identifies a pair of audio channels.
Definition: ntv2enums.h:3056
CNTV2Card::driverInterface
virtual CNTV2DriverInterface & driverInterface(void)
Definition: ntv2card.h:6121
NTV2AudioLevel
NTV2AudioLevel
Definition: ntv2enums.h:2257
NTV2_CSC_RGB_Range
NTV2_CSC_RGB_Range
Definition: ntv2enums.h:3678
UWord
uint16_t UWord
Definition: ajatypes.h:251
CXena2VidProc
CNTV2Card CXena2VidProc
Definition: ntv2card.h:6559
DMAEngine
DMAEngine
Definition: ntv2macpublicinterface.h:104
AUTOCIRCULATE_TRANSFER
This object specifies the information that will be transferred to or from the AJA device in the CNTV2...
Definition: ntv2publicinterface.h:7969
CNTV2WinDriverInterface
Physical device implementations of CNTV2DriverInterface methods through AJA Windows driver.
Definition: ntv2windriverinterface.h:31
NTV2UpConvertMode
NTV2UpConvertMode
Definition: ntv2enums.h:2164
ntv2utils.h
Declares numerous NTV2 utility functions.
kRegInputStatus2
@ kRegInputStatus2
Definition: ntv2publicinterface.h:411
NTV2Framesize
NTV2Framesize
Kona2/Xena2 specific enums.
Definition: ntv2enums.h:2061
Word
int16_t Word
Definition: ajatypes.h:250
NTV2BreakoutType
NTV2BreakoutType
Identifies the Breakout Boxes and Cables that may be attached to an AJA NTV2 device.
Definition: ntv2enums.h:3028
kRegInput56Status
@ kRegInput56Status
Definition: ntv2publicinterface.h:625
NTV2InputCrosspointID
NTV2InputCrosspointID
Identifies a widget input that potentially can accept a signal emitted from another widget's output (...
Definition: ntv2enums.h:2690
NTV2IsoConvertMode
NTV2IsoConvertMode
Definition: ntv2enums.h:2198
CNTV2Card
I interrogate and control an AJA video/audio capture/playout device.
Definition: ntv2card.h:28
kRegStatus2
@ kRegStatus2
Definition: ntv2publicinterface.h:388
SDRAMAuditor::SDRAMAuditor
SDRAMAuditor()
My default constructor. I am not ready for use until my SDRAMAuditor::Assess method has been called.
Definition: ntv2card.h:6597
SDRAMAuditor::SDRAMAuditor
SDRAMAuditor(CNTV2Card &inDevice)
Constructs me and automatically assesses the given device.
Definition: ntv2card.h:6610
NTV2DieTempScale_Celsius
@ NTV2DieTempScale_Celsius
Definition: ntv2enums.h:4128
AJA_VIRTUAL
#define AJA_VIRTUAL
Definition: ajatypes.h:160
CNTV2BareMetalDriverInterface::WriteRegister
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...
Definition: ntv2baremetaldriverinterface.cpp:141
NTV2WidgetID
NTV2WidgetID
Definition: ntv2enums.h:2847
NTV2AudioLoopBack
NTV2AudioLoopBack
This enum value determines/states if an audio output embedder will embed silence (zeroes) or de-embed...
Definition: ntv2enums.h:1973
DEVICE_ID_INVALID
@ DEVICE_ID_INVALID
Definition: ntv2enums.h:91
RP188_STRUCT
Definition: ntv2publicinterface.h:4083
CNTV2ProcAmp
CNTV2Card CNTV2ProcAmp
Definition: ntv2card.h:6558
NTV2ChannelSet
std::set< NTV2Channel > NTV2ChannelSet
A set of distinct NTV2Channel values.
Definition: ntv2publicinterface.h:3854
NTV2HDRColorimetry
enum NTV2VPIDColorimetry NTV2HDRColorimetry
NTV2_VPID_TC_SDR_TV
@ NTV2_VPID_TC_SDR_TV
Definition: ntv2enums.h:4164
CNTV2SignalRouter
This class is a collection of widget input-to-output connections that can be applied all-at-once to a...
Definition: ntv2signalrouter.h:55
NTV2QuarterSizeExpandMode
NTV2QuarterSizeExpandMode
Definition: ntv2enums.h:2430
NTV2VANCMode
NTV2VANCMode
These enum values identify the available VANC modes.
Definition: ntv2enums.h:3716
NTV2DSKMode
NTV2DSKMode
Definition: ntv2enums.h:3419
SDRAMAuditor::AssessDevice
bool AssessDevice(CNTV2Card &inDevice, const bool inIgnoreStoppedAudioBuffers=(0))
Assesses the given device.
Definition: ntv2card.cpp:508
NTV2OutputCrosspointID
NTV2OutputCrosspointID
Identifies a widget output, a signal source, that potentially can drive another widget's input (ident...
Definition: ntv2enums.h:2471
NTV2InputSource
NTV2InputSource
Identifies a specific video input source.
Definition: ntv2enums.h:1221
NTV2HDMIColorimetry
NTV2HDMIColorimetry
Indicates or specifies the HDMI colorimetry.
Definition: ntv2enums.h:3568
kRegStatus
@ kRegStatus
Definition: ntv2publicinterface.h:124
NTV2VPIDColorimetry
NTV2VPIDColorimetry
Definition: ntv2enums.h:4170
kRegSDI5678Input3GStatus
@ kRegSDI5678Input3GStatus
Definition: ntv2publicinterface.h:623
LUTTablePartitionSize
const ULWord LUTTablePartitionSize
Definition: ntv2publicinterface.h:84
NTV2HDMIV2Mode
NTV2HDMIV2Mode
Definition: ntv2enums.h:3919
SDRAMAuditor::GetUsedRegions
bool GetUsedRegions(ULWordSequence &outBlks) const
Answers with the list of used memory regions.
Definition: ntv2card.h:6666
SDRAMAuditor::GetRegions
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:578
SDRAMAuditor::TranslateRegions
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:660
NTV2AudioRate
NTV2AudioRate
Definition: ntv2enums.h:1873
NTV2EncodeAsPSF
NTV2EncodeAsPSF
Definition: ntv2enums.h:2456
CNTV2Card::IS_CHANNEL_VALID
virtual bool IS_CHANNEL_VALID(const NTV2Channel inChannel) const
Definition: ntv2card.h:6518
AUTOCIRCULATE_STATUS_STRUCT
Definition: ntv2publicinterface.h:4313
kRegSDIInput3GStatus2
@ kRegSDIInput3GStatus2
Definition: ntv2publicinterface.h:410
NTV2_SHOULD_BE_DEPRECATED
#define NTV2_SHOULD_BE_DEPRECATED(__f__)
Definition: ajatypes.h:521
NTV2VideoLimiting
NTV2VideoLimiting
These enum values identify the available SDI video output limiting modes.
Definition: ntv2enums.h:3697
NTV2_DEPRECATED_f
#define NTV2_DEPRECATED_f(__f__)
Definition: ajatypes.h:553
NTV2SDIInStatistics
This is used by the CNTV2Card::ReadSDIStatistics function.
Definition: ntv2publicinterface.h:7678
NTV2AudioMixerChannel
NTV2AudioMixerChannel
Definition: ntv2enums.h:3150
false
#define false
Definition: ntv2devicefeatures.h:25
UByte
uint8_t UByte
Definition: ajatypes.h:248
NTV2RegisterWrites
std::vector< NTV2RegInfo > NTV2RegisterWrites
Definition: ntv2publicinterface.h:4011
CNTV2BareMetalDriverInterface::ReadRegister
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....
Definition: ntv2baremetaldriverinterface.cpp:127
CNTV2Status
CNTV2Card CNTV2Status
Definition: ntv2card.h:6554
NTV2RegisterWriteMode
NTV2RegisterWriteMode
These values are used to determine when certain register writes actually take effect....
Definition: ntv2enums.h:1624
NTV2XptConnections
std::map< NTV2InputXptID, NTV2OutputXptID > NTV2XptConnections
Definition: ntv2signalrouter.h:39
NTV2_VPID_Color_Rec709
@ NTV2_VPID_Color_Rec709
Definition: ntv2enums.h:4172
ULWord64
uint64_t ULWord64
Definition: ajatypes.h:256
kRegInputStatus
@ kRegInputStatus
Definition: ntv2publicinterface.h:125
NTV2_RP188
This struct replaces the old RP188_STRUCT.
Definition: ntv2publicinterface.h:6760
ULWordSequence
std::vector< uint32_t > ULWordSequence
An ordered sequence of ULWord (uint32_t) values.
Definition: ntv2publicinterface.h:46
NTV2FrameBufferQuality
NTV2FrameBufferQuality
Definition: ntv2enums.h:2441
AUTOCIRCULATE_P2P_STRUCT
Definition: ntv2publicinterface.h:4657
AJAExport
#define AJAExport
Definition: export.h:33
NTV2VideoFormat
enum _NTV2VideoFormat NTV2VideoFormat
Identifies a particular video format.
kDeviceHasMicrophoneInput
@ kDeviceHasMicrophoneInput
True if device has a microphone input connector.
Definition: ntv2devicefeatures.h:141
SDRAMAuditor::TagVideoFrames
bool TagVideoFrames(CNTV2Card &inDevice)
Definition: ntv2card.cpp:702
NTV2PossibleConnections
std::multimap< NTV2InputXptID, NTV2OutputXptID > NTV2PossibleConnections
A map of zero or more one-to-many possible NTV2InputXptID to NTV2OutputXptID connections.
Definition: ntv2signalrouter.h:41
CNTV2DriverInterface::GetDescription
virtual std::string GetDescription(void) const
Definition: ntv2driverinterface.cpp:1132
NTV2VPIDTransferCharacteristics
NTV2VPIDTransferCharacteristics
Definition: ntv2enums.h:4162
NTV2FrameGeometry
NTV2FrameGeometry
Identifies a particular video frame geometry.
Definition: ntv2enums.h:336
NTV2ConversionMode
NTV2ConversionMode
Definition: ntv2enums.h:3633
CNTV2DriverInterface::GetFrameBufferSize
virtual ULWord GetFrameBufferSize(void) const
Definition: ntv2driverinterface.h:384
CNTV2MacDriverInterface
A Mac-specific implementation of CNTV2DriverInterface.
Definition: ntv2macdriverinterface.h:22
NTV2EveryFrameTaskMode
NTV2EveryFrameTaskMode
Describes the task mode state. See also: Sharing AJA Devices With Other Applications.
Definition: ntv2publicinterface.h:4288
NTV2DeviceIDSet
std::set< NTV2DeviceID > NTV2DeviceIDSet
A set of NTV2DeviceIDs.
Definition: ntv2utils.h:1031
SDRAMAuditor::CoalesceRegions
static ULWordSet CoalesceRegions(const ULWordSequence &inRgn1, const ULWordSequence &inRgn2, const ULWordSequence &inRgn3)
Definition: ntv2card.cpp:538
GetConversionMode
NTV2ConversionMode GetConversionMode(const NTV2VideoFormat inFormat, const NTV2VideoFormat outFormat)
Definition: ntv2utils.cpp:5507
NTV2Audio4ChannelSelect
NTV2Audio4ChannelSelect
Identifies a contiguous, adjacent group of four audio channels.
Definition: ntv2enums.h:3196
NTV2VPIDRGBRange
NTV2VPIDRGBRange
Definition: ntv2enums.h:4184
NTV2EncodedAudioMode
NTV2EncodedAudioMode
Definition: ntv2enums.h:1885
NTV2VANCDataShiftMode
NTV2VANCDataShiftMode
Definition: ntv2enums.h:3732
NTV2HDRLuminance
enum NTV2VPIDLuminance NTV2HDRLuminance
NTV2LSVideoADCMode
NTV2LSVideoADCMode
Definition: ntv2enums.h:2140
NTV2Interrupt2Mask
NTV2Interrupt2Mask
Definition: ntv2enums.h:1545
NTV2DieTempScale
NTV2DieTempScale
Definition: ntv2enums.h:4126
NTV2MixerRGBRange
NTV2MixerRGBRange
Definition: ntv2enums.h:2219
NTV2DeviceIDList
std::vector< NTV2DeviceID > NTV2DeviceIDList
An ordered list of NTV2DeviceIDs.
Definition: ntv2utils.h:1024
NTV2HDMISampleStructure
NTV2HDMISampleStructure
Definition: ntv2enums.h:4103
NTV2LUTControlSelect
NTV2LUTControlSelect
Definition: ntv2enums.h:3795
AJA_RETAIL_DEFAULT
#define AJA_RETAIL_DEFAULT
Definition: ntv2card.h:587
NTV2AncillaryDataRegion
NTV2AncillaryDataRegion
These enumerations identify the various ancillary data regions located at the bottom of each frame bu...
Definition: ntv2enums.h:4143
NTV2DIDSet
std::set< UByte > NTV2DIDSet
A set of distinct NTV2DID values.
Definition: ntv2publicinterface.h:76
NTV2EmbeddedAudioInput
NTV2EmbeddedAudioInput
This enum value determines/states which SDI video input will be used to supply audio samples to an au...
Definition: ntv2enums.h:1912
SDRAMAuditor::GetBadRegions
bool GetBadRegions(ULWordSequence &outBlks) const
Answers with the list of colliding and illegal memory regions.
Definition: ntv2card.h:6656
NTV2ColorSpaceMatrixType
NTV2ColorSpaceMatrixType
Definition: ntv2enums.h:3378
NTV2AudioSystem
NTV2AudioSystem
Used to identify an Audio System on an NTV2 device. See Audio System Operation for more information.
Definition: ntv2enums.h:3814
kDeviceCanDoHDMIAuxCapture
@ kDeviceCanDoHDMIAuxCapture
True if device has HDMI AUX data extractor(s).
Definition: ntv2devicefeatures.h:121
SDRAMAuditor::TagMemoryBlock
bool TagMemoryBlock(const uint64_t inStartAddr, const uint64_t inByteLength, const std::string &inTag)
Definition: ntv2card.h:6725
NTV2StreamBuffer
Definition: ntv2publicinterface.h:8729
HDRRegValues
Definition: ntv2publicinterface.h:9824
CNTV2DriverInterface
I'm the base class that undergirds the platform-specific derived classes (from which CNTV2Card is ult...
Definition: ntv2driverinterface.h:60
NTV2HDMIOut3DMode
NTV2HDMIOut3DMode
This specifies the HDMI Out Stereo 3D Mode.
Definition: ntv2enums.h:3513
NTV2MixerKeyerMode
NTV2MixerKeyerMode
These enum values identify the mixer mode.
Definition: ntv2enums.h:1736
NTV2Audio8ChannelSelect
NTV2Audio8ChannelSelect
Identifies a contiguous, adjacent group of eight audio channels.
Definition: ntv2enums.h:3245
NTV2_FRAMESIZE_INVALID
@ NTV2_FRAMESIZE_INVALID
Definition: ntv2enums.h:2080
NTV2AudioSource
NTV2AudioSource
This enum value determines/states where an audio system will obtain its audio samples.
Definition: ntv2enums.h:1950
CNTV2Card::BLUE
@ BLUE
Definition: ntv2card.h:6216
NTV2Crosspoint
NTV2Crosspoint
Logically, these are an NTV2Channel combined with an NTV2Mode.
Definition: ntv2enums.h:1645
NTV2_RS422_BAUD_RATE
NTV2_RS422_BAUD_RATE
These enum values identify RS-422 serial port baud rate configuration.
Definition: ntv2enums.h:4093
NTV2_VPID_Luminance_YCbCr
@ NTV2_VPID_Luminance_YCbCr
Definition: ntv2enums.h:4180
eFPGAVideoProc
@ eFPGAVideoProc
Definition: ntv2enums.h:3767
ntv2devicecapabilities.h
Declares the DeviceCapabilities class.
BITFILE_INFO_STRUCT
Definition: ntv2publicinterface.h:4803
NTV2AudioBufferSize
NTV2AudioBufferSize
Represents the size of the audio buffer used by a device audio system for storing captured samples or...
Definition: ntv2enums.h:1859
NTV2_AncRgn_All
@ NTV2_AncRgn_All
Identifies "all" ancillary data regions.
Definition: ntv2enums.h:4153
HevcDeviceTransfer
Definition: ntv2publicinterface.h:9638
NTV2RegInfo
Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.
Definition: ntv2publicinterface.h:3931
NTV2FBOrientation
enum NTV2VideoFrameBufferOrientation NTV2FBOrientation
SerialNum64ToString
std::string SerialNum64ToString(const uint64_t &inSerNum)
Definition: ntv2utils.cpp:8110
NTV2_RP188Mode
NTV2_RP188Mode
Definition: ntv2enums.h:2040
NTV2InputVideoSelect
NTV2InputVideoSelect
Definition: ntv2enums.h:2240
kRegGlobalControl
@ kRegGlobalControl
Definition: ntv2publicinterface.h:102
NTV2VideoDACMode
NTV2VideoDACMode
Definition: ntv2enums.h:2087
NTV2StereoCompressorOutputMode
NTV2StereoCompressorOutputMode
Definition: ntv2enums.h:3775
NTV2_AUDIOSYSTEM_INVALID
@ NTV2_AUDIOSYSTEM_INVALID
Definition: ntv2enums.h:3826