psd 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87dd8d12bd49feb7ad2502047fa2ec73d4aff7b1
-  data.tar.gz: 5647eca77e19f0a4ebb3ac59448d8b26d0f56da8
+  metadata.gz: ef242e267a313a38f9ef7cebab141f870c85555e
+  data.tar.gz: ee3814e3f35306f61b9b26d6124ef021ec22cc00
 SHA512:
-  metadata.gz: d82f2fde33a13a60863548bc75788ffd279651e1c66a553749d794080733463e4f78cf13cfbcbf58a4d6296579f678cc3e32a0e6419c83ef7273e1b41d1406c5
-  data.tar.gz: 23a3d1ba099ed12c363958af463393e56702e2ac2a02ba67a9af247016fbe2f384f893f5ea5dad4bdb651cb76196f9a77d42efe69cf7ced445ea6177e4ffbffe
+  metadata.gz: d7260fadf4dc3a2e99126427a85ce355832a897a058d681e7afe708116c427cf76210f766fcc7641b5c43e889c9c295f8a38c269af16d6ffc96ce861ac21565b
+  data.tar.gz: e97f791180a8452ed959fd72c831929d95d0666f7178d8f4d7dcf92bf229c6004e761782b251a8d3958e324d3a0de139be746db609d21921dd81947f27c37ae2

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  # - rbx-19mode

data/README.md

@@ -202,7 +202,7 @@ psd.image.save_as_png 'path/to/output.png' # writes PNG to disk
 If you run into any problems parsing a PSD, you can enable debug logging via the `PSD_DEBUG` environment variable. For example:
 
 ``` bash
-PSD_DEBUG=STDOUT bundle exec examples/parse.rb
+PSD_DEBUG=true bundle exec examples/parse.rb
 ```
 
 You can also give a path to a file instead. If you need to enable debugging programatically:
@@ -232,3 +232,4 @@ There are a few features that are currently missing from PSD.rb.
 * More image modes + depths for image exporting
 * A few layer info blocks
 * Support for rendering all layer styles
+* Render engine fixes for groups with lowered opacity

data/lib/psd.rb

@@ -1,13 +1,14 @@
 require "bindata"
 require "psd/enginedata"
+require "chunky_png"
 
 require_relative 'psd/section'
 
 dir_root = File.dirname(File.absolute_path(__FILE__)) + '/psd'
 [
+  '/image_exports/*',
   '/image_formats/*',
   '/image_modes/*',
-  '/image_exports/*',
   '/nodes/*',
   '/layer_info/*',
   '/layer/*',

data/lib/psd/blend_mode.rb

@@ -36,7 +36,11 @@ class PSD
       lLit: 'linear light',
       pLit: 'pin light',
       hMix: 'hard mix',
-      pass: 'passthru'
+      pass: 'passthru',
+      dkCl: 'darker color',
+      lgCl: 'lighter color',
+      fsub: 'subtract',
+      fdiv: 'divide'
     }
 
     # Get the readable name for this blend mode.

data/lib/psd/channel_image.rb

@@ -55,6 +55,8 @@ class PSD
           @height = @layer.height
         end
 
+        @length = @width * @height
+
         start = @file.tell
 
         PSD.logger.debug "Channel ##{ch_info[:id]}, length = #{ch_info[:length]}"
@@ -68,13 +70,13 @@ class PSD
         end
       end
 
-      @width = @layer.width
-      @height = @layer.height
-
-      if @channel_data.length != @length
+      if @channel_data.length != (@length * @channels_info.length)
         PSD.logger.error "#{@channel_data.length} read; expected #{@length}"
       end
 
+      @width = @layer.width
+      @height = @layer.height
+
       parse_user_mask
       process_image_data
     end

data/lib/psd/header.rb

@@ -57,5 +57,13 @@ class PSD
     def height
       rows
     end
+
+    def rgb?
+      mode == 3
+    end
+
+    def cmyk?
+      mode == 4
+    end
   end
 end

data/lib/psd/helpers.rb

@@ -32,8 +32,20 @@ class PSD
       @root ||= PSD::Node::Root.new(self)
     end
 
