VPI - Vision Programming Interface

1.0 Release

Array.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 NVIDIA Corporation. All rights reserved.
3  *
4  * NOTICE TO LICENSEE:
5  *
6  * This source code and/or documentation ("Licensed Deliverables") are
7  * subject to NVIDIA intellectual property rights under U.S. and
8  * international Copyright laws.
9  *
10  * These Licensed Deliverables contained herein is PROPRIETARY and
11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12  * conditions of a form of NVIDIA software license agreement by and
13  * between NVIDIA and Licensee ("License Agreement") or electronically
14  * accepted by Licensee. Notwithstanding any terms or conditions to
15  * the contrary in the License Agreement, reproduction or disclosure
16  * of the Licensed Deliverables to any third party without the express
17  * written consent of NVIDIA is prohibited.
18  *
19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32  * OF THESE LICENSED DELIVERABLES.
33  *
34  * U.S. Government End Users. These Licensed Deliverables are a
35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36  * 1995), consisting of "commercial computer software" and "commercial
37  * computer software documentation" as such terms are used in 48
38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39  * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41  * U.S. Government End Users acquire the Licensed Deliverables with
42  * only those rights set forth herein.
43  *
44  * Any use of the Licensed Deliverables in individual and commercial
45  * software must include, in the user documentation and internal
46  * comments to the code, the above Disclaimer and U.S. Government End
47  * Users Notice.
48  */
49 
56 #ifndef NV_VPI_ARRAY_H
57 #define NV_VPI_ARRAY_H
58 
59 #include "Export.h"
60 #include "Status.h"
61 #include "Types.h"
62 
63 #include <stdint.h>
64 
111 #include "ArrayType.h"
112 
113 #ifdef __cplusplus
114 extern "C" {
115 #endif
116 
118 typedef struct VPIArrayDataRec
119 {
121  int32_t *sizePointer;
122  int32_t capacity;
123  int32_t strideBytes;
124  void *data;
125 } VPIArrayData;
126 
143 VPI_PUBLIC VPIStatus vpiArrayCreate(int32_t capacity, VPIArrayType type, uint32_t flags, VPIArray *array);
144 
167 VPI_PUBLIC VPIStatus vpiArrayCreateHostMemWrapper(const VPIArrayData *arrayData, uint32_t flags, VPIArray *array);
168 
189 VPI_PUBLIC VPIStatus vpiArraySetWrappedHostMem(VPIArray array, const VPIArrayData *arrayData);
190 
199 VPI_PUBLIC void vpiArrayDestroy(VPIArray array);
200 
215 
224 VPI_PUBLIC VPIStatus vpiArrayGetSize(VPIArray array, int32_t *size);
225 
234 VPI_PUBLIC VPIStatus vpiArraySetSize(VPIArray array, int32_t size);
235 
244 VPI_PUBLIC VPIStatus vpiArrayGetCapacity(VPIArray array, int32_t *capacity);
245 
254 VPI_PUBLIC VPIStatus vpiArrayGetStrideBytes(VPIArray array, int32_t *strideBytes);
255 
264 VPI_PUBLIC VPIStatus vpiArrayGetFlags(VPIArray array, uint32_t *flags);
265 
275 
295 VPI_PUBLIC VPIStatus vpiArrayLock(VPIArray array, VPILockMode mode, VPIArrayData *arrayData);
296 
310 
311 #ifdef __cplusplus
312 }
313 #endif
314 
317 #endif /* NV_VPI_ARRAY_H */
Defines array types.
Declaration of VPI status codes handling functions.
Defines all types needed for programming with VPI.
int32_t * sizePointer
Points to the number of elements in the array.
Definition: Array.h:121
int32_t capacity
Maximum number of elements that the array can hold.
Definition: Array.h:122
VPIArrayType format
Format of each array element.
Definition: Array.h:120
int32_t strideBytes
Size in bytes of each array element.
Definition: Array.h:123
void * data
Points to the first element of the array.
Definition: Array.h:124
VPIStatus vpiArraySetSize(VPIArray array, int32_t size)
Set the array size in elements.
VPIStatus vpiArrayUnlock(VPIArray array)
Releases the lock on array object.
VPIStatus vpiArrayGetFormat(VPIArray array, VPIArrayType *type)
Returns the array type.
VPIStatus vpiArrayLock(VPIArray array, VPILockMode mode, VPIArrayData *arrayData)
Acquires the lock on array object and returns a pointer to array data.
void vpiArrayDestroy(VPIArray array)
Destroy an array instance.
VPIStatus vpiArrayGetStrideBytes(VPIArray array, int32_t *strideBytes)
Returns the array stride (distance between two consecutive elements) in bytes.
VPIArrayType
Array element formats.
Definition: ArrayType.h:67
VPIStatus vpiArrayGetFlags(VPIArray array, uint32_t *flags)
Returns the array flags.
VPIStatus vpiArrayCreate(int32_t capacity, VPIArrayType type, uint32_t flags, VPIArray *array)
Create an empty array instance.
VPIStatus vpiArrayGetSize(VPIArray array, int32_t *size)
Returns the array size in elements.
struct VPIArrayImpl * VPIArray
A handle to an array.
Definition: Types.h:173
VPIStatus vpiArrayGetCapacity(VPIArray array, int32_t *capacity)
Returns the array capacity in elements.
VPIStatus vpiArrayInvalidate(VPIArray array)
Informs that the array's wrapped memory was updated outside VPI.
Stores information about array characteristics and content.
Definition: Array.h:119
VPIStatus vpiArraySetWrappedHostMem(VPIArray array, const VPIArrayData *arrayData)
Redefines the wrapped host memory in an existing VPIArray wrapper.
VPIStatus vpiArrayCreateHostMemWrapper(const VPIArrayData *arrayData, uint32_t flags, VPIArray *array)
Create an array object by wrapping an existing host memory block.
VPIStatus
Status codes.
Definition: Status.h:81
VPILockMode
Defines the lock modes used by memory lock functions.
Definition: Types.h:345