image_voodoo 0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Thomas E Enebo <enebo@acm.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,17 @@
+bin/image_voodoo
+Manifest.txt
+Rakefile
+README.txt
+LICENSE.txt
+lib/image_science.rb
+lib/image_voodoo
+lib/image_voodoo/version.rb
+lib/image_voodoo.rb
+samples/bench.rb
+samples/checkerboard.jpg
+samples/file_greyscale.rb
+samples/file_thumbnail.rb
+samples/file_view.rb
+samples/in-memory.rb
+test/pix.png
+test/test_image_science.rb

data/README.txt

@@ -0,0 +1,34 @@
+= ImageVoodoo
+
+== DESCRIPTION:
+
+ImageVoodoo is an Image manipulation library with a ImageScience-compatible API for
+JRuby.
+
+http://jruby-extras.rubyforge.org/image_voodoo/
+
+== FEATURES/PROBLEMS:
+
+* Uses java.awt and javax.image APIs native to Java to perform image manipulation; no other dependencies needed.
+* Includes image_voodoo command-line utility for quick resizing of images, "image_voodoo --help" for usage.
+
+== SYNOPSIS:
+
+  ImageVoodoo.with_image(ARGV[0]) do |img|
+    img.cropped_thumbnail(100) { |img2| img2.save "CTH.jpg" }
+    img.with_crop(100, 200, 400, 600) { |img2| img2.save "CR.jpg" }
+    img.thumbnail(50) { |img2| img2.save "TH.jpg" }
+    img.resize(100, 150) do |img2|
+      img2.save "HEH.jpg"
+      img2.save "HEH.png"
+    end
+  end
+
+
+== REQUIREMENTS:
+
+* JRuby
+
+== INSTALL:
+
+* jruby -S gem install image_voodoo

data/Rakefile

@@ -0,0 +1,27 @@
+MANIFEST = FileList["bin/*", "Manifest.txt", "Rakefile", "README.txt", "LICENSE.txt", "lib/**/*", "samples/*","test/**/*"]
+
+file "Manifest.txt" => :manifest
+task :manifest do
+  File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
+end
+Rake::Task['manifest'].invoke # Always regen manifest, so Hoe has up-to-date list of files
+
+$LOAD_PATH << 'lib'
+require 'image_voodoo/version'
+begin
+  require 'hoe'
+  Hoe.new("image_voodoo", ImageVoodoo::VERSION) do |p|
+    p.rubyforge_name = "jruby-extras"
+    p.url = "http://jruby-extras.rubyforge.org/image_voodoo"
+    p.author = "Thomas Enebo, Charles Nutter and JRuby contributors"
+    p.email = "enebo@acm.org, headius@headius.com"
+    p.summary = "Image manipulation in JRuby with ImageScience compatible API"
+    p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+    p.description = "Install this gem and require 'image_voodoo' to load the library."
+  end.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
+rescue LoadError
+  puts "You need Hoe installed to be able to package this gem"
+rescue => e
+  p e.backtrace
+  puts "ignoring error while loading hoe: #{e.to_s}"
+end

