vips 8.8.0.3 → 8.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def8d2de5521071c5f93bda54b3856684a9aef80ee47104eac6cadcfe49af78b
-  data.tar.gz: 02bd0cad171e6b0ed6db4b33368556c06bf531608725bd7003f692cd2b43bb3f
+  metadata.gz: 791911df8d8ef4556cbf891fbb62f142cc13bfa062b6dc56de5a2fbc605b5af1
+  data.tar.gz: 477e946c45322d528ff3e162f1bb0d12e2b8bb7774956a36fad2455281ddaf00
 SHA512:
-  metadata.gz: 590a10204b092501c81d67e429700fd4f5226636729d5511956c2001f2486c41a1249e83d50bf3f69810abfab83bf89a7fe24458b45ccc7691ce55ce0c60f544
-  data.tar.gz: b9c6c6231d2e415643293fb4cf634ecfce4b6d37f5db81225cc7b84c72cddeeaf0d94f6756f253dfa8214ffb00a69cdbbd0fec686afdb8d1888ea0ead9efaa38
+  metadata.gz: be7311014c5f94c806ecfed73f99d09acd827439e91ae04803faa171510b725e6e097e5f2e3b5da5ffa72a469bac37d5bb56aa0add446329cd673c063fe802d7
+  data.tar.gz: d8a1bf4e00c93f9efddab64b11d82e8e53c2b01eccad3f8c44ad699082d4c9bb721a916070a388f4a9263cace566ae1d7200d79227e64be0980643d5b4412038

data/.travis.yml

@@ -24,9 +24,10 @@ addons:
       - libwebp-dev
   homebrew:
     packages:
-      # A simple way to install all dependencies.
-      - vips
       - glib
+      - libffi
+      - libexif
+    update: true
 
 cache:
   bundler: true
@@ -39,6 +40,8 @@ matrix:
     - rvm: 2.6
     - rvm: 2.6
       os: osx
+      env: PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"
+    - rvm: 2.7
     - rvm: truffleruby
     - rvm: jruby-head
     - rvm: ruby-head

data/README.md

@@ -1,10 +1,12 @@
 # Vips
 
