Declares the CNTV2Card class. More...

#include "ntv2macdriverinterface.h"
#include "ntv2signalrouter.h"
#include "ntv2utils.h"
#include <set>
#include <string>
#include <iostream>
#include <vector>
#include <bitset>

Include dependency graph for ntv2card.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	DeviceCapabilities
	Convenience class/API for inquiring about device capabilities of physical and virtual devices. Instead of calling the old global ::NTV2DeviceCanDoXXX(mDeviceID) functions, call mCard.features().CanDoXXX(). Instead of calling ::NTV2DeviceGetNumYYY(mDeviceID), call mCard.features().GetNumYYY(). More...

class	CNTV2Card
	I interrogate and control an AJA video/audio capture/playout device. More...

class	SDRAMAuditor
	Audits an NTV2 device's SDRAM utilization, and can report contiguous regions of SDRAM, whether unused/free, those being read/written by AutoCirculate, those being read/written by non-AutoCirculating FrameStores, those that are in conflict (AutoCirculate, FrameStore and/or Audio collisions), plus invalid/out-of-bounds regions being accessed. More...

Macros
#define	AJA_RETAIL_DEFAULT true

#define	Set425FrameEnable SetTsiFrameEnable

#define	Get425FrameEnable GetTsiFrameEnable

#define	NTV2_STREAM_SUCCESS(__status__) (__status__ == NTV2_STREAM_SUCCESS)

#define	NTV2_STREAM_FAIL(__status__) (__status__ != NTV2_STREAM_SUCCESS)

#define	SetTablesToHardware LoadLUTTables

#define	GetTablesFromHardware GetLUTTables

Typedefs
typedef std::set< NTV2AudioChannelPair >	NTV2AudioChannelPairs
	A set of distinct NTV2AudioChannelPair values. More...

typedef NTV2AudioChannelPairs::const_iterator	NTV2AudioChannelPairsConstIter
	Handy const iterator to iterate over a set of distinct NTV2AudioChannelPair values. More...

typedef std::set< NTV2AudioChannelQuad >	NTV2AudioChannelQuads
	A set of distinct NTV2AudioChannelQuad values. More...

typedef NTV2AudioChannelQuads::const_iterator	NTV2AudioChannelQuadsConstIter
	Handy const iterator to iterate over a set of distinct NTV2AudioChannelQuad values. More...

typedef std::set< NTV2AudioChannelOctet >	NTV2AudioChannelOctets
	A set of distinct NTV2AudioChannelOctet values. More...

typedef NTV2AudioChannelOctets::const_iterator	NTV2AudioChannelOctetsConstIter
	Handy const iterator to iterate over a set of distinct NTV2AudioChannelOctet values. More...

typedef std::vector< double >	NTV2DoubleArray
	An array of double-precision floating-point values. More...

typedef NTV2DoubleArray::iterator	NTV2DoubleArrayIter
	Handy non-const iterator to iterate over an NTV2DoubleArray. More...

typedef NTV2DoubleArray::const_iterator	NTV2DoubleArrayConstIter
	Handy const iterator to iterate over an NTV2DoubleArray. More...

typedef UByte	NTV2DID
	An ancillary Data IDentifier. More...

typedef std::set< UByte >	NTV2DIDSet
	A set of distinct NTV2DID values. More...

typedef NTV2DIDSet::iterator	NTV2DIDSetIter
	Handy non-const iterator to iterate over an NTV2DIDSet. More...

typedef NTV2DIDSet::const_iterator	NTV2DIDSetConstIter
	Handy const iterator to iterate over an NTV2DIDSet. More...

typedef std::bitset< 16 >	NTV2AudioChannelsMuted16
	Per-audio-channel mute state for up to 16 audio channels. More...

typedef CNTV2Card	CNTV2Device
	Instances of this class are able to interrogate and control an NTV2 AJA video/audio capture/playout device. More...

typedef CNTV2Card	CNTV2Status

typedef CNTV2Card	CNTV2TestPattern

typedef CNTV2Card	CNTV2VidProc

typedef CNTV2Card	CNTV2ColorCorrection

typedef CNTV2Card	CNTV2ProcAmp

typedef CNTV2Card	CXena2VidProc

Functions
std::ostream &	operator<< (std::ostream &inOutStr, const NTV2AudioChannelPairs &inSet)
	Handy ostream writer for NTV2AudioChannelPairs. More...

