lz5 to lizard

Author: inikep

.gitignore

@@ -23,15 +23,15 @@
 .clang_complete
 
 # Directories
-_lz5bench/
+_lizardbench/
 _visual/
 _codelite/
 _backup/
 _codelite_lz4/
 
 # Archives
 *.zip
-*.lz5
+*.liz
 
 *.txt
 *.bat

.travis.yml

@@ -4,12 +4,12 @@ matrix:
   include:
     # OS X Mavericks
     - os: osx
-      env: Ubu=OS_X_Mavericks Cmd='make -C tests test-lz5 CC=clang MOREFLAGS="-Werror -Wconversion -Wno-sign-conversion"' COMPILER=clang
+      env: Ubu=OS_X_Mavericks Cmd='make -C tests test-lizard CC=clang MOREFLAGS="-Werror -Wconversion -Wno-sign-conversion"' COMPILER=clang
 
     # Container-based 12.04 LTS Server Edition 64 bit (doesn't support 32-bit includes)
     - os: linux
       sudo: false
-      env: Ubu=12.04cont Cmd='make -C tests test-lz5 test-fullbench' COMPILER=cc
+      env: Ubu=12.04cont Cmd='make -C tests test-lizard test-fullbench' COMPILER=cc
 
     - os: linux
       sudo: false
@@ -21,7 +21,7 @@ matrix:
 
 
     # 14.04 LTS Server Edition 64 bit
-    - env: Ubu=14.04 Cmd='make -C tests test-lz5c32 test-fullbench32' COMPILER=cc
+    - env: Ubu=14.04 Cmd='make -C tests test-lizardc32 test-fullbench32' COMPILER=cc
       dist: trusty
       sudo: required
       addons:
@@ -79,7 +79,7 @@ matrix:
             - qemu-user-static
             - gcc-powerpc-linux-gnu
 
-    - env: Ubu=14.04 Cmd='make c_standards && make -C tests test-lz5' COMPILER=cc
+    - env: Ubu=14.04 Cmd='make c_standards && make -C tests test-lizard' COMPILER=cc
       dist: trusty
       sudo: required
 
@@ -91,7 +91,7 @@ matrix:
           packages:
             - valgrind
 
-    - env: Ubu=14.04 Cmd='make -C tests test-lz5 test-lz5c32 CC=gcc-5 MOREFLAGS=-Werror' COMPILER=gcc-5
+    - env: Ubu=14.04 Cmd='make -C tests test-lizard test-lizardc32 CC=gcc-5 MOREFLAGS=-Werror' COMPILER=gcc-5
       dist: trusty
       sudo: required
       addons:
@@ -104,7 +104,7 @@ matrix:
             - gcc-5
             - gcc-5-multilib
 
-    - env: Ubu=14.04 Cmd='make c_standards CC=gcc-6 && make -C tests test-lz5 CC=gcc-6 MOREFLAGS=-Werror' COMPILER=gcc-6
+    - env: Ubu=14.04 Cmd='make c_standards CC=gcc-6 && make -C tests test-lizard CC=gcc-6 MOREFLAGS=-Werror' COMPILER=gcc-6
       dist: trusty
       sudo: required
       addons:
@@ -114,7 +114,7 @@ matrix:
           packages:
             - gcc-6
 
-    - env: Ubu=14.04 Cmd='make -C tests test-lz5 CC=clang-3.8' COMPILER=clang-3.8
+    - env: Ubu=14.04 Cmd='make -C tests test-lizard CC=clang-3.8' COMPILER=clang-3.8
       dist: trusty
       sudo: required
       addons:

Makefile

@@ -28,7 +28,7 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 # You can contact the author at :
-#  - Lizard source repository : https://github.com/inikep/lz5
+#  - Lizard source repository : https://github.com/inikep/lizard
 # ################################################################
 
 DESTDIR ?=
@@ -48,25 +48,25 @@ EXT =
 endif
 
 
-.PHONY: default all lib lz5 clean test versionsTest examples
+.PHONY: default all lib lizard clean test versionsTest examples
 
-default: lz5
+default: lizard
 
-all: lib lz5
+all: lib lizard
 
 lib:
 	@$(MAKE) -C $(LIBDIR) all
 
-lz5:
+lizard:
 	@$(MAKE) -C $(PRGDIR)
