aboutsummaryrefslogtreecommitdiffstats
path: root/docs/psdlayermask.html
blob: 82162c818230844bab35ae56700282d73bc09cb7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<!DOCTYPE html>  <html> <head>   <title>psdlayermask.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 &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="blackwhite.html">                 blackwhite.coffee               </a>                                           <a class="source" href="brightnesscontrast.html">                 brightnesscontrast.coffee               </a>                                           <a class="source" href="colorbalance.html">                 colorbalance.coffee               </a>                                           <a class="source" href="curves.html">                 curves.coffee               </a>                                           <a class="source" href="exposure.html">                 exposure.coffee               </a>                                           <a class="source" href="gradient.html">                 gradient.coffee               </a>                                           <a class="source" href="huesaturation.html">                 huesaturation.coffee               </a>                                           <a class="source" href="invert.html">                 invert.coffee               </a>                                           <a class="source" href="layereffect.html">                 layereffect.coffee               </a>                                           <a class="source" href="levels.html">                 levels.coffee               </a>                                           <a class="source" href="pattern.html">                 pattern.coffee               </a>                                           <a class="source" href="photofilter.html">                 photofilter.coffee               </a>                                           <a class="source" href="posterize.html">                 posterize.coffee               </a>                                           <a class="source" href="selectivecolor.html">                 selectivecolor.coffee               </a>                                           <a class="source" href="solidcolor.html">                 solidcolor.coffee               </a>                                           <a class="source" href="threshold.html">                 threshold.coffee               </a>                                           <a class="source" href="typetool.html">                 typetool.coffee               </a>                                           <a class="source" href="vibrance.html">                 vibrance.coffee               </a>                                           <a class="source" href="log.html">                 log.coffee               </a>                                           <a class="source" href="psd.html">                 psd.coffee               </a>                                           <a class="source" href="psdassert.html">                 psdassert.coffee               </a>                                           <a class="source" href="psdchannelimage.html">                 psdchannelimage.coffee               </a>                                           <a class="source" href="psdcolor.html">                 psdcolor.coffee               </a>                                           <a class="source" href="psddescriptor.html">                 psddescriptor.coffee               </a>                                           <a class="source" href="psdfile.html">                 psdfile.coffee               </a>                                           <a class="source" href="psdheader.html">                 psdheader.coffee               </a>                                           <a class="source" href="psdimage.html">                 psdimage.coffee               </a>                                           <a class="source" href="psdlayer.html">                 psdlayer.coffee               </a>                                           <a class="source" href="psdlayermask.html">                 psdlayermask.coffee               </a>                                           <a class="source" href="psdresource.html">                 psdresource.coffee               </a>                                           <a class="source" href="util.html">                 util.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               psdlayermask.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>                            </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nx">PSDLayerMask</span>
  <span class="nv">constructor: </span><span class="nf">(@file, @header, @options) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Array to hold all of the layers</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@layers = </span><span class="p">[]</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>Does the first alpha channel contain the transparency data?</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@mergedAlpha = </span><span class="kc">false</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>The global layer mask</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@globalMask = </span><span class="p">{}</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>Additional layer information</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@extras = </span><span class="p">[]</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Skip over this section and don't parse it</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">skip: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>

  <span class="nv">parse: </span><span class="o">-&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Read the size of the entire layers and masks section</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">maskSize = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nv">endLoc = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">tell</span><span class="p">()</span> <span class="o">+</span> <span class="nx">maskSize</span>

    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Layer mask size is #{maskSize}&quot;</span></pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>If the mask size is > 0, then parse the section. Otherwise,
