Merge branch 'develop'

Benchmark/Benchmark.csproj

@@ -7,13 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.3" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.6" />
     <PackageReference Include="Crc32.NET" Version="1.2.0" />
     <PackageReference Include="K4os.Compression.LZ4.Streams" Version="1.3.5" />
     <PackageReference Include="K4os.Hash.Crc" Version="1.1.4" />
     <PackageReference Include="K4os.Hash.xxHash" Version="1.0.8" />
-    <PackageReference Include="SharpCompress" Version="0.32.2" />
-    <PackageReference Include="ZstdSharp.Port" Version="0.6.7" />
+    <PackageReference Include="SharpCompress" Version="0.33.0" />
+    <PackageReference Include="ZstdSharp.Port" Version="0.7.2" />
   </ItemGroup>
 
   <ItemGroup>

Joveler.Compression.LZ4.Tests/Joveler.Compression.LZ4.Tests.csproj

@@ -16,9 +16,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-    <PackageReference Include="MSTest.TestAdapter" Version="3.0.2" />
-    <PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
   </ItemGroup>
 
   <ItemGroup>

Joveler.Compression.LZ4.Tests/TestSetup.cs

@@ -33,6 +33,7 @@ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 using System.IO;
 using System.Runtime.InteropServices;
 using System.Security.Cryptography;
+using System.Text;
 // ReSharper disable InconsistentNaming
 
 namespace Joveler.Compression.LZ4.Tests
@@ -112,37 +113,16 @@ private static string GetNativeLibPath()
             return libPath;
         }
 
+        #region LogEnvironment
         [TestMethod]
-        public void LogRuntimeInfo()
+        public void LogEnvironment()
         {
-            string platform = "unknown";
-            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
-                platform = "win";
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
-                platform = "linux";
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
-                platform = "osx";
-
-            string arch = "unknown";
-            switch (RuntimeInformation.ProcessArchitecture)
-            {
-                case Architecture.X86:
-                    arch = "x86";
-                    break;
-                case Architecture.X64:
-                    arch = "x64";
-                    break;
-                case Architecture.Arm:
-                    arch = "arm";
-                    break;
-                case Architecture.Arm64:
-                    arch = "arm64";
-                    break;
-            }
-
-            Console.WriteLine($"Platform = {platform}");
-            Console.WriteLine($"Arch     = {arch}");
+            StringBuilder b = new StringBuilder();
+            b.AppendLine($"OS = {RuntimeInformation.OSDescription} {RuntimeInformation.OSArchitecture}");
+            b.AppendLine($"Dotnet Runtime = {RuntimeInformation.FrameworkDescription} {RuntimeInformation.ProcessArchitecture}");
+            Console.WriteLine(b.ToString());
         }
+        #endregion
     }
 
     public static class TestHelper

Joveler.Compression.XZ.Tests/Joveler.Compression.XZ.Tests.csproj

@@ -12,10 +12,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-    <PackageReference Include="MSTest.TestAdapter" Version="3.0.2" />
-    <PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
-    <PackageReference Include="coverlet.collector" Version="3.2.0">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

Joveler.Compression.XZ.Tests/TestSetup.cs

@@ -28,6 +28,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 using System.Diagnostics;
 using System.IO;
 using System.Runtime.InteropServices;
+using System.Text;
 
 namespace Joveler.Compression.XZ.Tests
 {
@@ -106,37 +107,16 @@ private static string GetNativeLibPath()
             return libPath;
         }
 
+        #region LogEnvironment
         [TestMethod]
-        public void LogRuntimeInfo()
+        public void LogEnvironment()
         {
-            string platform = "unknown";
-            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
-                platform = "win";
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
-                platform = "linux";
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
-                platform = "osx";
-
-            string arch = "unknown";
-            switch (RuntimeInformation.ProcessArchitecture)
-            {
-                case Architecture.X86:
-                    arch = "x86";
-                    break;
-                case Architecture.X64:
-                    arch = "x64";
-                    break;
-                case Architecture.Arm:
-                    arch = "arm";
-                    break;
-                case Architecture.Arm64:
-                    arch = "arm64";
-                    break;
-            }
-
-            Console.WriteLine($"Platform = {platform}");
-            Console.WriteLine($"Arch     = {arch}");
+            StringBuilder b = new StringBuilder();
+            b.AppendLine($"OS = {RuntimeInformation.OSDescription} {RuntimeInformation.OSArchitecture}");
+            b.AppendLine($"Dotnet Runtime = {RuntimeInformation.FrameworkDescription} {RuntimeInformation.ProcessArchitecture}");
+            Console.WriteLine(b.ToString());
         }
