Skip to content

Move MPO into "Fully supported formats" #8504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 1 commit into from
Oct 26, 2024
Merged

Move MPO into "Fully supported formats" #8504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/handbook/image-file-formats.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,30 @@ The :py:meth:`~PIL.Image.Image.save` method supports the following options:
you fail to do this, you will get errors about not being able to load the
``_imaging`` DLL).

MPO
^^^

Pillow reads and writes Multi Picture Object (MPO) files. When first opened, it loads
the primary image. The :py:meth:`~PIL.Image.Image.seek` and
:py:meth:`~PIL.Image.Image.tell` methods may be used to read other pictures from the
file. The pictures are zero-indexed and random access is supported.

.. _mpo-saving:

Saving
~~~~~~

When calling :py:meth:`~PIL.Image.Image.save` to write an MPO file, by default
only the first frame of a multiframe image will be saved. If the ``save_all``
argument is present and true, then all frames will be saved, and the following
option will also be available.

**append_images**
A list of images to append as additional pictures. Each of the
images in the list can be single or multiframe images.

.. versionadded:: 9.3.0

MSP
^^^

Expand Down Expand Up @@ -1435,30 +1459,6 @@ Note that there may be an embedded gamma of 2.2 in MIC files.

To enable MIC support, you must install :pypi:`olefile`.

MPO
^^^

Pillow identifies and reads Multi Picture Object (MPO) files, loading the primary
image when first opened. The :py:meth:`~PIL.Image.Image.seek` and :py:meth:`~PIL.Image.Image.tell`
methods may be used to read other pictures from the file. The pictures are
zero-indexed and random access is supported.

.. _mpo-saving:

Saving
~~~~~~

When calling :py:meth:`~PIL.Image.Image.save` to write an MPO file, by default
only the first frame of a multiframe image will be saved. If the ``save_all``
argument is present and true, then all frames will be saved, and the following
option will also be available.

**append_images**
A list of images to append as additional pictures. Each of the
images in the list can be single or multiframe images.

.. versionadded:: 9.3.0

PCD
^^^

Expand Down