AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
CNTV2KonaFlashProgram Class Reference

#include <ntv2konaflashprogram.h>

Inheritance diagram for CNTV2KonaFlashProgram:
[legend]
Collaboration diagram for CNTV2KonaFlashProgram:
[legend]

Public Member Functions

 CNTV2KonaFlashProgram ()
 
 CNTV2KonaFlashProgram (const UWord boardNumber)
 
virtual ~CNTV2KonaFlashProgram ()
 
virtual bool SetBoard (uint32_t index=0)
 
bool ReadHeader (FlashBlockID flashBlock)
 
bool ReadInfoString ()
 
bool SetBitFile (const std::string &inBitfileName, std::ostream &outMsgs, const FlashBlockID blockNumber=AUTO_FLASHBLOCK)
 
bool SetMCSFile (const std::string &sMCSFileName)
 
std::string Program (bool fullVerify=(0))
 
bool ProgramFromMCS (bool verify)
 
bool ProgramSOC (bool verify=(!(0)))
 
bool ProgramCustom (const std::string &sCustomFileName, const uint32_t addr, std::ostream &outMsgs)
 
bool ProgramKonaxMB (const std::string &sCustomFileName, const uint32_t addr, std::ostream &outMsgs)
 
bool EraseBlock (FlashBlockID blockNumber)
 
bool EraseChip (UWord chip=0)
 
bool CreateSRecord (bool bChangeEndian)
 
bool CreateEDIDIntelRecord ()
 
void SetQuietMode ()
 
bool VerifyFlash (FlashBlockID flashBlockNumber, bool fullVerify=(0))
 
bool ReadFlash (NTV2Buffer &outBuffer, const FlashBlockID flashID, CNTV2FlashProgress &inFlashProgress=CNTV2FlashProgress::nullUpdater)
 
bool SetBankSelect (BankSelect bankNumber)
 
bool SetFlashBlockIDBank (FlashBlockID blockID)
 
bool ROMHasBankSelect ()
 
uint32_t ReadBankSelect ()
 
bool SetMBReset ()
 
bool IsInstalledFWRunning (bool &outIsRunning, std::ostream &outErrorMsgs)
 
bool WriteCommand (_FLASH_COMMAND inCommand)
 
std::string GetDesignName (void) const
 
std::string GetPartName (void) const
 
std::string GetDate (void) const
 
std::string GetTime (void) const
 
const NTV2BitfileHeaderParserParser (void) const
 
uint32_t GetNumBytes (void) const
 
const std::string & GetMCSInfo (void) const
 
void ParsePartitionFromFileLines (uint32_t address, uint16_t &partitionOffset)
 
bool CreateBankRecord (BankSelect bankID)
 
bool ProgramMACAddresses (MacAddr *mac1, MacAddr *mac2)
 
bool ReadMACAddresses (MacAddr &mac1, MacAddr &mac2)
 
bool ProgramLicenseInfo (const std::string &licenseString)
 
bool ReadLicenseInfo (std::string &licenseString)
 
void DisplayData (const uint32_t address, const uint32_t len)
 
bool ProgramInfoFromString (std::string infoString)
 
bool FullProgram (std::vector< uint8_t > &dataBuffer)
 
int32_t NextMcsStep ()
 
bool WaitForFlashNOTBusy ()
 
bool ProgramFlashValue (uint32_t address, uint32_t value)
 
bool FastProgramFlash256 (uint32_t address, uint32_t *buffer)
 
bool EraseSector (uint32_t sectorAddress)
 
bool CheckFlashErasedWithBlockID (FlashBlockID flashBlockNumber)
 
uint32_t ReadDeviceID ()
 
bool SetDeviceProperties ()
 
void DetermineFlashTypeAndBlockNumberFromFileName (const std::string &bitFileName)
 
uint32_t GetSectorAddressForSector (FlashBlockID flashBlockNumber, uint32_t sectorNumber)
 
uint32_t GetBaseAddressForProgramming (FlashBlockID flashBlockNumber)
 
uint32_t GetNumberOfSectors (FlashBlockID flashBlockNumber)
 
bool VerifySOCPartition (FlashBlockID flashID, uint32_t FlashBlockOffset)
 
bool CheckAndFixMACs ()
 
bool MakeMACsFromSerial (const char *sSerialNumber, MacAddr *pMac1, MacAddr *pMac2)
 
- Public Member Functions inherited from CNTV2Card
virtual bool SetVideoFormat (const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail=(!(0)), const bool inKeepVancSettings=(0), const NTV2Channel inChannel=NTV2_CHANNEL1)
 Configures the AJA device to handle a specific video format. More...
 
virtual bool SetVideoFormat (const NTV2ChannelSet &inFrameStores, const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail=(!(0)))
 Sets the video format for one or more FrameStores. More...
 
virtual bool SetFrameGeometry (NTV2FrameGeometry inGeometry, bool inIsRetail=(!(0)), NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the frame geometry of the given channel. More...
 
virtual bool SetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat inNewFormat, bool inIsAJARetail=(!(0)), NTV2HDRXferChars inXferChars=NTV2_VPID_TC_SDR_TV, NTV2HDRColorimetry inColorimetry=NTV2_VPID_Color_Rec709, NTV2HDRLuminance inLuminance=NTV2_VPID_Luminance_YCbCr)
 Sets the frame buffer format for the given FrameStore on the AJA device. More...
 
virtual bool SetFrameBufferFormat (const NTV2ChannelSet &inFrameStores, const NTV2FrameBufferFormat inNewFormat, const bool inIsAJARetail=(!(0)), const NTV2HDRXferChars inXferChars=NTV2_VPID_TC_SDR_TV, const NTV2HDRColorimetry inColorimetry=NTV2_VPID_Color_Rec709, const NTV2HDRLuminance inLuminance=NTV2_VPID_Luminance_YCbCr)
 Sets the frame buffer format for the given FrameStore(s) on the AJA device. More...
 
virtual bool SetReference (const NTV2ReferenceSource inRefSource, const bool inKeepFramePulseSelect=(0))
 Sets the device's clock reference source. See Video Output Clocking & Synchronization for more information. More...
 
virtual bool GetReference (NTV2ReferenceSource &outRefSource)
 Answers with the device's current clock reference source. More...
 
virtual bool EnableFramePulseReference (const bool inEnable)
 Enables the device's frame pulse reference select. More...
 
virtual bool GetEnableFramePulseReference (bool &outEnabled)
 Answers whether or not the device's current frame pulse reference source is enabled. See Video Output Clocking & Synchronization for more information. More...
 
virtual bool SetFramePulseReference (const NTV2ReferenceSource inRefSource)
 Sets the device's frame pulse reference source. See Video Output Clocking & Synchronization for more information. More...
 
virtual bool GetFramePulseReference (NTV2ReferenceSource &outRefSource)
 Answers with the device's current frame pulse reference source. More...
 
virtual bool GetEveryFrameServices (NTV2EveryFrameTaskMode &outMode)
 Retrieves the device's current "retail service" task mode. More...
 
virtual bool SetEveryFrameServices (const NTV2EveryFrameTaskMode inMode)
 Sets the device's task mode. More...
 
virtual bool SetMode (const NTV2Channel inChannel, const NTV2Mode inNewValue, const bool inIsRetail=(!(0)))
 Determines if a given FrameStore on the AJA device will be used to capture or playout video. More...
 
virtual bool SetMode (const NTV2ChannelSet &inChannels, const NTV2Mode inMode)
 Sets the capture or playout mode of a set of FrameStores on the AJA device. More...
 
virtual bool GetMode (const NTV2Channel inChannel, NTV2Mode &outValue)
 Answers with the current NTV2Mode of the given FrameStore on the AJA device. More...
 
virtual bool GetFrameGeometry (NTV2FrameGeometry &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat &outValue)
 Returns the current frame buffer format for the given FrameStore on the AJA device. More...
 
virtual bool GetVideoFormat (NTV2VideoFormat &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetStandard (NTV2Standard inValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetStandard (NTV2Standard &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool IsProgressiveStandard (bool &outIsProgressive, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool IsSDStandard (bool &outIsStandardDef, NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetFrameRate (NTV2FrameRate inNewValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the AJA device's frame rate. More...
 
virtual bool GetFrameRate (NTV2FrameRate &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 Returns the AJA device's currently configured frame rate via its "value" parameter. More...
 
virtual bool SetSmpte372 (ULWord inValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 Enables or disables the device's SMPTE-372 (dual-link) mode (used for older 3G-levelB-capable devices). More...
 
virtual bool GetSmpte372 (ULWord &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
 Returns the device's current SMPTE-372 (dual-link) mode, whether it's enabled or not. More...
 
virtual bool SetProgressivePicture (ULWord value)
 
virtual bool GetProgressivePicture (ULWord &outValue)
 
virtual bool SetQuadFrameEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Enables or disables quad-frame mode on the device. More...
 
virtual bool GetQuadFrameEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Returns the device's current quad-frame mode, whether it's enabled or not. More...
 
virtual bool SetQuadQuadFrameEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Enables or disables "quad-quad" 8K frame mode on the device. More...
 
virtual bool GetQuadQuadFrameEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Returns the device's current "quad-quad" frame mode, whether it's enabled or not. More...
 
virtual bool SetQuadQuadSquaresEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Enables or disables quad-quad-frame (8K) squares mode on the device. More...
 
virtual bool GetQuadQuadSquaresEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Returns the device's current "quad-quad-squares" frame mode, whether it's enabled or not. More...
 
virtual bool Set4kSquaresEnable (const bool inIsEnabled, const NTV2Channel inChannel)
 Enables or disables SMPTE 425 "2K quadrants" mode for the given FrameStore bank on the device. Client applications should call this function when "4K Squares" mode (not two-sample-interleave) is needed. More...
 
virtual bool Get4kSquaresEnable (bool &outIsEnabled, const NTV2Channel inChannel)
 Answers whether the FrameStore bank's current SMPTE 425 "4K squares" (i.e., "2K quadrants") mode is enabled or not. More...
 
virtual bool SetTsiFrameEnable (const bool inIsEnabled, const NTV2Channel inChannel)
 Enables or disables SMPTE 425 two-sample interleave (Tsi) frame mode on the device. More...
 
virtual bool GetTsiFrameEnable (bool &outIsEnabled, const NTV2Channel inChannel)
 Returns the current SMPTE 425 two-sample-interleave frame mode on the device, whether it's enabled or not. More...
 
virtual bool GetTsiMuxSyncFail (bool &outSyncFailed, const NTV2Channel inWhichTsiMux)
 Answers if the SMPTE 425 two-sample-interleave mux/demux input sync has failed or not. More...
 
virtual bool SetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode inValue)
 
virtual bool GetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode &outValue)
 
virtual bool SetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality inValue)
 
virtual bool GetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality &outValue)
 
virtual bool SetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF inValue)
 
virtual bool GetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF &outValue)
 
virtual bool SetFrameBufferOrientation (const NTV2Channel inChannel, const NTV2FBOrientation inValue)
 Sets the frame buffer orientation for the given NTV2Channel. More...
 
virtual bool GetFrameBufferOrientation (const NTV2Channel inChannel, NTV2FBOrientation &outValue)
 Answers with the current frame buffer orientation for the given NTV2Channel. More...
 
virtual bool SetAlphaFromInput2Bit (ULWord inValue)
 
virtual bool GetAlphaFromInput2Bit (ULWord &outValue)
 
virtual bool SetOutputFrame (const NTV2Channel inChannel, const ULWord inValue)
 Sets the output frame index number for the given FrameStore. This identifies which frame in device SDRAM will be used for playout after the next VBI. More...
 
virtual bool GetOutputFrame (const NTV2Channel inChannel, ULWord &outValue)
 Answers with the current output frame number for the given FrameStore (expressed as an NTV2Channel). More...
 
virtual bool SetInputFrame (const NTV2Channel inChannel, const ULWord inValue)
 Sets the input frame index number for the given FrameStore. This identifies which frame in device SDRAM will be written after the next VBI. More...
 
virtual bool GetInputFrame (const NTV2Channel inChannel, ULWord &outValue)
 Answers with the current input frame index number for the given FrameStore. This identifies which particular frame in device SDRAM will be written after the next frame interrupt. More...
 
virtual bool SetDualLinkOutputEnable (const bool inIsEnabled)
 
virtual bool GetDualLinkOutputEnable (bool &outIsEnabled)
 
virtual bool SetDualLinkInputEnable (const bool inIsEnabled)
 
virtual bool GetDualLinkInputEnable (bool &outIsEnabled)
 
virtual bool SetVideoLimiting (const NTV2VideoLimiting inValue)
 Sets the device's video range limiting mode. More...
 
virtual bool GetVideoLimiting (NTV2VideoLimiting &outValue)
 Answers with the current video range limiting mode for the device. More...
 
virtual bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC, const NTV2Standard inStandard, const NTV2FrameGeometry inGeometry, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC=(0), const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the VANC mode for the given FrameStore. More...
 
virtual bool SetVANCMode (const NTV2ChannelSet &inChannels, const NTV2VANCMode inVancMode)
 Sets the VANC mode for the given FrameStores. More...
 
virtual bool GetVANCMode (NTV2VANCMode &outVancMode, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Retrieves the current VANC mode for the given FrameStore. More...
 
virtual bool SetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode inMode)
 Enables or disables the "VANC Shift Mode" feature for the given channel. More...
 
virtual bool SetVANCShiftMode (NTV2ChannelSet &inChannels, const NTV2VANCDataShiftMode inMode)
 Sets the "VANC Shift Mode" for the given channel(s). More...
 
virtual bool GetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode &outValue)
 Retrieves the current "VANC Shift Mode" feature for the given channel. More...
 
virtual bool SetPulldownMode (NTV2Channel inChannel, bool inValue)
 
virtual bool GetPulldownMode (NTV2Channel inChannel, bool &outValue)
 
virtual bool ReadLineCount (ULWord &outValue)
 Answers with the line offset into the frame currently being read (NTV2_MODE_DISPLAY) or written (NTV2_MODE_CAPTURE) for FrameStore 1. More...
 
virtual bool SetDefaultVideoOutMode (ULWord mode)
 
virtual bool GetDefaultVideoOutMode (ULWord &outMode)
 
virtual bool GetActiveFrameDimensions (NTV2FrameDimensions &outFrameDimensions, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual NTV2FrameDimensions GetActiveFrameDimensions (const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetNumberActiveLines (ULWord &outNumActiveLines)
 
virtual bool FlipFlopPage (const NTV2Channel inChannel)
 
virtual bool SetPCIAccessFrame (const NTV2Channel inChannel, const ULWord inValue, const bool inWaitForVBI=(!(0)))
 
virtual bool GetPCIAccessFrame (const NTV2Channel inChannel, ULWord &outValue)
 
virtual bool SetEnableVANCData (const NTV2ChannelSet &inChannels, const bool inVANCenable, const bool inTallerVANC=(0))
 
virtual bool SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Standard st, const NTV2FrameGeometry fg, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetBaseAddress (NTV2Channel channel, ULWord **pBaseAddress)
 
virtual bool GetBaseAddress (ULWord **pBaseAddress)
 
virtual bool GetRegisterBaseAddress (ULWord regNumber, ULWord **pRegAddress)
 
virtual bool GetXena2FlashBaseAddress (ULWord **pXena2FlashAddress)
 
virtual bool SupportsP2PTransfer (void)
 
virtual bool SupportsP2PTarget (void)
 
virtual bool SetForce64 (ULWord force64)
 
virtual bool GetForce64 (ULWord *force64)
 
virtual bool Get64BitAutodetect (ULWord *autodetect64)
 
virtual bool BankSelectReadRegister (const NTV2RegInfo &inBankSelect, NTV2RegInfo &inOutRegInfo)
 Reads the given set of registers from the bank specified in position 0. More...
 
virtual bool WriteRegisters (const NTV2RegisterWrites &inRegWrites)
 Writes the given sequence of NTV2RegInfo's. More...
 
virtual bool BankSelectWriteRegister (const NTV2RegInfo &inBankSelect, const NTV2RegInfo &inRegInfo)
 Writes the given set of registers to the bank specified at position 0. More...
 
virtual bool WriteVirtualData (const ULWord inTag, const void *inVirtualData, const ULWord inVirtualDataSize)
 Writes the block of virtual data. More...
 
virtual bool ReadVirtualData (const ULWord inTag, void *outVirtualData, const ULWord inVirtualDataSize)
 Reads the block of virtual data for a specific tag. More...
 
virtual bool ReadSDIStatistics (NTV2SDIInStatistics &outStats)
 For devices that support it (see the NTV2DeviceCanDoSDIErrorChecks function in "ntv2devicefeatures.h"), this function fetches the SDI statistics for all SDI input spigots. More...
 
virtual bool SetFrameBufferSize (const NTV2Framesize inSize)
 Sets the device's intrinsic frame buffer size. More...
 
virtual bool SetFrameBufferSize (const NTV2Channel inChannel, const NTV2Framesize inValue)
 Sets the device's intrinsic frame buffer size. More...
 
virtual bool GetFrameBufferSize (const NTV2Channel inChannel, NTV2Framesize &outValue)
 Answers with the frame size currently being used on the device. More...
 
virtual bool IsBufferSizeSetBySW (void)
 
virtual bool DisableChannel (const NTV2Channel inChannel)
 Disables the given FrameStore. More...
 
virtual bool DisableChannels (const NTV2ChannelSet &inChannels)
 Disables the given FrameStore(s). More...
 
virtual bool EnableChannel (const NTV2Channel inChannel)
 Enables the given FrameStore. More...
 
virtual bool EnableChannels (const NTV2ChannelSet &inChannels, const bool inDisableOthers=(0))
 Enables the given FrameStore(s). More...
 
virtual bool IsChannelEnabled (const NTV2Channel inChannel, bool &outEnabled)
 Answers whether or not the given FrameStore is enabled. More...
 
virtual bool GetEnabledChannels (NTV2ChannelSet &outChannels)
 Answers with the set of channels that are currently enabled. More...
 
virtual bool GetDisabledChannels (NTV2ChannelSet &outChannels)
 Answers with the set of channels that are currently disabled. More...
 
virtual bool SetVideoDACMode (NTV2VideoDACMode inValue)
 
virtual bool GetVideoDACMode (NTV2VideoDACMode &outValue)
 
virtual bool SetSDIOutputStandard (const UWord inOutputSpigot, const NTV2Standard inValue)
 Sets the SDI output spigot's video standard. More...
 
virtual bool SetSDIOutputStandard (const NTV2ChannelSet &inSDIOutputs, const NTV2Standard inValue)
 Sets the video standard for the given SDI output(s). More...
 
virtual bool GetSDIOutputStandard (const UWord inOutputSpigot, NTV2Standard &outValue)
 Answers with the current video standard of the given SDI output spigot. More...
 
virtual bool SetSecondaryVideoFormat (NTV2VideoFormat inFormat)
 
virtual bool GetSecondaryVideoFormat (NTV2VideoFormat &outFormat)
 
virtual bool SetInputVideoSelect (NTV2InputVideoSelect inInputSelect)
 
virtual bool GetInputVideoSelect (NTV2InputVideoSelect &outInputSelect)
 
virtual NTV2VideoFormat GetInputVideoFormat (const NTV2InputSource inVideoSource=NTV2_INPUTSOURCE_SDI1, const bool inIsProgressive=(0))
 Returns the video format of the signal that is present on the given input source. More...
 
virtual NTV2VideoFormat GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive=(0))
 Returns the video format of the signal that is present on the given SDI input source. More...
 
virtual NTV2VideoFormat GetHDMIInputVideoFormat (NTV2Channel inHDMIInput=NTV2_CHANNEL1)
 
virtual NTV2VideoFormat GetAnalogInputVideoFormat (void)
 Returns the video format of the signal that is present on the device's analog video input. More...
 
virtual NTV2VideoFormat GetAnalogCompositeInputVideoFormat (void)
 Returns the video format of the signal that is present on the device's composite video input. More...
 
virtual NTV2VideoFormat GetReferenceVideoFormat (void)
 Returns the video format of the signal that is present on the device's reference input. More...
 
virtual NTV2FrameRate GetSDIInputRate (const NTV2Channel channel)
 
virtual NTV2FrameGeometry GetSDIInputGeometry (const NTV2Channel channel)
 
virtual bool GetSDIInputIsProgressive (const NTV2Channel channel)
 
virtual bool GetSDIInput3GPresent (bool &outValue, const NTV2Channel channel)
 
virtual bool GetSDIInput3GbPresent (bool &outValue, const NTV2Channel channel)
 
virtual bool GetSDIInput6GPresent (bool &outValue, const NTV2Channel channel)
 
virtual bool GetSDIInput12GPresent (bool &outValue, const NTV2Channel channel)
 
virtual bool SetLHIVideoDACStandard (const NTV2Standard inValue)
 
virtual bool GetLHIVideoDACStandard (NTV2Standard &outValue)
 
virtual bool SetLHIVideoDACMode (NTV2LHIVideoDACMode value)
 
virtual bool GetLHIVideoDACMode (NTV2LHIVideoDACMode &outValue)
 
virtual bool SetLHIVideoDACMode (const NTV2VideoDACMode inValue)
 
virtual bool GetLHIVideoDACMode (NTV2VideoDACMode &outValue)
 
virtual bool SetSDIOut2Kx1080Enable (const NTV2Channel inChannel, const bool inIsEnabled)
 
virtual bool GetSDIOut2Kx1080Enable (const NTV2Channel inChannel, bool &outIsEnabled)
 
virtual bool SetSDIOut3GEnable (const NTV2Channel inChannel, const bool inEnable)
 
virtual bool GetSDIOut3GEnable (const NTV2Channel inChannel, bool &outIsEnabled)
 
virtual bool SetSDIOut3GbEnable (const NTV2Channel inChannel, const bool inEnable)
 
virtual bool GetSDIOut3GbEnable (const NTV2Channel inChannel, bool &outIsEnabled)
 
virtual bool SetSDIOut6GEnable (const NTV2Channel inChannel, const bool inEnable)
 
virtual bool GetSDIOut6GEnable (const NTV2Channel inChannel, bool &outIsEnabled)
 
virtual bool SetSDIOut12GEnable (const NTV2Channel inChannel, const bool inEnable)
 
virtual bool GetSDIOut12GEnable (const NTV2Channel inChannel, bool &outIsEnabled)
 
virtual bool SetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem)
 Sets the device's NTV2AudioSystem that will provide audio for the given SDI output's audio embedder. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A). More...
 
virtual bool SetSDIOutputAudioSystem (const NTV2ChannelSet &inSDIOutputs, const NTV2AudioSystem inAudioSystem, const bool inDS2=(0))
 Sets the device's NTV2AudioSystem that will provide audio for the given SDI outputs' audio embedders. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A). More...
 
