# pyheif-iplweb
Hacked version for building binary wheels for macOS because of [this issue](https://github.com/carsales/pyheif/issues/95).
Please use [the original library here](https://github.com/carsales/pyheif/issues/95).
To build, download this repo, create virtualenv with
your favourite Python version, don't forget about downloading
libheic with homebrew or macports and type:
```
make all
```
In the ``dist`` directory you will find the wheel.
# pyheif
Python 3.6+ interface to [libheif](https://github.com/strukturag/libheif) library using CFFI
*Note*: currently only reading is supported.
## Installation
### Simple installation - Linux (installs manylinux2014 wheel, doesn't work with Alpine)
```
pip install --upgrade pip
pip install pyheif
```
### Installing from source - MacOS
```
brew install libffi libheif
pip install git+https://github.com/carsales/pyheif.git
```
### Installing from source - Linux
```
apt install libffi libheif-dev libde265-dev
```
or
```
yum install libffi libheif-devel libde265-devel
```
then
```
pip install git+https://github.com/carsales/pyheif.git
```
### Installing from source - Windows
```
Sorry, not going to happen!
```
## Usage
### Read the primary image of a HEIF encoded file
The `pyheif.read(path_or_bytes)` function can be used to read the primary image of a HEIF encoded file. It can be passed any of the following:
* A string path to a file on disk
* A `pathlib.Path` path object
* A Python `bytes` or `bytearray` object containing HEIF content
* A file-like object with a `.read()` method that returns bytes
It returns a `HeifImage` object.
```python
import pyheif
# Using a file path:
heif_file = pyheif.read("IMG_7424.HEIC")
# Or using bytes directly:
heif_file = pyheif.read(open("IMG_7424.HEIC", "rb").read())
```
### Converting to a Pillow Image object
If your HEIF file contains an image that you would like to manipulate, you can do so using the [Pillow](https://pillow.readthedocs.io/) Python library. You can convert a `HeifImage` to a Pillow image like so:
```python
from PIL import Image
import pyheif
heif_file = pyheif.read("IMG_7424.HEIC")
image = Image.frombytes(
heif_file.mode,
heif_file.size,
heif_file.data,
"raw",
heif_file.mode,
heif_file.stride,
)
```
*Note*: the `mode` property is passed twice - once to the `mode` argument of the `frombytes` method, and again to the `mode` argument of the `raw` decoder.
You can now use any Pillow method to manipulate the file. Here's how to convert it to JPEG:
```python
image.save("IMG_7424.jpg", "JPEG")
```
### Read the entire container within the HEIF file
The `pyheif.open_container(path_or_bytes)` function can be used to read the HEIF container from a HEIF encoded file. It takes the same parameter as `pyheif.read()`
It returns a `HeifContainer` object.
## Objects
### The HeifImage object
The `HeifImage` has the following properties:
* `mode` - the image mode, e.g. "RGB" or "RGBA"
* `size` - the size of the image as a `(width, height)` tuple of integers
* `data` - the raw decoded file data, as bytes
* `metadata` - a list of metadata dictionaries
* `color_profile` - a color profile dictionary
* `stride` - the number of bytes in a row of decoded file data
* `bit_depth` - the number of bits in each component of a pixel
### The UndecodedHeifImage object
This is a HEIF image that has not been decoded. Calling the `UndecodedHeifImage.load()` method will load the data and the object will become a `HeifImage`
### The HeifContainer object
The `HeifContainer` has the following properties:
* `primary_image` - the `HeifTopLevelImage` object of the primary image in the file.
* `top_level_images` - a list of all `HeifTopLevelImage` objects in the file.
### The HeifTopLevelImage object
The `HeifTopLevelImage` has the following properties:
* `id` - the id of the image
* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image
* `is_primary` - is this the primary image in the container
* `depth_image` - the `HeifDepthImage` if there is one
* `auxiliary_images` - a list of `HeifAuxiliaryImage` objects
### The HeifDepthImage object
The `HeifDepthImage` has the following properties:
* `id` - the id of the image
* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image
### The HeifAuxiliaryImage object
The `HeifAuxiliaryImage` has the following properties:
* `id` - the id of the image
* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image
* `type` - a string indicating the type of auxiliary image
Raw data
{
"_id": null,
"home_page": "https://github.com/carsales/pyheif",
"name": "pyheif-iplweb",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": null,
"keywords": "heif heic",
"author": "Anthony Paes",
"author_email": "ant32bit-carsales@users.noreply.github.com",
"download_url": null,
"platform": null,
"description": "# pyheif-iplweb\nHacked version for building binary wheels for macOS because of [this issue](https://github.com/carsales/pyheif/issues/95).\n\nPlease use [the original library here](https://github.com/carsales/pyheif/issues/95).\n\nTo build, download this repo, create virtualenv with \nyour favourite Python version, don't forget about downloading\nlibheic with homebrew or macports and type:\n```\nmake all\n```\n\nIn the ``dist`` directory you will find the wheel. \n\n# pyheif\nPython 3.6+ interface to [libheif](https://github.com/strukturag/libheif) library using CFFI\n\n*Note*: currently only reading is supported.\n\n## Installation\n\n### Simple installation - Linux (installs manylinux2014 wheel, doesn't work with Alpine)\n```\npip install --upgrade pip\npip install pyheif\n```\n\n### Installing from source - MacOS\n```\nbrew install libffi libheif\npip install git+https://github.com/carsales/pyheif.git\n```\n\n### Installing from source - Linux\n```\napt install libffi libheif-dev libde265-dev\n```\nor\n```\nyum install libffi libheif-devel libde265-devel\n```\nthen\n```\npip install git+https://github.com/carsales/pyheif.git\n```\n\n### Installing from source - Windows\n```\nSorry, not going to happen!\n```\n\n## Usage\n\n### Read the primary image of a HEIF encoded file\n\nThe `pyheif.read(path_or_bytes)` function can be used to read the primary image of a HEIF encoded file. It can be passed any of the following:\n\n* A string path to a file on disk\n* A `pathlib.Path` path object\n* A Python `bytes` or `bytearray` object containing HEIF content\n* A file-like object with a `.read()` method that returns bytes\n\nIt returns a `HeifImage` object.\n\n```python\nimport pyheif\n\n# Using a file path:\nheif_file = pyheif.read(\"IMG_7424.HEIC\")\n# Or using bytes directly:\nheif_file = pyheif.read(open(\"IMG_7424.HEIC\", \"rb\").read())\n```\n\n### Converting to a Pillow Image object\n\nIf your HEIF file contains an image that you would like to manipulate, you can do so using the [Pillow](https://pillow.readthedocs.io/) Python library. You can convert a `HeifImage` to a Pillow image like so:\n\n```python\nfrom PIL import Image\nimport pyheif\n\nheif_file = pyheif.read(\"IMG_7424.HEIC\")\nimage = Image.frombytes(\n heif_file.mode, \n heif_file.size, \n heif_file.data,\n \"raw\",\n heif_file.mode,\n heif_file.stride,\n )\n```\n\n*Note*: the `mode` property is passed twice - once to the `mode` argument of the `frombytes` method, and again to the `mode` argument of the `raw` decoder.\n\nYou can now use any Pillow method to manipulate the file. Here's how to convert it to JPEG:\n\n```python\nimage.save(\"IMG_7424.jpg\", \"JPEG\")\n```\n\n### Read the entire container within the HEIF file\n\nThe `pyheif.open_container(path_or_bytes)` function can be used to read the HEIF container from a HEIF encoded file. It takes the same parameter as `pyheif.read()`\n\nIt returns a `HeifContainer` object.\n\n## Objects\n\n### The HeifImage object\n\nThe `HeifImage` has the following properties:\n\n* `mode` - the image mode, e.g. \"RGB\" or \"RGBA\"\n* `size` - the size of the image as a `(width, height)` tuple of integers\n* `data` - the raw decoded file data, as bytes\n* `metadata` - a list of metadata dictionaries\n* `color_profile` - a color profile dictionary\n* `stride` - the number of bytes in a row of decoded file data\n* `bit_depth` - the number of bits in each component of a pixel\n\n### The UndecodedHeifImage object\n\nThis is a HEIF image that has not been decoded. Calling the `UndecodedHeifImage.load()` method will load the data and the object will become a `HeifImage`\n\n### The HeifContainer object\n\nThe `HeifContainer` has the following properties:\n\n* `primary_image` - the `HeifTopLevelImage` object of the primary image in the file.\n* `top_level_images` - a list of all `HeifTopLevelImage` objects in the file.\n\n### The HeifTopLevelImage object\n\nThe `HeifTopLevelImage` has the following properties:\n\n* `id` - the id of the image\n* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image\n* `is_primary` - is this the primary image in the container\n* `depth_image` - the `HeifDepthImage` if there is one\n* `auxiliary_images` - a list of `HeifAuxiliaryImage` objects\n\n### The HeifDepthImage object\n\nThe `HeifDepthImage` has the following properties:\n\n* `id` - the id of the image\n* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image\n\n### The HeifAuxiliaryImage object\n\nThe `HeifAuxiliaryImage` has the following properties:\n\n* `id` - the id of the image\n* `image` - the `UndecodedHeifImage` or `HeifImage` object of the image\n* `type` - a string indicating the type of auxiliary image\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python 3.6+ interface to libheif library",
"version": "0.7.1.dev1176",
"project_urls": {
"Homepage": "https://github.com/carsales/pyheif"
},
"split_keywords": [
"heif",
"heic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87892cee563bb91c40798da40e0c9a10f342ec896f5a641b867d2ba314fd0958",
"md5": "47bdb3a551865c9ae44666c923a9a2a8",
"sha256": "72f7836029bf3b8b5c4cecbced2ff4234a631c578d16f9d780118950fbb906cc"
},
"downloads": -1,
"filename": "pyheif_iplweb-0.7.1.dev1176-cp310-none-any.whl",
"has_sig": false,
"md5_digest": "47bdb3a551865c9ae44666c923a9a2a8",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "~=3.10",
"size": 86068,
"upload_time": "2024-03-22T10:25:53",
"upload_time_iso_8601": "2024-03-22T10:25:53.644237Z",
"url": "https://files.pythonhosted.org/packages/87/89/2cee563bb91c40798da40e0c9a10f342ec896f5a641b867d2ba314fd0958/pyheif_iplweb-0.7.1.dev1176-cp310-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95b0f88854ecfe3172ed155fedf9506f7469b9f25d69e81d6e5da88a6985044d",
"md5": "2c6af7ba80e9e453516e55b179f9307b",
"sha256": "f2de518398cbcdc6062b16e01f2acec943c38497f37e4d8e7575facfbec75c08"
},
"downloads": -1,
"filename": "pyheif_iplweb-0.7.1.dev1176-cp311-none-any.whl",
"has_sig": false,
"md5_digest": "2c6af7ba80e9e453516e55b179f9307b",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": "~=3.10",
"size": 88875,
"upload_time": "2024-03-22T10:25:56",
"upload_time_iso_8601": "2024-03-22T10:25:56.006018Z",
"url": "https://files.pythonhosted.org/packages/95/b0/f88854ecfe3172ed155fedf9506f7469b9f25d69e81d6e5da88a6985044d/pyheif_iplweb-0.7.1.dev1176-cp311-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c8de80c5169685dd66039e62d35fe5613993764883be5a58e815a6cced96ce6",
"md5": "b8c5cc3b7eae27d9e043953247c47924",
"sha256": "e8b1221a920086a033c964b488f1579542682d79cd2432110097417b4708d379"
},
"downloads": -1,
"filename": "pyheif_iplweb-0.7.1.dev1176-cp312-none-any.whl",
"has_sig": false,
"md5_digest": "b8c5cc3b7eae27d9e043953247c47924",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "~=3.10",
"size": 128647,
"upload_time": "2024-03-22T10:25:58",
"upload_time_iso_8601": "2024-03-22T10:25:58.029711Z",
"url": "https://files.pythonhosted.org/packages/3c/8d/e80c5169685dd66039e62d35fe5613993764883be5a58e815a6cced96ce6/pyheif_iplweb-0.7.1.dev1176-cp312-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 10:25:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carsales",
"github_project": "pyheif",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyheif-iplweb"
}
JSON
