zpng 0.4.4 → 0.4.6

data/lib/zpng/jpeg/chunks.rb

@@ -0,0 +1,164 @@
+# -*- coding:binary; frozen_string_literal: true -*-
+
+module ZPNG
+  module JPEG
+
+    class Chunk
+      attr_accessor :marker, :size, :data
+
+      def initialize marker, io
+        @marker = marker
+        @size = io.read(2).unpack('n')[0]
+        @data = io.read(@size-2)
+      end
+
+      def type
+        r = self.class.name.split("::").last.ljust(4)
+        r = "ch_%02X" % @marker[1].ord if r == "Chunk"
+        r
+      end
+
+      def crc
+        :no_crc
+      end
+
+      def inspect *args
+        size = @size ? sprintf("%6d",@size) : sprintf("%6s","???")
+        sprintf "<%4s size=%s >", type, size
+      end
+
+      def export *args
+        @marker + [@size].pack('n') + @data
+      end
+    end
+
+    class APP < Chunk
+      attr_accessor :name
+
+      # BYTE Version[2];      /* 07h  JFIF Format Revision      */
+      # BYTE Units;           /* 09h  Units used for Resolution */
+      # BYTE Xdensity[2];     /* 0Ah  Horizontal Resolution     */
+      # BYTE Ydensity[2];     /* 0Ch  Vertical Resolution       */
+      # BYTE XThumbnail;      /* 0Eh  Horizontal Pixel Count    */
+      # BYTE YThumbnail;      /* 0Fh  Vertical Pixel Count      */
+      class JFIF < IOStruct.new( 'vCnnCC', :version, :units, :xdensity, :ydensity, :xthumbnail, :ythumbnail )
+        def inspect *args
+          r = "<" + super.split(' ',3).last
+          r.sub!(/version=\d+/, "version=#{version >> 8}.#{version & 0xff}") if version
+          r
+        end
+      end
+
+      def initialize marker, io
+        super
+        @id  = marker[1].ord & 0xf
+        @name = @data.unpack('Z*')[0]
+        if @name == 'JFIF'
+          @jfif = JFIF.read(@data[5..-1])
+          # TODO: read thumbnail, see https://en.wikipedia.org/wiki/JPEG_File_Interchange_Format
+        end
+      end
+
+      def type
+        "APP#{@id}"
+      end
+
+      def inspect *args
+        r = super.chop + ("name=%s >" % name.inspect)
+        if @jfif
+          r = r.chop + ("jfif=%s>" % @jfif.inspect)
+        end
+        r
+      end
+    end
+
+    class SOF < Chunk
+      def initialize marker, io
+        super
+        @id = marker[1].ord & 0xf
+      end
+
+      def type
+        "SOF#{@id}"
+      end
+    end
+
+    class SOF0 < SOF
+      attr_accessor :bpp, :width, :height, :components
+      attr_accessor :color # for compatibility with IHDR
+
+      def initialize marker, io
+        super
+        @bpp, @height, @width, @components = @data.unpack('CnnC')
+      end
+
+      def inspect *args
+        super.chop + ("bpp=%d width=%d height=%d components=%d >" % [bpp, width, height, components])
+      end
+    end
+
+    class SOF2 < SOF
+      attr_accessor :precision, :width, :height, :components
+      attr_accessor :color # for compatibility with IHDR
+
+      def initialize marker, io
+        super
+        @precision, @height, @width, @components = @data.unpack('CnnC')
+      end
+
+      def bpp
+        precision
+      end
+
+      def inspect *args
+        super.chop + ("precision=%d width=%d height=%d components=%d >" % [precision, width, height, components])
+      end
+    end
+
+    class DHT < Chunk
+      attr_accessor :id, :lengths, :values
+
+      def initialize marker, io
+        super
+        @id, *@lengths = @data.unpack("CC16")
+        @values = @data.unpack("x17C" + @lengths.inject(:+).to_s)
+      end
+
+      def inspect verbose = 0
+        r = super.chop + ("id=%02x lengths=%s >" % [id, lengths.inspect])
+        r = r.chop + ("values=%s >" % [values.inspect]) if verbose > 0
+        r
+      end
+    end
+
+    class SOS < Chunk; end
+    class DRI < Chunk; end
+    class DQT < Chunk; end
+    class DAC < Chunk; end
+
+    class COM < Chunk
+      def inspect *args
+        super.chop + ("data=%s>" % data.inspect)
+      end
+    end
+
+    # Its length is unknown in advance, nor defined in the file.
+    # The only way to get its length is to either decode it or to fast-forward over it:
+    # just scan forward for a FF byte. If it's a restart marker (followed by D0 - D7) or a data FF (followed by 00), continue.
+    class ECS < Chunk
+      def initialize io
+        @data = io.read
+        if (pos = @data.index(/\xff[^\x00\xd0-\xd7]/))
+          io.seek(pos-@data.size, :CUR) # seek back
+          @data = @data[0, pos]
+        end
+        @size = @data.size
+      end
+
+      def export *args
+        @data
+      end
+    end
+
+  end
+end

