ntv2formatdescriptor.h File Reference

Declares the NTV2FormatDescriptor class. More...

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

Include dependency graph for ntv2formatdescriptor.h:

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

Go to the source code of this file.

Classes
class	NTV2FormatDescriptor
	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...

Typedefs
typedef std::vector< ULWord >	NTV2RasterLineOffsets
	An ordered sequence of zero-based line offsets into a frame buffer. More...
typedef NTV2RasterLineOffsets::const_iterator	NTV2RasterLineOffsetsConstIter
	A handy const iterator into an NTV2RasterLineOffsets. More...
typedef NTV2RasterLineOffsets::iterator	NTV2RasterLineOffsetsIter
	A handy non-const iterator into an NTV2RasterLineOffsets. More...
typedef NTV2FormatDescriptor	NTV2FormatDesc
	Shorthand for NTV2FormatDescriptor. More...

Functions
std::ostream &	NTV2PrintRasterLineOffsets (const NTV2RasterLineOffsets &inObj, std::ostream &inOutStream=std::cout)
	Streams a human-readable dump of the given NTV2RasterLineOffsets sequence into the specified output stream. More...
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2FormatDescriptor &inFormatDesc)
	Writes the given NTV2FormatDescriptor to the specified output stream. More...
bool	UnpackLine_10BitYUVtoUWordSequence (const void *pIn10BitYUVLine, const NTV2FormatDescriptor &inFormatDesc, UWordSequence &out16BitYUVLine)
	Unpacks a line of NTV2_FBF_10BIT_YCBCR video into 16-bit-per-component YUV data. More...

Detailed Description

Declares the NTV2FormatDescriptor class.

Copyright

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

Definition in file ntv2formatdescriptor.h.

Typedef Documentation

NTV2FormatDesc

typedef NTV2FormatDescriptor NTV2FormatDesc

Shorthand for NTV2FormatDescriptor.

Definition at line 366 of file ntv2formatdescriptor.h.

NTV2RasterLineOffsets

typedef std::vector<ULWord> NTV2RasterLineOffsets

An ordered sequence of zero-based line offsets into a frame buffer.

Definition at line 23 of file ntv2formatdescriptor.h.

NTV2RasterLineOffsetsConstIter

typedef NTV2RasterLineOffsets::const_iterator NTV2RasterLineOffsetsConstIter

A handy const iterator into an NTV2RasterLineOffsets.

Definition at line 24 of file ntv2formatdescriptor.h.

NTV2RasterLineOffsetsIter

typedef NTV2RasterLineOffsets::iterator NTV2RasterLineOffsetsIter

A handy non-const iterator into an NTV2RasterLineOffsets.

Definition at line 25 of file ntv2formatdescriptor.h.

Function Documentation

NTV2PrintRasterLineOffsets()

std::ostream& NTV2PrintRasterLineOffsets	(	const NTV2RasterLineOffsets &	inObj,
		std::ostream &	inOutStream = std::cout
	)

Streams a human-readable dump of the given NTV2RasterLineOffsets sequence into the specified output stream.

Parameters

[in]	inObj	Specifies the NTV2RasterLineOffsets to be streamed to the output stream.
	inOutStream	Specifies the output stream to receive the dump. Defaults to std::cout.

Returns

A non-constant reference to the given output stream.

operator<<()

std::ostream& operator<< ( std::ostream &  inOutStream, const NTV2FormatDescriptor &  inFormatDesc  )

inline

Writes the given NTV2FormatDescriptor to the specified output stream.

Parameters

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

Returns

A non-constant reference to the specified output stream.

Definition at line 374 of file ntv2formatdescriptor.h.

UnpackLine_10BitYUVtoUWordSequence()

bool UnpackLine_10BitYUVtoUWordSequence	(	const void *	pIn10BitYUVLine,
		const NTV2FormatDescriptor &	inFormatDesc,
		UWordSequence &	out16BitYUVLine
	)

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 packed NTV2_FBF_10BIT_YCBCR data to be converted.
[in]	inFormatDesc	Describes the raster.
[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, . . .

Returns

True if successful; otherwise false.

Definition at line 143 of file ntv2utils.cpp.