prawn 1.0.0.rc2 → 1.0.0

data/lib/prawn/image_handler.rb

@@ -0,0 +1,42 @@
+# ImageHandler provides a way to register image processors with Prawn
+#
+# Contributed by Evan Sharp in November 2013.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  # @group Extension API
+  
+  def self.image_handler
+    @image_handler ||= ImageHandler.new
+  end
+
+  class ImageHandler
+    def initialize
+      @handlers = []
+    end
+
+    def register(handler)
+      @handlers.delete(handler)
+      @handlers.push handler
+    end
+
+    def register!(handler)
+      @handlers.delete(handler)
+      @handlers.unshift handler
+    end
+
+    def unregister(handler)
+      @handlers.reject!{ |h| h == handler }
+    end
+
+    def find(image_blob)
+      handler = @handlers.find{ |h| h.can_render? image_blob }
+
+      return handler if handler
+
+      raise Prawn::Errors::UnsupportedImageType,
+            "image file is an unrecognised format"
+    end
+  end
+end

data/lib/prawn/images.rb

@@ -6,42 +6,39 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require 'digest/sha1'
+require 'pathname'
 
 module Prawn
 
   module Images
+    # @group Stable API
 
     # Add the image at filename to the current page. Currently only
-    # JPG and PNG files are supported.
-    #
-    # NOTE: Prawn is very slow at rendering PNGs with alpha channels, and this
-    # uses a lot of RAM. The workaround for those who don't mind installing
-    # RMagick is to use:
-    #
-    # http://github.com/amberbit/prawn-fast-png
+    # JPG and PNG files are supported. (Note that processing PNG
+    # images with alpha channels can be processor and memory intensive.)
     #
     # Arguments:
-    # <tt>file</tt>:: path to file or an object that responds to #read
+    # <tt>file</tt>:: path to file or an object that responds to #read and #rewind
     #
     # Options:
     # <tt>:at</tt>:: an array [x,y] with the location of the top left corner of the image.
     # <tt>:position</tt>::  One of (:left, :center, :right) or an x-offset
-    # <tt>:vposition</tt>::  One of (:top, :center, :center) or an y-offset    
+    # <tt>:vposition</tt>::  One of (:top, :center, :center) or an y-offset
     # <tt>:height</tt>:: the height of the image [actual height of the image]
     # <tt>:width</tt>:: the width of the image [actual width of the image]
     # <tt>:scale</tt>:: scale the dimensions of the image proportionally
     # <tt>:fit</tt>:: scale the dimensions of the image proportionally to fit inside [width,height]
-    # 
-    #   Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do     
-    #     pigs = "#{Prawn::DATADIR}/images/pigs.jpg" 
-    #     image pigs, :at => [50,450], :width => 450                                      
+    #
+    #   Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do
+    #     pigs = "#{Prawn::DATADIR}/images/pigs.jpg"
+    #     image pigs, :at => [50,450], :width => 450
     #
     #     dice = "#{Prawn::DATADIR}/images/dice.png"
-    #     image dice, :at => [50, 450], :scale => 0.75 
-    #   end   
+    #     image dice, :at => [50, 450], :scale => 0.75
+    #   end
     #
     # If only one of :width / :height are provided, the image will be scaled
-    # proportionally.  When both are provided, the image will be stretched to 
+    # proportionally.  When both are provided, the image will be stretched to
     # fit the dimensions without maintaining the aspect ratio.
     #
     #
@@ -55,16 +52,16 @@ module Prawn
     #
     #   require "open-uri"
     #
-    #   Prawn::Document.generate("remote_images.pdf") do 
+    #   Prawn::Document.generate("remote_images.pdf") do
     #     image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
     #   end
     #
     # This method returns an image info object which can be used to check the
-    # dimensions of an image object if needed. 
+    # dimensions of an image object if needed.
     # (See also: Prawn::Images::PNG , Prawn::Images::JPG)
-    # 
+    #
     def image(file, options={})
