vips 8.10.5 → 8.12.2

data/lib/vips/target.rb

@@ -4,10 +4,10 @@
 # Author::    John Cupitt  (mailto:jcupitt@gmail.com)
 # License::   MIT
 
-require 'ffi'
+require "ffi"
 
 module Vips
-  if Vips::at_least_libvips?(8, 9)
+  if Vips.at_least_libvips?(8, 9)
     attach_function :vips_target_new_to_descriptor, [:int], :pointer
     attach_function :vips_target_new_to_file, [:string], :pointer
     attach_function :vips_target_new_to_memory, [], :pointer
@@ -43,45 +43,44 @@ module Vips
     #
     # Pass targets to {Image#write_to_target} to write images to
     # them.
-    # 
+    #
     # @param descriptor [Integer] the file descriptor
     # @return [Target] the new Vips::Target
     def self.new_to_descriptor(descriptor)
-      ptr = Vips::vips_target_new_to_descriptor descriptor
+      ptr = Vips.vips_target_new_to_descriptor descriptor
       raise Vips::Error if ptr.null?
 
       Vips::Target.new ptr
     end
 
-    # Create a new target to a file name. 
+    # Create a new target to a file name.
     #
     # Pass targets to {Image#write_to_target} to write images to
     # them.
-    # 
+    #
     # @param filename [String] the name of the file
     # @return [Target] the new Vips::Target
     def self.new_to_file(filename)
-      raise Vips::Error, 'filename is nil' if filename.nil?
-      ptr = Vips::vips_target_new_to_file filename
+      raise Vips::Error, "filename is nil" if filename.nil?
+      ptr = Vips.vips_target_new_to_file filename
       raise Vips::Error if ptr.null?
 
       Vips::Target.new ptr
     end
 
-    # Create a new target to an area of memory. 
+    # Create a new target to an area of memory.
     #
     # Pass targets to {Image#write_to_target} to write images to
     # them.
     #
-    # Once the image has been written, use {Object#get}`("blob")` to read out 
+    # Once the image has been written, use {Object#get}`("blob")` to read out
     # the data.
-    # 
+    #
     # @return [Target] the new Vips::Target
     def self.new_to_memory
-      ptr = Vips::vips_target_new_to_memory 
+      ptr = Vips.vips_target_new_to_memory
 
       Vips::Target.new ptr
     end
-
   end
 end

data/lib/vips/targetcustom.rb

@@ -4,14 +4,14 @@
 # Author::    John Cupitt  (mailto:jcupitt@gmail.com)
 # License::   MIT
 
-require 'ffi'
+require "ffi"
 
 module Vips
-  if Vips::at_least_libvips?(8, 9)
+  if Vips.at_least_libvips?(8, 9)
     attach_function :vips_target_custom_new, [], :pointer
   end
 
-  # A target you can attach action signal handlers to to implememt 
+  # A target you can attach action signal handlers to to implememt
   # custom output types.
   #
   # For example:
@@ -23,7 +23,7 @@ module Vips
   # image.write_to_target target, ".png"
   # ```
   #
-  # (just an example -- of course in practice you'd use {Target#new_to_file} 
+  # (just an example -- of course in practice you'd use {Target#new_to_file}
   # to write to a named file)
   class TargetCustom < Vips::Target
     module TargetCustomLayout
@@ -44,17 +44,17 @@ module Vips
     end
 
     def initialize
-      pointer = Vips::vips_target_custom_new
+      pointer = Vips.vips_target_custom_new
       raise Vips::Error if pointer.null?
 
       super pointer
     end
 
     # The block is executed to write data to the source. The interface is
-    # exactly as IO::write, ie. it should write the string and return the 
+    # exactly as IO::write, ie. it should write the string and return the
     # number of bytes written.
     #
-    # @yieldparam bytes [String] Write these bytes to the file 
+    # @yieldparam bytes [String] Write these bytes to the file
     # @yieldreturn [Integer] The number of bytes written, or -1 on error
     def on_write &block
       signal_connect "write" do |p, len|
@@ -69,10 +69,9 @@ module Vips
     # The block is executed at the end of write. It should do any necessary
     # finishing action, such as closing a file.
     def on_finish &block
-      signal_connect "finish" do 
-        block.call()
+      signal_connect "finish" do
+        block.call
       end
     end
