Mirror of phoboslab/qoi@github.com - "Quite Okay Image"
Go to file
Luis Alfredo Figueroa Bracamontes bce1a069a8
Adding links to required libreries
Adding the URLs to the repo of the required libraries to make even easier to use this program
2022-06-11 12:58:41 -05:00
.gitignore Ignore stb dependencies and build artifacts 2021-12-11 15:49:14 +01:00
Makefile Replaced remaining := with ?= to allow CLI parameters 2022-05-12 14:53:17 +02:00
README.md Add PureBasic implementation to readme 2022-06-07 09:37:35 +02:00
qoi.h Load/store RGBA separately instead of using a typecast; close #197 2022-04-11 23:19:04 +02:00
qoibench.c Remove obsolete, unused vars; close #56 2022-04-11 22:35:39 +02:00
qoiconv.c Adding links to required libreries 2022-06-11 12:58:41 -05:00
qoifuzz.c Add clang fuzzing harness. Thanks @landaire 2021-12-16 20:02:37 +01:00

README.md

QOI Logo

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.

Improvements, New Versions and Contributing

The QOI format has been finalized. It was a conscious decision to not have a version number in the file header. If you have a working QOI implementation today, you can rest assured that it will be compatible with all QOI files tomorrow.

There are a lot of interesting ideas for a successor of QOI, but none of these will be implemented here. That doesn't mean you shouldn't experiment with QOI, but please be aware that pull requests that change the format will not be accepted.

Likewise, pull requests for performance improvements will probably not be accepted either, as this "reference implementation" tries to be as easy to read as possible.

Tools

Implementations & Bindings of QOI

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
  • SAIL image decoding library, supports decoding and encoding QOI images
  • Orx 2D game engine, supports QOI natively
  • IrfanView supports decoding and encoding QOI through its Formats plugin
  • ImageMagick supports decoding and encoding QOI, since 7.1.0-20
  • barebox bootloader, supports decoding QOI images for splash logo, since v2022.03.0
  • KorGE & KorIM Kotlin 2D game engine and imaging library, supports decoding and encoding QOI natively since 2.7.0
  • DOjS DOS JavaScript Canvas implementation supports loading QOI files
  • XnView MP supports decoding QOI since 1.00

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.