PlusIgtlClientInfo.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __PlusIgtlClientInfo_h
#define __PlusIgtlClientInfo_h

// Local includes
#include "PlusConfigure.h"
#include "vtkPlusOpenIGTLinkExport.h"

// IGSIO includes
#include <vtkIGSIOFrameConverter.h>

// IGTL includes
#include <igtlClientSocket.h>

// STL includes
#include <string>
#include <vector>

class vtkPlusCommandProcessor;

class vtkPlusOpenIGTLinkExport PlusIgtlClientInfo
{
public:
  struct EncodingParameters
  {
    std::string FourCC;
    bool        Lossless;
    int         MinKeyframeDistance;
    int         MaxKeyframeDistance;
    int         Speed;
    std::string RateControl;
    std::string DeadlineMode;
    int         TargetBitrate;
    EncodingParameters()
      : FourCC("VP90")
      , Lossless(false)
      , MinKeyframeDistance(-1)
      , MaxKeyframeDistance(-1)
      , Speed(8)
      , RateControl("Q")
      , DeadlineMode("REALTIME")
      , TargetBitrate(-1)
    {
    }
  };

  struct ImageStream
  {
    std::string Name;
    std::string EmbeddedTransformToFrame;
    vtkSmartPointer<vtkIGSIOFrameConverter> FrameConverter;
    ImageStream()
      : FrameConverter(nullptr)
    {
    };
  };

  struct VideoStream
  {
    std::string Name;
    std::string EmbeddedTransformToFrame;
    EncodingParameters EncodeVideoParameters;
    vtkSmartPointer<vtkIGSIOFrameConverter> FrameConverter;
    VideoStream()
      : FrameConverter(nullptr)
    {
    };
  };

  PlusIgtlClientInfo();

  PlusStatus SetClientInfoFromXmlData(const char* strXmlData);

  PlusStatus SetClientInfoFromXmlData(vtkXMLDataElement* xmldata);

  void GetClientInfoInXmlData(std::string& strXmlData);

  virtual void PrintSelf(ostream& os, vtkIndent indent);

  int GetClientHeaderVersion() const;
  void SetClientHeaderVersion(int version);

  int GetTDATAResolution() const;
  void SetTDATAResolution(int val);

  bool GetTDATARequested() const;
  void SetTDATARequested(bool val);

  double GetLastTDATASentTimeStamp() const;
  void SetLastTDATASentTimeStamp(double val);

  std::vector<std::string> IgtlMessageTypes;

  std::vector<igsioTransformName> TransformNames;

  std::vector<std::string> StringNames;

  std::vector<ImageStream> ImageStreams;

  std::vector<VideoStream> VideoStreams;

protected:
  int     ClientHeaderVersion;
  bool    TDATARequested;
  double  LastTDATASentTimeStamp;
  int     TDATAResolution;
};

#endif