pylibheif 1.21.2__tar.gz → 1.21.2.post2__tar.gz

{pylibheif-1.21.2 → pylibheif-1.21.2.post2}/.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-14]
+        os: [ubuntu-latest, macos-14]
 
     steps:
       - uses: actions/checkout@v4
@@ -40,27 +40,40 @@ jobs:
         run: |
           brew install openjpeg nasm
 
-      # Windows dependencies
-      - name: Install Windows dependencies
-        if: runner.os == 'Windows'
-        run: |
-          choco install nasm
-
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.21.0
+        uses: pypa/cibuildwheel@v3.3.1
         env:
           # Build for Python 3.11-3.14
           CIBW_BUILD: cp311-* cp312-* cp313-* cp314-*
           # Skip 32-bit builds and musllinux
-          CIBW_SKIP: "*-win32 *-manylinux_i686 *musllinux*"
+          CIBW_SKIP: "*-manylinux_i686 *musllinux*"
           # Install build dependencies
           CIBW_BEFORE_BUILD_LINUX: |
-            yum install -y openjpeg2-devel nasm || apt-get install -y libopenjp2-7-dev nasm
+            if [ -x "$(command -v yum)" ]; then
+              yum install -y epel-release
+              /usr/bin/crb enable
+              yum install -y --nogpgcheck https://mirrors.rpmfusion.org/free/el/rpmfusion-free-release-8.noarch.rpm
+              yum install -y x265-devel libde265-devel libaom-devel libdav1d-devel openjpeg2-devel libjpeg-turbo-devel ffmpeg-devel nasm
+            else
+              apt-get update
+              apt-get install -y libx265-dev libde265-dev libaom-dev libdav1d-dev libopenjp2-7-dev libjpeg-dev libavcodec-dev libavutil-dev nasm
+            fi
+          CIBW_MANYLINUX_X86_64_IMAGE: manylinux_2_28
+          CIBW_CONFIG_SETTINGS_LINUX: >
+            cmake.define.WITH_DAV1D=OFF
+            cmake.define.WITH_OpenH264_DECODER=OFF
+            cmake.define.WITH_X264=OFF
+            cmake.define.WITH_FFMPEG_DECODER=ON
           CIBW_BEFORE_BUILD_MACOS: |
-            brew install openjpeg nasm
+            brew install openjpeg nasm x265 libde265 aom dav1d jpeg x264 openh264
+          CIBW_ENVIRONMENT_MACOS: MACOSX_DEPLOYMENT_TARGET=14.0
+          # Fix: Help delocate find Homebrew libraries on macOS
+          CIBW_REPAIR_WHEEL_COMMAND_MACOS: >
+            DYLD_LIBRARY_PATH=/opt/homebrew/lib:$DYLD_LIBRARY_PATH
+            delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}
           # Test the wheel
-          CIBW_TEST_REQUIRES: pytest numpy
-          CIBW_TEST_COMMAND: pytest {project}/tests -v
+          CIBW_TEST_REQUIRES: pytest numpy pytest-benchmark pillow-heif
+          CIBW_TEST_COMMAND: pytest {project}/tests -v --benchmark-skip
 
       - uses: actions/upload-artifact@v4
         with:

{pylibheif-1.21.2 → pylibheif-1.21.2.post2}/CMakeLists.txt

@@ -5,14 +5,19 @@ project(pylibheif LANGUAGES C CXX)
 find_package(pybind11 REQUIRED)
 
 # libheif options
-set(WITH_EXAMPLES OFF CACHE BOOL "Build examples" FORCE)
-set(WITH_RAV1E OFF CACHE BOOL "Build rav1e" FORCE)
-set(WITH_DAV1D ON CACHE BOOL "Build dav1d" FORCE)
-set(WITH_AOM ON CACHE BOOL "Build aom" FORCE)
-set(WITH_X265 ON CACHE BOOL "Build x265" FORCE)
-set(WITH_LIBDE265 ON CACHE BOOL "Build libde265" FORCE)
-set(WITH_OpenJPEG_ENCODER ON CACHE BOOL "Build OpenJPEG encoder" FORCE)
-set(WITH_OpenJPEG_DECODER ON CACHE BOOL "Build OpenJPEG decoder" FORCE)
+set(WITH_EXAMPLES OFF CACHE BOOL "Build examples")
+set(WITH_RAV1E OFF CACHE BOOL "Build rav1e")
+option(WITH_DAV1D "Build dav1d" ON)
+option(WITH_AOM "Build aom" ON)
+option(WITH_X265 "Build x265" ON)
+option(WITH_LIBDE265 "Build libde265" ON)
+option(WITH_OpenJPEG_ENCODER "Build OpenJPEG encoder" ON)
+option(WITH_OpenJPEG_DECODER "Build OpenJPEG decoder" ON)
+option(WITH_JPEG_ENCODER "Build JPEG encoder" ON)
+option(WITH_JPEG_DECODER "Build JPEG decoder" ON)
+option(WITH_X264 "Build x264 AVC encoder" ON)
+option(WITH_OpenH264_DECODER "Build OpenH264 AVC decoder" ON)
+option(WITH_FFMPEG_DECODER "Build FFmpeg HEVC/AVC decoder" OFF)
 
 # Disable plugin mode - build codecs as built-in
 set(WITH_DAV1D_PLUGIN OFF CACHE BOOL "Build dav1d as plugin" FORCE)

