QoiImagePlugin.py 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. #
  2. # The Python Imaging Library.
  3. #
  4. # QOI support for PIL
  5. #
  6. # See the README file for information on usage and redistribution.
  7. #
  8. from __future__ import annotations
  9. import os
  10. from typing import IO
  11. from . import Image, ImageFile
  12. from ._binary import i32be as i32
  13. from ._binary import o8
  14. from ._binary import o32be as o32
  15. def _accept(prefix: bytes) -> bool:
  16. return prefix.startswith(b"qoif")
  17. class QoiImageFile(ImageFile.ImageFile):
  18. format = "QOI"
  19. format_description = "Quite OK Image"
  20. def _open(self) -> None:
  21. if not _accept(self.fp.read(4)):
  22. msg = "not a QOI file"
  23. raise SyntaxError(msg)
  24. self._size = i32(self.fp.read(4)), i32(self.fp.read(4))
  25. channels = self.fp.read(1)[0]
  26. self._mode = "RGB" if channels == 3 else "RGBA"
  27. self.fp.seek(1, os.SEEK_CUR) # colorspace
  28. self.tile = [ImageFile._Tile("qoi", (0, 0) + self._size, self.fp.tell())]
  29. class QoiDecoder(ImageFile.PyDecoder):
  30. _pulls_fd = True
  31. _previous_pixel: bytes | bytearray | None = None
  32. _previously_seen_pixels: dict[int, bytes | bytearray] = {}
  33. def _add_to_previous_pixels(self, value: bytes | bytearray) -> None:
  34. self._previous_pixel = value
  35. r, g, b, a = value
  36. hash_value = (r * 3 + g * 5 + b * 7 + a * 11) % 64
  37. self._previously_seen_pixels[hash_value] = value
  38. def decode(self, buffer: bytes | Image.SupportsArrayInterface) -> tuple[int, int]:
  39. assert self.fd is not None
  40. self._previously_seen_pixels = {}
  41. self._previous_pixel = bytearray((0, 0, 0, 255))
  42. data = bytearray()
  43. bands = Image.getmodebands(self.mode)
  44. dest_length = self.state.xsize * self.state.ysize * bands
  45. while len(data) < dest_length:
  46. byte = self.fd.read(1)[0]
  47. value: bytes | bytearray
  48. if byte == 0b11111110 and self._previous_pixel: # QOI_OP_RGB
  49. value = bytearray(self.fd.read(3)) + self._previous_pixel[3:]
  50. elif byte == 0b11111111: # QOI_OP_RGBA
  51. value = self.fd.read(4)
  52. else:
  53. op = byte >> 6
  54. if op == 0: # QOI_OP_INDEX
  55. op_index = byte & 0b00111111
  56. value = self._previously_seen_pixels.get(
  57. op_index, bytearray((0, 0, 0, 0))
  58. )
  59. elif op == 1 and self._previous_pixel: # QOI_OP_DIFF
  60. value = bytearray(
  61. (
  62. (self._previous_pixel[0] + ((byte & 0b00110000) >> 4) - 2)
  63. % 256,
  64. (self._previous_pixel[1] + ((byte & 0b00001100) >> 2) - 2)
  65. % 256,
  66. (self._previous_pixel[2] + (byte & 0b00000011) - 2) % 256,
  67. self._previous_pixel[3],
  68. )
  69. )
  70. elif op == 2 and self._previous_pixel: # QOI_OP_LUMA
  71. second_byte = self.fd.read(1)[0]
  72. diff_green = (byte & 0b00111111) - 32
  73. diff_red = ((second_byte & 0b11110000) >> 4) - 8
  74. diff_blue = (second_byte & 0b00001111) - 8
  75. value = bytearray(
  76. tuple(
  77. (self._previous_pixel[i] + diff_green + diff) % 256
  78. for i, diff in enumerate((diff_red, 0, diff_blue))
  79. )
  80. )
  81. value += self._previous_pixel[3:]
  82. elif op == 3 and self._previous_pixel: # QOI_OP_RUN
  83. run_length = (byte & 0b00111111) + 1
  84. value = self._previous_pixel
  85. if bands == 3:
  86. value = value[:3]
  87. data += value * run_length
  88. continue
  89. self._add_to_previous_pixels(value)
  90. if bands == 3:
  91. value = value[:3]
  92. data += value
  93. self.set_as_raw(data)
  94. return -1, 0
  95. def _save(im: Image.Image, fp: IO[bytes], filename: str | bytes) -> None:
  96. if im.mode == "RGB":
  97. channels = 3
  98. elif im.mode == "RGBA":
  99. channels = 4
  100. else:
  101. msg = "Unsupported QOI image mode"
  102. raise ValueError(msg)
  103. colorspace = 0 if im.encoderinfo.get("colorspace") == "sRGB" else 1
  104. fp.write(b"qoif")
  105. fp.write(o32(im.size[0]))
  106. fp.write(o32(im.size[1]))
  107. fp.write(o8(channels))
  108. fp.write(o8(colorspace))
  109. ImageFile._save(im, fp, [ImageFile._Tile("qoi", (0, 0) + im.size)])
  110. class QoiEncoder(ImageFile.PyEncoder):
  111. _pushes_fd = True
  112. _previous_pixel: tuple[int, int, int, int] | None = None
  113. _previously_seen_pixels: dict[int, tuple[int, int, int, int]] = {}
  114. _run = 0
  115. def _write_run(self) -> bytes:
  116. data = o8(0b11000000 | (self._run - 1)) # QOI_OP_RUN
  117. self._run = 0
  118. return data
  119. def _delta(self, left: int, right: int) -> int:
  120. result = (left - right) & 255
  121. if result >= 128:
  122. result -= 256
  123. return result
  124. def encode(self, bufsize: int) -> tuple[int, int, bytes]:
  125. assert self.im is not None
  126. self._previously_seen_pixels = {0: (0, 0, 0, 0)}
  127. self._previous_pixel = (0, 0, 0, 255)
  128. data = bytearray()
  129. w, h = self.im.size
  130. bands = Image.getmodebands(self.mode)
  131. for y in range(h):
  132. for x in range(w):
  133. pixel = self.im.getpixel((x, y))
  134. if bands == 3:
  135. pixel = (*pixel, 255)
  136. if pixel == self._previous_pixel:
  137. self._run += 1
  138. if self._run == 62:
  139. data += self._write_run()
  140. else:
  141. if self._run:
  142. data += self._write_run()
  143. r, g, b, a = pixel
  144. hash_value = (r * 3 + g * 5 + b * 7 + a * 11) % 64
  145. if self._previously_seen_pixels.get(hash_value) == pixel:
  146. data += o8(hash_value) # QOI_OP_INDEX
  147. elif self._previous_pixel:
  148. self._previously_seen_pixels[hash_value] = pixel
  149. prev_r, prev_g, prev_b, prev_a = self._previous_pixel
  150. if prev_a == a:
  151. delta_r = self._delta(r, prev_r)
  152. delta_g = self._delta(g, prev_g)
  153. delta_b = self._delta(b, prev_b)
  154. if (
  155. -2 <= delta_r < 2
  156. and -2 <= delta_g < 2
  157. and -2 <= delta_b < 2
  158. ):
  159. data += o8(
  160. 0b01000000
  161. | (delta_r + 2) << 4
  162. | (delta_g + 2) << 2
  163. | (delta_b + 2)
  164. ) # QOI_OP_DIFF
  165. else:
  166. delta_gr = self._delta(delta_r, delta_g)
  167. delta_gb = self._delta(delta_b, delta_g)
  168. if (
  169. -8 <= delta_gr < 8
  170. and -32 <= delta_g < 32
  171. and -8 <= delta_gb < 8
  172. ):
  173. data += o8(
  174. 0b10000000 | (delta_g + 32)
  175. ) # QOI_OP_LUMA
  176. data += o8((delta_gr + 8) << 4 | (delta_gb + 8))
  177. else:
  178. data += o8(0b11111110) # QOI_OP_RGB
  179. data += bytes(pixel[:3])
  180. else:
  181. data += o8(0b11111111) # QOI_OP_RGBA
  182. data += bytes(pixel)
  183. self._previous_pixel = pixel
  184. if self._run:
  185. data += self._write_run()
  186. data += bytes((0, 0, 0, 0, 0, 0, 0, 1)) # padding
  187. return len(data), 0, data
  188. Image.register_open(QoiImageFile.format, QoiImageFile, _accept)
  189. Image.register_decoder("qoi", QoiDecoder)
  190. Image.register_extension(QoiImageFile.format, ".qoi")
  191. Image.register_save(QoiImageFile.format, _save)
  192. Image.register_encoder("qoi", QoiEncoder)