AuroraLib.Compression 1.5.0

AuroraLib.Compression

AuroraLib.Compression is a high-performance, memory-efficient library for a broad range of compression algorithms primarily used in video games. Designed for seamless use across multiple .NET versions. Written entirely in managed C#, it eliminates the need for external C++ libraries while offering fast decompression and compression.

Benchmarks

Supported Algorithms

AuroraLib.Compression

* Big-endian and little-endian version are supported.

AuroraLib.Compression-Extended

* Big-endian and little-endian version are supported.

How To Use

Decompress a File Using a Specific Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    using FileStream destination = new("output.dat", FileMode.Create, FileAccess.ReadWrite, FileShare.None);
    new LZSS().Decompress(source, destination);

Compress a File Using a Specific Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    using FileStream destination = new("output.dat", FileMode.Create, FileAccess.ReadWrite, FileShare.None);
    new LZSS().Compress(source, destination);

Check If a File Matches a Specific Compression Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    bool canDecompressed = new LZSS().IsMatch(source);

Configure an Compression Encoder

    Yaz0 encoder = new Yaz0
    {
        FormatByteOrder = Endian.Big,  // Use big-endian byte order
        LookAhead = false              // Disable look-ahead optimization
    };

Automatically Detect and Decompress Using a Recognized Algorithm

    FormatDictionary formats = new FormatDictionary(AppDomain.CurrentDomain.GetAssemblies());

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    ReadOnlySpan<char> fileName = Path.GetFileName("input.dat");

    if (formats.Identify(source, fileName, out IFormatInfo format) && format.Class != null)
    {
        var decoder = format.CreateInstance();
        if (decoder is ICompressionDecoder compressionDecoder)
        {
            using Stream destination = compressionDecoder.Decompress(source);
            // Use the decompressed stream as needed
        }
    }

Credits

• Nickworonekin Puyo Tools inspired the LZ Decode and Encode code and reference for CNX2, LZ00, LZ01, LZ10, LZ11, PRS algorithms.
• Haruhiko Okumura reference his original C implementation of the LZSS algorithm.
• Daniel-McCarthy reference for MIO0, YAZ0, YAY0 algorithm.
• Kuriimu reference for HUF20 algorithm.
• Niotso.wiki reference for RefPack algorithm.
• Sukharah reference for CLZ0 algorithm.
• Gamemasterplc reference for LZHudson algorithm.
• KirbyUK reference for LZShrek algorithm.
• Brolijah reference for ALLZ algorithm.thm.
• CUE reference for LZ40 algorithm.