Skip to main content

Encoder and decoder for Aperture Science Image Format (apf), Aperture Science Image Format 2 (apf2), Wireless Bitmap (wbmp), and Over-The-Air Bitmap (otb)

Project description

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

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

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

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

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_txt - txt extensions, useful for weeding out generic apf

extensions_all - all supported apftool extensions, useful for decodeany

dependancies

PIL, io, textwrap, math (apftool)

most of these a builtins but you may need to install PIL seperately

changelog:

0.4.1 - improve otb quality

0.4.1 - improve readme.md, fix otb encoder skuing

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.4.2.tar.gz (13.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.4.2-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apftool-0.4.2.tar.gz
  • Upload date:
  • Size: 13.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.4.2.tar.gz
Algorithm Hash digest
SHA256 ee1b4ecf5643e68a9cd40f96470ec9a5b74eb607cb9aa2c6558da70ce70ffb74
MD5 b91e44ea95e8771787ac4b7137d02da6
BLAKE2b-256 444e06f5ff4f6c674d211967f2c5d9bce429d74a2ec94049337b193670ba1b1b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: apftool-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 15.9 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.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1780fcb57d42f2a90946851bedf9fbbac32481a3fc7ebafe437fcb67d238b322
MD5 a811de52fee5133c4b5711ffd597dc79
BLAKE2b-256 13e4895723aefe8c485699e474622f6e4d974e612c1ca1499cf98830a6c62551

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