ruby-vips 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 614489c8022d27d06892f9980c0df0cca00d7598
-  data.tar.gz: 9c0332039d753a99a4eb526f6b424d6a432c4b6b
+  metadata.gz: 294dcea3bbc7b03ef6652be00b29732722bde853
+  data.tar.gz: 407c694bb0080bd7bdca1469e3db50f58c5c0daf
 SHA512:
-  metadata.gz: c9f73109c2116d56f607e9cee9a01b8bce41d380b223f0e734576a4066184cab9162e514759fcbf36750c6adc30df86467ed1755b9904b6469c66063efee1542
-  data.tar.gz: 12f7e4f9e3af5ead044a1fd9e46a2e080f0e612b34216fe26966c734501dd2633a66417a25144644b96e00440970345939e591503ca660fa76837b6ff365f85d
+  metadata.gz: a36160fc23f5953312f4e3e4fb44db4c45bf4f024586e72f397b7c88457284d4a1e2e0705ca83d2c993b04500d5347ea226b3af3889b91d81396ea432e1e4664
+  data.tar.gz: 83e9faa1e666f2d503a9d93f8a249b49c03bf4cda7a5b83bbc60df98e4dde0f51fd73086108749266b752dc887047a02e0ddad49b2f4f0a94b02815a3b2bd884

data/.travis.yml

@@ -5,27 +5,22 @@ env:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
     - VIPS_VERSION_MAJOR=8
     - VIPS_VERSION_MINOR=5
-    - VIPS_VERSION_MICRO=3
+    - VIPS_VERSION_MICRO=7
     - PATH=$HOME/vips/bin:$PATH
     - LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
     - PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
-    - PYTHONPATH=$HOME/vips/lib/python2.7/site-packages:$PYTHONPATH
-    - GI_TYPELIB_PATH=$HOME/vips/lib/girepository-1.0:$GI_TYPELIB_PATH
 
 dist: trusty
 
 addons:
   apt:
     packages:
-      - libxml2-dev
+      - libexpat1-dev
       - gettext
-      - python-dev
-      - liblcms1-dev
+      - liblcms2-dev
       - libmagickwand-dev
       - libopenexr-dev
       - libcfitsio3-dev
-      - gobject-introspection
-      - libgirepository1.0-dev
       - libgif-dev
       - libgs-dev
       - libgsf-1-dev
@@ -34,18 +29,20 @@ addons:
       - liborc-0.4-dev
       - libpango1.0-dev
       - libpoppler-glib-dev
+      - librsvg2-dev
       - libwebp-dev
+        # missing on trusty, unfortunately
+        # - libwebpmux2
+      - libfftw3-dev
       - libglib2.0-dev
 
 cache:
   directories:
     - $HOME/vips
 
-# gobject-introspection 3.1 declares itself as 2.1 minimum, so we can't test
-# 2.0 ... in fact it seems to work if you force it, but I don't think we can do
-# that on travis
 language: ruby
 rvm:
+  - 2.0
   - 2.1
   - 2.2
   - 2.3
@@ -58,4 +55,4 @@ gemfile:
 
 before_install:
   - uname -a
-  - bash install-vips.sh
+  - bash install-vips.sh --without-python

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 # master 
 
+# Version 2.0.0
+
+* rewrite on top of 'ffi' [John Cupitt, Kleis Auke Wolthuizen]
+
 # Version 1.0.6
 
-* remove lazy load, fixing a race with fork() [felixbuenemann]
+* remove lazy load, fixing a race with multi-threading [felixbuenemann]
 * make `Image#to_a` much faster [John Cupitt]
 * remove the `at_exit` handler [John Cupitt]
 

data/README.md

