Pillow/PIL/GifImagePlugin.py

688 lines
21 KiB
Python
Raw Normal View History

2010-07-31 06:52:47 +04:00
#
# The Python Imaging Library.
# $Id$
#
# GIF file handling
#
# History:
# 1995-09-01 fl Created
# 1996-12-14 fl Added interlace support
# 1996-12-30 fl Added animation support
# 1997-01-05 fl Added write support, fixed local colour map bug
# 1997-02-23 fl Make sure to load raster data in getdata()
# 1997-07-05 fl Support external decoder (0.4)
# 1998-07-09 fl Handle all modes when saving (0.5)
# 1998-07-15 fl Renamed offset attribute to avoid name clash
# 2001-04-16 fl Added rewind support (seek to frame 0) (0.6)
# 2001-04-17 fl Added palette optimization (0.7)
# 2002-06-06 fl Added transparency support for save (0.8)
# 2004-02-24 fl Disable interlacing for small images
#
# Copyright (c) 1997-2004 by Secret Labs AB
# Copyright (c) 1995-2004 by Fredrik Lundh
#
# See the README file for information on usage and redistribution.
#
from PIL import Image, ImageFile, ImagePalette, \
ImageChops, ImageSequence, _binary
2010-07-31 06:52:47 +04:00
__version__ = "0.9"
# --------------------------------------------------------------------
# Helpers
i8 = _binary.i8
i16 = _binary.i16le
o8 = _binary.o8
o16 = _binary.o16le
2010-07-31 06:52:47 +04:00
# --------------------------------------------------------------------
# Identify/read GIF files
def _accept(prefix):
return prefix[:6] in [b"GIF87a", b"GIF89a"]
2010-07-31 06:52:47 +04:00
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
##
# Image plugin for GIF images. This plugin supports both GIF87 and
# GIF89 images.
class GifImageFile(ImageFile.ImageFile):
format = "GIF"
format_description = "Compuserve GIF"
global_palette = None
def data(self):
s = self.fp.read(1)
if s and i8(s):
return self.fp.read(i8(s))
2010-07-31 06:52:47 +04:00
return None
def _open(self):
# Screen
s = self.fp.read(13)
if s[:6] not in [b"GIF87a", b"GIF89a"]:
raise SyntaxError("not a GIF file")
2010-07-31 06:52:47 +04:00
self.info["version"] = s[:6]
self.size = i16(s[6:]), i16(s[8:])
self.tile = []
flags = i8(s[10])
2010-07-31 06:52:47 +04:00
bits = (flags & 7) + 1
if flags & 128:
# get global palette
self.info["background"] = i8(s[11])
2010-07-31 06:52:47 +04:00
# check if palette contains colour indices
2014-08-26 17:47:10 +04:00
p = self.fp.read(3 << bits)
2010-07-31 06:52:47 +04:00
for i in range(0, len(p), 3):
if not (i//3 == i8(p[i]) == i8(p[i+1]) == i8(p[i+2])):
2010-07-31 06:52:47 +04:00
p = ImagePalette.raw("RGB", p)
self.global_palette = self.palette = p
break
2014-08-26 17:47:10 +04:00
self.__fp = self.fp # FIXME: hack
2010-07-31 06:52:47 +04:00
self.__rewind = self.fp.tell()
self._n_frames = None
2015-06-30 06:25:00 +03:00
self._is_animated = None
self._seek(0) # get ready to read first frame
@property
def n_frames(self):
if self._n_frames is None:
current = self.tell()
try:
while True:
self.seek(self.tell() + 1)
except EOFError:
self._n_frames = self.tell() + 1
self.seek(current)
return self._n_frames
2010-07-31 06:52:47 +04:00
2015-06-30 06:25:00 +03:00
@property
def is_animated(self):
if self._is_animated is None:
current = self.tell()
try:
self.seek(1)
self._is_animated = True
except EOFError:
self._is_animated = False
self.seek(current)
return self._is_animated
2010-07-31 06:52:47 +04:00
def seek(self, frame):
if frame == self.__frame:
return
if frame < self.__frame:
self._seek(0)
last_frame = self.__frame
for f in range(self.__frame + 1, frame + 1):
try:
self._seek(f)
except EOFError:
self.seek(last_frame)
raise EOFError("no more images in GIF file")
def _seek(self, frame):
2010-07-31 06:52:47 +04:00
if frame == 0:
# rewind
self.__offset = 0
self.dispose = None
2014-08-26 17:47:10 +04:00
self.dispose_extent = [0, 0, 0, 0] # x0, y0, x1, y1
2010-07-31 06:52:47 +04:00
self.__frame = -1
self.__fp.seek(self.__rewind)
self._prev_im = None
self.disposal_method = 0
else:
# ensure that the previous frame was loaded
if not self.im:
self.load()
2010-07-31 06:52:47 +04:00
if frame != self.__frame + 1:
raise ValueError("cannot seek to frame %d" % frame)
2010-07-31 06:52:47 +04:00
self.__frame = frame
self.tile = []
self.fp = self.__fp
if self.__offset:
# backup to last frame
self.fp.seek(self.__offset)
while self.data():
pass
self.__offset = 0
if self.dispose:
self.im.paste(self.dispose, self.dispose_extent)
2010-07-31 06:52:47 +04:00
from copy import copy
self.palette = copy(self.global_palette)
2010-07-31 06:52:47 +04:00
while True:
2010-07-31 06:52:47 +04:00
s = self.fp.read(1)
if not s or s == b";":
2010-07-31 06:52:47 +04:00
break
elif s == b"!":
2010-07-31 06:52:47 +04:00
#
# extensions
#
s = self.fp.read(1)
block = self.data()
if i8(s) == 249:
2010-07-31 06:52:47 +04:00
#
# graphic control extension
#
flags = i8(block[0])
2010-07-31 06:52:47 +04:00
if flags & 1:
self.info["transparency"] = i8(block[3])
2010-07-31 06:52:47 +04:00
self.info["duration"] = i16(block[1:3]) * 10
# disposal method - find the value of bits 4 - 6
dispose_bits = 0b00011100 & flags
dispose_bits = dispose_bits >> 2
if dispose_bits:
# only set the dispose if it is not
# unspecified. I'm not sure if this is
# correct, but it seems to prevent the last
# frame from looking odd for some animations
self.disposal_method = dispose_bits
elif i8(s) == 255:
2010-07-31 06:52:47 +04:00
#
# application extension
#
self.info["extension"] = block, self.fp.tell()
if block[:11] == b"NETSCAPE2.0":
2010-07-31 06:52:47 +04:00
block = self.data()
if len(block) >= 3 and i8(block[0]) == 1:
2010-07-31 06:52:47 +04:00
self.info["loop"] = i16(block[1:3])
while self.data():
pass
elif s == b",":
2010-07-31 06:52:47 +04:00
#
# local image
#
s = self.fp.read(9)
# extent
x0, y0 = i16(s[0:]), i16(s[2:])
x1, y1 = x0 + i16(s[4:]), y0 + i16(s[6:])
self.dispose_extent = x0, y0, x1, y1
flags = i8(s[8])
2010-07-31 06:52:47 +04:00
interlace = (flags & 64) != 0
if flags & 128:
bits = (flags & 7) + 1
self.palette =\
2014-08-26 17:47:10 +04:00
ImagePalette.raw("RGB", self.fp.read(3 << bits))
2010-07-31 06:52:47 +04:00
# image data
bits = i8(self.fp.read(1))
2010-07-31 06:52:47 +04:00
self.__offset = self.fp.tell()
self.tile = [("gif",
(x0, y0, x1, y1),
self.__offset,
(bits, interlace))]
break
else:
pass
# raise IOError, "illegal GIF tag `%x`" % i8(s)
2010-07-31 06:52:47 +04:00
try:
if self.disposal_method < 2:
# do not dispose or none specified
self.dispose = None
elif self.disposal_method == 2:
# replace with background colour
self.dispose = Image.core.fill("P", self.size,
self.info["background"])
else:
# replace with previous contents
if self.im:
self.dispose = self.im.copy()
# only dispose the extent in this frame
if self.dispose:
self.dispose = self.dispose.crop(self.dispose_extent)
except (AttributeError, KeyError):
pass
2010-07-31 06:52:47 +04:00
if not self.tile:
# self.__fp = None
raise EOFError
2010-07-31 06:52:47 +04:00
self.mode = "L"
if self.palette:
self.mode = "P"
def tell(self):
return self.__frame
def load_end(self):
ImageFile.ImageFile.load_end(self)
# if the disposal method is 'do not dispose', transparent
# pixels should show the content of the previous frame
if self._prev_im and self.disposal_method == 1:
# we do this by pasting the updated area onto the previous
# frame which we then use as the current image content
updated = self.im.crop(self.dispose_extent)
2014-08-26 17:47:10 +04:00
self._prev_im.paste(updated, self.dispose_extent,
updated.convert('RGBA'))
self.im = self._prev_im
self._prev_im = self.im.copy()
2010-07-31 06:52:47 +04:00
# --------------------------------------------------------------------
# Write GIF files
try:
import _imaging_gif
except ImportError:
_imaging_gif = None
RAWMODE = {
"1": "L",
"L": "L",
"P": "P",
}
2015-07-01 02:18:05 +03:00
2015-08-24 16:23:07 +03:00
def _convert_mode(im, initial_call=False):
2015-07-01 02:18:05 +03:00
# convert on the fly (EXPERIMENTAL -- I'm not sure PIL
# should automatically convert images on save...)
if Image.getmodebase(im.mode) == "RGB":
2015-08-24 16:23:07 +03:00
if initial_call:
palette_size = 256
if im.palette:
palette_size = len(im.palette.getdata()[1]) // 3
return im.convert("P", palette=1, colors=palette_size)
else:
return im.convert("P")
2015-07-01 02:18:05 +03:00
return im.convert("L")
2015-06-30 11:02:48 +03:00
def _save_all(im, fp, filename):
_save(im, fp, filename, save_all=True)
2014-08-26 17:47:10 +04:00
2015-07-01 02:18:05 +03:00
2015-06-30 11:02:48 +03:00
def _save(im, fp, filename, save_all=False):
2010-07-31 06:52:47 +04:00
im.encoderinfo.update(im.info)
2010-07-31 06:52:47 +04:00
if _imaging_gif:
# call external driver
try:
_imaging_gif.save(im, fp, filename)
return
except IOError:
2014-08-26 17:47:10 +04:00
pass # write uncompressed file
2010-07-31 06:52:47 +04:00
if im.mode in RAWMODE:
im_out = im.copy()
else:
2015-08-24 16:23:07 +03:00
im_out = _convert_mode(im, True)
2010-07-31 06:52:47 +04:00
# header
try:
palette = im.encoderinfo["palette"]
except KeyError:
palette = None
im.encoderinfo["optimize"] = im.encoderinfo.get("optimize", True)
2013-05-23 17:45:11 +04:00
2015-06-30 11:02:48 +03:00
if save_all:
previous = None
2010-07-31 06:52:47 +04:00
first_frame = None
2015-07-01 02:18:05 +03:00
for im_frame in ImageSequence.Iterator(im):
im_frame = _convert_mode(im_frame)
2015-06-30 11:02:48 +03:00
# To specify duration, add the time in milliseconds to getdata(),
# e.g. getdata(im_frame, duration=1000)
if not previous:
# global header
first_frame = getheader(im_frame, palette, im.encoderinfo)[0]
first_frame += getdata(im_frame, (0, 0), **im.encoderinfo)
2015-06-30 11:02:48 +03:00
else:
if first_frame:
for s in first_frame:
fp.write(s)
first_frame = None
2015-06-30 11:02:48 +03:00
# delta frame
2015-08-24 14:56:23 +03:00
delta = ImageChops.subtract_modulo(im_frame, previous.copy())
2015-06-30 11:02:48 +03:00
bbox = delta.getbbox()
if bbox:
# compress difference
for s in getdata(im_frame.crop(bbox),
bbox[:2], **im.encoderinfo):
2015-06-30 11:02:48 +03:00
fp.write(s)
else:
# FIXME: what should we do in this case?
pass
2015-08-24 14:56:23 +03:00
previous = im_frame
if first_frame:
save_all = False
if not save_all:
2015-06-30 11:02:48 +03:00
header = getheader(im_out, palette, im.encoderinfo)[0]
for s in header:
fp.write(s)
2015-06-30 11:02:48 +03:00
flags = 0
2015-06-30 11:02:48 +03:00
if get_interlace(im):
flags = flags | 64
2015-04-03 15:22:13 +03:00
2015-06-30 11:02:48 +03:00
# local image header
_get_local_header(fp, im, (0, 0), flags)
im_out.encoderconfig = (8, get_interlace(im))
ImageFile._save(im_out, fp, [("gif", (0, 0)+im.size, 0,
RAWMODE[im_out.mode])])
2015-04-03 15:22:13 +03:00
2015-06-30 11:02:48 +03:00
fp.write(b"\0") # end of image data
2015-04-03 15:22:13 +03:00
fp.write(b";") # end of file
2010-07-31 06:52:47 +04:00
2015-04-03 15:22:13 +03:00
try:
fp.flush()
except:
pass
2010-07-31 06:52:47 +04:00
2015-04-23 16:40:42 +03:00
2015-04-03 15:22:13 +03:00
def get_interlace(im):
2010-07-31 06:52:47 +04:00
try:
interlace = im.encoderinfo["interlace"]
except KeyError:
interlace = 1
# workaround for @PIL153
if min(im.size) < 16:
interlace = 0
2015-04-03 15:22:13 +03:00
return interlace
2010-07-31 06:52:47 +04:00
2015-06-30 11:02:48 +03:00
def _get_local_header(fp, im, offset, flags):
2015-04-03 15:22:13 +03:00
transparent_color_exists = False
2010-07-31 06:52:47 +04:00
try:
transparency = im.encoderinfo["transparency"]
except KeyError:
pass
else:
transparency = int(transparency)
# optimize the block away if transparent color is not used
2015-04-01 16:47:01 +03:00
transparent_color_exists = True
2010-07-31 06:52:47 +04:00
if _get_optimize(im, im.encoderinfo):
used_palette_colors = _get_used_palette_colors(im)
# adjust the transparency index after optimize
if len(used_palette_colors) < 256:
for i in range(len(used_palette_colors)):
if used_palette_colors[i] == transparency:
transparency = i
transparent_color_exists = True
break
else:
transparent_color_exists = False
2015-04-04 02:32:17 +03:00
if "duration" in im.encoderinfo:
2015-04-04 03:45:30 +03:00
duration = int(im.encoderinfo["duration"] / 10)
2015-04-03 15:22:13 +03:00
else:
duration = 0
if transparent_color_exists or duration != 0:
transparency_flag = 1 if transparent_color_exists else 0
if not transparent_color_exists:
transparency = 0
2015-04-23 16:40:42 +03:00
2015-04-03 15:22:13 +03:00
fp.write(b"!" +
2015-04-23 16:40:42 +03:00
o8(249) + # extension intro
o8(4) + # length
o8(transparency_flag) + # transparency info present
o16(duration) + # duration
o8(transparency) + # transparency index
2015-04-03 15:22:13 +03:00
o8(0))
2015-04-04 02:32:17 +03:00
if "loop" in im.encoderinfo:
number_of_loops = im.encoderinfo["loop"]
fp.write(b"!" +
2015-04-23 16:40:42 +03:00
o8(255) + # extension intro
2015-04-04 03:45:30 +03:00
o8(11) +
2015-04-04 02:32:17 +03:00
b"NETSCAPE2.0" +
o8(3) +
o8(1) +
2015-04-23 16:40:42 +03:00
o16(number_of_loops) + # number of loops
2015-04-04 02:32:17 +03:00
o8(0))
fp.write(b"," +
2015-04-23 16:40:42 +03:00
o16(offset[0]) + # offset
2015-04-03 15:22:13 +03:00
o16(offset[1]) +
2015-04-23 16:40:42 +03:00
o16(im.size[0]) + # size
2010-07-31 06:52:47 +04:00
o16(im.size[1]) +
2015-04-23 16:40:42 +03:00
o8(flags) + # flags
o8(8)) # bits
2013-05-23 17:45:11 +04:00
2010-07-31 06:52:47 +04:00
def _save_netpbm(im, fp, filename):
#
# If you need real GIF compression and/or RGB quantization, you
# can use the external NETPBM/PBMPLUS utilities. See comments
# below for information on how to enable this.
import os
2014-06-27 19:02:36 +04:00
from subprocess import Popen, check_call, PIPE, CalledProcessError
2014-08-26 17:47:10 +04:00
import tempfile
2010-07-31 06:52:47 +04:00
file = im._dump()
2010-07-31 06:52:47 +04:00
if im.mode != "RGB":
with open(filename, 'wb') as f:
stderr = tempfile.TemporaryFile()
check_call(["ppmtogif", file], stdout=f, stderr=stderr)
2010-07-31 06:52:47 +04:00
else:
with open(filename, 'wb') as f:
2014-06-27 19:02:36 +04:00
# Pipe ppmquant output into ppmtogif
# "ppmquant 256 %s | ppmtogif > %s" % (file, filename)
quant_cmd = ["ppmquant", "256", file]
togif_cmd = ["ppmtogif"]
stderr = tempfile.TemporaryFile()
quant_proc = Popen(quant_cmd, stdout=PIPE, stderr=stderr)
stderr = tempfile.TemporaryFile()
2014-08-26 17:47:10 +04:00
togif_proc = Popen(togif_cmd, stdin=quant_proc.stdout, stdout=f,
stderr=stderr)
2014-06-27 19:02:36 +04:00
# Allow ppmquant to receive SIGPIPE if ppmtogif exits
quant_proc.stdout.close()
retcode = quant_proc.wait()
if retcode:
raise CalledProcessError(retcode, quant_cmd)
retcode = togif_proc.wait()
if retcode:
raise CalledProcessError(retcode, togif_cmd)
try:
os.unlink(file)
2015-12-02 08:23:49 +03:00
except OSError:
pass
2010-07-31 06:52:47 +04:00
# --------------------------------------------------------------------
# GIF utilities
def _get_optimize(im, info):
return im.mode in ("P", "L") and info and info.get("optimize", 0)
def _get_used_palette_colors(im):
used_palette_colors = []
# check which colors are used
i = 0
for count in im.histogram():
if count:
used_palette_colors.append(i)
i += 1
return used_palette_colors
def getheader(im, palette=None, info=None):
2010-07-31 06:52:47 +04:00
"""Return a list of strings representing a GIF header"""
# Header Block
# http://www.matthewflickinger.com/lab/whatsinagif/bits_and_bytes.asp
version = b"87a"
for extensionKey in ["transparency", "duration", "loop"]:
if info and extensionKey in info and \
not (extensionKey == "duration" and info[extensionKey] == 0):
version = b"89a"
break
else:
if im.info.get("version") == "89a":
version = b"89a"
header = [
b"GIF"+version + # signature + version
o16(im.size[0]) + # canvas width
o16(im.size[1]) # canvas height
2010-07-31 06:52:47 +04:00
]
2013-05-23 17:45:11 +04:00
if im.mode == "P":
if palette and isinstance(palette, bytes):
2015-04-01 16:47:01 +03:00
source_palette = palette[:768]
else:
2015-04-01 16:47:01 +03:00
source_palette = im.im.getpalette("RGB")[:768]
2014-08-26 17:47:10 +04:00
else: # L-mode
if palette and isinstance(palette, bytes):
2015-04-01 16:47:01 +03:00
source_palette = palette[:768]
else:
2015-04-01 16:47:01 +03:00
source_palette = bytearray([i//3 for i in range(768)])
2015-04-01 16:47:01 +03:00
used_palette_colors = palette_bytes = None
if _get_optimize(im, info):
used_palette_colors = _get_used_palette_colors(im)
# create the new palette if not every color is used
2015-04-01 16:47:01 +03:00
if len(used_palette_colors) < 256:
palette_bytes = b""
new_positions = {}
i = 0
# pick only the used colors from the palette
2015-04-01 16:47:01 +03:00
for oldPosition in used_palette_colors:
palette_bytes += source_palette[oldPosition*3:oldPosition*3+3]
new_positions[oldPosition] = i
i += 1
2013-05-23 17:45:11 +04:00
# replace the palette color id of all pixel with the new id
2015-04-01 16:47:01 +03:00
image_bytes = bytearray(im.tobytes())
for i in range(len(image_bytes)):
image_bytes[i] = new_positions[image_bytes[i]]
im.frombytes(bytes(image_bytes))
new_palette_bytes = (palette_bytes +
(768 - len(palette_bytes)) * b'\x00')
im.putpalette(new_palette_bytes)
im.palette = ImagePalette.ImagePalette("RGB",
palette=palette_bytes,
size=len(palette_bytes))
if not palette_bytes:
palette_bytes = source_palette
# Logical Screen Descriptor
# calculate the palette size for the header
import math
2015-04-01 16:47:01 +03:00
color_table_size = int(math.ceil(math.log(len(palette_bytes)//3, 2)))-1
if color_table_size < 0:
color_table_size = 0
# size of global color table + global color table flag
2015-04-01 16:47:01 +03:00
header.append(o8(color_table_size + 128))
# background + reserved/aspect
if info and "background" in info:
background = info["background"]
elif "background" in im.info:
# This elif is redundant within GifImagePlugin
# since im.info parameters are bundled into the info dictionary
# However, external scripts may call getheader directly
# So this maintains earlier behaviour
background = im.info["background"]
else:
background = 0
header.append(o8(background) + o8(0))
# end of Logical Screen Descriptor
2013-05-23 17:45:11 +04:00
# add the missing amount of bytes
2013-05-23 16:31:48 +04:00
# the palette has to be 2<<n in size
2015-04-01 16:47:01 +03:00
actual_target_size_diff = (2 << color_table_size) - len(palette_bytes)//3
if actual_target_size_diff > 0:
palette_bytes += o8(0) * 3 * actual_target_size_diff
2013-05-23 17:45:11 +04:00
# Header + Logical Screen Descriptor + Global Color Table
2015-04-01 16:47:01 +03:00
header.append(palette_bytes)
return header, used_palette_colors
2013-05-23 17:45:11 +04:00
2010-07-31 06:52:47 +04:00
2014-08-26 17:47:10 +04:00
def getdata(im, offset=(0, 0), **params):
2010-07-31 06:52:47 +04:00
"""Return a list of strings representing this image.
The first string is a local image header, the rest contains
encoded image data."""
2015-05-26 17:07:21 +03:00
class Collector(object):
2010-07-31 06:52:47 +04:00
data = []
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
def write(self, data):
self.data.append(data)
2014-08-26 17:47:10 +04:00
im.load() # make sure raster data is available
2010-07-31 06:52:47 +04:00
2015-04-01 16:47:01 +03:00
fp = Collector()
2010-07-31 06:52:47 +04:00
try:
im.encoderinfo = params
# local image header
2015-06-30 11:02:48 +03:00
_get_local_header(fp, im, offset, 0)
2010-07-31 06:52:47 +04:00
2014-08-26 17:47:10 +04:00
ImageFile._save(im, fp, [("gif", (0, 0)+im.size, 0, RAWMODE[im.mode])])
2010-07-31 06:52:47 +04:00
2014-08-26 17:47:10 +04:00
fp.write(b"\0") # end of image data
2010-07-31 06:52:47 +04:00
finally:
del im.encoderinfo
return fp.data
# --------------------------------------------------------------------
# Registry
Image.register_open(GifImageFile.format, GifImageFile, _accept)
Image.register_save(GifImageFile.format, _save)
2015-06-30 11:02:48 +03:00
Image.register_save_all(GifImageFile.format, _save_all)
2010-07-31 06:52:47 +04:00
Image.register_extension(GifImageFile.format, ".gif")
Image.register_mime(GifImageFile.format, "image/gif")
#
# Uncomment the following line if you wish to use NETPBM/PBMPLUS
# instead of the built-in "uncompressed" GIF encoder
# Image.register_save(GifImageFile.format, _save_netpbm)