ruby-vips 2.0.16 → 2.0.17

data/lib/vips/region.rb

@@ -45,7 +45,7 @@ module Vips
 
     def initialize(name)
       ptr = Vips::vips_region_new name
-      raise Vips::Error if ptr.nil?
+      raise Vips::Error if ptr.null?
 
       super ptr
     end
@@ -62,7 +62,7 @@ module Vips
     def fetch(left, top, width, height)
       len = Vips::SizeStruct.new
       ptr = Vips::vips_region_fetch self, left, top, width, height, len
-      raise Vips::Error if ptr.nil?
+      raise Vips::Error if ptr.null?
 
       # wrap up as an autopointer
       ptr = FFI::AutoPointer.new(ptr, GLib::G_FREE)

data/lib/vips/source.rb

@@ -0,0 +1,89 @@
+# 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_source_new_from_descriptor, [:int], :pointer
+    attach_function :vips_source_new_from_file, [:pointer], :pointer
+    attach_function :vips_source_new_from_memory, [:pointer, :size_t], :pointer
+  end
+
+  # A source. For example:
+  #
+  # ```ruby
+  # source = Vips::Source.new_from_file("k2.jpg")
+  # image = Vips::Image.new_from_source(source)
+  # ```
+  class Source < Vips::Connection
+    module SourceLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Connection::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Connection::Struct
+      include SourceLayout
+    end
+
+    class ManagedStruct < Vips::Connection::ManagedStruct
+      include SourceLayout
+    end
+
+    # Create a new source from a file descriptor. File descriptors are
+    # small integers, for example 0 is stdin.
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    # 
+    # @param descriptor [Integer] the file descriptor
+    # @return [Source] the new Vips::Source
+    def self.new_from_descriptor(descriptor)
+      ptr = Vips::vips_source_new_from_descriptor descriptor
+      raise Vips::Error if ptr.null?
+
+      Vips::Source.new ptr
+    end
+
+    # Create a new source from a file name. 
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    # 
+    # @param filename [String] the name of the file
+    # @return [Source] the new Vips::Source
+    def self.new_from_file(filename)
+      raise Vips::Error, "filename is nil" if filename.nil?
+      ptr = Vips::vips_source_new_from_file filename
+      raise Vips::Error if ptr.null?
+
+      Vips::Source.new ptr
+    end
+
+    # Create a new source from an area of memory. Memory areas can be
+    # strings, arrays and so forth -- anything that supports bytesize.
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    # 
+    # @param data [String] memory area 
+    # @return [Source] the new Vips::Source
+    def self.new_from_memory(data)
+      ptr = Vips::vips_source_new_from_memory data, data.bytesize
+      raise Vips::Error if ptr.null?
+
+      # FIXME do we need to keep a ref to the underlying memory area? what 
+      # about Image.new_from_buffer? Does that need a secret ref too?
+
+      Vips::Source.new ptr
+    end
+
+  end
+end

data/lib/vips/sourcecustom.rb

@@ -0,0 +1,90 @@
+# 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_source_custom_new, [], :pointer
+  end
+
+  # A source you can attach action signal handlers to to implement 
+  # custom input types.
+  #
+  # For example:
+  #
+  # ```ruby
+  # file = File.open "some/file/name", "rb"
+  # source = Vips::SourceCustom.new
+  # source.on_read { |length| file.read length }
+  # image = Vips::Image.new_from_source source
+  # ```
+  #
+  # (just an example -- of course in practice you'd use {Source#new_from_file} 
+  # to read from a named file)
+  class SourceCustom < Vips::Source
+    module SourceCustomLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Source::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Source::Struct
+      include SourceCustomLayout
+    end
+
+    class ManagedStruct < Vips::Source::ManagedStruct
+      include SourceCustomLayout
+    end
+
+    def initialize
+      pointer = Vips::vips_source_custom_new
+      raise Vips::Error if pointer.null?
+
+      super pointer
+    end
+
+    # The block is executed to read data from the source. The interface is
+    # exactly as IO::read, ie. it takes a maximum number of bytes to read and
+    # returns a string of bytes from the source, or nil if the source is already
+    # at end of file.
+    #
+    # @yieldparam length [Integer] Read and return up to this many bytes
+    # @yieldreturn [String] Up to length bytes of data, or nil for EOF
+    def on_read &block
+      signal_connect "read" do |buf, len|
+        chunk = block.call len
+        return 0 if chunk == nil
+        bytes_read = chunk.bytesize
+        buf.put_bytes(0, chunk, 0, bytes_read)
+        chunk.clear
+
+        bytes_read
+      end
+    end
+
+    # The block is executed to seek the source. The interface is exactly as
+    # IO::seek, ie. it should take an offset and whence, and return the 
+    # new read position.
+    #
+    # This handler is optional -- if you do not attach a seek handler,
+    # {Source} will treat your source like an unseekable pipe object and
+    # do extra caching.
+    #
+    # @yieldparam offset [Integer] Seek offset
+    # @yieldparam whence [Integer] Seek whence
+    # @yieldreturn [Integer] the new read position, or -1 on error
+    def on_seek &block
+      signal_connect "seek" do |offset, whence|
+        block.call offset, whence
+      end
+    end
+
+  end
+end

