psd

Version:

A general purpose Photoshop file parser.

78 lines (60 loc) • 24.2 kB

HTML

<!DOCTYPE html><html><head><title>file.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 selected">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 ">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>file.coffee</h1><div class="filepath">lib/psd/</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> </td><td class="code"><div class="highlight"><pre>{jspack} = require 'jspack' iconv = require 'iconv-lite' Color = require './color.coffee' Util = require './util.coffee'</pre></div></td></tr><tr id="section-2"><td class="docs"><div class="pilwrap"><a href="#section-2" class="pilcrow">¶</a></div>A file abstraction that stores the PSD file data, and assists in parsing it. </td><td class="code"><div class="highlight"><pre>module.exports = class File FORMATS = Int: code: '>i' length: 4 UInt: code: '>I' length: 4 Short: code: '>h' length: 2 UShort: code: '>H' length: 2 Float: code: '>f' length: 4 Double: code: '>d' length: 8 LongLong: code: '>q' length: 8 for own format, info of FORMATS then do (format, info) => @::["read#{format}"] = -> @readf(info.code, info.length)[0]</pre></div></td></tr><tr id="section-3"><td class="docs"><div class="pilwrap"><a href="#section-3" class="pilcrow">¶</a></div>The current cursor position in the file. </td><td class="code"><div class="highlight"><pre> pos: 0</pre></div></td></tr><tr id="section-4"><td class="docs"><div class="pilwrap"><a href="#section-4" class="pilcrow">¶</a></div>Creates a new File with the given Uint8Array. </td><td class="code"><div class="highlight"><pre> constructor: (@data) -></pre></div></td></tr><tr id="section-5"><td class="docs"><div class="pilwrap"><a href="#section-5" class="pilcrow">¶</a></div>Returns the current cursor position. </td><td class="code"><div class="highlight"><pre> tell: -> @pos</pre></div></td></tr><tr id="section-6"><td class="docs"><div class="pilwrap"><a href="#section-6" class="pilcrow">¶</a></div>Reads raw file data with no processing. </td><td class="code"><div class="highlight"><pre> read: (length) -> (@data[@pos++] for i in [0...length])</pre></div></td></tr><tr id="section-7"><td class="docs"><div class="pilwrap"><a href="#section-7" class="pilcrow">¶</a></div>Reads file data and processes it with the given unpack format string. If the length is omitted, then it will be calculated automatically based on the format string. </td><td class="code"><div class="highlight"><pre> readf: (format, len = null) -> jspack.Unpack format, @read(len or jspack.CalcLength(format))</pre></div></td></tr><tr id="section-8"><td class="docs"><div class="pilwrap"><a href="#section-8" class="pilcrow">¶</a></div>Moves the cursor without parsing data. If <code>rel = false</code>, then the cursor will be set to the given value, which effectively sets the position relative to the start of the file. If <code>rel = true</code>, then the cursor will be moved relative to the current position. </td><td class="code"><div class="highlight"><pre> seek: (amt, rel = false) -> if rel then @pos += amt else @pos = amt</pre></div></td></tr><tr id="section-9"><td class="docs"><div class="pilwrap"><a href="#section-9" class="pilcrow">¶</a></div>Reads a String of the given length. </td><td class="code"><div class="highlight"><pre> readString: (length) -> String.fromCharCode.apply(null, @read(length)).replace /\u0000/g, ""</pre></div></td></tr><tr id="section-10"><td class="docs"><div class="pilwrap"><a href="#section-10" class="pilcrow">¶</a></div>Reads a Unicode UTF-16BE encoded string. </td><td class="code"><div class="highlight"><pre> readUnicodeString: (length = null) -> length or= @readInt() iconv.decode(new Buffer(@read(length * 2)),'utf-16be').replace /\u0000/g, ""</pre></div></td></tr><tr id="section-11"><td class="docs"><div class="pilwrap"><a href="#section-11" class="pilcrow">¶</a></div>Helper that reads a single byte. </td><td class="code"><div class="highlight"><pre> readByte: -> @read(1)[0]</pre></div></td></tr><tr id="section-12"><td class="docs"><div class="pilwrap"><a href="#section-12" class="pilcrow">¶</a></div>Helper that reads a single byte and interprets it as a boolean. </td><td class="code"><div class="highlight"><pre> readBoolean: -> @readByte() isnt 0</pre></div></td></tr><tr id="section-13"><td class="docs"><div class="pilwrap"><a href="#section-13" class="pilcrow">¶</a></div>Reads a 32-bit color space value. </td><td class="code"><div class="highlight"><pre> readSpaceColor: -> colorSpace = @readShort() colorComponent = (@readShort() >> 8) for i in [0...4] colorSpace: colorSpace, components: colorComponent</pre></div></td></tr><tr id="section-14"><td class="docs"><div class="pilwrap"><a href="#section-14" class="pilcrow">¶</a></div>Adobe's lovely signed 32-bit fixed-point number with 8bits.24bits <a href="http://www.adobe.com/devnet-apps/photoshop/fileformatashtml/PhotoshopFileFormats.htm#50577409_17587">http://www.adobe.com/devnet-apps/photoshop/fileformatashtml/PhotoshopFileFormats.htm#50577409_17587</a> </td><td class="code"><div class="highlight"><pre> readPathNumber: -> a = @readByte() arr = @read(3) b1 = arr[0] << 16 b2 = arr[1] << 8 b3 = arr[2] b = b1 | b2 | b3 parseFloat(a, 10) + parseFloat(b / Math.pow(2, 24), 10) </pre></div></td></tr></tbody></table><div id="generated">generated Tue May 12 2015 11:08:10 GMT-0400 (EDT) </div></div></body></html>