zpng 0.0.2 → 0.1.0

data/Gemfile

@@ -8,8 +8,7 @@ gem 'hexdump'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "rspec",   ">= 2.8.0"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
 end

data/Gemfile.lock

@@ -4,29 +4,31 @@ GEM
     colorize (0.5.8)
     diff-lcs (1.1.3)
     git (1.2.5)
-    hexdump (0.2.1)
-    jeweler (1.6.4)
+    hexdump (0.2.3)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.2.2)
-    rcov (0.9.11)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
+      rdoc
+    json (1.7.5)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (>= 1.0.0)
   colorize
   hexdump
-  jeweler (~> 1.6.4)
-  rcov
-  rspec (~> 2.8.0)
+  jeweler (~> 1.8.4)
+  rspec (>= 2.8.0)

data/README.md

@@ -1,4 +1,4 @@
-zpng
+zpng    [![Build Status](https://secure.travis-ci.org/zed-0xff/zpng.png)](http://secure.travis-ci.org/zed-0xff/zpng)  [![Dependency Status](https://gemnasium.com/zed-0xff/zpng.png)](https://gemnasium.com/zed-0xff/zpng)
 ======
 
 
@@ -15,14 +15,18 @@ Usage
 
     # zpng -h
 
-    Usage: zpng [options]
+    Usage: zpng [options] filename.png
         -v, --verbose                    Run verbosely (can be used multiple times)
         -q, --quiet                      Silent any warnings (can be used multiple times)
-        -I, --info                       General image info
         -C, --chunks                     Show file chunks (default)
+        -i, --info                       General image info (default)
         -A, --ascii                      Try to display image as ASCII (works best with monochrome images)
         -S, --scanlines                  Show scanlines info
         -P, --palette                    Show palette
+        -E, --extract-chunk ID           extract a single chunk
+        -U, --unpack-imagedata           unpack Image Data (IDAT) chunk(s), output to stdout
+        -c, --crop GEOMETRY              crop image, {WIDTH}x{HEIGHT}+{X}+{Y},
+                                         puts results on stdout unless --ascii given
 
 ### Info
 
@@ -35,15 +39,15 @@ Usage
 
     # zpng --chunks qr_aux_chunks.png
 
-    [.] #<ZPNG::Chunk  IHDR size=   13, crc=36a28ef4, width=35, height=35, depth=1, color=0, compression=0, filter=0, interlace=0> CRC OK
-    [.] #<ZPNG::Chunk  gAMA size=    4, crc=0bfc6105 > CRC OK
-    [.] #<ZPNG::Chunk  sRGB size=    1, crc=aece1ce9 > CRC OK
-    [.] #<ZPNG::Chunk  cHRM size=   32, crc=9cba513c > CRC OK
-    [.] #<ZPNG::Chunk  pHYs size=    9, crc=46c96b3e > CRC OK
-    [.] #<ZPNG::Chunk  IDAT size=  213, crc=5f3f1ff9 > CRC OK
-    [.] #<ZPNG::Chunk  tEXt size=   37, crc=8d62fd1a > CRC OK
-    [.] #<ZPNG::Chunk  tEXt size=   37, crc=fc3f45a6 > CRC OK
-    [.] #<ZPNG::Chunk  IEND size=    0, crc=ae426082 > CRC OK
+    [.] <Chunk #00 IHDR size=    13, crc=36a28ef4, width=35, height=35, depth=1, color=0, compression=0, filter=0, interlace=0, idx=0> CRC OK
+    [.] <Chunk #01 gAMA size=     4, crc=0bfc6105 > CRC OK
+    [.] <Chunk #02 sRGB size=     1, crc=aece1ce9 > CRC OK
+    [.] <Chunk #03 cHRM size=    32, crc=9cba513c > CRC OK
+    [.] <Chunk #04 pHYs size=     9, crc=46c96b3e > CRC OK
+    [.] <Chunk #05 IDAT size=   213, crc=5f3f1ff9 > CRC OK
+    [.] <Chunk #06 tEXt size=    37, crc=8d62fd1a > CRC OK
+    [.] <Chunk #07 tEXt size=    37, crc=fc3f45a6 > CRC OK
+    [.] <Chunk #08 IEND size=     0, crc=ae426082 > CRC OK
 
 ### ASCII
 
@@ -90,47 +94,47 @@ source image: ![qr_rgb.png](https://github.com/zed-0xff/zpng/raw/master/samples/
 
     # zpng --scanlines qr_rgb.png
 
-    [#<ZPNG::ScanLine idx=0, bpp=24, BPP=3, offset=1, filter=1>,
-     #<ZPNG::ScanLine idx=1, bpp=24, BPP=3, offset=107, filter=4>,
-     #<ZPNG::ScanLine idx=2, bpp=24, BPP=3, offset=213, filter=4>,
-     #<ZPNG::ScanLine idx=3, bpp=24, BPP=3, offset=319, filter=4>,
-     #<ZPNG::ScanLine idx=4, bpp=24, BPP=3, offset=425, filter=2>,
-     #<ZPNG::ScanLine idx=5, bpp=24, BPP=3, offset=531, filter=2>,
-     #<ZPNG::ScanLine idx=6, bpp=24, BPP=3, offset=637, filter=4>,
-     #<ZPNG::ScanLine idx=7, bpp=24, BPP=3, offset=743, filter=0>,
-     #<ZPNG::ScanLine idx=8, bpp=24, BPP=3, offset=849, filter=1>,
-     #<ZPNG::ScanLine idx=9, bpp=24, BPP=3, offset=955, filter=0>,
-     #<ZPNG::ScanLine idx=10, bpp=24, BPP=3, offset=1061, filter=0>,
-     #<ZPNG::ScanLine idx=11, bpp=24, BPP=3, offset=1167, filter=0>,
-     #<ZPNG::ScanLine idx=12, bpp=24, BPP=3, offset=1273, filter=1>,
-     #<ZPNG::ScanLine idx=13, bpp=24, BPP=3, offset=1379, filter=2>,
-     #<ZPNG::ScanLine idx=14, bpp=24, BPP=3, offset=1485, filter=4>,
-     #<ZPNG::ScanLine idx=15, bpp=24, BPP=3, offset=1591, filter=0>,
-     #<ZPNG::ScanLine idx=16, bpp=24, BPP=3, offset=1697, filter=4>,
-     #<ZPNG::ScanLine idx=17, bpp=24, BPP=3, offset=1803, filter=0>,
-     #<ZPNG::ScanLine idx=18, bpp=24, BPP=3, offset=1909, filter=4>,
-     #<ZPNG::ScanLine idx=19, bpp=24, BPP=3, offset=2015, filter=4>,
-     #<ZPNG::ScanLine idx=20, bpp=24, BPP=3, offset=2121, filter=0>,
-     #<ZPNG::ScanLine idx=21, bpp=24, BPP=3, offset=2227, filter=1>,
-     #<ZPNG::ScanLine idx=22, bpp=24, BPP=3, offset=2333, filter=2>,
-     #<ZPNG::ScanLine idx=23, bpp=24, BPP=3, offset=2439, filter=0>,
-     #<ZPNG::ScanLine idx=24, bpp=24, BPP=3, offset=2545, filter=2>,
-     #<ZPNG::ScanLine idx=25, bpp=24, BPP=3, offset=2651, filter=1>,
-     #<ZPNG::ScanLine idx=26, bpp=24, BPP=3, offset=2757, filter=1>,
-     #<ZPNG::ScanLine idx=27, bpp=24, BPP=3, offset=2863, filter=4>,
-     #<ZPNG::ScanLine idx=28, bpp=24, BPP=3, offset=2969, filter=4>,
-     #<ZPNG::ScanLine idx=29, bpp=24, BPP=3, offset=3075, filter=4>,
-     #<ZPNG::ScanLine idx=30, bpp=24, BPP=3, offset=3181, filter=4>,
-     #<ZPNG::ScanLine idx=31, bpp=24, BPP=3, offset=3287, filter=2>,
-     #<ZPNG::ScanLine idx=32, bpp=24, BPP=3, offset=3393, filter=4>,
-     #<ZPNG::ScanLine idx=33, bpp=24, BPP=3, offset=3499, filter=4>,
-     #<ZPNG::ScanLine idx=34, bpp=24, BPP=3, offset=3605, filter=1>]
+    [#<ZPNG::ScanLine idx=0, bpp=24, offset=1, filter=1>,
+     #<ZPNG::ScanLine idx=1, bpp=24, offset=107, filter=4>,
+     #<ZPNG::ScanLine idx=2, bpp=24, offset=213, filter=4>,
+     #<ZPNG::ScanLine idx=3, bpp=24, offset=319, filter=4>,
+     #<ZPNG::ScanLine idx=4, bpp=24, offset=425, filter=2>,
+     #<ZPNG::ScanLine idx=5, bpp=24, offset=531, filter=2>,
+     #<ZPNG::ScanLine idx=6, bpp=24, offset=637, filter=4>,
+     #<ZPNG::ScanLine idx=7, bpp=24, offset=743, filter=0>,
+     #<ZPNG::ScanLine idx=8, bpp=24, offset=849, filter=1>,
+     #<ZPNG::ScanLine idx=9, bpp=24, offset=955, filter=0>,
+     #<ZPNG::ScanLine idx=10, bpp=24, offset=1061, filter=0>,
+     #<ZPNG::ScanLine idx=11, bpp=24, offset=1167, filter=0>,
+     #<ZPNG::ScanLine idx=12, bpp=24, offset=1273, filter=1>,
+     #<ZPNG::ScanLine idx=13, bpp=24, offset=1379, filter=2>,
+     #<ZPNG::ScanLine idx=14, bpp=24, offset=1485, filter=4>,
+     #<ZPNG::ScanLine idx=15, bpp=24, offset=1591, filter=0>,
+     #<ZPNG::ScanLine idx=16, bpp=24, offset=1697, filter=4>,
+     #<ZPNG::ScanLine idx=17, bpp=24, offset=1803, filter=0>,
+     #<ZPNG::ScanLine idx=18, bpp=24, offset=1909, filter=4>,
+     #<ZPNG::ScanLine idx=19, bpp=24, offset=2015, filter=4>,
+     #<ZPNG::ScanLine idx=20, bpp=24, offset=2121, filter=0>,
+     #<ZPNG::ScanLine idx=21, bpp=24, offset=2227, filter=1>,
+     #<ZPNG::ScanLine idx=22, bpp=24, offset=2333, filter=2>,
+     #<ZPNG::ScanLine idx=23, bpp=24, offset=2439, filter=0>,
+     #<ZPNG::ScanLine idx=24, bpp=24, offset=2545, filter=2>,
+     #<ZPNG::ScanLine idx=25, bpp=24, offset=2651, filter=1>,
+     #<ZPNG::ScanLine idx=26, bpp=24, offset=2757, filter=1>,
+     #<ZPNG::ScanLine idx=27, bpp=24, offset=2863, filter=4>,
+     #<ZPNG::ScanLine idx=28, bpp=24, offset=2969, filter=4>,
+     #<ZPNG::ScanLine idx=29, bpp=24, offset=3075, filter=4>,
+     #<ZPNG::ScanLine idx=30, bpp=24, offset=3181, filter=4>,
+     #<ZPNG::ScanLine idx=31, bpp=24, offset=3287, filter=2>,
+     #<ZPNG::ScanLine idx=32, bpp=24, offset=3393, filter=4>,
+     #<ZPNG::ScanLine idx=33, bpp=24, offset=3499, filter=4>,
+     #<ZPNG::ScanLine idx=34, bpp=24, offset=3605, filter=1>]
 
 ### Palette
 
     # zpng --palette qr_plte_bw.png
 
-    #<ZPNG::Chunk  PLTE size=    6, crc=55c2d37e >
+    <Chunk #02 PLTE size=     6, crc=55c2d37e >
     00000000  ff ff ff 00 00 00                                      |......|
 
 
@@ -157,6 +161,16 @@ source image: ![qr_rgb.png](https://github.com/zed-0xff/zpng/raw/master/samples/
       f << img.export
     end
 
+## Create 16x16 transparent PNG
+
+    #!/usr/bin/env ruby
+    require 'zpng'
+    include ZPNG
+
+    img = Image.new :width => 16, :height => 16
+    File.open("16x16.png","wb") do |f|
+      f << img.export
+    end
 
 License
 -------

data/README.md.tpl

@@ -1,4 +1,4 @@
-zpng
+zpng    [![Build Status](https://secure.travis-ci.org/zed-0xff/zpng.png)](http://secure.travis-ci.org/zed-0xff/zpng)  [![Dependency Status](https://gemnasium.com/zed-0xff/zpng.png)](https://gemnasium.com/zed-0xff/zpng)
 ======
 
 
@@ -61,6 +61,16 @@ source image: ![qr_rgb.png](https://github.com/zed-0xff/zpng/raw/master/samples/
       f << img.export
     end
 
+## Create 16x16 transparent PNG
+
+    #!/usr/bin/env ruby
+    require 'zpng'
+    include ZPNG
+
+    img = Image.new :width => 16, :height => 16
+    File.open("16x16.png","wb") do |f|
+      f << img.export
+    end
 
 License
 -------

data/Rakefile

@@ -72,3 +72,46 @@ task :readme do
   Dir.chdir '..'
   File.open('README.md','w'){ |f| f << result }
 end
+
+desc "generate"
+task :gen do
+  $:.unshift("./lib")
+  require 'zpng'
+  img = ZPNG::Image.new :width => 16, :height => 16, :bpp => 4
+  img.save "out.png"
+end
+
+Rake::Task[:console].clear
+
+# from /usr/local/lib64/ruby/gems/1.9.1/gems/jeweler-1.8.4/lib/jeweler/tasks.rb
+desc "Start IRB with all runtime dependencies loaded"
+task :console, [:script] do |t,args|
+  # TODO move to a command
+  dirs = ['ext', 'lib'].select { |dir| File.directory?(dir) }
+
+  original_load_path = $LOAD_PATH
+
+  cmd = if File.exist?('Gemfile')
+          require 'bundler'
+          Bundler.setup(:default)
+        end
+
+  # add the project code directories
+  $LOAD_PATH.unshift(*dirs)
+
+  # clear ARGV so IRB is not confused
+  ARGV.clear
+
+  require 'irb'
+
+  # ZZZ actually added only these 2 lines
+  require 'zpng'
+  include ZPNG
+
+  # set the optional script to run
+  IRB.conf[:SCRIPT] = args.script
+  IRB.start
+
+  # return the $LOAD_PATH to it's original state
+  $LOAD_PATH.reject! { |path| !(original_load_path.include?(path)) }
+end

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/zpng/chunk.rb

@@ -18,25 +18,42 @@ module ZPNG
       end
     end
 
-    def initialize io
-      @size, @type = io.read(8).unpack('Na4')
-      @data        = io.read(size)
-      @crc         = io.read(4).to_s.unpack('N').first
+    def initialize x = {}
+      if x.respond_to?(:read)
+        # IO
+        @size, @type = x.read(8).unpack('Na4')
+        @data        = x.read(size)
+        @crc         = x.read(4).to_s.unpack('N').first
+      elsif x.respond_to?(:[])
+        # Hash
+        %w'size type data crc'.each do |k|
+          instance_variable_set "@#{k}", x[k.to_sym]
+        end
+        if !@type && self.class.superclass == ZPNG::Chunk
+          # guess @type from self class name, e.g. ZPNG::Chunk::IHDR => "IHDR"
+          @type = self.class.to_s.split("::").last
+        end
+        if !@size && @data
+          # guess @size from @data
+          @size = @data.size
+        end
+      end
     end
 
     def export
       @data = self.export_data # virtual
+      @size = @data.size # XXX hmm.. is it always is?
       @crc = Zlib.crc32(data, Zlib.crc32(type))
       [@size,@type].pack('Na4') + @data + [@crc].pack('N')
     end
 
     def export_data
       #STDERR.puts "[!] Chunk::#{type} must realize 'export_data' virtual method".yellow if @size != 0
-      @data
+      @data || ''
     end
 
     def inspect
-      size = @size ? sprintf("%5d",@size) : sprintf("%5s","???")
+      size = @size ? sprintf("%6d",@size) : sprintf("%6s","???")
       crc  = @crc  ? sprintf("%08x",@crc) : sprintf("%8s","???")
       type = @type.to_s.gsub(/[^0-9a-z]/i){ |x| sprintf("\\x%02X",x.ord) }
       sprintf "<Chunk #%02d %4s size=%s, crc=%s >", idx.to_i, type, size, crc
@@ -54,11 +71,16 @@ module ZPNG
       COLOR_USED   = 2
       ALPHA_USED   = 4
 
-      COLOR_GRAYSCALE  = 0  # Each pixel is a grayscale sample
-      COLOR_RGB        = 2  # Each pixel is an R,G,B triple.
-      COLOR_INDEXED    = 3  # Each pixel is a palette index; a PLTE chunk must appear.
-      COLOR_GRAY_ALPHA = 4  # Each pixel is a grayscale sample, followed by an alpha sample.
-      COLOR_RGBA       = 6  # Each pixel is an R,G,B triple, followed by an alpha sample.
+      # put constants in the scope of ZPNG module
+      # to be able to create new images easily with
+      # include ZPNG
+      # img = Image.new :width => 16, :height => 16, :color => COLOR_RGB
+
+      ZPNG::COLOR_GRAYSCALE  = 0  # Each pixel is a grayscale sample
+      ZPNG::COLOR_RGB        = 2  # Each pixel is an R,G,B triple.
+      ZPNG::COLOR_INDEXED    = 3  # Each pixel is a palette index; a PLTE chunk must appear.
+      ZPNG::COLOR_GRAY_ALPHA = 4  # Each pixel is a grayscale sample, followed by an alpha sample.
+      ZPNG::COLOR_RGBA       = 6  # Each pixel is an R,G,B triple, followed by an alpha sample.
 
       SAMPLES_PER_COLOR = {
         COLOR_GRAYSCALE  => 1,
@@ -68,11 +90,67 @@ module ZPNG
         COLOR_RGBA       => 4
       }
 
+      # http://www.w3.org/TR/PNG/#table111
+      ALLOWED_DEPTHS = {
+        COLOR_GRAYSCALE  => [ 1, 2, 4, 8, 16 ],
+        COLOR_RGB        => [          8, 16 ],
+        COLOR_INDEXED    => [ 1, 2, 4, 8     ],
+        COLOR_GRAY_ALPHA => [          8, 16 ],
+        COLOR_RGBA       => [          8, 16 ],
+      }
+
       FORMAT = 'NNC5'
 
-      def initialize io
+      def initialize x
         super
-        @width, @height, @depth, @color, @compression, @filter, @interlace = data.unpack(FORMAT)
+        vars = %w'width height depth color compression filter interlace' # order is important
+        if x.respond_to?(:read)
+          # IO
+        elsif x.respond_to?(:[])
+          # Hash
+          vars.each{ |k| instance_variable_set "@#{k}", x[k.to_sym] }
+
+          raise "[!] width not set" unless @width
+          raise "[!] height not set" unless @height
+
+          # allow easier image creation like
+          # img = Image.new :width => 16, :height => 16, :bpp => 4, :color => false
+          # img = Image.new :width => 16, :height => 16, :bpp => 1, :color => true
+          # img = Image.new :width => 16, :height => 16, :bpp => 32
+          if x[:bpp]
+            unless [true,false,nil].include?(@color)
+              raise "[!] :color must be either 'true' or 'false' when :bpp is set"
+            end
+            if @depth
+              raise "[!] don't use :depth when :bpp is set"
+            end
+            @color, @depth = case x[:bpp]
+              when 1,2,4,8; [ @color ? COLOR_INDEXED : COLOR_GRAYSCALE,  x[:bpp] ]
+              when 16;
+                raise "[!] I don't know how to make COLOR 16 bpp PNG. do you?" if @color
+                [ COLOR_GRAY_ALPHA, 8 ]
+              when 24;      [ COLOR_RGB,  8 ]
+              when 32;      [ COLOR_RGBA, 8 ]
+              else
+                raise "[!] unsupported bpp=#{x[:bpp].inspect}"
+              end
+          end
+
+          @color       ||= COLOR_RGBA
+          @depth       ||= 8
+          @compression ||= 0
+          @filter      ||= 0
+          @interlace   ||= 0
+
+          unless ALLOWED_DEPTHS[@color].include?(@depth)
+            raise "[!] invalid color mode (#{@color.inspect}) / bit depth (#{@depth.inspect}) combination"
+          end
+        end
+        if data
+          data.unpack(FORMAT).each_with_index do |value,idx|
+            instance_variable_set "@#{vars[idx]}", value
+          end
+        end
       end
 
       def export_data
@@ -109,13 +187,20 @@ module ZPNG
     end
 
     class PLTE < Chunk
+      attr_accessor :max_colors
+
       def [] idx
         rgb = @data[idx*3,3]
-        rgb && ZPNG::Color.new(*rgb.split('').map(&:ord))
+        rgb && ZPNG::Color.new(*rgb.unpack('C3'))
+      end
+
+      def []= idx, color
+        @data ||= ''
+        @data[idx*3,3] = [color.r, color.g, color.b].pack('C3')
       end
 
       def ncolors
-        @size/3
+        @data.to_s.size/3
       end
 
       def index color
@@ -125,11 +210,23 @@ module ZPNG
         end
         nil
       end
-    end
 
-    class IEND < Chunk
+      def add color
+        raise "palette full, cannot add color #{ncolors}" if ncolors >= max_colors
+        idx = ncolors
+        self[idx] = color
+        idx
+      end
+
+      def find_or_add color
+        index(color) || add(color)
+      end
+      alias :<< :find_or_add
     end
 
+    class IDAT < Chunk; end
+    class IEND < Chunk; end
+
     class ZTXT < Chunk
       attr_accessor :keyword, :comp_method, :text
       def initialize *args