vtkStreamingVolumeCodec.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 __vtkStreamingVolumeCodec_h
#define __vtkStreamingVolumeCodec_h

// vtkAddon includes
#include "vtkAddon.h"
#include "vtkAddonSetGet.h"
#include "vtkStreamingVolumeFrame.h"

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

// STD includes
#include <map>

#ifndef vtkCodecNewMacro
#define vtkCodecNewMacro(newClass) \
vtkStandardNewMacro(newClass); \
vtkStreamingVolumeCodec* newClass::CreateCodecInstance() \
{ \
return newClass::New(); \
}
#endif

class VTK_ADDON_EXPORT vtkStreamingVolumeCodec : public vtkObject
{
public:
  vtkTypeMacro(vtkStreamingVolumeCodec, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual std::string GetFourCC() = 0;

  // This can be overridden using vtkCodecNewMacro(className);
  virtual vtkStreamingVolumeCodec* CreateCodecInstance() = 0;

  virtual bool DecodeFrame(vtkStreamingVolumeFrame* frame, vtkImageData* outputImageData);

  virtual bool EncodeImageData(vtkImageData* inputImageData, vtkStreamingVolumeFrame* outputStreamingFrame, bool forceKeyFrame=false);

  virtual void SetParametersFromString(std::string parameterString);

  virtual std::string GetParametersAsString();

  enum
  {
    ParameterModifiedEvent = 18003 
  };

  vtkGetStdVectorMacro(AvailiableParameterNames, std::vector<std::string>);

  virtual std::string GetParameterDescription(std::string parameterName) = 0;

  virtual bool SetParameter(std::string parameterName, std::string parameterValue);

  virtual bool GetParameter(std::string parameterName, std::string& parameterValue);

  virtual void SetParameters(std::map<std::string, std::string> parameters);

  std::vector<std::string> GetParameterPresetNames() const;

  std::string GetParameterPresetValue(const std::string& presetName) const;

  std::string GetParameterPresetName(const std::string& presetValue) const;

  int GetNumberOfParameterPresets() const { return this->ParameterPresets.size(); };

  struct ParameterPreset
  {
    std::string Name;
    std::string Value;
  };
  // Get a list of all supported parameter presets for the codec
  vtkGetStdVectorMacro(ParameterPresets, const std::vector<ParameterPreset>);

  virtual bool SetParametersFromPresetValue(const std::string& presetValue);

  vtkGetMacro(DefaultParameterPresetValue, std::string);

protected:

  virtual bool UpdateParameterInternal(std::string parameterName, std::string parameterValue) = 0;

  virtual bool DecodeFrameInternal(vtkStreamingVolumeFrame* inputFrame, vtkImageData* outputImageData, bool saveDecodedImage = true) = 0;

  virtual bool EncodeImageDataInternal(vtkImageData* inputImageData, vtkStreamingVolumeFrame* outputFrame, bool forceKeyFrame) = 0;

protected:
  vtkStreamingVolumeCodec();
  ~vtkStreamingVolumeCodec();

private:
  vtkStreamingVolumeCodec(const vtkStreamingVolumeCodec&);
  void operator=(const vtkStreamingVolumeCodec&);

protected:
  std::vector<std::string>                  AvailiableParameterNames;
  vtkSmartPointer<vtkStreamingVolumeFrame>  LastDecodedFrame;
  std::map<std::string, std::string>        Parameters;
  std::vector<ParameterPreset>              ParameterPresets;
  std::string                               DefaultParameterPresetValue;
};

#endif