IVGCVSW-2662 Create ISerializer class and refactor Serializer

Change-Id: I8a500182193cd218d88c2bb406bf22f496fe43d1
Signed-off-by: Nattapat Chaimanowong <nattapat.chaimanowong@arm.com>

4 files changed, 136 insertions, 43 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2768f6a18b..6503e6c229 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -158,6 +158,7 @@ if(BUILD_ARMNN_SERIALIZER)
 
     set(armnn_serializer_sources)
     list(APPEND armnn_serializer_sources
+        include/armnnSerializer/ISerializer.hpp
         include/armnnDeserializeParser/IDeserializeParser.hpp
         src/armnnSerializer/Schema_generated.h
         src/armnnSerializer/Serializer.hpp
diff --git a/include/armnnSerializer/ISerializer.hpp b/include/armnnSerializer/ISerializer.hpp
new file mode 100644
index 0000000000..4dbd1d101f
--- /dev/null
+++ b/include/armnnSerializer/ISerializer.hpp
@@ -0,0 +1,37 @@
+//
+// Copyright © 2017 Arm Ltd. All rights reserved.
+// SPDX-License-Identifier: MIT
+//
+#pragma once
+
+#include "armnn/INetwork.hpp"
+#include "armnn/NetworkFwd.hpp"
+#include "armnn/Types.hpp"
+
+namespace armnnSerializer
+{
+
+class ISerializer;
+using ISerializerPtr = std::unique_ptr<ISerializer, void(*)(ISerializer* serializer)>;
+
+class ISerializer
+{
+public:
+    static ISerializer* CreateRaw();
+    static ISerializerPtr Create();
+    static void Destroy(ISerializer* serializer);
+
+    /// Serializes the network to ArmNN SerializedGraph.
+    /// @param [in] inNetwork The network to be serialized.
+    virtual void Serialize(const armnn::INetwork& inNetwork) = 0;
+
+    /// Serializes the SerializedGraph to the stream.
+    /// @param [stream] the stream to save to
+    /// @return true if graph is Serialized to the Stream, false otherwise
+    virtual bool SaveSerializedToStream(std::ostream& stream) = 0;
+
+protected:
+    virtual ~ISerializer() {};
+};
+
+} //namespace armnnSerializer
diff --git a/src/armnnSerializer/Serializer.cpp b/src/armnnSerializer/Serializer.cpp
index acb672ad1f..ef4be69233 100644
--- a/src/armnnSerializer/Serializer.cpp
+++ b/src/armnnSerializer/Serializer.cpp
@@ -36,7 +36,7 @@ serializer::DataType GetFlatBufferDataType(DataType dataType)
 }
 
 // Build FlatBuffer for Input Layer