-      Prawn.verify_options [:at, :position, :vposition, :height, 
+      Prawn.verify_options [:at, :position, :vposition, :height,
                             :width, :scale, :fit], options
 
       pdf_obj, info = build_image_object(file)
@@ -73,23 +70,14 @@ module Prawn
       info
     end
 
+
     # Builds an info object (Prawn::Images::*) and a PDF reference representing
     # the given image. Return a pair: [pdf_obj, info].
     #
+    # @private
     def build_image_object(file)
-      # Rewind if the object we're passed is an IO, so that multiple embeds of
-      # the same IO object will work
-      file.rewind  if file.respond_to?(:rewind)
-      # read the file as binary so the size is calculated correctly
-      file.binmode if file.respond_to?(:binmode)
-
-      if file.respond_to?(:read)
-        image_content = file.read
-      else
-        raise ArgumentError, "#{file} not found" unless File.file?(file)  
-        image_content = File.binread(file)
-      end
-      
+      io = verify_and_open_image(file)
+      image_content = io.read
       image_sha1 = Digest::SHA1.hexdigest(image_content)
 
       # if this image has already been embedded, just reuse it
@@ -98,11 +86,7 @@ module Prawn
         image_obj = image_registry[image_sha1][:obj]
       else
         # Build the image object
-        klass = case Image.detect_image_format(image_content)
-                when :jpg then Prawn::Images::JPG
-                when :png then Prawn::Images::PNG
-                end
-        info = klass.new(image_content)
+        info = Prawn.image_handler.find(image_content).new(image_content)
 
         # Bump PDF version if the image requires it
         min_version(info.min_pdf_version) if info.respond_to?(:min_pdf_version)
@@ -120,15 +104,16 @@ module Prawn
     # build_image_object), embed the image according to the <tt>options</tt>
     # given.
     #
+    # @private
     def embed_image(pdf_obj, info, options)
-      # find where the image will be placed and how big it will be  
+      # find where the image will be placed and how big it will be
       w,h = info.calc_image_dimensions(options)
 
-      if options[:at]     
-        x,y = map_to_absolute(options[:at]) 
-      else                  
-        x,y = image_position(w,h,options) 
-        move_text_position h   
+      if options[:at]
+        x,y = map_to_absolute(options[:at])
+      else
+        x,y = image_position(w,h,options)
+        move_text_position h
       end
 
       # add a reference to the image object to the current page
@@ -140,12 +125,31 @@ module Prawn
       instruct = "\nq\n%.3f 0 0 %.3f %.3f %.3f cm\n/%s Do\nQ"
       add_content instruct % [ w, h, x, y - h, label ]
     end
-    
-    private   
+
+    private
+
+    def verify_and_open_image(io_or_path)
+      # File or IO
+      if io_or_path.respond_to?(:rewind)
+        io = io_or_path
+        # Rewind if the object we're passed is an IO, so that multiple embeds of
+        # the same IO object will work
+        io.rewind
+        # read the file as binary so the size is calculated correctly
+        # guard binmode because some objects acting io-like don't implement it
+        io.binmode if io.respond_to?(:binmode)
+        return io
+      end
+      # String or Pathname
+      io_or_path = Pathname.new(io_or_path)
+      raise ArgumentError, "#{io_or_path} not found" unless io_or_path.file?
+      io = io_or_path.open('rb')
+      io
+    end
 
     def image_position(w,h,options)
       options[:position] ||= :left
-      
+
       y = case options[:vposition]
       when :top
         bounds.absolute_top
@@ -159,11 +163,11 @@ module Prawn
         determine_y_with_page_flow(h)
       end
 
-      x = case options[:position] 
+      x = case options[:position]
       when :left
         bounds.left_side
       when :center
-        bounds.left_side + (bounds.width - w) / 2.0 
+        bounds.left_side + (bounds.width - w) / 2.0
       when :right
         bounds.right_side - w
       when Numeric
@@ -171,17 +175,17 @@ module Prawn
       end
 
       return [x,y]
-    end 
-    
+    end
+
     def determine_y_with_page_flow(h)
       if overruns_page?(h)
         bounds.move_past_bottom
       end
       self.y
-    end 
-    
+    end
+
     def overruns_page?(h)
-      (self.y - h) < reference_bounds.absolute_bottom 
+      (self.y - h) < reference_bounds.absolute_bottom
     end
 
     def image_registry

data/lib/prawn/images/image.rb

@@ -10,23 +10,24 @@ require 'digest/sha1'
 module Prawn
   module Images
     class Image
+      # @group Extension API
 
       def calc_image_dimensions(options)
         w = options[:width] || width
         h = options[:height] || height
 
         if options[:width] && !options[:height]
-          wp = w / width.to_f 
+          wp = w / width.to_f
           w = width * wp
           h = height * wp
-        elsif options[:height] && !options[:width]         
+        elsif options[:height] && !options[:width]
           hp = h / height.to_f
           w = width * hp
-          h = height * hp   
-        elsif options[:scale] 
+          h = height * hp
+        elsif options[:scale]
           w = width * options[:scale]
           h = height * options[:scale]
-        elsif options[:fit] 
+        elsif options[:fit]
           bw, bh = options[:fit]
           bp = bw / bh.to_f
           ip = width / height.to_f
@@ -43,23 +44,6 @@ module Prawn
 
         [w,h]
       end
-
-      def self.detect_image_format(content)
-        top = content[0,128]                       
-
-        # Unpack before comparing for JPG header, so as to avoid having to worry
-        # about the source string encoding. We just want a byte-by-byte compare.
-        if top[0, 3].unpack("C*") == [255, 216, 255]
-          return :jpg
-        elsif top[0, 8].unpack("C*") == [137, 80, 78, 71, 13, 10, 26, 10]
-          return :png
-        else
-          raise Errors::UnsupportedImageType, "image file is an unrecognised format"
-        end
-      end
-
-
     end
   end
 end
-

data/lib/prawn/images/jpg.rb

@@ -10,37 +10,43 @@ require 'stringio'
 
 module Prawn
   module Images
+
     # A convenience class that wraps the logic for extracting the parts
     # of a JPG image that we need to embed them in a PDF
     #
     class JPG < Image
+      # @group Extension API
+      
       attr_reader :width, :height, :bits, :channels
       attr_accessor :scaled_width, :scaled_height
-      
-      JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf)
-      JPEG_APP_BLOCKS = %W(\xe0 \xe1 \xe2 \xe3 \xe4 \xe5 \xe6 \xe7 \xe8 \xe9 \xea \xeb \xec \xed \xee \xef)
+
+      JPEG_SOF_BLOCKS = [0xC0, 0xC1, 0xC2, 0xC3, 0xC5, 0xC6, 0xC7, 0xC9, 0xCA, 0xCB, 0xCD, 0xCE, 0xCF]
+
+      def self.can_render?(image_blob)
+        image_blob[0, 3].unpack("C*") == [255, 216, 255]
+      end
 
       # Process a new JPG image
       #
       # <tt>:data</tt>:: A binary string of JPEG data
       #
       def initialize(data)
