| commit | 661c48040ea485202f6ba1f0d029d1bc1fca963a | [log] [download] |
|---|---|---|
| author | Evan Nemerson <evan@nemerson.com> | Tue Nov 08 13:31:47 2016 -0800 |
| committer | Evan Nemerson <evan@nemerson.com> | Tue Nov 08 13:31:47 2016 -0800 |
| tree | ecf6d1953865d3782eac53dade28d8e8905ffcb7 | |
| parent | ce2202690f0f1ad093970a747f5d1dc01ee691f3 [diff] |
cmake: significant changes to accomodate a new "bundled" mode.
This makes it much easier to include LZ4 in a CMake-based project;
you only need to add_subdirectory(lz4/contrib/cmake_unofficial),
then you can use the lz4 target (which is the library). In bundled
mode a static library will be built and nothing will be installed,
although the lz4 and lz4c command line tools will still be built.
This also makes some other much less intrusive changes, including:
* Version information is now parsed from lib/lz4.h so the
CMakeLists.txt file no longer needs to manually be kept up to date
manually.
* pkg-config file uses ${prefix} where appropriate instead of writing
out full paths, which is important for people on Windows.
* Warning flags are now checked instead of blindly added.
* The GNUInstallDirs module is used to determine installation
locations.
* The static library generates position independent code, which means
it's usable when building a shared library.
* The CLI tools link to liblz4 instead of duplicating the object code.
- .gitattributes
- .gitignore
- .travis.yml
- LICENSE
- Makefile
- NEWS
- README.md
- appveyor.yml
- contrib/
- doc/
- examples/
- lib/
- programs/
- tests/
- visual/
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 |   |
| dev |  |
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 the Open-Source Benchmark program by m^2 (v0.14.3) compiled with GCC v4.8.2 on Linux Mint 64-bits v17. The reference system uses a Core i5-4300U @1.9GHz. Benchmark evaluates the compression of reference Silesia Corpus in single-thread mode.
| Compressor | Ratio | Compression | Decompression |
|---|---|---|---|
| memcpy | 1.000 | 4200 MB/s | 4200 MB/s |
| LZ4 fast 17 (r129) | 1.607 | 690 MB/s | 2220 MB/s |
| LZ4 default (r129) | 2.101 | 385 MB/s | 1850 MB/s |
| LZO 2.06 | 2.108 | 350 MB/s | 510 MB/s |
| QuickLZ 1.5.1.b6 | 2.238 | 320 MB/s | 380 MB/s |
| Snappy 1.1.0 | 2.091 | 250 MB/s | 960 MB/s |
| Zstandard 0.5.1 | 2.876 | 240 MB/s | 620 MB/s |
| LZF v3.6 | 2.073 | 175 MB/s | 500 MB/s |
| zlib 1.2.8 -1 | 2.730 | 59 MB/s | 250 MB/s |
| LZ4 HC (r129) | 2.720 | 22 MB/s | 1830 MB/s |
| zlib 1.2.8 -6 | 3.099 | 18 MB/s | 270 MB/s |
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.