ruby-vips 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d671129c93cfb4105aec4736c4caf7898c93f1ab088ee4a97b4a5189a924501e
-  data.tar.gz: 8c34c01cbb010805fced2d1677c814055c2856708d9e2175bbe4a016d2c32993
+  metadata.gz: 7e63754294a1cbf0c65135dca3b377085616a6e386fb75d6442937fccb9c4c5a
+  data.tar.gz: d885bef5779402c0fbdc100635d8f26794d4d7394c97ac4eb1829343aaa5d636
 SHA512:
-  metadata.gz: 70ccc45f4aa940db1e5959a50ae1e998415e9ad0ed7e8cd92726fc905a5a1ad22d530739fdd2192957464e3e96242400db29c644dbe815a741d1047211348cad
-  data.tar.gz: 0ce3050e2fc3ef1d4729881087b29eaa88c53960195a4b45e50fab4f618d50a2b9d50ac22ce72e433d0cad33f913f378f664a392faa7913a68db844549ed7412
+  metadata.gz: 2c52c6e54dc34dba9d01eb39dafc9e8d4132f3242d0a30ec89ea661c0b6d1be424ba6287398f13e697069e3a3d0f07e175f28f2f0f0b51caaed9cea8dc21aeee
+  data.tar.gz: 72e1116ca589860cbe30a3f6b89a7ca07a9d594b2be972a1cedad779a255a8d9418c5f9d472c90c1be63e76e518972d2ad48c73d31472aa8cf070ce668f29050

data/.rubocop_todo.yml

@@ -447,7 +447,7 @@ Style/TrailingCommaInHashLiteral:
 
 # Offense count: 1
 # Cop supports --auto-correct.
-Style/UnneededInterpolation:
+Style/RedundantInterpolation:
   Exclude:
     - 'lib/vips/image.rb'
 

data/.travis.yml

@@ -45,6 +45,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 script: bundle exec rake spec
 
@@ -54,9 +55,3 @@ gemfile:
 before_install:
   - uname -a
   - bash install-vips.sh
-
-jobs:
-  include:
-    - stage: Lint
-      rvm: 2.6
-      script: bundle exec rake rubocop

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## master
 
+## Version 2.0.17 (2019-10-29)
+
+* install msys2 libvips on Windows [larskanis]
+* better `-` to `_` conversion [Nakilon]
+* fix `GValue#set` for stricter metadata rules in 8.9 [jcupitt]
+* fix a ref leak on operation build error [jcupitt]
+* faster operation call [jcupitt]
+* add support for VipsConnection [jcupitt]
+* add `signal_connect` [jcupitt]
+* add `Image#set_kill` for progress termination [jcupitt]
+
 ## Version 2.0.16 (2019-9-21)
 
 * better library name generation [renchap]

data/README.md

