Linux implementation of CNTV2DriverInterface. More...

#include <ntv2linuxdriverinterface.h>

Inheritance diagram for CNTV2LinuxDriverInterface:

Collaboration diagram for CNTV2LinuxDriverInterface:

Public Member Functions
	CNTV2LinuxDriverInterface ()

virtual	~CNTV2LinuxDriverInterface ()

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	RestoreHardwareProcampRegisters (void)

virtual bool	DmaTransfer (const NTV2DMAEngine inDMAEngine, const bool inIsRead, const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inTotalByteCount, 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 inTotalByteCount, const ULWord inNumSegments, const ULWord inHostPitchPerSeg, const ULWord inCardPitchPerSeg, 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 inTarget, 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	ConfigureInterrupt (const bool bEnable, const INTERRUPT_ENUMS eInterruptType)

virtual bool	GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord &outCount)
	Answers with the current total number of interrupts of the given type processed by the driver's interrupt service routine (ISR). More...

virtual bool	WaitForInterrupt (INTERRUPT_ENUMS eInterrupt, ULWord timeOutMs=68)
	Efficiently waits for the next given interrupt to be signaled on the device. More...

virtual bool	AutoCirculate (AUTOCIRCULATE_DATA &autoCircData)
	Sends an AutoCirculate command to the NTV2 driver. More...

virtual bool	NTV2Message (NTV2_HEADER *pInOutMessage)
	Sends a message to the NTV2 driver (the new, improved, preferred way). More...

virtual bool	ControlDriverDebugMessages (NTV2_DriverDebugMessageSet msgSet, bool enable)

virtual bool	HevcSendMessage (HevcMessageHeader *pMsg)

virtual bool	SetupBoard (void)
	defined(NTV2_DEPRECATE_17_6) More...

virtual bool	DmaWriteWithOffsets (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord *pFrameBuffer, ULWord offsetSrc, ULWord offsetDest, ULWord bytes)

virtual bool	DmaReadWithOffsets (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord *pFrameBuffer, ULWord offsetSrc, ULWord offsetDest, ULWord bytes)

virtual bool	GetStreamingApplication (ULWord &outAppType, int32_t &outPID)

virtual bool	GetStreamingApplication (ULWord pAppType, int32_t pPID)

virtual bool	MapFrameBuffers (void)

virtual bool	UnmapFrameBuffers (void)

virtual bool	MapRegisters (void)

virtual bool	UnmapRegisters (void)

virtual bool	GetBA0MemorySize (ULWord *memSize)

virtual bool	GetBA1MemorySize (ULWord *memSize)

virtual bool	GetBA2MemorySize (ULWord *memSize)

virtual bool	GetBA4MemorySize (ULWord *memSize)

virtual bool	MapXena2Flash (void)

virtual bool	UnmapXena2Flash (void)

virtual bool	MapDNXRegisters (void)

virtual bool	UnmapDNXRegisters (void)

virtual bool	MapDMADriverBuffer ()

virtual bool	UnmapDMADriverBuffer ()

virtual bool	DmaReadFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame, ULWord bytes, ULWord downSample, ULWord linePitch, ULWord poll)

virtual bool	DmaReadFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame, ULWord offsetSrc, ULWord offsetDest, ULWord bytes, ULWord downSample, ULWord linePitch, ULWord poll)

virtual bool	DmaWriteFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame, ULWord bytes, ULWord poll)

virtual bool	DmaWriteFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame, ULWord offsetSrc, ULWord offsetDest, ULWord bytes, ULWord poll)

virtual bool	GetDMADriverBufferPhysicalAddress (ULWord *physAddr)

virtual bool	GetDMADriverBufferAddress (ULWord **pDMADriverBuffer)

virtual bool	GetDMANumDriverBuffers (ULWord *pNumDmaDriverBuffers)

virtual bool	SetAudioOutputMode (NTV2_GlobalAudioPlaybackMode mode)

virtual bool	GetAudioOutputMode (NTV2_GlobalAudioPlaybackMode *mode)

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)
	defined(NTV2_DEPRECATE_17_2) More...