+    def resource(id)
+      @resources[id].nil? ? nil : @resources[id].data
+    end
+
     def layer_comps
-      @resources[:layer_comps].data.to_a
+      resource(:layer_comps).to_a
+    end
+
+    def guides
+      resource(:guides).to_a
+    end
+
+    def slices
+      resource(:slices).to_a
     end
   end
 end

data/lib/psd/image.rb

@@ -17,7 +17,7 @@ class PSD
       'RLE',
       'ZIP',
       'ZIPPrediction'
-    ]
+    ].freeze
 
     # Store a reference to the file and the header. We also do a few simple calculations
     # to figure out the number of pixels in the image and the length of each channel.

data/lib/psd/image_exports/png.rb

@@ -1,5 +1,3 @@
-require RUBY_ENGINE =~ /jruby/ ? 'chunky_png' : 'oily_png'
-
 class PSD::Image
   module Export
     # PNG image export. This is the default export format.
@@ -15,7 +13,7 @@ class PSD::Image
         i = 0
         height.times do |y|
           width.times do |x|
-            @png[x,y] = @pixel_data[i]
+            @png[x, y] = @pixel_data[i]
             i += 1
           end
         end
@@ -24,76 +22,10 @@ class PSD::Image
       end
       alias :export :to_png
 
-      def to_png_with_mask
-        return to_png unless has_mask?
-        return @png_with_mask if @png_with_mask
-
-        PSD.logger.debug "Beginning PNG export with mask"
-
-        # We generate the preview at the document size instead to make applying the mask
-        # significantly easier.
-        width = @layer.header.width.to_i
-        height = @layer.header.height.to_i
-        @png_with_mask = ChunkyPNG::Canvas.new(width, height, ChunkyPNG::Color::TRANSPARENT)
-
-        i = 0
-        @layer.height.times do |y|
-          @layer.width.times do |x|
-            offset_x = x + @layer.left
-            offset_y = y + @layer.top
-
-            i +=1 and next if offset_x < 0 || offset_y < 0 || offset_x >= @png_with_mask.width || offset_y >= @png_with_mask.height
-
-            @png_with_mask[offset_x, offset_y] = @pixel_data[i]
-            i += 1
-          end
-        end
-
-        # Now we apply the mask
-        i = 0
-        @layer.mask.height.times do |y|
-          @layer.mask.width.times do |x|
-            offset_x = @layer.mask.left + x
-            offset_y = @layer.mask.top + y
-
-            i += 1 and next if offset_x < 0 || offset_y < 0 || offset_x >= @png_with_mask.width || offset_y >= @png_with_mask.height
-
-            color = ChunkyPNG::Color.to_truecolor_alpha_bytes(@png_with_mask[offset_x, offset_y])
-            color[3] = color[3] * @mask_data[i] / 255
-
-            @png_with_mask[offset_x, offset_y] = ChunkyPNG::Color.rgba(*color)
-            i += 1
-          end
-        end
-
-        crop_left = PSD::Util.clamp(@layer.left, 0, @png_with_mask.width)
-        crop_top = PSD::Util.clamp(@layer.top, 0, @png_with_mask.height)
-        crop_width = PSD::Util.clamp(@layer.width.to_i, 0, @png_with_mask.width - crop_left)
-        crop_height = PSD::Util.clamp(@layer.height.to_i, 0, @png_with_mask.height - crop_top)
-
-        @png_with_mask.crop!(crop_left, crop_top, crop_width, crop_height)
-      end
-
-      def mask_to_png
-        return unless has_mask?
-
-        png = ChunkyPNG::Canvas.new(@layer.mask.width.to_i, @layer.mask.height.to_i, ChunkyPNG::Color::TRANSPARENT)
-
-        i = 0
-        @layer.mask.height.times do |y|
-          @layer.mask.width.times do |x|
-            png[x, y] = ChunkyPNG::Color.grayscale(@mask_data[i])
-            i += 1
-          end
-        end
-
-        png
-      end
-
       # Saves the PNG data to disk.
       def save_as_png(file)
         to_png.save(file, :fast_rgba)
       end
     end
   end
-end
+end

data/lib/psd/image_formats/layer_raw.rb

@@ -7,7 +7,7 @@ class PSD
       # of the RAW encoding parser a bit. This version is aware of the current
       # channel data position, since layers that have RAW encoding often use RLE
       # encoded alpha channels.
-      def parse_raw!(length = @length)
+      def parse_raw!
         PSD.logger.debug "Attempting to parse RAW encoded channel..."
 
         (@chan_pos...(@chan_pos + @ch_info[:length] - 2)).each do |i|

data/lib/psd/image_formats/raw.rb

@@ -4,10 +4,8 @@ class PSD
     module RAW
       private
 
-      def parse_raw!(length = @length)
-        length.times do |i|
-          @channel_data[i] = @file.read(1).bytes.to_a[0]
-        end
+      def parse_raw!
+        @channel_data = @file.read(@length).bytes.to_a
       end
     end
   end

data/lib/psd/image_modes/cmyk.rb

@@ -5,14 +5,24 @@ class PSD
 
       def combine_cmyk_channel
         (0...@num_pixels).step(pixel_step) do |i|
-          c = @channel_data[i]
-          m = @channel_data[i + @channel_length]
-          y = @channel_data[i + @channel_length * 2]
-          k = @channel_data[i + @channel_length * 3]
-          a = (channels == 5 ? @channel_data[i + @channel_length * 4] : 255)
+          c = m = y = k = 0
+          a = 255
 
-          rgb = PSD::Color.cmyk_to_rgb(255 - c, 255 - m, 255 - y, 255 - k)
+          @channels_info.each_with_index do |chan, index|
+            next if chan[:id] == -2
+
+            val = @channel_data[i + (@channel_length * index)]
 
+            case chan[:id]
+            when -1 then a = val
+            when 0 then c = val
+            when 1 then m = val
+            when 2 then y = val
+            when 3 then k = val
+            end
+          end
+
+          rgb = PSD::Color.cmyk_to_rgb(255 - c, 255 - m, 255 - y, 255 - k)
           @pixel_data.push ChunkyPNG::Color.rgba(*rgb.values, a)
         end
       end

data/lib/psd/layer/helpers.rb

@@ -70,7 +70,7 @@ class PSD
 
       def fill_opacity
         return 255 unless info.has_key?(:fill_opacity)
-        info[:fill_opacity].enabled
+        info[:fill_opacity].value
       end
     end
   end

data/lib/psd/layer_info/fill_opacity.rb

@@ -4,10 +4,10 @@ class PSD
   class FillOpacity < LayerInfo
     @key = 'iOpa'
 
-    attr_reader :enabled
+    attr_reader :value
 
     def parse
-      @enabled = @file.read_boolean
+      @value = @file.read_byte.to_i
     end
   end
 end

data/lib/psd/logger.rb

@@ -7,7 +7,13 @@ class PSD
     end
 
     module ClassMethods
-      attr_accessor :debug
+      attr_reader :debug
+      attr_writer :logger
+
+      def debug=(enabled)
+        @debug = enabled
+        @logger = nil
+      end
 
       def logger
         return @logger if @logger

data/lib/psd/node.rb

@@ -21,7 +21,7 @@ class PSD
         @children << layer
       end
 
-      @force_visible = false
+      @force_visible = nil
     end
 
     def hidden?
@@ -29,7 +29,7 @@ class PSD
     end
 
     def visible?
-      force_visible || @layer.visible?
+      force_visible.nil? ? @layer.visible? : force_visible
     end
 
     def psd
@@ -44,6 +44,10 @@ class PSD
       is_a?(PSD::Node::Group) || is_a?(PSD::Node::Root)
     end
 
