chunky_png 1.1.2 → 1.2.0

data/README.rdoc

@@ -63,5 +63,8 @@ The library is written by Willem van Bergen for Floorplanner.com, and released
 under the MIT license (see LICENSE). Please contact me for questions or
 remarks. Patches are greatly appreciated!
 
+Please check out the changelog on https://github.com/wvanbergen/chunky_png/wiki/Changelog
+to see what changed in all versions.
+
 P.S.: The name of this library is intentionally similar to Chunky Bacon and 
 Chunky GIF. Use Google if you want to know _why. :-)

data/chunky_png.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
 
   # Do not change the version and date fields by hand. This will be done
   # automatically by the gem release script.
-  s.version = "1.1.2"
-  s.date    = "2011-05-06"
+  s.version = "1.2.0"
+  s.date    = "2011-05-08"
 
   s.summary     = "Pure ruby library for read/write, chunk-level access to PNG files"
   s.description = <<-EOT

data/lib/chunky_png.rb

@@ -25,7 +25,7 @@ module ChunkyPNG
 
   # The current version of ChunkyPNG. This value will be updated 
   # automatically by them <tt>gem:release</tt> rake task.
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 
   ###################################################
   # PNG international standard defined constants

data/lib/chunky_png/canvas/png_decoding.rb

@@ -33,6 +33,9 @@ module ChunkyPNG
       # tRNS chunk from the PNG stream. For RGB(A) images, no palette is required.
       # @return [ChunkyPNG::Palette]
       attr_accessor :decoding_palette
+      
+      # The color to be replaced with fully transparent pixels.
+      attr_accessor :transparent_color
 
       # Decodes a Canvas from a PNG encoded string.
       # @param [String] str The string to read from.
@@ -73,7 +76,15 @@ module ChunkyPNG
           raise ExpectationFailed, "Invalid image size, width: #{width}, height: #{height}"
         end
 
-        self.decoding_palette = ChunkyPNG::Palette.from_chunks(ds.palette_chunk, ds.transparency_chunk)
+        case color_mode
+          when ChunkyPNG::COLOR_INDEXED
+            self.decoding_palette = ChunkyPNG::Palette.from_chunks(ds.palette_chunk, ds.transparency_chunk)
+          when ChunkyPNG::COLOR_TRUECOLOR
+            self.transparent_color = ds.transparency_chunk.truecolor_entry(depth) if ds.transparency_chunk
+          when ChunkyPNG::COLOR_GRAYSCALE
+            self.transparent_color = ds.transparency_chunk.grayscale_entry(depth) if ds.transparency_chunk
+        end
+            
         decode_png_pixelstream(ds.imagedata, width, height, color_mode, depth, interlace)
       end
 
@@ -88,11 +99,15 @@ module ChunkyPNG
       # @return [ChunkyPNG::Canvas] The decoded Canvas instance.
       def decode_png_pixelstream(stream, width, height, color_mode, depth, interlace)
         raise ChunkyPNG::ExpectationFailed, "This palette is not suitable for decoding!" if decoding_palette && !decoding_palette.can_decode?
-        case interlace
+
+        image = case interlace
           when ChunkyPNG::INTERLACING_NONE;  decode_png_without_interlacing(stream, width, height, color_mode, depth)
           when ChunkyPNG::INTERLACING_ADAM7; decode_png_with_adam7_interlacing(stream, width, height, color_mode, depth)
           else raise ChunkyPNG::NotSupported, "Don't know how the handle interlacing method #{interlace}!"
         end
+        
+        image.pixels.map! { |c| c == transparent_color ? ChunkyPNG::Color::TRANSPARENT : c } if transparent_color
+        return image
       end
 
       protected
@@ -165,6 +180,13 @@ module ChunkyPNG
         value >> 8
       end
       
+      # No-op - available for completeness sake only
+      # @param [Integer] value The 8 bit value to resample.
+      # @return [Integer] The 8 bit resampled value
+      def decode_png_resample_8bit_value(value)
+        value
+      end
+      
       # Resamples a 4 bit value to an 8 bit value.
       # @param [Integer] value The 4 bit value to resample.
       # @return [Integer] The 8 bit resampled value.
