Video Decoder: Common Types

Detailed Description

Defines and manages objects that decode video.

The NvMediaVideoDecoder object decodes compressed video data, writing the results to a NvMediaVideoSurface.

A specific NvMedia implementation may support decoding multiple types of compressed video data. However, NvMediaVideoDecoder objects are able to decode a specific type of compressed video data. This type must be specified during creation.

Data Structures
struct	NvMediaVideoDecodeFrameStatus
	To Get the decoding status from HW decoder. More...
struct	NvMediaMotionVectorMB_Metadata
	Per Macroblock header information. More...
struct	NvMediaMotionVectorFrameMetaData
	Motion vector array to get the required current frame stats. More...
struct	NvMediaVideoDecodeStats
	Frame stats structure to get get ring entry idx and motion vector dump. More...

Macros
#define	NVMEDIA_COMMON_DECODE_VERSION_MAJOR   1
	Major Version number. More...
#define	NVMEDIA_COMMON_DECODE_VERSION_MINOR   2
	Minor Version number. More...

Typedefs
typedef void	NvMediaPictureInfo
	A generic "picture information" pointer type. More...
typedef void	NvMediaRefSurface
	A generic "reference surface" pointer type. More...

Enumerations
enum	NvMediaDecoderInstanceId {   NVMEDIA_DECODER_INSTANCE_0 = 0,   NVMEDIA_DECODER_INSTANCE_1,   NVMEDIA_DECODER_INSTANCE_AUTO,   NVMEDIA_DECODER_INSTANCE_0 = 0,   NVMEDIA_DECODER_INSTANCE_1,   NVMEDIA_DECODER_INSTANCE_AUTO }
	Specifies the decoder instance ID. More...
enum	{   NVMEDIA_SLH_PRESENT = 0x1,   NVMEDIA_SPS_PRESENT = 0x2,   NVMEDIA_PPS_PRESENT = 0x4 }
	NAL types found in a bitstream packet. More...
enum	NvMediaMacroBlockType {   NVMEDIA_MBTYPE_B,   NVMEDIA_MBTYPE_P_FORWARD,   NVMEDIA_MBTYPE_P_BACKWARD,   NVMEDIA_MBTYPE_I,   NVMEDIA_MBTYPE_B,   NVMEDIA_MBTYPE_P_FORWARD,   NVMEDIA_MBTYPE_P_BACKWARD,   NVMEDIA_MBTYPE_I }
	Macroblock types. More...
enum	NvMedia_MB_Type_enum {   NVMEDIA_SKIP,   NVMEDIA_P,   NVMEDIA_B,   NVMEDIA_I,   NVMEDIA_UNKNOWN_TYPE,   NVMEDIA_SKIP,   NVMEDIA_P,   NVMEDIA_B,   NVMEDIA_I,   NVMEDIA_UNKNOWN_TYPE }
	MB types. More...
enum	NvMedia_MB_Part_enum {   NVMEDIA_PART_16x16,   NVMEDIA_PART_16x8,   NVMEDIA_PART_8x16,   NVMEDIA_PART_8x8,   NVMEDIA_UNKNOWN_PART,   NVMEDIA_PART_16x16,   NVMEDIA_PART_16x8,   NVMEDIA_PART_8x16,   NVMEDIA_PART_8x8,   NVMEDIA_UNKNOWN_PART }
	MB part. More...

Macro Definition Documentation

NVMEDIA_COMMON_DECODE_VERSION_MAJOR

#define NVMEDIA_COMMON_DECODE_VERSION_MAJOR   1

Major Version number.

Definition at line 53 of file tvmr/include/nvmedia_common_decode.h.

NVMEDIA_COMMON_DECODE_VERSION_MINOR

#define NVMEDIA_COMMON_DECODE_VERSION_MINOR   2

Minor Version number.

Definition at line 55 of file tvmr/include/nvmedia_common_decode.h.

Typedef Documentation

NvMediaPictureInfo

typedef void NvMediaPictureInfo

A generic "picture information" pointer type.

