AJA NTV2 SDK  18.1.0.2145
NTV2 SDK 18.1.0.2145
Public Member Functions | Public Attributes | List of all members
NTV2FrameData Class Reference

I encapsulate the video, audio and anc host buffers used in the AutoCirculate demos. I'm a more modern version of the AVDataBuffer. More...

#include <ntv2democommon.h>

Collaboration diagram for NTV2FrameData:
[legend]

Public Member Functions

 NTV2FrameData ()
 
NTV2Buffer & VideoBuffer (void)
 
ULWord VideoBufferSize (void) const
 
NTV2Buffer & AudioBuffer (void)
 
ULWord AudioBufferSize (void) const
 
ULWord NumCapturedAudioBytes (void) const
 
bool HasAudioSamples (void) const
 
NTV2Buffer & AncBuffer (void)
 
ULWord AncBufferSize (void) const
 
ULWord NumCapturedAncBytes (void) const
 
bool HasF1Anc (void) const
 
NTV2Buffer & AncBuffer2 (void)
 
ULWord AncBuffer2Size (void) const
 
ULWord NumCapturedAnc2Bytes (void) const
 
bool HasF2Anc (void) const
 
NTV2Buffer & VideoBuffer2 (void)
 
ULWord VideoBufferSize2 (void) const
 
bool IsNULL (void) const
 
bool HasTimecode (const NTV2TCIndex inTCNdx) const
 
NTV2_RP188 Timecode (const NTV2TCIndex inTCNdx) const
 
bool HasValidTimecode (const NTV2TCIndex inTCNdx) const
 
bool HasTimeStamp (void) const
 
uint64_t TimeStamp (const bool useAudioClock=(!(0))) const
 
uint64_t UserData (void) const
 
NTV2FrameData & SetUserData (const uint64_t val)
 
void ZeroBuffers (void)
 
bool LockAll (CNTV2Card &inDevice)
 
bool UnlockAll (CNTV2Card &inDevice)
 
bool Reset (void)
 
bool SetCapturedFrameInfo (const AUTOCIRCULATE_TRANSFER &inXferInfo, const AUTOCIRCULATE_STATUS &acStatus)
 

Public Attributes

NTV2Buffer fVideoBuffer
 Host video buffer. More...
 
NTV2Buffer fVideoBuffer2
 Additional host video buffer, usually F2. More...
 
NTV2Buffer fAudioBuffer
 Host audio buffer. More...
 
NTV2Buffer fAncBuffer
 Host ancillary data buffer. More...
 
NTV2Buffer fAncBuffer2
 Additional "F2" host anc buffer. More...
 
NTV2TimeCodes fTimecodes
 Map of TC indexes to NTV2_RP188 values. More...
 
ULWord fNumAudioBytes
 Actual number of captured audio bytes. More...
 
ULWord fNumAncBytes
 Actual number of captured F1 anc bytes. More...
 
ULWord fNumAnc2Bytes
 Actual number of captured F2 anc bytes. More...
 
uint32_t fFrameFlags
 Frame data flags. More...
 
uint64_t fTimeStampAud
 VBI timestamp (device audio clock) More...
 
uint64_t fTimeStampOS
 VBI timestamp (host OS clock) More...
 
uint64_t fUserData
 User data (frame tag/id, for playback) More...
 

Detailed Description

I encapsulate the video, audio and anc host buffers used in the AutoCirculate demos. I'm a more modern version of the AVDataBuffer.

Definition at line 79 of file ntv2democommon.h.

Constructor & Destructor Documentation

◆ NTV2FrameData()

NTV2FrameData::NTV2FrameData ( )
inlineexplicit

Definition at line 96 of file ntv2democommon.h.

Member Function Documentation

◆ AncBuffer()

NTV2Buffer& NTV2FrameData::AncBuffer ( void  )
inline

Definition at line 120 of file ntv2democommon.h.

◆ AncBuffer2()

NTV2Buffer& NTV2FrameData::AncBuffer2 ( void  )
inline

Definition at line 125 of file ntv2democommon.h.

◆ AncBuffer2Size()

ULWord NTV2FrameData::AncBuffer2Size ( void  ) const
inline

Definition at line 126 of file ntv2democommon.h.

◆ AncBufferSize()

ULWord NTV2FrameData::AncBufferSize ( void  ) const
inline

Definition at line 121 of file ntv2democommon.h.

◆ AudioBuffer()

NTV2Buffer& NTV2FrameData::AudioBuffer ( void  )
inline

Definition at line 115 of file ntv2democommon.h.

◆ AudioBufferSize()

ULWord NTV2FrameData::AudioBufferSize ( void  ) const
inline

Definition at line 116 of file ntv2democommon.h.

◆ HasAudioSamples()

bool NTV2FrameData::HasAudioSamples ( void  ) const
inline

Definition at line 118 of file ntv2democommon.h.

◆ HasF1Anc()

bool NTV2FrameData::HasF1Anc ( void  ) const
inline

Definition at line 123 of file ntv2democommon.h.

◆ HasF2Anc()

bool NTV2FrameData::HasF2Anc ( void  ) const
inline

Definition at line 128 of file ntv2democommon.h.

◆ HasTimecode()

bool NTV2FrameData::HasTimecode ( const NTV2TCIndex  inTCNdx) const
inline

Definition at line 136 of file ntv2democommon.h.

◆ HasTimeStamp()

bool NTV2FrameData::HasTimeStamp ( void  ) const
inline

Definition at line 139 of file ntv2democommon.h.