virtual bool GetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem &outAudioSystem)
 Answers with the device's NTV2AudioSystem that is currently providing audio for the given SDI output's audio embedder. (For 3G-capable SDI outputs, this is for Data Stream 1, or Link A.) More...
 
virtual bool SetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem)
 Sets the Audio System that will supply audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link playout. More...
 
virtual bool GetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem &outAudioSystem)
 Answers with the device's Audio System that is currently providing audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link output. More...
 
virtual bool SetSDIInLevelBtoLevelAConversion (const NTV2ChannelSet &inSDIInputs, const bool inEnable)
 Enables or disables 3G level B to 3G level A conversion at the SDI input(s). More...
 
virtual bool SetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, const bool inEnable)
 Enables or disables 3G level B to 3G level A conversion at the SDI input widget (assuming the AJA device can do so). More...
 
virtual bool GetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, bool &outIsEnabled)
 Answers with the device's current 3G level B to 3G level A conversion setting for the given SDI input spigot (assuming the device can do such a conversion). More...
 
virtual bool SetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, const bool inEnable)
 Enables or disables 3G level A to 3G level B conversion at the SDI output widget (assuming the AJA device can do so). More...
 
virtual bool SetSDIOutLevelAtoLevelBConversion (const NTV2ChannelSet &inSDIOutputs, const bool inEnable)
 Enables or disables 3G level A to 3G level B conversion at the given SDI output(s). More...
 
virtual bool GetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, bool &outIsEnabled)
 Answers with the device's current 3G level A to 3G level B conversion setting for the given SDI output spigot (assuming the device can do such a conversion). More...
 
virtual bool SetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, const bool inEnable)
 Enables or disables an RGB-over-3G-level-A conversion at the SDI output widget (assuming the AJA device can do so). More...
 
virtual bool SetSDIOutRGBLevelAConversion (const NTV2ChannelSet &inSDIOutputs, const bool inEnable)
 Enables or disables an RGB-over-3G-level-A conversion at the given SDI output(s). More...
 
virtual bool GetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, bool &outIsEnabled)
 Answers with the device's current RGB-over-3G-level-A conversion at the given SDI output spigot (assuming the device can do such a conversion). More...
 
virtual bool SetMultiFormatMode (const bool inEnable)
 Enables or disables multi-format (per channel) device operation. If enabled, each device channel can handle a different video format (subject to certain limitations). If disabled, all device channels have the same video format. More...
 
virtual bool GetMultiFormatMode (bool &outIsEnabled)
 Answers if the device is operating in multiple-format per channel (independent channel) mode or not. If enabled, each device channel can accommodate a different video format (subject to certain limitations). If disabled, all device channels have the same video format. More...
 
virtual CNTV2DriverInterfacedriverInterface (void)
 
virtual std::string GetFPGAVersionString (const NTV2XilinxFPGA inFPGA=eFPGAVideoProc)
 
virtual Word GetPCIFPGAVersion (void)
 
virtual std::string GetPCIFPGAVersionString (void)
 
virtual bool GetInstalledBitfileInfo (ULWord &outNumBytes, std::string &outDateStr, std::string &outTimeStr)
 Returns the size and time/date stamp of the device's currently-installed firmware. More...
 
virtual std::string GetBitfileInfoString (const BITFILE_INFO_STRUCT &inBitFileInfo)
 Generates and returns an info string with date, time and name for the given inBifFileInfo. More...
 
virtual bool IsFailSafeBitfileLoaded (bool &outIsFailSafe)
 Answers whether or not the "fail-safe" (aka "safe-boot") bitfile is currently loaded and running in the FPGA. More...
 
virtual bool CanWarmBootFPGA (bool &outCanWarmBoot)
 Answers whether or not the FPGA can be reloaded without powering off. More...
 
virtual bool IsDynamicDevice (void)
 
virtual bool IsDynamicFirmwareLoaded (void)
 
virtual NTV2DeviceID GetBaseDeviceID ()
 
virtual NTV2DeviceIDList GetDynamicDeviceList (void)
 
virtual NTV2DeviceIDSet GetDynamicDeviceIDs (void)
 
virtual bool CanLoadDynamicDevice (const NTV2DeviceID inDeviceID)
 
virtual bool LoadDynamicDevice (const NTV2DeviceID inDeviceID)
 Quickly, dynamically loads the given device ID firmware. More...
 
virtual bool AddDynamicBitfile (const std::string &inBitfilePath)
 Adds the given bitfile to the list of available dynamic bitfiles. More...
 
virtual bool AddDynamicDirectory (const std::string &inDirectory)
 Adds all bitfiles found in the given host file directory to the list of available dynamic bitfiles. More...
 
virtual bool IsBreakoutBoardConnected (void)
 
virtual ULWord GetFrameBufferSize (void) const
 
 CNTV2Card ()
 My default constructor. More...
 
 CNTV2Card (const UWord inDeviceIndex, const std::string &inHostName=std::string())
 Constructor that opens the device. More...
 
virtual ~CNTV2Card ()
 My destructor. More...
 
virtual std::string GetDisplayName (void)
 Answers with this device's display name. More...
 
virtual std::string GetModelName (void)
 Answers with this device's model name. More...
 
virtual Word GetDeviceVersion (void)
 Answers with this device's version number. More...
 
virtual std::string GetDeviceVersionString (void)
 Answers with this device's version number as a human-readable string. More...
 
virtual std::string GetDriverVersionString (void)
 Answers with this device's driver's version as a human-readable string. More...
 
virtual std::string GetDescription (void) const
 
virtual bool GetDriverVersionComponents (UWord &outMajor, UWord &outMinor, UWord &outPoint, UWord &outBuild)
 Answers with the individual version components of this device's driver. More...
 
virtual uint64_t GetSerialNumber (void)
 Answers with my serial number. More...
 
virtual bool GetSerialNumberString (std::string &outSerialNumberString)
 Answers with a string that contains my human-readable serial number. More...
 
virtual bool GetPCIDeviceID (ULWord &outPCIDeviceID)
 Answers with my PCI device ID. More...
 
virtual NTV2BreakoutType GetBreakoutHardware (void)
 
virtual class DeviceCapabilitiesfeatures (void)
 
virtual bool DeviceCanDoFormat (const NTV2FrameRate inFR, const NTV2FrameGeometry inFG, const NTV2Standard inStd)
 
virtual ULWord DeviceGetFrameBufferSize (void)
 
virtual ULWord DeviceGetAudioFrameBuffer (void)
 
virtual ULWord DeviceGetAudioFrameBuffer2 (void)
 
virtual ULWord DeviceGetFrameBufferSize (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)
 
virtual ULWord DeviceGetNumberFrameBuffers (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)
 
virtual ULWord DeviceGetAudioFrameBuffer (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)
 
virtual ULWord DeviceGetAudioFrameBuffer2 (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)
 
virtual bool DeviceCanDoVideoFormat (const NTV2VideoFormat inVF)
 
virtual bool DeviceCanDoFrameBufferFormat (const NTV2PixelFormat inPF)
 
virtual bool DeviceCanDoWidget (const NTV2WidgetID inWgtID)
 
virtual bool DeviceCanDoConversionMode (const NTV2ConversionMode inCM)
 
virtual bool DeviceCanDoDSKMode (const NTV2DSKMode inDSKM)
 
virtual bool DeviceCanDoInputSource (const NTV2InputSource inSrc)
 
virtual ULWord DeviceGetNumberFrameBuffers (void)
 
virtual bool DMARead (const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
 Transfers data from the AJA device to the host. More...
 
virtual bool DMAWrite (const ULWord inFrameNumber, const ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
 Transfers data from the host to the AJA device. More...
 
virtual bool DMAReadFrame (const ULWord inFrameNumber, ULWord *pOutFrameBuffer, const ULWord inByteCount)
 Transfers a single frame from the AJA device to the host. More...
 
virtual bool DMAReadFrame (const ULWord inFrameNumber, ULWord *pHostBuffer, const ULWord inByteCount, const NTV2Channel inChannel)
 Transfers a single frame from the AJA device to the host. This call is multi-format compatible. More...
 
virtual bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord *pInFrameBuffer, const ULWord inByteCount)
 Transfers a single frame from the host to the AJA device. More...
 
virtual bool DMAWriteFrame (const ULWord inFrameNumber, const ULWord *pInFrameBuffer, const ULWord inByteCount, const NTV2Channel inChannel)
 Transfers a single frame from the host to the AJA device. This function is multi-format compatible. More...
 
virtual bool DMAReadSegments (const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inSegmentByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch)
 Performs a segmented data transfer from the AJA device to the host. More...
 
virtual bool DMAWriteSegments (const ULWord inFrameNumber, const ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inSegmentByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch)
 Performs a segmented data transfer from the host to the AJA device. More...
 
virtual bool DmaP2PTargetFrame (NTV2Channel channel, ULWord frameNumber, ULWord frameOffset, PCHANNEL_P2P_STRUCT pP2PData)
 DirectGMA p2p transfers (not GPUDirect: see DMABufferLock) More...
 
virtual bool DmaP2PTransferFrame (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord frameOffset, ULWord transferSize, ULWord numSegments, ULWord segmentTargetPitch, ULWord segmentCardPitch, PCHANNEL_P2P_STRUCT pP2PData)
 
virtual bool DMAReadAudio (const NTV2AudioSystem inAudioSystem, ULWord *pOutAudioBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
 Synchronously transfers audio data from a given Audio System's buffer memory on the AJA device to the specified host buffer, blocking until the transfer has completed. More...
 
virtual bool DMAWriteAudio (const NTV2AudioSystem inAudioSystem, const ULWord *pInAudioBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
 Synchronously transfers audio data from the specified host buffer to the given Audio System's buffer memory on the AJA device, blocking until the transfer has completed. More...
 
virtual bool DMAReadAnc (const ULWord inFrameNumber, NTV2Buffer &outAncF1Buffer, NTV2Buffer &outAncF2Buffer=NULL_POINTER, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Transfers the contents of the ancillary data buffer(s) from a given frame on the AJA device to the host. More...
 
virtual bool DMAWriteAnc (const ULWord inFrameNumber, NTV2Buffer &inAncF1Buffer, NTV2Buffer &inAncF2Buffer=NULL_POINTER, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Transfers the contents of the ancillary data buffer(s) from the host to a given frame on the AJA device. More...
 
virtual bool DMAWriteLUTTable (const ULWord inFrameNumber, const ULWord *pInLUTBuffer, const ULWord inLUTIndex, const ULWord inByteCount=LUTTablePartitionSize)
 Synchronously transfers LUT data from the specified host buffer to the given buffer memory on the AJA device, blocking until the transfer has completed. More...
 
virtual bool DMABufferLock (const NTV2Buffer &inBuffer, bool inMap=(0), bool inRDMA=(0))
 Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers. More...
 
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. More...
 
virtual bool DMABufferUnlock (const NTV2Buffer &inBuffer)
 Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock. More...
 
virtual bool DMABufferUnlock (const ULWord *pInBuffer, const ULWord inByteCount)
 Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock. More...
 
virtual bool DMABufferUnlockAll ()
 Unlocks all previously-locked buffers used for DMA transfers. More...
 
virtual bool DMABufferAutoLock (const bool inEnable, const bool inMap=(0), const ULWord64 inMaxLockSize=0)
 Enables or disables automatic buffer locking. More...
 
virtual bool DMAClearAncRegion (const UWord inStartFrameNumber, const UWord inEndFrameNumber, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All, const NTV2Channel=NTV2_CHANNEL1)
 Clears the ancillary data region in the device frame buffer for the specified frames. More...
 
virtual bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, uint64_t &outAddress, uint64_t &outLength)
 Answers with the address and size of the given frame. More...
 
virtual bool GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, ULWord &outIntrinsicSize, bool &outMultiFmt, bool &outQuad, bool &outQuadQuad, bool &outSquares, bool &outTSI, uint64_t &outAddress, uint64_t &outLength)
 
virtual bool DeviceAddressToFrameNumber (const uint64_t inAddress, UWord &outFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the frame number that contains the given address. More...
 
virtual bool GetAncRegionOffsetAndSize (ULWord &outByteOffset, ULWord &outByteCount, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All)
 Answers with the offset and size of an ancillary data region within a device frame buffer. More...
 
virtual bool GetAncRegionOffsetFromBottom (ULWord &outByteOffsetFromBottom, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All)
 Answers with the byte offset to the start of an ancillary data region within a device frame buffer, as measured from the bottom of the frame buffer. More...
 
virtual bool SetMixerVancOutputFromForeground (const UWord inWhichMixer, const bool inFromForegroundSource=(!(0)))
 Sets the VANC source for the given mixer/keyer to the foreground video (or not). See the SDI Ancillary Data discussion for more information. More...
 
virtual bool GetMixerVancOutputFromForeground (const UWord inWhichMixer, bool &outIsFromForegroundSource)
 Answers whether or not the VANC source for the given mixer/keyer is currently the foreground video. See the SDI Ancillary Data discussion for more information. More...
 
virtual bool SetMixerFGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl)
 Sets the foreground input control value for the given mixer/keyer. More...
 
virtual bool GetMixerFGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl &outInputControl)
 Returns the current foreground input control value for the given mixer/keyer. More...
 
virtual bool SetMixerBGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl)
 Sets the background input control value for the given mixer/keyer. More...
 
virtual bool GetMixerBGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl &outInputControl)
 Returns the current background input control value for the given mixer/keyer. More...
 
virtual bool SetMixerMode (const UWord inWhichMixer, const NTV2MixerKeyerMode inMode)
 Sets the mode for the given mixer/keyer. More...
 
virtual bool GetMixerMode (const UWord inWhichMixer, NTV2MixerKeyerMode &outMode)
 Returns the current operating mode of the given mixer/keyer. More...
 
virtual bool SetMixerCoefficient (const UWord inWhichMixer, const ULWord inMixCoefficient)
 Sets the current mix coefficient of the given mixer/keyer. More...
 
virtual bool GetMixerCoefficient (const UWord inWhichMixer, ULWord &outMixCoefficient)
 Returns the current mix coefficient the given mixer/keyer. More...
 
virtual bool GetMixerSyncStatus (const UWord inWhichMixer, bool &outIsSyncOK)
 Returns the current sync state of the given mixer/keyer. More...
 
virtual bool GetMixerFGMatteEnabled (const UWord inWhichMixer, bool &outIsEnabled)
 Answers if the given mixer/keyer's foreground matte is enabled or not. More...
 
virtual bool SetMixerFGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled)
 Answers if the given mixer/keyer's foreground matte is enabled or not. More...
 
virtual bool GetMixerBGMatteEnabled (const UWord inWhichMixer, bool &outIsEnabled)
 Answers if the given mixer/keyer's background matte is enabled or not. More...
 
virtual bool SetMixerBGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled)
 Answers if the given mixer/keyer's background matte is enabled or not. More...
 
