devil 0.1.8.5 → 0.1.8.8

data/CHANGELOG

@@ -1,3 +1,20 @@
+2009-10-29 John Mair (Banisterfiend)
+* version 0.1.8.8
+* added Devil.with_group (for loading multiple images into the same block)
+* all images passed into block are cleaned up at end of block
+* images at end of block are only free'd if they have not already been freed by user
+* ruby_il.c: added IMAGE_BITS_PER_PIXEL and IMAGE_BYTES_PER_PIXEL constants
+* finalizers still not implemented
+
+2009-10-28 John Mair (Banisterfiend)
+* removed finalizer and replaced with explicit call to image.free at end of block. If no block is used, user must call image.free at end of use
+* above fixes memory leak.
+* changed STR2CSTR() to StringValuePtr() in ruby_il.c
+
+2009-10-28 John Mair (Banisterfiend)
+* added IL::ConvertImage(IL::RGBA, IL::UNSIGNED_BYTE) to Devil#load; ensures that all image data is in the same format (image files only support RGB/UB and RGBA/UB so make them all RGBA/UB)
+* changed compile-time conditional for the IL_LBM constant. now checks if IL_LBM is defined before it tries IL_ILBM
+
 2009-10-25 John Mair (Banisterfiend)
 version 0.1.8.5
 * added hooks: prepare_image_hook, create_image_hook, load_image_hook 

data/README

@@ -1,4 +1,4 @@
-Ruby Devil version 0.1.8.5
+Ruby Devil version 0.1.8.8
 ========================
 
 * Original author: Jaroslaw Tworek <dev.jrx@gmail.com>

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/gempackagetask'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-DEVIL_VERSION = "0.1.8.5"
+DEVIL_VERSION = "0.1.8.8"
 
 dlext = Config::CONFIG['DLEXT']
 

data/ext/devil/ruby_il.c

