vtkLZ4DataCompressor.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkLZ4DataCompressor.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkLZ4DataCompressor_h
#define vtkLZ4DataCompressor_h
 
#include "vtkDataCompressor.h"
#include "vtkIOCoreModule.h" // For export macro
 
class VTKIOCORE_EXPORT vtkLZ4DataCompressor : public vtkDataCompressor
{
public:
  vtkTypeMacro(vtkLZ4DataCompressor, vtkDataCompressor);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkLZ4DataCompressor* New();
 
  size_t GetMaximumCompressionSpace(size_t size) override;
  // Compression level getter required by vtkDataCompressor.
  int GetCompressionLevel() override;
 
  // Compression level setter required by vtkDataCompresor.
  void SetCompressionLevel(int compressionLevel) override;
 
  // Direct setting of AccelerationLevel allows more direct
  // control over LZ4 compressor
  vtkSetClampMacro(AccelerationLevel, int, 1, VTK_INT_MAX);
  vtkGetMacro(AccelerationLevel, int);
 
protected:
  vtkLZ4DataCompressor();
  ~vtkLZ4DataCompressor() override;
 
  int AccelerationLevel;
 
  // Compression method required by vtkDataCompressor.
  size_t CompressBuffer(unsigned char const* uncompressedData, size_t uncompressedSize,
    unsigned char* compressedData, size_t compressionSpace) override;
  // Decompression method required by vtkDataCompressor.
  size_t UncompressBuffer(unsigned char const* compressedData, size_t compressedSize,
    unsigned char* uncompressedData, size_t uncompressedSize) override;
 
private:
  vtkLZ4DataCompressor(const vtkLZ4DataCompressor&) = delete;
  void operator=(const vtkLZ4DataCompressor&) = delete;
};
 
#endif