-        @data = data.dup
-        ruby_19 { data.force_encoding("binary") }
-        data = StringIO.new(data)
+        @data = data
+        d = StringIO.new(@data)
+        d.binmode
 
-        c_marker = "\xff" # Section marker.
-        data.read(2)   # Skip the first two bytes of JPEG identifier.
+        c_marker = 0xff # Section marker.
+        d.seek(2)    # Skip the first two bytes of JPEG identifier.
         loop do
-          marker, code, length = data.read(4).unpack('aan')
+          marker, code, length = d.read(4).unpack('CCn')
           raise "JPEG marker not found!" if marker != c_marker
 
           if JPEG_SOF_BLOCKS.include?(code)
-            @bits, @height, @width, @channels = data.read(6).unpack("CnnC")
+            @bits, @height, @width, @channels = d.read(6).unpack("CnnC")
             break
           end
 
-          buffer = data.read(length - 2)
+          d.seek(length - 2, IO::SEEK_CUR)
         end
       end
 
@@ -62,12 +68,11 @@ module Prawn
         obj = document.ref!(
           :Type             => :XObject,
           :Subtype          => :Image,
-          :Filter           => :DCTDecode,
           :ColorSpace       => color_space,
           :BitsPerComponent => bits,
           :Width            => width,
           :Height           => height
-        ) 
+        )
 
         # add extra decode params for CMYK images. By swapping the
         # min and max values from the default, we invert the colours. See
