image_science 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,15 @@
+== 1.1.1 / 2007-03-08
+
+* 5 minor enhancements:
+  * Added error handler that raises with information about what went wrong.
+  * thumbnail is now pure ruby, everything now uses resize.
+  * Produces cleaner JPEG files, with a small cost to file size/speed.
+  * resize now uses Catmull-Rom spline filter for better quality.
+  * resize copies existing ICC Profile to thumbnail, producing better color.
+  * ICC Profile NOT copied for PNG as it seems to be buggy.
+* 1 bug fix:
+  * Fixed rdoc
+
 == 1.1.0 / 2007-01-05
 
 * 3 major enhancements:

data/README.txt

@@ -1,6 +1,6 @@
 ImageScience
+    http://seattlerb.rubyforge.org/ImageScience.html
     http://rubyforge.org/projects/seattlerb
-    http://seattlerb.rubyforge.org/
     by Ryan Davis
 
 == DESCRIPTION:
@@ -13,18 +13,20 @@ For more information including build steps, see http://seattlerb.rubyforge.org/
 
 == FEATURES/PROBLEMS:
 
-* 93 glorious lines of graphics manipulation magi... errr, SCIENCE!
-* Supports both square and proportional thumbnails.
+* Glorious graphics manipulation magi... errr, SCIENCE! in less than 200 LoC!
+* Supports square and proportional thumbnails, as well as arbitrary resizes.
 * Pretty much any graphics format you could want. No really.
 
 == SYNOPSYS:
 
   ImageScience.with_image(file) do |img|
-    img.cropped_thumbnail("#{file}_cropped.png", 100)
-  end
-  
-  ImageScience.with_image(file) do |img|
-    img.thumbnail("#{file}_thumb.png", 100)
+    img.cropped_thumbnail(100) do |thumb|
+      thumb.save "#{file}_cropped.png"
+    end
+
+    img.thumbnail(100) do |thumb|
+      thumb.save "#{file}_thumb.png"
+    end
   end
 
 == REQUIREMENTS:
@@ -36,12 +38,13 @@ For more information including build steps, see http://seattlerb.rubyforge.org/
 
 * Download and install FreeImage. See notes at url above.
 * sudo gem install -y image_science
+* see http://seattlerb.rubyforge.org/ImageScience.html for more info.
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2006 Ryan Davis, Seattle.rb
+Copyright (c) 2006-2007 Ryan Davis, Seattle.rb
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bench.rb

@@ -4,7 +4,10 @@ require 'benchmark'
 require 'rubygems'
 require 'image_science'
 
-file = "blah_big.png"
+max = (ARGV.shift || 100).to_i
+ext = ARGV.shift || "png"
+
+file = "blah_big.#{ext}"
 
 if RUBY_PLATFORM =~ /darwin/ then
   # how fucking cool is this???
@@ -14,7 +17,9 @@ else
   abort "You need to plonk down #{file} or buy a mac"
 end unless test ?f, "#{file}"
 
-max = (ARGV.shift || 100).to_i
+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|
@@ -28,7 +33,7 @@ Benchmark::bm(20) do |x|
     for i in 0..max do
       ImageScience.with_image(file) do |img|
         img.cropped_thumbnail(100) do |thumb|
-          thumb.save("blah_cropped.png")
+          thumb.save("blah_cropped.#{ext}")
         end
       end
     end
@@ -38,7 +43,7 @@ Benchmark::bm(20) do |x|
     for i in 0..max do
       ImageScience.with_image(file) do |img|
         img.thumbnail(100) do |thumb|
-          thumb.save("blah_thumb.png")
+          thumb.save("blah_thumb.#{ext}")
         end
       end
     end
@@ -48,11 +53,11 @@ Benchmark::bm(20) do |x|
     for i in 0..max do
       ImageScience.with_image(file) do |img|
         img.resize(200, 200) do |resize|
-          resize.save("blah_resize.png")
+          resize.save("blah_resize.#{ext}")
         end
       end
     end
   }
 end
 
