NvSIPLClient.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2018-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef NVSIPLCLIENT_HPP
#define NVSIPLCLIENT_HPP
 
#include "NvSIPLCommon.hpp"
#include "NvSIPLISPStructs.hpp"
 
#include "NvSIPLCDICommon.h"
 
#include "nvscisync.h"
#include "nvscistream.h"
 
#include <cstdint>
#include <string>
#include <memory>
 
namespace nvsipl
{
class INvSIPLClient
{
public:
    struct ImageMetaData
    {
        uint64_t frameCaptureTSC;
        uint64_t frameCaptureStartTSC;
        uint32_t numExposures;
        DevBlkCDIExposure sensorExpInfo;
        DevBlkCDIWhiteBalance sensorWBInfo;
        DevBlkCDIIllumination illuminationInfo;
        DevBlkCDIPWL sensorPWLInfo;
        DevBlkCDICRC sensorCRCInfo;
        DevBlkCDIFrameReport sensorReportInfo;
        DevBlkCDITemperature sensorTempInfo;
        DevBlkCDIFrameSeqNum frameSeqNumInfo;
 
        bool badPixelStatsValid;
        NvSiplISPBadPixelStatsData badPixelStats;
        NvSiplISPBadPixelStats badPixelSettings;
        bool deadPixelStatsValid;
        NvSiplISPDeadPixelCorrectionStatsData deadPixelStats;
 
        DevBlkCDIFrameTimestamp frameTimestampInfo;
 
        bool histogramStatsValid[3];
        NvSiplISPHistogramStatsData histogramStats[3];
 
        NvSiplISPHistogramStats histogramSettings[3];
        bool localAvgClipStatsValid[2];
        NvSiplISPLocalAvgClipStatsData localAvgClipStats[2];
        NvSiplISPLocalAvgClipStats localAvgClipSettings[2];
 
        int8_t errorFlag;
        NvSiplControlInfo controlInfo;
    };
 
     struct ImageEmbeddedData
     {
          uint32_t embeddedBufTopSize;
          uint32_t embeddedBufBottomSize;
          uint8_t *embeddedBufTop;
          uint8_t *embeddedBufBottom;
     };
 
    class INvSIPLBuffer
    {
     public:
        virtual void AddRef() = 0;
 
        virtual SIPLStatus Release() = 0;
 
        virtual SIPLStatus AddNvSciSyncPrefence(NvSciSyncFence const &prefence) = 0;
 
        virtual SIPLStatus GetEOFNvSciSyncFence(NvSciSyncFence *const postfence) = 0;
 
        virtual ~INvSIPLBuffer() = default;
 
        INvSIPLBuffer(INvSIPLBuffer& other) = delete;
 
        INvSIPLBuffer& operator=(INvSIPLBuffer& other) & = delete;
 
        INvSIPLBuffer(INvSIPLBuffer&& other) = delete;
 
        INvSIPLBuffer& operator=(INvSIPLBuffer&& other) & = delete;
 
    protected:
        INvSIPLBuffer() = default;
 
    };
 
    class INvSIPLNvMBuffer : public INvSIPLBuffer
    {
     public:
        virtual NvSciBufObj GetNvSciBufImage() const = 0;
 
        virtual ImageMetaData const& GetImageData() const = 0;
 
        virtual ImageEmbeddedData const& GetImageEmbeddedData() const = 0;
 
        ~INvSIPLNvMBuffer() override = default;
 
        INvSIPLNvMBuffer(INvSIPLNvMBuffer& other) = delete;
 
        INvSIPLNvMBuffer& operator=(INvSIPLNvMBuffer& other) & = delete;
 
        INvSIPLNvMBuffer(INvSIPLNvMBuffer&& other) = delete;
 
        INvSIPLNvMBuffer& operator=(INvSIPLNvMBuffer&& other) & = delete;
 
    protected:
        INvSIPLNvMBuffer() = default;
 
    };
 
    struct ConsumerDesc
    {
        enum class OutputType : std::uint8_t
        {
            ICP,  
            ISP0, 
            ISP1, 
            ISP2, 
        };
    };
 
    virtual ~INvSIPLClient() = default;
 
    INvSIPLClient(INvSIPLClient& other) = delete;
 
    INvSIPLClient& operator=(INvSIPLClient& other) & = delete;
 
    INvSIPLClient(INvSIPLClient&& other) = delete;
 
    INvSIPLClient& operator=(INvSIPLClient&& other) & = delete;
 
protected:
    INvSIPLClient() = default;
 
};
 
} // namespace nvsipl
 
#endif // NVSIPLCLIENT_HPP