AuroraMiddleware/lz4
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
a01e10dbdc
lz4/lib
History
Yann Collet a01e10dbdc Changed LZ4F compressionLevel from unsigned to signed, in anticipation for LZ4_compress_fast() integration.
2015-04-20 12:12:02 +01:00
..
liblz4.pc.in New directory structure : library source files into /lib directory 2014-11-30 23:32:12 +01:00
LICENSE New directory structure : library source files into /lib directory 2014-11-30 23:32:12 +01:00
lz4.c Replace GCC_VERSION with LZ4_GCC_VERSION 2015-04-15 06:39:04 +09:00
lz4.h Fix LZ4_DEPRECATED() for older/non-gcc/clang/MSVC compilers 2015-04-15 06:39:05 +09:00
lz4frame_static.h Updated LZ4F_getFrameInfo() behavior, related to uncomplete frame header decoding attempts 2015-04-19 15:23:53 +01:00
lz4frame.c Changed LZ4F compressionLevel from unsigned to signed, in anticipation for LZ4_compress_fast() integration. 2015-04-20 12:12:02 +01:00
lz4frame.h Changed LZ4F compressionLevel from unsigned to signed, in anticipation for LZ4_compress_fast() integration. 2015-04-20 12:12:02 +01:00
lz4hc.c Fixed a few Valgrind warnings 2015-04-12 09:29:52 +01:00
lz4hc.h Fix LZ4_DEPRECATED() in lz4hc.h 2015-04-15 14:19:17 +09:00
Makefile changed "make install" default install directory to /usr/local 2015-03-15 20:40:38 +01:00
README.md Added : Readme into lib directory, to explain what does each file 2015-03-16 21:48:40 +01:00
xxhash.c Fixed a few warnings from -fsanitize=undefined 2015-04-09 22:59:07 +01:00
xxhash.h Fixed cast-align warnings on 32-bits 2015-03-25 18:06:40 +01:00

README.md

LZ4 - Library Files

This directory contains many files, but you don't necessarily need them all.

If you want to integrate LZ4 compression/decompression into your program, you basically need to include "lz4.c" and "lz4.h" only.

If you want more compression, at the cost of compression speed (but preserving decompression speed), you will also have to include "lz4hc.c" and "lz4hc.h". Note that lz4hc needs lz4 to work properly.

Next level, if you want to produce files or data streams compatible with lz4 utility, you will have to use and include "lz4frame.c" and lz4frame.h". This library encapsulate lz4-compressed blocks into the official interoperable frame format. In order to work properly, lz4frame needs lz4 and lz4hc, and also "xxhash.c" and "xxhash.h", which provide the error detection algorithm.

A more complex "lz4frame_static.h" is also provided, although its usage is not recommended. It contains definitions which are not guaranteed to remain stable within future versions. Use only if you don't plan to update your lz4 version.

The other files are not source code. There are :

  • LICENSE : contains the BSD license text
  • Makefile : script to compile or install lz4 library (static or dynamic)
  • liblz4.pc.in : for pkg-config (make install)