Skip to content

Latest commit

 

History

History
151 lines (96 loc) · 4.93 KB

README.md

File metadata and controls

151 lines (96 loc) · 4.93 KB
Raw

psd-reader

Display Adobe® Photoshop® PSD files directly in the web browser.

  • Use PSD files as an image source for canvas.
  • Convert PSD to PNG or JPEG directly in the browser.
  • Create slide-shows with support for PSD files.

demo snapshot

Features

  • Fast and lightweight
  • Asynchronous and segment-based decoding (no UI-blocking)
  • No dependencies
  • Reads all supported formats (Greyscale, Bitmap, Indexed, RGB, CMYK, DuoTone, Multi-channel and Lab)
  • Reads all color depths (1/8/16/32 bits)
  • Handles alpha channel, and transparency for indexed mode
  • De-matte (matte removal) processing of images with alpha-channel (eliminates "halo" problems)
  • Supports RLE compressed and uncompressed image data
  • By default, converts all formats to RGBA so it can be used directly with canvas
  • Canvas helper method with optional scaling and high-quality down-sampling
  • Optional gamma correction
  • By default, auto-corrects display gamma for 32-bit color mode
  • Access to the original channel bitmaps (decompressed if needed)
  • Access to raw meta and header data
  • Access to resource chunks (incl. ID locator method)
  • Passive load mode allowing parsing to be invoked manually later
  • Validates and performs error checks
  • Works in all major browsers (Firefox, Chrome, IE, Opera, Safari).
  • For client-side use
  • An original parser implementation built from scratch.
  • Full documentation (see docs/ folder or online docs)

Demos

Demos demonstrating psd-reader.

Note that PSD files can be relative large in size so please be patient when downloading the test images for the acid-test demo.

➜ Acid-test - various color modes, formats and depths

➜ Built-in gamma correction

➜ Drop in your own PSD files

Install

Install psd-reader in various ways:

Documentation

The project is documented and is available as html in the docs folder

➜ The documentation can be viewed online

Tutorials and general information is included in the docs.

Usage

Create a new instance, pass in an URL (or an array buffer), and a callback:

var psd = new PsdReader({url: "path/to.psd", onLoad: myCallback});

In your callback you can access the RGBA data:

function myCallback(e) {
    var bitmap = this.rgba;
}

To get a canvas version of the data:

function myCallback(e) {
    var canvas = this.toCanvas();
    ...
}

An already existing ArrayBuffer can be used instead of an URL:

var psd = new PsdReader({buffer: psdArrayBuffer, onLoad: myCallback});

There is additional access to the original channel bitmap data in it´s native format (8-bit, 16-bit etc.). The header information can be accessed through the info object:

var width     = psd.info.width;
var height    = psd.info.height;
var depth     = psd.info.depth;
var layers    = psd.info.chunks[3];		// the layers area

var channel0  = psd.bitmaps[0];	        // in native format (but uncompressed)
...

A method to locate resources is included:

var icc = psd.findResource(1039);       // find resource with resource ID

Requirements

A browser with support for HTML5 Canvas and typed arrays.

There are no dependencies.

Limitations

These are generally non-problematic, but something to have in mind:

  • Does not intend to parse individual layers (we will publish something for this later)
  • The PSD must be saved in (the typical) compatibility mode (see tutorial section in docs for details)
  • ICC profiles are not parsed/applied

Issues

See the issue tracker for details.

Please do report issues if you find any.

License

Released under MIT license. You may use this class in both commercial and non-commercial projects provided that full header (minified and developer versions) is included.

© 2015 Epistmex

Epistemex