imagecodecs 2022.12.22

Quickstart

Install the imagecodecs package and all dependencies from the Python Package Index:

python -m pip install -U imagecodecs[all]

Imagecodecs is also available in other package repositories such as Anaconda, MSYS2, and MacPorts.

See Requirements and Notes for building from source.

See Examples for using the programming interface.

Source code and support are available on GitHub.

Requirements

This release has been tested with the following requirements and dependencies (other versions may work):

• CPython 3.8.10, 3.9.13, 3.10.9, 3.11.1

• Numpy 1.23.5

Build requirements:

• Cython 0.29.32

• bitshuffle 0.5.1 (vendored)

• brotli 1.0.9

• brunsli 0.1

• bzip2 1.0.8

• c-blosc 1.21.3

• c-blosc2 2.6.1

• cfitsio 3.49

• charls 2.3.4

• giflib 5.2.1

• jetraw 22.02.16.1

• jxrlib 1.1

• lcms 2.14

• lerc 4.0.0

• libaec 1.0.6

• libavif 0.11.1 (aom 3.5.0, dav1d 1.0.0, rav1e 0.6.1)

• libdeflate 1.15

• libheif 1.14.0 (libde265 1.0.9, x265 3.5)

• libjpeg-turbo 2.1.4

• libjxl 0.7.0

• liblzf 3.6 (vendored)

• libpng 1.6.39

• libpng-apng 1.6.39

• libspng 0.7.3 (vendored)

• libtiff 4.5.0

• libwebp 1.2.4

• lz4 1.9.4

• lzfse 1.0,

• lzham_codec 1.0,

• mozjpeg 4.1.1

• openjpeg 2.5.0

• qoi 75e7f30 (vendored)

• rgbe.c 5/26/95 (vendored)

• snappy 1.1.9

• xz 5.4.0

• zfp 1.0.0

• zlib 1.2.13

• zlib-ng 2.0.6

• zopfli-1.0.3

• zstd 1.5.2

Test requirements:

• tifffile 2022.10.10

• czifile 2019.7.2

• zarr 2.13.3

• numcodecs 0.11.0

• bitshuffle 0.5.1

• python-blosc 1.11.1

• python-blosc2-2.0.0

• python-brotli 1.0.9

• python-lz4 4.0.2

• python-lzf 0.2.4

• python-snappy 0.6.1

• python-zstd 1.5.2.6

• pyliblzfse 0.4.1

• zopflipy 1.8

Revisions

2022.12.22

• Pass 6510 tests.

• Require libtiff 4.5 (breaking).

• Require libavif 0.11 (breaking).

• Change jpegxl_encode level parameter to resemble libjpeg quality (breaking).

• Add LZFSE codec via lzfse library.

• Add LZHAM codec via lzham library.

