vtkZlibImageCompressor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkZlibImageCompressor_h
#define vtkZlibImageCompressor_h

#include "vtkImageCompressor.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro

class vtkZlibCompressorImageConditioner;
class vtkMultiProcessStream;

class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkZlibImageCompressor : public vtkImageCompressor
{
public:
  static vtkZlibImageCompressor* New();
  vtkTypeMacro(vtkZlibImageCompressor, vtkImageCompressor);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  int Compress() override;
  int Decompress() override;


  void SaveConfiguration(vtkMultiProcessStream* stream) override;
  bool RestoreConfiguration(vtkMultiProcessStream* stream) override;

  const char* SaveConfiguration() override;
  const char* RestoreConfiguration(const char* stream) override;


  vtkSetClampMacro(CompressionLevel, int, 1, 9);
  vtkGetMacro(CompressionLevel, int);


  void SetColorSpace(int csId);
  int GetColorSpace();


  void SetStripAlpha(int status);
  int GetStripAlpha();

  void SetLossLessMode(int mode) override;

protected:
  vtkZlibImageCompressor();
  ~vtkZlibImageCompressor() override;

private:
  vtkZlibCompressorImageConditioner* Conditioner; // manages color space reduction and strip alpha
  int CompressionLevel;                           // zlib compression level

  vtkZlibImageCompressor(const vtkZlibImageCompressor&) = delete;
  void operator=(const vtkZlibImageCompressor&) = delete;
};

#endif