2022-01-03 17:57:25 +00:00
|
|
|
# [qoi-fast](https://crates.io/crates/qoi-fast)
|
2022-01-02 22:40:25 +00:00
|
|
|
|
|
|
|
|
[](https://github.com/aldanor/qoi-fast/actions?query=branch%3Amaster)
|
|
|
|
|
[](https://crates.io/crates/qoi-fast)
|
|
|
|
|
[](https://docs.rs/qoi-fast)
|
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
2022-01-03 11:51:39 +00:00
|
|
|
[](https://github.com/rust-secure-code/safety-dance)
|
2022-01-02 22:40:25 +00:00
|
|
|
|
2022-01-03 17:57:25 +00:00
|
|
|
Fast encoder/decoder for [QOI image format](https://qoiformat.org/), implemented in pure and safe Rust.
|
|
|
|
|
|
2022-01-04 00:10:55 +00:00
|
|
|
- One of the [fastest](#benchmarks) QOI encoders/decoders out there.
|
2022-01-03 17:57:25 +00:00
|
|
|
- Compliant with the [latest](https://qoiformat.org/qoi-specification.pdf) QOI format specification.
|
2022-01-03 11:25:25 +00:00
|
|
|
- Zero unsafe code.
|
|
|
|
|
- Supports decoding from / encoding to `std::io` streams directly.
|
2022-01-03 17:57:25 +00:00
|
|
|
- `no_std` support.
|
2022-01-03 11:25:25 +00:00
|
|
|
- Roundtrip-tested vs the reference C implementation; fuzz-tested.
|
|
|
|
|
|
|
|
|
|
### Examples
|
|
|
|
|
|
|
|
|
|
```rust
|
2022-01-03 22:52:42 +00:00
|
|
|
use qoi_fast::{encode_to_vec, decode_to_vec};
|
|
|
|
|
|
|
|
|
|
let encoded = encode_to_vec(&pixels, width, height)?;
|
|
|
|
|
let (header, decoded) = decode_to_vec(&encoded)?;
|
|
|
|
|
|
|
|
|
|
assert_eq!(header.width, width);
|
|
|
|
|
assert_eq!(header.height, height);
|
|
|
|
|
assert_eq!(decoded, pixels);
|
2022-01-03 11:25:25 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Benchmarks
|
|
|
|
|
|
|
|
|
|
Comparison to the reference C implementation
|
|
|
|
|
(as of [00e34217](https://github.com/phoboslab/qoi/commit/00e34217)),
|
|
|
|
|
benchmarks timings collected on Apple M1 (1782 images, 1187 MB total):
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
codec decode:ms encode:ms decode:mp/s encode:mp/s
|
|
|
|
|
|
2022-01-03 22:47:01 +00:00
|
|
|
qoi-c 4389.75 5524.18 283.5 225.3
|
|
|
|
|
qoi-fast 3026.68 4304.26 411.2 289.2
|
2022-01-03 11:25:25 +00:00
|
|
|
```
|
2022-01-02 22:40:25 +00:00
|
|
|
|
2022-01-03 22:58:27 +00:00
|
|
|
Benchmarks have also been run for all of the other Rust implementations
|
|
|
|
|
of QOI for comparison purposes and, at the time of writing this document,
|
|
|
|
|
this library proved to be the fastest one by a noticeable margin.
|
|
|
|
|
|
2022-01-04 11:52:45 +00:00
|
|
|
### Rust version
|
|
|
|
|
|
|
|
|
|
The minimum required Rust version is 1.51.0 (any changes to this would be
|
|
|
|
|
considered to be a breaking change).
|
|
|
|
|
|
2022-01-03 18:57:54 +00:00
|
|
|
### `no_std`
|
|
|
|
|
|
|
|
|
|
This crate supports `no_std` mode. By default, std is enabled via the `std`
|
|
|
|
|
feature. You can deactivate the `default-features` to target core instead.
|
|
|
|
|
In that case anything related to `std::io`, `std::error::Error` and heap
|
|
|
|
|
allocations is disabled. There is an additional `alloc` feature that can
|
|
|
|
|
be activated to bring back the support for heap allocations.
|
|
|
|
|
|
2022-01-02 22:40:25 +00:00
|
|
|
### License
|
|
|
|
|
|
2022-01-03 11:51:39 +00:00
|
|
|
This project is dual-licensed under MIT and Apache 2.0.
|
