Array.h

Go to the documentation of this file.

/*
 * Copyright 2019-2021 NVIDIA Corporation. All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee. Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users. These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_VPI_ARRAY_H
#define NV_VPI_ARRAY_H
 
#include "Export.h"
#include "Status.h"
#include "Types.h"
 
#include <stdint.h>
 
#include "ArrayType.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct VPIArrayBufferAOS
{
    VPIArrayType type;
 
    int32_t *sizePointer;
 
    int32_t capacity;
 
    int32_t strideBytes;
 
    void *data;
} VPIArrayBufferAOS;
 
typedef enum
{
    VPI_ARRAY_BUFFER_INVALID,
 
    VPI_ARRAY_BUFFER_HOST_AOS,
 
    VPI_ARRAY_BUFFER_CUDA_AOS,
 
} VPIArrayBufferType;
 
typedef struct VPIArrayBufferRec
{
    VPIArrayBufferAOS aos;
 
} VPIArrayBuffer;
 
typedef struct VPIArrayDataRec
{
    VPIArrayBufferType bufferType;
 
    VPIArrayBuffer buffer;
 
} VPIArrayData;
 
VPI_PUBLIC VPIStatus vpiArrayCreate(int32_t capacity, VPIArrayType type, uint64_t flags, VPIArray *array);
 
VPI_PUBLIC VPIStatus vpiArrayCreateWrapper(const VPIArrayData *data, uint64_t flags, VPIArray *array);
 
VPI_PUBLIC VPIStatus vpiArraySetWrapper(VPIArray array, const VPIArrayData *data);
 
VPI_PUBLIC void vpiArrayDestroy(VPIArray array);
 
VPI_PUBLIC VPIStatus vpiArrayGetSize(VPIArray array, int32_t *size);
 
VPI_PUBLIC VPIStatus vpiArraySetSize(VPIArray array, int32_t size);
 
VPI_PUBLIC VPIStatus vpiArrayGetCapacity(VPIArray array, int32_t *capacity);
 
VPI_PUBLIC VPIStatus vpiArrayGetStrideBytes(VPIArray array, int32_t *strideBytes);
 
VPI_PUBLIC VPIStatus vpiArrayGetFlags(VPIArray array, uint64_t *flags);
 
VPI_PUBLIC VPIStatus vpiArrayGetType(VPIArray array, VPIArrayType *type);
 
VPI_PUBLIC VPIStatus vpiArrayLock(VPIArray array, VPILockMode mode);
 
VPI_PUBLIC VPIStatus vpiArrayLockData(VPIArray array, VPILockMode mode, VPIArrayBufferType bufType, VPIArrayData *data);
 
VPI_PUBLIC VPIStatus vpiArrayUnlock(VPIArray array);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_ARRAY_H */