| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 1 | zstd - library files |
| 2 | ================================ |
| 3 | |
| 4 | The __lib__ directory contains several files, but depending on target use case, some of them may not be necessary. |
| 5 | |
| 6 | #### Minimal library files |
| 7 | |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 8 | To build the zstd library the following files are required: |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 9 | |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 10 | - [common/bitstream.h](common/bitstream.h) |
| 11 | - [common/error_private.h](common/error_private.h) |
| 12 | - [common/error_public.h](common/error_public.h) |
| 13 | - common/fse.h |
| 14 | - common/fse_static.h |
| 15 | - common/huf.h |
| 16 | - common/huf_static.h |
| 17 | - [common/mem.h](common/mem.h) |
| inikep | a8138fd | 2016-04-25 11:36:44 +0200 | [diff] [blame^] | 18 | - [common/zstd.h] |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 19 | - common/zstd_internal.h |
| 20 | - common/zstd_static.h |
| 21 | - compress/fse_compress.c |
| 22 | - compress/huf_compress.c |
| 23 | - compress/zstd_compress.c |
| 24 | - compress/zstd_opt.h |
| 25 | - decompress/fse_decompress.c |
| 26 | - decompress/huf_decompress.c |
| 27 | - decompress/zstd_decompress.c |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 28 | |
| inikep | a8138fd | 2016-04-25 11:36:44 +0200 | [diff] [blame^] | 29 | Stable API is exposed in [common/zstd.h]. |
| 30 | Advanced and experimental API is exposed in `common/zstd_static.h`. |
| 31 | `common/zstd_static.h` API elements should be used with static linking only, |
| Yann Collet | dcc000f | 2016-03-10 01:09:41 +0100 | [diff] [blame] | 32 | as their definition may change in future version of the library. |
| 33 | |
| inikep | a8138fd | 2016-04-25 11:36:44 +0200 | [diff] [blame^] | 34 | [common/zstd.h]: common/zstd.h |
| 35 | |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 36 | |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 37 | #### Separate compressor and decompressor |
| 38 | |
| inikep | a8138fd | 2016-04-25 11:36:44 +0200 | [diff] [blame^] | 39 | To build a separate zstd compressor all files from `common/` and `compressor/` directories are required. |
| 40 | In a similar way to build a separate zstd decompressor all files from `common/` and `decompressor/` directories are needed. |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 41 | |
| Yann Collet | dcc000f | 2016-03-10 01:09:41 +0100 | [diff] [blame] | 42 | |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 43 | #### Buffered streaming |
| 44 | |
| 45 | This complementary API makes streaming integration easier. |
| Yann Collet | dcc000f | 2016-03-10 01:09:41 +0100 | [diff] [blame] | 46 | It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) : |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 47 | |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 48 | - common/zbuff.h |
| 49 | - common/zbuff_static.h |
| 50 | - compress/zbuff_compress.c |
| 51 | - decompress/zbuff_decompress.c |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 52 | |
| 53 | #### Dictionary builder |
| 54 | |
| 55 | To create dictionaries from training sets : |
| 56 | |
| inikep | 4979431 | 2016-04-25 11:31:28 +0200 | [diff] [blame] | 57 | - dictBuilder/divsufsort.c |
| 58 | - dictBuilder/divsufsort.h |
| 59 | - dictBuilder/zdict.c |
| 60 | - dictBuilder/zdict.h |
| 61 | - dictBuilder/zdict_static.h |
| Yann Collet | d56a419 | 2016-02-17 17:47:29 +0100 | [diff] [blame] | 62 | |
| 63 | #### Miscellaneous |
| 64 | |
| 65 | The other files are not source code. There are : |
| 66 | |
| 67 | - LICENSE : contains the BSD license text |
| 68 | - Makefile : script to compile or install zstd library (static or dynamic) |
| 69 | - libzstd.pc.in : for pkg-config (make install) |
| 70 | |