include/armnnDeserializer/IDeserializer.hpp

//
// Copyright © 2017 Arm Ltd. All rights reserved.
// SPDX-License-Identifier: MIT
//
#pragma once

#include "armnn/Types.hpp"
#include "armnn/NetworkFwd.hpp"
#include "armnn/Tensor.hpp"
#include "armnn/INetwork.hpp"

#include <memory>
#include <map>
#include <vector>

namespace armnnDeserializer
{
struct BindingPointInfo
{
    armnn::LayerBindingId   m_BindingId;
    armnn::TensorInfo       m_TensorInfo;
};

class IDeserializer;
using IDeserializerPtr = std::unique_ptr<IDeserializer, void(*)(IDeserializer* parser)>;

class IDeserializer
{
public:
    static IDeserializer* CreateRaw();
    static IDeserializerPtr Create();
    static void Destroy(IDeserializer* parser);

    /// Create an input network from binary file contents
    virtual armnn::INetworkPtr CreateNetworkFromBinary(const std::vector<uint8_t>& binaryContent) = 0;

    /// Create an input network from a binary input stream
    virtual armnn::INetworkPtr CreateNetworkFromBinary(std::istream& binaryContent) = 0;

    /// Retrieve binding info (layer id and tensor info) for the network input identified by
    /// the given layer name and layers id
    virtual BindingPointInfo GetNetworkInputBindingInfo(unsigned int layerId,
                                                        const std::string& name) const = 0;

    /// Retrieve binding info (layer id and tensor info) for the network output identified by
    /// the given layer name and layers id
    virtual BindingPointInfo GetNetworkOutputBindingInfo(unsigned int layerId,
                                                         const std::string& name) const = 0;

protected:
    virtual ~IDeserializer() {};

};
} //namespace armnnDeserializer