Skip to main content

Encoder and decoder for Aperture Science Image Format (apf), Aperture Science Image Format 2 (apf2), Wireless Bitmap (wbmp), Over-The-Air Bitmap (otb), and FaceDev's .bruh format

Project description

A library for converting to and from Aperture Science apf files, the custom extended apf2s, otb/wbmp images, and facedev's bruh format.

basic usage:

import apftool

apfString = apftool.encodeapf(pngObject) # turns image bytes object into apf string
pngObject = apftool.decodeapf(apfString) # turns apf string object into image bytes

additional tooling and software using apftool can be found at https://github.com/kbity/apftool, including custom MIME extensions.

funcs and features

encoders:

encodeapf(img: bytes, lineskip: int = 1, findbestlineskip: bool = False) takes image bytes and outputs apf string. lineskip is interleave value, findbestlineskip brute-forces different interleave values to the possible max of 199 and uses the smallest one.

encodeaf2(img: bytes, lineskip: int = 1, findbestlineskip: bool = False, legacy: bool = False, trans: bool = False, pal: int = 95) takes image bytes and outputs af2 string. lineskip is interleave value, findbestlineskip brute-forces different interleave values to the provided lineskip and uses the smallest one. legacy uses apf1-style 1 color data instead of a 95 color palette. trans enables/disables transparency, which overrides a color. pal allows you to manually force a smaller palette.

encodewbmp(img: Image) takes pil image object and outputs wbmp bytes

encodeotab(img: Image, width=255, height=255) takes pil image object and outputs otb bytes. max size is 255x255. the size input is max size, the output may be smaller

encodebruh(img: Image) takes pil image object and outputs bruh bytes

decoders:

decodeany(data, format: str = 'PNG', returnImageObject: bool = False) takes in string or bytes and outputs bytes image or PIL image using best-guess for the decoders

decodeapf(apf: str, format: str = 'PNG', returnImageObject: bool = False) takes apf string and outputs either image bytes in specified format or pil image object

decodeaf2(af2: str, format: str = 'PNG', returnImageObject: bool = False) hi i am the same thing, i am literally a dropin replacement for decodeapf too

decodewbmp(wbmp: bytes, format: str = 'PNG', returnImageObject: bool = False) takes wbmp bytes and outputs either image bytes in specified format or pil image object

decodeotab(otab: bytes, format: str = 'PNG', returnImageObject: bool = False) hi i have the same usage as decodewbmp but for .otb images

decodebruh(bruh: bytes, format: str = 'PNG', returnImageObject: bool = False) bruh decoder, acts the same as the others.

misc:

apftool provides many extensions tuples:

extensions - apf/apf2 extensions

extensions_apf - apf extensions

extensions_apf2 - apf2 extensions

extensions_wbmp - wbmp extensions

extensions_otab - otb extensions

extensions_bruh - bruh extensions

extensions_txt - txt extensions, useful for weeding out generic apf

extensions_all - all supported apftool extensions, useful for decodeany

dependancies

PIL (pillow) is required

numpy and scikit-learn are needed for high-speed APF2-1994 257+ Color Encoding, if missing the code will use a very slow fallback.

changelog:

0.5.5 - implement apf2-1994 encoding and decoding

0.5.2 - add bruh heristic to decodeany

0.5.1 - attempt to fix bruh resolution parsing issue

0.5.0 - add bruh encoder and decoder

0.4.3 - actually improve otb quality

0.4.2 - did not improve otb quality

0.4.1 - improve readme.md, fix otb encoder skuing due to flushing

0.4.0 - add support for otb images, improve readme.md, and add decodeany to decode all suported formats automatically

0.3.3 - make the af2 decoder more lenient

0.3.2 - i forgot but i think it made the af2 decoder more lenient

0.3.1 - fix 0.3.0

0.3.0 - add support for wbmp images, broken release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apftool-0.5.5.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apftool-0.5.5-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file apftool-0.5.5.tar.gz.

File metadata

  • Download URL: apftool-0.5.5.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for apftool-0.5.5.tar.gz
Algorithm Hash digest
SHA256 59825f6ac6888be3665c272b2fb9d37691c117e1ea0f8e1d7f991ac4099033a1
MD5 68d8e99e9ae6f2f43c593a2ddfe8100c
BLAKE2b-256 c28641f2429565f5b871dbe86e566141dd73e0e717c1a299856efec0e43c2af3

See more details on using hashes here.

File details

Details for the file apftool-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: apftool-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for apftool-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 92d1eefca2ca3da786d4188de21ec4bf53db023680104480da558b916462f233
MD5 aff3063540a25d2a27a3644e2f8080e0
BLAKE2b-256 c1de9d795cc09364636bd19b26518d0778a63168fa293acdb653c8378c5bfc82

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page