virtual bool	DriverGetBuildInformation (BUILD_INFO_STRUCT &outBuildInfo)
	Answers with the driver's build 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	MailBufferOps (const NTV2Channel inChannel, NTV2Buffer &inBuffer, ULWord dataSize, ULWord flags, ULWord delay, ULWord timeout, NTV2MailBuffer &status)

virtual bool	ReadRP188Registers (const NTV2Channel inChannel, RP188_STRUCT *pRP188Data)

virtual std::string	GetHostName (void) const

virtual bool	IsRemote (void) const

virtual bool	IsRemoteConnected (void) const

virtual std::string	GetDescription (void) const

virtual NTV2NubProtocolVersion	GetNubProtocolVersion (void) const

virtual NTV2Dictionary	ConnectParams (void) const

virtual bool	SuspendAudio (void)

virtual bool	ResumeAudio (const ULWord inFBSize)

virtual bool	DmaUnlock (void)

virtual bool	CompleteMemoryForDMA (ULWord *pHostBuffer)

virtual bool	PrepareMemoryForDMA (ULWord *pHostBuffer, const ULWord inNumBytes)

virtual bool	GetInterruptCount (const INTERRUPT_ENUMS eInt, ULWord *pCnt)

virtual bool	ReadRegisterMulti (const ULWord numRegs, ULWord *pOutWhichRegFailed, NTV2RegInfo aRegs[])

virtual ULWord	GetPCISlotNumber (void) const

virtual Word	SleepMs (const LWord msec)

virtual ULWord	GetAudioFrameBufferNumber (void) const

virtual bool	SetDefaultDeviceForPID (const int32_t procID)

virtual bool	IsDefaultDeviceForPID (const int32_t procID)

virtual NTV2DeviceID	GetDeviceID (void)

virtual UWord	GetIndexNumber (void) const

virtual bool	IsOpen (void) const

virtual bool	IsDeviceReady (const bool inCheckValid=(0))

virtual bool	IsMBSystemValid (void)

virtual bool	IsMBSystemReady (void)

virtual bool	IsIPDevice (void)

virtual bool	Is25GIPDevice (void)

virtual bool	IsLPSystemReady (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	GetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, ULWord &outCount)
	Answers with the current number of interrupt events that this CNTV2Card/CNTV2DriverInterface instance successfully waited for. More...

virtual bool	SetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, const ULWord inCount)
	Sets the interrupt event tally for the given interrupt type for this CNTV2Card/CNTV2DriverInterface instance to the given value. More...

virtual bool	GetOutputVerticalEventCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the number of output interrupt events that this device instance 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 this device instance successfully waited for on the given channel. More...

virtual bool	SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Resets the output interrupt event tally for this device instance for the given channel. More...

virtual bool	SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Resets the input interrupt event tally for this device instance for the given channel. More...

virtual bool	IsSupported (const NTV2BoolParamID inParamID)

virtual ULWord	GetNumSupported (const NTV2NumericParamID inParamID)

virtual ULWordSet	GetSupportedItems (const NTV2EnumsID inEnumsID)

virtual bool	GetBoolParam (const ULWord inParamID, ULWord &outValue)
	Answers with the boolean value of the given parameter of interest. More...

virtual bool	GetNumericParam (const ULWord inParamID, ULWord &outValue)
	Answers with the numeric value of the given parameter of interest. More...

virtual bool	GetBoolParamWithDeviceID (const ULWord inParamID, ULWord &outValue)
	(Internal SDK use only) Answers with the boolean value returned from the appropriate "ntv2devicefeatures.hpp" function using my NTV2DeviceID. More...

virtual bool	GetNumericParamWithDeviceID (const ULWord inParamID, ULWord &outValue)
	(Internal SDK use only) Answers with the numeric value returned from the appropriate "ntv2devicefeatures.hpp" function using my NTV2DeviceID. More...

virtual bool	HasRegInfoForBoolParam (const ULWord inParamID)
	(Internal SDK use only) Answers whether or not the given parameter's value is determined by a device register. More...

virtual bool	HasRegInfoForNumericParam (const ULWord inParamID)
	(Internal SDK use only) Answers whether or not the given parameter's value is determined by a device register. More...