-
   end
 end

data/lib/vips/version.rb

@@ -1,4 +1,4 @@
 
 module Vips
-	VERSION = "8.10.5"
+	VERSION = "8.12.2"
 end

data/lib/vips.rb

@@ -4,8 +4,8 @@
 # Author::    John Cupitt  (mailto:jcupitt@gmail.com)
 # License::   MIT
 
-require 'ffi'
-require 'logger'
+require "ffi"
+require "logger"
 
 # This module uses FFI to make a simple layer over the glib and gobject
 # libraries.
@@ -27,9 +27,9 @@ def library_name(name, abi_number)
   if FFI::Platform.windows?
     "lib#{name}-#{abi_number}.dll"
   elsif FFI::Platform.mac?
-    "#{name}.#{abi_number}"
+    "lib#{name}.#{abi_number}.dylib"
   else
-    "#{name}.so.#{abi_number}"
+    "lib#{name}.so.#{abi_number}"
   end
 end
 
@@ -37,12 +37,12 @@ module GLib
   class << self
     attr_accessor :logger
   end
-  @logger = Logger.new(STDOUT)
+  @logger = Logger.new($stdout)
   @logger.level = Logger::WARN
 
   extend FFI::Library
 
-  ffi_lib library_name('glib-2.0', 0)
+  ffi_lib library_name("glib-2.0", 0)
 
   attach_function :g_malloc, [:size_t], :pointer
 
@@ -52,20 +52,20 @@ module GLib
 
   callback :g_log_func, [:string, :int, :string, :pointer], :void
   attach_function :g_log_set_handler,
-      [:string, :int, :g_log_func, :pointer], :int
+    [:string, :int, :g_log_func, :pointer], :int
   attach_function :g_log_remove_handler, [:string, :int], :void
 
   # log flags
-  LOG_FLAG_RECURSION          = 1 << 0
-  LOG_FLAG_FATAL              = 1 << 1
+  LOG_FLAG_RECURSION = 1 << 0
+  LOG_FLAG_FATAL = 1 << 1
 
   # GLib log levels
