Jetson Linux API Reference

39.2 Release
NvSIPLClient.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
13 #ifndef NVSIPLCLIENT_HPP
14 #define NVSIPLCLIENT_HPP
15 
16 #include "NvSIPLCommon.hpp"
17 #include "NvSIPLISPStructs.hpp"
18 
19 #include "NvSIPLCDICommon.h"
20 
21 #include "nvscisync.h"
22 #include "nvscistream.h"
23 
24 #include <cstdint>
25 #include <string>
26 #include <memory>
27 
42 namespace nvsipl
43 {
55 {
56 public:
59  {
61  uint64_t frameCaptureTSC;
65  uint32_t numExposures;
86  int8_t errorFlag;
89 
92 
95  };
96 
98  {
104  uint8_t *embeddedBufTop;
107  };
108 
115  {
116  public:
150  virtual void AddRef() = 0;
151 
185  virtual SIPLStatus Release() = 0;
186 
230  virtual SIPLStatus AddNvSciSyncPrefence(NvSciSyncFence const &prefence) = 0;
231 
270  virtual SIPLStatus GetSOFNvSciSyncFence(NvSciSyncFence *const sofFence) = 0;
271 
308  virtual SIPLStatus GetEOFNvSciSyncFence(NvSciSyncFence *const postfence) = 0;
309 
311  virtual ~INvSIPLBuffer() = default;
312 
314  INvSIPLBuffer(INvSIPLBuffer& other) = delete;
315 
317  INvSIPLBuffer& operator=(INvSIPLBuffer& other) & = delete;
318 
320  INvSIPLBuffer(INvSIPLBuffer&& other) = delete;
321 
323  INvSIPLBuffer& operator=(INvSIPLBuffer&& other) & = delete;
324 
325  protected:
327  INvSIPLBuffer() = default;
328 
329  };
330 
336  {
337  public:
366  virtual NvSciBufObj GetNvSciBufImage() const = 0;
367 
396  virtual ImageMetaData const& GetImageData() const = 0;
397 
427  virtual ImageEmbeddedData const& GetImageEmbeddedData() const = 0;
428 
430  ~INvSIPLNvMBuffer() override = default;
431 
433  INvSIPLNvMBuffer(INvSIPLNvMBuffer& other) = delete;
434 
436  INvSIPLNvMBuffer& operator=(INvSIPLNvMBuffer& other) & = delete;
437 
439  INvSIPLNvMBuffer(INvSIPLNvMBuffer&& other) = delete;
440 
442  INvSIPLNvMBuffer& operator=(INvSIPLNvMBuffer&& other) & = delete;
443 
444  protected:
446  INvSIPLNvMBuffer() = default;
447 
448  };
449 
452  {
454  enum class OutputType : std::uint8_t
455  {
456  ICP,
457  ISP0,
458  ISP1,
459  ISP2,
460  };
461  };
462 
464  virtual ~INvSIPLClient() = default;
465 
467  INvSIPLClient(INvSIPLClient& other) = delete;
468 
470  INvSIPLClient& operator=(INvSIPLClient& other) & = delete;
471 
473  INvSIPLClient(INvSIPLClient&& other) = delete;
474 
476  INvSIPLClient& operator=(INvSIPLClient&& other) & = delete;
477 
478 protected:
480  INvSIPLClient() = default;
481 
482 };
483 
486 } // namespace nvsipl
487 
488 #endif // NVSIPLCLIENT_HPP
DevBlkCDIFrameTimestamp
Holds the sensor frame timestamp structure.
Definition: NvSIPLCDICommon.h:451
nvsipl::INvSIPLClient::ImageMetaData::frameTimestampInfo
DevBlkCDIFrameTimestamp frameTimestampInfo
Holds parsed embedded data frame timestamp info for the captured frame.
Definition: NvSIPLClient.hpp:83
nvsipl::NvSiplControlInfo
Defines the control info.
Definition: NvSIPLISPStructs.hpp:58
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufBottomSize
uint32_t embeddedBufBottomSize
Holds size of the bottom embedded data.
Definition: NvSIPLClient.hpp:102
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer
INvSIPLNvMBuffer()=default
Default constructor declared in order to allow construction of derived objects.
nvsipl::INvSIPLClient::INvSIPLBuffer::operator=
INvSIPLBuffer & operator=(INvSIPLBuffer &other) &=delete
Delete copy assignment operator.
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::operator=
INvSIPLNvMBuffer & operator=(INvSIPLNvMBuffer &other) &=delete
Delete copy assignment operator.
nvsipl::INvSIPLClient::INvSIPLBuffer::Release
virtual SIPLStatus Release()=0
Release a reference.
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageData
virtual ImageMetaData const & GetImageData() const =0
Gets an nvsipl::INvSIPLClient::ImageMetaData associated with NvSciBufObj.
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP1
@ ISP1
Indicates the first output of ISP.
nvsipl::INvSIPLClient::ImageMetaData::sensorTempInfo
DevBlkCDITemperature sensorTempInfo
Holds the parsed embedded data sensor temperature info for the captured frame.
Definition: NvSIPLClient.hpp:79
nvsipl::INvSIPLClient
Defines the public data structures and describes the interfaces for NvSIPL Client.
Definition: NvSIPLClient.hpp:54
nvsipl::INvSIPLClient::operator=
INvSIPLClient & operator=(INvSIPLClient &other) &=delete
Delete copy assignment operation.
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
nvsipl::INvSIPLClient::ConsumerDesc::OutputType
OutputType
Defines the types of the SIPL pipeline output.
Definition: NvSIPLClient.hpp:454
nvsipl::INvSIPLClient::ImageMetaData
Defines the metadata associated with the image.
Definition: NvSIPLClient.hpp:58
nvsipl::INvSIPLClient::INvSIPLBuffer
Abstract interface for SIPL buffers.
Definition: NvSIPLClient.hpp:114
nvsipl::INvSIPLClient::ImageEmbeddedData
Definition: NvSIPLClient.hpp:97
DevBlkCDIPWL
Holds the sensor companding piecewise linear (PWL) structure.
Definition: NvSIPLCDICommon.h:407
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ICP
@ ICP
nvsipl::INvSIPLClient::INvSIPLBuffer::INvSIPLBuffer
INvSIPLBuffer()=default
Default constructor declared in order to allow construction of derived objects.
DevBlkCDIFrameReport
Holds the sensor report frame report structure.
Definition: NvSIPLCDICommon.h:383
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufBottom
uint8_t * embeddedBufBottom
Holds pointer to the bottom embedded data.
Definition: NvSIPLClient.hpp:106
nvsipl::INvSIPLClient::ConsumerDesc
Describes a client of the pipeline.
Definition: NvSIPLClient.hpp:451
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:153
nvsipl::INvSIPLClient::ImageMetaData::sensorExpInfo
DevBlkCDIExposure sensorExpInfo
Holds the parsed embedded data sensor exposure info for the captured frame.
Definition: NvSIPLClient.hpp:67
nvsipl::INvSIPLClient::INvSIPLBuffer::GetSOFNvSciSyncFence
virtual SIPLStatus GetSOFNvSciSyncFence(NvSciSyncFence *const sofFence)=0
Retrieve the latest NvSciSync SOF fence.
nvsipl::INvSIPLClient::~INvSIPLClient
virtual ~INvSIPLClient()=default
Default destructor.
NvSIPLCDICommon.h
DevBlkCDIWhiteBalance
Holds the sensor white balance gain structure.
Definition: NvSIPLCDICommon.h:322
nvsipl::INvSIPLClient::ImageMetaData::numExposures
uint32_t numExposures
Holds the parsed embedded data frame number of exposures info for the captured frame.
Definition: NvSIPLClient.hpp:65
DevBlkCDIFrameCtxID
Holds the sensor frame context id structure.
Definition: NvSIPLCDICommon.h:233
nvsipl::INvSIPLClient::ImageMetaData::frameCaptureTSC
uint64_t frameCaptureTSC
Holds the TSC timestamp of the end of frame for capture.
Definition: NvSIPLClient.hpp:61
nvsipl::INvSIPLClient::ImageMetaData::frameCtxIDInfo
DevBlkCDIFrameCtxID frameCtxIDInfo
Holds the parsed embedded data frame context id info for the captured frame.
Definition: NvSIPLClient.hpp:94
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::~INvSIPLNvMBuffer
~INvSIPLNvMBuffer() override=default
Default destructor.
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP0
@ ISP0
Indicates the unprocessed output of the image sensor.
nvsipl::INvSIPLClient::ImageMetaData::controlInfo
NvSiplControlInfo controlInfo
Holds the control information.
Definition: NvSIPLClient.hpp:88
nvsipl::INvSIPLClient::ImageMetaData::sensorReportInfo
DevBlkCDIFrameReport sensorReportInfo
Holds the parsed embedded data frame report info for the captured frame.
Definition: NvSIPLClient.hpp:77
DevBlkCDIIllumination
Holds the sensor illumination control structure.
Definition: NvSIPLCDICommon.h:343
nvsipl::INvSIPLClient::ImageMetaData::frameCaptureStartTSC
uint64_t frameCaptureStartTSC
Holds the TSC timestamp of the start of frame for capture.
Definition: NvSIPLClient.hpp:63
nvsipl::INvSIPLClient::ImageEmbeddedData::embeddedBufTop
uint8_t * embeddedBufTop
Holds pointer to the top embedded data.
Definition: NvSIPLClient.hpp:104
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:81
DevBlkCDITemperature
Holds the sensor temperature structure.
Definition: NvSIPLCDICommon.h:359
nvsipl::INvSIPLClient::INvSIPLBuffer::AddRef
virtual void AddRef()=0
Adds a reference.
nvsipl::INvSIPLClient::ImageMetaData::sensorCRCInfo
DevBlkCDICRC sensorCRCInfo
Holds the parsed embedded data sensor crc info for the captured frame.
Definition: NvSIPLClient.hpp:75
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:71
nvsipl::INvSIPLClient::ImageMetaData::sensorPWLInfo
DevBlkCDIPWL sensorPWLInfo
Holds the parsed embedded data sensor PWL info for the captured frame.
Definition: NvSIPLClient.hpp:73
DevBlkCDIExposure
Holds sensor exposure information.
Definition: NvSIPLCDICommon.h:272
nvsipl::INvSIPLClient::INvSIPLNvMBuffer
Describes a SIPL buffer containing an NvSciBufObj.
Definition: NvSIPLClient.hpp:335
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: NvSIPLCameraQuery.hpp:22
nvsipl::INvSIPLClient::INvSIPLClient
INvSIPLClient()=default
Default constructor declared in order to allow construction of derived objects.
DevBlkCDIFrameSeqNum
Holds the sensor frame sequence number structure.
Definition: NvSIPLCDICommon.h:217
DevBlkCDICRC
Holds the sensor CRC structure.
Definition: NvSIPLCDICommon.h:430
nvsipl::INvSIPLClient::ImageMetaData::sensorWBInfo
DevBlkCDIWhiteBalance sensorWBInfo
Holds the parsed embedded data sensor white balance info for the captured frame.
Definition: NvSIPLClient.hpp:69
nvsipl::INvSIPLClient::INvSIPLBuffer::~INvSIPLBuffer
virtual ~INvSIPLBuffer()=default
Default destructor.
nvsipl::INvSIPLClient::ConsumerDesc::OutputType::ISP2
@ ISP2
Indicates the second output of ISP.
nvsipl::INvSIPLClient::INvSIPLBuffer::AddNvSciSyncPrefence
virtual SIPLStatus AddNvSciSyncPrefence(NvSciSyncFence const &prefence)=0
Add an NvSciSync prefence.
nvsipl::INvSIPLClient::ImageMetaData::wasFrameDropped
bool wasFrameDropped
Holds a flag indicating if the frame was dropped.
Definition: NvSIPLClient.hpp:91
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:100
nvsipl::INvSIPLClient::ImageMetaData::errorFlag
int8_t errorFlag
Holds information on errors present in the embedded data.
Definition: NvSIPLClient.hpp:86
nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetNvSciBufImage
virtual NvSciBufObj GetNvSciBufImage() const =0
Gets a handle to NvSciBufObj.