Go to file

Josh Soref 2fff023912 spelling: ignore Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>		2021-12-25 22:49:37 -05:00
.gitignore	Ignore stb dependencies and build artifacts	2021-12-11 15:49:14 +01:00
qoi.h	Clarify pixel ordering; close #120	2021-12-23 11:45:19 +01:00
qoibench.c	spelling: ignore	2021-12-25 22:49:37 -05:00
qoiconv.c	Replace printf() with puts()	2021-12-21 09:41:33 +00:00
qoifuzz.c	Add clang fuzzing harness. Thanks @landaire	2021-12-16 20:02:37 +01:00
README.md	Mention qoic, an OCaml implementation.	2021-12-24 00:27:47 +01:00

README.md

QOI - The “Quite OK Image Format” for fast, lossless image compression

Single-file MIT licensed library for C/C++

See qoi.h for the documentation and format specification.

More info at https://qoiformat.org

Why?

Compared to stb_image and stb_image_write QOI offers 20x-50x faster encoding, 3x-4x faster decoding and 20% better compression. It's also stupidly simple and fits in about 300 lines of C.

Example Usage

qoiconv.c converts between png <> qoi
qoibench.c a simple wrapper to benchmark stbi, libpng and qoi

Limitations

The QOI file format allows for huge images with up to 18 exa-pixels. A streaming en-/decoder can handle these with minimal RAM requirements, assuming there is enough storage space.

This particular implementation of QOI however is limited to images with a maximum size of 400 million pixels. It will safely refuse to en-/decode anything larger than that. This is not a streaming en-/decoder. It loads the whole image file into RAM before doing any work and is not extensively optimized for performance (but it's still very fast).

If this is a limitation for your use case, please look into any of the other implementations listed below.

Tools

https://github.com/floooh/qoiview - native QOI viewer
https://github.com/pfusik/qoi-ci/releases/tag/qoi-ci-1.1.0 - QOI Plugin installer for GIMP, Imagine, Paint.NET and XnView MP
https://github.com/iOrange/QoiFileTypeNet/releases/tag/v0.2 - QOI Plugin for Paint.NET
https://github.com/iOrange/QOIThumbnailProvider - Add thumbnails for QOI images in Windows Explorer

Implementations & Bindings of QOI

https://github.com/pfusik/qoi-ci (Ć, transpiled to C, C++, C#, Java, JavaScript, Python and Swift)
https://github.com/kodonnell/qoi (Python)
https://github.com/Cr4xy/lua-qoi (Lua)
https://github.com/superzazu/SDL_QOI (C, SDL2 bindings)
https://github.com/saharNooby/qoi-java (Java)
https://github.com/MasterQ32/zig-qoi (Zig)
https://github.com/rbino/qoix (Elixir)
https://github.com/NUlliiON/QoiSharp (C#)
https://github.com/zakarumych/rapid-qoi (Rust)
https://github.com/takeyourhatoff/qoi (Go)
https://github.com/DosWorld/pasqoi (Pascal)
https://github.com/elihwyma/Swift-QOI (Swift)
https://github.com/xfmoulet/qoi (Go)
https://erratique.ch/software/qoic (OCaml)

QOI Support in Other Software

SerenityOS supports decoding QOI system wide through a custom cpp implementation in LibGfx
Raylib supports decoding and encoding QOI textures through its rtextures module
Rebol3 supports decoding and encoding QOI using a native codec
c-ray supports QOI natively

Packages

AUR - system-wide qoi.h, qoiconv and qoibench install as split packages.

Implementations not yet conforming to the final specification

These implementations are based on the pre-release version of QOI. Resulting files are not compatible with the current version.

https://github.com/steven-joruk/qoi (Rust)
https://github.com/ChevyRay/qoi_rs (Rust)
https://github.com/panzi/jsqoi (TypeScript)
https://github.com/0xd34df00d/hsqoi (Haskell)