CNTV2VPID Class Reference

A convenience class that simplifies encoding or decoding the 4-byte VPID payload that can be read or written from/to VPID registers. More...

#include <ntv2vpid.h>

Public Member Functions
Construction, Destruction, Copying, Assigning
	CNTV2VPID (const ULWord inData=0)
	CNTV2VPID (const CNTV2VPID &other)
virtual CNTV2VPID &	operator= (const CNTV2VPID &inRHS)
virtual	~CNTV2VPID ()
Inquiry
virtual VPIDVersion	GetVersion (void) const
virtual NTV2VideoFormat	GetVideoFormat (void) const
virtual bool	IsStandard3Ga (void) const
virtual bool	IsStandardMultiLink4320 (void) const
virtual bool	IsStandardTwoSampleInterleave (void) const
virtual VPIDStandard	GetStandard (void) const
virtual bool	GetProgressiveTransport (void) const
virtual bool	GetProgressivePicture (void) const
virtual VPIDPictureRate	GetPictureRate (void) const
virtual bool	GetImageAspect16x9 (void) const
virtual VPIDSampling	GetSampling (void) const
virtual bool	IsRGBSampling (void) const
virtual VPIDChannel	GetChannel (void) const
virtual VPIDChannel	GetDualLinkChannel (void) const
virtual VPIDBitDepth	GetBitDepth (void) const
virtual AJALabelValuePairs &	GetInfo (AJALabelValuePairs &outInfo) const
virtual NTV2VPIDXferChars	GetTransferCharacteristics (void) const
virtual NTV2VPIDColorimetry	GetColorimetry (void) const
virtual NTV2VPIDLuminance	GetLuminance (void) const
virtual NTV2VPIDRGBRange	GetRGBRange (void) const
virtual std::ostream &	Print (std::ostream &ostrm) const
virtual std::ostream &	PrintPretty (std::ostream &ostrm) const
virtual std::string	AsString (const bool inTabular=false) const
Changing
virtual CNTV2VPID &	SetVPID (const ULWord inData)
virtual bool	SetVPID (const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inFrameBufferFormat, const bool inIsProgressive, const bool inIs16x9Aspect, const VPIDChannel inVPIDChannel)
virtual bool	SetVPID (const NTV2VideoFormat inOutputFormat, const bool inIsDualLink, const bool inIs48BitRGBFormat, const bool inIsOutput3Gb, const bool inIsSMPTE425, const VPIDChannel inVPIDhannel)
virtual CNTV2VPID &	SetVersion (const VPIDVersion inVersion)
virtual CNTV2VPID &	SetStandard (const VPIDStandard inStandard)
virtual CNTV2VPID &	SetProgressiveTransport (const bool inIsProgressiveTransport)
virtual CNTV2VPID &	SetProgressivePicture (const bool inIsProgressivePicture)
virtual CNTV2VPID &	SetPictureRate (const VPIDPictureRate inPictureRate)
virtual CNTV2VPID &	SetImageAspect16x9 (const bool inIs16x9Aspect)
virtual CNTV2VPID &	SetSampling (const VPIDSampling inSampling)
virtual CNTV2VPID &	SetChannel (const VPIDChannel inChannel)
virtual CNTV2VPID &	SetDualLinkChannel (const VPIDChannel inChannel)
virtual CNTV2VPID &	SetBitDepth (const VPIDBitDepth inBitDepth)
virtual CNTV2VPID &	SetTransferCharacteristics (const NTV2VPIDXferChars inXferChars)
virtual CNTV2VPID &	SetColorimetry (const NTV2VPIDColorimetry inColorimetry)
virtual CNTV2VPID &	SetLuminance (const NTV2VPIDLuminance inLuminance)
virtual CNTV2VPID &	SetRGBRange (const NTV2VPIDRGBRange inRGBRange)
virtual CNTV2VPID &	MakeInvalid (void)