@@ -3,12 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/ruby-vips.svg)](https://badge.fury.io/rb/ruby-vips)
 [![Build Status](https://travis-ci.org/jcupitt/ruby-vips.svg?branch=master)](https://travis-ci.org/jcupitt/ruby-vips)
 
-*API break:* version 1.0 of this gem is an API break, see below for some notes
-on why there is a break and how to update your code. 
-The older `ruby-vips` is still here and still maintained in branch 
-`0.3-stable`.
-
-This gem provides a Ruby binding for the [vips image processing
+This gem provides a Ruby binding for the [libvips image processing
 library](https://jcupitt.github.io/libvips).
 
 Programs that use `ruby-vips` don't
@@ -17,25 +12,22 @@ operations building on a source image. When the end of the pipe is connected
 to a destination, the whole pipeline executes at once, streaming the image
 in parallel from source to destination a section at a time. 
 
-Because `ruby-vips` is very parallel, it's quick, and because it doesn't need
-to keep entire images in memory, it's light. 
-For example, the benchmark at 
-[vips-benchmarks](https://github.com/stanislaw/vips-benchmarks) loads a large
-image, crops, shrinks, sharpens and saves again, and repeats 10 times. 
+Because `ruby-vips` is parallel, it's quick, and because it doesn't need to
+keep entire images in memory, it's light.  For example, the benchmark at
+[vips-benchmarks](https://github.com/jcupitt/vips-benchmarks) loads a
+large image, crops, shrinks, sharpens and saves again, and repeats 10 times.
 
 ```text
 real time in seconds, fastest of three runs
-benchmark       tiff	jpeg
-ruby-vips.rb    2.97	3.29	
-image-magick    8.18	9.71	
-rmagick.rb      9.22	10.06	
-image_sci.rb    9.39	7.20	
+benchmark       tiff    jpeg
+ruby-vips.rb    0.66    0.44
+image-magick    1.10    1.50
+rmagick.rb      1.63    2.16
 
 peak memory use in bytes
 benchmark       peak RSS
-ruby-vips.rb    117604
-image_sci.rb    146536
-rmagick.rb      3352020
+ruby-vips.rb    58696
+rmagick.rb      787564
 ```
 
 See also [benchmarks at the official libvips
@@ -46,50 +38,32 @@ which gives some more background.
 
 ## Requirements
 
-  * OS X or Linux
-  * libvips 8.2 and later
+  * macOS, Linux, and Windows tested
 
-## Installation prerequisites
+  * libvips 8.2 or later, see the [libvips install instructions](https://jcupitt.github.io/libvips/install.html)
 
-### OS X 
+  * [ruby-ffi](https://github.com/ffi/ffi) 1.9 or later 
 
-Install [homebrew](http://mxcl.github.com/homebrew) and enter:
+  * Ruby 2.0+, JRuby should work
 
-```bash
-$ brew install homebrew/science/vips
-```
+## Install
 
-To verify that your vips install is working, try:
+It's just:
 
-```bash
-$ vips --version
-vips-8.2.1
 ```
-
-### Other platforms
-
-Check your package manager and see if the libvips on your system is new enough.
-`ruby-vips` needs libvips 8.2 or later. 
-
-If it's too old, you'll need to build libvips from source. 
-Download a tarball from the 
-[libvips website](https://jcupitt.github.io/libvips), or build
-from [the git repository](https://github.com/jcupitt/libvips) and see the
-README.
-
-## Installing the gem.
-
-```bash
-$ gem install ruby-vips
+	$ gem install ruby-vips
 ```
 
-or include it in Gemfile:
+or include it in `Gemfile`:
 
 ```ruby
 gem 'ruby-vips'
 ```
 
-And take a look in `examples/`. There is full yard documentation, take a look
+On Windows, you'll need to set the `RUBY_DLL_PATH` environment variable to 
+point to the libvips bin directory.
+
+Take a look in `examples/`. There is full yard documentation, take a look
 there too.
 
 # Example
@@ -103,7 +77,7 @@ im = Vips::Image.new_from_file filename
 # make the other pixels in the image by mirroring im up / down / 
 # left / right, see
 # https://jcupitt.github.io/libvips/API/current/libvips-conversion.html#vips-embed
-im = im.embed 100, 100, 3000, 3000, :extend => :mirror
+im = im.embed 100, 100, 3000, 3000, extend: :mirror
 
 # multiply the green (middle) band by 2, leave the other two alone
 im *= [1, 2, 1]
@@ -113,76 +87,19 @@ mask = Vips::Image.new_from_array [
     [-1, -1, -1],
     [-1, 16, -1],
     [-1, -1, -1]], 8
-im = im.conv mask
+im = im.conv mask, precision: :integer
 
 # finally, write the result back to a file on disk
 im.write_to_file output_filename
 ```
 
-# Why the API break?
-
-There's been a `ruby-vips` for a few years now. 
-It was written by a Ruby
-expert, it works well, it includes a test-suite, and has pretty full
-documentation. Why rewrite?
-
-`ruby-vips` 0.3 was based on the old vips7 API. There's now vips8, 
-which adds several
-very useful new features:
-
-* [GObject](https://developer.gnome.org/gobject/stable/)-based API with full
-  introspection. You can discover the vips8 API at runtime. This means that if
-  libvips gets a new operator, any binding that goes via vips8 will 
-  get the new thing immediately. With vips7, whenever libvips was changed, all
-  the bindings needed to be changed too.
-
-* No C required. Thanks to
-  [gobject-introspection](https://wiki.gnome.org/Projects/GObjectIntrospection)
-  you can write the binding in Ruby itself, there's no need for any C. This
-  makes it a lot smaller and more portable. 
-
-* vips7 probably won't get new features. vips7 doesn't really exist any more:
-  the API is still there, but now just a thin compatibility layer over vips8.
-  New features may well not get added to the vips7 API.
-
-There are some more minor pluses as well:
-
-* Named and optional arguments. vips8 lets you have optional and required
-  arguments, both input and output, and optional arguments can have default
-  values. 
-
-* Operation cache. vips8 keeps track of the last 1,000 or so operations and
-  will automatically reuse results when it can. This can give a huge speedup
-  in some cases.
-
-* vips8 is much simpler and more regular. For example, 
-  ruby-vips had to work hard to offer a nice loader system, but that's all
-  built into vips8. It can do things like load and save formatted images to 
-  and from memory buffers as well, which just wasn't possible before. 
-
-This binding adds some extra useful features over the old `ruby-vips` binding.
-
-* Full set of arithmetic operator overloads.
-
-* Automatic constant expansion. You can write things like
-  `image.bandjoin(255)` and the 255 will be automatically expanded to an image 
-  and attached as an extra band. You can mix int, float, scalar, vector and
-  image constants freely.
-
-# How to update your code
-
-* `VIPS::` becomes `Vips::`
-
-* `VIPS::Image.new(filename)` becomes `Vips::Image.new_from_file(filename)`. 
-  `VIPS::Image.jpeg(filename)` also becomes 
-  `Vips::Image.new_from_file(filename)`, similarly for other formats.  
+# Older versions
 
-* `#write(filename)` becomes `#write_to_file(filename)`. `#png(filename)` also
-  becomes `#write_to_file(filename)`, same for all other
-  formats.
+There are two older versions of this gem.
 
-* Most member functions are unchanged, but check the yard docs. You can also
-  use the C docs directly, since `ruby-vips` is now a very thin layer over the
-  C API. See the docs for the `Vips` class for guidance. 
+The `0.3-stable` branch is written in C and supports a different API. It still
+works, but is only maintained for compatibility.
 
-* There are lots of nice new features, see the docs and examples.
+The `1.0-stable` branch is based on `gobject-introspection` rather than
+`ffi`. It supports the same API as the current version, but is harder to
+install, less portable, slower, and less stable.

data/TODO

@@ -1,11 +1,5 @@
 # Notes
 
-- mail about the getpoint unimplemented error
-
-  http://sourceforge.net/p/ruby-gnome2/mailman/ruby-gnome2-devel-en/thread/CAGNS0RuZ5N6bha3M7B0%2BYf2M9-oni44idzZO17mtQiykS%2BmJKQ%40mail.gmail.com/#msg34790843
-
-- still missing a few enum docs
-
 - support complex constants, eg. 
 
 	Complex(1, 2)
@@ -28,3 +22,7 @@
 - push new gem to rubygems, tag repository with version
 
   bundle exec rake release
+
+- regenerate docs
+
+  bundle exec rake yard

data/VERSION

@@ -1 +1 @@
-1.0.6
+2.0.0

data/example/inheritance_with_refcount.rb

@@ -0,0 +1,286 @@
+#!/usr/bin/ruby
+
+require 'ffi'
+require 'forwardable'
+
+# this is really very crude logging
+
+# @private
+$vips_debug = true
+
+# @private
+def log str
+    if $vips_debug
+        puts str
+    end
+end
+
+def set_debug debug
+    $vips_debug = debug
+end
+
+module Libc
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    attach_function :malloc, [:size_t], :pointer
+    attach_function :free, [:pointer], :void
+end
+
+module GLib
+    extend FFI::Library
+    ffi_lib 'gobject-2.0'
+
+    # nil being the default
+    glib_log_domain = nil
+
+    def self.set_log_domain(domain)
+        glib_log_domain = domain
+    end
+
+    # we have a set of things we need to inherit in different ways:
+    #
+    # - we want to be able to subclass GObject in a simple way
+    # - the layouts of the nested structs
+    # - casting between structs which share a base
+    # - gobject refcounting
+    #
+    # the solution is to split the class into four areas which we treat
+    # differently:
+    #
+    # - we have a "wrapper" Ruby class to allow easy subclassing ... this has a
+    #   @struct member which holds the actual pointer
+    # - we use "forwardable" to forward the various ffi methods on to the
+    #   @struct member ... we arrange things so that subclasses do not need to
+    #   do the forwarding themselves
+    # - we have two versions of the struct: a plain one which we can use for
+    #   casting that will not change the refcounts
+    # - and a managed one with an unref which we just use for .new
+    # - we separate the struct layout into a separate module to avoid repeating
+    #   ourselves
+
+    class GObject
+        extend Forwardable
+        extend SingleForwardable
+
+        def_instance_delegators :@struct, :[], :to_ptr
+        def_single_delegators :ffi_struct, :ptr
+
+        # the layout of the GObject struct
+        module GObjectLayout
+            def self.included(base)
+                base.class_eval do
+                    layout :g_type_instance, :pointer,
+                           :ref_count, :uint,
+                           :qdata, :pointer
+                end
+            end
+        end
+
+        # the struct with unref ... manage object lifetime with this
+        class ManagedStruct < FFI::ManagedStruct
+            include GObjectLayout
+
+            def initialize(ptr)
+                log "GLib::GObject::ManagedStruct.new: #{ptr}"
+                super
+            end
+
+            def self.release(ptr)
+                log "GLib::GObject::ManagedStruct.release: unreffing #{ptr}"
+                GLib::g_object_unref(ptr) unless ptr.null?
+            end
+
+        end
+
+        # the plain struct ... cast with this
+        class Struct < FFI::Struct
+            include GObjectLayout
+
+            def initialize(ptr)
+                log "GLib::GObject::Struct.new: #{ptr}"
+                super
+            end
+
+        end
+
+        # don't allow ptr == nil, we never want to allocate a GObject struct
+        # ourselves, we just want to wrap GLib-allocated GObjects
+        #
+        # here we use ManagedStruct, not Struct, since this is the ref that will
+        # need the unref
+        def initialize(ptr)
+            log "GLib::GObject.initialize: ptr = #{ptr}"
+            @struct = ffi_managed_struct.new(ptr)
+        end
+
+        # access to the cast struct for this class
+        def ffi_struct
+            self.class.ffi_struct
+        end
+
+        class << self
+            def ffi_struct
+                self.const_get(:Struct)
+            end
+        end
+
+        # access to the lifetime managed struct for this class
+        def ffi_managed_struct
+            self.class.ffi_managed_struct
+        end
+
+        class << self
+            def ffi_managed_struct
+                self.const_get(:ManagedStruct)
+            end
+        end
+
+    end
+
+    # :gtype will usually be 64-bit, but will be 32-bit on 32-bit Windows
+    typedef :ulong, :GType
+
+end
+
+module Vips
+    extend FFI::Library
+    ffi_lib 'vips'
+
+    LOG_DOMAIN = "VIPS"
+    GLib::set_log_domain(LOG_DOMAIN)
+
+    # need to repeat this
+    typedef :ulong, :GType
+
+    attach_function :vips_init, [:string], :int
+    attach_function :vips_shutdown, [], :void
+
+    attach_function :vips_error_buffer, [], :string
+    attach_function :vips_error_clear, [], :void
+
+    def self.get_error
+        errstr = Vips::vips_error_buffer
+        Vips::vips_error_clear
+        errstr
+    end
+
+    if Vips::vips_init($0) != 0
+        puts Vips::get_error
+        exit 1
+    end
+
+    at_exit {
+        Vips::vips_shutdown
+    }
+
+    attach_function :vips_object_print_all, [], :void
+    attach_function :vips_leak_set, [:int], :void
+
+    def self.showall
+        if $vips_debug
+            GC.start
+            vips_object_print_all
+        end
+    end
+
+    if $vips_debug
+        vips_leak_set 1
+    end
+
+    class VipsObject < GLib::GObject
+
+        # the layout of the VipsObject struct
+        module VipsObjectLayout
+            def self.included(base)
+                base.class_eval do
+                    # don't actually need most of these, remove them later
+                    layout :parent, GLib::GObject::Struct, 
+                       :constructed, :int,
+                       :static_object, :int,
+                       :argument_table, :pointer,
+                       :nickname, :string,
+                       :description, :string,
+                       :preclose, :int,
+                       :close, :int,
+                       :postclose, :int,
+                       :local_memory, :size_t
+                end
+            end
+        end
+
+        class Struct < GLib::GObject::Struct
+            include VipsObjectLayout
+
+            def initialize(ptr)
+                log "Vips::VipsObject::Struct.new: #{ptr}"
+                super
+            end
+
+        end
+
+        class ManagedStruct < GLib::GObject::ManagedStruct
+            include VipsObjectLayout
+
+            def initialize(ptr)
+                log "Vips::VipsObject::ManagedStruct.new: #{ptr}"
+                super
+            end
+
+        end
+
+    end
+
+    class VipsImage < VipsObject
+
+        # the layout of the VipsImage struct
+        module VipsImageLayout
+            def self.included(base)
+                base.class_eval do
+                    layout :parent, VipsObject::Struct
+                    # rest opaque
+                end
+            end
+        end
+
+        class Struct < VipsObject::Struct
+            include VipsImageLayout
+
+            def initialize(ptr)
+                log "Vips::VipsImage::Struct.new: #{ptr}"
+                super
+            end
+
+        end
+
+        class ManagedStruct < VipsObject::ManagedStruct
+            include VipsImageLayout
+
+            def initialize(ptr)
+                log "Vips::VipsImage::ManagedStruct.new: #{ptr}"
+                super
+            end
+
+        end
+
+        def self.new_partial
+            VipsImage.new(Vips::vips_image_new)
+        end
+
+    end
+
+    attach_function :vips_image_new, [], :pointer
+
+end
+
+puts "creating image"
+begin
+    x = Vips::VipsImage.new_partial 
+    puts "x = #{x}"
+    puts ""
+    puts "x[:parent] = #{x[:parent]}"
+    puts ""
+    puts "x[:parent][:description] = #{x[:parent][:description]}"
+    puts ""
+end
+