std::ostream &	operator<< (std::ostream &inOutStr, const NTV2AudioChannelQuads &inSet)
	Handy ostream writer for NTV2AudioChannelQuads. More...

std::ostream &	operator<< (std::ostream &inOutStr, const NTV2AudioChannelOctets &inSet)
	Handy ostream writer for NTV2AudioChannelOctets. More...

std::ostream &	operator<< (std::ostream &inOutStr, const NTV2DoubleArray &inVector)
	Handy ostream writer for NTV2DoubleArray. More...

std::ostream &	operator<< (std::ostream &inOutStr, const NTV2DIDSet &inDIDs)
	Handy ostream writer for NTV2DIDSet. More...

Variables
const NTV2AudioChannelsMuted16	NTV2AudioChannelsMuteAll = NTV2AudioChannelsMuted16(0xFFFF)
	All 16 audio channels muted/disabled. More...

const NTV2AudioChannelsMuted16	NTV2AudioChannelsEnableAll = NTV2AudioChannelsMuted16(0x0000)
	All 16 audio channels unmuted/enabled. More...

const ULWord	LUTTablePartitionSize = ULWord(0x40000)

Detailed Description

Declares the CNTV2Card class.

Copyright: (C) 2004-2022 AJA Video Systems, Inc.

Definition in file ntv2card.h.

Macro Definition Documentation

◆ AJA_RETAIL_DEFAULT

#define AJA_RETAIL_DEFAULT true

Definition at line 838 of file ntv2card.h.

◆ Get425FrameEnable

#define Get425FrameEnable GetTsiFrameEnable

Definition at line 1451 of file ntv2card.h.

◆ GetTablesFromHardware

#define GetTablesFromHardware GetLUTTables

Definition at line 6487 of file ntv2card.h.

◆ NTV2_STREAM_FAIL

#define NTV2_STREAM_FAIL ( __status__ ) (__status__ != NTV2_STREAM_SUCCESS)

Definition at line 3702 of file ntv2card.h.

◆ NTV2_STREAM_SUCCESS

#define NTV2_STREAM_SUCCESS ( __status__ ) (__status__ == NTV2_STREAM_SUCCESS)

Definition at line 3701 of file ntv2card.h.

◆ Set425FrameEnable

#define Set425FrameEnable SetTsiFrameEnable

Definition at line 1450 of file ntv2card.h.

◆ SetTablesToHardware

#define SetTablesToHardware LoadLUTTables

Definition at line 6486 of file ntv2card.h.

Typedef Documentation

◆ CNTV2ColorCorrection

typedef CNTV2Card CNTV2ColorCorrection

Deprecated:: Use CNTV2Card instead.

Definition at line 6481 of file ntv2card.h.

◆ CNTV2Device

typedef CNTV2Card CNTV2Device

Instances of this class are able to interrogate and control an NTV2 AJA video/audio capture/playout device.

Definition at line 6476 of file ntv2card.h.

◆ CNTV2ProcAmp

typedef CNTV2Card CNTV2ProcAmp

Deprecated:: Use CNTV2Card instead.

Definition at line 6482 of file ntv2card.h.

◆ CNTV2Status

typedef CNTV2Card CNTV2Status

Deprecated:: Use CNTV2Card instead.

Definition at line 6478 of file ntv2card.h.

◆ CNTV2TestPattern

typedef CNTV2Card CNTV2TestPattern

Deprecated:: Use CNTV2Card instead.

Definition at line 6479 of file ntv2card.h.

◆ CNTV2VidProc

typedef CNTV2Card CNTV2VidProc

Deprecated:: Use CNTV2Card instead

Definition at line 6480 of file ntv2card.h.

◆ CXena2VidProc

typedef CNTV2Card CXena2VidProc

Deprecated:: Use CNTV2Card instead.

Definition at line 6483 of file ntv2card.h.

◆ NTV2AudioChannelOctets

typedef std::set<NTV2AudioChannelOctet> NTV2AudioChannelOctets

A set of distinct NTV2AudioChannelOctet values.

Definition at line 37 of file ntv2card.h.

◆ NTV2AudioChannelOctetsConstIter

typedef NTV2AudioChannelOctets::const_iterator NTV2AudioChannelOctetsConstIter

Handy const iterator to iterate over a set of distinct NTV2AudioChannelOctet values.

Definition at line 38 of file ntv2card.h.

◆ NTV2AudioChannelPairs

typedef std::set<NTV2AudioChannelPair> NTV2AudioChannelPairs

