Go to file
2018-04-26 17:18:40 -04:00
contrib fix #482: change CFLAGS to CXXFLAGS 2018-03-09 11:54:32 -08:00
doc minor edit of block format 2018-04-25 06:42:57 -07:00
examples merge lz4opt.h into lz4hc.c 2018-02-25 00:32:09 -08:00
lib Limit Dictionary Size During LZ4F Decompression 2018-04-26 17:18:40 -04:00
programs Change Over Includes in the Project 2018-04-24 16:22:28 -04:00
tests Multiply-Include Header to Check Guard Macro Correctness 2018-04-24 18:50:03 -04:00
visual added vs2017 projects 2018-04-02 10:52:45 +08:00
.gitattributes restored .travis 2018-01-14 00:21:43 -08:00
.gitignore added fullbench-dll.sln that works with gcc/MinGW 2016-11-15 12:57:03 +01:00
.travis.yml added sudo rights for low-mem-address tests 2018-04-13 00:59:27 -07:00
appveyor.yml EnableWholeProgramOptimization and UseStaticCRT msbuild custom properties 2017-12-11 14:57:19 +02:00
circle.yml modified versionsTest 2018-04-12 06:47:27 -07:00
INSTALL minor typo fix 2017-08-30 15:02:04 -07:00
LICENSE updated LICENSE 2017-02-28 15:12:24 -08:00
Makefile reduced test time on circle-ci 2018-04-11 16:31:43 -07:00
NEWS bumped version number to v1.8.2 2018-02-26 13:50:04 -08:00
README.md minor typo fix 2017-08-30 15:02:04 -07:00

LZ4 - Extremely fast compression

LZ4 is lossless compression algorithm, providing compression speed at 400 MB/s per core, scalable with multi-cores CPU. It features an extremely fast decoder, with speed in multiple GB/s per core, typically reaching RAM speed limits on multi-core systems.

Speed can be tuned dynamically, selecting an "acceleration" factor which trades compression ratio for more speed up. On the other end, a high compression derivative, LZ4_HC, is also provided, trading CPU time for improved compression ratio. All versions feature the same decompression speed.

LZ4 library is provided as open-source software using BSD 2-Clause license.

Branch Status
master Build Status Build status coverity
dev Build Status Build status

Branch Policy:

  • The "master" branch is considered stable, at all times.
  • The "dev" branch is the one where all contributions must be merged before being promoted to master.
    • If you plan to propose a patch, please commit into the "dev" branch, or its own feature branch. Direct commit to "master" are not permitted.

Benchmarks

The benchmark uses lzbench, from @inikep compiled with GCC v6.2.0 on Linux 64-bits. The reference system uses a Core i7-3930K CPU @ 4.5GHz. Benchmark evaluates the compression of reference Silesia Corpus in single-thread mode.

Compressor Ratio Compression Decompression
memcpy 1.000 7300 MB/s 7300 MB/s
LZ4 fast 8 (v1.7.3) 1.799 911 MB/s 3360 MB/s
LZ4 default (v1.7.3) 2.101 625 MB/s 3220 MB/s
LZO 2.09 2.108 620 MB/s 845 MB/s
QuickLZ 1.5.0 2.238 510 MB/s 600 MB/s
Snappy 1.1.3 2.091 450 MB/s 1550 MB/s
LZF v3.6 2.073 365 MB/s 820 MB/s
Zstandard 1.1.1 -1 2.876 330 MB/s 930 MB/s
Zstandard 1.1.1 -3 3.164 200 MB/s 810 MB/s
zlib deflate 1.2.8 -1 2.730 100 MB/s 370 MB/s
LZ4 HC -9 (v1.7.3) 2.720 34 MB/s 3240 MB/s
zlib deflate 1.2.8 -6 3.099 33 MB/s 390 MB/s

LZ4 is also compatible and well optimized for x32 mode, for which it provides an additional +10% speed performance.

Installation

make
make install     # this command may require root access

LZ4's Makefile supports standard Makefile conventions, including staged installs, redirection, or command redefinition. It is compatible with parallel builds (-j#).

Documentation

The raw LZ4 block compression format is detailed within lz4_Block_format.

To compress an arbitrarily long file or data stream, multiple blocks are required. Organizing these blocks and providing a common header format to handle their content is the purpose of the Frame format, defined into lz4_Frame_format. Interoperable versions of LZ4 must respect this frame format.

Other source versions

Beyond the C reference source, many contributors have created versions of lz4 in multiple languages (Java, C#, Python, Perl, Ruby, etc.). A list of known source ports is maintained on the LZ4 Homepage.