Brule

Collection of C extension modules for SUPer with pure-python fallbacks

• Brule: Bitmap RUn LEngth coder and decoder.
• LayoutEngine: An optimal two-rects layout finder for a sequence of images.
• HexTree: RGBA image quantizer.

Brule brief

Brule implements 2 or 3 times the same function, and select the fastest implementation available at runtime.

• C (fastest)
• numba (fast - implemented only for the RLE codec)
• pure Python (slow)

For the encoder, the C implementation is up to 20 times faster than numba. The pure Python implementation does not compete and is only there for convenience.

Install

Given ./brule the (cloned) repository:

$ python -m pip install ./brule

Example (RLE Codec)

The run-length codec is operated like this:

>>> from brule import Brule
>>> import numpy as np
>>> bitmap_orig = np.ones((1080, 1920), np.uint8)
>>> rle_data = Brule.encode(bitmap_orig)
>>> bitmap = Brule.decode(rle_data)
>>> assert np.all(bitmap == bitmap_orig)
True

Example (HexTree)

The image quantizer is used like this:

>>> from brule import HexTree
>>> import numpy as np
>>> from PIL import Image
>>> rgba = np.asarray(Image.open(...).convert('RGBA'))
>>> #quantize with 255 colours 
>>> bitmap, palette = HexTree.quantize(rgba, 255)

Credits

• https://github.com/pallets/markupsafe markupsafe for the pip install fallback mechanism with compiled extensions.