extlz4 0.2.5 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc2c22224769c26e8e6c7fe4eded483f7963203ddc87da1b834c4597d3e6e593
-  data.tar.gz: 615d87e1be068ecc93a1c262127d1ad28787a5d25ede531fb15cb1dda1c4a533
+  metadata.gz: 960dfd2d3d26080ed4115e4e5131c510a28f4415054deead1dc4f7563163d43e
+  data.tar.gz: c421de615b4ad2c71e4e4645f0ca94f3426aadc354350a0365ddd6912c472d10
 SHA512:
-  metadata.gz: db7354b91b1776a973eb323680509c30f0c9704a8ee61c00f88fa20bf020128a4bb5cd53e9393d8115fa54e10b137bbd43a570a830d75bbf9d7c5d4ef6e1148d
-  data.tar.gz: fc2e568642e6ffd47d8b941dff6edf54fca9a9cf19017e31808c0382c3e481d5714316db915a1cae3e15a2d04833e4bc8fdb5094e38ae122f069826f2d73a92d
+  metadata.gz: 70cde50167bc57e50a63148b9beb3e662007b5d50bfd902108d0de8cd28214a05620b3df7c52e71d01fc3ea73250b78103b93cc625dd9d7a62c3a042f63f85ad
+  data.tar.gz: df0df6e229d8ee0a5f1f1f4b229fc7558385ea0a8453dc242558946bb7c29ab8e1c84dbf46d745f07afa627456dd5d872e29287c3c63801ead1325088bd28fce

data/HISTORY.ja.md