-void Serializer::VisitInputLayer(const IConnectableLayer* layer, LayerBindingId id, const char* name)
+void SerializerVisitor::VisitInputLayer(const IConnectableLayer* layer, LayerBindingId id, const char* name)
 {
     // Create FlatBuffer BaseLayer
     auto flatBufferInputBaseLayer = CreateLayerBase(layer, serializer::LayerType::LayerType_Input);
@@ -57,7 +57,7 @@ void Serializer::VisitInputLayer(const IConnectableLayer* layer, LayerBindingId
 }
 
 // Build FlatBuffer for Output Layer
-void Serializer::VisitOutputLayer(const IConnectableLayer* layer, LayerBindingId id, const char* name)
+void SerializerVisitor::VisitOutputLayer(const IConnectableLayer* layer, LayerBindingId id, const char* name)
 {
     // Create FlatBuffer BaseLayer
     auto flatBufferOutputBaseLayer = CreateLayerBase(layer, serializer::LayerType::LayerType_Output);
@@ -76,7 +76,7 @@ void Serializer::VisitOutputLayer(const IConnectableLayer* layer, LayerBindingId
 }
 
 // Build FlatBuffer for Addition Layer
-void Serializer::VisitAdditionLayer(const IConnectableLayer* layer, const char* name)
+void SerializerVisitor::VisitAdditionLayer(const IConnectableLayer* layer, const char* name)
 {
     // Create FlatBuffer BaseLayer
     auto flatBufferAdditionBaseLayer = CreateLayerBase(layer, serializer::LayerType::LayerType_Addition);
@@ -89,7 +89,7 @@ void Serializer::VisitAdditionLayer(const IConnectableLayer* layer, const char*
 }
 
 // Build FlatBuffer for Multiplication Layer
-void Serializer::VisitMultiplicationLayer(const IConnectableLayer* layer, const char* name)
+void SerializerVisitor::VisitMultiplicationLayer(const IConnectableLayer* layer, const char* name)
 {
     // Create FlatBuffer BaseLayer
     auto flatBufferMultiplicationBaseLayer = CreateLayerBase(layer, serializer::LayerType::LayerType_Multiplication);
@@ -102,29 +102,8 @@ void Serializer::VisitMultiplicationLayer(const IConnectableLayer* layer, const
     CreateAnyLayer(flatBufferMultiplicationLayer.o, serializer::Layer::Layer_MultiplicationLayer);
 }
 
-void Serializer::Serialize(const INetwork& inNetwork)
-{
-    // Iterate through to network
-    inNetwork.Accept(*this);
-
-    // Create FlatBuffer SerializedGraph
-    auto serializedGraph = serializer::CreateSerializedGraph(m_flatBufferBuilder,
-                                                             m_flatBufferBuilder.CreateVector(m_serializedLayers),
-                                                             m_flatBufferBuilder.CreateVector(m_inputIds),
-                                                             m_flatBufferBuilder.CreateVector(m_outputIds));
-
-    // Serialize the graph
-    m_flatBufferBuilder.Finish(serializedGraph);
-}
-
-bool Serializer::SaveSerializedToStream(std::ostream& stream)
-{
-    stream.write(reinterpret_cast<const char*>(m_flatBufferBuilder.GetBufferPointer()), m_flatBufferBuilder.GetSize());
-    return !stream.bad();
-}
-
-fb::Offset<serializer::LayerBase> Serializer::CreateLayerBase(const IConnectableLayer* layer,
-                                                              const serializer::LayerType layerType)
+fb::Offset<serializer::LayerBase> SerializerVisitor::CreateLayerBase(const IConnectableLayer* layer,
+                                                                     const serializer::LayerType layerType)
 {
     std::vector<fb::Offset<serializer::InputSlot>> inputSlots = CreateInputSlots(layer);
     std::vector<fb::Offset<serializer::OutputSlot>> outputSlots = CreateOutputSlots(layer);
@@ -137,7 +116,7 @@ fb::Offset<serializer::LayerBase> Serializer::CreateLayerBase(const IConnectable
                                        m_flatBufferBuilder.CreateVector(outputSlots));
 }
 
-void Serializer::CreateAnyLayer(const flatbuffers::Offset<void>& layer, const serializer::Layer serializerLayer)
+void SerializerVisitor::CreateAnyLayer(const flatbuffers::Offset<void>& layer, const serializer::Layer serializerLayer)
 {
     auto anyLayer = armnn::armnnSerializer::CreateAnyLayer(m_flatBufferBuilder,
                                                            serializerLayer,
@@ -145,7 +124,7 @@ void Serializer::CreateAnyLayer(const flatbuffers::Offset<void>& layer, const se
     m_serializedLayers.push_back(anyLayer);
 }
 
-std::vector<fb::Offset<serializer::InputSlot>> Serializer::CreateInputSlots(const IConnectableLayer* layer)
+std::vector<fb::Offset<serializer::InputSlot>> SerializerVisitor::CreateInputSlots(const IConnectableLayer* layer)
 {
     std::vector<fb::Offset <serializer::InputSlot>> inputSlots;
 
@@ -165,7 +144,7 @@ std::vector<fb::Offset<serializer::InputSlot>> Serializer::CreateInputSlots(cons
     return inputSlots;
 }
 
-std::vector<fb::Offset<serializer::OutputSlot>> Serializer::CreateOutputSlots(const IConnectableLayer* layer)
+std::vector<fb::Offset<serializer::OutputSlot>> SerializerVisitor::CreateOutputSlots(const IConnectableLayer* layer)
 {
     std::vector<fb::Offset<serializer::OutputSlot>> outputSlots;
 
@@ -197,4 +176,45 @@ std::vector<fb::Offset<serializer::OutputSlot>> Serializer::CreateOutputSlots(co
     return outputSlots;
 }
 
-} //namespace armnnSerializer
+
+ISerializer* ISerializer::CreateRaw()
+{
+    return new Serializer();
+}
+
+ISerializerPtr ISerializer::Create()
+{
+    return ISerializerPtr(CreateRaw(), &ISerializer::Destroy);
+}
+
+void ISerializer::Destroy(ISerializer* serializer)
+{
+    delete serializer;
+}
+
+void Serializer::Serialize(const INetwork& inNetwork)
+{
+    // Iterate through to network
+    inNetwork.Accept(m_SerializerVisitor);
+    flatbuffers::FlatBufferBuilder& fbBuilder = m_SerializerVisitor.GetFlatBufferBuilder();
+
+    // Create FlatBuffer SerializedGraph
+    auto serializedGraph = serializer::CreateSerializedGraph(
+        fbBuilder,
+        fbBuilder.CreateVector(m_SerializerVisitor.GetSerializedLayers()),
+        fbBuilder.CreateVector(m_SerializerVisitor.GetInputIds()),
+        fbBuilder.CreateVector(m_SerializerVisitor.GetOutputIds()));
+
+    // Serialize the graph
+    fbBuilder.Finish(serializedGraph);
+}
+
+bool Serializer::SaveSerializedToStream(std::ostream& stream)
+{
+    flatbuffers::FlatBufferBuilder& fbBuilder = m_SerializerVisitor.GetFlatBufferBuilder();
+
+    stream.write(reinterpret_cast<const char*>(fbBuilder.GetBufferPointer()), fbBuilder.GetSize());
+    return !stream.bad();
+}
+
+} //nameespace armnnSerializer
diff --git a/src/armnnSerializer/Serializer.hpp b/src/armnnSerializer/Serializer.hpp
index 8aec3ca42a..376f6a87d3 100644
--- a/src/armnnSerializer/Serializer.hpp
+++ b/src/armnnSerializer/Serializer.hpp
@@ -6,17 +6,40 @@
 
 #include <armnn/ILayerVisitor.hpp>
 #include <armnn/LayerVisitorBase.hpp>
+
+#include <armnnSerializer/ISerializer.hpp>
+
 #include <iostream>
 #include <Schema_generated.h>
 
 namespace armnnSerializer
 {
 
-class Serializer : public armnn::LayerVisitorBase<armnn::VisitorNoThrowPolicy>
+class SerializerVisitor : public armnn::LayerVisitorBase<armnn::VisitorNoThrowPolicy>
 {
 public:
-    Serializer() {};
-    ~Serializer() {};
+    SerializerVisitor() {};
+    ~SerializerVisitor() {};
+
+    flatbuffers::FlatBufferBuilder& GetFlatBufferBuilder()
+    {
+        return m_flatBufferBuilder;
+    }
+
+    std::vector<unsigned int>& GetInputIds()
+    {
+        return m_inputIds;
+    }
+
+    std::vector<unsigned int>& GetOutputIds()
+    {
+        return m_outputIds;
+    }
+
+    std::vector<flatbuffers::Offset<armnn::armnnSerializer::AnyLayer>>& GetSerializedLayers()
+    {
+        return m_serializedLayers;
+    }
 
     void VisitAdditionLayer(const armnn::IConnectableLayer* layer,
                             const char* name = nullptr) override;
@@ -32,15 +55,6 @@ public:
     void VisitMultiplicationLayer(const armnn::IConnectableLayer* layer,
                                   const char* name = nullptr) override;
 
-    /// Serializes the network to ArmNN SerializedGraph.
-    /// @param [in] inNetwork The network to be serialized.
-    void Serialize(const armnn::INetwork& inNetwork);
-
-    /// Serializes the SerializedGraph to the stream.
-    /// @param [stream] the stream to save to
-    /// @return true if graph is Serialized to the Stream, false otherwise
-    bool SaveSerializedToStream(std::ostream& stream);
-
 private:
 
     /// Creates the Input Slots and Output Slots and LayerBase for the layer.
@@ -72,4 +86,25 @@ private:
     std::vector<unsigned int> m_outputIds;
 };
 
+class Serializer : public ISerializer
+{
+public:
+    Serializer() {};
+    ~Serializer() {};
+
+    /// Serializes the network to ArmNN SerializedGraph.
+    /// @param [in] inNetwork The network to be serialized.
+    void Serialize(const armnn::INetwork& inNetwork) override;
+
+    /// Serializes the SerializedGraph to the stream.
+    /// @param [stream] the stream to save to
+    /// @return true if graph is Serialized to the Stream, false otherwise
+    bool SaveSerializedToStream(std::ostream& stream) override;
+
+private:
+
+    /// Visitor to contruct serialized network
+    SerializerVisitor m_SerializerVisitor;
+};
+
 } //namespace armnnSerializer