VPI - Vision Programming Interface

1.0 Release

Status.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_STATUS_H
57 #define NV_VPI_STATUS_H
58 
59 #include "Export.h"
60 
61 #include <stdint.h>
62 
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76 
80 typedef enum
81 {
96 
105 VPI_PUBLIC const char *vpiStatusGetName(VPIStatus code);
106 
112 #define VPI_MAX_STATUS_MESSAGE_LENGTH 256
113 
122 
136 VPI_PUBLIC VPIStatus vpiGetLastStatusMessage(char *msgBuffer, int32_t lenBuffer);
137 
145 
158 VPI_PUBLIC VPIStatus vpiPeekAtLastStatusMessage(char *msgBuffer, int32_t lenBuffer);
159 
162 #ifdef __cplusplus
163 }
164 #endif
165 
166 #endif /* NV_VPI_STATUS_H */
VPIStatus
Status codes.
Definition: Status.h:81
VPIStatus vpiGetLastStatus()
Returns and resets the status of the last VPI function call in current thread.
VPIStatus vpiPeekAtLastStatusMessage(char *msgBuffer, int32_t lenBuffer)
Returns and status code and message of the last VPI function call in current thread.
const char * vpiStatusGetName(VPIStatus code)
Returns a string representation of the status code.
VPIStatus vpiPeekAtLastStatus()
Returns the status of the last VPI function call in current thread.
VPIStatus vpiGetLastStatusMessage(char *msgBuffer, int32_t lenBuffer)
Returns and resets the status code and message of the last VPI function call in current thread.
@ VPI_SUCCESS
Operation completed successfully.
Definition: Status.h:82
@ VPI_ERROR_INTERNAL
Internal, non specific error.
Definition: Status.h:94
@ VPI_ERROR_BUFFER_LOCKED
Invalid operation on a locked buffer.
Definition: Status.h:92
@ VPI_ERROR_INVALID_CONTEXT
Context is invalid or is already destroyed.
Definition: Status.h:89
@ VPI_ERROR_NOT_READY
Operation not completed yet, try again later.
Definition: Status.h:91
@ VPI_ERROR_INVALID_ARRAY_TYPE
Array type not accepted.
Definition: Status.h:86
@ VPI_ERROR_OUT_OF_MEMORY
Not enough free memory to allocate object.
Definition: Status.h:93
@ VPI_ERROR_DEVICE
Device backend error.
Definition: Status.h:90
@ VPI_ERROR_INVALID_PAYLOAD_TYPE
Payload not created for this algorithm.
Definition: Status.h:87
@ VPI_ERROR_INVALID_ARGUMENT
Invalid argument, either wrong range or value not accepted.
Definition: Status.h:84
@ VPI_ERROR_NOT_IMPLEMENTED
Operation isn't implemented.
Definition: Status.h:83
@ VPI_ERROR_INVALID_IMAGE_FORMAT
Image type not accepted.
Definition: Status.h:85
@ VPI_ERROR_INVALID_OPERATION
Operation isn't valid in this context.
Definition: Status.h:88