psd 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e806c5a8d10b43d7bddb5bf2e0e9ca3843a579f
-  data.tar.gz: 5560fc10135e67e5d396a367c5ae737cf0f84c51
+  metadata.gz: 93b149110f6660cd6b6231f8e8e1bcf440ffac4c
+  data.tar.gz: 7762bab9c1c6504a5fd39f54602acd27e30746ee
 SHA512:
-  metadata.gz: bcac2c4003765bc89eaba409c48b860bcc6d49ec377953332dcfccbb58baecc9b7531d285a95cfeaff14c1f8102b5b8bfab341ae915b4270f67760d271abf186
-  data.tar.gz: c8656fe0d3ccb52301f09e40856a0f90d1ad7ebeba4ba2793a0cc3edef958fd57daa9e16a69034abf1ae416420126bd1e9e456da5ba69b7edc28d0483755c3cb
+  metadata.gz: d198525b3c71df4b3c4d869a3d56752f709bde1ccda35f25c22b4da0d68775bbe7ed09adfdb013fce65600953a4a421eb618430a613017c16c93aa404887ff19
+  data.tar.gz: 90ba4242c94d7cb725ed2180188cee87ba2230a2cc45bd77ed33bf6e2e7046561efabd6c9293847343e55fa13d7efba9e4b7491e004c100a3c8c32ab304ee51f

data/lib/psd.rb

@@ -28,7 +28,8 @@ class PSD
     parse_layer_images: false
   }
 
-  attr_reader :file
+  attr_reader :file, :opts
+  alias :options :opts
 
   # Opens the named file, parses it, and makes it available for reading. Then, closes it after you're finished.
   # @param filename [String]  the name of the file to open
@@ -112,7 +113,7 @@ class PSD
     ensure_header
     ensure_resources
 
-    @layer_mask ||= LayerMask.new(@file, @header).parse
+    @layer_mask ||= LayerMask.new(@file, @header, @opts).parse
   end
 
   # Get the full size flattened preview Image.
@@ -164,7 +165,7 @@ class PSD
   def ensure_layer_mask
     return unless @layer_mask.nil?
 
-    @layer_mask = LayerMask.new(@file, @header)
+    @layer_mask = LayerMask.new(@file, @header, @opts)
     @layer_mask.skip
   end
 end

data/lib/psd/channel_image.rb

@@ -4,6 +4,85 @@ class PSD
   # Represents an image for a single layer, which differs slightly in format from
   # the full size preview image.
   class ChannelImage < Image
+    include ImageFormat::LayerRLE
+    include ImageFormat::LayerRAW
 
+    attr_reader :width, :height
+
+    def initialize(file, header, layer)
+      @layer = layer
+
+      @width = @layer.width
+      @height = @layer.height
+
+      super(file, header)
+
+      @channels_info = @layer.channels_info
+    end
+
+    def skip
+      PSD.logger.debug "Skipping channel image data. Layer = #{@layer.name}"
+      @channels_info.each do |ch|
+        @file.seek ch.length, IO::SEEK_CUR
+      end
+    end
+
+    def channels
+      @layer.channels
+    end
+
+    def parse
+      PSD.logger.debug "Layer = #{@layer.name}, Size = #{width}x#{height}"
+
+      @chan_pos = 0
+
+      @channels_info.each do |ch_info|
+        @ch_info = ch_info
+        if ch_info[:length] <= 0
+          parse_compression! and next
+        end
+
+        # If the ID of this current channel is -2, then we assume the dimensions
+        # of the layer mask.
+        if ch_info[:id] == -2
+          @width = @layer.mask.width
+          @height = @layer.mask.height
+        else
+          @width = @layer.width
+          @height = @layer.height
+        end
+
+        start = @file.tell
+
+        PSD.logger.debug "Channel ##{ch_info[:id]}, length = #{ch_info[:length]}"
+        parse_image_data!
+
+        finish = @file.tell
+
+        if finish != start + ch_info[:length]
+          PSD.logger.error "Read incorrect number of bytes for channel ##{ch_info[:id]}. Expected = #{ch_info[:length]}, Actual = #{finish - start}"
+          @file.seek start + @ch_info[:length]
+        end
+      end
+
+      if @channel_data.length != @length
+        PSD.logger.error "#{channel_data.length} read; expected #{@length}"
+      end
+
+      process_image_data
+    end
+
+    def parse_image_data!
+      @compression = parse_compression!
+
+      case @compression
+      when 0 then parse_raw!
+      when 1 then parse_rle!
+      when 2, 3 then parse_zip!
+      else
+        PSD.logger.error "Unknown image compression. Attempting to skip."
+        @file.seek(@end_pos)
+      end
+    end
   end
 end

data/lib/psd/image.rb

