dball-zoomifier 1.2

data/README.txt

@@ -0,0 +1,4 @@
+Zoomifier is a ruby library for creating directories of tiled images
+suitable for viewing with the free Zoomify flash player:
+
+http://www.zoomify.com/

data/bin/zoomify

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'zoomifier'
+Zoomifier::zoomify(ARGV[0])

data/lib/zoomifier.rb

@@ -0,0 +1,182 @@
+require 'fileutils'
+require 'open-uri'
+require 'rubygems'
+require 'rmagick'
+
+# Breaks up images into tiles suitable for viewing with Zoomify.
+# See http://zoomify.com/ for more details.
+#
+# @author Donald A. Ball Jr. <donald.ball@gmail.com>
+# @version 1.2
+# @copyright (C) 2008 Donald A. Ball Jr.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module Zoomifier
+
+  TILESIZE = 256
+
+  # Zoomifies the image file specified by filename. The zoomified directory
+  # name will be the filename without its extension, e.g. 5.jpg will be
+  # zoomified into a directory named 5. If there is already a directory with
+  # this name, it will be destroyed without mercy.
+  def self.zoomify(filename)
+    raise ArgumentError unless filename && File.file?(filename)
+    #filename = File.expand_path(filename)
+    outputdir = File.dirname(filename) + '/' + File.basename(filename, '.*')
+    raise ArgumentError unless filename != outputdir
+    FileUtils.rm_rf(outputdir) if File.exists?(outputdir)
+    Dir.mkdir(outputdir)
+    tmpdir = "#{outputdir}/tmp"
+    Dir.mkdir(tmpdir)
+    tilesdir = nil
+    image = Magick::Image.read(filename).first.strip!
+    # Each level of zoom is a factor of 2. Here we obtain the number of zooms
+    # allowed by the original file dimensions and the constant tile size.
+    levels = (Math.log([image.rows, image.columns].max.to_f / TILESIZE) / Math.log(2)).ceil
+    tiles = 0
+    (0..levels).each do |level|
+      n = levels - level
+      # Obtain the image to tile for this level. The 0th level should consist
+      # of one tile, while the highest level should be the original image.
+      level_image = image.resize(image.columns >> n, image.rows >> n)
+      tiles(tmpdir, level, level_image) do |filename|
+        # The tile images are chunked into directories named TileGroupN, N
+        # starting at 0 and increasing monotonically. Each directory contains
+        # at most 256 images. The images are sorted by level, tile row, and
+        # tile column.
+        div, mod = tiles.divmod(256)
+        if mod == 0
+          tilesdir = "#{outputdir}/TileGroup#{div}"
+          Dir.mkdir(tilesdir)
+        end
+        FileUtils.mv("#{tmpdir}/#{filename}", "#{tilesdir}/#{filename}")
+        tiles += 1
+      end
+      # Rmagick needs a bit of help freeing image memory.
+      level_image = nil
+      GC.start
+    end
+    File.open("#{outputdir}/ImageProperties.xml", 'w') do |f|
+      f.write("<IMAGE_PROPERTIES WIDTH=\"#{image.columns}\" HEIGHT=\"#{image.rows}\" NUMTILES=\"#{tiles}\" NUMIMAGES=\"1\" VERSION=\"1.8\" TILESIZE=\"#{TILESIZE}\" />")
+    end
+    Dir.rmdir(tmpdir)
+    outputdir
+  end
+
+  # Splits the given image up into images of TILESIZE, writes them to the
+  # given directory, and yields their names
+  def self.tiles(dir, level, image)
+    slice(image.rows).each_with_index do |y_slice, j|
+      slice(image.columns).each_with_index do |x_slice, i|
+        # The images are named "level-column-row.jpg"
+        filename = "#{level}-#{i}-#{j}.jpg"
+        tile_image = image.crop(x_slice[0], y_slice[0], x_slice[1], y_slice[1])
+        tile_image.write("#{dir}/#{filename}") do
+          # FIXME - the images end up being 4-5x larger than those produced
+          # by Zoomifier EZ and friends... no idea why just yet, except to note
+          # that the density of these tiles ends up being 400x400, while
+          # everybody else produces tiles at 72x72. Can't see why that would
+          # matter though...
+          self.quality = 80 
+        end
+        # Rmagick needs a bit of help freeing image memory.
+        tile_image = nil
+        GC.start
+        yield filename
+      end
+    end
+  end
+
+  # Returns an array of slices ([offset, length]) obtained by slicing the
+  # given number by TILESIZE.
+  # E.g. 256 -> [[0, 256]], 257 -> [[0, 256], [256, 1]],
+  #      513 -> [[0, 256], [256, 256], [512, 1]]
+  def self.slice(n)
+    results = []
+    i = 0
+    while true
+      if i + TILESIZE >= n
+        results << [i, n-i]
+        break
+      else
+        results << [i, TILESIZE]
+        i += TILESIZE
+      end
+    end
+    results
+  end
+
+  def self.unzoomify(url)
+    tmpdir = 'tmp'
+    FileUtils.rm_rf(tmpdir) if File.exists?(tmpdir)
+    Dir.mkdir(tmpdir)
+    doc = nil
+    begin
+      open("#{url}/ImageProperties.xml") do |f|
+        doc = REXML::Document.new(f)
+      end
+    rescue OpenURI::HTTPError
+      return nil
+    end
+    attrs = doc.root.attributes
+    return nil unless attrs['TILESIZE'] == '256' && attrs['VERSION'] == '1.8'
+    width = attrs['WIDTH'].to_i
+    height = attrs['HEIGHT'].to_i
+    tiles = attrs['NUMTILES'].to_i
+    image_paths = (0 .. tiles/256).map {|n| "TileGroup#{n}"}
+    max_level = 0
+    while (get_tile(url, image_paths, tmpdir, "#{max_level}-0-0.jpg"))
+      max_level += 1
+    end
+    max_level -= 1
+    image = Magick::Image.new(width, height)
+    (0 .. width / TILESIZE).each do |column|
+      (0 .. height / TILESIZE).each do |row|
+        filename = "#{max_level}-#{column}-#{row}.jpg"
+        get_tile(url, image_paths, tmpdir, filename)
+        tile_image = Magick::Image.read("#{tmpdir}/#{filename}").first
+        image.composite!(tile_image, column*TILESIZE, row*TILESIZE, Magick::OverCompositeOp)
+        time_image = nil
+        GC.start
+      end
+    end
+    # FIXME - get filename from the url
+    image.write('file.jpg') { self.quality = 90 }
+    image = nil
+    GC.start
+    FileUtils.rm_rf(tmpdir)
+  end
+
+  # TODO - could reduce the miss rate by using heuristics to guess the
+  # proper path from which to download the file
+  def self.get_tile(url, image_paths, tmpdir, filename)
+    image_paths.each do |path|
+      begin
+        open("#{tmpdir}/#{filename}", 'wb') {|f| f.write(open("#{url}/#{path}/#{filename}").read)}
+        return filename
+      rescue OpenURI::HTTPError
+      end
+    end
+    nil
+  end 
+  
+end
+
+if __FILE__ == $0
+  if ARGV.length == 1
+    Zoomifier::zoomify(ARGV[0])
+  else
+    puts "Usage: zoomify filename"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib/')

