// Copyright 2013 Velodyne Acoustics, Inc.
// Copyright 2018 Kitware SAS.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef VTKSTREAM_H
#define VTKSTREAM_H

#include <memory>
#include <mutex>
#include <string>

#include <vtkDataObjectAlgorithm.h>
#include <vtkSmartPointer.h>

class NetworkPacket;
class PacketConsumer;
class PacketFileWriter;
class PacketReceiver;
class vtkInterpreter;

class VTK_EXPORT vtkStream : public vtkDataObjectAlgorithm
{
public:
  vtkTypeMacro(vtkStream, vtkDataObjectAlgorithm)

  virtual void Start();
  void Stop();

  static void StartRecording(const std::string& filename);
  static void StopRecording();
  static bool IsRecording();

  vtkGetMacro(ListeningPort, int)
  void SetListeningPort(int);

  vtkGetMacro(MulticastAddress, std::string)
  void SetMulticastAddress(const std::string&);

  vtkGetMacro(LocalListeningAddress, std::string)
  void SetLocalListeningAddress(const std::string&);

  vtkGetMacro(ForwardedIpAddress, std::string)
  void SetForwardedIpAddress(const std::string& ipAddress);

  vtkGetMacro(ForwardedPort, int)
  void SetForwardedPort(int);

  vtkGetMacro(IsForwarding, bool)
  void SetIsForwarding(bool);

  vtkGetMacro(IsCrashAnalysing, bool)
  void SetIsCrashAnalysing(bool value);

  /**
   * @brief GetNeedsUpdate
   * @return true if a new data is ready
   */
  bool GetNeedsUpdate();

  /**
   * @brief AddNewData Add the new data available to the specific buffer of the Stream
   * @warning Not thread safe! Be sure the DataMutex is locked before calling it!
   */
  virtual void AddNewData() = 0;

  /**
   * @brief ClearAllDataAvailable Clear the buffer that contains data
   * @warning Not thread safe! Be sure the DataMutex is locked before calling it!
   */
  virtual void ClearAllDataAvailable() = 0;

  /**
   * @brief CheckForNewData Check if there is new data available
   * @warning Not thread safe! Be sure the DataMutex is locked before calling it!
   *
   */
  virtual int CheckForNewData() = 0;

  /**
   * @brief GetInterpreter Get specific subclass interpreter
   */
  virtual vtkSmartPointer<vtkInterpreter> GetInterpreter() = 0;

  /**
   * @brief SetInterpreter Set specific subclass interpreter
   */
  virtual void SetInterpreter(vtkSmartPointer<vtkInterpreter> interpreter) = 0;

  /**
   * @brief mutex to protect the data store in the Stream as they are filled
   * in one thread by the ConsumerThread, and accesed in another thread by the
   * RequestData.
   *
   * @todo it look like the interpreter is another shared ressource.
   * However unless making the Interpreter thread-safe, it seams impossible
   * to lock it before accesing it, as it will be accessed by some generated
   * code, due to paraview.
   */
  std::mutex DataMutex;

protected:
  vtkStream();
  // WARNING: inheriting classes destructors must call Stop() on this base class
  // because this base Stream class holds (and starts) the callback thread that
  // call the packet consumer of the derived class.
  // Forgetting to do so might let the callback thread "ConsumerThread" call
  // the consumer function "AddNewData" after actual inherited class destruction,
  // resulting in a pure virtual function call at runtime.
  virtual ~vtkStream() = 0;

  virtual int RequestData(vtkInformation* request,
                  vtkInformationVector** inputVector,
                  vtkInformationVector* outputVector) = 0;

private:
  vtkStream(const vtkStream&) = delete;
  void operator=(const vtkStream&) = delete;

  /*!< The port to receive information*/
  int ListeningPort = 2368;
  /*!< The multicast address to receive packets*/
  std::string MulticastAddress;
  /*!< The Listening address in case of multiples interfaces*/
  std::string LocalListeningAddress;

  /*!< Allowing the forwarding of the packets*/
  bool IsForwarding = false;
  /*!< The port to send forwarded packets*/
  int ForwardedPort = 2369;
  /*!< The ip to send forwarded packets*/
  std::string ForwardedIpAddress = "127.0.0.1";


  bool IsCrashAnalysing = false;

  //! Thread that will listen on the network to get the packets
  std::unique_ptr<PacketReceiver> ReceiverThread;
  //! Thread that will consume the packets
  std::unique_ptr<PacketConsumer> ConsumerThread;
  //! Thread that will write the packets if recording
  static std::unique_ptr<PacketFileWriter> WriterThread;

  //! Callback function used by the ReceiverThread once a new NetworkPacket is ready
  //! The given packet will be queue in the Consumer and Writer thread queue.
  void EnqueuePacket(NetworkPacket* packet);

  bool IsRunning();

  //! helper function
  template<class T> void SetAttributeAndRestartIfRunning(T& attribute, const T& value);
};

#endif // VTKSTREAM_H