data/lib/zpng/jpeg/reader.rb

@@ -0,0 +1,55 @@
+# -*- coding:binary; frozen_string_literal: true -*-
+
+# https://github.com/corkami/formats/blob/master/image/jpeg.md
+# https://docs.fileformat.com/image/jpeg/
+# https://www.file-recovery.com/jpg-signature-format.htm
+# https://exiftool.org/TagNames/JPEG.html
+
+module ZPNG
+  module JPEG
+
+    SOI = "\xff\xd8" # Start of Image
+    EOI = "\xff\xd9" # End of Image
+
+    MAGIC = SOI
+
+    module Reader
+      def _read_jpeg io
+        @format = :jpeg
+
+        while !io.eof?
+          marker = io.read(2)
+          break if marker == EOI
+
+          case marker[1].ord
+          when 0xc0
+            @chunks << (@ihdr=SOF0.new(marker, io))
+          when 0xc2
+            @chunks << (@ihdr=SOF2.new(marker, io))
+          when 0xc4
+            @chunks << DHT.new(marker, io)
+          when 0xcc
+            @chunks << DAC.new(marker, io)
+          when 0xc1..0xcf
+            @chunks << SOF.new(marker, io)
+          when 0xda
+            @chunks << SOS.new(marker, io)
+            # Entropy-Coded Segment starts
+            @chunks << ECS.new(io)
+          when 0xdb
+            @chunks << DQT.new(marker, io)
+          when 0xdd
+            @chunks << DRI.new(marker, io)
+          when 0xe0..0xef
+            @chunks << APP.new(marker, io)
+          when 0xfe
+            @chunks << COM.new(marker, io)
+          else
+            $stderr.puts "[?] Unknown JPEG marker #{marker.inspect}".yellow
+            @chunks << Chunk.new(marker, io)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zpng/scan_line.rb

@@ -1,4 +1,7 @@
 #coding: binary
+
+require 'set'
+
 module ZPNG
   class ScanLine
     FILTER_NONE           = 0
@@ -39,6 +42,7 @@ module ZPNG
           STDERR.puts "[!] #{self.class}: ##@idx: no data at pos 0, scanline dropped".red
         end
       end
+      @errors = Set.new
     end
 
     # ScanLine is BAD if it has no filter
@@ -146,6 +150,24 @@ module ZPNG
       end # case image.hdr.color
     end
 
+    def get_raw x
+      return nil if @bpp > 8 || image.hdr.color != COLOR_INDEXED
+
+      raw =
+        if @BPP
+          # 8, 16, 24, 32, 48 bits per pixel
+          decoded_bytes[x*@BPP, @BPP]
+        else
+          # 1, 2 or 4 bits per pixel
+          decoded_bytes[x*@bpp/8]
+        end
+
+      mask  = 2**@bpp-1
+      shift = 8-(x%(8/@bpp)+1)*@bpp
+      raise "invalid shift #{shift}" if shift < 0 || shift > 7
+      idx = (raw.ord >> shift) & mask
+    end
+
     def [] x
       raw =
         if @BPP
@@ -162,6 +184,20 @@ module ZPNG
         shift = 8-(x%(8/@bpp)+1)*@bpp
         raise "invalid shift #{shift}" if shift < 0 || shift > 7
         idx = (raw.ord >> shift) & mask
+        color = image.palette[idx]
+        unless color
+          if !@errors.include?(x) && @image.verbose >= -1
+            # prevent same error popping up multiple times, f.ex. in zsteg analysis
+            @errors << x
+            if (32..127).include?(idx)
+              msg = '[!] %s: color #%-3d ("%c") at x=%d y=%d is out of palette!'.red % [self.class, idx, idx, x, @idx]
+            else
+              msg = "[!] %s: color #%-3d at x=%d y=%d is out of palette!".red % [self.class, idx, x, @idx]
+            end
+            STDERR.puts msg
+          end
+          color = Color.new(0,0,0)
+        end
         if image.trns
           # transparency from tRNS chunk
           # For color type 3 (indexed color), the tRNS chunk contains a series of one-byte alpha values,