pylibheif-1.21.2.post2/LICENSE

@@ -0,0 +1,165 @@
+                    GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  "Application" refers to the work that makes use of an interface
+provided by the Library, but which is not otherwise based on the
+Library.  Defining a subclass of a class defined by the Library is
+deemed a mode of using an interface provided by the Library.
+
+  "Combined Work" refers to a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time.  Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation.  If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

{pylibheif-1.21.2 → pylibheif-1.21.2.post2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pylibheif
-Version: 1.21.2
+Version: 1.21.2.post2
 Summary: Python bindings for libheif - HEIC/AVIF/JPEG2000 image codec
 Keywords: heif,heic,avif,jpeg2000,image,codec,libheif
 Author-Email: Curry Tang <twn39@163.com>
@@ -65,16 +65,24 @@ sudo apt install libopenjp2-7-dev
 
 ## Installation
 
+```bash
+pip install pylibheif
+```
+
+Or with uv:
+```bash
+uv pip install pylibheif
+```
+
+### Building from Source
+
 ```bash
 # Clone with submodules
-git clone --recursive https://github.com/your-username/pylibheif.git
+git clone --recursive https://github.com/twn39/pylibheif.git
 cd pylibheif
 
-# Install with uv (recommended)
+# Install
 uv pip install -e .
-
-# Or with pip
-pip install -e .
 ```
 
 ## Usage
@@ -199,24 +207,164 @@ for id in exif_ids:
 
 ## API Reference
 
-### Classes
+### class `pylibheif.HeifContext`
 
-- `HeifContext`: Main context for reading/writing HEIF files
-- `HeifImageHandle`: Handle to a decoded image with metadata
-- `HeifImage`: Raw image data with buffer protocol support
-- `HeifEncoder`: Encoder for creating HEIF files
-- `HeifPlane`: Image plane with NumPy buffer protocol
+Manages the valid lifetime of libheif context. It is the main entry point (root object) for high-level API.
 
-### Enums
+#### Methods
+
+**`__init__()`**
+Creates a new empty context.
+
+**`read_from_file(filename: str) -> None`**
+Reads a HEIF file from the given filename.
+- `filename`: Path to the HEIF file.
+
+**`read_from_memory(data: bytes) -> None`**
+Reads a HEIF file from a bytes object.
+- `data`: Bytes containing the file content.
+
+**`write_to_file(filename: str) -> None`**
+Writes the current context to a file.
+- `filename`: Destination path.
+
+**`write_to_bytes() -> bytes`**
+Writes the current context to a bytes object.
+- Returns: `bytes` object containing the encoded file data.
+
+**`get_primary_image_handle() -> HeifImageHandle`**
+Gets the handle for the primary image in the file.
+- Returns: `HeifImageHandle` for the primary image.
+
+**`get_image_handle(id: int) -> HeifImageHandle`**
+Gets the handle for a specific image ID.
+- `id`: The ID of the image (see `get_list_of_top_level_image_IDs`).
+- Returns: `HeifImageHandle`.
+
+**`get_list_of_top_level_image_IDs() -> List[int]`**
+Gets a list of IDs of all top-level images in the file.
+- Returns: List of integer IDs.
+
+---
+
+### class `pylibheif.HeifImageHandle`
+
+Represents a compressed image within the HEIF file.
+
+#### Properties
+
+- **`width`** *(int)*: The width of the image.
+- **`height`** *(int)*: The height of the image.
+- **`has_alpha`** *(bool)*: True if the image has an alpha channel.
+
+#### Methods
+
+**`decode(colorspace: HeifColorspace = HeifColorspace.RGB, chroma: HeifChroma = HeifChroma.InterleavedRGB) -> HeifImage`**
+Decodes the image handle into an uncompressed `HeifImage`.
+- `colorspace`: Target colorspace (default: RGB).
+- `chroma`: Target chroma format (default: InterleavedRGB).
+- Returns: Decoded `HeifImage`.
+
+**`get_metadata_block_ids(type_filter: str = "") -> List[str]`**
+Gets a list of metadata block IDs attached to this image.
+- `type_filter`: Optional filter string (e.g. "Exif", "XMP").
+- Returns: List of metadata ID strings.
+
+**`get_metadata_block_type(id: str) -> str`**
+Gets the type string of a specific metadata block.
+- `id`: Metadata ID.
+- Returns: Type string (e.g. "Exif").
 
-- `HeifColorspace`: RGB, YCbCr, Monochrome
-- `HeifChroma`: C420, C422, C444, InterleavedRGB, InterleavedRGBA
-- `HeifChannel`: Y, Cb, Cr, R, G, B, Alpha, Interleaved
-- `HeifCompressionFormat`: HEVC, AV1, JPEG, JPEG2000
+**`get_metadata_block(id: str) -> bytes`**
+Gets the raw data of a metadata block.
+- `id`: Metadata ID.
+- Returns: `bytes` object containing the metadata.
 
-### Exceptions
+---
 
-- `HeifError`: Base exception for all libheif errors
+### class `pylibheif.HeifImage`
+
+Represents an uncompressed image containing pixel data. Supports the Python Buffer Protocol for zero-copy access with NumPy.
+
+#### Properties
+
+- **`width`** *(int)*: The width of the image.
+- **`height`** *(int)*: The height of the image.
+
+#### Methods
+
+**`__init__(width: int, height: int, colorspace: HeifColorspace, chroma: HeifChroma)`**
+Creates a new empty image.
+- `width`: Image width.
+- `height`: Image height.
+- `colorspace`: Image colorspace.
+- `chroma`: Image chroma format.
+
+**`add_plane(channel: HeifChannel, width: int, height: int, bit_depth: int) -> None`**
+Adds a new plane to the image.
+- `channel`: The channel type (e.g. `HeifChannel.Interleaved`).
+- `width`: Width of the plane.
+- `height`: Height of the plane.
+- `bit_depth`: Bit depth (e.g. 8).
+
+**`get_plane(channel: HeifChannel, writeable: bool = False) -> HeifPlane`**
+Gets a plane object that supports the buffer protocol.
+- `channel`: The channel to retrieve.
+- `writeable`: Whether the buffer should be writable.
+- Returns: `HeifPlane` object (wrappable with `np.asarray()`).
+
+---
+
+### class `pylibheif.HeifEncoder`
+
+Controls the encoding process.
+
+#### Methods
+
+**`__init__(format: HeifCompressionFormat)`**
+Creates a new encoder for the specified format.
+- `format`: Compression format (e.g. `HeifCompressionFormat.HEVC`).
+
+**`set_lossy_quality(quality: int) -> None`**
+Sets the quality for lossy compression.
+- `quality`: Integer between 0 (lowest) and 100 (highest).
+
+**`set_parameter(name: str, value: str) -> None`**
+Sets a low-level encoder parameter.
+- `name`: Parameter name (e.g. "speed" for AV1).
+- `value`: Parameter value.
+
+**`encode_image(context: HeifContext, image: HeifImage) -> None`**
+Encodes the given image and appends it to the context.
+- `context`: The destination `HeifContext`.
+- `image`: The source `HeifImage` to encode.
+
+---
+
+### Enums
+
+#### `pylibheif.HeifColorspace`
+- `RGB`, `YCbCr`, `Monochrome`, `Undefined`
+
+#### `pylibheif.HeifChroma`
+- `InterleavedRGB`: Interleaved R, G, B bytes.
+- `InterleavedRGBA`: Interleaved R, G, B, A bytes.
+- `C420`: YUV 4:2:0 planar.
+- `C422`: YUV 4:2:2 planar.
+- `C444`: YUV 4:4:4 planar.
+- `Monochrome`.
+
+#### `pylibheif.HeifChannel`
+- `Interleaved`: For interleaved RGB/RGBA.
+- `Y`, `Cb`, `Cr`: For YUV planar.
+- `R`, `G`, `B`: For RGB planar.
+- `Alpha`: For Alpha channel.
+
+#### `pylibheif.HeifCompressionFormat`
+- `HEVC`: H.265 (libx265).
+- `AV1`: AV1 (AOM/RAV1E/SVT).
+- `JPEG`: JPEG.
+- `JPEG2000`: JPEG 2000 (OpenJPEG).
 
 ## Building from Source
 
@@ -229,6 +377,24 @@ cd pylibheif
 uv pip install -e .
 ```
 
+## Performance
+
+Benchmarks on 1920x1080 RGB image (Apple Silicon):
+
+| Operation | pylibheif | pillow-heif | Note |
+|:---|:---:|:---:|:---|
+| HEVC Decode | 25 ms | 25 ms | ~39 FPS |
+| HEVC Encode | 279 ms | 272 ms | Quality 80 |
+| AV1 Encode | 91 ms | - | Speed 50 |
+
+`pylibheif` offers performance comparable to `pillow-heif` (both wrapper libheif), but exposes a lower-level C++ API for fine-grained control.
+
+Run benchmarks yourself:
+```bash
+uv pip install pillow-heif pytest-benchmark
+uv run pytest tests/test_benchmark.py --benchmark-only
+```
+
 ## License
 
 This project is licensed under the LGPL-3.0 License - see the [LICENSE](LICENSE) file for details.