-# File.unlink(*Dir["blah*png"])
+# File.unlink(*Dir["blah*#{ext}"])

data/lib/image_science.rb

@@ -4,25 +4,27 @@ require 'rubygems'
 require 'inline'
 
 ##
-# Provides a simple and clean API to generate thumbnails using
+# Provides a clean and simple API to generate thumbnails using
 # FreeImage as the underlying mechanism.
 #
 # For more information or if you have build issues with FreeImage, see
 # http://seattlerb.rubyforge.org/ImageScience.html
 
 class ImageScience
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
   ##
   # The top-level image loader opens +path+ and then yields the image.
 
-  def self.with_image(path); end # :yields: image
+  def self.with_image(path) # :yields: image
+  end
 
   ##
   # Crops an image to +left+, +top+, +right+, and +bottom+ and then
   # yields the new image.
 
-  def with_crop(left, top, right, bottom); end # :yields: image
+  def with_crop(left, top, right, bottom) # :yields: image
+  end
 
   ##
   # Returns the width of the image, in pixels.
@@ -34,17 +36,31 @@ class ImageScience
 
   def height; end
 
+  ##
+  # Saves the image out to +path+. Changing the file extension will
+  # convert the file type to the appropriate format.
+
+  def save(path); end
+
   ##
   # Resizes the image to +width+ and +height+ using a cubic-bspline
   # filter and yields the new image.
 
-  def resize(width, height); end # :yields: image
+  def resize(width, height) # :yields: image
+  end
 
   ##
-  # Creates a proportional thumbnail of the image scaled so its widest
+  # Creates a proportional thumbnail of the image scaled so its longest
   # edge is resized to +size+ and yields the new image.
 
-  def thumbnail(size); end # :yields: image
+  def thumbnail(size) # :yields: image
+    w, h = width, height
+    scale = size.to_f / (w > h ? w : h)
+
+    self.resize((w * scale).to_i, (h * scale).to_i) do |image|
+      yield image
+    end
+  end
 
   ##
   # Creates a square thumbnail of the image cropping the longest edge
@@ -84,8 +100,37 @@ class ImageScience
         DATA_PTR(self) = NULL;
         return Qnil;
       }
+
+      VALUE wrap_and_yield(FIBITMAP *image, VALUE self, FREE_IMAGE_FORMAT fif) {
+        VALUE klass = fif ? self         : CLASS_OF(self);
+        VALUE type  = fif ? INT2FIX(fif) : rb_iv_get(self, "@file_type");
+        VALUE obj = Data_Wrap_Struct(klass, NULL, NULL, image);
+        rb_iv_set(obj, "@file_type", type);
+        return rb_ensure(rb_yield, obj, unload, obj);
+      }
+
+      void copy_icc_profile(VALUE self, FIBITMAP *from, FIBITMAP *to) {
+        FREE_IMAGE_FORMAT fif = FIX2INT(rb_iv_get(self, "@file_type"));
+        if (fif != FIF_PNG && FreeImage_FIFSupportsICCProfiles(fif)) {
+          FIICCPROFILE *profile = FreeImage_GetICCProfile(from);
+          if (profile && profile->data) { 
+            FreeImage_CreateICCProfile(to, profile->data, profile->size); 
+          }
+        }
+      }
+    END
+
+    builder.prefix <<-"END"
+      void FreeImageErrorHandler(FREE_IMAGE_FORMAT fif, const char *message) {
+        rb_raise(rb_eRuntimeError,
+                 "FreeImage exception for type %s: %s",
+                  (fif == FIF_UNKNOWN) ? "???" : FreeImage_GetFormatFromFIF(fif),
+                  message);
+      }
     END
 
