NVIDIA DRIVE 5.0 Linux SDK API Reference

5.0.5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Basic NvMedia Types and Structures

Detailed Description

Defines basic types used throughout the NvMedia API.

Data Structures

struct  NvMediaEncodeQP
 Holds quantization parameters(QP) value for frames. More...
 
struct  NvMediaEncodeRCParams
 Holds rate control configuration parameters. More...
 
struct  NvMediaColor
 Holds a constant RGBA color. More...
 
struct  NvMediaRect
 Holds a rectangular region of a surface. More...
 
struct  NvMediaPoint
 Holds a location on a 2-dimensional object. More...
 
struct  NvMediaROI
 Holda a Region of Interest. More...
 
struct  NvMediaTaskStatus
 Holds status of latest operation for NvMedia managed data structure. More...
 

Modules

 Basic IPP Types
 The Image Processing Pipeline API provides common IPP processing functions.
 
 Basic ISC Types
 The Image Sensor Control API provides common ISC processing functions.
 
 Basic ISP Types
 The Image Signal Processing API provides common ISP processing functions.
 
 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
 Provides structures for defining the H.264 reference frame.
 
 H.265 Encoder
 The H.265 Encoder API provides basic encode parameters.
 
 H.265 Structures
 Provides structures for defining the H.265 reference frame.
 
 MPEG-1 and MPEG-2 Structures
 Provides a structure for defining the MPEG-1 and MPEG-2 picture parameter information.
 
 MPEG4 Part 2 Structures
 Provides a structure for defining picture parameters for the MPEG-4 Part 2 picture.
 
 Palette
 Defines and manages objects that provide device-specific RGBA color palettes.
 
 Version Information
 Provides version information for the NvMedia library.
 

Macros

#define NVMEDIA_RELEASE_VERSION_MAJOR   2
 Major Version number. More...
 
#define NVMEDIA_RELEASE_VERSION_MINOR   0
 Minor Version number. More...
 
#define NVMEDIA_CORE_VERSION_MAJOR   1
 Major Version number. More...
 
#define NVMEDIA_CORE_VERSION_MINOR   3
 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 (timespec as defined by the POSIX specification). More...
 
typedef uint64_t NvMediaGlobalTime
 Media global time, measured in microseconds. More...
 

Enumerations

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,
  NVMEDIA_STATUS_BAD_PARAMETER,
  NVMEDIA_STATUS_PENDING,
  NVMEDIA_STATUS_TIMED_OUT,
  NVMEDIA_STATUS_OUT_OF_MEMORY,
  NVMEDIA_STATUS_NOT_INITIALIZED,
  NVMEDIA_STATUS_NOT_SUPPORTED,
  NVMEDIA_STATUS_ERROR,
  NVMEDIA_STATUS_NONE_PENDING,
  NVMEDIA_STATUS_INSUFFICIENT_BUFFERING,
  NVMEDIA_STATUS_INVALID_SIZE,
  NVMEDIA_STATUS_INCOMPATIBLE_VERSION,
  NVMEDIA_STATUS_CANCELLED,
  NVMEDIA_STATUS_UNDEFINED_STATE
}
 The set of all possible error codes. More...
 

Macro Definition Documentation

#define NVMEDIA_CORE_VERSION_MAJOR   1

Major Version number.

Definition at line 66 of file nvmedia_core.h.

#define NVMEDIA_CORE_VERSION_MINOR   3

Minor Version number.

Definition at line 68 of file nvmedia_core.h.

#define NVMEDIA_FALSE

A false NvMediaBool value.

Definition at line 73 of file nvmedia_core.h.

#define NVMEDIA_RELEASE_VERSION_MAJOR   2

Major Version number.

Definition at line 61 of file nvmedia_core.h.

#define NVMEDIA_RELEASE_VERSION_MINOR   0

Minor Version number.

Definition at line 63 of file nvmedia_core.h.

#define NVMEDIA_TRUE

A true NvMediaBool value.

Definition at line 71 of file nvmedia_core.h.

Typedef Documentation

typedef uint32_t NvMediaBool

A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.

Definition at line 79 of file nvmedia_core.h.

typedef uint64_t NvMediaGlobalTime

Media global time, measured in microseconds.

Definition at line 89 of file nvmedia_core.h.

typedef struct timespec NvMediaTime

Holds the media time (timespec as defined by the POSIX specification).

Definition at line 84 of file nvmedia_core.h.

Enumeration Type Documentation

Defines color standards.

Enumerator
NVMEDIA_COLOR_STANDARD_ITUR_BT_601 

ITU BT.601 color standard.

NVMEDIA_COLOR_STANDARD_ITUR_BT_709 

ITU BT.709 color standard.

NVMEDIA_COLOR_STANDARD_SMPTE_240M 

SMTE 240M color standard.

NVMEDIA_COLOR_STANDARD_ITUR_BT_601_ER 

ITU BT.601 color standard extended range.

NVMEDIA_COLOR_STANDARD_ITUR_BT_709_ER 

ITU BT.709 color standard extended range.

Definition at line 112 of file nvmedia_core.h.

The set of all possible error codes.

Enumerator
NVMEDIA_STATUS_OK 

The operation completed successfully; no error.

NVMEDIA_STATUS_BAD_PARAMETER 

Bad parameter was passed.

NVMEDIA_STATUS_PENDING 

Operation has not finished yet.

NVMEDIA_STATUS_TIMED_OUT 

Operation timed out.

NVMEDIA_STATUS_OUT_OF_MEMORY 

Out of memory.

NVMEDIA_STATUS_NOT_INITIALIZED 

Not initialized.

NVMEDIA_STATUS_NOT_SUPPORTED 

Not supported.

NVMEDIA_STATUS_ERROR 

A catch-all error, used when no other error code applies.

NVMEDIA_STATUS_NONE_PENDING 

No operation is pending.

NVMEDIA_STATUS_INSUFFICIENT_BUFFERING 

Insufficient buffering.

NVMEDIA_STATUS_INVALID_SIZE 

Invalid size.

NVMEDIA_STATUS_INCOMPATIBLE_VERSION 

Incompatible version.

NVMEDIA_STATUS_CANCELLED 

Operation is cancelled when the hardware is timed out.

NVMEDIA_STATUS_UNDEFINED_STATE 

Undefined state.

Definition at line 178 of file nvmedia_core.h.