Basic NvMedia Types and Structures

Detailed Description

Defines basic types used throughout the NvMedia API.

Data Structures
struct	NvMediaRect
	Holds a rectangular region of a surface. More...
struct	NvMediaPoint
	Defines the location of a point on a two-dimensional object. More...
struct	NvMediaPointFloat
	Defines the float-precision location of a point on a two-dimensional object. More...
struct	NvMediaPointDouble
	Defines the double-precision location of a point on a two-dimensional object. More...
struct	NvMediaTaskStatus
	Holds status of latest operation for NvMedia managed data structure. More...
struct	NvMediaEncodeQP
	Holds quantization parameters(QP) value for frames. More...
struct	NvMediaEncodeRCParams
	Holds rate control configuration parameters. More...

Modules
	Device
	Manages NvMediaDevice objects, which are the root of the Nvmedia object system.
	H.264 Encoder
	The H.264 Encoder API provides basic encode picture types.
	H.264 Structures
	H.265 Encoder: Common Types
	The H.265 Encoder API provides basic encode parameters.
	H.265 Structures
	MPEG-1 and MPEG-2 Structures
	MPEG4 Part 2 Structures
	Version Information
	Provides version information for the NvMedia library.

Macros
#define	NVMEDIA_RELEASE_VERSION_MAJOR   2
	Release major version number. More...
#define	NVMEDIA_RELEASE_VERSION_MINOR   0
	Release minor version number. More...
#define	NVMEDIA_CORE_VERSION_MAJOR   1
	Core major version number. More...
#define	NVMEDIA_CORE_VERSION_MINOR   14
	Core minor version number. More...
#define	NVMEDIA_TRUE
	A true NvMediaBool value. More...
#define	NVMEDIA_FALSE
	A false NvMediaBool value. More...

Typedefs
typedef uint32_t	NvMediaBool
	A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE. More...
typedef struct timespec	NvMediaTime
	Holds the media time in timespec format as defined by the POSIX specification. More...
typedef uint64_t	NvMediaGlobalTime
	Media global time, measured in microseconds. More...

Enumerations
enum	NvMediaTimeBase {   NVMEDIA_TIME_BASE_CLOCK_PTP,   NVMEDIA_TIME_BASE_CLOCK_MONOTONIC,   NVMEDIA_TIME_BASE_CLOCK_USER_DEFINED }
	Defines clock base for NvMediaTime. More...
enum	NvMediaColorStandard {   NVMEDIA_COLOR_STANDARD_ITUR_BT_601,   NVMEDIA_COLOR_STANDARD_ITUR_BT_709,   NVMEDIA_COLOR_STANDARD_SMPTE_240M,   NVMEDIA_COLOR_STANDARD_ITUR_BT_601_ER,   NVMEDIA_COLOR_STANDARD_ITUR_BT_709_ER }
	Defines color standards. More...
enum	NvMediaStatus {   NVMEDIA_STATUS_OK = 0,   NVMEDIA_STATUS_BAD_PARAMETER = 1,   NVMEDIA_STATUS_PENDING = 2,   NVMEDIA_STATUS_TIMED_OUT = 3,   NVMEDIA_STATUS_OUT_OF_MEMORY = 4,   NVMEDIA_STATUS_NOT_INITIALIZED = 5,   NVMEDIA_STATUS_NOT_SUPPORTED = 6,   NVMEDIA_STATUS_ERROR = 7,   NVMEDIA_STATUS_NONE_PENDING = 8,   NVMEDIA_STATUS_INSUFFICIENT_BUFFERING = 9,   NVMEDIA_STATUS_INVALID_SIZE = 10,   NVMEDIA_STATUS_INCOMPATIBLE_VERSION = 11,   NVMEDIA_STATUS_UNDEFINED_STATE = 13,   NVMEDIA_STATUS_PFSD_ERROR = 14 }
	Defines all possible error codes. More...

Macro Definition Documentation

NVMEDIA_CORE_VERSION_MAJOR

#define NVMEDIA_CORE_VERSION_MAJOR   1

Core major version number.

Definition at line 67 of file nvmedia_core.h.

NVMEDIA_CORE_VERSION_MINOR

#define NVMEDIA_CORE_VERSION_MINOR   14