@@ -1,11 +1,11 @@
 class PSD
   # Parses the full preview image at the end of the PSD document.
   class Image
-    include Format::RAW
-    include Format::RLE
-    include Mode::CMYK
-    include Mode::Greyscale
-    include Mode::RGB
+    include ImageFormat::RAW
+    include ImageFormat::RLE
+    include ImageMode::CMYK
+    include ImageMode::Greyscale
+    include ImageMode::RGB
     include Export::PNG
 
     # All of the possible compression formats Photoshop uses.
@@ -16,14 +16,6 @@ class PSD
       'ZIPPrediction'
     ]
 
-    # Each color channel is represented by a unique ID
-    CHANNEL_INFO = [
-      {id: 0},
-      {id: 1},
-      {id: 2},
-      {id: -1}
-    ]
-
     # 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.
     def initialize(file, header)
@@ -42,6 +34,14 @@ class PSD
       @pixel_data = []
 
       PSD.logger.debug "Image: #{width}x#{height}, length = #{@length}, mode = #{@header.mode_name}, position = #{@start_pos}"
+
+      # Each color channel is represented by a unique ID
+      @channels_info = [
+        {id: 0},
+        {id: 1},
+        {id: 2},
+        {id: -1}
+      ]
     end
 
     # Begins parsing the image by first figuring out the compression format used, and then

data/lib/psd/image_exports/png.rb

@@ -7,24 +7,26 @@ class PSD::Image
       # Load the image pixels into a PNG file and return a reference to the
       # data.
       def to_png
-        PSD.logger.debug "Beginning PNG export"
-        png = ChunkyPNG::Image.new(width.to_i, height.to_i, ChunkyPNG::Color::TRANSPARENT)
+        @png ||= (
+          PSD.logger.debug "Beginning PNG export"
+          png = ChunkyPNG::Image.new(width.to_i, height.to_i, ChunkyPNG::Color::TRANSPARENT)
 
-        i = 0
-        height.times do |y|
-          width.times do |x|
-            png[x,y] = ChunkyPNG::Color.rgba(
-              @pixel_data[i],
-              @pixel_data[i+1],
-              @pixel_data[i+2],
-              @pixel_data[i+3]
-            )
+          i = 0
+          height.times do |y|
+            width.times do |x|
+              png[x,y] = ChunkyPNG::Color.rgba(
+                @pixel_data[i],
+                @pixel_data[i+1],
+                @pixel_data[i+2],
+                @pixel_data[i+3]
+              )
 
-            i += 4
+              i += 4
+            end
           end
-        end
 
-        png
+          png
+        )
       end
       alias :export :to_png
 

data/lib/psd/image_formats/layer_raw.rb

@@ -0,0 +1,21 @@
+class PSD
+  module ImageFormat
+    module LayerRAW
+      private
+
+      # Since we're parsing on a per-channel basis, we need to modify the behavior
+      # 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)
+        PSD.logger.debug "Attempting to parse RAW encoded channel..."
+
+        (@chan_pos...(@chan_pos + @ch_info[:length] - 2)).each do |i|
+          @channel_data[i] = @file.read(1).bytes.to_a[0]
+        end
+
+        @chan_pos += @ch_info[:length] - 2
+      end
+    end
+  end
+end

data/lib/psd/image_formats/layer_rle.rb

@@ -0,0 +1,22 @@
+class PSD
+  module ImageFormat
+    # Some method overrides for layer images.
+    module LayerRLE
+      private
+
+      def parse_byte_counts!
+        byte_counts = []
+        height.times do
+          byte_counts << @file.read_short
+        end
+
+        return byte_counts
+      end
+
+      def parse_channel_data!
+        PSD.logger.debug "Parsing layer RLE channel ##{@ch_info[:id]}: position = #{@chan_pos}"
+        @chan_pos = decode_rle_channel(@chan_pos, 0)
+      end
+    end
+  end
+end

data/lib/psd/image_formats/raw.rb

@@ -1,12 +1,12 @@
-class PSD::Image
-  module Format
+class PSD
+  module ImageFormat
     # Parses a RAW uncompressed image
     module RAW
       private
 
       def parse_raw!(length = @length)
         @length.times do |i|
-          @channel_data[i] = @file.read(1).unpack('C')[0]
+          @channel_data[i] = @file.read(1).bytes.to_a[0]
         end
       end
     end

data/lib/psd/image_formats/rle.rb

@@ -1,5 +1,5 @@
-class PSD::Image
-  module Format
+class PSD
+  module ImageFormat
     # Parses an RLE compressed image
     module RLE
       private

data/lib/psd/image_modes/cmyk.rb

@@ -1,26 +1,28 @@
-class PSD::Image::Mode
-  module CMYK
-    private
+class PSD
+  module ImageMode
+    module CMYK
+      private
 
