2013-10-07 05:56:28 +04:00
|
|
|
|
.. _image-file-formats:
|
|
|
|
|
|
|
|
|
|
Image file formats
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
The Python Imaging Library supports a wide variety of raster file formats.
|
2015-12-29 16:05:36 +03:00
|
|
|
|
Over 30 different file formats can be identified and read by the library.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
Write support is less extensive, but most common interchange and presentation
|
|
|
|
|
formats are supported.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` function identifies files from their
|
|
|
|
|
contents, not their names, but the :py:meth:`~PIL.Image.Image.save` method
|
|
|
|
|
looks at the name to determine which format to use, unless the format is given
|
|
|
|
|
explicitly.
|
|
|
|
|
|
|
|
|
|
Fully supported formats
|
|
|
|
|
-----------------------
|
|
|
|
|
|
2016-09-03 05:19:04 +03:00
|
|
|
|
.. contents::
|
2016-08-07 14:31:09 +03:00
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
BMP
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes Windows and OS/2 BMP files containing ``1``, ``L``, ``P``,
|
|
|
|
|
or ``RGB`` data. 16-colour images are read as ``P`` images. Run-length encoding
|
|
|
|
|
is not supported.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**compression**
|
|
|
|
|
Set to ``bmp_rle`` if the file is run-length encoded.
|
|
|
|
|
|
|
|
|
|
EPS
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies EPS files containing image data, and can read files that contain
|
|
|
|
|
embedded raster images (ImageData descriptors). If Ghostscript is available,
|
2016-05-27 00:25:37 +03:00
|
|
|
|
other EPS files can be read as well. The EPS driver can also write EPS
|
|
|
|
|
images. The EPS driver can read EPS images in ``L``, ``LAB``, ``RGB`` and
|
|
|
|
|
``CMYK`` mode, but Ghostscript may convert the images to ``RGB`` mode rather
|
|
|
|
|
than leaving them in the original color space. The EPS driver can write images
|
|
|
|
|
in ``L``, ``RGB`` and ``CMYK`` modes.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2013-11-20 11:14:51 +04:00
|
|
|
|
If Ghostscript is available, you can call the :py:meth:`~PIL.Image.Image.load`
|
|
|
|
|
method with the following parameter to affect how Ghostscript renders the EPS
|
|
|
|
|
|
|
|
|
|
**scale**
|
|
|
|
|
Affects the scale of the resultant rasterized image. If the EPS suggests
|
|
|
|
|
that the image be rendered at 100px x 100px, setting this parameter to
|
|
|
|
|
2 will make the Ghostscript render a 200px x 200px image instead. The
|
|
|
|
|
relative position of the bounding box is maintained::
|
|
|
|
|
|
|
|
|
|
im = Image.open(...)
|
|
|
|
|
im.size #(100,100)
|
|
|
|
|
im.load(scale=2)
|
|
|
|
|
im.size #(200,200)
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
GIF
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads GIF87a and GIF89a versions of the GIF file format. The library writes
|
2015-09-18 14:41:36 +03:00
|
|
|
|
run-length encoded files in GIF87a by default, unless GIF89a features
|
|
|
|
|
are used or GIF89a is already in use.
|
|
|
|
|
|
|
|
|
|
Note that GIF files are always read as grayscale (``L``)
|
|
|
|
|
or palette mode (``P``) images.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**background**
|
|
|
|
|
Default background color (a palette color index).
|
|
|
|
|
|
|
|
|
|
**transparency**
|
|
|
|
|
Transparency color index. This key is omitted if the image is not
|
|
|
|
|
transparent.
|
|
|
|
|
|
|
|
|
|
**version**
|
|
|
|
|
Version (either ``GIF87a`` or ``GIF89a``).
|
|
|
|
|
|
2017-02-14 12:27:02 +03:00
|
|
|
|
**duration**
|
2016-12-27 14:09:55 +03:00
|
|
|
|
May not be present. The time to display the current frame
|
|
|
|
|
of the GIF, in milliseconds.
|
2015-09-18 14:41:36 +03:00
|
|
|
|
|
|
|
|
|
**loop**
|
|
|
|
|
May not be present. The number of times the GIF should loop.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
Reading sequences
|
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The GIF loader supports the :py:meth:`~file.seek` and :py:meth:`~file.tell`
|
2015-06-28 14:04:46 +03:00
|
|
|
|
methods. You can seek to the next frame (``im.seek(im.tell() + 1)``), or rewind
|
2015-09-18 14:41:36 +03:00
|
|
|
|
the file by seeking to the first frame. Random access is not supported.
|
|
|
|
|
|
|
|
|
|
``im.seek()`` raises an ``EOFError`` if you try to seek after the last frame.
|
|
|
|
|
|
2016-12-27 14:09:55 +03:00
|
|
|
|
Saving
|
|
|
|
|
~~~~~~
|
2015-09-18 14:41:36 +03:00
|
|
|
|
|
2016-12-27 14:09:55 +03:00
|
|
|
|
When calling :py:meth:`~PIL.Image.Image.save`, the following options
|
|
|
|
|
are available::
|
2016-09-23 15:00:31 +03:00
|
|
|
|
|
|
|
|
|
im.save(out, save_all=True, append_images=[im1, im2, ...])
|
2015-09-18 14:41:36 +03:00
|
|
|
|
|
2016-12-27 14:09:55 +03:00
|
|
|
|
**save_all**
|
|
|
|
|
If present and true, all frames of the image will be saved. If
|
|
|
|
|
not, then only the first frame of a multiframe image will be saved.
|
|
|
|
|
|
|
|
|
|
**append_images**
|
|
|
|
|
A list of images to append as additional frames. Each of the
|
|
|
|
|
images in the list can be single or multiframe images.
|
2017-07-01 14:34:41 +03:00
|
|
|
|
This is currently only supported for GIF, PDF and TIFF.
|
2016-12-27 14:09:55 +03:00
|
|
|
|
|
|
|
|
|
**duration**
|
|
|
|
|
The display duration of each frame of the multiframe gif, in
|
|
|
|
|
milliseconds. Pass a single integer for a constant duration, or a
|
|
|
|
|
list or tuple to set the duration for each frame separately.
|
|
|
|
|
|
|
|
|
|
**loop**
|
|
|
|
|
Integer number of times the GIF should loop.
|
|
|
|
|
|
|
|
|
|
**optimize**
|
|
|
|
|
If present and true, attempt to compress the palette by
|
|
|
|
|
eliminating unused colors. This is only useful if the palette can
|
|
|
|
|
be compressed to the next smaller power of 2 elements.
|
|
|
|
|
|
2017-06-13 23:08:46 +03:00
|
|
|
|
**palette**
|
2017-03-07 01:46:55 +03:00
|
|
|
|
Use the specified palette for the saved image. The palette should
|
|
|
|
|
be a bytes or bytearray object containing the palette entries in
|
|
|
|
|
RGBRGB... form. It should be no more than 768 bytes. Alternately,
|
|
|
|
|
the palette can be passed in as an
|
|
|
|
|
:py:class:`PIL.ImagePalette.ImagePalette` object.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
Reading local images
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The GIF loader creates an image memory the same size as the GIF file’s *logical
|
|
|
|
|
screen size*, and pastes the actual pixel data (the *local image*) into this
|
|
|
|
|
image. If you only want the actual pixel rectangle, you can manipulate the
|
|
|
|
|
:py:attr:`~PIL.Image.Image.size` and :py:attr:`~PIL.Image.Image.tile`
|
|
|
|
|
attributes before loading the file::
|
|
|
|
|
|
|
|
|
|
im = Image.open(...)
|
|
|
|
|
|
|
|
|
|
if im.tile[0][0] == "gif":
|
|
|
|
|
# only read the first "local image" from this GIF file
|
|
|
|
|
tag, (x0, y0, x1, y1), offset, extra = im.tile[0]
|
|
|
|
|
im.size = (x1 - x0, y1 - y0)
|
|
|
|
|
im.tile = [(tag, (0, 0) + im.size, offset, extra)]
|
|
|
|
|
|
2015-12-29 15:51:05 +03:00
|
|
|
|
ICNS
|
|
|
|
|
^^^^
|
|
|
|
|
|
2016-09-23 14:12:03 +03:00
|
|
|
|
PIL reads and (macOS only) writes macOS ``.icns`` files. By default, the
|
2015-12-29 15:51:05 +03:00
|
|
|
|
largest available icon is read, though you can override this by setting the
|
|
|
|
|
:py:attr:`~PIL.Image.Image.size` property before calling
|
|
|
|
|
:py:meth:`~PIL.Image.Image.load`. The :py:meth:`~PIL.Image.Image.open` method
|
|
|
|
|
sets the following :py:attr:`~PIL.Image.Image.info` property:
|
|
|
|
|
|
|
|
|
|
**sizes**
|
|
|
|
|
A list of supported sizes found in this icon file; these are a
|
|
|
|
|
3-tuple, ``(width, height, scale)``, where ``scale`` is 2 for a retina
|
|
|
|
|
icon and 1 for a standard icon. You *are* permitted to use this 3-tuple
|
|
|
|
|
format for the :py:attr:`~PIL.Image.Image.size` property if you set it
|
|
|
|
|
before calling :py:meth:`~PIL.Image.Image.load`; after loading, the size
|
|
|
|
|
will be reset to a 2-tuple containing pixel dimensions (so, e.g. if you
|
|
|
|
|
ask for ``(512, 512, 2)``, the final value of
|
|
|
|
|
:py:attr:`~PIL.Image.Image.size` will be ``(1024, 1024)``).
|
|
|
|
|
|
2016-10-26 21:41:40 +03:00
|
|
|
|
ICO
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
ICO is used to store icons on Windows. The largest available icon is read.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method supports the following options:
|
|
|
|
|
|
|
|
|
|
**sizes**
|
|
|
|
|
A list of sizes including in this ico file; these are a 2-tuple,
|
|
|
|
|
``(width, height)``; Default to ``[(16, 16), (24, 24), (32, 32), (48, 48),
|
2016-10-28 11:59:40 +03:00
|
|
|
|
(64, 64), (128, 128), (255, 255)]``. Any sizes bigger than the original
|
2016-10-26 21:41:40 +03:00
|
|
|
|
size or 255 will be ignored.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
IM
|
|
|
|
|
^^
|
|
|
|
|
|
|
|
|
|
IM is a format used by LabEye and other applications based on the IFUNC image
|
|
|
|
|
processing library. The library reads and writes most uncompressed interchange
|
|
|
|
|
versions of this format.
|
|
|
|
|
|
|
|
|
|
IM is the only format that can store all internal PIL formats.
|
|
|
|
|
|
|
|
|
|
JPEG
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
PIL reads JPEG, JFIF, and Adobe JPEG files containing ``L``, ``RGB``, or
|
|
|
|
|
``CMYK`` data. It writes standard and progressive JFIF files.
|
|
|
|
|
|
|
|
|
|
Using the :py:meth:`~PIL.Image.Image.draft` method, you can speed things up by
|
|
|
|
|
converting ``RGB`` images to ``L``, and resize images to 1/2, 1/4 or 1/8 of
|
2015-04-03 00:28:25 +03:00
|
|
|
|
their original size while loading them.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2014-09-25 03:30:39 +04:00
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method may set the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties if available:
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
**jfif**
|
|
|
|
|
JFIF application marker found. If the file is not a JFIF file, this key is
|
|
|
|
|
not present.
|
|
|
|
|
|
2014-09-25 03:30:39 +04:00
|
|
|
|
**jfif_version**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
A tuple representing the jfif version, (major version, minor version).
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
|
|
|
|
**jfif_density**
|
|
|
|
|
A tuple representing the pixel density of the image, in units specified
|
|
|
|
|
by jfif_unit.
|
|
|
|
|
|
|
|
|
|
**jfif_unit**
|
|
|
|
|
Units for the jfif_density:
|
|
|
|
|
|
|
|
|
|
* 0 - No Units
|
|
|
|
|
* 1 - Pixels per Inch
|
|
|
|
|
* 2 - Pixels per Centimeter
|
|
|
|
|
|
|
|
|
|
**dpi**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
A tuple representing the reported pixel density in pixels per inch, if
|
|
|
|
|
the file is a jfif file and the units are in inches.
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
**adobe**
|
|
|
|
|
Adobe application marker found. If the file is not an Adobe JPEG file, this
|
|
|
|
|
key is not present.
|
|
|
|
|
|
2014-09-25 03:30:39 +04:00
|
|
|
|
**adobe_transform**
|
|
|
|
|
Vendor Specific Tag.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
**progression**
|
|
|
|
|
Indicates that this is a progressive JPEG file.
|
|
|
|
|
|
2016-03-28 05:32:49 +03:00
|
|
|
|
**icc_profile**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
The ICC color profile for the image.
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
|
|
|
|
**exif**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
Raw EXIF data from the image.
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method supports the following options:
|
|
|
|
|
|
|
|
|
|
**quality**
|
|
|
|
|
The image quality, on a scale from 1 (worst) to 95 (best). The default is
|
|
|
|
|
75. Values above 95 should be avoided; 100 disables portions of the JPEG
|
2014-08-15 14:58:54 +04:00
|
|
|
|
compression algorithm, and results in large files with hardly any gain in
|
2013-10-07 05:56:28 +04:00
|
|
|
|
image quality.
|
|
|
|
|
|
|
|
|
|
**optimize**
|
2016-09-25 14:22:38 +03:00
|
|
|
|
If present and true, indicates that the encoder should make an extra pass
|
|
|
|
|
over the image in order to select optimal encoder settings.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
**progressive**
|
2016-09-25 14:22:38 +03:00
|
|
|
|
If present and true, indicates that this image should be stored as a
|
|
|
|
|
progressive JPEG file.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2014-09-25 03:30:39 +04:00
|
|
|
|
**dpi**
|
|
|
|
|
A tuple of integers representing the pixel density, ``(x,y)``.
|
|
|
|
|
|
2016-03-28 05:32:49 +03:00
|
|
|
|
**icc_profile**
|
2016-09-25 14:22:38 +03:00
|
|
|
|
If present and true, the image is stored with the provided ICC profile.
|
|
|
|
|
If this parameter is not provided, the image will be saved with no profile
|
|
|
|
|
attached. To preserve the existing profile::
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
|
|
|
|
im.save(filename, 'jpeg', icc_profile=im.info.get('icc_profile'))
|
|
|
|
|
|
|
|
|
|
**exif**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
If present, the image will be stored with the provided raw EXIF data.
|
2014-09-25 03:30:39 +04:00
|
|
|
|
|
2014-06-20 12:39:42 +04:00
|
|
|
|
**subsampling**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
If present, sets the subsampling for the encoder.
|
|
|
|
|
|
2014-06-20 12:39:42 +04:00
|
|
|
|
* ``keep``: Only valid for JPEG files, will retain the original image setting.
|
|
|
|
|
* ``4:4:4``, ``4:2:2``, ``4:1:1``: Specific sampling values
|
|
|
|
|
* ``-1``: equivalent to ``keep``
|
|
|
|
|
* ``0``: equivalent to ``4:4:4``
|
|
|
|
|
* ``1``: equivalent to ``4:2:2``
|
|
|
|
|
* ``2``: equivalent to ``4:1:1``
|
|
|
|
|
|
|
|
|
|
**qtables**
|
|
|
|
|
If present, sets the qtables for the encoder. This is listed as an
|
|
|
|
|
advanced option for wizards in the JPEG documentation. Use with
|
|
|
|
|
caution. ``qtables`` can be one of several types of values:
|
|
|
|
|
|
|
|
|
|
* a string, naming a preset, e.g. ``keep``, ``web_low``, or ``web_high``
|
|
|
|
|
* a list, tuple, or dictionary (with integer keys =
|
|
|
|
|
range(len(keys))) of lists of 64 integers. There must be
|
2015-01-15 21:14:30 +03:00
|
|
|
|
between 2 and 4 tables.
|
2014-06-20 12:39:42 +04:00
|
|
|
|
|
|
|
|
|
.. versionadded:: 2.5.0
|
|
|
|
|
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
To enable JPEG support, you need to build and install the IJG JPEG library
|
|
|
|
|
before building the Python Imaging Library. See the distribution README for
|
|
|
|
|
details.
|
|
|
|
|
|
2014-03-14 20:39:09 +04:00
|
|
|
|
JPEG 2000
|
|
|
|
|
^^^^^^^^^
|
|
|
|
|
|
2014-04-02 09:21:01 +04:00
|
|
|
|
.. versionadded:: 2.4.0
|
|
|
|
|
|
2014-03-14 20:39:09 +04:00
|
|
|
|
PIL reads and writes JPEG 2000 files containing ``L``, ``LA``, ``RGB`` or
|
|
|
|
|
``RGBA`` data. It can also read files containing ``YCbCr`` data, which it
|
|
|
|
|
converts on read into ``RGB`` or ``RGBA`` depending on whether or not there is
|
|
|
|
|
an alpha channel. PIL supports JPEG 2000 raw codestreams (``.j2k`` files), as
|
|
|
|
|
well as boxed JPEG 2000 files (``.j2p`` or ``.jpx`` files). PIL does *not*
|
|
|
|
|
support files whose components have different sampling frequencies.
|
|
|
|
|
|
|
|
|
|
When loading, if you set the ``mode`` on the image prior to the
|
|
|
|
|
:py:meth:`~PIL.Image.Image.load` method being invoked, you can ask PIL to
|
|
|
|
|
convert the image to either ``RGB`` or ``RGBA`` rather than choosing for
|
|
|
|
|
itself. It is also possible to set ``reduce`` to the number of resolutions to
|
|
|
|
|
discard (each one reduces the size of the resulting image by a factor of 2),
|
|
|
|
|
and ``layers`` to specify the number of quality layers to load.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method supports the following options:
|
|
|
|
|
|
|
|
|
|
**offset**
|
|
|
|
|
The image offset, as a tuple of integers, e.g. (16, 16)
|
|
|
|
|
|
|
|
|
|
**tile_offset**
|
|
|
|
|
The tile offset, again as a 2-tuple of integers.
|
|
|
|
|
|
|
|
|
|
**tile_size**
|
|
|
|
|
The tile size as a 2-tuple. If not specified, or if set to None, the
|
|
|
|
|
image will be saved without tiling.
|
|
|
|
|
|
|
|
|
|
**quality_mode**
|
|
|
|
|
Either `"rates"` or `"dB"` depending on the units you want to use to
|
|
|
|
|
specify image quality.
|
|
|
|
|
|
|
|
|
|
**quality_layers**
|
|
|
|
|
A sequence of numbers, each of which represents either an approximate size
|
|
|
|
|
reduction (if quality mode is `"rates"`) or a signal to noise ratio value
|
|
|
|
|
in decibels. If not specified, defaults to a single layer of full quality.
|
|
|
|
|
|
|
|
|
|
**num_resolutions**
|
|
|
|
|
The number of different image resolutions to be stored (which corresponds
|
|
|
|
|
to the number of Discrete Wavelet Transform decompositions plus one).
|
|
|
|
|
|
|
|
|
|
**codeblock_size**
|
|
|
|
|
The code-block size as a 2-tuple. Minimum size is 4 x 4, maximum is 1024 x
|
|
|
|
|
1024, with the additional restriction that no code-block may have more
|
|
|
|
|
than 4096 coefficients (i.e. the product of the two numbers must be no
|
|
|
|
|
greater than 4096).
|
|
|
|
|
|
|
|
|
|
**precinct_size**
|
|
|
|
|
The precinct size as a 2-tuple. Must be a power of two along both axes,
|
|
|
|
|
and must be greater than the code-block size.
|
|
|
|
|
|
|
|
|
|
**irreversible**
|
|
|
|
|
If ``True``, use the lossy Irreversible Color Transformation
|
|
|
|
|
followed by DWT 9-7. Defaults to ``False``, which means to use the
|
|
|
|
|
Reversible Color Transformation with DWT 5-3.
|
|
|
|
|
|
|
|
|
|
**progression**
|
|
|
|
|
Controls the progression order; must be one of ``"LRCP"``, ``"RLCP"``,
|
|
|
|
|
``"RPCL"``, ``"PCRL"``, ``"CPRL"``. The letters stand for Component,
|
|
|
|
|
Position, Resolution and Layer respectively and control the order of
|
|
|
|
|
encoding, the idea being that e.g. an image encoded using LRCP mode can
|
|
|
|
|
have its quality layers decoded as they arrive at the decoder, while one
|
|
|
|
|
encoded using RLCP mode will have increasing resolutions decoded as they
|
|
|
|
|
arrive, and so on.
|
|
|
|
|
|
|
|
|
|
**cinema_mode**
|
|
|
|
|
Set the encoder to produce output compliant with the digital cinema
|
|
|
|
|
specifications. The options here are ``"no"`` (the default),
|
|
|
|
|
``"cinema2k-24"`` for 24fps 2K, ``"cinema2k-48"`` for 48fps 2K, and
|
|
|
|
|
``"cinema4k-24"`` for 24fps 4K. Note that for compliant 2K files,
|
|
|
|
|
*at least one* of your image dimensions must match 2048 x 1080, while
|
|
|
|
|
for compliant 4K files, *at least one* of the dimensions must match
|
|
|
|
|
4096 x 2160.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
To enable JPEG 2000 support, you need to build and install the OpenJPEG
|
|
|
|
|
library, version 2.0.0 or higher, before building the Python Imaging
|
|
|
|
|
Library.
|
|
|
|
|
|
|
|
|
|
Windows users can install the OpenJPEG binaries available on the
|
|
|
|
|
OpenJPEG website, but must add them to their PATH in order to use PIL (if
|
|
|
|
|
you fail to do this, you will get errors about not being able to load the
|
|
|
|
|
``_imaging`` DLL).
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
MSP
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies and reads MSP files from Windows 1 and 2. The library writes
|
|
|
|
|
uncompressed (Windows 1) versions of this format.
|
|
|
|
|
|
|
|
|
|
PCX
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes PCX files containing ``1``, ``L``, ``P``, or ``RGB`` data.
|
|
|
|
|
|
|
|
|
|
PNG
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies, reads, and writes PNG files containing ``1``, ``L``, ``P``,
|
2013-10-07 09:30:16 +04:00
|
|
|
|
``RGB``, or ``RGBA`` data. Interlaced files are supported as of v1.1.7.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties, when appropriate:
|
|
|
|
|
|
|
|
|
|
**gamma**
|
|
|
|
|
Gamma, given as a floating point number.
|
|
|
|
|
|
|
|
|
|
**transparency**
|
2016-04-19 11:21:19 +03:00
|
|
|
|
For ``P`` images: Either the palette index for full transparent pixels,
|
|
|
|
|
or a byte string with alpha values for each palette entry.
|
|
|
|
|
|
|
|
|
|
For ``L`` and ``RGB`` images, the color that represents full transparent
|
|
|
|
|
pixels in this image.
|
|
|
|
|
|
|
|
|
|
This key is omitted if the image is not a transparent palette image.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2014-11-20 02:35:01 +03:00
|
|
|
|
``Open`` also sets ``Image.text`` to a list of the values of the
|
2014-12-31 04:06:38 +03:00
|
|
|
|
``tEXt``, ``zTXt``, and ``iTXt`` chunks of the PNG image. Individual
|
|
|
|
|
compressed chunks are limited to a decompressed size of
|
|
|
|
|
``PngImagePlugin.MAX_TEXT_CHUNK``, by default 1MB, to prevent
|
|
|
|
|
decompression bombs. Additionally, the total size of all of the text
|
|
|
|
|
chunks is limited to ``PngImagePlugin.MAX_TEXT_MEMORY``, defaulting to
|
|
|
|
|
64MB.
|
2014-11-20 02:35:01 +03:00
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method supports the following options:
|
|
|
|
|
|
|
|
|
|
**optimize**
|
2016-09-25 14:22:38 +03:00
|
|
|
|
If present and true, instructs the PNG writer to make the output file as
|
|
|
|
|
small as possible. This includes extra processing in order to find optimal
|
|
|
|
|
encoder settings.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2015-01-15 21:14:30 +03:00
|
|
|
|
**transparency**
|
2013-11-27 02:51:07 +04:00
|
|
|
|
For ``P``, ``L``, and ``RGB`` images, this option controls what
|
|
|
|
|
color image to mark as transparent.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2016-04-19 11:21:19 +03:00
|
|
|
|
For ``P`` images, this can be a either the palette index,
|
|
|
|
|
or a byte string with alpha values for each palette entry.
|
|
|
|
|
|
2014-11-20 02:35:01 +03:00
|
|
|
|
**dpi**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
A tuple of two numbers corresponding to the desired dpi in each direction.
|
2014-11-20 02:35:01 +03:00
|
|
|
|
|
|
|
|
|
**pnginfo**
|
|
|
|
|
A :py:class:`PIL.PngImagePlugin.PngInfo` instance containing text tags.
|
|
|
|
|
|
2015-01-15 21:14:30 +03:00
|
|
|
|
**compress_level**
|
|
|
|
|
ZLIB compression level, a number between 0 and 9: 1 gives best speed,
|
|
|
|
|
9 gives best compression, 0 gives no compression at all. Default is 6.
|
|
|
|
|
When ``optimize`` option is True ``compress_level`` has no effect
|
|
|
|
|
(it is set to 9 regardless of a value passed).
|
|
|
|
|
|
2016-06-25 13:10:11 +03:00
|
|
|
|
**icc_profile**
|
2016-07-01 14:27:01 +03:00
|
|
|
|
The ICC Profile to include in the saved file.
|
2016-06-25 13:10:11 +03:00
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
**bits (experimental)**
|
|
|
|
|
For ``P`` images, this option controls how many bits to store. If omitted,
|
|
|
|
|
the PNG writer uses 8 bits (256 colors).
|
|
|
|
|
|
|
|
|
|
**dictionary (experimental)**
|
|
|
|
|
Set the ZLIB encoder dictionary.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
To enable PNG support, you need to build and install the ZLIB compression
|
2016-06-25 13:10:11 +03:00
|
|
|
|
library before building the Python Imaging Library. See the installation
|
|
|
|
|
documentation for details.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
PPM
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes PBM, PGM and PPM files containing ``1``, ``L`` or ``RGB``
|
|
|
|
|
data.
|
|
|
|
|
|
2016-12-31 15:33:33 +03:00
|
|
|
|
SGI
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
Pillow reads and writes uncompressed ``L``, ``RGB``, and ``RGBA`` files.
|
|
|
|
|
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
SPIDER
|
|
|
|
|
^^^^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes SPIDER image files of 32-bit floating point data
|
|
|
|
|
("F;32F").
|
|
|
|
|
|
|
|
|
|
PIL also reads SPIDER stack files containing sequences of SPIDER images. The
|
|
|
|
|
:py:meth:`~file.seek` and :py:meth:`~file.tell` methods are supported, and
|
|
|
|
|
random access is allowed.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following attributes:
|
|
|
|
|
|
|
|
|
|
**format**
|
|
|
|
|
Set to ``SPIDER``
|
|
|
|
|
|
|
|
|
|
**istack**
|
|
|
|
|
Set to 1 if the file is an image stack, else 0.
|
|
|
|
|
|
|
|
|
|
**nimages**
|
|
|
|
|
Set to the number of images in the stack.
|
|
|
|
|
|
|
|
|
|
A convenience method, :py:meth:`~PIL.Image.Image.convert2byte`, is provided for
|
|
|
|
|
converting floating point data to byte data (mode ``L``)::
|
|
|
|
|
|
|
|
|
|
im = Image.open('image001.spi').convert2byte()
|
|
|
|
|
|
|
|
|
|
Writing files in SPIDER format
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The extension of SPIDER files may be any 3 alphanumeric characters. Therefore
|
|
|
|
|
the output format must be specified explicitly::
|
|
|
|
|
|
|
|
|
|
im.save('newimage.spi', format='SPIDER')
|
|
|
|
|
|
|
|
|
|
For more information about the SPIDER image processing package, see the
|
2014-10-01 14:51:08 +04:00
|
|
|
|
`SPIDER homepage`_ at `Wadsworth Center`_.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2017-02-14 12:27:02 +03:00
|
|
|
|
.. _SPIDER homepage: https://spider.wadsworth.org/spider_doc/spider/docs/spider.html
|
|
|
|
|
.. _Wadsworth Center: https://www.wadsworth.org/
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
TIFF
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes TIFF files. It can read both striped and tiled images,
|
|
|
|
|
pixel and plane interleaved multi-band images, and either uncompressed, or
|
2013-10-07 09:41:25 +04:00
|
|
|
|
Packbits, LZW, or JPEG compressed images.
|
|
|
|
|
|
|
|
|
|
If you have libtiff and its headers installed, PIL can read and write many more
|
|
|
|
|
kinds of compressed TIFF files. If not, PIL will always write uncompressed
|
|
|
|
|
files.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**compression**
|
|
|
|
|
Compression mode.
|
|
|
|
|
|
2015-09-14 17:01:57 +03:00
|
|
|
|
.. versionadded:: 2.0.0
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
**dpi**
|
2015-09-14 17:01:57 +03:00
|
|
|
|
Image resolution as an ``(xdpi, ydpi)`` tuple, where applicable. You can use
|
2013-10-07 05:56:28 +04:00
|
|
|
|
the :py:attr:`~PIL.Image.Image.tag` attribute to get more detailed
|
|
|
|
|
information about the image resolution.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.5
|
|
|
|
|
|
2015-09-14 17:01:57 +03:00
|
|
|
|
**resolution**
|
2015-10-11 13:24:35 +03:00
|
|
|
|
Image resolution as an ``(xres, yres)`` tuple, where applicable. This is a
|
2015-09-14 17:01:57 +03:00
|
|
|
|
measurement in whichever unit is specified by the file.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.5
|
|
|
|
|
|
|
|
|
|
|
2015-12-28 14:15:27 +03:00
|
|
|
|
The :py:attr:`~PIL.Image.Image.tag_v2` attribute contains a dictionary
|
|
|
|
|
of TIFF metadata. The keys are numerical indexes from
|
2015-12-31 00:52:13 +03:00
|
|
|
|
:py:attr:`~PIL.TiffTags.TAGS_V2`. Values are strings or numbers for single
|
2015-12-28 14:15:27 +03:00
|
|
|
|
items, multiple values are returned in a tuple of values. Rational
|
|
|
|
|
numbers are returned as a :py:class:`~PIL.TiffImagePlugin.IFDRational`
|
|
|
|
|
object.
|
2015-09-14 17:01:57 +03:00
|
|
|
|
|
|
|
|
|
.. versionadded:: 3.0.0
|
|
|
|
|
|
|
|
|
|
For compatibility with legacy code, the
|
|
|
|
|
:py:attr:`~PIL.Image.Image.tag` attribute contains a dictionary of
|
|
|
|
|
decoded TIFF fields as returned prior to version 3.0.0. Values are
|
|
|
|
|
returned as either strings or tuples of numeric values. Rational
|
|
|
|
|
numbers are returned as a tuple of ``(numerator, denominator)``.
|
|
|
|
|
|
|
|
|
|
.. deprecated:: 3.0.0
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2013-10-09 09:41:44 +04:00
|
|
|
|
Saving Tiff Images
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method can take the following keyword arguments:
|
|
|
|
|
|
2016-10-03 17:05:03 +03:00
|
|
|
|
**save_all**
|
|
|
|
|
If true, Pillow will save all frames of the image to a multiframe tiff document.
|
2016-10-28 11:59:40 +03:00
|
|
|
|
|
2016-10-03 17:05:03 +03:00
|
|
|
|
.. versionadded:: 3.4.0
|
|
|
|
|
|
2015-01-15 21:14:30 +03:00
|
|
|
|
**tiffinfo**
|
2015-09-14 17:01:57 +03:00
|
|
|
|
A :py:class:`~PIL.TiffImagePlugin.ImageFileDirectory_v2` object or dict
|
2013-10-09 09:41:44 +04:00
|
|
|
|
object containing tiff tags and values. The TIFF field type is
|
|
|
|
|
autodetected for Numeric and string values, any other types
|
2015-09-14 17:01:57 +03:00
|
|
|
|
require using an :py:class:`~PIL.TiffImagePlugin.ImageFileDirectory_v2`
|
2013-10-09 09:41:44 +04:00
|
|
|
|
object and setting the type in
|
2015-09-14 17:01:57 +03:00
|
|
|
|
:py:attr:`~PIL.TiffImagePlugin.ImageFileDirectory_v2.tagtype` with
|
2013-10-09 09:41:44 +04:00
|
|
|
|
the appropriate numerical value from
|
|
|
|
|
``TiffTags.TYPES``.
|
2015-01-15 21:14:30 +03:00
|
|
|
|
|
2013-10-09 09:41:44 +04:00
|
|
|
|
.. versionadded:: 2.3.0
|
|
|
|
|
|
2015-12-28 14:15:27 +03:00
|
|
|
|
Metadata values that are of the rational type should be passed in
|
|
|
|
|
using a :py:class:`~PIL.TiffImagePlugin.IFDRational` object.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 3.1.0
|
|
|
|
|
|
2015-09-14 17:01:57 +03:00
|
|
|
|
For compatibility with legacy code, a
|
2015-12-28 14:15:27 +03:00
|
|
|
|
:py:class:`~PIL.TiffImagePlugin.ImageFileDirectory_v1` object may
|
|
|
|
|
be passed in this field. However, this is deprecated.
|
2015-09-14 17:01:57 +03:00
|
|
|
|
|
2015-12-28 14:15:27 +03:00
|
|
|
|
.. versionadded:: 3.0.0
|
2015-09-14 17:01:57 +03:00
|
|
|
|
|
2016-01-05 14:39:15 +03:00
|
|
|
|
.. note::
|
2015-12-31 00:52:01 +03:00
|
|
|
|
|
|
|
|
|
Only some tags are currently supported when writing using
|
|
|
|
|
libtiff. The supported list is found in
|
|
|
|
|
:py:attr:`~PIL:TiffTags.LIBTIFF_CORE`.
|
|
|
|
|
|
2016-01-05 14:39:15 +03:00
|
|
|
|
**compression**
|
2013-10-09 09:41:44 +04:00
|
|
|
|
A string containing the desired compression method for the
|
2015-12-31 00:52:13 +03:00
|
|
|
|
file. (valid only with libtiff installed) Valid compression
|
|
|
|
|
methods are: ``None``, ``"tiff_ccitt"``, ``"group3"``,
|
|
|
|
|
``"group4"``, ``"tiff_jpeg"``, ``"tiff_adobe_deflate"``,
|
|
|
|
|
``"tiff_thunderscan"``, ``"tiff_deflate"``, ``"tiff_sgilog"``,
|
|
|
|
|
``"tiff_sgilog24"``, ``"tiff_raw_16"``
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
2015-12-28 14:15:27 +03:00
|
|
|
|
These arguments to set the tiff header fields are an alternative to
|
|
|
|
|
using the general tags available through tiffinfo.
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
2015-01-15 21:14:30 +03:00
|
|
|
|
**description**
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
|
|
|
|
**software**
|
|
|
|
|
|
2014-12-10 02:17:33 +03:00
|
|
|
|
**date_time**
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
|
|
|
|
**artist**
|
|
|
|
|
|
|
|
|
|
**copyright**
|
|
|
|
|
Strings
|
|
|
|
|
|
2014-12-10 02:17:33 +03:00
|
|
|
|
**resolution_unit**
|
2015-01-15 21:14:30 +03:00
|
|
|
|
A string of "inch", "centimeter" or "cm"
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
|
|
|
|
**resolution**
|
|
|
|
|
|
2014-12-10 02:17:33 +03:00
|
|
|
|
**x_resolution**
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
2014-12-10 02:17:33 +03:00
|
|
|
|
**y_resolution**
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
2016-01-05 14:39:15 +03:00
|
|
|
|
**dpi**
|
2015-12-28 14:15:27 +03:00
|
|
|
|
Either a Float, 2 tuple of (numerator, denominator) or a
|
|
|
|
|
:py:class:`~PIL.TiffImagePlugin.IFDRational`. Resolution implies
|
|
|
|
|
an equal x and y resolution, dpi also implies a unit of inches.
|
|
|
|
|
|
2013-10-09 09:41:44 +04:00
|
|
|
|
|
2013-10-07 09:39:02 +04:00
|
|
|
|
WebP
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes WebP files. The specifics of PIL's capabilities with this
|
|
|
|
|
format are currently undocumented.
|
|
|
|
|
|
2013-10-22 23:32:01 +04:00
|
|
|
|
The :py:meth:`~PIL.Image.Image.save` method supports the following options:
|
|
|
|
|
|
2013-11-20 11:14:51 +04:00
|
|
|
|
**lossless**
|
2016-09-25 14:22:38 +03:00
|
|
|
|
If present and true, instructs the WEBP writer to use lossless compression.
|
2013-10-22 23:32:01 +04:00
|
|
|
|
|
2013-11-20 11:14:51 +04:00
|
|
|
|
**quality**
|
2013-10-22 23:32:01 +04:00
|
|
|
|
Integer, 1-100, Defaults to 80. Sets the quality level for
|
|
|
|
|
lossy compression.
|
|
|
|
|
|
2013-11-20 11:14:51 +04:00
|
|
|
|
**icc_procfile**
|
2013-10-22 23:32:01 +04:00
|
|
|
|
The ICC Profile to include in the saved file. Only supported if
|
|
|
|
|
the system webp library was built with webpmux support.
|
|
|
|
|
|
2013-11-20 11:14:51 +04:00
|
|
|
|
**exif**
|
2013-10-22 23:32:01 +04:00
|
|
|
|
The exif data to include in the saved file. Only supported if
|
|
|
|
|
the system webp library was built with webpmux support.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
XBM
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads and writes X bitmap files (mode ``1``).
|
|
|
|
|
|
|
|
|
|
Read-only formats
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
CUR
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
CUR is used to store cursors on Windows. The CUR decoder reads the largest
|
|
|
|
|
available cursor. Animated cursors are not supported.
|
|
|
|
|
|
|
|
|
|
DCX
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
DCX is a container file format for PCX files, defined by Intel. The DCX format
|
|
|
|
|
is commonly used in fax applications. The DCX decoder can read files containing
|
|
|
|
|
``1``, ``L``, ``P``, or ``RGB`` data.
|
|
|
|
|
|
|
|
|
|
When the file is opened, only the first image is read. You can use
|
|
|
|
|
:py:meth:`~file.seek` or :py:mod:`~PIL.ImageSequence` to read other images.
|
|
|
|
|
|
2016-01-05 14:39:15 +03:00
|
|
|
|
|
|
|
|
|
DDS
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
DDS is a popular container texture format used in video games and natively
|
|
|
|
|
supported by DirectX.
|
2016-10-03 17:05:03 +03:00
|
|
|
|
Currently, DXT1, DXT3, and DXT5 pixel formats are supported and only in ``RGBA``
|
2016-01-05 14:39:15 +03:00
|
|
|
|
mode.
|
|
|
|
|
|
2016-10-03 17:05:03 +03:00
|
|
|
|
.. versionadded:: 3.4.0 DXT3
|
2016-01-05 14:39:15 +03:00
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
FLI, FLC
|
|
|
|
|
^^^^^^^^
|
|
|
|
|
|
|
|
|
|
PIL reads Autodesk FLI and FLC animations.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**duration**
|
|
|
|
|
The delay (in milliseconds) between each frame.
|
|
|
|
|
|
|
|
|
|
FPX
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads Kodak FlashPix files. In the current version, only the highest
|
|
|
|
|
resolution image is read from the file, and the viewing transform is not taken
|
|
|
|
|
into account.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
To enable full FlashPix support, you need to build and install the IJG JPEG
|
|
|
|
|
library before building the Python Imaging Library. See the distribution
|
|
|
|
|
README for details.
|
|
|
|
|
|
2016-02-02 16:02:46 +03:00
|
|
|
|
FTEX
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 3.2.0
|
|
|
|
|
|
|
|
|
|
The FTEX decoder reads textures used for 3D objects in
|
|
|
|
|
Independence War 2: Edge Of Chaos. The plugin reads a single texture
|
|
|
|
|
per file, in the compressed and uncompressed formats.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
GBR
|
|
|
|
|
^^^
|
|
|
|
|
|
2016-01-08 18:25:42 +03:00
|
|
|
|
The GBR decoder reads GIMP brush files, version 1 and 2.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
2016-01-08 18:25:42 +03:00
|
|
|
|
**comment**
|
2013-10-07 05:56:28 +04:00
|
|
|
|
The brush name.
|
|
|
|
|
|
2016-01-08 18:25:42 +03:00
|
|
|
|
**spacing**
|
|
|
|
|
The spacing between the brushes, in pixels. Version 2 only.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
GD
|
|
|
|
|
^^
|
|
|
|
|
|
|
|
|
|
PIL reads uncompressed GD files. Note that this file format cannot be
|
|
|
|
|
automatically identified, so you must use :py:func:`PIL.GdImageFile.open` to
|
|
|
|
|
read such a file.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**transparency**
|
|
|
|
|
Transparency color index. This key is omitted if the image is not
|
|
|
|
|
transparent.
|
|
|
|
|
|
|
|
|
|
IMT
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads Image Tools images containing ``L`` data.
|
|
|
|
|
|
|
|
|
|
IPTC/NAA
|
|
|
|
|
^^^^^^^^
|
|
|
|
|
|
|
|
|
|
PIL provides limited read support for IPTC/NAA newsphoto files.
|
|
|
|
|
|
|
|
|
|
MCIDAS
|
|
|
|
|
^^^^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies and reads 8-bit McIdas area files.
|
|
|
|
|
|
2015-12-29 16:15:13 +03:00
|
|
|
|
MIC
|
|
|
|
|
^^^
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
PIL identifies and reads Microsoft Image Composer (MIC) files. When opened, the
|
|
|
|
|
first sprite in the file is loaded. You can use :py:meth:`~file.seek` and
|
|
|
|
|
:py:meth:`~file.tell` to read other sprites from the file.
|
|
|
|
|
|
2017-06-13 23:08:46 +03:00
|
|
|
|
Note that there may be an embedded gamma of 2.2 in MIC files.
|
|
|
|
|
|
2014-07-24 19:16:12 +04:00
|
|
|
|
MPO
|
|
|
|
|
^^^
|
|
|
|
|
|
2014-07-25 22:47:07 +04:00
|
|
|
|
Pillow identifies and reads Multi Picture Object (MPO) files, loading the primary
|
2014-07-24 19:16:12 +04:00
|
|
|
|
image when first opened. The :py:meth:`~file.seek` and :py:meth:`~file.tell`
|
|
|
|
|
methods may be used to read other pictures from the file. The pictures are
|
|
|
|
|
zero-indexed and random access is supported.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
PCD
|
|
|
|
|
^^^
|
|
|
|
|
|
2016-09-29 13:10:58 +03:00
|
|
|
|
PIL reads PhotoCD files containing ``RGB`` data. This only reads the 768x512
|
|
|
|
|
resolution image from the file. Higher resolutions are encoded in a proprietary
|
|
|
|
|
encoding.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2015-12-29 16:15:13 +03:00
|
|
|
|
PIXAR
|
|
|
|
|
^^^^^
|
|
|
|
|
|
|
|
|
|
PIL provides limited support for PIXAR raster files. The library can identify
|
|
|
|
|
and read “dumped” RGB files.
|
|
|
|
|
|
|
|
|
|
The format code is ``PIXAR``.
|
|
|
|
|
|
2013-10-07 05:56:28 +04:00
|
|
|
|
PSD
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies and reads PSD files written by Adobe Photoshop 2.5 and 3.0.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TGA
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads 24- and 32-bit uncompressed and run-length encoded TGA files.
|
|
|
|
|
|
|
|
|
|
WAL
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.4
|
|
|
|
|
|
|
|
|
|
PIL reads Quake2 WAL texture files.
|
|
|
|
|
|
|
|
|
|
Note that this file format cannot be automatically identified, so you must use
|
|
|
|
|
the open function in the :py:mod:`~PIL.WalImageFile` module to read files in
|
|
|
|
|
this format.
|
|
|
|
|
|
|
|
|
|
By default, a Quake2 standard palette is attached to the texture. To override
|
|
|
|
|
the palette, use the putpalette method.
|
|
|
|
|
|
|
|
|
|
XPM
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL reads X pixmap files (mode ``P``) with 256 colors or less.
|
|
|
|
|
|
|
|
|
|
The :py:meth:`~PIL.Image.Image.open` method sets the following
|
|
|
|
|
:py:attr:`~PIL.Image.Image.info` properties:
|
|
|
|
|
|
|
|
|
|
**transparency**
|
|
|
|
|
Transparency color index. This key is omitted if the image is not
|
|
|
|
|
transparent.
|
|
|
|
|
|
|
|
|
|
Write-only formats
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
PALM
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
PIL provides write-only support for PALM pixmap files.
|
|
|
|
|
|
|
|
|
|
The format code is ``Palm``, the extension is ``.palm``.
|
|
|
|
|
|
|
|
|
|
PDF
|
|
|
|
|
^^^
|
|
|
|
|
|
|
|
|
|
PIL can write PDF (Acrobat) images. Such images are written as binary PDF 1.1
|
|
|
|
|
files, using either JPEG or HEX encoding depending on the image mode (and
|
|
|
|
|
whether JPEG support is available or not).
|
|
|
|
|
|
2015-10-01 12:45:27 +03:00
|
|
|
|
When calling :py:meth:`~PIL.Image.Image.save`, if a multiframe image is used,
|
|
|
|
|
by default, only the first image will be saved. To save all frames, each frame
|
|
|
|
|
to a separate page of the PDF, the ``save_all`` parameter must be present and
|
|
|
|
|
set to ``True``.
|
|
|
|
|
|
2015-12-29 16:15:13 +03:00
|
|
|
|
XV Thumbnails
|
|
|
|
|
^^^^^^^^^^^^^
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
2015-12-29 16:15:13 +03:00
|
|
|
|
PIL can read XV thumbnail files.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
Identify-only formats
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
BUFR
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.3
|
|
|
|
|
|
|
|
|
|
PIL provides a stub driver for BUFR files.
|
|
|
|
|
|
|
|
|
|
To add read or write support to your application, use
|
|
|
|
|
:py:func:`PIL.BufrStubImagePlugin.register_handler`.
|
|
|
|
|
|
|
|
|
|
FITS
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.5
|
|
|
|
|
|
|
|
|
|
PIL provides a stub driver for FITS files.
|
|
|
|
|
|
|
|
|
|
To add read or write support to your application, use
|
|
|
|
|
:py:func:`PIL.FitsStubImagePlugin.register_handler`.
|
|
|
|
|
|
|
|
|
|
GRIB
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.5
|
|
|
|
|
|
|
|
|
|
PIL provides a stub driver for GRIB files.
|
|
|
|
|
|
|
|
|
|
The driver requires the file to start with a GRIB header. If you have files
|
|
|
|
|
with embedded GRIB data, or files with multiple GRIB fields, your application
|
|
|
|
|
has to seek to the header before passing the file handle to PIL.
|
|
|
|
|
|
|
|
|
|
To add read or write support to your application, use
|
|
|
|
|
:py:func:`PIL.GribStubImagePlugin.register_handler`.
|
|
|
|
|
|
|
|
|
|
HDF5
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1.5
|
|
|
|
|
|
|
|
|
|
PIL provides a stub driver for HDF5 files.
|
|
|
|
|
|
|
|
|
|
To add read or write support to your application, use
|
|
|
|
|
:py:func:`PIL.Hdf5StubImagePlugin.register_handler`.
|
|
|
|
|
|
|
|
|
|
MPEG
|
|
|
|
|
^^^^
|
|
|
|
|
|
|
|
|
|
PIL identifies MPEG files.
|
|
|
|
|
|
|
|
|
|
WMF
|
|
|
|
|
^^^
|
|
|
|
|
|
2016-09-27 19:42:18 +03:00
|
|
|
|
PIL can identify playable WMF files.
|
2013-10-07 05:56:28 +04:00
|
|
|
|
|
|
|
|
|
In PIL 1.1.4 and earlier, the WMF driver provides some limited rendering
|
|
|
|
|
support, but not enough to be useful for any real application.
|
|
|
|
|
|
|
|
|
|
In PIL 1.1.5 and later, the WMF driver is a stub driver. To add WMF read or
|
|
|
|
|
write support to your application, use
|
|
|
|
|
:py:func:`PIL.WmfImagePlugin.register_handler` to register a WMF handler.
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
from PIL import Image
|
|
|
|
|
from PIL import WmfImagePlugin
|
|
|
|
|
|
|
|
|
|
class WmfHandler:
|
|
|
|
|
def open(self, im):
|
|
|
|
|
...
|
|
|
|
|
def load(self, im):
|
|
|
|
|
...
|
|
|
|
|
return image
|
|
|
|
|
def save(self, im, fp, filename):
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
wmf_handler = WmfHandler()
|
|
|
|
|
|
|
|
|
|
WmfImagePlugin.register_handler(wmf_handler)
|
|
|
|
|
|
|
|
|
|
im = Image.open("sample.wmf")
|