origami 1.0.2

data/origami/filters/predictors.rb

@@ -0,0 +1,276 @@
+=begin
+
+= File
+	filters/predictors.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume Delugré <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+module Origami
+
+  module Filter
+    
+    class PredictorError < Exception #:nodoc:
+    end
+    
+    module Predictor
+      
+      NONE = 1
+      TIFF = 2
+      PNG_NONE = 10
+      PNG_SUB = 11
+      PNG_UP = 12
+      PNG_AVERAGE = 13
+      PNG_PAETH = 14
+      PNG_OPTIMUM = 15
+
+      def self.do_pre_prediction(data, predictor = NONE, colors = 1, bpc = 8, columns = 1)
+      
+        return data if predictor == NONE
+
+        unless (1..4) === colors.to_i
+          raise PredictorError, "Colors must be between 1 and 4"
+        end
+
+        unless [1,2,4,8,16].include?(bpc.to_i)
+          raise PredictorError, "BitsPerComponent must be in 1, 2, 4, 8 or 16"
+        end
+
+        # components per line
+        nvals = columns * colors
+
+        # bytes per pixel
+        bpp = (colors * bpc + 7) >> 3
+
+        # bytes per row
+        bpr = (nvals * bpc + 7) >> 3
+
+        unless data.size % bpr == 0
+          raise PredictorError, "Invalid data size #{data.size}, should be multiple of bpr=#{bpr}"
+        end
+
+        if predictor == TIFF
+          do_tiff_pre_prediction(data, colors, bpc, columns)
+        elsif predictor >= 10 # PNG
+          do_png_pre_prediction(data, predictor, bpp, bpr)
+        else
+          raise PredictorError, "Unknown predictor : #{predictor}"
+        end
+     end
+
+      def self.do_post_prediction(data, predictor = NONE, colors = 1, bpc = 8, columns = 1)
+
+        return data if predictor == NONE
+
+        unless (1..4) === colors
+          raise PredictorError, "Colors must be between 1 and 4"
+        end
+
+        unless [1,2,4,8,16].include?(bpc)
+          raise PredictorError, "BitsPerComponent must be in 1, 2, 4, 8 or 16"
+        end
+
+        # components per line
+        nvals = columns * colors
+
+        # bytes per pixel
+        bpp = (colors * bpc + 7) >> 3
+
+        # bytes per row
+        bpr = ((nvals * bpc + 7) >> 3) + 1
+
+        if predictor == TIFF
+          do_tiff_post_prediction(data, colors, bpc, columns)
+        elsif predictor >= 10 # PNG
+          do_png_post_prediction(data, bpp, bpr)
+        else
+          raise PredictorError, "Unknown predictor : #{predictor}"
+        end
+      end
+
+      def self.do_png_post_prediction(data, bpp, bpr)
+
+        result = ""
+        uprow = "\0" * bpr
+        thisrow = "\0" * bpr
+        nrows = (data.size + bpr - 1) / bpr
+        
+        nrows.times do |irow|
+
+          line = data[irow * bpr, bpr]
+          predictor = 10 + line[0].ord
+          line[0] = "\0"
+
+          for i in (1..line.size-1)
+            up = uprow[i].ord
+
+            if bpp > i
+              left = upleft = 0
+            else
+              left = line[i-bpp].ord
+              upleft = uprow[i-bpp].ord
+            end
+
+            case predictor
+              when PNG_NONE
+                thisrow = line 
+              when PNG_SUB
+                thisrow[i] = ((line[i].ord + left) & 0xFF).chr
+              when PNG_UP
+                thisrow[i] = ((line[i].ord + up) & 0xFF).chr
+              when PNG_AVERAGE
+                thisrow[i] = ((line[i].ord + ((left + up) / 2)) & 0xFF).chr
+              when PNG_PAETH
+                p = left + up - upleft
+                pa, pb, pc = (p - left).abs, (p - up).abs, (p - upleft).abs
+
+                thisrow[i] = ((line[i].ord + 
+                  case [ pa, pb, pc ].min
+                    when pa then left
+                    when pb then up
+                    when pc then upleft
+                  end
+                ) & 0xFF).chr
+            else
+              puts "Unknown PNG predictor : #{predictor}"
+              thisrow = line
+            end
+            
+          end
+
+          result << thisrow[1..-1]
+          uprow = thisrow
+        end
+  
+        result
+      end
+
+      def self.do_png_pre_prediction(data, predictor, bpp, bpr)
+        
+        result = ""
+        nrows = data.size / bpr
+
+        line = "\0" + data[-bpr, bpr]
+        
+        (nrows-1).downto(0) do |irow|
+
+          uprow = 
+          if irow == 0 
+            "\0" * (bpr+1) 
+          else 
+            "\0" + data[(irow-1)*bpr,bpr]
+          end
+
+          bpr.downto(1) do |i|
+
+            up = uprow[i].ord
+            left = line[i-bpp].ord
+            upleft = uprow[i-bpp].ord
+
+            case predictor
+              when PNG_SUB
+                line[i] = ((line[i].ord - left) & 0xFF).chr
+              when PNG_UP
+                line[i] = ((line[i].ord - up) & 0xFF).chr
+              when PNG_AVERAGE
+                line[i] = ((line[i].ord - ((left + up) / 2)) & 0xFF).chr
+              when PNG_PAETH
+                p = left + up - upleft
+                pa, pb, pc = (p - left).abs, (p - up).abs, (p - upleft).abs
+
+                line[i] = ((line[i].ord - 
+                case [ pa, pb, pc ].min
+                  when pa then left
+                  when pb then up
+                  when pc then upleft
+                end
+                ) & 0xFF).chr
+              when PNG_NONE
+            else
+              raise PredictorError, "Unsupported PNG predictor : #{predictor}"
+            end
+            
+          end
+          
+          line[0] = (predictor - 10).chr
+          result = line + result
+          
+          line = uprow
+        end
+  
+        result
+      end
+
+      def self.do_tiff_post_prediction(data, colors, bpc, columns) #:nodoc:
+
+        bpr = (colors * bpc * columns + 7) >> 3
+        nrows = data.size / bpr
+        bitmask = (1 << bpc) - 1
+        result = Utils::BitWriter.new
+
+        nrows.times do |irow|
+          line = Utils::BitReader.new(data[irow * bpr, bpr])
+
+          pixel = ::Array.new(colors, 0)
+          columns.times do
+            diffpixel = ::Array.new(colors) { line.read(bpc) }
+            pixel = pixel.zip(diffpixel).map!{|c, diff| (c + diff) & bitmask}
+            
+            pixel.each do |c|
+              result.write(c, bpc)
+            end
+          end
+          
+          result.final
+        end
+
+        result.final.to_s
+      end
+
+      def self.do_tiff_pre_prediction(data, colors, bpc, columns) #:nodoc:
+
+        bpr = (colors * bpc * columns + 7) >> 3
+        nrows = data.size / bpr
+        bitmask = (1 << bpc) - 1
+        result = Utils::BitWriter.new
+
+        nrows.times do |irow|
+          line = Utils::BitReader.new(data[irow * bpr, bpr])
+
+          diffpixel = ::Array.new(colors, 0)
+          columns.times do
+            pixel = ::Array.new(colors) { line.read(bpc) }
+            diffpixel = diffpixel.zip(pixel).map!{|diff, c| (c - diff) & bitmask}
+            
+            diffpixel.each do |c|
+              result.write(c, bpc)
+            end
+          end
+          
+          result.final
+        end
+       
+        result.final.to_s
+      end
+    end
+
+  end
+end
+

data/origami/filters/runlength.rb

@@ -0,0 +1,117 @@
+=begin
+
+= File
+	filters/runlength.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume Delugré <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+module Origami
+  
+  module Filter
+    
+    class InvalidRunLengthDataError < Exception #:nodoc:
+    end
+    
+    #
+    # Class representing a Filter used to encode and decode data using RLE compression algorithm.
+    #
+    class RunLength
+      include Filter
+      
+      EOD = 128 #:nodoc:
+      
+      #
+      # Encodes data using RLE compression method.
+      # _stream_:: The data to encode.
+      #
+      def encode(stream)
+
+        result = ""
+        i = 0
+
+        while i < stream.size
+          
+          #
+          # How many identical bytes coming?
+          #
+          length = 1
+          while i+1 < stream.size and length < EOD and stream[i] == stream[i+1]
+            length = length + 1
+            i = i + 1
+          end
+
+          #
+          # If more than 1, then compress them.
+          #
+          if length > 1
+            result << (257 - length).chr << stream[i,1]
+
+          #
+          # Otherwise how many different bytes to copy ?
+          #
+          else
+            j = i
+            while j+1 < stream.size and (j - i + 1) < EOD and stream[j] != stream[j+1]
+              j = j + 1
+            end
+
+            length = j - i
+            result << length.chr << stream[i, length+1]
+
+            i = j
+          end
+
+          i = i + 1
+        end
+
+        result << EOD.chr
+      end
+
+
+      #
+      # Decodes data using RLE decompression method.
+      # _stream_:: The data to decode.
+      #
+      def decode(stream)
+        raise InvalidRunLengthDataError, "No end marker" unless stream.include?(EOD.chr)
+        
+        i = 0
+        result = ""
+        until stream[i].ord == EOD do
+        
+          length = stream[i]
+          if length < EOD
+            result << stream[i + 1, length + 1]
+            i = i + length + 2
+          else
+            result << stream[i + 1,1] * (257 - length)
+            i = i + 2
+          end
+          
+        end
+        
+        result
+      end
+
+    end
+  end
+end
+