@@ -171,17 +207,14 @@ module ZPNG
           #   Alpha for palette index 1:  1 byte
           #   ...
           #
-          color = image.palette[idx].dup
           if color.alpha = image.trns.data[idx]
             # if it's not NULL - convert it from char to int,
             # otherwise it means fully opaque color, as well as NULL alpha in ZPNG::Color
+            color = color.dup
             color.alpha = color.alpha.ord
           end
-          return color
-        else
-          # no transparency
-          return image.palette[idx]
         end
+        return color
 
       when COLOR_GRAYSCALE              # ALLOWED_DEPTHS: 1, 2, 4, 8, 16
         c = if @bpp == 16

data/lib/zpng.rb

@@ -16,11 +16,12 @@ require 'zpng/scan_line'
 require 'zpng/scan_line/mixins'
 require 'zpng/chunk'
 require 'zpng/text_chunk'
-require 'zpng/readable_struct'
 require 'zpng/adam7_decoder'
 require 'zpng/hexdump'
 require 'zpng/metadata'
 require 'zpng/pixels'
 
 require 'zpng/bmp/reader'
+require 'zpng/jpeg/chunks'
+require 'zpng/jpeg/reader'
 require 'zpng/image'

data/spec/bad_samples_spec.rb

@@ -19,6 +19,18 @@ each_sample("bad/*.png") do |fname|
       @img[0,0].should be_instance_of(ZPNG::Color)
     end
 
+    it "accessess all pixels" do
+      skip "no BPP" unless @img.bpp
+      skip if fname == 'samples/bad/b1.png'
+      skip if fname == 'samples/bad/000000.png'
+      n = 0
+      @img.each_pixel do |px|
+        px.should be_instance_of(ZPNG::Color)
+        n += 1
+      end
+      n.should == @img.width*@img.height
+    end
+
     describe "CLI" do
       it "shows info & chunks" do
         orig_stdout, out = $stdout, ""

data/spec/cli_spec.rb

@@ -1,8 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '/spec_helper'))
 require 'zpng/cli'
 
