Skip to content

Commit

Permalink
improve phrasing in overview.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kspalaiologos authored Dec 14, 2024
1 parent b8d9257 commit 31c2437
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions doc/overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# BZip3 Format Documentation

BZip3 is a modern compression format designed for high compression ratios while maintaining
reasonable decompression speeds. It targets the same category/weight as LZMA and BZip2; as opposed
to the speedy LZ based formats like ZStandard
reasonable decompression speeds. It is intended to provide similar compression ratio and
performance to LZMA and BZip2; as opposed to faster Lempel-Ziv codecs that usually offer worse
compression ratio like ZStandard or LZ4.

This documentation covers the technical specifications of the BZip3 format.

Expand All @@ -13,15 +14,17 @@ This documentation covers the technical specifications of the BZip3 format.
- Memory usage of ~(6 x block size), both compression and decompression
- Little-endian encoding for integers
- Embedded CRC32 checksums for data integrity
- Combines LZP, RLE followed by Burrows-Wheeler transform and arithmetic coding.
- Combines LZP, RLE followed by Burrows-Wheeler transform and arithmetic coding coupled with
a statistical predictor.

## Format Overview

BZip3 uses two main formats:
BZip3 uses two main top-level formats:

1. **File Format**: The standard format used by the command-line tool
2. **Frame Format**: Used by the high-level API functions `bz3_compress` and `bz3_decompress`.

These formats are the same, except the fact that the file format also contains a block count field.
These formats are very similar: the file format is a superset of the frame format and thus also
contains a block count field.

See [bzip3_format.md](./bzip3_format.md) for the exact specification.
See [bzip3_format.md](./bzip3_format.md) for more details.

0 comments on commit 31c2437

Please sign in to comment.