Basic NvMedia Types and Structures

Detailed Description

Defines basic types used throughout the NvMedia API.

6

Data Structures
struct	NvMediaRect
	Holds a rectangular region of a surface. More...

Modules
	Device
	Manages NvMediaDevice objects, which are the root of the Nvmedia object system.
	Version Information
	Provides version information for the NvMedia library.

Macros
#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...

Enumerations
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...
enum	NvMediaNvSciSyncClientType {   NVMEDIA_SIGNALER,   NVMEDIA_WAITER,   NVMEDIA_SIGNALER_WAITER }
	NvMedia NvSciSync Client Type. More...
enum	NvMediaNvSciSyncObjType {   NVMEDIA_PRESYNCOBJ,   NVMEDIA_EOFSYNCOBJ,   NVMEDIA_SOFSYNCOBJ,   NVMEDIA_EOF_PRESYNCOBJ,   NVMEDIA_SOF_PRESYNCOBJ }
	Defines NvMedia NvSciSyncObj types. More...

Macro Definition Documentation

NVMEDIA_FALSE

#define NVMEDIA_FALSE

A false NvMediaBool value.

Definition at line 66 of file nvmedia_core.h.

NVMEDIA_TRUE

#define NVMEDIA_TRUE

A true NvMediaBool value.

Definition at line 63 of file nvmedia_core.h.

Typedef Documentation

NvMediaBool

typedef uint32_t NvMediaBool

A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.

Definition at line 72 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 77 of file nvmedia_core.h.

Enumeration Type Documentation

NvMediaNvSciSyncClientType

enum NvMediaNvSciSyncClientType

NvMedia NvSciSync Client Type.

Enumerator
NVMEDIA_SIGNALER	An NvMedia component acts as a signaler.
NVMEDIA_WAITER	An NvMedia component acts as a waiter.
NVMEDIA_SIGNALER_WAITER	An NvMedia component acts as a signaler and waiter also for the same NvSciSyncObj.

Definition at line 174 of file nvmedia_core.h.

NvMediaNvSciSyncObjType

enum NvMediaNvSciSyncObjType

Defines NvMedia NvSciSyncObj types.

Enumerator
NVMEDIA_PRESYNCOBJ	Specifies an NvSciSyncObj type for which an NvMedia component acts as a waiter.
NVMEDIA_EOFSYNCOBJ	Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling EOFFence.
NVMEDIA_SOFSYNCOBJ	Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence.
NVMEDIA_EOF_PRESYNCOBJ	Specifies an NvSciSyncObj type for which an NvMedia component acts both as a signaler, signaling EOFFence, and as a waiter. Use this type in use cases where a EOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.
NVMEDIA_SOF_PRESYNCOBJ	Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence, as a waiter. Use this type in use cases where a SOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.

Definition at line 187 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 104 of file nvmedia_core.h.