1  # The MIT License (MIT)
 2  #
 3  # Copyright (c) 2018 Scott Shawcroft for Adafruit Industries LLC
 4  #
 5  # Permission is hereby granted, free of charge, to any person obtaining a copy
 6  # of this software and associated documentation files (the "Software"), to deal
 7  # in the Software without restriction, including without limitation the rights
 8  # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9  # copies of the Software, and to permit persons to whom the Software is
10  # furnished to do so, subject to the following conditions:
11  #
12  # The above copyright notice and this permission notice shall be included in
13  # all copies or substantial portions of the Software.
14  #
15  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  # THE SOFTWARE.
22  """
23  `adafruit_imageload`
24  ====================================================
25  
26  Load pixel values (indices or colors) into a bitmap and colors into a palette.
27  
28  * Author(s): Scott Shawcroft
29  
30  """
31  # pylint: disable=import-outside-toplevel
32  
33  __version__ = "0.0.0-auto.0"
34  __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad.git"
35  
36  
37  def load(filename, *, bitmap=None, palette=None):
38      """Load pixel values (indices or colors) into a bitmap and colors into a palette.
39  
40         bitmap is the desired type. It must take width, height and color_depth in the constructor. It
41         must also have a _load_row method to load a row's worth of pixel data.
42  
43         palette is the desired pallete type. The constructor should take the number of colors and
44         support assignment to indices via [].
45      """
46      if not bitmap or not palette:
47          try:
48              # use displayio if available
49              import displayio
50  
51              if not bitmap:
52                  bitmap = displayio.Bitmap
53              if not palette:
54                  palette = displayio.Palette
55          except ModuleNotFoundError:
56              # meh, we tried
57              pass
58  
59      with open(filename, "rb") as file:
60          header = file.read(3)
61          file.seek(0)
62          if header.startswith(b"BM"):
63              from . import bmp
64  
65              return bmp.load(file, bitmap=bitmap, palette=palette)
66          if header.startswith(b"P"):
67              from . import pnm
68  
69              return pnm.load(file, header, bitmap=bitmap, palette=palette)
70          if header.startswith(b"GIF"):
71              from . import gif
72  
73              return gif.load(file, bitmap=bitmap, palette=palette)
74          raise RuntimeError("Unsupported image format")