upng

A small, fast and advanced PNG / APNG encoder and decoder

This project is a fork of UPNG.js and was created for use in @adnsistemas/pdf-lib. The maintainer of the original repo does not publish it to NPM. That is the primary purpose of this fork. In addition, an index.d.ts file has been added (copied directly from @types/upng-js) to makes TypeScript definitions available without requiring additional packages to be installed.
The original package @pdf-lib/upng was modified to be able to use it in ESM and CommonJS projects.

Example of UPNG.toRGBA8

// Import the UPNG class
import UPNG from '@adnsistemas/upng';

// Create a UPNG object
const pngImage = UPNG.decode(/* Uint8Array containing bytes of PNG image */);

// `pixels` is a 1D array (in rgba order) of decoded pixel data
const pixels = pngImage.UPNG.toRGBA8();

Installation

NPM Module

To install the latest stable version:

# With npm
npm install --save @adnsistemas/upng

# With yarn
yarn add @adnsistemas/upng

This assumes you're using npm or yarn as your package manager.

UMD Module

You can also download @pdf-lib/upng as a UMD module from unpkg. The UMD builds have been compiled to ES5, so they should work in any modern browser. UMD builds are useful if you aren't using a package manager or module bundler. For example, you can use them directly in the <script> tag of an HTML page.

The following builds are available:

• https://unpkg.com/@pdf-lib/upng/dist/UPNG.js
• https://unpkg.com/@pdf-lib/upng/dist/UPNG.min.js

When using a UMD build, you will have access to a global window.UPNG variable. This variable contains the UPNG class exported by @pdf-lib/upng. For example:

// NPM module
import UPNG from '@pdf-lib/upng';
const pngImage = UPNG.decode(/* ... */)

// UMD module
var pngImage = window.UPNG.decode(/* ... */)

Encoder

UPNG.js supports APNG and the interface expects "frames". Regular PNG is just a single-frame animation (single-item array).

UPNG.encode(imgs, w, h, cnum, [dels], [tabs])

• imgs: array of frames. A frame is an ArrayBuffer containing the pixel data (RGBA, 8 bits per channel)
• w, h : width and height of the image
• cnum: number of colors in the result; 0: all colors (lossless PNG)
• dels: array of millisecond delays for each frame (only when 2 or more frames)
• tabs: object of options. { loop: 1 } will play the animation only once (default is 0, will play indefinitely).
• returns an ArrayBuffer with binary data of a PNG file

UPNG.js can do a lossy minification of PNG files, similar to TinyPNG and other tools. It performed quantization with k-means algorithm in the past, but now we use K-d trees.

Lossy compression is allowed by the last parameter cnum. Set it to zero for a lossless compression, or write the number of allowed colors in the image. Smaller values produce smaller files. Or just use 0 for lossless / 256 for lossy.

// Read RGBA from canvas and encode with UPNG
var dta = ctx.getImageData(0,0,200,300).data;  // ctx is Context2D of a Canvas
//  dta = new Uint8Array(200 * 300 * 4);       // or generate pixels manually
var png = UPNG.encode([dta.buffer], 200, 300, 0);   console.log(new Uint8Array(png));

UPNG.encodeLL(imgs, w, h, cc, ac, depth, [dels]) - low-level encode

• imgs: array of frames. A frame is an ArrayBuffer containing the pixel data (corresponding to following parameters)
• w, h : width and height of the image
• cc, ac: number of color channels (1 or 3) and alpha channels (0 or 1)
• depth: bit depth of pixel data (1, 2, 4, 8, 16)
• dels: array of millisecond delays for each frame (only when 2 or more frames)
• returns an ArrayBuffer with binary data of a PNG file

This function does not do any optimizations, it just stores what you give it. There are two cases when it is useful:

• saving 16-bit colors (note, that PNG is big-endian, unlike Uint16Array in JS)
• your image is too large, and "expanding" to 8-bit RGBA would use too much memory (e.g. 4-bit grayscale 50,000 x 50,000 = 1.25 GB, 8-bit RGBA would be 10 GB)

Decoder

Supports all color types (including Grayscale and Palettes), all channel depths (1, 2, 4, 8, 16), interlaced images etc. Opens PNGs which other libraries can not open (tested with PngSuite).

UPNG.decode(buffer)

• buffer: ArrayBuffer containing the PNG file
• returns an image object with following properties:
• • width: the width of the image
• • height: the height of the image
• • depth: number of bits per channel
• • ctype: color type of the file (Truecolor, Grayscale, Palette ...)
• • frames: additional info about frames (frame delays etc.)
• • tabs: additional chunks of the PNG file
• • data: pixel data of the image

PNG files may have a various number of channels and a various color depth. The interpretation of data depends on the current color type and color depth (see the PNG specification).

UPNG.toRGBA8(img)

• img: PNG image object (returned by UPNG.decode())
• returns an array of frames. A frame is ArrayBuffer of the image in RGBA format, 8 bits per channel.

Example

var img  = UPNG.decode(buff);        // put ArrayBuffer of the PNG file into UPNG.decode
var rgba = UPNG.toRGBA8(img)[0];     // UPNG.toRGBA8 returns array of frames, size: width * height * 4 bytes.

PNG format uses the Inflate algorithm. Right now, UPNG.js calls Pako.js for the Inflate and Deflate method.

Quantizer

UPNG.js contains a very good Quantizer of 4-component 8-bit vectors (i.e. pixels). It can be used to generate nice color palettes (e.g. Photopea uses UPNG.js to make palettes for GIF images).

Quantization consists of two important steps: Finding a nice palette and Finding the closest color in the palette for each sample (non-trivial for large palettes). UPNG perfroms both steps.

var res  = UPNG.quantize(data, psize);

• data: ArrayBuffer of samples (byte length is a multiple of four)
• psize : Palette size (how many colors you want to have)

The result object "res" has following properties:

• abuf: ArrayBuffer corresponding to data, where colors are remapped by a palette
• inds: Uint8Array : the index of a color for each sample (only when psize<=256)
• plte: Array : the Palette - a list of colors, plte[i].est.q and plte[i].est.rgba is the color value

FAQ

• To get one common palette for multiple images (e.g. frames of the animation), concatenate them into one array data.
• When working with less than four components, set the remaining components to a constant value (e.g. to zero)
• When working with transparency, premultiply color components by transparency (otherwise, rgba(1,1,1,0) would be closer to rgba(1,1,1,1) than to rgba(0,0,0,0) - transparent mapped to white instead of transparent)