-	@cp $(PRGDIR)/lz5$(EXT) .
+	@cp $(PRGDIR)/lizard$(EXT) .
 
 clean:
 	@$(MAKE) -C $(PRGDIR) $@ > $(VOID)
 	@$(MAKE) -C $(TESTDIR) $@ > $(VOID)
 	@$(MAKE) -C $(LIBDIR) $@ > $(VOID)
 	@$(MAKE) -C examples $@ > $(VOID)
-	@$(RM) lz5$(EXT)
+	@$(RM) lizard$(EXT)
 	@echo Cleaning completed
 
 
@@ -109,7 +109,7 @@ staticAnalyze: clean
 	CFLAGS=-g scan-build --status-bugs -v $(MAKE) all
 
 platformTest: clean
-	@echo "\n ---- test lz5 with $(CC) compiler ----"
+	@echo "\n ---- test lizard with $(CC) compiler ----"
 	@$(CC) -v
 	CFLAGS="-O3 -Werror"         $(MAKE) -C $(LIBDIR) all
 	CFLAGS="-O3 -Werror -static" $(MAKE) -C $(PRGDIR) native
@@ -121,7 +121,7 @@ versionsTest: clean
 
 examples:
 	$(MAKE) -C $(LIBDIR)
-	$(MAKE) -C $(PRGDIR) lz5
+	$(MAKE) -C $(PRGDIR) lizard
 	$(MAKE) -C examples test
 
 endif

NEWS

@@ -13,7 +13,7 @@ LZ5 v1.5
 - introduced compatibility with Visual C++ 2010 and newer
 - attached Visual Studio 2010 project
 - thoroughly tested with 21 Travis CI and 7 AppVeyor CI tests
-- fixed bug with reusing a context in lz5frame.c (LizardF_compressBegin and Lizard_compress_HC_continue)
+- fixed bug with reusing a context in lizardframe.c (LizardF_compressBegin and Lizard_compress_HC_continue)
 - fixed rare bug in match finder (concerns levels 4 - 15)
 
 LZ5 v1.4.1
@@ -22,8 +22,8 @@ LZ5 v1.4.1
 LZ5 v1.4
 - improved: levels from 13 to 15 (maximum compression ratio)
 - added a new parser: LizardHC_optimal_price_bt
-- updated documentation: lz5_Block_format.md and lz5_Frame_format.md 
-- changed lz5.exe: the "-B" option with block size [1-7] = 64KB, 256KB, 1MB, 4MB, 16MB, 64MB, 256MB (default : 4 = 4MB)
+- updated documentation: lizard_Block_format.md and lizard_Frame_format.md 
+- changed lizard.exe: the "-B" option with block size [1-7] = 64KB, 256KB, 1MB, 4MB, 16MB, 64MB, 256MB (default : 4 = 4MB)
 
 LZ5 v1.3.3
 - added: new levels from 11 to 18 (maximum compression ratio)

README.md

@@ -14,15 +14,15 @@ The high compression/decompression speed is achieved without any SSE and AVX ext
 
 |Branch      |Status   |
 |------------|---------|
-|lz5_v1.5    | [![Build Status][travis15Badge]][travisLink]    [![Build status][Appveyor15Badge]][AppveyorLink]     |
-|lz5_v2.0    | [![Build Status][travis20Badge]][travisLink]    [![Build status][Appveyor20Badge]][AppveyorLink]     |
+|lizard_v1.5    | [![Build Status][travis15Badge]][travisLink]    [![Build status][Appveyor15Badge]][AppveyorLink]     |
+|lizard_v2.0    | [![Build Status][travis20Badge]][travisLink]    [![Build status][Appveyor20Badge]][AppveyorLink]     |
 
