Detailed Description

The NvMedia Array API encompasses all NvMedia functions that create, destroy, access and update arrays used in media processing and computer vision applications.

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

Functions
NvMediaStatus	NvMediaArrayGetVersion (NvMediaVersion *version)
	Returns the version information for the NvMediaArray library. More...

NvMediaArray *	NvMediaArrayCreate (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...

Macro Definition Documentation

#define NVM_ARRAY_ATTR_CPU_ACCESS_CACHED 0x00000001

NVM_SURF_ATTR_CPU_ACCESS flag: Cached (mapped) access type flag.

Definition at line 93 of file nvmedia_array.h.

#define NVM_ARRAY_ATTR_CPU_ACCESS_UNCACHED 0x00000000

NVM_SURF_ATTR_CPU_ACCESS flags

Uncached (mapped) access type flag

Definition at line 91 of file nvmedia_array.h.

#define NVMEDIA_ARRAY_TIMEOUT_INFINITE

Infinite time-out for NvMediaArrayGetStatus.

Definition at line 46 of file nvmedia_array.h.

#define NVMEDIA_ARRAY_VERSION_MAJOR 2

Major Version number.

Definition at line 38 of file nvmedia_array.h.

#define NVMEDIA_ARRAY_VERSION_MINOR 1

Minor Version number.

Definition at line 40 of file nvmedia_array.h.

Typedef Documentation

typedef struct NvMediaArray NvMediaArray

Holds a descriptor for the array.

Note: The array needs to be created and destroyed using the corresponding NvMediaArrayCreate() and NvMediaArrayDestroy() functions.

Definition at line 78 of file nvmedia_array.h.

Enumeration Type Documentation

enum NvMediaArrayAllocAttrType

Defines NvMedia array allocation attribute types.

Enumerator
NVM_ARRAY_ATTR_CPU_ACCESS	! CPU access to surface flags (default: uncached)

Definition at line 83 of file nvmedia_array.h.

enum NvMediaArrayType

Defines the different types of Arrays.

Enumerator
NVMEDIA_ARRAY_TYPE_UNDEFINED	Undefined array type.
NVMEDIA_ARRAY_TYPE_INT8	Signed 8 bit.
NVMEDIA_ARRAY_TYPE_UINT8	Unsigned 8 bit.
NVMEDIA_ARRAY_TYPE_INT16	Signed 16 bit.
NVMEDIA_ARRAY_TYPE_UINT16	Unsigned 16 bit.
NVMEDIA_ARRAY_TYPE_FLOAT16	Float 16 bit.
NVMEDIA_ARRAY_TYPE_UINT32	Unsigned 32 bit.
NVMEDIA_ARRAY_TYPE_INT32	Signed 32 bit.
NVMEDIA_ARRAY_TYPE_FLOAT32	Float 32 bit.
NVMEDIA_ARRAY_NUM_TYPES	Number of types - If more types are needed, add above this and update this.

Definition at line 50 of file nvmedia_array.h.

Function Documentation

NvMediaArray* NvMediaArrayCreate	(	NvMediaDevice *	device,
		NvMediaArrayType	type,
		uint32_t	stride,
		uint32_t	numElements,
		const NvMediaArrayAllocAttr *	attrs,
		uint32_t	numAttrs
	)

Creates an NvMedia Array.

Parameters

[in]	device	Handle to the NvMedia device obtained by calling NvMediaDeviceCreate.
[in]	type	NvMediaArrayType Type of Array to be created.
[in]	stride	Stride in bytes of each element.
[in]	numElements	number of Elements in the array.
[in]	attrs	An array of NvMediaArrayAllocAttr Allocation attributes.
[in]	numAttrs	Number of allocation objects attrs.

Returns: NvMediaArray Handle to array. Null if unsuccessful.

NvMediaStatus NvMediaArrayDestroy ( NvMediaArray * handle )

Destroys an array created by NvMediaArrayCreate().

Parameters

[in] handle The handle to the array to be destroyed.

Returns

NvMediaStatus The status of the API. Possible return values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if input argument is NULL.
NVMEDIA_STATUS_ERROR for any other error.

NvMediaStatus NvMediaArrayGetElemSizeForType	(	NvMediaArrayType	type,
		uint32_t *	elementSize
	)

Gets the size of an element, for a particular type of array element.

Parameters

[in]	type	NvMediaArrayType Type of element.
[out]	elementSize	Pointer to size of element in bytes.

Returns

NvMediaStatus The status of the API. Possible return values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER for invalid type, or NULL pointer.
NVMEDIA_STATUS_ERROR for any other error.

NvMediaStatus NvMediaArrayGetProperties	(	NvMediaArray *	handle,
		NvMediaArrayType *	elementType,
		uint32_t *	capacity,
		uint32_t *	stride
	)

Helper function to get array properties with which array was created.

Parameters

[in]	handle	The handle to the array.
[out]	elementType	Type of elements NvMediaArrayType.
[out]	capacity	Pointer to the capacity (Number of elements).
[out]	stride	Pointer to the stride (Stride in bytes to move to next element).

Returns

NvMediaStatus The status of the API. Possible return values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_ERROR for any other error.

NvMediaStatus NvMediaArrayGetSize	(	NvMediaArray *	handle,
		uint32_t *	numElementsPtr
	)

Gets the size of the array.

An array's size is the number of populated elements in the array. If the array has not been written to, the function sets *numElementsPtr to 0.

Parameters

[in]	handle	The handle to the array.
[out]	numElementsPtr	Pointer to the number of valid elements.

Returns

NvMediaStatus The status of the API. Possible return values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if input argument is NULL.
NVMEDIA_STATUS_ERROR if array is not locked.

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.

Parameters

[in]	handle	The handle to the array.
[in]	millisecondWait	Time in milliseconds to wait for operation to complete before getting status. NVMEDIA_ARRAY_TIMEOUT_INFINITE means wait till operation is completed and then get status.
[out]	status	Status of the operation.

Returns

NvMediaStatus The status of the function call. Possible values are:

NvMediaStatus NvMediaArrayGetVersion ( NvMediaVersion * version )

Returns the version information for the NvMediaArray library.

Parameters

[in] version A pointer to a NvMediaVersion structure filled by the NvMediaArray library.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if the pointer is invalid.

NvMediaStatus NvMediaArraySetSize	(	NvMediaArray *	handle,
		uint32_t	numElements
	)

Sets the size of the array.

Call this function before writing to the array. The number of elements must be less than the number with which the array was created. An array's size is the number of populated elements in the array.

See also: NvMediaArrayCreate().

Parameters

[in]	handle	The handle to the array.
[in]	numElements	Number of elements to set the size to.

Returns

NvMediaStatus The status of the API. Possible return values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if input argument is NULL.
NVMEDIA_STATUS_INVALID_SIZE if numElements is greater than initial size.
NVMEDIA_STATUS_ERROR if array is not locked.

NVIDIA DRIVE OS Linux API Reference

5.1.0.2 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation