nvsipl::ISiplControlAuto Class Reference

Detailed Description

Defines SIPL Control Auto Interface Class.

Definition at line 44 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	GetNoiseProfile (const SiplControlEmbedInfo &currFrameEmbedInfo, const uint32_t maxSupportedNoiseProfiles, uint32_t &noiseProfile)
	Function to get captured frame noise profile. More...
virtual SIPLStatus	Reset ()
	Function to reset to state right after initialization. More...
virtual	~ISiplControlAuto ()=default
	Default destructor. More...

Protected Member Functions
	ISiplControlAuto ()=default
	Default constructor. More...

Constructor & Destructor Documentation

~ISiplControlAuto()

virtual nvsipl::ISiplControlAuto::~ISiplControlAuto ( )

virtualdefault

Default destructor.

ISiplControlAuto()

nvsipl::ISiplControlAuto::ISiplControlAuto ( )

protecteddefault

Default constructor.

Member Function Documentation

GetNoiseProfile()

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

inlinevirtual

Function to get captured frame noise profile.

This is plugin API that is called by SIPL.

Precondition

None.

Parameters

[in]	currFrameEmbedInfo	Captured frame embedded information. Valid range: See SiplControlEmbedInfo
[in]	maxSupportedNoiseProfiles	Maximum number of supported noise profiles. Supported range:[1, 32].
[out]	noiseProfile	output noise profile for captured frame ISP processing

Returns

• NVSIPL_STATUS_OK: on successful completion
• NVSIPL_STATUS_NOT_INITIALIZED: if object is not initialized.
• NVSIPL_STATUS_BAD_ARGUMENT: an error status if input parameters are invalid.
• NVSIPL_STATUS_ERROR: an error status 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
• API group
  • Init: No
  • Runtime: Yes
  • De-Init: No

Definition at line 119 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.

This is plugin API that is called by SIPL.

Precondition

None.

Parameters

[in]	inParams	Sipl Control Auto input parameters. Valid range: See SiplControlAutoInputParam
[out]	outParam	Sipl Control Auto output parameters.

Returns

• NVSIPL_STATUS_OK: on successful completion
• NVSIPL_STATUS_BAD_ARGUMENT: an error status if input parameters are invalid.
• NVSIPL_STATUS_NOT_INITIALIZED: an error status if not initialized.
• NVSIPL_STATUS_ERROR: an error status 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
• API group
  • Init: No
  • Runtime: Yes
  • De-Init: No

Reset()

virtual SIPLStatus nvsipl::ISiplControlAuto::Reset ( )

inlinevirtual

Function to reset to state right after initialization.

This is plugin API that is called by SIPL.

Precondition

None.

Returns

• NVSIPL_STATUS_OK: on successful completion
• NVSIPL_STATUS_NOT_INITIALIZED: an error status if not initialized.

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
• API group
  • Init: Yes
  • Runtime: Yes
  • De-Init: No

Definition at line 155 of file INvSiplControlAuto.hpp.

References nvsipl::NVSIPL_STATUS_NOT_SUPPORTED.

---

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

• INvSiplControlAuto.hpp