apftool 0.3.2__tar.gz → 0.4.0__tar.gz

apftool-0.4.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: apftool
+Version: 0.4.0
+Summary: Encoder and decoder for Aperture Science Image Format (apf), Aperture Science Image Format 2 (apf2), Wireless Bitmap (wbmp), and Over-The-Air Bitmap (otb)
+Author: Mari (kbity)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Pillow
+Dynamic: license-file
+
+# 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
+
+## dependancies
+
+`PIL, io, textwrap, math` (apftool)
+
+most of these a builtins but you may need to install PIL seperately
+
+## changelog:
+
+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

apftool-0.4.0/README.md

@@ -0,0 +1,52 @@
+# 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
+
+## dependancies
+
+`PIL, io, textwrap, math` (apftool)
+
+most of these a builtins but you may need to install PIL seperately
+
+## changelog:
+
+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

apftool-0.4.0/apftool/__init__.py

@@ -0,0 +1,37 @@
+# apftool/__init__.py
+
+from .apftool import encodeapf, decodeapf
+from .af2tool import encodeaf2, decodeaf2
+from .wbmptool import encodewbmp, decodewbmp
+from .otabtool import encodeotab, decodeotab
+
+extensions = (".apf", ".apf2", ".aif", ".af2", ".ap2", ".aif2", ".txt", ".text")
+extensions_apf = (".apf", ".aif", ".txt", ".text")
+extensions_apf2 = (".apf2", ".af2", ".ap2", ".aif2", ".txt")
+extensions_wbmp = (".wbmp", ".wbitmap", ".wbm")
+extensions_otab = (".otb", ".ota", ".otab")
+
+extensions_txt = (".txt", ".text") # txt is seen as a generic container for apf/apf2 because they're just txt files
+extensions_all = (".apf", ".apf2", ".aif", ".af2", ".ap2", ".aif2", ".txt", ".text", ".wbmp", ".wbitmap", ".wbm", ".otb", ".ota", ".otab") # useful for decodeany
+
+def decodeany(data, format: str = 'PNG', returnImageObject: bool = False):
+
+    if isinstance(data, str):
+        return decodeaf2(data, format, returnImageObject) # apf and af2 decoder
+
+    elif isinstance(data, bytes):
+        if data.startswith(b'\x00\x00'): # type 00 wbmp header
+            return decodewbmp(data, format, returnImageObject)
+
+        elif data.startswith(b'APERTURE IMAGE FORMAT (c) '): # this makes me GLaD
+            apfX = data.decode("ascii")
+            return decodeaf2(apfX, format, returnImageObject) # yeah ok vrumbler
+
+        elif data.startswith(b'\x00'): # looser check that otbs follow
+            return decodeotab(data, format, returnImageObject) # assume otb if it doesnt look like a wbmp
+
+        else:
+            raise Exception("This is definitely not an otb or wbmp")
+
+    else:
+        raise Exception("Invalid data! Must be bytes or str")

{apftool-0.3.2 → apftool-0.4.0}/apftool/af2tool.py

