JpegImagePlugin.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902
  1. #
  2. # The Python Imaging Library.
  3. # $Id$
  4. #
  5. # JPEG (JFIF) file handling
  6. #
  7. # See "Digital Compression and Coding of Continuous-Tone Still Images,
  8. # Part 1, Requirements and Guidelines" (CCITT T.81 / ISO 10918-1)
  9. #
  10. # History:
  11. # 1995-09-09 fl Created
  12. # 1995-09-13 fl Added full parser
  13. # 1996-03-25 fl Added hack to use the IJG command line utilities
  14. # 1996-05-05 fl Workaround Photoshop 2.5 CMYK polarity bug
  15. # 1996-05-28 fl Added draft support, JFIF version (0.1)
  16. # 1996-12-30 fl Added encoder options, added progression property (0.2)
  17. # 1997-08-27 fl Save mode 1 images as BW (0.3)
  18. # 1998-07-12 fl Added YCbCr to draft and save methods (0.4)
  19. # 1998-10-19 fl Don't hang on files using 16-bit DQT's (0.4.1)
  20. # 2001-04-16 fl Extract DPI settings from JFIF files (0.4.2)
  21. # 2002-07-01 fl Skip pad bytes before markers; identify Exif files (0.4.3)
  22. # 2003-04-25 fl Added experimental EXIF decoder (0.5)
  23. # 2003-06-06 fl Added experimental EXIF GPSinfo decoder
  24. # 2003-09-13 fl Extract COM markers
  25. # 2009-09-06 fl Added icc_profile support (from Florian Hoech)
  26. # 2009-03-06 fl Changed CMYK handling; always use Adobe polarity (0.6)
  27. # 2009-03-08 fl Added subsampling support (from Justin Huff).
  28. #
  29. # Copyright (c) 1997-2003 by Secret Labs AB.
  30. # Copyright (c) 1995-1996 by Fredrik Lundh.
  31. #
  32. # See the README file for information on usage and redistribution.
  33. #
  34. from __future__ import annotations
  35. import array
  36. import io
  37. import math
  38. import os
  39. import struct
  40. import subprocess
  41. import sys
  42. import tempfile
  43. import warnings
  44. from typing import IO, Any
  45. from . import Image, ImageFile
  46. from ._binary import i16be as i16
  47. from ._binary import i32be as i32
  48. from ._binary import o8
  49. from ._binary import o16be as o16
  50. from ._deprecate import deprecate
  51. from .JpegPresets import presets
  52. TYPE_CHECKING = False
  53. if TYPE_CHECKING:
  54. from .MpoImagePlugin import MpoImageFile
  55. #
  56. # Parser
  57. def Skip(self: JpegImageFile, marker: int) -> None:
  58. n = i16(self.fp.read(2)) - 2
  59. ImageFile._safe_read(self.fp, n)
  60. def APP(self: JpegImageFile, marker: int) -> None:
  61. #
  62. # Application marker. Store these in the APP dictionary.
  63. # Also look for well-known application markers.
  64. n = i16(self.fp.read(2)) - 2
  65. s = ImageFile._safe_read(self.fp, n)
  66. app = f"APP{marker & 15}"
  67. self.app[app] = s # compatibility
  68. self.applist.append((app, s))
  69. if marker == 0xFFE0 and s.startswith(b"JFIF"):
  70. # extract JFIF information
  71. self.info["jfif"] = version = i16(s, 5) # version
  72. self.info["jfif_version"] = divmod(version, 256)
  73. # extract JFIF properties
  74. try:
  75. jfif_unit = s[7]
  76. jfif_density = i16(s, 8), i16(s, 10)
  77. except Exception:
  78. pass
  79. else:
  80. if jfif_unit == 1:
  81. self.info["dpi"] = jfif_density
  82. elif jfif_unit == 2: # cm
  83. # 1 dpcm = 2.54 dpi
  84. self.info["dpi"] = tuple(d * 2.54 for d in jfif_density)
  85. self.info["jfif_unit"] = jfif_unit
  86. self.info["jfif_density"] = jfif_density
  87. elif marker == 0xFFE1 and s.startswith(b"Exif\0\0"):
  88. # extract EXIF information
  89. if "exif" in self.info:
  90. self.info["exif"] += s[6:]
  91. else:
  92. self.info["exif"] = s
  93. self._exif_offset = self.fp.tell() - n + 6
  94. elif marker == 0xFFE1 and s.startswith(b"http://ns.adobe.com/xap/1.0/\x00"):
  95. self.info["xmp"] = s.split(b"\x00", 1)[1]
  96. elif marker == 0xFFE2 and s.startswith(b"FPXR\0"):
  97. # extract FlashPix information (incomplete)
  98. self.info["flashpix"] = s # FIXME: value will change
  99. elif marker == 0xFFE2 and s.startswith(b"ICC_PROFILE\0"):
  100. # Since an ICC profile can be larger than the maximum size of
  101. # a JPEG marker (64K), we need provisions to split it into
  102. # multiple markers. The format defined by the ICC specifies
  103. # one or more APP2 markers containing the following data:
  104. # Identifying string ASCII "ICC_PROFILE\0" (12 bytes)
  105. # Marker sequence number 1, 2, etc (1 byte)
  106. # Number of markers Total of APP2's used (1 byte)
  107. # Profile data (remainder of APP2 data)
  108. # Decoders should use the marker sequence numbers to
  109. # reassemble the profile, rather than assuming that the APP2
  110. # markers appear in the correct sequence.
  111. self.icclist.append(s)
  112. elif marker == 0xFFED and s.startswith(b"Photoshop 3.0\x00"):
  113. # parse the image resource block
  114. offset = 14
  115. photoshop = self.info.setdefault("photoshop", {})
  116. while s[offset : offset + 4] == b"8BIM":
  117. try:
  118. offset += 4
  119. # resource code
  120. code = i16(s, offset)
  121. offset += 2
  122. # resource name (usually empty)
  123. name_len = s[offset]
  124. # name = s[offset+1:offset+1+name_len]
  125. offset += 1 + name_len
  126. offset += offset & 1 # align
  127. # resource data block
  128. size = i32(s, offset)
  129. offset += 4
  130. data = s[offset : offset + size]
  131. if code == 0x03ED: # ResolutionInfo
  132. photoshop[code] = {
  133. "XResolution": i32(data, 0) / 65536,
  134. "DisplayedUnitsX": i16(data, 4),
  135. "YResolution": i32(data, 8) / 65536,
  136. "DisplayedUnitsY": i16(data, 12),
  137. }
  138. else:
  139. photoshop[code] = data
  140. offset += size
  141. offset += offset & 1 # align
  142. except struct.error:
  143. break # insufficient data
  144. elif marker == 0xFFEE and s.startswith(b"Adobe"):
  145. self.info["adobe"] = i16(s, 5)
  146. # extract Adobe custom properties
  147. try:
  148. adobe_transform = s[11]
  149. except IndexError:
  150. pass
  151. else:
  152. self.info["adobe_transform"] = adobe_transform
  153. elif marker == 0xFFE2 and s.startswith(b"MPF\0"):
  154. # extract MPO information
  155. self.info["mp"] = s[4:]
  156. # offset is current location minus buffer size
  157. # plus constant header size
  158. self.info["mpoffset"] = self.fp.tell() - n + 4
  159. def COM(self: JpegImageFile, marker: int) -> None:
  160. #
  161. # Comment marker. Store these in the APP dictionary.
  162. n = i16(self.fp.read(2)) - 2
  163. s = ImageFile._safe_read(self.fp, n)
  164. self.info["comment"] = s
  165. self.app["COM"] = s # compatibility
  166. self.applist.append(("COM", s))
  167. def SOF(self: JpegImageFile, marker: int) -> None:
  168. #
  169. # Start of frame marker. Defines the size and mode of the
  170. # image. JPEG is colour blind, so we use some simple
  171. # heuristics to map the number of layers to an appropriate
  172. # mode. Note that this could be made a bit brighter, by
  173. # looking for JFIF and Adobe APP markers.
  174. n = i16(self.fp.read(2)) - 2
  175. s = ImageFile._safe_read(self.fp, n)
  176. self._size = i16(s, 3), i16(s, 1)
  177. self.bits = s[0]
  178. if self.bits != 8:
  179. msg = f"cannot handle {self.bits}-bit layers"
  180. raise SyntaxError(msg)
  181. self.layers = s[5]
  182. if self.layers == 1:
  183. self._mode = "L"
  184. elif self.layers == 3:
  185. self._mode = "RGB"
  186. elif self.layers == 4:
  187. self._mode = "CMYK"
  188. else:
  189. msg = f"cannot handle {self.layers}-layer images"
  190. raise SyntaxError(msg)
  191. if marker in [0xFFC2, 0xFFC6, 0xFFCA, 0xFFCE]:
  192. self.info["progressive"] = self.info["progression"] = 1
  193. if self.icclist:
  194. # fixup icc profile
  195. self.icclist.sort() # sort by sequence number
  196. if self.icclist[0][13] == len(self.icclist):
  197. profile = [p[14:] for p in self.icclist]
  198. icc_profile = b"".join(profile)
  199. else:
  200. icc_profile = None # wrong number of fragments
  201. self.info["icc_profile"] = icc_profile
  202. self.icclist = []
  203. for i in range(6, len(s), 3):
  204. t = s[i : i + 3]
  205. # 4-tuples: id, vsamp, hsamp, qtable
  206. self.layer.append((t[0], t[1] // 16, t[1] & 15, t[2]))
  207. def DQT(self: JpegImageFile, marker: int) -> None:
  208. #
  209. # Define quantization table. Note that there might be more
  210. # than one table in each marker.
  211. # FIXME: The quantization tables can be used to estimate the
  212. # compression quality.
  213. n = i16(self.fp.read(2)) - 2
  214. s = ImageFile._safe_read(self.fp, n)
  215. while len(s):
  216. v = s[0]
  217. precision = 1 if (v // 16 == 0) else 2 # in bytes
  218. qt_length = 1 + precision * 64
  219. if len(s) < qt_length:
  220. msg = "bad quantization table marker"
  221. raise SyntaxError(msg)
  222. data = array.array("B" if precision == 1 else "H", s[1:qt_length])
  223. if sys.byteorder == "little" and precision > 1:
  224. data.byteswap() # the values are always big-endian
  225. self.quantization[v & 15] = [data[i] for i in zigzag_index]
  226. s = s[qt_length:]
  227. #
  228. # JPEG marker table
  229. MARKER = {
  230. 0xFFC0: ("SOF0", "Baseline DCT", SOF),
  231. 0xFFC1: ("SOF1", "Extended Sequential DCT", SOF),
  232. 0xFFC2: ("SOF2", "Progressive DCT", SOF),
  233. 0xFFC3: ("SOF3", "Spatial lossless", SOF),
  234. 0xFFC4: ("DHT", "Define Huffman table", Skip),
  235. 0xFFC5: ("SOF5", "Differential sequential DCT", SOF),
  236. 0xFFC6: ("SOF6", "Differential progressive DCT", SOF),
  237. 0xFFC7: ("SOF7", "Differential spatial", SOF),
  238. 0xFFC8: ("JPG", "Extension", None),
  239. 0xFFC9: ("SOF9", "Extended sequential DCT (AC)", SOF),
  240. 0xFFCA: ("SOF10", "Progressive DCT (AC)", SOF),
  241. 0xFFCB: ("SOF11", "Spatial lossless DCT (AC)", SOF),
  242. 0xFFCC: ("DAC", "Define arithmetic coding conditioning", Skip),
  243. 0xFFCD: ("SOF13", "Differential sequential DCT (AC)", SOF),
  244. 0xFFCE: ("SOF14", "Differential progressive DCT (AC)", SOF),
  245. 0xFFCF: ("SOF15", "Differential spatial (AC)", SOF),
  246. 0xFFD0: ("RST0", "Restart 0", None),
  247. 0xFFD1: ("RST1", "Restart 1", None),
  248. 0xFFD2: ("RST2", "Restart 2", None),
  249. 0xFFD3: ("RST3", "Restart 3", None),
  250. 0xFFD4: ("RST4", "Restart 4", None),
  251. 0xFFD5: ("RST5", "Restart 5", None),
  252. 0xFFD6: ("RST6", "Restart 6", None),
  253. 0xFFD7: ("RST7", "Restart 7", None),
  254. 0xFFD8: ("SOI", "Start of image", None),
  255. 0xFFD9: ("EOI", "End of image", None),
  256. 0xFFDA: ("SOS", "Start of scan", Skip),
  257. 0xFFDB: ("DQT", "Define quantization table", DQT),
  258. 0xFFDC: ("DNL", "Define number of lines", Skip),
  259. 0xFFDD: ("DRI", "Define restart interval", Skip),
  260. 0xFFDE: ("DHP", "Define hierarchical progression", SOF),
  261. 0xFFDF: ("EXP", "Expand reference component", Skip),
  262. 0xFFE0: ("APP0", "Application segment 0", APP),
  263. 0xFFE1: ("APP1", "Application segment 1", APP),
  264. 0xFFE2: ("APP2", "Application segment 2", APP),
  265. 0xFFE3: ("APP3", "Application segment 3", APP),
  266. 0xFFE4: ("APP4", "Application segment 4", APP),
  267. 0xFFE5: ("APP5", "Application segment 5", APP),
  268. 0xFFE6: ("APP6", "Application segment 6", APP),
  269. 0xFFE7: ("APP7", "Application segment 7", APP),
  270. 0xFFE8: ("APP8", "Application segment 8", APP),
  271. 0xFFE9: ("APP9", "Application segment 9", APP),
  272. 0xFFEA: ("APP10", "Application segment 10", APP),
  273. 0xFFEB: ("APP11", "Application segment 11", APP),
  274. 0xFFEC: ("APP12", "Application segment 12", APP),
  275. 0xFFED: ("APP13", "Application segment 13", APP),
  276. 0xFFEE: ("APP14", "Application segment 14", APP),
  277. 0xFFEF: ("APP15", "Application segment 15", APP),
  278. 0xFFF0: ("JPG0", "Extension 0", None),
  279. 0xFFF1: ("JPG1", "Extension 1", None),
  280. 0xFFF2: ("JPG2", "Extension 2", None),
  281. 0xFFF3: ("JPG3", "Extension 3", None),
  282. 0xFFF4: ("JPG4", "Extension 4", None),
  283. 0xFFF5: ("JPG5", "Extension 5", None),
  284. 0xFFF6: ("JPG6", "Extension 6", None),
  285. 0xFFF7: ("JPG7", "Extension 7", None),
  286. 0xFFF8: ("JPG8", "Extension 8", None),
  287. 0xFFF9: ("JPG9", "Extension 9", None),
  288. 0xFFFA: ("JPG10", "Extension 10", None),
  289. 0xFFFB: ("JPG11", "Extension 11", None),
  290. 0xFFFC: ("JPG12", "Extension 12", None),
  291. 0xFFFD: ("JPG13", "Extension 13", None),
  292. 0xFFFE: ("COM", "Comment", COM),
  293. }
  294. def _accept(prefix: bytes) -> bool:
  295. # Magic number was taken from https://en.wikipedia.org/wiki/JPEG
  296. return prefix.startswith(b"\xff\xd8\xff")
  297. ##
  298. # Image plugin for JPEG and JFIF images.
  299. class JpegImageFile(ImageFile.ImageFile):
  300. format = "JPEG"
  301. format_description = "JPEG (ISO 10918)"
  302. def _open(self) -> None:
  303. s = self.fp.read(3)
  304. if not _accept(s):
  305. msg = "not a JPEG file"
  306. raise SyntaxError(msg)
  307. s = b"\xff"
  308. # Create attributes
  309. self.bits = self.layers = 0
  310. self._exif_offset = 0
  311. # JPEG specifics (internal)
  312. self.layer: list[tuple[int, int, int, int]] = []
  313. self._huffman_dc: dict[Any, Any] = {}
  314. self._huffman_ac: dict[Any, Any] = {}
  315. self.quantization: dict[int, list[int]] = {}
  316. self.app: dict[str, bytes] = {} # compatibility
  317. self.applist: list[tuple[str, bytes]] = []
  318. self.icclist: list[bytes] = []
  319. while True:
  320. i = s[0]
  321. if i == 0xFF:
  322. s = s + self.fp.read(1)
  323. i = i16(s)
  324. else:
  325. # Skip non-0xFF junk
  326. s = self.fp.read(1)
  327. continue
  328. if i in MARKER:
  329. name, description, handler = MARKER[i]
  330. if handler is not None:
  331. handler(self, i)
  332. if i == 0xFFDA: # start of scan
  333. rawmode = self.mode
  334. if self.mode == "CMYK":
  335. rawmode = "CMYK;I" # assume adobe conventions
  336. self.tile = [
  337. ImageFile._Tile("jpeg", (0, 0) + self.size, 0, (rawmode, ""))
  338. ]
  339. # self.__offset = self.fp.tell()
  340. break
  341. s = self.fp.read(1)
  342. elif i in {0, 0xFFFF}:
  343. # padded marker or junk; move on
  344. s = b"\xff"
  345. elif i == 0xFF00: # Skip extraneous data (escaped 0xFF)
  346. s = self.fp.read(1)
  347. else:
  348. msg = "no marker found"
  349. raise SyntaxError(msg)
  350. self._read_dpi_from_exif()
  351. def __getattr__(self, name: str) -> Any:
  352. if name in ("huffman_ac", "huffman_dc"):
  353. deprecate(name, 12)
  354. return getattr(self, "_" + name)
  355. raise AttributeError(name)
  356. def __getstate__(self) -> list[Any]:
  357. return super().__getstate__() + [self.layers, self.layer]
  358. def __setstate__(self, state: list[Any]) -> None:
  359. self.layers, self.layer = state[6:]
  360. super().__setstate__(state)
  361. def load_read(self, read_bytes: int) -> bytes:
  362. """
  363. internal: read more image data
  364. For premature EOF and LOAD_TRUNCATED_IMAGES adds EOI marker
  365. so libjpeg can finish decoding
  366. """
  367. s = self.fp.read(read_bytes)
  368. if not s and ImageFile.LOAD_TRUNCATED_IMAGES and not hasattr(self, "_ended"):
  369. # Premature EOF.
  370. # Pretend file is finished adding EOI marker
  371. self._ended = True
  372. return b"\xff\xd9"
  373. return s
  374. def draft(
  375. self, mode: str | None, size: tuple[int, int] | None
  376. ) -> tuple[str, tuple[int, int, float, float]] | None:
  377. if len(self.tile) != 1:
  378. return None
  379. # Protect from second call
  380. if self.decoderconfig:
  381. return None
  382. d, e, o, a = self.tile[0]
  383. scale = 1
  384. original_size = self.size
  385. assert isinstance(a, tuple)
  386. if a[0] == "RGB" and mode in ["L", "YCbCr"]:
  387. self._mode = mode
  388. a = mode, ""
  389. if size:
  390. scale = min(self.size[0] // size[0], self.size[1] // size[1])
  391. for s in [8, 4, 2, 1]:
  392. if scale >= s:
  393. break
  394. assert e is not None
  395. e = (
  396. e[0],
  397. e[1],
  398. (e[2] - e[0] + s - 1) // s + e[0],
  399. (e[3] - e[1] + s - 1) // s + e[1],
  400. )
  401. self._size = ((self.size[0] + s - 1) // s, (self.size[1] + s - 1) // s)
  402. scale = s
  403. self.tile = [ImageFile._Tile(d, e, o, a)]
  404. self.decoderconfig = (scale, 0)
  405. box = (0, 0, original_size[0] / scale, original_size[1] / scale)
  406. return self.mode, box
  407. def load_djpeg(self) -> None:
  408. # ALTERNATIVE: handle JPEGs via the IJG command line utilities
  409. f, path = tempfile.mkstemp()
  410. os.close(f)
  411. if os.path.exists(self.filename):
  412. subprocess.check_call(["djpeg", "-outfile", path, self.filename])
  413. else:
  414. try:
  415. os.unlink(path)
  416. except OSError:
  417. pass
  418. msg = "Invalid Filename"
  419. raise ValueError(msg)
  420. try:
  421. with Image.open(path) as _im:
  422. _im.load()
  423. self.im = _im.im
  424. finally:
  425. try:
  426. os.unlink(path)
  427. except OSError:
  428. pass
  429. self._mode = self.im.mode
  430. self._size = self.im.size
  431. self.tile = []
  432. def _getexif(self) -> dict[int, Any] | None:
  433. return _getexif(self)
  434. def _read_dpi_from_exif(self) -> None:
  435. # If DPI isn't in JPEG header, fetch from EXIF
  436. if "dpi" in self.info or "exif" not in self.info:
  437. return
  438. try:
  439. exif = self.getexif()
  440. resolution_unit = exif[0x0128]
  441. x_resolution = exif[0x011A]
  442. try:
  443. dpi = float(x_resolution[0]) / x_resolution[1]
  444. except TypeError:
  445. dpi = x_resolution
  446. if math.isnan(dpi):
  447. msg = "DPI is not a number"
  448. raise ValueError(msg)
  449. if resolution_unit == 3: # cm
  450. # 1 dpcm = 2.54 dpi
  451. dpi *= 2.54
  452. self.info["dpi"] = dpi, dpi
  453. except (
  454. struct.error, # truncated EXIF
  455. KeyError, # dpi not included
  456. SyntaxError, # invalid/unreadable EXIF
  457. TypeError, # dpi is an invalid float
  458. ValueError, # dpi is an invalid float
  459. ZeroDivisionError, # invalid dpi rational value
  460. ):
  461. self.info["dpi"] = 72, 72
  462. def _getmp(self) -> dict[int, Any] | None:
  463. return _getmp(self)
  464. def _getexif(self: JpegImageFile) -> dict[int, Any] | None:
  465. if "exif" not in self.info:
  466. return None
  467. return self.getexif()._get_merged_dict()
  468. def _getmp(self: JpegImageFile) -> dict[int, Any] | None:
  469. # Extract MP information. This method was inspired by the "highly
  470. # experimental" _getexif version that's been in use for years now,
  471. # itself based on the ImageFileDirectory class in the TIFF plugin.
  472. # The MP record essentially consists of a TIFF file embedded in a JPEG
  473. # application marker.
  474. try:
  475. data = self.info["mp"]
  476. except KeyError:
  477. return None
  478. file_contents = io.BytesIO(data)
  479. head = file_contents.read(8)
  480. endianness = ">" if head.startswith(b"\x4d\x4d\x00\x2a") else "<"
  481. # process dictionary
  482. from . import TiffImagePlugin
  483. try:
  484. info = TiffImagePlugin.ImageFileDirectory_v2(head)
  485. file_contents.seek(info.next)
  486. info.load(file_contents)
  487. mp = dict(info)
  488. except Exception as e:
  489. msg = "malformed MP Index (unreadable directory)"
  490. raise SyntaxError(msg) from e
  491. # it's an error not to have a number of images
  492. try:
  493. quant = mp[0xB001]
  494. except KeyError as e:
  495. msg = "malformed MP Index (no number of images)"
  496. raise SyntaxError(msg) from e
  497. # get MP entries
  498. mpentries = []
  499. try:
  500. rawmpentries = mp[0xB002]
  501. for entrynum in range(quant):
  502. unpackedentry = struct.unpack_from(
  503. f"{endianness}LLLHH", rawmpentries, entrynum * 16
  504. )
  505. labels = ("Attribute", "Size", "DataOffset", "EntryNo1", "EntryNo2")
  506. mpentry = dict(zip(labels, unpackedentry))
  507. mpentryattr = {
  508. "DependentParentImageFlag": bool(mpentry["Attribute"] & (1 << 31)),
  509. "DependentChildImageFlag": bool(mpentry["Attribute"] & (1 << 30)),
  510. "RepresentativeImageFlag": bool(mpentry["Attribute"] & (1 << 29)),
  511. "Reserved": (mpentry["Attribute"] & (3 << 27)) >> 27,
  512. "ImageDataFormat": (mpentry["Attribute"] & (7 << 24)) >> 24,
  513. "MPType": mpentry["Attribute"] & 0x00FFFFFF,
  514. }
  515. if mpentryattr["ImageDataFormat"] == 0:
  516. mpentryattr["ImageDataFormat"] = "JPEG"
  517. else:
  518. msg = "unsupported picture format in MPO"
  519. raise SyntaxError(msg)
  520. mptypemap = {
  521. 0x000000: "Undefined",
  522. 0x010001: "Large Thumbnail (VGA Equivalent)",
  523. 0x010002: "Large Thumbnail (Full HD Equivalent)",
  524. 0x020001: "Multi-Frame Image (Panorama)",
  525. 0x020002: "Multi-Frame Image: (Disparity)",
  526. 0x020003: "Multi-Frame Image: (Multi-Angle)",
  527. 0x030000: "Baseline MP Primary Image",
  528. }
  529. mpentryattr["MPType"] = mptypemap.get(mpentryattr["MPType"], "Unknown")
  530. mpentry["Attribute"] = mpentryattr
  531. mpentries.append(mpentry)
  532. mp[0xB002] = mpentries
  533. except KeyError as e:
  534. msg = "malformed MP Index (bad MP Entry)"
  535. raise SyntaxError(msg) from e
  536. # Next we should try and parse the individual image unique ID list;
  537. # we don't because I've never seen this actually used in a real MPO
  538. # file and so can't test it.
  539. return mp
  540. # --------------------------------------------------------------------
  541. # stuff to save JPEG files
  542. RAWMODE = {
  543. "1": "L",
  544. "L": "L",
  545. "RGB": "RGB",
  546. "RGBX": "RGB",
  547. "CMYK": "CMYK;I", # assume adobe conventions
  548. "YCbCr": "YCbCr",
  549. }
  550. # fmt: off
  551. zigzag_index = (
  552. 0, 1, 5, 6, 14, 15, 27, 28,
  553. 2, 4, 7, 13, 16, 26, 29, 42,
  554. 3, 8, 12, 17, 25, 30, 41, 43,
  555. 9, 11, 18, 24, 31, 40, 44, 53,
  556. 10, 19, 23, 32, 39, 45, 52, 54,
  557. 20, 22, 33, 38, 46, 51, 55, 60,
  558. 21, 34, 37, 47, 50, 56, 59, 61,
  559. 35, 36, 48, 49, 57, 58, 62, 63,
  560. )
  561. samplings = {
  562. (1, 1, 1, 1, 1, 1): 0,
  563. (2, 1, 1, 1, 1, 1): 1,
  564. (2, 2, 1, 1, 1, 1): 2,
  565. }
  566. # fmt: on
  567. def get_sampling(im: Image.Image) -> int:
  568. # There's no subsampling when images have only 1 layer
  569. # (grayscale images) or when they are CMYK (4 layers),
  570. # so set subsampling to the default value.
  571. #
  572. # NOTE: currently Pillow can't encode JPEG to YCCK format.
  573. # If YCCK support is added in the future, subsampling code will have
  574. # to be updated (here and in JpegEncode.c) to deal with 4 layers.
  575. if not isinstance(im, JpegImageFile) or im.layers in (1, 4):
  576. return -1
  577. sampling = im.layer[0][1:3] + im.layer[1][1:3] + im.layer[2][1:3]
  578. return samplings.get(sampling, -1)
  579. def _save(im: Image.Image, fp: IO[bytes], filename: str | bytes) -> None:
  580. if im.width == 0 or im.height == 0:
  581. msg = "cannot write empty image as JPEG"
  582. raise ValueError(msg)
  583. try:
  584. rawmode = RAWMODE[im.mode]
  585. except KeyError as e:
  586. msg = f"cannot write mode {im.mode} as JPEG"
  587. raise OSError(msg) from e
  588. info = im.encoderinfo
  589. dpi = [round(x) for x in info.get("dpi", (0, 0))]
  590. quality = info.get("quality", -1)
  591. subsampling = info.get("subsampling", -1)
  592. qtables = info.get("qtables")
  593. if quality == "keep":
  594. quality = -1
  595. subsampling = "keep"
  596. qtables = "keep"
  597. elif quality in presets:
  598. preset = presets[quality]
  599. quality = -1
  600. subsampling = preset.get("subsampling", -1)
  601. qtables = preset.get("quantization")
  602. elif not isinstance(quality, int):
  603. msg = "Invalid quality setting"
  604. raise ValueError(msg)
  605. else:
  606. if subsampling in presets:
  607. subsampling = presets[subsampling].get("subsampling", -1)
  608. if isinstance(qtables, str) and qtables in presets:
  609. qtables = presets[qtables].get("quantization")
  610. if subsampling == "4:4:4":
  611. subsampling = 0
  612. elif subsampling == "4:2:2":
  613. subsampling = 1
  614. elif subsampling == "4:2:0":
  615. subsampling = 2
  616. elif subsampling == "4:1:1":
  617. # For compatibility. Before Pillow 4.3, 4:1:1 actually meant 4:2:0.
  618. # Set 4:2:0 if someone is still using that value.
  619. subsampling = 2
  620. elif subsampling == "keep":
  621. if im.format != "JPEG":
  622. msg = "Cannot use 'keep' when original image is not a JPEG"
  623. raise ValueError(msg)
  624. subsampling = get_sampling(im)
  625. def validate_qtables(
  626. qtables: (
  627. str | tuple[list[int], ...] | list[list[int]] | dict[int, list[int]] | None
  628. ),
  629. ) -> list[list[int]] | None:
  630. if qtables is None:
  631. return qtables
  632. if isinstance(qtables, str):
  633. try:
  634. lines = [
  635. int(num)
  636. for line in qtables.splitlines()
  637. for num in line.split("#", 1)[0].split()
  638. ]
  639. except ValueError as e:
  640. msg = "Invalid quantization table"
  641. raise ValueError(msg) from e
  642. else:
  643. qtables = [lines[s : s + 64] for s in range(0, len(lines), 64)]
  644. if isinstance(qtables, (tuple, list, dict)):
  645. if isinstance(qtables, dict):
  646. qtables = [
  647. qtables[key] for key in range(len(qtables)) if key in qtables
  648. ]
  649. elif isinstance(qtables, tuple):
  650. qtables = list(qtables)
  651. if not (0 < len(qtables) < 5):
  652. msg = "None or too many quantization tables"
  653. raise ValueError(msg)
  654. for idx, table in enumerate(qtables):
  655. try:
  656. if len(table) != 64:
  657. msg = "Invalid quantization table"
  658. raise TypeError(msg)
  659. table_array = array.array("H", table)
  660. except TypeError as e:
  661. msg = "Invalid quantization table"
  662. raise ValueError(msg) from e
  663. else:
  664. qtables[idx] = list(table_array)
  665. return qtables
  666. if qtables == "keep":
  667. if im.format != "JPEG":
  668. msg = "Cannot use 'keep' when original image is not a JPEG"
  669. raise ValueError(msg)
  670. qtables = getattr(im, "quantization", None)
  671. qtables = validate_qtables(qtables)
  672. extra = info.get("extra", b"")
  673. MAX_BYTES_IN_MARKER = 65533
  674. if xmp := info.get("xmp"):
  675. overhead_len = 29 # b"http://ns.adobe.com/xap/1.0/\x00"
  676. max_data_bytes_in_marker = MAX_BYTES_IN_MARKER - overhead_len
  677. if len(xmp) > max_data_bytes_in_marker:
  678. msg = "XMP data is too long"
  679. raise ValueError(msg)
  680. size = o16(2 + overhead_len + len(xmp))
  681. extra += b"\xff\xe1" + size + b"http://ns.adobe.com/xap/1.0/\x00" + xmp
  682. if icc_profile := info.get("icc_profile"):
  683. overhead_len = 14 # b"ICC_PROFILE\0" + o8(i) + o8(len(markers))
  684. max_data_bytes_in_marker = MAX_BYTES_IN_MARKER - overhead_len
  685. markers = []
  686. while icc_profile:
  687. markers.append(icc_profile[:max_data_bytes_in_marker])
  688. icc_profile = icc_profile[max_data_bytes_in_marker:]
  689. i = 1
  690. for marker in markers:
  691. size = o16(2 + overhead_len + len(marker))
  692. extra += (
  693. b"\xff\xe2"
  694. + size
  695. + b"ICC_PROFILE\0"
  696. + o8(i)
  697. + o8(len(markers))
  698. + marker
  699. )
  700. i += 1
  701. comment = info.get("comment", im.info.get("comment"))
  702. # "progressive" is the official name, but older documentation
  703. # says "progression"
  704. # FIXME: issue a warning if the wrong form is used (post-1.1.7)
  705. progressive = info.get("progressive", False) or info.get("progression", False)
  706. optimize = info.get("optimize", False)
  707. exif = info.get("exif", b"")
  708. if isinstance(exif, Image.Exif):
  709. exif = exif.tobytes()
  710. if len(exif) > MAX_BYTES_IN_MARKER:
  711. msg = "EXIF data is too long"
  712. raise ValueError(msg)
  713. # get keyword arguments
  714. im.encoderconfig = (
  715. quality,
  716. progressive,
  717. info.get("smooth", 0),
  718. optimize,
  719. info.get("keep_rgb", False),
  720. info.get("streamtype", 0),
  721. dpi,
  722. subsampling,
  723. info.get("restart_marker_blocks", 0),
  724. info.get("restart_marker_rows", 0),
  725. qtables,
  726. comment,
  727. extra,
  728. exif,
  729. )
  730. # if we optimize, libjpeg needs a buffer big enough to hold the whole image
  731. # in a shot. Guessing on the size, at im.size bytes. (raw pixel size is
  732. # channels*size, this is a value that's been used in a django patch.
  733. # https://github.com/matthewwithanm/django-imagekit/issues/50
  734. if optimize or progressive:
  735. # CMYK can be bigger
  736. if im.mode == "CMYK":
  737. bufsize = 4 * im.size[0] * im.size[1]
  738. # keep sets quality to -1, but the actual value may be high.
  739. elif quality >= 95 or quality == -1:
  740. bufsize = 2 * im.size[0] * im.size[1]
  741. else:
  742. bufsize = im.size[0] * im.size[1]
  743. if exif:
  744. bufsize += len(exif) + 5
  745. if extra:
  746. bufsize += len(extra) + 1
  747. else:
  748. # The EXIF info needs to be written as one block, + APP1, + one spare byte.
  749. # Ensure that our buffer is big enough. Same with the icc_profile block.
  750. bufsize = max(len(exif) + 5, len(extra) + 1)
  751. ImageFile._save(
  752. im, fp, [ImageFile._Tile("jpeg", (0, 0) + im.size, 0, rawmode)], bufsize
  753. )
  754. def _save_cjpeg(im: Image.Image, fp: IO[bytes], filename: str | bytes) -> None:
  755. # ALTERNATIVE: handle JPEGs via the IJG command line utilities.
  756. tempfile = im._dump()
  757. subprocess.check_call(["cjpeg", "-outfile", filename, tempfile])
  758. try:
  759. os.unlink(tempfile)
  760. except OSError:
  761. pass
  762. ##
  763. # Factory for making JPEG and MPO instances
  764. def jpeg_factory(
  765. fp: IO[bytes], filename: str | bytes | None = None
  766. ) -> JpegImageFile | MpoImageFile:
  767. im = JpegImageFile(fp, filename)
  768. try:
  769. mpheader = im._getmp()
  770. if mpheader is not None and mpheader[45057] > 1:
  771. for segment, content in im.applist:
  772. if segment == "APP1" and b' hdrgm:Version="' in content:
  773. # Ultra HDR images are not yet supported
  774. return im
  775. # It's actually an MPO
  776. from .MpoImagePlugin import MpoImageFile
  777. # Don't reload everything, just convert it.
  778. im = MpoImageFile.adopt(im, mpheader)
  779. except (TypeError, IndexError):
  780. # It is really a JPEG
  781. pass
  782. except SyntaxError:
  783. warnings.warn(
  784. "Image appears to be a malformed MPO file, it will be "
  785. "interpreted as a base JPEG file"
  786. )
  787. return im
  788. # ---------------------------------------------------------------------
  789. # Registry stuff
  790. Image.register_open(JpegImageFile.format, jpeg_factory, _accept)
  791. Image.register_save(JpegImageFile.format, _save)
  792. Image.register_extensions(JpegImageFile.format, [".jfif", ".jpe", ".jpg", ".jpeg"])
  793. Image.register_mime(JpegImageFile.format, "image/jpeg")