Static Public Member Functions
Class Methods
static bool	SetVPIDData (ULWord &outVPID, const NTV2VideoFormat inOutputFormat, const NTV2FrameBufferFormat inFrameBufferFormat, const bool inIsProgressive, const bool inIs16x9Aspect, const VPIDChannel inVPIDChannel, const bool inUseVPIDChannel=true)
static bool	SetVPIDData (ULWord &outVPID, const NTV2VideoFormat inOutputFormat, const bool inIsDualLinkRGB, const bool inIsRGB48Bit, const bool inIsOutput3Gb, const bool inIsSMPTE425, const VPIDChannel inVPIDChannel, const bool inUseVPIDChannel=true, const bool inOutputIs6G=false, const bool inOutputIs12G=false, const NTV2VPIDXferChars inXferChars=NTV2_VPID_TC_SDR_TV, const NTV2VPIDColorimetry inColorimetry=NTV2_VPID_Color_Rec709, const NTV2VPIDLuminance inLuminance=NTV2_VPID_Luminance_YCbCr, const NTV2VPIDRGBRange inRGBRange=NTV2_VPID_Range_Narrow)
static const std::string	VersionString (const VPIDVersion version)
static const std::string	StandardString (const VPIDStandard std)
static const std::string	PictureRateString (const VPIDPictureRate rate)
static const std::string	SamplingString (const VPIDSampling sample)
static const std::string	ChannelString (const VPIDChannel chan)
static const std::string	DynamicRangeString (const VPIDDynamicRange range)
static const std::string	BitDepthString (const VPIDBitDepth depth)
static const std::string	LinkString (const VPIDLink link)
static const std::string	AudioString (const VPIDAudio audio)
static const std::string	VPIDVersionToString (const VPIDVersion inVers)
static const std::string	VPIDStandardToString (const VPIDStandard inStd)
static bool	VPIDStandardIsSingleLink (const VPIDStandard inStd)
static bool	VPIDStandardIsDualLink (const VPIDStandard inStd)
static bool	VPIDStandardIsQuadLink (const VPIDStandard inStd)
static bool	VPIDStandardIsOctLink (const VPIDStandard inStd)

Detailed Description

A convenience class that simplifies encoding or decoding the 4-byte VPID payload that can be read or written from/to VPID registers.

Definition at line 23 of file ntv2vpid.h.

Constructor & Destructor Documentation

CNTV2VPID() [1/2]

CNTV2VPID::CNTV2VPID

(

const ULWord

inData = 0

)

Definition at line 206 of file ntv2vpid.cpp.

CNTV2VPID() [2/2]

CNTV2VPID::CNTV2VPID

(

const CNTV2VPID &

other

)

Definition at line 213 of file ntv2vpid.cpp.

~CNTV2VPID()

virtual CNTV2VPID::~CNTV2VPID ( )

inlinevirtual

Definition at line 33 of file ntv2vpid.h.

Member Function Documentation

AsString()

string CNTV2VPID::AsString ( const bool  inTabular = false ) const

virtual

Definition at line 1413 of file ntv2vpid.cpp.

AudioString()

const string CNTV2VPID::AudioString ( const VPIDAudio  audio )

static

Definition at line 1008 of file ntv2vpid.cpp.

BitDepthString()

const string CNTV2VPID::BitDepthString ( const VPIDBitDepth  depth )

static

Definition at line 978 of file ntv2vpid.cpp.

ChannelString()

const string CNTV2VPID::ChannelString ( const VPIDChannel  chan )

static

Definition at line 948 of file ntv2vpid.cpp.

DynamicRangeString()

const string CNTV2VPID::DynamicRangeString ( const VPIDDynamicRange  range )

static

Definition at line 965 of file ntv2vpid.cpp.

GetBitDepth()

VPIDBitDepth CNTV2VPID::GetBitDepth ( void  ) const

virtual

Definition at line 462 of file ntv2vpid.cpp.

GetChannel()

VPIDChannel CNTV2VPID::GetChannel ( void  ) const

virtual

Definition at line 434 of file ntv2vpid.cpp.

GetColorimetry()

NTV2VPIDColorimetry CNTV2VPID::GetColorimetry ( void  ) const

virtual

Definition at line 506 of file ntv2vpid.cpp.

GetDualLinkChannel()

VPIDChannel CNTV2VPID::GetDualLinkChannel ( void  ) const

virtual

Definition at line 448 of file ntv2vpid.cpp.

GetImageAspect16x9()

bool CNTV2VPID::GetImageAspect16x9 ( void  ) const

virtual

Definition at line 386 of file ntv2vpid.cpp.

GetInfo()

AJALabelValuePairs & CNTV2VPID::GetInfo ( AJALabelValuePairs &  outInfo ) const

virtual

Definition at line 1386 of file ntv2vpid.cpp.

GetLuminance()

NTV2VPIDLuminance CNTV2VPID::GetLuminance ( void  ) const

virtual

Definition at line 533 of file ntv2vpid.cpp.

GetPictureRate()

VPIDPictureRate CNTV2VPID::GetPictureRate ( void  ) const

virtual

Definition at line 359 of file ntv2vpid.cpp.

GetProgressivePicture()

bool CNTV2VPID::GetProgressivePicture ( void  ) const

virtual

Definition at line 346 of file ntv2vpid.cpp.

GetProgressiveTransport()

bool CNTV2VPID::GetProgressiveTransport ( void  ) const

virtual

Definition at line 332 of file ntv2vpid.cpp.

GetRGBRange()

NTV2VPIDRGBRange CNTV2VPID::GetRGBRange ( void  ) const

virtual

Definition at line 561 of file ntv2vpid.cpp.