virtual bool	GetRegInfoForBoolParam (const NTV2BoolParamID inParamID, NTV2RegInfo &outRegInfo, bool &outFlipSense)
	(Internal SDK use only) Answers with the NTV2RegInfo for the given parameter. More...

virtual bool	GetRegInfoForNumericParam (const NTV2NumericParamID inParamID, NTV2RegInfo &outRegInfo)
	(Internal SDK use only) Answers with the NTV2RegInfo for the given parameter. More...

virtual bool	AcquireStreamForApplicationWithReference (const ULWord inAppType, const int32_t inProcessID)
	A reference-counted version of CNTV2DriverInterface::AcquireStreamForApplication useful for process groups. More...

virtual bool	ReleaseStreamForApplicationWithReference (const ULWord inAppType, const int32_t inProcessID)
	A reference-counted version of CNTV2DriverInterface::ReleaseStreamForApplication useful for process groups. More...

virtual bool	AcquireStreamForApplication (const ULWord inAppType, const 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 (const ULWord inAppType, const int32_t inProcessID)
	Releases exclusive use of the AJA device for the given process, permitting other processes to acquire it. More...

virtual bool	SetStreamingApplication (const ULWord inAppType, const int32_t inProcessID)
	Forcibly 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	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...

Protected Member Functions
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 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	ParseFlashHeader (BITFILE_INFO_STRUCT &outBitfileInfo)

virtual bool	ReadFlashULWord (const ULWord inAddress, ULWord &outValue, const ULWord inRetryCount=1000)

void	setDeviceIndexNumber (const UWord num)

Protected Attributes
std::string	_bitfileDirectory

HANDLE	_hDevice

ULWord *	_pDMADriverBufferAddress

ULWord	_BA0MemorySize

ULWord *	_pDNXRegisterBaseAddress

ULWord	_BA2MemorySize

ULWord	_BA4MemorySize

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...

_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
	defined(NTV2_DEPRECATE_17_2) More...

Additional Inherited Members
Static Public Member Functions inherited from CNTV2DriverInterface
static NTV2StringList	GetLegalSchemeNames (void)

static UWord	MaxNumDevices (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 Types inherited from CNTV2DriverInterface
typedef std::vector< ULWord >	_EventCounts

Detailed Description

Linux implementation of CNTV2DriverInterface.

Definition at line 25 of file ntv2linuxdriverinterface.h.

Constructor & Destructor Documentation

◆ CNTV2LinuxDriverInterface()

CNTV2LinuxDriverInterface::CNTV2LinuxDriverInterface ( )

Definition at line 40 of file ntv2linuxdriverinterface.cpp.

◆ ~CNTV2LinuxDriverInterface()

CNTV2LinuxDriverInterface::~CNTV2LinuxDriverInterface ( )

virtual

Definition at line 53 of file ntv2linuxdriverinterface.cpp.

Member Function Documentation

◆ AutoCirculate()

bool CNTV2LinuxDriverInterface::AutoCirculate ( AUTOCIRCULATE_DATA & pAutoCircData )

virtual

Sends an AutoCirculate command to the NTV2 driver.

Parameters

pAutoCircData Points to the AUTOCIRCULATE_DATA that contains the AutoCirculate API command and parameters.

Returns: True if successful; otherwise false.

Reimplemented from CNTV2DriverInterface.

Definition at line 873 of file ntv2linuxdriverinterface.cpp.

◆ CloseLocalPhysical()

bool CNTV2LinuxDriverInterface::CloseLocalPhysical ( void )

protectedvirtual

Releases host resources associated with the local/physical device connection.

Reimplemented from CNTV2DriverInterface.

Definition at line 108 of file ntv2linuxdriverinterface.cpp.

◆ ConfigureInterrupt()

bool CNTV2LinuxDriverInterface::ConfigureInterrupt	(	const bool	bEnable,
		const INTERRUPT_ENUMS	eInterruptType
	)

virtual

Reimplemented from CNTV2DriverInterface.

Definition at line 220 of file ntv2linuxdriverinterface.cpp.

◆ ControlDriverDebugMessages()

bool CNTV2LinuxDriverInterface::ControlDriverDebugMessages	(	NTV2_DriverDebugMessageSet	msgSet,
		bool	enable
	)

virtual

Reimplemented from CNTV2DriverInterface.

Definition at line 338 of file ntv2linuxdriverinterface.cpp.

◆ DmaReadFrameDriverBuffer() [1/2]

bool CNTV2LinuxDriverInterface::DmaReadFrameDriverBuffer	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		unsigned long	dmaBufferFrame,
		ULWord	bytes,
		ULWord	downSample,
		ULWord	linePitch,
		ULWord	poll
	)

virtual

Definition at line 1292 of file ntv2linuxdriverinterface.cpp.

◆ DmaReadFrameDriverBuffer() [2/2]

bool CNTV2LinuxDriverInterface::DmaReadFrameDriverBuffer	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		unsigned long	dmaBufferFrame,
		ULWord	offsetSrc,
		ULWord	offsetDest,
		ULWord	bytes,
		ULWord	downSample,
		ULWord	linePitch,
		ULWord	poll
	)

