tuxmain/qoi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme + update bench timings

Browse source
This commit is contained in:
Ivan Smirnov 2022-01-03 20:57:25 +03:00
parent 718e09e303
commit 82f07a3e8d
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,4 @@
# qoi-fast # [qoi-fast](https://crates.io/crates/qoi-fast)
VERY fast encoder/decoder for [QOI image format](https://qoiformat.org/), implemented in pure Rust.
[![Build](https://github.com/aldanor/qoi-fast/workflows/CI/badge.svg)](https://github.com/aldanor/qoi-fast/actions?query=branch%3Amaster) [![Build](https://github.com/aldanor/qoi-fast/workflows/CI/badge.svg)](https://github.com/aldanor/qoi-fast/actions?query=branch%3Amaster)
[![Latest Version](https://img.shields.io/crates/v/qoi-fast.svg)](https://crates.io/crates/qoi-fast) [![Latest Version](https://img.shields.io/crates/v/qoi-fast.svg)](https://crates.io/crates/qoi-fast)
@ -9,13 +7,16 @@ VERY fast encoder/decoder for [QOI image format](https://qoiformat.org/), implem
[![MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance) [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance)
Fast encoder/decoder for [QOI image format](https://qoiformat.org/), implemented in pure and safe Rust.
Quick summary: Quick summary:
- One of the [fastest](https://github.com/aldanor/qoi-fast#benchmarks) - One of the [fastest](https://github.com/aldanor/qoi-fast#benchmarks)
QOI encoders/decoders out there. QOI encoders/decoders out there.
- Compliant with the latest QOI [format specification](https://qoiformat.org/qoi-specification.pdf). - Compliant with the [latest](https://qoiformat.org/qoi-specification.pdf) QOI format specification.
- Zero unsafe code. - Zero unsafe code.
- Supports decoding from / encoding to `std::io` streams directly. - Supports decoding from / encoding to `std::io` streams directly.
- `no_std` support.
- Roundtrip-tested vs the reference C implementation; fuzz-tested. - Roundtrip-tested vs the reference C implementation; fuzz-tested.
### Examples ### Examples
@ -33,8 +34,8 @@ benchmarks timings collected on Apple M1 (1782 images, 1187 MB total):
``` ```
codec decode:ms encode:ms decode:mp/s encode:mp/s codec decode:ms encode:ms decode:mp/s encode:mp/s
qoi-c 4409.34 5531.82 282.3 225.0 qoi-c 4406.63 5515.80 282.4 225.6
qoi-fast 3105.60 4726.19 400.8 263.3 qoi-fast 3071.49 4545.08 405.2 273.8
``` ```
### License ### License