This type serves solely to document the expected usage of a generic (void *) function parameter. In actual usage, the application is expected to physically provide a pointer to an instance of one of the "real" NvMediaPictureInfo* structures, picking the type appropriate for the decoder object in question.

Definition at line 94 of file tvmr/include/nvmedia_common_decode.h.

NvMediaRefSurface

typedef void NvMediaRefSurface

A generic "reference surface" pointer type.

This type serves solely to document the expected usage of a generic (void *) function parameter. In actual usage, the application is expected to physically provide a pointer to an instance of NvMediaVideoSurface or NvMediaImage, depending on the type of decoder API used.

Definition at line 106 of file tvmr/include/nvmedia_common_decode.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

NAL types found in a bitstream packet.

This is used for TK1 H264 OTF cases.

Enumerator
NVMEDIA_SLH_PRESENT	slice header data present or not
NVMEDIA_SPS_PRESENT	sequence header data present or not
NVMEDIA_PPS_PRESENT	picture header data present or not

Definition at line 74 of file tvmr/include/nvmedia_common_decode.h.

NvMedia_MB_Part_enum

enum NvMedia_MB_Part_enum

MB part.

Enumerator
NVMEDIA_PART_16x16	MB part 16x16.
NVMEDIA_PART_16x8	MB part 16x8.
NVMEDIA_PART_8x16	MB part 8x16.
NVMEDIA_PART_8x8	MB part 8x8.
NVMEDIA_UNKNOWN_PART	invalid option
NVMEDIA_PART_16x16	MB part 16x16.
NVMEDIA_PART_16x8	MB part 16x8.
NVMEDIA_PART_8x16	MB part 8x16.
NVMEDIA_PART_8x8	MB part 8x8.
NVMEDIA_UNKNOWN_PART	invalid option

Definition at line 159 of file tvmr/include/nvmedia_common_decode.h.

NvMedia_MB_Type_enum

enum NvMedia_MB_Type_enum

MB types.

Enumerator
NVMEDIA_SKIP	MB type SKIP.
NVMEDIA_P	MB type P.
NVMEDIA_B	MB type B.
NVMEDIA_I	MB type I.
NVMEDIA_UNKNOWN_TYPE	invalid option
NVMEDIA_SKIP	MB type SKIP.
NVMEDIA_P	MB type P.
NVMEDIA_B	MB type B.
NVMEDIA_I	MB type I.
NVMEDIA_UNKNOWN_TYPE	invalid option

Definition at line 143 of file tvmr/include/nvmedia_common_decode.h.

NvMediaDecoderInstanceId

enum NvMediaDecoderInstanceId

Specifies the decoder instance ID.

Enumerator
NVMEDIA_DECODER_INSTANCE_0	Specifies the decoder instance ID 0.
NVMEDIA_DECODER_INSTANCE_1	Specifies the decoder instance ID 1.
NVMEDIA_DECODER_INSTANCE_AUTO	Specifies that the decoder instance ID can be set dynamically during decode.
NVMEDIA_DECODER_INSTANCE_0	Specifies the decoder instance ID 0.
NVMEDIA_DECODER_INSTANCE_1	Specifies the decoder instance ID 1.
NVMEDIA_DECODER_INSTANCE_AUTO	Specifies that the decoder instance ID can be set dynamically during decode.

Definition at line 60 of file tvmr/include/nvmedia_common_decode.h.

NvMediaMacroBlockType

enum NvMediaMacroBlockType

Macroblock types.

Enumerator
NVMEDIA_MBTYPE_B	macroblock type B
NVMEDIA_MBTYPE_P_FORWARD	macroblock type P forward
NVMEDIA_MBTYPE_P_BACKWARD	macroblock type P backward
NVMEDIA_MBTYPE_I	macroblock type I
NVMEDIA_MBTYPE_B	macroblock type B
NVMEDIA_MBTYPE_P_FORWARD	macroblock type P forward
NVMEDIA_MBTYPE_P_BACKWARD	macroblock type P backward
NVMEDIA_MBTYPE_I	macroblock type I

Definition at line 129 of file tvmr/include/nvmedia_common_decode.h.