data/lib/vips/target.rb

@@ -0,0 +1,87 @@
+# 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_target_new_to_descriptor, [:int], :pointer
+    attach_function :vips_target_new_to_file, [:string], :pointer
+    attach_function :vips_target_new_to_memory, [], :pointer
+  end
+
+  # A target. For example:
+  #
+  # ```ruby
+  # target = Vips::Target.new_to_file('k2.jpg')
+  # image.write_to_target(target, '.jpg')
+  # ```
+  class Target < Vips::Connection
+    # The layout of the VipsRegion struct.
+    module TargetLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Connection::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Connection::Struct
+      include TargetLayout
+    end
+
+    class ManagedStruct < Vips::Connection::ManagedStruct
+      include TargetLayout
+    end
+
+    # Create a new target to a file descriptor. File descriptors are
+    # small integers, for example 1 is stdout.
+    #
+    # 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
+      raise Vips::Error if ptr.null?
+
+      Vips::Target.new ptr
+    end
+
+    # 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 if ptr.null?
+
+      Vips::Target.new ptr
+    end
+
+    # 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 
+    # the data.
+    # 
+    # @return [Target] the new Vips::Target
+    def self.new_to_memory
+      ptr = Vips::vips_target_new_to_memory 
+
+      Vips::Target.new ptr
+    end
+
+  end
+end

data/lib/vips/targetcustom.rb

@@ -0,0 +1,78 @@
+# 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_target_custom_new, [], :pointer
+  end
+
+  # A target you can attach action signal handlers to to implememt 
+  # custom output types.
+  #
+  # For example:
+  #
+  # ```ruby
+  # file = File.open "some/file/name", "wb"
+  # target = Vips::TargetCustom.new
+  # target.on_write { |bytes| file.write bytes }
+  # image.write_to_target target, ".png"
+  # ```
+  #
+  # (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
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Target::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Target::Struct
+      include TargetCustomLayout
+    end
+
+    class ManagedStruct < Vips::Target::ManagedStruct
+      include TargetCustomLayout
+    end
+
+    def initialize
+      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 
+    # number of bytes written.
+    #
+    # @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|
+        chunk = p.get_bytes(0, len)
+        bytes_written = block.call chunk
+        chunk.clear
+
+        bytes_written
+      end
+    end
+
+    # 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()
+      end
+    end
+
+  end
+end

data/lib/vips/version.rb

@@ -1,3 +1,3 @@
 module Vips
-  VERSION = "2.0.16"
+  VERSION = "2.0.17"
 end

data/ruby-vips.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email = "jcupitt@gmail.com"
 
   spec.summary = "Ruby extension for the vips image processing library."
-  spec.description = "ruby-vips is a binding for the vips image processing library. It is extremely fast and it can process huge images without loading the whole image in memory."
+  spec.description = "ruby-vips is a binding for the vips image processing library. It is fast and it can process large images without loading the whole image in memory."
   spec.homepage = "http://github.com/libvips/ruby-vips"
   spec.licenses = ["MIT"]
 
@@ -39,4 +39,6 @@ Gem::Specification.new do |spec|
   if Gem.ruby_version >= Gem::Version.new("2.2")
     spec.add_development_dependency "rubocop", ["~> 0.64"]
   end
+
+  spec.metadata["msys2_mingw_dependencies"] = "libvips"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-vips
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors:
 - John Cupitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -128,8 +128,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.64'
-description: ruby-vips is a binding for the vips image processing library. It is extremely
-  fast and it can process huge images without loading the whole image in memory.
+description: ruby-vips is a binding for the vips image processing library. It is fast
+  and it can process large images without loading the whole image in memory.
 email: jcupitt@gmail.com
 executables: []
 extensions: []
@@ -151,6 +151,7 @@ files:
 - TODO
 - VERSION
 - example/annotate.rb
+- example/connection.rb
 - example/daltonize8.rb
 - example/example1.rb
 - example/example2.rb
@@ -158,6 +159,7 @@ files:
 - example/example4.rb
 - example/example5.rb
 - example/inheritance_with_refcount.rb
+- example/progress.rb
 - example/thumb.rb
 - example/trim8.rb
 - example/watermark.rb
@@ -173,6 +175,7 @@ files:
 - lib/vips/blend_mode.rb
 - lib/vips/coding.rb
 - lib/vips/compass_direction.rb
+- lib/vips/connection.rb
 - lib/vips/direction.rb
 - lib/vips/extend.rb
 - lib/vips/gobject.rb
@@ -195,12 +198,17 @@ files:
 - lib/vips/operationround.rb
 - lib/vips/region.rb
 - lib/vips/size.rb
+- lib/vips/source.rb
+- lib/vips/sourcecustom.rb
+- lib/vips/target.rb
+- lib/vips/targetcustom.rb
 - lib/vips/version.rb
 - ruby-vips.gemspec
 homepage: http://github.com/libvips/ruby-vips
 licenses:
 - MIT
-metadata: {}
+metadata:
+  msys2_mingw_dependencies: libvips
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -216,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby extension for the vips image processing library.