+Programs that use `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.
+
 This gem is a backwards compatible fork of `ruby-vips` but also includes (and compiles) the [libvips] source code.
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/vips.svg)](http://travis-ci.org/ioquatix/vips)
 
-[libvips]: https://jcupitt.github.io/libvips
+[libvips]: https://libvips.github.io/libvips
 
 ## Installation
 

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/daltonize8.rb

@@ -9,18 +9,18 @@
 
 require 'vips'
 
-#Vips.set_debug true
+# Vips.set_debug true
 
 # matrices to convert D65 XYZ to and from bradford cone space
 xyz_to_brad = [
-    [0.8951,  0.2664, -0.1614],
-    [-0.7502,  1.7135,  0.0367],
-    [0.0389, -0.0685,  1.0296]
+  [0.8951, 0.2664, -0.1614],
+  [-0.7502, 1.7135, 0.0367],
+  [0.0389, -0.0685, 1.0296]
 ]
 brad_to_xyz = [
-    [0.987, -0.147, 0.16],
-    [0.432, 0.5184, 0.0493],
-    [-0.0085, 0.04, 0.968]
+  [0.987, -0.147, 0.16],
+  [0.432, 0.5184, 0.0493],
+  [-0.0085, 0.04, 0.968]
 ]
 
 im = Vips::Image.new_from_file ARGV[0]
@@ -47,9 +47,9 @@ brad = xyz.recomb xyz_to_brad
 # we need rows to sum to 1 in Bradford space --- the matrix in the original
 # Python code sums to 1.742
 deut = brad.recomb [
-    [1, 0, 0],
-    [0.7, 0, 0.3],
-    [0, 0, 1]
+  [1, 0, 0],
+  [0.7, 0, 0.3],
+  [0, 0, 1]
 ]
 
 xyz = deut.recomb brad_to_xyz
@@ -61,11 +61,9 @@ rgb = xyz.colourspace :srgb
 err = im - rgb
 
 # add the error back to other channels to make a compensated image
-im = im + err.recomb([
-    [0, 0, 0],
-    [0.7, 1, 0],
-    [0.7, 0, 1]
-])
+im = im + err.recomb([[0, 0, 0],
+                      [0.7, 1, 0],
+                      [0.7, 0, 1]])
 
 # reattach any alpha we saved above
 if alpha

data/example/example1.rb

@@ -5,8 +5,7 @@ require 'vips'
 
 GLib::logger.level = Logger::DEBUG
 
-op = Vips::Operation.new "black"
+Vips::Operation.new "black"
 
-op = nil
 GC.start
 Vips::Operation.print_all

data/example/example4.rb

@@ -6,10 +6,10 @@ require 'vips'
 Vips::leak_set true
 
 # disable the operation cache
-#Vips::cache_set_max 0
+# Vips::cache_set_max 0
 
 # turn on debug logging
-#Vips.set_debug true
+# Vips.set_debug true
 
 ARGV.each do |filename|
   im = Vips::Image.new_from_file filename

data/example/example5.rb

@@ -9,7 +9,7 @@ require 'vips'
 # Vips::cache_set_max 0
 
 # turn on debug logging
-#Vips.set_debug true
+# Vips.set_debug true
 
 if ARGV.length < 2
   raise "usage: #{$PROGRAM_NAME}: input-file output-file"
@@ -22,10 +22,9 @@ im *= [1, 2, 1]
 # we want to be able to specify a scale for the convolution mask, so we have to
 # make it ourselves
 # if you are OK with scale=1, you can just pass the array directly to .conv()
-mask = Vips::Image.new_from_array [
-    [-1, -1, -1],
-    [-1, 16, -1],
-    [-1, -1, -1]], 8
+mask = Vips::Image.new_from_array [[-1, -1, -1],
+                                   [-1, 16, -1],
+                                   [-1, -1, -1]], 8
 im = im.conv mask
 
 im.write_to_file ARGV[1]

data/example/inheritance_with_refcount.rb

@@ -31,11 +31,8 @@ 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
+  def self.set_log_domain(_domain)
+    # FIXME: this needs hooking up
   end
 
   # we have a set of things we need to inherit in different ways:
@@ -90,7 +87,6 @@ module GLib
         log "GLib::GObject::ManagedStruct.release: unreffing #{ptr}"
         GLib::g_object_unref(ptr) unless ptr.null?
       end
-
     end
 
     # the plain struct ... cast with this
@@ -101,7 +97,6 @@ module GLib
         log "GLib::GObject::Struct.new: #{ptr}"
         super
       end
-
     end
 
     # don't allow ptr == nil, we never want to allocate a GObject struct
@@ -135,12 +130,10 @@ module GLib
         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
@@ -189,7 +182,6 @@ module Vips
   end
 
   class VipsObject < GLib::GObject
-
     # the layout of the VipsObject struct
     module VipsObjectLayout
       def self.included(base)
@@ -216,7 +208,6 @@ module Vips
         log "Vips::VipsObject::Struct.new: #{ptr}"
         super
       end
-
     end
 
     class ManagedStruct < GLib::GObject::ManagedStruct
@@ -226,13 +217,10 @@ module Vips
         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)
@@ -250,7 +238,6 @@ module Vips
         log "Vips::VipsImage::Struct.new: #{ptr}"
         super
       end
-
     end
 
     class ManagedStruct < VipsObject::ManagedStruct
@@ -260,17 +247,14 @@ module Vips
         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"
@@ -283,4 +267,3 @@ begin
   puts "x[:parent][:description] = #{x[:parent][:description]}"
   puts ""
 end
-

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/example/thumb.rb

@@ -24,8 +24,6 @@ end
 
 ARGV.each do |filename|
   puts "processing #{filename} ..."
-  thumb = via_memory(filename, 500)
-  # thumb = via_files(filename, 500)
+  _thumb = via_memory(filename, 500)
+  # _thumb = via_files(filename, 500)
 end
-
-

data/example/trim8.rb

@@ -23,16 +23,16 @@ mask = (im.median - background).abs > 10
 # direction
 columns, rows = mask.project
 
-first_column, first_row = columns.profile
+_first_column, first_row = columns.profile
 left = first_row.min
 
-first_column, first_row = columns.fliphor.profile
+_first_column, first_row = columns.fliphor.profile
 right = columns.width - first_row.min
 
-first_column, first_row = rows.profile
+first_column, _first_row = rows.profile
 top = first_column.min
 
-first_column, first_row = rows.flipver.profile
+first_column, _first_row = rows.flipver.profile
 bottom = rows.height - first_column.min
 
 # and now crop the original image

data/ext/Rakefile

@@ -8,9 +8,9 @@ prefix = ENV['PREFIX'] || File.dirname(__dir__)
 
 task :fetch do
 	url = "https://github.com/libvips/libvips/releases/download/v#{version}/#{archive_path}"
-	
+
 	unless File.exist? archive_path
-		sh "wget #{url}"
+		sh "wget #{url} -O #{archive_path}"
 	end
 end
 

data/lib/vips.rb

@@ -10,6 +10,29 @@ require 'logger'
 # This module uses FFI to make a simple layer over the glib and gobject
 # libraries.
 
+# Generate a library name for ffi.
+#
+# Platform notes:
+# linux:
+#   Some distros allow "libvips.so", but only if the -dev headers have been
+#   installed. To work everywhere, you must include the ABI number.
+#   Confusingly, the file extension is not at the end. ffi adds the "lib"
+#   prefix.
+# mac:
+#   As linux, but the extension is at the end and is added by ffi.
+# windows:
+#   The ABI number must be included, but with a hyphen. ffi does not add a
+#   "lib" prefix or a ".dll" suffix.
+def library_name(name, abi_number)
+  if FFI::Platform.windows?
+    "lib#{name}-#{abi_number}.dll"
+  elsif FFI::Platform.mac?
+    "#{name}.#{abi_number}"
+  else
+    "#{name}.so.#{abi_number}"
+  end
+end
+
 module GLib
   class << self
     attr_accessor :logger
@@ -19,13 +42,7 @@ module GLib
 
   extend FFI::Library
 
-  if FFI::Platform.windows?
-    glib_libname = 'libglib-2.0-0.dll'
-  else
-    glib_libname = 'glib-2.0'
-  end
-
-  ffi_lib glib_libname
+  ffi_lib library_name('glib-2.0', 0)
 
   attach_function :g_malloc, [:size_t], :pointer
 
@@ -43,7 +60,7 @@ module GLib
   LOG_FLAG_FATAL              = 1 << 1
 
   # GLib log levels
-  LOG_LEVEL_ERROR             = 1 << 2       # always fatal
+  LOG_LEVEL_ERROR             = 1 << 2 # always fatal
   LOG_LEVEL_CRITICAL          = 1 << 3
   LOG_LEVEL_WARNING           = 1 << 4
   LOG_LEVEL_MESSAGE           = 1 << 5
@@ -52,12 +69,12 @@ module GLib
 
   # map glib levels to Logger::Severity
   GLIB_TO_SEVERITY = {
-      LOG_LEVEL_ERROR => Logger::ERROR,
-      LOG_LEVEL_CRITICAL => Logger::FATAL,
-      LOG_LEVEL_WARNING => Logger::WARN,
-      LOG_LEVEL_MESSAGE => Logger::UNKNOWN,
-      LOG_LEVEL_INFO => Logger::INFO,
-      LOG_LEVEL_DEBUG => Logger::DEBUG
+    LOG_LEVEL_ERROR => Logger::ERROR,
+    LOG_LEVEL_CRITICAL => Logger::FATAL,
+    LOG_LEVEL_WARNING => Logger::WARN,
+    LOG_LEVEL_MESSAGE => Logger::UNKNOWN,
+    LOG_LEVEL_INFO => Logger::INFO,
+    LOG_LEVEL_DEBUG => Logger::DEBUG
   }
   GLIB_TO_SEVERITY.default = Logger::UNKNOWN
 
@@ -66,7 +83,7 @@ module GLib
   @glib_log_handler_id = 0
 
   # module-level, so it's not GCd away
-  LOG_HANDLER = Proc.new do |domain, level, message, user_data|
+  LOG_HANDLER = Proc.new do |domain, level, message, _user_data|
     @logger.log(GLIB_TO_SEVERITY[level], message, domain)
   end
 
@@ -111,21 +128,13 @@ module GLib
         GLib::remove_log_handler
       }
     end
-
   end
-
 end
 
 module GObject
   extend FFI::Library
 
-  if FFI::Platform.windows?
-    gobject_libname = 'libgobject-2.0-0.dll'
-  else
-    gobject_libname = 'gobject-2.0'
-  end
-
-  ffi_lib gobject_libname
+  ffi_lib library_name('gobject-2.0', 0)
 
   # we can't just use ulong, windows has different int sizing rules
   if FFI::Platform::ADDRESS_SIZE == 64
@@ -151,14 +160,13 @@ module GObject
   GFLAGS_TYPE = g_type_from_name "GFlags"
   GSTR_TYPE = g_type_from_name "gchararray"
   GOBJECT_TYPE = g_type_from_name "GObject"
-
 end
 
 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
 #
@@ -204,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
@@ -245,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
@@ -385,7 +399,7 @@ require 'vips/gvalue'
 #
 # https://developer.gnome.org/glib/stable/glib-Message-Logging.html
 #
-# You can disable wanrings by defining the `VIPS_WARNING` environment variable.
+# You can disable warnings by defining the `VIPS_WARNING` environment variable.
 # You can enable info output by defining `VIPS_INFO`.
 #
 # # Exceptions
@@ -396,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
@@ -426,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
@@ -465,7 +528,7 @@ module Vips
   if FFI::Platform.windows?
     vips_libname = 'libvips-42.dll'
   else
-    vips_libname = File.expand_path(FFI::map_library_name('vips'), __dir__)
+    vips_libname = File.expand_path(FFI.map_library_name('vips'), __dir__)
   end
 
   ffi_lib vips_libname
@@ -528,7 +591,7 @@ module Vips
   # Turn libvips leak testing on and off. Handy for debugging ruby-vips, not
   # very useful for user code.
   def self.leak_set leak
-    vips_leak_set (leak ? 1 : 0)
+    vips_leak_set((leak ? 1 : 0))
   end
 
   attach_function :vips_cache_set_max, [:int], :void
@@ -612,15 +675,18 @@ 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
 
 require 'vips/object'
 require 'vips/operation'
 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'