• Fix AttributeError in cms_profile (#52).

• Support gamma argument in cms_profile (#53).

• Raise limit of TIFF pages to 1048576.

• Use libtiff thread-safe error/warning handlers.

• Add option to specify filters and strategy in png_encode.

• Add option to specify integrity check type in lzma_encode.

• Fix DeprecationWarning with NumPy 1.24.

• Support Python 3.11 and win-arm64.

2022.9.26

• Support JPEG XL multi-channel (planar grayscale only) and multi-frame.

• Require libjxl 0.7 (breaking).

• Switch to Blosc2 API and require c-blosc 2.4 (breaking).

• Return LogLuv encoded TIFF as float32.

• Add RGBE codec via rgbe.c.

2022.8.8

• Drop support for libjpeg.

• Fix encoding JPEG in RGB color space.

• Require ZFP 1.0.

2022.7.31

• Add option to decode WebP as RGBA.

• Add option to specify WebP compression method.

• Use exact lossless WebP encoding.

2022.7.27

• Add LZW encoder.

• Add QOI codec via qoi.h (#37).

• Add HEIF codec via libheif (source only; #33).

• Add JETRAW codec via Jetraw demo (source only).

• Add ByteShuffle codec, a generic version of FloatPred.

• Replace imcd_floatpred by imcd_byteshuffle (breaking).

• Use bool type in imcd (breaking).

2022.2.22

• Fix jpeg numcodecs with tables (#28).

• Add APNG codec via libpng-apng patch.

• Add lossless and decodingspeed parameters to jpegxl_encode (#30).

• Add option to read JPEG XL animations.

• Add dummy numthreads parameter to codec functions.

• Set default numthreads to 1 (disable multi-threading).

• Drop support for Python 3.7 and numpy < 1.19 (NEP29).

2021.11.20

• Fix testing on pypy and Python 3.10.

2021.11.11

• Require libjxl 0.6.x.

• Add CMS codec via Little CMS library for color space transformations (WIP).

• Add MOZJPEG codec via mozjpeg library (Windows only).

• Add SPNG codec via libspng library.

• Rename avif_encode maxthreads parameter to numthreads (breaking).

• Accept n-dimensional output in non-image numcodecs decoders.

• Support masks in LERC codec.

• Support multi-threading and planar format in JPEG2K codec.

• Support multi-resolution, MCT, bitspersample, and 32-bit in jpeg2k encoder.

• Change jpeg2k_encode level parameter to fixed quality psnr (breaking).

• Change jpegxl_encode effort parameter default to minimum 3.

• Change JPEG encoders to use YCbCr for RGB images by default.

• Replace lerc_encode planarconfig with planar parameter (breaking).

• Add option to specify omp numthreads and chunksize in ZFP codec.

• Set default numthreads to 0.

• Fix Blosc default typesize.

• Fix segfault in jpegxl_encode.

• Replace many constants with enums (breaking).

2021.8.26

• Add BLOSC2 codec via c-blosc2 library.

• Require LERC 3 and libjxl 0.5.

• Do not exceed literal-only size in PackBits encoder.

• Raise ImcdError if output is insufficient in PackBits codecs (breaking).

• Raise ImcdError if input is corrupt in PackBits decoder (breaking).

• Fix delta codec for non-native byteorder.

2021.7.30

• …

Refer to the CHANGES file for older revisions.

Notes

This library is largely a work in progress.

The API is not stable yet and might change between revisions.

Python <= 3.7 is no longer supported. 32-bit versions are deprecated.

Works on little-endian platforms only.

The tiff, packints, and jpegsof3 codecs are currently decode-only.

The heif and jetraw codecs are distributed as source code only due to license and possible patent usage issues.

The latest Microsoft Visual C++ Redistributable for Visual Studio 2015-2022 is required on Windows.

Refer to the imagecodecs/licenses folder for 3rd-party library licenses.

This software is based in part on the work of the Independent JPEG Group.

This software includes modified versions of dcm2niix’s jpg_0XC3.cpp, PostgreSQL’s pg_lzcompress.c, bitshuffle, liblj92, and rgbe.c.

This software includes qoi.h.

Wheels for macOS may not be available for the latest releases.

Build instructions and wheels for manylinux and macOS courtesy of Grzegorz Bokota.

Update pip and setuptools to the latest version before installing imagecodecs:

python -m pip install -U pip setuptools wheel Cython

Install the requirements for building imagecodecs from source code on latest Ubuntu Linux distributions:

sudo apt-get install build-essential python3-dev cython3 python3-setuptools python3-pip python3-wheel python3-numpy python3-zarr python3-pytest python3-blosc python3-brotli python3-snappy python3-lz4 libz-dev libblosc-dev liblzma-dev liblz4-dev libzstd-dev libpng-dev libwebp-dev libbz2-dev libopenjp2-7-dev libjpeg-dev libjxr-dev liblcms2-dev libcharls-dev libaec-dev libbrotli-dev libsnappy-dev libzopfli-dev libgif-dev libtiff-dev libdeflate-dev libavif-dev libheif-dev libcfitsio-dev

Use the --lite build option to only build extensions without 3rd-party dependencies. Use the --skip-extension build options to skip building specific extensions, e.g.:

python -m pip install imagecodecs --global-option="build_ext" --global-option="--skip-bitshuffle"

The apng, avif, jetraw, jpeg12, jpegls, jpegxl, lerc, lz4f, lzfse, lzham, mozjpeg, zfp, and zlibng extensions are disabled by default when building from source.

To modify other build settings such as library names and compiler arguments, provide a imagecodecs_distributor_setup.customize_build function, which is imported and executed during setup. See setup.py for examples.

Other Python packages and C libraries providing imaging or compression codecs: Python zlib, Python bz2, Python lzma, backports.lzma, python-lzo, python-lzw, python-lerc, packbits, isa-l.igzip, fpzip, libmng, OpenEXR (EXR, PIZ, PXR24, B44, DWA), pyJetraw, tinyexr, pytinyexr, pyroexr, libjpeg (GPL), pylibjpeg, pylibjpeg-libjpeg (GPL), pylibjpeg-openjpeg, pylibjpeg-rle, glymur, pyheif, pyrus-cramjam, PyLZHAM, QuickLZ (GPL), LZO (GPL), nvJPEG, nvJPEG2K, PyTurboJPEG, CCSDS123, LPC-Rice, MAFISC.

Examples

Import the JPEG2K codec:

>>> from imagecodecs import (
...     jpeg2k_encode, jpeg2k_decode, jpeg2k_check, jpeg2k_version, JPEG2K
... )

Check that the JPEG2K codec is available in the imagecodecs build:

>>> bool(JPEG2K)
True

Print the version of the JPEG2K codec’s underlying OpenJPEG library:

>>> jpeg2k_version()
'openjpeg 2.5.0'

Encode a numpy array in lossless JP2 format:

>>> array = numpy.random.randint(100, 200, (256, 256, 3), numpy.uint8)
>>> encoded = jpeg2k_encode(array, level=0)
>>> bytes(encoded[:12])
b'\x00\x00\x00\x0cjP  \r\n\x87\n'

Check that the encoded bytes likely contain a JPEG 2000 stream:

>>> jpeg2k_check(encoded)
True

Decode the JP2 encoded bytes to a numpy array:

>>> decoded = jpeg2k_decode(encoded)
>>> numpy.array_equal(decoded, array)
True

Decode the JP2 encoded bytes to an existing numpy array:

>>> out = numpy.empty_like(array)
>>> _ = jpeg2k_decode(encoded, out=out)
>>> numpy.array_equal(out, array)
True

Not all codecs are fully implemented, raising exceptions at runtime:

>>> from imagecodecs import tiff_encode
>>> tiff_encode(array)
Traceback (most recent call last):
 ...
NotImplementedError: tiff_encode

Write the numpy array to a JP2 file:

>>> from imagecodecs import imwrite, imread
>>> imwrite('_test.jp2', array)

Read the image from the JP2 file as numpy array:

>>> image = imread('_test.jp2')
>>> numpy.array_equal(image, array)
True

Create a JPEG 2000 compressed Zarr array:

>>> import zarr
>>> import numcodecs
>>> from imagecodecs.numcodecs import Jpeg2k
>>> numcodecs.register_codec(Jpeg2k)
>>> zarr.zeros(
...     (512, 512, 3), chunks=(256, 256, 3), dtype='u1', compressor=Jpeg2k()
... )
<zarr.core.Array (512, 512, 3) uint8>

Access image data in a sequence of JP2 files via tifffile.FileSequence and dask.array:

>>> import tifffile
>>> import dask.array
>>> def jp2_read(filename):
...     with open(filename, 'rb') as fh:
...         data = fh.read()
...     return jpeg2k_decode(data)
>>> with tifffile.FileSequence(jp2_read, '*.jp2') as ims:
...     with ims.aszarr() as store:
...         dask.array.from_zarr(store)
dask.array<from-zarr, shape=(1, 256, 256, 3)...chunksize=(1, 256, 256, 3)...

View the image in the JP2 file from the command line:

$ python -m imagecodecs _test.jp2