data/bin/image_voodoo

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+actions = []
+images = []
+original_image = nil
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: image_voodoo [actions] image_file"
+  opts.separator "Perform some actions on a source image."
+
+  opts.separator ""
+  opts.separator "Actions are meant to be chained. Examples:"
+  opts.separator "  # Print the dimensions"
+  opts.separator "  image_voodoo --dim small.jpg"
+  opts.separator ""
+  opts.separator "  # Convert to a thumbnail, preview, and then save the result"
+  opts.separator "  image_voodoo --thumb 50 --preview --save thumb.png large.jpg"
+  opts.separator ""
+  opts.separator "  # Convert source to 3 thumbnails, showing dimensions and"
+  opts.separator "  # previewing along the way"
+  opts.separator "  image_voodoo --dim --resize 50x50 --dim --preview --save t1.jpg"
+  opts.separator "    --pop --resize 40x40 --dim --preview --save t2.jpg"
+  opts.separator "    --pop --resize 30x30 --dim --preview --save t3.jpg image.jpg"
+
+  opts.separator ""
+  opts.separator "Actions:"
+
+  opts.on("-d", "--dimensions", "Print the image dimensions") do
+    actions << lambda {|img| puts "#{img.width}x#{img.height}"; img }
+  end
+
+  opts.on("-s", "--save FILENAME", "Save the results to a new file") do |f|
+    actions << lambda {|img| img.save(f); img }
+  end
+
+  opts.on("-t", "--thumbnail SIZE", Integer, "Create a thumbnail of the given size") do |size|
+    actions << lambda {|img| result = nil; img.thumbnail(size) {|img2| result = img2 }; result }
+  end
+
+  opts.on("-p", "--preview", "Preview the image. Close the frame window",
+    "to continue, or quit the application to", "abort the action pipeline") do
+    actions << lambda do |img|
+      done = false
+      img.preview { done = true }
+      Thread.pass until done
+      img
+    end
+  end
+
+  opts.on("--push", "Save the current image to be popped later") do
+    actions << lambda {|img| images << img; img }
+  end
+
+  opts.on("--pop", "Revert back to the previous saved image", "or the original source image") do
+    actions << lambda {|img| images.pop || original_image }
+  end
+
+  opts.on("-r", "--resize WIDTHxHEIGHT", "Create a new image with the specified", "dimensions") do |dim|
+    width, height = dim.split(/x/i).map {|v| v.to_i}
+    opts.usage "You need to specify proper dimensions" unless width && width > 0 && height && height > 0
+    actions << lambda {|img| result = nil; img.resize(width,height) {|img2| result = img2}; result }
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit 0
+  end
+
+  def opts.usage(msg)
+    puts msg
+    puts self
+    exit 1
+  end
+end
+opts.parse!(ARGV)
+opts.usage("You need to supply a source image filename.") unless ARGV.first
+opts.usage("You need to supply one or more actions.") unless actions.size > 0
+
+require 'image_voodoo'
+ImageVoodoo.with_image(ARGV.first) do |img|
+  original_image = img
+  actions.each do |act|
+    img = act.call(img)
+  end
+end
+# Be sure we exit out of swing
+java.lang.System.exit(0)

data/lib/image_science.rb

@@ -0,0 +1,3 @@
+require 'image_voodoo'
+# HA HA...let the pin-pricking begin
+ImageScience = ImageVoodoo

data/lib/image_voodoo/version.rb

@@ -0,0 +1,3 @@
+class ImageVoodoo
+  VERSION = "0.1"
+end

data/lib/image_voodoo.rb

