Jetson Linux API Reference

39.2 Release
nvsipl::ISiplControlAuto Class Referenceabstract

Detailed Description

Defines SIPL Control Auto Interface Class.

Definition at line 46 of file INvSiplControlAuto.hpp.

Public Member Functions

virtual SIPLStatus Process (const SiplControlAutoInputParam &inParams, SiplControlAutoOutputParam &outParams)=0
 Function to process auto (AE-AWB) algorithm. More...
 
virtual SIPLStatus GetIspOverrideSettings (const SiplControlEmbedInfo &currFrameEmbedInfo, SiplControlIspOverrideSetting &ispOverrideSettings)
 Function to get per-frame ISP override settings for the captured frame. More...
 
virtual SIPLStatus GetNoiseProfile (const SiplControlEmbedInfo &currFrameEmbedInfo, uint32_t const maxSupportedNoiseProfiles, uint32_t &noiseProfile)
 Function to get noise profile from captured frame embedded data. More...
 
virtual SIPLStatus Reset ()
 Function to reset to the state right after initialization. More...
 
virtual ~ISiplControlAuto ()=default
 SIPL Control Auto Interface class default destructor. More...
 

Protected Member Functions

 ISiplControlAuto ()=default
 SIPL Control Auto Interface class default constructor. More...
 

Constructor & Destructor Documentation

◆ ~ISiplControlAuto()

virtual nvsipl::ISiplControlAuto::~ISiplControlAuto ( )
virtualdefault

SIPL Control Auto Interface class default destructor.

◆ ISiplControlAuto()

nvsipl::ISiplControlAuto::ISiplControlAuto ( )
protecteddefault

SIPL Control Auto Interface class default constructor.

Member Function Documentation

◆ GetIspOverrideSettings()

virtual SIPLStatus nvsipl::ISiplControlAuto::GetIspOverrideSettings ( const SiplControlEmbedInfo &  currFrameEmbedInfo,
SiplControlIspOverrideSetting &  ispOverrideSettings 
)
inlinevirtual

Function to get per-frame ISP override settings for the captured frame.

Note
This is plugin API that is called by SIPL for getting per-frame ISP override settings to be applied for processing the captured frame.
Precondition
None.
Parameters
[in]currFrameEmbedInfoCaptured frame embedded information. Valid range: See SiplControlEmbedInfo
[out]ispOverrideSettingsPer frame ISP override settings for processing the captured frame. ISP settings enabled in this struct will override the settings from NITO. Valid range: See SiplControlIspOverrideSetting
Return values
NVSIPL_STATUS_OKon successful completion.
NVSIPL_STATUS_BAD_ARGUMENTif input parameters are invalid.
(SIPLStatus)if there are other errors.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes, with the following conditions:
      • Provided the same instance is not used on multiple threads at the same time.
    • Re-entrant: Yes
    • Async/Sync: Sync
  • Required privileges: Yes, with the following conditions:
    • Grants: nonroot, allow
    • Abilities: public_channel
    • Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
  • Allowed execution state
    • Initialization: No
    • Operational: Yes
    • Reinit/Deinit Preparation: No
    • Maturity: Experimental

Definition at line 131 of file INvSiplControlAuto.hpp.

References nvsipl::NVSIPL_STATUS_OK.

◆ GetNoiseProfile()

virtual SIPLStatus nvsipl::ISiplControlAuto::GetNoiseProfile ( const SiplControlEmbedInfo &  currFrameEmbedInfo,
uint32_t const  maxSupportedNoiseProfiles,
uint32_t &  noiseProfile 
)
inlinevirtual

Function to get noise profile from captured frame embedded data.

Note
This is plugin API that is called by SIPL for getting noise profile for the captured frame.
Precondition
None.
Parameters
[in]currFrameEmbedInfoCaptured frame embedded information. Valid range: See SiplControlEmbedInfo
[in]maxSupportedNoiseProfilesMaximum number of supported noise profiles. Valid range:[1, 32].
[out]noiseProfilecaptured frame noise profile.
Return values
NVSIPL_STATUS_OKon successful completion.
NVSIPL_STATUS_BAD_ARGUMENTif input parameters are invalid.
(SIPLStatus)if there are other errors.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes, with the following conditions:
      • Provided the same instance is not used on multiple threads at the same time.
    • Re-entrant: Yes
    • Async/Sync: Sync
  • Required privileges: Yes, with the following conditions:
    • Grants: nonroot, allow
    • Abilities: public_channel
    • Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
  • Allowed execution state
    • Initialization: No
    • Operational: Yes
    • Reinit/Deinit Preparation: No
    • Maturity: GA

Definition at line 176 of file INvSiplControlAuto.hpp.

References nvsipl::NVSIPL_STATUS_OK.

◆ Process()

virtual SIPLStatus nvsipl::ISiplControlAuto::Process ( const SiplControlAutoInputParam &  inParams,
SiplControlAutoOutputParam &  outParams 
)
pure virtual

Function to process auto (AE-AWB) algorithm.

Note
This is plugin API that is called by SIPL at run-time for processing auto(AE-AWB) algorithm.
Precondition
None.
Parameters
[in]inParamsSipl Control Auto input parameters. Valid range: See SiplControlAutoInputParam
[out]outParamSipl Control Auto output parameters.
Return values
NVSIPL_STATUS_OKon successful completion.
NVSIPL_STATUS_BAD_ARGUMENTif input parameters are invalid (range check failure).
NVSIPL_STATUS_RESOURCE_ERRORif resource related errors are detected (frame or settings drop).
(SIPLStatus)if there are other errors.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes, with the following conditions:
      • Provided the same instance is not used on multiple threads at the same time.
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: Yes, with the following conditions:
    • Grants: nonroot, allow
    • Abilities: public_channel
    • Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
  • Allowed execution state
    • Initialization: No
    • Operational: Yes
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ Reset()

virtual SIPLStatus nvsipl::ISiplControlAuto::Reset ( )
inlinevirtual

Function to reset to the state right after initialization.

Note
This is plugin API that is called by SIPL to reset SIPL Control Auto to the state right after initialization.
Precondition
None.
Return values
NVSIPL_STATUS_OKon successful completion.
(SIPLStatus)if there are other errors.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes, with the following conditions:
      • Provided the same instance is not used on multiple threads at the same time.
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: Yes, with the following conditions:
    • Grants: nonroot, allow
    • Abilities: public_channel
    • Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
  • Allowed execution state
    • Initialization: Yes
    • Operational: Yes
    • Reinit/Deinit Preparation: No
    • Maturity: GA

Definition at line 218 of file INvSiplControlAuto.hpp.

References nvsipl::NVSIPL_STATUS_NOT_SUPPORTED.


The documentation for this class was generated from the following file: