NameDateSize

..10-Aug-20184 KiB

.gitignore10-Aug-201834

Android.bp10-Aug-2018349

dll/10-Aug-20184 KiB

liblz4.pc.in10-Aug-2018385

LICENSE10-Aug-20181.3 KiB

lz4.c10-Aug-201856.5 KiB

lz4.h10-Aug-201822.8 KiB

lz4frame.c10-Aug-201858.5 KiB

lz4frame.h10-Aug-201816.4 KiB

lz4frame_static.h10-Aug-20183.3 KiB

lz4hc.c10-Aug-201827.3 KiB

lz4hc.h10-Aug-201811.5 KiB

lz4opt.h10-Aug-201812.7 KiB

Makefile10-Aug-20186.2 KiB

MODULE_LICENSE_BSD10-Aug-20180

NOTICE10-Aug-20181.3 KiB

README.md10-Aug-20182.7 KiB

xxhash.c10-Aug-201829 KiB

xxhash.h10-Aug-201812.3 KiB

README.md

1LZ4 - Library Files
2================================
3
4The directory contains many files, but depending on project's objectives,
5not all of them are necessary.
6
7#### Minimal LZ4 build
8
9The minimum required is **`lz4.c`** and **`lz4.h`**,
10which will provide the fast compression and decompression algorithm.
11
12
13#### The High Compression variant of LZ4
14
15For more compression at the cost of compression speed,
16the High Compression variant **lz4hc** is available.
17It's necessary to add **`lz4hc.c`** and **`lz4hc.h`**.
18The variant still depends on regular `lz4` source files.
19In particular, the decompression is still provided by `lz4.c`.
20
21
22#### Compatibility issues
23
24In order to produce files or streams compatible with `lz4` command line utility,
25it's necessary to encode lz4-compressed blocks using the [official interoperable frame format].
26This format is generated and decoded automatically by the **lz4frame** library.
27In order to work properly, lz4frame needs lz4 and lz4hc, and also **xxhash**,
28which provides error detection.
29(_Advanced stuff_ : It's possible to hide xxhash symbols into a local namespace.
30This is what `liblz4` does, to avoid symbol duplication
31in case a user program would link to several libraries containing xxhash symbols.)
32
33
34#### Advanced API 
35
36A more complex `lz4frame_static.h` is also provided.
37It contains definitions which are not guaranteed to remain stable within future versions.
38It must be used with static linking ***only***.
39
40
41#### Using MinGW+MSYS to create DLL
42
43DLL can be created using MinGW+MSYS with the `make liblz4` command.
44This command creates `dll\liblz4.dll` and the import library `dll\liblz4.lib`.
45The import library is only required with Visual C++.
46The header files `lz4.h`, `lz4hc.h`, `lz4frame.h` and the dynamic library
47`dll\liblz4.dll` are required to compile a project using gcc/MinGW.
48The dynamic library has to be added to linking options.
49It means that if a project that uses LZ4 consists of a single `test-dll.c`
50file it should be linked with `dll\liblz4.dll`. For example:
51```
52    gcc $(CFLAGS) -Iinclude/ test-dll.c -o test-dll dll\liblz4.dll
53```
54The compiled executable will require LZ4 DLL which is available at `dll\liblz4.dll`. 
55
56
57#### Miscellaneous 
58
59Other files present in the directory are not source code. There are :
60
61 - LICENSE : contains the BSD license text
62 - Makefile : script to compile or install lz4 library (static or dynamic)
63 - liblz4.pc.in : for pkg-config (make install)
64 - README.md : this file
65
66[official interoperable frame format]: ../doc/lz4_Frame_format.md
67
68
69#### License 
70
71All source material within __lib__ directory are BSD 2-Clause licensed.
72See [LICENSE](LICENSE) for details.
73The license is also repeated at the top of each source file.
74