virtual

Definition at line 1331 of file ntv2linuxdriverinterface.cpp.

◆ DmaReadWithOffsets()

bool CNTV2LinuxDriverInterface::DmaReadWithOffsets	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		ULWord *	pFrameBuffer,
		ULWord	offsetSrc,
		ULWord	offsetDest,
		ULWord	bytes
	)

virtual

Definition at line 1409 of file ntv2linuxdriverinterface.cpp.

◆ DmaTransfer() [1/3]

bool CNTV2LinuxDriverInterface::DmaTransfer	(	const NTV2DMAEngine	inDMAEngine,
		const bool	inIsRead,
		const ULWord	inFrameNumber,
		ULWord *	pFrameBuffer,
		const ULWord	inCardOffsetBytes,
		const ULWord	inTotalByteCount,
		const bool	inSynchronous = `(! (0) )`
	)

virtual

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.

Parameters

[in]	inDMAEngine	Specifies the device DMA engine to use. Use NTV2_DMA_FIRST_AVAILABLE for most applications. (Use the NTV2DeviceGetNumDMAEngines function to determine how many are available.)
[in]	inIsRead	Specifies the transfer direction. Use 'true' for reading (device-to-host). Use 'false' for writing (host-to-device).
[in]	inFrameNumber	Specifies the zero-based frame number of the starting frame to be transferred to/from the device.
	pFrameBuffer	Specifies a valid, non-NULL address of the host buffer. If reading (device-to-host), this memory will be written into. If writing (host-to-device), this memory will be read from.
[in]	inCardOffsetBytes	Specifies the byte offset into the device frame buffer where the data transfer will start.
[in]	inTotalByteCount	Specifies the total number of bytes to be transferred.
[in]	inSynchronous	This parameter is obsolete, and ignored.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount + inOffsetBytes in size; otherwise, host memory will be corrupted, or a bus error or other runtime exception may occur.

Reimplemented from CNTV2DriverInterface.

Definition at line 624 of file ntv2linuxdriverinterface.cpp.

◆ DmaTransfer() [2/3]

bool CNTV2LinuxDriverInterface::DmaTransfer	(	const NTV2DMAEngine	inDMAEngine,
		const bool	inIsRead,
		const ULWord	inFrameNumber,
		ULWord *	pFrameBuffer,
		const ULWord	inCardOffsetBytes,
		const ULWord	inTotalByteCount,
		const ULWord	inNumSegments,
		const ULWord	inHostPitchPerSeg,
		const ULWord	inCardPitchPerSeg,
		const bool	inSynchronous = `(! (0) )`
	)

virtual

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.

Parameters

[in]	inDMAEngine	Specifies the device DMA engine to use. Use NTV2_DMA_FIRST_AVAILABLE for most applications. (Use the NTV2DeviceGetNumDMAEngines function to determine how many are available.)
[in]	inIsRead	Specifies the transfer direction. Use 'true' for reading (device-to-host). Use 'false' for writing (host-to-device).
[in]	inFrameNumber	Specifies the zero-based frame number of the starting frame to be transferred to/from the device.
	pFrameBuffer	Specifies a valid, non-NULL address of the host buffer. If reading (device-to-host), this memory will be written into. If writing (host-to-device), this memory will be read from.