+        #endregion
     }
 
     public static class TestHelper

Joveler.Compression.XZ/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## v4.x
 
+### v4.2.2
+
+Released in 2023-08-06
+
+- Update xz-utils to 5.4.3.
+
 ### v4.2.1
 
 Released in 2023-02-16

Joveler.Compression.XZ/Joveler.Compression.XZ.csproj

@@ -9,7 +9,7 @@
 
     <PackageId>Joveler.Compression.XZ</PackageId>
     <Title>Joveler.Compression.XZ</Title>
-    <Version>4.2.1</Version>
+    <Version>4.2.2</Version>
     <Authors>Hajin Jang</Authors>
     <Company>Joveler</Company>
     <Description>XZ Utils (liblzma) pinvoke library for .NET.
@@ -21,9 +21,7 @@ Supports Windows, Linux and macOS.</Description>
     <PackageProjectUrl>https://github.com/ied206/Joveler.Compression</PackageProjectUrl>
     <PackageIcon>images\Logo.png</PackageIcon>
     <RepositoryUrl>https://github.com/ied206/Joveler.Compression</RepositoryUrl>
-    <PackageReleaseNotes>- Support xz-utils 5.4.1.
-- Target .NET Framework 4.6 instead of deprecated 4.5.1.
-- Fix .NET Framework build script path issue.</PackageReleaseNotes>
+    <PackageReleaseNotes>- Update xz-utils to 5.4.3.</PackageReleaseNotes>
     <PackageTags>xz xz-utils liblzma lzma lzma2 compress compression decompress decompression archive crc32 crc64 crc checksum native pinvoke interop</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>

Joveler.Compression.XZ/NUGET_README.md

@@ -5,6 +5,7 @@
 ## Features
 
 - XZStream, the stream for [.xz file format](https://tukaani.org/xz/xz-file-format.txt).
+- Fast native implementation of CRC32 and CRC64 checksums.
 
 ## Usage
 
@@ -38,15 +39,7 @@ Please refer the [project homepage](https://github.com/ied206/Joveler.Compressio
 | macOS    | x64          | Yes    |
 |          | arm64        | Yes    |
 
-#### Tested linux distributions
-
-| Architecture  | Distribution | Note |
-|---------------|--------------|------|
-| x64           | Ubuntu 20.04 | Tested on AppVeyor CI |
-| armhf         | Debian 11    | Emulated on QEMU      |
-| arm64         | Debian 11    | Emulated on QEMU      |
-
 ### Supported XZ Utils version
 
-- 5.4.1 (Included)
+- 5.4.3 (Included)
 

Joveler.Compression.XZ/README.md

@@ -11,6 +11,7 @@ Joveler.Compression.XZ can be installed via [nuget](https://www.nuget.org/packag
 ## Features
 
 - XZStream, the stream for [.xz file format](https://tukaani.org/xz/xz-file-format.txt).
+- Fast native implementation of CRC32 and CRC64 checksums.
 
 ## Support
 
@@ -40,17 +41,9 @@ Joveler.Compression.XZ can be installed via [nuget](https://www.nuget.org/packag
 | macOS    | x64          | Yes    |
 |          | arm64        | Yes    |
 
-#### Tested linux distributions
-
-| Architecture  | Distribution | Note |
-|---------------|--------------|------|
-| x64           | Ubuntu 20.04 | Tested on AppVeyor CI |
-| armhf         | Debian 11    | Emulated on QEMU      |
-| arm64         | Debian 11    | Emulated on QEMU      |
-
 ### Supported XZ Utils version
 
-- 5.4.1 (Included)
+- 5.4.3 (Included)
 
 ## Usage
 

Joveler.Compression.XZ/USAGE.md

@@ -10,7 +10,7 @@ You must call `XZInit.GlobalInit()` before using Joveler.Compression.XZ. Please
 
 **WARNING**: The caller process and callee library must have the same architecture!
 
-#### On .NET Core
+#### On .NET/.NET Core
 
 ```cs
 public static void InitNativeLibrary()
@@ -89,39 +89,25 @@ public static void InitNativeLibrary()
 
 ### Embedded binary
 
-Joveler.Compression.XZ comes with sets of static binaries of `liblzma 5.4.1`. They will be copied into the build directory at build time.
+Joveler.Compression.XZ comes with sets of static binaries of `liblzma 5.4.3`. They will be copied into the build directory at build time.
 
-#### On .NET Standard & .NET Core
+#### On .NET/.NET Core & .NET Standard
 
-| Platform             | Binary                                       | License       | Note          |
-|----------------------|----------------------------------------------|---------------|---------------|
-| Windows x86          | `$(OutDir)\runtimes\win-x86\liblzma.dll`     | Public Domain | Universal CRT |
-| Windows x64          | `$(OutDir)\runtimes\win-x64\liblzma.dll`     | Public Domain | Universal CRT |
-| Windows arm64        | `$(OutDir)\runtimes\win-arm64\liblzma.dll`   | Public Domain | Universal CRT |
-| Ubuntu 20.04 x64     | `$(OutDir)\runtimes\linux-x64\liblzma.so`    | Public Domain | glibc         |
-| Debian 11 armhf      | `$(OutDir)\runtimes\linux-arm\liblzma.so`    | Public Domain | glibc         |
-| Debian 11 arm64      | `$(OutDir)\runtimes\linux-arm64\liblzma.so`  | Public Domain | glibc         |
-| macOS Big Sur x64    | `$(OutDir)\runtimes\osx-x64\liblzma.dylib`   | Public Domain | libSystem     |
-| macOS Ventura arm64  | `$(OutDir)\runtimes\osx-arm64\liblzma.dylib` | Public Domain | libSystem     |
-
-- Create an empty file named `Joveler.Compression.XZ.Precompiled.Exclude` in the project directory to prevent copy of the package-embedded binary.
-
-#### For .NET Standard 2.0+
-
-| Platform      | Binary                                      | Note                     |
-|---------------|---------------------------------------------|--------------------------|
-| Windows x86   | `$(OutDir)\runtimes\win-x86\liblzma.dll`    | Official binary          |
-| Windows x64   | `$(OutDir)\runtimes\win-x64\liblzma.dll`    | Official binary          |
-| Windows arm64 | `$(OutDir)\runtimes\win-arm64\liblzma.dll`  | Compiled with MSVC 2019  |
-| Linux x64     | `$(OutDir)\runtimes\linux-x64\liblzma.so`   | Compiled in Ubuntu 18.04 |
-| Linux armhf   | `$(OutDir)\runtimes\linux-arm\liblzma.so`   | Compiled in Debian 10    |
-| Linux arm64   | `$(OutDir)\runtimes\linux-arm64\liblzma.so` | Compiled in Debian 10    |
-| macOS x64     | `$(OutDir)\runtimes\osx-x64\liblzma.dylib`  | Compiled in Catalina     |
+| Platform              | Binary                                       | License       | C Runtime     |
+|-----------------------|----------------------------------------------|---------------|---------------|
+| Windows x86           | `$(OutDir)\runtimes\win-x86\liblzma.dll`     | Public Domain | Universal CRT |
+| Windows x64           | `$(OutDir)\runtimes\win-x64\liblzma.dll`     | Public Domain | Universal CRT |
+| Windows arm64         | `$(OutDir)\runtimes\win-arm64\liblzma.dll`   | Public Domain | Universal CRT |
+| Ubuntu 20.04 x64      | `$(OutDir)\runtimes\linux-x64\liblzma.so`    | Public Domain | glibc         |
+| Debian 12 armhf       | `$(OutDir)\runtimes\linux-arm\liblzma.so`    | Public Domain | glibc         |
+| Debian 12 arm64       | `$(OutDir)\runtimes\linux-arm64\liblzma.so`  | Public Domain | glibc         |
+| macOS Big Sur x64     | `$(OutDir)\runtimes\osx-x64\liblzma.dylib`   | Public Domain | libSystem     |
+| macOS Monterey arm64  | `$(OutDir)\runtimes\osx-arm64\liblzma.dylib` | Public Domain | libSystem     |
 
 - Bundled Windows binaires now target [Universal CRT](https://learn.microsoft.com/en-us/cpp/windows/universal-crt-deployment?view=msvc-170) for better interopability with MSVC.
     - .NET Core/.NET 5+ runs on UCRT, so no action is required in most cases.
     - If you encounter a dependency issue on Windows Vista, 7 or 8.1, try [installing UCRT manually](https://learn.microsoft.com/en-us/cpp/windows/universal-crt-deployment?view=msvc-170).
-- If you call `XZInit.GlobalInit()` without `libPath` parameter on Linux or macOS, it will search for system-installed liblzma.
+- If you call `XZInit.GlobalInit()` without the `libPath` parameter on Linux or macOS, it will search for system-installed liblzma.
 - Linux binaries are not portable. They may not work on your distribution.
     - You may call parameter-less `XZInit.GlobalInit()` to use system-installed liblzma.
 
@@ -166,7 +152,7 @@ You can tune xz compress options with this class.
 
 | Property | Summary |
 |----------|---------|
-| Level | Compression level. The Default is `ZLibCompLevel.Default` (6). |
+| Level | Compression level. The Default is `LzmaCompLevel.Default` (6). |
 | ExtremeFlag | Use a slower variant to get a little bit better compression ratio hopefully. |
 | BufferSize | Size of the internal buffer. The default is 1MB. |
 | LeaveOpen | Whether to leave the base stream object open after disposing of the xz stream object. |
@@ -202,7 +188,7 @@ It may contain more advanced options.
 
 **NOTE**: You must use threaded compression to let xz-utils decompress in parallel, even if you are using only 1 thread. 
 
-**WARNING**: If possible, always check the available system memory. Modern CPUs have a lot of cores, and each thread will allocate its buffer.
+**WARNING**: If possible, always check the available system memory. Modern CPUs have a lot of cores, and each thread will allocate its own buffer.
 
 **WARNING**: In multi-threaded compression, each thread may allocate more memory than the single-thread mode, including compressing in 1 thread. xz-utils aggressively buffers input and output in parallel compression. Use `XZInit.EncoderMemUsage()` to check the exact memory requirement for your config.
 
@@ -309,7 +295,7 @@ switch (XZInit.Lib.PlatformBitness)
 {
     case DynLoader.PlatformBitness.Bit32:
         threadOpts.MemlimitThreading = Math.Min(XZHardware.PhysMem() / 4, 1400U << 20);
-        break;
+        break;s
     case DynLoader.PlatformBitness.Bit64:
         threadOpts.MemlimitThreading = XZHardware.PhysMem() / 4;
         break;
@@ -327,11 +313,9 @@ using (XZStream zs = new XZStream(fsComp, decompOpts, threadOpts))
 
 `Crc32Checksum` is the class designed to compute CRC32 checksum.
 
-- Use `Append()` method to compute the checksum.  
-- Use `Checksum` property to get the checksum value.
-- Use `Reset()` method to reset `Checksum` property.
-
-**NOTE**: xz-utils provides about twice faster CRC32 implementation than zlib, in my benchmark with [Joveler.Compression.ZLib](https://www.nuget.org/packages/Joveler.Compression.ZLib).
+- Use the `Append()` method to compute the checksum.  
+- Use the `Checksum` property to get the checksum value.
+- Use the `Reset()` method to reset the `Checksum` property.
 
 ### Examples
 
@@ -379,9 +363,9 @@ It inherits and implements [HashAlgorithm](https://docs.microsoft.com/en-US/dotn
 
 `Crc64Checksum` is the class designed to compute CRC64 checksum.
 
-Use `Append()` method to compute the checksum.  
-Use `Checksum` property to get the checksum value.
-Use `Reset()` method to reset `Checksum` property.
+Use the `Append()` method to compute the checksum.  
+Use the `Checksum` property to get the checksum value.
+Use the `Reset()` method to reset the `Checksum` property.
 
 ### Examples
 
@@ -420,6 +404,6 @@ using (FileStream fs = new FileStream("read.txt", FileMode.Open))
 
 ## Crc64Algorithm
 
-`Crc64Algorithm` is the class designed to compute CRC64 checksum.
+`Crc64Algorithm` is the class designed to compute the CRC64 checksum.
 
 It inherits and implements [HashAlgorithm](https://docs.microsoft.com/en-US/dotnet/api/system.security.cryptography.hashalgorithm).

Joveler.Compression.ZLib.Tests/Joveler.Compression.ZLib.Tests.csproj

@@ -14,10 +14,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-    <PackageReference Include="MSTest.TestAdapter" Version="3.0.2" />
-    <PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
-    <PackageReference Include="coverlet.collector" Version="3.2.0">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>