@@ -1,4 +1,19 @@
-# extlz4-0.2.4.4 (平成30年1月14日 日曜日)
+# extlz4-0.3.1 (令和2年6月7日)
+
+  * lz4-1.9.2 に更新
+  * `extlz4.so` が `<extlz4-dir>/lib` へ置かれない環境に対応
+      * https://github.com/dearblue/ruby-extlz4/issues/2
+
+
+# extlz4-0.3 (平成31年4月)
+
+  * lz4-1.9.0 に更新
+  * `LZ4` モジュールをリファインメントとして利用できるように機能を追加
+      * `Object` および `String` クラスで `.to_lz4frame` `.unlz4frame` メソッドが利用できるようになりました。
+      * `String` クラスで `.to_lz4block` `.unlz4block` メソッドが利用できるようになりました。
+
+
+# extlz4-0.2.5 (平成30年1月14日 日曜日)
 
   * lz4 ライブラリを [1.8.1](https://github.com/lz4/lz4/releases/tag/v1.8.1) に更新
 

data/README.md

@@ -5,28 +5,28 @@
 
 LZ4 データストリームを圧縮・伸張できます。lz4-cli で扱うことが出来ます。
 
-``` shell:shell
+```shell:shell
 $ dmesg | ruby -r extlz4 -e 'LZ4.encode_file($stdin.binmode, $stdout.binmode)' | lz4c -d | more
 ```
 
 ほかの ruby 向けの lz4 バインディングライブラリとしては KOMIYA Atsushi さんによる [lz4-ruby (http://rubygems.org/gems/lz4-ruby)](http://rubygems.org/gems/lz4-ruby) があります。
 
 
-## SUMMARY (概要)
-
-  * package name: extlz4
-  * author: dearblue (mailto:dearblue@users.noreply.github.com)
-  * report issue to: <https://github.com/dearblue/ruby-extlz4/issues>
-  * how to install: `gem install extlz4`
-  * version: 0.2.5
-  * product quality: technical preview
-  * licensing: BSD-2-Clause License
-  * dependency gems: none
-  * dependency external c libraries: none
-  * bundled external c libraries:
-      * lz4-1.8.1 <https://github.com/lz4/lz4/tree/v1.8.1>
-        under [BSD 2-Clause license](https://github.com/lz4/lz4/tree/v1.8.1/LICENSE)
-        by [Yann Collet](https://github.com/Cyan4973)
+## FEATURES (機能)
+
+  * Generic LZ4 frame data process (for `.lz4` file format)
+      * Decode LZ4 Frame data : `LZ4.decode`
+      * Encode LZ4 Frame data : `LZ4.encode`
+  * Generic LZ4 frame data file process (for `.lz4` file format)
+      * Decode LZ4 Frame data file : `LZ4.decode_file`
+      * Encode LZ4 Frame data file : `LZ4.encode_file`
+  * LZ4 block data process
+      * Decode LZ4 block data : `LZ4.block_decode`
+      * Encode LZ4 block data : `LZ4.block_encode` (supporting high compression level)
+      * Streaming Decode LZ4 block data : `LZ4.block_stream_decode` and `LZ4::BlockDecoder#update`
+      * Streaming Encode LZ4 block data : `LZ4.block_stream_encode` and `LZ4::BlockEncoder#update` (supporting high compression level)
+
+See [Quick reference](QUICKREF.md) for more details.
 
 
 ## ATTENTIONS (注意事項)
@@ -59,31 +59,6 @@ extlz4-0.1.1 でその不具合の修正を行いました。
 修復できるのはあくまで extlz4-0.1 のこの不具合に起因するファイルのみとなります。
 
 
-## FEATURES (機能)
-
-  * Generic LZ4 frame data process
-      * Decode LZ4 Frame data : LZ4.decode
-      * Encode LZ4 Frame data : LZ4.encode
-  * Generic LZ4 frame data file process
-      * Decode LZ4 Frame data file : LZ4.decode\_file
-      * Encode LZ4 Frame data file : LZ4.encode\_file
-  * LZ4 block data process
-      * Decode LZ4 block data : LZ4.block\_decode
-      * Encode LZ4 block data : LZ4.block\_encode (supporting high compression level)
-      * Streaming Decode LZ4 block data : LZ4.block\_stream\_decode and LZ4::BlockDecoder#update
-      * Streaming Encode LZ4 block data : LZ4.block\_stream\_encode and LZ4::BlockEncoder#update (supporting high compression level)
-
-
-## ABOUT TAINT STATE AND SECURITY (汚染状態とセキュリティについて)
-
-extlz4 はオブジェクト間での汚染状態を一方向伝播します。
-
-オブジェクトの汚染伝播については『入力 -> 出力』となり、
-ストリーム処理の場合は『入力 -> 圧縮器・伸張器 -> 出力』というようになります。
-
-セキュリティレベルによる処理の拒否は行いません。
-
-
 ## EXAMPLES (用例)
 
 First, load extlz4. (最初に extlz4 を読み込んでください)
@@ -92,25 +67,25 @@ First, load extlz4. (最初に extlz4 を読み込んでください)
 require "extlz4"
 ```
 
-### Decoding (伸張処理)
+### One shot decoding from LZ4 Frame (LZ4 Frame 伸張処理)
 
 ``` ruby:ruby
 uncompressed_data_string = LZ4.decode(compressed_data_string)
 ```
 
-### Encoding (通常圧縮処理)
+### One shot encoding to LZ4 Frame (LZ4 Frame 通常圧縮処理)
 
 ``` ruby:ruby
 compressed_data_string = LZ4.encode(uncompressed_data_string)
 ```
 
-### High compression encoding (高圧縮処理)
+### One shot high compression encoding to LZ4 Frame (LZ4 Frame 高圧縮処理)
 
 ``` ruby:ruby
 compressed_data_string = LZ4.encode(uncompressed_data_string, 9)
 ```
 
-### Frame decoding
+### Stream decoding to LZ4 Frame
 
 ``` ruby:ruby
 File.open("sample.txt.lz4", "rb") do |file|
@@ -122,7 +97,7 @@ File.open("sample.txt.lz4", "rb") do |file|
 end
 ```
 
-### Frame encoding by high compression
+### Stream encoding by high compression to LZ4 Frame
 
 ``` ruby:ruby
 File.open("sample.txt.lz4", "wb") do |file|
@@ -133,7 +108,7 @@ File.open("sample.txt.lz4", "wb") do |file|
 end
 ```
 
-### Frame encoding without block
+### Stream encoding without block to LZ4 Frame
 
 ``` ruby:ruby
 file = File.open("sample.txt.lz4", "wb")
@@ -142,7 +117,7 @@ lz4 << "abcdefghijklmnopqrstuvwxyz\n"
 lz4.close  # VERY IMPORTANT!
 ```
 
-### Block data processing (fast compression encoding and decoding)
+### One shot block data processing to/from LZ4 Block (fast compression encoding and decoding)
 
 ``` ruby:ruby
 src = "abcdefg" * 100
@@ -151,7 +126,7 @@ data = LZ4.block_decode(lz4data)
 p src == data  # => true
 ```
 
-### Block data processing (high compression encoding and decoding)
+### One shot block data processing to/from LZ4 Block (high compression encoding and decoding)
 
 ``` ruby:ruby
 src = "abcdefg" * 100
@@ -161,7 +136,7 @@ data = LZ4.block_decode(lz4data)
 p src == data  # => true
 ```
 
-### Block data processing (high speed encoding)
+### One shot block data processing to/from LZ4 Block (high speed encoding)
 
 ``` ruby:ruby
 src = "abcdefg" * 100
@@ -169,7 +144,7 @@ level = -19 # transform to one's complement as acceleration
 lz4data = LZ4.block_encode(level, src)
 ```
 
-### Block stream data processing (high compression encoding and decoding)
+### Block stream data processing to/from LZ4 Block (high compression encoding and decoding)
 
 ``` ruby:ruby
 level = 8 # (OPTIONAL PARAMETER)
@@ -194,6 +169,11 @@ p src2 == data  # => true
 ```
 
 
+## Support `Ractor` with Ruby3
+
+Ruby3 で追加された `Ractor` に対応しています。
+
+
 ## BONUS (おまけ)
 
 コマンドラインプログラムとして ``extlz4`` が追加されます。
@@ -201,3 +181,21 @@ p src2 == data  # => true
 これは lz4 と同程度の機能を持ちます (車輪の再発明とも言う)。
 
 とはいえ、引数のとり方を変えてあり、gzip のような形で利用できます。
+
+
+## SPECIFICATION (仕様)
+
+  - package name: extlz4
+  - author: dearblue (mailto:dearblue@users.osdn.me)
+  - project page: <https://github.com/dearblue/ruby-extlz4>
+  - how to install: `gem install extlz4`
+  - version: 0.3.4
+  - product quality: technical preview
+  - licensing: [2 clause BSD License](LICENSE)
+  - dependency gems: none
+  - dependency external c libraries: none
+  - bundled external c libraries (git submodules):
+      - [lz4](https://github.com/lz4/lz4)
+        [version 1.9.3](https://github.com/lz4/lz4/tree/v1.9.3)
+        under [2 clause BSD license](https://github.com/lz4/lz4/blob/v1.9.3/LICENSE)
+        by [Yann Collet](https://github.com/Cyan4973)

data/Rakefile

@@ -35,6 +35,7 @@ GEMSTUB.executables.sort!
 PACKAGENAME = "#{GEMSTUB.name}-#{GEMSTUB.version}"
 GEMFILE = "#{PACKAGENAME}.gem"
 GEMSPEC = "#{PACKAGENAME}.gemspec"
+BUNDLER_GEMFILE = "Gemfile"
 
 GEMSTUB.files += DOC + EXT + EXTCONF + BIN + LIB + SPEC + TEST + EXAMPLE + RAKEFILE + EXTRA
 GEMSTUB.files.sort!
@@ -194,6 +195,9 @@ task "package-name" do
   puts PACKAGENAME
 end
 
+desc "generate Gemfile for bundler"
+task "gemfile" => BUNDLER_GEMFILE
+
 file GEMFILE => DOC + EXT + EXTCONF + BIN + LIB + SPEC + TEST + EXAMPLE + RAKEFILE + [GEMSPEC] do
   sh "gem build #{GEMSPEC}"
 end
@@ -210,3 +214,21 @@ end
 file GEMSPEC_TRYOUT => RAKEFILE do
   File.write(GEMSPEC_TRYOUT, GEMSTUB_TRYOUT.to_ruby, mode: "wb")
 end
+
+file BUNDLER_GEMFILE => RAKEFILE do
+  File.write(BUNDLER_GEMFILE, <<~GemfileSource, mode: "wb")
+    source "https://rubygems.org/"
+
+    group "default" do
+    #{GEMSTUB.runtime_dependencies.map { |e|
+      %(  gem #{e.name.inspect}, #{e.requirements_list.map { |ee| ee.inspect }.join(", ")})
+    }.join("\n")}
+    end
+
+    group "development", "test" do
+    #{GEMSTUB.development_dependencies.map { |e|
+      %(  gem #{e.name.inspect}, #{e.requirements_list.map { |ee| ee.inspect }.join(", ")})
+    }.join("\n")}
+    end
+  GemfileSource
+end

data/bin/extlz4

@@ -1,7 +1,7 @@
 #!ruby
 #vim: set fileencoding:utf-8
 
-# AUTHOR: dearblue <dearblue@users.noreply.github.com>
+# AUTHOR: dearblue <dearblue@users.osdn.me>
 # Only this program is usable as public domain software.
 
 require "extlz4"

data/contrib/lz4/LICENSE

@@ -8,4 +8,5 @@ and with presence of COPYING or LICENSE file in associated directories.
 This model is selected to emphasize that
 files in the `lib` directory are designed to be included into 3rd party applications,
 while all other files, in `programs`, `tests` or `examples`,
-receive more limited attention and support for such scenario.
+are intended to be used "as is", as part of their intended scenarios,
+with no intention to support 3rd party integration use cases.

data/contrib/lz4/Makefile.inc

@@ -0,0 +1,111 @@
+# ################################################################
+# LZ4 - Makefile common definitions
+# Copyright (C) Yann Collet 2020
+# All rights reserved.
+#
+# BSD license
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# You can contact the author at :
+#  - LZ4 source repository : https://github.com/lz4/lz4
+#  - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c
+# ################################################################
+
+UNAME ?= uname
+
+TARGET_OS ?= $(shell $(UNAME))
+ifeq ($(TARGET_OS),)
+  TARGET_OS ?= $(OS)
+endif
+
+ifneq (,$(filter Windows%,$(TARGET_OS)))
+LIBLZ4 = liblz4-$(LIBVER_MAJOR)
+LIBLZ4_EXP = liblz4.lib
+WINBASED   = yes
+else
+LIBLZ4_EXP = liblz4.dll.a
+  ifneq (,$(filter MINGW%,$(TARGET_OS)))
+LIBLZ4     = liblz4
+WINBASED   = yes
+  else
+    ifneq (,$(filter MSYS%,$(TARGET_OS)))
+LIBLZ4     = msys-lz4-$(LIBVER_MAJOR)
+WINBASED   = yes
+    else
+      ifneq (,$(filter CYGWIN%,$(TARGET_OS)))
+LIBLZ4     = cyglz4-$(LIBVER_MAJOR)
+WINBASED   = yes
+      else
+LIBLZ4     = liblz4.$(SHARED_EXT_VER)
+WINBASED   = no
+EXT        =
+      endif
+    endif
+  endif
+endif
+
+ifeq ($(WINBASED),yes)
+EXT        = .exe
+WINDRES    = windres
+endif
+
+#determine if dev/nul based on host environment
+ifneq (,$(filter MINGW% MSYS% CYGWIN%,$(shell $(UNAME))))
+VOID := /dev/null
+else
+  ifneq (,$(filter Windows%,$(OS)))
+VOID := nul
+  else
+VOID  := /dev/null
+  endif
+endif
+
+ifneq (,$(filter Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku MidnightBSD MINGW% CYGWIN% MSYS%,$(shell $(UNAME))))
+POSIX_ENV = Yes
+else
+POSIX_ENV = No
+endif
+
+# Avoid symlinks when targeting Windows or building on a Windows host
+ifeq ($(WINBASED),yes)
+LN_SF = cp -p
+else
+  ifneq (,$(filter MINGW% MSYS% CYGWIN%,$(shell $(UNAME))))
+LN_SF = cp -p
+  else
+    ifneq (,$(filter Windows%,$(OS)))
+LN_SF = cp -p
+    else
+LN_SF  = ln -sf
+    endif
+  endif
+endif
+
+ifneq (,$(filter $(shell $(UNAME)),SunOS))
+INSTALL ?= ginstall
+else
+INSTALL ?= install
+endif
+
+INSTALL_PROGRAM ?= $(INSTALL) -m 755
+INSTALL_DATA    ?= $(INSTALL) -m 644
+INSTALL_DIR     ?= $(INSTALL) -d -m 755

data/contrib/lz4/NEWS

@@ -1,3 +1,100 @@
+v1.9.4
+perf : faster decoding speed (~+20%) on aarch64 platforms
+perf : faster decoding speed (~+70%) for -BD4 setting in CLI
+api  : new function `LZ4_decompress_safe_partial_usingDict()` by @yawqi
+api  : lz4frame: ability to provide custom allocators at state creation
+api  : can skip checksum validation for improved decoding speed
+api  : new experimental unit `lz4file` for file i/o API, by @anjiahao1
+api  : new experimental function `LZ4F_uncompressedUpdate()`, by @alexmohr
+cli  : `--list` works on `stdin` input, by @Low-power
+cli  : `--no-crc` does not produce (compression) nor check (decompression) checksums
+cli  : fix: `--test` and `--list` produce an error code when parsing invalid input
+cli  : fix: support skippable frames when passed via `stdin`, reported by @davidmankin
+build: fix: Makefile respects CFLAGS directives passed via environment variable
+build: `LZ4_FREESTANDING`, new build macro for freestanding environments, by @t-mat
+build: `make` and `make test` are compatible with `-j` parallel run
+build: AS/400 compatibility, by @jonrumsey
+build: Solaris 10 compatibility, by @pekdon
+build: MSVC 2022 support, by @t-mat
+build: improved meson script, by @eli-schwartz
+doc  : Updated LZ4 block format, provide an "implementation notes" section
+
+v1.9.3
+perf: highly improved speed in kernel space, by @terrelln
+perf: faster speed with Visual Studio, thanks to @wolfpld and @remittor
+perf: improved dictionary compression speed, by @felixhandte
+perf: fixed LZ4_compress_HC_destSize() ratio, detected by @hsiangkao
+perf: reduced stack usage in high compression mode, by @Yanpas
+api : LZ4_decompress_safe_partial() supports unknown compressed size, requested by @jfkthame
+api : improved LZ4F_compressBound() with automatic flushing, by Christopher Harvie
+api : can (de)compress to/from NULL without UBs
+api : fix alignment test on 32-bit systems (state initialization)
+api : fix LZ4_saveDictHC() in corner case scenario, detected by @IgorKorkin
+cli : `-l` legacy format is now compatible with `-m` multiple files, by Filipe Calasans
+cli : benchmark mode supports dictionary, by @rkoradi
+cli : fix --fast with large argument, detected by @picoHz
+build: link to user-defined memory functions with LZ4_USER_MEMORY_FUNCTIONS, suggested by Yuriy Levchenko
+build: contrib/cmake_unofficial/ moved to build/cmake/
+build: visual/* moved to build/
+build: updated meson script, by @neheb
+build: tinycc support, by Anton Kochkov
+install: Haiku support, by Jerome Duval
+doc : updated LZ4 frame format, clarify EndMark
+
+v1.9.2
+fix : out-of-bound read in exceptional circumstances when using decompress_partial(), by @terrelln
+fix : slim opportunity for out-of-bound write with compress_fast() with a large enough input and when providing an output smaller than recommended (< LZ4_compressBound(inputSize)), by @terrelln
+fix : rare data corruption bug with LZ4_compress_destSize(), by @terrelln
+fix : data corruption bug when Streaming with an Attached Dict in HC Mode, by @felixhandte
+perf: enable LZ4_FAST_DEC_LOOP on aarch64/GCC by default, by @prekageo
+perf: improved lz4frame streaming API speed, by @dreambottle
+perf: speed up lz4hc on slow patterns when using external dictionary, by @terrelln
+api: better in-place decompression and compression support
+cli : --list supports multi-frames files, by @gstedman
+cli: --version outputs to stdout
+cli : add option --best as an alias of -12 , by @Low-power
+misc: Integration into oss-fuzz by @cmeister2, expanded list of scenarios by @terrelln
+
+v1.9.1
+fix : decompression functions were reading a few bytes beyond input size (introduced in v1.9.0, reported by @ppodolsky and @danlark1)
+api : fix : lz4frame initializers compatibility with c++, reported by @degski
+cli : added command --list, based on a patch by @gabrielstedman
+build: improved Windows build, by @JPeterMugaas
+build: AIX, by Norman Green
+
+v1.9.0
+perf: large decompression speed improvement on x86/x64 (up to +20%) by @djwatson
+api : changed : _destSize() compression variants are promoted to stable API
+api : new : LZ4_initStream(HC), replacing LZ4_resetStream(HC)
+api : changed : LZ4_resetStream(HC) as recommended reset function, for better performance on small data
+cli : support custom block sizes, by @blezsan
+build: source code can be amalgamated, by Bing Xu
+build: added meson build, by @lzutao
+build: new build macros : LZ4_DISTANCE_MAX, LZ4_FAST_DEC_LOOP
+install: MidnightBSD, by @laffer1
+install: msys2 on Windows 10, by @vtorri
+
+v1.8.3
+perf: minor decompression speed improvement (~+2%) with gcc
+fix : corruption in v1.8.2 at level 9 for files > 64KB under rare conditions (#560)
+cli : new command --fast, by @jennifermliu
+cli : fixed elapsed time, and added cpu load indicator (on -vv) (#555)
+api : LZ4_decompress_safe_partial() now decodes exactly the nb of bytes requested (feature request #566)
+build : added Haiku target, by @fbrosson, and MidnightBSD, by @laffer1
+doc : updated documentation regarding dictionary compression
+
+v1.8.2
+perf: *much* faster dictionary compression on small files, by @felixhandte
+perf: improved decompression speed and binary size, by Alexey Tourbin (@svpv)
+perf: slightly faster HC compression and decompression speed
+perf: very small compression ratio improvement
+fix : compression compatible with low memory addresses (< 0xFFFF)
+fix : decompression segfault when provided with NULL input, by @terrelln
+cli : new command --favor-decSpeed
+cli : benchmark mode more accurate for small inputs
+fullbench : can bench _destSize() variants, by @felixhandte
+doc : clarified block format parsing restrictions, by Alexey Tourbin (@svpv)
+
 v1.8.1
 perf : faster and stronger ultra modes (levels 10+)
 perf : slightly faster compression and decompression speed

data/contrib/lz4/README.md

@@ -2,74 +2,68 @@ LZ4 - Extremely fast compression
 ================================
 
 LZ4 is lossless compression algorithm,
-providing compression speed at 400 MB/s per core,
+providing compression speed > 500 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.
+which trades compression ratio for faster speed.
 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 is also compatible with [dictionary compression](https://github.com/facebook/zstd#the-case-for-small-data-compression),
+both at [API](https://github.com/lz4/lz4/blob/v1.8.3/lib/lz4frame.h#L481) and [CLI](https://github.com/lz4/lz4/blob/v1.8.3/programs/lz4.1.md#operation-modifiers) levels.
+It can ingest any input file as dictionary, though only the final 64KB are used.
+This capability can be combined with the [Zstandard Dictionary Builder](https://github.com/facebook/zstd/blob/v1.3.5/programs/zstd.1.md#dictionary-builder),
+in order to drastically improve compression performance on small files.
+
+
 LZ4 library is provided as open-source software using BSD 2-Clause license.
 
 
 |Branch      |Status   |
 |------------|---------|
-|master      | [![Build Status][travisMasterBadge]][travisLink] [![Build status][AppveyorMasterBadge]][AppveyorLink] [![coverity][coverBadge]][coverlink] |
 |dev         | [![Build Status][travisDevBadge]][travisLink]    [![Build status][AppveyorDevBadge]][AppveyorLink]                                         |
 
-[travisMasterBadge]: https://travis-ci.org/lz4/lz4.svg?branch=master "Continuous Integration test suite"
 [travisDevBadge]: https://travis-ci.org/lz4/lz4.svg?branch=dev "Continuous Integration test suite"
 [travisLink]: https://travis-ci.org/lz4/lz4
-[AppveyorMasterBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=master&svg=true "Windows test suite"
 [AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=dev&svg=true "Windows test suite"
 [AppveyorLink]: https://ci.appveyor.com/project/YannCollet/lz4-1lndh
-[coverBadge]: https://scan.coverity.com/projects/4735/badge.svg "Static code analysis of Master branch"
-[coverlink]: https://scan.coverity.com/projects/4735
 
-> **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 [lzbench], from @inikep
-compiled with GCC v6.2.0 on Linux 64-bits.
-The reference system uses a Core i7-3930K CPU @ 4.5GHz.
+compiled with GCC v8.2.0 on Linux 64-bits (Ubuntu 4.18.0-17).
+The reference system uses a Core i7-9700K CPU @ 4.9GHz (w/ turbo boost).
 Benchmark evaluates the compression of reference [Silesia Corpus]
 in single-thread mode.
 
 [lzbench]: https://github.com/inikep/lzbench
 [Silesia Corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
 
-|  Compressor            | Ratio   | Compression | Decompression |
-|  ----------            | -----   | ----------- | ------------- |
-|  memcpy                |  1.000  | 7300 MB/s   |   7300 MB/s   |
-|**LZ4 fast 8  (v1.7.3)**|  1.799  |**911 MB/s** | **3360 MB/s** |
-|**LZ4 default (v1.7.3)**|**2.101**|**625 MB/s** | **3220 MB/s** |
-|  LZO 2.09              |  2.108  |  620 MB/s   |    845 MB/s   |
-|  QuickLZ 1.5.0         |  2.238  |  510 MB/s   |    600 MB/s   |
-|  Snappy 1.1.3          |  2.091  |  450 MB/s   |   1550 MB/s   |
-|  LZF v3.6              |  2.073  |  365 MB/s   |    820 MB/s   |
-|  [Zstandard] 1.1.1 -1  |  2.876  |  330 MB/s   |    930 MB/s   |
-|  [Zstandard] 1.1.1 -3  |  3.164  |  200 MB/s   |    810 MB/s   |
-| [zlib] deflate 1.2.8 -1|  2.730  |  100 MB/s   |    370 MB/s   |
-|**LZ4 HC -9 (v1.7.3)**  |**2.720**|   34 MB/s   | **3240 MB/s** |
-| [zlib] deflate 1.2.8 -6|  3.099  |   33 MB/s   |    390 MB/s   |
+|  Compressor             | Ratio   | Compression | Decompression |
+|  ----------             | -----   | ----------- | ------------- |
+|  memcpy                 |  1.000  | 13700 MB/s  |  13700 MB/s   |
+|**LZ4 default (v1.9.0)** |**2.101**| **780 MB/s**| **4970 MB/s** |
+|  LZO 2.09               |  2.108  |   670 MB/s  |    860 MB/s   |
+|  QuickLZ 1.5.0          |  2.238  |   575 MB/s  |    780 MB/s   |
+|  Snappy 1.1.4           |  2.091  |   565 MB/s  |   1950 MB/s   |
+| [Zstandard] 1.4.0 -1    |  2.883  |   515 MB/s  |   1380 MB/s   |
+|  LZF v3.6               |  2.073  |   415 MB/s  |    910 MB/s   |
+| [zlib] deflate 1.2.11 -1|  2.730  |   100 MB/s  |    415 MB/s   |
+|**LZ4 HC -9 (v1.9.0)**   |**2.721**|    41 MB/s  | **4900 MB/s** |
+| [zlib] deflate 1.2.11 -6|  3.099  |    36 MB/s  |    445 MB/s   |
 
 [zlib]: http://www.zlib.net/
 [Zstandard]: http://www.zstd.net/
 
-LZ4 is also compatible and well optimized for x32 mode, for which it provides an additional +10% speed performance.
+LZ4 is also compatible and optimized for x32 mode,
+for which it provides additional speed performance.
 
 
 Installation
@@ -77,7 +71,7 @@ Installation
 
 ```
 make
-make install     # this command may require root access
+make install     # this command may require root permissions
 ```
 
 LZ4's `Makefile` supports standard [Makefile conventions],
@@ -89,16 +83,27 @@ It is compatible with parallel builds (`-j#`).
 [redirection]: https://www.gnu.org/prep/standards/html_node/Directory-Variables.html
 [command redefinition]: https://www.gnu.org/prep/standards/html_node/Utilities-in-Makefiles.html
 
+### Building LZ4 - Using vcpkg
+
+You can download and install LZ4 using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
+
+    git clone https://github.com/Microsoft/vcpkg.git
+    cd vcpkg
+    ./bootstrap-vcpkg.sh
+    ./vcpkg integrate install
+    vcpkg install lz4
+
+The LZ4 port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
 
 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.
+Arbitrarily long files or data streams are compressed using multiple blocks,
+for streaming requirements. These blocks are organized into a frame,
+defined into [lz4_Frame_format].
+Interoperable versions of LZ4 must also respect the frame format.
 
 [lz4_Block_format]: doc/lz4_Block_format.md
 [lz4_Frame_format]: doc/lz4_Frame_format.md