@@ -200,6 +222,14 @@ module ChunkyPNG
         when 0x03; 0xff
         end
       end
+      
+      # Resamples a 1 bit value to an 8 bit value.
+      # @param [Integer] value The 1 bit value to resample.
+      # @return [Integer] The 8 bit resampled value
+      def decode_png_resample_1bit_value(value)
+        value == 0x01 ? 0xff : 0x00
+      end
+      
 
       # Decodes a scanline of a 1-bit, indexed image into a row of pixels.
       # @param [String] stream The stream to decode from.

data/lib/chunky_png/chunk.rb

@@ -177,12 +177,46 @@ module ChunkyPNG
     class Palette < Generic
     end
 
-    # A transparency (tRNS) chunk contains the alpha channel for the colors 
-    # defined in the Palette (PLTE) chunk
+    # A transparency (tRNS) chunk defines the transparency for an image.
+    #
+    # * For indexed images, it contains the alpha channel for the colors defined in the Palette (PLTE) chunk.
+    # * For grayscale images, it contains the grayscale teint that should be considered fully transparent.
+    # * For truecolor images, it contains the color that should be considered fully transparent.
+    #
+    # Images having a color mode that already includes an alpha channel, this chunk should not be included.
     #
     # @see ChunkyPNG::Chunk::Palette
     # @see ChunkyPNG::Palette
     class Transparency < Generic
+      
+      # Returns the alpha channel for the palette of an indexed image.
+      #
+      # This method should only be used for images having color mode ChunkyPNG::COLOR_INDEXED (3).
+      #
+      # @return [Array<Integer>] Returns an array of alpha channel values [0-255].
+      def palette_alpha_channel
+        content.unpack('C*')
+      end
+      
+      # Returns the truecolor entry to be replaced by transparent pixels,
+      #
+      # This method should only be used for images having color mode ChunkyPNG::COLOR_TRUECOLOR (2).
+      #
+      # @return [Integer] The color to replace with fully transparent pixels.
+      def truecolor_entry(bit_depth)
+        values = content.unpack('nnn').map { |c| ChunkyPNG::Canvas.send(:"decode_png_resample_#{bit_depth}bit_value", c) }
+        ChunkyPNG::Color.rgb(*values)
+      end
+
+      # Returns the grayscale entry to be replaced by transparent pixels.
+      #
+      # This method should only be used for images having color mode ChunkyPNG::COLOR_GRAYSCALE (0).
+      #
+      # @return [Integer] The (grayscale) color to replace with fully transparent pixels.      
+      def grayscale_entry(bit_depth)
+        value = ChunkyPNG::Canvas.send(:"decode_png_resample_#{bit_depth}bit_value", content.unpack('n')[0])
+        ChunkyPNG::Color.grayscale(value)
+      end
     end
 
     class ImageData < Generic

data/spec/png_suite_spec.rb

@@ -85,6 +85,26 @@ describe 'PNG testuite' do
     end
   end
   
+  context 'Decoding transparency' do
+    png_suite_files(:transparency, 'tp0*.png').each do |file|
+      it "should not have transparency in #{File.basename(file)}" do
+        ChunkyPNG::Color.a(ChunkyPNG::Image.from_file(file)[0,0]).should == 255
+      end
+    end
+    
+    png_suite_files(:transparency, 'tp1*.png').each do |file|
+      it "should have transparency in #{File.basename(file)}" do
+        ChunkyPNG::Color.a(ChunkyPNG::Image.from_file(file)[0,0]).should == 0
+      end
+    end
+    
+    png_suite_files(:transparency, 'tb*.png').each do |file|
+      it "should have transparency in #{File.basename(file)}" do
+        ChunkyPNG::Color.a(ChunkyPNG::Image.from_file(file)[0,0]).should == 0
+      end
+    end
+  end
+  
   context 'Decoding different sizes' do
     
     png_suite_files(:sizes, '*n*.png').each do |file|

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 -04:00
+date: 2011-05-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency