AJA NTV2 SDK  18.0.0.2122
NTV2 SDK 18.0.0.2122
AUTOCIRCULATE_TRANSFER Class Reference

This object specifies the information that will be transferred to or from the AJA device in the CNTV2Card::AutoCirculateTransfer function call. More...

#include <ntv2publicinterface.h>

Collaboration diagram for AUTOCIRCULATE_TRANSFER:
[legend]

Public Member Functions

 operator NTV2_HEADER * ()
 
bool RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)
 
bool RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
 
bool RPCDecodeClient (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
 
bool RPCEncodeClient (NTV2_RPC_BLOB_TYPE &inBlob)
 
bool RPCDecodeServer (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)
 
bool RPCEncodeServer (NTV2_RPC_BLOB_TYPE &inBlob)
 
Buffer Management
bool SetBuffers (ULWord *pInVideoBuffer, const ULWord inVideoByteCount, ULWord *pInAudioBuffer, const ULWord inAudioByteCount, ULWord *pInANCBuffer, const ULWord inANCByteCount, ULWord *pInANCF2Buffer=NULL, const ULWord inANCF2ByteCount=0)
 Sets my buffers for use in a subsequent call to CNTV2Card::AutoCirculateTransfer. More...
 
bool SetVideoBuffer (ULWord *pInVideoBuffer, const ULWord inVideoByteCount)
 Sets my video buffer for use in a subsequent call to CNTV2Card::AutoCirculateTransfer. More...
 
bool SetAudioBuffer (ULWord *pInAudioBuffer, const ULWord inAudioByteCount)
 Sets my audio buffer for use in a subsequent call to CNTV2Card::AutoCirculateTransfer. More...
 
bool SetAncBuffers (ULWord *pInANCBuffer, const ULWord inANCByteCount, ULWord *pInANCF2Buffer=NULL, const ULWord inANCF2ByteCount=0)
 Sets my ancillary data buffers for use in a subsequent call to CNTV2Card::AutoCirculateTransfer. More...
 
const NTV2Buffer & GetVideoBuffer (void) const
 
const NTV2Buffer & GetAudioBuffer (void) const
 
const NTV2Buffer & GetAncBuffer (const bool inField2=false) const
 
Timecode
bool SetOutputTimeCodes (const NTV2TimeCodes &inValues)
 Intended for playout, replaces the contents of my acOutputTimeCodes member. More...
 
bool SetOutputTimeCode (const NTV2_RP188 &inTimecode, const NTV2TCIndex inTCIndex=NTV2_TCINDEX_SDI1)
 Intended for playout, sets one element of my acOutputTimeCodes member. More...
 
bool SetAllOutputTimeCodes (const NTV2_RP188 &inTimecode, const bool inIncludeF2=true)
 Intended for playout, replaces all elements of my acOutputTimeCodes member with the given timecode value. More...
 
bool GetInputTimeCodes (NTV2TimeCodeList &outValues) const
 Intended for capture, answers with the timecodes captured in my acTransferStatus member's acFrameStamp member. More...
 
bool GetInputTimeCode (NTV2_RP188 &outTimeCode, const NTV2TCIndex inTCIndex=NTV2_TCINDEX_SDI1) const
 Intended for capture, answers with a specific timecode captured in my acTransferStatus member's acFrameStamp member's acTimeCodes member. More...
 
bool GetInputTimeCodes (NTV2TimeCodes &outTimeCodes, const NTV2Channel inSDIInput=NTV2_CHANNEL1, const bool inValidOnly=true) const
 Retrieves the timecodes from the captured frame that are associated with the given SDI input. More...
 
Miscellaneous
bool SetFrameUserCookie (const ULWord64 &inUserCookie)
 Intended for playout, replaces my current acUserCookie value with the new value. More...
 
bool SetFrameBufferFormat (const NTV2FrameBufferFormat inNewFormat)
 Sets my acFrameBufferFormat value to the given new value (if valid and circulating with AUTOCIRCULATE_WITH_FBFCHANGE option). More...
 
void EnableQuarterSizeExpandMode (void)
 Enables quarter-size expansion mode. More...
 
void DisableQuarterSizeExpandMode (void)
 Enables quarter-size expansion mode. More...
 
bool IsQuarterSizeExpandModeEnabled (void) const
 
const AUTOCIRCULATE_TRANSFER_STATUS & GetTransferStatus (void) const
 Returns a constant reference to my AUTOCIRCULATE_TRANSFER_STATUS. More...
 
const FRAME_STAMP & GetFrameInfo (void) const
 Returns a constant reference to my FRAME_STAMP. More...
 
ULWord GetCapturedAudioByteCount (void) const
 
ULWord GetAudioByteCount (void) const
 
ULWord GetCapturedAncByteCount (const bool inField2=false) const
 
ULWord GetAncByteCount (const bool inField2=false) const
 
NTV2FrameBufferFormat GetFrameBufferFormat (void) const
 
LWord GetTransferFrameNumber (void) const
 
Segmented DMAs
bool EnableSegmentedDMAs (const ULWord inNumSegments, const ULWord inNumActiveBytesPerLine, const ULWord inHostBytesPerLine, const ULWord inDeviceBytesPerLine)
 Enables segmented DMAs given a segment count, a host pitch, and device pitch value. More...
 
bool DisableSegmentedDMAs (void)
 Disables segmented DMAs, performing a Reset on my acInSegmentedDMAInfo. More...
 
bool SegmentedDMAsEnabled (void) const
 

Public Attributes

NTV2_HEADER acHeader
 The common structure header – ALWAYS FIRST! More...
 
NTV2Buffer acVideoBuffer
 The host video buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no video will be transferred. AJA recommends keeping this buffer 64-bit aligned and page-aligned for best performance. Use the AUTOCIRCULATE_TRANSFER::SetVideoBuffer method to set or reset this field. More...
 
NTV2Buffer acAudioBuffer
 The host audio buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no audio will be transferred. AJA recommends keeping this buffer 64-bit aligned and page-aligned for best performance. Use the AUTOCIRCULATE_TRANSFER::SetAudioBuffer method to set or reset this field. More...
 
NTV2Buffer acANCBuffer
 The host ancillary data buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no ancillary data will be transferred. Use the AUTOCIRCULATE_TRANSFER::SetAncBuffers method to set or reset this field. More...
 
NTV2Buffer acANCField2Buffer
 The host "Field 2" ancillary data buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no "Field 2" ancillary data will be transferred. Use the AUTOCIRCULATE_TRANSFER::SetAncBuffers method to set or reset this field. More...
 
NTV2Buffer acOutputTimeCodes
 Intended for playout, this is an ordered sequence of NTV2_RP188 values to send to the device. If empty, no timecodes will be transferred. This field is ignored if AUTOCIRCULATE_WITH_RP188 option is not set. More...
 
AUTOCIRCULATE_TRANSFER_STATUS acTransferStatus
 Contains status information that's valid after CNTV2Card::AutoCirculateTransfer returns, including the driver buffer level, number of frames processed or dropped, audio and anc transfer byte counts, and a complete FRAME_STAMP that has even more detailed clocking information. More...
 
ULWord64 acInUserCookie
 Intended for playout, an optional app-specific cookie value that tags this frame, such that if this same tag appears in acTransferStatus.acFrameStamp.acCurrentUserCookie after AutoCirculateTransfer returns, or if it appears in the FRAME_STAMP's acCurrentUserCookie field after CNTV2Card::AutoCirculateGetFrameStamp returns, identifies when the frame was on-the-air. More...
 
ULWord acInVideoDMAOffset
 Optional byte offset into the device frame buffer. Defaults to zero. If non-zero, should be a multiple of the line length, or else bad video will likely result. On capture, this specifies where the first byte in the device video buffer will be read from (and that byte will end up in the first byte position in the host video buffer. Conversely, on playout, this specifies where the first byte from the host video buffer will end up in the device video buffer. More...
 
NTV2SegmentedDMAInfo acInSegmentedDMAInfo
 Optional segmented DMA info, for use with specialized data transfers. More...
 
NTV2ColorCorrectionData acColorCorrection
 Color correction data. This field is ignored if AUTOCIRCULATE_WITH_COLORCORRECT option is not set. More...
 
NTV2FrameBufferFormat acFrameBufferFormat
 Specifies the frame buffer format to change to. Ignored if AUTOCIRCULATE_WITH_FBFCHANGE option is not set. More...
 
NTV2FBOrientation acFrameBufferOrientation
 Specifies the frame buffer orientation to change to. Ignored if AUTOCIRCULATE_WITH_FBOCHANGE option is not set. More...
 
AutoCircVidProcInfo acVidProcInfo
 Specifies the mixer/keyer transition to make. Ignored if AUTOCIRCULATE_WITH_VIDPROC option is not set. More...
 
NTV2QuarterSizeExpandMode acVideoQuarterSizeExpand
 Turns on the "quarter-size expand" (2x H + 2x V) hardware. Defaults to off (1:1). More...
 
NTV2Buffer acHDMIAuxData
 
NTV2_TRAILER acTrailer
 The common structure trailer – ALWAYS LAST! More...
 
Lesser-used and Deprecated Members
ULWord acPeerToPeerFlags
 
ULWord acFrameRepeatCount
 Intended for playout. The number of times to repeat the frame being transferred. More...
 
LWord acDesiredFrame
 Used to specify a different frame in the circulate ring to transfer to/from. More...
 
NTV2_RP188 acRP188
 Will be deprecated – use AUTOCIRCULATE_TRANSFER::SetOutputTimeCode instead. More...
 
NTV2Crosspoint acCrosspoint
 Will be deprecated – used internally by the SDK. Will be removed when the driver changes to use NTV2Channel/NTV2Mode. More...
 

Construction & Destruction

 AUTOCIRCULATE_TRANSFER ()
 Constructs a default AUTOCIRCULATE_TRANSFER struct. More...
 
 ~AUTOCIRCULATE_TRANSFER ()
 My default destructor, which frees all allocatable fields that I own. More...
 
 AUTOCIRCULATE_TRANSFER (ULWord *pInVideoBuffer, const ULWord inVideoByteCount, ULWord *pInAudioBuffer=NULL, const ULWord inAudioByteCount=0, ULWord *pInANCBuffer=NULL, const ULWord inANCByteCount=0, ULWord *pInANCF2Buffer=NULL, const ULWord inANCF2ByteCount=0)
 Constructs an AUTOCIRCULATE_TRANSFER object to use in a CNTV2Card::AutoCirculateTransfer call. More...
 
void Clear (void)
 Resets the struct to its initialized state, with timecode capture disabled, freeing all buffers that were allocated by the SDK. (Buffers set by the client application are zeroed but not freed.) More...
 

Detailed Description

This object specifies the information that will be transferred to or from the AJA device in the CNTV2Card::AutoCirculateTransfer function call.

Note
This struct uses a constructor to properly initialize itself. Do not use memset or bzero to initialize or "clear" it.

Definition at line 8304 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ AUTOCIRCULATE_TRANSFER() [1/2]

AUTOCIRCULATE_TRANSFER::AUTOCIRCULATE_TRANSFER ( )
explicit

Constructs a default AUTOCIRCULATE_TRANSFER struct.

Definition at line 2823 of file ntv2publicinterface.cpp.

◆ ~AUTOCIRCULATE_TRANSFER()

AUTOCIRCULATE_TRANSFER::~AUTOCIRCULATE_TRANSFER ( )

My default destructor, which frees all allocatable fields that I own.

Definition at line 2877 of file ntv2publicinterface.cpp.

◆ AUTOCIRCULATE_TRANSFER() [2/2]

AUTOCIRCULATE_TRANSFER::AUTOCIRCULATE_TRANSFER ( ULWord *  pInVideoBuffer,
const ULWord  inVideoByteCount,
ULWord *  pInAudioBuffer = NULL,
const ULWord  inAudioByteCount = 0,
ULWord *  pInANCBuffer = NULL,
const ULWord  inANCByteCount = 0,
ULWord *  pInANCF2Buffer = NULL,
const ULWord  inANCF2ByteCount = 0 
)
explicit

Constructs an AUTOCIRCULATE_TRANSFER object to use in a CNTV2Card::AutoCirculateTransfer call.

Parameters
pInVideoBufferSpecifies a pointer to the host video buffer. On capture, this buffer will be written during the DMA operation. On playout, this buffer will be read during the DMA operation. If NULL, no video will be transferred.
inVideoByteCountOn capture, specifies the maximum capacity of the host video buffer, in bytes. On playout, specifies the number of video bytes to transfer from the host buffer. If zero, no video will be transferred.
pInAudioBufferOptionally specifies a pointer to the host audio buffer. On capture, audio data will be DMA'd to this buffer. On playout, audio data will be read from this buffer. If NULL, no audio will be transferred. Defaults to NULL.
inAudioByteCountOptionally specifies the maximum capacity of the host audio buffer, in bytes. If zero, no audio will be transferred. Defaults to zero.
pInANCBufferOptionally specifies a pointer to the host ancillary data buffer. On capture, ancillary data will be DMA'd into this buffer. On playout, ancillary data will be read from this buffer. If NULL, no Field 1 ancillary data will be transferred. Defaults to NULL.
inANCByteCountOptionally specifies the maximum capacity of the Field 1 host ancillary data buffer, in bytes. If zero, no ancillary data (progressive or interlaced F1) will be transferred. Defaults to zero.
pInANCF2BufferOptionally specifies a pointer to the Field 2 host ancillary data buffer. On capture, ancillary data will be DMA'd into this buffer. On playout, ancillary data will be read from this buffer. If NULL, no ancillary data will be transferred. Defaults to NULL.
inANCF2ByteCountOptionally specifies the maximum capacity of the Field 2 host ancillary data buffer, in bytes. If zero, no ancillary data (interlaced F2) will be transferred. Defaults to zero.

Definition at line 2847 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Clear()

void AUTOCIRCULATE_TRANSFER::Clear ( void  )

Resets the struct to its initialized state, with timecode capture disabled, freeing all buffers that were allocated by the SDK. (Buffers set by the client application are zeroed but not freed.)

Definition at line 2986 of file ntv2publicinterface.cpp.

◆ DisableQuarterSizeExpandMode()

void AUTOCIRCULATE_TRANSFER::DisableQuarterSizeExpandMode ( void  )
inline

Enables quarter-size expansion mode.

Definition at line 8648 of file ntv2publicinterface.h.

◆ DisableSegmentedDMAs()

bool AUTOCIRCULATE_TRANSFER::DisableSegmentedDMAs ( void  )

Disables segmented DMAs, performing a Reset on my acInSegmentedDMAInfo.

Returns
True if successful; otherwise false.

Definition at line 3005 of file ntv2publicinterface.cpp.

◆ EnableQuarterSizeExpandMode()

void AUTOCIRCULATE_TRANSFER::EnableQuarterSizeExpandMode ( void  )
inline

Enables quarter-size expansion mode.

Definition at line 8643 of file ntv2publicinterface.h.

◆ EnableSegmentedDMAs()

bool AUTOCIRCULATE_TRANSFER::EnableSegmentedDMAs ( const ULWord  inNumSegments,
const ULWord  inNumActiveBytesPerLine,
const ULWord  inHostBytesPerLine,
const ULWord  inDeviceBytesPerLine 
)

Enables segmented DMAs given a segment count, a host pitch, and device pitch value.

Parameters
[in]inNumSegmentsSpecifies the number of segments (lines) to DMA. If zero or 1, this actually disables segmented DMAs, and the remaining parameters are ignored.
[in]inNumActiveBytesPerLineSpecifies the number of active bytes in a line of video.
[in]inHostBytesPerLineSpecifies the offset, in bytes, between two adjacent segments on the host.
[in]inDeviceBytesPerLineSpecifies the offset, in bytes, between two adjacent segments on the device.
Returns
True if successful; otherwise false.
Note
IMPORTANT: For segmented DMAs, the AUTOCIRCULATE_TRANSFER::acVideoBuffer.fByteCount field holds the segment byte count (i.e., the number of bytes to transfer per segment.
Todo:
Add a new inNumBytesPerSegment parameter to eliminate the necessity of setting AUTOCIRCULATE_TRANSFER::acVideoBuffer.fByteCount to store the bytes-per-segment value.

Definition at line 2993 of file ntv2publicinterface.cpp.

◆ GetAncBuffer()

const NTV2Buffer& AUTOCIRCULATE_TRANSFER::GetAncBuffer ( const bool  inField2 = false) const
inline
Parameters
[in]inField2Specify true for Field2. Defaults to false (Field1).
Returns
My ancillary data buffer.

Definition at line 8539 of file ntv2publicinterface.h.

◆ GetAncByteCount()

ULWord AUTOCIRCULATE_TRANSFER::GetAncByteCount ( const bool  inField2 = false) const
inline
Deprecated:
Use GetCapturedAncByteCount instead.

Definition at line 8682 of file ntv2publicinterface.h.

◆ GetAudioBuffer()

const NTV2Buffer& AUTOCIRCULATE_TRANSFER::GetAudioBuffer ( void  ) const
inline
Returns
My audio buffer.

Definition at line 8533 of file ntv2publicinterface.h.

◆ GetAudioByteCount()

ULWord AUTOCIRCULATE_TRANSFER::GetAudioByteCount ( void  ) const
inline
Deprecated:
Use GetCapturedAudioByteCount instead.

Definition at line 8673 of file ntv2publicinterface.h.

◆ GetCapturedAncByteCount()

ULWord AUTOCIRCULATE_TRANSFER::GetCapturedAncByteCount ( const bool  inField2 = false) const
inline
Returns
The number of ancillary data bytes deposited/transferred into the host anc buffer after the last successful CNTV2Card::AutoCirculateTransfer.
Parameters
[in]inField2Specify true to obtain the Field 2 ancillary byte count. Specify false (the default) to return the Field 1 (or progessive) ancillary byte count.

Definition at line 8681 of file ntv2publicinterface.h.

◆ GetCapturedAudioByteCount()

ULWord AUTOCIRCULATE_TRANSFER::GetCapturedAudioByteCount ( void  ) const
inline
Returns
The number of audio bytes deposited/transferred into the host audio buffer after the last successful CNTV2Card::AutoCirculateTransfer.

Definition at line 8671 of file ntv2publicinterface.h.

◆ GetFrameBufferFormat()

NTV2FrameBufferFormat AUTOCIRCULATE_TRANSFER::GetFrameBufferFormat ( void  ) const
inline
Returns
My current frame buffer format.

Definition at line 8687 of file ntv2publicinterface.h.

◆ GetFrameInfo()

const FRAME_STAMP& AUTOCIRCULATE_TRANSFER::GetFrameInfo ( void  ) const
inline

Returns a constant reference to my FRAME_STAMP.

Returns
A constant reference to my FRAME_STAMP.

Definition at line 8665 of file ntv2publicinterface.h.

◆ GetInputTimeCode()

bool AUTOCIRCULATE_TRANSFER::GetInputTimeCode ( NTV2_RP188 &  outTimeCode,
const NTV2TCIndex  inTCIndex = NTV2_TCINDEX_SDI1 
) const

Intended for capture, answers with a specific timecode captured in my acTransferStatus member's acFrameStamp member's acTimeCodes member.

Parameters
[out]outTimeCodeReceives the requested timecode value.
[in]inTCIndexSpecifies which NTV2TCIndex to use. Defaults to NTV2_TCINDEX_SDI1.
Note
Note that specifying an SDI input source that's not connected to the framestore associated with the channel being AutoCirculated will likely result in a timecode that's not frame-accurate.
To work right, CNTV2Card::AutoCirculateInitForInput must have been initialized with the AUTOCIRCULATE_WITH_RP188 option.
Returns
True if successful; otherwise false.

Definition at line 3027 of file ntv2publicinterface.cpp.

◆ GetInputTimeCodes() [1/2]

bool AUTOCIRCULATE_TRANSFER::GetInputTimeCodes ( NTV2TimeCodeList &  outValues) const

Intended for capture, answers with the timecodes captured in my acTransferStatus member's acFrameStamp member.

Parameters
[out]outValuesReceives the NTV2TimeCodeList that was transferred from the device. (An NTV2TCIndex value can be used as in index in the list.)
Returns
True if successful; otherwise false.
Note
To work right, CNTV2Card::AutoCirculateInitForInput must have been initialized with the AUTOCIRCULATE_WITH_RP188 option.

Definition at line 3020 of file ntv2publicinterface.cpp.

◆ GetInputTimeCodes() [2/2]

bool AUTOCIRCULATE_TRANSFER::GetInputTimeCodes ( NTV2TimeCodes &  outTimeCodes,
const NTV2Channel  inSDIInput = NTV2_CHANNEL1,
const bool  inValidOnly = true 
) const

Retrieves the timecodes from the captured frame that are associated with the given SDI input.

Parameters
[out]outTimeCodesReceives the timecode values as a mapping of NTV2TCIndex values to NTV2_RP188 objects.
[in]inSDIInputSpecifies the SDI input of interest as an NTV2Channel. Defaults to NTV2_CHANNEL1 (SDI In 1).
[in]inValidOnlyOptionally specifies if only valid timecodes should be returned. Defaults to true. Specify false to return all timecode values associated with the SDI input of interest, even if they're not valid.
Note
Note that specifying an SDI input source that's not connected to the framestore associated with the channel being AutoCirculated will likely result in a timecode that's not frame-accurate.
To work right, CNTV2Card::AutoCirculateInitForInput must have been initialized with the AUTOCIRCULATE_WITH_RP188 option.
Returns
True if successful; otherwise false.

Definition at line 3034 of file ntv2publicinterface.cpp.

◆ GetTransferFrameNumber()

LWord AUTOCIRCULATE_TRANSFER::GetTransferFrameNumber ( void  ) const
inline
Returns
The frame number that was transferred (or -1 if failed).

Definition at line 8692 of file ntv2publicinterface.h.

◆ GetTransferStatus()

const AUTOCIRCULATE_TRANSFER_STATUS& AUTOCIRCULATE_TRANSFER::GetTransferStatus ( void  ) const
inline

Returns a constant reference to my AUTOCIRCULATE_TRANSFER_STATUS.

Returns
A constant reference to my AUTOCIRCULATE_TRANSFER_STATUS.

Definition at line 8659 of file ntv2publicinterface.h.

◆ GetVideoBuffer()

const NTV2Buffer& AUTOCIRCULATE_TRANSFER::GetVideoBuffer ( void  ) const
inline
Returns
My video buffer.

Definition at line 8528 of file ntv2publicinterface.h.

◆ IsQuarterSizeExpandModeEnabled()

bool AUTOCIRCULATE_TRANSFER::IsQuarterSizeExpandModeEnabled ( void  ) const
inline
Returns
True if quarter-size expansion mode is enabled.

Definition at line 8653 of file ntv2publicinterface.h.

◆ operator NTV2_HEADER *()

AUTOCIRCULATE_TRANSFER::operator NTV2_HEADER * ( )
inline
Returns
My address casted to an NTV2_HEADER pointer.

Definition at line 8729 of file ntv2publicinterface.h.

◆ RPCDecode()

bool AUTOCIRCULATE_TRANSFER::RPCDecode ( const NTV2_RPC_BLOB_TYPE &  inBlob,
size_t &  inOutIndex 
)

Definition at line 4272 of file ntv2publicinterface.cpp.

◆ RPCDecodeClient()

bool AUTOCIRCULATE_TRANSFER::RPCDecodeClient ( const NTV2_RPC_BLOB_TYPE &  inBlob,
size_t &  inOutIndex 
)

◆ RPCDecodeServer()

bool AUTOCIRCULATE_TRANSFER::RPCDecodeServer ( const NTV2_RPC_BLOB_TYPE &  inBlob,
size_t &  inOutIndex 
)

◆ RPCEncode()

bool AUTOCIRCULATE_TRANSFER::RPCEncode ( NTV2_RPC_BLOB_TYPE &  outBlob)

Definition at line 4238 of file ntv2publicinterface.cpp.

◆ RPCEncodeClient()

bool AUTOCIRCULATE_TRANSFER::RPCEncodeClient ( NTV2_RPC_BLOB_TYPE &  inBlob)

◆ RPCEncodeServer()

bool AUTOCIRCULATE_TRANSFER::RPCEncodeServer ( NTV2_RPC_BLOB_TYPE &  inBlob)

◆ SegmentedDMAsEnabled()

bool AUTOCIRCULATE_TRANSFER::SegmentedDMAsEnabled ( void  ) const
Returns
True if segmented DMAs are currently enabled; otherwise false.

Definition at line 3013 of file ntv2publicinterface.cpp.

◆ SetAllOutputTimeCodes()

bool AUTOCIRCULATE_TRANSFER::SetAllOutputTimeCodes ( const NTV2_RP188 &  inTimecode,
const bool  inIncludeF2 = true 
)

Intended for playout, replaces all elements of my acOutputTimeCodes member with the given timecode value.

Parameters
[in]inTimecodeSpecifies the timecode value to use for all possible embedded (VITC, ATC-LTC) and analog timecode outputs for the device.
[in]inIncludeF2Specify true to include Field2 timecode values (VITC2), or false to exclude them. Defaults to true.
Note
Note that specifying an SDI output destination that's not connected to the framestore associated with the AutoCirculate channel can result in the wrong timecode being transmitted from another channel's SDI output(s).
Returns
True if successful; otherwise false.

Definition at line 2957 of file ntv2publicinterface.cpp.

◆ SetAncBuffers()

bool AUTOCIRCULATE_TRANSFER::SetAncBuffers ( ULWord *  pInANCBuffer,
const ULWord  inANCByteCount,
ULWord *  pInANCF2Buffer = NULL,
const ULWord  inANCF2ByteCount = 0 
)

Sets my ancillary data buffers for use in a subsequent call to CNTV2Card::AutoCirculateTransfer.

Parameters
pInANCBufferSpecifies a pointer to the host ancillary data buffer. On capture, ancillary data will be DMA'd into this buffer. On playout, ancillary data will be read from this buffer. If NULL, no ancillary data will be transferred.
inANCByteCountOn capture, specifies the maximum capacity of the host ancillary data buffer, in bytes. After the transfer, it will contain the actual number of bytes transferred. On playout, specifies the number of ancillary data bytes to transfer from the host buffer. If zero, no ancillary data will be transferred.
pInANCF2BufferOptionally specifies a pointer to the Field 2 host ancillary data buffer. On capture, ancillary data for Field 2 (interlaced video formats only) will be DMA'd into this buffer. On playout, ancillary data for Field 2 (interlaced video formats only) will be read from this buffer. If NULL, no Field 2 ancillary data will be transferred. Defaults to NULL.
inANCF2ByteCountOptionally specifies the maximum capacity of the Field 2 host ancillary data buffer, in bytes, or the maximum number of Field 2 ancillary data bytes to transfer. If zero, no F2 ancillary data will be transferred. Defaults to zero.
Note
If using a non-NULL pointer address for either pInANCBuffer or pInANCF2Buffer, be sure they're aligned to the nearest 8-byte boundary.
If using a non-zero byte count, AJA recommends using a 2048-byte buffer (per field). There's no need to fill the entire buffer, but the data it contains should be compatible with what's documented in SDI Anc Packet Capture or SDI Anc Packet Playout (as appropriate).
This function also works for HDMI Auxiliary Data.
Returns
True if successful; otherwise false.

Definition at line 2910 of file ntv2publicinterface.cpp.

◆ SetAudioBuffer()

bool AUTOCIRCULATE_TRANSFER::SetAudioBuffer ( ULWord *  pInAudioBuffer,
const ULWord  inAudioByteCount 
)

Sets my audio buffer for use in a subsequent call to CNTV2Card::AutoCirculateTransfer.

Parameters
pInAudioBufferSpecifies a pointer to the host audio buffer. On capture, audio data will be DMA'd into this buffer. On playout, audio data will be DMA'd from this buffer. If NULL, no audio data will be transferred.
inAudioByteCountOn capture, specifies the maximum capacity of the host audio buffer, in bytes; on playout, specifies the number of audio bytes (and therefore audio samples) to transfer. If zero, no audio data will be transferred.
Returns
True if successful; otherwise false.
Note
Having the pInAudioBuffer address start on at least an 8-byte boundary or even better, on a page boundary, increases PCIe DMA efficiency on most modern operating systems.

Definition at line 2902 of file ntv2publicinterface.cpp.

◆ SetBuffers()

bool AUTOCIRCULATE_TRANSFER::SetBuffers ( ULWord *  pInVideoBuffer,
const ULWord  inVideoByteCount,
ULWord *  pInAudioBuffer,
const ULWord  inAudioByteCount,
ULWord *  pInANCBuffer,
const ULWord  inANCByteCount,
ULWord *  pInANCF2Buffer = NULL,
const ULWord  inANCF2ByteCount = 0 
)

Sets my buffers for use in a subsequent call to CNTV2Card::AutoCirculateTransfer.

Parameters
pInVideoBufferSpecifies a pointer to the host video buffer. On capture, this buffer will be written during the DMA operation. On playout, this buffer will be read during the DMA operation. If NULL, no video will be transferred.
inVideoByteCountOn capture, specifies the maximum capacity of the host video buffer, in bytes. On playout, specifies the number of video bytes to transfer from the host buffer. If zero, no video will be transferred.
pInAudioBufferSpecifies a pointer to the host audio buffer. On capture, audio data will be DMA'd to this buffer. On playout, audio data will be read from this buffer. If NULL, no audio will be transferred.
inAudioByteCountOn capture, specifies the maximum capacity of the host audio buffer, in bytes. On playout, specifies the number of audio bytes (and therefore audio samples) to transfer from the host buffer. If zero, no audio will be transferred.
pInANCBufferSpecifies a pointer to the host ancillary data buffer. On capture, ancillary data will be DMA'd into this buffer. On playout, ancillary data will be read from this buffer. If NULL, no ancillary data will be transferred.
inANCByteCountOn capture, specifies the maximum capacity of the host ancillary data buffer, in bytes. After the transfer, it will contain the actual number of bytes transferred. On playout, specifies the number of ancillary data bytes to transfer from the host buffer. If zero, no ancillary data will be transferred.
pInANCF2BufferOptionally specifies a pointer to the Field 2 host ancillary data buffer. On capture, ancillary data for Field 2 (interlaced video formats only) will be DMA'd into this buffer. On playout, ancillary data for Field 2 (interlaced video formats only) will be read from this buffer. If NULL, no Field 2 ancillary data will be transferred. Defaults to NULL.
inANCF2ByteCountOptionally specifies the maximum capacity of the Field 2 host ancillary data buffer, in bytes. If zero, no ancillary data (interlaced F2) will be transferred. Defaults to zero.

Definition at line 2882 of file ntv2publicinterface.cpp.

◆ SetFrameBufferFormat()

bool AUTOCIRCULATE_TRANSFER::SetFrameBufferFormat ( const NTV2FrameBufferFormat  inNewFormat)

Sets my acFrameBufferFormat value to the given new value (if valid and circulating with AUTOCIRCULATE_WITH_FBFCHANGE option).

Parameters
[in]inNewFormatSpecifies the new frame buffer format value to change to. Must be a valid format for the device.
Returns
True if successful; otherwise false.
Note
This function call is ignored if CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput were called without the AUTOCIRCULATE_WITH_FBFCHANGE option set.

Definition at line 2976 of file ntv2publicinterface.cpp.

◆ SetFrameUserCookie()

bool AUTOCIRCULATE_TRANSFER::SetFrameUserCookie ( const ULWord64 &  inUserCookie)
inline

Intended for playout, replaces my current acUserCookie value with the new value.

Parameters
[in]inUserCookieSpecifies the new cookie value.
Returns
True if successful; otherwise false.
Note
This is useful in playout applications that need to know when a specific frame was actually transmitted on-air. By calling this method with a unique tag (or application-specific pointer address), and monitoring the FRAME_STAMP after calling CNTV2Card::AutoCirculateTransfer or CNTV2Card::AutoCirculateGetFrameStamp, you can tell if/when the frame went on-the-air.

Definition at line 8629 of file ntv2publicinterface.h.

◆ SetOutputTimeCode()

bool AUTOCIRCULATE_TRANSFER::SetOutputTimeCode ( const NTV2_RP188 &  inTimecode,
const NTV2TCIndex  inTCIndex = NTV2_TCINDEX_SDI1 
)

Intended for playout, sets one element of my acOutputTimeCodes member.

Parameters
[in]inTimecodeSpecifies the timecode value.
[in]inTCIndexSpecifies which NTV2TCIndex to use. Defaults to NTV2_TCINDEX_SDI1.
Note
Note that specifying an SDI output destination that's not connected to the framestore associated with the channel being AutoCirculated can result in the wrong timecode being transmitted from another AutoCirculate channel's SDI output(s).
To work right, CNTV2Card::AutoCirculateInitForOutput must have been initialized with the AUTOCIRCULATE_WITH_RP188 option.
Returns
True if successful; otherwise false.

Definition at line 2941 of file ntv2publicinterface.cpp.

◆ SetOutputTimeCodes()

bool AUTOCIRCULATE_TRANSFER::SetOutputTimeCodes ( const NTV2TimeCodes &  inValues)

Intended for playout, replaces the contents of my acOutputTimeCodes member.

Parameters
[in]inValuesSpecifies the NTV2TimeCodes map to transfer to the device.
Returns
True if successful; otherwise false.
Note
The NTV2TimeCodes map should be populated only with timecodes that make sense for the AutoCirculate channel that's in use, otherwise the timecode output of other channels may be affected.
To work right, CNTV2Card::AutoCirculateInitForOutput must have been initialized with the AUTOCIRCULATE_WITH_RP188 option.

Definition at line 2921 of file ntv2publicinterface.cpp.

◆ SetVideoBuffer()

bool AUTOCIRCULATE_TRANSFER::SetVideoBuffer ( ULWord *  pInVideoBuffer,
const ULWord  inVideoByteCount 
)

Sets my video buffer for use in a subsequent call to CNTV2Card::AutoCirculateTransfer.

Parameters
pInVideoBufferSpecifies a pointer to the host video buffer. On capture, this buffer will be written during the DMA operation. On playout, this buffer will be read during the DMA operation. If NULL, no video data will be transferred.
inVideoByteCountSpecifies the maximum capacity of the host video buffer, in bytes, or the maximum number of video data bytes to transfer. If zero, no video data will be transferred.
Returns
True if successful; otherwise false.
Note
Having the pInAudioBuffer address start on at least an 8-byte boundary or even better, on a page boundary, and the inAudioByteCount be a multiple of 8-bytes (or optimally a multiple of a page) increases PCIe DMA efficiency on most modern operating systems.

Definition at line 2894 of file ntv2publicinterface.cpp.

Member Data Documentation

◆ acANCBuffer

NTV2Buffer AUTOCIRCULATE_TRANSFER::acANCBuffer

The host ancillary data buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no ancillary data will be transferred. Use the AUTOCIRCULATE_TRANSFER::SetAncBuffers method to set or reset this field.

Note
If non-empty (i.e., non-NULL), be sure that the pointer address is aligned to the nearest 8-byte boundary. AJA recommends using a full 2048-byte buffer. For playout, its content should be compatible with what's documented in SDI Ancillary Data and all subsequent bytes in the buffer should be zero. For capture, AJA recommends clearing (zeroing) the buffer prior to each transfer.

Definition at line 8330 of file ntv2publicinterface.h.

◆ acANCField2Buffer

NTV2Buffer AUTOCIRCULATE_TRANSFER::acANCField2Buffer

The host "Field 2" ancillary data buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no "Field 2" ancillary data will be transferred. Use the AUTOCIRCULATE_TRANSFER::SetAncBuffers method to set or reset this field.

Note
If non-empty (i.e., non-NULL), be sure that the pointer address is aligned to the nearest 8-byte boundary. AJA recommends using a full 2048-byte buffer. For playout, its content should be compatible with what's documented in SDI Ancillary Data and all subsequent bytes in the buffer should be zero. For capture, AJA recommends clearing (zeroing) the buffer prior to each transfer.

Definition at line 8341 of file ntv2publicinterface.h.

◆ acAudioBuffer

NTV2Buffer AUTOCIRCULATE_TRANSFER::acAudioBuffer

The host audio buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no audio will be transferred. AJA recommends keeping this buffer 64-bit aligned and page-aligned for best performance. Use the AUTOCIRCULATE_TRANSFER::SetAudioBuffer method to set or reset this field.

Definition at line 8319 of file ntv2publicinterface.h.

◆ acColorCorrection

NTV2ColorCorrectionData AUTOCIRCULATE_TRANSFER::acColorCorrection

Color correction data. This field is ignored if AUTOCIRCULATE_WITH_COLORCORRECT option is not set.

Definition at line 8374 of file ntv2publicinterface.h.

◆ acCrosspoint

NTV2Crosspoint AUTOCIRCULATE_TRANSFER::acCrosspoint

Will be deprecated – used internally by the SDK. Will be removed when the driver changes to use NTV2Channel/NTV2Mode.

Definition at line 8390 of file ntv2publicinterface.h.

◆ acDesiredFrame

LWord AUTOCIRCULATE_TRANSFER::acDesiredFrame

Used to specify a different frame in the circulate ring to transfer to/from.

Definition at line 8388 of file ntv2publicinterface.h.

◆ acFrameBufferFormat

NTV2FrameBufferFormat AUTOCIRCULATE_TRANSFER::acFrameBufferFormat

Specifies the frame buffer format to change to. Ignored if AUTOCIRCULATE_WITH_FBFCHANGE option is not set.

Definition at line 8375 of file ntv2publicinterface.h.

◆ acFrameBufferOrientation

NTV2FBOrientation AUTOCIRCULATE_TRANSFER::acFrameBufferOrientation

Specifies the frame buffer orientation to change to. Ignored if AUTOCIRCULATE_WITH_FBOCHANGE option is not set.

Definition at line 8376 of file ntv2publicinterface.h.

◆ acFrameRepeatCount

ULWord AUTOCIRCULATE_TRANSFER::acFrameRepeatCount

Intended for playout. The number of times to repeat the frame being transferred.

Definition at line 8387 of file ntv2publicinterface.h.

◆ acHDMIAuxData

NTV2Buffer AUTOCIRCULATE_TRANSFER::acHDMIAuxData

Definition at line 8380 of file ntv2publicinterface.h.

◆ acHeader

NTV2_HEADER AUTOCIRCULATE_TRANSFER::acHeader

The common structure header – ALWAYS FIRST!

Definition at line 8305 of file ntv2publicinterface.h.

◆ acInSegmentedDMAInfo

NTV2SegmentedDMAInfo AUTOCIRCULATE_TRANSFER::acInSegmentedDMAInfo

Optional segmented DMA info, for use with specialized data transfers.

Definition at line 8373 of file ntv2publicinterface.h.

◆ acInUserCookie

ULWord64 AUTOCIRCULATE_TRANSFER::acInUserCookie

Intended for playout, an optional app-specific cookie value that tags this frame, such that if this same tag appears in acTransferStatus.acFrameStamp.acCurrentUserCookie after AutoCirculateTransfer returns, or if it appears in the FRAME_STAMP's acCurrentUserCookie field after CNTV2Card::AutoCirculateGetFrameStamp returns, identifies when the frame was on-the-air.

Definition at line 8363 of file ntv2publicinterface.h.

◆ acInVideoDMAOffset

ULWord AUTOCIRCULATE_TRANSFER::acInVideoDMAOffset

Optional byte offset into the device frame buffer. Defaults to zero. If non-zero, should be a multiple of the line length, or else bad video will likely result. On capture, this specifies where the first byte in the device video buffer will be read from (and that byte will end up in the first byte position in the host video buffer. Conversely, on playout, this specifies where the first byte from the host video buffer will end up in the device video buffer.

Definition at line 8371 of file ntv2publicinterface.h.

◆ acOutputTimeCodes

NTV2Buffer AUTOCIRCULATE_TRANSFER::acOutputTimeCodes

Intended for playout, this is an ordered sequence of NTV2_RP188 values to send to the device. If empty, no timecodes will be transferred. This field is ignored if AUTOCIRCULATE_WITH_RP188 option is not set.

Note
This field is owned by the SDK, which is responsible for allocating and/or freeing it. Use my AUTOCIRCULATE_TRANSFER::SetOutputTimeCodes or AUTOCIRCULATE_TRANSFER::SetOutputTimeCode methods to change this field.

Definition at line 8349 of file ntv2publicinterface.h.

◆ acPeerToPeerFlags

ULWord AUTOCIRCULATE_TRANSFER::acPeerToPeerFlags

Definition at line 8386 of file ntv2publicinterface.h.

◆ acRP188

NTV2_RP188 AUTOCIRCULATE_TRANSFER::acRP188

Will be deprecated – use AUTOCIRCULATE_TRANSFER::SetOutputTimeCode instead.

Definition at line 8389 of file ntv2publicinterface.h.

◆ acTrailer

NTV2_TRAILER AUTOCIRCULATE_TRANSFER::acTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8392 of file ntv2publicinterface.h.

◆ acTransferStatus

AUTOCIRCULATE_TRANSFER_STATUS AUTOCIRCULATE_TRANSFER::acTransferStatus

Contains status information that's valid after CNTV2Card::AutoCirculateTransfer returns, including the driver buffer level, number of frames processed or dropped, audio and anc transfer byte counts, and a complete FRAME_STAMP that has even more detailed clocking information.

Definition at line 8356 of file ntv2publicinterface.h.

◆ acVideoBuffer

NTV2Buffer AUTOCIRCULATE_TRANSFER::acVideoBuffer

The host video buffer. This field is owned by the client application, and thus is responsible for allocating and/or freeing it. If the pointer is NULL or the size is zero, no video will be transferred. AJA recommends keeping this buffer 64-bit aligned and page-aligned for best performance. Use the AUTOCIRCULATE_TRANSFER::SetVideoBuffer method to set or reset this field.

Definition at line 8312 of file ntv2publicinterface.h.

◆ acVideoQuarterSizeExpand

NTV2QuarterSizeExpandMode AUTOCIRCULATE_TRANSFER::acVideoQuarterSizeExpand

Turns on the "quarter-size expand" (2x H + 2x V) hardware. Defaults to off (1:1).

Definition at line 8378 of file ntv2publicinterface.h.

◆ acVidProcInfo

AutoCircVidProcInfo AUTOCIRCULATE_TRANSFER::acVidProcInfo

Specifies the mixer/keyer transition to make. Ignored if AUTOCIRCULATE_WITH_VIDPROC option is not set.

Definition at line 8377 of file ntv2publicinterface.h.


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