GetSampling()

VPIDSampling CNTV2VPID::GetSampling ( void  ) const

virtual

Definition at line 409 of file ntv2vpid.cpp.

GetStandard()

VPIDStandard CNTV2VPID::GetStandard ( void  ) const

virtual

Definition at line 318 of file ntv2vpid.cpp.

GetTransferCharacteristics()

NTV2VPIDXferChars CNTV2VPID::GetTransferCharacteristics ( void  ) const

virtual

Definition at line 475 of file ntv2vpid.cpp.

GetVersion()

VPIDVersion CNTV2VPID::GetVersion ( void  ) const

virtual

Definition at line 304 of file ntv2vpid.cpp.

GetVideoFormat()

NTV2VideoFormat CNTV2VPID::GetVideoFormat ( void  ) const

virtual

Definition at line 674 of file ntv2vpid.cpp.

IsRGBSampling()

bool CNTV2VPID::IsRGBSampling ( void  ) const

virtual

Definition at line 414 of file ntv2vpid.cpp.

IsStandard3Ga()

bool CNTV2VPID::IsStandard3Ga ( void  ) const

virtual

Definition at line 250 of file ntv2vpid.cpp.

IsStandardMultiLink4320()

bool CNTV2VPID::IsStandardMultiLink4320 ( void  ) const

virtual

Definition at line 266 of file ntv2vpid.cpp.

IsStandardTwoSampleInterleave()

bool CNTV2VPID::IsStandardTwoSampleInterleave ( void  ) const

virtual

Definition at line 281 of file ntv2vpid.cpp.

LinkString()

const string CNTV2VPID::LinkString ( const VPIDLink  link )

static

Definition at line 991 of file ntv2vpid.cpp.

MakeInvalid()

virtual CNTV2VPID& CNTV2VPID::MakeInvalid ( void  )

inlinevirtual

Definition at line 102 of file ntv2vpid.h.

operator=()

CNTV2VPID & CNTV2VPID::operator= ( const CNTV2VPID &  inRHS )

virtual

Definition at line 220 of file ntv2vpid.cpp.

PictureRateString()

const string CNTV2VPID::PictureRateString ( const VPIDPictureRate  rate )

static

Definition at line 898 of file ntv2vpid.cpp.

Print()

ostream & CNTV2VPID::Print ( std::ostream &  ostrm ) const

virtual

Definition at line 1338 of file ntv2vpid.cpp.

PrintPretty()

ostream & CNTV2VPID::PrintPretty ( std::ostream &  ostrm ) const

virtual

Definition at line 1361 of file ntv2vpid.cpp.

SamplingString()

const string CNTV2VPID::SamplingString ( const VPIDSampling  sample )

static

Definition at line 923 of file ntv2vpid.cpp.

SetBitDepth()

CNTV2VPID & CNTV2VPID::SetBitDepth ( const VPIDBitDepth  inBitDepth )

virtual

Definition at line 454 of file ntv2vpid.cpp.

SetChannel()

CNTV2VPID & CNTV2VPID::SetChannel ( const VPIDChannel  inChannel )

virtual

Definition at line 426 of file ntv2vpid.cpp.

SetColorimetry()

CNTV2VPID & CNTV2VPID::SetColorimetry ( const NTV2VPIDColorimetry  inColorimetry )

virtual

Definition at line 480 of file ntv2vpid.cpp.

SetDualLinkChannel()

CNTV2VPID & CNTV2VPID::SetDualLinkChannel ( const VPIDChannel  inChannel )

virtual

Definition at line 440 of file ntv2vpid.cpp.

SetImageAspect16x9()

CNTV2VPID & CNTV2VPID::SetImageAspect16x9 ( const bool  inIs16x9Aspect )

virtual

Definition at line 365 of file ntv2vpid.cpp.

SetLuminance()

CNTV2VPID & CNTV2VPID::SetLuminance ( const NTV2VPIDLuminance  inLuminance )

virtual

Definition at line 525 of file ntv2vpid.cpp.

SetPictureRate()

CNTV2VPID & CNTV2VPID::SetPictureRate ( const VPIDPictureRate  inPictureRate )

virtual

Definition at line 352 of file ntv2vpid.cpp.

SetProgressivePicture()

CNTV2VPID & CNTV2VPID::SetProgressivePicture ( const bool  inIsProgressivePicture )

virtual

Definition at line 338 of file ntv2vpid.cpp.

SetProgressiveTransport()

CNTV2VPID & CNTV2VPID::SetProgressiveTransport ( const bool  inIsProgressiveTransport )

virtual

Definition at line 324 of file ntv2vpid.cpp.

SetRGBRange()

CNTV2VPID & CNTV2VPID::SetRGBRange ( const NTV2VPIDRGBRange  inRGBRange )