this section doesn't exist and the whole layers/masks data
is 4 bytes (the length we've already read)</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="k">return</span> <span class="k">if</span> <span class="nx">maskSize</span> <span class="o">&lt;=</span> <span class="mi">0</span>
    </pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <p>Size of the layer info section. 4 bytes, rounded up by 2's.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">layerInfoSize = </span><span class="nx">Util</span><span class="p">.</span><span class="nx">pad2</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <p>Store the current position in case we need to bail
and skip over this section.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">pos = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">tell</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <p>If the layer info size is > 0, then we have some layers</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="k">if</span> <span class="nx">layerInfoSize</span> <span class="o">&gt;</span> <span class="mi">0</span></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <p>Read the number of layers, 2 bytes.</p>             </td>             <td class="code">               <div class="highlight"><pre>      <span class="vi">@numLayers = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <p>If the number of layers is negative, the absolute value is
the actual number of layers, and the first alpha channel contains
the transparency data for the merged image.</p>             </td>             <td class="code">               <div class="highlight"><pre>      <span class="k">if</span> <span class="nx">@numLayers</span> <span class="o">&lt;</span> <span class="mi">0</span>
        <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Note: first alpha channel contains transparency data&quot;</span>
        <span class="vi">@numLayers = </span><span class="nb">Math</span><span class="p">.</span><span class="nx">abs</span> <span class="nx">@numLayers</span>
        <span class="vi">@mergedAlpha = </span><span class="kc">true</span>

      <span class="k">if</span> <span class="nx">@numLayers</span> <span class="o">*</span> <span class="p">(</span><span class="mi">18</span> <span class="o">+</span> <span class="mi">6</span> <span class="o">*</span> <span class="nx">@header</span><span class="p">.</span><span class="nx">channels</span><span class="p">)</span> <span class="o">&gt;</span> <span class="nx">layerInfoSize</span>
        <span class="k">throw</span> <span class="s2">&quot;Unlikely number of #{@numLayers} layers for #{@header[&#39;channels&#39;]} with #{layerInfoSize} layer info size. Giving up.&quot;</span>

      <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Found #{@numLayers} layer(s)&quot;</span>

      <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">@numLayers</span><span class="p">]</span>
        <span class="nv">layer = </span><span class="k">new</span> <span class="nx">PSDLayer</span> <span class="nx">@file</span>
        <span class="nx">layer</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">i</span><span class="p">)</span>
        <span class="nx">@layers</span><span class="p">.</span><span class="nx">push</span> <span class="nx">layer</span>

      <span class="k">for</span> <span class="nx">layer</span> <span class="k">in</span> <span class="nx">@layers</span>
        <span class="k">if</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">isFolder</span> <span class="o">or</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">isHidden</span></pre></div>             </td>           </tr>                               <tr id="section-14">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-14">&#182;</a>               </div>               <p>Layer contains no image data. Skip ahead.</p>             </td>             <td class="code">               <div class="highlight"><pre>          <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="mi">8</span>
          <span class="k">continue</span>

        <span class="nv">layer.image = </span><span class="k">new</span> <span class="nx">PSDChannelImage</span><span class="p">(</span><span class="nx">@file</span><span class="p">,</span> <span class="nx">@header</span><span class="p">,</span> <span class="nx">layer</span><span class="p">)</span>

        <span class="k">if</span> <span class="nx">@options</span><span class="p">.</span><span class="nx">layerImages</span> <span class="o">and</span> <span class="p">(</span>
          <span class="p">(</span><span class="nx">@options</span><span class="p">.</span><span class="nx">onlyVisibleLayers</span> <span class="o">and</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">visible</span><span class="p">)</span> <span class="o">or</span>
          <span class="o">!</span><span class="nx">@options</span><span class="p">.</span><span class="nx">onlyVisibleLayers</span>
          <span class="p">)</span>
          <span class="nx">layer</span><span class="p">.</span><span class="nx">image</span><span class="p">.</span><span class="nx">parse</span><span class="p">()</span>
        <span class="k">else</span>
          <span class="nx">layer</span><span class="p">.</span><span class="nx">image</span><span class="p">.</span><span class="nx">skip</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-15">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-15">&#182;</a>               </div>               <p>Layers are parsed in reverse order</p>             </td>             <td class="code">               <div class="highlight"><pre>      <span class="nx">@layers</span><span class="p">.</span><span class="nx">reverse</span><span class="p">()</span>
      <span class="nx">@groupLayers</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-16">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-16">&#182;</a>               </div>               <p>In case there are filler zeros</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">pos</span> <span class="o">+</span> <span class="nx">layerInfoSize</span><span class="p">,</span> <span class="kc">false</span></pre></div>             </td>           </tr>                               <tr id="section-17">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-17">&#182;</a>               </div>               <p>Parse the global layer mask</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@parseGlobalMask</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-18">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-18">&#182;</a>               </div>               <p>Temporarily skip the rest of layers &amp; masks section</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">endLoc</span><span class="p">,</span> <span class="kc">false</span>
    <span class="k">return</span></pre></div>             </td>           </tr>                               <tr id="section-19">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-19">&#182;</a>               </div>               <p>We have more additional info to parse, especially beacuse this is PS >= 4.0
@parseExtraInfo(endLoc) if @file.tell() &lt; endLoc</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseGlobalMask: </span><span class="o">-&gt;</span>
    <span class="nv">length = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="k">return</span> <span class="k">if</span> <span class="nx">length</span> <span class="o">is</span> <span class="mi">0</span>

    <span class="nv">start = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">tell</span><span class="p">()</span>
    <span class="nv">end = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">tell</span><span class="p">()</span> <span class="o">+</span> <span class="nx">length</span>

    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Global mask length: #{length}&quot;</span></pre></div>             </td>           </tr>                               <tr id="section-20">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-20">&#182;</a>               </div>               <p>Undocumented</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@globalMask.overlayColorSpace = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-21">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-21">&#182;</a>               </div>               <p>TODO: parse color space components into actual color.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@globalMask.colorComponents = </span><span class="p">[]</span>
    <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="mi">4</span><span class="p">]</span>
      <span class="nx">@globalMask</span><span class="p">.</span><span class="nx">colorComponents</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span> <span class="o">&gt;&gt;</span> <span class="mi">8</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-22">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-22">&#182;</a>               </div>               <p>0 = transparent, 100 = opaque</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@globalMask.opacity = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-23">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-23">&#182;</a>               </div>               <p>0 = color selected; 1 = color protected; 128 = use value per layer</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@globalMask.kind = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>

    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Global mask:&quot;</span><span class="p">,</span> <span class="nx">@globalMask</span></pre></div>             </td>           </tr>                               <tr id="section-24">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-24">&#182;</a>               </div>               <p>Filler zeros, seek to end.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">end</span><span class="p">,</span> <span class="kc">false</span>

  <span class="nv">parseExtraInfo: </span><span class="nf">(end) -&gt;</span>
    <span class="k">while</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">tell</span><span class="p">()</span> <span class="o">&lt;</span> <span class="nx">end</span></pre></div>             </td>           </tr>                               <tr id="section-25">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-25">&#182;</a>               </div>               <p>Temporary</p>             </td>             <td class="code">               <div class="highlight"><pre>      <span class="p">[</span>
        <span class="nx">sig</span><span class="p">,</span>
        <span class="nx">key</span><span class="p">,</span>
        <span class="nx">length</span>
      <span class="p">]</span> <span class="o">=</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;4s4sI&quot;</span>

      <span class="nv">length = </span><span class="nx">Util</span><span class="p">.</span><span class="nx">pad2</span> <span class="nx">length</span>

      <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Layer extra:&quot;</span><span class="p">,</span> <span class="nx">sig</span><span class="p">,</span> <span class="nx">key</span><span class="p">,</span> <span class="nx">length</span>

      <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">length</span>

  <span class="nv">groupLayers: </span><span class="o">-&gt;</span>
    <span class="nv">groupLayer = </span><span class="kc">null</span>
    <span class="k">for</span> <span class="nx">layer</span> <span class="k">in</span> <span class="nx">@layers</span>
      <span class="k">if</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">isFolder</span>
        <span class="nv">groupLayer = </span><span class="nx">layer</span>
      <span class="k">else</span> <span class="k">if</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">isHidden</span>
        <span class="nv">groupLayer = </span><span class="kc">null</span>
      <span class="k">else</span>
        <span class="nv">layer.groupLayer = </span><span class="nx">groupLayer</span>

  <span class="nv">toJSON: </span><span class="o">-&gt;</span>
    <span class="nv">data =</span>
      <span class="nv">mergedAlpha: </span><span class="nx">@mergedAlpha</span>
      <span class="nv">globalMask: </span><span class="nx">@globalMask</span>
      <span class="nv">extraInfo: </span><span class="nx">@extras</span>
      <span class="nv">numLayers: </span><span class="nx">@numLayers</span>
      <span class="nv">layers: </span><span class="p">[]</span>

    <span class="k">for</span> <span class="nx">layer</span> <span class="k">in</span> <span class="nx">@layers</span>
      <span class="nx">data</span><span class="p">.</span><span class="nx">layers</span><span class="p">.</span><span class="nx">push</span> <span class="nx">layer</span><span class="p">.</span><span class="nx">toJSON</span><span class="p">()</span>

    <span class="nx">data</span>

</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>