-    def combine_cmyk_channel
-      (0...@num_pixels).step(pixel_step) do |i|
-        if channels == 5
-          a = @channel_data[i]
-          c = @channel_data[i + @channel_length]
-          m = @channel_data[i + @channel_length * 2]
-          y = @channel_data[i + @channel_length * 3]
-          k = @channel_data[i + @channel_length * 4]
-        else
-          a = 255
-          c = @channel_data[i]
-          m = @channel_data[i + @channel_length]
-          y = @channel_data[i + @channel_length * 2]
-          k = @channel_data[i + @channel_length * 3]
-        end
+      def combine_cmyk_channel
+        (0...@num_pixels).step(pixel_step) do |i|
+          if channels == 5
+            a = @channel_data[i]
+            c = @channel_data[i + @channel_length]
+            m = @channel_data[i + @channel_length * 2]
+            y = @channel_data[i + @channel_length * 3]
+            k = @channel_data[i + @channel_length * 4]
+          else
+            a = 255
+            c = @channel_data[i]
+            m = @channel_data[i + @channel_length]
+            y = @channel_data[i + @channel_length * 2]
+            k = @channel_data[i + @channel_length * 3]
+          end
 
-        rgb = PSD::Color.cmyk_to_rgb(255 - c, 255 - m, 255 - y, 255 - k)
+          rgb = PSD::Color.cmyk_to_rgb(255 - c, 255 - m, 255 - y, 255 - k)
 
-        @pixel_data.push *rgb.values, a
+          @pixel_data.push *rgb.values, a
+        end
       end
     end
   end

data/lib/psd/image_modes/greyscale.rb

@@ -1,18 +1,20 @@
-class PSD::Image::Mode
-  module Greyscale
-    private
+class PSD
+  module ImageMode
+    module Greyscale
+      private
 
-    def combine_greyscale_channel
-      if channels == 2
-        (0...@num_pixels).step(pixel_step) do |i|
-          alpha = @channel_data[i]
-          grey = @channel_data[@channel_length + i]
+      def combine_greyscale_channel
+        if channels == 2
+          (0...@num_pixels).step(pixel_step) do |i|
+            alpha = @channel_data[i]
+            grey = @channel_data[@channel_length + i]
 
-          @pixel_data.push grey, grey, grey, alpha
-        end
-      else
-        (0...@num_pixels).step(pixel_step) do |i|
-          @pixel_data.push *([@channel_data[i]] * 3), 255
+            @pixel_data.push grey, grey, grey, alpha
+          end
+        else
+          (0...@num_pixels).step(pixel_step) do |i|
+            @pixel_data.push *([@channel_data[i]] * 3), 255
+          end
         end
       end
     end

data/lib/psd/image_modes/rgb.rb

@@ -1,28 +1,30 @@
-class PSD::Image::Mode
-  # Combines the channel data from the image into RGB pixel values
-  module RGB
-    private
+class PSD
+  module ImageMode
+    # Combines the channel data from the image into RGB pixel values
+    module RGB
+      private
 
-    def combine_rgb_channel
-      PSD.logger.debug "Beginning RGB processing"
+      def combine_rgb_channel
+        PSD.logger.debug "Beginning RGB processing"
 
-      (0...@num_pixels).step(pixel_step) do |i|
-        r = g = b = 0
-        a = 255
+        (0...@num_pixels).step(pixel_step) do |i|
+          r = g = b = 0
+          a = 255
 
-        PSD::Image::CHANNEL_INFO.each_with_index do |chan, index|
-          next if channels == 3 && chan[:id] == -1
-          val = @channel_data[i + (@channel_length * index)]
+          @channels_info.each_with_index do |chan, index|
+            next if channels == 3 && chan[:id] == -1
+            val = @channel_data[i + (@channel_length * index)]
 
-          case chan[:id]
-          when -1 then  a = val
-          when 0 then   r = val
-          when 1 then   g = val
-          when 2 then   b = val
+            case chan[:id]
+            when -1 then  a = val
+            when 0 then   r = val
+            when 1 then   g = val
+            when 2 then   b = val
+            end
           end
-        end
 
-        @pixel_data.push r, g, b, a
+          @pixel_data.push r, g, b, a
+        end
       end
     end
   end

data/lib/psd/layer.rb

@@ -96,8 +96,9 @@ class PSD
       self.send(val)
     end
 
-    def parse_channel_image!(header) #:nodoc:
-      # @image = ChannelImage.new(@file, header, self)
+    def parse_channel_image!(header, parse)
+      @image = ChannelImage.new(@file, header, self)
+      parse ? @image.parse : @image.skip
     end
 
     # Does this layer represent the start of a folder section?

data/lib/psd/layer_mask.rb

@@ -7,9 +7,10 @@ class PSD
     attr_reader :layers, :global_mask
 
     # Store a reference to the file and the header and initialize the defaults.