-  LOG_LEVEL_ERROR             = 1 << 2 # always fatal
-  LOG_LEVEL_CRITICAL          = 1 << 3
-  LOG_LEVEL_WARNING           = 1 << 4
-  LOG_LEVEL_MESSAGE           = 1 << 5
-  LOG_LEVEL_INFO              = 1 << 6
-  LOG_LEVEL_DEBUG             = 1 << 7
+  LOG_LEVEL_ERROR = 1 << 2 # always fatal
+  LOG_LEVEL_CRITICAL = 1 << 3
+  LOG_LEVEL_WARNING = 1 << 4
+  LOG_LEVEL_MESSAGE = 1 << 5
+  LOG_LEVEL_INFO = 1 << 6
+  LOG_LEVEL_DEBUG = 1 << 7
 
   # map glib levels to Logger::Severity
   GLIB_TO_SEVERITY = {
@@ -83,9 +83,9 @@ 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 { |domain, level, message, _user_data|
     @logger.log(GLIB_TO_SEVERITY[level], message, domain)
-  end
+  }
 
   def self.remove_log_handler
     if @glib_log_handler_id != 0 && @glib_log_domain
@@ -95,7 +95,7 @@ module GLib
   end
 
   def self.set_log_domain domain
-    GLib::remove_log_handler
+    GLib.remove_log_handler
 
     @glib_log_domain = domain
 
@@ -125,7 +125,7 @@ module GLib
       # on shutdown and we don't want LOG_HANDLER to be invoked
       # after Ruby has gone
       at_exit {
-        GLib::remove_log_handler
+        GLib.remove_log_handler
       }
     end
   end
@@ -134,7 +134,7 @@ end
 module GObject
   extend FFI::Library
 
-  ffi_lib library_name('gobject-2.0', 0)
+  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
@@ -162,8 +162,8 @@ module GObject
   GOBJECT_TYPE = g_type_from_name "GObject"
 end
 
-require 'vips/gobject'
-require 'vips/gvalue'
+require "vips/gobject"
+require "vips/gvalue"
 
 # This module provides a binding for the [libvips image processing
 # library](https://libvips.github.io/libvips/).
@@ -208,12 +208,10 @@ require 'vips/gvalue'
 # for full details
 # on the various modes available.
 #
-# You can also load formatted images from
-# 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.
+# You can also load formatted images from 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:
 #
@@ -256,7 +254,7 @@ 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 
+# Use {Target} and {Image#write_to_target} to write formatted images to
 # any data sink, for example URIs.
 #
 # # How it works
@@ -409,36 +407,83 @@ require 'vips/gvalue'
 #
 # # Automatic YARD documentation
 #
-# The bulk of these API docs are generated automatically by
-# {Vips::Yard::generate}. It examines
-# libvips and writes a summary of each operation and the arguments and options
-# that that operation expects.
+# The bulk of these API docs are generated automatically by {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://libvips.github.io/libvips/API/current)
+# Use the [C API # docs](https://libvips.github.io/libvips/API/current)
 # for more detail.
 #
 # # Enums
 #
 # The libvips enums, such as `VipsBandFormat` appear in ruby-vips as Symbols
 # like `:uchar`. They are documented as a set of classes for convenience, see
-# the class list.
+# {Vips::BandFormat}, for example.
 #
 # # Draw operations
 #
-# Paint operations like {Image#draw_circle} and {Image#draw_line}
-# modify their input image. This
-# makes them hard to use with the rest of libvips: you need to be very careful
-# about the order in which operations execute or you can get nasty crashes.
+# There are two ways of calling the libvips draw operations, like
+# {Image#draw_circle} and {Image#draw_line}.
+#
+# First, you can use them like functions. For example:
+#
+# ```ruby
+# y = x.draw_line 255, 0, 0, x.width, x.height
+# ```
+#
+# This will make a new image, `y`, which is a copy of `x` but with a line
+# drawn across it. `x` is unchanged.
+#
+# This is simple, but will be slow if you want to draw many lines, since
+# ruby-vips will make a copy of the whole image each time.
+#
+# You can use {Image#mutate} to make a {MutableImage}. This is an image which
+# is unshared and is only available inside the {Image#mutate} block. Within
+# this block, you can use `!` versions of the draw operations to modify images
+# and avoid the copy. For example:
+#
+# ```ruby
+# image = image.mutate do |mutable|
+#   (0 ... 1).step(0.01) do |i|
+#     mutable.draw_line! 255, mutable.width * i, 0, 0, mutable.height * (1 - i)
+#   end
+# end
+# ```
+#
+# Now each {Image#draw_line} will directly modify the mutable image, saving
+# the copy. This is much faster and needs much less memory.
+#
+# # Metadata read
+#
+# Use {Image#get_fields} to get a list of the metadata fields that an image
+# supports. ICC profiles, for example, are in a field called
+# `icc-profile-data`. Use `vipsheader -a something.jpg` at the command-line
+# to see all the fields on an image.
 #
-# The wrapper spots operations of this type and makes a private copy of the
-# image in memory before calling the operation. This stops crashes, but it does
-# make it inefficient. If you draw 100 lines on an image, for example, you'll
-# copy the image 100 times. The wrapper does make sure that memory is recycled
-# where possible, so you won't have 100 copies in memory.
+# Use {Image#get_typeof} to get the type of a field. Types are integers, with
+# 0 meaning "no such field". Constants like {GObject::GINT_TYPE} are useful for
+# testing field types.
 #
-# If you want to avoid the copies, you'll need to call drawing operations
-# yourself.
+# You can read image metadata using {Image#get}. The field value is converted
+# to a Ruby value in the obvious way.
+#
+# # Metadata write
+#
+# You can also set and remove image metadata fields. Images are immutable, so
+# you must make any changes inside a {Image#mutate} block. For example:
+#
+# ```ruby
+# image = image.mutate do |mutable|
+#   image.get_fields.each do |field|
+#     mutable.remove! field unless field == "icc-profile-data"
+#   end
+# end
+# ```
+#
+# To remove all metadata except the icc profile.
+#
+# You can use {MutableImage#set!} to change the value of an existing field,
+# and {MutableImage#set_type!} to create a new field with a specified type.
 #
 # # Progress
 #
@@ -448,7 +493,7 @@ require 'vips/gvalue'
 # ```ruby
 # image = Vips::Image.black 1, 100000
 # image.set_progress true
-# 
+#
 # def progress_to_s(name, progress)
 #   puts "#{name}:"
 #   puts "    run = #{progress[:run]}"
@@ -457,23 +502,23 @@ require 'vips/gvalue'
 #   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.
 #
@@ -525,21 +570,22 @@ require 'vips/gvalue'
 module Vips
   extend FFI::Library
 
-  if FFI::Platform.windows?
-    vips_libname = 'libvips-42.dll'
-  else
-    vips_libname = File.expand_path(FFI.map_library_name('vips'), __dir__)
-  end
-
-  ffi_lib vips_libname
+  ffi_lib File.expand_path(library_name("vips", 42), __dir__)
 
   LOG_DOMAIN = "VIPS"
-  GLib::set_log_domain LOG_DOMAIN
+  GLib.set_log_domain LOG_DOMAIN
 
-  typedef :ulong, :GType
+  # we can't just use ulong, windows has different int sizing rules
+  if FFI::Platform::ADDRESS_SIZE == 64
+    typedef :uint64, :GType
+  else
+    typedef :uint32, :GType
+  end
 
   attach_function :vips_error_buffer, [], :string
   attach_function :vips_error_clear, [], :void
+  attach_function :vips_error_freeze, [], :void
+  attach_function :vips_error_thaw, [], :void
 
   # The ruby-vips error class.
   class Error < RuntimeError
@@ -548,9 +594,9 @@ module Vips
     def initialize msg = nil
       if msg
         @details = msg
-      elsif Vips::vips_error_buffer != ""
-        @details = Vips::vips_error_buffer
-        Vips::vips_error_clear
+      elsif Vips.vips_error_buffer != ""
+        @details = Vips.vips_error_buffer
+        Vips.vips_error_clear
       else
         @details = nil
       end
@@ -560,7 +606,7 @@ module Vips
     #
     # @return [String] The error message
     def to_s
-      if @details != nil
+      if !@details.nil?
         @details
       else
         super.to_s
@@ -570,8 +616,8 @@ module Vips
 
   attach_function :vips_init, [:string], :int
 
-  if Vips::vips_init($0) != 0
-    throw Vips::get_error
+  if Vips.vips_init($0) != 0
+    throw Vips.get_error
   end
 
   # don't use at_exit to call vips_shutdown, it causes problems with fork, and
@@ -579,7 +625,12 @@ module Vips
 
   attach_function :vips_leak_set, [:int], :void
   attach_function :vips_vector_set_enabled, [:int], :void
+  attach_function :vips_vector_isenabled, [], :int
   attach_function :vips_concurrency_set, [:int], :void
+  attach_function :vips_concurrency_get, [], :int
+
+  # Track the original default concurrency so we can reset to it.
+  DEFAULT_CONCURRENCY = vips_concurrency_get
 
   # vips_foreign_get_suffixes was added in libvips 8.8
   begin
@@ -594,20 +645,66 @@ module Vips
     vips_leak_set((leak ? 1 : 0))
   end
 
+  attach_function :vips_tracked_get_mem, [], :int
+  attach_function :vips_tracked_get_mem_highwater, [], :int
+  attach_function :vips_tracked_get_allocs, [], :int
+  attach_function :vips_tracked_get_files, [], :int
+  attach_function :vips_cache_get_max, [], :int
+  attach_function :vips_cache_get_max_mem, [], :int
+  attach_function :vips_cache_get_max_files, [], :int
   attach_function :vips_cache_set_max, [:int], :void
   attach_function :vips_cache_set_max_mem, [:int], :void
   attach_function :vips_cache_set_max_files, [:int], :void
+  attach_function :vips_cache_print, [], :void
+  attach_function :vips_cache_drop_all, [], :void
+
+  # Get the number of bytes currently allocated via vips_malloc.
+  def self.tracked_mem
+    vips_tracked_get_mem
+  end
+
+  # Get the greatest number of bytes ever actively allocated via vips_malloc.
+  def self.tracked_mem_highwater
+    vips_tracked_get_mem_highwater
+  end
+
+  # Get the number of active allocations.
+  def self.tracked_allocs
+    vips_tracked_get_allocs
+  end
+
+  # Get the number of open files.
+  def self.tracked_files
+    vips_tracked_get_files
+  end
+
+  # Get the maximum number of operations that libvips should cache.
+  def self.cache_max
+    vips_cache_get_max
+  end
+
+  # Get the maximum amount of memory that libvips uses for the operation cache.
+  def self.cache_max_mem
+    vips_cache_get_max_mem
+  end
+
+  # Get the maximum number of files libvips keeps open in the operation cache.
+  def self.cache_max_files
+    vips_cache_get_max_files
+  end
 
   # Set the maximum number of operations that libvips should cache. Set 0 to
   # disable the operation cache. The default is 1000.
   def self.cache_set_max size
     vips_cache_set_max size
+    cache_max
   end
 
   # Set the maximum amount of memory that libvips should use for the operation
   # cache. Set 0 to disable the operation cache. The default is 100mb.
   def self.cache_set_max_mem size
     vips_cache_set_max_mem size
+    cache_max_mem
   end
 
   # Set the maximum number of files libvips should keep open in the
@@ -615,12 +712,43 @@ module Vips
   # 100.
   def self.cache_set_max_files size
     vips_cache_set_max_files size
+    cache_max_files
+  end
+
+  # Print the libvips operation cache to stdout. Handy for debugging.
+  def self.cache_print # :nodoc:
+    vips_cache_print
+  end
+
+  # Drop the libvips operation cache. Handy for leak tracking.
+  def self.cache_drop_all # :nodoc:
+    vips_cache_drop_all
   end
 
-  # Set the size of the libvips worker pool. This defaults to the number of
-  # hardware threads on your computer. Set to 1 to disable threading.
+  # Get the size of libvips worker pools. Defaults to the VIPS_CONCURRENCY env
+  # var or the number of hardware threads on your computer.
+  def self.concurrency
+    vips_concurrency_get
+  end
+
+  # Get the default size of libvips worker pools.
+  def self.concurrency_default
+    DEFAULT_CONCURRENCY
+  end
+
+  # Set the size of each libvips worker pool. Max 1024 threads. Set to 1 to
+  # disable threading. Set to 0 or nil to reset to default.
   def self.concurrency_set n
+    n = DEFAULT_CONCURRENCY if n.to_i == 0
     vips_concurrency_set n
+    concurrency
+  end
+
+  # Whether SIMD and the run-time compiler are enabled. This can give a nice
+  # speed-up, but can also be unstable on some systems or with some versions
+  # of the run-time compiler.
+  def self.vector?
+    vips_vector_isenabled == 1
   end
 
   # Enable or disable SIMD and the run-time compiler. This can give a nice
@@ -628,6 +756,7 @@ module Vips
   # of the run-time compiler.
   def self.vector_set enabled
     vips_vector_set_enabled(enabled ? 1 : 0)
+    vector?
   end
 
   # Deprecated compatibility function.
@@ -635,7 +764,7 @@ module Vips
   # Don't use this, instead change GLib::logger.level.
   def self.set_debug debug
     if debug
-      GLib::logger.level = Logger::DEBUG
+      GLib.logger.level = Logger::DEBUG
     end
   end
 
@@ -657,36 +786,37 @@ module Vips
     # vips_foreign_get_suffixes() was added in libvips 8.8
     return [] unless Vips.respond_to? :vips_foreign_get_suffixes
 
-    array = Vips::vips_foreign_get_suffixes
+    array = Vips.vips_foreign_get_suffixes
 
     names = []
     p = array
     until (q = p.read_pointer).null?
       suff = q.read_string
-      GLib::g_free q
+      GLib.g_free q
       names << suff unless names.include? suff
       p += FFI::Type::POINTER.size
     end
-    GLib::g_free array
+    GLib.g_free array
 
     names
   end
 
-  LIBRARY_VERSION = Vips::version_string
+  LIBRARY_VERSION = Vips.version_string
 
   # libvips has this arbitrary number as a sanity-check upper bound on image
   # 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'
+require "vips/object"
+require "vips/operation"
+require "vips/image"
+require "vips/mutableimage"
+require "vips/interpolate"
+require "vips/region"
+require "vips/version"
+require "vips/connection"
+require "vips/source"
+require "vips/sourcecustom"
+require "vips/target"
+require "vips/targetcustom"