VPI - Vision Programming Interface

2.4 Release

StereoDisparity.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2023 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 
50 #ifndef NV_VPI_ALGORITHMS_STEREO_DISPARITY_H
51 #define NV_VPI_ALGORITHMS_STEREO_DISPARITY_H
52 
59 #include "../Export.h"
60 #include "../ImageFormat.h"
61 #include "../Status.h"
62 #include "../Types.h"
63 
64 #include <stdint.h>
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
82 typedef struct
83 {
93  int32_t maxDisparity;
94 
101 
109 
111 
125 #if NV_VPI_VERSION_API_AT_MOST(2, 2)
126 __asm__(".symver vpiInitStereoDisparityEstimatorCreationParams,vpiInitStereoDisparityEstimatorCreationParams@VPI_2.0");
128 #else
130 #endif
131 
192 VPI_PUBLIC VPIStatus vpiCreateStereoDisparityEstimator(uint64_t backends, int32_t imageWidth, int32_t imageHeight,
193  VPIImageFormat inputFormat,
195  VPIPayload *payload);
196 
203 typedef enum
204 {
209 
214 
216 
220 typedef struct
221 {
230  int32_t windowSize;
231 
235  int32_t maxDisparity;
236 
241 
246  int32_t quality;
247 
252 
257  int32_t minDisparity;
258 
266  int32_t p1;
267 
277  int32_t p2;
278 
290  int32_t p2Alpha;
291 
299  float uniqueness;
300 
307  int8_t numPasses;
308 
310 
332 #if NV_VPI_VERSION_API_AT_MOST(2, 2)
333 __asm__(".symver vpiInitStereoDisparityEstimatorParams,vpiInitStereoDisparityEstimatorParams@VPI_2.0");
335 #else
337 #endif
338 
403 #if NV_VPI_VERSION_API_AT_MOST(2, 2)
404 __asm__(".symver vpiSubmitStereoDisparityEstimator,vpiSubmitStereoDisparityEstimator@VPI_2.0");
405 VPI_PUBLIC VPIStatus vpiSubmitStereoDisparityEstimator(VPIStream stream, uint64_t backend, VPIPayload payload,
406  VPIImage left, VPIImage right, VPIImage disparity,
407  VPIImage confidenceMap,
408  const VPIStereoDisparityEstimatorParams *params);
409 #else
410 VPI_PUBLIC VPIStatus vpiSubmitStereoDisparityEstimator(VPIStream stream, uint64_t backend, VPIPayload payload,
411  VPIImage left, VPIImage right, VPIImage disparity,
412  VPIImage confidenceMap,
413  const VPIStereoDisparityEstimatorParams *params);
414 #endif
415 
418 #ifdef __cplusplus
419 }
420 #endif
421 
422 #endif /* NV_VPI_ALGORITHMS_STEREO_DISPARITY_H */
uint64_t VPIImageFormat
Pre-defined image formats.
Definition: ImageFormat.h:94
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:256
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:268
VPIStatus
Status codes.
Definition: Status.h:81
int32_t p2Alpha
Alpha is used to enable adaptive large penalty (adaptive P2) feature.
int32_t p1
Penalty on disparity changes of +/- 1 between neighbor pixels.
int32_t maxDisparity
Maximum disparity for matching search.
float uniqueness
Uniqueness ratio, in [0, 1] range, is a margin by which best cost value should win over the second be...
VPIStereoDisparityConfidenceType confidenceType
Computation type to produce the confidence output.
int32_t windowSize
Represents the median filter size (on PVA+NVENC+VIC or OFA+PVA+VIC backend) or census transform windo...
int32_t minDisparity
Minimum possible disparity value.
int32_t quality
Quality of disparity output.
int32_t confidenceThreshold
Confidence threshold above which disparity values are considered valid.
int32_t downscaleFactor
Output's downscale factor with respect to the input's resolution.
int32_t p2
Penalty on disparity changes of more than 1 between neighbor pixels.
int8_t numPasses
Number of passes in memory-efficient semi-global matching (eSGM) computation.
int32_t maxDisparity
Maximum disparity for matching search.
int8_t includeDiagonals
Include diagonals or oblique paths in semi-global matching (SGM) computation.
VPIStatus vpiInitStereoDisparityEstimatorCreationParams(VPIStereoDisparityEstimatorCreationParams *params)
Initializes VPIStereoDisparityEstimatorCreationParams with default values.
VPIStatus vpiCreateStereoDisparityEstimator(uint64_t backends, int32_t imageWidth, int32_t imageHeight, VPIImageFormat inputFormat, const VPIStereoDisparityEstimatorCreationParams *params, VPIPayload *payload)
Creates payload for vpiSubmitStereoDisparityEstimator.
VPIStatus vpiInitStereoDisparityEstimatorParams(VPIStereoDisparityEstimatorParams *params)
Initializes VPIStereoDisparityEstimatorParams with default values.
VPIStereoDisparityConfidenceType
Defines the way the confidence values are computed.
VPIStatus vpiSubmitStereoDisparityEstimator(VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage left, VPIImage right, VPIImage disparity, VPIImage confidenceMap, const VPIStereoDisparityEstimatorParams *params)
Runs stereo processing on a pair of images and outputs a disparity map.
@ VPI_STEREO_CONFIDENCE_RELATIVE
The U16 confidence value of a pixel is given by: [ 1 - abs(D_lr - D_rl) / D_lr ] * 0xFFFF.
@ VPI_STEREO_CONFIDENCE_ABSOLUTE
The U16 confidence value of a pixel is given by: [ 1 - abs(D_lr - D_rl) / MAX_DISP ] * 0xFFFF.
Structure that defines the parameters for vpiCreateStereoDisparityEstimator.
Structure that defines the parameters for vpiSubmitStereoDisparityEstimator.
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:250