[in]	inCardOffsetBytes	Specifies the byte offset into the device frame buffer where the data transfer will start.
[in]	inTotalByteCount	Specifies the total number of bytes to be transferred.
[in]	inNumSegments	Specifies the number of segments to transfer. Note that this determines the number of bytes per segment (by dividing into inTotalByteCount).
[in]	inHostPitchPerSeg	Specifies the number of bytes to increment the host memory pointer after each segment is transferred.
[in]	inCardPitchPerSeg	Specifies the number of bytes to increment the on-device memory pointer after each segment is transferred.
[in]	inSynchronous	This parameter is obsolete, and ignored.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount + inOffsetBytes in size; otherwise, host memory will be corrupted, or a bus error or other runtime exception may occur.

Reimplemented from CNTV2DriverInterface.

Definition at line 712 of file ntv2linuxdriverinterface.cpp.

◆ DmaTransfer() [3/3]

bool CNTV2LinuxDriverInterface::DmaTransfer	(	const NTV2DMAEngine	inDMAEngine,
		const NTV2Channel	inDMAChannel,
		const bool	inTarget,
		const ULWord	inFrameNumber,
		const ULWord	inCardOffsetBytes,
		const ULWord	inByteCount,
		const ULWord	inNumSegments,
		const ULWord	inSegmentHostPitch,
		const ULWord	inSegmentCardPitch,
		const PCHANNEL_P2P_STRUCT &	inP2PData
	)

virtual

Reimplemented from CNTV2DriverInterface.

Definition at line 803 of file ntv2linuxdriverinterface.cpp.

◆ DmaWriteFrameDriverBuffer() [1/2]

bool CNTV2LinuxDriverInterface::DmaWriteFrameDriverBuffer	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		unsigned long	dmaBufferFrame,
		ULWord	bytes,
		ULWord	poll
	)

virtual

Definition at line 1223 of file ntv2linuxdriverinterface.cpp.

◆ DmaWriteFrameDriverBuffer() [2/2]

bool CNTV2LinuxDriverInterface::DmaWriteFrameDriverBuffer	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		unsigned long	dmaBufferFrame,
		ULWord	offsetSrc,
		ULWord	offsetDest,
		ULWord	bytes,
		ULWord	poll
	)

virtual

Definition at line 1257 of file ntv2linuxdriverinterface.cpp.

◆ DmaWriteWithOffsets()

bool CNTV2LinuxDriverInterface::DmaWriteWithOffsets	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		ULWord *	pFrameBuffer,
		ULWord	offsetSrc,
		ULWord	offsetDest,
		ULWord	bytes
	)

virtual

Definition at line 1363 of file ntv2linuxdriverinterface.cpp.

◆ GetAudioOutputMode()

bool CNTV2LinuxDriverInterface::GetAudioOutputMode ( NTV2_GlobalAudioPlaybackMode * mode )

virtual

Definition at line 1206 of file ntv2linuxdriverinterface.cpp.

◆ GetBA0MemorySize()

bool CNTV2LinuxDriverInterface::GetBA0MemorySize ( ULWord * memSize )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 498 of file ntv2linuxdriverinterface.cpp.

◆ GetBA1MemorySize()

bool CNTV2LinuxDriverInterface::GetBA1MemorySize ( ULWord * memSize )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 503 of file ntv2linuxdriverinterface.cpp.

◆ GetBA2MemorySize()

bool CNTV2LinuxDriverInterface::GetBA2MemorySize ( ULWord * memSize )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 508 of file ntv2linuxdriverinterface.cpp.

◆ GetBA4MemorySize()

bool CNTV2LinuxDriverInterface::GetBA4MemorySize ( ULWord * memSize )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 513 of file ntv2linuxdriverinterface.cpp.

◆ GetDMADriverBufferAddress()

bool CNTV2LinuxDriverInterface::GetDMADriverBufferAddress ( ULWord ** pDMADriverBuffer )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 1166 of file ntv2linuxdriverinterface.cpp.