-    def initialize(file, header)
+    def initialize(file, header, options)
       @file = file
       @header = header
+      @options = options
 
       @layers = []
       @merged_alpha = false
@@ -55,8 +56,7 @@ class PSD
 
         layers.each do |layer|
           @file.seek 8, IO::SEEK_CUR and next if layer.folder? || layer.folder_end?
-
-          layer.parse_channel_image!(@header)
+          layer.parse_channel_image!(@header, @options[:parse_layer_images])
         end
       end
 

data/lib/psd/node.rb

@@ -29,6 +29,14 @@ class PSD
       @layer.visible?
     end
 
+    def layer?
+      is_a?(PSD::Node::Layer)
+    end
+
+    def group?
+      is_a?(PSD::Node::Group)
+    end
+
     def to_hash
       hash = {
         type: nil,

data/lib/psd/version.rb

@@ -1,3 +1,3 @@
 class PSD
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/image_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe 'Image Exporting' do
+  before(:each) do
+    class PSD::Image 
+      attr_accessor :pixel_data
+    end
+
+    @psd = PSD.new('spec/files/pixel.psd')
+  end
+
+  describe "the full preview image" do
+    it "should successfully parse the image data" do
+      @psd.parse!
+      expect(@psd).to be_parsed
+      expect(@psd.image).to_not be_nil
+      expect(@psd.image.width).to eq(1)
+      expect(@psd.image.height).to eq(1)
+      expect(@psd.image.pixel_data).to eq([0, 100, 200, 255])
+    end
+
+    it "should be able to skip to the image" do
+      expect(@psd).to_not be_parsed
+      expect(@psd.image.width).to eq(1)
+      expect(@psd.image.height).to eq(1)
+      expect(@psd.image.pixel_data).to eq([0, 100, 200, 255])
+    end
+
+    describe "as PNG" do
+      it "should produce a valid PNG object" do
+        expect(@psd.image.to_png).to be_an_instance_of(ChunkyPNG::Image)
+
+        # Ensure it's cached
+        expect(@psd.image.to_png).to be @psd.image.to_png
+        expect(@psd.image.to_png.width).to eq(1)
+        expect(@psd.image.to_png.height).to eq(1)
+        expect(
+          ChunkyPNG::Color.to_truecolor_alpha_bytes(@psd.image.to_png[0,0])
+        ).to eq([0, 100, 200, 255])
+      end
+    end
+  end
+
+  describe "layer images" do
+    it "should successfully parse the image data" do
+      @psd.options[:parse_layer_images] = true
+      @psd.parse!
+
+      image = @psd.tree.children.first.image
+      expect(image).to be_an_instance_of(PSD::ChannelImage)
+      expect(image.width).to eq(1)
+      expect(image.height).to eq(1)
+
+      expect(image.pixel_data).to eq([0, 100, 200, 255])
+    end
+
+    describe "as PNG" do
+      it "should produce a valid PNG object" do
+        @psd.options[:parse_layer_images] = true
+        @psd.parse!
+
+        png = @psd.tree.children.first.image.to_png
+        expect(png).to be_an_instance_of(ChunkyPNG::Image)
+        expect(png.width).to eq(1)
+        expect(png.height).to eq(1)
+        expect(
+          ChunkyPNG::Color.to_truecolor_alpha_bytes(png[0,0])
+        ).to eq([0, 100, 200, 255])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -136,6 +136,8 @@ files:
 - lib/psd/helpers.rb
 - lib/psd/image.rb
 - lib/psd/image_exports/png.rb
+- lib/psd/image_formats/layer_raw.rb
+- lib/psd/image_formats/layer_rle.rb
 - lib/psd/image_formats/raw.rb
 - lib/psd/image_formats/rle.rb
 - lib/psd/image_modes/cmyk.rb
@@ -179,10 +181,12 @@ files:
 - spec/files/example.psd
 - spec/files/one_layer.psd
 - spec/files/path.psd
+- spec/files/pixel.psd
 - spec/files/simplest.psd
 - spec/files/text.psd
 - spec/hierarchy_spec.rb
 - spec/identity_spec.rb
+- spec/image_spec.rb
 - spec/parsing_spec.rb
 - spec/psd_spec.rb
 - spec/spec_helper.rb
@@ -215,10 +219,12 @@ test_files:
 - spec/files/example.psd
 - spec/files/one_layer.psd
 - spec/files/path.psd
+- spec/files/pixel.psd
 - spec/files/simplest.psd
 - spec/files/text.psd
 - spec/hierarchy_spec.rb
 - spec/identity_spec.rb
+- spec/image_spec.rb
 - spec/parsing_spec.rb
 - spec/psd_spec.rb
 - spec/spec_helper.rb