PpmImagePlugin.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. #
  2. # The Python Imaging Library.
  3. # $Id$
  4. #
  5. # PPM support for PIL
  6. #
  7. # History:
  8. # 96-03-24 fl Created
  9. # 98-03-06 fl Write RGBA images (as RGB, that is)
  10. #
  11. # Copyright (c) Secret Labs AB 1997-98.
  12. # Copyright (c) Fredrik Lundh 1996.
  13. #
  14. # See the README file for information on usage and redistribution.
  15. #
  16. from . import Image, ImageFile
  17. from ._binary import i16be as i16
  18. from ._binary import o8
  19. from ._binary import o32le as o32
  20. #
  21. # --------------------------------------------------------------------
  22. b_whitespace = b"\x20\x09\x0a\x0b\x0c\x0d"
  23. MODES = {
  24. # standard
  25. b"P1": "1",
  26. b"P2": "L",
  27. b"P3": "RGB",
  28. b"P4": "1",
  29. b"P5": "L",
  30. b"P6": "RGB",
  31. # extensions
  32. b"P0CMYK": "CMYK",
  33. # PIL extensions (for test purposes only)
  34. b"PyP": "P",
  35. b"PyRGBA": "RGBA",
  36. b"PyCMYK": "CMYK",
  37. }
  38. def _accept(prefix):
  39. return prefix[0:1] == b"P" and prefix[1] in b"0123456y"
  40. ##
  41. # Image plugin for PBM, PGM, and PPM images.
  42. class PpmImageFile(ImageFile.ImageFile):
  43. format = "PPM"
  44. format_description = "Pbmplus image"
  45. def _read_magic(self):
  46. magic = b""
  47. # read until whitespace or longest available magic number
  48. for _ in range(6):
  49. c = self.fp.read(1)
  50. if not c or c in b_whitespace:
  51. break
  52. magic += c
  53. return magic
  54. def _read_token(self):
  55. token = b""
  56. while len(token) <= 10: # read until next whitespace or limit of 10 characters
  57. c = self.fp.read(1)
  58. if not c:
  59. break
  60. elif c in b_whitespace: # token ended
  61. if not token:
  62. # skip whitespace at start
  63. continue
  64. break
  65. elif c == b"#":
  66. # ignores rest of the line; stops at CR, LF or EOF
  67. while self.fp.read(1) not in b"\r\n":
  68. pass
  69. continue
  70. token += c
  71. if not token:
  72. # Token was not even 1 byte
  73. raise ValueError("Reached EOF while reading header")
  74. elif len(token) > 10:
  75. raise ValueError(f"Token too long in file header: {token.decode()}")
  76. return token
  77. def _open(self):
  78. magic_number = self._read_magic()
  79. try:
  80. mode = MODES[magic_number]
  81. except KeyError:
  82. raise SyntaxError("not a PPM file")
  83. if magic_number in (b"P1", b"P4"):
  84. self.custom_mimetype = "image/x-portable-bitmap"
  85. elif magic_number in (b"P2", b"P5"):
  86. self.custom_mimetype = "image/x-portable-graymap"
  87. elif magic_number in (b"P3", b"P6"):
  88. self.custom_mimetype = "image/x-portable-pixmap"
  89. maxval = None
  90. decoder_name = "raw"
  91. if magic_number in (b"P1", b"P2", b"P3"):
  92. decoder_name = "ppm_plain"
  93. for ix in range(3):
  94. token = int(self._read_token())
  95. if ix == 0: # token is the x size
  96. xsize = token
  97. elif ix == 1: # token is the y size
  98. ysize = token
  99. if mode == "1":
  100. self.mode = "1"
  101. rawmode = "1;I"
  102. break
  103. else:
  104. self.mode = rawmode = mode
  105. elif ix == 2: # token is maxval
  106. maxval = token
  107. if not 0 < maxval < 65536:
  108. raise ValueError(
  109. "maxval must be greater than 0 and less than 65536"
  110. )
  111. if maxval > 255 and mode == "L":
  112. self.mode = "I"
  113. if decoder_name != "ppm_plain":
  114. # If maxval matches a bit depth, use the raw decoder directly
  115. if maxval == 65535 and mode == "L":
  116. rawmode = "I;16B"
  117. elif maxval != 255:
  118. decoder_name = "ppm"
  119. args = (rawmode, 0, 1) if decoder_name == "raw" else (rawmode, maxval)
  120. self._size = xsize, ysize
  121. self.tile = [(decoder_name, (0, 0, xsize, ysize), self.fp.tell(), args)]
  122. #
  123. # --------------------------------------------------------------------
  124. class PpmPlainDecoder(ImageFile.PyDecoder):
  125. _pulls_fd = True
  126. def _read_block(self):
  127. return self.fd.read(ImageFile.SAFEBLOCK)
  128. def _find_comment_end(self, block, start=0):
  129. a = block.find(b"\n", start)
  130. b = block.find(b"\r", start)
  131. return min(a, b) if a * b > 0 else max(a, b) # lowest nonnegative index (or -1)
  132. def _ignore_comments(self, block):
  133. if self._comment_spans:
  134. # Finish current comment
  135. while block:
  136. comment_end = self._find_comment_end(block)
  137. if comment_end != -1:
  138. # Comment ends in this block
  139. # Delete tail of comment
  140. block = block[comment_end + 1 :]
  141. break
  142. else:
  143. # Comment spans whole block
  144. # So read the next block, looking for the end
  145. block = self._read_block()
  146. # Search for any further comments
  147. self._comment_spans = False
  148. while True:
  149. comment_start = block.find(b"#")
  150. if comment_start == -1:
  151. # No comment found
  152. break
  153. comment_end = self._find_comment_end(block, comment_start)
  154. if comment_end != -1:
  155. # Comment ends in this block
  156. # Delete comment
  157. block = block[:comment_start] + block[comment_end + 1 :]
  158. else:
  159. # Comment continues to next block(s)
  160. block = block[:comment_start]
  161. self._comment_spans = True
  162. break
  163. return block
  164. def _decode_bitonal(self):
  165. """
  166. This is a separate method because in the plain PBM format, all data tokens are
  167. exactly one byte, so the inter-token whitespace is optional.
  168. """
  169. data = bytearray()
  170. total_bytes = self.state.xsize * self.state.ysize
  171. while len(data) != total_bytes:
  172. block = self._read_block() # read next block
  173. if not block:
  174. # eof
  175. break
  176. block = self._ignore_comments(block)
  177. tokens = b"".join(block.split())
  178. for token in tokens:
  179. if token not in (48, 49):
  180. raise ValueError(f"Invalid token for this mode: {bytes([token])}")
  181. data = (data + tokens)[:total_bytes]
  182. invert = bytes.maketrans(b"01", b"\xFF\x00")
  183. return data.translate(invert)
  184. def _decode_blocks(self, maxval):
  185. data = bytearray()
  186. max_len = 10
  187. out_byte_count = 4 if self.mode == "I" else 1
  188. out_max = 65535 if self.mode == "I" else 255
  189. bands = Image.getmodebands(self.mode)
  190. total_bytes = self.state.xsize * self.state.ysize * bands * out_byte_count
  191. half_token = False
  192. while len(data) != total_bytes:
  193. block = self._read_block() # read next block
  194. if not block:
  195. if half_token:
  196. block = bytearray(b" ") # flush half_token
  197. else:
  198. # eof
  199. break
  200. block = self._ignore_comments(block)
  201. if half_token:
  202. block = half_token + block # stitch half_token to new block
  203. tokens = block.split()
  204. if block and not block[-1:].isspace(): # block might split token
  205. half_token = tokens.pop() # save half token for later
  206. if len(half_token) > max_len: # prevent buildup of half_token
  207. raise ValueError(
  208. f"Token too long found in data: {half_token[:max_len + 1]}"
  209. )
  210. for token in tokens:
  211. if len(token) > max_len:
  212. raise ValueError(
  213. f"Token too long found in data: {token[:max_len + 1]}"
  214. )
  215. value = int(token)
  216. if value > maxval:
  217. raise ValueError(f"Channel value too large for this mode: {value}")
  218. value = round(value / maxval * out_max)
  219. data += o32(value) if self.mode == "I" else o8(value)
  220. if len(data) == total_bytes: # finished!
  221. break
  222. return data
  223. def decode(self, buffer):
  224. self._comment_spans = False
  225. if self.mode == "1":
  226. data = self._decode_bitonal()
  227. rawmode = "1;8"
  228. else:
  229. maxval = self.args[-1]
  230. data = self._decode_blocks(maxval)
  231. rawmode = "I;32" if self.mode == "I" else self.mode
  232. self.set_as_raw(bytes(data), rawmode)
  233. return -1, 0
  234. class PpmDecoder(ImageFile.PyDecoder):
  235. _pulls_fd = True
  236. def decode(self, buffer):
  237. data = bytearray()
  238. maxval = self.args[-1]
  239. in_byte_count = 1 if maxval < 256 else 2
  240. out_byte_count = 4 if self.mode == "I" else 1
  241. out_max = 65535 if self.mode == "I" else 255
  242. bands = Image.getmodebands(self.mode)
  243. while len(data) < self.state.xsize * self.state.ysize * bands * out_byte_count:
  244. pixels = self.fd.read(in_byte_count * bands)
  245. if len(pixels) < in_byte_count * bands:
  246. # eof
  247. break
  248. for b in range(bands):
  249. value = (
  250. pixels[b] if in_byte_count == 1 else i16(pixels, b * in_byte_count)
  251. )
  252. value = min(out_max, round(value / maxval * out_max))
  253. data += o32(value) if self.mode == "I" else o8(value)
  254. rawmode = "I;32" if self.mode == "I" else self.mode
  255. self.set_as_raw(bytes(data), rawmode)
  256. return -1, 0
  257. #
  258. # --------------------------------------------------------------------
  259. def _save(im, fp, filename):
  260. if im.mode == "1":
  261. rawmode, head = "1;I", b"P4"
  262. elif im.mode == "L":
  263. rawmode, head = "L", b"P5"
  264. elif im.mode == "I":
  265. rawmode, head = "I;16B", b"P5"
  266. elif im.mode in ("RGB", "RGBA"):
  267. rawmode, head = "RGB", b"P6"
  268. else:
  269. raise OSError(f"cannot write mode {im.mode} as PPM")
  270. fp.write(head + b"\n%d %d\n" % im.size)
  271. if head == b"P6":
  272. fp.write(b"255\n")
  273. elif head == b"P5":
  274. if rawmode == "L":
  275. fp.write(b"255\n")
  276. else:
  277. fp.write(b"65535\n")
  278. ImageFile._save(im, fp, [("raw", (0, 0) + im.size, 0, (rawmode, 0, 1))])
  279. # ALTERNATIVE: save via builtin debug function
  280. # im._dump(filename)
  281. #
  282. # --------------------------------------------------------------------
  283. Image.register_open(PpmImageFile.format, PpmImageFile, _accept)
  284. Image.register_save(PpmImageFile.format, _save)
  285. Image.register_decoder("ppm", PpmDecoder)
  286. Image.register_decoder("ppm_plain", PpmPlainDecoder)
  287. Image.register_extensions(PpmImageFile.format, [".pbm", ".pgm", ".ppm", ".pnm"])
  288. Image.register_mime(PpmImageFile.format, "image/x-portable-anymap")