chunky_png 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2774ecc9f2d9e0bb09588d857ec1bf66fe0161e2
-  data.tar.gz: 0144ec4242f3bf5c180a8ef5a1bb51fd3e42ca65
+  metadata.gz: de005461c2c1664cf8c8328e5769415e26b365fe
+  data.tar.gz: 0cf85db842b733efc160097379b39af523930694
 SHA512:
-  metadata.gz: ea93bfb789b22f4158605984c46fdc333a6e2a83d4f0cf2165b739be6da12383128fd61d89558bed9cef213d8546010c482b1244ccc3aa2423eb1943a0df3c34
-  data.tar.gz: baa158877d3f95359219b5a4c1d31e517a9853a947567a3e5bb4d27c5d9ab876be7321b5e7087d5e56f7895b0e5d515f0d2c44c2d3acb35ba32e92ab7cc9d00a
+  metadata.gz: 68ceb6232a10ad75694c1f908b2c7a16d9bb5b0f9c5cf0f2c017b02b60e5655e99341ab44d6135975888b8855ced580054365d670494f64ea35eeee2eabc1ed6
+  data.tar.gz: 791b4ce5e7e2228b5d3ba0c41edb1f9d0b649bbe15f6ea808bca5c716fad10205f1cff408a3f79daf8389664e58124f4e53e74018ece8da38afed0cf685e3ce7

data/CHANGELOG.rdoc

@@ -9,6 +9,10 @@ The file documents the changes to this library over the different versions.
 
 - Nothing yet!
 
+=== 1.3.8 - 2016-08-31
+
+- Add support for reading and writing an image's physical dimension (pHYs chunks).
+
 === 1.3.7 - 2016-08-31
 
 - Performance improvement for <tt>Color.euclidean_distance_rgba</tt>.

data/lib/chunky_png.rb

@@ -121,6 +121,11 @@ module ChunkyPNG
   class OutOfBounds < ChunkyPNG::ExpectationFailed
   end
 
+  # Exception that is raised when requesting the DPI of a PNG that doesn't
+  # specify the units of its physical pixel dimensions.
+  class UnitsUnknown < ChunkyPNG::Exception
+  end
+
   def self.force_binary(str)
     str.respond_to?(:force_encoding) ? str.force_encoding('BINARY') : str
   end

data/lib/chunky_png/chunk.rb

@@ -319,6 +319,47 @@ module ChunkyPNG
       end
     end
 
+    # The Physical (pHYs) chunk specifies the intended pixel size or aspect
+    # ratio for display of the image.
+    #
+    # http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html#C.pHYs
+    #
+    class Physical < Generic
+      attr_accessor :ppux, :ppuy, :unit
+
+      def initialize(ppux, ppuy, unit = :unknown)
+        raise ArgumentError, 'unit must be either :meters or :unknown' unless [:meters, :unknown].member?(unit)
+        super('pHYs')
+        @ppux, @ppuy, @unit = ppux, ppuy, unit
+      end
+
+      def dpix
+        raise ChunkyPNG::UnitsUnknown, 'the PNG specifies its physical aspect ratio, but does not specify the units of its pixels\' physical dimensions' unless unit == :meters
+        ppux * INCHES_PER_METER
+      end
+
+      def dpiy
+        raise ChunkyPNG::UnitsUnknown, 'the PNG specifies its physical aspect ratio, but does not specify the units of its pixels\' physical dimensions' unless unit == :meters
+        ppuy * INCHES_PER_METER
+      end
+
+      def self.read(type, content)
+        ppux, ppuy, unit = content.unpack('NNC')
+        unit = unit == 1 ? :meters : :unknown
+        new(ppux, ppuy, unit)
+      end
+
+      # Creates the content to write to the stream, by concatenating the
+      # keyword with the deflated value, joined by a null character.
+      #
+      # @return The content that should be written to the datastream.
+      def content
+        [ppux, ppuy, unit == :meters ? 1 : 0].pack('NNC')
+      end
+
+      INCHES_PER_METER = 0.0254
+    end
+
     # The Text (iTXt) chunk contains keyword/value metadata about the PNG
     # stream.
     #
@@ -352,6 +393,7 @@ module ChunkyPNG
       'tEXt' => Text,
       'zTXt' => CompressedText,
       'iTXt' => InternationalText,
+      'pHYs' => Physical,
     }
   end
 end

data/lib/chunky_png/datastream.rb

@@ -29,6 +29,10 @@ module ChunkyPNG
     # @return [ChunkyPNG::Chunk::Transparency]
     attr_accessor :transparency_chunk
 
+    # The chunk containing the physical dimensions of the PNG's pixels.
+    # @return [ChunkyPNG::Chunk::Physical]
+    attr_accessor :physical_chunk
+
     # The chunks that together compose the images pixel data.
     # @return [Array<ChunkyPNG::Chunk::ImageData>]
     attr_accessor :data_chunks
@@ -81,6 +85,7 @@ module ChunkyPNG
             when ChunkyPNG::Chunk::Palette;      ds.palette_chunk = chunk
             when ChunkyPNG::Chunk::Transparency; ds.transparency_chunk = chunk
             when ChunkyPNG::Chunk::ImageData;    ds.data_chunks << chunk
+            when ChunkyPNG::Chunk::Physical;     ds.physical_chunk = chunk
             when ChunkyPNG::Chunk::End;          ds.end_chunk = chunk
             else ds.other_chunks << chunk
           end
@@ -121,6 +126,7 @@ module ChunkyPNG
       other_chunks.each { |chunk| yield(chunk) }
       yield(palette_chunk)      if palette_chunk
       yield(transparency_chunk) if transparency_chunk
+      yield(physical_chunk)     if physical_chunk
       data_chunks.each  { |chunk| yield(chunk) }
       yield(end_chunk)
     end

data/lib/chunky_png/version.rb

@@ -1,5 +1,5 @@
 module ChunkyPNG
   # The current version of ChunkyPNG.
   # Set it and commit the change this before running rake release.
-  VERSION = "1.3.7"
+  VERSION = "1.3.8"
 end

data/spec/chunky_png/datastream_spec.rb

@@ -40,4 +40,22 @@ describe ChunkyPNG::Datastream do
       expect(ds.metadata['Copyright']).to eql "Copyright Willem van Schaik, Singapore 1995-96"
     end
   end
+
+  describe '#physical_chunk' do
+    it 'should read and write pHYs chunks correctly' do
+      filename = resource_file('clock.png')
+      ds = ChunkyPNG::Datastream.from_file(filename)
+      expect(ds.physical_chunk.unit).to eql :meters
+      expect(ds.physical_chunk.dpix.round).to eql 72
+      expect(ds.physical_chunk.dpiy.round).to eql 72
+      ds = ChunkyPNG::Datastream.from_blob(ds.to_blob)
+      expect(ds.physical_chunk).not_to be_nil
+    end
+
+    it 'should raise ChunkyPNG::UnitsUnknown if we request dpi but the units are unknown' do
+      physical_chunk = ChunkyPNG::Chunk::Physical.new(2835, 2835, :unknown)
+      expect{physical_chunk.dpix}.to raise_error(ChunkyPNG::UnitsUnknown)
+      expect{physical_chunk.dpiy}.to raise_error(ChunkyPNG::UnitsUnknown)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chunky_png
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors:
 - Willem van Bergen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake