AuroraMiddleware/lz4
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
594 Commits 13 Branches 31 Tags 6.8 MiB
C 84.9%
Makefile 6%
Python 3.9%
Meson 1.8%
Roff 0.9%
Other 2.4%
936f75b4db
Go to file
Louis P. Santillan 936f75b4db Renamed the djgpp README so that it gets converted to HTML by github. Fixed breakage of make install.
2015-05-26 10:26:42 -07:00
cmake_unofficial Install the lz4frame.h header in the cmake build 2015-04-28 09:53:08 -05:00
examples Updated lz4hc API 2015-05-03 20:57:21 +01:00
lib Renamed the djgpp README so that it gets converted to HTML by github. Fixed breakage of make install. 2015-05-26 10:26:42 -07:00
programs Fixup programs/{Makefile,lz4cli.c,lz4io.c} to build with Andrew Wu's build-djgpp cross compilers. Add some documentation in README.DJ 2015-05-25 21:41:45 -07:00
visual/2012 Modified files rights 2015-03-31 20:29:24 +01:00
.gitattributes Added : Visual project directory 2015-01-13 05:36:58 +01:00
.travis.yml Added : sanitize test 2015-04-09 23:53:55 +01:00
lz4_Block_format.md minor parsing update 2015-05-06 20:57:35 +01:00
lz4_Frame_format.md updated doc 2015-04-06 01:03:49 +01:00
Makefile Makefile cleanups to make building with Andrew Wu's build-djgpp cross compilers (and everyone else) simpler. 2015-05-25 21:48:40 -07:00
NEWS Updated readme 2015-05-04 14:43:37 +01:00
README.md Updated readme 2015-05-04 14:43:37 +01:00
READMEDJ.MD Renamed the djgpp README so that it gets converted to HTML by github. Fixed breakage of make install. 2015-05-26 10:26:42 -07:00

README.md

LZ4 - Extremely fast compression

LZ4 is lossless compression algorithm, providing compression speed at 400 MB/s per core, scalable with multi-cores CPU. It also 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 excellent decompression speed.

Branch Status
master Build Status Build status
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 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
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. A list of these sources is maintained on the LZ4 Homepage.