NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvmedia_array.h File Reference

Detailed Description

NVIDIA Media Interface: Arrays

Description: This file contains the API to access 1 dimensional arrays managed by NvMedia used in multimedia applications.

Definition in file nvmedia_array.h.

Go to the source code of this file.

Data Structures

struct  NvMediaArrayAllocAttr
 Holds array allocation attributes. More...
 

Macros

#define NVMEDIA_ARRAY_VERSION_MAJOR   2
 Major Version number. More...
 
#define NVMEDIA_ARRAY_VERSION_MINOR   1
 Minor Version number. More...
 
#define NVMEDIA_ARRAY_TIMEOUT_INFINITE
 Infinite time-out for NvMediaArrayGetStatus. More...
 
#define NVM_ARRAY_ATTR_CPU_ACCESS_UNCACHED   0x00000000
 NVM_SURF_ATTR_CPU_ACCESS flags More...
 
#define NVM_ARRAY_ATTR_CPU_ACCESS_CACHED   0x00000001
 NVM_SURF_ATTR_CPU_ACCESS flag: Cached (mapped) access type flag. More...
 

Typedefs

typedef struct NvMediaArray NvMediaArray
 Holds a descriptor for the array. More...
 

Enumerations

enum  NvMediaArrayType {
  NVMEDIA_ARRAY_TYPE_UNDEFINED = 0,
  NVMEDIA_ARRAY_TYPE_INT8 = 1,
  NVMEDIA_ARRAY_TYPE_UINT8 = 2,
  NVMEDIA_ARRAY_TYPE_INT16 = 3,
  NVMEDIA_ARRAY_TYPE_UINT16 = 4,
  NVMEDIA_ARRAY_TYPE_FLOAT16 = 5,
  NVMEDIA_ARRAY_TYPE_UINT32 = 6,
  NVMEDIA_ARRAY_TYPE_INT32 = 7,
  NVMEDIA_ARRAY_TYPE_FLOAT32 = 8,
  NVMEDIA_ARRAY_NUM_TYPES = 8
}
 Defines the different types of Arrays. More...
 
enum  NvMediaArrayAllocAttrType { NVM_ARRAY_ATTR_CPU_ACCESS }
 Defines NvMedia array allocation attribute types. More...
 
enum  NvMediaArrayLockAccess {
  NVMEDIA_ARRAY_ACCESS_READ = (1 << 0),
  NVMEDIA_ARRAY_ACCESS_WRITE = (1 << 1),
  NVMEDIA_ARRAY_ACCESS_READ_WRITE = (NVMEDIA_ARRAY_ACCESS_READ | NVMEDIA_ARRAY_ACCESS_WRITE)
}
 Defines array-lock access types. More...
 

Functions

NvMediaStatus NvMediaArrayGetVersion (NvMediaVersion *version)
 Returns the version information for the NvMediaArray library. More...
 
NvMediaArrayNvMediaArrayCreate (NvMediaDevice *device, NvMediaArrayType type, uint32_t stride, uint32_t numElements, const NvMediaArrayAllocAttr *attrs, uint32_t numAttrs)
 Creates an NvMedia Array. More...
 
NvMediaStatus NvMediaArrayDestroy (NvMediaArray *handle)
 Destroys an array created by NvMediaArrayCreate(). More...
 
NvMediaStatus NvMediaArrayGetElemSizeForType (NvMediaArrayType type, uint32_t *elementSize)
 Gets the size of an element, for a particular type of array element. More...
 
NvMediaStatus NvMediaArrayGetSize (NvMediaArray *handle, uint32_t *numElementsPtr)
 Gets the size of the array. More...
 
NvMediaStatus NvMediaArraySetSize (NvMediaArray *handle, uint32_t numElements)
 Sets the size of the array. More...
 
NvMediaStatus NvMediaArrayGetProperties (NvMediaArray *handle, NvMediaArrayType *elementType, uint32_t *capacity, uint32_t *stride)
 Helper function to get array properties with which array was created. More...
 
NvMediaStatus NvMediaArrayGetStatus (NvMediaArray *handle, uint32_t millisecondWait, NvMediaTaskStatus *status)
 Gets the status of the current/last operation for the Array and optionally waits for the operation to complete/timeout. More...
 
NvMediaStatus NvMediaArrayLock (NvMediaArray *handle, NvMediaArrayLockAccess lockAccessType, void **ptr)
 Locks an Array to which data can be written/read without interference from another thread/process. More...
 
void NvMediaArrayUnlock (NvMediaArray *handle)
 Unlocks an Array. More...