@@ -13,7 +13,8 @@ def af2_apfdecodedata(data: str, h: int, w: int, apfbuffer: list, lineskip: int,
     for char in data:
         runlen = ord(char) - 32
         for i in range(runlen):
-            apfbuffer[y][x] = (state)
+            if 0 <= y < len(apfbuffer) and 0 <= x < len(apfbuffer[0]):
+                apfbuffer[y][x] = (state)
             x += 1
             if not x < w:
                 y = y - lineskip
@@ -61,7 +62,8 @@ def af2decodedata(data: str, h: int, w: int, apfbuffer: list, lineskip: int, pal
         runlen = ord(data[pair*2+1]) - 32
 
         for i in range(runlen):
-            apfbuffer[y][x] = pal[color]
+            if 0 <= y < len(apfbuffer) and 0 <= x < len(apfbuffer[0]):
+                apfbuffer[y][x] = pal[color]
 
             x += 1
             if x >= w:

{apftool-0.3.2 → apftool-0.4.0}/apftool/apftool.py

@@ -31,7 +31,8 @@ def decodeapf(apf: str, format: str = 'PNG', returnImageObject: bool = False):
     for char in data:
         runlen = ord(char) - 32
         for i in range(runlen):
-            apfbuffer[y][x] = (state)
+            if 0 <= y < len(apfbuffer) and 0 <= x < len(apfbuffer[0]):
+                apfbuffer[y][x] = (state)
             x += 1
             if not x < w:
                 y = y - lineskip

apftool-0.4.0/apftool/otabtool.py

@@ -0,0 +1,92 @@
+import io, textwrap, os, math
+from PIL import Image, ImageSequence, ImageOps
+
+def bitstring_to_bytes(s):
+    s = s.replace(" ", "")
+    s = s.replace(",", "")
+    s = s.replace("_", "")
+    return int(s, 2).to_bytes((len(s) + 7) // 8, byteorder='big')
+    
+def encodeotab(img: Image, width=255, height=255):
+    if width > 255 or height > 255:
+        raise Exception("Invalid Resolution")
+    img = img.convert("1")
+    res = img.size
+    
+    # don't upscale
+    if width > res[0]:
+        width = res[0]
+    if height > res[1]:
+        height = res[1]
+    img = img.resize((width, height))
+    
+    pixels = img.load()
+    payload = b'\x00' # type 0 hardcoded header
+    payload += width.to_bytes(1, 'big')
+    payload += height.to_bytes(1, 'big')
+    payload += b'\x01' # 1 color hardcoded header
+    print(f"header: {payload.hex()}")
+    bitmap = [[pixels[x, y] for x in range(img.width)] for y in range(img.height)]
+
+    collection = ""
+    cat = 0
+    for hline in bitmap:
+        for px in hline:
+            cat += 1
+            if px:
+                collection += "0"
+            else:
+                collection += "1"
+            if len(collection) == 8:
+                payload += bitstring_to_bytes(collection)
+                collection = ""
+            if cat == width:
+                if collection:
+                    payload += bitstring_to_bytes(collection)
+                    collection = ""
+                    cat = 0
+
+    return payload
+
+def decodeotab(otab: bytes, format: str = 'PNG', returnImageObject: bool = False):
+    w = 0
+    h = 0
+    it = 0
+    
+    headeryeah = False
+    img = None
+    for byte in otab:
+        if headeryeah:
+            for p in range(0, 8):
+                bit = (byte >> (7 - p)) & 1
+                x = it % w
+                y = it // w
+                if 0 <= x < w and 0 <= y < h:
+                    pixels[x, y] = not bit
+                it += 1
+        else:
+            it += 1
+            if it == 1:
+                if not byte == 0:
+                    raise Exception("Invalid or unsupported Otb!")
+            elif w == 0:
+                w = byte
+            elif h == 0:
+                h = byte
+                img = Image.new("1", (w, h))
+                pixels = img.load()
+            elif it == 4:
+                if byte != 1:
+                    raise Exception("Invalid or unsupported Otb!")
+                else:
+                    headeryeah = True
+                    it = 0
+                    
+    if returnImageObject:
+        return img
+    else:
+        imageData = io.BytesIO()
+        img.save(imageData, format=format)
+        imageData = imageData.getvalue()
+        return imageData
+

apftool-0.4.0/apftool/test.py

@@ -0,0 +1,85 @@
+from otabtool import encodeotab
+import io
+from PIL import Image
+
+# apf
+# the following is an example of usage of the decoder. it expects a string as an input, outputs a bytes image.
+#file_path = 'input.apf'
+#with open(file_path, 'r') as f:
+#    file_content = f.read()
+#decodedapf = decodeapf(file_content)
+#with open("output.png", "wb") as f:
+#    f.write(decodedapf)
+
+# the following is an example of usage of the encoder. it expects a bytes image as an input, outputs a string.
+#file_path = 'output.png'
+#with open(file_path, "rb") as f:
+#    data = io.BytesIO()
+#    data = f.read()
+
+#encodedapf = encodeapf(data, 3, True)
+#with open("output.apf", "w") as f:
+#    f.write(encodedapf)
+
+
+
+# af2
+# the following is an example of usage of the decoder. it expects a string as an input, outputs a bytes image.
+#file_path = 'input.af2'
+#with open(file_path, 'r') as f:
+#    file_content = f.read()
+#decodedapf = decodeaf2(file_content, 'PNG')
+#with open("output.png", "wb") as f:
+#    f.write(decodedapf)
+
+# the following is an example of usage of the encoder. it expects a bytes image as an input, outputs a string.
+#file_path = 'input.png'
+#with open(file_path, "rb") as f:
+#    data = io.BytesIO()
+#    data = f.read()
+
+#encodedapf = encodeaf2(data, 9, False, False, True)
+#with open("output.af2", "w") as f:
+#    f.write(encodedapf)
+
+
+
+# wbmp
+# the following is an example of usage of the decoder. it expects a string as an input, outputs a bytes image.
+#file_path = 'input.wbmp'
+#with open(file_path, 'rb') as f:
+#    file_content = f.read()
+#decodedwbmp = decodewbmp(file_content)
+#with open("output.png", "wb") as f:
+#    f.write(decodedwbmp)
+
+# the following is an example of usage of the encoder. it expects a bytes image as an input, outputs a string.
+#file_path = 'output.png'
+#with open(file_path, "rb") as f:
+#    data = io.BytesIO()
+#    data = f.read()
+
+#encodedwbmp = encodewbmp(data)
+#with open("output.wbmp", "w") as f:
+#    f.write(encodedwbmp)
+
+# otab
+# the following is an example of usage of the decoder. it expects a string as an input, outputs a bytes image.
+#file_path = 'input.otb'
+#with open(file_path, 'rb') as f:
+#    file_content = f.read()
+#decodedotab = decodeotab(file_content)
+#with open("output.png", "wb") as f:
+#    f.write(decodedotab)
+
+# the following is an example of usage of the encoder. it expects a bytes image as an input, outputs a string.
+#file_path = 'biohazzard1bbp.png'
+#with open(file_path, "rb") as f:
+#    data = io.BytesIO()
+#    data = f.read()
+#
+#image = Image.open(io.BytesIO(data))
+#encodedotab = encodeotab(image)
+#with open("output.otb", "wb") as f:
+#    f.write(encodedotab)
+

{apftool-0.3.2 → apftool-0.4.0}/apftool/wbmptool.py

@@ -42,7 +42,7 @@ def encodewbmp(img: Image):
     height = res[1]
     payload += mk_uintvar(width)
     payload += mk_uintvar(height)
-    print(f"header: {payload.hex()}")
+    #print(f"header: {payload.hex()}")
     bitmap = [[pixels[x, y] for x in range(img.width)] for y in range(img.height)]
 
     collection = ""
@@ -113,7 +113,7 @@ def decodewbmp(wbmp: bytes, format: str = 'PNG', returnImageObject: bool = False
                     pixels = img.load()
                     it = 0
     ds = w-oldw
-    print(ds)
+    #print(ds)
     img = img.crop((0,0,oldw,h))
 
     if returnImageObject:

apftool-0.4.0/apftool.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: apftool
+Version: 0.4.0
+Summary: Encoder and decoder for Aperture Science Image Format (apf), Aperture Science Image Format 2 (apf2), Wireless Bitmap (wbmp), and Over-The-Air Bitmap (otb)
+Author: Mari (kbity)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Pillow
+Dynamic: license-file
+
+# 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
+
+## dependancies
+
+`PIL, io, textwrap, math` (apftool)
+
+most of these a builtins but you may need to install PIL seperately
+
+## changelog:
+
+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

{apftool-0.3.2 → apftool-0.4.0}/apftool.egg-info/SOURCES.txt

@@ -4,6 +4,8 @@ pyproject.toml
 apftool/__init__.py
 apftool/af2tool.py
 apftool/apftool.py
+apftool/otabtool.py
+apftool/test.py
 apftool/wbmptool.py
 apftool.egg-info/PKG-INFO
 apftool.egg-info/SOURCES.txt

{apftool-0.3.2 → apftool-0.4.0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "apftool"
-version = "0.3.2"
-description = "Aperture Science Image Format (apf) encoder and decoder"
+version = "0.4.0"
+description = "Encoder and decoder for Aperture Science Image Format (apf), Aperture Science Image Format 2 (apf2), Wireless Bitmap (wbmp), and Over-The-Air Bitmap (otb)"
 authors = [{name = "Mari (kbity)"}]
 readme = "README.md"
 requires-python = ">=3.10"

apftool-0.3.2/PKG-INFO

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: apftool
-Version: 0.3.2
-Summary: Aperture Science Image Format (apf) encoder and decoder
-Author: Mari (kbity)
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Pillow
-Dynamic: license-file
-
-A library for converting to and from Aperture Science apf files, the custom extended apf2s, and 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
-```
-
-included is a simple cli tool.
-
-usage:
-
-```
-python apfcli.py maricom.png # creates maricom.apf
-python apfcli.py maricom.apf # creates maricom.png
-```
-
-dependancies: `PIL, io` (apftool)
-
-dependancies: `sys, os, io` (apfcli)
-
-most of these a builtins but you may need to install PIL seporately

apftool-0.3.2/README.md

@@ -1,24 +0,0 @@
-A library for converting to and from Aperture Science apf files, the custom extended apf2s, and 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
-```
-
-included is a simple cli tool.
-
-usage:
-
-```
-python apfcli.py maricom.png # creates maricom.apf
-python apfcli.py maricom.apf # creates maricom.png
-```
-
-dependancies: `PIL, io` (apftool)
-
-dependancies: `sys, os, io` (apfcli)
-
-most of these a builtins but you may need to install PIL seporately

apftool-0.3.2/apftool/__init__.py

@@ -1,6 +0,0 @@
-# apftool/__init__.py
-from .apftool import encodeapf, decodeapf
-from .af2tool import encodeaf2, decodeaf2
-from .wbmptool import encodewbmp, decodewbmp
-extensions = (".apf", ".apf2", ".aif", ".af2", ".ap2", ".aif2", ".txt")
-extensions_wbmp = (".wbmp", ".wbitmap", ".wbm")

apftool-0.3.2/apftool.egg-info/PKG-INFO

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: apftool
-Version: 0.3.2
-Summary: Aperture Science Image Format (apf) encoder and decoder
-Author: Mari (kbity)
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Pillow
-Dynamic: license-file
-
-A library for converting to and from Aperture Science apf files, the custom extended apf2s, and 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
-```
-
-included is a simple cli tool.
-
-usage:
-
-```
-python apfcli.py maricom.png # creates maricom.apf
-python apfcli.py maricom.apf # creates maricom.png
-```
-
-dependancies: `PIL, io` (apftool)
-
-dependancies: `sys, os, io` (apfcli)
-
-most of these a builtins but you may need to install PIL seporately