VPI - Vision Programming Interface

0.2.0 Release

Stream.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019 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_STREAM_H
57 #define NV_VPI_STREAM_H
58 
80 #include "Export.h"
81 #include "Status.h"
82 #include "Types.h"
83 
88 typedef struct CUstream_st *CUstream;
89 
90 #ifdef __cplusplus
91 extern "C" {
92 #endif
93 
102 VPI_PUBLIC VPIStatus vpiStreamCreate(VPIDeviceType devType, VPIStream *stream);
103 
111 VPI_PUBLIC VPIStatus vpiStreamWrapCuda(CUstream cudaStream, VPIStream *stream);
112 
118 VPI_PUBLIC void vpiStreamDestroy(VPIStream stream);
119 
126 VPI_PUBLIC VPIStatus vpiStreamGetDeviceType(VPIStream stream, VPIDeviceType *deviceType);
127 
137 VPI_PUBLIC VPIStatus vpiStreamSync(VPIStream stream);
138 
148 VPI_PUBLIC VPIStatus vpiStreamWaitFor(VPIStream stream, VPIEvent event);
149 
158 
165 VPI_PUBLIC void vpiPayloadDestroy(VPIPayload payload);
166 
167 #ifdef __cplusplus
168 }
169 #endif
170  // end of VPI_Stream
172 
173 #endif // NV_VPI_STREAM_H
Export.h
VPIDeviceType
VPIDeviceType
Device types.
Definition: Types.h:513
vpiStreamGetThreadHandle
VPIStatus vpiStreamGetThreadHandle(VPIStream stream, VPINativeThreadHandle *handle)
Returns OS-specific handle of the background stream processing thread.
Types.h
vpiStreamWrapCuda
VPIStatus vpiStreamWrapCuda(CUstream cudaStream, VPIStream *stream)
Wraps an existing CUDA stream in a VPI stream for CUDA backend.
vpiStreamCreate
VPIStatus vpiStreamCreate(VPIDeviceType devType, VPIStream *stream)
Create a stream instance.
vpiStreamSync
VPIStatus vpiStreamSync(VPIStream stream)
Blocks the calling thread until all submitted commands in this stream queue are done (queue is empty)...
vpiStreamDestroy
void vpiStreamDestroy(VPIStream stream)
Destroy a stream instance and deallocate all HW resources.
VPIEvent
struct VPIEventImpl * VPIEvent
Definition: Types.h:158
VPIStatus
VPIStatus
Error codes.
Definition: Types.h:488
vpiStreamWaitFor
VPIStatus vpiStreamWaitFor(VPIStream stream, VPIEvent event)
Pushes a command that blocks the processing of all future commands by the backend until the event is ...
Status.h
VPIPayload
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:181
vpiPayloadDestroy
void vpiPayloadDestroy(VPIPayload payload)
Deallocates the payload object and all associated resources.
VPINativeThreadHandle
void * VPINativeThreadHandle
Definition: Types.h:140
vpiStreamGetDeviceType
VPIStatus vpiStreamGetDeviceType(VPIStream stream, VPIDeviceType *deviceType)
Returns the backend type associated with the given stream.
VPIStream
struct VPIStreamImpl * VPIStream
Definition: Types.h:164