NVIDIA DRIVE OS Linux SDK API Reference

6.0.5 Release
NvSIPLPipelineMgr.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA CORPORATION and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA CORPORATION is strictly prohibited.
9  */
10 
11 #ifndef NVSIPLPIPELINEMGR_HPP
12 #define NVSIPLPIPELINEMGR_HPP
13 
14 #include "NvSIPLCommon.hpp"
15 #include "NvSIPLClient.hpp"
16 #include "NvSIPLPlatformCfg.hpp"
17 #include "NvSIPLInterrupts.hpp"
18 
19 #include <cstdint>
20 #include <vector>
21 
30 namespace nvsipl
31 {
52 {
54  static constexpr uint32_t MAX_DEVICE_GPIOS {8U};
55 
56 public:
59  {
65 
71 
77 
85 
91 
97 
103 
109 
115 
121 
127 
133 
139 
145 
151 
157 
163 
170  };
171 
177  {
181  uint32_t uIndex;
183  uint8_t uLinkMask;
185  uint64_t frameCaptureTSC;
189  InterruptCode intrCode;
191  uint64_t intrData;
193  uint32_t gpioIdxs[MAX_DEVICE_GPIOS];
195  uint32_t numGpioIdxs;
196  };
197 
199  virtual ~NvSIPLPipelineNotifier(void) = default;
200 };
201 
219 {
220 public:
222  struct RawBuffer
223  {
227  uint32_t uIndex;
233  uint64_t frameCaptureTSC;
236  };
237 
249  virtual SIPLStatus FillRawBuffer(RawBuffer &oRawBuffer) = 0;
250 
252  virtual ~NvSIPLImageGroupWriter(void) = default;
253 };
254 
260 {
263 
265  bool isp0OutputRequested {false};
266 
268  bool isp1OutputRequested {false};
269 
271  bool isp2OutputRequested {false};
272 
275 
282 
285 
287  bool enableSubframe {false};
288 };
289 
294 {
295 public:
296 
335  size_t const timeoutUsec) = 0;
336 
361  virtual size_t GetCount() const = 0;
362 
363 protected:
364 
365  INvSIPLFrameCompletionQueue() = default;
366  virtual ~INvSIPLFrameCompletionQueue() = default;
367 
368 private:
369 
371  INvSIPLFrameCompletionQueue& operator=(INvSIPLFrameCompletionQueue const& rhs) = delete;
372 };
373 
378 {
379 public:
380 
416  size_t const timeoutUsec) = 0;
417 
442  virtual size_t GetCount() const = 0;
443 
444 protected:
445 
446  INvSIPLNotificationQueue() = default;
447  virtual ~INvSIPLNotificationQueue() = default;
448 
449 private:
450 
451  INvSIPLNotificationQueue(INvSIPLNotificationQueue const& other) = delete;
452  INvSIPLNotificationQueue& operator=(INvSIPLNotificationQueue const& rhs) = delete;
453 };
454 
461 {
467 
473 
479 
485 
488 };
489 
494 {
497 };
498 
501 } // namespace nvsipl
502 
503 
504 #endif // NVSIPLPIPELINEMGR_HPP
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_SENSOR_FAILURE
@ NOTIF_ERROR_SENSOR_FAILURE
Device block event, indicates a sensor failure.
Definition: NvSIPLPipelineMgr.hpp:156
NvSIPLClient.hpp
NVIDIA SIPL: Client Interface - NvSIPL Client
nvsipl::NvSIPLPipelineNotifier::NOTIF_WARN_ICP_FRAME_DISCONTINUITY
@ NOTIF_WARN_ICP_FRAME_DISCONTINUITY
Pipeline event, indicates a discontinuity was detected in parsed embedded data frame sequence number.
Definition: NvSIPLPipelineMgr.hpp:96
nvsipl::NvSIPLPipelineQueues::notificationQueue
INvSIPLNotificationQueue * notificationQueue
The queue for event notifications.
Definition: NvSIPLPipelineMgr.hpp:487
nvsipl::NvSIPLPipelineNotifier::NotificationData::frameCaptureTSC
uint64_t frameCaptureTSC
Holds the TSC timestamp of the end of frame for capture.
Definition: NvSIPLPipelineMgr.hpp:185
nvsipl::NvSIPLPipelineQueues::isp1CompletionQueue
INvSIPLFrameCompletionQueue * isp1CompletionQueue
The queue for completed frames from the second ISP output.
Definition: NvSIPLPipelineMgr.hpp:478
nvsipl::NvSIPLDownscaleCropCfg
Downscale and crop configuration.
Definition: NvSIPLISPStructs.hpp:87
nvsipl::INvSIPLNotificationQueue
The interface to the notification queue.
Definition: NvSIPLPipelineMgr.hpp:377
nvsipl::NvSIPLPipelineQueues::captureCompletionQueue
INvSIPLFrameCompletionQueue * captureCompletionQueue
The queue for completed capture frames.
Definition: NvSIPLPipelineMgr.hpp:466
nvsipl::NvSIPLPipelineQueues::isp0CompletionQueue
INvSIPLFrameCompletionQueue * isp0CompletionQueue
The queue for completed frames from the first ISP output.
Definition: NvSIPLPipelineMgr.hpp:472
nvsipl::INvSIPLFrameCompletionQueue::Get
virtual SIPLStatus Get(INvSIPLClient::INvSIPLBuffer *&item, size_t const timeoutUsec)=0
Retrieve the next item from the queue.
nvsipl::NvSIPLImageGroupWriter::RawBuffer::discontinuity
bool discontinuity
Holds a flag to signal discontinuity for the current raw buffer from the previous one.
Definition: NvSIPLPipelineMgr.hpp:229
nvsipl::NvSIPLPipelineNotifier::NotificationData::intrData
uint64_t intrData
Holds the Interrupt Data.
Definition: NvSIPLPipelineMgr.hpp:191
nvsipl::NvSIPLPipelineNotifier::NotificationData::uLinkMask
uint8_t uLinkMask
Holds the device block link mask.
Definition: NvSIPLPipelineMgr.hpp:183
nvsipl::NvSIPLImageGroupWriter::~NvSIPLImageGroupWriter
virtual ~NvSIPLImageGroupWriter(void)=default
Default destructor.
nvsipl::NvSIPLPipelineNotifier::NotificationData::frameCaptureStartTSC
uint64_t frameCaptureStartTSC
Holds the TSC timestamp of the start of frame for capture.
Definition: NvSIPLPipelineMgr.hpp:187
nvsipl::NvSIPLPipelineNotifier::NotificationData::eNotifType
NotificationType eNotifType
Holds the NotificationType event type.
Definition: NvSIPLPipelineMgr.hpp:179
nvsipl::NvSIPLPipelineNotifier::NotificationData::gpioIdxs
uint32_t gpioIdxs[MAX_DEVICE_GPIOS]
Holds the GPIO indices.
Definition: NvSIPLPipelineMgr.hpp:193
nvsipl::NvSIPLPipelineQueues::isp2CompletionQueue
INvSIPLFrameCompletionQueue * isp2CompletionQueue
The queue for completed frames from the third ISP output.
Definition: NvSIPLPipelineMgr.hpp:484
nvsipl::NvSIPLPipelineNotifier::NotificationData::intrCode
InterruptCode intrCode
Holds the Interrupt Code.
Definition: NvSIPLPipelineMgr.hpp:189
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ICP_BAD_INPUT_STREAM
@ NOTIF_ERROR_ICP_BAD_INPUT_STREAM
Pipeline event, indicates ICP bad input stream.
Definition: NvSIPLPipelineMgr.hpp:108
nvsipl::INvSIPLNotificationQueue::INvSIPLNotificationQueue
INvSIPLNotificationQueue()=default
NvSciBufObj
struct NvSciBufObjRefRec * NvSciBufObj
A memory object is a container holding the reconciled NvSciBufAttrList defining constraints of the bu...
Definition: nvscibuf.h:2717
nvsipl::NvSIPLPipelineNotifier::NotificationData
Defines the notification data.
Definition: NvSIPLPipelineMgr.hpp:176
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ISP_PROCESSING_FAILURE
@ NOTIF_ERROR_ISP_PROCESSING_FAILURE
Pipeline event, indicates ISP processing failure.
Definition: NvSIPLPipelineMgr.hpp:126
NvSIPLPlatformCfg.hpp
NVIDIA SIPL: Camera Platform Configuration
nvsipl::NvSIPLPipelineNotifier::NotificationData::uIndex
uint32_t uIndex
Holds the ID of the pipeline.
Definition: NvSIPLPipelineMgr.hpp:181
nvsipl::NvSIPLPipelineConfiguration::statsOverrideSettings
NvSIPLIspStatsOverrideSetting statsOverrideSettings
Holds ISP statistics override parameters.
Definition: NvSIPLPipelineMgr.hpp:281
nvsipl::INvSIPLClient::INvSIPLBuffer
Abstract interface for SIPL buffers.
Definition: NvSIPLClient.hpp:131
nvsipl::NvSIPLPipelineConfiguration::captureOutputRequested
bool captureOutputRequested
true if the client wants capture output frames to be delivered
Definition: NvSIPLPipelineMgr.hpp:262
nvsipl::NvSIPLPipelineNotifier
Describes the interfaces of the SIPL pipeline notification handler.
Definition: NvSIPLPipelineMgr.hpp:51
nvsipl::NvSIPLImageGroupWriter::RawBuffer
Describes an unprocessed sensor output buffer.
Definition: NvSIPLPipelineMgr.hpp:222
nvsipl::NvSIPLPipelineConfiguration::enableSubframe
bool enableSubframe
true if the client wants to use subframe feature
Definition: NvSIPLPipelineMgr.hpp:287
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_DESERIALIZER_FAILURE
@ NOTIF_ERROR_DESERIALIZER_FAILURE
Device block event, indicates a deserializer failure.
Definition: NvSIPLPipelineMgr.hpp:144
nvsipl::NvSIPLPipelineNotifier::NOTIF_WARN_ICP_FRAME_DROP
@ NOTIF_WARN_ICP_FRAME_DROP
Pipeline event, indicates pipeline was forced to drop a frame due to a slow consumer or system issues...
Definition: NvSIPLPipelineMgr.hpp:90
nvsipl::NvSIPLPipelineQueues
This is the output structure for SetPipelineCfg().
Definition: NvSIPLPipelineMgr.hpp:460
nvsipl::NvSIPLImageGroupWriter::RawBuffer::uIndex
uint32_t uIndex
Holds the ID of the sensor in PlatformCfg.
Definition: NvSIPLPipelineMgr.hpp:227
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_CDI_SET_SENSOR_CTRL_FAILURE
@ NOTIF_ERROR_CDI_SET_SENSOR_CTRL_FAILURE
Pipeline event, indicates CDI set sensor control failure.
Definition: NvSIPLPipelineMgr.hpp:138
nvsipl::NvSIPLPipelineConfiguration::imageGroupWriter
NvSIPLImageGroupWriter * imageGroupWriter
Holds a pointer to an NvSIPLImageGroupWriter.
Definition: NvSIPLPipelineMgr.hpp:284
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ICP_CAPTURE_FAILURE
@ NOTIF_ERROR_ICP_CAPTURE_FAILURE
Pipeline event, indicates ICP capture failure.
Definition: NvSIPLPipelineMgr.hpp:114
nvsipl::NvSIPLPipelineConfiguration::isp2OutputRequested
bool isp2OutputRequested
true if the client wants frames to be delivered from the third ISP output
Definition: NvSIPLPipelineMgr.hpp:271
nvsipl::NvSIPLPipelineConfiguration
Defines the camera pipeline configuration.
Definition: NvSIPLPipelineMgr.hpp:259
nvsipl::INvSIPLNotificationQueue::GetCount
virtual size_t GetCount() const =0
Return the current queue length.
nvsipl::INvSIPLNotificationQueue::Get
virtual SIPLStatus Get(NvSIPLPipelineNotifier::NotificationData &item, size_t const timeoutUsec)=0
Retrieve the next item from the queue.
nvsipl::NvSIPLDeviceBlockQueues::notificationQueue
INvSIPLNotificationQueue * notificationQueue[MAX_DEVICEBLOCKS_PER_PLATFORM]
Queues for event notifications for each device block.
Definition: NvSIPLPipelineMgr.hpp:496
nvsipl::NvSIPLPipelineConfiguration::isp1OutputRequested
bool isp1OutputRequested
true if the client wants frames to be delivered from the second ISP output
Definition: NvSIPLPipelineMgr.hpp:268
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:115
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ISP_PROCESSING_FAILURE_RECOVERABLE
@ NOTIF_ERROR_ISP_PROCESSING_FAILURE_RECOVERABLE
Pipeline event, indicates isp process failure due to recoverable errors.
Definition: NvSIPLPipelineMgr.hpp:162
nvsipl::NvSIPLPipelineConfiguration::isp0OutputRequested
bool isp0OutputRequested
true if the client wants frames to be delivered from the first ISP output
Definition: NvSIPLPipelineMgr.hpp:265
nvsipl::NvSIPLPipelineNotifier::NOTIF_WARN_ICP_CAPTURE_TIMEOUT
@ NOTIF_WARN_ICP_CAPTURE_TIMEOUT
Pipeline event, indicates occurrence of timeout while capturing.
Definition: NvSIPLPipelineMgr.hpp:102
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_SERIALIZER_FAILURE
@ NOTIF_ERROR_SERIALIZER_FAILURE
Device block event, indicates a serializer failure.
Definition: NvSIPLPipelineMgr.hpp:150
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ACP_PROCESSING_FAILURE
@ NOTIF_ERROR_ACP_PROCESSING_FAILURE
Pipeline event, indicates auto control processing failure.
Definition: NvSIPLPipelineMgr.hpp:132
nvsipl::NvSIPLImageGroupWriter
Describes the interfaces of SIPL pipeline feeder.
Definition: NvSIPLPipelineMgr.hpp:218
nvsipl::INvSIPLNotificationQueue::~INvSIPLNotificationQueue
virtual ~INvSIPLNotificationQueue()=default
nvsipl::INvSIPLFrameCompletionQueue::GetCount
virtual size_t GetCount() const =0
Return the current queue length.
nvsipl::INvSIPLFrameCompletionQueue
The interface to the frame completion queue.
Definition: NvSIPLPipelineMgr.hpp:293
nvsipl::NvSIPLImageGroupWriter::RawBuffer::image
NvSciBufObj image
Holds an NvSciBufObj.
Definition: NvSIPLPipelineMgr.hpp:225
nvsipl::NvSIPLPipelineNotifier::NOTIF_INFO_CDI_PROCESSING_DONE
@ NOTIF_INFO_CDI_PROCESSING_DONE
Pipeline event, indicates CDI processing is finished.
Definition: NvSIPLPipelineMgr.hpp:84
nvsipl::NvSIPLImageGroupWriter::FillRawBuffer
virtual SIPLStatus FillRawBuffer(RawBuffer &oRawBuffer)=0
Populates the buffer with RAW data.
nvsipl::NvSIPLImageGroupWriter::RawBuffer::dropBuffer
bool dropBuffer
Holds a flag to signal that the pipeline should drop the current buffer.
Definition: NvSIPLPipelineMgr.hpp:231
nvsipl::NvSIPLPipelineNotifier::~NvSIPLPipelineNotifier
virtual ~NvSIPLPipelineNotifier(void)=default
Default destructor.
nvsipl::INvSIPLFrameCompletionQueue::~INvSIPLFrameCompletionQueue
virtual ~INvSIPLFrameCompletionQueue()=default
nvsipl::NvSIPLPipelineNotifier::NotificationData::numGpioIdxs
uint32_t numGpioIdxs
Holds the number of GPIO indices in the array.
Definition: NvSIPLPipelineMgr.hpp:195
nvsipl::NvSIPLPipelineNotifier::NOTIF_INFO_ICP_PROCESSING_DONE
@ NOTIF_INFO_ICP_PROCESSING_DONE
Pipeline event, indicates ICP processing is finished.
Definition: NvSIPLPipelineMgr.hpp:64
nvsipl::NvSIPLIspStatsOverrideSetting
SIPL ISP Statistics Override Parameters.
Definition: NvSIPLISPStat.hpp:616
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_INTERNAL_FAILURE
@ NOTIF_ERROR_INTERNAL_FAILURE
Pipeline and device block event, indicates an unexpected internal failure.
Definition: NvSIPLPipelineMgr.hpp:169
nvsipl::NvSIPLPipelineNotifier::NOTIF_INFO_ACP_PROCESSING_DONE
@ NOTIF_INFO_ACP_PROCESSING_DONE
Pipeline event, indicates auto control processing is finished.
Definition: NvSIPLPipelineMgr.hpp:76
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: INvSiplControlAuto.hpp:33
nvsipl::INvSIPLFrameCompletionQueue::INvSIPLFrameCompletionQueue
INvSIPLFrameCompletionQueue()=default
nvsipl::NvSIPLPipelineNotifier::NotificationType
NotificationType
Defines the events of the image processing pipeline and the device block.
Definition: NvSIPLPipelineMgr.hpp:58
nvsipl::NvSIPLImageGroupWriter::RawBuffer::frameCaptureStartTSC
uint64_t frameCaptureStartTSC
Holds the TSC timestamp of the start of frame for capture.
Definition: NvSIPLPipelineMgr.hpp:235
nvsipl::NvSIPLPipelineConfiguration::downscaleCropCfg
NvSIPLDownscaleCropCfg downscaleCropCfg
Holds a downscale and crop configuration.
Definition: NvSIPLPipelineMgr.hpp:274
nvsipl::NvSIPLImageGroupWriter::RawBuffer::frameCaptureTSC
uint64_t frameCaptureTSC
Holds the TSC timestamp of the end of frame for capture.
Definition: NvSIPLPipelineMgr.hpp:233
nvsipl::NvSIPLPipelineNotifier::NOTIF_ERROR_ICP_EMB_DATA_PARSE_FAILURE
@ NOTIF_ERROR_ICP_EMB_DATA_PARSE_FAILURE
Pipeline event, indicates embedded data parsing failure.
Definition: NvSIPLPipelineMgr.hpp:120
nvsipl::MAX_DEVICEBLOCKS_PER_PLATFORM
static constexpr uint32_t MAX_DEVICEBLOCKS_PER_PLATFORM
Indicates the maximum number of device blocks per platform.
Definition: NvSIPLDeviceBlockInfo.hpp:43
nvsipl::NvSIPLDeviceBlockQueues
Holds the queues used by the client to receive device block event notifications.
Definition: NvSIPLPipelineMgr.hpp:493
nvsipl::NvSIPLPipelineNotifier::NOTIF_INFO_ISP_PROCESSING_DONE
@ NOTIF_INFO_ISP_PROCESSING_DONE
Pipeline event, indicates ISP processing is finished.
Definition: NvSIPLPipelineMgr.hpp:70