-CLI_PATHNAME = File.expand_path(File.join(File.dirname(__FILE__), '/../bin/zpng'))
-
 describe "CLI" do
   PNGSuite.each_good do |fname|
     describe fname.sub(%r|\A#{Regexp::escape(Dir.getwd)}/?|, '') do

data/spec/image_spec.rb

@@ -1,51 +1,126 @@
+# coding: binary
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 NEW_IMG_WIDTH  = 20
 NEW_IMG_HEIGHT = 10
 
 describe ZPNG::Image do
-  describe "new" do
-    let!(:img){ ZPNG::Image.new :width => NEW_IMG_WIDTH, :height => NEW_IMG_HEIGHT }
+
+  shared_examples "exported image" do |bpp=32|
+    let(:eimg){ img.export }
+    let(:img2){ ZPNG::Image.new(eimg) }
+
+    it "has PNG header" do
+      eimg.should start_with(ZPNG::Image::PNG_HDR)
+    end
+
+    describe "parsed again" do
+      it "is a ZPNG::Image" do
+        img2.should be_instance_of(ZPNG::Image)
+      end
+
+      it "should be of specified size" do
+        img2.width.should  == NEW_IMG_WIDTH
+        img2.height.should == NEW_IMG_HEIGHT
+      end
+
+      it "should have bpp = #{bpp}" do
+        img2.hdr.bpp.should == bpp
+      end
+
+      it "should have 3 chunks: IHDR, IDAT, IEND" do
+        img2.chunks.map(&:type).should == %w'IHDR IDAT IEND'
+      end
+
+    end
+  end
+
+  describe ".new" do
+    let(:img){ ZPNG::Image.new :width => NEW_IMG_WIDTH, :height => NEW_IMG_HEIGHT }
 
     it "returns ZPNG::Image" do
       img.should be_instance_of(ZPNG::Image)
     end
+
     it "creates new image of specified size" do
       img.width.should  == NEW_IMG_WIDTH
       img.height.should == NEW_IMG_HEIGHT
     end
 
-    describe "exported image" do
-      let!(:eimg){ img.export }
-      it "has PNG header" do
-        eimg.should start_with(ZPNG::Image::PNG_HDR)
+    include_examples "exported image" do
+      it "should have all pixels transparent" do
+        NEW_IMG_HEIGHT.times do |y|
+          NEW_IMG_WIDTH.times do |x|
+            img2[x,y].should be_transparent
+          end
+        end
       end
+    end
 
-      describe "parsed again" do
-        let!(:img2){ ZPNG::Image.new(eimg) }
-
-        it "is a ZPNG::Image" do
-          img2.should be_instance_of(ZPNG::Image)
+    describe "setting imagedata" do
+      before do
+        imagedata_size = NEW_IMG_WIDTH * NEW_IMG_HEIGHT * 4
+        imagedata = "\x00" * imagedata_size
+        imagedata_size.times do |i|
+          imagedata.setbyte(i, i & 0xff)
         end
+        img.imagedata = imagedata
+      end
 
-        it "should be of specified size" do
-          img2.width.should  == NEW_IMG_WIDTH
-          img2.height.should == NEW_IMG_HEIGHT
+      include_examples "exported image" do
+        it "should not have all pixels transparent" do
+          skip "TBD"
+          NEW_IMG_HEIGHT.times do |y|
+            NEW_IMG_WIDTH.times do |x|
+              img2[x,y].should_not be_transparent
+            end
+          end
         end
+      end
+    end
 
-        it "should have bpp = 32" do
-          img2.hdr.bpp.should == 32
-        end
+  end
+
+  describe ".from_rgb" do
+    before do
+      data_size = NEW_IMG_WIDTH * NEW_IMG_HEIGHT * 3
+      @data = "\x00" * data_size
+      data_size.times do |i|
+        @data.setbyte(i, i & 0xff)
+      end
+    end
+
+    let(:img){ ZPNG::Image.from_rgb(@data, width: NEW_IMG_WIDTH, height: NEW_IMG_HEIGHT) }
 
-        it "should have 3 chunks: IHDR, IDAT, IEND" do
-          img2.chunks.map(&:type).should == %w'IHDR IDAT IEND'
+    include_examples "exported image", 24 do
+      it "should have pixels from passed data" do
+        i = (0..255).cycle
+        NEW_IMG_HEIGHT.times do |y|
+          NEW_IMG_WIDTH.times do |x|
+            img2[x,y].should == ZPNG::Color.new(i.next, i.next, i.next)
+          end
         end
+      end
+    end
+  end
 
-        it "should have all pixels transparent" do
-          NEW_IMG_HEIGHT.times do |y|
-            NEW_IMG_WIDTH.times do |x|
-              img2[x,y].should be_transparent
-            end
+  describe ".from_rgba" do
+    before do
+      data_size = NEW_IMG_WIDTH * NEW_IMG_HEIGHT * 4
+      @data = "\x00" * data_size
+      data_size.times do |i|
+        @data.setbyte(i, i & 0xff)
+      end
+    end
+
+    let(:img){ ZPNG::Image.from_rgba(@data, width: NEW_IMG_WIDTH, height: NEW_IMG_HEIGHT) }
+
+    include_examples "exported image" do
+      it "should have pixels from passed data" do
+        i = (0..255).cycle
+        NEW_IMG_HEIGHT.times do |y|
+          NEW_IMG_WIDTH.times do |x|
+            img2[x,y].should == ZPNG::Color.new(i.next, i.next, i.next, i.next)
           end
         end
       end

data/spec/pixel_access_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '/spec_helper'))
 require 'zpng/cli'
