NVIDIA DRIVE OS Linux SDK API Reference

6.0.8 Release
NvSIPLClient.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2023, NVIDIA CORPORATION & AFFILIATES. 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 NVSIPLCLIENT_HPP
12 #define NVSIPLCLIENT_HPP
13 
14 #include "NvSIPLCommon.hpp"
15 #include "NvSIPLISPStructs.hpp"
16 
17 #include "NvSIPLCDICommon.h"
18 
19 #include "nvscisync.h"
20 #include "nvscistream.h"
21 
22 #include <cstdint>
23 #include <string>
24 #include <memory>
25 
40 namespace nvsipl
41 {
53 {
54 public:
57  {
59  uint64_t frameCaptureTSC;
63  uint32_t numExposures;
65  DevBlkCDIExposure sensorExpInfo;
67  DevBlkCDIWhiteBalance sensorWBInfo;
69  DevBlkCDIIllumination illuminationInfo;
71  DevBlkCDIPWL sensorPWLInfo;
73  DevBlkCDICRC sensorCRCInfo;
75  DevBlkCDIFrameReport sensorReportInfo;
77  DevBlkCDITemperature sensorTempInfo;
79  DevBlkCDIFrameSeqNum frameSeqNumInfo;
87  DevBlkCDIFrameTimestamp frameTimestampInfo;
88 
93 
104  int8_t errorFlag;
107 
108  };
109 
111  {
117  uint8_t *embeddedBufTop;
120  };
121 
128  {
129  public:
156  virtual void AddRef() = 0;
157 
188  virtual SIPLStatus Release() = 0;
189 
228  virtual SIPLStatus AddNvSciSyncPrefence(const NvSciSyncFence &prefence) = 0;
229 
262  virtual SIPLStatus GetEOFNvSciSyncFence(NvSciSyncFence *const postfence) = 0;
263  };
264 
270  {
271  public:
295  virtual NvSciBufObj GetNvSciBufImage() const = 0;
296 
320  virtual ImageMetaData const& GetImageData() const = 0;
321 
347  virtual ImageEmbeddedData const& GetImageEmbeddedData() const = 0;
348 
349  };
350 
353  {
355  enum class OutputType
356  {
357  ICP,
358  ISP0,
359  ISP1,
360  ISP2,
361  };
362  };
363 };
364 
367 } // namespace nvsipl
368 
369 #endif // NVSIPLCLIENT_HPP
nvsipl::INvSIPLClient::ImageMetaData::frameTimestampInfo
DevBlkCDIFrameTimestamp frameTimestampInfo
Holds parsed embedded data frame timestamp info for the captured frame.
Definition: NvSIPLClient.hpp:87
nvsipl::NvSiplControlInfo
Defines the control info.
Definition: NvSIPLISPStructs.hpp:56
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufBottomSize
uint32_t embeddedBufBottomSize
Holds size of the bottom embedded data.
Definition: NvSIPLClient.hpp:115
nvsipl::INvSIPLClient::ImageMetaData::badPixelSettings
NvSiplISPBadPixelStats badPixelSettings
Holds the ISP bad pixel settings for the previous ISP output frame.
Definition: NvSIPLClient.hpp:85
nvsipl::NvSiplISPLocalAvgClipStatsData
Holds local average and clip statistics block (LAC Stats).
Definition: NvSIPLISPStat.hpp:448
nvsipl::INvSIPLClient::INvSIPLBuffer::Release
virtual SIPLStatus Release()=0
Release a reference.
nvsipl::NvSiplISPLocalAvgClipStats
Holds controls for local average and clip statistics (LAC Stats).
Definition: NvSIPLISPStat.hpp:458
nvsipl::INvSIPLClient::INvSIPLBuffer::AddNvSciSyncPrefence
virtual SIPLStatus AddNvSciSyncPrefence(const NvSciSyncFence &prefence)=0
Add an NvSciSync prefence.
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageData
virtual ImageMetaData const & GetImageData() const =0
Gets an nvsipl::INvSIPLClient::ImageMetaData associated with NvSciBufObj.
nvsipl::INvSIPLClient::ImageMetaData::sensorTempInfo
DevBlkCDITemperature sensorTempInfo
Holds the parsed embedded data sensor temperature info for the captured frame.
Definition: NvSIPLClient.hpp:77
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ICP
@ ICP
Indicates the unprocessed output of the image sensor.
nvsipl::INvSIPLClient
Defines the public data structures and describes the interfaces for NvSIPL Client.
Definition: NvSIPLClient.hpp:52
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP2
@ ISP2
Indicates the third output of ISP.
nvsipl::INvSIPLClient::ImageMetaData::localAvgClipStats
NvSiplISPLocalAvgClipStatsData localAvgClipStats[2]
Holds the ISP Local Average and Clipped statistics for the previous ISP output frame.
Definition: NvSIPLClient.hpp:99
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP0
@ ISP0
Indicates the first output of ISP.
nvsipl::INvSIPLClient::ImageMetaData::histogramSettings
NvSiplISPHistogramStats histogramSettings[2]
Holds the ISP Histogram settings for the previous ISP output frame.
Definition: NvSIPLClient.hpp:95
nvsipl::NvSiplISPHistogramStats
Holds controls for histogram statistics (HIST Stats).
Definition: NvSIPLISPStat.hpp:376
NvSciBufObj
struct NvSciBufObjRefRec * NvSciBufObj
A memory object is a container holding the reconciled NvSciBufAttrList defining constraints of the bu...
Definition: nvscibuf.h:3102
nvsipl::INvSIPLClient::ImageMetaData
Defines the metadata associated with the image.
Definition: NvSIPLClient.hpp:56
nvscisync.h
NVIDIA Software Communications Interface (SCI) : NvSciSync
nvsipl::INvSIPLClient::INvSIPLBuffer
Abstract interface for SIPL buffers.
Definition: NvSIPLClient.hpp:127
nvsipl::INvSIPLClient::ImageMetaData::badPixelStatsValid
bool badPixelStatsValid
Holds a flag indicating if the ISP bad pixel statistics are valid.
Definition: NvSIPLClient.hpp:81
nvsipl::INvSIPLClient::ImageMetaData::localAvgClipStatsValid
bool localAvgClipStatsValid[2]
Holds a flag indicating if the ISP Local Average and Clipped statistics are valid.
Definition: NvSIPLClient.hpp:97
nvsipl::INvSIPLClient::ImageEmbeddedData
Definition: NvSIPLClient.hpp:110
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufBottom
uint8_t * embeddedBufBottom
Holds pointer to the bottom embedded data.
Definition: NvSIPLClient.hpp:119
nvsipl::INvSIPLClient::ConsumerDesc::OutputType
OutputType
Defines the types of the SIPL pipeline output.
Definition: NvSIPLClient.hpp:355
nvsipl::INvSIPLClient::ImageMetaData::badPixelStats
NvSiplISPBadPixelStatsData badPixelStats
Holds the ISP bad pixel statistics for the previous ISP output frame.
Definition: NvSIPLClient.hpp:83
nvsipl::INvSIPLClient::ConsumerDesc
Describes a client of the pipeline.
Definition: NvSIPLClient.hpp:352
nvsipl::INvSIPLClient::ImageMetaData::sensorExpInfo
DevBlkCDIExposure sensorExpInfo
Holds the parsed embedded data sensor exposure info for the captured frame.
Definition: NvSIPLClient.hpp:65
nvsipl::INvSIPLClient::ImageMetaData::numExposures
uint32_t numExposures
Holds the parsed embedded data frame number of exposures info for the captured frame.
Definition: NvSIPLClient.hpp:63
nvsipl::INvSIPLClient::ImageMetaData::frameCaptureTSC
uint64_t frameCaptureTSC
Holds the TSC timestamp of the end of frame for capture.
Definition: NvSIPLClient.hpp:59
nvsipl::INvSIPLClient::ImageMetaData::controlInfo
NvSiplControlInfo controlInfo
Holds the control information.
Definition: NvSIPLClient.hpp:106
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:115
nvsipl::INvSIPLClient::ImageMetaData::sensorReportInfo
DevBlkCDIFrameReport sensorReportInfo
Holds the parsed embedded data frame report info for the captured frame.
Definition: NvSIPLClient.hpp:75
nvsipl::INvSIPLClient::ImageMetaData::frameCaptureStartTSC
uint64_t frameCaptureStartTSC
Holds the TSC timestamp of the start of frame for capture.
Definition: NvSIPLClient.hpp:61
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufTop
uint8_t * embeddedBufTop
Holds pointer to the top embedded data.
Definition: NvSIPLClient.hpp:117
NvSIPLISPStructs.hpp
NVIDIA SIPL: ISP Definitions - NvSIPL Client
nvsipl::INvSIPLClient::ImageMetaData::frameSeqNumInfo
DevBlkCDIFrameSeqNum frameSeqNumInfo
Holds the parsed embedded data frame sequence number info for the captured frame.
Definition: NvSIPLClient.hpp:79
nvsipl::INvSIPLClient::INvSIPLBuffer::AddRef
virtual void AddRef()=0
Adds a reference.
nvsipl::NvSiplISPBadPixelStatsData
Holds bad pixel statistics (BP Stats).
Definition: NvSIPLISPStat.hpp:82
NvSciSyncFence
Defines the opaque NvSciSyncFence.
Definition: nvscisync.h:249
nvsipl::NvSiplISPHistogramStatsData
Holds histogram statistics (HIST Stats).
Definition: NvSIPLISPStat.hpp:123
nvsipl::INvSIPLClient::ImageMetaData::sensorCRCInfo
DevBlkCDICRC sensorCRCInfo
Holds the parsed embedded data sensor crc info for the captured frame.
Definition: NvSIPLClient.hpp:73
nvscistream.h
NVIDIA Software Communications Interface (SCI) : NvSciStream
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP1
@ ISP1
Indicates the second output of ISP.
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageEmbeddedData
virtual ImageEmbeddedData const & GetImageEmbeddedData() const =0
Gets an nvsipl::INvSIPLClient::ImageEmbeddedData this is the RAW data associated with the captured im...
nvsipl::INvSIPLClient::ImageMetaData::illuminationInfo
DevBlkCDIIllumination illuminationInfo
Holds the parsed embedded data illumination info for the captured frame.
Definition: NvSIPLClient.hpp:69
nvsipl::INvSIPLClient::ImageMetaData::sensorPWLInfo
DevBlkCDIPWL sensorPWLInfo
Holds the parsed embedded data sensor PWL info for the captured frame.
Definition: NvSIPLClient.hpp:71
nvsipl::NvSiplISPBadPixelStats
Holds controls for bad pixel statistics (BP Stats).
Definition: NvSIPLISPStat.hpp:516
nvsipl::INvSIPLClient::INvSIPLNvMBuffer
Describes a SIPL buffer containing an NvSciBufObj.
Definition: NvSIPLClient.hpp:269
nvsipl::INvSIPLClient::ImageMetaData::histogramStatsValid
bool histogramStatsValid[2]
Holds a flag indicating if the ISP Histogram statistics are valid.
Definition: NvSIPLClient.hpp:90
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: INvSiplControlAuto.hpp:33
nvsipl::INvSIPLClient::ImageMetaData::sensorWBInfo
DevBlkCDIWhiteBalance sensorWBInfo
Holds the parsed embedded data sensor white balance info for the captured frame.
Definition: NvSIPLClient.hpp:67
nvsipl::INvSIPLClient::ImageMetaData::histogramStats
NvSiplISPHistogramStatsData histogramStats[2]
Holds the ISP Histogram statistics for the previous ISP output frame.
Definition: NvSIPLClient.hpp:92
nvsipl::INvSIPLClient::INvSIPLBuffer::GetEOFNvSciSyncFence
virtual SIPLStatus GetEOFNvSciSyncFence(NvSciSyncFence *const postfence)=0
Retrieve the latest NvSciSync EOF fence.
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufTopSize
uint32_t embeddedBufTopSize
Holds size of the top embedded data.
Definition: NvSIPLClient.hpp:113
nvsipl::INvSIPLClient::ImageMetaData::errorFlag
int8_t errorFlag
Holds information on errors present in the embedded data.
Definition: NvSIPLClient.hpp:104
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetNvSciBufImage
virtual NvSciBufObj GetNvSciBufImage() const =0
Gets a handle to NvSciBufObj.
nvsipl::INvSIPLClient::ImageMetaData::localAvgClipSettings
NvSiplISPLocalAvgClipStats localAvgClipSettings[2]
Holds the ISP Local Average and Clipped settings for the previous ISP output frame.
Definition: NvSIPLClient.hpp:101