NvSIPLClient.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2019, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */

#ifndef NVSIPLCLIENT_HPP
#define NVSIPLCLIENT_HPP

#include "NvSIPLCommon.hpp"

#include "nvmedia_image.h"
#include "nvmedia_isc.h"

#include <cstdint>
#include <string>
#include <memory>

namespace nvsipl
{

class INvSIPLClient
{
 public:
    struct ImageMetaData
    {
        std::uint64_t frameCaptureTSC;
        uint32_t numExposures;
        NvMediaISCExposure sensorExpInfo;
        NvMediaISCWhiteBalance sensorWBInfo;
        NvMediaISCPWL sensorPWLInfo;
        NvMediaISCCRC sensorCRCInfo;
        NvMediaISCFrameReport sensorReportInfo;
        NvMediaISCTemperature sensorTempInfo;
        NvMediaISCFrameSeqNum frameSeqNumInfo;
    };

    struct ConsumerDesc
    {
        enum class OutputType
        {
            ICP,  
            ISP0, 
            ISP1, 
        };

        std::string sName;
        std::uint32_t uSensorIndex;
        OutputType eOutputType;
    };

    struct ClientDesc
    {
        ConsumerDesc oConsDesc;

        virtual ~ClientDesc() = default;
    };

    class INvSIPLBuffer
    {
     public:
        virtual void AddRef(void) = 0;

        virtual SIPLStatus Release(void) = 0;
    };

    class INvSIPLNvMBuffer : public INvSIPLBuffer
    {
     public:
        virtual NvMediaImage* GetImage() = 0;

        virtual NvMediaImageGroup* GetImageGroup() = 0;

        virtual ImageMetaData GetImageData() = 0;
    };

    class INvMCallback
    {
     public:
        virtual SIPLStatus OnFrameAvailable(INvSIPLBuffer* pBuffer) = 0;

        virtual SIPLStatus OnError(void) = 0;

        virtual ~INvMCallback(void) = default;
    };

    static std::unique_ptr<INvSIPLClient> Create();

    virtual SIPLStatus Init(ClientDesc* pDesc, INvMCallback* pCallback) = 0;

    virtual SIPLStatus Start(void) = 0;

    virtual SIPLStatus Stop(void) = 0;

    virtual SIPLStatus Deinit(void) = 0;

    virtual ~INvSIPLClient(void) = default;
};

} // namespace nvsipl



#endif // NVSIPLCLIENT_HPP