https://github.com/catdad-experiments/heic-decode
🤳 decode heic images to extracts the raw pixel data
https://github.com/catdad-experiments/heic-decode
decode heic heif image npm-module
Last synced: 3 months ago
JSON representation
🤳 decode heic images to extracts the raw pixel data
- Host: GitHub
- URL: https://github.com/catdad-experiments/heic-decode
- Owner: catdad-experiments
- Created: 2020-01-17T22:37:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-01T06:17:19.000Z (almost 2 years ago)
- Last Synced: 2025-05-30T11:50:54.652Z (4 months ago)
- Topics: decode, heic, heif, image, npm-module
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 47
- Watchers: 3
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# heic-decode
> Decode HEIC images to extract raw pixel data.
[![CI][ci.svg]][ci.link]
[![npm-downloads][npm-downloads.svg]][npm.link]
[![npm-version][npm-version.svg]][npm.link]
[ci.svg]: https://github.com/catdad-experiments/heic-decode/actions/workflows/ci.yml/badge.svg
[ci.link]: https://github.com/catdad-experiments/heic-decode/actions/workflows/ci.yml
[npm-downloads.svg]: https://img.shields.io/npm/dm/heic-decode.svg
[npm.link]: https://www.npmjs.com/package/heic-decode
[npm-version.svg]: https://img.shields.io/npm/v/heic-decode.svg
## Install
```bash
npm install heic-decode
```
## Usage
Decode the main image in the file:
```javascript
const fs = require('fs');
const { promisify } = require('util');
const decode = require('heic-decode');
(async () => {
const buffer = await promisify(fs.readFile)('/path/to/my/image.heic');
const {
width, // integer width of the image
height, // integer height of the image
data // Uint8ClampedArray containing pixel data
} = await decode({ buffer });
})();
```
Decode all images in the file:
```javascript
const fs = require('fs');
const { promisify } = require('util');
const decode = require('heic-decode');
(async () => {
const buffer = await promisify(fs.readFile)('/path/to/my/multi-image.heic');
const images = await decode.all({ buffer });
for (let image of images) {
// decode and use each image individually
// so you don't run out of memory
const {
width, // integer width of the image
height, // integer height of the image
data // Uint8ClampedArray containing pixel data
} = await image.decode();
}
})();
```
When the images are decoded, the return value is a plain object in the format of [`ImageData`](https://developer.mozilla.org/en-US/docs/Web/API/ImageData). You can use this object to integrate with other imaging libraries for processing.
_Note that while the decoder returns a Promise, it does the majority of the work synchronously, so you should consider using a worker thread in order to not block the main thread in highly concurrent production environments._
## Related
* [heic-cli](https://github.com/catdad-experiments/heic-cli) - convert heic/heif images to jpeg or png from the command line
* [heic-convert](https://github.com/catdad-experiments/heic-convert) - convert heic/heif images to jpeg and png
* [libheif-js](https://github.com/catdad-experiments/libheif-js) - libheif as a pure-javascript npm module