◆ GetDMADriverBufferPhysicalAddress()

bool CNTV2LinuxDriverInterface::GetDMADriverBufferPhysicalAddress ( ULWord * physAddr )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 1121 of file ntv2linuxdriverinterface.cpp.

◆ GetDMANumDriverBuffers()

bool CNTV2LinuxDriverInterface::GetDMANumDriverBuffers ( ULWord * pNumDmaDriverBuffers )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 1126 of file ntv2linuxdriverinterface.cpp.

◆ GetInterruptCount()

bool CNTV2LinuxDriverInterface::GetInterruptCount	(	const INTERRUPT_ENUMS	eInterrupt,
		ULWord &	outCount
	)

virtual

Answers with the current total number of interrupts of the given type processed by the driver's interrupt service routine (ISR).

Parameters

[in]	eInterrupt	The interrupt type of interest.
[out]	outCount	Receives the count value.

Returns: True if successful; otherwise false.

Reimplemented from CNTV2DriverInterface.

Definition at line 240 of file ntv2linuxdriverinterface.cpp.

◆ GetStreamingApplication() [1/2]

virtual bool CNTV2LinuxDriverInterface::GetStreamingApplication	(	ULWord &	outAppType,
		int32_t &	outPID
	)

inlinevirtual

Deprecated:: Deprecated starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 88 of file ntv2linuxdriverinterface.h.

◆ GetStreamingApplication() [2/2]

virtual bool CNTV2LinuxDriverInterface::GetStreamingApplication	(	ULWord *	pAppType,
		int32_t *	pPID
	)

inlinevirtual

Deprecated:: Deprecated starting in SDK 16.0.

Definition at line 89 of file ntv2linuxdriverinterface.h.

◆ HevcSendMessage()

virtual bool CNTV2LinuxDriverInterface::HevcSendMessage ( HevcMessageHeader * pMsg )

inlinevirtual

Deprecated:: Corvid HEVC support dropped in SDK 17.6

Reimplemented from CNTV2DriverInterface.

Definition at line 75 of file ntv2linuxdriverinterface.h.

◆ MapDMADriverBuffer()

bool CNTV2LinuxDriverInterface::MapDMADriverBuffer ( void )

virtual

Definition at line 1134 of file ntv2linuxdriverinterface.cpp.

◆ MapDNXRegisters()

bool CNTV2LinuxDriverInterface::MapDNXRegisters ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 567 of file ntv2linuxdriverinterface.cpp.

◆ MapFrameBuffers()

bool CNTV2LinuxDriverInterface::MapFrameBuffers ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 377 of file ntv2linuxdriverinterface.cpp.

◆ MapRegisters()

bool CNTV2LinuxDriverInterface::MapRegisters ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 449 of file ntv2linuxdriverinterface.cpp.

◆ MapXena2Flash()

bool CNTV2LinuxDriverInterface::MapXena2Flash ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 518 of file ntv2linuxdriverinterface.cpp.

◆ NTV2Message()

bool CNTV2LinuxDriverInterface::NTV2Message ( NTV2_HEADER * pInMessage )

virtual

Sends a message to the NTV2 driver (the new, improved, preferred way).

Parameters

pInMessage Points to the message to pass to the driver. Valid messages start with an NTV2_HEADER and end with an NTV2_TRAILER.

Returns: True if successful; otherwise false.

Reimplemented from CNTV2DriverInterface.

Definition at line 1102 of file ntv2linuxdriverinterface.cpp.

◆ OpenLocalPhysical()

bool CNTV2LinuxDriverInterface::OpenLocalPhysical ( const UWord inDeviceIndex )

protectedvirtual

Opens the local/physical device connection.

Reimplemented from CNTV2DriverInterface.

Definition at line 64 of file ntv2linuxdriverinterface.cpp.

◆ ReadRegister()

bool CNTV2LinuxDriverInterface::ReadRegister	(	const ULWord	inRegNum,
		ULWord &	outValue,
		const ULWord	inMask = `0xFFFFFFFF`,
		const ULWord	inShift = `0`
	)

virtual

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.

Returns: True if successful; otherwise false.