virtual bool GetMixerMatteColor (const UWord inWhichMixer, YCbCr10BitPixel &outYCbCrValue)
 Answers with the given mixer/keyer's current matte color value being used. More...
 
virtual bool SetMixerMatteColor (const UWord inWhichMixer, const YCbCr10BitPixel inYCbCrValue)
 Sets the matte color to use for the given mixer/keyer. More...
 
virtual bool MixerHasRGBModeSupport (const UWord inWhichMixer, bool &outIsSupported)
 Answers if the given mixer/keyer's has RGB mode support. More...
 
virtual bool SetMixerRGBRange (const UWord inWhichMixer, const NTV2MixerRGBRange inRGBRange)
 Sets the RGB range for the given mixer/keyer. More...
 
virtual bool GetMixerRGBRange (const UWord inWhichMixer, NTV2MixerRGBRange &outRGBRange)
 Answers with the given mixer/keyer's current RGB Range. More...
 
virtual bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the number of audio channels to be concurrently captured or played for a given Audio System on the AJA device. More...
 
virtual bool SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystemSet &inAudioSystems)
 Sets the number of audio channels to be concurrently captured or played for the given Audio System(s). More...
 
virtual bool GetNumberAudioChannels (ULWord &outNumChannels, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Returns the current number of audio channels being captured or played by a given Audio System on the AJA device. More...
 
virtual bool SetAudioRate (const NTV2AudioRate inRate, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the NTV2AudioRate for the given Audio System. More...
 
virtual bool GetAudioRate (NTV2AudioRate &outRate, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Returns the current NTV2AudioRate for the given Audio System. More...
 
virtual bool SetAudioBufferSize (const NTV2AudioBufferSize inValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Changes the size of the audio buffer that is used for a given Audio System in the AJA device. More...
 
virtual bool SetAudioBufferSize (const NTV2AudioBufferSize inMode, const NTV2AudioSystemSet &inAudioSystems)
 Changes the size of the audio buffer used for the given Audio System(s). More...
 
virtual bool GetAudioBufferSize (NTV2AudioBufferSize &outSize, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Retrieves the size of the input or output audio buffer being used for a given Audio System on the AJA device. More...
 
virtual bool SetAudio20BitMode (const NTV2AudioSystem inAudioSystem, const bool inEnable)
 Enables or disables 20-bit mode for the NTV2AudioSystem. More...
 
virtual bool GetAudio20BitMode (const NTV2AudioSystem inAudioSystem, bool &outEnable)
 Answers whether or not the device's NTV2AudioSystem is currently operating in 20-bit mode. Normally the NTV2AudioSystem operates in 24-bit mode. More...
 
virtual bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Enables or disables NTV2AudioLoopBack mode for the given NTV2AudioSystem. More...
 
virtual bool SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystemSet &inAudioSystems)
 Enables or disables NTV2AudioLoopBack mode for the given Audio Systems. More...
 
virtual bool GetAudioLoopBack (NTV2AudioLoopBack &outMode, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Answers if NTV2AudioLoopBack mode is currently on or off for the given NTV2AudioSystem. More...
 
virtual bool SetAudioAnalogLevel (const NTV2AudioLevel value, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 
virtual bool GetAudioAnalogLevel (NTV2AudioLevel &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 
virtual bool SetEncodedAudioMode (const NTV2EncodedAudioMode value, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 
virtual bool GetEncodedAudioMode (NTV2EncodedAudioMode &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 
virtual bool SetEmbeddedAudioClock (const NTV2EmbeddedAudioClock inValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the NTV2EmbeddedAudioClock setting for the given NTV2AudioSystem. More...
 
virtual bool GetEmbeddedAudioClock (NTV2EmbeddedAudioClock &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 For the given NTV2AudioSystem, answers with the current NTV2EmbeddedAudioClock setting. More...
 
virtual bool GetAudioWrapAddress (ULWord &outWrapAddress, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 For the given Audio System, answers with the wrap address, the threshold at which input/record or output/play transfers will likely need to account for "wrapping" around the end of the buffer back to the start of the buffer to continue recording/playing. More...
 
virtual bool GetAudioReadOffset (ULWord &outReadOffset, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 For the given Audio System, answers with the byte offset from the start of the audio buffer to the first byte of the input/capture buffer. (The capture buffer immediately follows the playout buffer in increasing memory address order.) More...
 
virtual bool GetAudioMemoryOffset (const ULWord inOffsetBytes, ULWord &outAbsByteOffset, const NTV2AudioSystem inAudioSystem, const bool inCaptureBuffer=(0))
 Answers with the byte offset in device SDRAM into the specified Audio System's audio buffer. More...
 
virtual bool ReadAudioLastOut (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 For the given Audio System, answers with the byte offset of the tail end of the last chunk of audio samples read by the device's output audio embedder. This is essentially the position of the "Play Head" during audio output. More...
 
virtual bool ReadAudioLastIn (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 For the given Audio System, answers with the byte offset to the last byte of the latest chunk of 4-byte audio samples written into the device's input audio buffer by its input audio de-embedder. This is essentially the position of the "Write Head" during audio capture. More...
 
virtual bool StartAudioOutput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI=(0))
 Starts the playout side of the given NTV2AudioSystem, reading outgoing audio samples from the Audio System's playout buffer. More...
 
virtual bool StopAudioOutput (const NTV2AudioSystem inAudioSystem)
 Stops the playout side of the given NTV2AudioSystem, parking the "Read Head" at the start of the playout buffer. More...
 
virtual bool IsAudioOutputRunning (const NTV2AudioSystem inAudioSystem, bool &outIsRunning)
 Answers whether or not the playout side of the given NTV2AudioSystem is currently running. More...
 
virtual bool SetAudioOutputPause (const NTV2AudioSystem inAudioSystem, const bool inPausePlayout)
 Pauses or resumes output of audio samples and advancement of the audio buffer pointer ("play head") of the given Audio System. More...
 
virtual bool GetAudioOutputPause (const NTV2AudioSystem inAudioSystem, bool &outIsPaused)
 Answers if the device's Audio System is currently paused or not. More...
 
virtual bool StartAudioInput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI=(0))
 Starts the capture side of the given NTV2AudioSystem, writing incoming audio samples into the Audio System's capture buffer. More...
 
virtual bool StopAudioInput (const NTV2AudioSystem inAudioSystem)
 Stops the capture side of the given NTV2AudioSystem, and resets the capture position (i.e. "Write Head") back to the start of the Audio System's capture buffer (offset zero). This can be useful for resynchronizing audio and video. More...
 
virtual bool IsAudioInputRunning (const NTV2AudioSystem inAudioSystem, bool &outIsRunning)
 Answers whether or not the capture side of the given NTV2AudioSystem is currently running. More...
 
virtual bool SetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable)
 Enables or disables the writing of incoming audio into the given Audio System's capture buffer. More...
 
virtual bool GetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, bool &outEnable)
 Answers whether or not the Audio System is configured to write captured audio samples into device audio buffer memory. More...
 
virtual bool SetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable)
 Enables or disables a special mode for the given Audio System whereby its embedder and deembedder both start from the audio base address, instead of operating independently. More...
 
virtual bool GetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, bool &outEnable)
 Answers whether or not the device's Audio System is currently operating in a special mode in which its embedder and deembedder both start from the audio base address, instead of operating independently. More...
 
virtual bool SetAudioInputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay)
 Sets the audio input delay for the given Audio System on the device. More...
 
virtual bool GetAudioInputDelay (const NTV2AudioSystem inAudioSystem, ULWord &outDelay)
 Answers with the audio input delay for the given Audio System on the device. More...
 
virtual bool SetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay)
 Sets the audio output delay for the given Audio System on the device. More...
 
virtual bool GetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, ULWord &outDelay)
 Answers with the audio output delay for the given Audio System on the device. More...
 
virtual bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const bool inIsNonPCM)
 Determines whether or not all outgoing audio channel pairs are to be flagged as non-PCM for the given Audio System on the device. More...
 
virtual bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, bool &outIsNonPCM)
 Answers whether or not all outgoing audio channel pairs are currently being flagged as non-PCM for the given Audio System on the device. More...
 
virtual bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, const bool inIsNonPCM)
 Determines whether the given audio channel pair being transmitted by the given Audio System is to be flagged as non-PCM or not. More...
 
virtual bool SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPairs &inNonPCMChannelPairs)
 Sets the non-PCM indicator in the AES header of the given channel pairs for the given Audio System on the device. More...
 
virtual bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool &outIsNonPCM)
 Answers whether or not the given audio channel pair in the given Audio System on the device is being treated as normal PCM audio. More...
 
virtual bool GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs &outNonPCMChannelPairs)
 Answers which NTV2AudioChannelPairs being transmitted by the given NTV2AudioSystem are currently being flagged as non-PCM. More...
 
virtual bool IsAudioChannelPairPresent (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool &outIsPresent)
 Answers whether or not the given NTV2AudioChannelPair in the given NTV2AudioSystem on the device is present in the input signal. More...
 
virtual bool GetDetectedAudioChannelPairs (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs &outDetectedChannelPairs)
 Answers which audio channel pairs are present in the given Audio System's input stream. More...
 
virtual bool GetDetectedAESChannelPairs (NTV2AudioChannelPairs &outDetectedChannelPairs)
 Answers which AES/EBU audio channel pairs are present on the device. More...
 
virtual bool SetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, const NTV2AudioSource inAudioSource, const NTV2EmbeddedAudioInput inEmbeddedInput)
 Sets the audio source for the given NTV2AudioSystem on the device. More...
 
virtual bool GetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, NTV2AudioSource &outAudioSource, NTV2EmbeddedAudioInput &outEmbeddedSource)
 Answers with the device's current NTV2AudioSource (and also possibly its NTV2EmbeddedAudioInput) for the given NTV2AudioSystem. More...
 
virtual bool SetEmbeddedAudioInput (const NTV2EmbeddedAudioInput inEmbeddedSource, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the embedded (SDI) audio source for the given NTV2AudioSystem on the device. More...
 
virtual bool GetEmbeddedAudioInput (NTV2EmbeddedAudioInput &outEmbeddedSource, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Answers with the device's current embedded (SDI) audio source for the given NTV2AudioSystem. More...
 
virtual bool InputAudioChannelPairHasPCM (const NTV2Channel inSDIInputConnector, const NTV2AudioChannelPair inAudioChannelPair, bool &outIsPCM)
 For the given SDI input (specified as a channel number), answers if the specified audio channel pair is currently PCM-encoded or not. More...
 
virtual bool GetInputAudioChannelPairsWithPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs &outChannelPairs)
 For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently PCM-encoded. More...
 
virtual bool GetInputAudioChannelPairsWithoutPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs &outChannelPairs)
 For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently not PCM-encoded. More...
 
virtual bool GetSuspendHostAudio (bool &outIsSuspended)
 Answers as to whether or not the host OS audio services for the AJA device (e.g. CoreAudio on MacOS) are currently suspended or not. More...
 
virtual bool SetSuspendHostAudio (const bool inSuspend)
 Suspends or resumes host OS audio (e.g. CoreAudio on MacOS) for the AJA device. More...
 
virtual bool GetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, NTV2AudioSystem &outSrcAudioSystem, NTV2Audio4ChannelSelect &outSrcAudioChannels)
 Answers with the current audio source for a given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc. More...
 
virtual bool SetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, const NTV2AudioSystem inSrcAudioSystem, const NTV2Audio4ChannelSelect inSrcAudioChannels)
 Changes the audio source for the given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc. More...
 
virtual bool SetAudioOutputMonitorSource (const NTV2AudioChannelPair inChannelPair, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the audio monitor output source to a specified audio system and channel pair. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack. More...
 
virtual bool GetAudioOutputMonitorSource (NTV2AudioChannelPair &outChannelPair, NTV2AudioSystem &outAudioSystem)
 Answers with the current audio monitor source. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack. More...
 
virtual bool GetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, bool &outIsEnabled)
 Answers with the current state of the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream. More...
 
virtual bool SetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, const bool &inEnable)
 Enables or disables the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream. More...
 
virtual bool GetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, bool &outEraseModeEnabled)
 Answers with the current state of the audio output erase mode for the given Audio System. If enabled, the Audio System automatically writes zeroes into the audio output buffer behind the output read head during playout. More...
 
virtual bool SetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, const bool &inEraseModeEnabled)
 Enables or disables output erase mode for the given Audio System, which, when enabled, automatically writes zeroes into the audio output buffer behind the output read head. More...
 
virtual bool GetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, bool &outAESSyncModeBitSet)
 Answers with the current state of the AES Sync Mode bit for the given Audio System's output. More...
 
virtual bool SetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, const bool &inAESSyncModeBitSet)
 Sets or clears the AES Sync Mode bit for the given Audio System's output. More...
 
virtual bool SetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, const bool inEnable)
 Sets the specified bidirectional XLR audio connectors to collectively act as inputs or outputs. More...
 
virtual bool GetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, bool &outEnabled)
 Answers whether or not the specified bidirectional XLR audio connectors are collectively acting as inputs or outputs. More...
 
virtual bool GetRawAudioTimer (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Answers with the current value of the 48kHz audio clock counter. More...
 
virtual bool EnableBOBAnalogAudioIn (bool inEnable)
 Enables breakout board analog audio XLR inputs. More...
 
virtual bool SetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, const bool inEnable)
 Sets the multi-link audio mode for the given audio system. More...
 
virtual bool GetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, bool &outEnabled)
 Answers with the current multi-link audio mode for the given audio system. More...
 
virtual bool WriteAudioSource (const ULWord inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool ReadAudioSource (ULWord &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetAnalogAudioIOConfiguration (const NTV2AnalogAudioIO inConfig)
 
virtual bool GetAnalogAudioIOConfiguration (NTV2AnalogAudioIO &outConfig)
 
virtual bool GetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, NTV2AudioSystem &outAudioSystem)
 Answers with the Audio System that's currently driving the given input of the Audio Mixer. More...
 
virtual bool SetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, const NTV2AudioSystem inAudioSystem)
 Sets the Audio System that will drive the given input of the Audio Mixer. More...
 
virtual bool GetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelPair &outChannelPair)
 Answers with the Audio Channel Pair that's currently driving the given input of the Audio Mixer. More...
 
virtual bool SetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPair inChannelPair)
 Specifies the Audio Channel Pair that will drive the given input of the Audio Mixer. More...
 
virtual bool GetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, ULWord &outGainValue)
 Answers with the current gain setting for the Audio Mixer's given input. More...
 
virtual bool SetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, const ULWord inGainValue)
 Sets the gain for the given input of the Audio Mixer. More...
 
virtual bool GetAudioMixerOutputGain (ULWord &outGainValue)
 Answers with the current gain setting for the Audio Mixer's output. More...
 
virtual bool SetAudioMixerOutputGain (const ULWord inGainValue)
 Sets the gain for the output of the Audio Mixer. More...
 
virtual bool GetAudioMixerOutputLevels (const NTV2AudioChannelPairs &inChannelPairs, std::vector< uint32_t > &outLevels)
 Answers with the Audio Mixer's current audio output levels. More...
 
virtual bool GetHeadphoneOutputGain (ULWord &outGainValue)
 Answers with the current gain setting for the headphone out. More...
 
virtual bool SetHeadphoneOutputGain (const ULWord inGainValue)
 Sets the gain for the headphone out. More...
 
virtual bool GetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelsMuted16 &outMutes)
 Answers with a std::bitset that indicates which input audio channels of the given Audio Mixer input are currently muted. More...
 
virtual bool SetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelsMuted16 inMutes)
 Mutes (or enables) the given output audio channel of the Audio Mixer. More...
 
virtual bool GetAudioMixerInputLevels (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPairs &inChannelPairs, std::vector< uint32_t > &outLevels)
 Answers with the Audio Mixer's current audio input levels. More...
 
virtual bool GetAudioMixerLevelsSampleCount (ULWord &outSampleCount)
 Answers with the Audio Mixer's current sample count used for measuring audio levels. More...
 
virtual bool SetAudioMixerLevelsSampleCount (const ULWord inSampleCount)
 Sets the Audio Mixer's sample count it uses for measuring audio levels. More...
 
virtual bool GetAudioMixerOutputChannelsMute (NTV2AudioChannelsMuted16 &outMutes)
 Answers with a std::bitset that indicates which output audio channels of the Audio Mixer are currently muted. More...
 
virtual bool SetAudioMixerOutputChannelsMute (const NTV2AudioChannelsMuted16 inMutes)
 Mutes or enables the individual output audio channels of the Audio Mixer. More...
 
virtual bool ReadFlashProgramControl (ULWord &outValue)
 
virtual bool IsXilinxProgrammed ()
 
virtual bool ProgramMainFlash (const std::string &inFileName, const bool bInForceUpdate=(0), const bool bInQuiet=(0))
 
virtual bool GetProgramStatus (SSC_GET_FIRMWARE_PROGRESS_STRUCT *statusStruct)
 
virtual bool GetRunningFirmwarePackageRevision (ULWord &outRevision)
 Reports the revision number of the currently-running firmware package. KonaIP style boards have a package. More...
 
virtual bool GetRunningFirmwareRevision (UWord &outRevision)
 Reports the revision number of the currently-running firmware. More...
 
virtual bool GetRunningFirmwareDate (UWord &outYear, UWord &outMonth, UWord &outDay)
 Reports the (local Pacific) build date of the currently-running firmware. More...
 
virtual bool GetRunningFirmwareTime (UWord &outHours, UWord &outMinutes, UWord &outSeconds)
 Reports the (local Pacific) build time of the currently-running firmware. More...
 
virtual bool GetRunningFirmwareDate (std::string &outDate, std::string &outTime)
 Reports the (local Pacific) build date and time of the currently-running firmware. More...
 
virtual bool GetRunningFirmwareUserID (ULWord &outUserID)
 Reports the UserID number of the currently-running firmware. More...
 
virtual bool SetLEDState (ULWord inValue)
 The four on-board LEDs can be set by writing 0-15. More...
 
virtual bool GetLEDState (ULWord &outValue)
 Answers with the current state of the four on-board LEDs. More...
 
virtual bool SetRP188Mode (const NTV2Channel inChannel, const NTV2_RP188Mode inMode)
 Sets the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel. More...
 
virtual bool GetRP188Mode (const NTV2Channel inChannel, NTV2_RP188Mode &outMode)
 Returns the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel. More...
 
virtual bool SetRP188Data (const NTV2Channel inSDIOutput, const NTV2_RP188 &inRP188Data)
 Writes the raw RP188 data into the DBB/Low/Hi registers for the given SDI output. These values are latched and sent at the next VBI. More...
 
