Working P1-P6 formats

.gitignore

@@ -4,3 +4,7 @@ _build
 .env
 build*
 bundles
+.idea/
+venv/
+
+.vscode

.pylintrc

@@ -7,7 +7,7 @@ extension-pkg-whitelist=
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS
+ignore=CVS,adafruit_imageload/tests
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.

.travis.yml

@@ -27,6 +27,7 @@ install:
   - pip install --force-reinstall pylint==1.9.2
 
 script:
+  - pytest adafruit_imageload
   - pylint adafruit_imageload/**
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-imageload --library_location .

adafruit_imageload/__init__.py

@@ -43,8 +43,11 @@ def load(filename, *, bitmap=None, palette=None):
     """
     with open(filename, "rb") as file:
         header = file.read(3)
+        file.seek(0)
         if header.startswith(b"BM"):
             from . import bmp
-            file.seek(0)
             return bmp.load(file, bitmap=bitmap, palette=palette)
+        if header.startswith(b"P"):
+            from . import pnm
+            return pnm.load(file, header, bitmap=bitmap, palette=palette)
         raise RuntimeError("Unsupported image format")

adafruit_imageload/pnm/__init__.py

@@ -0,0 +1,111 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_imageload.pnm`
+====================================================
+
+Load pixel values (indices or colors) into a bitmap and colors into a palette.
+
+* Author(s): Matt Land, Brooke Storm, Sam McGahan
+
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad.git"
+
+
+def load(file, header, *, bitmap=None, palette=None):
+    """
+    Scan for netpbm format info, skip over comments, and and delegate to a submodule
+    to do the actual data loading.
+    Formats P1, P4 have two space padded pieces of information: width and height.
+    All other formats have three: width, height, and max color value.
+    """
+    magic_number = header[:2]
+    file.seek(2)
+    pnm_header = []
+    while True:
+        # We have all we need at length 3 for formats P2, P3, P5, P6
+        if len(pnm_header) == 3:
+            break
+        if len(pnm_header) == 2 and magic_number in [b"P1", b"P4"]:
+            bitmap = bitmap(pnm_header[0], pnm_header[1], 1)
+            if palette:
+                palette = palette(1)
+                palette[0] = b"\xFF\xFF\xFF"
+            if magic_number.startswith(b"P1"):
+                from . import pbm_ascii
+
+                return pbm_ascii.load(
+                    file, pnm_header[0], pnm_header[1], bitmap=bitmap, palette=palette
+                )
+
+            from . import pbm_binary
+
+            return pbm_binary.load(
+                file, pnm_header[0], pnm_header[1], bitmap=bitmap, palette=palette
+            )
+
+        next_byte = file.read(1)
+        if next_byte == b"#":
+            while True:
+                next_byte = file.read(1)
+                if not next_byte:
+                    raise RuntimeError("Unsupported image format")
+                if next_byte == b"\n":
+                    break
+        if next_byte.isdigit():
+            value = bytearray()
+            while True:
+                if not next_byte.isdigit():
+                    break
+                value += next_byte
+                next_byte = file.read(1)
+                if not next_byte:
+                    raise RuntimeError("Unsupported image format")
+
+            pnm_header.append(int("".join(["%c" % char for char in value])))
+            continue
+
+        if not next_byte:
+            raise RuntimeError("Unsupported image format")
+
+    if magic_number in [b"P2", b"P5"]:
+        from . import pgm
+
+        return pgm.load(file, magic_number, pnm_header, bitmap=bitmap, palette=palette)
+
+    if magic_number == b"P3":
+        from . import ppm_ascii
+
+        return ppm_ascii.load(
+            file, pnm_header[0], pnm_header[1], bitmap=bitmap, palette=palette
+        )
+
+    if magic_number == b"P6":
+        from . import ppm_binary
+
+        return ppm_binary.load(
+            file, pnm_header[0], pnm_header[1], bitmap=bitmap, palette=palette
+        )
+
+    raise RuntimeError("Unsupported image format {}".format(magic_number))

adafruit_imageload/pnm/pbm_ascii.py

@@ -0,0 +1,52 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_imageload.pnm.pbm_ascii`
+====================================================
+
+Load pixel values (indices or colors) into a bitmap and for an ascii ppm,
+return None for pallet.
+
+* Author(s):  Matt Land, Brooke Storm, Sam McGahan
+
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad.git"
+
+
+def load(file, width, height, bitmap=None, palette=None):
+    """
+    Load a P1 'PBM' ascii image into the displayio.Bitmap
+    """
+    next_byte = True
+    for y in range(height):
+        x = 0
+        while next_byte:
+            next_byte = file.read(1)
+            if not next_byte.isdigit():
+                continue
+            bitmap[x, y] = 1 if next_byte == b"1" else 0
+            if x == width - 1:
+                break
+            x += 1
+    return bitmap, palette

adafruit_imageload/pnm/pbm_binary.py

@@ -0,0 +1,63 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_imageload.pnm.pbm_binary`
+====================================================
+
+Load pixel values (indices or colors) into a bitmap and for an ascii ppm,
+return None for pallet.
+
+* Author(s):  Matt Land, Brooke Storm, Sam McGahan
+
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad.git"
+
+
+def load(file, width, height, bitmap=None, palette=None):
+    """
+    Load a P4 'PBM' binary image into the displayio.Bitmap
+    """
+    x = 0
+    y = 0
+    while True:
+        next_byte = file.read(1)
+        if not next_byte:
+            break  # out of bits
+        for bit in iterbits(int.from_bytes(next_byte, "little")):
+            bitmap[x, y] = bit
+            x += 1
+            if x > width - 1:
+                y += 1
+                x = 0
+            if y > height - 1:
+                break
+    return bitmap, palette
+
+
+def iterbits(b):
+    """
+    generator to iterate over the bits in a byte (character)
+    """
+    for i in range(8):
+        yield (b >> i) & 1

adafruit_imageload/pnm/pgm/__init__.py

@@ -0,0 +1,50 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_imageload.pnm.pgm`
+====================================================
+
+Load pixel values (indices or colors) into a bitmap and colors into a palette.
+
+* Author(s): Matt Land, Brooke Storm, Sam McGahan
+
+"""
+
+
+def load(file, magic_number, header, *, bitmap=None, palette=None):
+    """
+    Perform the load of Netpbm greyscale images (P2, P5)
+    """
+    if header[2] > 256:
+        raise NotImplementedError("16 bit files are not supported")
+    width = header[0]
+    height = header[1]
+
+    if magic_number == b"P2":  # To handle ascii PGM files.
+        from . import ascii as pgm_ascii
+        return pgm_ascii.load(file, width, height, bitmap=bitmap, palette=palette)
+
+    if magic_number == b"P5":  # To handle binary PGM files.
+        from . import binary
+        return binary.load(file, width, height, bitmap=bitmap, palette=palette)
+
+    raise NotImplementedError("Was not able to send image")

adafruit_imageload/pnm/pgm/ascii.py

@@ -0,0 +1,76 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_imageload.pnm.pgm.ascii`
+====================================================
+
+Load pixel values (indices or colors) into a bitmap and colors into a palette.
+
+* Author(s): Matt Land, Brooke Storm, Sam McGahan
+
+"""
+
+
+def load(file, width, height, bitmap=None, palette=None):
+    """
+    Load a PGM ascii file (P2)
+    """
+    data_start = file.tell()  # keep this so we can rewind
+    palette_colors = set()
+    pixel = bytearray()
+    # build a set of all colors present in the file, so palette and bitmap can be constructed
+    while True:
+        byte = file.read(1)
+        if byte == b"":
+            break
+        if not byte.isdigit():
+            int_pixel = int("".join(["%c" % char for char in pixel]))
+            palette_colors.add(int_pixel)
+            pixel = bytearray()
+        pixel += byte
+    if palette:
+        palette = build_palette(palette, palette_colors)
+    if bitmap:
+        bitmap = bitmap(width, height, len(palette_colors))
+        palette_colors = list(palette_colors)
+        file.seek(data_start)
+        for y in range(height):
+            for x in range(width):
+                pixel = bytearray()
+                while True:
+                    byte = file.read(1)
+                    if not byte.isdigit():
+                        break
+                    pixel += byte
+                int_pixel = int("".join(["%c" % char for char in pixel]))
+                bitmap[x, y] = palette_colors.index(int_pixel)
+    return bitmap, palette
+
+
+def build_palette(palette_class, palette_colors):
+    """
+    construct the Palette, and populate it with the set of palette_colors
+    """
+    palette = palette_class(len(palette_colors))
+    for counter, color in enumerate(palette_colors):
+        palette[counter] = bytes([color, color, color])
+    return palette