Jetson Linux API Reference

39.2 Release
INvSiplControlAuto.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
13 /* NVIDIA SIPL Control Auto Interface */
14 
15 #ifndef NVSIPLCONTROLAUTOINTERFACE_HPP
16 #define NVSIPLCONTROLAUTOINTERFACE_HPP
17 
18 
19 #include "NvSIPLCommon.hpp"
20 #include "NvSiplControlAutoDef.hpp"
21 
35 namespace nvsipl
36 {
37 
47 
48 public:
86  virtual SIPLStatus Process(const SiplControlAutoInputParam& inParams,
87  SiplControlAutoOutputParam& outParams) = 0;
88 
89 
90 
131  virtual SIPLStatus GetIspOverrideSettings(const SiplControlEmbedInfo& currFrameEmbedInfo,
132  SiplControlIspOverrideSetting& ispOverrideSettings) {
133  static_cast<void>(currFrameEmbedInfo);
134  ispOverrideSettings = {};
135  return NVSIPL_STATUS_OK;
136  }
137 
176  virtual SIPLStatus GetNoiseProfile(const SiplControlEmbedInfo& currFrameEmbedInfo,
177  uint32_t const maxSupportedNoiseProfiles,
178  uint32_t& noiseProfile) {
179  static_cast<void>(currFrameEmbedInfo);
180  static_cast<void>(maxSupportedNoiseProfiles);
181  noiseProfile = 0U;
182  return NVSIPL_STATUS_OK;
183  }
184 
218  virtual SIPLStatus Reset() {
220  }
221 
223  virtual ~ISiplControlAuto() = default;
224 
225 protected:
227  ISiplControlAuto() = default;
228 
229 private:
230 
232  ISiplControlAuto(ISiplControlAuto const &) = delete;
234  ISiplControlAuto& operator= (ISiplControlAuto const &) & = delete;
235 
237  ISiplControlAuto(ISiplControlAuto &&) = delete;
239  ISiplControlAuto& operator= (ISiplControlAuto &&) & = delete;
240 };
241 
244 } // namespace nvsipl
245 
246 #endif // NVSIPLCONTROLAUTOINTERFACE_HPP
nvsipl::NVSIPL_STATUS_NOT_SUPPORTED
@ NVSIPL_STATUS_NOT_SUPPORTED
Indicates an unsupported operation or argument was encountered.
Definition: NvSIPLCommon.hpp:164
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
nvsipl::NVSIPL_STATUS_OK
@ NVSIPL_STATUS_OK
Indicates the operation completed successfully without errors.
Definition: NvSIPLCommon.hpp:158
nvsipl::SiplControlAutoOutputParam
AE/AWB Output parameters.
Definition: NvSiplControlAutoDef.hpp:560
nvsipl::ISiplControlAuto::Reset
virtual SIPLStatus Reset()
Function to reset to the state right after initialization.
Definition: INvSiplControlAuto.hpp:218
NvSiplControlAutoDef.hpp
NVIDIA SIPL: Auto Control Settings - SIPL Auto Control
nvsipl::ISiplControlAuto::~ISiplControlAuto
virtual ~ISiplControlAuto()=default
SIPL Control Auto Interface class default destructor.
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:153
nvsipl::SiplControlIspOverrideSetting
Structure containing dynamic override ISP block settings to be applied during runtime.
Definition: NvSiplControlAutoDef.hpp:393
nvsipl::SiplControlAutoInputParam
Input parameters for processing AE/AWB.
Definition: NvSiplControlAutoDef.hpp:538
nvsipl::SiplControlEmbedInfo
Parsed frame embedded information.
Definition: NvSiplControlAutoDef.hpp:93
nvsipl::ISiplControlAuto::GetNoiseProfile
virtual SIPLStatus GetNoiseProfile(const SiplControlEmbedInfo &currFrameEmbedInfo, uint32_t const maxSupportedNoiseProfiles, uint32_t &noiseProfile)
Function to get noise profile from captured frame embedded data.
Definition: INvSiplControlAuto.hpp:176
nvsipl::ISiplControlAuto::GetIspOverrideSettings
virtual SIPLStatus GetIspOverrideSettings(const SiplControlEmbedInfo &currFrameEmbedInfo, SiplControlIspOverrideSetting &ispOverrideSettings)
Function to get per-frame ISP override settings for the captured frame.
Definition: INvSiplControlAuto.hpp:131
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: NvSIPLCameraQuery.hpp:22
nvsipl::ISiplControlAuto::ISiplControlAuto
ISiplControlAuto()=default
SIPL Control Auto Interface class default constructor.
nvsipl::ISiplControlAuto
Defines SIPL Control Auto Interface Class.
Definition: INvSiplControlAuto.hpp:46
nvsipl::ISiplControlAuto::Process
virtual SIPLStatus Process(const SiplControlAutoInputParam &inParams, SiplControlAutoOutputParam &outParams)=0
Function to process auto (AE-AWB) algorithm.