-[travis15Badge]: https://travis-ci.org/inikep/lz5.svg?branch=lz5_v1.5 "Continuous Integration test suite"
-[travis20Badge]: https://travis-ci.org/inikep/lz5.svg?branch=lz5_v2.0 "Continuous Integration test suite"
-[travisLink]: https://travis-ci.org/inikep/lz5
-[Appveyor15Badge]: https://ci.appveyor.com/api/projects/status/o0ib75nwokjiui36/branch/lz5_v1.5?svg=true "Visual test suite"
-[Appveyor20Badge]: https://ci.appveyor.com/api/projects/status/o0ib75nwokjiui36/branch/lz5_v2.0?svg=true "Visual test suite"
-[AppveyorLink]: https://ci.appveyor.com/project/inikep/lz5
+[travis15Badge]: https://travis-ci.org/inikep/lizard.svg?branch=lizard_v1.5 "Continuous Integration test suite"
+[travis20Badge]: https://travis-ci.org/inikep/lizard.svg?branch=lizard_v2.0 "Continuous Integration test suite"
+[travisLink]: https://travis-ci.org/inikep/lizard
+[Appveyor15Badge]: https://ci.appveyor.com/api/projects/status/o0ib75nwokjiui36/branch/lizard_v1.5?svg=true "Visual test suite"
+[Appveyor20Badge]: https://ci.appveyor.com/api/projects/status/o0ib75nwokjiui36/branch/lizard_v2.0?svg=true "Visual test suite"
+[AppveyorLink]: https://ci.appveyor.com/project/inikep/lizard
 [LZ4]: https://github.com/lz4/lz4
 [zlib]: https://github.com/madler/zlib
 [zstd]: https://github.com/facebook/zstd
@@ -45,22 +45,22 @@ with [silesia.tar] which contains tarred files from [Silesia compression corpus]
 | lz4hc 1.7.3 -9          |    22 MB/s |  2315 MB/s |    77892285 | 36.75 |
 | lz4hc 1.7.3 -12         |    17 MB/s |  2323 MB/s |    77849762 | 36.73 |
 | lz4hc 1.7.3 -16         |    10 MB/s |  2323 MB/s |    77841782 | 36.73 |
-| lz5 2.0 -10             |   346 MB/s |  2610 MB/s |   103402971 | 48.79 |
-| lz5 2.0 -12             |   103 MB/s |  2458 MB/s |    86232422 | 40.69 |
-| lz5 2.0 -15             |    50 MB/s |  2552 MB/s |    81187330 | 38.31 |
-| lz5 2.0 -19             |  3.04 MB/s |  2497 MB/s |    77416400 | 36.53 |
-| lz5 2.0 -21             |   157 MB/s |  1795 MB/s |    89239174 | 42.10 |
-| lz5 2.0 -23             |    30 MB/s |  1778 MB/s |    81097176 | 38.26 |
-| lz5 2.0 -26             |  6.63 MB/s |  1734 MB/s |    74503695 | 35.15 |
-| lz5 2.0 -29             |  1.37 MB/s |  1634 MB/s |    68694227 | 32.41 |
-| lz5 2.0 -30             |   246 MB/s |   909 MB/s |    85727429 | 40.45 |
-| lz5 2.0 -32             |    94 MB/s |  1244 MB/s |    76929454 | 36.30 |
-| lz5 2.0 -35             |    47 MB/s |  1435 MB/s |    73850400 | 34.84 |
-| lz5 2.0 -39             |  2.94 MB/s |  1502 MB/s |    69807522 | 32.94 |
-| lz5 2.0 -41             |   126 MB/s |   961 MB/s |    76100661 | 35.91 |
-| lz5 2.0 -43             |    28 MB/s |  1101 MB/s |    70955653 | 33.48 |
-| lz5 2.0 -46             |  6.25 MB/s |  1073 MB/s |    65413061 | 30.86 |
-| lz5 2.0 -49             |  1.27 MB/s |  1064 MB/s |    60679215 | 28.63 |
+| lizard 2.0 -10             |   346 MB/s |  2610 MB/s |   103402971 | 48.79 |
+| lizard 2.0 -12             |   103 MB/s |  2458 MB/s |    86232422 | 40.69 |
+| lizard 2.0 -15             |    50 MB/s |  2552 MB/s |    81187330 | 38.31 |
+| lizard 2.0 -19             |  3.04 MB/s |  2497 MB/s |    77416400 | 36.53 |
+| lizard 2.0 -21             |   157 MB/s |  1795 MB/s |    89239174 | 42.10 |
+| lizard 2.0 -23             |    30 MB/s |  1778 MB/s |    81097176 | 38.26 |
+| lizard 2.0 -26             |  6.63 MB/s |  1734 MB/s |    74503695 | 35.15 |
+| lizard 2.0 -29             |  1.37 MB/s |  1634 MB/s |    68694227 | 32.41 |
+| lizard 2.0 -30             |   246 MB/s |   909 MB/s |    85727429 | 40.45 |
+| lizard 2.0 -32             |    94 MB/s |  1244 MB/s |    76929454 | 36.30 |
+| lizard 2.0 -35             |    47 MB/s |  1435 MB/s |    73850400 | 34.84 |
+| lizard 2.0 -39             |  2.94 MB/s |  1502 MB/s |    69807522 | 32.94 |
+| lizard 2.0 -41             |   126 MB/s |   961 MB/s |    76100661 | 35.91 |
+| lizard 2.0 -43             |    28 MB/s |  1101 MB/s |    70955653 | 33.48 |
+| lizard 2.0 -46             |  6.25 MB/s |  1073 MB/s |    65413061 | 30.86 |
+| lizard 2.0 -49             |  1.27 MB/s |  1064 MB/s |    60679215 | 28.63 |
 | zlib 1.2.8 -1           |    66 MB/s |   244 MB/s |    77259029 | 36.45 |
 | zlib 1.2.8 -6           |    20 MB/s |   263 MB/s |    68228431 | 32.19 |
 | zlib 1.2.8 -9           |  8.37 MB/s |   266 MB/s |    67644548 | 31.92 |
