Pillow/src/PIL/BmpImagePlugin.py

381 lines
14 KiB
Python
Raw Normal View History

2010-07-31 06:52:47 +04:00
#
# The Python Imaging Library.
# $Id$
#
# BMP file handler
#
# Windows (and OS/2) native bitmap storage format.
#
# history:
# 1995-09-01 fl Created
# 1996-04-30 fl Added save
# 1997-08-27 fl Fixed save of 1-bit images
# 1998-03-06 fl Load P images as L where possible
# 1998-07-03 fl Load P images as 1 where possible
# 1998-12-29 fl Handle small palettes
# 2002-12-30 fl Fixed load of 1-bit palette images
# 2003-04-21 fl Fixed load of 1-bit monochrome images
# 2003-04-23 fl Added limited support for BI_BITFIELDS compression
#
# Copyright (c) 1997-2003 by Secret Labs AB
# Copyright (c) 1995-2003 by Fredrik Lundh
#
# See the README file for information on usage and redistribution.
#
from . import Image, ImageFile, ImagePalette
2019-03-21 16:28:20 +03:00
from ._binary import i8, i16le as i16, i32le as i32, o8, o16le as o16, o32le as o32
2010-07-31 06:52:47 +04:00
#
# --------------------------------------------------------------------
# Read BMP file
BIT2MODE = {
# bits => mode, rawmode
1: ("P", "P;1"),
4: ("P", "P;4"),
8: ("P", "P"),
16: ("RGB", "BGR;15"),
24: ("RGB", "BGR"),
32: ("RGB", "BGRX"),
2010-07-31 06:52:47 +04:00
}
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
def _accept(prefix):
return prefix[:2] == b"BM"
2010-07-31 06:52:47 +04:00
2014-08-26 17:47:10 +04:00
def _dib_accept(prefix):
return i32(prefix[:4]) in [12, 40, 64, 108, 124]
2018-10-24 22:24:03 +03:00
# =============================================================================
2010-07-31 06:52:47 +04:00
# Image plugin for the Windows BMP format.
2018-10-24 22:24:03 +03:00
# =============================================================================
2010-07-31 06:52:47 +04:00
class BmpImageFile(ImageFile.ImageFile):
""" Image plugin for the Windows Bitmap format (BMP) """
2015-04-01 22:38:18 +03:00
2018-10-24 22:24:03 +03:00
# ------------------------------------------------------------- Description
2015-03-05 01:06:21 +03:00
format_description = "Windows Bitmap"
format = "BMP"
2018-10-24 22:24:03 +03:00
# -------------------------------------------------- BMP Compression values
2019-03-21 16:28:20 +03:00
COMPRESSIONS = {"RAW": 0, "RLE8": 1, "RLE4": 2, "BITFIELDS": 3, "JPEG": 4, "PNG": 5}
2019-05-25 09:05:07 +03:00
for k, v in COMPRESSIONS.items():
vars()[k] = v
2010-07-31 06:52:47 +04:00
def _bitmap(self, header=0, offset=0):
""" Read relevant info about the BMP """
read, seek = self.fp.read, self.fp.seek
if header:
seek(header)
file_info = {}
2018-06-24 15:32:25 +03:00
# read bmp header size @offset 14 (this is part of the header size)
2019-03-21 16:28:20 +03:00
file_info["header_size"] = i32(read(4))
file_info["direction"] = -1
2018-10-24 22:24:03 +03:00
# -------------------- If requested, read header at a specific position
2018-06-24 15:32:25 +03:00
# read the rest of the bmp header, without its size
2019-03-21 16:28:20 +03:00
header_data = ImageFile._safe_read(self.fp, file_info["header_size"] - 4)
2018-10-24 22:24:03 +03:00
# -------------------------------------------------- IBM OS/2 Bitmap v1
# ----- This format has different offsets because of width/height types
2019-03-21 16:28:20 +03:00
if file_info["header_size"] == 12:
file_info["width"] = i16(header_data[0:2])
file_info["height"] = i16(header_data[2:4])
file_info["planes"] = i16(header_data[4:6])
file_info["bits"] = i16(header_data[6:8])
file_info["compression"] = self.RAW
file_info["palette_padding"] = 3
2018-10-24 22:24:03 +03:00
# --------------------------------------------- Windows Bitmap v2 to v5
# v3, OS/2 v2, v4, v5
2019-03-21 16:28:20 +03:00
elif file_info["header_size"] in (40, 64, 108, 124):
file_info["y_flip"] = i8(header_data[7]) == 0xFF
file_info["direction"] = 1 if file_info["y_flip"] else -1
file_info["width"] = i32(header_data[0:4])
file_info["height"] = (
i32(header_data[4:8])
if not file_info["y_flip"]
else 2 ** 32 - i32(header_data[4:8])
)
file_info["planes"] = i16(header_data[8:10])
file_info["bits"] = i16(header_data[10:12])
file_info["compression"] = i32(header_data[12:16])
2019-03-15 02:46:34 +03:00
# byte size of pixel data
2019-03-21 16:28:20 +03:00
file_info["data_size"] = i32(header_data[16:20])
file_info["pixels_per_meter"] = (
i32(header_data[20:24]),
i32(header_data[24:28]),
)
file_info["colors"] = i32(header_data[28:32])
file_info["palette_padding"] = 4
2019-03-15 02:46:34 +03:00
self.info["dpi"] = tuple(
2019-03-21 16:28:20 +03:00
int(x / 39.3701 + 0.5) for x in file_info["pixels_per_meter"]
)
if file_info["compression"] == self.BITFIELDS:
2019-03-15 02:46:34 +03:00
if len(header_data) >= 52:
2019-03-21 16:28:20 +03:00
for idx, mask in enumerate(
["r_mask", "g_mask", "b_mask", "a_mask"]
):
file_info[mask] = i32(header_data[36 + idx * 4 : 40 + idx * 4])
2019-03-15 02:46:34 +03:00
else:
# 40 byte headers only have the three components in the
# bitfields masks, ref:
# https://msdn.microsoft.com/en-us/library/windows/desktop/dd183376(v=vs.85).aspx
# See also
# https://github.com/python-pillow/Pillow/issues/1293
# There is a 4th component in the RGBQuad, in the alpha
# location, but it is listed as a reserved component,
# and it is not generally an alpha channel
2019-03-21 16:28:20 +03:00
file_info["a_mask"] = 0x0
for mask in ["r_mask", "g_mask", "b_mask"]:
2019-03-15 02:46:34 +03:00
file_info[mask] = i32(read(4))
2019-03-21 16:28:20 +03:00
file_info["rgb_mask"] = (
file_info["r_mask"],
file_info["g_mask"],
file_info["b_mask"],
)
file_info["rgba_mask"] = (
file_info["r_mask"],
file_info["g_mask"],
file_info["b_mask"],
file_info["a_mask"],
)
2010-07-31 06:52:47 +04:00
else:
raise OSError("Unsupported BMP header type (%d)" % file_info["header_size"])
2018-10-24 22:24:03 +03:00
2015-04-01 22:38:18 +03:00
# ------------------ Special case : header is reported 40, which
# ---------------------- is shorter than real size for bpp >= 16
2019-03-21 16:28:20 +03:00
self._size = file_info["width"], file_info["height"]
2018-10-24 22:24:03 +03:00
# ------- If color count was not found in the header, compute from bits
2019-03-21 16:28:20 +03:00
file_info["colors"] = (
file_info["colors"]
if file_info.get("colors", 0)
else (1 << file_info["bits"])
)
2018-10-24 22:24:03 +03:00
# ------------------------------- Check abnormal values for DOS attacks
2019-03-21 16:28:20 +03:00
if file_info["width"] * file_info["height"] > 2 ** 31:
raise OSError("Unsupported BMP Size: (%dx%d)" % self.size)
2018-10-24 22:24:03 +03:00
# ---------------------- Check bit depth for unusual unsupported values
2019-03-21 16:28:20 +03:00
self.mode, raw_mode = BIT2MODE.get(file_info["bits"], (None, None))
if self.mode is None:
raise OSError("Unsupported BMP pixel depth (%d)" % file_info["bits"])
2018-10-24 22:24:03 +03:00
# ---------------- Process BMP with Bitfields compression (not palette)
2019-03-21 16:28:20 +03:00
if file_info["compression"] == self.BITFIELDS:
SUPPORTED = {
2019-03-21 16:28:20 +03:00
32: [
(0xFF0000, 0xFF00, 0xFF, 0x0),
(0xFF0000, 0xFF00, 0xFF, 0xFF000000),
(0xFF, 0xFF00, 0xFF0000, 0xFF000000),
(0x0, 0x0, 0x0, 0x0),
(0xFF000000, 0xFF0000, 0xFF00, 0x0),
],
24: [(0xFF0000, 0xFF00, 0xFF)],
16: [(0xF800, 0x7E0, 0x1F), (0x7C00, 0x3E0, 0x1F)],
2015-12-30 23:27:27 +03:00
}
MASK_MODES = {
2019-03-21 16:28:20 +03:00
(32, (0xFF0000, 0xFF00, 0xFF, 0x0)): "BGRX",
(32, (0xFF000000, 0xFF0000, 0xFF00, 0x0)): "XBGR",
(32, (0xFF, 0xFF00, 0xFF0000, 0xFF000000)): "RGBA",
(32, (0xFF0000, 0xFF00, 0xFF, 0xFF000000)): "BGRA",
2015-12-10 01:23:04 +03:00
(32, (0x0, 0x0, 0x0, 0x0)): "BGRA",
2019-03-21 16:28:20 +03:00
(24, (0xFF0000, 0xFF00, 0xFF)): "BGR",
(16, (0xF800, 0x7E0, 0x1F)): "BGR;16",
(16, (0x7C00, 0x3E0, 0x1F)): "BGR;15",
2015-12-10 01:23:04 +03:00
}
2019-03-21 16:28:20 +03:00
if file_info["bits"] in SUPPORTED:
if (
file_info["bits"] == 32
and file_info["rgba_mask"] in SUPPORTED[file_info["bits"]]
):
raw_mode = MASK_MODES[(file_info["bits"], file_info["rgba_mask"])]
self.mode = "RGBA" if "A" in raw_mode else self.mode
2019-03-21 16:28:20 +03:00
elif (
file_info["bits"] in (24, 16)
and file_info["rgb_mask"] in SUPPORTED[file_info["bits"]]
):
raw_mode = MASK_MODES[(file_info["bits"], file_info["rgb_mask"])]
else:
raise OSError("Unsupported BMP bitfields layout")
2010-07-31 06:52:47 +04:00
else:
raise OSError("Unsupported BMP bitfields layout")
2019-03-21 16:28:20 +03:00
elif file_info["compression"] == self.RAW:
if file_info["bits"] == 32 and header == 22: # 32-bit .cur offset
raw_mode, self.mode = "BGRA", "RGBA"
else:
raise OSError("Unsupported BMP compression (%d)" % file_info["compression"])
2018-10-24 22:24:03 +03:00
# --------------- Once the header is processed, process the palette/LUT
if self.mode == "P": # Paletted for 1, 4 and 8 bit images
2018-10-24 22:24:03 +03:00
# ---------------------------------------------------- 1-bit images
2019-03-21 16:28:20 +03:00
if not (0 < file_info["colors"] <= 65536):
raise OSError("Unsupported BMP Palette size (%d)" % file_info["colors"])
2010-07-31 06:52:47 +04:00
else:
2019-03-21 16:28:20 +03:00
padding = file_info["palette_padding"]
palette = read(padding * file_info["colors"])
greyscale = True
2019-03-21 16:28:20 +03:00
indices = (
(0, 255)
if file_info["colors"] == 2
else list(range(file_info["colors"]))
)
2018-10-24 22:24:03 +03:00
# ----------------- Check if greyscale and ignore palette if so
for ind, val in enumerate(indices):
2019-03-21 16:28:20 +03:00
rgb = palette[ind * padding : ind * padding + 3]
if rgb != o8(val) * 3:
greyscale = False
2018-10-24 22:24:03 +03:00
# ------- If all colors are grey, white or black, ditch palette
if greyscale:
2019-03-21 16:28:20 +03:00
self.mode = "1" if file_info["colors"] == 2 else "L"
raw_mode = self.mode
2010-07-31 06:52:47 +04:00
else:
self.mode = "P"
2018-06-24 15:32:25 +03:00
self.palette = ImagePalette.raw(
2019-03-21 16:28:20 +03:00
"BGRX" if padding == 4 else "BGR", palette
)
2015-04-01 22:38:18 +03:00
2018-10-24 22:24:03 +03:00
# ---------------------------- Finally set the tile data for the plugin
2019-03-21 16:28:20 +03:00
self.info["compression"] = file_info["compression"]
2018-06-24 15:32:25 +03:00
self.tile = [
2019-03-21 16:28:20 +03:00
(
"raw",
(0, 0, file_info["width"], file_info["height"]),
offset or self.fp.tell(),
(
raw_mode,
((file_info["width"] * file_info["bits"] + 31) >> 3) & (~3),
file_info["direction"],
),
)
2018-06-24 15:32:25 +03:00
]
def _open(self):
""" Open file, check magic number and read header """
# read 14 bytes: magic number, filesize, reserved, header final offset
head_data = self.fp.read(14)
# choke if the file does not have the required magic bytes
if head_data[0:2] != b"BM":
raise SyntaxError("Not a BMP file")
2015-04-01 22:38:18 +03:00
# read the start position of the BMP image data (u32)
offset = i32(head_data[10:14])
# load bitmap information (offset=raster info)
self._bitmap(offset=offset)
2018-10-24 22:24:03 +03:00
# =============================================================================
# Image plugin for the DIB format (BMP alias)
2018-10-24 22:24:03 +03:00
# =============================================================================
2010-07-31 06:52:47 +04:00
class DibImageFile(BmpImageFile):
format = "DIB"
format_description = "Windows Bitmap"
def _open(self):
self._bitmap()
2019-03-21 16:28:20 +03:00
2010-07-31 06:52:47 +04:00
#
# --------------------------------------------------------------------
# Write BMP file
2018-03-03 12:54:00 +03:00
2010-07-31 06:52:47 +04:00
SAVE = {
"1": ("1", 1, 2),
"L": ("L", 8, 256),
"P": ("P", 8, 256),
"RGB": ("BGR", 24, 0),
"RGBA": ("BGRA", 32, 0),
2010-07-31 06:52:47 +04:00
}
def _dib_save(im, fp, filename):
_save(im, fp, filename, False)
def _save(im, fp, filename, bitmap_header=True):
2010-07-31 06:52:47 +04:00
try:
rawmode, bits, colors = SAVE[im.mode]
except KeyError:
raise OSError("cannot write mode %s as BMP" % im.mode)
2010-07-31 06:52:47 +04:00
info = im.encoderinfo
dpi = info.get("dpi", (96, 96))
# 1 meter == 39.3701 inches
2019-03-30 07:03:57 +03:00
ppm = tuple(map(lambda x: int(x * 39.3701 + 0.5), dpi))
2019-03-21 16:28:20 +03:00
stride = ((im.size[0] * bits + 7) // 8 + 3) & (~3)
2014-08-26 17:47:10 +04:00
header = 40 # or 64 for OS/2 version 2
image = stride * im.size[1]
2010-07-31 06:52:47 +04:00
# bitmap header
if bitmap_header:
offset = 14 + header + colors * 4
file_size = offset + image
if file_size > 2 ** 32 - 1:
raise ValueError("File size is too large for the BMP format")
2019-03-21 16:28:20 +03:00
fp.write(
2019-12-21 00:15:48 +03:00
b"BM" # file type (magic)
+ o32(file_size) # file size
2019-12-21 00:15:48 +03:00
+ o32(0) # reserved
+ o32(offset) # image data offset
)
2010-07-31 06:52:47 +04:00
# bitmap info header
2019-03-21 16:28:20 +03:00
fp.write(
o32(header) # info header size
+ o32(im.size[0]) # width
+ o32(im.size[1]) # height
+ o16(1) # planes
+ o16(bits) # depth
+ o32(0) # compression (0=uncompressed)
+ o32(image) # size of bitmap
+ o32(ppm[0]) # resolution
+ o32(ppm[1]) # resolution
+ o32(colors) # colors used
+ o32(colors) # colors important
)
fp.write(b"\0" * (header - 40)) # padding (for OS/2 format)
2010-07-31 06:52:47 +04:00
if im.mode == "1":
for i in (0, 255):
fp.write(o8(i) * 4)
2010-07-31 06:52:47 +04:00
elif im.mode == "L":
for i in range(256):
fp.write(o8(i) * 4)
2010-07-31 06:52:47 +04:00
elif im.mode == "P":
fp.write(im.im.getpalette("RGB", "BGRX"))
2019-03-21 16:28:20 +03:00
ImageFile._save(im, fp, [("raw", (0, 0) + im.size, 0, (rawmode, stride, -1))])
2010-07-31 06:52:47 +04:00
#
# --------------------------------------------------------------------
# Registry
2018-03-03 12:54:00 +03:00
2010-07-31 06:52:47 +04:00
Image.register_open(BmpImageFile.format, BmpImageFile, _accept)
Image.register_save(BmpImageFile.format, _save)
Image.register_extension(BmpImageFile.format, ".bmp")
2015-06-16 20:33:27 +03:00
Image.register_mime(BmpImageFile.format, "image/bmp")
Image.register_open(DibImageFile.format, DibImageFile, _dib_accept)
Image.register_save(DibImageFile.format, _dib_save)
Image.register_extension(DibImageFile.format, ".dib")
Image.register_mime(DibImageFile.format, "image/bmp")