Socket
Socket
Sign inDemoInstall

utif

Package Overview
Dependencies
1
Maintainers
2
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    utif

Fast and advanced TIFF decoder


Version published
Maintainers
2
Created

Readme

Source

UTIF.js

A small, fast and advanced TIFF / EXIF decoder and encoder. It is the main TIFF library for Photopea image editor. Try to open your TIFF file with Photopea to see, if UTIF.js can parse it.

  • Supports Black & White, Grayscale, RGB and Paletted images
  • Supports Fax 3 and Fax 4 (CCITT), LZW, PackBits and other compressions
  • E.g. this 8 MPix image with Fax 4 compression is just 56 kB ( Open in Photopea )

Installation

Download and include the UTIF.js file in your code. If you're in NodeJS or otherwise using NPM, run:

npm install utif
UTIF.decode(buffer)
  • buffer: ArrayBuffer containing TIFF or EXIF data
  • returns an array of "images" (or "layers", "pages"). Each element of this array is an object with following properties:
    • width: the width of the image
    • height: the height of the image
    • data: decompressed pixel data of the image
    • tXYZ: other TIFF tags

TIFF files may have different number of channels and different color depth. The interpretation of data depends on many tags (see the TIFF 6 specification).

UTIF.toRGBA8(img)
  • img: TIFF image object (returned by UTIF.decode())
  • returns Uint8Array of the image in RGBA format, 8 bits per channel (ready to use in ctx.putImageData() etc.)

Example

function imgLoaded(e) {
  var pages = UTIF.decode(e.target.response);
  var rgba  = UTIF.toRGBA8(pages[0]);  // Uint8Array with RGBA pixels
  console.log(pages[0].width, pages[0].height, pages[0]);
}

var xhr = new XMLHttpRequest();
xhr.open("GET", "my_image.tif");
xhr.responseType = "arraybuffer";
xhr.onload = imgLoaded;   xhr.send();

Use TIFF images in HTML

If you are not a programmer, you can use TIFF images directly inside the <img> element of HTML. Then, it is enough to call UTIF.replaceIMG() once at some point.

UTIF.replaceIMG()
<body onload="UTIF.replaceIMG()">
...
<img src="image.tif" />  <img src="dog.tif" /> ...

And UTIF.js will do the rest. Internally, an Image elements will be replaced by a Canvas elements. The attributes "id", "class" and "style" will be copied from the original Image to the new Canvas. Use CSS to style such images.

Encoding TIFF images

You should not save images into TIFF format in the 21st century. Save them as PNG instead (e.g. using UPNG.js). If you still want to use TIFF format for some reason, here it is.

UTIF.encodeImage(rgba, w, h, metadata)
  • rgba: ArrayBuffer containing RGBA pixel data
  • w: image width
  • h: image height
  • metadata [optional]: IFD object (see below)
  • returns ArrayBuffer of the binary TIFF file. No compression right now.
UTIF.encode(ifds)
  • ifds: array of IFDs (image file directories). An IFD is a JS object with properties "tXYZ" (where XYZ are TIFF tags)
  • returns ArrayBuffer of binary data. You can use it to encode EXIF data.

Dependencies

TIFF format sometimes uses Inflate algorithm for compression (but it is quite rare). Right now, UTIF.js calls Pako.js for the Inflate method. TIFF format sometimes uses JPEG compression (but it is quite rare). Right now, UTIF.js calls "JpegDecoder" constructor, which comes from pdf.js. You can find it "separated" from pdf.js in libraries such as jpg.js.

Keywords

FAQs

Last updated on 19 Sep 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc