Python interface for libheif library

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for andrey18106 from gravatar.com andrey18106 Avatar for bigcat88 from gravatar.com bigcat88

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 (GPLv2) (BSD-3-Clause)
  • Author: Alexander Piskun
  • Tags heif, heic, avif, pillow
  • Requires: Python >=3.8
Classifiers
Report project as malware

Project description

pillow-heif

Analysis & Coverage Nightly build Wheels test docs codecov

PythonVersion impl pypi Downloads Downloads

Mac OS Windows Linux Alpine Linux Raspberry Pi

Python bindings to libheif for working with HEIF images and plugin for Pillow.

Features:

  • Decoding of 8, 10, 12 bit HEIC and AVIF files.
  • Encoding of 8, 10, 12 bit HEIC and AVIF files.
  • EXIF, XMP, IPTC read & write support.
  • Support of multiple images in one file and a PrimaryImage attribute.
  • Adding & removing thumbnails.
  • Reading of Depth Images.
  • Adding HEIF support to Pillow in one line of code as a plugin.

Note: Here is a light version pi-heif of this project without encoding capabilities.

Install

python3 -m pip install -U pip
python3 -m pip install pillow-heif

Example of use as a Pillow plugin

from PIL import Image
from pillow_heif import register_heif_opener

register_heif_opener()

im = Image.open("image.heic")  # do whatever need with a Pillow image
im = im.rotate(13)
im.save(f"rotated_image.heic", quality=90)

16 bit PNG to 10 bit HEIF using OpenCV

import cv2
import pillow_heif

cv_img = cv2.imread("16bit_with_alpha.png", cv2.IMREAD_UNCHANGED)
heif_file = pillow_heif.from_bytes(
    mode="BGRA;16",
    size=(cv_img.shape[1], cv_img.shape[0]),
    data=bytes(cv_img)
)
heif_file.save("RGBA_10bit.heic", quality=-1)

8/10/12 bit HEIF to 8/16 bit PNG using OpenCV

import numpy as np
import cv2
import pillow_heif

heif_file = pillow_heif.open_heif("image.heic", convert_hdr_to_8bit=False, bgr_mode=True)
np_array = np.asarray(heif_file)
cv2.imwrite("image.png", np_array)

Accessing decoded image data

import pillow_heif

if pillow_heif.is_supported("image.heic"):
    heif_file = pillow_heif.open_heif("image.heic", convert_hdr_to_8bit=False)
    print("image size:", heif_file.size)
    print("image mode:", heif_file.mode)
    print("image data length:", len(heif_file.data))
    print("image data stride:", heif_file.stride)

Get decoded image data as a Numpy array

import numpy as np
import pillow_heif

if pillow_heif.is_supported("input.heic"):
    heif_file = pillow_heif.open_heif("input.heic")
    np_array = np.asarray(heif_file)

AVIF support

Working with the AVIF files as the same as with the HEIC files. Just use a separate function to register plugin:

import pillow_heif

pillow_heif.register_avif_opener()

More Information

Wheels

Wheels table macOS
Intel		 macOS
Silicon		 Windows
64bit		 musllinux* manylinux*
CPython 3.8 ✅ ✅ ✅ ✅ ✅
CPython 3.9 ✅ ✅ ✅ ✅ ✅
CPython 3.10 ✅ ✅ ✅ ✅ ✅
CPython 3.11 ✅ ✅ ✅ ✅ ✅
CPython 3.12 ✅ ✅ ✅ ✅ ✅
PyPy 3.8 v7.3 ✅ ✅ ✅ N/A ✅
PyPy 3.9 v7.3 ✅ ✅ ✅ N/A ✅
PyPy 3.10 v7.3 ✅ ✅ ✅ N/A ✅

* x86_64, aarch64 wheels.

i686, ARMv7l, PyPy 32-bit wheels are published only for pi-heif from 0.13.0 version.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page