Awesome

Mini QOI (abbreviated mQOI) is a streaming QOI decoder, designed for embedded systems with very little RAM.

It sucessfully decoded all of the QOI test images posted on the QOI website, with no errors. As far as I know, that means it's compatible with the format!

Why choose mQOI?

• It bypasses the 400MP limit of the reference decoder!
• It requires no dynamic memory allocation!
• It only needs about 300 bytes of RAM while decoding an image!
• It supports decoding an incoming QOI stream byte-by-byte!

If you're making an embedded app that makes use of the .qoi format and need a simple decoder, this is for you!

Why not choose mQOI?

• It's probably slightly slower than the reference codec.
• It doesn't support encoding (yet)

If you're making an application that needs the fastest decoder available, this likely isn't for you.

Performance testing

Here's some performance data from testing on the QOI logo, a 448x220 pixel image.

For simple images like the QOI logo, the compression ratio is about 1:20! Without compression, the logo would be 394 kB, which wouldn't even fit in the flash memory of the UNO.

Example build instructions

To build the example decoding app, use CMake:

cd examples/cmdline_decoder
mkdir build
cd build
cmake ..
cmake --build .

Now the examples/build directory should contain mqoi_decoder, a simple app that decodes a .qoi image and stores it as a file in the RGBA8 format.

Minimal code example

This is a minimal example with no error handling. Assume that get_next_byte() is a function that returns the next byte in the QOI file.

#include "mini_qoi.h"

// image metadata decoding

mqoi_desc_t img_desc;
uint32_t img_w, img_h;

mqoi_desc_init(&img_desc); // initialize the image descriptor object

while (!mqoi_desc_done(&img_desc)) { // while the image descriptor isn't complete,
    mqoi_desc_push(&img_desc, get_next_byte()); // read one byte and push it to the image descriptor 
}

mqoi_desc_verify(&img_desc, &img_w, &img_h); // read the image width and height

// image decoding

mqoi_dec_t dec;
mqoi_rgba_t * px;

mqoi_dec_init(&dec, img_w * img_h);

while (!mqoi_dec_done(&dec)) {
    mqoi_dec_push(&dec, get_next_byte()); // read one byte and push it to the image decoder 

    while ((px = mqoi_dec_pop(&dec)) != NULL) { // as long as the decoder has pixels to read
        // do whatever you want with the pixel here
        // remember that it's a pointer to a pixel!
    }
}

// done!