+    builder.add_to_init "FreeImage_SetOutputMessage(FreeImageErrorHandler);"
+
     builder.c_singleton <<-"END"
       VALUE with_image(char * input) {
         FREE_IMAGE_FORMAT fif = FIF_UNKNOWN; 
@@ -95,10 +140,9 @@ class ImageScience
         if ((fif != FIF_UNKNOWN) && FreeImage_FIFSupportsReading(fif)) { 
           FIBITMAP *bitmap;
           VALUE result = Qnil;
-          if (bitmap = FreeImage_Load(fif, input, 0)) {
-            VALUE obj = Data_Wrap_Struct(self, NULL, NULL, bitmap);
-            rb_iv_set(obj, "@file_type", INT2FIX(fif));
-            result = rb_ensure(rb_yield, obj, unload, obj);
+          int flags = fif == FIF_JPEG ? JPEG_ACCURATE : 0;
+          if (bitmap = FreeImage_Load(fif, input, flags)) {
+            result = wrap_and_yield(bitmap, self, fif);
           }
           return result;
         }
@@ -113,8 +157,8 @@ class ImageScience
         GET_BITMAP(bitmap);
 
         if (copy = FreeImage_Copy(bitmap, l, t, r, b)) {
-          VALUE obj = Data_Wrap_Struct(CLASS_OF(self), NULL, NULL, copy);
-          result = rb_ensure(rb_yield, obj, unload, obj);
+          copy_icc_profile(self, bitmap, copy);
+          result = wrap_and_yield(copy, self, 0);
         }
         return result;
       }
@@ -136,21 +180,12 @@ class ImageScience
       }
     END
 
-    builder.c <<-"END"
-      VALUE thumbnail(int size) {
-        GET_BITMAP(bitmap);
-        FIBITMAP *image = FreeImage_MakeThumbnail(bitmap, size, TRUE);
-        VALUE obj = Data_Wrap_Struct(CLASS_OF(self), NULL, NULL, image);
-        return rb_ensure(rb_yield, obj, unload, obj);
-      }
-    END
-
     builder.c <<-"END"
       VALUE resize(int w, int h) {
         GET_BITMAP(bitmap);
-        FIBITMAP *image = FreeImage_Rescale(bitmap, w, h, FILTER_BSPLINE);
-        VALUE obj = Data_Wrap_Struct(CLASS_OF(self), NULL, NULL, image);
-        return rb_ensure(rb_yield, obj, unload, obj);
+        FIBITMAP *image = FreeImage_Rescale(bitmap, w, h, FILTER_CATMULLROM);
+        copy_icc_profile(self, bitmap, image);
+        return wrap_and_yield(image, self, 0);
       }
     END
 
@@ -160,11 +195,8 @@ class ImageScience
         if (fif == FIF_UNKNOWN) fif = FIX2INT(rb_iv_get(self, "@file_type"));
         if ((fif != FIF_UNKNOWN) && FreeImage_FIFSupportsWriting(fif)) { 
           GET_BITMAP(bitmap);
-
-          if (FreeImage_Save(fif, bitmap, output, 0)) {
-            return Qtrue;
-          }
-          return Qfalse;
+          int flags = fif == FIF_JPEG ? JPEG_QUALITYSUPERB : 0;
+          return FreeImage_Save(fif, bitmap, output, flags) ? Qtrue : Qfalse;
         }
         rb_raise(rb_eTypeError, "Unknown file format");
       }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0.8
+rubygems_version: 0.9.0.9
 specification_version: 1
 name: image_science
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2007-01-05 00:00:00 -08:00
+  version: 1.1.1
+date: 2007-03-08 00:00:00 -08:00
 summary: ImageScience is a clean and happy Ruby library that generates thumbnails -- and kicks the living crap out of RMagick.
 require_paths: 
 - lib
 email: ryand-ruby@zenspider.com
-homepage: http://rubyforge.org/projects/seattlerb
+homepage: http://seattlerb.rubyforge.org/ImageScience.html
 rubyforge_project: seattlerb
 description: ImageScience is a clean and happy Ruby library that generates thumbnails -- and kicks the living crap out of RMagick. Oh, and it doesn't leak memory like a sieve. :) For more information including build steps, see http://seattlerb.rubyforge.org/
 autorequire: 
@@ -49,20 +49,20 @@ requirements: []
 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: RubyInline
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version 
-        version: 1.1.6
+        version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: RubyInline
+  name: hoe
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: 1.2.0
     version: