Describes a SIPL buffer containing an NvSciBufObj.
Definition at line 335 of file NvSIPLClient.hpp.
|
| | INvSIPLNvMBuffer ()=default |
| | Default constructor declared in order to allow construction of derived objects. More...
|
| |
◆ ~INvSIPLNvMBuffer()
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::~INvSIPLNvMBuffer |
( |
| ) |
|
|
overridedefault |
◆ INvSIPLNvMBuffer() [1/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
INvSIPLNvMBuffer & |
other | ) |
|
|
delete |
◆ INvSIPLNvMBuffer() [2/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
INvSIPLNvMBuffer && |
other | ) |
|
|
delete |
◆ INvSIPLNvMBuffer() [3/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
| ) |
|
|
protecteddefault |
Default constructor declared in order to allow construction of derived objects.
◆ AddNvSciSyncPrefence()
| virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::AddNvSciSyncPrefence |
( |
NvSciSyncFence const & |
prefence | ) |
|
|
pure virtualinherited |
Add an NvSciSync prefence.
Add an NvSciSync prefence to be used with the next ISP or ICP operation. ICP operations support up to 16 unique pre-fences per pipeline ISP operations support up to 16 unique pre-fences per pipeline
- Attention
- This function creates its own duplicate of the fence, so the caller must clear their copy of the fence by calling NvSciSyncFenceClear().
-
The caller ensure that the added prefences expire in a timely manner.
- Note
- Users need to ensure that the number of unique pre-fences for ISP does not exceed 16 across the all output buffers if using more than one ISP outputs for the pipeline.
- Precondition
- None.
- Parameters
-
| [in] | prefence | Prefence to be added. |
- Return values
-
| NVSIPL_STATUS_OK | The function succeeds. |
| NVSIPL_STATUS_ERROR | If internal NvSci fence operations fail. |
| (SIPLStatus) | Other values of SIPLStatus if there are failures due to dependencies. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ AddRef()
| virtual void nvsipl::INvSIPLClient::INvSIPLBuffer::AddRef |
( |
| ) |
|
|
pure virtualinherited |
Adds a reference.
Adding a reference to the buffer ensures that this buffer is not re-used by the producer of the buffer.
- Attention
- The user must release the references in a timely manner using Release to avoid starving SIPL of the buffers required for capture and/or processing
- Precondition
- None.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes, with the following conditions:
- There is no active release operation that results in the buffer available for re-use.
- 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
◆ GetEOFNvSciSyncFence()
| virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::GetEOFNvSciSyncFence |
( |
NvSciSyncFence *const |
postfence | ) |
|
|
pure virtualinherited |
Retrieve the latest NvSciSync EOF fence.
Retrieve the buffer's latest NvSciSync EOF fence associated with the engine's set NvSciSync EOF object.
- Attention
- The caller must clear the returned fence by calling NvSciSyncFenceClear().
- Precondition
- None.
- Parameters
-
| [out] | postfence | EOF fence being returned. |
- Return values
-
| NVSIPL_STATUS_OK | The function succeeds. |
| NVSIPL_STATUS_ERROR | If internal NvSci fence operations fail. |
| (SIPLStatus) | Other values of SIPLStatus if there are failures due to dependencies. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ GetImageData()
| virtual ImageMetaData const& nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageData |
( |
| ) |
const |
|
pure virtual |
Gets an nvsipl::INvSIPLClient::ImageMetaData associated with NvSciBufObj.
- Precondition
- Should be called after EOF for the capture buffer has expired.
- Returns
- A const reference to nvsipl::INvSIPLClient::ImageMetaData.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ GetImageEmbeddedData()
| virtual ImageEmbeddedData const& nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageEmbeddedData |
( |
| ) |
const |
|
pure virtual |
Gets an nvsipl::INvSIPLClient::ImageEmbeddedData this is the RAW data associated with the captured image from the sensor before it is parsed to ImageMetaData structure.
- Precondition
- Should be called after EOF for the capture buffer has expired.
- Returns
- A const reference to nvsipl::INvSIPLClient::ImageEmbeddedData.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ GetNvSciBufImage()
| virtual NvSciBufObj nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetNvSciBufImage |
( |
| ) |
const |
|
pure virtual |
Gets a handle to NvSciBufObj.
- Precondition
- Should be called after EOF for the capture buffer has expired.
- Returns
- A NvSciBufObj.
-
nullptr If a buffer is dropped.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ GetSOFNvSciSyncFence()
| virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::GetSOFNvSciSyncFence |
( |
NvSciSyncFence *const |
sofFence | ) |
|
|
pure virtualinherited |
Retrieve the latest NvSciSync SOF fence.
Retrieve the buffer's latest NvSciSync SOF fence associated with the engine's set NvSciSync SOF object.
- Attention
- The caller must clear the returned fence by calling NvSciSyncFenceClear().
-
In case of ISP buffers, a null pointer is returned.
- Precondition
- None.
- Parameters
-
| [out] | sofFence | SOF fence being returned. |
- Return values
-
| NVSIPL_STATUS_OK | The function succeeds. |
| NVSIPL_STATUS_ERROR | If internal NvSci fence operations fail. |
| (SIPLStatus) | Other values of SIPLStatus if there are failures due to dependencies. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
◆ operator=() [1/2]
Delete move assignment operator.
◆ operator=() [2/2]
Delete copy assignment operator.
◆ Release()
| virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::Release |
( |
| ) |
|
|
pure virtualinherited |
Release a reference.
Once the reference has been released as many times as the reference was added, it implies that the user has finished working with the buffer and the buffer is available for re-use by SIPL.
- Precondition
- None.
- Return values
-
| NVSIPL_STATUS_OK | The releasing operation succeeds. |
| NVSIPL_STATUS_BAD_ARGUMENT | If the buffer is already released. |
| (SIPLStatus) | Other values of SIPLStatus if there are failures due to dependencies. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- 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
The documentation for this class was generated from the following file: