vtkMRMLStreamingVolumeNode.h

Go to the documentation of this file.

/*==============================================================================

Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
Queen's University, Kingston, ON, Canada. All Rights Reserved.

See COPYRIGHT.txt
or http://www.slicer.org/copyright/copyright.txt for details.

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.

This file was originally developed by Kyle Sunderland, PerkLab, Queen's University
and was supported through CANARIE's Research Software Program, and Cancer
Care Ontario.

==============================================================================*/

#ifndef __vtkMRMLStreamingVolumeNode_h
#define __vtkMRMLStreamingVolumeNode_h

// MRML includes
#include "vtkMRML.h"
#include "vtkMRMLNode.h"
#include "vtkMRMLStorageNode.h"
#include "vtkMRMLVectorVolumeDisplayNode.h"
#include "vtkMRMLVectorVolumeNode.h"
#include "vtkMRMLVolumeArchetypeStorageNode.h"

// vtkAddon includes
#include "vtkStreamingVolumeCodec.h"

// VTK includes
#include <vtkImageData.h>
#include <vtkObject.h>
#include <vtkStdString.h>
#include <vtkUnsignedCharArray.h>

class  VTK_MRML_EXPORT vtkMRMLStreamingVolumeNode : public vtkMRMLVectorVolumeNode
{
public:
  static vtkMRMLStreamingVolumeNode *New();
  vtkTypeMacro(vtkMRMLStreamingVolumeNode,vtkMRMLVectorVolumeNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLNode* CreateNodeInstance() override;

  void ProcessMRMLEvents(vtkObject *caller, unsigned long event, void *callData) override;

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLStreamingVolumeNode);

  const char* GetNodeTagName() override
  {return "StreamingVolume";}

  void SetAndObserveImageData(vtkImageData* imageData) override;
  vtkImageData* GetImageData() override;
  vtkAlgorithmOutput* GetImageDataConnection() override;

  void SetAndObserveFrame(vtkStreamingVolumeFrame* frame);

  vtkStreamingVolumeFrame* GetFrame(){return this->Frame.GetPointer();};

  virtual bool EncodeImageData(bool forceKeyFrame = false);

  virtual bool DecodeFrame();

  virtual bool IsKeyFrame();

  static void FrameModifiedCallback(vtkObject *caller, unsigned long eid, void* clientData, void* callData);
  enum
  {
    FrameModifiedEvent = 18002
  };

  vtkSetMacro(Codec, vtkStreamingVolumeCodec*);
  vtkStreamingVolumeCodec* GetCodec();

  vtkGetMacro(CodecFourCC, std::string);
  vtkSetMacro(CodecFourCC, std::string);

  void SetCodecParameterString(std::string parameterString);
  std::string GetCodecParameterString();

protected:
  vtkMRMLStreamingVolumeNode();
  ~vtkMRMLStreamingVolumeNode() override;
  vtkMRMLStreamingVolumeNode(const vtkMRMLStreamingVolumeNode&);
  void operator=(const vtkMRMLStreamingVolumeNode&);

  void AllocateImageForFrame(vtkImageData* imageData);

  bool HasExternalImageObserver();

protected:
  vtkSmartPointer<vtkStreamingVolumeCodec> Codec;
  std::string                              CodecFourCC;
  vtkSmartPointer<vtkStreamingVolumeFrame> Frame;
  bool                                     FrameDecoded{false};
  bool                                     FrameDecodingInProgress{false};
  vtkSmartPointer<vtkCallbackCommand>      FrameModifiedCallbackCommand;

};

#endif