blob: 75043cb0a729449b2ad534ca36e4d2572cfd9d17 [file] [log] [blame]
Yann Collet51208832019-12-03 17:06:42 -08001v1.4.5
2perf: Improved decompression speed, +10% on clang, +5% on gcc, by @terrelln
3cli: new command : provide list of files to de/compress within a file with --filelist=FILE, by @AhmedAbdellah19
4api: low latency blocks, new experimental parameter by @ephiepark
5build: mingw cross-compilation from unix, by @Ericson2314
6misc: bitflip analyzer tool, by @felixhandte
7
Yann Colletfaddd2a2019-10-28 12:57:05 -07008v1.4.4
9perf: Improved decompression speed, by > 10%, by @terrelln
10perf: Better compression speed when re-using a context, by @felixhandte
11perf: Fix compression ratio when compressing large files with small dictionary, by @senhuang42
12perf: zstd reference encoder can generate RLE blocks, by @bimbashrestha
13perf: minor generic speed optimization, by @davidbolvansky
14api: new ability to extract sequences from the parser for analysis, by @bimbashrestha
15api: fixed decoding of magic-less frames, by @terrelln
16api: fixed ZSTD_initCStream_advanced() performance with fast modes, reported by @QrczakMK
17cli: Named pipes support, by @bimbashrestha
18cli: short tar's extension support, by @stokito
19cli: command --output-dir-flat= , generates target files into requested directory, by @senhuang42
20cli: commands --stream-size=# and --size-hint=#, by @nmagerko
Yann Colletae3d35d2019-10-30 12:16:45 -070021cli: command --exclude-compressed, by @shashank0791
Yann Colletfaddd2a2019-10-28 12:57:05 -070022cli: faster `-t` test mode
23cli: improved some error messages, by @vangyzen
Yann Collet31192562020-01-07 09:51:22 -080024cli: fix command `-D dictionary` on Windows, reported by @artyompetrov
25cli: fix rare deadlock condition within dictionary builder, by @terrelln
Yann Colletfaddd2a2019-10-28 12:57:05 -070026build: single-file decoder with emscripten compilation script, by @cwoffenden
27build: fixed zlibWrapper compilation on Visual Studio, reported by @bluenlive
28build: fixed deprecation warning for certain gcc version, reported by @jasonma163
29build: fix compilation on old gcc versions, by @cemeyer
30build: improved installation directories for cmake script, by Dmitri Shubin
31pack: modified pkgconfig, for better integration into openwrt, requested by @neheb
32misc: Improved documentation : ZSTD_CLEVEL, DYNAMIC_BMI2, ZSTD_CDict, function deprecation, zstd format
33misc: fixed educational decoder : accept larger literals section, and removed UNALIGNED() macro
34
W. Felix Handte6b689802019-08-06 13:44:05 -040035v1.4.3
36bug: Fix Dictionary Compression Ratio Regression by @cyan4973 (#1709)
Yann Colletfaddd2a2019-10-28 12:57:05 -070037bug: Fix Buffer Overflow in legacy v0.3 decompression by @felixhandte (#1722)
W. Felix Handte6b689802019-08-06 13:44:05 -040038build: Add support for IAR C/C++ Compiler for Arm by @joseph0918 (#1705)
W. Felix Handte6b689802019-08-06 13:44:05 -040039
W. Felix Handte25824cc2019-07-24 17:35:52 -040040v1.4.2
41bug: Fix bug in zstd-0.5 decoder by @terrelln (#1696)
42bug: Fix seekable decompression in-memory API by @iburinoc (#1695)
43misc: Validate blocks are smaller than size limit by @vivekmg (#1685)
44misc: Restructure source files by @ephiepark (#1679)
45
W. Felix Handte62a0dc52019-07-19 11:18:10 -040046v1.4.1
47bug: Fix data corruption in niche use cases by @terrelln (#1659)
48bug: Fuzz legacy modes, fix uncovered bugs by @terrelln (#1593, #1594, #1595)
49bug: Fix out of bounds read by @terrelln (#1590)
50perf: Improve decode speed by ~7% @mgrice (#1668)
51perf: Slightly improved compression ratio of level 3 and 4 (ZSTD_dfast) by @cyan4973 (#1681)
52perf: Slightly faster compression speed when re-using a context by @cyan4973 (#1658)
53perf: Improve compression ratio for small windowLog by @cyan4973 (#1624)
54perf: Faster compression speed in high compression mode for repetitive data by @terrelln (#1635)
55api: Add parameter to generate smaller dictionaries by @tyler-tran (#1656)
56cli: Recognize symlinks when built in C99 mode by @felixhandte (#1640)
57cli: Expose cpu load indicator for each file on -vv mode by @ephiepark (#1631)
58cli: Restrict read permissions on destination files by @chungy (#1644)
59cli: zstdgrep: handle -f flag by @felixhandte (#1618)
60cli: zstdcat: follow symlinks by @vejnar (#1604)
61doc: Remove extra size limit on compressed blocks by @felixhandte (#1689)
62doc: Fix typo by @yk-tanigawa (#1633)
63doc: Improve documentation on streaming buffer sizes by @cyan4973 (#1629)
64build: CMake: support building with LZ4 @leeyoung624 (#1626)
65build: CMake: install zstdless and zstdgrep by @leeyoung624 (#1647)
66build: CMake: respect existing uninstall target by @j301scott (#1619)
67build: Make: skip multithread tests when built without support by @michaelforney (#1620)
68build: Make: Fix examples/ test target by @sjnam (#1603)
69build: Meson: rename options out of deprecated namespace by @lzutao (#1665)
70build: Meson: fix build by @lzutao (#1602)
71build: Visual Studio: don't export symbols in static lib by @scharan (#1650)
72build: Visual Studio: fix linking by @absotively (#1639)
73build: Fix MinGW-W64 build by @myzhang1029 (#1600)
74misc: Expand decodecorpus coverage by @ephiepark (#1664)
75
Nick Terrellbef61222019-04-15 13:57:42 -070076v1.4.0
77perf: Improve level 1 compression speed in most scenarios by 6% by @gbtucker and @terrelln
78api: Move the advanced API, including all functions in the staging section, to the stable section
79api: Make ZSTD_e_flush and ZSTD_e_end block for maximum forward progress
80api: Rename ZSTD_CCtxParam_getParameter to ZSTD_CCtxParams_getParameter
81api: Rename ZSTD_CCtxParam_setParameter to ZSTD_CCtxParams_setParameter
82api: Don't export ZSTDMT functions from the shared library by default
Nick Terrellde0499f2019-04-15 22:49:44 -070083api: Require ZSTD_MULTITHREAD to be defined to use ZSTDMT
Nick Terrellbef61222019-04-15 13:57:42 -070084api: Add ZSTD_decompressBound() to provide an upper bound on decompressed size by @shakeelrao
85api: Fix ZSTD_decompressDCtx() corner cases with a dictionary
86api: Move ZSTD_getDictID_*() functions to the stable section
87api: Add ZSTD_c_literalCompressionMode flag to enable or disable literal compression by @terrelln
88api: Allow compression parameters to be set when a dictionary is used
89api: Allow setting parameters before or after ZSTD_CCtx_loadDictionary() is called
90api: Fix ZSTD_estimateCStreamSize_usingCCtxParams()
91api: Setting ZSTD_d_maxWindowLog to 0 means use the default
92cli: Ensure that a dictionary is not used to compress itself by @shakeelrao
93cli: Add --[no-]compress-literals flag to enable or disable literal compression
94doc: Update the examples to use the advanced API
95doc: Explain how to transition from old streaming functions to the advanced API in the header
96build: Improve the Windows release packages
97build: Improve CMake build by @hjmjohnson
98build: Build fixes for FreeBSD by @lwhsu
99build: Remove redundant warnings by @thatsafunnyname
100build: Fix tests on OpenBSD by @bket
101build: Extend fuzzer build system to work with the new clang engine
102build: CMake now creates the libzstd.so.1 symlink
103build: Improve Menson build by @lzutao
104misc: Fix symbolic link detection on FreeBSD
105misc: Use physical core count for -T0 on FreeBSD by @cemeyer
106misc: Fix zstd --list on truncated files by @kostmo
107misc: Improve logging in debug mode by @felixhandte
108misc: Add CirrusCI tests by @lwhsu
109misc: Optimize dictionary memory usage in corner cases
110misc: Improve the dictionary builder on small or homogeneous data
111misc: Fix spelling across the repo by @jsoref
Nick Terrell2e8c19f2019-02-20 10:46:14 -0800112
Yann Collet092c4ab2018-11-13 15:53:38 -0800113v1.3.8
114perf: better decompression speed on large files (+7%) and cold dictionaries (+15%)
Yann Collet0d212dd2018-12-22 12:10:29 -0800115perf: slightly better compression ratio at high compression modes
116api : finalized advanced API, last stage before "stable" status
117api : new --rsyncable mode, by @terrelln
118api : support decompression of empty frames into NULL (used to be an error) (#1385)
119build: new set of macros to build a minimal size decoder, by @felixhandte
120build: fix compilation on MIPS32, reported by @clbr (#1441)
121build: fix compilation with multiple -arch flags, by @ryandesign
122build: highly upgraded meson build, by @lzutao
123build: improved buck support, by @obelisk
124build: fix cmake script : can create debug build, by @pitrou
125build: Makefile : grep works on both colored consoles and systems without color support
Yann Collet092c4ab2018-11-13 15:53:38 -0800126build: fixed zstd-pgo, by @bmwiedemann
Yann Collet0d212dd2018-12-22 12:10:29 -0800127cli : support ZSTD_CLEVEL environment variable, by @yijinfb (#1423)
128cli : --no-progress flag, preserving final summary (#1371), by @terrelln
129cli : ensure destination file is not source file (#1422)
130cli : clearer error messages, especially when input file not present
Yann Collet092c4ab2018-11-13 15:53:38 -0800131doc : clarified zstd_compression_format.md, by @ulikunitz
Yann Collet0d212dd2018-12-22 12:10:29 -0800132misc: fixed zstdgrep, returns 1 on failure, by @lzutao
133misc: NEWS renamed as CHANGELOG, in accordance with fboss
Yann Collet092c4ab2018-11-13 15:53:38 -0800134
Yann Colleta2708de2018-10-11 16:49:55 -0700135v1.3.7
136perf: slightly better decompression speed on clang (depending on hardware target)
137fix : performance of dictionary compression for small input < 4 KB at levels 9 and 10
138build: no longer build backtrace by default in release mode; restrict further automatic mode
139build: control backtrace support through build macro BACKTRACE
Yann Collet21cd8a92018-10-16 20:58:52 -0700140misc: added man pages for zstdless and zstdgrep, by @samrussell
Yann Colleta2708de2018-10-11 16:49:55 -0700141
Yann Collet63a519d2018-09-11 17:23:44 -0700142v1.3.6
143perf: much faster dictionary builder, by @jenniferliu
Yann Collet8514bd82018-10-01 17:49:18 -0700144perf: faster dictionary compression on small data when using multiple contexts, by @felixhandte
145perf: faster dictionary decompression when using a very large number of dictionaries simultaneously
146cli : fix : does no longer overwrite destination when source does not exist (#1082)
147cli : new command --adapt, for automatic compression level adaptation
148api : fix : block api can be streamed with > 4 GB, reported by @catid
149api : reduced ZSTD_DDict size by 2 KB
150api : minimum negative compression level is defined, and can be queried using ZSTD_minCLevel().
Yann Collet11cd2ea2018-10-03 16:37:50 -0700151build: support Haiku target, by @korli
152build: Read Legacy format is limited to v0.5+ by default. Can be changed at compile time with macro ZSTD_LEGACY_SUPPORT.
Yann Collet8514bd82018-10-01 17:49:18 -0700153doc : zstd_compression_format.md updated to match wording in IETF RFC 8478
Yann Collet63a519d2018-09-11 17:23:44 -0700154misc: tests/paramgrill, a parameter optimizer, by @GeorgeLu97
155
Yann Collet24319972018-06-06 15:51:55 -0700156v1.3.5
157perf: much faster dictionary compression, by @felixhandte
158perf: small quality improvement for dictionary generation, by @terrelln
159perf: slightly improved high compression levels (notably level 19)
160mem : automatic memory release for long duration contexts
161cli : fix : overlapLog can be manually set
162cli : fix : decoding invalid lz4 frames
163api : fix : performance degradation for dictionary compression when using advanced API, by @terrelln
164api : change : clarify ZSTD_CCtx_reset() vs ZSTD_CCtx_resetParameters(), by @terrelln
165build: select custom libzstd scope through control macros, by @GeorgeLu97
166build: OpenBSD patch, by @bket
167build: make and make all are compatible with -j
168doc : clarify zstd_compression_format.md, updated for IETF RFC process
169misc: pzstd compatible with reproducible compilation, by @lamby
170
Yann Collet8c6dbf42018-03-09 16:22:34 -0800171v1.3.4
Yann Colleteba13db2018-03-26 10:21:49 -0700172perf: faster speed (especially decoding speed) on recent cpus (haswell+)
173perf: much better performance associating --long with multi-threading, by @terrelln
174perf: better compression at levels 13-15
175cli : asynchronous compression by default, for faster experience (use --single-thread for former behavior)
176cli : smoother status report in multi-threading mode
177cli : added command --fast=#, for faster compression modes
Yann Collet8c6dbf42018-03-09 16:22:34 -0800178cli : fix crash when not overwriting existing files, by Pádraig Brady (@pixelb)
179api : `nbThreads` becomes `nbWorkers` : 1 triggers asynchronous mode
Yann Colleteba13db2018-03-26 10:21:49 -0700180api : compression levels can be negative, for even more speed
Yann Collet8c6dbf42018-03-09 16:22:34 -0800181api : ZSTD_getFrameProgression() : get precise progress status of ZSTDMT anytime
182api : ZSTDMT can accept new compression parameters during compression
Yann Colleteba13db2018-03-26 10:21:49 -0700183api : implemented all advanced dictionary decompression prototypes
Yann Collet8c6dbf42018-03-09 16:22:34 -0800184build: improved meson recipe, by Shawn Landden (@shawnl)
Yann Colleteba13db2018-03-26 10:21:49 -0700185build: VS2017 scripts, by @HaydnTrigg
186misc: all /contrib projects fixed
187misc: added /contrib/docker script by @gyscos
Yann Collet8c6dbf42018-03-09 16:22:34 -0800188
Yann Collet2cff66b2017-12-14 16:11:20 -0800189v1.3.3
Yann Collet8c6dbf42018-03-09 16:22:34 -0800190perf: faster zstd_opt strategy (levels 16-19)
Yann Collet2cff66b2017-12-14 16:11:20 -0800191fix : bug #944 : multithreading with shared ditionary and large data, reported by @gsliepen
192cli : fix : content size written in header by default
193cli : fix : improved LZ4 format support, by @felixhandte
194cli : new : hidden command `-S`, to benchmark multiple files while generating one result per file
195api : fix : support large skippable frames, by @terrelln
196api : fix : streaming interface was adding a useless 3-bytes null block to small frames
197api : change : when setting `pledgedSrcSize`, use `ZSTD_CONTENTSIZE_UNKNOWN` macro value to mean "unknown"
198build: fix : compilation under rhel6 and centos6, reported by @pixelb
199build: added `check` target
200
Yann Collet90238982017-08-30 17:44:12 -0700201v1.3.2
Yann Collet92889702017-09-18 13:41:54 -0700202new : long range mode, using --long command, by Stella Lau (@stellamplau)
Yann Collet7e00df42017-10-02 16:27:25 -0700203new : ability to generate and decode magicless frames (#591)
204changed : maximum nb of threads reduced to 200, to avoid address space exhaustion in 32-bits mode
Yann Collet92889702017-09-18 13:41:54 -0700205fix : multi-threading compression works with custom allocators
Yann Colletf97c2db2017-09-21 16:07:29 -0700206fix : ZSTD_sizeof_CStream() was over-evaluating memory usage
207fix : a rare compression bug when compression generates very large distances and bunch of other conditions (only possible at --ultra -22)
Yann Collet92889702017-09-18 13:41:54 -0700208fix : 32-bits build can now decode large offsets (levels 21+)
Yann Collet7e00df42017-10-02 16:27:25 -0700209cli : added LZ4 frame support by default, by Felix Handte (@felixhandte)
210cli : improved --list output
Yann Collet92889702017-09-18 13:41:54 -0700211cli : new : can split input file for dictionary training, using command -B#
Yann Collet7e00df42017-10-02 16:27:25 -0700212cli : new : clean operation artefact on Ctrl-C interruption
Yann Collet92889702017-09-18 13:41:54 -0700213cli : fix : do not change /dev/null permissions when using command -t with root access, reported by @mike155 (#851)
Yann Collet7e00df42017-10-02 16:27:25 -0700214cli : fix : write file size in header in multiple-files mode
215api : added macro ZSTD_COMPRESSBOUND() for static allocation
216api : experimental : new advanced decompression API
217api : fix : sizeof_CCtx() used to over-estimate
Yann Collet0d6ecc72017-09-11 14:09:34 -0700218build: fix : no-multithread variant compiles without pool.c dependency, reported by Mitchell Blank Jr (@mitchblank) (#819)
Yann Collet90238982017-08-30 17:44:12 -0700219build: better compatibility with reproducible builds, by Bernhard M. Wiedemann (@bmwiedemann) (#818)
Yann Collet7e00df42017-10-02 16:27:25 -0700220example : added streaming_memory_usage
221license : changed /examples license to BSD + GPLv2
222license : fix a few header files to reflect new license (#825)
Yann Collet90238982017-08-30 17:44:12 -0700223
Yann Collet40156a42017-07-08 04:55:09 -0700224v1.3.1
Yann Collet4912fc22017-08-20 11:45:58 -0700225New license : BSD + GPLv2
226perf: substantially decreased memory usage in Multi-threading mode, thanks to reports by Tino Reichardt (@mcmilk)
Yann Collet6733c072017-07-13 15:34:44 -0700227perf: Multi-threading supports up to 256 threads. Cap at 256 when more are requested (#760)
Yann Colletc523c932017-08-18 15:57:53 -0700228cli : improved and fixed --list command, by @ib (#772)
Yann Collet4912fc22017-08-20 11:45:58 -0700229cli : command -vV to list supported formats, by @ib (#771)
230build : fixed binary variants, reported by @svenha (#788)
231build : fix Visual compilation for non x86/x64 targets, reported by Greg Slazinski (@GregSlazinski) (#718)
Yann Collet8ef666c2017-07-12 14:23:34 -0700232API exp : breaking change : ZSTD_getframeHeader() provides more information
Yann Collet2bd64402017-07-13 17:12:16 -0700233API exp : breaking change : pinned down values of error codes
Yann Collet4912fc22017-08-20 11:45:58 -0700234doc : fixed huffman example, by Ulrich Kunitz (@ulikunitz)
235new : contrib/adaptive-compression, I/O driven compression strength, by Paul Cruz (@paulcruz74)
236new : contrib/long_distance_matching, statistics by Stella Lau (@stellamplau)
237updated : contrib/linux-kernel, by Nick Terrell (@terrelln)
Yann Collet40156a42017-07-08 04:55:09 -0700238
Yann Collet257a7222017-06-02 17:35:11 -0700239v1.3.0
Yann Collet224e7a12017-06-21 15:58:36 -0700240cli : new : `--list` command, by Paul Cruz
Yann Colletacbef3d2017-06-29 05:18:09 -0700241cli : changed : xz/lzma support enabled by default
Yann Collet224e7a12017-06-21 15:58:36 -0700242cli : changed : `-t *` continue processing list after a decompression error
Yann Collet01743a32017-06-16 17:56:41 -0700243API : added : ZSTD_versionString()
Yann Colletacbef3d2017-06-29 05:18:09 -0700244API : promoted to stable status : ZSTD_getFrameContentSize(), by Sean Purcell
Yann Collet86bd83e2017-06-02 17:43:55 -0700245API exp : new advanced API : ZSTD_compress_generic(), ZSTD_CCtx_setParameter()
246API exp : new : API for static or external allocation : ZSTD_initStatic?Ctx()
247API exp : added : ZSTD_decompressBegin_usingDDict(), requested by Guy Riddle (#700)
Yann Colletacbef3d2017-06-29 05:18:09 -0700248API exp : clarified memory estimation / measurement functions.
Yann Collet224e7a12017-06-21 15:58:36 -0700249API exp : changed : strongest strategy renamed ZSTD_btultra, fastest strategy ZSTD_fast set to 1
Yann Colletacbef3d2017-06-29 05:18:09 -0700250tools : decodecorpus can generate random dictionary-compressed samples, by Paul Cruz
Yann Collet257a7222017-06-02 17:35:11 -0700251new : contrib/seekable_format, demo and API, by Sean Purcell
252changed : contrib/linux-kernel, updated version and license, by Nick Terrell
253
Yann Collet8b669532017-04-27 12:50:20 -0700254v1.2.0
Yann Collet5a804452017-04-27 12:49:22 -0700255cli : changed : Multithreading enabled by default (use target zstd-nomt or HAVE_THREAD=0 to disable)
256cli : new : command -T0 means "detect and use nb of cores", by Sean Purcell
257cli : new : zstdmt symlink hardwired to `zstd -T0`
Yann Collet7bd68e12017-04-28 08:54:13 -0700258cli : new : command --threads=# (#671)
Yann Collet7aada3c2017-05-02 12:14:12 -0700259cli : changed : cover dictionary builder by default, for improved quality, by Nick Terrell
260cli : new : commands --train-cover and --train-legacy, to select dictionary algorithm and parameters
Yann Colletc08e5682017-05-03 14:32:33 -0700261cli : experimental targets `zstd4` and `xzstd4`, with support for lz4 format, by Sean Purcell
Yann Collet5a804452017-04-27 12:49:22 -0700262cli : fix : does not output compressed data on console
263cli : fix : ignore symbolic links unless --force specified,
264API : breaking change : ZSTD_createCDict_advanced(), only use compressionParameters as argument
Yann Collet68a7d3d2017-04-28 12:46:48 -0700265API : added : prototypes ZSTD_*_usingCDict_advanced(), for direct control over frameParameters.
Yann Collet5a804452017-04-27 12:49:22 -0700266API : improved: ZSTDMT_compressCCtx() reduced memory usage
267API : fix : ZSTDMT_compressCCtx() now provides srcSize in header (#634)
268API : fix : src size stored in frame header is controlled at end of frame
Yann Collet7aada3c2017-05-02 12:14:12 -0700269API : fix : enforced consistent rules for pledgedSrcSize==0 (#641)
270API : fix : error code "GENERIC" replaced by "dstSizeTooSmall" when appropriate
Yann Colletf3dfcdc2017-03-21 12:18:28 -0700271build: improved cmake script, by @Majlen
Yann Collet5a804452017-04-27 12:49:22 -0700272build: enabled Multi-threading support for *BSD, by Baptiste Daroussin
273tools: updated Paramgrill. Command -O# provides best parameters for sample and speed target.
274new : contrib/linux-kernel version, by Nick Terrell
Yann Colletf3dfcdc2017-03-21 12:18:28 -0700275
Yann Collet58af6142017-02-13 18:32:12 -0800276v1.1.4
Yann Colletc09d16b2017-02-14 10:45:19 -0800277cli : new : can compress in *.gz format, using --format=gzip command, by Przemyslaw Skibinski
278cli : new : advanced benchmark command --priority=rt
Yann Collet58af6142017-02-13 18:32:12 -0800279cli : fix : write on sparse-enabled file systems in 32-bits mode, by @ds77
Yann Colletdccd6b62017-02-27 15:57:50 -0800280cli : fix : --rm remains silent when input is stdin
Yann Collet7ae30392017-03-14 04:19:51 -0700281cli : experimental : xzstd, with support for xz/lzma decoding, by Przemyslaw Skibinski
Yann Collet43764cd2017-02-28 17:44:17 -0800282speed : improved decompression speed in streaming mode for single shot scenarios (+5%)
Yann Collet5a804452017-04-27 12:49:22 -0700283memory: DDict (decompression dictionary) memory usage down from 150 KB to 20 KB
284arch: 32-bits variant able to generate and decode very long matches (>32 MB), by Sean Purcell
Yann Collete02409f2017-03-02 17:14:57 -0800285API : new : ZSTD_findFrameCompressedSize(), ZSTD_getFrameContentSize(), ZSTD_findDecompressedSize()
Yann Collet7ae30392017-03-14 04:19:51 -0700286API : changed : dropped support of legacy versions <= v0.3 (can be changed by modifying ZSTD_LEGACY_SUPPORT value)
Yann Collet5a804452017-04-27 12:49:22 -0700287build : new: meson build system in contrib/meson, by Dima Krasner
288build : improved cmake script, by @Majlen
289build : added -Wformat-security flag, as recommended by Padraig Brady
Yann Collet58af6142017-02-13 18:32:12 -0800290doc : new : educational decoder, by Sean Purcell
291
Yann Colletd46ecb52016-12-17 16:28:12 +0100292v1.1.3
Yann Collet5962e582017-02-05 18:09:35 -0800293cli : zstd can decompress .gz files (can be disabled with `make zstd-nogz` or `make HAVE_ZLIB=0`)
Yann Collet122b6aa2017-01-27 03:22:37 -0800294cli : new : experimental target `make zstdmt`, with multi-threading support
Yann Collet00ea51f2017-02-07 12:05:28 -0800295cli : new : improved dictionary builder "cover" (experimental), by Nick Terrell, based on prior work by Giuseppe Ottaviano.
Yann Colletd76d1a92016-12-22 20:18:43 +0100296cli : new : advanced commands for detailed parameters, by Przemyslaw Skibinski
Yann Colletaca113f2016-12-23 22:25:03 +0100297cli : fix zstdless on Mac OS-X, by Andrew Janke
Yann Collet122b6aa2017-01-27 03:22:37 -0800298cli : fix #232 "compress non-files"
Yann Collet8e44bd82017-01-17 13:15:25 -0800299dictBuilder : improved dictionary generation quality, thanks to Nick Terrell
Yann Collet122b6aa2017-01-27 03:22:37 -0800300API : new : lib/compress/ZSTDMT_compress.h multithreading API (experimental)
Yann Collet4e5eea62016-12-21 16:44:35 +0100301API : new : ZSTD_create?Dict_byReference(), requested by Bartosz Taudul
Yann Colletd76d1a92016-12-22 20:18:43 +0100302API : new : ZDICT_finalizeDictionary()
Yann Collet122b6aa2017-01-27 03:22:37 -0800303API : fix : ZSTD_initCStream_usingCDict() properly writes dictID into frame header, by Gregory Szorc (#511)
304API : fix : all symbols properly exposed in libzstd, by Nick Terrell
305build : support for Solaris target, by Przemyslaw Skibinski
Yann Collet816edeb2017-02-06 17:39:54 -0800306doc : clarified specification, by Sean Purcell
Yann Colletd46ecb52016-12-17 16:28:12 +0100307
Yann Collet0018ca22016-11-07 14:41:21 -0800308v1.1.2
Yann Colletb23420f2016-12-13 19:47:17 +0100309API : streaming : decompression : changed : automatic implicit reset when chain-decoding new frames without init
310API : experimental : added : dictID retrieval functions, and ZSTD_initCStream_srcSize()
Yann Collet08698532016-12-13 11:45:19 +0100311API : zbuff : changed : prototypes now generate deprecation warnings
312lib : improved : faster decompression speed at ultra compression settings and 32-bits mode
313lib : changed : only public ZSTD_ symbols are now exposed
314lib : changed : reduced usage of stack memory
315lib : fixed : several corner case bugs, by Nick Terrell
Yann Collet743b33f2016-12-02 15:18:57 -0800316cli : new : gzstd, experimental version able to decode .gz files, by Przemyslaw Skibinski
317cli : new : preserve file attributes
Yann Collet9ffbeea2016-12-02 18:37:38 -0800318cli : new : added zstdless and zstdgrep tools
Yann Collet22383122016-12-02 11:36:11 -0800319cli : fixed : status displays total amount decoded, even for file consisting of multiple frames (like pzstd)
Yann Collet743b33f2016-12-02 15:18:57 -0800320cli : fixed : zstdcat
Yann Collete7a41a52016-12-05 16:21:06 -0800321zlib_wrapper : added support for gz* functions, by Przemyslaw Skibinski
Yann Collet08698532016-12-13 11:45:19 +0100322install : better compatibility with FreeBSD, by Dimitry Andric
323source tree : changed : zbuff source files moved to lib/deprecated
Yann Collet0018ca22016-11-07 14:41:21 -0800324
Yann Collete405c7a2016-10-12 15:29:22 -0700325v1.1.1
Yann Collet2b361cf2016-10-14 16:03:34 -0700326New : command -M#, --memory=, --memlimit=, --memlimit-decompress= to limit allowed memory consumption
Yann Collet37d13002016-10-24 17:22:12 -0700327New : doc/zstd_manual.html, by Przemyslaw Skibinski
Yann Collet95162342016-10-25 16:19:52 -0700328Improved : slightly better compression ratio at --ultra levels (>= 20)
Yann Collet4c0b44f2016-11-01 11:13:22 -0700329Improved : better memory usage when using streaming compression API, thanks to @Rogier-5 report
330Added : API : ZSTD_initCStream_usingCDict(), ZSTD_initDStream_usingDDict() (experimental section)
331Added : example/multiple_streaming_compression.c
332Changed : zstd_errors.h is now installed within /include (and replaces errors_public.h)
Yann Collet22de81e2016-10-28 13:58:31 -0700333Updated man page
Yann Collet37d13002016-10-24 17:22:12 -0700334Fixed : zstd-small, zstd-compress and zstd-decompress compilation targets
Yann Collete405c7a2016-10-12 15:29:22 -0700335
Yann Collet1eb2fdc2016-09-18 12:21:47 +0200336v1.1.0
Yann Collet1563bfe2016-09-02 11:44:21 -0700337New : contrib/pzstd, parallel version of zstd, by Nick Terrell
Yann Colleta4c212c2016-09-05 08:06:33 -0700338added : NetBSD install target (#338)
Yann Collet83543a72016-09-28 00:15:03 +0200339Improved : speed for batches of small files
340Improved : speed of zlib wrapper, by Przemyslaw Skibinski
341Changed : libzstd on Windows supports legacy formats, by Christophe Chevalier
Yann Collet7304eb72016-09-01 15:47:33 -0700342Fixed : CLI -d output to stdout by default when input is stdin (#322)
Yann Collet60181e32016-09-01 17:12:26 -0700343Fixed : CLI correctly detects console on Mac OS-X
Yann Collet220c5672016-09-13 19:40:50 +0200344Fixed : CLI supports recursive mode `-r` on Mac OS-X
345Fixed : Legacy decoders use unified error codes, reported by benrg (#341), fixed by Przemyslaw Skibinski
Yann Collet855766d2016-09-02 17:04:49 -0700346Fixed : compatibility with OpenBSD, reported by Juan Francisco Cantero Hurtado (#319)
Yann Collet30d30562016-09-13 17:23:31 +0200347Fixed : compatibility with Hurd, by Przemyslaw Skibinski (#365)
Yann Collet1563bfe2016-09-02 11:44:21 -0700348Fixed : zstd-pgo, reported by octoploid (#329)
Yann Collet7304eb72016-09-01 15:47:33 -0700349
Yann Collet0588ee62016-08-31 09:05:22 -0700350v1.0.0
351Change Licensing, all project is now BSD, Copyright Facebook
Yann Collet8baf78a2016-08-20 03:47:49 +0200352Small decompression speed improvement
Yann Collet0588ee62016-08-31 09:05:22 -0700353API : Streaming API supports legacy format
Josh Sorefa880ca22019-04-12 14:18:11 -0400354API : ZDICT_getDictID(), ZSTD_sizeof_{CCtx, DCtx, CStream, DStream}(), ZSTD_setDStreamParameter()
Yann Collet0588ee62016-08-31 09:05:22 -0700355CLI supports legacy formats v0.4+
356Fixed : compression fails on certain huge files, reported by Jesse McGrew
Yann Collet94376ac2016-08-25 19:09:21 +0200357Enhanced documentation, by Przemyslaw Skibinski
Yann Collet8baf78a2016-08-20 03:47:49 +0200358
Yann Collet346efcc2016-08-02 14:26:00 +0200359v0.8.1
Yann Collet655393c2016-08-14 00:16:20 +0200360New streaming API
Yann Colletfe0590f2016-08-12 18:04:15 +0200361Changed : --ultra now enables levels beyond 19
Yann Collet346efcc2016-08-02 14:26:00 +0200362Changed : -i# now selects benchmark time in second
363Fixed : ZSTD_compress* can now compress > 4 GB in a single pass, reported by Nick Terrell
Yann Colletfe0590f2016-08-12 18:04:15 +0200364Fixed : speed regression on specific patterns (#272)
Yann Colletb3950ee2016-08-16 15:10:30 +0200365Fixed : support for Z_SYNC_FLUSH, by Dmitry Krot (#291)
Yann Collet79d9cdd2016-08-18 11:50:37 +0200366Fixed : ICC compilation, by Przemyslaw Skibinski
Yann Collet346efcc2016-08-02 14:26:00 +0200367
Yann Collet6fa05a22016-07-20 14:58:49 +0200368v0.8.0
Yann Colletdd25a272016-07-27 12:35:29 +0200369Improved : better speed on clang and gcc -O2, thanks to Eric Biggers
Yann Collet8f29e8e2016-07-31 02:43:17 +0200370New : Build on FreeBSD and DragonFly, thanks to JrMarino
Yann Collet62470b42016-07-28 15:29:08 +0200371Changed : modified API : ZSTD_compressEnd()
Yann Colletd5c5a772016-07-19 15:06:55 +0200372Fixed : legacy mode with ZSTD_HEAPMODE=0, by Christopher Bergqvist
Yann Collet24a3d902016-07-26 01:26:56 +0200373Fixed : premature end of frame when zero-sized raw block, reported by Eric Biggers
Yann Collet3ca75032016-08-01 02:26:20 +0200374Fixed : large dictionaries (> 384 KB), reported by Ilona Papava
Yann Collet6fa05a22016-07-20 14:58:49 +0200375Fixed : checksum correctly checked in single-pass mode
Yann Collet24a3d902016-07-26 01:26:56 +0200376Fixed : combined --test amd --rm, reported by Andreas M. Nilsson
Yann Collet85f39192016-07-17 20:42:21 +0200377Modified : minor compression level adaptations
Yann Collet6fa05a22016-07-20 14:58:49 +0200378Updated : compression format specification to v0.2.0
Yann Collet356e5e22016-07-18 03:14:58 +0200379changed : zstd.h moved to /lib directory
Yann Colletd54b2d22016-07-17 15:53:18 +0200380
Yann Colletef9999f2016-09-01 16:44:48 -0700381v0.7.5
382Transition version, supporting decoding of v0.8.x
383
Yann Collet5e80dd32016-07-13 17:38:39 +0200384v0.7.4
Yann Colletd5c5a772016-07-19 15:06:55 +0200385Added : homebrew for Mac, by Daniel Cade
Yann Collet3b8b5752016-07-16 20:04:47 +0200386Added : more examples
Yann Collet227cc392016-07-15 11:27:09 +0200387Fixed : segfault when using small dictionaries, reported by Felix Handte
Yann Collet3b8b5752016-07-16 20:04:47 +0200388Modified : default compression level for CLI is now 3
389Updated : specification, to v0.1.1
Yann Colletea2ecdc2016-07-14 22:43:12 +0200390
Yann Colletd916c902016-07-04 00:42:58 +0200391v0.7.3
Yann Colletd4e103a2016-07-08 19:18:30 +0200392New : compression format specification
Yann Collet19c27d22016-07-07 14:40:13 +0200393New : `--` separator, stating that all following arguments are file names. Suggested by Chip Turner.
394New : `ZSTD_getDecompressedSize()`
395New : OpenBSD target, by Juan Francisco Cantero Hurtado
396New : `examples` directory
Yann Colleta295b312016-07-06 13:13:12 +0200397fixed : dictBuilder using HC levels, reported by Bartosz Taudul
Yann Colletf246cf52016-07-06 20:30:52 +0200398fixed : legacy support from ZSTD_decompress_usingDDict(), reported by Felix Handte
Yann Colletd4e103a2016-07-08 19:18:30 +0200399fixed : multi-blocks decoding with intermediate uncompressed blocks, reported by Greg Slazinski
Yann Collet19c27d22016-07-07 14:40:13 +0200400modified : removed "mem.h" and "error_public.h" dependencies from "zstd.h" (experimental section)
401modified : legacy functions no longer need magic number
Yann Colletd916c902016-07-04 00:42:58 +0200402
Yann Collet529d9c72016-06-27 10:03:10 +0200403v0.7.2
Yann Collet00d44ab2016-07-04 01:29:47 +0200404fixed : ZSTD_decompressBlock() using multiple consecutive blocks. Reported by Greg Slazinski.
Yann Colletd96e8f22016-07-02 22:03:08 +0200405fixed : potential segfault on very large files (many gigabytes). Reported by Chip Turner.
406fixed : CLI displays system error message when destination file cannot be created (#231). Reported by Chip Turner.
Yann Collet529d9c72016-06-27 10:03:10 +0200407
Yann Colletc98f8e72016-06-20 16:31:24 +0200408v0.7.1
Yann Colletaa292262016-06-21 14:04:57 +0200409fixed : ZBUFF_compressEnd() called multiple times with too small `dst` buffer, reported by Christophe Chevalier
Yann Collet3755eb82016-06-22 13:15:53 +0200410fixed : dictBuilder fails if first sample is too small, reported by Руслан Ковалёв
Yann Colleta436a522016-06-20 23:34:04 +0200411fixed : corruption issue, reported by cj
412modified : checksum enabled by default in command line mode
Yann Colletc98f8e72016-06-20 16:31:24 +0200413
Yann Collete3f4e6c2016-05-31 10:12:04 +0200414v0.7.0
Yann Colletdd97e242016-05-30 14:05:44 +0200415New : Support for directory compression, using `-r`, thanks to Przemyslaw Skibinski
Yann Colletb09b12c2016-06-09 22:59:51 +0200416New : Command `--rm`, to remove source file after successful de/compression
Yann Collet662a5412016-06-08 11:11:02 +0200417New : Visual build scripts, by Christophe Chevalier
Yann Colletde95f962016-05-23 19:46:47 +0200418New : Support for Sparse File-systems (do not use space for zero-filled sectors)
Yann Collet0d311602016-06-04 00:09:02 +0200419New : Frame checksum support
Yann Collete3f4e6c2016-05-31 10:12:04 +0200420New : Support pass-through mode (when using `-df`)
Yann Collet4948f272016-06-16 15:38:51 +0200421API : more efficient Dictionary API : `ZSTD_compress_usingCDict()`, `ZSTD_decompress_usingDDict()`
422API : create dictionary files from custom content, by Giuseppe Ottaviano
423API : support for custom malloc/free functions
Yann Collete3f4e6c2016-05-31 10:12:04 +0200424New : controllable Dictionary ID
Yann Collet0d311602016-06-04 00:09:02 +0200425New : Support for skippable frames
Yann Colletde95f962016-05-23 19:46:47 +0200426
Yann Colletf6ca09b2016-05-09 04:44:45 +0200427v0.6.1
Yann Collete6aa23b2016-05-13 11:29:38 +0200428New : zlib wrapper API, thanks to Przemyslaw Skibinski
Yann Colletd9b3cca2016-05-13 12:43:36 +0200429New : Ability to compile compressor / decompressor separately
430Changed : new lib directory structure
Yann Colletf6ca09b2016-05-09 04:44:45 +0200431Fixed : Legacy codec v0.5 compatible with dictionary decompression
432Fixed : Decoder corruption error (#173)
Yann Collet918b9342016-05-10 07:00:07 +0200433Fixed : null-string roundtrip (#176)
Yann Collete6aa23b2016-05-13 11:29:38 +0200434New : benchmark mode can select directory as input
Yann Colletd9b3cca2016-05-13 12:43:36 +0200435Experimental : midipix support, VMS support
Yann Colletf6ca09b2016-05-09 04:44:45 +0200436
Yann Collet6cb41352016-03-15 15:47:38 +0100437v0.6.0
438Stronger high compression modes, thanks to Przemyslaw Skibinski
439API : ZSTD_getFrameParams() provides size of decompressed content
Yann Collet34b20ec2016-03-15 20:47:23 +0100440New : highest compression modes require `--ultra` command to fully unleash their capacity
Yann Colletfbc40b82016-03-16 16:53:47 +0100441Fixed : zstd cli return error code > 0 and removes dst file artifact when decompression fails, thanks to Chip Turner
Yann Collet6cb41352016-03-15 15:47:38 +0100442
Yann Collet0db41152016-02-10 14:50:22 +0100443v0.5.1
444New : Optimal parsing => Very high compression modes, thanks to Przemyslaw Skibinski
Yann Collet459a6b72016-02-15 20:37:23 +0100445Changed : Dictionary builder integrated into libzstd and zstd cli
Yann Collet4c64d512016-02-18 01:01:42 +0100446Changed (!) : zstd cli now uses "multiple input files" as default mode. See `zstd -h`.
Yann Collet459a6b72016-02-15 20:37:23 +0100447Fix : high compression modes for big-endian platforms
Yann Collet2d08b092016-02-16 14:42:08 +0100448New : zstd cli : `-t` | `--test` command
Yann Collet0db41152016-02-10 14:50:22 +0100449
Yann Colletfb810d62016-01-28 00:18:06 +0100450v0.5.0
Yann Collete618f8e2016-01-28 00:29:58 +0100451New : dictionary builder utility
Yann Colletfd416f12016-01-30 03:14:15 +0100452Changed : streaming & dictionary API
Yann Collet45ff4302016-02-05 15:24:57 +0100453Improved : better compression of small data
Yann Colletfb810d62016-01-28 00:18:06 +0100454
Yann Collet223f6332016-01-21 13:33:05 +0100455v0.4.7
456Improved : small compression speed improvement in HC mode
457Changed : `zstd_decompress.c` has ZSTD_LEGACY_SUPPORT to 0 by default
458fix : bt search bug
459
Yann Collet5f9f9872015-12-30 19:52:08 +0100460v0.4.6
461fix : fast compression mode on Windows
Yann Collet3e5b73b2016-01-10 20:46:20 +0100462New : cmake configuration file, thanks to Artyom Dymchenko
Yann Collet5f9f9872015-12-30 19:52:08 +0100463Improved : high compression mode on repetitive data
Yann Colletbf42c8e2016-01-09 01:08:23 +0100464New : block-level API
465New : ZSTD_duplicateCCtx()
Yann Collet5f9f9872015-12-30 19:52:08 +0100466
Yann Colletdeb078b2015-12-17 20:30:14 +0100467v0.4.5
468new : -m/--multiple : compress/decompress multiple files
469
Yann Collet7b7027f2015-12-10 23:53:21 +0100470v0.4.4
Yann Collet6c3e2e72015-12-11 10:44:07 +0100471Fixed : high compression modes for Windows 32 bits
Yann Colletf6f3d752015-12-13 13:35:21 +0100472new : external dictionary API extended to buffered mode and accessible through command line
Yann Collet7b7027f2015-12-10 23:53:21 +0100473new : windows DLL project, thanks to Christophe Chevalier
474
Yann Collet28e7cef2015-12-03 12:11:30 +0100475v0.4.3 :
Yann Collet417890c2015-12-04 17:16:37 +0100476new : external dictionary API
Yann Collet56005e72015-12-07 10:44:25 +0100477new : zstd-frugal
Yann Collet28e7cef2015-12-03 12:11:30 +0100478
Yann Colletaaf6f202015-12-02 15:03:11 +0100479v0.4.2 :
480Generic minor improvements for small blocks
481Fixed : big-endian compatibility, by Peter Harris (#85)
482
Yann Colleta85a8dd2015-11-30 11:53:11 +0100483v0.4.1
Yann Collet44287a32015-11-30 23:13:56 +0100484Fixed : ZSTD_LEGACY_SUPPORT=0 build mode (reported by Luben)
Yann Colletdaa1c652015-11-30 12:25:48 +0100485removed `zstd.c`
Yann Colleta85a8dd2015-11-30 11:53:11 +0100486
Yann Collet7f6e91f2015-11-11 14:39:50 +0100487v0.4.0
Yann Colletdd97e242016-05-30 14:05:44 +0200488Command line utility compatible with high compression levels
Yann Collet7f6e91f2015-11-11 14:39:50 +0100489Removed zstdhc => merged into zstd
Yann Collet88fcd292015-11-25 14:42:45 +0100490Added : ZBUFF API (see zstd_buffered.h)
Yann Collet5b78d2f2015-11-12 15:36:05 +0100491Rolling buffer support
Yann Collet7f6e91f2015-11-11 14:39:50 +0100492
Yann Collet43e0cd52015-11-09 16:38:17 +0100493v0.3.6
494small blocks params
495
Yann Colletf48e35c2015-11-07 01:13:31 +0100496v0.3.5
497minor generic compression improvements
498
Yann Colletf12c1302015-11-05 18:16:59 +0100499v0.3.4
Yann Colletacd222c2015-11-06 12:39:39 +0100500Faster fast cLevels
Yann Colletf12c1302015-11-05 18:16:59 +0100501
Yann Collet35644872015-11-02 16:14:46 +0100502v0.3.3
503Small compression ratio improvement
504
Yann Collet7671f392015-11-02 12:17:39 +0100505v0.3.2
506Fixed Visual Studio
507
Yann Collet66d22b82015-11-02 02:36:10 +0100508v0.3.1 :
509Small compression ratio improvement
510
Yann Colletc776c462015-10-29 19:10:54 +0100511v0.3
512HC mode : compression levels 2-26
513
Yann Collet1077bb82015-10-28 12:32:25 +0100514v0.2.2
515Fix : Visual Studio 2013 & 2015 release compilation, by Christophe Chevalier
516
Yann Collet81e49e62015-10-28 15:56:48 +0100517v0.2.1
Yann Colletdd97e242016-05-30 14:05:44 +0200518Fix : Read errors, advanced fuzzer tests, by Hanno Böck
Yann Collet1077bb82015-10-28 12:32:25 +0100519
Yann Colleta3befd32015-10-21 11:13:31 +0100520v0.2.0
521**Breaking format change**
522Faster decompression speed
523Can still decode v0.1 format
524
525v0.1.3
526fix uninitialization warning, reported by Evan Nemerson
527
Yann Collet5abd8202015-08-27 03:16:04 +0100528v0.1.2
Yann Colleta3befd32015-10-21 11:13:31 +0100529frame concatenation support
Yann Collet5abd8202015-08-27 03:16:04 +0100530
531v0.1.1
532fix compression bug
533detects write-flush errors
Yann Collet33a04652016-09-02 22:11:49 -0700534
Yann Collet5abd8202015-08-27 03:16:04 +0100535v0.1.0
536first release