ntv2utils.h File Reference

Declares numerous NTV2 utility functions. More...

#include "ajaexport.h"
#include "ajatypes.h"
#include "ntv2enums.h"
#include "ntv2videodefines.h"
#include "ntv2publicinterface.h"
#include "ntv2formatdescriptor.h"
#include "ntv2m31enums.h"
#include <string>
#include <iostream>
#include <vector>

Include dependency graph for ntv2utils.h:

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

Go to the source code of this file.

Classes
struct	NTV2SmpteLineNumber
	Used to describe Start of Active Video (SAV) location and field dominance for a given NTV2Standard. (See GetSmpteLineNumber function.) More...
class	NTV2ACFrameRange
	AutoCirculate Frame Range. More...

Macros
#define	Enum2Str(e)   {e, #e},
#define	DEFAULT_PATT_GAIN   0.9
#define	HD_NUMCOMPONENTPIXELS_2K   2048
#define	HD_NUMCOMPONENTPIXELS_1080_2K   2048
#define	HD_NUMCOMPONENTPIXELS_1080   1920
#define	CCIR601_10BIT_BLACK   64
#define	CCIR601_10BIT_WHITE   940
#define	CCIR601_10BIT_CHROMAOFFSET   512
#define	CCIR601_8BIT_BLACK   16
#define	CCIR601_8BIT_WHITE   235
#define	CCIR601_8BIT_CHROMAOFFSET   128
#define	FRAME_0_BASE   (0x0)
#define	FRAME_1080_10BIT_LINEPITCH   (1280*4)
#define	FRAME_1080_8BIT_LINEPITCH   (1920*2)
#define	FRAME_QUADHD_10BIT_SIZE   (FRAME_1080_10BIT_LINEPITCH*2160)
#define	FRAME_QUADHD_8BIT_SIZE   (FRAME_1080_8BIT_LINEPITCH*2160)
#define	FRAME_BASE(__frameNum__, __frameSize__)   ((__frameNum__)*(__frameSize__))
#define	GetHdmiV2StandardFromVideoFormat(__vf__)   ::GetNTV2StandardFromVideoFormat (__vf__)
#define	GetTCIndexesForSDIInput   GetTCIndexesForSDIConnector
#define	NTV2ChannelToCaptureCrosspoint   NTV2ChannelToInputCrosspoint
#define	NTV2ChannelToIngestCrosspoint   NTV2ChannelToInputCrosspoint
#define	NTV2ChannelToInputChannelSpec   NTV2ChannelToInputCrosspoint
#define	NTV2ChannelToPlayoutCrosspoint   NTV2ChannelToOutputCrosspoint
#define	NTV2ChannelToOutputChannelSpec   NTV2ChannelToOutputCrosspoint
#define	NTV2CrosspointIDToString   NTV2OutputCrosspointIDToString

Typedefs
typedef struct NTV2SmpteLineNumber	NTV2SmpteLineNumber
	Used to describe Start of Active Video (SAV) location and field dominance for a given NTV2Standard. (See GetSmpteLineNumber function.) More...
typedef std::vector< NTV2DeviceID >	NTV2DeviceIDList
	An ordered list of NTV2DeviceIDs. More...
typedef NTV2DeviceIDList::iterator	NTV2DeviceIDListIter
	A convenient non-const iterator for NTV2DeviceIDList. More...
typedef NTV2DeviceIDList::const_iterator	NTV2DeviceIDListConstIter
	A convenient const iterator for NTV2DeviceIDList. More...
typedef std::set< NTV2DeviceID >	NTV2DeviceIDSet
	A set of NTV2DeviceIDs. More...
typedef NTV2DeviceIDSet::iterator	NTV2DeviceIDSetIter
	A convenient non-const iterator for NTV2DeviceIDSet. More...
typedef NTV2DeviceIDSet::const_iterator	NTV2DeviceIDSetConstIter
	A convenient const iterator for NTV2DeviceIDSet. More...
typedef std::vector< NTV2OutputCrosspointID >	NTV2OutputCrosspointIDs
	An ordered sequence of NTV2OutputCrosspointID values. More...
typedef NTV2OutputCrosspointIDs::iterator	NTV2OutputCrosspointIDsIter
	A convenient non-const iterator for NTV2OutputCrosspointIDs. More...
typedef NTV2OutputCrosspointIDs::const_iterator	NTV2OutputCrosspointIDsConstIter
	A convenient const iterator for NTV2OutputCrosspointIDs. More...
typedef std::vector< NTV2InputCrosspointID >	NTV2InputCrosspointIDs
	An ordered sequence of NTV2InputCrosspointID values. More...
typedef NTV2InputCrosspointIDs::iterator	NTV2InputCrosspointIDsIter
	A convenient non-const iterator for NTV2InputCrosspointIDs. More...
typedef NTV2InputCrosspointIDs::const_iterator	NTV2InputCrosspointIDsConstIter
	A convenient const iterator for NTV2InputCrosspointIDs. More...
typedef std::vector< std::string >	NTV2StringList
typedef NTV2StringList::iterator	NTV2StringListIter
typedef NTV2StringList::const_iterator	NTV2StringListConstIter
typedef std::set< std::string >	NTV2StringSet
typedef NTV2StringSet::const_iterator	NTV2StringSetConstIter

Functions
uint32_t	CalcRowBytesForFormat (const NTV2FrameBufferFormat inPF, const uint32_t pixWidth)
void	UnPack10BitYCbCrBuffer (uint32_t *packedBuffer, uint16_t *ycbcrBuffer, uint32_t numPixels)
void	PackTo10BitYCbCrBuffer (const uint16_t *ycbcrBuffer, uint32_t *packedBuffer, const uint32_t numPixels)
void	MakeUnPacked10BitYCbCrBuffer (uint16_t *buffer, uint16_t Y, uint16_t Cb, uint16_t Cr, uint32_t numPixels)
void	ConvertLineTo8BitYCbCr (const uint16_t *ycbcr10BitBuffer, uint8_t *ycbcr8BitBuffer, const uint32_t numPixels)
void	ConvertUnpacked10BitYCbCrToPixelFormat (uint16_t *unPackedBuffer, uint32_t *packedBuffer, uint32_t numPixels, NTV2FrameBufferFormat pixelFormat, bool bUseSmpteRange=false, bool bAlphaFromLuma=false)
void	MaskUnPacked10BitYCbCrBuffer (uint16_t *ycbcrUnPackedBuffer, uint16_t signalMask, uint32_t numPixels)
void	StackQuadrants (uint8_t *pSrc, uint32_t srcWidth, uint32_t srcHeight, uint32_t srcRowBytes, uint8_t *pDst)
void	CopyFromQuadrant (uint8_t *srcBuffer, uint32_t srcHeight, uint32_t srcRowBytes, uint32_t srcQuadrant, uint8_t *dstBuffer, uint32_t quad13Offset=0)
void	CopyToQuadrant (uint8_t *srcBuffer, uint32_t srcHeight, uint32_t srcRowBytes, uint32_t dstQuadrant, uint8_t *dstBuffer, uint32_t quad13Offset=0)
bool	UnpackLine_10BitYUVtoUWordSequence (const void *pIn10BitYUVLine, UWordSequence &out16BitYUVLine, ULWord inNumPixels)
	Unpacks a line of NTV2_FBF_10BIT_YCBCR video into 16-bit-per-component YUV data. More...
bool	PackLine_UWordSequenceTo10BitYUV (const UWordSequence &in16BitYUVLine, ULWord *pOut10BitYUVLine, const ULWord inNumPixels)
	Packs a line of 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) video into 10-bit-per-component YCbCr data. More...
bool	YUVComponentsTo10BitYUVPackedBuffer (const std::vector< uint16_t > &inYCbCrLine, NTV2Buffer &inFrameBuffer, const NTV2FormatDescriptor &inDescriptor, const UWord inLineOffset)
	Packs up to one raster line of uint16_t YUV components into an NTV2_FBF_10BIT_YCBCR frame buffer. More...
bool	UnpackLine_10BitYUVtoU16s (std::vector< uint16_t > &outYCbCrLine, const NTV2Buffer &inFrameBuffer, const NTV2FormatDescriptor &inDescriptor, const UWord inLineOffset)
	Unpacks up to one raster line of an NTV2_FBF_10BIT_YCBCR frame buffer into an array of uint16_t values containing the 10-bit YUV data. More...
void	UnpackLine_10BitYUVto16BitYUV (const ULWord *pIn10BitYUVLine, UWord *pOut16BitYUVLine, const ULWord inNumPixels)
	Unpacks a line of 10-bit-per-component YCbCr video into 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) data. More...
void	PackLine_16BitYUVto10BitYUV (const UWord *pIn16BitYUVLine, ULWord *pOut10BitYUVLine, const ULWord inNumPixels)
	Packs a line of 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) video into 10-bit-per-component YCbCr data. More...
void	RePackLineDataForYCbCrDPX (ULWord *packedycbcrLine, ULWord numULWords)
void	UnPack10BitDPXtoRGBAlpha10BitPixel (RGBAlpha10BitPixel *rgba10BitBuffer, const ULWord *DPXLinebuffer, ULWord numPixels, bool bigEndian)
void	UnPack10BitDPXtoForRP215withEndianSwap (UWord *rawrp215Buffer, ULWord *DPXLinebuffer, ULWord numPixels)
void	UnPack10BitDPXtoForRP215 (UWord *rawrp215Buffer, ULWord *DPXLinebuffer, ULWord numPixels)
void	MaskYCbCrLine (UWord *ycbcrLine, UWord signalMask, ULWord numPixels)
void	Make10BitBlackLine (UWord *pOutLineData, const ULWord inNumPixels=1920)
	Writes a line of unpacked, legal SMPTE 10-bit Y/C black values into the given buffer. More...
void	Make10BitWhiteLine (UWord *pOutLineData, const ULWord inNumPixels=1920)
	Writes a line of unpacked, legal SMPTE 10-bit Y/C white values into the given buffer. More...
bool	Fill10BitYCbCrVideoFrame (void *pBaseVideoAddress, const NTV2Standard inStandard, const NTV2FrameBufferFormat inPixelFormat, const YCbCr10BitPixel inPixelColor, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
void	Make8BitBlackLine (UByte *lineData, ULWord numPixels=1920, NTV2FrameBufferFormat=NTV2_FBF_8BIT_YCBCR)
void	Make8BitWhiteLine (UByte *lineData, ULWord numPixels=1920, NTV2FrameBufferFormat=NTV2_FBF_8BIT_YCBCR)
void	Make10BitLine (UWord *lineData, const UWord Y, const UWord Cb, const UWord Cr, const ULWord numPixels=1920)
void	Make8BitLine (UByte *lineData, UByte Y, UByte Cb, UByte Cr, ULWord numPixels=1920, NTV2FrameBufferFormat=NTV2_FBF_8BIT_YCBCR)
bool	Fill8BitYCbCrVideoFrame (void *pBaseVideoAddress, const NTV2Standard inStandard, const NTV2FrameBufferFormat inFBF, const YCbCrPixel inPixelColor, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
void	Fill4k8BitYCbCrVideoFrame (PULWord _baseVideoAddress, NTV2FrameBufferFormat frameBufferFormat, YCbCrPixel color, bool vancEnabled=false, bool b4k=false, bool wideVANC=false)
void	CopyRGBAImageToFrame (ULWord *pSrcBuffer, ULWord srcHeight, ULWord srcWidth, ULWord *pDstBuffer, ULWord dstHeight, ULWord dstWidth)
bool	SetRasterLinesBlack (const NTV2PixelFormat inPixelFormat, UByte *pDstBuffer, const ULWord inDstBytesPerLine, const UWord inDstTotalLines)
	Sets all or part of a destination raster image to legal black. More...
bool	SetRasterLinesWhite (const NTV2PixelFormat inPixelFormat, UByte *pDstBuffer, const ULWord inDstBytesPerLine, const UWord inDstTotalLines)
	Sets all or part of a destination raster image to legal white. More...
bool	CopyRaster (const NTV2PixelFormat inPixelFormat, UByte *pDstBuffer, const ULWord inDstBytesPerLine, const UWord inDstTotalLines, const UWord inDstVertLineOffset, const UWord inDstHorzPixelOffset, const UByte *pSrcBuffer, const ULWord inSrcBytesPerLine, const UWord inSrcTotalLines, const UWord inSrcVertLineOffset, const UWord inSrcVertLinesToCopy, const UWord inSrcHorzPixelOffset, const UWord inSrcHorzPixelsToCopy)
	Copies all or part of a source raster image into a destination raster at a given position. More...
NTV2Standard	GetNTV2StandardFromScanGeometry (const UByte inScanGeometry, const bool inIsProgressiveTransport)
NTV2VideoFormat	GetSupportedNTV2VideoFormatFromInputVideoFormat (const NTV2VideoFormat inVideoFormat)
NTV2Standard	GetNTV2StandardFromVideoFormat (const NTV2VideoFormat inVideoFormat)
NTV2FrameGeometry	GetNTV2FrameGeometryFromVideoFormat (const NTV2VideoFormat inVideoFormat)
ULWord	GetVideoActiveSize (const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inFBFormat, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
ULWord	GetVideoWriteSize (const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inFBFormat, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
	Identical to the GetVideoActiveSize function, except rounds the result up to the nearest 4K page size multiple. More...
NTV2VideoFormat	GetQuarterSizedVideoFormat (const NTV2VideoFormat inVideoFormat)
NTV2VideoFormat	GetQuadSizedVideoFormat (const NTV2VideoFormat inVideoFormat, const bool isSquareDivision=true)
NTV2FrameGeometry	GetQuarterSizedGeometry (const NTV2FrameGeometry inGeometry)
NTV2FrameGeometry	Get4xSizedGeometry (const NTV2FrameGeometry inGeometry)
NTV2Standard	GetQuarterSizedStandard (const NTV2Standard inGeometry)
NTV2Standard	Get4xSizedStandard (const NTV2Standard inGeometry, const bool bIs4k=false)
double	GetFramesPerSecond (const NTV2FrameRate inFrameRate)
double	GetFrameTime (const NTV2FrameRate inFrameRate)
NTV2VideoFormat	GetFirstMatchingVideoFormat (const NTV2FrameRate inFrameRate, const UWord inHeightLines, const UWord inWidthPixels, const bool inIsInterlaced, const bool inIsLevelB, const bool inIsPSF)
bool	GetFramesPerSecond (const NTV2FrameRate inFrameRate, ULWord &outFractionNumerator, ULWord &outFractionDenominator)
	Answers with the given frame rate, in frames per second, as two components: the numerator and denominator of the fractional rate. More...
bool	NTV2DeviceCanDoFormat (const NTV2DeviceID inDevID, const NTV2FrameRate inFR, const NTV2FrameGeometry inFG, const NTV2Standard inStd)
ULWord	GetAudioSamplesPerFrame (const NTV2FrameRate inFrameRate, const NTV2AudioRate inAudioRate, ULWord inCadenceFrame=0, bool inIsSMPTE372Enabled=false)
	Returns the number of audio samples for a given video frame rate, audio sample rate, and frame number. This is useful since AJA devices use fixed audio sample rates (typically 48KHz), and some video frame rates will necessarily result in some frames having more audio samples than others. More...
LWord64	GetTotalAudioSamplesFromFrameNbrZeroUpToFrameNbr (NTV2FrameRate frameRate, NTV2AudioRate audioRate, ULWord frameNbrNonInclusive)
double	GetAudioSamplesPerSecond (const NTV2AudioRate inAudioRate)
	Returns the audio sample rate as a number of audio samples per second. More...
ULWord	GetVaricamRepeatCount (const NTV2FrameRate inSequenceRate, const NTV2FrameRate inPlayRate, const ULWord inCadenceFrame=0)
ULWord	GetScaleFromFrameRate (const NTV2FrameRate inFrameRate)
NTV2FrameRate	GetFrameRateFromScale (long scale, long duration, NTV2FrameRate playFrameRate)
NTV2FrameRate	GetNTV2FrameRateFromNumeratorDenominator (const ULWord inNumerator, const ULWord inDenominator)
NTV2FrameRate	GetNTV2FrameRateFromVideoFormat (const NTV2VideoFormat inVideoFormat)
NTV2FrameGeometry	GetNormalizedFrameGeometry (const NTV2FrameGeometry inFrameGeometry)
NTV2FrameGeometry	GetVANCFrameGeometry (const NTV2FrameGeometry inFrameGeometry, const NTV2VANCMode inVancMode)
NTV2FrameGeometry	GetGeometryFromFrameDimensions (const NTV2FrameDimensions &inFD)
bool	HasVANCGeometries (const NTV2FrameGeometry inFrameGeometry)
NTV2GeometrySet	GetRelatedGeometries (const NTV2FrameGeometry inFrameGeometry)
NTV2VANCMode	GetVANCModeForGeometry (const NTV2FrameGeometry inFrameGeometry)
ULWord	GetNTV2FrameGeometryWidth (const NTV2FrameGeometry inFrameGeometry)
ULWord	GetNTV2FrameGeometryHeight (const NTV2FrameGeometry inFrameGeometry)
NTV2FrameGeometry	GetGeometryFromStandard (const NTV2Standard inStandard)
NTV2Standard	GetStandardFromGeometry (const NTV2FrameGeometry inGeometry, const bool inIsProgressive=true)
ULWord	GetDisplayWidth (const NTV2VideoFormat videoFormat)
ULWord	GetDisplayHeight (const NTV2VideoFormat videoFormat)
NTV2ConversionMode	GetConversionMode (const NTV2VideoFormat inFormat, const NTV2VideoFormat outFormat)
NTV2VideoFormat	GetInputForConversionMode (const NTV2ConversionMode conversionMode)
NTV2VideoFormat	GetOutputForConversionMode (const NTV2ConversionMode conversionMode)
NTV2Channel	GetNTV2ChannelForIndex (const ULWord inIndex0)
ULWord	GetIndexForNTV2Channel (const NTV2Channel inChannel)
NTV2Crosspoint	GetNTV2CrosspointChannelForIndex (const ULWord inIndex0)
ULWord	GetIndexForNTV2CrosspointChannel (const NTV2Crosspoint inChannel)
NTV2Crosspoint	GetNTV2CrosspointInputForIndex (const ULWord inIndex0)
ULWord	GetIndexForNTV2CrosspointInput (const NTV2Crosspoint inChannel)
NTV2Crosspoint	GetNTV2CrosspointForIndex (const ULWord inIndex0)
ULWord	GetIndexForNTV2Crosspoint (const NTV2Crosspoint inChannel)
bool	IsNTV2CrosspointInput (const NTV2Crosspoint inChannel)
bool	IsNTV2CrosspointOutput (const NTV2Crosspoint inChannel)
std::string	NTV2CrosspointToString (const NTV2Crosspoint inChannel)
NTV2Channel	NTV2CrosspointToNTV2Channel (const NTV2Crosspoint inCrosspointChannel)
NTV2Crosspoint	NTV2ChannelToInputCrosspoint (const NTV2Channel inChannel)
NTV2Crosspoint	NTV2ChannelToOutputCrosspoint (const NTV2Channel inChannel)
NTV2InputSource	GetNTV2HDMIInputSourceForIndex (const ULWord inIndex0)
NTV2VideoFormat	GetTransportCompatibleFormat (const NTV2VideoFormat inFormat, const NTV2VideoFormat inTargetFormat)
bool	IsTransportCompatibleFormat (const NTV2VideoFormat inFormat1, const NTV2VideoFormat inFormat2)
NTV2InputSource	GetNTV2InputSourceForIndex (const ULWord inIndex0, const NTV2IOKinds inKinds=NTV2_IOKINDS_SDI)
ULWord	GetIndexForNTV2InputSource (const NTV2InputSource inValue)
INTERRUPT_ENUMS	NTV2ChannelToInputInterrupt (const NTV2Channel inChannel)
	Converts the given NTV2Channel value into the equivalent input INTERRUPT_ENUMS value. More...
INTERRUPT_ENUMS	NTV2ChannelToOutputInterrupt (const NTV2Channel inChannel)
	Converts the given NTV2Channel value into the equivalent output INTERRUPT_ENUMS value. More...
NTV2TCIndex	NTV2ChannelToTimecodeIndex (const NTV2Channel inChannel, const bool inEmbeddedLTC=false, const bool inIsF2=false)
	Converts the given NTV2Channel value into the equivalent NTV2TCIndex value. More...
NTV2TCIndexes	GetTCIndexesForSDIConnector (const NTV2Channel inSDIConnector)
NTV2Channel	NTV2TimecodeIndexToChannel (const NTV2TCIndex inTCIndex)
	Converts the given NTV2TCIndex value into the appropriate NTV2Channel value. More...
NTV2InputSource	NTV2TimecodeIndexToInputSource (const NTV2TCIndex inTCIndex)
	Converts the given NTV2TCIndex value into the appropriate NTV2InputSource value. More...
ULWord	NTV2FramesizeToByteCount (const NTV2Framesize inFrameSize)
	Converts the given NTV2Framesize value into an exact byte count. More...
ULWord	NTV2AudioBufferSizeToByteCount (const NTV2AudioBufferSize inBufferSize)
	Converts the given NTV2BufferSize value into its exact byte count. More...
NTV2EmbeddedAudioInput	NTV2ChannelToEmbeddedAudioInput (const NTV2Channel inChannel)
	Converts the given NTV2Channel value into its equivalent NTV2EmbeddedAudioInput. More...
NTV2EmbeddedAudioInput	NTV2InputSourceToEmbeddedAudioInput (const NTV2InputSource inInputSource)
	Converts a given NTV2InputSource to its equivalent NTV2EmbeddedAudioInput value. More...
NTV2AudioSource	NTV2InputSourceToAudioSource (const NTV2InputSource inInputSource)
NTV2Crosspoint	NTV2InputSourceToChannelSpec (const NTV2InputSource inInputSource)
	Converts a given NTV2InputSource to its equivalent NTV2Crosspoint value. More...
NTV2Channel	NTV2InputSourceToChannel (const NTV2InputSource inInputSource)
	Converts a given NTV2InputSource to its equivalent NTV2Channel value. More...
NTV2ReferenceSource	NTV2InputSourceToReferenceSource (const NTV2InputSource inInputSource)
	Converts a given NTV2InputSource to its equivalent NTV2ReferenceSource value. More...
NTV2AudioSystem	NTV2InputSourceToAudioSystem (const NTV2InputSource inInputSource)
	Converts a given NTV2InputSource to its equivalent NTV2AudioSystem value. More...
NTV2TimecodeIndex	NTV2InputSourceToTimecodeIndex (const NTV2InputSource inInputSource, const bool inEmbeddedLTC=false)
	Converts a given NTV2InputSource to its equivalent NTV2TimecodeIndex value. More...
NTV2AudioSystem	NTV2ChannelToAudioSystem (const NTV2Channel inChannel)
	Converts the given NTV2Channel value into its equivalent NTV2AudioSystem. More...
NTV2InputSource	NTV2ChannelToInputSource (const NTV2Channel inChannel, const NTV2IOKinds inKinds=NTV2_IOKINDS_SDI)
NTV2Channel	NTV2OutputDestinationToChannel (const NTV2OutputDestination inOutputDest)
	Converts a given NTV2OutputDestination to its equivalent NTV2Channel value. More...
NTV2OutputDestination	NTV2ChannelToOutputDestination (const NTV2Channel inChannel)
	Converts the given NTV2Channel value into its ordinary equivalent NTV2OutputDestination. More...
NTV2FrameRate	GetFrameRateFamily (const NTV2FrameRate inFrameRate)
bool	IsMultiFormatCompatible (const NTV2FrameRate inFrameRate1, const NTV2FrameRate inFrameRate2)
	Compares two frame rates and returns true if they are "compatible" (with respect to a multiformat-capable device). More...
bool	IsMultiFormatCompatible (const NTV2VideoFormat inFormat1, const NTV2VideoFormat inFormat2)
	Compares two video formats and returns true if they are "compatible" (with respect to a multiformat-capable device). More...
bool	IsPSF (const NTV2VideoFormat format)
bool	IsProgressivePicture (const NTV2VideoFormat format)
bool	IsProgressiveTransport (const NTV2VideoFormat format)
bool	IsProgressiveTransport (const NTV2Standard format)
bool	IsRGBFormat (const NTV2FrameBufferFormat format)
bool	IsYCbCrFormat (const NTV2FrameBufferFormat format)
bool	IsAlphaChannelFormat (const NTV2FrameBufferFormat format)
bool	Is2KFormat (const NTV2VideoFormat format)
bool	Is4KFormat (const NTV2VideoFormat format)
bool	Is8KFormat (const NTV2VideoFormat format)
bool	IsRaw (const NTV2FrameBufferFormat format)
bool	Is8BitFrameBufferFormat (const NTV2FrameBufferFormat fbFormat)
bool	IsVideoFormatA (const NTV2VideoFormat format)
bool	IsVideoFormatB (const NTV2VideoFormat format)
bool	IsVideoFormatJ2KSupported (const NTV2VideoFormat format)
int	RecordCopyAudio (PULWord pAja, PULWord pSR, int iStartSample, int iNumBytes, int iChan0, int iNumChans, bool bKeepAudio24Bits)
bool	AddAudioTone (ULWord &outNumBytesWritten, NTV2Buffer &inAudioBuffer, ULWord &inOutCurrentSample, const ULWord inNumSamples, const double inSampleRate, const double inAmplitude, const double inFrequency, const ULWord inNumBits, const bool inByteSwap, const ULWord inNumChannels)
	Fills the given buffer with 32-bit (ULWord) audio tone samples. More...
ULWord	AddAudioTone (ULWord *pAudioBuffer, ULWord &inOutCurrentSample, const ULWord inNumSamples, const double inSampleRate, const double inAmplitude, const double inFrequency, const ULWord inNumBits, const bool inByteSwap, const ULWord inNumChannels)
	Fills the given buffer with 32-bit (ULWord) audio tone samples. More...
ULWord	AddAudioTone (ULWord *pAudioBuffer, ULWord &inOutCurrentSample, const ULWord inNumSamples, const double inSampleRate, const double *pInAmplitudes, const double *pInFrequencies, const ULWord inNumBits, const bool inByteSwap, const ULWord inNumChannels)
	Fills the given buffer with 32-bit (ULWord) audio tone samples with a different frequency in each audio channel. More...
ULWord	AddAudioTone (UWord *pAudioBuffer, ULWord &inOutCurrentSample, const ULWord inNumSamples, const double inSampleRate, const double inAmplitude, const double inFrequency, const ULWord inNumBits, const bool inByteSwap, const ULWord inNumChannels)
	Fills the given buffer with 16-bit (UWord) audio tone samples. More...
ULWord	AddAudioTestPattern (ULWord *pAudioBuffer, ULWord &inOutCurrentSample, const ULWord inNumSamples, const ULWord inModulus, const bool inEndianConvert, const ULWord inNumChannels)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2FrameDimensions inFrameDimensions)
	Writes the given NTV2FrameDimensions to the specified output stream. More...
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2SmpteLineNumber &inSmpteLineNumber)
	Writes the given NTV2SmpteLineNumber to the specified output stream. More...
NTV2SmpteLineNumber	GetSmpteLineNumber (const NTV2Standard inStandard)
	For the given video standard, returns the SMPTE-designated line numbers for Field 1 and Field 2 that correspond to the start-of-active-video (SAV). More...
std::ostream &	operator<< (std::ostream &inOutStr, const NTV2DeviceIDList &inSet)
	Handy ostream writer for NTV2DeviceIDList. More...
NTV2DeviceIDSet	NTV2GetSupportedDevices (const NTV2DeviceKinds inKinds=NTV2_DEVICEKIND_ALL)
	Returns an NTV2DeviceIDSet of devices supported by the SDK. More...
std::ostream &	operator<< (std::ostream &inOutStr, const NTV2DeviceIDSet &inSet)
	Handy ostream writer for NTV2DeviceIDSet. More...
UWord	NTV2GetSDKVersionComponent (const int inVersionComponent=0)
	Returns an SDK version component value. More...
std::ostream &	operator<< (std::ostream &inOutStr, const NTV2OutputCrosspointIDs &inList)
	Handy ostream writer for NTV2OutputCrosspointIDs. More...
std::string	NTV2DeviceIDToString (const NTV2DeviceID inValue, const bool inForRetailDisplay=false)
std::string	NTV2VideoFormatToString (const NTV2VideoFormat inValue, const bool inUseFrameRate=false)
std::string	NTV2StandardToString (const NTV2Standard inValue, const bool inForRetailDisplay=false)
std::string	NTV2FrameBufferFormatToString (const NTV2FrameBufferFormat inValue, const bool inForRetailDisplay=false)
std::string	NTV2M31VideoPresetToString (const M31VideoPreset inValue, const bool inForRetailDisplay=false)
std::string	NTV2FrameGeometryToString (const NTV2FrameGeometry inValue, const bool inForRetailDisplay=false)
std::string	NTV2FrameRateToString (const NTV2FrameRate inValue, const bool inForRetailDisplay=false)
std::string	NTV2InputSourceToString (const NTV2InputSource inValue, const bool inForRetailDisplay=false)
std::string	NTV2OutputDestinationToString (const NTV2OutputDestination inValue, const bool inForRetailDisplay=false)
std::string	NTV2ReferenceSourceToString (const NTV2ReferenceSource inValue, const bool inForRetailDisplay=false)
std::string	NTV2RegisterWriteModeToString (const NTV2RegisterWriteMode inValue, const bool inForRetailDisplay=false)
std::string	NTV2InterruptEnumToString (const INTERRUPT_ENUMS inInterruptEnumValue)
std::string	NTV2IpErrorEnumToString (const NTV2IpError inIpErrorEnumValue)
std::string	NTV2ChannelToString (const NTV2Channel inValue, const bool inForRetailDisplay=false)
std::string	NTV2AudioSystemToString (const NTV2AudioSystem inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioRateToString (const NTV2AudioRate inValue, const bool inForRetailDisplay=false)
std::string	NTV2AudioBufferSizeToString (const NTV2AudioBufferSize inValue, const bool inForRetailDisplay=false)
std::string	NTV2AudioLoopBackToString (const NTV2AudioLoopBack inValue, const bool inForRetailDisplay=false)
std::string	NTV2EmbeddedAudioClockToString (const NTV2EmbeddedAudioClock inValue, const bool inForRetailDisplay=false)
std::string	NTV2GetBitfileName (const NTV2DeviceID inValue, const bool useOemNameOnWindows=false)
bool	NTV2IsCompatibleBitfileName (const std::string &inBitfileName, const NTV2DeviceID inDeviceID)
NTV2DeviceID	NTV2GetDeviceIDFromBitfileName (const std::string &inBitfileName)
std::string	NTV2GetFirmwareFolderPath (void)
std::ostream &	operator<< (std::ostream &inOutStream, const RP188_STRUCT &inObj)
std::string	NTV2GetVersionString (const bool inDetailed=false)
std::string	NTV2RegisterNumberToString (const NTV2RegisterNumber inValue)
std::string	AutoCircVidProcModeToString (const AutoCircVidProcMode inValue, const bool inCompactDisplay=false)
std::string	NTV2ColorCorrectionModeToString (const NTV2ColorCorrectionMode inValue, const bool inCompactDisplay=false)
std::string	NTV2InputCrosspointIDToString (const NTV2InputCrosspointID inValue, const bool inForRetailDisplay=false)
std::string	NTV2OutputCrosspointIDToString (const NTV2OutputCrosspointID inValue, const bool inForRetailDisplay=false)
std::string	NTV2WidgetIDToString (const NTV2WidgetID inValue, const bool inCompactDisplay=false)
std::string	NTV2WidgetTypeToString (const NTV2WidgetType inValue, const bool inCompactDisplay=false)
std::string	NTV2TaskModeToString (const NTV2EveryFrameTaskMode inValue, const bool inCompactDisplay=false)
std::string	NTV2RegNumSetToString (const NTV2RegisterNumberSet &inValue)
std::string	NTV2TCIndexToString (const NTV2TCIndex inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioChannelPairToString (const NTV2AudioChannelPair inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioChannelQuadToString (const NTV2Audio4ChannelSelect inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioChannelOctetToString (const NTV2Audio8ChannelSelect inValue, const bool inCompactDisplay=false)
std::string	NTV2FramesizeToString (const NTV2Framesize inValue, const bool inCompactDisplay=false)
std::string	NTV2ModeToString (const NTV2Mode inValue, const bool inCompactDisplay=false)
std::string	NTV2VANCModeToString (const NTV2VANCMode inValue, const bool inCompactDisplay=false)
std::string	NTV2MixerKeyerModeToString (const NTV2MixerKeyerMode inValue, const bool inCompactDisplay=false)
std::string	NTV2MixerInputControlToString (const NTV2MixerKeyerInputControl inValue, const bool inCompactDisplay=false)
std::string	NTV2VideoLimitingToString (const NTV2VideoLimiting inValue, const bool inCompactDisplay=false)
std::string	NTV2BreakoutTypeToString (const NTV2BreakoutType inValue, const bool inCompactDisplay=false)
std::string	NTV2AncDataRgnToStr (const NTV2AncDataRgn inValue, const bool inCompactDisplay=false)
std::string	NTV2UpConvertModeToString (const NTV2UpConvertMode inValue, const bool inCompactDisplay=false)
std::string	NTV2DownConvertModeToString (const NTV2DownConvertMode inValue, const bool inCompactDisplay=false)
std::string	NTV2IsoConvertModeToString (const NTV2IsoConvertMode inValue, const bool inCompactDisplay=false)
std::string	NTV2HDMIBitDepthToString (const NTV2HDMIBitDepth inValue, const bool inCompactDisplay=false)
std::string	NTV2HDMIAudioChannelsToString (const NTV2HDMIAudioChannels inValue, const bool inCompactDisplay=false)
std::string	NTV2HDMIProtocolToString (const NTV2HDMIProtocol inValue, const bool inCompactDisplay=false)
std::string	NTV2HDMIRangeToString (const NTV2HDMIRange inValue, const bool inCompactDisplay=false)
std::string	NTV2HDMIColorSpaceToString (const NTV2HDMIColorSpace inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioFormatToString (const NTV2AudioFormat inValue, const bool inCompactDisplay=false)
std::string	NTV2BitfileTypeToString (const NTV2BitfileType inValue, const bool inCompactDisplay=false)
bool	convertHDRFloatToRegisterValues (const HDRFloatValues &inFloatValues, HDRRegValues &outRegisterValues)
bool	convertHDRRegisterToFloatValues (const HDRRegValues &inRegisterValues, HDRFloatValues &outFloatValues)
void	setHDRDefaultsForBT2020 (HDRRegValues &outRegisterValues)
void	setHDRDefaultsForDCIP3 (HDRRegValues &outRegisterValues)
std::string	NTV2EmbeddedAudioInputToString (const NTV2EmbeddedAudioInput inValue, const bool inCompactDisplay=false)
std::string	NTV2AudioSourceToString (const NTV2AudioSource inValue, const bool inCompactDisplay=false)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2StringList &inData)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2StringSet &inData)
NTV2RegisterReads	FromRegNumSet (const NTV2RegNumSet &inRegNumSet)
NTV2RegNumSet	ToRegNumSet (const NTV2RegisterReads &inRegReads)
bool	GetRegNumChanges (const NTV2RegNumSet &inBefore, const NTV2RegNumSet &inAfter, NTV2RegNumSet &outGone, NTV2RegNumSet &outSame, NTV2RegNumSet &outAdded)
bool	GetChangedRegisters (const NTV2RegisterReads &inBefore, const NTV2RegisterReads &inAfter, NTV2RegNumSet &outChanged)
std::string	PercentEncode (const std::string &inStr)
std::string	PercentDecode (const std::string &inStr)
bool	StringToSerialNum64 (const std::string &inSerNumStr, uint64_t &outSerNum)
std::string	SerialNum64ToString (const uint64_t &inSerNum)
bool	GetInstalledMacDriverVersion (UWord &outMaj, UWord &outMin, UWord &outPt, UWord &outBld, UWord &outType)

Detailed Description

Declares numerous NTV2 utility functions.

Copyright

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

Definition in file ntv2utils.h.

Macro Definition Documentation

CCIR601_10BIT_BLACK

#define CCIR601_10BIT_BLACK   64

Definition at line 34 of file ntv2utils.h.

CCIR601_10BIT_CHROMAOFFSET

#define CCIR601_10BIT_CHROMAOFFSET   512

Definition at line 36 of file ntv2utils.h.

CCIR601_10BIT_WHITE

#define CCIR601_10BIT_WHITE   940

Definition at line 35 of file ntv2utils.h.

CCIR601_8BIT_BLACK

#define CCIR601_8BIT_BLACK   16

Definition at line 38 of file ntv2utils.h.

CCIR601_8BIT_CHROMAOFFSET

#define CCIR601_8BIT_CHROMAOFFSET   128

Definition at line 40 of file ntv2utils.h.

CCIR601_8BIT_WHITE

#define CCIR601_8BIT_WHITE   235

Definition at line 39 of file ntv2utils.h.

DEFAULT_PATT_GAIN

#define DEFAULT_PATT_GAIN   0.9

Definition at line 29 of file ntv2utils.h.

Enum2Str

#define Enum2Str

(

e

)

{e, #e},

Definition at line 25 of file ntv2utils.h.

FRAME_0_BASE

#define FRAME_0_BASE   (0x0)

Definition at line 43 of file ntv2utils.h.

FRAME_1080_10BIT_LINEPITCH

#define FRAME_1080_10BIT_LINEPITCH   (1280*4)

Definition at line 44 of file ntv2utils.h.

FRAME_1080_8BIT_LINEPITCH

#define FRAME_1080_8BIT_LINEPITCH   (1920*2)

Definition at line 45 of file ntv2utils.h.

FRAME_BASE

#define FRAME_BASE	(		__frameNum__,
			__frameSize__
	)		((__frameNum__)*(__frameSize__))

Definition at line 48 of file ntv2utils.h.

FRAME_QUADHD_10BIT_SIZE

#define FRAME_QUADHD_10BIT_SIZE   (FRAME_1080_10BIT_LINEPITCH*2160)

Definition at line 46 of file ntv2utils.h.

FRAME_QUADHD_8BIT_SIZE

#define FRAME_QUADHD_8BIT_SIZE   (FRAME_1080_8BIT_LINEPITCH*2160)

Definition at line 47 of file ntv2utils.h.

GetHdmiV2StandardFromVideoFormat

#define GetHdmiV2StandardFromVideoFormat

(

__vf__

)

::GetNTV2StandardFromVideoFormat (__vf__)

Definition at line 312 of file ntv2utils.h.

GetTCIndexesForSDIInput

#define GetTCIndexesForSDIInput   GetTCIndexesForSDIConnector

Definition at line 587 of file ntv2utils.h.

HD_NUMCOMPONENTPIXELS_1080

#define HD_NUMCOMPONENTPIXELS_1080   1920

Definition at line 32 of file ntv2utils.h.

HD_NUMCOMPONENTPIXELS_1080_2K

#define HD_NUMCOMPONENTPIXELS_1080_2K   2048

Definition at line 31 of file ntv2utils.h.

HD_NUMCOMPONENTPIXELS_2K

#define HD_NUMCOMPONENTPIXELS_2K   2048

Definition at line 30 of file ntv2utils.h.

NTV2ChannelToCaptureCrosspoint

#define NTV2ChannelToCaptureCrosspoint   NTV2ChannelToInputCrosspoint

Definition at line 588 of file ntv2utils.h.

NTV2ChannelToIngestCrosspoint

#define NTV2ChannelToIngestCrosspoint   NTV2ChannelToInputCrosspoint

Definition at line 589 of file ntv2utils.h.

NTV2ChannelToInputChannelSpec

#define NTV2ChannelToInputChannelSpec   NTV2ChannelToInputCrosspoint

Definition at line 590 of file ntv2utils.h.

NTV2ChannelToOutputChannelSpec

#define NTV2ChannelToOutputChannelSpec   NTV2ChannelToOutputCrosspoint

Definition at line 592 of file ntv2utils.h.

NTV2ChannelToPlayoutCrosspoint

#define NTV2ChannelToPlayoutCrosspoint   NTV2ChannelToOutputCrosspoint

Definition at line 591 of file ntv2utils.h.

NTV2CrosspointIDToString

#define NTV2CrosspointIDToString   NTV2OutputCrosspointIDToString

Deprecated:

Use NTV2OutputCrosspointIDToString

Definition at line 1159 of file ntv2utils.h.

Typedef Documentation

NTV2DeviceIDList

typedef std::vector<NTV2DeviceID> NTV2DeviceIDList

An ordered list of NTV2DeviceIDs.

Definition at line 1024 of file ntv2utils.h.

NTV2DeviceIDListConstIter

typedef NTV2DeviceIDList::const_iterator NTV2DeviceIDListConstIter

A convenient const iterator for NTV2DeviceIDList.

Definition at line 1026 of file ntv2utils.h.

NTV2DeviceIDListIter

typedef NTV2DeviceIDList::iterator NTV2DeviceIDListIter

A convenient non-const iterator for NTV2DeviceIDList.

Definition at line 1025 of file ntv2utils.h.

NTV2DeviceIDSet

typedef std::set<NTV2DeviceID> NTV2DeviceIDSet

A set of NTV2DeviceIDs.

Definition at line 1031 of file ntv2utils.h.

NTV2DeviceIDSetConstIter

typedef NTV2DeviceIDSet::const_iterator NTV2DeviceIDSetConstIter

A convenient const iterator for NTV2DeviceIDSet.

Definition at line 1033 of file ntv2utils.h.

NTV2DeviceIDSetIter

typedef NTV2DeviceIDSet::iterator NTV2DeviceIDSetIter

A convenient non-const iterator for NTV2DeviceIDSet.

Definition at line 1032 of file ntv2utils.h.

NTV2InputCrosspointIDs

typedef std::vector<NTV2InputCrosspointID> NTV2InputCrosspointIDs

An ordered sequence of NTV2InputCrosspointID values.

Definition at line 1061 of file ntv2utils.h.

NTV2InputCrosspointIDsConstIter

typedef NTV2InputCrosspointIDs::const_iterator NTV2InputCrosspointIDsConstIter

A convenient const iterator for NTV2InputCrosspointIDs.

Definition at line 1063 of file ntv2utils.h.

NTV2InputCrosspointIDsIter

typedef NTV2InputCrosspointIDs::iterator NTV2InputCrosspointIDsIter

A convenient non-const iterator for NTV2InputCrosspointIDs.

Definition at line 1062 of file ntv2utils.h.

NTV2OutputCrosspointIDs

typedef std::vector<NTV2OutputCrosspointID> NTV2OutputCrosspointIDs

An ordered sequence of NTV2OutputCrosspointID values.

Definition at line 1054 of file ntv2utils.h.

NTV2OutputCrosspointIDsConstIter

typedef NTV2OutputCrosspointIDs::const_iterator NTV2OutputCrosspointIDsConstIter

A convenient const iterator for NTV2OutputCrosspointIDs.

Definition at line 1056 of file ntv2utils.h.

NTV2OutputCrosspointIDsIter

typedef NTV2OutputCrosspointIDs::iterator NTV2OutputCrosspointIDsIter

A convenient non-const iterator for NTV2OutputCrosspointIDs.

Definition at line 1055 of file ntv2utils.h.

NTV2SmpteLineNumber

typedef struct NTV2SmpteLineNumber NTV2SmpteLineNumber

Used to describe Start of Active Video (SAV) location and field dominance for a given NTV2Standard. (See GetSmpteLineNumber function.)

NTV2StringList

typedef std::vector<std::string> NTV2StringList

Definition at line 1134 of file ntv2utils.h.

NTV2StringListConstIter

typedef NTV2StringList::const_iterator NTV2StringListConstIter

Definition at line 1136 of file ntv2utils.h.

NTV2StringListIter

typedef NTV2StringList::iterator NTV2StringListIter

Definition at line 1135 of file ntv2utils.h.

NTV2StringSet

typedef std::set<std::string> NTV2StringSet

Definition at line 1137 of file ntv2utils.h.

NTV2StringSetConstIter

typedef NTV2StringSet::const_iterator NTV2StringSetConstIter

Definition at line 1138 of file ntv2utils.h.

Function Documentation

AddAudioTestPattern()

ULWord AddAudioTestPattern	(	ULWord *	pAudioBuffer,
		ULWord &	inOutCurrentSample,
		const ULWord	inNumSamples,
		const ULWord	inModulus,
		const bool	inEndianConvert,
		const ULWord	inNumChannels
	)

Definition at line 4652 of file ntv2utils.cpp.

AddAudioTone() [1/4]

bool AddAudioTone	(	ULWord &	outNumBytesWritten,
		NTV2Buffer &	inAudioBuffer,
		ULWord &	inOutCurrentSample,
		const ULWord	inNumSamples,
		const double	inSampleRate,
		const double	inAmplitude,
		const double	inFrequency,
		const ULWord	inNumBits,
		const bool	inByteSwap,
		const ULWord	inNumChannels
	)

Fills the given buffer with 32-bit (ULWord) audio tone samples.

Parameters

[out]	outNumBytesWritten	Receives the number of bytes written into the buffer.
[in]	inAudioBuffer	Specifies the buffer to be filled with audio samples. Must be at least 4 x numSamples x numChannels bytes in size.
	inOutCurrentSample	On entry, specifies the sample where waveform generation is to resume. On exit, receives the sample number where waveform generation left off. Zero should be specified for the first invocation of this function.
[in]	inNumSamples	Specifies the number of samples to generate.
[in]	inSampleRate	Specifies the sample rate, in samples per second.
[in]	inAmplitude	Specifies the amplitude of the generated tone.
[in]	inFrequency	Specifies the frequency of the generated tone, in cycles per second (Hertz).
[in]	inNumBits	Specifies the number of bits per sample. Should be between 8 and 32 (inclusive).
[in]	inByteSwap	If true, byte-swaps each 32-bit sample before copying it into the destination buffer.
[in]	inNumChannels	Specifies the number of audio channels to produce.

Returns

True if successful; otherwise false.

Definition at line 4478 of file ntv2utils.cpp.

AddAudioTone() [2/4]

ULWord AddAudioTone	(	ULWord *	pAudioBuffer,
		ULWord &	inOutCurrentSample,
		const ULWord	inNumSamples,
		const double	inSampleRate,
		const double *	pInAmplitudes,
		const double *	pInFrequencies,
		const ULWord	inNumBits,
		const bool	inByteSwap,
		const ULWord	inNumChannels
	)

Fills the given buffer with 32-bit (ULWord) audio tone samples with a different frequency in each audio channel.

Parameters

	pAudioBuffer	If non-NULL, must be a valid pointer to the buffer to be filled with audio samples, and must be at least 4 x numSamples x numChannels bytes in size. Callers may specify NULL to have the function return the required size of the buffer.
	inOutCurrentSample	On entry, specifies the sample where waveform generation is to resume. If audioBuffer is non-NULL, on exit, receives the sample number where waveform generation left off. Callers should specify zero for the first invocation of this function.
[in]	inNumSamples	Specifies the number of samples to generate.
[in]	inSampleRate	Specifies the sample rate, in samples per second.
[in]	pInAmplitudes	A valid, non-NULL pointer to an array of per-channel amplitude values. This array must contain at least "inNumChannels" entries.
[in]	pInFrequencies	A valid, non-NULL pointer to an array of per-channel frequency values, in cycles per second (Hertz). This array must contain at least "inNumChannels" entries.
[in]	inNumBits	Specifies the number of bits per sample. Should be between 8 and 32 (inclusive).
[in]	inByteSwap	If true, byte-swaps each 32-bit sample before copying it into the destination buffer.
[in]	inNumChannels	Specifies the number of audio channels to produce.

Returns

The total number of bytes written into the destination buffer (or if audioBuffer is NULL, the minimum required size of the destination buffer, in bytes).

Definition at line 4604 of file ntv2utils.cpp.

AddAudioTone() [3/4]

ULWord AddAudioTone	(	ULWord *	pAudioBuffer,
		ULWord &	inOutCurrentSample,
		const ULWord	inNumSamples,
		const double	inSampleRate,
		const double	inAmplitude,
		const double	inFrequency,
		const ULWord	inNumBits,
		const bool	inByteSwap,
		const ULWord	inNumChannels
	)

Fills the given buffer with 32-bit (ULWord) audio tone samples.

Parameters

	pAudioBuffer	If non-NULL, must be a valid pointer to the buffer to be filled with audio samples, and must be at least 4 x numSamples x numChannels bytes in size. Callers may specify NULL to have the function return the required size of the buffer.
	inOutCurrentSample	On entry, specifies the sample where waveform generation is to resume. If audioBuffer is non-NULL, on exit, receives the sample number where waveform generation left off. Callers should specify zero for the first invocation of this function.
[in]	inNumSamples	Specifies the number of samples to generate.
[in]	inSampleRate	Specifies the sample rate, in samples per second.
[in]	inAmplitude	Specifies the amplitude of the generated tone.
[in]	inFrequency	Specifies the frequency of the generated tone, in cycles per second (Hertz).
[in]	inNumBits	Specifies the number of bits per sample. Should be between 8 and 32 (inclusive).
[in]	inByteSwap	If true, byte-swaps each 32-bit sample before copying it into the destination buffer.
[in]	inNumChannels	Specifies the number of audio channels to produce.

Returns

The total number of bytes written into the destination buffer (or if audioBuffer is NULL, the minimum required size of the destination buffer, in bytes).

Definition at line 4526 of file ntv2utils.cpp.

AddAudioTone() [4/4]

ULWord AddAudioTone	(	UWord *	pAudioBuffer,
		ULWord &	inOutCurrentSample,
		const ULWord	inNumSamples,
		const double	inSampleRate,
		const double	inAmplitude,
		const double	inFrequency,
		const ULWord	inNumBits,
		const bool	inByteSwap,
		const ULWord	inNumChannels
	)

Fills the given buffer with 16-bit (UWord) audio tone samples.

Parameters

	pAudioBuffer	If non-NULL, must be a valid pointer to the buffer to be filled with audio samples, and must be at least numSamples*2*numChannels bytes in size. Callers may specify NULL to have the function return the required size of the buffer.
	inOutCurrentSample	On entry, specifies the sample where waveform generation is to resume. If audioBuffer is non-NULL, on exit, receives the sample number where waveform generation left off. Callers should specify zero for the first invocation of this function.
[in]	inNumSamples	Specifies the number of samples to generate.
[in]	inSampleRate	Specifies the sample rate, in samples per second.
[in]	inAmplitude	Specifies the amplitude of the generated tone.
[in]	inFrequency	Specifies the frequency of the generated tone, in cycles per second (Hertz).
[in]	inNumBits	Specifies the number of bits per sample. Should be between 8 and 16 (inclusive).
[in]	inByteSwap	If true, byte-swaps each 16-bit sample before copying it into the destination buffer.
[in]	inNumChannels	Specifies the number of audio channels to produce.

Returns

The total number of bytes written into the destination buffer (or if audioBuffer is NULL, the minimum required size of the destination buffer, in bytes).

Definition at line 4565 of file ntv2utils.cpp.

AutoCircVidProcModeToString()

std::string AutoCircVidProcModeToString	(	const AutoCircVidProcMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 7712 of file ntv2utils.cpp.

CalcRowBytesForFormat()

uint32_t CalcRowBytesForFormat	(	const NTV2FrameBufferFormat	inPF,
		const uint32_t	pixWidth
	)

Deprecated:

This function doesn't support planar pixel formats. Use NTV2FormatDescriptor instead.

Definition at line 45 of file ntv2utils.cpp.

convertHDRFloatToRegisterValues()

bool convertHDRFloatToRegisterValues	(	const HDRFloatValues &	inFloatValues,
		HDRRegValues &	outRegisterValues
	)

Definition at line 7816 of file ntv2utils.cpp.

convertHDRRegisterToFloatValues()

bool convertHDRRegisterToFloatValues	(	const HDRRegValues &	inRegisterValues,
		HDRFloatValues &	outFloatValues
	)

Definition at line 7846 of file ntv2utils.cpp.

ConvertLineTo8BitYCbCr()

void ConvertLineTo8BitYCbCr	(	const uint16_t *	ycbcr10BitBuffer,
		uint8_t *	ycbcr8BitBuffer,
		const uint32_t	numPixels
	)

Definition at line 212 of file ntv2utils.cpp.

ConvertUnpacked10BitYCbCrToPixelFormat()

void ConvertUnpacked10BitYCbCrToPixelFormat	(	uint16_t *	unPackedBuffer,
		uint32_t *	packedBuffer,
		uint32_t	numPixels,
		NTV2FrameBufferFormat	pixelFormat,
		bool	bUseSmpteRange = false,
		bool	bAlphaFromLuma = false
	)

Definition at line 223 of file ntv2utils.cpp.

CopyFromQuadrant()

void CopyFromQuadrant	(	uint8_t *	srcBuffer,
		uint32_t	srcHeight,
		uint32_t	srcRowBytes,
		uint32_t	srcQuadrant,
		uint8_t *	dstBuffer,
		uint32_t	quad13Offset = 0
	)

Definition at line 454 of file ntv2utils.cpp.

CopyRaster()

bool CopyRaster	(	const NTV2PixelFormat	inPixelFormat,
		UByte *	pDstBuffer,
		const ULWord	inDstBytesPerLine,
		const UWord	inDstTotalLines,
		const UWord	inDstVertLineOffset,
		const UWord	inDstHorzPixelOffset,
		const UByte *	pSrcBuffer,
		const ULWord	inSrcBytesPerLine,
		const UWord	inSrcTotalLines,
		const UWord	inSrcVertLineOffset,
		const UWord	inSrcVertLinesToCopy,
		const UWord	inSrcHorzPixelOffset,
		const UWord	inSrcHorzPixelsToCopy
	)

Copies all or part of a source raster image into a destination raster at a given position.

Parameters

[in]	inPixelFormat	Specifies the NTV2PixelFormat of both the destination and source buffers. (Note that many pixel formats are not currently supported.)
	pDstBuffer	Specifies the starting address of the destination buffer to be modified. Must be non-NULL.
[in]	inDstBytesPerLine	The number of bytes per raster line of the destination buffer. Note that this value is used to compute the maximum pixel width of the destination raster. Also note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 16, while NTV2_FBF_8BIT_YCBCR requires an even number). Must exceed zero.
[in]	inDstTotalLines	The maximum height of the destination buffer, in raster lines. Must exceed zero.
[in]	inDstVertLineOffset	Specifies the vertical line offset into the destination raster where the top edge of the source image will appear. This value must be less than the inDstTotalLines value (i.e., at least one line of the source must appear in the destination).
[in]	inDstHorzPixelOffset	Specifies the horizontal pixel offset into the destination raster where the left edge of the source image will appear. This value must be less than the maximum width of the destination raster (as stipulated by the inDstBytesPerLine parameter). Thus, at least one pixel of the source (the leftmost edge) must appear in the destination (at the right edge). Note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 6, while NTV2_FBF_8BIT_YCBCR requires this to be even).
[in]	pSrcBuffer	Specifies the starting address of the source buffer to be copied from. Must be non-NULL.
[in]	inSrcBytesPerLine	The number of bytes per raster line of the source buffer. Note that this value is used to compute the maximum pixel width of the source raster. Also note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 16, while NTV2_FBF_8BIT_YCBCR requires this to be even). Must exceed zero.
[in]	inSrcTotalLines	The maximum height of the source buffer, in raster lines. Must exceed zero.
[in]	inSrcVertLineOffset	Specifies the top edge of the source image to copy. This value must be less than the inSrcTotalLines value.
[in]	inSrcVertLinesToCopy	Specifies the height of the source image to copy, in lines. This value can be larger than what's possible. The function guarantees that lines past the bottom edge of the source raster will not be accessed. It is not an error to specify zero, although nothing will be copied.
[in]	inSrcHorzPixelOffset	Specifies the left edge of the source image to copy. This value must be less than the maximum width of the source raster (as stipulated by the inSrcBytesPerLine parameter). Note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 6, while NTV2_FBF_8BIT_YCBCR requires this to be even).
[in]	inSrcHorzPixelsToCopy	Specifies the width of the source image to copy, in pixels. This value can be larger than what's possible. This function will ensure that pixels past the right edge of the source raster will not be accessed. It is not an error to specify zero, although nothing will be copied. Note that some pixel formats set constraints on this value(e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 6, while NTV2_FBF_8BIT_YCBCR requires this to be even).

Returns

True if successful; otherwise false.

Note

The source and destination buffers MUST have the same pixel format.

The source and destination buffers must NOT point to the same buffer.

The use of unsigned values precludes positioning the source raster above the top line of the destination raster, or to the left of the destination raster's left edge. This function will, however, clip the source raster if it overhangs the bottom and/or right edge of the destination raster.

Bug:

This function doesn't work with planar formats.

Needs implementations for NTV2_FBF_10BIT_YCBCRA, NTV2_FBF_10BIT_RGB_PACKED, NTV2_FBF_10BIT_ARGB, NTV2_FBF_16BIT_ARGB.

Definition at line 1642 of file ntv2utils.cpp.

CopyRGBAImageToFrame()

void CopyRGBAImageToFrame	(	ULWord *	pSrcBuffer,
		ULWord	srcHeight,
		ULWord	srcWidth,
		ULWord *	pDstBuffer,
		ULWord	dstHeight,
		ULWord	dstWidth
	)

Definition at line 949 of file ntv2utils.cpp.

CopyToQuadrant()

void CopyToQuadrant	(	uint8_t *	srcBuffer,
		uint32_t	srcHeight,
		uint32_t	srcRowBytes,
		uint32_t	dstQuadrant,
		uint8_t *	dstBuffer,
		uint32_t	quad13Offset = 0
	)

Definition at line 482 of file ntv2utils.cpp.

Fill10BitYCbCrVideoFrame()

bool Fill10BitYCbCrVideoFrame	(	void *	pBaseVideoAddress,
		const NTV2Standard	inStandard,
		const NTV2FrameBufferFormat	inPixelFormat,
		const YCbCr10BitPixel	inPixelColor,
		const NTV2VANCMode	inVancMode = NTV2_VANCMODE_OFF
	)

Returns

True if successful; otherwise false.

Definition at line 805 of file ntv2utils.cpp.

Fill4k8BitYCbCrVideoFrame()

void Fill4k8BitYCbCrVideoFrame	(	PULWord	_baseVideoAddress,
		NTV2FrameBufferFormat	frameBufferFormat,
		YCbCrPixel	color,
		bool	vancEnabled = false,
		bool	b4k = false,
		bool	wideVANC = false
	)

Definition at line 917 of file ntv2utils.cpp.

Fill8BitYCbCrVideoFrame()

bool Fill8BitYCbCrVideoFrame	(	void *	pBaseVideoAddress,
		const NTV2Standard	inStandard,
		const NTV2FrameBufferFormat	inFBF,
		const YCbCrPixel	inPixelColor,
		const NTV2VANCMode	inVancMode = NTV2_VANCMODE_OFF
	)

Definition at line 900 of file ntv2utils.cpp.

FromRegNumSet()

NTV2RegisterReads FromRegNumSet

(

const NTV2RegNumSet &

inRegNumSet

)

Definition at line 7964 of file ntv2utils.cpp.

Get4xSizedGeometry()

NTV2FrameGeometry Get4xSizedGeometry

(

const NTV2FrameGeometry

inGeometry

)

Definition at line 2230 of file ntv2utils.cpp.

Get4xSizedStandard()

NTV2Standard Get4xSizedStandard	(	const NTV2Standard	inGeometry,
		const bool	bIs4k = false
	)

Definition at line 2259 of file ntv2utils.cpp.

GetAudioSamplesPerFrame()

ULWord GetAudioSamplesPerFrame	(	const NTV2FrameRate	inFrameRate,
		const NTV2AudioRate	inAudioRate,
		ULWord	inCadenceFrame = 0,
		bool	inIsSMPTE372Enabled = false
	)

Returns the number of audio samples for a given video frame rate, audio sample rate, and frame number. This is useful since AJA devices use fixed audio sample rates (typically 48KHz), and some video frame rates will necessarily result in some frames having more audio samples than others.

Parameters

[in]	inFrameRate	Specifies the video frame rate.
[in]	inAudioRate	Specifies the audio sample rate. Must be one of NTV2_AUDIO_48K or NTV2_AUDIO_96K.
[in]	inCadenceFrame	Optionally specifies a frame number for maintaining proper cadence in a frame sequence, for those video frame rates that don't accommodate an even number of audio samples. Defaults to zero.
[in]	inIsSMPTE372Enabled	Specifies that 1080p60, 1080p5994 or 1080p50 is being used. In this mode, the device's framerate might be NTV2_FRAMERATE_3000, but since 2 links are coming out, the video rate is effectively NTV2_FRAMERATE_6000. Defaults to false.

Returns

The number of audio samples.

See also

See Correlating Audio Samples to Video Frames

defined(NTV2_DEPRECATE_16_0)

defined(NTV2_DEPRECATE_16_0)

defined(NTV2_DEPRECATE_16_0)

Definition at line 2789 of file ntv2utils.cpp.

GetAudioSamplesPerSecond()

double GetAudioSamplesPerSecond

(

const NTV2AudioRate

inAudioRate

)

Returns the audio sample rate as a number of audio samples per second.

Parameters

[in]

inAudioRate

Specifies the audio sample rate.

Returns

The number of audio samples per second, or zero upon failure.

See also

See Correlating Audio Samples to Video Frames

Definition at line 3203 of file ntv2utils.cpp.

GetChangedRegisters()

bool GetChangedRegisters	(	const NTV2RegisterReads &	inBefore,
		const NTV2RegisterReads &	inAfter,
		NTV2RegNumSet &	outChanged
	)

Definition at line 7989 of file ntv2utils.cpp.

GetConversionMode()

NTV2ConversionMode GetConversionMode	(	const NTV2VideoFormat	inFormat,
		const NTV2VideoFormat	outFormat
	)

Definition at line 5507 of file ntv2utils.cpp.

GetDisplayHeight()

ULWord GetDisplayHeight

(

const NTV2VideoFormat

videoFormat

)

Definition at line 4106 of file ntv2utils.cpp.

GetDisplayWidth()

ULWord GetDisplayWidth

(

const NTV2VideoFormat

videoFormat

)

Definition at line 4098 of file ntv2utils.cpp.

GetFirstMatchingVideoFormat()

NTV2VideoFormat GetFirstMatchingVideoFormat	(	const NTV2FrameRate	inFrameRate,
		const UWord	inHeightLines,
		const UWord	inWidthPixels,
		const bool	inIsInterlaced,
		const bool	inIsLevelB,
		const bool	inIsPSF
	)

Returns

The first NTV2VideoFormat that matches the given frame rate and raster dimensions (and whether it's interlaced or not).

Parameters

[in]	inFrameRate	Specifies the frame rate of interest.
[in]	inHeightLines	Specifies the raster height, in lines of visible video.
[in]	inWidthPixels	Specifies the raster width, in pixels.
[in]	inIsInterlaced	Specify true for interlaced/psf video, or false for progressive.
[in]	inIsLevelB	Specify true for level B, or false for everything else.
[in]	inIsPSF	Specify true for segmented format false for everything else.

Definition at line 1825 of file ntv2utils.cpp.

GetFrameRateFamily()

NTV2FrameRate GetFrameRateFamily

(

const NTV2FrameRate

inFrameRate

)

Returns

The frame rate family that the given NTV2FrameRate belongs to. (This is the NTV2FrameRate of the family having the lowest ordinal value.)

Parameters

[in]

inFrameRate

Specifies the frame rate of interest.

Definition at line 5375 of file ntv2utils.cpp.

GetFrameRateFromScale()

NTV2FrameRate GetFrameRateFromScale	(	long	scale,
		long	duration,
		NTV2FrameRate	playFrameRate
	)

Definition at line 3391 of file ntv2utils.cpp.

GetFramesPerSecond() [1/2]

double GetFramesPerSecond

(

const NTV2FrameRate

inFrameRate

)

defined(NTV2_DEPRECATE_16_0)

Definition at line 1737 of file ntv2utils.cpp.

GetFramesPerSecond() [2/2]

bool GetFramesPerSecond	(	const NTV2FrameRate	inFrameRate,
		ULWord &	outFractionNumerator,
		ULWord &	outFractionDenominator
	)

Answers with the given frame rate, in frames per second, as two components: the numerator and denominator of the fractional rate.

Parameters

[in]	inFrameRate	Specifies the frame rate of interest.
[out]	outFractionNumerator	Receives the numerator of the fractional frame rate. This will be zero if the function returns false.
[out]	outFractionDenominator	Receives the denominator of the fractional frame rate. If the function is successful, this will be either 1000 or 1001. This will be zero if the function returns false.

Returns

True if successful; otherwise false.

Definition at line 1772 of file ntv2utils.cpp.

GetFrameTime()

double GetFrameTime ( const NTV2FrameRate  inFrameRate )

inline

Definition at line 350 of file ntv2utils.h.

GetGeometryFromFrameDimensions()

NTV2FrameGeometry GetGeometryFromFrameDimensions

(

const NTV2FrameDimensions &

inFD

)

Returns

The first matching NTV2FrameGeometry that matches the given NTV2FrameDimensions, or NTV2_FG_INVALID if none match.

Parameters

[in]

inFD

Specifies the NTV2FrameDimensions of interest.

Definition at line 3856 of file ntv2utils.cpp.

GetGeometryFromStandard()

NTV2FrameGeometry GetGeometryFromStandard

(

const NTV2Standard

inStandard

)

Returns

The equivalent normalized (non-VANC) NTV2FrameGeometry value for a given NTV2Standard.

Parameters

[in]

inStandard

Specifies the NTV2Standard to be converted into a normalized NTV2FrameGeometry.

Definition at line 3967 of file ntv2utils.cpp.

GetIndexForNTV2Channel()

ULWord GetIndexForNTV2Channel

(

const NTV2Channel

inChannel

)

Definition at line 4760 of file ntv2utils.cpp.

GetIndexForNTV2Crosspoint()

ULWord GetIndexForNTV2Crosspoint

(

const NTV2Crosspoint

inChannel

)

Definition at line 4882 of file ntv2utils.cpp.

GetIndexForNTV2CrosspointChannel()

ULWord GetIndexForNTV2CrosspointChannel

(

const NTV2Crosspoint

inChannel

)

Definition at line 4810 of file ntv2utils.cpp.

GetIndexForNTV2CrosspointInput()

ULWord GetIndexForNTV2CrosspointInput

(

const NTV2Crosspoint

inChannel

)

Definition at line 4842 of file ntv2utils.cpp.

GetIndexForNTV2InputSource()

ULWord GetIndexForNTV2InputSource

(

const NTV2InputSource

inValue

)

Definition at line 5306 of file ntv2utils.cpp.

GetInputForConversionMode()

NTV2VideoFormat GetInputForConversionMode

(

const NTV2ConversionMode

conversionMode

)

Definition at line 5655 of file ntv2utils.cpp.

GetInstalledMacDriverVersion()

bool GetInstalledMacDriverVersion	(	UWord &	outMaj,
		UWord &	outMin,
		UWord &	outPt,
		UWord &	outBld,
		UWord &	outType
	)

Definition at line 8157 of file ntv2utils.cpp.

GetNormalizedFrameGeometry()

NTV2FrameGeometry GetNormalizedFrameGeometry

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

The equivalent non-VANC NTV2FrameGeometry value for a given NTV2FrameGeometry.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry to be normalized into its non-VANC equivalent.

See also

GetVANCFrameGeometry

Definition at line 3755 of file ntv2utils.cpp.

GetNTV2ChannelForIndex()

NTV2Channel GetNTV2ChannelForIndex

(

const ULWord

inIndex0

)

Definition at line 4755 of file ntv2utils.cpp.

GetNTV2CrosspointChannelForIndex()

NTV2Crosspoint GetNTV2CrosspointChannelForIndex

(

const ULWord

inIndex0

)

Definition at line 4794 of file ntv2utils.cpp.

GetNTV2CrosspointForIndex()

NTV2Crosspoint GetNTV2CrosspointForIndex

(

const ULWord

inIndex0

)

Definition at line 4858 of file ntv2utils.cpp.

GetNTV2CrosspointInputForIndex()

NTV2Crosspoint GetNTV2CrosspointInputForIndex

(

const ULWord

inIndex0

)

Definition at line 4826 of file ntv2utils.cpp.

GetNTV2FrameGeometryFromVideoFormat()

NTV2FrameGeometry GetNTV2FrameGeometryFromVideoFormat

(

const NTV2VideoFormat

inVideoFormat

)

Returns

The NTV2FrameGeometry that corresponds to the given NTV2VideoFormat.

Parameters

[in]

inVideoFormat

Specifies the NTV2VideoFormat of interest.

See also

GetNTV2StandardFromScanGeometry

Definition at line 2545 of file ntv2utils.cpp.

GetNTV2FrameGeometryHeight()

ULWord GetNTV2FrameGeometryHeight

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

The height, in lines, of the given NTV2FrameGeometry.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry of interest.

See also

GetVANCFrameGeometry

Definition at line 4084 of file ntv2utils.cpp.

GetNTV2FrameGeometryWidth()

ULWord GetNTV2FrameGeometryWidth

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

The pixel width of the given NTV2FrameGeometry.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry of interest.

See also

GetVANCFrameGeometry

Definition at line 4090 of file ntv2utils.cpp.

GetNTV2FrameRateFromNumeratorDenominator()

NTV2FrameRate GetNTV2FrameRateFromNumeratorDenominator	(	const ULWord	inNumerator,
		const ULWord	inDenominator
	)

Definition at line 3488 of file ntv2utils.cpp.

GetNTV2FrameRateFromVideoFormat()

NTV2FrameRate GetNTV2FrameRateFromVideoFormat

(

const NTV2VideoFormat

inVideoFormat

)

Returns

The NTV2FrameRate of the given NTV2VideoFormat.

Parameters

[in]

inVideoFormat

Specifies the NTV2VideoFormat of interest.

Note

This function is physical-transport-centric, so "B" formats will answer with the frame rate of a single link. For example, NTV2_FORMAT_1080p_6000_B will result in NTV2_FRAMERATE_3000. See Dual-Link and 3G Overview for more information.

Definition at line 3530 of file ntv2utils.cpp.

GetNTV2HDMIInputSourceForIndex()

NTV2InputSource GetNTV2HDMIInputSourceForIndex

(

const ULWord

inIndex0

)

Definition at line 5300 of file ntv2utils.cpp.

GetNTV2InputSourceForIndex()

NTV2InputSource GetNTV2InputSourceForIndex	(	const ULWord	inIndex0,
		const NTV2IOKinds	inKinds = NTV2_IOKINDS_SDI
	)

Returns

The input source that corresponds to an index value, or NTV2_INPUTSOURCE_INVALID upon failure.

Parameters

[in]	inIndex0	Specifies the unsigned, zero-based integer value to be converted into an equivalent NTV2InputSource.
[in]	inKinds	Optionally specifies the input source type (SDI, HDMI, Analog, etc.) of interest. Defaults to NTV2_INPUTSOURCES_SDI.

Definition at line 5268 of file ntv2utils.cpp.

GetNTV2StandardFromScanGeometry()

NTV2Standard GetNTV2StandardFromScanGeometry	(	const UByte	inScanGeometry,
		const bool	inIsProgressiveTransport
	)

Definition at line 1807 of file ntv2utils.cpp.

GetNTV2StandardFromVideoFormat()

NTV2Standard GetNTV2StandardFromVideoFormat

(

const NTV2VideoFormat

inVideoFormat

)

Returns

The NTV2Standard that corresponds to the given NTV2VideoFormat.

Parameters

[in]

inVideoFormat

Specifies the NTV2VideoFormat of interest.

See also

GetNTV2FrameGeometryFromVideoFormat, GetGeometryFromStandard

Definition at line 2277 of file ntv2utils.cpp.

GetOutputForConversionMode()

NTV2VideoFormat GetOutputForConversionMode

(

const NTV2ConversionMode

conversionMode

)

Definition at line 5699 of file ntv2utils.cpp.

GetQuadSizedVideoFormat()

NTV2VideoFormat GetQuadSizedVideoFormat	(	const NTV2VideoFormat	inVideoFormat,
		const bool	isSquareDivision = true
	)

Definition at line 2032 of file ntv2utils.cpp.

GetQuarterSizedGeometry()

NTV2FrameGeometry GetQuarterSizedGeometry

(

const NTV2FrameGeometry

inGeometry

)

Definition at line 2217 of file ntv2utils.cpp.

GetQuarterSizedStandard()

NTV2Standard GetQuarterSizedStandard

(

const NTV2Standard

inGeometry

)

Definition at line 2242 of file ntv2utils.cpp.

GetQuarterSizedVideoFormat()

NTV2VideoFormat GetQuarterSizedVideoFormat

(

const NTV2VideoFormat

inVideoFormat

)

Definition at line 1844 of file ntv2utils.cpp.

GetRegNumChanges()

bool GetRegNumChanges	(	const NTV2RegNumSet &	inBefore,
		const NTV2RegNumSet &	inAfter,
		NTV2RegNumSet &	outGone,
		NTV2RegNumSet &	outSame,
		NTV2RegNumSet &	outAdded
	)

Definition at line 7980 of file ntv2utils.cpp.

GetRelatedGeometries()

NTV2GeometrySet GetRelatedGeometries

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

An NTV2GeometrySet containing normal, tall and (possibly) taller frame geometries that are associated with the given NTV2FrameGeometry; or an empty set if passed an invalid geometry.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry. (Need not be normalized.)

Note

The resulting set will, at the least, contain the given geometry (if valid).

See also

GetVANCFrameGeometry

Definition at line 3901 of file ntv2utils.cpp.

GetScaleFromFrameRate()

ULWord GetScaleFromFrameRate

(

const NTV2FrameRate

inFrameRate

)

defined(NTV2_DEPRECATE_16_0)

Definition at line 3354 of file ntv2utils.cpp.

GetSmpteLineNumber()

NTV2SmpteLineNumber GetSmpteLineNumber ( const NTV2Standard  inStandard )

inline

For the given video standard, returns the SMPTE-designated line numbers for Field 1 and Field 2 that correspond to the start-of-active-video (SAV).

Parameters

[in]

inStandard

Specifies the video standard of interest.

Returns

The NTV2SmpteLineNumber structure that corresponds to the given video standard.

Definition at line 955 of file ntv2utils.h.

GetStandardFromGeometry()

NTV2Standard GetStandardFromGeometry	(	const NTV2FrameGeometry	inGeometry,
		const bool	inIsProgressive = true
	)

Returns

The equivalent NTV2Standard for the given NTV2FrameGeometry.

Parameters

[in]	inGeometry	Specifies the NTV2FrameGeometry to be converted into a NTV2Standard.
[in]	inIsProgressive	Specifies if the resulting Standard should have a progressive transport or not. Defaults to true.

Definition at line 4003 of file ntv2utils.cpp.

GetSupportedNTV2VideoFormatFromInputVideoFormat()

NTV2VideoFormat GetSupportedNTV2VideoFormatFromInputVideoFormat

(

const NTV2VideoFormat

inVideoFormat

)

Returns

The NTV2VideoFormat that is supported by the device (in frame buffer).

Parameters

[in]

inVideoFormat

Specifies the input NTV2VideoFormat of interest.

Definition at line 2499 of file ntv2utils.cpp.

GetTCIndexesForSDIConnector()

NTV2TCIndexes GetTCIndexesForSDIConnector

(

const NTV2Channel

inSDIConnector

)

Returns

The NTV2TCIndexes that are associated with the given SDI connector.

Parameters

[in]

inSDIConnector

The SDI connector of interest, specified as an NTV2Channel (a zero-based index number).

Definition at line 5028 of file ntv2utils.cpp.

GetTotalAudioSamplesFromFrameNbrZeroUpToFrameNbr()

LWord64 GetTotalAudioSamplesFromFrameNbrZeroUpToFrameNbr	(	NTV2FrameRate	frameRate,
		NTV2AudioRate	audioRate,
		ULWord	frameNbrNonInclusive
	)

defined(NTV2_DEPRECATE_16_0)

defined(NTV2_DEPRECATE_16_0)

Definition at line 3046 of file ntv2utils.cpp.

GetTransportCompatibleFormat()

NTV2VideoFormat GetTransportCompatibleFormat	(	const NTV2VideoFormat	inFormat,
		const NTV2VideoFormat	inTargetFormat
	)

Definition at line 5238 of file ntv2utils.cpp.

GetVANCFrameGeometry()

NTV2FrameGeometry GetVANCFrameGeometry	(	const NTV2FrameGeometry	inFrameGeometry,
		const NTV2VANCMode	inVancMode
	)

Returns

The equivalent VANC NTV2FrameGeometry value for a given NTV2VANCMode.

Parameters

[in]	inFrameGeometry	Specifies the NTV2FrameGeometry to be converted into its VANC equivalent.
[in]	inVancMode	Specifies the desired NTV2VANCMode.

See also

GetNormalizedFrameGeometry

Definition at line 3803 of file ntv2utils.cpp.

GetVANCModeForGeometry()

NTV2VANCMode GetVANCModeForGeometry

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

The equivalent NTV2VANCMode for a given NTV2FrameGeometry.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry.

See also

GetVANCFrameGeometry

Definition at line 3955 of file ntv2utils.cpp.

GetVaricamRepeatCount()

ULWord GetVaricamRepeatCount	(	const NTV2FrameRate	inSequenceRate,
		const NTV2FrameRate	inPlayRate,
		const ULWord	inCadenceFrame = 0
	)

Definition at line 3215 of file ntv2utils.cpp.

GetVideoActiveSize()

ULWord GetVideoActiveSize	(	const NTV2VideoFormat	inVideoFormat,
		const NTV2FrameBufferFormat	inFBFormat,
		const NTV2VANCMode	inVancMode = NTV2_VANCMODE_OFF
	)

Returns

The minimum number of bytes required to store a single frame of video in the given frame buffer format having the given video format, including VANC lines, if any.

Parameters

[in]	inVideoFormat	Specifies the video format.
[in]	inFBFormat	Specifies the frame buffer format.
[in]	inVancMode	Optionally specifies the VANC mode. Defaults to OFF (no VANC lines).

Definition at line 2758 of file ntv2utils.cpp.

GetVideoWriteSize()

ULWord GetVideoWriteSize	(	const NTV2VideoFormat	inVideoFormat,
		const NTV2FrameBufferFormat	inFBFormat,
		const NTV2VANCMode	inVancMode = NTV2_VANCMODE_OFF
	)

Identical to the GetVideoActiveSize function, except rounds the result up to the nearest 4K page size multiple.

Returns

The number of bytes required to store a single frame of video in the given frame buffer format having the given video format, including VANC lines, if any, rounded up to the nearest 4096-byte multiple.

Parameters

[in]	inVideoFormat	Specifies the video format.
[in]	inFBFormat	Specifies the frame buffer format.
[in]	inVancMode	Optionally specifies the VANC mode. Defaults to OFF (no VANC lines).

Historically, this "nearest 4K page size" was necessary to get high-speed I/O bursting to work between the AJA device and the Windows disk system. The file needed to be opened with FILE_FLAG_NO_BUFFERING to bypass the file system cache.

Definition at line 2775 of file ntv2utils.cpp.

HasVANCGeometries()

bool HasVANCGeometries

(

const NTV2FrameGeometry

inFrameGeometry

)

Returns

True if the given NTV2FrameGeometry has tall or taller geometries associated with it; otherwise false.

Parameters

[in]

inFrameGeometry

Specifies the NTV2FrameGeometry.

See also

GetVANCFrameGeometry

Definition at line 3865 of file ntv2utils.cpp.

Is2KFormat()

bool Is2KFormat

(

const NTV2VideoFormat

format

)

Definition at line 5460 of file ntv2utils.cpp.

Is4KFormat()

bool Is4KFormat

(

const NTV2VideoFormat

format

)

Definition at line 5466 of file ntv2utils.cpp.

Is8BitFrameBufferFormat()

bool Is8BitFrameBufferFormat

(

const NTV2FrameBufferFormat

fbFormat

)

Definition at line 5484 of file ntv2utils.cpp.

Is8KFormat()

bool Is8KFormat

(

const NTV2VideoFormat

format

)

Definition at line 5472 of file ntv2utils.cpp.

IsAlphaChannelFormat()

bool IsAlphaChannelFormat

(

const NTV2FrameBufferFormat

format

)

Definition at line 5454 of file ntv2utils.cpp.

IsMultiFormatCompatible() [1/2]

bool IsMultiFormatCompatible	(	const NTV2FrameRate	inFrameRate1,
		const NTV2FrameRate	inFrameRate2
	)

Compares two frame rates and returns true if they are "compatible" (with respect to a multiformat-capable device).

Parameters

[in]	inFrameRate1	Specifies one of the frame rates to be compared.
[in]	inFrameRate2	Specifies another frame rate to be compared.

Definition at line 5389 of file ntv2utils.cpp.

IsMultiFormatCompatible() [2/2]

bool IsMultiFormatCompatible	(	const NTV2VideoFormat	inFormat1,
		const NTV2VideoFormat	inFormat2
	)

Compares two video formats and returns true if they are "compatible" (with respect to a multiformat-capable device).

Parameters

[in]	inFormat1	Specifies one of the video formats to be compared.
[in]	inFormat2	Specifies another video format to be compared.

Definition at line 5408 of file ntv2utils.cpp.

IsNTV2CrosspointInput()

bool IsNTV2CrosspointInput

(

const NTV2Crosspoint

inChannel

)

Definition at line 4907 of file ntv2utils.cpp.

IsNTV2CrosspointOutput()

bool IsNTV2CrosspointOutput

(

const NTV2Crosspoint

inChannel

)

Definition at line 4913 of file ntv2utils.cpp.

IsProgressivePicture()

bool IsProgressivePicture

(

const NTV2VideoFormat

format

)

Definition at line 5423 of file ntv2utils.cpp.

IsProgressiveTransport() [1/2]

bool IsProgressiveTransport

(

const NTV2Standard

format

)

Definition at line 5436 of file ntv2utils.cpp.

IsProgressiveTransport() [2/2]

bool IsProgressiveTransport

(

const NTV2VideoFormat

format

)

Definition at line 5429 of file ntv2utils.cpp.

IsPSF()

bool IsPSF

(

const NTV2VideoFormat

format

)

Definition at line 5417 of file ntv2utils.cpp.

IsRaw()

bool IsRaw

(

const NTV2FrameBufferFormat

format

)

Definition at line 5478 of file ntv2utils.cpp.

IsRGBFormat()

bool IsRGBFormat

(

const NTV2FrameBufferFormat

format

)

Definition at line 5442 of file ntv2utils.cpp.

IsTransportCompatibleFormat()

bool IsTransportCompatibleFormat	(	const NTV2VideoFormat	inFormat1,
		const NTV2VideoFormat	inFormat2
	)

Definition at line 5250 of file ntv2utils.cpp.

IsVideoFormatA()

bool IsVideoFormatA

(

const NTV2VideoFormat

format

)

Definition at line 5490 of file ntv2utils.cpp.

IsVideoFormatB()

bool IsVideoFormatB

(

const NTV2VideoFormat

format

)

Definition at line 5496 of file ntv2utils.cpp.

IsVideoFormatJ2KSupported()

bool IsVideoFormatJ2KSupported

(

const NTV2VideoFormat

format

)

Definition at line 5501 of file ntv2utils.cpp.

IsYCbCrFormat()

bool IsYCbCrFormat

(

const NTV2FrameBufferFormat

format

)

Definition at line 5448 of file ntv2utils.cpp.

Make10BitBlackLine()

void Make10BitBlackLine	(	UWord *	pOutLineData,
		const ULWord	inNumPixels = 1920
	)

Writes a line of unpacked, legal SMPTE 10-bit Y/C black values into the given buffer.

Parameters

[in]	pOutLineData	A valid, non-NULL pointer to the destination UWord buffer.
[in]	inNumPixels	Specifies the width of the line, in pixels. Defaults to 1920.

Warning

This function performs no error checking. Memory corruption will occur if the destination buffer is smaller than 4 x 'inNumPixels' bytes.

Note

This function writes UNPACKED Y/C values. When I return, the destination buffer will NOT contain NTV2_FBF_10BIT_YCBCR-formatted pixel values. Use PackLine_16BitYUVto10BitYUV to convert to NTV2_FBF_10BIT_YCBCR.

Definition at line 766 of file ntv2utils.cpp.

Make10BitLine()

void Make10BitLine	(	UWord *	lineData,
		const UWord	Y,
		const UWord	Cb,
		const UWord	Cr,
		const ULWord	numPixels = 1920
	)

Definition at line 792 of file ntv2utils.cpp.

Make10BitWhiteLine()

void Make10BitWhiteLine	(	UWord *	pOutLineData,
		const ULWord	inNumPixels = 1920
	)

Writes a line of unpacked, legal SMPTE 10-bit Y/C white values into the given buffer.

Parameters

[in]	pOutLineData	A valid, non-NULL pointer to the destination UWord buffer.
[in]	inNumPixels	Specifies the width of the line, in pixels. Defaults to 1920.

Warning

This function performs no error checking. Memory corruption will occur if the destination buffer is smaller than 4 x 'inNumPixels' bytes.

Note

This function writes UNPACKED Y/C values. When I return, the destination buffer will NOT contain NTV2_FBF_10BIT_YCBCR-formatted pixel values. Use PackLine_16BitYUVto10BitYUV to convert to NTV2_FBF_10BIT_YCBCR.

Definition at line 779 of file ntv2utils.cpp.

Make8BitBlackLine()

void Make8BitBlackLine	(	UByte *	lineData,
		ULWord	numPixels = 1920,
		NTV2FrameBufferFormat	= NTV2_FBF_8BIT_YCBCR
	)

Definition at line 828 of file ntv2utils.cpp.

Make8BitLine()

void Make8BitLine	(	UByte *	lineData,
		UByte	Y,
		UByte	Cb,
		UByte	Cr,
		ULWord	numPixels = 1920,
		NTV2FrameBufferFormat	= NTV2_FBF_8BIT_YCBCR
	)

Definition at line 874 of file ntv2utils.cpp.

Make8BitWhiteLine()

void Make8BitWhiteLine	(	UByte *	lineData,
		ULWord	numPixels = 1920,
		NTV2FrameBufferFormat	= NTV2_FBF_8BIT_YCBCR
	)

Definition at line 850 of file ntv2utils.cpp.

MakeUnPacked10BitYCbCrBuffer()

void MakeUnPacked10BitYCbCrBuffer	(	uint16_t *	buffer,
		uint16_t	Y,
		uint16_t	Cb,
		uint16_t	Cr,
		uint32_t	numPixels
	)

Definition at line 197 of file ntv2utils.cpp.

MaskUnPacked10BitYCbCrBuffer()

void MaskUnPacked10BitYCbCrBuffer	(	uint16_t *	ycbcrUnPackedBuffer,
		uint16_t	signalMask,
		uint32_t	numPixels
	)

Definition at line 330 of file ntv2utils.cpp.

MaskYCbCrLine()

void MaskYCbCrLine	(	UWord *	ycbcrLine,
		UWord	signalMask,
		ULWord	numPixels
	)

Definition at line 691 of file ntv2utils.cpp.

NTV2AncDataRgnToStr()

std::string NTV2AncDataRgnToStr	(	const NTV2AncDataRgn	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6593 of file ntv2utils.cpp.

NTV2AudioBufferSizeToByteCount()

ULWord NTV2AudioBufferSizeToByteCount

(

const NTV2AudioBufferSize

inBufferSize

)

Converts the given NTV2BufferSize value into its exact byte count.

Parameters

[in]

inBufferSize

Specifies the NTV2AudioBufferSize to be converted.

Returns

The equivalent number of bytes.

Definition at line 5334 of file ntv2utils.cpp.

NTV2AudioBufferSizeToString()

std::string NTV2AudioBufferSizeToString	(	const NTV2AudioBufferSize	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5801 of file ntv2utils.cpp.

NTV2AudioChannelOctetToString()

std::string NTV2AudioChannelOctetToString	(	const NTV2Audio8ChannelSelect	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6472 of file ntv2utils.cpp.

NTV2AudioChannelPairToString()

std::string NTV2AudioChannelPairToString	(	const NTV2AudioChannelPair	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6450 of file ntv2utils.cpp.

NTV2AudioChannelQuadToString()

std::string NTV2AudioChannelQuadToString	(	const NTV2Audio4ChannelSelect	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6461 of file ntv2utils.cpp.

NTV2AudioFormatToString()

std::string NTV2AudioFormatToString	(	const NTV2AudioFormat	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6706 of file ntv2utils.cpp.

NTV2AudioLoopBackToString()

std::string NTV2AudioLoopBackToString	(	const NTV2AudioLoopBack	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5813 of file ntv2utils.cpp.

NTV2AudioRateToString()

std::string NTV2AudioRateToString	(	const NTV2AudioRate	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5788 of file ntv2utils.cpp.

NTV2AudioSourceToString()

std::string NTV2AudioSourceToString	(	const NTV2AudioSource	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6735 of file ntv2utils.cpp.

NTV2AudioSystemToString()

std::string NTV2AudioSystemToString	(	const NTV2AudioSystem	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 5777 of file ntv2utils.cpp.

NTV2BitfileTypeToString()

std::string NTV2BitfileTypeToString	(	const NTV2BitfileType	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 7739 of file ntv2utils.cpp.

NTV2BreakoutTypeToString()

std::string NTV2BreakoutTypeToString	(	const NTV2BreakoutType	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6574 of file ntv2utils.cpp.

NTV2ChannelToAudioSystem()

NTV2AudioSystem NTV2ChannelToAudioSystem

(

const NTV2Channel

inChannel

)

Converts the given NTV2Channel value into its equivalent NTV2AudioSystem.

Parameters

[in]

inChannel

Specifies the NTV2Channel to be converted.

Returns

The equivalent NTV2AudioSystem value.

Definition at line 4927 of file ntv2utils.cpp.

NTV2ChannelToEmbeddedAudioInput()

NTV2EmbeddedAudioInput NTV2ChannelToEmbeddedAudioInput

(

const NTV2Channel

inChannel

)

Converts the given NTV2Channel value into its equivalent NTV2EmbeddedAudioInput.

Parameters

[in]

inChannel

Specifies the NTV2Channel to be converted.

Returns

The equivalent NTV2EmbeddedAudioInput value.

Definition at line 4919 of file ntv2utils.cpp.

NTV2ChannelToInputCrosspoint()

NTV2Crosspoint NTV2ChannelToInputCrosspoint

(

const NTV2Channel

inChannel

)

Definition at line 4973 of file ntv2utils.cpp.

NTV2ChannelToInputInterrupt()

INTERRUPT_ENUMS NTV2ChannelToInputInterrupt

(

const NTV2Channel

inChannel

)

Converts the given NTV2Channel value into the equivalent input INTERRUPT_ENUMS value.

Parameters

[in]

inChannel

Specifies the NTV2Channel to be converted.

Returns

The equivalent input INTERRUPT_ENUMS value.

Definition at line 4995 of file ntv2utils.cpp.

NTV2ChannelToInputSource()

NTV2InputSource NTV2ChannelToInputSource	(	const NTV2Channel	inChannel,
		const NTV2IOKinds	inKinds = NTV2_IOKINDS_SDI
	)

Parameters

[in]	inChannel	Specifies the NTV2Channel to be converted.
[in]	inKinds	Specifies the type of input source of interest (SDI, HDMI, etc.). Defaults to SDI.

Returns

The NTV2InputSource value that corresponds to the given NTV2Channel value.

Definition at line 5190 of file ntv2utils.cpp.

NTV2ChannelToOutputCrosspoint()

NTV2Crosspoint NTV2ChannelToOutputCrosspoint

(

const NTV2Channel

inChannel

)

Definition at line 4984 of file ntv2utils.cpp.

NTV2ChannelToOutputDestination()

NTV2OutputDestination NTV2ChannelToOutputDestination

(

const NTV2Channel

inChannel

)

Converts the given NTV2Channel value into its ordinary equivalent NTV2OutputDestination.

Parameters

[in]

inChannel

Specifies the NTV2Channel to be converted.

Returns

The equivalent NTV2OutputDestination value.

Definition at line 5225 of file ntv2utils.cpp.

NTV2ChannelToOutputInterrupt()

INTERRUPT_ENUMS NTV2ChannelToOutputInterrupt

(

const NTV2Channel

inChannel

)

Converts the given NTV2Channel value into the equivalent output INTERRUPT_ENUMS value.

Parameters

[in]

inChannel

Specifies the NTV2Channel to be converted.

Returns

The equivalent output INTERRUPT_ENUMS value.

Definition at line 5005 of file ntv2utils.cpp.

NTV2ChannelToString()

std::string NTV2ChannelToString	(	const NTV2Channel	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5759 of file ntv2utils.cpp.

NTV2ChannelToTimecodeIndex()

NTV2TCIndex NTV2ChannelToTimecodeIndex	(	const NTV2Channel	inChannel,
		const bool	inEmbeddedLTC = false,
		const bool	inIsF2 = false
	)

Converts the given NTV2Channel value into the equivalent NTV2TCIndex value.

Parameters

[in]	inChannel	Specifies the NTV2Channel to be converted.
[in]	inEmbeddedLTC	Specify true for embedded LTC. Defaults to false.
[in]	inIsF2	Specify true for VITC2. Defaults to false.

Returns

The equivalent NTV2TCIndex value.

Definition at line 5020 of file ntv2utils.cpp.

NTV2ColorCorrectionModeToString()

std::string NTV2ColorCorrectionModeToString	(	const NTV2ColorCorrectionMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 7726 of file ntv2utils.cpp.

NTV2CrosspointToNTV2Channel()

NTV2Channel NTV2CrosspointToNTV2Channel

(

const NTV2Crosspoint

inCrosspointChannel

)

Definition at line 4766 of file ntv2utils.cpp.

NTV2CrosspointToString()

std::string NTV2CrosspointToString

(

const NTV2Crosspoint

inChannel

)

Definition at line 5837 of file ntv2utils.cpp.

NTV2DeviceCanDoFormat()

bool NTV2DeviceCanDoFormat	(	const NTV2DeviceID	inDevID,
		const NTV2FrameRate	inFR,
		const NTV2FrameGeometry	inFG,
		const NTV2Standard	inStd
	)

Parameters

[in]	inDevID	Specifies the NTV2DeviceID of the device of interest.
[in]	inFR	Specifies the NTV2FrameRate of interest.
[in]	inFG	Specifies the NTV2FrameGeometry of interest.
[in]	inStd	Specifies the NTV2Standard of interest.

Deprecated:

This function is deprecated.

Note

The implementation of this function is very inefficient. Do not call it every frame.

Returns

True if the device having the given NTV2DeviceID supports the given frame rate, geometry and standard.

Definition at line 4057 of file ntv2utils.cpp.

NTV2DeviceIDToString()

std::string NTV2DeviceIDToString	(	const NTV2DeviceID	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 4673 of file ntv2utils.cpp.

NTV2DownConvertModeToString()

std::string NTV2DownConvertModeToString	(	const NTV2DownConvertMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6621 of file ntv2utils.cpp.

NTV2EmbeddedAudioClockToString()

std::string NTV2EmbeddedAudioClockToString	(	const NTV2EmbeddedAudioClock	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5825 of file ntv2utils.cpp.

NTV2EmbeddedAudioInputToString()

std::string NTV2EmbeddedAudioInputToString	(	const NTV2EmbeddedAudioInput	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6717 of file ntv2utils.cpp.

NTV2FrameBufferFormatToString()

std::string NTV2FrameBufferFormatToString	(	const NTV2FrameBufferFormat	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 6940 of file ntv2utils.cpp.

NTV2FrameGeometryToString()

std::string NTV2FrameGeometryToString	(	const NTV2FrameGeometry	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 7154 of file ntv2utils.cpp.

NTV2FrameRateToString()

std::string NTV2FrameRateToString	(	const NTV2FrameRate	inValue,
		const bool	inForRetailDisplay = false
	)

defined(NTV2_DEPRECATE_16_0)

Definition at line 7184 of file ntv2utils.cpp.

NTV2FramesizeToByteCount()

ULWord NTV2FramesizeToByteCount

(

const NTV2Framesize

inFrameSize

)

Converts the given NTV2Framesize value into an exact byte count.

Parameters

[in]

inFrameSize

Specifies the NTV2Framesize to be converted.

Returns

The equivalent number of bytes.

Definition at line 5319 of file ntv2utils.cpp.

NTV2FramesizeToString()

std::string NTV2FramesizeToString	(	const NTV2Framesize	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6483 of file ntv2utils.cpp.

NTV2GetBitfileName()

std::string NTV2GetBitfileName	(	const NTV2DeviceID	inValue,
		const bool	useOemNameOnWindows = false
	)

Definition at line 7405 of file ntv2utils.cpp.

NTV2GetDeviceIDFromBitfileName()

NTV2DeviceID NTV2GetDeviceIDFromBitfileName

(

const std::string &

inBitfileName

)

NTV2GetFirmwareFolderPath()

std::string NTV2GetFirmwareFolderPath

(

void

)

Definition at line 7530 of file ntv2utils.cpp.

NTV2GetSDKVersionComponent()

UWord NTV2GetSDKVersionComponent

(

const int

inVersionComponent = 0

)

Returns an SDK version component value.

Parameters

[in]

inVersionComponent

Optionally specifies which version component to return. Legal values are 0 (major version), 1 (minor version), 2 (point or "dot" version), and 3 (build number). Defaults to 0 (the major version).

Returns

The value of the requested version component, or zero if an invalid version component is specified.

Definition at line 7692 of file ntv2utils.cpp.

NTV2GetSupportedDevices()

NTV2DeviceIDSet NTV2GetSupportedDevices

(

const NTV2DeviceKinds

inKinds = NTV2_DEVICEKIND_ALL

)

Returns an NTV2DeviceIDSet of devices supported by the SDK.

Parameters

[in]

inKinds

Optionally specifies an NTV2DeviceKinds filter. Defaults to NTV2_DEVICEKIND_ALL.

Returns

An NTV2DeviceIDSet of devices supported by the SDK.

Definition at line 7552 of file ntv2utils.cpp.

NTV2GetVersionString()

std::string NTV2GetVersionString

(

const bool

inDetailed = false

)

Definition at line 7680 of file ntv2utils.cpp.

NTV2HDMIAudioChannelsToString()

std::string NTV2HDMIAudioChannelsToString	(	const NTV2HDMIAudioChannels	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6661 of file ntv2utils.cpp.

NTV2HDMIBitDepthToString()

std::string NTV2HDMIBitDepthToString	(	const NTV2HDMIBitDepth	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6649 of file ntv2utils.cpp.

NTV2HDMIColorSpaceToString()

std::string NTV2HDMIColorSpaceToString	(	const NTV2HDMIColorSpace	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6694 of file ntv2utils.cpp.

NTV2HDMIProtocolToString()

std::string NTV2HDMIProtocolToString	(	const NTV2HDMIProtocol	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6672 of file ntv2utils.cpp.

NTV2HDMIRangeToString()

std::string NTV2HDMIRangeToString	(	const NTV2HDMIRange	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6683 of file ntv2utils.cpp.

NTV2InputCrosspointIDToString()

std::string NTV2InputCrosspointIDToString	(	const NTV2InputCrosspointID	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5846 of file ntv2utils.cpp.

NTV2InputSourceToAudioSource()

NTV2AudioSource NTV2InputSourceToAudioSource

(

const NTV2InputSource

inInputSource

)

Parameters

[in]

inInputSource

Specifies the NTV2InputSource.

Returns

The NTV2AudioSource that corresponds to the given NTV2InputSource.

Definition at line 4959 of file ntv2utils.cpp.

NTV2InputSourceToAudioSystem()

NTV2AudioSystem NTV2InputSourceToAudioSystem

(

const NTV2InputSource

inInputSource

)

Converts a given NTV2InputSource to its equivalent NTV2AudioSystem value.

Parameters

[in]

inInputSource

Specifies the NTV2InputSource to be converted.

Returns

The equivalent NTV2AudioSystem value.

Definition at line 5129 of file ntv2utils.cpp.

NTV2InputSourceToChannel()

NTV2Channel NTV2InputSourceToChannel

(

const NTV2InputSource

inInputSource

)

Converts a given NTV2InputSource to its equivalent NTV2Channel value.

Parameters

[in]

inInputSource

Specifies the NTV2InputSource to be converted.

Returns

The equivalent NTV2Channel value.

Definition at line 5105 of file ntv2utils.cpp.

NTV2InputSourceToChannelSpec()

NTV2Crosspoint NTV2InputSourceToChannelSpec

(

const NTV2InputSource

inInputSource

)

Converts a given NTV2InputSource to its equivalent NTV2Crosspoint value.

Parameters

[in]

inInputSource

Specifies the NTV2InputSource to be converted.

Returns

The equivalent NTV2Crosspoint value.

Definition at line 5057 of file ntv2utils.cpp.

NTV2InputSourceToEmbeddedAudioInput()

NTV2EmbeddedAudioInput NTV2InputSourceToEmbeddedAudioInput

(

const NTV2InputSource

inInputSource

)

Converts a given NTV2InputSource to its equivalent NTV2EmbeddedAudioInput value.

Parameters

[in]

inInputSource

Specifies the NTV2InputSource to be converted.

Returns

The equivalent NTV2EmbeddedAudioInput value.

Definition at line 4935 of file ntv2utils.cpp.

NTV2InputSourceToReferenceSource()

NTV2ReferenceSource NTV2InputSourceToReferenceSource

(

const NTV2InputSource

inInputSource

)

Converts a given NTV2InputSource to its equivalent NTV2ReferenceSource value.

Parameters

[in]

inInputSource

Specifies the NTV2InputSource to be converted.

Returns

The equivalent NTV2ReferenceSource value.

Definition at line 5081 of file ntv2utils.cpp.

NTV2InputSourceToString()

std::string NTV2InputSourceToString	(	const NTV2InputSource	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 7215 of file ntv2utils.cpp.

NTV2InputSourceToTimecodeIndex()

NTV2TimecodeIndex NTV2InputSourceToTimecodeIndex	(	const NTV2InputSource	inInputSource,
		const bool	inEmbeddedLTC = false
	)

Converts a given NTV2InputSource to its equivalent NTV2TimecodeIndex value.

Parameters

[in]	inInputSource	Specifies the NTV2InputSource to be converted.
[in]	inEmbeddedLTC	Specify true for embedded ATC LTC. Defaults to false.

Returns

The equivalent NTV2TimecodeIndex value.

Definition at line 5153 of file ntv2utils.cpp.

NTV2InterruptEnumToString()

std::string NTV2InterruptEnumToString

(

const INTERRUPT_ENUMS

inInterruptEnumValue

)

Definition at line 7300 of file ntv2utils.cpp.

NTV2IpErrorEnumToString()

std::string NTV2IpErrorEnumToString

(

const NTV2IpError

inIpErrorEnumValue

)

Definition at line 7350 of file ntv2utils.cpp.

NTV2IsCompatibleBitfileName()

bool NTV2IsCompatibleBitfileName	(	const std::string &	inBitfileName,
		const NTV2DeviceID	inDeviceID
	)

NTV2IsoConvertModeToString()

std::string NTV2IsoConvertModeToString	(	const NTV2IsoConvertMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6634 of file ntv2utils.cpp.

NTV2M31VideoPresetToString()

std::string NTV2M31VideoPresetToString	(	const M31VideoPreset	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 6982 of file ntv2utils.cpp.

NTV2MixerInputControlToString()

std::string NTV2MixerInputControlToString	(	const NTV2MixerKeyerInputControl	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6548 of file ntv2utils.cpp.

NTV2MixerKeyerModeToString()

std::string NTV2MixerKeyerModeToString	(	const NTV2MixerKeyerMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6534 of file ntv2utils.cpp.

NTV2ModeToString()

std::string NTV2ModeToString	(	const NTV2Mode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6509 of file ntv2utils.cpp.

NTV2OutputCrosspointIDToString()

std::string NTV2OutputCrosspointIDToString	(	const NTV2OutputCrosspointID	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 5989 of file ntv2utils.cpp.

NTV2OutputDestinationToChannel()

NTV2Channel NTV2OutputDestinationToChannel

(

const NTV2OutputDestination

inOutputDest

)

Converts a given NTV2OutputDestination to its equivalent NTV2Channel value.

Parameters

[in]

inOutputDest

Specifies the NTV2OutputDestination to be converted.

Returns

The equivalent NTV2Channel value.

Definition at line 5213 of file ntv2utils.cpp.

NTV2OutputDestinationToString()

std::string NTV2OutputDestinationToString	(	const NTV2OutputDestination	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 7238 of file ntv2utils.cpp.

NTV2ReferenceSourceToString()

std::string NTV2ReferenceSourceToString	(	const NTV2ReferenceSource	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 7258 of file ntv2utils.cpp.

NTV2RegisterNumberToString()

std::string NTV2RegisterNumberToString

(

const NTV2RegisterNumber

inValue

)

Definition at line 7706 of file ntv2utils.cpp.

NTV2RegisterWriteModeToString()

std::string NTV2RegisterWriteModeToString	(	const NTV2RegisterWriteMode	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 7287 of file ntv2utils.cpp.

NTV2RegNumSetToString()

std::string NTV2RegNumSetToString

(

const NTV2RegisterNumberSet &

inValue

)

Definition at line 6385 of file ntv2utils.cpp.

NTV2StandardToString()

std::string NTV2StandardToString	(	const NTV2Standard	inValue,
		const bool	inForRetailDisplay = false
	)

Definition at line 6914 of file ntv2utils.cpp.

NTV2TaskModeToString()

std::string NTV2TaskModeToString	(	const NTV2EveryFrameTaskMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6372 of file ntv2utils.cpp.

NTV2TCIndexToString()

std::string NTV2TCIndexToString	(	const NTV2TCIndex	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6413 of file ntv2utils.cpp.

NTV2TimecodeIndexToChannel()

NTV2Channel NTV2TimecodeIndexToChannel

(

const NTV2TCIndex

inTCIndex

)

Converts the given NTV2TCIndex value into the appropriate NTV2Channel value.

Parameters

[in]

inTCIndex

Specifies the NTV2TCIndex to be converted.

Returns

The equivalent NTV2Channel value.

Definition at line 5037 of file ntv2utils.cpp.

NTV2TimecodeIndexToInputSource()

NTV2InputSource NTV2TimecodeIndexToInputSource

(

const NTV2TCIndex

inTCIndex

)

Converts the given NTV2TCIndex value into the appropriate NTV2InputSource value.

Parameters

[in]

inTCIndex

Specifies the NTV2TCIndex to be converted.

Returns

The equivalent NTV2InputSource value.

Definition at line 5046 of file ntv2utils.cpp.

NTV2UpConvertModeToString()

std::string NTV2UpConvertModeToString	(	const NTV2UpConvertMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6607 of file ntv2utils.cpp.

NTV2VANCModeToString()

std::string NTV2VANCModeToString	(	const NTV2VANCMode	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6521 of file ntv2utils.cpp.

NTV2VideoFormatToString()

std::string NTV2VideoFormatToString	(	const NTV2VideoFormat	inValue,
		const bool	inUseFrameRate = false
	)

Definition at line 6750 of file ntv2utils.cpp.

NTV2VideoLimitingToString()

std::string NTV2VideoLimitingToString	(	const NTV2VideoLimiting	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6561 of file ntv2utils.cpp.

NTV2WidgetIDToString()

std::string NTV2WidgetIDToString	(	const NTV2WidgetID	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6194 of file ntv2utils.cpp.

NTV2WidgetTypeToString()

std::string NTV2WidgetTypeToString	(	const NTV2WidgetType	inValue,
		const bool	inCompactDisplay = false
	)

Definition at line 6321 of file ntv2utils.cpp.

operator<<() [1/8]

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

Handy ostream writer for NTV2DeviceIDList.

Definition at line 7665 of file ntv2utils.cpp.

operator<<() [2/8]

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

Handy ostream writer for NTV2DeviceIDSet.

operator<<() [3/8]

std::ostream & operator<<	(	std::ostream &	inOutStr,
		const NTV2OutputCrosspointIDs &	inList
	)

Handy ostream writer for NTV2OutputCrosspointIDs.

operator<<() [4/8]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2FrameDimensions	inFrameDimensions
	)

Writes the given NTV2FrameDimensions to the specified output stream.

Parameters

	inOutStream	Specifies the output stream to receive the human-readable representation of the NTV2FrameDimensions.
[in]	inFrameDimensions	Specifies the NTV2FrameDimensions to print to the output stream.

Returns

A non-constant reference to the specified output stream.

operator<<() [5/8]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2SmpteLineNumber &	inSmpteLineNumber
	)

Writes the given NTV2SmpteLineNumber to the specified output stream.

Parameters

	inOutStream	Specifies the output stream to receive the human-readable representation of the NTV2SmpteLineNumber.
[in]	inSmpteLineNumber	Specifies the NTV2SmpteLineNumber instance to print to the output stream.

Returns

A non-constant reference to the specified output stream.

operator<<() [6/8]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2StringList &	inData
	)

operator<<() [7/8]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2StringSet &	inData
	)

operator<<() [8/8]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const RP188_STRUCT &	inObj
	)

PackLine_16BitYUVto10BitYUV()

void PackLine_16BitYUVto10BitYUV	(	const UWord *	pIn16BitYUVLine,
		ULWord *	pOut10BitYUVLine,
		const ULWord	inNumPixels
	)

Packs a line of 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) video into 10-bit-per-component YCbCr data.

Parameters

[in]	pIn16BitYUVLine	A valid, non-NULL pointer to the input buffer that contains the 16-bit-per-component YUV data to be converted into 10-bit-per-component YUV.
[out]	pOut10BitYUVLine	A valid, non-NULL pointer to the output buffer to receive the packed 10-bit-per-component YUV data.
[in]	inNumPixels	Specifies the width of the line to be converted, in pixels.

Definition at line 527 of file ntv2utils.cpp.

PackLine_UWordSequenceTo10BitYUV()

bool PackLine_UWordSequenceTo10BitYUV	(	const UWordSequence &	in16BitYUVLine,
		ULWord *	pOut10BitYUVLine,
		const ULWord	inNumPixels
	)

Packs a line of 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) video into 10-bit-per-component YCbCr data.

Parameters

[in]	in16BitYUVLine	The UWordSequence that contains the 16-bit-per-component YUV data to be converted into 10-bit-per-component YUV.
[out]	pOut10BitYUVLine	A valid, non-NULL pointer to the output buffer to receive the packed 10-bit-per-component YUV data.
[in]	inNumPixels	Specifies the width of the line to be converted, in pixels.

Returns

True if successful; otherwise false.

Definition at line 544 of file ntv2utils.cpp.

PackTo10BitYCbCrBuffer()

void PackTo10BitYCbCrBuffer	(	const uint16_t *	ycbcrBuffer,
		uint32_t *	packedBuffer,
		const uint32_t	numPixels
	)

Definition at line 184 of file ntv2utils.cpp.

PercentDecode()

std::string PercentDecode

(

const std::string &

inStr

)

Returns

The URL-decoded input string.

PercentEncode()

std::string PercentEncode

(

const std::string &

inStr

)

Returns

The URL-encoded input string.

RecordCopyAudio()

int RecordCopyAudio	(	PULWord	pAja,
		PULWord	pSR,
		int	iStartSample,
		int	iNumBytes,
		int	iChan0,
		int	iNumChans,
		bool	bKeepAudio24Bits
	)

Definition at line 4403 of file ntv2utils.cpp.

RePackLineDataForYCbCrDPX()

void RePackLineDataForYCbCrDPX	(	ULWord *	packedycbcrLine,
		ULWord	numULWords
	)

Definition at line 637 of file ntv2utils.cpp.

SerialNum64ToString()

std::string SerialNum64ToString

(

const uint64_t &

inSerNum

)

Definition at line 8114 of file ntv2utils.cpp.

setHDRDefaultsForBT2020()

void setHDRDefaultsForBT2020

(

HDRRegValues &

outRegisterValues

)

Definition at line 7874 of file ntv2utils.cpp.

setHDRDefaultsForDCIP3()

void setHDRDefaultsForDCIP3

(

HDRRegValues &

outRegisterValues

)

Definition at line 7892 of file ntv2utils.cpp.

SetRasterLinesBlack()

bool SetRasterLinesBlack	(	const NTV2PixelFormat	inPixelFormat,
		UByte *	pDstBuffer,
		const ULWord	inDstBytesPerLine,
		const UWord	inDstTotalLines
	)

Sets all or part of a destination raster image to legal black.

Parameters

[in]	inPixelFormat	Specifies the NTV2PixelFormat of the destination buffer. (Note that many pixel formats are not currently supported.)
	pDstBuffer	Specifies the address of the destination buffer to be modified. Must be non-NULL.
[in]	inDstBytesPerLine	The number of bytes per raster line of the destination buffer. Note that this value is used to compute the maximum pixel width of the destination raster. Also note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 16, while NTV2_FBF_8BIT_YCBCR requires an even number). Must exceed zero.
[in]	inDstTotalLines	The total number of raster lines to set to legal black. Must exceed zero.

Bug:

Need implementations for numerous pixel formats.

Returns

True if successful; otherwise false.

Definition at line 1081 of file ntv2utils.cpp.

SetRasterLinesWhite()

bool SetRasterLinesWhite	(	const NTV2PixelFormat	inPixelFormat,
		UByte *	pDstBuffer,
		const ULWord	inDstBytesPerLine,
		const UWord	inDstTotalLines
	)

Sets all or part of a destination raster image to legal white.

Parameters

[in]	inPixelFormat	Specifies the NTV2PixelFormat of the destination buffer. (Note that many pixel formats are not currently supported.)
	pDstBuffer	Specifies the address of the destination buffer to be modified. Must be non-NULL.
[in]	inDstBytesPerLine	The number of bytes per raster line of the destination buffer. Note that this value is used to compute the maximum pixel width of the destination raster. Also note that some pixel formats set constraints on this value (e.g., NTV2_FBF_10BIT_YCBCR requires this be a multiple of 16, while NTV2_FBF_8BIT_YCBCR requires an even number). Must exceed zero.
[in]	inDstTotalLines	The total number of raster lines to set to legal white. Must exceed zero.

Bug:

Need implementations for numerous pixel formats.

Returns

True if successful; otherwise false.

Definition at line 1141 of file ntv2utils.cpp.

StackQuadrants()

void StackQuadrants	(	uint8_t *	pSrc,
		uint32_t	srcWidth,
		uint32_t	srcHeight,
		uint32_t	srcRowBytes,
		uint8_t *	pDst
	)

Definition at line 413 of file ntv2utils.cpp.

StringToSerialNum64()

bool StringToSerialNum64	(	const std::string &	inSerNumStr,
		uint64_t &	outSerNum
	)

ToRegNumSet()

NTV2RegNumSet ToRegNumSet

(

const NTV2RegisterReads &

inRegReads

)

Definition at line 7972 of file ntv2utils.cpp.

UnPack10BitDPXtoForRP215()

void UnPack10BitDPXtoForRP215	(	UWord *	rawrp215Buffer,
		ULWord *	DPXLinebuffer,
		ULWord	numPixels
	)

Definition at line 679 of file ntv2utils.cpp.

UnPack10BitDPXtoForRP215withEndianSwap()

void UnPack10BitDPXtoForRP215withEndianSwap	(	UWord *	rawrp215Buffer,
		ULWord *	DPXLinebuffer,
		ULWord	numPixels
	)

Definition at line 669 of file ntv2utils.cpp.

UnPack10BitDPXtoRGBAlpha10BitPixel()

void UnPack10BitDPXtoRGBAlpha10BitPixel	(	RGBAlpha10BitPixel *	rgba10BitBuffer,
		const ULWord *	DPXLinebuffer,
		ULWord	numPixels,
		bool	bigEndian
	)

Definition at line 648 of file ntv2utils.cpp.

UnPack10BitYCbCrBuffer()

void UnPack10BitYCbCrBuffer	(	uint32_t *	packedBuffer,
		uint16_t *	ycbcrBuffer,
		uint32_t	numPixels
	)

Definition at line 169 of file ntv2utils.cpp.

UnpackLine_10BitYUVto16BitYUV()

void UnpackLine_10BitYUVto16BitYUV	(	const ULWord *	pIn10BitYUVLine,
		UWord *	pOut16BitYUVLine,
		const ULWord	inNumPixels
	)

Unpacks a line of 10-bit-per-component YCbCr video into 16-bit-per-component YCbCr (NTV2_FBF_10BIT_YCBCR) data.

Parameters

[in]	pIn10BitYUVLine	A valid, non-NULL pointer to the input buffer that contains the packed 10-bit-per-component YUV data to be converted into 16-bit-per-component YUV.
[out]	pOut16BitYUVLine	A valid, non-NULL pointer to the output buffer to receive the unpacked 16-bit-per-component YUV data.
[in]	inNumPixels	Specifies the width of the line to be converted, in pixels.

Definition at line 511 of file ntv2utils.cpp.

UnpackLine_10BitYUVtoU16s()

bool UnpackLine_10BitYUVtoU16s	(	std::vector< uint16_t > &	outYCbCrLine,
		const NTV2Buffer &	inFrameBuffer,
		const NTV2FormatDescriptor &	inDescriptor,
		const UWord	inLineOffset
	)

Unpacks up to one raster line of an NTV2_FBF_10BIT_YCBCR frame buffer into an array of uint16_t values containing the 10-bit YUV data.

Parameters

[out]	outYCbCrLine	The YUV components unpacked from the frame buffer. This will be cleared upon entry, and if successful, will contain at least 12 values upon exit.
	inFrameBuffer	The frame buffer in host memory that is to be read.
[in]	inDescriptor	The NTV2FormatDescriptor that describes the frame buffer.
[in]	inLineOffset	The zero-based line offset into the frame buffer.

Returns

True if successful; otherwise false.

Note

This is a safer version of the UnpackLine_10BitYUVtoUWordSequence function.

UnpackLine_10BitYUVtoUWordSequence()

bool UnpackLine_10BitYUVtoUWordSequence	(	const void *	pIn10BitYUVLine,
		UWordSequence &	out16BitYUVLine,
		ULWord	inNumPixels
	)

Unpacks a line of NTV2_FBF_10BIT_YCBCR video into 16-bit-per-component YUV data.

Parameters

[in]	pIn10BitYUVLine	A valid, non-NULL pointer to the start of the line that contains the NTV2_FBF_10BIT_YCBCR data to be converted.
[out]	out16BitYUVLine	Receives the unpacked 16-bit-per-component YUV data. The sequence is cleared before filling. The UWord sequence will be Cb0, Y0, Cr0, Y1, Cb1, Y2, Cr1, Y3, Cb2, Y4, Cr2, Y5, . . .
[in]	inNumPixels	Specifies the width of the line to be converted, in pixels.

Returns

True if successful; otherwise false.

Definition at line 119 of file ntv2utils.cpp.

YUVComponentsTo10BitYUVPackedBuffer()

bool YUVComponentsTo10BitYUVPackedBuffer	(	const std::vector< uint16_t > &	inYCbCrLine,
		NTV2Buffer &	inFrameBuffer,
		const NTV2FormatDescriptor &	inDescriptor,
		const UWord	inLineOffset
	)

Packs up to one raster line of uint16_t YUV components into an NTV2_FBF_10BIT_YCBCR frame buffer.

Parameters

[in]	inYCbCrLine	The YUV components to be packed into the frame buffer. This must contain at least 12 values.
	inFrameBuffer	The frame buffer in host memory that is to be modified.
[in]	inDescriptor	The NTV2FormatDescriptor that describes the frame buffer.
[in]	inLineOffset	The zero-based line offset into the frame buffer where the packed components will be written.

Returns

True if successful; otherwise false.

Note

Neighboring components in the packed output will be corrupted if input component values exceed 0x3FF.

This is a safer version of the PackLine_UWordSequenceTo10BitYUV function.