apple-hdr-heic 0.1.0

A library/tool to decode images in HEIC/HEIF format taken on Apple devices that contain HDR gain map.

apple-hdr-heic

A library/tool to decode photos (HEIC files) taken on an iPhone that contain HDR gain map, and convert it to standard HDR representations such as:

1. A 16- or 32-bit per channel float representation in a given linear color space, which could be saved to an EXR file.
2. A 48-bit (16-bit per channel) representation as per Rec. 2100 with PQ transfer function, which could be saved to a PNG file.

Disclaimer: This project is not affiliated with, or endorsed by, Apple Inc. or any of its subsidiaries.

Pre-requisites

• Python 3.10+
• exiftool 12.54+
  • For Ubuntu or Debian, do sudo apt install libimage-exiftool-perl
  • For other Linux distros, search exiftool using your package manager
  • For Mac or Windows, follow the instructions in website
  • For Windows, it is also available via Scoop

Installation

To install the latest published version, do (preferrably in a virtual environment):

pip install apple-hdr-heic

Or if you want the latest development version, install using a Github archive link:

pip install https://github.com/johncf/apple-hdr-heic/archive/master.tar.gz

Usage

CLI Tool

apple-hdr-heic-decode input.heic output.png
apple-hdr-heic-decode input.heic output.heic -q 95

Near-lossless conversion:

apple-hdr-heic-decode input.heic output.avif -b 12 -y 444

Note: With 12-bit channels (in AVIF or HEIC), it's not truly lossless compared to 16-bit channels in PNG or 32-bit channels in EXR, but it's close enough.

Truly lossless conversion:

apple-hdr-heic-decode input.heic output.exr -b 32 --colorspace "ROMM RGB"

Note: Even though this preserves all the HDR information in the original image, the HDR-to-SDR tone-mapping information will be lost. To preserve that, an additional layer of information is required (like the HDR gain map in the original image, which is an inverse tone-map).

Library Usage

from apple_hdr_heic import load_as_bt2020_linear, quantize_bt2020_to_bt2100_pq

bt2020_linear = load_as_bt2020_linear("input.heic")
bt2100_pq = quantize_bt2020_to_bt2100_pq(bt2020_linear)
cv2.imwrite("output.png", bt2100_pq[:, :, ::-1])

Note: The output file output.png (in examples above) does not contain the necessary cICP metadata that denotes it to have bt2020 (9) color primaries and smpte2084 (16) transfer characteristics. Therefore, all image viewers will display them incorrectly.

Development

Environment Set Up

Install uv.

Install nox using uv:

uv tool install nox

Unit Testing

nox -s test

Type Checking

nox -s typeck

Linting

nox -s lint

Formatting

nox -s style

Building

uv tool install flit
flit build --no-use-vcs

Miscellaneous Notes

About 12-bit HEIC Files

Although this tool supports 12-bit HEIC output, it doesn't seem to be widely supported, even in Apple softwares.

About AVIF Output

If you want to use a different AVIF encoder, first use this tool to produce a PNG file, then use libavif with --cicp set to 9/16/9 to convert the PNG to AVIF:

avifenc -s 4 -j 4 --min 1 --max 56 -a end-usage=q -a cq-level=10 -a tune=ssim -a color:enable-qm=1 \
    -a color:enable-chroma-deltaq=1 -d 12 --cicp 9/16/9 output.png output.avif

About EXR Output

Although the EXR file created by apple-hdr-heic-decoder tool contains colorspace information (specifically, color primaries and white point), it is not read/used by most softwares out there. Therefore it's recommended to use the --colorspace argument to make the EXR file's color space match what the software consuming the file expects.

For example, Affinity Photo 2 expects "ROMM RGB" by default when opening an EXR file. This default colorspace for 32-bit HDR can be changed from Settings > Color options in Affinity Photo 2.