@@ -0,0 +1,152 @@
+# ImageVoodoo is an ImageScience-API-compatible image manipulation library for JRuby.
+#
+# Example of usage:
+#
+#    ImageVoodoo.with_image(ARGV[0]) do |img|
+#      img.cropped_thumbnail(100) { |img2| img2.save "CTH.jpg" }
+#      img.with_crop(100, 200, 400, 600) { |img2| img2.save "CR.jpg" }
+#      img.thumbnail(50) { |img2| img2.save "TH.jpg" }
+#      img.resize(100, 150) do |img2|
+#        img2.save "HEH.jpg"
+#        img2.save "HEH.png"
+#      end
+#    end
+class ImageVoodoo
+  VERSION = "0.1"
+
+  include Java
+
+  import java.awt.RenderingHints
+  import java.awt.geom.AffineTransform
+  import java.awt.image.BufferedImage
+  import javax.imageio.ImageIO
+  import javax.swing.JFrame
+
+  JFile = java.io.File
+  BAIS = java.io.ByteArrayInputStream
+  BAOS = java.io.ByteArrayOutputStream
+
+  class JImagePanel < javax.swing.JPanel
+    def initialize(image, x, y)
+      super()
+      @image, @x, @y = image, x, y
+    end
+    def getPreferredSize
+      java.awt.Dimension.new(@image.width, @image.height)
+    end
+    def paintComponent(graphics)
+      graphics.drawImage(@image, @x, @y, nil)
+    end
+  end
+
+  def initialize(src)
+    @src = src
+  end
+
+  def cropped_thumbnail(size)
+    l, t, r, b, half = 0, 0, width, height, (width - height).abs / 2
+    l, r = half, half + height if width > height
+    t, b = half, half + width if height > width
+
+    with_crop(l, t, r, b) do |img|
+      img.thumbnail(size) { |thumb| yield thumb }
+    end
+  end
+
+  def height
+    @src.height
+  end
+
+  def width
+    @src.width
+  end
+
+  def resize(width, height)
+    target = BufferedImage.new(width, height, BufferedImage::TYPE_INT_RGB)
+    graphics = target.graphics
+    graphics.set_rendering_hint(RenderingHints::KEY_INTERPOLATION,
+                                RenderingHints::VALUE_INTERPOLATION_BICUBIC)
+
+    w_scale = width.to_f / @src.width
+    h_scale = height.to_f / @src.height
+
+    transform = AffineTransform.get_scale_instance w_scale, h_scale
+
+    graphics.draw_rendered_image @src, transform
+    graphics.dispose
+
+    yield ImageVoodoo.new(target)
+  rescue NativeException => ne
+    raise ArgumentError, ne.message
+  end
+
+  def greyscale
+    target = BufferedImage.new(width, height, BufferedImage::TYPE_USHORT_GRAY)
+    graphics = target.graphics
+    graphics.set_rendering_hint(RenderingHints::KEY_INTERPOLATION,
+                                RenderingHints::VALUE_INTERPOLATION_BICUBIC)
+
+    graphics.draw_rendered_image @src, nil
+    graphics.dispose
+
+    yield ImageVoodoo.new(target)
+  end
+
+  def save(file)
+    format = File.extname(file)
+    return false if format == ""
+    format = format[1..-1].downcase
+    ImageIO.write(@src, format, JFile.new(file))
+    true
+  end
+
+  class WindowClosed
+    def initialize(block = nil)
+      @block = block || proc { java.lang.System.exit(0) }
+    end
+    def method_missing(meth,*args); end
+    def windowClosing(event); @block.call; end
+  end
+
+  def preview(&block)
+    frame = JFrame.new("Preview")
+    frame.add_window_listener WindowClosed.new(block)
+    frame.set_bounds 0, 0, width + 20, height + 40
+    frame.add JImagePanel.new(@src, 10, 10)
+    frame.visible = true
+  end
+
+  def bytes(format)
+    out = BAOS.new
+    ImageIO.write(@src, format, out)
+    String.from_java_bytes(out.to_byte_array)
+  end
+
+  def thumbnail(size)
+    scale = size.to_f / (width > height ? width : height)
+    new_width = (width * scale).to_i
+    new_height = (height * scale).to_i
+    resize(new_width, new_height) {|image| yield image }
+  end
+
+  def with_crop(left, top, right, bottom)
+    subimage = @src.get_subimage(left, top, right - left, bottom - top)
+    yield ImageVoodoo.new(subimage)
+  end
+
+  def self.with_image(file)
+    readers = ImageIO.getImageReadersBySuffix(File.extname(file)[1..-1])
+    raise TypeError, "unrecognized format for #{file}" unless readers.hasNext
+    image = ImageIO.read(JFile.new(file))
+    yield ImageVoodoo.new(image)
+  rescue NativeException => ne
+    nil
+  end
+
+  def self.with_bytes(bytes)
+    bytes = bytes.to_java_bytes if String === bytes
+
+    image = ImageIO.read(BAIS.new(bytes))
+    yield ImageVoodoo.new(image)
+  end
+end

data/samples/bench.rb