@@ -3,35 +3,15 @@
 [![Gem Version](https://badge.fury.io/rb/ruby-vips.svg)](https://badge.fury.io/rb/ruby-vips)
 [![Build Status](https://travis-ci.org/libvips/ruby-vips.svg?branch=master)](https://travis-ci.org/libvips/ruby-vips)
 
-This gem provides a Ruby binding for the [libvips image processing
+This gem is a Ruby binding for the [libvips image processing
 library](https://libvips.github.io/libvips).
 
-Programs that use `ruby-vips` don't
-manipulate images directly, instead they create pipelines of image processing
-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 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 five runs
-benchmark       tiff    jpeg
-ruby-vips.rb	0.85	0.78	
-image-magick	2.03	2.44	
-rmagick.rb	3.87	3.89	
-
-peak memory use in kb
-benchmark	peak RES
-ruby-vips.rb	43864
-rmagick.rb	788768
-```
-
-See also [benchmarks at the official libvips
-website](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
+Programs that use `ruby-vips` don't manipulate images directly, instead
+they create pipelines of image processing 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 parallel, it's quick,
+and because it doesn't need to keep entire images in memory, it's light.
 
 ## Requirements
 
@@ -60,9 +40,6 @@ gem 'ruby-vips'
 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 API
-documentation](http://www.rubydoc.info/gems/ruby-vips). 
-
 # Example
 
 ```ruby
@@ -90,13 +67,37 @@ im = im.conv mask, precision: :integer
 im.write_to_file output_filename
 ```
 
-# Older versions
+The `Vips` section in the API docs has a [tutorial introduction with
+examples](https://www.rubydoc.info/gems/ruby-vips/Vips).
 
-There are two older versions of this gem.
+ruby-vips has [API
+ documentation](http://www.rubydoc.info/gems/ruby-vips). The [libvips
+ reference manual](https://libvips.github.io/libvips/API/current/) has a
+ complete explanation of every method.
 
-The `0.3-stable` branch is written in C and supports a different API. It still
-works, but is only maintained for compatibility.
+The 
+[`example/`](https://github.com/libvips/ruby-vips/tree/master/example)
+directory has some simple example programs.
+
+# Benchmarks
+
+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 five runs
+benchmark       tiff    jpeg
+ruby-vips.rb	0.85	0.78	
+image-magick	2.03	2.44	
+rmagick.rb	3.87	3.89	
+
+peak memory use in kb
+benchmark	peak RES
+ruby-vips.rb	43864
+rmagick.rb	788768
+```
+
+See also [benchmarks at the official libvips
+website](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
 
-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

@@ -28,7 +28,7 @@
 
 	cd lib/vips
 	ruby > methods.rb
-	require 'vips'; Vips::generate_yard
+	require 'vips'; Vips::Yard.generate
 	^D
 
 - Regenerate `.rubocop_todo.yml`.

data/VERSION

@@ -1 +1 @@
-2.0.16
+2.0.17

data/example/connection.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+file = File.open ARGV[0], "rb"
+source = Vips::SourceCustom.new
+source.on_read { |length| file.read length }
+# this method is optional
+# source.on_seek { |offset, whence| file.seek(offset, whence) }
+
+dest = File.open ARGV[1], "wb"
+target = Vips::TargetCustom.new
+target.on_write { |chunk| dest.write(chunk) }
+target.on_finish { dest.close }
+
+image = Vips::Image.new_from_source source, "", access: :sequential
+image.write_to_target target, ".png"

data/example/progress.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+image = Vips::Image.black 1, 100000
+image.set_progress true
+
+def progress_to_s(name, progress)
+  puts "#{name}:"
+  puts "    progress.run = #{progress[:run]}"
+  puts "    progress.eta = #{progress[:eta]}"
+  puts "    progress.tpels = #{progress[:tpels]}"
+  puts "    progress.npels = #{progress[:npels]}"
+  puts "    progress.percent = #{progress[:percent]}"
+end 
+
+image.signal_connect :preeval do |progress|
+  progress_to_s("preeval", progress)
+end 
+
+image.signal_connect :eval do |progress|
+  progress_to_s("eval", progress)
+  image.set_kill(true) if progress[:percent] > 50
+end
+
+image.signal_connect :posteval do |progress|
+  progress_to_s("posteval", progress)
+end
+
+image.avg

data/lib/vips.rb

@@ -166,7 +166,7 @@ require 'vips/gobject'
 require 'vips/gvalue'
 
 # This module provides a binding for the [libvips image processing
-# library](https://jcupitt.github.io/libvips/).
+# library](https://libvips.github.io/libvips/).
 #
 # # Example
 #
@@ -212,6 +212,9 @@ require 'vips/gvalue'
 # memory buffers, create images that wrap C-style memory arrays, or make images
 # from constants.
 #
+# Use {Source} and {Image.new_from_source} to load images from any data
+# source, for example URIs.
+#
 # The next line:
 #
 # ```ruby
@@ -253,6 +256,9 @@ require 'vips/gvalue'
 # suffix. You can also write formatted images to memory buffers, or dump
 # image data to a raw memory array.
 #
+# Use {Target} and {Image#write_to_target} to write formatted images to 
+# any data sink, for example URIs.
+#
 # # How it works
 #
 # The binding uses [ruby-ffi](https://github.com/ffi/ffi) to open the libvips
@@ -404,12 +410,12 @@ require 'vips/gvalue'
 # # Automatic YARD documentation
 #
 # The bulk of these API docs are generated automatically by
-# {Vips::generate_yard}. It examines
+# {Vips::Yard::generate}. It examines
 # libvips and writes a summary of each operation and the arguments and options
 # that that operation expects.
 #
 # Use the [C API
-# docs](https://jcupitt.github.io/libvips/API/current)
+# docs](https://libvips.github.io/libvips/API/current)
 # for more detail.
 #
 # # Enums
@@ -434,6 +440,55 @@ require 'vips/gvalue'
 # If you want to avoid the copies, you'll need to call drawing operations
 # yourself.
 #
+# # Progress
+#
+# You can attach signal handlers to images to watch computation progress. For
+# example:
+#
+# ```ruby
+# image = Vips::Image.black 1, 100000
+# image.set_progress true
+# 
+# def progress_to_s(name, progress)
+#   puts "#{name}:"
+#   puts "    run = #{progress[:run]}"
+#   puts "    eta = #{progress[:eta]}"
+#   puts "    tpels = #{progress[:tpels]}"
+#   puts "    npels = #{progress[:npels]}"
+#   puts "    percent = #{progress[:percent]}"
+# end
+# 
+# image.signal_connect :preeval do |progress|
+#   progress_to_s("preeval", progress)
+# end
+# 
+# image.signal_connect :eval do |progress|
+#   progress_to_s("eval", progress)
+#   image.set_kill(true) if progress[:percent] > 50
+# end
+# 
+# image.signal_connect :posteval do |progress|
+#   progress_to_s("posteval", progress)
+# end
+# 
+# image.avg
+# ```
+# 
+# The `:eval` signal will fire for every tile that is processed. You can stop
+# progress with {Image#set_kill} and processing will end with an exception.
+#
+# User streams
+#
+# You can make your own input and output stream objects with {SourceCustom} and
+# {TargetCustom}. For example:
+#
+# ```ruby
+# file = File.open "some/file", "rb"
+# source = Vips::SourceCustom.new
+# source.on_read { |length| file.read length }
+# image = Vips::Image.new_from_source source, "", access: "sequential"
+# ```
+#
 # # Overloads
 #
 # The wrapper defines the usual set of arithmetic, boolean and relational
@@ -614,7 +669,7 @@ module Vips
   LIBRARY_VERSION = Vips::version_string
 
   # libvips has this arbitrary number as a sanity-check upper bound on image
-  # size. It's sometimes useful for know whan calculating image ratios.
+  # size. It's sometimes useful to know when calculating scale factors.
   MAX_COORD = 10000000
 end
 
@@ -624,3 +679,8 @@ require 'vips/image'
 require 'vips/interpolate'
 require 'vips/region'
 require 'vips/version'
+require 'vips/connection'
+require 'vips/source'
+require 'vips/sourcecustom'
+require 'vips/target'
+require 'vips/targetcustom'

data/lib/vips/connection.rb

@@ -0,0 +1,46 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require 'ffi'
+
+module Vips
+  if Vips::at_least_libvips?(8, 9)
+    attach_function :vips_connection_filename, [:pointer], :string
+    attach_function :vips_connection_nick, [:pointer], :string
+  end
+
+  # Abstract base class for connections.
+  class Connection < Vips::Object
+    # The layout of the VipsRegion struct.
+    module ConnectionLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Object::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Object::Struct
+      include ConnectionLayout
+    end
+
+    class ManagedStruct < Vips::Object::ManagedStruct
+      include ConnectionLayout
+    end
+
+    # Get any filename associated with a connection, or nil.
+    def filename
+      Vips::vips_connection_filename self
+    end
+
+    # Get a nickname (short description) of a connection that could be shown to
+    # the user.
+    def nick
+      Vips::vips_connection_nick self
+    end
+  end
+end

data/lib/vips/gobject.rb

@@ -73,6 +73,9 @@ module GObject
     def initialize ptr
       # GLib::logger.debug("GObject::GObject.initialize") {"ptr = #{ptr}"}
       @struct = ffi_managed_struct.new ptr
+
+      # sometimes we need to keep refs across C calls ... hide them here
+      @references = []
     end
 
     # access to the casting struct for this class
@@ -111,8 +114,13 @@ module GObject
     layout :value, GParamSpec.ptr
   end
 
-  attach_function :g_param_spec_get_blurb, [GParamSpec.ptr], :string
+  attach_function :g_param_spec_get_blurb, [:pointer], :string
 
   attach_function :g_object_ref, [:pointer], :void
   attach_function :g_object_unref, [:pointer], :void
+
+  # we just use one gcallback type for every signal, hopefully this is OK
+  callback :gcallback, [:pointer], :void
+  attach_function :g_signal_connect_data,
+    [:pointer, :string, :gcallback, :pointer, :pointer, :int], :long
 end

data/lib/vips/gvalue.rb

@@ -13,6 +13,8 @@ module GObject
   # gvalue.init GObject::GDOUBLE_TYPE
   # gvalue.set 3.1415
   # value = gvalue.get
+  # # optional -- drop any ref the gvalue had
+  # gvalue.unset
   # ```
   #
   # Lifetime is managed automatically. It doesn't know about all GType values,
@@ -25,12 +27,11 @@ module GObject
     # convert an enum value (str/symb/int) into an int ready for libvips
     def self.from_nick(gtype, value)
       value = value.to_s if value.is_a? Symbol
-      # libvips expects "-" as a separator in enum names, but "_" is more
-      # convenient for ruby, eg. :b_w
-      value = value.tr("_", "-")
 
       if value.is_a? String
-        value = Vips::vips_enum_from_nick "ruby-vips", gtype, value
+        # libvips expects "-" as a separator in enum names, but "_" is more
+        # convenient for ruby, eg. :b_w
+        value = Vips::vips_enum_from_nick "ruby-vips", gtype, value.tr("_", "-")
         if value == -1
           raise Vips::Error
         end
@@ -244,6 +245,14 @@ module GObject
 
       return result
     end
+
+    # Clear the thing held by a GValue. 
+    #
+    # This happens automatically when a GValue is GCed, but this method can be 
+    # handy if you need to drop a reference explicitly for some reason.
+    def unset 
+      ::GObject::g_value_unset self
+    end
   end
 
   attach_function :g_value_init, [GValue.ptr, :GType], :void