psd

Version:

A general purpose Photoshop file parser.

85 lines (68 loc) • 20.7 kB

HTML

<!DOCTYPE html><html><head><title>psd.coffee</title><meta http-equiv="Content-Type" content="text/html" charset="UTF-8"><link rel="stylesheet" media="all" href="../docco.css"></head><body><div id="container"><div id="background"></div><div id="jump_to">Jump To …<div id="jump_wrapper"><div id="jump_page"><a href="../index.html" class="source">README</a><a href="../lib/psd/blend_mode.coffee.html" class="source ">lib / psd / blend_mode.coffee</a><a href="../lib/psd/channel_image.coffee.html" class="source ">lib / psd / channel_image.coffee</a><a href="../lib/psd/color.coffee.html" class="source ">lib / psd / color.coffee</a><a href="../lib/psd/descriptor.coffee.html" class="source ">lib / psd / descriptor.coffee</a><a href="../lib/psd/file.coffee.html" class="source ">lib / psd / file.coffee</a><a href="../lib/psd/header.coffee.html" class="source ">lib / psd / header.coffee</a><a href="../lib/psd/image.coffee.html" class="source ">lib / psd / image.coffee</a><a href="../lib/psd/image_export.coffee.html" class="source ">lib / psd / image_export.coffee</a><a href="../lib/psd/image_exports/png.coffee.html" class="source ">lib / psd / image_exports / png.coffee</a><a href="../lib/psd/image_format.coffee.html" class="source ">lib / psd / image_format.coffee</a><a href="../lib/psd/image_formats/layer_raw.coffee.html" class="source ">lib / psd / image_formats / layer_raw.coffee</a><a href="../lib/psd/image_formats/layer_rle.coffee.html" class="source ">lib / psd / image_formats / layer_rle.coffee</a><a href="../lib/psd/image_formats/raw.coffee.html" class="source ">lib / psd / image_formats / raw.coffee</a><a href="../lib/psd/image_formats/rle.coffee.html" class="source ">lib / psd / image_formats / rle.coffee</a><a href="../lib/psd/image_mode.coffee.html" class="source ">lib / psd / image_mode.coffee</a><a href="../lib/psd/image_modes/cmyk.coffee.html" class="source ">lib / psd / image_modes / cmyk.coffee</a><a href="../lib/psd/image_modes/greyscale.coffee.html" class="source ">lib / psd / image_modes / greyscale.coffee</a><a href="../lib/psd/image_modes/rgb.coffee.html" class="source ">lib / psd / image_modes / rgb.coffee</a><a href="../lib/psd/init.coffee.html" class="source ">lib / psd / init.coffee</a><a href="../lib/psd/layer/blend_modes.coffee.html" class="source ">lib / psd / layer / blend_modes.coffee</a><a href="../lib/psd/layer/blending_ranges.coffee.html" class="source ">lib / psd / layer / blending_ranges.coffee</a><a href="../lib/psd/layer/channel_image.coffee.html" class="source ">lib / psd / layer / channel_image.coffee</a><a href="../lib/psd/layer/helpers.coffee.html" class="source ">lib / psd / layer / helpers.coffee</a><a href="../lib/psd/layer/info.coffee.html" class="source ">lib / psd / layer / info.coffee</a><a href="../lib/psd/layer/mask.coffee.html" class="source ">lib / psd / layer / mask.coffee</a><a href="../lib/psd/layer/name.coffee.html" class="source ">lib / psd / layer / name.coffee</a><a href="../lib/psd/layer/position_channels.coffee.html" class="source ">lib / psd / layer / position_channels.coffee</a><a href="../lib/psd/layer.coffee.html" class="source ">lib / psd / layer.coffee</a><a href="../lib/psd/layer_info/blend_clipping_elements.coffee.html" class="source ">lib / psd / layer_info / blend_clipping_elements.coffee</a><a href="../lib/psd/layer_info/blend_interior_elements.coffee.html" class="source ">lib / psd / layer_info / blend_interior_elements.coffee</a><a href="../lib/psd/layer_info/fill_opacity.coffee.html" class="source ">lib / psd / layer_info / fill_opacity.coffee</a><a href="../lib/psd/layer_info/gradient_fill.coffee.html" class="source ">lib / psd / layer_info / gradient_fill.coffee</a><a href="../lib/psd/layer_info/layer_id.coffee.html" class="source ">lib / psd / layer_info / layer_id.coffee</a><a href="../lib/psd/layer_info/layer_name_source.coffee.html" class="source ">lib / psd / layer_info / layer_name_source.coffee</a><a href="../lib/psd/layer_info/legacy_typetool.coffee.html" class="source ">lib / psd / layer_info / legacy_typetool.coffee</a><a href="../lib/psd/layer_info/locked.coffee.html" class="source ">lib / psd / layer_info / locked.coffee</a><a href="../lib/psd/layer_info/metadata.coffee.html" class="source ">lib / psd / layer_info / metadata.coffee</a><a href="../lib/psd/layer_info/nested_section_divider.coffee.html" class="source ">lib / psd / layer_info / nested_section_divider.coffee</a><a href="../lib/psd/layer_info/object_effects.coffee.html" class="source ">lib / psd / layer_info / object_effects.coffee</a><a href="../lib/psd/layer_info/section_divider.coffee.html" class="source ">lib / psd / layer_info / section_divider.coffee</a><a href="../lib/psd/layer_info/solid_color.coffee.html" class="source ">lib / psd / layer_info / solid_color.coffee</a><a href="../lib/psd/layer_info/typetool.coffee.html" class="source ">lib / psd / layer_info / typetool.coffee</a><a href="../lib/psd/layer_info/unicode_name.coffee.html" class="source ">lib / psd / layer_info / unicode_name.coffee</a><a href="../lib/psd/layer_info/vector_mask.coffee.html" class="source ">lib / psd / layer_info / vector_mask.coffee</a><a href="../lib/psd/layer_info/vector_origination.coffee.html" class="source ">lib / psd / layer_info / vector_origination.coffee</a><a href="../lib/psd/layer_info/vector_stroke.coffee.html" class="source ">lib / psd / layer_info / vector_stroke.coffee</a><a href="../lib/psd/layer_info/vector_stroke_content.coffee.html" class="source ">lib / psd / layer_info / vector_stroke_content.coffee</a><a href="../lib/psd/layer_info.coffee.html" class="source ">lib / psd / layer_info.coffee</a><a href="../lib/psd/layer_mask.coffee.html" class="source ">lib / psd / layer_mask.coffee</a><a href="../lib/psd/lazy_execute.coffee.html" class="source ">lib / psd / lazy_execute.coffee</a><a href="../lib/psd/mask.coffee.html" class="source ">lib / psd / mask.coffee</a><a href="../lib/psd/node.coffee.html" class="source ">lib / psd / node.coffee</a><a href="../lib/psd/nodes/ancestry.coffee.html" class="source ">lib / psd / nodes / ancestry.coffee</a><a href="../lib/psd/nodes/build_preview.coffee.html" class="source ">lib / psd / nodes / build_preview.coffee</a><a href="../lib/psd/nodes/group.coffee.html" class="source ">lib / psd / nodes / group.coffee</a><a href="../lib/psd/nodes/layer.coffee.html" class="source ">lib / psd / nodes / layer.coffee</a><a href="../lib/psd/nodes/root.coffee.html" class="source ">lib / psd / nodes / root.coffee</a><a href="../lib/psd/nodes/search.coffee.html" class="source ">lib / psd / nodes / search.coffee</a><a href="../lib/psd/path_record.coffee.html" class="source ">lib / psd / path_record.coffee</a><a href="../lib/psd/resource.coffee.html" class="source ">lib / psd / resource.coffee</a><a href="../lib/psd/resource_section.coffee.html" class="source ">lib / psd / resource_section.coffee</a><a href="../lib/psd/resources/layer_comps.coffee.html" class="source ">lib / psd / resources / layer_comps.coffee</a><a href="../lib/psd/resources.coffee.html" class="source ">lib / psd / resources.coffee</a><a href="../lib/psd/util.coffee.html" class="source ">lib / psd / util.coffee</a><a href="../lib/psd.coffee.html" class="source selected">lib / psd.coffee</a><a href="../shims/init.coffee.html" class="source ">shims / init.coffee</a><a href="../shims/png.coffee.html" class="source ">shims / png.coffee</a></div></div></div><table cellpadding="0" cellspacing="0"><thead><tr><th class="docs"><h1>psd.coffee</h1><div class="filepath">lib/</div></th><th class="code"></th></tr></thead><tbody><tr id="section-1"><td class="docs"><div class="pilwrap"><a href="#section-1" class="pilcrow">¶</a></div>A general purpose parser for Photoshop files. PSDs are broken up in to 4 logical sections: the header, resources, the layer mask (including layers), and the preview image. We parse each of these sections in order. <h2 id="nodejs-examples">NodeJS Examples</h2> Parsing asynchronously <pre><code class="lang-coffeescript">PSD.open('path/to/file.psd').then (psd) -> console.log psd.tree().export() </code></pre> Parsing synchronously <pre><code class="lang-coffeescript">psd = PSD.fromFile('path/to/file.psd') psd.parse() console.log psd.tree().export() </code></pre> </td><td class="code"><div class="highlight"><pre>RSVP = require 'rsvp' {Module} = require 'coffeescript-module' File = require './psd/file.coffee' LazyExecute = require './psd/lazy_execute.coffee' Header = require './psd/header.coffee' Resources = require './psd/resources.coffee' LayerMask = require './psd/layer_mask.coffee' Image = require './psd/image.coffee' module.exports = class PSD extends Module @Node: Root: require('./psd/nodes/root.coffee') @extends require('./psd/init.coffee')</pre></div></td></tr><tr id="section-2"><td class="docs"><div class="pilwrap"><a href="#section-2" class="pilcrow">¶</a></div>Creates a new PSD object. Typically you will use a helper method to instantiate the PSD object. However, if you already have the PSD data stored as a Uint8Array, you can instantiate the PSD object directly. </td><td class="code"><div class="highlight"><pre> constructor: (data) -> @file = new File(data) @parsed = false @header = null Object.defineProperty @, 'layers', get: -> @layerMask.layers RSVP.on 'error', (reason) -> console.error(reason)</pre></div></td></tr><tr id="section-3"><td class="docs"><div class="pilwrap"><a href="#section-3" class="pilcrow">¶</a></div>Parses the PSD. You must call this method before attempting to access PSD data. It will not re-parse the PSD if it has already been parsed. </td><td class="code"><div class="highlight"><pre> parse: -> return if @parsed @parseHeader() @parseResources() @parseLayerMask() @parseImage() @parsed = true</pre></div></td></tr><tr id="section-4"><td class="docs"><div class="pilwrap"><a href="#section-4" class="pilcrow">¶</a></div>The next 4 methods are responsible for parsing the 4 main sections of the PSD. These are private, and you should never call them from your own code. </td><td class="code"><div class="highlight"><pre> parseHeader: -> @header = new Header(@file) @header.parse() parseResources: -> resources = new Resources(@file) @resources = new LazyExecute(resources, @file) .now('skip') .later('parse') .get() parseLayerMask: -> layerMask = new LayerMask(@file, @header) @layerMask = new LazyExecute(layerMask, @file) .now('skip') .later('parse') .get() parseImage: -> image = new Image(@file, @header) @image = new LazyExecute(image, @file) .later('parse') .ignore('width', 'height') .get()</pre></div></td></tr><tr id="section-5"><td class="docs"><div class="pilwrap"><a href="#section-5" class="pilcrow">¶</a></div>Returns a tree representation of the PSD document, which is the preferred way of accessing most of the PSD's data. </td><td class="code"><div class="highlight"><pre> tree: -> new PSD.Node.Root(@) </pre></div></td></tr></tbody></table><div id="generated">generated Tue May 12 2015 11:08:15 GMT-0400 (EDT) </div></div></body></html>