nvmedia_array.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved. All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */


#ifndef _NVMEDIA_ARRAY_H
#define _NVMEDIA_ARRAY_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"

#define NVMEDIA_ARRAY_VERSION_MAJOR   2

#define NVMEDIA_ARRAY_VERSION_MINOR   1

#define NVMEDIA_ARRAY_TIMEOUT_INFINITE  0xFFFFFFFF

typedef enum {
    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,
} NvMediaArrayType;

typedef struct NvMediaArray NvMediaArray;

typedef enum {
    NVM_ARRAY_ATTR_CPU_ACCESS,
} NvMediaArrayAllocAttrType;

#define NVM_ARRAY_ATTR_CPU_ACCESS_UNCACHED 0x00000000

#define NVM_ARRAY_ATTR_CPU_ACCESS_CACHED 0x00000001

typedef struct {
    NvMediaArrayAllocAttrType type;
    uint32_t value;
} NvMediaArrayAllocAttr;

typedef enum {
    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),
} NvMediaArrayLockAccess;

NvMediaStatus
NvMediaArrayGetVersion(
    NvMediaVersion *version
);

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

NvMediaStatus
NvMediaArrayDestroy(
    NvMediaArray* handle
);

NvMediaStatus
NvMediaArrayGetElemSizeForType(
    NvMediaArrayType type,
    uint32_t *elementSize
);

NvMediaStatus
NvMediaArrayGetSize(
    NvMediaArray* handle,
    uint32_t *numElementsPtr
);

NvMediaStatus
NvMediaArraySetSize(
    NvMediaArray* handle,
    uint32_t numElements
);

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

NvMediaStatus
NvMediaArrayGetStatus(
    NvMediaArray *handle,
    uint32_t millisecondWait,
    NvMediaTaskStatus *status
);

NvMediaStatus
NvMediaArrayLock(
    NvMediaArray *handle,
    NvMediaArrayLockAccess lockAccessType,
    void **ptr
);

void
NvMediaArrayUnlock(
    NvMediaArray *handle
);

/*
 * \defgroup history_nvmedia_array History
 * Provides change history for the NvMedia Array API.
 *
 * \section history_nvmedia_arrays Version History
 *
 * <b> Version 1.0 </b> December 4, 2017
 * - Initial Release.
 *
 * <b> Version 2.0 </b> June 1, 2018
 * - Remove keypoint type. VPI-specific types are in VPI headers.
 *
 * <b> Version 2.1 </b> July 9, 2018
 * - Add version query API.
 */

#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif // _NVMEDIA_ARRAY_H