NvSIPLCamera.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 _NVSIPLCAMERA_HPP_
#define _NVSIPLCAMERA_HPP_

#include "NvSIPLCommon.hpp"
#include "NvSIPLPlatformCfg.hpp"
#include "NvSIPLPipelineMgr.hpp"

#include <memory>

namespace nvsipl
{

class INvSIPLCamera
{
 public:
    static std::unique_ptr<INvSIPLCamera> GetInstance(void);

    virtual SIPLStatus SetPlatformCfg(const PlatformCfg* platformCfg) = 0;

    virtual const PlatformCfg* GetPlatformCfg(void) const = 0;

    virtual SIPLStatus SetNotifier(std::uint32_t uIndex, NvSIPLPipelineNotifier* pNotifier) = 0;


    virtual SIPLStatus SetImageGroupWriterCallback(std::uint32_t uIndex, NvSIPLImageGroupWriter* pImageGroupWriter) = 0;

    virtual SIPLStatus SetOutputDesc(std::vector<INvSIPLClient::ConsumerDesc> vDescs) = 0;

    virtual SIPLStatus SetImagePoolAttributes(std::uint32_t index,
                                              INvSIPLClient::ConsumerDesc::OutputType outType,
                                              uint32_t numOfImages,
                                              const NvSIPLImageAttr &imageAttr) = 0;

    virtual SIPLStatus Init(void) = 0;

    virtual INvSIPLClient::ClientDesc* GetClientDesc(std::uint32_t index,
                                                     INvSIPLClient::ConsumerDesc::OutputType outType) = 0;

    virtual SIPLStatus Start(void) = 0;

    virtual SIPLStatus Stop(void) = 0;

    virtual SIPLStatus Deinit(void) = 0;

    virtual ~INvSIPLCamera(void) = default;

    // TODO: Add APIs to get deviceblock errors and handle recovery.

}; // INvSIPLCamera

} // namespace nvsipl



#endif //_NVSIPLCAMERA_HPP_