+    def debug_name
+      root? ? ":root:" : name
+    end
+
     def to_hash
       hash = {
         type: nil,

data/lib/psd/node_group.rb

@@ -46,8 +46,16 @@ class PSD::Node
       @children.each{ |c| c.show! }
     end
 
+    def passthru_blending?
+      blending_mode == 'passthru'
+    end
+
     def empty?
-      @children.empty?
+      @children.each do |child|
+        return false unless child.empty?
+      end
+      
+      return true
     end
 
     # Export this layer and it's children to a hash recursively.

data/lib/psd/node_root.rb

@@ -7,6 +7,7 @@ class PSD::Node
     include PSD::Node::ParseLayers
 
     attr_accessor :children
+    attr_reader :psd
 
     # Stores a reference to the parsed PSD and builds the
     # tree hierarchy.
@@ -21,25 +22,32 @@ class PSD::Node
         children: children.map(&:to_hash),
         document: {
           width: document_width,
-          height: document_height
+          height: document_height,
+          resources: {
+            layer_comps: @psd.layer_comps,
+            guides: @psd.guides,
+            slices: @psd.slices
+          }
         }
       }
     end
 
     # Returns the width and height of the entire PSD document.
     def document_dimensions
-      [@psd.header.width, @psd.header.height]
+      [document_width, document_height]
     end
 
     # The width of the full PSD document as defined in the header.
     def document_width
       @psd.header.width.to_i
     end
+    alias_method :width, :document_width
 
     # The height of the full PSD document as defined in the header.
     def document_height
       @psd.header.height.to_i
     end
+    alias_method :height, :document_height
 
     # The root node has no name since it's not an actual layer or group.
     def name
@@ -51,7 +59,12 @@ class PSD::Node
       0
     end
 
-    def psd; @psd; end
+    [:top, :right, :bottom, :left].each do |meth|
+      define_method(meth) { 0 }
+    end
+
+    def opacity; 255; end
+    def fill_opacity; 255; end
 
     private
 

data/lib/psd/nodes/build_preview.rb

@@ -1,78 +1,16 @@
-class PSD
+ class PSD
   class Node
     module BuildPreview
-      include PSD::Image::Export::PNG
-
-      alias :orig_to_png :to_png
-      def to_png
-        return build_png if group?
-        layer.image.to_png_with_mask
-      end
-
-      def build_png(png=nil)
-        png ||= create_canvas
-
-        children.reverse.each do |c|
-          next unless c.visible?
-
-          if c.group?
-            if c.blending_mode == 'passthru'
-              c.build_png(png)
-            else
-              compose! c, png, c.build_png, 0, 0
-            end
-          else
-            compose!(
-              c,
-              png,
-              c.image.to_png_with_mask,
-              PSD::Util.clamp(c.left.to_i, 0, png.width),
-              PSD::Util.clamp(c.top.to_i, 0, png.height)
-            )
-          end
-        end
-
-        png
-      end
-
-      private
-
-      def create_canvas
-        width, height = document_dimensions
-        ChunkyPNG::Canvas.new(width.to_i, height.to_i, ChunkyPNG::Color::TRANSPARENT)
+      def renderer
+        PSD::Renderer.new(self)
       end
 
-      # Modified from ChunkyPNG::Canvas#compose! in order to support various blend modes.
-      def compose!(layer, base, other, offset_x, offset_y)
-        blending_mode = layer.blending_mode.gsub(/ /, '_')
-        PSD.logger.warn("Blend mode #{blending_mode} is not implemented") unless Compose.respond_to?(blending_mode)
-        PSD.logger.debug("Blending #{layer.name} with #{blending_mode} blend mode")
-
-        other = ClippingMask.new(layer, other).apply
-        LayerStyles.new(layer, other).apply!
-
-        blend_pixels!(blending_mode, layer, base, other, offset_x, offset_y)
+      def to_png
+        renderer.to_png
       end
 
-      def blend_pixels!(blending_mode, layer, base, other, offset_x, offset_y)
-        other.height.times do |y|
-          other.width.times do |x|
-            base_x = x + offset_x
-            base_y = y + offset_y
-
-            next if base_x < 0 || base_y < 0 || base_x >= base.width || base_y >= base.height
-
-            color = Compose.send(
-              blending_mode,
-              other[x, y],
-              base[base_x, base_y],
-              opacity: layer.opacity,
-              fill_opacity: layer.fill_opacity
-            )
-
-            base[base_x, base_y] = color
-          end
-        end
+      def save_as_png(output)
+        to_png.save(output)
       end
     end
   end