@@ -76,7 +81,8 @@ module Prawn
           obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
         end
 
-        obj << @data
+        obj.stream << @data
+        obj.stream.filters << :DCTDecode
         obj
       end
 

data/lib/prawn/images/png.rb

@@ -17,12 +17,18 @@ module Prawn
     # of a PNG image that we need to embed them in a PDF
     #
     class PNG < Image
+      # @group Extension API
+
       attr_reader :palette, :img_data, :transparency
       attr_reader :width, :height, :bits
       attr_reader :color_type, :compression_method, :filter_method
       attr_reader :interlace_method, :alpha_channel
       attr_accessor :scaled_width, :scaled_height
 
+      def self.can_render?(image_blob)
+        image_blob[0, 8].unpack("C*") == [137, 80, 78, 71, 13, 10, 26, 10]
+      end
+
       # Process a new PNG image
       #
       # <tt>data</tt>:: A binary string of PNG data
@@ -88,6 +94,8 @@ module Prawn
 
           data.read(4)  # Skip the CRC
         end
+
+        @img_data = Zlib::Inflate.inflate(@img_data)
       end
 
       # number of color components to each pixel
@@ -101,34 +109,17 @@ module Prawn
         end
       end
 
-      # number of bits used per pixel
-      #
-      def pixel_bitlength
-        if alpha_channel?
-          self.bits * (self.colors + 1)
-        else
-          self.bits * self.colors
-        end
-      end
-
       # split the alpha channel data from the raw image data in images
       # where it's required.
       #
       def split_alpha_channel!
-        unfilter_image_data if alpha_channel?
+        split_image_data if alpha_channel?
       end
 
       def alpha_channel?
         @color_type == 4 || @color_type == 6
       end
 
-      # Adobe Reader can't handle 16-bit png channels -- chop off the second
-      # byte (least significant)
-      #
-      def alpha_channel_bits
-        8
-      end
-
       # Build a PDF object representing this image in +document+, and return
       # a Reference to it.
       #
@@ -168,20 +159,21 @@ module Prawn
           :Subtype          => :Image,
           :Height           => height,
           :Width            => width,
-          :BitsPerComponent => bits,
-          :Filter           => :FlateDecode
+          :BitsPerComponent => bits
         )
 
-        unless alpha_channel
-          obj.data[:DecodeParms] = {:Predictor => 15,
-                                    :Colors    => colors,
-                                    :BitsPerComponent => bits,
-                                    :Columns   => width}
-        end
-
         # append the actual image data to the object as a stream
         obj << img_data
 
+        obj.stream.filters << {
+          :FlateDecode => {
+            :Predictor => 15,
+            :Colors    => colors,
+            :BitsPerComponent => bits,
+            :Columns   => width
+          }
+        }
+
         # sort out the colours of the image
         if palette.empty?
           obj.data[:ColorSpace] = color
@@ -232,12 +224,20 @@ module Prawn
             :Subtype          => :Image,
             :Height           => height,
             :Width            => width,
-            :BitsPerComponent => alpha_channel_bits,
-            :Filter           => :FlateDecode,
+            :BitsPerComponent => bits,
             :ColorSpace       => :DeviceGray,
             :Decode           => [0, 1]
           )
-          smask_obj << alpha_channel
+          smask_obj.stream << alpha_channel
+
+          smask_obj.stream.filters << {
+            :FlateDecode => {
+              :Predictor => 15,
+              :Colors    => 1,
+              :BitsPerComponent => bits,
+              :Columns   => width
+            }
+          }
           obj.data[:SMask] = smask_obj
         end
 
@@ -259,103 +259,40 @@ module Prawn
 
       private
 
