VPI - Vision Programming Interface

1.0 Release

TemporalNoiseReduction.h
Go to the documentation of this file.
1 /*
2  * Copyright 2020-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_TEMPORAL_NOISE_REDUCTION_H
57 #define NV_VPI_ALGORITHMS_TEMPORAL_NOISE_REDUCTION_H
58 
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 enum
83 {
92 
97 typedef enum
98 {
102  VPI_TNR_V3
104 
120 VPI_PUBLIC VPIStatus vpiCreateTemporalNoiseReduction(uint32_t backends, int32_t width, int32_t height,
121  VPIImageFormat imgFormat, VPITNRVersion version,
122  VPITNRPreset preset, float strength, VPIPayload *payload);
123 
142 VPI_PUBLIC VPIStatus vpiSubmitTemporalNoiseReduction(VPIStream stream, uint32_t backend, VPIPayload payload,
143  VPIImage prevFrame, VPIImage curFrame, VPIImage outFrame);
144 
147 #ifdef __cplusplus
148 }
149 #endif
150 
151 #endif /* NV_VPI_ALGORITHMS_TEMPORAL_NOISE_REDUCTION_H */
VPIImageFormat
Pre-defined image formats.
Definition: ImageFormat.h:99
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:197
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:209
VPIStatus
Status codes.
Definition: Status.h:81
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:191
VPIStatus vpiSubmitTemporalNoiseReduction(VPIStream stream, uint32_t backend, VPIPayload payload, VPIImage prevFrame, VPIImage curFrame, VPIImage outFrame)
Submits a Temporal Noise Reduction operation to the stream associated with the given payload.
VPITNRPreset
Defines scene presets for temporal noise reduction.
VPIStatus vpiCreateTemporalNoiseReduction(uint32_t backends, int32_t width, int32_t height, VPIImageFormat imgFormat, VPITNRVersion version, VPITNRPreset preset, float strength, VPIPayload *payload)
Creates a payload for Temporal Noise Reduction algorithm.
VPITNRVersion
Defines the version of the Temporal Noise Reduction algorithm to be used.
@ VPI_TNR_PRESET_OUTDOOR_HIGH_LIGHT
Bright light outdoor scene.
@ VPI_TNR_PRESET_INDOOR_HIGH_LIGHT
Bright light indoor scene.
@ VPI_TNR_PRESET_DEFAULT
Default preset, suitable for most scenes.
@ VPI_TNR_PRESET_OUTDOOR_MEDIUM_LIGHT
Medium light outdoor scene.
@ VPI_TNR_PRESET_OUTDOOR_LOW_LIGHT
Low light outdoor scene.
@ VPI_TNR_PRESET_INDOOR_LOW_LIGHT
Low light indoor scene.
@ VPI_TNR_PRESET_INDOOR_MEDIUM_LIGHT
Medium light indoor scene.
@ VPI_TNR_V2
Version 2, offers noise reduction strength control with decent processing speed.
@ VPI_TNR_V3
Version 3, offers quite good quality overall, specially in dark scenes.
@ VPI_TNR_V1
Version 1, without scene control and somewhat poor noise reduction capability specially in dark scene...
@ VPI_TNR_DEFAULT
Chooses the version with best quality available in the current device and given backend.