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