https://github.com/image-js/tiff
TIFF image decoder written entirely in JavaScript
https://github.com/image-js/tiff
image image-decoder javascript nodejs tiff
Last synced: 3 months ago
JSON representation
TIFF image decoder written entirely in JavaScript
- Host: GitHub
- URL: https://github.com/image-js/tiff
- Owner: image-js
- License: mit
- Created: 2015-09-19T10:23:55.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T08:24:33.000Z (over 1 year ago)
- Last Synced: 2024-04-14T09:45:31.949Z (about 1 year ago)
- Topics: image, image-decoder, javascript, nodejs, tiff
- Language: TypeScript
- Homepage:
- Size: 13.4 MB
- Stars: 176
- Watchers: 13
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Maintained by Zakodium
# tiff
[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[![test coverage][codecov-image]][codecov-url]
[![license][license-image]][license-url]
TIFF image decoder written entirely in TypeScript.
## Installation
```console
npm i tiff
```
## Compatibility
### [TIFF standard](./TIFF6.pdf)
The library can currently decode greyscale and RGB images (8, 16 or 32 bits).
It supports LZW compression and images with an additional alpha channel.
### Extensions
Images compressed with Zlib/deflate algorithm are also supported.
## API
### `tiff.decode(data[, options])`
Decodes the file and returns TIFF IFDs.
#### IFD object
Each decoded image is stored in an `IFD`.
##### IFD#data
The `data` property is a Typed Array containing the pixel data. It is a
`Uint8Array` for 8bit images, a `Uint16Array` for 16bit images and a
`Float32Array` for 32bit images.
##### Other properties of IFD
- `size` - number of pixels
- `width` - number of columns
- `height` - number of rows
- `bitsPerSample` - bit depth
- `alpha` - `true` if the image has an additional alpha channel
- `xResolution`
- `yResolution`
- `resolutionUnit`
### `tiff.pageCount(data)`
Returns the number of IFDs (pages) in the file.
### `tiff.isMultiPage(data)`
Returns true if the file has 2 or more IFDs (pages) and false if it has 1.
This is slightly more efficient than calling `pageCount()` if all you need to
know is whether the file has multiple pages or not.
## License
[MIT](./LICENSE)
[npm-image]: https://img.shields.io/npm/v/tiff.svg
[npm-url]: https://www.npmjs.com/package/tiff
[download-image]: https://img.shields.io/npm/dm/tiff.svg
[download-url]: https://www.npmjs.com/package/tiff
[codecov-image]: https://img.shields.io/codecov/c/github/image-js/tiff.svg
[codecov-url]: https://app.codecov.io/gh/image-js/tiff
[license-image]: https://img.shields.io/npm/l/tiff.svg
[license-url]: https://github.com/image-js/tiff/blob/main/LICENSE