Describes a video frame for a given video standard or format and pixel format, including the total number of lines, number of pixels per line, line pitch, and which line contains the start of active video. More...

#include <ntv2formatdescriptor.h>

Public Member Functions
bool	IsSDFormat (void) const

void	MakeInvalid (void)
	defined(NTV2_DEPRECATE_16_3) More...

Constructors
	NTV2FormatDescriptor ()
	My default constructor initializes me in an "invalid" state. More...

	NTV2FormatDescriptor (const ULWord inNumLines, const ULWord inNumPixels, const ULWord inLinePitch, const ULWord in1stActiveLine=0, const UByte inNumLumaBits=0, const UByte inNumChromaBits=0, const UByte inNumAlphaBits=0)
	Construct from line and pixel count, plus line pitch. More...

	NTV2FormatDescriptor (const NTV2Standard inStandard, const NTV2FrameBufferFormat inFrameBufferFormat, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
	Constructs me from the given video standard, pixel format, and VANC settings. More...

	NTV2FormatDescriptor (const NTV2VideoFormat inVideoFormat, const NTV2FrameBufferFormat inFrameBufferFormat, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
	Constructs me from the given video format, pixel format and VANC settings. More...

	NTV2FormatDescriptor (const NTV2FrameSize &inRasterSize, const NTV2PixelFormat inPixelFormat, const NTV2VANCMode inVancMode=NTV2_VANCMODE_OFF)
	Constructs me from the given video format, pixel format and VANC settings. More...

Inquiry
bool	IsValid (void) const

bool	IsVANC (void) const

bool	IsPlanar (void) const

ULWord	GetVerticalSampleRatio (const UWord inPlaneIndex0=0) const

ULWord	GetTotalRasterBytes (const UWord inPlaneIndex0=0) const

ULWord	GetTotalBytes (void) const

ULWord	GetVideoWriteSize (ULWord inPageSize=4096UL) const

ULWord	GetVisibleRasterBytes (const UWord inPlaneIndex0=0) const

ULWord	GetBytesPerRow (const UWord inPlaneIndex0=0) const

ULWord	GetRasterWidth (void) const

UWord	GetNumPlanes (void) const

std::string	PlaneToString (const UWord inPlaneIndex0) const

UWord	ByteOffsetToPlane (const ULWord inByteOffset) const

UWord	ByteOffsetToRasterLine (const ULWord inByteOffset) const

bool	IsAtLineStart (ULWord inByteOffset) const

ULWord	GetRasterHeight (const bool inVisibleOnly=false) const

ULWord	GetFullRasterHeight (void) const

ULWord	GetFirstActiveLine (void) const

ULWord	GetVisibleRasterHeight (void) const

bool	GetRowBuffer (const NTV2Buffer &inFrameBuffer, NTV2Buffer &inOutRowBuffer, const ULWord inRowIndex0, const UWord inPlaneIndex0=0) const
	Answers with an NTV2Buffer that describes the given row (and plane) given the NTV2Buffer that describes the frame buffer. More...

const void *	GetRowAddress (const void *pInStartAddress, const ULWord inRowIndex0, const UWord inPlaneIndex0=0) const

void *	GetWriteableRowAddress (void *pInStartAddress, const ULWord inRowIndex0, const UWord inPlaneIndex0=0) const

ULWord	RasterLineToByteOffset (const ULWord inRowIndex0, const UWord inPlaneIndex0=0) const

UByte *	GetTopVisibleRowAddress (UByte *pInStartAddress) const

bool	GetFirstChangedRow (const void pInStartAddress1, const void pInStartAddress2, ULWord &outFirstChangedRowNum) const
	Compares two buffers line-by-line (using my description of the buffer contents). More...

bool	GetChangedLines (NTV2RasterLineOffsets &outDiffs, const void pInBuffer1, const void pInBuffer2, const ULWord inMaxLines=0) const
	Compares two buffers line-by-line (using my description of the buffer contents). More...

bool	FlipVertically (NTV2Buffer &inFB) const
	Vertically inverts the raster image in the given NTV2Buffer. More...

NTV2FrameSize	GetFullRasterDimensions (void) const

NTV2FrameSize	GetVisibleRasterDimensions (void) const

bool	GetSMPTELineNumber (const ULWord inLineOffset, ULWord &outSMPTELine, bool &outIsField2) const
	Answers with the equivalent SMPTE line number for the given line offset into the frame buffer I describe. More...

bool	GetLineOffsetFromSMPTELine (const ULWord inSMPTELine, ULWord &outLineOffset) const
	Answers with the equivalent line offset into the raster I describe for the given SMPTE line number. More...

NTV2SegmentedXferInfo &	GetSegmentedXferInfo (NTV2SegmentedXferInfo &inSegmentInfo, const bool inIsSource=true) const
	Sets the given NTV2SegmentedXferInfo to match my raster, as a source or destination. More...

bool	operator== (const NTV2FormatDescriptor &inRHS) const

std::ostream &	Print (std::ostream &inOutStream, const bool inDetailed=true) const
	Writes a human-readable description of me into the given output stream. More...

std::ostream &	PrintSMPTELineNumber (std::ostream &inOutStream, const ULWord inLineOffset, const bool inForTextMode=false) const
	Writes the given frame buffer line offset as a formatted SMPTE line number into the given output stream. More...

NTV2Standard	GetVideoStandard (void) const

NTV2VideoFormat	GetVideoFormat (void) const

NTV2FrameBufferFormat	GetPixelFormat (void) const

NTV2VANCMode	GetVANCMode (void) const

bool	IsSD (void) const

bool	IsHD (void) const

bool	IsUHD (void) const

bool	Is4K (void) const

bool	IsUHD2 (void) const

bool	Is8K (void) const

bool	IsQuadRaster (void) const

bool	IsTallVanc (void) const

bool	IsTallerVanc (void) const

NTV2FrameGeometry	GetFrameGeometry (void) const

UByte	GetNumBitsLuma (void) const

UByte	GetNumBitsChroma (void) const

UByte	GetNumBitsAlpha (void) const

bool	HasAlpha (void) const

bool	IsRGB (void) const

bool	Is2KFormat (void) const

Public Attributes
ULWord	numLines
	Height – total number of lines. More...

ULWord	numPixels
	Width – total number of pixels per line. More...

ULWord	linePitch
	Number of 32-bit words per line – shadows mLinePitch[0] / sizeof(ULWord) More...

ULWord	firstActiveLine
	First active line of video (0 if NTV2_VANCMODE_OFF) More...

Friends
class	CNTV2CaptionRenderer

Detailed Description

Describes a video frame for a given video standard or format and pixel format, including the total number of lines, number of pixels per line, line pitch, and which line contains the start of active video.

Note: It is possible to construct a format descriptor that is not supported by the AJA device.

Definition at line 41 of file ntv2formatdescriptor.h.

Constructor & Destructor Documentation

◆ NTV2FormatDescriptor() [1/5]

NTV2FormatDescriptor::NTV2FormatDescriptor ( )

explicit

My default constructor initializes me in an "invalid" state.

My default constructor

Definition at line 903 of file ntv2formatdescriptor.cpp.

◆ NTV2FormatDescriptor() [2/5]

NTV2FormatDescriptor::NTV2FormatDescriptor	(	const ULWord	inNumLines,
		const ULWord	inNumPixels,
		const ULWord	inLinePitch,
		const ULWord	in1stActiveLine = `0`,
		const UByte	inNumLumaBits = `0`,
		const UByte	inNumChromaBits = `0`,
		const UByte	inNumAlphaBits = `0`
	)

explicit

Construct from line and pixel count, plus line pitch.

Parameters

[in]	inNumLines	Specifies the total number of lines.
[in]	inNumPixels	Specifies the total number of pixels.
[in]	inLinePitch	Specifies the line pitch as the number of 32-bit words per line.
[in]	in1stActiveLine	Optionally specifies the first active line of video, where zero is the first (top) line. Defaults to zero.
[in]	inNumLumaBits	Optionally specifies the number of luma bits. Defaults to zero.
[in]	inNumChromaBits	Optionally specifies the number of chroma bits. Defaults to zero.
[in]	inNumAlphaBits	Optionally specifies the number of alpha bits. Defaults to zero.

Definition at line 909 of file ntv2formatdescriptor.cpp.

◆ NTV2FormatDescriptor() [3/5]

NTV2FormatDescriptor::NTV2FormatDescriptor	(	const NTV2Standard	inStandard,
		const NTV2FrameBufferFormat	inFrameBufferFormat,
		const NTV2VANCMode	inVancMode = `NTV2_VANCMODE_OFF`
	)

explicit

Constructs me from the given video standard, pixel format, and VANC settings.

Parameters

[in]	inStandard	Specifies the video standard being used.
[in]	inFrameBufferFormat	Specifies the pixel format of the frame buffer.
[in]	inVancMode	Specifies the VANC mode. Defaults to OFF.

Definition at line 651 of file ntv2formatdescriptor.cpp.

◆ NTV2FormatDescriptor() [4/5]

NTV2FormatDescriptor::NTV2FormatDescriptor	(	const NTV2VideoFormat	inVideoFormat,
		const NTV2FrameBufferFormat	inFrameBufferFormat,
		const NTV2VANCMode	inVancMode = `NTV2_VANCMODE_OFF`
	)

explicit

Constructs me from the given video format, pixel format and VANC settings.

Parameters

[in]	inVideoFormat	Specifies the video format being used.
[in]	inFrameBufferFormat	Specifies the pixel format of the frame buffer.
[in]	inVancMode	Specifies the VANC mode.

Definition at line 756 of file ntv2formatdescriptor.cpp.

◆ NTV2FormatDescriptor() [5/5]

NTV2FormatDescriptor::NTV2FormatDescriptor	(	const NTV2FrameSize &	inRasterSize,
		const NTV2PixelFormat	inPixelFormat,
		const NTV2VANCMode	inVancMode = `NTV2_VANCMODE_OFF`
	)

explicit

Constructs me from the given video format, pixel format and VANC settings.

Parameters

[in]	inRasterSize	Specifies the raster dimensions.
[in]	inPixelFormat	Specifies the pixel format of the frame buffer.
[in]	inVancMode	Specifies the VANC mode. If NTV2_VANCMODE_TALL or NTV2_VANCMODE_TALLER, "inRasterSize" must match a "tall" or "taller" NTV2FrameGeometry.

Note: Invalid or conflicting parameters will construct an invalid descriptor.

Definition at line 811 of file ntv2formatdescriptor.cpp.

Member Function Documentation

◆ ByteOffsetToPlane()

UWord NTV2FormatDescriptor::ByteOffsetToPlane ( const ULWord inByteOffset ) const

Returns: The zero-based index number of the plane that contains the byte at the given offset, or 0xFFFF if the offset is not within any plane in the buffer.

Parameters

[in] inByteOffset The offset, in bytes, to the byte of interest in the frame.

Definition at line 1020 of file ntv2formatdescriptor.cpp.

◆ ByteOffsetToRasterLine()

UWord NTV2FormatDescriptor::ByteOffsetToRasterLine ( const ULWord inByteOffset ) const

Returns: The zero-based index number of the raster line (row) that contains the byte at the given offset, or 0xFFFF if the offset does not fall within any plane or line in the buffer.

Parameters

[in] inByteOffset The offset, in bytes, to the byte of interest in the raster buffer.

Definition at line 1037 of file ntv2formatdescriptor.cpp.

◆ FlipVertically()

bool NTV2FormatDescriptor::FlipVertically ( NTV2Buffer & inFB ) const

Vertically inverts the raster image in the given NTV2Buffer.

Parameters

[in] inFB Specifies the frame buffer containing the image/raster to be flipped (and includes all planes, if planar).

Returns: True if successful; otherwise false.

Definition at line 1202 of file ntv2formatdescriptor.cpp.

◆ GetBytesPerRow()

ULWord NTV2FormatDescriptor::GetBytesPerRow ( const UWord inPlaneIndex0 = 0 ) const

inline

Returns: The number of bytes per row/line of the raster.

Parameters

[in] inPlaneIndex0 Specifies the plane of interest. Defaults to zero.

Definition at line 158 of file ntv2formatdescriptor.h.

◆ GetChangedLines()

bool NTV2FormatDescriptor::GetChangedLines	(	NTV2RasterLineOffsets &	outDiffs,
		const void *	pInBuffer1,
		const void *	pInBuffer2,
		const ULWord	inMaxLines = `0`
	)		const

Compares two buffers line-by-line (using my description of the buffer contents).

Parameters

[out]	outDiffs	Receives the ordered sequence of line offsets of the lines that differed. This will be empty if the two buffers are identical (or if an error occurs).
[in]	pInBuffer1	Specifies the non-NULL address of the first memory buffer whose contents are to be compared.
[in]	pInBuffer2	Specifies the non-NULL address of the second memory buffer whose contents are to be compared.
[in]	inMaxLines	Optionally specifies the maximum number of lines to compare. If zero, all lines are compared. Defaults to zero (all lines).

Returns: True if successful; otherwise false.

Note: The buffers must be large enough to accommodate my video standard/format or else a memory access violation will occur.

Definition at line 1173 of file ntv2formatdescriptor.cpp.

◆ GetFirstActiveLine()

ULWord NTV2FormatDescriptor::GetFirstActiveLine ( void ) const

inline

Returns: The zero-based index number of the first active (visible) line in the raster. This will be zero for non-VANC rasters.

Definition at line 198 of file ntv2formatdescriptor.h.

◆ GetFirstChangedRow()

bool NTV2FormatDescriptor::GetFirstChangedRow	(	const void *	pInStartAddress1,
		const void *	pInStartAddress2,
		ULWord &	outFirstChangedRowNum
	)		const

Compares two buffers line-by-line (using my description of the buffer contents).

Parameters

[in]	pInStartAddress1	A valid, non-NULL pointer to the start of the first raster buffer.
[in]	pInStartAddress2	A valid, non-NULL pointer to the start of the second raster buffer.
[out]	outFirstChangedRowNum	Receives the zero-based row number of the first row that's different, or 0xFFFFFFFF if identical.

Returns: True if successful; otherwise false.

Definition at line 1149 of file ntv2formatdescriptor.cpp.

◆ GetFrameGeometry()

NTV2FrameGeometry NTV2FormatDescriptor::GetFrameGeometry ( void ) const

inline

Returns: The frame geometry I was created with.

Definition at line 352 of file ntv2formatdescriptor.h.

◆ GetFullRasterDimensions()

NTV2FrameSize NTV2FormatDescriptor::GetFullRasterDimensions ( void ) const

Returns: The full-raster NTV2FrameDimensions (including VANC lines, if any).

Definition at line 1374 of file ntv2formatdescriptor.cpp.

◆ GetFullRasterHeight()

ULWord NTV2FormatDescriptor::GetFullRasterHeight ( void ) const

inline

Returns: The full height of the raster, in lines (including VANC, if any).

Definition at line 193 of file ntv2formatdescriptor.h.

◆ GetLineOffsetFromSMPTELine()

bool NTV2FormatDescriptor::GetLineOffsetFromSMPTELine	(	const ULWord	inSMPTELine,
		ULWord &	outLineOffset
	)		const

Answers with the equivalent line offset into the raster I describe for the given SMPTE line number.

Parameters

[in]	inSMPTELine	Specifies the SMPTE line number.
[out]	outLineOffset	Receives the zero-based line offset into the raster I describe.

Returns: True if successful; otherwise false.

Definition at line 1316 of file ntv2formatdescriptor.cpp.

◆ GetNumBitsAlpha()

UByte NTV2FormatDescriptor::GetNumBitsAlpha ( void ) const

inline

Returns: The number of bits per alpha component sample. New in SDK 17.0.

Definition at line 355 of file ntv2formatdescriptor.h.

◆ GetNumBitsChroma()

UByte NTV2FormatDescriptor::GetNumBitsChroma ( void ) const

inline

Returns: The number of bits per chroma component sample. New in SDK 17.0.

Definition at line 354 of file ntv2formatdescriptor.h.

◆ GetNumBitsLuma()

UByte NTV2FormatDescriptor::GetNumBitsLuma ( void ) const

inline

Returns: The number of bits per luminance (Y) component sample. New in SDK 17.0.

Definition at line 353 of file ntv2formatdescriptor.h.

◆ GetNumPlanes()

UWord NTV2FormatDescriptor::GetNumPlanes ( void ) const

inline

Returns: The number of planes in the raster.

Definition at line 161 of file ntv2formatdescriptor.h.

◆ GetPixelFormat()

NTV2FrameBufferFormat NTV2FormatDescriptor::GetPixelFormat ( void ) const

inline

Returns: The pixel format I was created with.

Definition at line 341 of file ntv2formatdescriptor.h.

◆ GetRasterHeight()

ULWord NTV2FormatDescriptor::GetRasterHeight ( const bool inVisibleOnly = false ) const

inline

Returns: The height of the raster, in lines.

Parameters

[in] inVisibleOnly Specify true to return just the visible height; otherwise false (the default) to return the full height.

Definition at line 188 of file ntv2formatdescriptor.h.

◆ GetRasterWidth()

ULWord NTV2FormatDescriptor::GetRasterWidth ( void ) const

inline

Returns: The width of the raster, in pixels.

Definition at line 160 of file ntv2formatdescriptor.h.

◆ GetRowAddress()

const void * NTV2FormatDescriptor::GetRowAddress	(	const void *	pInStartAddress,
		const ULWord	inRowIndex0,
		const UWord	inPlaneIndex0 = `0`
	)		const

Returns: A pointer to the start of the given row in the given buffer, or NULL if row index is bad (using my description of the buffer contents).

Parameters

[in]	pInStartAddress	A pointer to the raster buffer.
[in]	inRowIndex0	Specifies the row of interest in the buffer, where zero is the topmost row.
[in]	inPlaneIndex0	Specifies the plane of interest. Defaults to zero.

Definition at line 1092 of file ntv2formatdescriptor.cpp.

◆ GetRowBuffer()

bool NTV2FormatDescriptor::GetRowBuffer	(	const NTV2Buffer &	inFrameBuffer,
		NTV2Buffer &	inOutRowBuffer,
		const ULWord	inRowIndex0,
		const UWord	inPlaneIndex0 = `0`
	)		const

Answers with an NTV2Buffer that describes the given row (and plane) given the NTV2Buffer that describes the frame buffer.

Parameters

[in]	inFrameBuffer	Specifies the frame buffer (that includes all planes, if planar).
	inOutRowBuffer	Receives the NTV2Buffer that references the row (and plane) in the frame buffer.
[in]	inRowIndex0	Specifies the row of interest in the buffer, where zero is the topmost row.
[in]	inPlaneIndex0	Optionally specifies the plane of interest. Defaults to zero.

Returns: True if successful; otherwise false.

Definition at line 1066 of file ntv2formatdescriptor.cpp.

◆ GetSegmentedXferInfo()

NTV2SegmentedXferInfo & NTV2FormatDescriptor::GetSegmentedXferInfo	(	NTV2SegmentedXferInfo &	inSegmentInfo,
		const bool	inIsSource = `true`
	)		const

Sets the given NTV2SegmentedXferInfo to match my raster, as a source or destination.

Parameters

	inSegmentInfo	Specifies the segmented transfer object to modify.
[in]	inIsSource	Specify 'true' (the default) to set the "source" aspect of the transfer info object; otherwise 'false' to set the "destination" aspect of it.

Returns: A non-const reference to the NTV2SegmentedXferInfo object.

Definition at line 1385 of file ntv2formatdescriptor.cpp.

◆ GetSMPTELineNumber()

bool NTV2FormatDescriptor::GetSMPTELineNumber	(	const ULWord	inLineOffset,
		ULWord &	outSMPTELine,
		bool &	outIsField2
	)		const

Answers with the equivalent SMPTE line number for the given line offset into the frame buffer I describe.

Parameters

[in]	inLineOffset	Specifies the zero-based line offset into the frame buffer that I describe.
[out]	outSMPTELine	Receives the equivalent SMPTE line number.
[out]	outIsField2	Receives true if the line number is associated with Field 2 (interlaced only); otherwise false.

Returns: True if successful; otherwise false.

Definition at line 1284 of file ntv2formatdescriptor.cpp.

◆ GetTopVisibleRowAddress()

UByte* NTV2FormatDescriptor::GetTopVisibleRowAddress ( UByte * pInStartAddress ) const

inline

Returns: A pointer to the start of the first visible row in the given buffer, or NULL if invalid (using my description of the buffer contents).

Parameters

[in] pInStartAddress A pointer to the raster buffer.

Definition at line 248 of file ntv2formatdescriptor.h.

◆ GetTotalBytes()

ULWord NTV2FormatDescriptor::GetTotalBytes ( void ) const

Returns: The total number of bytes required to hold the raster, including any VANC, and all planes of planar formats.

Definition at line 946 of file ntv2formatdescriptor.cpp.

◆ GetTotalRasterBytes()

ULWord NTV2FormatDescriptor::GetTotalRasterBytes ( const UWord inPlaneIndex0 = 0 ) const

inline

Returns: The total number of bytes required to hold the raster plane, including any VANC lines. Returns zero upon error.

Note: To determine the byte count of all planes of a planar format, call GetTotalBytes.

Parameters

[in] inPlaneIndex0 Specifies the plane of interest. Defaults to zero.

Definition at line 132 of file ntv2formatdescriptor.h.

◆ GetVANCMode()

NTV2VANCMode NTV2FormatDescriptor::GetVANCMode ( void ) const

inline

Returns: The VANC mode I was created with.

Definition at line 342 of file ntv2formatdescriptor.h.

◆ GetVerticalSampleRatio()

ULWord NTV2FormatDescriptor::GetVerticalSampleRatio ( const UWord inPlaneIndex0 = 0 ) const

Returns: The number of samples spanned per sample used, usually 1 for most formats. Returns zero if an invalid plane is specified.

Parameters

[in] inPlaneIndex0 Specifies the plane of interest. Defaults to zero.

Note: Used for asymmetric vertical sampling, such as 3-plane 4:2:0 formats, where the returned value is 1 for the Y plane, and 2 for the Cb/Cr planes.

Definition at line 976 of file ntv2formatdescriptor.cpp.

◆ GetVideoFormat()

NTV2VideoFormat NTV2FormatDescriptor::GetVideoFormat ( void ) const

inline

Returns: The video format I was created with.

Definition at line 340 of file ntv2formatdescriptor.h.

◆ GetVideoStandard()

NTV2Standard NTV2FormatDescriptor::GetVideoStandard ( void ) const

inline

Returns: The video standard I was created with.

Definition at line 339 of file ntv2formatdescriptor.h.

◆ GetVideoWriteSize()

ULWord NTV2FormatDescriptor::GetVideoWriteSize ( ULWord inPageSize = 4096UL ) const

Returns: The result of GetTotalBytes rounded up to the nearest page size.

Parameters

[in] inPageSize Optionally specifies the page size to use. Defaults to 4096 (4K) bytes.

Definition at line 957 of file ntv2formatdescriptor.cpp.

◆ GetVisibleRasterBytes()

ULWord NTV2FormatDescriptor::GetVisibleRasterBytes ( const UWord inPlaneIndex0 = 0 ) const

inline

Returns: The total number of bytes required to hold the visible raster (i.e. active lines after any VANC lines).

Parameters

[in] inPlaneIndex0 Specifies the plane of interest. Defaults to zero, the first plane.

Definition at line 152 of file ntv2formatdescriptor.h.

◆ GetVisibleRasterDimensions()

NTV2FrameSize NTV2FormatDescriptor::GetVisibleRasterDimensions ( void ) const

Returns: The visible NTV2FrameDimensions (excluding VANC lines, if any).

Definition at line 1379 of file ntv2formatdescriptor.cpp.

◆ GetVisibleRasterHeight()

ULWord NTV2FormatDescriptor::GetVisibleRasterHeight ( void ) const

inline

Returns: The visible height of the raster, in lines (excluding VANC, if any).

Definition at line 203 of file ntv2formatdescriptor.h.

◆ GetWriteableRowAddress()

void * NTV2FormatDescriptor::GetWriteableRowAddress	(	void *	pInStartAddress,
		const ULWord	inRowIndex0,
		const UWord	inPlaneIndex0 = `0`
	)		const

Returns: A non-const pointer to the start of the given row in the given buffer, or NULL if row index is bad (using my description of the buffer contents).

Parameters

[in]	pInStartAddress	A non-const pointer to the raster buffer.
[in]	inRowIndex0	Specifies the row of interest in the buffer, where zero is the topmost row.
[in]	inPlaneIndex0	Specifies the plane of interest. Defaults to zero.

Definition at line 1113 of file ntv2formatdescriptor.cpp.

◆ HasAlpha()

bool NTV2FormatDescriptor::HasAlpha ( void ) const

inline

Returns: True if I have an alpha channel. New in SDK 17.0.

Definition at line 356 of file ntv2formatdescriptor.h.

◆ Is2KFormat()

bool NTV2FormatDescriptor::Is2KFormat ( void ) const

Returns: True if I was created with a 2Kx1080 video format.

Definition at line 993 of file ntv2formatdescriptor.cpp.

◆ Is4K()

bool NTV2FormatDescriptor::Is4K ( void ) const

inline

Returns: True if I was created with an 4K video format or standard.

Definition at line 346 of file ntv2formatdescriptor.h.

◆ Is8K()

bool NTV2FormatDescriptor::Is8K ( void ) const

inline

Returns: True if I was created with an 8K video format or standard.

Definition at line 348 of file ntv2formatdescriptor.h.

◆ IsAtLineStart()

bool NTV2FormatDescriptor::IsAtLineStart ( ULWord inByteOffset ) const

Returns: True if the given byte offset is at the start of a new raster line (row); otherwise false.

Parameters

[in] inByteOffset The offset, in bytes, to the byte of interest in the frame.

Definition at line 1052 of file ntv2formatdescriptor.cpp.

◆ IsHD()

bool NTV2FormatDescriptor::IsHD ( void ) const

inline

Returns: True if I was created with an HD video format or standard.

Definition at line 344 of file ntv2formatdescriptor.h.

◆ IsPlanar()

bool NTV2FormatDescriptor::IsPlanar ( void ) const

inline

Returns: True if planar format; otherwise false.

Definition at line 115 of file ntv2formatdescriptor.h.

◆ IsQuadRaster()

bool NTV2FormatDescriptor::IsQuadRaster ( void ) const

inline

Returns: True if I was created with a 4K/UHD video format or standard.

Definition at line 349 of file ntv2formatdescriptor.h.

◆ IsRGB()

bool NTV2FormatDescriptor::IsRGB ( void ) const

inline

Returns: True if my pixel format is RGB. New in SDK 17.0.

Definition at line 357 of file ntv2formatdescriptor.h.

◆ IsSD()

bool NTV2FormatDescriptor::IsSD ( void ) const

inline

Returns: True if I was created with an SD video format or standard.

Definition at line 343 of file ntv2formatdescriptor.h.

◆ IsSDFormat()

bool NTV2FormatDescriptor::IsSDFormat ( void ) const

inline

Deprecated:: Obsolete starting in SDK 16.3.

Definition at line 361 of file ntv2formatdescriptor.h.

◆ IsTallerVanc()

bool NTV2FormatDescriptor::IsTallerVanc ( void ) const

inline

Returns: True if I was created with "taller" VANC.

Definition at line 351 of file ntv2formatdescriptor.h.

◆ IsTallVanc()

bool NTV2FormatDescriptor::IsTallVanc ( void ) const

inline

Returns: True if I was created with just "tall" VANC.

Definition at line 350 of file ntv2formatdescriptor.h.

◆ IsUHD()

bool NTV2FormatDescriptor::IsUHD ( void ) const

inline

Returns: True if I was created with an UHD video format or standard.

Definition at line 345 of file ntv2formatdescriptor.h.

◆ IsUHD2()

bool NTV2FormatDescriptor::IsUHD2 ( void ) const

inline

Returns: True if I was created with an UHD2 video format or standard.

Definition at line 347 of file ntv2formatdescriptor.h.

◆ IsValid()

bool NTV2FormatDescriptor::IsValid ( void ) const

inline

Returns: True if valid – i.e. non-zero line count, non-zero pixel count, non-zero plane count, non-zero line pitch (1st plane), and a non-zero bit count (for luma or chroma).

Definition at line 112 of file ntv2formatdescriptor.h.

◆ IsVANC()

bool NTV2FormatDescriptor::IsVANC ( void ) const

inline

Returns: True if VANC geometry; otherwise false.

Definition at line 114 of file ntv2formatdescriptor.h.

◆ MakeInvalid()

void NTV2FormatDescriptor::MakeInvalid ( void )

defined(NTV2_DEPRECATE_16_3)

Resets me into an invalid (NULL) state.

Definition at line 930 of file ntv2formatdescriptor.cpp.

◆ operator==()

bool NTV2FormatDescriptor::operator== ( const NTV2FormatDescriptor & inRHS ) const

Returns: True if I'm equal to the given NTV2FormatDescriptor.

Parameters

[in] inRHS The right-hand-side operand that I'll be compared with.

Definition at line 1003 of file ntv2formatdescriptor.cpp.

◆ PlaneToString()

string NTV2FormatDescriptor::PlaneToString ( const UWord inPlaneIndex0 ) const

Returns: A string containing a human-readable name for the specified plane.

Definition at line 1011 of file ntv2formatdescriptor.cpp.

◆ Print()

ostream & NTV2FormatDescriptor::Print	(	std::ostream &	inOutStream,
		const bool	inDetailed = `true`
	)		const

Writes a human-readable description of me into the given output stream.

Parameters

	inOutStream	The output stream to be written into.
[in]	inDetailed	If true (the default), writes a detailed description; otherwise writes a brief one.

Returns: The output stream I was handed.

Definition at line 1224 of file ntv2formatdescriptor.cpp.

◆ PrintSMPTELineNumber()

ostream & NTV2FormatDescriptor::PrintSMPTELineNumber	(	std::ostream &	inOutStream,
		const ULWord	inLineOffset,
		const bool	inForTextMode = `false`
	)		const

Writes the given frame buffer line offset as a formatted SMPTE line number into the given output stream.

Parameters

	inOutStream	The output stream to be written into.
[in]	inLineOffset	Specifies the zero-based line offset in the frame buffer.
[in]	inForTextMode	Defaults to false. If true, omits the space between the field indicator and the line number, and adds leading zeroes to line number.

Returns: The output stream I was handed.

Definition at line 1358 of file ntv2formatdescriptor.cpp.

◆ RasterLineToByteOffset()

ULWord NTV2FormatDescriptor::RasterLineToByteOffset	(	const ULWord	inRowIndex0,
		const UWord	inPlaneIndex0 = `0`
	)		const

Returns: The absolute byte offset from the start of the frame buffer to the start of the given raster line in the given plane (or 0xFFFFFFFF if the row and/or plane indexes are bad).

Note: This function assumes that the planes contiguously abut each other in memory, in ascending address order.

Parameters

[in]	inRowIndex0	Specifies the row of interest in the buffer, where zero is the topmost row.
[in]	inPlaneIndex0	Specifies the plane of interest. Defaults to zero.

Definition at line 1131 of file ntv2formatdescriptor.cpp.

Friends And Related Function Documentation

◆ CNTV2CaptionRenderer

friend class CNTV2CaptionRenderer

friend

Definition at line 366 of file ntv2formatdescriptor.h.

Member Data Documentation

◆ firstActiveLine

ULWord NTV2FormatDescriptor::firstActiveLine

First active line of video (0 if NTV2_VANCMODE_OFF)

Definition at line 376 of file ntv2formatdescriptor.h.

◆ linePitch

ULWord NTV2FormatDescriptor::linePitch

Number of 32-bit words per line – shadows mLinePitch[0] / sizeof(ULWord)

Definition at line 375 of file ntv2formatdescriptor.h.

◆ numLines

ULWord NTV2FormatDescriptor::numLines

Height – total number of lines.

Definition at line 373 of file ntv2formatdescriptor.h.

◆ numPixels

ULWord NTV2FormatDescriptor::numPixels

Width – total number of pixels per line.

Definition at line 374 of file ntv2formatdescriptor.h.

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

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

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NTV2FormatDescriptor() [1/5]

◆ NTV2FormatDescriptor() [2/5]

◆ NTV2FormatDescriptor() [3/5]

◆ NTV2FormatDescriptor() [4/5]

◆ NTV2FormatDescriptor() [5/5]

Member Function Documentation

◆ ByteOffsetToPlane()

◆ ByteOffsetToRasterLine()

◆ FlipVertically()

◆ GetBytesPerRow()

◆ GetChangedLines()

◆ GetFirstActiveLine()

◆ GetFirstChangedRow()

◆ GetFrameGeometry()

◆ GetFullRasterDimensions()

◆ GetFullRasterHeight()

◆ GetLineOffsetFromSMPTELine()

◆ GetNumBitsAlpha()

◆ GetNumBitsChroma()

◆ GetNumBitsLuma()

◆ GetNumPlanes()

◆ GetPixelFormat()

◆ GetRasterHeight()

◆ GetRasterWidth()

◆ GetRowAddress()

◆ GetRowBuffer()

◆ GetSegmentedXferInfo()

◆ GetSMPTELineNumber()

◆ GetTopVisibleRowAddress()

◆ GetTotalBytes()

◆ GetTotalRasterBytes()

◆ GetVANCMode()

◆ GetVerticalSampleRatio()

◆ GetVideoFormat()

◆ GetVideoStandard()

◆ GetVideoWriteSize()

◆ GetVisibleRasterBytes()

◆ GetVisibleRasterDimensions()

◆ GetVisibleRasterHeight()

◆ GetWriteableRowAddress()

◆ HasAlpha()

◆ Is2KFormat()

◆ Is4K()

◆ Is8K()

◆ IsAtLineStart()

◆ IsHD()

◆ IsPlanar()

◆ IsQuadRaster()

◆ IsRGB()

◆ IsSD()

◆ IsSDFormat()

◆ IsTallerVanc()

◆ IsTallVanc()

◆ IsUHD()

◆ IsUHD2()

◆ IsValid()

◆ IsVANC()

◆ MakeInvalid()

◆ operator==()

◆ PlaneToString()

◆ Print()

◆ PrintSMPTELineNumber()

◆ RasterLineToByteOffset()

Friends And Related Function Documentation

◆ CNTV2CaptionRenderer

Member Data Documentation

◆ firstActiveLine

◆ linePitch

◆ numLines

◆ numPixels