virtual bool GetRP188Data (const NTV2Channel inSDIInput, NTV2_RP188 &outRP188Data)
 Reads the raw RP188 data from the DBB/Low/Hi registers for the given SDI input. On newer devices with bi-directional SDI connectors – see Timecode (RP-188, SMPTE-12M) for details – if the device is configured for... More...
 
virtual bool SetRP188SourceFilter (const NTV2Channel inSDIInput, const UWord inFilterValue)
 Sets the RP188 DBB filter for the given SDI input. More...
 
virtual bool GetRP188SourceFilter (const NTV2Channel inSDIInput, UWord &outFilterValue)
 Returns the current RP188 filter setting for the given SDI input. More...
 
virtual bool IsRP188BypassEnabled (const NTV2Channel inSDIOutput, bool &outIsBypassEnabled)
 Answers if the SDI output's RP-188 bypass mode is enabled or not. More...
 
virtual bool DisableRP188Bypass (const NTV2Channel inSDIOutput)
 Configures the SDI output's embedder to embed SMPTE 12M timecode specified in calls to CNTV2Card::SetRP188Data. More...
 
virtual bool EnableRP188Bypass (const NTV2Channel inSDIOutput)
 Configures the SDI output's embedder to embed SMPTE 12M timecode obtained from an SDI input, which is often useful in E-E mode. More...
 
virtual bool SetRP188BypassSource (const NTV2Channel inSDIOutput, const UWord inSDIInput)
 For the given SDI output that's in RP188 bypass mode (E-E), specifies the SDI input to be used as a timecode source. More...
 
virtual bool GetRP188BypassSource (const NTV2Channel inSDIOutput, UWord &outSDIInput)
 For the given SDI output that's in RP188 bypass mode (E-E), answers with the SDI input that's currently being used as a timecode source. More...
 
virtual bool EnableInterrupt (const INTERRUPT_ENUMS inEventCode)
 
virtual bool EnableOutputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
 Allows the CNTV2Card instance to wait for and respond to output vertical blanking interrupts originating from the given frameStore on the receiver's AJA device. More...
 
virtual bool EnableInputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
 Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given input channel on the receiver's AJA device. More...
 
virtual bool EnableInputInterrupt (const NTV2ChannelSet &inFrameStores)
 Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given FrameStore(s). More...
 
virtual bool DisableInterrupt (const INTERRUPT_ENUMS inEventCode)
 
virtual bool DisableOutputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
 Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given output channel on the device. More...
 
virtual bool DisableInputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
 Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given input channel on the device. More...
 
virtual bool DisableInputInterrupt (const NTV2ChannelSet &inFrameStores)
 Prevents the CNTV2Card instance from waiting for and responding to input vertical blanking interrupts originating from the given frameStore(s) on the device. More...
 
virtual bool GetCurrentInterruptMasks (NTV2InterruptMask &outIntMask1, NTV2Interrupt2Mask &outIntMask2)
 
virtual bool SubscribeEvent (const INTERRUPT_ENUMS inEventCode)
 Causes me to be notified when the given event/interrupt is triggered for the AJA device. More...
 
virtual bool SubscribeOutputVerticalEvent (const NTV2Channel inChannel)
 Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel. More...
 
virtual bool SubscribeOutputVerticalEvent (const NTV2ChannelSet &inChannels)
 Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel(s). More...
 
virtual bool SubscribeInputVerticalEvent (const NTV2Channel inChannel=NTV2_CHANNEL1)
 Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel. More...
 
virtual bool SubscribeInputVerticalEvent (const NTV2ChannelSet &inChannels)
 Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel(s). More...
 
virtual bool UnsubscribeEvent (const INTERRUPT_ENUMS inEventCode)
 Unregisters me so I'm no longer notified when the given event/interrupt is triggered on the AJA device. More...
 
virtual bool UnsubscribeOutputVerticalEvent (const NTV2Channel inChannel)
 Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel. More...
 
virtual bool UnsubscribeOutputVerticalEvent (const NTV2ChannelSet &inChannels)
 Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel(s). More...
 
virtual bool UnsubscribeInputVerticalEvent (const NTV2Channel inChannel=NTV2_CHANNEL1)
 Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel. More...
 
virtual bool UnsubscribeInputVerticalEvent (const NTV2ChannelSet &inChannels)
 Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel(s). More...
 
virtual bool GetOutputVerticalInterruptCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the number of output vertical interrupts handled by the driver for the given output channel. More...
 
virtual bool GetInputVerticalInterruptCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the number of input vertical interrupts handled by the driver for the given input channel. More...
 
virtual bool GetOutputVerticalEventCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the number of output interrupt events that I successfully waited for on the given channel. More...
 
virtual bool GetInputVerticalEventCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the number of input interrupt events that I successfully waited for on the given channel. More...
 
virtual bool SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Resets my output interrupt event tally for the given channel. More...
 
virtual bool SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Resets my input interrupt event tally for the given channel. More...
 
virtual bool GetOutputFieldID (const NTV2Channel channel, NTV2FieldID &outFieldID)
 Returns the current field ID of the specified output channel. More...
 
virtual bool GetInputFieldID (const NTV2Channel channel, NTV2FieldID &outFieldID)
 Returns the current field ID of the specified input channel. More...
 
virtual bool WaitForOutputVerticalInterrupt (const NTV2Channel inChannel=NTV2_CHANNEL1, UWord inRepeatCount=1)
 Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified output channel. More...
 
virtual bool WaitForOutputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Efficiently sleeps the calling thread/process until the next output VBI for the given field and output channel. More...
 
virtual bool WaitForInputVerticalInterrupt (const NTV2Channel inChannel=NTV2_CHANNEL1, UWord inRepeatCount=1)
 Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified input channel. More...
 
virtual bool WaitForInputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Efficiently sleeps the calling thread/process until the next input VBI for the given field and input channel. More...
 
virtual bool SetRegisterWriteMode (const NTV2RegisterWriteMode inValue, const NTV2Channel inFrameStore=NTV2_CHANNEL1)
 Sets the FrameStore's NTV2RegisterWriteMode, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect. More...
 
virtual bool GetRegisterWriteMode (NTV2RegisterWriteMode &outValue, const NTV2Channel inFrameStore=NTV2_CHANNEL1)
 Answers with the FrameStore's current NTV2RegisterWriteMode setting, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect. More...
 
virtual bool GetFrameStamp (NTV2Crosspoint channelSpec, ULWord frameNum, FRAME_STAMP_STRUCT *pFrameStamp)
 
virtual bool GetAutoCirculate (NTV2Crosspoint channelSpec, AUTOCIRCULATE_STATUS_STRUCT *autoCirculateStatus)
 
virtual bool AutoCirculateInitForInput (const NTV2Channel inChannel, const UWord inFrameCount=7, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_INVALID, const ULWord inOptionFlags=0, const UByte inNumChannels=1, const UWord inStartFrameNumber=0, const UWord inEndFrameNumber=0)
 Prepares for subsequent AutoCirculate ingest, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop. More...
 
virtual bool AutoCirculateInitForOutput (const NTV2Channel inChannel, const UWord inFrameCount=7, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_INVALID, const ULWord inOptionFlags=0, const UByte inNumChannels=1, const UWord inStartFrameNumber=0, const UWord inEndFrameNumber=0)
 Prepares for subsequent AutoCirculate playout, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop. More...
 
virtual bool AutoCirculateStart (const NTV2Channel inChannel, const ULWord64 inStartTime=0)
 Starts AutoCirculating the specified channel that was previously initialized by CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput. More...
 
virtual bool AutoCirculateStop (const NTV2Channel inChannel, const bool inAbort=(0))
 Stops AutoCirculate for the given channel, and releases the on-device frame buffers that were allocated to it. More...
 
virtual bool AutoCirculateStop (const NTV2ChannelSet &inChannels, const bool inAbort=(0))
 Stops any number of AutoCirculate channels. See the other AutoCirculateStop function overload for full details on what happens to each channel. More...
 
virtual bool AutoCirculatePause (const NTV2Channel inChannel, const UWord inAtFrameNum=0xFFFF)
 Pauses AutoCirculate for the given channel. Once paused, AutoCirculate can be resumed later by calling CNTV2Card::AutoCirculateResume, picking up at the next frame without any loss of audio synchronization. More...
 
virtual bool AutoCirculateResume (const NTV2Channel inChannel, const bool inClearDropCount=(0))
 Resumes AutoCirculate for the given channel, picking up at the next frame without loss of audio synchronization. More...
 
virtual bool AutoCirculateFlush (const NTV2Channel inChannel, const bool inClearDropCount=(0))
 Flushes AutoCirculate for the given channel. More...
 
virtual bool AutoCirculatePreRoll (const NTV2Channel inChannel, const ULWord inPreRollFrames)
 Tells AutoCirculate how many frames to skip before playout starts for the given channel. More...
 
virtual bool AutoCirculateGetStatus (const NTV2Channel inChannel, AUTOCIRCULATE_STATUS &outStatus)
 Returns the current AutoCirculate status for the given channel. More...
 
virtual bool AutoCirculateGetFrameStamp (const NTV2Channel inChannel, const ULWord inFrameNumber, FRAME_STAMP &outFrameInfo)
 Returns precise timing information for the given frame and channel that's currently AutoCirculating. More...
 
virtual bool AutoCirculateSetActiveFrame (const NTV2Channel inChannel, const ULWord inNewActiveFrame)
 Immediately changes the Active Frame for the given channel. More...
 
virtual bool AutoCirculateTransfer (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &transferInfo)
 Transfers all or part of a frame as specified in the given AUTOCIRCULATE_TRANSFER object to/from the host. More...
 
virtual bool FindUnallocatedFrames (const UWord inFrameCount, LWord &outStartFrame, LWord &outEndFrame, const NTV2Channel inFrameStore=NTV2_CHANNEL_INVALID)
 Returns the device frame buffer numbers of the first unallocated contiguous band of frame buffers having the given size that are available for use. This function is called by CNTV2Card::AutoCirculateInitForInput and CNTV2Card::AutoCirculateInitForOutput whenever a frame count is specified in lieu of explicit frame ranges. More...
 
virtual ULWord StreamChannelInitialize (const NTV2Channel inChannel)
 Initialize a stream. Put the stream queue and hardware in a known good state ready for use. Releases all buffers remaining in the queue. At least one new buffer must be queued before starting the stream. More...
 
virtual ULWord StreamChannelRelease (const NTV2Channel inChannel)
 Release a stream. Releases all buffers remaining in the queue. More...
 
virtual ULWord StreamChannelStart (const NTV2Channel inChannel, NTV2StreamChannel &status)
 Start a stream. Put the stream is the active state to start processing queued buffers. For frame based video, the stream will start with the current buffer on the next frame sync. More...
 
virtual ULWord StreamChannelStop (const NTV2Channel inChannel, NTV2StreamChannel &status)
 Stop a stream. Put the stream is the idle state. For frame based video, the stream will idle on the buffer on air after the next frame sync. More...
 
virtual ULWord StreamChannelFlush (const NTV2Channel inChannel, NTV2StreamChannel &status)
 Flush a stream. Remove all the buffers from the stream except a currently active idle buffer. The stream must be in the initialize or idle state. More...
 
virtual ULWord StreamChannelStatus (const NTV2Channel inChannel, NTV2StreamChannel &status)
 Get the current stream status. More...
 
virtual ULWord StreamChannelWait (const NTV2Channel inChannel, NTV2StreamChannel &status)
 Wait for any stream event. Returns for any state or buffer change. More...
 
virtual ULWord StreamBufferQueue (const NTV2Channel inChannel, NTV2Buffer &inBuffer, ULWord64 bufferCookie, NTV2StreamBuffer &status)
 Queue a buffer to the stream. The bufferCookie is a user defined identifier of the buffer used by the stream methods. More...
 
virtual ULWord StreamBufferRelease (const NTV2Channel inChannel, NTV2StreamBuffer &status)
 Remove the oldest buffer released by the streaming engine from the buffer queue. More...
 
virtual ULWord StreamBufferStatus (const NTV2Channel inChannel, ULWord64 bufferCookie, NTV2StreamBuffer &status)
 Get the status of the buffer identified by the bufferCookie. More...
 
virtual bool GetNominalMinMaxHV (int &outNominalH, int &outMinH, int &outMaxH, int &outNominalV, int &outMinV, int &outMaxV)
 
virtual bool SetVideoHOffset (const int inHOffset, const UWord inOutputSpigot=0)
 Adjusts the horizontal timing offset, in pixels, for the given SDI output connector. More...
 
virtual bool GetVideoHOffset (int &outHOffset, const UWord inOutputSpigot=0)
 Answers with the current horizontal timing offset, in pixels, for the given SDI output connector. More...
 
virtual bool SetVideoVOffset (const int inVOffset, const UWord inOutputSpigot=0)
 Adjusts the vertical timing offset, in lines, for the given SDI output connector. More...
 
virtual bool GetVideoVOffset (int &outVOffset, const UWord inOutputSpigot=0)
 Answers with the current vertical timing offset, in lines, for the given SDI output connector. More...
 
virtual bool SetAnalogOutHTiming (ULWord inValue)
 
virtual bool GetAnalogOutHTiming (ULWord &outValue)
 
virtual bool WriteOutputTimingControl (const ULWord inValue, const UWord inOutputSpigot=0)
 Adjusts the output timing for the given SDI output connector. More...
 
virtual bool ReadOutputTimingControl (ULWord &outValue, const UWord inOutputSpigot=0)
 Returns the current output timing control value for the given SDI output connector. More...
 
virtual bool SetSDI1OutHTiming (ULWord value)
 
virtual bool GetSDI1OutHTiming (ULWord *value)
 
virtual bool SetSDI2OutHTiming (ULWord value)
 
virtual bool GetSDI2OutHTiming (ULWord *value)
 
virtual bool SetSDIOutVPID (const ULWord inValueA, const ULWord inValueB, const UWord inOutputSpigot=NTV2_CHANNEL1)
 
virtual bool GetSDIOutVPID (ULWord &outValueA, ULWord &outValueB, const UWord inOutputSpigot=NTV2_CHANNEL1)
 
virtual bool ReadSDIInVPID (const NTV2Channel inSDIInput, ULWord &outValueA, ULWord &outValueB)
 
virtual bool GetVPIDValidA (const NTV2Channel inChannel)
 
virtual bool GetVPIDValidB (const NTV2Channel inChannel)
 
virtual bool SetUpConvertMode (const NTV2UpConvertMode inValue)
 
virtual bool GetUpConvertMode (NTV2UpConvertMode &outValue)
 
virtual bool SetConverterOutStandard (const NTV2Standard inValue)
 
virtual bool GetConverterOutStandard (NTV2Standard &outValue)
 
virtual bool SetConverterOutRate (const NTV2FrameRate inValue)
 
virtual bool GetConverterOutRate (NTV2FrameRate &outValue)
 
virtual bool SetConverterInStandard (const NTV2Standard inValue)
 
virtual bool GetConverterInStandard (NTV2Standard &outValue)
 
virtual bool SetConverterInRate (const NTV2FrameRate inValue)
 
virtual bool GetConverterInRate (NTV2FrameRate &outValue)
 
virtual bool SetConverterPulldown (const ULWord inValue)
 
virtual bool GetConverterPulldown (ULWord &outValue)
 
virtual bool SetUCPassLine21 (const ULWord inValue)
 
virtual bool GetUCPassLine21 (ULWord &outValue)
 
virtual bool SetUCAutoLine21 (const ULWord inValue)
 
virtual bool GetUCAutoLine21 (ULWord &outValue)
 
virtual bool SetDownConvertMode (const NTV2DownConvertMode inValue)
 
virtual bool GetDownConvertMode (NTV2DownConvertMode &outValue)
 
virtual bool SetIsoConvertMode (const NTV2IsoConvertMode inValue)
 
virtual bool GetIsoConvertMode (NTV2IsoConvertMode &outValue)
 
virtual bool SetEnableConverter (const bool inValue)
 
virtual bool GetEnableConverter (bool &outValue)
 
virtual bool SetDeinterlaceMode (const ULWord inValue)
 
virtual bool GetDeinterlaceMode (ULWord &outValue)
 
virtual bool SetConversionMode (const NTV2ConversionMode inConversionMode)
 
virtual bool GetConversionMode (NTV2ConversionMode &outConversionMode)
 
virtual bool GetConnectedOutput (const NTV2InputCrosspointID inInputXpt, NTV2OutputCrosspointID &outOutputXpt)
 Answers with the currently connected NTV2OutputCrosspointID for the given NTV2InputCrosspointID. More...
 
virtual bool GetConnectedInput (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointID &outInputXpt)
 Answers with a connected NTV2InputCrosspointID for the given NTV2OutputCrosspointID. More...
 
virtual bool GetConnectedInputs (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointIDSet &outInputXpts)
 Answers with all of the NTV2InputCrosspointIDs that are connected to the given NTV2OutputCrosspointID. More...
 
virtual bool Connect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, const bool inValidate=(0))
 Connects the given widget signal input (sink) to the given widget signal output (source). More...
 
virtual bool Disconnect (const NTV2InputCrosspointID inInputXpt)
 Disconnects the given widget signal input (sink) from whatever output (source) it may be connected. More...
 
virtual bool IsConnected (const NTV2InputCrosspointID inInputXpt, bool &outIsConnected)
 Answers whether or not the given widget signal input (sink) is connected to another output (source). More...
 
virtual bool IsConnectedTo (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool &outIsConnected)
 Answers whether or not the given widget signal input (sink) is connected to another output (source). More...
 
virtual bool CanConnect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool &outCanConnect)
 Answers whether or not the given widget signal input (sink) can legally be connected to the given signal output (source). More...
 
virtual bool ApplySignalRoute (const CNTV2SignalRouter &inRouter, const bool inReplace=(0))
 Applies the given routing table to the AJA device. More...
 
virtual bool ApplySignalRoute (const NTV2XptConnections &inConnections, const bool inReplace=(0))
 Applies the given widget routing connections to the AJA device. More...
 
virtual bool RemoveConnections (const NTV2XptConnections &inConnections)
 Removes the given widget routing connections from the AJA device. More...
 
virtual bool ClearRouting (void)
 Removes all existing signal path connections between any and all widgets on the AJA device. More...
 
virtual bool GetRouting (CNTV2SignalRouter &outRouting)
 Answers with the current signal routing between any and all widgets on the AJA device. More...
 
virtual bool GetConnections (NTV2XptConnections &outConnections)
 Answers with the device's current widget routing connections. More...
 
virtual bool GetRoutingForChannel (const NTV2Channel inChannel, CNTV2SignalRouter &outRouting)
 Answers with the current signal routing for the given channel. More...
 
virtual bool GetPossibleConnections (NTV2PossibleConnections &outConnections)
 Answers with the implemented crosspoint connections (if known). More...
 
virtual bool WriteSDProcAmpControlsInitialized (const ULWord inNewValue=1)
 
virtual bool WriteSDBrightnessAdjustment (const ULWord inNewValue)
 
