vtkDataCompressor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkDataCompressor_h
#define vtkDataCompressor_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkUnsignedCharArray;
 
class VTKIOCORE_EXPORT vtkDataCompressor : public vtkObject
{
public:
  vtkTypeMacro(vtkDataCompressor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual size_t GetMaximumCompressionSpace(size_t size) = 0;
 
  size_t Compress(unsigned char const* uncompressedData, size_t uncompressedSize,
    unsigned char* compressedData, size_t compressionSpace);
 
  size_t Uncompress(unsigned char const* compressedData, size_t compressedSize,
    unsigned char* uncompressedData, size_t uncompressedSize);
 
  vtkUnsignedCharArray* Compress(unsigned char const* uncompressedData, size_t uncompressedSize);
 
  vtkUnsignedCharArray* Uncompress(
    unsigned char const* compressedData, size_t compressedSize, size_t uncompressedSize);
 
  virtual void SetCompressionLevel(int compressionLevel) = 0;
  virtual int GetCompressionLevel() = 0;
 
protected:
  vtkDataCompressor();
  ~vtkDataCompressor() override;
 
  // Actual compression method.  This must be provided by a subclass.
  // Must return the size of the compressed data, or zero on error.
  virtual size_t CompressBuffer(unsigned char const* uncompressedData, size_t uncompressedSize,
    unsigned char* compressedData, size_t compressionSpace) = 0;
  // Actual decompression method.  This must be provided by a subclass.
  // Must return the size of the uncompressed data, or zero on error.
  virtual size_t UncompressBuffer(unsigned char const* compressedData, size_t compressedSize,
    unsigned char* uncompressedData, size_t uncompressedSize) = 0;
 
private:
  vtkDataCompressor(const vtkDataCompressor&) = delete;
  void operator=(const vtkDataCompressor&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif