ruby-vips 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,11 +1,25 @@
 # master 
 
+# Version 0.3.0
+
+Release date: 2012-07-20
+
+### Added
+
+* More rspec tests [John Cupitt]
+* Updated to libvips-7.30 [John Cupitt]
+
 ### Changed
 
+* Reworked Reader class offers better performance and compatibility [John
+  Cupitt]
 * Don't use :sequential option for older libvipses [John Cupitt]
+* Rename "tone_analyze" as "tone_analyse" for consistency with the rest of
+  vips [John  CUpitt]
 
 ### Fixed
 
+* Now passes rspec test suite cleanly in valgrind [John Cupitt]
 * Fixed check of sequential mode support [Stanislaw Pankevich]
 
 # Version 0.2.0

data/README.md

@@ -1,24 +1,20 @@
 # ruby-vips : A fast image processing extension for Ruby.
 
-*Note*: ruby-vips git master is the development version and uses features
-from git master of libvips (the unreleased 7.29) as well. You may prefer
-the stable 0.2 branch of ruby-vips.
-
 [![Build Status](https://secure.travis-ci.org/jcupitt/ruby-vips.png)](http://travis-ci.org/jcupitt/ruby-vips)
 
 ruby-vips is a ruby extension for [vips](http://www.vips.ecs.soton.ac.uk). 
-It is extremely fast and it can process huge images without requiring the 
+It is fast and it can process images without requiring the 
 entire image to be loaded into memory. For example, the benchmark at 
 [vips-benchmarks](https://github.com/stanislaw/vips-benchmarks) loads a large
 image, crops, shrinks, sharpens and saves again:
 
-<pre>
+```text
 real time in seconds, fastest of three runs
 benchmark       tiff    jpeg
 ruby-vips.rb    0.45    0.56    
 rmagick.rb      1.69    1.90    
 netpbm.sh       1.74    1.63    
-image-magick    2.87    3.02    
+image-magick.sh 2.87    3.02    
 image_sci.rb    3.19    2.90    
 
 peak memory use in kilobytes
@@ -26,7 +22,7 @@ benchmark       peak RSS
 ruby-vips.rb    160400
 image_sci.rb    546992
 rmagick.rb      1370064
-</pre>
+```
 
 See also [benchmarks at the official libvips
 website](http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use).
@@ -45,7 +41,7 @@ or to disk.
   * OS X or Linux
   * MRI 1.8.7, 1.9.2
   * libvips 7.29 and later (it will work with earlier libvips, but some
-    features may not be functional -- you may prefer the stable 0.1 branch)
+    features may not be functional)
 
 ## Installation.
 
@@ -65,7 +61,8 @@ TODO: Describe & test with macports.
 
 ### Other platforms
 
-See [Installiation on various platforms](https://github.com/jcupitt/ruby-vips/wiki/installiation-on-various-platforms).
+See [Installation on various
+platforms](https://github.com/jcupitt/ruby-vips/wiki/installation-on-various-platforms).
 
 ### Installing the gem.
 
@@ -73,6 +70,16 @@ See [Installiation on various platforms](https://github.com/jcupitt/ruby-vips/wi
 $ gem install ruby-vips
 ```
 
+Alternatively, for a debug build:
+
+```bash
+$ gem install ruby-vips -- --enable-debug
+```
+
+```bash
+$ gem install ruby-vips
+```
+
 or include it in Gemfile:
 
 ```ruby
@@ -82,7 +89,7 @@ gem 'ruby-vips'
 ## Documentation.
 
 ruby-vips has [rdoc
-documentation](http://rubydoc.info/gems/ruby-vips/0.1.1/frames). Also
+documentation](http://rubydoc.info/gems/ruby-vips/0.2.0/frames). Also
 see [Wiki page](https://github.com/jcupitt/ruby-vips/wiki)
 
 ## Small example
@@ -97,12 +104,17 @@ require 'vips'
 
 include VIPS
 
-# Create an image object. It will not actually load the image until needed.
+# Create an image object. It will not actually load the pixel data until 
+# needed. 
 im = Image.jpeg('mypic.jpg')
 
+# You can read all the header fields without triggering a pixel load.
+puts "it's #{im.x_size} pixels across!"
+
 # Shrink the jpeg by a factor of four when loading -- huge speed and CPU
 # improvements on large images.
 im = Image.jpeg('mypic.jpg', :shrink_factor => 4)
+puts "but only #{im.x_size} pixels when we shrink on load"
 
 # Add a shrink by a factor of two to the pipeline. This will not actually be
 # executed yet.
@@ -112,6 +124,9 @@ im_shrink_by_two = im.shrink(2)
 # actually loaded and resized. With images that allow for random access from
 # the hard drive (VIPS native format, tiled OpenEXR, ppm/pbm/pgm/pfm, tiled
 # tiff, and RAW images), the entire image is never read into memory.
+# For other formats, the image is either decompressed to a temporary disc 
+# file and then processed from there, or, if you give the :sequential hint, 
+# streamed directly from the file.
 im_shrink_by_two.png('out.png', :interlace => true)
 
 # All ruby-vips image commands can be chained, so the above sequence could
@@ -126,18 +141,16 @@ Image.jpeg('mypic.jpg', :shrink_factor => 4).shrink(2).png('out.png')
 Image.new('mypic.jpg').shrink(2).write('out.png')
 ```
 
-## Gotchas
-
-### Contain memuse
+## Garbage collection
 
-ruby-vips only finalises vips images on GC. In other words:
+ruby-vips only frees images on GC. In other words:
 
 ```ruby
 a = Image.new(filename)
 a = nil
 ```
 
-will not release the resources associated with a, you have to
+will not release the resources associated with `a`, you have to
 either request a GC explicitly or wait for Ruby to GC for you. This can
 be a problem if you're processing many images.
 

data/ext/extconf.rb

@@ -4,8 +4,28 @@ require "mkmf"
 
 File::unlink("Makefile") if (File::exist?("Makefile"))
 
-VIPS_VERSIONS = %w[7.29 7.28 7.27 7.26 7.24 7.23 7.22 7.20]
+# override normal build configuration to build debug friendly library
+# if installed via 'gem install ruby-vips -- --enable-debug'
+# see: http://jonforums.github.com/ruby/2011/01/27/debugging-native-gems-1.html
+if enable_config('debug')
+    puts '[INFO] enabling debug library build configuration.'
+    if RUBY_VERSION < '1.9'
+        $CFLAGS = CONFIG['CFLAGS'].gsub(/\s\-O\d?\s/, ' -O0 ')
+        $CFLAGS.gsub!(/\s?\-g\w*\s/, ' -ggdb3 ')
+        CONFIG['LDSHARED'] = CONFIG['LDSHARED'].gsub(/\s\-s(\s|\z)/, ' ')
+    else
+        CONFIG['debugflags'] << ' -ggdb3 -O0'
+    end
+end
 
-raise("There is no pkg_config for any of following libvips versions: #{VIPS_VERSIONS.join(', ')}") unless VIPS_VERSIONS.detect {|x| pkg_config("vips-#{x}") }
+# vips-7.30 and later use plain "vips" for the pkg-config name: look for that
+# first
+if not pkg_config("vips") 
+    VIPS_VERSIONS = %w[7.29 7.28 7.27 7.26 7.24 7.23 7.22 7.20]
+
+    if not VIPS_VERSIONS.detect {|x| pkg_config("vips-#{x}") }
+        raise("no pkg_config for any of following libvips versions: #{VIPS_VERSIONS.join(', ')}") 
+    end
+end
 
 create_makefile('vips_ext')

data/ext/header.c

@@ -1,6 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "header.h"
 
 VALUE mVIPSHeader;
 
@@ -22,8 +20,8 @@ header_band_fmt_to_id(VipsBandFmt band_fmt)
         case IM_BANDFMT_COMPLEX:   return id_complex; // two floats
         case IM_BANDFMT_DOUBLE:    return id_double;
         case IM_BANDFMT_DPCOMPLEX: return id_dbcomplex; // two doubles
+    	default:		return id_notset;
     }
-    return id_notset;
 }
 
 VipsBandFmt
@@ -399,7 +397,7 @@ header_set(VALUE obj, VALUE name, VALUE value)
  */
 
 void
-init_Header()
+init_Header( void )
 {
     mVIPSHeader = rb_define_module_under(mVIPS, "Header");
 

data/ext/header.h

@@ -4,5 +4,6 @@
 extern VALUE mVIPSHeader;
 
 VipsBandFmt header_id_to_band_fmt(VALUE);
+void init_Header( void );
 
 #endif

data/ext/image.c

@@ -1,18 +1,4 @@
 #include "ruby_vips.h"
-#include "header.h"
-
-#include "image.h"
-#include "image_arithmetic.h"
-#include "image_boolean.h"
-#include "image_colour.h"
-#include "image_conversion.h"
-#include "image_convolution.h"
-#include "image_freq_filt.h"
-#include "image_histograms_lut.h"
-#include "image_morphology.h"
-#include "image_mosaicing.h"
-#include "image_relational.h"
-#include "image_resample.h"
 
 VALUE cVIPSImage;
 
@@ -150,8 +136,8 @@ img_vtype_to_id(VipsType vtype)
         case IM_TYPE_YXY:       return id_yxy;
         case IM_TYPE_RGB16:     return id_rgb16;
         case IM_TYPE_GREY16:    return id_grey16;
+	default:		return id_b_w;
     }
-    return id_b_w;
 }
 
 ID
@@ -161,8 +147,8 @@ img_coding_to_id(VipsCoding coding)
         case IM_CODING_NONE: return id_none;
         case IM_CODING_LABQ: return id_labq;
         case IM_CODING_RAD:  return id_rad;
+    	default:	     return id_none;
     }
-    return id_none;
 }
 
 /*
@@ -283,6 +269,8 @@ img_pixel_to_rb(VipsImage *im, int x, int y)
     case IM_BANDFMT_DOUBLE:    GETPIX( double, rb_float_new ); break;
     case IM_BANDFMT_COMPLEX:   CGETPIX( float, rb_float_new ); break; 
     case IM_BANDFMT_DPCOMPLEX: CGETPIX( double, rb_float_new ); break; 
+
+    default: 			GETPIX( unsigned char, UINT2NUM ); break;
     }
 }
 
@@ -356,7 +344,8 @@ img_data(VALUE obj)
     if (im_incheck(im) || im_check_uncoded("img_aref", im))
         return( Qnil );
 
-    return rb_tainted_str_new(im->data, IM_IMAGE_SIZEOF_LINE(im) * im->Ysize);
+    return rb_tainted_str_new((const char *) im->data, 
+		    IM_IMAGE_SIZEOF_LINE(im) * im->Ysize);
 }
 
 /*
@@ -565,7 +554,7 @@ init_Image(void)
     rb_define_method(cVIPSImage, "heq", img_heq, -1); // in image_histograms_lut.c
     rb_define_method(cVIPSImage, "lhisteq", img_lhisteq, 2); // in image_histograms_lut.c
     rb_define_method(cVIPSImage, "stdif", img_stdif, 6); // in image_histograms_lut.c
-    rb_define_method(cVIPSImage, "tone_analyze", img_tone_analyze, 6); // in image_histograms_lut.c
+    rb_define_method(cVIPSImage, "tone_analyse", img_tone_analyse, 6); // in image_histograms_lut.c
     rb_define_method(cVIPSImage, "maplut", img_maplut, 1); // in image_histograms_lut.c
     rb_define_method(cVIPSImage, "histplot", img_histplot, 0); // in image_histograms_lut.c
     rb_define_method(cVIPSImage, "dilate", img_dilate, 1); // in image_morphology.c

data/ext/image.h

@@ -21,10 +21,11 @@ VALUE img_init(VALUE, VipsImage*);
 VALUE img_init_partial();
 VALUE img_init_partial_anyclass(VALUE);
 VipsBandFmt img_id_to_band_fmt(VALUE);
+void init_Image(void);
 
 #define GetImg(obj, data, im) \
     vipsImg *data; \
-    VipsImage *im; \
+    VipsImage *im __attribute__ ((unused)); \
     Data_Get_Struct(obj, vipsImg, data); \
     im = data->in;
 

data/ext/image_arithmetic.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "interpolator.h"
 
 /*
  *  call-seq:
@@ -21,7 +18,6 @@ img_measure_area(VALUE obj, VALUE left, VALUE top, VALUE width, VALUE height,
 	VALUE h, VALUE v, VALUE sel)
 {
     DOUBLEMASK *ret;
-    VALUE results;
     int *a, i, len = RARRAY_LENINT(sel);
 	GetImg(obj, data, im);
 

data/ext/image_arithmetic.h

@@ -25,7 +25,7 @@ VALUE img_ceil(VALUE);
 VALUE img_s_linreg(int, VALUE*, VALUE);
 VALUE img_point(VALUE, VALUE, VALUE, VALUE, VALUE);
 VALUE img_pow(int, VALUE*, VALUE);
-VALUE img_pow_binop(int, VALUE*, VALUE);
+VALUE img_pow_binop(VALUE obj, VALUE arg);
 VALUE img_expn(int, VALUE*, VALUE);
 VALUE img_log(VALUE);
 VALUE img_log10(VALUE);

data/ext/image_boolean.c

@@ -1,5 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
 
 static VALUE
 img_and_img(VALUE obj, VALUE obj2)

data/ext/image_boolean.h

@@ -4,5 +4,5 @@ VALUE img_or(int, VALUE*, VALUE);
 VALUE img_or_binop(VALUE, VALUE arg);
 VALUE img_xor(int, VALUE*, VALUE);
 VALUE img_xor_binop(VALUE, VALUE arg);
-VALUE img_shiftleft(int, VALUE*, VALUE);
-VALUE img_shiftright(int, VALUE*, VALUE);
+VALUE img_shiftleft(VALUE obj, VALUE arg);
+VALUE img_shiftright(VALUE obj, VALUE arg);

data/ext/image_colour.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "image_colour.h"
 
 static ID id_perceptual, id_relative_colorimetric, id_saturation,
 	id_absolute_colorimetric;

data/ext/image_conversion.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "header.h"
 
 static ID id_black, id_extend, id_repeat, id_mirror, id_white;
 
@@ -591,8 +588,8 @@ img_insertset(int argc, VALUE *argv, VALUE obj, VALUE obj2)
     y = IM_ARRAY(im_new, argc - 1, int);
 
     for(i = 1; i < argc; i++) {
-        x[i] = NUM2INT(RARRAY_PTR(argv[i])[0]);
-        y[i] = NUM2INT(RARRAY_PTR(argv[i])[1]);
+        x[i - 1] = NUM2INT(RARRAY_PTR(argv[i])[0]);
+        y[i - 1] = NUM2INT(RARRAY_PTR(argv[i])[1]);
     }
 
     if( im_insertset(im, im2, im_new, argc - 1, x, y) )

data/ext/image_convolution.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "image_convolution.h"
 
 /*
  *  call-seq:

data/ext/image_freq_filt.c

@@ -1,6 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "image_freq_filt.h"
 
 /*
  *  call-seq:

data/ext/image_histograms_lut.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "image_histograms_lut.h"
 
 /*
  *  call-seq:
@@ -620,21 +617,21 @@ img_s_tone_build(VALUE obj,
 
 /*
  *  call-seq:
- *     im.tone_analyze(ps, pm, ph, s, m, h) -> image
+ *     im.tone_analyse(ps, pm, ph, s, m, h) -> image
  *
  *  As Image#tone_build, but analyse the histogram of *self* and use it to pick
  *  the 0.1% and 99.9% points for <i>lb</i> and <i>lw</i>.
  */
 
 VALUE
-img_tone_analyze(VALUE obj,
+img_tone_analyse(VALUE obj,
 	VALUE ps, VALUE pm, VALUE ph, VALUE s, VALUE m, VALUE h)
 {
 #if IM_MAJOR_VERSION > 7 || IM_MINOR_VERSION >= 23
 	GetImg(obj, data, im);
 	OutImg(obj, new, data_new, im_new);
 
-    if (im_tone_analyze(im, im_new,
+    if (im_tone_analyse(im, im_new,
 		NUM2DBL(ps), NUM2DBL(pm), NUM2DBL(ph),
 		NUM2DBL(s), NUM2DBL(m), NUM2DBL(h)) )
         vips_lib_error();

data/ext/image_histograms_lut.h

@@ -25,4 +25,4 @@ VALUE img_s_tone_build_range(VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE,
 	VALUE, VALUE, VALUE, VALUE);
 VALUE img_s_tone_build(VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE,
 	VALUE);
-VALUE img_tone_analyze(VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
+VALUE img_tone_analyse(VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);

data/ext/image_morphology.c

@@ -1,7 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "mask.h"
-#include "image_morphology.h"
 
 /*
  *  call-seq:
@@ -170,7 +167,7 @@ img_rank_image(int argc, VALUE *argv, VALUE obj)
 VALUE
 img_maxvalue(int argc, VALUE *argv, VALUE obj)
 {
-	img_rank_image_internal(argc, argv, obj, argc - 1);
+	return img_rank_image_internal(argc, argv, obj, argc - 1);
 }
 
 static VALUE

data/ext/image_mosaicing.c

@@ -1,6 +1,4 @@
 #include "ruby_vips.h"
-#include "image.h"
-#include "image_mosaicing.h"
 
 ID id_match_left, id_match_right, id_match_both, id_match_none;