MspImagePlugin.py 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. #
  2. # The Python Imaging Library.
  3. #
  4. # MSP file handling
  5. #
  6. # This is the format used by the Paint program in Windows 1 and 2.
  7. #
  8. # History:
  9. # 95-09-05 fl Created
  10. # 97-01-03 fl Read/write MSP images
  11. # 17-02-21 es Fixed RLE interpretation
  12. #
  13. # Copyright (c) Secret Labs AB 1997.
  14. # Copyright (c) Fredrik Lundh 1995-97.
  15. # Copyright (c) Eric Soroos 2017.
  16. #
  17. # See the README file for information on usage and redistribution.
  18. #
  19. # More info on this format: https://archive.org/details/gg243631
  20. # Page 313:
  21. # Figure 205. Windows Paint Version 1: "DanM" Format
  22. # Figure 206. Windows Paint Version 2: "LinS" Format. Used in Windows V2.03
  23. #
  24. # See also: http://www.fileformat.info/format/mspaint/egff.htm
  25. import io
  26. import struct
  27. from . import Image, ImageFile
  28. from ._binary import i8, i16le as i16, o16le as o16
  29. # __version__ is deprecated and will be removed in a future version. Use
  30. # PIL.__version__ instead.
  31. __version__ = "0.1"
  32. #
  33. # read MSP files
  34. def _accept(prefix):
  35. return prefix[:4] in [b"DanM", b"LinS"]
  36. ##
  37. # Image plugin for Windows MSP images. This plugin supports both
  38. # uncompressed (Windows 1.0).
  39. class MspImageFile(ImageFile.ImageFile):
  40. format = "MSP"
  41. format_description = "Windows Paint"
  42. def _open(self):
  43. # Header
  44. s = self.fp.read(32)
  45. if s[:4] not in [b"DanM", b"LinS"]:
  46. raise SyntaxError("not an MSP file")
  47. # Header checksum
  48. checksum = 0
  49. for i in range(0, 32, 2):
  50. checksum = checksum ^ i16(s[i : i + 2])
  51. if checksum != 0:
  52. raise SyntaxError("bad MSP checksum")
  53. self.mode = "1"
  54. self._size = i16(s[4:]), i16(s[6:])
  55. if s[:4] == b"DanM":
  56. self.tile = [("raw", (0, 0) + self.size, 32, ("1", 0, 1))]
  57. else:
  58. self.tile = [("MSP", (0, 0) + self.size, 32, None)]
  59. class MspDecoder(ImageFile.PyDecoder):
  60. # The algo for the MSP decoder is from
  61. # http://www.fileformat.info/format/mspaint/egff.htm
  62. # cc-by-attribution -- That page references is taken from the
  63. # Encyclopedia of Graphics File Formats and is licensed by
  64. # O'Reilly under the Creative Common/Attribution license
  65. #
  66. # For RLE encoded files, the 32byte header is followed by a scan
  67. # line map, encoded as one 16bit word of encoded byte length per
  68. # line.
  69. #
  70. # NOTE: the encoded length of the line can be 0. This was not
  71. # handled in the previous version of this encoder, and there's no
  72. # mention of how to handle it in the documentation. From the few
  73. # examples I've seen, I've assumed that it is a fill of the
  74. # background color, in this case, white.
  75. #
  76. #
  77. # Pseudocode of the decoder:
  78. # Read a BYTE value as the RunType
  79. # If the RunType value is zero
  80. # Read next byte as the RunCount
  81. # Read the next byte as the RunValue
  82. # Write the RunValue byte RunCount times
  83. # If the RunType value is non-zero
  84. # Use this value as the RunCount
  85. # Read and write the next RunCount bytes literally
  86. #
  87. # e.g.:
  88. # 0x00 03 ff 05 00 01 02 03 04
  89. # would yield the bytes:
  90. # 0xff ff ff 00 01 02 03 04
  91. #
  92. # which are then interpreted as a bit packed mode '1' image
  93. _pulls_fd = True
  94. def decode(self, buffer):
  95. img = io.BytesIO()
  96. blank_line = bytearray((0xFF,) * ((self.state.xsize + 7) // 8))
  97. try:
  98. self.fd.seek(32)
  99. rowmap = struct.unpack_from(
  100. "<%dH" % (self.state.ysize), self.fd.read(self.state.ysize * 2)
  101. )
  102. except struct.error:
  103. raise IOError("Truncated MSP file in row map")
  104. for x, rowlen in enumerate(rowmap):
  105. try:
  106. if rowlen == 0:
  107. img.write(blank_line)
  108. continue
  109. row = self.fd.read(rowlen)
  110. if len(row) != rowlen:
  111. raise IOError(
  112. "Truncated MSP file, expected %d bytes on row %s", (rowlen, x)
  113. )
  114. idx = 0
  115. while idx < rowlen:
  116. runtype = i8(row[idx])
  117. idx += 1
  118. if runtype == 0:
  119. (runcount, runval) = struct.unpack_from("Bc", row, idx)
  120. img.write(runval * runcount)
  121. idx += 2
  122. else:
  123. runcount = runtype
  124. img.write(row[idx : idx + runcount])
  125. idx += runcount
  126. except struct.error:
  127. raise IOError("Corrupted MSP file in row %d" % x)
  128. self.set_as_raw(img.getvalue(), ("1", 0, 1))
  129. return 0, 0
  130. Image.register_decoder("MSP", MspDecoder)
  131. #
  132. # write MSP files (uncompressed only)
  133. def _save(im, fp, filename):
  134. if im.mode != "1":
  135. raise IOError("cannot write mode %s as MSP" % im.mode)
  136. # create MSP header
  137. header = [0] * 16
  138. header[0], header[1] = i16(b"Da"), i16(b"nM") # version 1
  139. header[2], header[3] = im.size
  140. header[4], header[5] = 1, 1
  141. header[6], header[7] = 1, 1
  142. header[8], header[9] = im.size
  143. checksum = 0
  144. for h in header:
  145. checksum = checksum ^ h
  146. header[12] = checksum # FIXME: is this the right field?
  147. # header
  148. for h in header:
  149. fp.write(o16(h))
  150. # image body
  151. ImageFile._save(im, fp, [("raw", (0, 0) + im.size, 32, ("1", 0, 1))])
  152. #
  153. # registry
  154. Image.register_open(MspImageFile.format, MspImageFile, _accept)
  155. Image.register_save(MspImageFile.format, _save)
  156. Image.register_extension(MspImageFile.format, ".msp")