heic-decode
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/heic-decode package

2.0.0 • Public • Published

heic-decode

Decode HEIC images to extract raw pixel data.

travis npm-downloads npm-version

Install

npm install heic-decode

Usage

Decode the main image in the file:

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:

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. 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.

  • heic-cli - convert heic/heif images to jpeg or png from the command line
  • heic-convert - convert heic/heif images to jpeg and png
  • libheif-js - libheif as a pure-javascript npm module

Package Sidebar

Install

npm i heic-decode

Weekly Downloads

52,379

Version

2.0.0

License

ISC

Unpacked Size

5.86 kB

Total Files

4

Last publish

Collaborators

  • kirilv