# decode-tiff

> Lightweight tiff decoder

Latest version **0.2.1** (published 2017-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install decode-tiff
pnpm add decode-tiff
yarn add decode-tiff
bun add decode-tiff
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2017-07-18 |
| First published | 2017-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Quramy |
| Maintainers | quramy |
| Keywords | image, codec, tiff |

## Links

- npm: https://www.npmjs.com/package/decode-tiff
- Repository: https://github.com/Quramy/decode-tiff
- Homepage: https://github.com/Quramy/decode-tiff#readme
- Issues: https://github.com/Quramy/decode-tiff/issues
- npm.io page: https://npm.io/package/decode-tiff

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2017-07-18
- 0.2.0 — 2017-07-18
- 0.1.0 — 2017-07-17

## README

# decode-tiff
[![npm version](https://badge.fury.io/js/decode-tiff.svg)](https://badge.fury.io/js/decode-tiff)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

:zap: A lightweight pure JavaScript TIFF decoder. :art:

## How to use it
### With Node.js

```sh
npm i tiff-decode
```

The following example reads .tiff and converts to .png file using [pngjs](https://www.npmjs.com/package/pngjs).

```js
const { decode } = require("decode-tiff");

const { PNG } = require("pngjs");
const fs = require("fs");

const { width, height, data } = decode(fs.readFileSync(__dirname + "/lena_color.tiff"));

const png =  new PNG({ width, height });
png.data = data;
fs.writeFileSync(__dirname + "/lena.png", PNG.sync.write(png));
```

### With Browser

Download script file from [dist/decode-tiff.min.js](https://raw.githubusercontent.com/Quramy/decode-tiff/master/dist/decode-tiff.min.js). Alternatively you can use Module Bundler, such as webpack, Browserify, and Rollup.

This example shows metadata of the dropped file. [Working demonstration is here.](https://quramy.github.io/decode-tiff/)

```html
<html>
<head></head>
<body>

  <div id="drop">
    <p>Drop TIFF file here!</p>
  </div>

<script src="decode-tiff.min.js"></script>
<script>
const { decode } = window.decodeTiff;
const elm = document.getElementById("drop");
elm.addEventListener("dragenter", e => e.preventDefault());
elm.addEventListener("dragover", e => e.preventDefault());
elm.addEventListener("drop", e => {
  e.preventDefault();
  const file = e.dataTransfer.files[0];
  const reader = new FileReader();
  reader.addEventListener("load", e => {
    const arrayBuffer = e.target.result;
    const { width, height, ifdEntries } = decode(arrayBuffer);
    const metadata = JSON.stringify({ width, height, ifdEntries }, null, 2);
    elm.innerHTML = `<pre>${metadata}</pre>`;
  });
  reader.readAsArrayBuffer(file);
});
</script>
</body>
</html>
```

## API
### `decode(buffer: ArrayBuffer | Buffer, options?: { singlePage?: boolean }): TiffImage | TiffImage[]`

- params
  - `buffer` - *Required* - Buffer of the target TIFF image. Node.js Buffer and ECMA Script's ArrayBuffer are acceptable.
  - `options.singlePage` - *Optional (default: `true`)* - If true, this function returns a single TiffImage object. If the input has 2 or more pages, return value will be the first page.
- returns
  - `TiffImage` - An object.
  - `TiffImage.width` - *number* - Width of the input image.
  - `TiffImage.height` - *number* - Height of the input image.
  - `TiffImage.data` - *Uint8Array* - Image pixel data. Every pixel consists 4 bytes: R, G, B, A (opacity)
  - `TiffImage.ifdEntries` - *{[key: string]: Array}* - Each IFD entries of the input image.

## Compatibility

- Byte Order
  - [x] Little endian
  - [x] Big endian
- Color resolusion
  - [x] 32bit Full Colors
  - [x] 24bit Full Colors
  - [x] 8bit Gray scale
  - [x] 4bit Gray scale
  - [ ] Palette-Color
  - [ ] Bilevel(white)
  - [ ] Bilevel(black)
- Compression
  - [x] No Compression
  - [ ] CCITT Group 3
  - [ ] LZW Compression
  - [ ] ZIP
  - [ ] Packbits
- Masking
  - [ ] Transparency Mask

## License
MIT. See LICENSE.txt.

---
_Source: https://npm.io/package/decode-tiff · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._