Parameters

[in]	inRegNum	Specifies the register number of interest.
[out]	outValue	Receives the register value obtained from the device.
[in]	inMask	Optionally specifies a bit mask to be applied after reading the device register. Zero and 0xFFFFFFFF masks are ignored. Defaults to 0xFFFFFFFF (no masking).
[in]	inShift	Optionally specifies the number of bits to right-shift the value obtained from the device register after the mask has been applied. Defaults to zero (no shift).

Note: This function should be used only when there is no higher-level function available to accomplish the desired task.; The mask and shift parameters are ignored when reading a virtual register.

Reimplemented from CNTV2DriverInterface.

Definition at line 132 of file ntv2linuxdriverinterface.cpp.

◆ RestoreHardwareProcampRegisters()

bool CNTV2LinuxDriverInterface::RestoreHardwareProcampRegisters ( void )

virtual

Definition at line 202 of file ntv2linuxdriverinterface.cpp.

◆ SetAudioOutputMode()

bool CNTV2LinuxDriverInterface::SetAudioOutputMode ( NTV2_GlobalAudioPlaybackMode mode )

virtual

Definition at line 1201 of file ntv2linuxdriverinterface.cpp.

◆ SetupBoard()

bool CNTV2LinuxDriverInterface::SetupBoard ( void )

virtual

defined(NTV2_DEPRECATE_17_6)

Definition at line 356 of file ntv2linuxdriverinterface.cpp.

◆ UnmapDMADriverBuffer()

bool CNTV2LinuxDriverInterface::UnmapDMADriverBuffer ( void )

virtual

Definition at line 1178 of file ntv2linuxdriverinterface.cpp.

◆ UnmapDNXRegisters()

bool CNTV2LinuxDriverInterface::UnmapDNXRegisters ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 602 of file ntv2linuxdriverinterface.cpp.

◆ UnmapFrameBuffers()

bool CNTV2LinuxDriverInterface::UnmapFrameBuffers ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 426 of file ntv2linuxdriverinterface.cpp.

◆ UnmapRegisters()

bool CNTV2LinuxDriverInterface::UnmapRegisters ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 486 of file ntv2linuxdriverinterface.cpp.

◆ UnmapXena2Flash()

bool CNTV2LinuxDriverInterface::UnmapXena2Flash ( void )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Reimplemented from CNTV2DriverInterface.

Definition at line 552 of file ntv2linuxdriverinterface.cpp.

◆ WaitForInterrupt()

bool CNTV2LinuxDriverInterface::WaitForInterrupt	(	INTERRUPT_ENUMS	eInterrupt,
		ULWord	timeOutMs = `68`
	)

virtual

Efficiently waits for the next given interrupt to be signaled on the device.

Parameters

[in]	eInterrupt	The interrupt of interest.
[in]	timeOutMs	Optionally specifies the maximum time to wait for the interrupt. Defaults to 68 milliseconds.

Returns: True if successful; otherwise false.

Note: Superclass implementations must call this function for remote devices (when built with NTV2_NUB_CLIENT_SUPPORT).

Reimplemented from CNTV2DriverInterface.

Definition at line 310 of file ntv2linuxdriverinterface.cpp.

◆ WriteRegister()

bool CNTV2LinuxDriverInterface::WriteRegister	(	const ULWord	inRegNum,
		const ULWord	inValue,
		const ULWord	inMask = `0xFFFFFFFF`,
		const ULWord	inShift = `0`
	)

virtual

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.

Returns: True if successful; otherwise false.

Parameters

[in]	inRegNum	Specifies the register number of interest.
[in]	inValue	Specifies the desired new register value. If the "inShift" parameter is non-zero, this value is shifted left by the designated number of bit positions before being masked and applied to the real register contents.
[in]	inMask	Optionally specifies a bit mask to be applied to the new (shifted) value before updating the register. Defaults to 0xFFFFFFFF, which does not perform any masking. On Windows and MacOS, a zero mask is treated the same as 0xFFFFFFFF.
[in]	inShift	Optionally specifies the number of bits to left-shift the specified value before applying it to the register. Defaults to zero, which does not perform any shifting. On MacOS, this parameter is ignored. On Windows, a shift value of 0xFFFFFFFF is treated the same as a zero shift value.