virtual

Definition at line 538 of file ntv2vpid.cpp.

SetSampling()

CNTV2VPID & CNTV2VPID::SetSampling ( const VPIDSampling  inSampling )

virtual

Definition at line 401 of file ntv2vpid.cpp.

SetStandard()

CNTV2VPID & CNTV2VPID::SetStandard ( const VPIDStandard  inStandard )

virtual

Definition at line 310 of file ntv2vpid.cpp.

SetTransferCharacteristics()

CNTV2VPID & CNTV2VPID::SetTransferCharacteristics ( const NTV2VPIDXferChars  inXferChars )

virtual

Definition at line 467 of file ntv2vpid.cpp.

SetVersion()

CNTV2VPID & CNTV2VPID::SetVersion ( const VPIDVersion  inVersion )

virtual

Definition at line 296 of file ntv2vpid.cpp.

SetVPID() [1/3]

bool CNTV2VPID::SetVPID ( const NTV2VideoFormat  inOutputFormat, const bool  inIsDualLink, const bool  inIs48BitRGBFormat, const bool  inIsOutput3Gb, const bool  inIsSMPTE425, const VPIDChannel  inVPIDhannel  )

virtual

Definition at line 239 of file ntv2vpid.cpp.

SetVPID() [2/3]

bool CNTV2VPID::SetVPID ( const NTV2VideoFormat  inVideoFormat, const NTV2FrameBufferFormat  inFrameBufferFormat, const bool  inIsProgressive, const bool  inIs16x9Aspect, const VPIDChannel  inVPIDChannel  )

virtual

Definition at line 229 of file ntv2vpid.cpp.

SetVPID() [3/3]

virtual CNTV2VPID& CNTV2VPID::SetVPID ( const ULWord  inData )

inlinevirtual

Definition at line 71 of file ntv2vpid.h.

SetVPIDData() [1/2]

bool CNTV2VPID::SetVPIDData ( ULWord &  outVPID, const NTV2VideoFormat  inOutputFormat, const bool  inIsDualLinkRGB, const bool  inIsRGB48Bit, const bool  inIsOutput3Gb, const bool  inIsSMPTE425, const VPIDChannel  inVPIDChannel, const bool  inUseVPIDChannel = true, const bool  inOutputIs6G = false, const bool  inOutputIs12G = false, const NTV2VPIDXferChars  inXferChars = NTV2_VPID_TC_SDR_TV, const NTV2VPIDColorimetry  inColorimetry = NTV2_VPID_Color_Rec709, const NTV2VPIDLuminance  inLuminance = NTV2_VPID_Luminance_YCbCr, const NTV2VPIDRGBRange  inRGBRange = NTV2_VPID_Range_Narrow  )

static

Definition at line 631 of file ntv2vpid.cpp.

SetVPIDData() [2/2]

bool CNTV2VPID::SetVPIDData ( ULWord &  outVPID, const NTV2VideoFormat  inOutputFormat, const NTV2FrameBufferFormat  inFrameBufferFormat, const bool  inIsProgressive, const bool  inIs16x9Aspect, const VPIDChannel  inVPIDChannel, const bool  inUseVPIDChannel = true  )

static

Definition at line 578 of file ntv2vpid.cpp.

StandardString()

const string CNTV2VPID::StandardString ( const VPIDStandard  std )

static

Definition at line 842 of file ntv2vpid.cpp.

VersionString()

const string CNTV2VPID::VersionString ( const VPIDVersion  version )

static

Definition at line 831 of file ntv2vpid.cpp.

VPIDStandardIsDualLink()

bool CNTV2VPID::VPIDStandardIsDualLink ( const VPIDStandard  inStd )

static

Definition at line 1149 of file ntv2vpid.cpp.

VPIDStandardIsOctLink()

bool CNTV2VPID::VPIDStandardIsOctLink ( const VPIDStandard  inStd )

static

Definition at line 1263 of file ntv2vpid.cpp.

VPIDStandardIsQuadLink()

bool CNTV2VPID::VPIDStandardIsQuadLink ( const VPIDStandard  inStd )

static

Definition at line 1206 of file ntv2vpid.cpp.

VPIDStandardIsSingleLink()

bool CNTV2VPID::VPIDStandardIsSingleLink ( const VPIDStandard  inStd )

static

Definition at line 1092 of file ntv2vpid.cpp.

VPIDStandardToString()

const string CNTV2VPID::VPIDStandardToString ( const VPIDStandard  inStd )

static

Definition at line 1034 of file ntv2vpid.cpp.

VPIDVersionToString()

const string CNTV2VPID::VPIDVersionToString ( const VPIDVersion  inVers )

static

Definition at line 1021 of file ntv2vpid.cpp.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2vpid.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2vpid.cpp