https://github.com/mvdan/zstd
Zstandard implementation in Wuffs
https://github.com/mvdan/zstd
wuffs zstd
Last synced: 10 months ago
JSON representation
Zstandard implementation in Wuffs
- Host: GitHub
- URL: https://github.com/mvdan/zstd
- Owner: mvdan
- License: bsd-3-clause
- Created: 2018-02-25T15:52:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-19T23:51:32.000Z (about 6 years ago)
- Last Synced: 2024-10-14T11:55:19.561Z (about 1 year ago)
- Topics: wuffs, zstd
- Language: C
- Homepage:
- Size: 55.7 KB
- Stars: 112
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zstd
An implementation from scratch of [Zstandard] in [Wuffs]. It is being
developed following the published [spec].
This is very much a work in progress, so it is not ready for use.
To build a simple `zstd` binary that will use stdin and stdout:
./build
And to test it with the input/output cases in `testdata`:
./test
### Why?
Writing a decoder in Wuffs takes more time, but the end result is an
implementation that is safe and can be used in many languages without
linking against C.
For example, that would mean no cgo overhead with Go, and safer code for
languages like Rust. Though that is somewhere in the future - see the
roadmap.
If you're after a zstd implementation that works today, use
https://github.com/DataDog/zstd.
### Roadmap
This is the current progress of the decoder.
- [x] Zstandard frames
- [x] Raw blocks
- [x] RLE blocks
- [ ] Compressed blocks
- [ ] Literals section
- [ ] Raw literals block
- [ ] RLE literals block
- [ ] Compressed literals block
- [ ] Treeless literals block
- [ ] Sequences section
- [ ] Predefined mode
- [ ] RLE mode
- [ ] Repeat mode
- [ ] FSE compression mode
- [ ] Sequence execution
- [ ] Repeat offsets
- [ ] Other offsets
- [ ] XXH64 frame content checksum
- [x] Skippable frames
- [ ] Dictionaries
These items are required for a stable 1.0 release:
- [ ] Wuffs 1.0 release
- [ ] Go support in Wuffs (generating a Go zstd library)
- [ ] Full zstd decoder implemented
[Zstandard]: https://facebook.github.io/zstd/
[Wuffs]: https://github.com/google/wuffs
[spec]: https://github.com/facebook/zstd/blob/dev/doc/zstd_compression_format.md