@@ -0,0 +1,64 @@
+#!/usr/local/bin/ruby -w
+
+require 'benchmark'
+require 'rbconfig'
+require 'rubygems'
+require 'image_science'
+
+max = (ARGV.shift || 100).to_i
+ext = ARGV.shift || "png"
+
+file = "blah_big.#{ext}"
+
+if Config::CONFIG['host_os'] =~ /darwin/ then
+  # how fucking cool is this???
+  puts "taking screenshot for thumbnailing benchmarks"
+  system "screencapture -SC #{file}"
+else
+  abort "You need to plonk down #{file} or buy a mac"
+end unless test ?f, "#{file}"
+
+ImageScience.with_image(file.sub(/#{ext}$/, 'png')) do |img|
+  img.save(file)
+end if ext != "png"
+
+puts "# of iterations = #{max}"
+Benchmark::bm(20) do |x|
+  x.report("null_time") {
+    for i in 0..max do
+      # do nothing
+    end
+  }
+
+  x.report("cropped") {
+    for i in 0..max do
+      ImageScience.with_image(file) do |img|
+        img.cropped_thumbnail(100) do |thumb|
+          thumb.save("blah_cropped.#{ext}")
+        end
+      end
+    end
+  }
+
+  x.report("proportional") {
+    for i in 0..max do
+      ImageScience.with_image(file) do |img|
+        img.thumbnail(100) do |thumb|
+          thumb.save("blah_thumb.#{ext}")
+        end
+      end
+    end
+  }
+
+  x.report("resize") {
+    for i in 0..max do
+      ImageScience.with_image(file) do |img|
+        img.resize(200, 200) do |resize|
+          resize.save("blah_resize.#{ext}")
+        end
+      end
+    end
+  }
+end
+
+# File.unlink(*Dir["blah*#{ext}"])

data/samples/file_greyscale.rb

@@ -0,0 +1,13 @@
+require 'image_voodoo'
+
+# reads in the file specified by ARGV[0], transforming to greyscale and
+# writing to the file specified by ARGV[1]
+ImageVoodoo.with_image(ARGV[0]) do |img|
+  img.greyscale do |img2|
+    if ARGV[1]
+      img2.save(ARGV[1])
+    else
+      img2.preview
+    end
+  end
+end

data/samples/file_thumbnail.rb

@@ -0,0 +1,14 @@
+require 'image_science'
+
+# reads in the file specified by ARGV[0], transforms it into a 32-pixel thumbnail,
+# and writes it out to the file specified by ARGV[1], using that extension as the
+# target format.
+ImageScience.with_image(ARGV[0]) do |img|
+  img.thumbnail(32) do |img2|
+    if ARGV[1]
+      img2.save(ARGV[1])
+    else
+      img2.preview
+    end
+  end
+end

data/samples/file_view.rb

@@ -0,0 +1,6 @@
+require 'image_voodoo'
+
+# preview the file specified by ARGV[0] in a swing window
+ImageVoodoo.with_image(ARGV[0]) do |img|
+  img.preview
+end

data/samples/in-memory.rb

@@ -0,0 +1,11 @@
+require 'image_voodoo'
+
+# reads in the image at ARGV[0], transforms it into a 32-pixel thumbnail in-memory,
+# and writes it back out as a png to the file specified by ARGV[1]
+ImageVoodoo.with_bytes(File.read(ARGV[0])) do |img|
+  img.thumbnail(32) do |img2|
+    File.open(ARGV[1], 'w') do |file|
+      file.write(img2.bytes('png'))
+    end
+  end
+end

data/test/test_image_science.rb

@@ -0,0 +1,124 @@
+require 'test/unit/testcase'
+require 'test/unit' if $0 == __FILE__
+require 'image_science'
+
+class TestImageScience < Test::Unit::TestCase
+  def deny x; assert ! x; end
+
+  def setup
+    @path = 'test/pix.png'
+    @tmppath = 'test/pix-tmp.png'
+    @h = @w = 50
+  end
+
+  def teardown
+    File.unlink @tmppath if File.exist? @tmppath
+  end
+
+  def test_class_with_image
+    ImageScience.with_image @path do |img|
+      assert_kind_of ImageScience, img
+      assert_equal @h, img.height
+      assert_equal @w, img.width
+      assert img.save(@tmppath)
+    end
+
+    assert File.exists?(@tmppath)
+
+    ImageScience.with_image @tmppath do |img|
+      assert_kind_of ImageScience, img
+      assert_equal @h, img.height
+      assert_equal @w, img.width
+    end
+  end
+
+  def test_class_with_image_missing
+    assert_raises TypeError do
+      ImageScience.with_image @path + "nope" do |img|
+        flunk
+      end
+    end
+  end
+
+  def test_class_with_image_missing_with_img_extension
+    assert_nil ImageScience.with_image("nope#{@path}") do |img|
+      flunk
+    end
+  end
+
+  def test_resize
+    ImageScience.with_image @path do |img|
+      img.resize(25, 25) do |thumb|
+        assert thumb.save(@tmppath)
+      end
+    end
+
+    assert File.exists?(@tmppath)
+
+    ImageScience.with_image @tmppath do |img|
+      assert_kind_of ImageScience, img
+      assert_equal 25, img.height
+      assert_equal 25, img.width
+    end
+  end
+
+  def test_resize_floats
+    ImageScience.with_image @path do |img|
+      img.resize(25.2, 25.7) do |thumb|
+        assert thumb.save(@tmppath)
+      end
+    end
+
+    assert File.exists?(@tmppath)
+
+    ImageScience.with_image @tmppath do |img|
+      assert_kind_of ImageScience, img
+      assert_equal 25, img.height
+      assert_equal 25, img.width
+    end
+  end
+
+  def test_resize_zero
+    assert_raises ArgumentError do
+      ImageScience.with_image @path do |img|
+        img.resize(0, 25) do |thumb|
+          assert thumb.save(@tmppath)
+        end
+      end
+    end
+
+    deny File.exists?(@tmppath)
+
+    assert_raises ArgumentError do
+      ImageScience.with_image @path do |img|
+        img.resize(25, 0) do |thumb|
+          assert thumb.save(@tmppath)
+        end
+      end
+    end
+
+    deny File.exists?(@tmppath)
+  end
+
+  def test_resize_negative
+    assert_raises ArgumentError do
+      ImageScience.with_image @path do |img|
+        img.resize(-25, 25) do |thumb|
+          assert thumb.save(@tmppath)
+        end
+      end
+    end
+
+    deny File.exists?(@tmppath)
+
+    assert_raises ArgumentError do
+      ImageScience.with_image @path do |img|
+        img.resize(25, -25) do |thumb|
+          assert thumb.save(@tmppath)
+        end
+      end
+    end
+
+    deny File.exists?(@tmppath)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: image_voodoo
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Thomas Enebo, Charles Nutter and JRuby contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Install this gem and require 'image_voodoo' to load the library.
+email: enebo@acm.org, headius@headius.com
+executables: 
+- image_voodoo
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+files: 
+- bin/image_voodoo
+- Manifest.txt
+- Rakefile
+- README.txt
+- LICENSE.txt
+- lib/image_science.rb
+- lib/image_voodoo
+- lib/image_voodoo/version.rb
+- lib/image_voodoo.rb
+- samples/bench.rb
+- samples/checkerboard.jpg
+- samples/file_greyscale.rb
+- samples/file_thumbnail.rb
+- samples/file_view.rb
+- samples/in-memory.rb
+- test/pix.png
+- test/test_image_science.rb
+has_rdoc: true
+homepage: http://jruby-extras.rubyforge.org/image_voodoo
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: jruby-extras
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Image manipulation in JRuby with ImageScience compatible API
+test_files: 
+- test/test_image_science.rb