◆ HasValidTimecode()

bool NTV2FrameData::HasValidTimecode ( const NTV2TCIndex  inTCNdx) const
inline

Definition at line 138 of file ntv2democommon.h.

◆ IsNULL()

bool NTV2FrameData::IsNULL ( void  ) const
inline

Definition at line 133 of file ntv2democommon.h.

◆ LockAll()

bool NTV2FrameData::LockAll ( CNTV2Card &  inDevice)

Definition at line 412 of file ntv2democommon.cpp.

◆ NumCapturedAnc2Bytes()

ULWord NTV2FrameData::NumCapturedAnc2Bytes ( void  ) const
inline

Definition at line 127 of file ntv2democommon.h.

◆ NumCapturedAncBytes()

ULWord NTV2FrameData::NumCapturedAncBytes ( void  ) const
inline

Definition at line 122 of file ntv2democommon.h.

◆ NumCapturedAudioBytes()

ULWord NTV2FrameData::NumCapturedAudioBytes ( void  ) const
inline

Definition at line 117 of file ntv2democommon.h.

◆ Reset()

bool NTV2FrameData::Reset ( void  )
inline

Definition at line 160 of file ntv2democommon.h.

◆ SetCapturedFrameInfo()

bool NTV2FrameData::SetCapturedFrameInfo ( const AUTOCIRCULATE_TRANSFER &  inXferInfo,
const AUTOCIRCULATE_STATUS &  acStatus 
)

Definition at line 454 of file ntv2democommon.cpp.

◆ SetUserData()

NTV2FrameData& NTV2FrameData::SetUserData ( const uint64_t  val)
inline

Definition at line 142 of file ntv2democommon.h.

◆ Timecode()

NTV2_RP188 NTV2FrameData::Timecode ( const NTV2TCIndex  inTCNdx) const

Definition at line 404 of file ntv2democommon.cpp.

◆ TimeStamp()

uint64_t NTV2FrameData::TimeStamp ( const bool  useAudioClock = (! (0) )) const
inline

Definition at line 140 of file ntv2democommon.h.

◆ UnlockAll()

bool NTV2FrameData::UnlockAll ( CNTV2Card &  inDevice)

Definition at line 433 of file ntv2democommon.cpp.

◆ UserData()

uint64_t NTV2FrameData::UserData ( void  ) const
inline

Definition at line 141 of file ntv2democommon.h.

◆ VideoBuffer()

NTV2Buffer& NTV2FrameData::VideoBuffer ( void  )
inline

Definition at line 112 of file ntv2democommon.h.

◆ VideoBuffer2()

NTV2Buffer& NTV2FrameData::VideoBuffer2 ( void  )
inline

Definition at line 130 of file ntv2democommon.h.

◆ VideoBufferSize()

ULWord NTV2FrameData::VideoBufferSize ( void  ) const
inline

Definition at line 113 of file ntv2democommon.h.

◆ VideoBufferSize2()

ULWord NTV2FrameData::VideoBufferSize2 ( void  ) const
inline

Definition at line 131 of file ntv2democommon.h.

◆ ZeroBuffers()

void NTV2FrameData::ZeroBuffers ( void  )
inline

Definition at line 145 of file ntv2democommon.h.

Member Data Documentation

◆ fAncBuffer

NTV2Buffer NTV2FrameData::fAncBuffer

Host ancillary data buffer.

Definition at line 85 of file ntv2democommon.h.

◆ fAncBuffer2

NTV2Buffer NTV2FrameData::fAncBuffer2

Additional "F2" host anc buffer.

Definition at line 86 of file ntv2democommon.h.

◆ fAudioBuffer

NTV2Buffer NTV2FrameData::fAudioBuffer

Host audio buffer.

Definition at line 84 of file ntv2democommon.h.

◆ fFrameFlags

uint32_t NTV2FrameData::fFrameFlags

Frame data flags.

Definition at line 91 of file ntv2democommon.h.

◆ fNumAnc2Bytes

ULWord NTV2FrameData::fNumAnc2Bytes

Actual number of captured F2 anc bytes.

Definition at line 90 of file ntv2democommon.h.

◆ fNumAncBytes

ULWord NTV2FrameData::fNumAncBytes

Actual number of captured F1 anc bytes.

Definition at line 89 of file ntv2democommon.h.

◆ fNumAudioBytes

ULWord NTV2FrameData::fNumAudioBytes

Actual number of captured audio bytes.

Definition at line 88 of file ntv2democommon.h.

◆ fTimecodes

NTV2TimeCodes NTV2FrameData::fTimecodes

Map of TC indexes to NTV2_RP188 values.

Definition at line 87 of file ntv2democommon.h.

◆ fTimeStampAud

uint64_t NTV2FrameData::fTimeStampAud

VBI timestamp (device audio clock)

Definition at line 92 of file ntv2democommon.h.

◆ fTimeStampOS

uint64_t NTV2FrameData::fTimeStampOS

VBI timestamp (host OS clock)

Definition at line 93 of file ntv2democommon.h.

◆ fUserData

uint64_t NTV2FrameData::fUserData

User data (frame tag/id, for playback)

Definition at line 94 of file ntv2democommon.h.

◆ fVideoBuffer

NTV2Buffer NTV2FrameData::fVideoBuffer

Host video buffer.

Definition at line 82 of file ntv2democommon.h.

◆ fVideoBuffer2

NTV2Buffer NTV2FrameData::fVideoBuffer2

Additional host video buffer, usually F2.

Definition at line 83 of file ntv2democommon.h.

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