data/spec/zoomifier_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'zoomifier'
+
+describe Zoomifier do
+  it "should respond to its main method" do
+    Zoomifier.should respond_to(:zoomify)
+  end
+
+  describe "On a 1024x768 JPEG file" do
+    before(:all) do
+      @input = File.dirname(__FILE__) + '/data/1024x768.jpg'
+      @output = File.dirname(__FILE__) + '/data/1024x768/'
+      @tiles = %w[0-0-0.jpg 1-1-1.jpg 2-1-0.jpg 2-2-1.jpg 2-3-2.jpg
+                  1-0-0.jpg 2-0-0.jpg 2-1-1.jpg 2-2-2.jpg
+                  1-0-1.jpg 2-0-1.jpg 2-1-2.jpg 2-3-0.jpg
+                  1-1-0.jpg 2-0-2.jpg 2-2-0.jpg 2-3-1.jpg]
+      FileUtils.rm_rf(@output)
+      Zoomifier::zoomify(@input)
+    end
+
+    after(:all) do
+      FileUtils.rm_rf(@output)
+    end
+
+    it "should create the output directory" do
+      File.directory?(@output).should be_true
+    end
+
+    it "should create the image properties file" do
+      File.file?(@output + '/ImageProperties.xml').should be_true
+    end
+
+    it "should create a tile group directory" do
+      File.directory?(@output + '/TileGroup0/').should be_true
+    end
+
+    it "should create the tiled images" do
+      tile_images = Dir.entries(@output + '/TileGroup0/').reject {|f| f.match(/^\./)}
+      tile_images.sort.should == @tiles.sort
+      tile_images.each do |file|
+        image = Magick::Image.read(@output + '/TileGroup0/' + file).first
+        image.rows.should <= 256
+        image.columns.should <= 256
+      end
+    end
+  end
+
+  describe "On a 2973x2159 JPEG file" do
+    before(:all) do
+      @input = File.dirname(__FILE__) + '/data/2973x2159.jpg'
+      @output = File.dirname(__FILE__) + '/data/2973x2159/'
+      @tiles = %w[
+      0-0-0.jpg 3-3-2.jpg   4-10-0.jpg  4-3-4.jpg   4-6-8.jpg
+      1-0-0.jpg 3-3-3.jpg   4-10-1.jpg  4-3-5.jpg   4-7-0.jpg
+      1-0-1.jpg 3-3-4.jpg   4-10-2.jpg  4-3-6.jpg   4-7-1.jpg
+      1-1-0.jpg 3-4-0.jpg   4-10-3.jpg  4-3-7.jpg   4-7-2.jpg
+      1-1-1.jpg 3-4-1.jpg   4-10-4.jpg  4-3-8.jpg   4-7-3.jpg
+      2-0-0.jpg 3-4-2.jpg   4-10-5.jpg  4-4-0.jpg   4-7-4.jpg
+      2-0-1.jpg 3-4-3.jpg   4-10-6.jpg  4-4-1.jpg   4-7-5.jpg
+      2-0-2.jpg 3-4-4.jpg   4-10-7.jpg  4-4-2.jpg   4-7-6.jpg
+      2-1-0.jpg 3-5-0.jpg   4-10-8.jpg  4-4-3.jpg   4-7-7.jpg
+      2-1-1.jpg 3-5-1.jpg   4-11-0.jpg  4-4-4.jpg   4-7-8.jpg
+      2-1-2.jpg 3-5-2.jpg   4-11-1.jpg  4-4-5.jpg   4-8-0.jpg
+      2-2-0.jpg 3-5-3.jpg   4-11-2.jpg  4-4-6.jpg   4-8-1.jpg
+      2-2-1.jpg 3-5-4.jpg   4-11-3.jpg  4-4-7.jpg   4-8-2.jpg
+      2-2-2.jpg 4-0-0.jpg   4-11-4.jpg  4-4-8.jpg   4-8-3.jpg
+      3-0-0.jpg 4-0-1.jpg   4-11-5.jpg  4-5-0.jpg   4-8-4.jpg
+      3-0-1.jpg 4-0-2.jpg   4-11-6.jpg  4-5-1.jpg   4-8-5.jpg
+      3-0-2.jpg 4-0-3.jpg   4-11-7.jpg  4-5-2.jpg   4-8-6.jpg
+      3-0-3.jpg 4-0-4.jpg   4-11-8.jpg  4-5-3.jpg   4-8-7.jpg
+      3-0-4.jpg 4-0-5.jpg   4-2-0.jpg   4-5-4.jpg   4-8-8.jpg
+      3-1-0.jpg 4-0-6.jpg   4-2-1.jpg   4-5-5.jpg   4-9-0.jpg
+      3-1-1.jpg 4-0-7.jpg   4-2-2.jpg   4-5-6.jpg   4-9-1.jpg
+      3-1-2.jpg 4-0-8.jpg   4-2-3.jpg   4-5-7.jpg   4-9-2.jpg
+      3-1-3.jpg 4-1-0.jpg   4-2-4.jpg   4-5-8.jpg   4-9-3.jpg
+      3-1-4.jpg 4-1-1.jpg   4-2-5.jpg   4-6-0.jpg   4-9-4.jpg
+      3-2-0.jpg 4-1-2.jpg   4-2-6.jpg   4-6-1.jpg   4-9-5.jpg
+      3-2-1.jpg 4-1-3.jpg   4-2-7.jpg   4-6-2.jpg   4-9-6.jpg
+      3-2-2.jpg 4-1-4.jpg   4-2-8.jpg   4-6-3.jpg   4-9-7.jpg
+      3-2-3.jpg 4-1-5.jpg   4-3-0.jpg   4-6-4.jpg   4-9-8.jpg
+      3-2-4.jpg 4-1-6.jpg   4-3-1.jpg   4-6-5.jpg
+      3-3-0.jpg 4-1-7.jpg   4-3-2.jpg   4-6-6.jpg
+      3-3-1.jpg 4-1-8.jpg   4-3-3.jpg   4-6-7.jpg]
+      FileUtils.rm_rf(@output)
+      Zoomifier::zoomify(@input)
+    end
+
+    after(:all) do
+      FileUtils.rm_rf(@output)
+    end
+
+    it "should create the output directory" do
+      File.directory?(@output).should be_true
+    end
+
+    it "should create the image properties file" do
+      File.file?(@output + '/ImageProperties.xml').should be_true
+    end
+
+    it "should create a tile group directory" do
+      File.directory?(@output + '/TileGroup0/').should be_true
+    end
+
+    it "should create the tiled images" do
+      tile_images = Dir.entries(@output + '/TileGroup0/').reject {|f| f.match(/^\./)}
+      tile_images.sort.should == @tiles.sort
+      tile_images.each do |file|
+        image = Magick::Image.read(@output + '/TileGroup0/' + file).first
+        image.rows.should <= 256
+        image.columns.should <= 256
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: dball-zoomifier
+version: !ruby/object:Gem::Version 
+  version: "1.2"
+platform: ruby
+authors: 
+- Donald Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-21 00:00:00 -08:00
+default_executable: zoomify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: donald.ball@gmail.com
+executables: 
+- zoomify
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/zoomifier.rb
+- bin/zoomify
+- spec/zoomifier_spec.rb
+- spec/spec_helper.rb
+- spec/data/1024x768.jpg
+- spec/data/2973x2159.jpg
+- README.txt
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for zoomifying images
+test_files: 
+- spec/zoomifier_spec.rb