PsdImagePlugin.py 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. #
  2. # The Python Imaging Library
  3. # $Id$
  4. #
  5. # Adobe PSD 2.5/3.0 file handling
  6. #
  7. # History:
  8. # 1995-09-01 fl Created
  9. # 1997-01-03 fl Read most PSD images
  10. # 1997-01-18 fl Fixed P and CMYK support
  11. # 2001-10-21 fl Added seek/tell support (for layers)
  12. #
  13. # Copyright (c) 1997-2001 by Secret Labs AB.
  14. # Copyright (c) 1995-2001 by Fredrik Lundh
  15. #
  16. # See the README file for information on usage and redistribution.
  17. #
  18. from __future__ import annotations
  19. import io
  20. from functools import cached_property
  21. from typing import IO
  22. from . import Image, ImageFile, ImagePalette
  23. from ._binary import i8
  24. from ._binary import i16be as i16
  25. from ._binary import i32be as i32
  26. from ._binary import si16be as si16
  27. from ._binary import si32be as si32
  28. from ._util import DeferredError
  29. MODES = {
  30. # (photoshop mode, bits) -> (pil mode, required channels)
  31. (0, 1): ("1", 1),
  32. (0, 8): ("L", 1),
  33. (1, 8): ("L", 1),
  34. (2, 8): ("P", 1),
  35. (3, 8): ("RGB", 3),
  36. (4, 8): ("CMYK", 4),
  37. (7, 8): ("L", 1), # FIXME: multilayer
  38. (8, 8): ("L", 1), # duotone
  39. (9, 8): ("LAB", 3),
  40. }
  41. # --------------------------------------------------------------------.
  42. # read PSD images
  43. def _accept(prefix: bytes) -> bool:
  44. return prefix.startswith(b"8BPS")
  45. ##
  46. # Image plugin for Photoshop images.
  47. class PsdImageFile(ImageFile.ImageFile):
  48. format = "PSD"
  49. format_description = "Adobe Photoshop"
  50. _close_exclusive_fp_after_loading = False
  51. def _open(self) -> None:
  52. assert self.fp is not None
  53. read = self.fp.read
  54. #
  55. # header
  56. s = read(26)
  57. if not _accept(s) or i16(s, 4) != 1:
  58. msg = "not a PSD file"
  59. raise SyntaxError(msg)
  60. psd_bits = i16(s, 22)
  61. psd_channels = i16(s, 12)
  62. psd_mode = i16(s, 24)
  63. mode, channels = MODES[(psd_mode, psd_bits)]
  64. if channels > psd_channels:
  65. msg = "not enough channels"
  66. raise OSError(msg)
  67. if mode == "RGB" and psd_channels == 4:
  68. mode = "RGBA"
  69. channels = 4
  70. self._mode = mode
  71. self._size = i32(s, 18), i32(s, 14)
  72. #
  73. # color mode data
  74. size = i32(read(4))
  75. if size:
  76. data = read(size)
  77. if mode == "P" and size == 768:
  78. self.palette = ImagePalette.raw("RGB;L", data)
  79. #
  80. # image resources
  81. self.resources = []
  82. size = i32(read(4))
  83. if size:
  84. # load resources
  85. end = self.fp.tell() + size
  86. while self.fp.tell() < end:
  87. read(4) # signature
  88. id = i16(read(2))
  89. name = read(i8(read(1)))
  90. if not (len(name) & 1):
  91. read(1) # padding
  92. data = read(i32(read(4)))
  93. if len(data) & 1:
  94. read(1) # padding
  95. self.resources.append((id, name, data))
  96. if id == 1039: # ICC profile
  97. self.info["icc_profile"] = data
  98. #
  99. # layer and mask information
  100. self._layers_position = None
  101. size = i32(read(4))
  102. if size:
  103. end = self.fp.tell() + size
  104. size = i32(read(4))
  105. if size:
  106. self._layers_position = self.fp.tell()
  107. self._layers_size = size
  108. self.fp.seek(end)
  109. self._n_frames: int | None = None
  110. #
  111. # image descriptor
  112. self.tile = _maketile(self.fp, mode, (0, 0) + self.size, channels)
  113. # keep the file open
  114. self._fp = self.fp
  115. self.frame = 1
  116. self._min_frame = 1
  117. @cached_property
  118. def layers(
  119. self,
  120. ) -> list[tuple[str, str, tuple[int, int, int, int], list[ImageFile._Tile]]]:
  121. layers = []
  122. if self._layers_position is not None:
  123. if isinstance(self._fp, DeferredError):
  124. raise self._fp.ex
  125. self._fp.seek(self._layers_position)
  126. _layer_data = io.BytesIO(ImageFile._safe_read(self._fp, self._layers_size))
  127. layers = _layerinfo(_layer_data, self._layers_size)
  128. self._n_frames = len(layers)
  129. return layers
  130. @property
  131. def n_frames(self) -> int:
  132. if self._n_frames is None:
  133. self._n_frames = len(self.layers)
  134. return self._n_frames
  135. @property
  136. def is_animated(self) -> bool:
  137. return len(self.layers) > 1
  138. def seek(self, layer: int) -> None:
  139. if not self._seek_check(layer):
  140. return
  141. if isinstance(self._fp, DeferredError):
  142. raise self._fp.ex
  143. # seek to given layer (1..max)
  144. _, mode, _, tile = self.layers[layer - 1]
  145. self._mode = mode
  146. self.tile = tile
  147. self.frame = layer
  148. self.fp = self._fp
  149. def tell(self) -> int:
  150. # return layer number (0=image, 1..max=layers)
  151. return self.frame
  152. def _layerinfo(
  153. fp: IO[bytes], ct_bytes: int
  154. ) -> list[tuple[str, str, tuple[int, int, int, int], list[ImageFile._Tile]]]:
  155. # read layerinfo block
  156. layers = []
  157. def read(size: int) -> bytes:
  158. return ImageFile._safe_read(fp, size)
  159. ct = si16(read(2))
  160. # sanity check
  161. if ct_bytes < (abs(ct) * 20):
  162. msg = "Layer block too short for number of layers requested"
  163. raise SyntaxError(msg)
  164. for _ in range(abs(ct)):
  165. # bounding box
  166. y0 = si32(read(4))
  167. x0 = si32(read(4))
  168. y1 = si32(read(4))
  169. x1 = si32(read(4))
  170. # image info
  171. bands = []
  172. ct_types = i16(read(2))
  173. if ct_types > 4:
  174. fp.seek(ct_types * 6 + 12, io.SEEK_CUR)
  175. size = i32(read(4))
  176. fp.seek(size, io.SEEK_CUR)
  177. continue
  178. for _ in range(ct_types):
  179. type = i16(read(2))
  180. if type == 65535:
  181. b = "A"
  182. else:
  183. b = "RGBA"[type]
  184. bands.append(b)
  185. read(4) # size
  186. # figure out the image mode
  187. bands.sort()
  188. if bands == ["R"]:
  189. mode = "L"
  190. elif bands == ["B", "G", "R"]:
  191. mode = "RGB"
  192. elif bands == ["A", "B", "G", "R"]:
  193. mode = "RGBA"
  194. else:
  195. mode = "" # unknown
  196. # skip over blend flags and extra information
  197. read(12) # filler
  198. name = ""
  199. size = i32(read(4)) # length of the extra data field
  200. if size:
  201. data_end = fp.tell() + size
  202. length = i32(read(4))
  203. if length:
  204. fp.seek(length - 16, io.SEEK_CUR)
  205. length = i32(read(4))
  206. if length:
  207. fp.seek(length, io.SEEK_CUR)
  208. length = i8(read(1))
  209. if length:
  210. # Don't know the proper encoding,
  211. # Latin-1 should be a good guess
  212. name = read(length).decode("latin-1", "replace")
  213. fp.seek(data_end)
  214. layers.append((name, mode, (x0, y0, x1, y1)))
  215. # get tiles
  216. layerinfo = []
  217. for i, (name, mode, bbox) in enumerate(layers):
  218. tile = []
  219. for m in mode:
  220. t = _maketile(fp, m, bbox, 1)
  221. if t:
  222. tile.extend(t)
  223. layerinfo.append((name, mode, bbox, tile))
  224. return layerinfo
  225. def _maketile(
  226. file: IO[bytes], mode: str, bbox: tuple[int, int, int, int], channels: int
  227. ) -> list[ImageFile._Tile]:
  228. tiles = []
  229. read = file.read
  230. compression = i16(read(2))
  231. xsize = bbox[2] - bbox[0]
  232. ysize = bbox[3] - bbox[1]
  233. offset = file.tell()
  234. if compression == 0:
  235. #
  236. # raw compression
  237. for channel in range(channels):
  238. layer = mode[channel]
  239. if mode == "CMYK":
  240. layer += ";I"
  241. tiles.append(ImageFile._Tile("raw", bbox, offset, layer))
  242. offset = offset + xsize * ysize
  243. elif compression == 1:
  244. #
  245. # packbits compression
  246. i = 0
  247. bytecount = read(channels * ysize * 2)
  248. offset = file.tell()
  249. for channel in range(channels):
  250. layer = mode[channel]
  251. if mode == "CMYK":
  252. layer += ";I"
  253. tiles.append(ImageFile._Tile("packbits", bbox, offset, layer))
  254. for y in range(ysize):
  255. offset = offset + i16(bytecount, i)
  256. i += 2
  257. file.seek(offset)
  258. if offset & 1:
  259. read(1) # padding
  260. return tiles
  261. # --------------------------------------------------------------------
  262. # registry
  263. Image.register_open(PsdImageFile.format, PsdImageFile, _accept)
  264. Image.register_extension(PsdImageFile.format, ".psd")
  265. Image.register_mime(PsdImageFile.format, "image/vnd.adobe.photoshop")