LZ👌 – MIT licensed C++ implementation of LZO compression/decompression algorithm
Go to file
Phillip Stephens db2df1fcbe
Merge pull request #7 from bionade24/master
Fix building on gcc>=12 and Clang >=13 by including <iterator> explicitly.
2023-10-22 08:29:08 -07:00
lzokay-c Add a C wrapper for decompression 2020-05-09 18:31:38 +02:00
CMakeLists.txt Merge pull request #3 from robUx4/c-wrapper 2020-05-09 12:10:08 -10:00
Config.cmake.in Adding install commands and cmake build config file support 2019-01-04 14:53:04 -07:00
LICENSE Initial commit 2018-12-23 15:43:24 -10:00
README.md Update README.md 2019-07-13 11:35:06 -10:00
lzokay.cpp Include <iterator> explicitly for building on gcc12, clang13 and higher. 2023-08-28 12:25:37 +02:00
lzokay.hpp Make public API have separate input/output dest size variables 2019-06-13 14:32:25 -10:00
test.cpp Update test.cpp for API change 2019-06-13 14:40:21 -10:00

README.md

LZ👌

A minimal, C++14 implementation of the LZO compression format.

Objective

The implementation provides compression behavior similar to the lzo1x_999_compress function in lzo2 (i.e. higher compression, lower speed). The implementation is fixed to the default parameters of the original and provides no facilities for various compression "levels" or an initialization dictionary.

The decompressor is compatible with data compressed by other LZO1X implementations.

Usage

#include <lzokay.hpp>
#include <cstring>

int compress_and_decompress(const uint8_t* data, std::size_t length) {
  lzokay::EResult error;

  /* This variable and 6th parameter of compress() is optional, but may
   * be reused across multiple compression runs; avoiding repeat
   * allocation/deallocation of the work memory used by the compressor.
   */
  lzokay::Dict<> dict;

  std::size_t estimated_size = lzokay::compress_worst_size(length);
  std::unique_ptr<uint8_t[]> compressed(new uint8_t[estimated_size]);
  std::size_t compressed_size;
  error = lzokay::compress(data, length, compressed.get(), estimated_size,
                           compressed_size, dict);
  if (error < lzokay::EResult::Success)
    return 1;

  std::unique_ptr<uint8_t[]> decompressed(new uint8_t[length]);
  std::size_t decompressed_size;
  error = lzokay::decompress(compressed.get(), compressed_size,
                             decompressed.get(), length, decompressed_size);
  if (error < lzokay::EResult::Success)
    return 1;

  if (std::memcmp(data, decompressed.get(), decompressed_size) != 0)
    return 1;

  return 0;
}

License

LZ👌 is available under the MIT License and has no external dependencies.