Managed C# dotnet wrapper around the Native GrindCore library - GrindCore GitHub Repository
Published to nuget as GrindCore
This library is in the early stages of development. There may be many breaking changes over the following months.
GrindCore is an innovative library designed to streamline and enhance compression processes in dotnet applications. It aims to tackle prevalent issues such as performance degradation and outdated implementations when native code updates frequently. By unifying multiple C forks into a single, multiplatform library, GrindCore achieves a cohesive and efficient solution.
The primary goal of GrindCore is to deliver a maintainable compression and hashing solution for dotnet applications. Leveraging the exact method used to build C in the dotnet runtime ensures a robust approach. By preserving precise compression algorithms for key versions, GrindCore guarantees compatibility and reliability for projects requiring byte-perfect output.
- ZLib, Deflate
- Brotli
- Zip
- Blake3, Blake2sp
- MD5, MD4, MD2
- SHA1
- SHA2 (SHA256, SHA384, SHA512)
- SHA3 (SHA3-224, SHA3-256, SHA3-384, SHA3-512)
- XXHash (XXH32, XXH64)
Lots more functionality to be added.
A comprehensive list of test statuses for various platforms is available below. For a quick summary: GrindCore is being actively tested across major platforms including Linux ARM64, Linux ARM, Linux x64, macOS x64, macOS ARM64, Windows x64, and Windows x86. Windows ARM64 builds, but there is no test platform available.
| Platform | Unit Test Status |
|---|---|
| Linux ARM64 |  |
| Linux ARM |  |
| Linux x64 |  |
| macOS x64 |  |
| macOS ARM64 |  |
| Windows x64 |  |
| Windows x86 |  |
| Windows ARM64 | Builds, no test platform available |
GrindCore integrates robust solutions from several key projects:
- dotnet Runtime GitHub Repository:
- Provides a foundation with multiplatform C compilation based on CMake and C, ensuring seamless integration across different platforms.
- Supplies zlib/deflate and Brotli from the dotnet 8 code, combined with C# wrappers, to offer efficient and reliable compression algorithms.
- 7zip mcmilk GitHub Repository: Contributes a comprehensive suite of hash functions, including SHA-1, SHA-2, SHA-3, MD2, MD4, MD5, and XXHash (32 and 64). More compression and hashing algorithms will be ported, benefiting from a uniform Make project structure that simplifies integration.
- SharpCompress GitHub Repository: Expected to provide managed code to process archives and wrap native compression streams, further enhancing the library's capabilities and user experience.
GrindCore is designed to overcome several known complications in the dotnet ecosystem:
- Performance: C# ports generally perform slower than native C, although the JIT offers powerful optimization capabilities.
- Up-to-date Implementations: Leveraging well-maintained projects like dotnet Runtime and 7zip mcmilk ensures that the C algorithms can be updated easily.
- Cross-Platform Compatibility: Through multiplatform C compilation via the dotnet CMake system, GrindCore ensures seamless functionality across different operating systems. The managed layer abstracts this, allowing it to be used as System.IO.Compression would be used.
- Consistency: By preserving exact compression algorithms, the library is ideal for projects requiring checksummed output, ensuring consistent data results and reliability.
- Addressing Missing Functionality: GrindCore aims to expose additional functionalities not available in other libraries, such as
compress2from zlib/deflate, providing more options and flexibility for developers.
GrindCore is on a journey to create a more reliable and efficient compression solution for dotnet. The community's contributions and collaboration are welcomed.