ZstdCompression.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>
#include <OpenMS/CONCEPT/Exception.h>
 
#include <string>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI ZstdCompression
  {
public:
 
    enum class ByteTransform
    {
      NONE,         
      BYTE_SHUFFLE, 
      DICTIONARY    
    };
 
    static constexpr int DEFAULT_LEVEL = 3;
 
    static void compressData(const void* raw_data, size_t in_length, std::string& compressed_data, int level = DEFAULT_LEVEL);
 
    static void uncompressData(const void* compressed_data, size_t nr_bytes, std::string& out, size_t expected_size = 0,
                               size_t max_size = 0);
 
    static void byteShuffle(const void* data, size_t nr_bytes, size_t element_size, std::string& out);
 
    static void byteUnshuffle(const void* data, size_t nr_bytes, size_t element_size, std::string& out);
 
    static void dictionaryEncode(const void* data, size_t nr_bytes, size_t element_size, std::string& out);
 
    static void dictionaryDecode(const void* data, size_t nr_bytes, size_t element_size, std::string& out, size_t array_length = 0);
 
    static void encode(const void* data, size_t nr_bytes, ByteTransform transform, size_t element_size, std::string& out, int level = DEFAULT_LEVEL);
 
    static void decode(const void* data, size_t nr_bytes, ByteTransform transform, size_t element_size, std::string& out, size_t array_length = 0);
  };
 
} // namespace OpenMS