Note: This function should be used only when there is no higher-level function available to accomplish the desired task.; The mask and shift parameters are ignored when setting a virtual register.

Bug:: On MacOS, "holes" in the mask (i.e., one or more runs of 0-bits lying between more-significant and less-significant 1-bits) were not handled correctly.

Reimplemented from CNTV2DriverInterface.

Definition at line 167 of file ntv2linuxdriverinterface.cpp.

Member Data Documentation

◆ _BA0MemorySize

ULWord CNTV2LinuxDriverInterface::_BA0MemorySize

protected

Definition at line 135 of file ntv2linuxdriverinterface.h.

◆ _BA2MemorySize

ULWord CNTV2LinuxDriverInterface::_BA2MemorySize

protected

Definition at line 137 of file ntv2linuxdriverinterface.h.

◆ _BA4MemorySize

ULWord CNTV2LinuxDriverInterface::_BA4MemorySize

protected

Definition at line 138 of file ntv2linuxdriverinterface.h.

◆ _bitfileDirectory

std::string CNTV2LinuxDriverInterface::_bitfileDirectory

protected

Definition at line 131 of file ntv2linuxdriverinterface.h.

◆ _hDevice

HANDLE CNTV2LinuxDriverInterface::_hDevice

protected

Definition at line 132 of file ntv2linuxdriverinterface.h.

◆ _pDMADriverBufferAddress

ULWord* CNTV2LinuxDriverInterface::_pDMADriverBufferAddress

protected

Definition at line 134 of file ntv2linuxdriverinterface.h.

◆ _pDNXRegisterBaseAddress

ULWord* CNTV2LinuxDriverInterface::_pDNXRegisterBaseAddress

protected

Definition at line 136 of file ntv2linuxdriverinterface.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/lin/ntv2linuxdriverinterface.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/lin/ntv2linuxdriverinterface.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CNTV2LinuxDriverInterface()

◆ ~CNTV2LinuxDriverInterface()

Member Function Documentation

◆ AutoCirculate()

◆ CloseLocalPhysical()

◆ ConfigureInterrupt()

◆ ControlDriverDebugMessages()

◆ DmaReadFrameDriverBuffer() [1/2]

◆ DmaReadFrameDriverBuffer() [2/2]

◆ DmaReadWithOffsets()

◆ DmaTransfer() [1/3]

◆ DmaTransfer() [2/3]

◆ DmaTransfer() [3/3]

◆ DmaWriteFrameDriverBuffer() [1/2]

◆ DmaWriteFrameDriverBuffer() [2/2]

◆ DmaWriteWithOffsets()

◆ GetAudioOutputMode()

◆ GetBA0MemorySize()

◆ GetBA1MemorySize()

◆ GetBA2MemorySize()

◆ GetBA4MemorySize()

◆ GetDMADriverBufferAddress()

◆ GetDMADriverBufferPhysicalAddress()

◆ GetDMANumDriverBuffers()

◆ GetInterruptCount()

◆ GetStreamingApplication() [1/2]

◆ GetStreamingApplication() [2/2]

◆ HevcSendMessage()

◆ MapDMADriverBuffer()

◆ MapDNXRegisters()

◆ MapFrameBuffers()

◆ MapRegisters()

◆ MapXena2Flash()

◆ NTV2Message()

◆ OpenLocalPhysical()

◆ ReadRegister()

◆ RestoreHardwareProcampRegisters()

◆ SetAudioOutputMode()

◆ SetupBoard()

◆ UnmapDMADriverBuffer()

◆ UnmapDNXRegisters()

◆ UnmapFrameBuffers()

◆ UnmapRegisters()

◆ UnmapXena2Flash()

◆ WaitForInterrupt()

◆ WriteRegister()

Member Data Documentation

◆ _BA0MemorySize

◆ _BA2MemorySize

◆ _BA4MemorySize

◆ _bitfileDirectory

◆ _hDevice

◆ _pDMADriverBufferAddress

◆ _pDNXRegisterBaseAddress