Core minor version number.

Definition at line 69 of file nvmedia_core.h.

NVMEDIA_FALSE

#define NVMEDIA_FALSE

A false NvMediaBool value.

Definition at line 74 of file nvmedia_core.h.

NVMEDIA_RELEASE_VERSION_MAJOR

#define NVMEDIA_RELEASE_VERSION_MAJOR   2

Release major version number.

Definition at line 62 of file nvmedia_core.h.

NVMEDIA_RELEASE_VERSION_MINOR

#define NVMEDIA_RELEASE_VERSION_MINOR   0

Release minor version number.

Definition at line 64 of file nvmedia_core.h.

NVMEDIA_TRUE

#define NVMEDIA_TRUE

A true NvMediaBool value.

Definition at line 72 of file nvmedia_core.h.

Typedef Documentation

NvMediaBool

typedef uint32_t NvMediaBool

A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.

Definition at line 80 of file nvmedia_core.h.

NvMediaGlobalTime

typedef uint64_t NvMediaGlobalTime

Media global time, measured in microseconds.

Definition at line 90 of file nvmedia_core.h.

NvMediaTime

typedef struct timespec NvMediaTime

Holds the media time in timespec format as defined by the POSIX specification.

Definition at line 85 of file nvmedia_core.h.

Enumeration Type Documentation

NvMediaColorStandard

enum NvMediaColorStandard

Defines color standards.

Enumerator
NVMEDIA_COLOR_STANDARD_ITUR_BT_601	Specifies ITU BT.601 color standard.
NVMEDIA_COLOR_STANDARD_ITUR_BT_709	Specifies ITU BT.709 color standard.
NVMEDIA_COLOR_STANDARD_SMPTE_240M	Specifies SMTE 240M color standard.
NVMEDIA_COLOR_STANDARD_ITUR_BT_601_ER	Specifies ITU BT.601 color standard extended range.
NVMEDIA_COLOR_STANDARD_ITUR_BT_709_ER	Specifies ITU BT.709 color standard extended range.

Definition at line 108 of file nvmedia_core.h.

NvMediaStatus

enum NvMediaStatus

Defines all possible error codes.

Enumerator
NVMEDIA_STATUS_OK	Specifies that the operation completed successfully (with no error).
NVMEDIA_STATUS_BAD_PARAMETER	Specifies that a bad parameter was passed.
NVMEDIA_STATUS_PENDING	Specifies that the operation has not finished yet.
NVMEDIA_STATUS_TIMED_OUT	Specifies that the operation timed out.
NVMEDIA_STATUS_OUT_OF_MEMORY	Specifies that the process is out of memory.
NVMEDIA_STATUS_NOT_INITIALIZED	Specifies that a component requred by the function call is not initialized.
NVMEDIA_STATUS_NOT_SUPPORTED	Specifies that the requested operation is not supported.
NVMEDIA_STATUS_ERROR	Specifies a catch-all error, used when no other error code applies.
NVMEDIA_STATUS_NONE_PENDING	Specifies that no operation is pending.
NVMEDIA_STATUS_INSUFFICIENT_BUFFERING	Specifies insufficient buffering.
NVMEDIA_STATUS_INVALID_SIZE	Specifies that the size of an object passed to a function was invalid.
NVMEDIA_STATUS_INCOMPATIBLE_VERSION	Specifies that a library's version is incompatible with the application.
NVMEDIA_STATUS_UNDEFINED_STATE	Specifies that the operation entered an undefined state.
NVMEDIA_STATUS_PFSD_ERROR	Specifies an error from Permanent Fault Software Diagnostic.

Definition at line 180 of file nvmedia_core.h.

NvMediaTimeBase

enum NvMediaTimeBase

Defines clock base for NvMediaTime.

Enumerator
NVMEDIA_TIME_BASE_CLOCK_PTP	Specifies that PTP clock is used for base time calculation.
NVMEDIA_TIME_BASE_CLOCK_MONOTONIC	Specifies that kernel monotonic clock is used for base time calculation.
NVMEDIA_TIME_BASE_CLOCK_USER_DEFINED	Specifies that a user defined clock is used for base time calculation.

Definition at line 94 of file nvmedia_core.h.