ruby-vips 2.0.13 → 2.1.0

data/lib/vips/operationboolean.rb

@@ -1,14 +1,13 @@
 module Vips
+  # The type of boolean operation to perform on an image. See
+  # {Image#boolean}.
+  #
+  # * ':and' bitwise and
+  # * ':or' bitwise or
+  # * ':eor' bitwise eor
+  # * ':lshift' shift left n bits
+  # * ':rshift' shift right n bits
 
-    # The type of boolean operation to perform on an image. See 
-    # {Image#boolean}.
-    #
-    # * ':and' bitwise and
-    # * ':or' bitwise or
-    # * ':eor' bitwise eor
-    # * ':lshift' shift left n bits
-    # * ':rshift' shift right n bits
-
-    class OperationBoolean < Symbol
-    end
+  class OperationBoolean < Symbol
+  end
 end

data/lib/vips/operationcomplex.rb

@@ -1,12 +1,11 @@
 module Vips
+  # The type of complex operation to perform on an image. See
+  # {Image#complex}.
+  #
+  # * ':polar' to polar coordinates
+  # * ':rect' to rectangular coordinates
+  # * ':conj' complex conjugate
 
-    # The type of complex operation to perform on an image. See 
-    # {Image#complex}.
-    #
-    # * ':polar' to polar coordinates
-    # * ':rect' to rectangular coordinates
-    # * ':conj' complex conjugate
-
-    class OperationComplex < Symbol
-    end
+  class OperationComplex < Symbol
+  end
 end

data/lib/vips/operationcomplex2.rb

@@ -1,10 +1,9 @@
 module Vips
+  # The type of binary complex operation to perform on an image. See
+  # {Image#complex2}.
+  #
+  # * ':cross_phase' cross phase
 
-    # The type of binary complex operation to perform on an image. See 
-    # {Image#complex2}.
-    #
-    # * ':cross_phase' cross phase
-
-    class OperationComplex2 < Symbol
-    end
+  class OperationComplex2 < Symbol
+  end
 end

data/lib/vips/operationcomplexget.rb

@@ -1,11 +1,10 @@
 module Vips
+  # The type of complex projection operation to perform on an image. See
+  # {Image#complexget}.
+  #
+  # * ':real' get real part
+  # * ':imag' get imaginary part
 
-    # The type of complex projection operation to perform on an image. See 
-    # {Image#complexget}.
-    #
-    # * ':real' get real part
-    # * ':imag' get imaginary part
-
-    class OperationComplexget < Symbol
-    end
+  class OperationComplexget < Symbol
+  end
 end

data/lib/vips/operationmath.rb

@@ -1,18 +1,17 @@
 module Vips
+  # The math operation to perform on an image. See {Image#math}.
+  #
+  # * ':sin' sin(), angles in degrees
+  # * ':cos' cos(), angles in degrees
+  # * ':tan' tan(), angles in degrees
+  # * ':asin' asin(), angles in degrees
+  # * ':acos' acos(), angles in degrees
+  # * ':atan' atan(), angles in degrees
+  # * ':log' log base e
+  # * ':log10' log base 10
+  # * ':exp' e to the something
+  # * ':exp10' 10 to the something
 
-    # The math operation to perform on an image. See {Image#math}.
-    #
-    # * ':sin' sin(), angles in degrees
-    # * ':cos' cos(), angles in degrees
-    # * ':tan' tan(), angles in degrees
-    # * ':asin' asin(), angles in degrees
-    # * ':acos' acos(), angles in degrees
-    # * ':atan' atan(), angles in degrees
-    # * ':log' log base e 
-    # * ':log10' log base 10 
-    # * ':exp' e to the something
-    # * ':exp10' 10 to the something
-
-    class OperationMath < Symbol
-    end
+  class OperationMath < Symbol
+  end
 end

data/lib/vips/operationmath2.rb

@@ -1,10 +1,9 @@
 module Vips
+  # The binary math operation to perform on an image. See {Image#math2}.
+  #
+  # * ':pow' pow()
+  # * ':wop' pow(), but with the arguments reversed
 