@@ -80,21 +80,21 @@ static VALUE il_DeleteImages(VALUE obj, VALUE images) {
 }
 
 static VALUE il_LoadImage(VALUE obj, VALUE rb_filename) {
-    char* filename = STR2CSTR(rb_filename);
+    char* filename = StringValuePtr(rb_filename);
     ILboolean load = ilLoadImage(filename);
     return load ? Qtrue : Qfalse;
 }
 
 static VALUE il_Load(VALUE obj, VALUE rb_type, VALUE rb_filename) {
     ILenum type = NUM2INT(rb_type);
-    char* filename = STR2CSTR(rb_filename);
+    char* filename = StringValuePtr(rb_filename);
 
     ILboolean load = ilLoad(type, filename);
     return load ? Qtrue : Qfalse;
 }
 
 static VALUE il_SaveImage(VALUE obj, VALUE rb_filename) {
-    char* filename = STR2CSTR(rb_filename);
+    char* filename = StringValuePtr(rb_filename);
     ILboolean load = ilSaveImage(filename);
 
     return load ? Qtrue : Qfalse;
@@ -102,7 +102,7 @@ static VALUE il_SaveImage(VALUE obj, VALUE rb_filename) {
 
 static VALUE il_Save(VALUE obj, VALUE rb_type, VALUE rb_filename) {
     ILenum type = NUM2INT(rb_type);
-    char* filename = STR2CSTR(rb_filename);
+    char* filename = StringValuePtr(rb_filename);
     ILboolean load = ilSave(type, filename);
 
     return load ? Qtrue : Qfalse;
@@ -117,6 +117,7 @@ static VALUE il_TexImage(VALUE obj, VALUE rb_width, VALUE rb_height,
     ILubyte bpp = NUM2INT(rb_bpp);
     ILenum format = NUM2INT(rb_format);
     ILenum type = NUM2INT(rb_type);
+    ILboolean flag;
 
     /* from ILvoid */
     void * data = NULL;
@@ -126,7 +127,7 @@ static VALUE il_TexImage(VALUE obj, VALUE rb_width, VALUE rb_height,
     else
         data = ImageData2Arr(rb_data);
 
-    ILboolean flag = ilTexImage(width, height, depth,
+    flag = ilTexImage(width, height, depth,
                                 bpp, format, type, data);
     return flag ? Qtrue : Qfalse;
 }
@@ -435,7 +436,7 @@ InitializeIL() {
     rb_define_const(mIL, "JPG", INT2NUM(IL_JPG));
     rb_define_const(mIL, "JFIF", INT2NUM(IL_JFIF));
     
-#ifdef _WIN32    
+#ifndef IL_LBM   
     rb_define_const(mIL, "LBM", INT2NUM(IL_ILBM));
 #else
     rb_define_const(mIL, "LBM", INT2NUM(IL_LBM));
@@ -517,6 +518,8 @@ InitializeIL() {
     rb_define_const(mIL, "IMAGE_WIDTH", INT2NUM(IL_IMAGE_WIDTH));
     rb_define_const(mIL, "IMAGE_HEIGHT", INT2NUM(IL_IMAGE_HEIGHT));
     rb_define_const(mIL, "IMAGE_FORMAT", INT2NUM(IL_IMAGE_FORMAT));
+    rb_define_const(mIL, "IMAGE_BITS_PER_PIXEL", INT2NUM(IL_IMAGE_BITS_PER_PIXEL));
+    rb_define_const(mIL, "IMAGE_BYTES_PER_PIXEL", INT2NUM(IL_IMAGE_BYTES_PER_PIXEL));
     rb_define_const(mIL, "FILE_OVERWRITE", INT2NUM(IL_FILE_OVERWRITE));
     rb_define_const(mIL, "ORIGIN_SET", INT2NUM(IL_ORIGIN_SET));
     rb_define_const(mIL, "CONV_PAL", INT2NUM(IL_CONV_PAL));

data/lib/devil.rb

@@ -19,7 +19,7 @@ module Devil
     include IL
     include ILU
 
-    VERSION = '0.1.8.5'
+    VERSION = '0.1.8.8'
     
     class << self
 
@@ -27,29 +27,31 @@ module Devil
         # Optionally accepts a block and yields the newly created image to the block.
         def load_image(file, options={}, &block)
             name = prepare_image
+            attach_image_from_file(file)
+            
             out_profile = options[:out_profile]
             in_profile = options[:in_profile]
             
-            IL.LoadImage(file)
-
             # apply a color profile if one is provided
             IL.ApplyProfile(in_profile, out_profile) if out_profile
 
-            # run the proc (if it exists)
-            load_image_proc = Devil.get_options[:load_image_hook]
-            load_image_proc.call if load_image_proc            
-
-            if (error_code = IL.GetError) != IL::NO_ERROR
-                raise RuntimeError, "an error occured while trying to "+
-                    "load the image #{file}. #{ILU.ErrorString(error_code)}"
-            end
-
+            # run the load image hook (if it exists)
+            check_and_run_hook(:load_image_hook)
+            
+            error_check
+     
             img = Image.new(name, file)
             if block
-                block.call(img)
+                begin
+                    block.call(img)
+                ensure
+                    # don't bother freeing it if it's already free
+                    img.free if img.name
+                end
+            else
+                # ObjectSpace.define_finalizer(img, proc { IL.DeleteImages([img.name]) if img.name })
+                img
             end
-            
-            img
         end
 
         alias_method :with_image, :load_image
@@ -66,6 +68,7 @@ module Devil
 
             clear_color = options[:color]
 
+            # created image is formatted RGBA8
             IL.TexImage(width, height, 1, 4, IL::RGBA, IL::UNSIGNED_BYTE, nil)
 
             # apply a color profile if one is provided
@@ -75,26 +78,52 @@ module Devil
             IL.ClearImage
             IL.ClearColour(*Devil.get_options[:clear_color]) if clear_color
 
-            # run the proc (if it exists)
-            create_image_proc = Devil.get_options[:create_image_hook]
-            create_image_proc.call if create_image_proc
+            # run the create image hook (if it exists)
+            check_and_run_hook(:create_image_hook)
+            
+            error_check
+            
+            img = Image.new(name, nil)
+            if block
+                begin
+                    block.call(img)
+                ensure
+                    img.free if img.name
+                end
+            else
+                # ObjectSpace.define_finalizer(img, proc { IL.DeleteImages([img.name]) if img.name })
+                img
+            end
+        end
 
-            if (error_code = IL.GetError) != IL::NO_ERROR
-                raise RuntimeError, "an error occured while trying to "+
-                    "create an image. #{ILU.ErrorString(error_code)}"
+        alias_method :create_blank_image, :create_image
+
+        # load multiple images and yield them to the block
+        # e.g Devil.with_group("hello.png", "friend.png") { |img1, img2| ... }
+        # all yielded images are cleaned up at end of block so you do not need to
+        # explictly call img1.free
+        def with_group(*files, &block)
+            images = files.map do |file|
+                name = prepare_image
+                attach_image_from_file(file)
+                check_and_run_hook(:load_image_hook)
+                error_check
+                
+                Image.new(name, file)
             end
 
-            img = Image.new(name, nil)
             if block
-                block.call(img)
+                begin
+                    block.call(*images)
+                ensure
+                    images.each { |img| img.free if img.name }
+                end
+            else
+                raise RuntimeError, "a block must be provided."
             end
-            
-            img
         end
 
-        alias_method :create_blank_image, :create_image
-        alias_method :create_blank, :create_image
-        alias_method :blank_image, :create_image
+        alias_method :with_images, :with_group
         
         # convert an image +blob+ with +width+ and +height+
         # to a bona fide image
@@ -130,6 +159,10 @@ module Devil
         # :edge_filter sets the edge detection algorithm to use when invoking
         # the 'edge_detect' method. (defaults to :prewitt)
         # Allowed values are :prewitt and :sobel
+        #
+        # hooks:
+        # :prepare_image_hook, :create_image_hook, :load_image_hook
+        # e.g Devil.set_options :load_image_hook => proc { IL::ConvertImage(IL::RGBA, IL::UNSIGNED_BYTE) }
         def set_options(options={})
             @options.merge!(options)
 
@@ -186,15 +219,31 @@ module Devil
             name = IL.GenImages(1).first
             IL.BindImage(name)
 
-            # run the proc (if it exists)
-            prepare_image_proc = Devil.get_options[:prepare_image_hook]
-            prepare_image_proc.call if prepare_image_proc
+            # run the prepare image hook (if it exists)
+            check_and_run_hook(:prepare_image_hook)
 
             name
         end
+
+        def attach_image_from_file(file)
+            IL.LoadImage(file)
+
+            # ensure all images are formatted RGBA8
+            IL.ConvertImage(IL::RGBA, IL::UNSIGNED_BYTE)
+        end
+
+        def check_and_run_hook(hook_name)
+            Devil.get_options[hook_name].call if Devil.get_options[hook_name]
+        end
+
+        def error_check
+            if (error_code = IL.GetError) != IL::NO_ERROR
+                raise RuntimeError, "An error occured. #{ILU.ErrorString(error_code)}"
+            end
+        end
     end
 end
-# end of Devil module 
+## end of Devil module 
 
 # wraps a DevIL image
 class Devil::Image
@@ -203,9 +252,19 @@ class Devil::Image
     def initialize(name, file)
         @name = name
         @file = file
+    end
 
-        ObjectSpace.define_finalizer( self, proc { IL.DeleteImages(1, [name]) } )
+    # Frees the memory associated with the image.
+    # Must be called explictly if load_image or create_image is invoked without a block.
+    def free
+        raise "Error: calling 'free' on already freed image! #{self}" if !@name
+        IL.DeleteImages([@name])
+        error_check
+        @name = nil
     end
+
+    alias_method :close, :free
+    alias_method :delete, :free
     
     # returns the width of the image.
     def width
@@ -438,6 +497,7 @@ class Devil::Image
     private
 
     def set_binding
+        raise "Error: trying to use image that has already been freed! #{self}" if !@name
         IL.BindImage(@name)
     end
 
@@ -455,5 +515,7 @@ class Devil::Image
         result
     end
 end
+## end of Devil::Image
 
+# initialize Devil and set default config
 Devil.init

data/lib/devil/gosu.rb

@@ -9,8 +9,10 @@ module TexPlay
     # save a Gosu::Image to +file+
     # This method is only available if require 'devil/gosu' is used
     def save(file)
-        capture { 
-            to_devil.save(file)
+        capture {
+            img = to_devil
+            img.save(file)
+            img.free
         }
         self
     end
@@ -20,7 +22,7 @@ module TexPlay
     def to_devil
         devil_img = nil
         capture {
-            devil_img = Devil.from_blob(self.to_blob, self.width, self.height)
+            devil_img = Devil.from_blob(self.to_blob, self.width, self.height).flip
             devil_img
         }
         devil_img
@@ -64,8 +66,15 @@ class Gosu::Image
         def new(window, file, *args, &block)
             if file.respond_to?(:to_blob) || file =~ /\.(bmp|png)$/
                 original_new_redux(window, file, *args, &block)
-            else 
-                original_new_redux(window, Devil.load(file).flip, *args, &block)
+            else
+                img = Devil.load(file).flip
+                begin
+                    gosu_img = original_new_redux(window, img, *args, &block)
+                ensure
+                    img.free
+                end
+
+                gosu_img
             end
         end
     end
@@ -113,8 +122,11 @@ class Devil::Image
         end
 
         # note we dup the image so the displayed image is a snapshot taken at the time #show is invoked
-        @@window.show_list.push :image => Gosu::Image.new(@@window, self.dup.flip), :x => x, :y => y
 
+        img = self.dup.flip
+        @@window.show_list.push :image => Gosu::Image.new(@@window, img), :x => x, :y => y
+        img.free
+        
         self
     end
 end

data/test/test_blank.rb

@@ -5,13 +5,17 @@ $LOAD_PATH.push("#{$direc}/../lib/")
 require 'rubygems'
 require 'devil/gosu'
 
-Devil.set_options :load_image_hook => proc { IL.ConvertImage(IL::RGBA, IL::UNSIGNED_BYTE) }
-
 Devil.create_image(500, 500, :color => [255, 255, 0, 255]) do |img|
     source1 = Devil.load("texture.png").thumbnail(100)
     img.blit source1, 100, 100
     img.blit source1, 400, 100
-    img.blit source1.dup.rotate(45), 100, 300
+    
+    source1_dup = source1.dup
+    img.blit source1_dup.rotate(45), 100, 300
+
     img.show
+
+    source1.free
+    source1_dup.free
 end
 

data/test/test_blit.rb

@@ -7,10 +7,9 @@ require 'devil/gosu'
 
 Devil.with_image("#{$direc}/texture.png") do |img|
     img2 = Devil.load("#{$direc}/red.png")
-
-    img.show(200,200)
-
+    
     img.blit img2, 100, 100, :crop => [0, 0, img2.width / 2, img2.height / 2]
+    img2.free
 
     img.show
 end

data/test/test_clone_and_crop.rb

@@ -15,6 +15,9 @@ img.rotate(rand(360))
 img.show(200,200)
 img_dup.show(450, 200)
 
+img.free
+img_dup.free
+
 
 
 

data/test/test_gosu_load.rb

@@ -10,7 +10,6 @@ class W < Gosu::Window
         super(1024, 768, false, 20)
 
         @img = Gosu::Image.new(self, "#{$direc}/texture.jpg")
-        @img = @img.to_devil.save("cunt.png").to_gosu(self).to_devil.blur(5).to_gosu(self)
     end
     
     def draw

data/test/test_gosu_roundtrip.rb

@@ -10,10 +10,12 @@ class W < Gosu::Window
         super(1024, 768, false, 20)
 
         @img = Gosu::Image.new(self, "#{$direc}/texture.jpg")
-        @img = @img.to_devil.
-            emboss.
+        dimg = @img.to_devil
+        @img = dimg.emboss.
             rotate(45).
             to_gosu(self)
+        
+        dimg.free
     end
     
     def draw
@@ -24,4 +26,4 @@ end
 
 w = W.new
 w.show
-        
+

data/test/test_group.rb

@@ -0,0 +1,18 @@
+$direc = File.dirname(__FILE__)
+
+$LOAD_PATH.push("#{$direc}/../lib/")
+
+require 'rubygems'
+require 'devil/gosu'
+
+Devil.with_group("#{$direc}/texture.png", "#{$direc}/red.png") do |img, img2|
+
+    img.blit img2, 100, 100, :crop => [0, 0, img2.width / 2, img2.height / 2]
+    img.show
+end
+
+
+
+                   
+
+

data/test/test_new_api.rb

@@ -6,8 +6,9 @@ require 'rubygems'
 require "devil"
 
 Devil.with_image("#{$direc}/texture.png") do |img|
-    img.negative
-    img.save("#{$direc}/texture_neg.png")
+    img.pixelize(10)
+    img.save("#{$direc}/texture_blocky.png")
+    img.free
 end
 
 img = Devil.load_image("#{$direc}/texture.png")
@@ -16,8 +17,10 @@ bink = Devil.load_image("#{$direc}/texture.png")
 img.gamma_correct(1.6)
 bink.resize(50, 50)
 
-img.save("#{$direc}/texture_gamma.png")
-bink.save("#{$direc}/texture_tiny.png")
+img.save("#{$direc}/texture_gamma.png").free
+bink.save("#{$direc}/texture_tiny.png").free
+
+
 
 
                    

data/test/test_profile.rb

@@ -5,4 +5,4 @@ $LOAD_PATH.push("#{$direc}/../lib/")
 require 'rubygems'
 require 'devil/gosu'
 
-Devil.load("texture.png", :inprofile => "sRGB.icm", :out_profile => "color/AdobeRGB1998.icc").save("texture_out.png")
+Devil.load("texture.png", :inprofile => "sRGB.icm", :out_profile => "AdobeRGB1998.icc").save("texture_out.png").free

data/test/test_screenshot.rb

@@ -22,7 +22,7 @@ class W < Gosu::Window
 
     def update
         if button_down?(Gosu::KbEscape)
-            screenshot.rotate(45).save("screenshot.png")
+            screenshot.rotate(45).save("screenshot.png").free
             exit
         end
     end

data/test/test_thumbnail.rb

@@ -6,7 +6,7 @@ require 'rubygems'
 require 'devil/gosu'
 
 Devil.load("texture.png") do |img|
-    img.dup.thumbnail(150, :filter => Devil::NEAREST).show(100, 300)
-    img.dup.thumbnail(150).show(100, 100)
+    img.dup.thumbnail(150, :filter => Devil::NEAREST).show(100, 300).free
+    img.dup.thumbnail(150).show(100, 100).free
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devil
 version: !ruby/object:Gem::Version 
-  version: 0.1.8.5
+  version: 0.1.8.8
 platform: ruby
 authors: 
 - Jaroslaw Tworek, John Mair (banisterfiend)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-25 00:00:00 -04:00
+date: 2009-10-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -42,6 +42,7 @@ files:
 - test/test_gosu_show.rb
 - test/test_profile.rb
 - test/test_screenshot.rb
+- test/test_group.rb
 - test/test_gosu_roundtrip.rb
 - test/test_gosu_save.rb
 - test/test_thumbnail.rb