data/origami/font.rb

@@ -0,0 +1,209 @@
+=begin
+
+= File
+	font.rb
+
+= Info
+	This file is part of Origami, PDF manipulation framework for Ruby
+	Copyright (C) 2010	Guillaume Delugr� <guillaume@security-labs.org>
+	All right reserved.
+	
+  Origami is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  Origami is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+module Origami
+
+  #
+  # Class representing a rendering font in a document.
+  #
+  class Font < Dictionary
+    
+    include StandardObject
+   
+    field   :Type,                    :Type => Name, :Default => :Font, :Required => true
+    field   :Subtype,                 :Type => Name, :Default => :Type1, :Required => true
+    field   :Name,                    :Type => Name
+    field   :FirstChar,               :Type => Integer
+    field   :LastChar,                :Type => Integer
+    field   :Widths,                  :Type => Array
+    field   :FontDescriptor,          :Type => Dictionary
+    field   :Encoding,                :Type => [ Name, Dictionary ], :Default => :MacRomanEncoding
+    field   :ToUnicode,               :Type => Stream, :Version => "1.2"
+   
+    # TODO: Type0 and CID Fonts
+
+    #
+    # Type1 Fonts.
+    #
+    class Type1 < Font
+
+      field   :BaseFont,              :Type => Name, :Default => :Helvetica, :Required => true
+      field   :Subtype,               :Type => Name, :Default => :Type1, :Required => true
+      
+      #
+      # 14 standard Type1 fonts.
+      #
+      module Standard
+        
+        class TimesRoman < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Times-Roman", :Required => true
+        end
+
+        class Helvetica < Type1
+          field   :BaseFont,          :Type => Name, :Default => :Helvetica, :Required => true
+        end
+
+        class Courier < Type1
+          field   :BaseFont,          :Type => Name, :Default => :Courier, :Required => true
+        end
+
+        class Symbol < Type1
+          field   :BaseFont,          :Type => Name, :Default => :Symbol, :Required => true
+        end
+
+        class TimesBold < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Times-Bold", :Required => true
+        end
+
+        class HelveticaBold < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Bold", :Required => true
+        end
+
+        class CourierBold < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Courier-Bold", :Required => true
+        end
+
+        class ZapfDingbats < Type1
+          field   :BaseFont,          :Type => Name, :Default => :ZapfDingbats, :Required => true
+        end
+
+        class TimesItalic < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Times-Italic", :Required => true
+        end
+
+        class HelveticaOblique < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Oblique", :Required => true
+        end
+
+        class CourierOblique < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Courier-Oblique", :Required => true
+        end
+
+        class TimesBoldItalic < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Times-BoldItalic", :Required => true
+        end
+
+        class HelveticaBoldOblique < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-BoldOblique", :Required => true
+        end
+
+        class CourierBoldOblique < Type1
+          field   :BaseFont,          :Type => Name, :Default => :"Courier-BoldOblique", :Required => true
+        end
+
+      end
+
+    end
+
+    #
+    # TrueType Fonts
+    #
+    class TrueType < Font
+      field   :Subtype,               :Type => Name, :Default => :TrueType, :Required => true
+    end
+
+    #
+    # Type 3 Fonts
+    #
+    class Type3 < Font
+
+      field   :Subtype,               :Type => Name, :Default => :Type3, :Required => true
+      field   :FontBBox,              :Type => Array, :Required => true
+      field   :FontMatrix,            :Type => Array, :Required => true
+      field   :CharProcs,             :Type => Dictionary, :Required => true
+      field   :Resources,             :Type => Dictionary, :Version => "1.2"
+
+    end
+
+  end
+
+  #
+  # Embedded font stream.
+  #
+  class FontStream < Stream
+    
+    field   :Subtype,                 :Type => Name
+    field   :Length1,                 :Type => Integer
+    field   :Length2,                 :Type => Integer
+    field   :Length3,                 :Type => Integer
+
+  end
+  
+  #
+  # Class representing a font details in a document.
+  #
+  class FontDescriptor < Dictionary
+    
+    include StandardObject
+    
+    FIXEDPITCH  = 1 << 1
+    SERIF       = 1 << 2
+    SYMBOLIC    = 1 << 3
+    SCRIPT      = 1 << 4
+    NONSYMBOLIC = 1 << 6
+    ITALIC      = 1 << 7
+    ALLCAP      = 1 << 17
+    SMALLCAP    = 1 << 18
+    FORCEBOLD   = 1 << 19
+
+    field   :Type,                    :Type => Name, :Default => :FontDescriptor, :Required => true
+    field   :FontName,                :Type => Name, :Required => true
+    field   :FontFamily,              :Type => ByteString, :Version => "1.5"
+    field   :FontStretch,             :Type => Name, :Default => :Normal, :Version => "1.5"
+    field   :FontWeight,              :Type => Integer, :Default => 400, :Version => "1.5"
+    field   :Flags,                   :Type => Integer, :Required => true
+    field   :FontBBox,                :Type => Array
+    field   :ItalicAngle,             :Type => Number, :Required => true
+    field   :Ascent,                  :Type => Number
+    field   :Descent,                 :Type => Number
+    field   :Leading,                 :Type => Number, :Default => 0
+    field   :CapHeight,               :Type => Number
+    field   :XHeight,                 :Type => Number, :Default => 0
+    field   :StemV,                   :Type => Number
+    field   :StemH,                   :Type => Number, :Default => 0
+    field   :AvgWidth,                :Type => Number, :Default => 0
+    field   :MaxWidth,                :Type => Number, :Default => 0
+    field   :MissingWidth,            :Type => Number, :Default => 0
+    field   :FontFile,                :Type => Stream
+    field   :FontFile2,               :Type => Stream, :Version => "1.1"
+    field   :FontFile3,               :Type => Stream, :Version => "1.2"
+    field   :CharSet,                 :Type => ByteString, :Version => "1.1"
+    
+  end
+  
+  #
+  # Class representing a character encoding in a document.
+  #
+  class Encoding < Dictionary
+    
+    include StandardObject
+
+    field   :Type,                    :Type => Name, :Default => :Encoding
+    field   :BaseEncoding,            :Type => Name
+    field   :Differences,             :Type => Array
+   
+  end
+ 
+end