-    # The binary math operation to perform on an image. See {Image#math2}.
-    #
-    # * ':pow' pow()
-    # * ':wop' pow(), but with the arguments reversed
-
-    class OperationMath2 < Symbol
-    end
+  class OperationMath2 < Symbol
+  end
 end

data/lib/vips/operationrelational.rb

@@ -1,15 +1,14 @@
 module Vips
+  # The type of relational operation to perform on an image. See
+  # {Image#relational}.
+  #
+  # * ':more' more than
+  # * ':less' less than
+  # * ':moreeq' more than or equal to
+  # * ':lesseq' less than or equal to
+  # * ':equal' equal to
+  # * ':noteq' not equal to
 
-    # The type of relational operation to perform on an image. See 
-    # {Image#relational}.
-    #
-    # * ':more' more than
-    # * ':less' less than
-    # * ':moreeq' more than or equal to
-    # * ':lesseq' less than or equal to
-    # * ':equal' equal to
-    # * ':noteq' not equal to
-
-    class OperationRelational < Symbol
-    end
+  class OperationRelational < Symbol
+  end
 end

data/lib/vips/operationround.rb

@@ -1,11 +1,10 @@
 module Vips
+  # The type of rounding to perform on an image. See {Image#round}.
+  #
+  # * ':ceil' round up
+  # * ':floor' round down
+  # * ':rint' round to nearest integer
 
-    # The type of rounding to perform on an image. See {Image#round}.
-    #
-    # * ':ceil' round up
-    # * ':floor' round down
-    # * ':rint' round to nearest integer
-
-    class OperationRound < Symbol
-    end
+  class OperationRound < Symbol
+  end
 end

data/lib/vips/region.rb

@@ -0,0 +1,73 @@
+# 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
+  attach_function :vips_region_new, [:pointer], :pointer
+
+  if Vips.at_least_libvips?(8, 8)
+    attach_function :vips_region_fetch, [:pointer, :int, :int, :int, :int, SizeStruct.ptr], :pointer
+    attach_function :vips_region_width, [:pointer], :int
+    attach_function :vips_region_height, [:pointer], :int
+  end
+
+  # A region on an image. Create one, then use `fetch` to quickly get a region
+  # of pixels.
+  #
+  # For example:
+  #
+  #  ```ruby
+  #  region = Vips::Region.new(image)
+  #  pixels = region.fetch(10, 10, 100, 100)
+  #  ```
+  class Region < Vips::Object
+    # The layout of the VipsRegion struct.
+    module RegionLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Object::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Object::Struct
+      include RegionLayout
+    end
+
+    class ManagedStruct < Vips::Object::ManagedStruct
+      include RegionLayout
+    end
+
+    def initialize(name)
+      ptr = Vips.vips_region_new name
+      raise Vips::Error if ptr.null?
+
+      super ptr
+    end
+
+    def width
+      Vips.vips_region_width self
+    end
+
+    def height
+      Vips.vips_region_height self
+    end
+
+    # Fetch a region filled with pixel data.
+    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.null?
+
+      # wrap up as an autopointer
+      ptr = FFI::AutoPointer.new(ptr, GLib::G_FREE)
+
+      ptr.get_bytes 0, len[:value]
+    end
+  end
+end

data/lib/vips/size.rb

@@ -1,13 +1,12 @@
 module Vips
+  # Controls whether an operation should upsize, downsize, or both up and
+  # downsize.
+  #
+  # * `:both` size both up and down
+  # * `:up` only upsize
+  # * `:down` only downsize
+  # * `:force` change aspect ratio
 
-    # Controls whether an operation should upsize, downsize, or both up and
-    # downsize. 
-    #
-    # * `:both` size both up and down
-    # * `:up` only upsize
-    # * `:down` only downsize
-    # * `:force` change aspect ratio
-
-    class Size < Symbol
-    end
+  class Size < Symbol
+  end
 end

data/lib/vips/source.rb

@@ -0,0 +1,88 @@
+# 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,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_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