SgiImagePlugin.py 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. #
  2. # The Python Imaging Library.
  3. # $Id$
  4. #
  5. # SGI image file handling
  6. #
  7. # See "The SGI Image File Format (Draft version 0.97)", Paul Haeberli.
  8. # <ftp://ftp.sgi.com/graphics/SGIIMAGESPEC>
  9. #
  10. #
  11. # History:
  12. # 2017-22-07 mb Add RLE decompression
  13. # 2016-16-10 mb Add save method without compression
  14. # 1995-09-10 fl Created
  15. #
  16. # Copyright (c) 2016 by Mickael Bonfill.
  17. # Copyright (c) 2008 by Karsten Hiddemann.
  18. # Copyright (c) 1997 by Secret Labs AB.
  19. # Copyright (c) 1995 by Fredrik Lundh.
  20. #
  21. # See the README file for information on usage and redistribution.
  22. #
  23. from __future__ import annotations
  24. import os
  25. import struct
  26. from typing import IO
  27. from . import Image, ImageFile
  28. from ._binary import i16be as i16
  29. from ._binary import o8
  30. def _accept(prefix: bytes) -> bool:
  31. return len(prefix) >= 2 and i16(prefix) == 474
  32. MODES = {
  33. (1, 1, 1): "L",
  34. (1, 2, 1): "L",
  35. (2, 1, 1): "L;16B",
  36. (2, 2, 1): "L;16B",
  37. (1, 3, 3): "RGB",
  38. (2, 3, 3): "RGB;16B",
  39. (1, 3, 4): "RGBA",
  40. (2, 3, 4): "RGBA;16B",
  41. }
  42. ##
  43. # Image plugin for SGI images.
  44. class SgiImageFile(ImageFile.ImageFile):
  45. format = "SGI"
  46. format_description = "SGI Image File Format"
  47. def _open(self) -> None:
  48. # HEAD
  49. assert self.fp is not None
  50. headlen = 512
  51. s = self.fp.read(headlen)
  52. if not _accept(s):
  53. msg = "Not an SGI image file"
  54. raise ValueError(msg)
  55. # compression : verbatim or RLE
  56. compression = s[2]
  57. # bpc : 1 or 2 bytes (8bits or 16bits)
  58. bpc = s[3]
  59. # dimension : 1, 2 or 3 (depending on xsize, ysize and zsize)
  60. dimension = i16(s, 4)
  61. # xsize : width
  62. xsize = i16(s, 6)
  63. # ysize : height
  64. ysize = i16(s, 8)
  65. # zsize : channels count
  66. zsize = i16(s, 10)
  67. # layout
  68. layout = bpc, dimension, zsize
  69. # determine mode from bits/zsize
  70. rawmode = ""
  71. try:
  72. rawmode = MODES[layout]
  73. except KeyError:
  74. pass
  75. if rawmode == "":
  76. msg = "Unsupported SGI image mode"
  77. raise ValueError(msg)
  78. self._size = xsize, ysize
  79. self._mode = rawmode.split(";")[0]
  80. if self.mode == "RGB":
  81. self.custom_mimetype = "image/rgb"
  82. # orientation -1 : scanlines begins at the bottom-left corner
  83. orientation = -1
  84. # decoder info
  85. if compression == 0:
  86. pagesize = xsize * ysize * bpc
  87. if bpc == 2:
  88. self.tile = [
  89. ImageFile._Tile(
  90. "SGI16",
  91. (0, 0) + self.size,
  92. headlen,
  93. (self.mode, 0, orientation),
  94. )
  95. ]
  96. else:
  97. self.tile = []
  98. offset = headlen
  99. for layer in self.mode:
  100. self.tile.append(
  101. ImageFile._Tile(
  102. "raw", (0, 0) + self.size, offset, (layer, 0, orientation)
  103. )
  104. )
  105. offset += pagesize
  106. elif compression == 1:
  107. self.tile = [
  108. ImageFile._Tile(
  109. "sgi_rle", (0, 0) + self.size, headlen, (rawmode, orientation, bpc)
  110. )
  111. ]
  112. def _save(im: Image.Image, fp: IO[bytes], filename: str | bytes) -> None:
  113. if im.mode not in {"RGB", "RGBA", "L"}:
  114. msg = "Unsupported SGI image mode"
  115. raise ValueError(msg)
  116. # Get the keyword arguments
  117. info = im.encoderinfo
  118. # Byte-per-pixel precision, 1 = 8bits per pixel
  119. bpc = info.get("bpc", 1)
  120. if bpc not in (1, 2):
  121. msg = "Unsupported number of bytes per pixel"
  122. raise ValueError(msg)
  123. # Flip the image, since the origin of SGI file is the bottom-left corner
  124. orientation = -1
  125. # Define the file as SGI File Format
  126. magic_number = 474
  127. # Run-Length Encoding Compression - Unsupported at this time
  128. rle = 0
  129. # Number of dimensions (x,y,z)
  130. dim = 3
  131. # X Dimension = width / Y Dimension = height
  132. x, y = im.size
  133. if im.mode == "L" and y == 1:
  134. dim = 1
  135. elif im.mode == "L":
  136. dim = 2
  137. # Z Dimension: Number of channels
  138. z = len(im.mode)
  139. if dim in {1, 2}:
  140. z = 1
  141. # assert we've got the right number of bands.
  142. if len(im.getbands()) != z:
  143. msg = f"incorrect number of bands in SGI write: {z} vs {len(im.getbands())}"
  144. raise ValueError(msg)
  145. # Minimum Byte value
  146. pinmin = 0
  147. # Maximum Byte value (255 = 8bits per pixel)
  148. pinmax = 255
  149. # Image name (79 characters max, truncated below in write)
  150. img_name = os.path.splitext(os.path.basename(filename))[0]
  151. if isinstance(img_name, str):
  152. img_name = img_name.encode("ascii", "ignore")
  153. # Standard representation of pixel in the file
  154. colormap = 0
  155. fp.write(struct.pack(">h", magic_number))
  156. fp.write(o8(rle))
  157. fp.write(o8(bpc))
  158. fp.write(struct.pack(">H", dim))
  159. fp.write(struct.pack(">H", x))
  160. fp.write(struct.pack(">H", y))
  161. fp.write(struct.pack(">H", z))
  162. fp.write(struct.pack(">l", pinmin))
  163. fp.write(struct.pack(">l", pinmax))
  164. fp.write(struct.pack("4s", b"")) # dummy
  165. fp.write(struct.pack("79s", img_name)) # truncates to 79 chars
  166. fp.write(struct.pack("s", b"")) # force null byte after img_name
  167. fp.write(struct.pack(">l", colormap))
  168. fp.write(struct.pack("404s", b"")) # dummy
  169. rawmode = "L"
  170. if bpc == 2:
  171. rawmode = "L;16B"
  172. for channel in im.split():
  173. fp.write(channel.tobytes("raw", rawmode, 0, orientation))
  174. if hasattr(fp, "flush"):
  175. fp.flush()
  176. class SGI16Decoder(ImageFile.PyDecoder):
  177. _pulls_fd = True
  178. def decode(self, buffer: bytes | Image.SupportsArrayInterface) -> tuple[int, int]:
  179. assert self.fd is not None
  180. assert self.im is not None
  181. rawmode, stride, orientation = self.args
  182. pagesize = self.state.xsize * self.state.ysize
  183. zsize = len(self.mode)
  184. self.fd.seek(512)
  185. for band in range(zsize):
  186. channel = Image.new("L", (self.state.xsize, self.state.ysize))
  187. channel.frombytes(
  188. self.fd.read(2 * pagesize), "raw", "L;16B", stride, orientation
  189. )
  190. self.im.putband(channel.im, band)
  191. return -1, 0
  192. #
  193. # registry
  194. Image.register_decoder("SGI16", SGI16Decoder)
  195. Image.register_open(SgiImageFile.format, SgiImageFile, _accept)
  196. Image.register_save(SgiImageFile.format, _save)
  197. Image.register_mime(SgiImageFile.format, "image/sgi")
  198. Image.register_extensions(SgiImageFile.format, [".bw", ".rgb", ".rgba", ".sgi"])
  199. # End of file