-      def unfilter_image_data
-        data = Zlib::Inflate.inflate(@img_data).bytes
-        @img_data = ""
-        @alpha_channel = ""
-
-        pixel_bytes     = pixel_bitlength / 8
-        scanline_length = pixel_bytes * self.width + 1
-        row = 0
-        pixels = []
-        row_data = [] # reused for each row of the image
-        paeth, pa, pb, pc = nil
-
-        data.each do |byte|
-          # accumulate a whole scanline of bytes, and then process it all at once
-          # we could do this with Enumerable#each_slice, but it allocates memory,
-          #   and we are trying to avoid that
-          row_data << byte
-          next if row_data.length < scanline_length
-          
-          filter = row_data.shift
-          case filter
-          when 0 # None
-          when 1 # Sub
-            row_data.each_with_index do |byte, index|
-              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
-              row_data[index] = (byte + left) % 256
-              #p [byte, left, row_data[index]]
-            end
-          when 2 # Up
-            row_data.each_with_index do |byte, index|
-              col = (index / pixel_bytes).floor
-              upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
-              row_data[index] = (upper + byte) % 256
-            end
-          when 3  # Average
-            row_data.each_with_index do |byte, index|
-              col = (index / pixel_bytes).floor
-              upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
-              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
+      def split_image_data
+        alpha_bytes = bits / 8
+        color_bytes = colors * bits / 8
 
-              row_data[index] = (byte + ((left + upper)/2).floor) % 256
-            end
-          when 4 # Paeth
-            left = upper = upper_left = nil
-            row_data.each_with_index do |byte, index|
-              col = (index / pixel_bytes).floor
-
-              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
-              if row.zero?
-                upper = upper_left = 0
-              else
-                upper = pixels[row-1][col][index % pixel_bytes]
-                upper_left = col.zero? ? 0 :
-                  pixels[row-1][col-1][index % pixel_bytes]
-              end
-
-              p = left + upper - upper_left
-              pa = (p - left).abs
-              pb = (p - upper).abs
-              pc = (p - upper_left).abs
-
-              paeth = if pa <= pb && pa <= pc
-                left
-              elsif pb <= pc
-                upper
-              else
-                upper_left
-              end
-
-              row_data[index] = (byte + paeth) % 256
-            end
-          else
-            raise ArgumentError, "Invalid filter algorithm #{filter}"
-          end
+        scanline_length  = (color_bytes + alpha_bytes) * self.width + 1
+        scanlines = @img_data.bytesize / scanline_length
+        pixels = self.width * self.height
 
-          s = []
-          row_data.each_slice pixel_bytes do |slice|
-            s << slice
-          end
-          pixels << s
-          row += 1
-          row_data.clear
-        end
+        data = StringIO.new(@img_data)
+        data.binmode
+
+        color_data = [0x00].pack('C') * (pixels * color_bytes + scanlines)
+        color = StringIO.new(color_data)
+        color.binmode
+
+        @alpha_channel = [0x00].pack('C') * (pixels * alpha_bytes + scanlines)
+        alpha = StringIO.new(@alpha_channel)
+        alpha.binmode
+
+        scanlines.times do |line|
+          data.seek(line * scanline_length)
+
+          filter = data.getbyte
+
+          color.putc filter
+          alpha.putc filter
 
-        # convert the pixel data to separate strings for colours and alpha
-        color_byte_size = self.colors * self.bits / 8
-        alpha_byte_size = alpha_channel_bits / 8
-        pixels.each do |this_row|
-          this_row.each do |pixel|
-            @img_data << pixel[0, color_byte_size].pack("C*")
-            @alpha_channel << pixel[color_byte_size, alpha_byte_size].pack("C*")
+          self.width.times do
+            color.write data.read(color_bytes)
+            alpha.write data.read(alpha_bytes)
           end
         end
 
-        # compress the data
-        @img_data = Zlib::Deflate.deflate(@img_data)
-        @alpha_channel = Zlib::Deflate.deflate(@alpha_channel)
+        @img_data = color_data
       end
     end
   end