virtual bool WriteSDContrastAdjustment (const ULWord inNewValue)
 
virtual bool WriteSDSaturationAdjustment (const ULWord inNewValue)
 
virtual bool WriteSDHueAdjustment (const ULWord inNewValue)
 
virtual bool WriteSDCbOffsetAdjustment (const ULWord inNewValue)
 
virtual bool WriteSDCrOffsetAdjustment (const ULWord inNewValue)
 
virtual bool WriteHDProcAmpControlsInitialized (const ULWord inNewValue=1)
 
virtual bool WriteHDBrightnessAdjustment (const ULWord inNewValue)
 
virtual bool WriteHDContrastAdjustment (const ULWord inNewValue)
 
virtual bool WriteHDSaturationAdjustmentCb (const ULWord inNewValue)
 
virtual bool WriteHDSaturationAdjustmentCr (const ULWord inNewValue)
 
virtual bool WriteHDCbOffsetAdjustment (const ULWord inNewValue)
 
virtual bool WriteHDCrOffsetAdjustment (const ULWord inNewValue)
 
virtual bool ReadSDProcAmpControlsInitialized (ULWord &outValue)
 
virtual bool ReadSDBrightnessAdjustment (ULWord &outValue)
 
virtual bool ReadSDContrastAdjustment (ULWord &outValue)
 
virtual bool ReadSDSaturationAdjustment (ULWord &outValue)
 
virtual bool ReadSDHueAdjustment (ULWord &outValue)
 
virtual bool ReadSDCbOffsetAdjustment (ULWord &outValue)
 
virtual bool ReadSDCrOffsetAdjustment (ULWord &outValue)
 
virtual bool ReadHDProcAmpControlsInitialized (ULWord &outValue)
 
virtual bool ReadHDBrightnessAdjustment (ULWord &outValue)
 
virtual bool ReadHDContrastAdjustment (ULWord &outValue)
 
virtual bool ReadHDSaturationAdjustmentCb (ULWord &outValue)
 
virtual bool ReadHDSaturationAdjustmentCr (ULWord &outValue)
 
virtual bool ReadHDCbOffsetAdjustment (ULWord &outValue)
 
virtual bool ReadHDCrOffsetAdjustment (ULWord &outValue)
 
virtual bool WriteProcAmpC1YAdjustment (const ULWord inNewValue)
 
virtual bool WriteProcAmpC1CBAdjustment (const ULWord inNewValue)
 
virtual bool WriteProcAmpC1CRAdjustment (const ULWord inNewValue)
 
virtual bool WriteProcAmpC2CBAdjustment (const ULWord inNewValue)
 
virtual bool WriteProcAmpC2CRAdjustment (const ULWord inNewValue)
 
virtual bool WriteProcAmpOffsetYAdjustment (const ULWord inNewValue)
 
virtual bool ReadProcAmpC1YAdjustment (ULWord &outValue)
 
virtual bool ReadProcAmpC1CBAdjustment (ULWord &outValue)
 
virtual bool ReadProcAmpC1CRAdjustment (ULWord &outValue)
 
virtual bool ReadProcAmpC2CBAdjustment (ULWord &outValue)
 
virtual bool ReadProcAmpC2CRAdjustment (ULWord &outValue)
 
virtual bool ReadProcAmpOffsetYAdjustment (ULWord &outValue)
 
virtual bool SetAnalogInputADCMode (const NTV2LSVideoADCMode inValue)
 
virtual bool GetAnalogInputADCMode (NTV2LSVideoADCMode &outValue)
 
virtual bool SetLTCInputEnable (const bool inEnable)
 Enables or disables the ability for the device to read analog LTC on the reference input connector. More...
 
virtual bool GetLTCInputEnable (bool &outIsEnabled)
 Answers true if the device is currently configured to read analog LTC from the reference input connector (instead of reference). More...
 
virtual bool GetLTCInputPresent (bool &outIsPresent, const UWord inLTCInputNdx=0)
 Answers whether or not a valid analog LTC signal is being applied to the device's analog LTC input connector. More...
 
virtual bool ReadAnalogLTCInput (const UWord inLTCInput, RP188_STRUCT &outRP188Data)
 Reads the current contents of the device's analog LTC input registers. More...
 
virtual bool ReadAnalogLTCInput (const UWord inLTCInput, NTV2_RP188 &outRP188Data)
 Reads the current contents of the device's analog LTC input registers. More...
 
virtual bool GetAnalogLTCInClockChannel (const UWord inLTCInput, NTV2Channel &outChannel)
 Answers with the (SDI) input channel that's providing the clock reference being used by the given device's analog LTC input. More...
 
virtual bool SetAnalogLTCInClockChannel (const UWord inLTCInput, const NTV2Channel inChannel)
 Sets the (SDI) input channel that is to provide the clock reference to be used by the given analog LTC input. More...
 
virtual bool WriteAnalogLTCOutput (const UWord inLTCOutput, const RP188_STRUCT &inRP188Data)
 Writes the given timecode to the specified analog LTC output register. More...
 
virtual bool WriteAnalogLTCOutput (const UWord inLTCOutput, const NTV2_RP188 &inRP188Data)
 Writes the given timecode to the specified analog LTC output register. More...
 
virtual bool GetAnalogLTCOutClockChannel (const UWord inLTCOutput, NTV2Channel &outChannel)
 Answers with the (SDI) output channel that's providing the clock reference being used by the given device's analog LTC output. More...
 
virtual bool SetAnalogLTCOutClockChannel (const UWord inLTCOutput, const NTV2Channel inChannel)
 Sets the (SDI) output channel that is to provide the clock reference to be used by the given analog LTC output. More...
 
virtual bool SetLTCEmbeddedOutEnable (const bool inNewValue)
 
virtual bool GetLTCEmbeddedOutEnable (bool &outValue)
 
virtual bool SetStereoCompressorOutputMode (const NTV2StereoCompressorOutputMode inNewValue)
 
virtual bool GetStereoCompressorOutputMode (NTV2StereoCompressorOutputMode &outValue)
 
virtual bool SetStereoCompressorFlipMode (const ULWord inNewValue)
 
virtual bool GetStereoCompressorFlipMode (ULWord &outValue)
 
virtual bool SetStereoCompressorFlipLeftHorz (const ULWord inNewValue)
 
virtual bool GetStereoCompressorFlipLeftHorz (ULWord &outValue)
 
virtual bool SetStereoCompressorFlipLeftVert (const ULWord inNewValue)
 
virtual bool GetStereoCompressorFlipLeftVert (ULWord &outValue)
 
virtual bool SetStereoCompressorFlipRightHorz (const ULWord inNewValue)
 
virtual bool GetStereoCompressorFlipRightHorz (ULWord &outValue)
 
virtual bool SetStereoCompressorFlipRightVert (const ULWord inNewValue)
 
virtual bool GetStereoCompressorFlipRightVert (ULWord &outValue)
 
virtual bool SetStereoCompressorStandard (const NTV2Standard inNewValue)
 
virtual bool GetStereoCompressorStandard (NTV2Standard &outValue)
 
virtual bool SetStereoCompressorLeftSource (const NTV2OutputCrosspointID inNewValue)
 
virtual bool GetStereoCompressorLeftSource (NTV2OutputCrosspointID &outValue)
 
virtual bool SetStereoCompressorRightSource (const NTV2OutputCrosspointID inNewValue)
 
virtual bool GetStereoCompressorRightSource (NTV2OutputCrosspointID &outValue)
 
virtual bool SetSDITransmitEnable (const NTV2Channel inChannel, const bool inEnable)
 Sets the specified bidirectional SDI connector to act as an input or an output. More...
 
virtual bool SetSDITransmitEnable (const NTV2ChannelSet &inSDIConnectors, const bool inEnable)
 Sets the specified SDI connector(s) to act as an input or an output. More...
 
virtual bool GetSDITransmitEnable (const NTV2Channel inChannel, bool &outEnabled)
 Answers whether or not the specified SDI connector is currently acting as a transmitter (i.e. an output). More...
 
virtual bool GetTransmitSDIs (NTV2ChannelSet &outXmitSDIs)
 Answers with the transmitting/output SDI connectors. More...
 
virtual bool GetSDIRelayPosition (NTV2RelayState &outValue, const UWord inIndex0)
 Answers if the bypass relays between connectors 1/2 or 3/4 are currently in bypass or routing the signals through the device. More...
 
virtual bool GetSDIRelayManualControl (NTV2RelayState &outValue, const UWord inIndex0)
 Answers if the bypass relays between connectors 1 and 2 would be in bypass or would route signals through the device, if under manual control. More...
 
virtual bool SetSDIRelayManualControl (const NTV2RelayState inValue, const UWord inIndex0)
 Sets the state of the given connector pair relays to NTV2_DEVICE_BYPASSED (or NTV2_THROUGH_DEVICE if under manual control). More...
 
virtual bool GetSDIWatchdogEnable (bool &outIsEnabled, const UWord inIndex0)
 Answers true if the given connector pair relays are under watchdog timer control, or false if they're under manual control. More...
 
virtual bool SetSDIWatchdogEnable (const bool inEnable, const UWord inIndex0)
 Sets the connector pair relays to be under watchdog timer control or manual control. More...
 
virtual bool GetSDIWatchdogStatus (NTV2RelayState &outValue)
 Answers if the watchdog timer would put the SDI relays into NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE. More...
 
virtual bool GetSDIWatchdogTimeout (ULWord &outValue)
 Answers with the amount of time that must elapse before the watchdog timer times out. More...
 
virtual bool SetSDIWatchdogTimeout (const ULWord inValue)
 Specifies the amount of time that must elapse before the watchdog timer times out. More...
 
virtual bool KickSDIWatchdog (void)
 Restarts the countdown timer to prevent the watchdog timer from timing out. More...
 
virtual bool Enable4KDCRGBMode (bool inEnable)
 Sets 4K Down Convert RGB mode. More...
 
virtual bool GetEnable4KDCRGBMode (bool &outIsEnabled)
 
virtual bool Enable4KDCYCC444Mode (bool inEnable)
 Sets 4K Down Convert YCC 444 mode. More...
 
virtual bool GetEnable4KDCYCC444Mode (bool &outIsEnabled)
 
virtual bool Enable4KDCPSFInMode (bool inEnable)
 Sets 4K Down Convert PSF in mode. More...
 
virtual bool GetEnable4KDCPSFInMode (bool &outIsEnabled)
 
virtual bool Enable4KPSFOutMode (bool inEnable)
 Sets 4K Down Convert PSF out Mode. More...
 
virtual bool GetEnable4KPSFOutMode (bool &outIsEnabled)
 
virtual bool GetSDITRSError (const NTV2Channel inChannel)
 
virtual bool GetSDILock (const NTV2Channel inChannel)
 
virtual ULWord GetSDIUnlockCount (const NTV2Channel inChannel)
 
virtual ULWord GetCRCErrorCountA (const NTV2Channel inChannel)
 
virtual ULWord GetCRCErrorCountB (const NTV2Channel inChannel)
 
virtual bool SetRS422Parity (const NTV2Channel inSerialPort, const NTV2_RS422_PARITY inParity)
 Sets the parity control on the specified RS422 serial port. More...
 
virtual bool GetRS422Parity (const NTV2Channel inSerialPort, NTV2_RS422_PARITY &outParity)
 Answers with the current parity control for the specified RS422 serial port. More...
 
virtual bool SetRS422BaudRate (const NTV2Channel inSerialPort, const NTV2_RS422_BAUD_RATE inBaudRate)
 Sets the baud rate of the specified RS422 serial port. More...
 
virtual bool GetRS422BaudRate (const NTV2Channel inSerialPort, NTV2_RS422_BAUD_RATE &outBaudRate)
 Answers with the current baud rate of the specified RS422 serial port. More...
 
virtual bool AcquireMailBoxLock (void)
 
virtual bool ReleaseMailBoxLock (void)
 
virtual bool AbortMailBoxLock (void)
 
virtual bool GetDieTemperature (double &outTemp, const NTV2DieTempScale inTempScale=NTV2DieTempScale_Celsius)
 Reads the current die temperature of the device. More...
 
virtual bool GetDieVoltage (double &outVoltage)
 Reads the current "Vcc" voltage of the device. More...
 
virtual bool HevcGetDeviceInfo (HevcDeviceInfo *pInfo)
 Returns the driver version and time/date stamp of the hevc device's currently-installed firmware. More...
 
virtual bool HevcWriteRegister (ULWord address, ULWord value, ULWord mask=0xffffffff, ULWord shift=0)
 Write an hevc register. More...
 
virtual bool HevcReadRegister (ULWord address, ULWord *pValue, ULWord mask=0xffffffff, ULWord shift=0)
 Read an hevc register. More...
 
virtual bool HevcSendCommand (HevcDeviceCommand *pCommand)
 Send a command to the hevc device. See the hevc codec documentation for details on commands. More...
 
virtual bool HevcVideoTransfer (HevcDeviceTransfer *pTransfer)
 Transfer video to/from the hevc device. More...
 
virtual bool HevcGetStatus (HevcDeviceStatus *pStatus)
 Get the status of the hevc device. More...
 
virtual bool HevcDebugInfo (HevcDeviceDebug *pDebug)
 Get debug data from the hevc device. More...
 
virtual bool EnableHDMIHDR (const bool inEnableHDMIHDR)
 Enables or disables HDMI HDR. More...
 
virtual bool GetHDMIHDREnabled (void)
 
virtual bool EnableHDMIHDRDolbyVision (const bool inEnable)
 Enables or disables HDMI HDR Dolby Vision. More...
 
virtual bool GetHDMIHDRDolbyVisionEnabled (void)
 
virtual bool SetHDMIHDRConstantLuminance (const bool inEnableConstantLuminance)
 Enables or disables BT.2020 Y'cC'bcC'rc versus BT.2020 Y'C'bC'r or R'G'B'. More...
 
virtual bool GetHDMIHDRConstantLuminance (void)
 
virtual bool SetHDMIHDRGreenPrimaryX (const uint16_t inGreenPrimaryX)
 Sets the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRGreenPrimaryX (uint16_t &outGreenPrimaryX)
 Answers with the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRGreenPrimaryY (const uint16_t inGreenPrimaryY)
 Sets the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRGreenPrimaryY (uint16_t &outGreenPrimaryY)
 Answers with the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRBluePrimaryX (const uint16_t inBluePrimaryX)
 Sets the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRBluePrimaryX (uint16_t &outBluePrimaryX)
 Answers with the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRBluePrimaryY (const uint16_t inBluePrimaryY)
 Sets the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRBluePrimaryY (uint16_t &outBluePrimaryY)
 Answers with the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRRedPrimaryX (const uint16_t inRedPrimaryX)
 Sets the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRRedPrimaryX (uint16_t &outRedPrimaryX)
 Answers with the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRRedPrimaryY (const uint16_t inRedPrimaryY)
 Sets the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRRedPrimaryY (uint16_t &outRedPrimaryY)
 Answers with the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRWhitePointX (const uint16_t inWhitePointX)
 Sets the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRWhitePointX (uint16_t &outWhitePointX)
 Answers with the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRWhitePointY (const uint16_t inWhitePointY)
 Sets the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRWhitePointY (uint16_t &outWhitePointY)
 Answers with the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRMaxMasteringLuminance (const uint16_t inMaxMasteringLuminance)
 Sets the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRMaxMasteringLuminance (uint16_t &outMaxMasteringLuminance)
 Answers with the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRMinMasteringLuminance (const uint16_t inMinMasteringLuminance)
 Sets the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRMinMasteringLuminance (uint16_t &outMinMasteringLuminance)
 Answers with the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRMaxContentLightLevel (const uint16_t inMaxContentLightLevel)
 Sets the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRMaxContentLightLevel (uint16_t &outMaxContentLightLevel)
 Answers with the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRMaxFrameAverageLightLevel (const uint16_t inMaxFrameAverageLightLevel)
 Sets the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1. More...
 
virtual bool GetHDMIHDRMaxFrameAverageLightLevel (uint16_t &outMaxFrameAverageLightLevel)
 Answers with the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1. More...
 
virtual bool SetHDMIHDRElectroOpticalTransferFunction (const uint8_t inEOTFByte)
 
virtual bool GetHDMIHDRElectroOpticalTransferFunction (uint8_t &outEOTFByte)
 
virtual bool SetHDMIHDRStaticMetadataDescriptorID (const uint8_t inSMDId)
 
virtual bool GetHDMIHDRStaticMetadataDescriptorID (uint8_t &outSMDId)
 
virtual bool SetHDRData (const HDRFloatValues &inFloatValues)
 
virtual bool SetHDRData (const HDRRegValues &inRegisterValues)
 
virtual bool GetHDRData (HDRFloatValues &outFloatValues)
 
virtual bool GetHDRData (HDRRegValues &outRegisterValues)
 
virtual bool SetHDMIHDRBT2020 (void)
 
virtual bool SetHDMIHDRDCIP3 (void)
 
virtual bool SetVPIDTransferCharacteristics (const NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel)
 
virtual bool GetVPIDTransferCharacteristics (NTV2VPIDTransferCharacteristics &outValue, const NTV2Channel inChannel)
 
virtual bool SetVPIDColorimetry (const NTV2VPIDColorimetry inValue, const NTV2Channel inChannel)
 
virtual bool GetVPIDColorimetry (NTV2VPIDColorimetry &outValue, const NTV2Channel inChannel)
 
virtual bool SetVPIDLuminance (const NTV2VPIDLuminance inValue, const NTV2Channel inChannel)
 
virtual bool GetVPIDLuminance (NTV2VPIDLuminance &outValue, const NTV2Channel inChannel)
 
virtual bool SetVPIDRGBRange (const NTV2VPIDRGBRange inValue, const NTV2Channel inChannel)
 
virtual bool GetVPIDRGBRange (NTV2VPIDRGBRange &outValue, const NTV2Channel inChannel)
 
virtual bool Set3DLUTTableLocation (const ULWord inFrameNumber, ULWord inLUTIndex=0)
 
virtual bool Load3DLUTTable (void)
 
virtual bool Set1DLUTTableLocation (const NTV2Channel inChannel, const ULWord inFrameNumber, ULWord inLUTIndex=0)
 
virtual bool Load1DLUTTable (const NTV2Channel inChannel)
 
virtual bool HasMultiRasterWidget (void)
 
virtual bool SetMultiRasterBypassEnable (const bool inEnable)
 
virtual bool GetMultiRasterBypassEnable (bool &outEnabled)
 
virtual bool IsMultiRasterWidgetChannel (const NTV2Channel inChannel)
 
virtual bool SetColorSpaceMethod (const NTV2ColorSpaceMethod inCSCMethod, const NTV2Channel inChannel)
 Selects the color space converter operation method. More...
 
