Skip to content

Commit

Permalink
Fix readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrii Dmytrenko committed May 20, 2014
1 parent 902ad0f commit 5fa2d39
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Rust gpx reader
===============

Reads GuitarPro 6 compressed gpx file with BCFZ compression.
****
###Reads GuitarPro 6 compressed gpx file with BCFZ compression.
****

In order to decompress BCFZ file, you need to implement BitStream reader,
capable of reading bit-by-bit from a stream.
Expand All @@ -11,10 +12,13 @@ File has a BCFZ header following 32 le bit integer specifying expected decompres
The rest of a file consists of 2 types of data chunks (uncompressed, raw data and compressed).
Read 1 bit from a bitstream.
If bit is 0, uncompressed chunk follows:

1. Next 2 le bits are length in bytes.
2. Read length bytes from a bitstream.
3. Put those bytes into a decompressed data buffer.

If bit is 1, then compressed chunk follows:

1. Next 4 be bits are word size.
2. Read word size bits to get offset.
3. Read word size bits to get length.
Expand Down

0 comments on commit 5fa2d39

Please sign in to comment.