@@ -84,12 +84,12 @@ with [silesia.tar] which contains tarred files from [Silesia compression corpus]
 Documentation
 -------------------------
 
-The raw Lizard block compression format is detailed within [lz5_Block_format].
+The raw Lizard block compression format is detailed within [lizard_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 [lz5_Frame_format].
+is the purpose of the Frame format, defined into [lizard_Frame_format].
 Interoperable versions of Lizard must respect this frame format.
 
-[lz5_Block_format]: doc/lz5_Block_format.md
-[lz5_Frame_format]: doc/lz5_Frame_format.md
+[lizard_Block_format]: doc/lizard_Block_format.md
+[lizard_Frame_format]: doc/lizard_Frame_format.md

appveyor.yml

@@ -47,9 +47,9 @@ build_script:
       make -v &&
       echo ----- &&
       if not [%PLATFORM%]==[clang] (
-        make -C programs lz5 && make -C tests fullbench && make -C lib lib
+        make -C programs lizard && make -C tests fullbench && make -C lib lib
       ) ELSE (
-        make -C programs lz5 CC=clang MOREFLAGS="--target=x86_64-w64-mingw32 -Werror -Wconversion -Wno-sign-conversion" &&
+        make -C programs lizard CC=clang MOREFLAGS="--target=x86_64-w64-mingw32 -Werror -Wconversion -Wno-sign-conversion" &&
         make -C tests fullbench CC=clang MOREFLAGS="--target=x86_64-w64-mingw32 -Werror -Wconversion -Wno-sign-conversion" &&
         make -C lib lib CC=clang MOREFLAGS="--target=x86_64-w64-mingw32 -Werror -Wconversion -Wno-sign-conversion"
       )
@@ -59,42 +59,42 @@ build_script:
       COPY tests\fullbench.c bin\example\ &&
       COPY lib\xxhash.c bin\example\ &&
       COPY lib\xxhash.h bin\example\ &&
-      COPY lib\lz5.h bin\include\ &&
-      COPY lib\lz5hc.h bin\include\ &&
-      COPY lib\lz5frame.h bin\include\ &&
-      COPY lib\liblz5.a bin\static\liblz5_static.lib &&
-      COPY lib\dll\liblz5.* bin\dll\ &&
+      COPY lib\lizard.h bin\include\ &&
+      COPY lib\lizardhc.h bin\include\ &&
+      COPY lib\lizardframe.h bin\include\ &&
+      COPY lib\liblizard.a bin\static\liblizard_static.lib &&
+      COPY lib\dll\liblizard.* bin\dll\ &&
       COPY lib\dll\example\Makefile bin\example\ &&
       COPY lib\dll\example\fullbench-dll.* bin\example\ &&
       COPY lib\dll\example\README.md bin\ &&
-      COPY programs\lz5.exe bin\lz5.exe
+      COPY programs\lizard.exe bin\lizard.exe
     )
   - if [%COMPILER%]==[gccX] if [%PLATFORM%]==[mingw64] (
-      7z.exe a bin\lz5_x64.zip NEWS .\bin\lz5.exe .\bin\README.md .\bin\example .\bin\dll .\bin\static .\bin\include &&
-      appveyor PushArtifact bin\lz5_x64.zip
+      7z.exe a bin\lizard_x64.zip NEWS .\bin\lizard.exe .\bin\README.md .\bin\example .\bin\dll .\bin\static .\bin\include &&
+      appveyor PushArtifact bin\lizard_x64.zip
     )
   - if [%COMPILER%]==[gccX] if [%PLATFORM%]==[mingw32] (
-      7z.exe a bin\lz5_x86.zip NEWS .\bin\lz5.exe .\bin\README.md .\bin\example .\bin\dll .\bin\static .\bin\include &&
-      appveyor PushArtifact bin\lz5_x86.zip
+      7z.exe a bin\lizard_x86.zip NEWS .\bin\lizard.exe .\bin\README.md .\bin\example .\bin\dll .\bin\static .\bin\include &&
+      appveyor PushArtifact bin\lizard_x86.zip
     )
   - if [%COMPILER%]==[gcc] (COPY tests\fullbench.exe programs\)
   - if [%COMPILER%]==[visual] (
       ECHO *** &&
       ECHO *** Building Visual Studio 2010 %PLATFORM%\%CONFIGURATION% &&
       ECHO *** &&
-      msbuild "visual\VS2010\lz5.sln" %ADDITIONALPARAM% /m /verbosity:minimal /property:PlatformToolset=v100 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
+      msbuild "visual\VS2010\lizard.sln" %ADDITIONALPARAM% /m /verbosity:minimal /property:PlatformToolset=v100 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
       ECHO *** &&
       ECHO *** Building Visual Studio 2012 %PLATFORM%\%CONFIGURATION% &&
       ECHO *** &&
-      msbuild "visual\VS2010\lz5.sln" /m /verbosity:minimal /property:PlatformToolset=v110 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
+      msbuild "visual\VS2010\lizard.sln" /m /verbosity:minimal /property:PlatformToolset=v110 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
       ECHO *** &&
       ECHO *** Building Visual Studio 2013 %PLATFORM%\%CONFIGURATION% &&
       ECHO *** &&
-      msbuild "visual\VS2010\lz5.sln" /m /verbosity:minimal /property:PlatformToolset=v120 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
+      msbuild "visual\VS2010\lizard.sln" /m /verbosity:minimal /property:PlatformToolset=v120 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
       ECHO *** &&
       ECHO *** Building Visual Studio 2015 %PLATFORM%\%CONFIGURATION% &&
       ECHO *** &&
-      msbuild "visual\VS2010\lz5.sln" /m /verbosity:minimal /property:PlatformToolset=v140 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
+      msbuild "visual\VS2010\lizard.sln" /m /verbosity:minimal /property:PlatformToolset=v140 /t:Clean,Build /p:Platform=%PLATFORM% /p:Configuration=%CONFIGURATION% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" &&
       COPY visual\VS2010\bin\%PLATFORM%_%CONFIGURATION%\*.exe programs\
     )
 
@@ -104,22 +104,22 @@ test_script:
       ECHO ***
   - if not [%COMPILER%]==[unknown] (
       CD programs &&
-      lz5 -h &&
-      lz5 -i1b lz5.exe &&
-      lz5 -i1b5 lz5.exe &&
-      lz5 -i1b10 lz5.exe &&
-      lz5 -i1b15 lz5.exe &&
-      echo ------- lz5 tested ------- &&
+      lizard -h &&
+      lizard -i1b lizard.exe &&
+      lizard -i1b5 lizard.exe &&
+      lizard -i1b10 lizard.exe &&
+      lizard -i1b15 lizard.exe &&
+      echo ------- lizard tested ------- &&
       fullbench.exe -i1 fullbench.exe
     )
 
 artifacts:
-  - path: bin\lz5_x64.zip
-  - path: bin\lz5_x86.zip
+  - path: bin\lizard_x64.zip
+  - path: bin\lizard_x86.zip
 
 deploy:
 - provider: GitHub
-  artifact: bin\lz5_x64.zip
+  artifact: bin\lizard_x64.zip
   auth_token:
     secure: LgJo8emYc3sFnlNWkGl4/VYK3nk/8+RagcsqDlAi3xeqNGNutnKjcftjg84uJoT4
   force_update: true
@@ -131,7 +131,7 @@ deploy:
     branch: autobuild
 
 - provider: GitHub
-  artifact: bin\lz5_x86.zip
+  artifact: bin\lizard_x86.zip
   auth_token:
     secure: LgJo8emYc3sFnlNWkGl4/VYK3nk/8+RagcsqDlAi3xeqNGNutnKjcftjg84uJoT4
   force_update: true