virtual bool GetColorSpaceMethod (NTV2ColorSpaceMethod &outMethod, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the current operating mode of the given color space converter. More...
 
virtual bool SetColorSpaceMatrixSelect (const NTV2ColorSpaceMatrixType inType, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the matrix type to be used for the given CSC, typically NTV2_Rec601Matrix or NTV2_Rec709Matrix. More...
 
virtual bool GetColorSpaceMatrixSelect (NTV2ColorSpaceMatrixType &outType, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the current matrix type being used for the given CSC. More...
 
virtual bool DownloadLUTToHW (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT, const NTV2Channel inLUT, const int inBank)
 Sends the given color lookup tables (LUTs) to the given LUT and bank. More...
 
virtual bool Download12BitLUTToHW (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT, const NTV2Channel inLUT, const int inBank)
 
virtual bool DownloadLUTToHW (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT, const NTV2Channel inLUT, const int inBank)
 Writes the LUT tables to the given LUT and bank. More...
 
virtual bool Download12BitLUTToHW (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT, const NTV2Channel inLUT, const int inBank)
 
virtual bool SetLUTEnable (const bool inEnable, const NTV2Channel inLUT)
 Enables or disables the given LUT. More...
 
virtual bool LoadLUTTables (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT)
 Writes the LUT tables. More...
 
virtual bool Load12BitLUTTables (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT)
 
virtual bool WriteLUTTables (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT)
 Writes the LUT tables. More...
 
virtual bool Write12BitLUTTables (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT)
 
virtual bool GetLUTTables (NTV2DoubleArray &outRedLUT, NTV2DoubleArray &outGreenLUT, NTV2DoubleArray &outBlueLUT)
 Reads the LUT tables (as double-precision floating point values). More...
 
virtual bool Get12BitLUTTables (NTV2DoubleArray &outRedLUT, NTV2DoubleArray &outGreenLUT, NTV2DoubleArray &outBlueLUT)
 
virtual bool ReadLUTTables (UWordSequence &outRedLUT, UWordSequence &outGreenLUT, UWordSequence &outBlueLUT)
 Reads the LUT tables (as raw, unsigned 10-bit integers). More...
 
virtual bool Read12BitLUTTables (UWordSequence &outRedLUT, UWordSequence &outGreenLUT, UWordSequence &outBlueLUT)
 
virtual bool SetLUTV2HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue)
 
virtual bool GetLUTV2HostAccessBank (NTV2ColorCorrectionHostAccessBank &outValue, const NTV2Channel inChannel)
 
virtual bool SetLUTV2OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank)
 
virtual bool GetLUTV2OutputBank (const NTV2Channel inLUTWidget, ULWord &outBank)
 
virtual bool Has12BitLUTSupport (void)
 
virtual bool Set12BitLUTPlaneSelect (const NTV2LUTPlaneSelect inLUTPlane)
 Sets the LUT plane. More...
 
virtual bool Get12BitLUTPlaneSelect (NTV2LUTPlaneSelect &outLUTPlane)
 Answers with the current LUT plane. More...
 
virtual bool SetColorSpaceRGBBlackRange (const NTV2_CSC_RGB_Range inRange, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the RGB range for the given CSC. More...
 
virtual bool GetColorSpaceRGBBlackRange (NTV2_CSC_RGB_Range &outRange, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the current RGB range being used by a given CSC. More...
 
virtual bool SetColorSpaceUseCustomCoefficient (const ULWord inUseCustomCoefficient, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetColorSpaceUseCustomCoefficient (ULWord &outUseCustomCoefficient, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetColorSpaceMakeAlphaFromKey (const bool inMakeAlphaFromKey, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Specifies whether or not the given CSC will produce alpha channel data from its key input. More...
 
virtual bool GetColorSpaceMakeAlphaFromKey (ULWord &outMakeAlphaFromKey, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers whether or not the given CSC is set to produce alpha channel data from its key input. More...
 
virtual bool GetColorSpaceVideoKeySyncFail (bool &outVideoKeySyncFail, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers whether or not the video signal present at the CSC’s Key Input is in sync with the video signal present at its Video Input. More...
 
virtual bool SetColorSpaceCustomCoefficients (const NTV2CSCCustomCoeffs &inCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetColorSpaceCustomCoefficients (NTV2CSCCustomCoeffs &outCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetColorSpaceCustomCoefficients12Bit (const NTV2CSCCustomCoeffs &inCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetColorSpaceCustomCoefficients12Bit (NTV2CSCCustomCoeffs &outCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetLUTControlSelect (const NTV2LUTControlSelect inLUTSelect)
 
virtual bool GetLUTControlSelect (NTV2LUTControlSelect &outLUTSelect)
 
virtual bool SetColorCorrectionMode (const NTV2Channel inChannel, const NTV2ColorCorrectionMode inMode)
 
virtual bool GetColorCorrectionMode (const NTV2Channel inChannel, NTV2ColorCorrectionMode &outMode)
 
virtual bool SetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, const ULWord inBank)
 Sets the LUT bank to be used for the given LUT. More...
 
virtual bool GetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, ULWord &outBank)
 Answers with the current LUT bank in use for the given LUT. More...
 
virtual bool SetColorCorrectionHostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue)
 
virtual bool GetColorCorrectionHostAccessBank (NTV2ColorCorrectionHostAccessBank &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetColorCorrectionSaturation (const NTV2Channel inChannel, const ULWord inValue)
 
virtual bool GetColorCorrectionSaturation (const NTV2Channel inChannel, ULWord &outValue)
 
virtual bool SetDitherFor8BitInputs (const NTV2Channel inChannel, const ULWord inDither)
 
virtual bool GetDitherFor8BitInputs (const NTV2Channel inChannel, ULWord &outDither)
 
virtual NTV2ColorSpaceMethod GetColorSpaceMethod (const NTV2Channel inChannel)
 
virtual bool DownloadLUTToHW (const double *pInTable, const NTV2Channel inChannel, const int inBank)
 
virtual bool LoadLUTTable (const double *pInTable)
 
virtual bool GetHDMIInputColor (NTV2LHIHDMIColorSpace &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the current colorspace for the given HDMI input. More...
 
virtual bool SetHDMIInputRange (const NTV2HDMIRange inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the given HDMI input's input range. More...
 
virtual bool GetHDMIInputRange (NTV2HDMIRange &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's current input range setting. More...
 
virtual bool GetHDMIInputAudioChannels (NTV2HDMIAudioChannels &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the current number of audio channels being received on the given HDMI input. More...
 
virtual bool SetHDMIInColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the given HDMI input's color space. More...
 
virtual bool GetHDMIInColorSpace (NTV2HDMIColorSpace &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's current color space setting. More...
 
virtual bool GetHDMIInProtocol (NTV2HDMIProtocol &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's protocol. More...
 
virtual bool GetHDMIInIsLocked (bool &outIsLocked, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers if the given HDMI input is genlocked or not. More...
 
virtual bool SetHDMIInAudioSampleRateConverterEnable (const bool inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool GetHDMIInAudioSampleRateConverterEnable (bool &outIsEnabled, const NTV2Channel inChannel=NTV2_CHANNEL1)
 
virtual bool SetHDMIInBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the given HDMI input's bit depth. More...
 
virtual bool GetHDMIInBitDepth (NTV2HDMIBitDepth &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's current bit depth setting. More...
 
virtual bool GetHDMIInAudioChannel34Swap (bool &outIsSwapped, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's current audio channel 3/4 swap setting. More...
 
virtual bool SetHDMIInAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Sets the given HDMI input's audio channel 3/4 swap state. More...
 
virtual bool GetHDMIInVideoRange (NTV2HDMIRange &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's video black/white range. More...
 
virtual bool GetHDMIInDynamicRange (HDRRegValues &outRegValues, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's video dynamic range and mastering information. More...
 
virtual bool GetHDMIInDynamicRange (HDRFloatValues &outFloatValues, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's video dynamic range and mastering information. More...
 
virtual bool GetHDMIInColorimetry (NTV2HDMIColorimetry &outColorimetry, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's current colorimetry. More...
 
virtual bool GetHDMIInDolbyVision (bool &outIsDolbyVision, const NTV2Channel inChannel=NTV2_CHANNEL1)
 Answers with the given HDMI input's Dolby Vision flag is set. More...
 
virtual bool SetHDMIOut3DPresent (const bool inIs3DPresent)
 
virtual bool GetHDMIOut3DPresent (bool &outIs3DPresent)
 
virtual bool SetHDMIOut3DMode (const NTV2HDMIOut3DMode inValue)
 
virtual bool GetHDMIOut3DMode (NTV2HDMIOut3DMode &outValue)
 
virtual bool SetHDMIV2TxBypass (const bool inBypass)
 
virtual bool SetHDMIOutVideoStandard (const NTV2Standard inNewValue)
 
virtual bool GetHDMIOutVideoStandard (NTV2Standard &outValue)
 
virtual bool SetHDMIOutSampleStructure (const NTV2HDMISampleStructure inNewValue)
 
virtual bool GetHDMIOutSampleStructure (NTV2HDMISampleStructure &outValue)
 
virtual bool SetHDMIOutVideoFPS (const NTV2FrameRate inNewValue)
 
virtual bool GetHDMIOutVideoFPS (NTV2FrameRate &outValue)
 
virtual bool SetHDMIOutRange (const NTV2HDMIRange inNewValue)
 
virtual bool GetHDMIOutRange (NTV2HDMIRange &outValue)
 
virtual bool SetHDMIOutAudioChannels (const NTV2HDMIAudioChannels inNewValue)
 
virtual bool GetHDMIOutAudioChannels (NTV2HDMIAudioChannels &outValue)
 
virtual bool SetHDMIOutColorSpace (const NTV2HDMIColorSpace inNewValue)
 
virtual bool GetHDMIOutColorSpace (NTV2HDMIColorSpace &outValue)
 
virtual bool SetLHIHDMIOutColorSpace (const NTV2LHIHDMIColorSpace inNewValue)
 
virtual bool GetLHIHDMIOutColorSpace (NTV2LHIHDMIColorSpace &outValue)
 
virtual bool SetHDMIOutBitDepth (const NTV2HDMIBitDepth inNewValue)
 
virtual bool GetHDMIOutBitDepth (NTV2HDMIBitDepth &outValue)
 
virtual bool SetHDMIOutProtocol (const NTV2HDMIProtocol inNewValue)
 
virtual bool GetHDMIOutProtocol (NTV2HDMIProtocol &outValue)
 
virtual bool SetHDMIOutForceConfig (const bool inNewValue)
 
virtual bool GetHDMIOutForceConfig (bool &outValue)
 
virtual bool SetHDMIOutPrefer420 (const bool inNewValue)
 
virtual bool GetHDMIOutPrefer420 (bool &outValue)
 
virtual bool GetHDMIOutDownstreamBitDepth (NTV2HDMIBitDepth &outValue)
 
virtual bool GetHDMIOutDownstreamColorSpace (NTV2LHIHDMIColorSpace &outValue)
 
virtual bool SetHDMIOutAudioSource2Channel (const NTV2AudioChannelPair inNewValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Sets the HDMI output's 2-channel audio source. More...
 
virtual bool GetHDMIOutAudioSource2Channel (NTV2AudioChannelPair &outValue, NTV2AudioSystem &outAudioSystem)
 Answers with the HDMI output's current 2-channel audio source. More...
 
virtual bool SetHDMIOutAudioSource8Channel (const NTV2Audio8ChannelSelect inNewValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
 Changes the HDMI output's 8-channel audio source. More...
 
virtual bool GetHDMIOutAudioSource8Channel (NTV2Audio8ChannelSelect &outValue, NTV2AudioSystem &outAudioSystem)
 Answers with the HDMI output's current 8-channel audio source. More...
 
virtual bool GetHDMIOutAudioChannel34Swap (bool &outIsSwapped, const NTV2Channel inWhichHDMIOut=NTV2_CHANNEL1)
 Answers with the HDMI output's current audio channel 3/4 swap setting. More...
 
virtual bool SetHDMIOutAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inWhichHDMIOut=NTV2_CHANNEL1)
 Sets the HDMI output's audio channel 3/4 swap state. More...
 
virtual bool SetHDMIOutAudioRate (const NTV2AudioRate inNewValue)
 Sets the HDMI output's audio rate. More...
 
virtual bool GetHDMIOutAudioRate (NTV2AudioRate &outValue)
 Answers with the HDMI output's current audio rate. More...
 
virtual bool SetHDMIOutAudioFormat (const NTV2AudioFormat inNewValue)
 Sets the HDMI output's audio format. More...
 
virtual bool GetHDMIOutAudioFormat (NTV2AudioFormat &outValue)
 Answers with the HDMI output's current audio format. More...
 
virtual bool EnableHDMIOutUserOverride (const bool inEnable)
 Enables or disables override of HDMI parameters. More...
 
virtual bool GetEnableHDMIOutUserOverride (bool &outIsEnabled)
 Answers if override of HDMI parameters is enabled or not. More...
 
virtual bool EnableHDMIOutCenterCrop (const bool inEnable)
 Controls the 4k/2k -> UHD/HD HDMI center cropping feature. More...
 
virtual bool GetEnableHDMIOutCenterCrop (bool &outIsEnabled)
 Answers if the HDMI 4k/2k -> UHD/HD center cropping is enabled or not. More...
 
virtual bool SetHDMIOutDecimateMode (const bool inEnable)
 Enables or disables decimate mode on the device's HDMI rasterizer, which halves the output frame rate when enabled. This allows a 60 Hz video stream to be displayed on a 30 Hz HDMI monitor. More...
 
virtual bool GetHDMIOutDecimateMode (bool &outIsEnabled)
 
virtual bool SetHDMIOutTsiIO (const bool inTsiEnable)
 Enables or disables two sample interleave I/O mode on the device's HDMI rasterizer. More...
 
virtual bool GetHDMIOutTsiIO (bool &tsiEnabled)
 
virtual bool SetHDMIOutLevelBMode (const bool inEnable)
 Enables or disables level-B mode on the device's HDMI rasterizer. More...
 
virtual bool GetHDMIOutLevelBMode (bool &outIsEnabled)
 
virtual bool SetHDMIV2Mode (const NTV2HDMIV2Mode inMode)
 Sets HDMI V2 mode for the device. More...
 
virtual bool GetHDMIV2Mode (NTV2HDMIV2Mode &outMode)
 Answers with the current HDMI V2 mode of the device. More...
 
virtual bool GetHDMIOutStatus (NTV2HDMIOutputStatus &outStatus)
 Answers with the current HDMI output status. More...
 
virtual bool GetHDMIInputStatus (ULWord &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1, const bool in12BitDetection=(0))
 Answers with the contents of the HDMI Input status register for the given HDMI input. More...
 
virtual bool AncSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size)
 Sets the capacity of the SDI ANC or HDMI AUX buffers in device frame memory. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertInit (const UWord inSDIOutput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
 Initializes the given SDI output's Anc inserter for custom Anc packet insertion. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertSetComponents (const UWord inSDIOutput, const bool inVancY, const bool inVancC, const bool inHancY, const bool inHancC)
 Enables or disables individual Anc insertion components for the given SDI output. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertSetEnable (const UWord inSDIOutput, const bool inIsEnabled)
 Enables or disables the given SDI output's Anc inserter frame buffer reads. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertIsEnabled (const UWord inSDIOutput, bool &outIsEnabled)
 Answers with the run state of the given Anc inserter – i.e. if its "memory reader" is enabled or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncInsertSetReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF1Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the Anc inserter for the next frame's F1 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertSetField2ReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF2Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the Anc inserter for the next frame's F2 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncInsertSetIPParams (const UWord inSDIOutput, const UWord ancChannel, const ULWord payloadID, const ULWord ssrc)
 Configures the Anc inserter IP specific params. More...
 
virtual bool AncInsertGetReadInfo (const UWord inSDIOutput, uint64_t &outF1StartAddr, uint64_t &outF2StartAddr)
 Answers where, in device SDRAM, the given SDI connector's Anc inserter is currently reading Anc data for playout. More...
 
virtual bool AncExtractInit (const UWord inSDIInput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
 Initializes the given SDI input's Anc extractor for custom Anc packet detection and de-embedding. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...
 
virtual bool AncExtractSetComponents (const UWord inSDIInput, const bool inVancY, const bool inVancC, const bool inHancY, const bool inHancC)
 Enables or disables the Anc extraction components for the given SDI input. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...
 
virtual bool AncExtractSetEnable (const UWord inSDIInput, const bool inIsEnabled)
 Enables or disables the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...
 
virtual bool AncExtractIsEnabled (const UWord inSDIInput, bool &outIsEnabled)
 Answers whether the given SDI input's Anc extractor is enabled/active or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractSetWriteParams (const UWord inSDIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the given SDI input's Anc extractor to receive the next frame's F1 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncExtractSetField2WriteParams (const UWord inSDIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the given SDI input's Anc extractor to receive the next frame's F2 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncExtractGetWriteInfo (const UWord inSDIInput, uint64_t &outF1StartAddr, uint64_t &outF1EndAddr, uint64_t &outF2StartAddr, uint64_t &outF2EndAddr)
 Answers with the given SDI input's current Anc extractor info. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...
 
virtual bool AncExtractGetFilterDIDs (const UWord inSDIInput, NTV2DIDSet &outDIDs)
 Answers with the DIDs currently being excluded (filtered) by the SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractSetFilterDIDs (const UWord inSDIInput, const NTV2DIDSet &inDIDs)
 Replaces the DIDs to be excluded (filtered) by the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractGetField1Size (const UWord inSDIInput, ULWord &outF1Size)
 Answers with the number of bytes of field 1 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractGetField2Size (const UWord inSDIInput, ULWord &outF2Size)
 Answers with the number of bytes of field 2 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractGetBufferOverrun (const UWord inSDIInput, bool &outIsOverrun, const UWord inField=0)
 Answers whether or not the given SDI input's Anc extractor reached its buffer limits. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AncExtractIsProgressive (const UWord inSDIInput, bool &outIsProgressive)
 Answers whether or not the given SDI input's Anc extractor was configured with a progressive video format. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...
 
virtual bool AuxSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size)
 Sets the capacity of the HDMI AUX buffers in device frame memory. More...
 
virtual bool AuxInsertInit (const UWord inHDMIOutput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
 Initializes the given HDMI output's Aux inserter for custom Aux packet insertion. More...
 
virtual bool AuxInsertSetComponents (const UWord inHDMIOutput, const bool inVauxY, const bool inVauxC, const bool inHauxY, const bool inHauxC)
 Enables or disables individual Aux insertion components for the given HDMI output. More...
 
virtual bool AuxInsertSetEnable (const UWord inHDMIOutput, const bool inIsEnabled)
 Enables or disables the given HDMI output's Aux inserter frame buffer reads. More...
 
virtual bool AuxInsertIsEnabled (const UWord inHDMIOutput, bool &outIsEnabled)
 Answers with the run state of the given Aux inserter – i.e. if its "memory reader" is enabled or not. More...
 
virtual bool AuxInsertSetReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF1Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the Aux inserter for the next frame's F1 Aux data to embed/transmit. More...
 
virtual bool AuxInsertSetField2ReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF2Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 Configures the Aux inserter for the next frame's F2 Aux data to embed/transmit. More...
 
virtual bool AuxInsertSetIPParams (const UWord inHDMIOutput, const UWord auxChannel, const ULWord payloadID, const ULWord ssrc)
 Configures the Aux inserter IP specific params. More...
 
virtual bool AuxInsertGetReadInfo (const UWord inHDMIOutput, uint64_t &outF1StartAddr, uint64_t &outF2StartAddr)
 Answers where, in device SDRAM, the given HDMI connector's Aux inserter is currently reading Aux data for playout. More...
 
virtual bool AuxExtractInit (const UWord inHDMIInput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
 Initializes the given HDMI input's Aux extractor for custom Aux packet detection and de-embedding. More...
 
virtual bool AuxExtractSetEnable (const UWord inHDMIInput, const bool inIsEnabled)
 Enables or disables the given HDMI input's Aux extractor. More...
 
virtual bool AuxExtractIsEnabled (const UWord inHDMIInput, bool &outIsEnabled)
 Answers whether the given HDMI input's Aux extractor is enabled/active or not. More...
 
virtual bool AuxExtractSetWriteParams (const UWord inHDMIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 
virtual bool AuxExtractSetField2WriteParams (const UWord inHDMIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
 
virtual bool AuxExtractGetWriteInfo (const UWord inHDMIInput, uint64_t &outF1StartAddr, uint64_t &outF1EndAddr, uint64_t &outF2StartAddr, uint64_t &outF2EndAddr)
 Answers with the given HDMI input's current Aux extractor info. More...
 
virtual bool AuxExtractGetField1Size (const UWord inHDMIInput, ULWord &outF1Size)
 Answers with the number of bytes of field 1 ANC extracted. More...
 
virtual bool AuxExtractGetField2Size (const UWord inHDMIInput, ULWord &outF2Size)
 Answers with the number of bytes of field 2 HDMI AUX data extracted. More...
 
virtual bool AuxExtractGetPacketFilters (const UWord inHDMIInput, NTV2DIDSet &outDIDs)
 Answers with the HDMI packet types currently being excluded (filtered) by the HDMI input's Aux extractor. More...
 
virtual bool AuxExtractSetPacketFilters (const UWord inHDMIInput, const NTV2DIDSet &inDIDs)
 Replaces the HDMI packet types to be excluded (filtered) by the given HDMI input's Aux extractor. More...
 
virtual bool AuxExtractSetFilterInclusionMode (const UWord inHDMIInput, const bool inEnable)
 Enables or disables HDMI AUX packet filtering for the given HDMI input. More...
 
virtual bool AuxExtractGetFilterInclusionMode (const UWord inHDMIInput, bool &outEnabled)
 Answers whether or not HDMI AUX packet filtering is enabled for the given HDMI input. More...
 
virtual bool AuxExtractGetBufferOverrun (const UWord inHDMIInput, bool &outIsOverrun, const UWord inField=0)
 Answers whether or not the given HDMI input's Aux extractor reached its buffer limits. More...
 
virtual bool AuxExtractIsProgressive (const UWord inHDMIInput, bool &outIsProgressive)
 Answers whether or not the given HDMI input's Aux extractor was configured with a progressive video format. More...
 
- Public Member Functions inherited from CNTV2MacDriverInterface
virtual bool SystemControl (void *dataPtr, SystemControlCode systemControlCode)
 
virtual bool MapFrameBuffers (void)
 
virtual bool UnmapFrameBuffers (void)
 
virtual bool MapRegisters (void)
 
virtual bool UnmapRegisters (void)
 
virtual bool MapXena2Flash (void)
 
virtual bool UnmapXena2Flash (void)
 
virtual ULWord GetPCISlotNumber (void) const
 
virtual bool MapMemory (const MemoryType memType, void **memPtr)
 
virtual bool SetAudioOutputMode (NTV2_GlobalAudioPlaybackMode mode)
 
virtual bool GetAudioOutputMode (NTV2_GlobalAudioPlaybackMode *mode)
 
virtual bool KernelLog (void *dataPtr, UInt32 dataSize)
 
virtual bool ConfigureInterrupt (bool, INTERRUPT_ENUMS)
 
virtual std::string GetConnectionType (void) const
 
 CNTV2MacDriverInterface ()
 My default constructor. More...
 
virtual ~CNTV2MacDriverInterface ()
 My destructor. More...
 
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 the AJA device. Using the optional mask and shift parameters, it's possible to set or clear any number of specific bits in a real register without altering any of the register's other bits. More...
 
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. Using the optional mask and shift parameters, it's possible to read any number of specific bits in a register while ignoring the register's other bits. More...
 
virtual bool AcquireStreamForApplication (ULWord inApplicationType, int32_t inProcessID)
 Reserves exclusive use of the AJA device for a given process, preventing other processes on the host from acquiring it until subsequently released. More...
 
virtual bool ReleaseStreamForApplication (ULWord inApplicationType, int32_t inProcessID)
 Releases exclusive use of the AJA device for the given process, permitting other processes to acquire it. More...
 
virtual bool AcquireStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID)
 A reference-counted version of CNTV2DriverInterface::AcquireStreamForApplication useful for process groups. More...
 
virtual bool ReleaseStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID)
 A reference-counted version of CNTV2DriverInterface::ReleaseStreamForApplication useful for process groups. More...
 
virtual bool SetStreamingApplication (const ULWord appType, const int32_t pid)
 Sets the four-CC type and process ID of the application that should "own" the AJA device (i.e. reserve it for exclusive use). More...
 
virtual bool GetStreamingApplication (ULWord &outAppType, int32_t &outProcessID)
 Answers with the four-CC type and process ID of the application that currently "owns" the AJA device (i.e. reserved it for exclusive use). More...
 
virtual bool WaitForInterrupt (const INTERRUPT_ENUMS type, const ULWord timeout=50)
 
virtual bool GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord &outCount)
 Answers with the number of interrupts of the given type processed by the driver. More...
 
virtual bool WaitForChangeEvent (UInt32 timeout=0)
 
virtual bool DmaTransfer (const NTV2DMAEngine inDMAEngine, const bool inIsRead, const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inByteCount, const bool inSynchronous=(!(0)))
 Transfers data between the AJA device and the host. This function will block and not return to the caller until the transfer has finished or failed. More...
 
virtual bool DmaTransfer (const NTV2DMAEngine inDMAEngine, const bool inIsRead, const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch, const bool inSynchronous=(!(0)))
 Transfers data in segments between the AJA device and the host. This function will block and not return to the caller until the transfer has finished or failed. More...
 
virtual bool DmaTransfer (const NTV2DMAEngine inDMAEngine, const NTV2Channel inDMAChannel, const bool inIsTarget, const ULWord inFrameNumber, const ULWord inCardOffsetBytes, const ULWord inByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch, const PCHANNEL_P2P_STRUCT &inP2PData)
 
virtual bool AutoCirculate (AUTOCIRCULATE_DATA &autoCircData)
 Sends an AutoCirculate command to the NTV2 driver. More...
 
virtual bool NTV2Message (NTV2_HEADER *pInMessage)
 Sends a message to the NTV2 driver (the new, improved, preferred way). More...
 
virtual bool ControlDriverDebugMessages (NTV2_DriverDebugMessageSet, bool)
 
- Public Member Functions inherited from CNTV2DriverInterface
virtual ULWord GetNumFrameBuffers (void) const
 
virtual ULWord GetFrameBufferSize (void) const
 
virtual bool DriverGetBitFileInformation (BITFILE_INFO_STRUCT &outBitFileInfo, const NTV2BitFileType inBitFileType=NTV2_VideoProcBitFile)
 Answers with the currently-installed bitfile information. More...
 
virtual bool DriverGetBuildInformation (BUILD_INFO_STRUCT &outBuildInfo)
 Answers with the driver's build information. More...
 
virtual bool GetPackageInformation (PACKAGE_INFO_STRUCT &outPkgInfo)
 Answers with the IP device's package information. More...
 
virtual bool BitstreamWrite (const NTV2Buffer &inBuffer, const bool inFragment, const bool inSwap)
 
virtual bool BitstreamReset (const bool inConfiguration, const bool inInterface)
 
virtual bool BitstreamStatus (NTV2ULWordVector &outRegValues)
 
virtual bool BitstreamLoad (const bool inSuspend, const bool inResume)
 
virtual bool StreamChannelOps (const NTV2Channel inChannel, ULWord flags, NTV2StreamChannel &status)
 
virtual bool StreamBufferOps (const NTV2Channel inChannel, NTV2Buffer &inBuffer, ULWord64 bufferCookie, ULWord flags, NTV2StreamBuffer &status)
 
virtual bool ReadRP188Registers (const NTV2Channel inChannel, RP188_STRUCT *pRP188Data)
 
virtual NTV2Dictionary ConnectParams (void) const
 
virtual bool SuspendAudio (void)
 
virtual bool ResumeAudio (const ULWord inFBSize)
 
virtual bool ReadRegisterMulti (const ULWord numRegs, ULWord *pOutWhichRegFailed, NTV2RegInfo aRegs[])
 
virtual Word SleepMs (const LWord msec)
 
virtual NTV2DeviceID GetDeviceID (void)
 
virtual bool IsDeviceReady (const bool inCheckValid=(0))
 
virtual bool IsMBSystemValid (void)
 
virtual bool IsMBSystemReady (void)
 
virtual bool Open (const UWord inDeviceIndex)
 Opens a local/physical AJA device so it can be monitored/controlled. More...
 
virtual bool Open (const std::string &inURLSpec)
 Opens the specified local, remote or software device. More...
 
virtual bool Close (void)
 Closes me, releasing host resources that may have been allocated in a previous Open call. More...
 
template<typename T >
bool ReadRegister (const ULWord inRegNum, T &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
 This template function reads all or part of the 32-bit contents of a specific register (real or virtual) from the AJA device, and if successful, returns its value automatically casted to the scalar type of the "outValue" parameter. More...
 
virtual bool ReadRegisters (NTV2RegisterReads &inOutValues)
 Reads the register(s) specified by the given NTV2RegInfo sequence. More...
 
virtual bool ConfigureSubscription (const bool bSubscribe, const INTERRUPT_ENUMS inInterruptType, PULWord &outSubcriptionHdl)
 
virtual HANDLE GetInterruptEvent (const INTERRUPT_ENUMS eInterruptType)
 
virtual bool GetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, ULWord &outCount)
 Answers with the number of interrupt events that I successfully waited for. More...
 
virtual bool SetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, const ULWord inCount)
 Resets my interrupt event tally for the given interrupt type. (This is my count of the number of successful event waits.) More...
 
virtual bool HevcSendMessage (HevcMessageHeader *pMessage)
 Sends an HEVC message to the NTV2 driver. More...
 
virtual bool IsSupported (const NTV2BoolParamID inParamID)
 
virtual ULWord GetNumSupported (const NTV2NumericParamID inParamID)
 
virtual ULWordSet GetSupportedItems (const NTV2EnumsID inEnumsID)
 
virtual bool GetRecordedRegisterWrites (NTV2RegisterWrites &outRegWrites) const
 Answers with the recorded register writes. More...
 
virtual bool StartRecordRegisterWrites (const bool inSkipActualWrites=(0))
 Starts recording all WriteRegister calls. More...
 
virtual bool IsRecordingRegisterWrites (void) const
 
virtual bool StopRecordRegisterWrites (void)
 Stops recording all WriteRegister calls. More...
 
virtual bool PauseRecordRegisterWrites (void)
 Pauses recording WriteRegister calls. More...
 
virtual bool ResumeRecordRegisterWrites (void)
 Resumes recording WriteRegister calls (after a prior call to PauseRecordRegisterWrites). More...
 
virtual ULWord GetNumRecordedRegisterWrites (void) const
 
 CNTV2DriverInterface ()
 My default constructor. More...
 
virtual ~CNTV2DriverInterface ()
 My destructor. More...
 

Static Public Member Functions

static std::string FlashBlockIDToString (const FlashBlockID inID, const bool inShortDisplay=(0))
 
- Static Public Member Functions inherited from CNTV2Card
static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, UByte inputGeometry, bool progressiveTransport, bool isThreeG, bool progressivePicture=(0))
 
static NTV2VideoFormat GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=(0), bool isSquareDivision=(!(0)))
 
static std::string SerialNum64ToString (const uint64_t inSerialNumber)
 Returns a string containing the decoded, human-readable device serial number. More...
 
static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, NTV2DoubleArray &outTable, const NTV2LutBitDepth inBitDepth=NTV2_LUT10Bit)
 
static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, UWordSequence &outTable, const NTV2LutBitDepth inBitDepth=NTV2_LUT10Bit)
 
static bool GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, double *pOutTable)
 
static UWord AncExtractGetMaxNumFilterDIDs (void)
 
static NTV2DIDSet AncExtractGetDefaultDIDs (const bool inHDAudio=(!(0)))
 
static UWord AuxExtractGetMaxNumPacketFilters (void)
 
static NTV2DIDSet AuxExtractGetDefaultPacketFilters (void)
 
- Static Public Member Functions inherited from CNTV2DriverInterface
static NTV2StringList GetLegalSchemeNames (void)
 
static void SetShareMode (const bool inSharedMode)
 Specifies if subsequent Open calls should open the device in shared mode or not. More...
 
static bool GetShareMode (void)
 
static void SetOverlappedMode (const bool inOverlapMode)
 Specifies if the next Open call should try to open the device in overlapped mode or not. More...
 
static bool GetOverlappedMode (void)
 

Protected Attributes

NTV2Buffer _bitFileBuffer
 
uint8_t * _customFileBuffer
 
uint32_t _bitFileSize
 
NTV2BitfileHeaderParser _parser
 
std::string _bitFileName
 
std::string _mcsInfo
 
uint32_t _spiDeviceID
 
uint32_t _flashSize
 
uint32_t _bankSize
 
uint32_t _sectorSize
 
uint32_t _mainOffset
 
uint32_t _failSafeOffset
 
uint32_t _macOffset
 
uint32_t _mcsInfoOffset
 
uint32_t _licenseOffset
 
uint32_t _soc1Offset
 
uint32_t _soc2Offset
 
uint32_t _numSectorsMain
 
uint32_t _numSectorsSOC1
 
uint32_t _numSectorsSOC2
 
uint32_t _numSectorsFailSafe
 
uint32_t _numBytes
 
FlashBlockID _flashID
 
uint32_t _deviceID
 
bool _bQuiet
 
int32_t _mcsStep
 
CNTV2MCSfile _mcsFile
 
std::vector< uint8_t > _partitionBuffer
 
uint32_t _failSafePadding
 
CNTV2SpiFlash_spiFlash
 
bool _hasExtendedCommandSupport
 
- Protected Attributes inherited from CNTV2DriverInterface
UWord _boardNumber
 My device index number. More...
 
NTV2DeviceID _boardID
 My cached device ID. More...
 
bool _boardOpened
 True if I'm open and connected to the device. More...
 
bool mRecordRegWrites
 True if recording; otherwise false when not recording. More...
 
bool mSkipRegWrites
 True if actual register writes are skipped while recording. More...
 
ULWord _programStatus
 
NTV2RPCAPI_pRPCAPI
 Points to remote or software device interface; otherwise NULL for local physical device. More...
 
_EventHandles mInterruptEventHandles
 For subscribing to each possible event, one for each interrupt type. More...
 
_EventCounts mEventCounts
 My event tallies, one for each interrupt type. Note that these. More...
 
NTV2RegisterWrites mRegWrites
 Stores WriteRegister data. More...
 
AJALock mRegWritesLock
 Guard mutex for mRegWrites. More...
 
ULWord_pFrameBaseAddress
 
ULWord_pRegisterBaseAddress
 
ULWord _pRegisterBaseAddressLength
 
ULWord_pXena2FlashBaseAddress
 
ULWord_pCh1FrameBaseAddress
 
ULWord_pCh2FrameBaseAddress
 
ULWord _ulNumFrameBuffers
 
ULWord _ulFrameBufferSize
 
ULWord _pciSlot
 

Additional Inherited Members

- Public Types inherited from CNTV2Card
enum  ColorCorrectionColor { RED, GREEN, BLUE, NUM_COLORS }
 
- Protected Types inherited from CNTV2DriverInterface
typedef std::vector< ULWord_EventCounts
 
typedef std::vector< PULWord_EventHandles
 
- Protected Member Functions inherited from CNTV2Card
virtual ULWord GetSerialNumberLow (void)
 
virtual ULWord GetSerialNumberHigh (void)
 
virtual bool IS_CHANNEL_VALID (const NTV2Channel inChannel) const
 
virtual bool IS_CHANNEL_INVALID (const NTV2Channel inChannel) const
 
virtual bool IS_OUTPUT_SPIGOT_INVALID (const UWord inOutputSpigot)
 
virtual bool IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot)
 
virtual bool IS_HDMI_INPUT_SPIGOT_INVALID (const UWord inInputHDMIPort)
 
virtual bool SetWarmBootFirmwareReload (bool enable)
 
virtual bool S2110DeviceAncToXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &inOutXferInfo)
 
virtual bool S2110DeviceAncToBuffers (const NTV2Channel inChannel, NTV2Buffer &ancF1, NTV2Buffer &ancF2)
 
virtual bool S2110DeviceAncFromXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &inOutXferInfo)
 
virtual bool S2110DeviceAncFromBuffers (const NTV2Channel inChannel, NTV2Buffer &ancF1, NTV2Buffer &ancF2)
 
virtual bool WriteSDIInVPID (const NTV2Channel inChannel, const ULWord inValA, const ULWord inValB)
 
virtual bool GetHDMIInputStatusRegNum (ULWord &outRegNum, const NTV2Channel inChannel=NTV2_CHANNEL1, const bool in12BitDetection=(0))
 Answers with the HDMI Input status register number for the given HDMI input. More...
 
- Protected Member Functions inherited from CNTV2MacDriverInterface
virtual bool OpenLocalPhysical (const UWord inDeviceIndex)
 Opens the local/physical device connection. More...
 
virtual bool CloseLocalPhysical (void)
 Releases host resources associated with the local/physical device connection. More...
 
- Protected Member Functions inherited from CNTV2DriverInterface
virtual bool OpenRemote (const NTV2DeviceSpecParser &inSpec)
 Peforms the housekeeping details of opening the remote/virtual device using the given specParser. More...
 
virtual bool CloseRemote (void)
 Releases host resources associated with the remote/special device connection. More...
 
virtual bool ParseFlashHeader (BITFILE_INFO_STRUCT &outBitfileInfo)
 
virtual bool GetBoolParam (const ULWord inParamID, ULWord &outValue)
 
virtual bool GetNumericParam (const ULWord inParamID, ULWord &outValue)
 
virtual bool GetRegInfoForBoolParam (const NTV2BoolParamID inParamID, NTV2RegInfo &outRegInfo)
 Answers with the NTV2RegInfo of the register associated with the given boolean (i.e., "Can Do") device feature. More...
 
virtual bool GetRegInfoForNumericParam (const NTV2NumericParamID inParamID, NTV2RegInfo &outRegInfo)
 Answers with the NTV2RegInfo of the register associated with the given numeric (i.e., "Get Num") device feature. More...
 
virtual void BumpEventCount (const INTERRUPT_ENUMS eInterruptType)
 Atomically increments the event count tally for the given interrupt type. More...
 
virtual void FinishOpen (void)
 Initializes my member variables after a successful Open. More...
 
virtual bool ReadFlashULWord (const ULWord inAddress, ULWord &outValue, const ULWord inRetryCount=1000)
 
- Static Protected Attributes inherited from CNTV2Card
static NTV2Buffer NULL_POINTER
 Used for default empty NTV2Buffer parameters – do not modify. More...
 

Detailed Description

Definition at line 47 of file ntv2konaflashprogram.h.

Constructor & Destructor Documentation

◆ CNTV2KonaFlashProgram() [1/2]

CNTV2KonaFlashProgram::CNTV2KonaFlashProgram ( )

Definition at line 61 of file ntv2konaflashprogram.cpp.

◆ CNTV2KonaFlashProgram() [2/2]

CNTV2KonaFlashProgram::CNTV2KonaFlashProgram ( const UWord  boardNumber)

Definition at line 89 of file ntv2konaflashprogram.cpp.

◆ ~CNTV2KonaFlashProgram()

CNTV2KonaFlashProgram::~CNTV2KonaFlashProgram ( )
virtual

Definition at line 118 of file ntv2konaflashprogram.cpp.

Member Function Documentation

◆ CheckAndFixMACs()

bool CNTV2KonaFlashProgram::CheckAndFixMACs ( )

Definition at line 2353 of file ntv2konaflashprogram.cpp.

◆ CheckFlashErasedWithBlockID()

bool CNTV2KonaFlashProgram::CheckFlashErasedWithBlockID ( FlashBlockID  flashBlockNumber)

Definition at line 866 of file ntv2konaflashprogram.cpp.

◆ CreateBankRecord()

bool CNTV2KonaFlashProgram::CreateBankRecord ( BankSelect  bankID)

Definition at line 1001 of file ntv2konaflashprogram.cpp.

◆ CreateEDIDIntelRecord()

bool CNTV2KonaFlashProgram::CreateEDIDIntelRecord ( )

Definition at line 1089 of file ntv2konaflashprogram.cpp.

◆ CreateSRecord()

bool CNTV2KonaFlashProgram::CreateSRecord ( bool  bChangeEndian)

Definition at line 901 of file ntv2konaflashprogram.cpp.

◆ DetermineFlashTypeAndBlockNumberFromFileName()

void CNTV2KonaFlashProgram::DetermineFlashTypeAndBlockNumberFromFileName ( const std::string &  bitFileName)

Definition at line 467 of file ntv2konaflashprogram.cpp.

◆ DisplayData()

void CNTV2KonaFlashProgram::DisplayData ( const uint32_t  address,
const uint32_t  len 
)

Definition at line 2256 of file ntv2konaflashprogram.cpp.

◆ EraseBlock()

bool CNTV2KonaFlashProgram::EraseBlock ( FlashBlockID  blockNumber)

Definition at line 646 of file ntv2konaflashprogram.cpp.

◆ EraseChip()

bool CNTV2KonaFlashProgram::EraseChip ( UWord  chip = 0)

Definition at line 703 of file ntv2konaflashprogram.cpp.

◆ EraseSector()

bool CNTV2KonaFlashProgram::EraseSector ( uint32_t  sectorAddress)

Definition at line 694 of file ntv2konaflashprogram.cpp.

◆ FastProgramFlash256()

bool CNTV2KonaFlashProgram::FastProgramFlash256 ( uint32_t  address,
uint32_t *  buffer 
)

Definition at line 619 of file ntv2konaflashprogram.cpp.

◆ FlashBlockIDToString()

string CNTV2KonaFlashProgram::FlashBlockIDToString ( const FlashBlockID  inID,
const bool  inShortDisplay = (0) 
)
static

Definition at line 44 of file ntv2konaflashprogram.cpp.

◆ FullProgram()

bool CNTV2KonaFlashProgram::FullProgram ( std::vector< uint8_t > &  dataBuffer)

Definition at line 2294 of file ntv2konaflashprogram.cpp.

◆ GetBaseAddressForProgramming()

uint32_t CNTV2KonaFlashProgram::GetBaseAddressForProgramming ( FlashBlockID  flashBlockNumber)
inline

Definition at line 115 of file ntv2konaflashprogram.h.

◆ GetDate()

std::string CNTV2KonaFlashProgram::GetDate ( void  ) const
inline

Definition at line 83 of file ntv2konaflashprogram.h.

◆ GetDesignName()

std::string CNTV2KonaFlashProgram::GetDesignName ( void  ) const
inline

Definition at line 81 of file ntv2konaflashprogram.h.

◆ GetMCSInfo()

const std::string& CNTV2KonaFlashProgram::GetMCSInfo ( void  ) const
inline

Definition at line 87 of file ntv2konaflashprogram.h.

◆ GetNumberOfSectors()

uint32_t CNTV2KonaFlashProgram::GetNumberOfSectors ( FlashBlockID  flashBlockNumber)
inline

Definition at line 131 of file ntv2konaflashprogram.h.

◆ GetNumBytes()

uint32_t CNTV2KonaFlashProgram::GetNumBytes ( void  ) const
inline

Definition at line 86 of file ntv2konaflashprogram.h.

◆ GetPartName()

std::string CNTV2KonaFlashProgram::GetPartName ( void  ) const
inline

Definition at line 82 of file ntv2konaflashprogram.h.

◆ GetSectorAddressForSector()

uint32_t CNTV2KonaFlashProgram::GetSectorAddressForSector ( FlashBlockID  flashBlockNumber,
uint32_t  sectorNumber 
)
inline

Definition at line 110 of file ntv2konaflashprogram.h.

◆ GetTime()

std::string CNTV2KonaFlashProgram::GetTime ( void  ) const
inline

Definition at line 84 of file ntv2konaflashprogram.h.

◆ IsInstalledFWRunning()

bool CNTV2KonaFlashProgram::IsInstalledFWRunning ( bool &  outIsRunning,
std::ostream &  outErrorMsgs 
)

Definition at line 158 of file ntv2konaflashprogram.cpp.

◆ MakeMACsFromSerial()

bool CNTV2KonaFlashProgram::MakeMACsFromSerial ( const char *  sSerialNumber,
MacAddr pMac1,
MacAddr pMac2 
)

Definition at line 2369 of file ntv2konaflashprogram.cpp.

◆ NextMcsStep()

int32_t CNTV2KonaFlashProgram::NextMcsStep ( )
inline

Definition at line 99 of file ntv2konaflashprogram.h.

◆ ParsePartitionFromFileLines()

void CNTV2KonaFlashProgram::ParsePartitionFromFileLines ( uint32_t  address,
uint16_t &  partitionOffset 
)

Definition at line 2193 of file ntv2konaflashprogram.cpp.

◆ Parser()

const NTV2BitfileHeaderParser& CNTV2KonaFlashProgram::Parser ( void  ) const
inline

Definition at line 85 of file ntv2konaflashprogram.h.

◆ Program()

std::string CNTV2KonaFlashProgram::Program ( bool  fullVerify = (0))

Definition at line 538 of file ntv2konaflashprogram.cpp.

◆ ProgramCustom()

bool CNTV2KonaFlashProgram::ProgramCustom ( const std::string &  sCustomFileName,
const uint32_t  addr,
std::ostream &  outMsgs 
)

Definition at line 1986 of file ntv2konaflashprogram.cpp.

◆ ProgramFlashValue()

bool CNTV2KonaFlashProgram::ProgramFlashValue ( uint32_t  address,
uint32_t  value 
)

Definition at line 607 of file ntv2konaflashprogram.cpp.

◆ ProgramFromMCS()

bool CNTV2KonaFlashProgram::ProgramFromMCS ( bool  verify)

Definition at line 1520 of file ntv2konaflashprogram.cpp.

◆ ProgramInfoFromString()

bool CNTV2KonaFlashProgram::ProgramInfoFromString ( std::string  infoString)

◆ ProgramKonaxMB()

bool CNTV2KonaFlashProgram::ProgramKonaxMB ( const std::string &  sCustomFileName,
const uint32_t  addr,
std::ostream &  outMsgs 
)

Definition at line 2148 of file ntv2konaflashprogram.cpp.

◆ ProgramLicenseInfo()

bool CNTV2KonaFlashProgram::ProgramLicenseInfo ( const std::string &  licenseString)

Definition at line 1343 of file ntv2konaflashprogram.cpp.

◆ ProgramMACAddresses()

bool CNTV2KonaFlashProgram::ProgramMACAddresses ( MacAddr mac1,
MacAddr mac2 
)

Definition at line 1155 of file ntv2konaflashprogram.cpp.

◆ ProgramSOC()

bool CNTV2KonaFlashProgram::ProgramSOC ( bool  verify = (! (0) ))

Definition at line 1767 of file ntv2konaflashprogram.cpp.

◆ ReadBankSelect()

uint32_t CNTV2KonaFlashProgram::ReadBankSelect ( )

Definition at line 1501 of file ntv2konaflashprogram.cpp.

◆ ReadDeviceID()

uint32_t CNTV2KonaFlashProgram::ReadDeviceID ( )

Definition at line 634 of file ntv2konaflashprogram.cpp.

◆ ReadFlash()

bool CNTV2KonaFlashProgram::ReadFlash ( NTV2Buffer outBuffer,
const FlashBlockID  flashID,
CNTV2FlashProgress inFlashProgress = CNTV2FlashProgress::nullUpdater 
)

Definition at line 776 of file ntv2konaflashprogram.cpp.

◆ ReadHeader()

bool CNTV2KonaFlashProgram::ReadHeader ( FlashBlockID  flashBlock)

Definition at line 474 of file ntv2konaflashprogram.cpp.

◆ ReadInfoString()

bool CNTV2KonaFlashProgram::ReadInfoString ( )

Definition at line 491 of file ntv2konaflashprogram.cpp.

◆ ReadLicenseInfo()

bool CNTV2KonaFlashProgram::ReadLicenseInfo ( std::string &  licenseString)

Definition at line 1407 of file ntv2konaflashprogram.cpp.

◆ ReadMACAddresses()

bool CNTV2KonaFlashProgram::ReadMACAddresses ( MacAddr mac1,
MacAddr mac2 
)

Definition at line 1249 of file ntv2konaflashprogram.cpp.

◆ ROMHasBankSelect()

bool CNTV2KonaFlashProgram::ROMHasBankSelect ( )

Definition at line 2188 of file ntv2konaflashprogram.cpp.

◆ SetBankSelect()

bool CNTV2KonaFlashProgram::SetBankSelect ( BankSelect  bankNumber)

Definition at line 1484 of file ntv2konaflashprogram.cpp.

◆ SetBitFile()

bool CNTV2KonaFlashProgram::SetBitFile ( const std::string &  inBitfileName,
std::ostream &  outMsgs,
const FlashBlockID  blockNumber = AUTO_FLASHBLOCK 
)

Definition at line 428 of file ntv2konaflashprogram.cpp.

◆ SetBoard()

bool CNTV2KonaFlashProgram::SetBoard ( uint32_t  index = 0)
virtual

Definition at line 208 of file ntv2konaflashprogram.cpp.

◆ SetDeviceProperties()

bool CNTV2KonaFlashProgram::SetDeviceProperties ( )

Definition at line 223 of file ntv2konaflashprogram.cpp.

◆ SetFlashBlockIDBank()

bool CNTV2KonaFlashProgram::SetFlashBlockIDBank ( FlashBlockID  blockID)

Definition at line 2160 of file ntv2konaflashprogram.cpp.

◆ SetMBReset()

bool CNTV2KonaFlashProgram::SetMBReset ( )

Definition at line 140 of file ntv2konaflashprogram.cpp.

◆ SetMCSFile()

bool CNTV2KonaFlashProgram::SetMCSFile ( const std::string &  sMCSFileName)

Definition at line 1513 of file ntv2konaflashprogram.cpp.

◆ SetQuietMode()

void CNTV2KonaFlashProgram::SetQuietMode ( )

Definition at line 124 of file ntv2konaflashprogram.cpp.

◆ VerifyFlash()

bool CNTV2KonaFlashProgram::VerifyFlash ( FlashBlockID  flashBlockNumber,
bool  fullVerify = (0) 
)

Definition at line 717 of file ntv2konaflashprogram.cpp.

◆ VerifySOCPartition()

bool CNTV2KonaFlashProgram::VerifySOCPartition ( FlashBlockID  flashID,
uint32_t  FlashBlockOffset 
)

Definition at line 2205 of file ntv2konaflashprogram.cpp.

◆ WaitForFlashNOTBusy()

bool CNTV2KonaFlashProgram::WaitForFlashNOTBusy ( )

Definition at line 842 of file ntv2konaflashprogram.cpp.

◆ WriteCommand()

bool CNTV2KonaFlashProgram::WriteCommand ( _FLASH_COMMAND  inCommand)

Definition at line 131 of file ntv2konaflashprogram.cpp.

Member Data Documentation

◆ _bankSize

uint32_t CNTV2KonaFlashProgram::_bankSize
protected

Definition at line 159 of file ntv2konaflashprogram.h.

◆ _bitFileBuffer

NTV2Buffer CNTV2KonaFlashProgram::_bitFileBuffer
protected

Definition at line 151 of file ntv2konaflashprogram.h.

◆ _bitFileName

std::string CNTV2KonaFlashProgram::_bitFileName
protected

Definition at line 155 of file ntv2konaflashprogram.h.

◆ _bitFileSize

uint32_t CNTV2KonaFlashProgram::_bitFileSize
protected

Definition at line 153 of file ntv2konaflashprogram.h.

◆ _bQuiet

bool CNTV2KonaFlashProgram::_bQuiet
protected

Definition at line 175 of file ntv2konaflashprogram.h.

◆ _customFileBuffer

uint8_t* CNTV2KonaFlashProgram::_customFileBuffer
protected

Definition at line 152 of file ntv2konaflashprogram.h.

◆ _deviceID

uint32_t CNTV2KonaFlashProgram::_deviceID
protected

Definition at line 174 of file ntv2konaflashprogram.h.

◆ _failSafeOffset

uint32_t CNTV2KonaFlashProgram::_failSafeOffset
protected

Definition at line 162 of file ntv2konaflashprogram.h.

◆ _failSafePadding

uint32_t CNTV2KonaFlashProgram::_failSafePadding
protected

Definition at line 179 of file ntv2konaflashprogram.h.

◆ _flashID

FlashBlockID CNTV2KonaFlashProgram::_flashID
protected

Definition at line 173 of file ntv2konaflashprogram.h.

◆ _flashSize

uint32_t CNTV2KonaFlashProgram::_flashSize
protected

Definition at line 158 of file ntv2konaflashprogram.h.

◆ _hasExtendedCommandSupport

bool CNTV2KonaFlashProgram::_hasExtendedCommandSupport
protected

Definition at line 181 of file ntv2konaflashprogram.h.

◆ _licenseOffset

uint32_t CNTV2KonaFlashProgram::_licenseOffset
protected

Definition at line 165 of file ntv2konaflashprogram.h.

◆ _macOffset

uint32_t CNTV2KonaFlashProgram::_macOffset
protected

Definition at line 163 of file ntv2konaflashprogram.h.

◆ _mainOffset

uint32_t CNTV2KonaFlashProgram::_mainOffset
protected

Definition at line 161 of file ntv2konaflashprogram.h.

◆ _mcsFile

CNTV2MCSfile CNTV2KonaFlashProgram::_mcsFile
protected

Definition at line 177 of file ntv2konaflashprogram.h.

◆ _mcsInfo

std::string CNTV2KonaFlashProgram::_mcsInfo
protected

Definition at line 156 of file ntv2konaflashprogram.h.

◆ _mcsInfoOffset

uint32_t CNTV2KonaFlashProgram::_mcsInfoOffset
protected

Definition at line 164 of file ntv2konaflashprogram.h.

◆ _mcsStep

int32_t CNTV2KonaFlashProgram::_mcsStep
protected

Definition at line 176 of file ntv2konaflashprogram.h.

◆ _numBytes

uint32_t CNTV2KonaFlashProgram::_numBytes
protected

Definition at line 172 of file ntv2konaflashprogram.h.

◆ _numSectorsFailSafe

uint32_t CNTV2KonaFlashProgram::_numSectorsFailSafe
protected

Definition at line 171 of file ntv2konaflashprogram.h.

◆ _numSectorsMain

uint32_t CNTV2KonaFlashProgram::_numSectorsMain
protected

Definition at line 168 of file ntv2konaflashprogram.h.

◆ _numSectorsSOC1

uint32_t CNTV2KonaFlashProgram::_numSectorsSOC1
protected

Definition at line 169 of file ntv2konaflashprogram.h.

◆ _numSectorsSOC2

uint32_t CNTV2KonaFlashProgram::_numSectorsSOC2
protected

Definition at line 170 of file ntv2konaflashprogram.h.

◆ _parser

NTV2BitfileHeaderParser CNTV2KonaFlashProgram::_parser
protected

Definition at line 154 of file ntv2konaflashprogram.h.

◆ _partitionBuffer

std::vector<uint8_t> CNTV2KonaFlashProgram::_partitionBuffer
protected

Definition at line 178 of file ntv2konaflashprogram.h.

◆ _sectorSize

uint32_t CNTV2KonaFlashProgram::_sectorSize
protected

Definition at line 160 of file ntv2konaflashprogram.h.

◆ _soc1Offset

uint32_t CNTV2KonaFlashProgram::_soc1Offset
protected

Definition at line 166 of file ntv2konaflashprogram.h.

◆ _soc2Offset

uint32_t CNTV2KonaFlashProgram::_soc2Offset
protected

Definition at line 167 of file ntv2konaflashprogram.h.

◆ _spiDeviceID

uint32_t CNTV2KonaFlashProgram::_spiDeviceID
protected

Definition at line 157 of file ntv2konaflashprogram.h.

◆ _spiFlash

CNTV2SpiFlash* CNTV2KonaFlashProgram::_spiFlash
protected

Definition at line 180 of file ntv2konaflashprogram.h.


The documentation for this class was generated from the following files: