Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Implement LZSS decoder, LZSS encoder and RLE decoder #39

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

pleonex
Copy link
Member

@pleonex pleonex commented Oct 13, 2024

Implement compression and decompression for some of the BIOS built-in compressions:

  • LZSS: decompress and compress
  • RLE: decompress

TODO:

  • Unit tests for RLE
  • Compression for RLE
  • Update documentation (and README)

Part of #29

Quality check list

  • Related code has been tested automatically or manually
  • Related documentation is updated
  • I acknowledge I have read and filled this checklist and accept the
    developer certificate of origin

Acceptance criteria

  • Compress and decompress LZSS files.

Follow-up work

  • Implement Huffman compressions
  • Implement BLZ compressions
  • Implement LZ11 compression

Example

// Compress a Stream
var encoder = new LzssEncoder();
using Stream outputStream = encoder.Convert(inputStream);

// Or pass the output in the constructor
new LzssEncoder(outputStream).Convert(inputStream);

Same for the LZSS decompressor LzssDecoder or the RLE decompressor RleDecoder.

@pleonex pleonex added the enhancement New feature or request label Oct 13, 2024
@pleonex pleonex self-assigned this Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant