ruby-vips 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # master 
 
+# Version 0.3.1
+
+### Fixed
+
+* PNG writer no longer changes the filename argument [John Cupitt]
+* Workaround helps ruby-vips compile against 7.26.3 [John Cupitt]
+* Image read now runs GC and retries on fail [John Cupitt]
+* Image write GCs every 100 images [John Cupitt]
+
 # Version 0.3.0
 
 Release date: 2012-07-20

data/README.md

@@ -36,11 +36,15 @@ manipulate, and pass around Image objects without incurring any memory or CPU
 costs. The image is not actually processed until you write the image to memory
 or to disk.
 
+*note*: ruby-vips will work with versions of libvips as far back as 7.12, but
+with missing features and with reduced performance. For best results, use the 
+latest libvips you can.
+
 ## Requirements.
 
   * OS X or Linux
   * MRI 1.8.7, 1.9.2
-  * libvips 7.29 and later (it will work with earlier libvips, but some
+  * libvips 7.24 and later (it will work with earlier libvips, but some
     features may not be functional)
 
 ## Installation.
@@ -54,9 +58,19 @@ $ apt-get install libvips-dev
 ### OS X Prerequisites.
 
 ```bash
-$ brew install vips -HEAD
+$ brew install --use-llvm vips
 ```
 
+You may need to set your PKG_CONFIG_PATH before vips can see your libpng. Try
+something like:
+
+```bash
+export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig:/usr/X11/lib/pkgconfig
+```
+
+See the Mac OS X Lion section in [Installation on various
+platforms](https://github.com/jcupitt/ruby-vips/wiki/installation-on-various-platforms).
+
 TODO: Describe & test with macports.
 
 ### Other platforms
@@ -159,6 +173,6 @@ We suggest you schedule a GC every 100 images processed.
 ## Why use ruby-vips?
 
   - It supports over 250 low-level image and color manipulation operations.
-  - Operations are chainable, and do not get executed until the image is sent to an output.
+  - Operations are chainable and do not get executed until the image is sent to an output.
   - Memory use is low, even for very, very large images.
   - Fastest ruby library for resizing large images. See [benchmarks at the official libvips website](http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use) and [vips-benchmarks](https://github.com/stanislaw/vips-benchmarks)

data/ext/ruby_vips.h

@@ -28,6 +28,14 @@ void vips_lib_error();
 #define rb_str_new_cstr(str) rb_str_new(str, (long)strlen(str))
 #endif
 
+/* vips-7.26.3 and earlier 7.26 (used on Ubuntu 12.04) has a broken compat
+ * macro for im_openout(). Make sure we have the correct one defined.
+ */
+#ifdef im_openout
+#undef im_openout
+#define im_openout( F ) vips_image_new_mode( F, "w" )
+#endif /*im_openout*/
+
 #include "header.h"
 #include "image_arithmetic.h"
 #include "image_boolean.h"

data/lib/vips.rb

@@ -6,7 +6,7 @@ require 'vips/version'
 require 'vips/reader'
 require 'vips/writer'
 
-module Vips
+module VIPS
   class << self
     def sequential_mode_supported?
       comp = VIPS::LIB_VERSION_ARRAY <=> [7,28,0]

data/lib/vips/reader.rb

@@ -10,7 +10,7 @@ module VIPS
     def read
       # in case the sub-class has not read it
       if not @_im 
-          @_im = read_internal @path, 0
+          @_im = read_retry @path, 0
       end
       @_im
     end
@@ -23,6 +23,21 @@ module VIPS
     def y_size
         @_im.y_size
     end
+
+    private
+
+    # read can fail due to no file descriptors ... if we fail, do a GC and try
+    # again a second time
+    def read_retry(path, seq)
+      im = nil
+      begin
+        im = read_internal path, seq
+      rescue
+        GC.start
+        im = read_internal path, seq
+      end
+      im
+    end
   end
 
   class JPEGReader < Reader
@@ -47,13 +62,13 @@ module VIPS
       str << "fail" if @fail_on_warn
 
       seq = 0
-      if Vips.sequential_mode_supported?
+      if VIPS.sequential_mode_supported?
         str << "," 
         str << "sequential" if @sequential
         seq = 1
       end
 
-      @_im = read_internal str, seq
+      @_im = read_retry str, seq
     end
 
     # Shrink the jpeg while reading from disk. This means that the entire image
@@ -89,7 +104,7 @@ module VIPS
       # VIPS magic open path limitation/bug -- we cannot specify the comma char
       str << ",sep:#{@separator}" unless @separator[/,/]
 
-      @_im = read_internal str, 0
+      @_im = read_retry str, 0
     end
 
     # Set the number of lines to skip at the beginning of the file.
@@ -129,13 +144,13 @@ module VIPS
       str << "#{@page_number}" if @page_number
 
       seq = 0
-      if Vips.sequential_mode_supported?
+      if VIPS.sequential_mode_supported?
         str << ","
         str << "sequential" if @sequential
         seq = 1
       end
 
-      @_im = read_internal str, seq
+      @_im = read_retry str, seq
     end
 
     # Select which page in a multiple-page tiff to read. When set to nil, all
@@ -160,16 +175,15 @@ module VIPS
     end
 
     def read
-      str = @path
+      str = "#{@path}:"
 
       seq = 0
-      if Vips.sequential_mode_supported?
-        str << ":"
+      if VIPS.sequential_mode_supported?
         str << "sequential" if @sequential
         seq = 1
       end
 
-      @_im = read_internal str, seq
+      @_im = read_retry str, seq
     end
   end
 

data/lib/vips/version.rb

@@ -1,3 +1,3 @@
 module VIPS
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/vips/writer.rb

@@ -1,6 +1,29 @@
 module VIPS
   class Writer
     def write(path)
+      write_gc path
+    end
+
+    private
+
+    # write can fail due to no file descriptors 
+    #
+    # we can't try a write and GC and retry on fail, since the write may take a
+    # long time 
+    #
+    # GCing before every write would have a horrible effect on performance, so
+    # as a compromise we GC every @@gc_interval writes
+
+    @@gc_interval = 100
+    @@gc_countdown = @@gc_interval
+
+    def write_gc(path)
+      @@gc_countdown -= 1
+      if @@gc_countdown < 0 
+        @@gc_countdown = @@gc_interval
+        GC.start
+      end
+
       write_internal path
     end
   end
@@ -16,7 +39,7 @@ module VIPS
     end
 
     def write(path)
-      write_internal "#{path}:sep:#{@separator}"
+      write_gc "#{path}:sep:#{@separator}"
     end
   end
 
@@ -32,7 +55,7 @@ module VIPS
     end
 
     def write(path)
-      write_internal "#{path}:#{@quality}"
+      write_gc "#{path}:#{@quality}"
     end
 
     def to_memory
@@ -63,7 +86,7 @@ module VIPS
     end
 
     def write(path)
-      write_internal "#{path}:#{@compression},#{@interlace ? 1 : 0}"
+      write_gc "#{path}:#{@compression},#{@interlace ? 1 : 0}"
     end
 
     def to_memory
@@ -93,7 +116,7 @@ module VIPS
     end
 
     def write(path)
-      write_internal "#{path}:#{@format}"
+      write_gc "#{path}:#{@format}"
     end
 
     def format=(format_v)
@@ -136,7 +159,7 @@ module VIPS
 
     def write(path)
       opts = [compression_str, layout_str, @multi_res, @format, resolution_str].join ','
-      write_internal "#{path}:#{opts}"
+      write_gc "#{path}:#{opts}"
     end
 
     def compression_str

data/ruby-vips.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-vips"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Timothy Elliott", "John Cupitt"]
-  s.date = "2012-07-24"
+  s.date = "2012-08-30"
   s.description = "Ruby extension for the vips image processing library."
   s.email = "jcupitt@gmail.com"
   s.extensions = ["ext/extconf.rb"]
@@ -69,7 +69,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jcupitt/ruby-vips"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.19"
+  s.rubygems_version = "1.8.15"
   s.summary = "ruby-vips is a ruby extension for vips. It is extremely fast and it can process huge images without requiring the entire image to be loaded into memory."
 
   if s.respond_to? :specification_version then

metadata

@@ -1,91 +1,93 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ruby-vips
-version: !ruby/object:Gem::Version
-  version: 0.3.0
+version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
-authors:
+authors: 
 - Timothy Elliott
 - John Cupitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2012-08-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  name: rdoc
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
         version: 1.8.3
-  type: :development
+  name: jeweler
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.3
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  type: :development
+  requirement: *id004
 description: Ruby extension for the vips image processing library.
 email: jcupitt@gmail.com
 executables: []
-extensions:
+
+extensions: 
 - ext/extconf.rb
-extra_rdoc_files:
+extra_rdoc_files: 
 - LICENSE
 - README.md
 - TODO
-files:
+files: 
 - CHANGELOG.md
 - Gemfile.lock
 - README.md
@@ -135,32 +137,37 @@ files:
 - LICENSE
 - TODO
 homepage: http://github.com/jcupitt/ruby-vips
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 665410675
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: ruby-vips is a ruby extension for vips. It is extremely fast and it can process
-  huge images without requiring the entire image to be loaded into memory.
+summary: ruby-vips is a ruby extension for vips. It is extremely fast and it can process huge images without requiring the entire image to be loaded into memory.
 test_files: []
+