VPI - Vision Programming Interface

3.0 Release

OpticalFlowDense.h
Go to the documentation of this file.
1 /*
2  * Copyright 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_ALGORITHMS_OPTICALFLOWDENSE_H
57 #define NV_VPI_ALGORITHMS_OPTICALFLOWDENSE_H
58 
68 #include "../Export.h"
69 #include "../ImageFormat.h"
70 #include "../Pyramid.h"
71 #include "../Status.h"
72 #include "../Types.h"
73 
74 #include <stdbool.h>
75 #include <stdint.h>
76 
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80 
151 VPI_PUBLIC VPIStatus vpiCreateOpticalFlowDense(uint64_t backends, int32_t width, int32_t height,
152  VPIImageFormat inputFmt, const int32_t *gridSize, int32_t numLevels,
153  VPIOpticalFlowQuality quality, VPIPayload *payload);
197 VPI_PUBLIC VPIStatus vpiSubmitOpticalFlowDense(VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage prevImg,
198  VPIImage curImg, VPIImage mvImg);
199 
245 VPI_PUBLIC VPIStatus vpiSubmitOpticalFlowDensePyramid(VPIStream stream, uint64_t backend, VPIPayload payload,
246  VPIPyramid prevPyr, VPIPyramid curPyr, VPIImage mvImg);
247 
252 typedef struct
253 {
257 
261 
265  int32_t p2Alpha[VPI_MAX_PYRAMID_LEVEL_COUNT];
266 
270  int32_t numPasses[VPI_MAX_PYRAMID_LEVEL_COUNT];
271 
275  int8_t includeDiagonals[VPI_MAX_PYRAMID_LEVEL_COUNT];
277 
292 
310 
311 #ifdef __cplusplus
312 }
313 #endif
314  // end of VPI_OpticalFlowDense
316 
317 #endif // NV_VPI_ALGORITHMS_OPTICALFLOWDENSE_H
uint64_t VPIImageFormat
Pre-defined image formats.
Definition: ImageFormat.h:94
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:256
VPIStatus vpiCreateOpticalFlowDense(uint64_t backends, int32_t width, int32_t height, VPIImageFormat inputFmt, const int32_t *gridSize, int32_t numLevels, VPIOpticalFlowQuality quality, VPIPayload *payload)
Creates payload for vpiSubmitOpticalFlowDense.
VPIStatus vpiOpticalFlowDenseGetSGMParams(VPIPayload payload, VPIOpticalFlowDenseSGMParams *sgmParams)
Retrieves the semi-global matching parameters set up in the Dense Optical Flow payload.
VPIStatus vpiOpticalFlowDenseSetSGMParams(VPIPayload payload, const VPIOpticalFlowDenseSGMParams *sgmParams)
Sets the semi-global matching parameters to be used by the Dense Optical Flow operations with the giv...
VPIStatus vpiSubmitOpticalFlowDense(VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage prevImg, VPIImage curImg, VPIImage mvImg)
Runs dense Optical Flow on two frames, outputting motion vectors.
VPIStatus vpiSubmitOpticalFlowDensePyramid(VPIStream stream, uint64_t backend, VPIPayload payload, VPIPyramid prevPyr, VPIPyramid curPyr, VPIImage mvImg)
Runs dense Optical Flow on two frames, outputting motion vectors.
Dense optical flow parameters for semi-global matching pass.
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:268
struct VPIPyramidImpl * VPIPyramid
A handle to an image pyramid.
Definition: Types.h:262
#define VPI_MAX_PYRAMID_LEVEL_COUNT
Maximum number of pyramid levels.
Definition: Pyramid.h:105
VPIStatus
Status codes.
Definition: Status.h:81
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:250
VPIOpticalFlowQuality
Defines the quality of the optical flow algorithm.
Definition: Types.h:576