+require 'set'
 
 PNGSuite.each_good do |fname|
   describe fname.sub(%r|\A#{Regexp::escape(Dir.getwd)}/?|, '') do
@@ -12,5 +13,38 @@ PNGSuite.each_good do |fname|
       end
       n.should == img.width*img.height
     end
+
+    it "accessess all pixels with coords" do
+      img = ZPNG::Image.load(fname)
+      n = 0
+      ax = Set.new
+      ay = Set.new
+      img.each_pixel do |px, x, y|
+        px.should be_instance_of(ZPNG::Color)
+        n += 1
+        ax << x
+        ay << y
+      end
+      n.should == img.width*img.height
+      ax.size.should == img.width
+      ay.size.should == img.height
+    end
+
+    it "accessess all pixels using method #2" do
+      img = ZPNG::Image.load(fname)
+      n = 0
+      a = img.each_pixel.to_a
+      ax = Set.new
+      ay = Set.new
+      a.each do |px, x, y|
+        px.should be_instance_of(ZPNG::Color)
+        n += 1
+        ax << x
+        ay << y
+      end
+      n.should == img.width*img.height
+      ax.size.should == img.width
+      ay.size.should == img.height
+    end
   end
 end

data/spec/rotate_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+ROTATE_SAMPLE = File.join(SAMPLES_DIR, "captcha_4bpp.png")
+
+include ZPNG
+
+describe Image do
+  describe "#rotated_90_cw" do
+    it "rotates and keeps original image unchanged" do
+      src = Image.load(ROTATE_SAMPLE)
+      src2 = Image.load(ROTATE_SAMPLE)
+      dst = src.rotated_90_cw
+
+      dst.width.should  == src.height
+      dst.height.should == src.width
+
+      dst.width.should_not  == src.width
+      dst.height.should_not == src.height
+
+      src.export.should == src2.export
+      src.export.should_not == dst.export
+      src2.export.should_not == dst.export
+
+      dst.should == Image.load(File.join(SAMPLES_DIR, "captcha_4bpp_rotated90.png"))
+    end
+  end
+
+  describe "#rotated" do
+    0.step(360, 90) do |angle|
+      it "rotates #{angle} degrees and keeps original image unchanged" do
+        src = Image.load(ROTATE_SAMPLE)
+        src2 = Image.load(ROTATE_SAMPLE)
+        dst = src.rotated(angle)
+        dst.save(File.join(SAMPLES_DIR, "captcha_4bpp_rotated#{angle}.png"))
+
+        if angle % 180 == 0
+          dst.width.should  == src.width
+          dst.height.should == src.height
+        else
+          dst.width.should  == src.height
+          dst.height.should == src.width
+
+          dst.width.should_not  == src.width
+          dst.height.should_not == src.height
+        end
+
+        src.export.should == src2.export
+
+        if angle % 360 == 0
+          src.export == dst.export
+          src2.export == dst.export
+        else
+          src.export.should_not == dst.export
+          src2.export.should_not == dst.export
+        end
+
+        src = Image.load(angle % 360 == 0 ? ROTATE_SAMPLE : File.join(SAMPLES_DIR, "captcha_4bpp_rotated#{angle}.png"))
+        dst.should == src
+      end
+    end
+  end
+end

data/zpng.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: zpng 0.4.4 ruby lib
+# stub: zpng 0.4.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "zpng".freeze
-  s.version = "0.4.4"
+  s.version = "0.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andrey \"Zed\" Zaikin".freeze]
-  s.date = "2023-02-14"
+  s.date = "2026-01-28"
   s.email = "zed.0xff@gmail.com".freeze
   s.executables = ["zpng".freeze]
   s.extra_rdoc_files = [
@@ -42,9 +42,10 @@ Gem::Specification.new do |s|
     "lib/zpng/deep_copyable.rb",
     "lib/zpng/hexdump.rb",
     "lib/zpng/image.rb",
+    "lib/zpng/jpeg/chunks.rb",
+    "lib/zpng/jpeg/reader.rb",
     "lib/zpng/metadata.rb",
     "lib/zpng/pixels.rb",
-    "lib/zpng/readable_struct.rb",
     "lib/zpng/scan_line.rb",
     "lib/zpng/scan_line/mixins.rb",
     "lib/zpng/string_ext.rb",
@@ -68,6 +69,7 @@ Gem::Specification.new do |s|
     "spec/modify_spec.rb",
     "spec/pixel_access_spec.rb",
     "spec/pixels_enumerator_spec.rb",
+    "spec/rotate_spec.rb",
     "spec/running_pixel_spec.rb",
     "spec/set_random_pixel_spec.rb",
     "spec/spec_helper.rb",
@@ -76,7 +78,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/zed-0xff/zpng".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.3.7".freeze
+  s.rubygems_version = "3.2.33".freeze
   s.summary = "pure ruby PNG file manipulation & validation".freeze
 
   if s.respond_to? :specification_version then
@@ -85,11 +87,13 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<rainbow>.freeze, ["~> 3.1.1"])
+    s.add_runtime_dependency(%q<iostruct>.freeze, [">= 0.7.0"])
     s.add_development_dependency(%q<rspec>.freeze, ["~> 3.11.0"])
     s.add_development_dependency(%q<rspec-its>.freeze, ["~> 1.3.0"])
     s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
   else
     s.add_dependency(%q<rainbow>.freeze, ["~> 3.1.1"])
+    s.add_dependency(%q<iostruct>.freeze, [">= 0.7.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.11.0"])
     s.add_dependency(%q<rspec-its>.freeze, ["~> 1.3.0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])