A set of distinct NTV2AudioChannelPair values.

Definition at line 29 of file ntv2card.h.

◆ NTV2AudioChannelPairsConstIter

typedef NTV2AudioChannelPairs::const_iterator NTV2AudioChannelPairsConstIter

Handy const iterator to iterate over a set of distinct NTV2AudioChannelPair values.

Definition at line 30 of file ntv2card.h.

◆ NTV2AudioChannelQuads

typedef std::set<NTV2AudioChannelQuad> NTV2AudioChannelQuads

A set of distinct NTV2AudioChannelQuad values.

Definition at line 33 of file ntv2card.h.

◆ NTV2AudioChannelQuadsConstIter

typedef NTV2AudioChannelQuads::const_iterator NTV2AudioChannelQuadsConstIter

Handy const iterator to iterate over a set of distinct NTV2AudioChannelQuad values.

Definition at line 34 of file ntv2card.h.

◆ NTV2AudioChannelsMuted16

typedef std::bitset<16> NTV2AudioChannelsMuted16

Per-audio-channel mute state for up to 16 audio channels.

Definition at line 53 of file ntv2card.h.

◆ NTV2DID

typedef UByte NTV2DID

An ancillary Data IDentifier.

Definition at line 46 of file ntv2card.h.

◆ NTV2DIDSet

typedef std::set<UByte> NTV2DIDSet

A set of distinct NTV2DID values.

Definition at line 47 of file ntv2card.h.

◆ NTV2DIDSetConstIter

typedef NTV2DIDSet::const_iterator NTV2DIDSetConstIter

Handy const iterator to iterate over an NTV2DIDSet.

Definition at line 49 of file ntv2card.h.

◆ NTV2DIDSetIter

typedef NTV2DIDSet::iterator NTV2DIDSetIter

Handy non-const iterator to iterate over an NTV2DIDSet.

Definition at line 48 of file ntv2card.h.

◆ NTV2DoubleArray

typedef std::vector<double> NTV2DoubleArray

An array of double-precision floating-point values.

Definition at line 41 of file ntv2card.h.

◆ NTV2DoubleArrayConstIter

typedef NTV2DoubleArray::const_iterator NTV2DoubleArrayConstIter

Handy const iterator to iterate over an NTV2DoubleArray.

Definition at line 43 of file ntv2card.h.

◆ NTV2DoubleArrayIter

typedef NTV2DoubleArray::iterator NTV2DoubleArrayIter

Handy non-const iterator to iterate over an NTV2DoubleArray.

Definition at line 42 of file ntv2card.h.

Function Documentation

◆ operator<<() [1/5]

std::ostream& operator<<	(	std::ostream &	inOutStr,
		const NTV2AudioChannelOctets &	inSet
	)

Handy ostream writer for NTV2AudioChannelOctets.

◆ operator<<() [2/5]

std::ostream& operator<<	(	std::ostream &	inOutStr,
		const NTV2AudioChannelPairs &	inSet
	)

Handy ostream writer for NTV2AudioChannelPairs.

◆ operator<<() [3/5]

std::ostream& operator<<	(	std::ostream &	inOutStr,
		const NTV2AudioChannelQuads &	inSet
	)

Handy ostream writer for NTV2AudioChannelQuads.

◆ operator<<() [4/5]

std::ostream& operator<<	(	std::ostream &	inOutStr,
		const NTV2DIDSet &	inDIDs
	)

Handy ostream writer for NTV2DIDSet.

◆ operator<<() [5/5]

std::ostream& operator<<	(	std::ostream &	inOutStr,
		const NTV2DoubleArray &	inVector
	)

Handy ostream writer for NTV2DoubleArray.

Variable Documentation

◆ LUTTablePartitionSize

const ULWord LUTTablePartitionSize = ULWord(0x40000)

Definition at line 56 of file ntv2card.h.

◆ NTV2AudioChannelsEnableAll

const NTV2AudioChannelsMuted16 NTV2AudioChannelsEnableAll = NTV2AudioChannelsMuted16(0x0000)

All 16 audio channels unmuted/enabled.

Definition at line 55 of file ntv2card.h.

◆ NTV2AudioChannelsMuteAll

const NTV2AudioChannelsMuted16 NTV2AudioChannelsMuteAll = NTV2AudioChannelsMuted16(0xFFFF)

All 16 audio channels muted/disabled.

Definition at line 54 of file ntv2card.h.

Classes

Macros

Typedefs

Functions

Variables