From 81ae67c934e58ba65c37244ccf21f7cd469ade3e Mon Sep 17 00:00:00 2001 From: Charles Date: Fri, 26 Jun 2020 10:17:45 +0200 Subject: Added serialization --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74ef205..75fb0ad 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ # huffman -Implementation of [Huffman coding](https://en.wikipedia.org/wiki/Huffman_coding?oldformat=true) made for educational purposes. +Implementation of the [Huffman coding](https://en.wikipedia.org/wiki/Huffman_coding?oldformat=true) made for educational purposes. ## Usage +* compress: `cargo run < input_file > output_file.huffman` +* decompress: `cargo run d < input_file.huffman > output_file` + `python3 draft.py [file_name]` to run the python draft. -`cargo run [file_name]` for the real thing. +## File format + +Compress to a custom `.huffman` file format which is a header of the huffman coding tree followed by the compressed content. + + +### Header format + +4 byte unsigned int: header size (including this field) +Conversion table where each entry's format is: + 1 byte for the actual byte value + 1 byte for size of representation in bits + the representation aligned on a 8-bit boundary -- cgit