~ruther/qmk_firmware

ref: 7bd1d18427dd3a4fd5f72c8a88a022beeb53273b qmk_firmware/docs/quantum_painter_rle.md -rw-r--r-- 879 bytes
7bd1d184 — Drashna Jaelre [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) 2 years ago

#QMK QGF/QFF RLE data schema :id=qmk-qp-rle-schema

There are two "modes" to the RLE algorithm used in both QGF/QFF:

  • Non-repeating sections of octets, with associated length of up to 128 octets
    • length = marker - 128
    • A corresponding length number of octets follow directly after the marker octet
  • Repeated octet with associated length, with associated length of up to 128
    • length = marker
    • A single octet follows the marker that should be repeated length times.

Decoder pseudocode:

while !EOF
    marker = READ_OCTET()

    if marker >= 128
        length = marker - 128
        for i = 0 ... length-1
            c = READ_OCTET()
            WRITE_OCTET(c)

    else
        length = marker
        c = READ_OCTET()
        for i = 0 ... length-1
            WRITE_OCTET(c)