ruby-vips 2.0.13 → 2.1.0

data/lib/vips/access.rb

@@ -1,11 +1,11 @@
 module Vips
-    # The type of access an operation has to supply. 
-    # 
-    # *   `:random` means requests can come in any order. 
-    # 
-    # *   `:sequential` means requests will be top-to-bottom, but with some
-    #     amount of buffering behind the read point for small non-local
-    #     accesses. 
-    class Access < Symbol
-    end
+  # The type of access an operation has to supply.
+  #
+  # *   `:random` means requests can come in any order.
+  #
+  # *   `:sequential` means requests will be top-to-bottom, but with some
+  #     amount of buffering behind the read point for small non-local
+  #     accesses.
+  class Access < Symbol
+  end
 end

data/lib/vips/align.rb

@@ -1,11 +1,10 @@
 module Vips
+  # Various types of alignment. See {Image#join}, for example.
+  #
+  # * `:low` Align on the low coordinate edge
+  # * `:centre` Align on the centre
+  # * `:high` Align on the high coordinate edge
 
-    # Various types of alignment. See {Image#join}, for example.
-    #
-    # * `:low` Align on the low coordinate edge
-    # * `:centre` Align on the centre
-    # * `:high` Align on the high coordinate edge
-
-    class Align < Symbol
-    end
+  class Align < Symbol
+  end
 end

data/lib/vips/angle.rb

@@ -1,12 +1,11 @@
 module Vips
+  # Various fixed 90 degree rotation angles. See {Image#rot}.
+  #
+  # * `:d0` no rotate
+  # * `:d90` 90 degrees clockwise
+  # * `:d180` 180 degrees
+  # * `:d270` 90 degrees anti-clockwise
 
-    # Various fixed 90 degree rotation angles. See {Image#rot}.
-    #
-    # * `:d0` no rotate
-    # * `:d90` 90 degrees clockwise
-    # * `:d180` 180 degrees 
-    # * `:d270` 90 degrees anti-clockwise
-
-    class Angle < Symbol
-    end
+  class Angle < Symbol
+  end
 end

data/lib/vips/angle45.rb

@@ -1,16 +1,15 @@
 module Vips
+  # Various fixed 45 degree rotation angles. See {Image#rot45}.
+  #
+  # * `:d0` no rotate
+  # * `:d45` 45 degrees clockwise
+  # * `:d90` 90 degrees clockwise
+  # * `:d135` 135 degrees clockwise
+  # * `:d180` 180 degrees
+  # * `:d225` 135 degrees anti-clockwise
+  # * `:d270` 90 degrees anti-clockwise
+  # * `:d315` 45 degrees anti-clockwise
 
-    # Various fixed 45 degree rotation angles. See {Image#rot45}.
-    #
-    # * `:d0` no rotate
-    # * `:d45` 45 degrees clockwise 
-    # * `:d90` 90 degrees clockwise
-    # * `:d135` 135 degrees clockwise
-    # * `:d180` 180 degrees 
-    # * `:d225` 135 degrees anti-clockwise
-    # * `:d270` 90 degrees anti-clockwise
-    # * `:d315` 45 degrees anti-clockwise
-
-    class Angle45 < Symbol
-    end
+  class Angle45 < Symbol
+  end
 end

data/lib/vips/bandformat.rb

@@ -1,20 +1,18 @@
 module Vips
-
-    # The format used for each band element. Each corresponds to a native C type
-    # for the current machine.
-    #
-    # * `:notset` invalid setting
-    # * `:uchar` unsigned char format
-    # * `:char` char format
-    # * `:ushort` unsigned short format
-    # * `:short` short format
-    # * `:uint` unsigned int format
-    # * `:int` int format
-    # * `:float` float format
-    # * `:complex` complex (two floats) format
-    # * `:double` double float format
-    # * `:dpcomplex` double complex (two double) format
-    class BandFormat < Symbol
-    end
-
+  # The format used for each band element. Each corresponds to a native C type
+  # for the current machine.
+  #
+  # * `:notset` invalid setting
+  # * `:uchar` unsigned char format
+  # * `:char` char format
+  # * `:ushort` unsigned short format
+  # * `:short` short format
+  # * `:uint` unsigned int format
+  # * `:int` int format
+  # * `:float` float format
+  # * `:complex` complex (two floats) format
+  # * `:double` double float format
+  # * `:dpcomplex` double complex (two double) format
+  class BandFormat < Symbol
+  end
 end

data/lib/vips/blend_mode.rb

@@ -0,0 +1,36 @@
+module Vips
+  # Blend mode to use when compositing images. See {Image#composite}.
+  #
+  # * `:clear` where the second object is drawn, the first is removed
+  # * `:source` the second object is drawn as if nothing were below
+  # * `:over` the image shows what you would expect if you held two
+  #    semi-transparent slides on top of each other
+  # * `:in` the first object is removed completely, the second is only
+  #    drawn where the first was
+  # * `:out` the second is drawn only where the first isn't
+  # * `:atop` this leaves the first object mostly intact, but mixes both
+  #    objects in the overlapping area
+  # * `:dest` leaves the first object untouched, the second is discarded
+  #    completely
+  # * `:dest_over` like `:over`, but swaps the arguments
+  # * `:dest_in` like `:in`, but swaps the arguments
+  # * `:dest_out` like `:out`, but swaps the arguments
+  # * `:dest_atop` like `:atop`, but swaps the arguments
+  # * `:xor` something like a difference operator
+  # * `:add` a bit like adding the two images
+  # * `:saturate` a bit like the darker of the two
+  # * `:multiply` at least as dark as the darker of the two inputs
+  # * `:screen` at least as light as the lighter of the inputs
+  # * `:overlay` multiplies or screens colors, depending on the lightness
+  # * `:darken` the darker of each component
+  # * `:lighten` the lighter of each component
+  # * `:colour_dodge` brighten first by a factor second
+  # * `:colour_burn` darken first by a factor of second
+  # * `:hard_light` multiply or screen, depending on lightness
+  # * `:soft_light` darken or lighten, depending on lightness
+  # * `:difference` difference of the two
+  # * `:exclusion` somewhat like `:difference`, but lower-contrast
+
+  class BlendMode < Symbol
+  end
+end

data/lib/vips/coding.rb

@@ -1,14 +1,13 @@
 module Vips
-
-    # How pixels are coded. 
-    #
-    # Normally, pixels are uncoded and can be manipulated as you would expect.
-    # However some file formats code pixels for compression, and sometimes it's
-    # useful to be able to manipulate images in the coded format.
-    #
-    # * `:none` pixels are not coded
-    # * `:labq` pixels encode 3 float CIELAB values as 4 uchar
-    # * `:rad` pixels encode 3 float RGB as 4 uchar (Radiance coding)
-    class Coding < Symbol
-    end
+  # How pixels are coded.
+  #
+  # Normally, pixels are uncoded and can be manipulated as you would expect.
+  # However some file formats code pixels for compression, and sometimes it's
+  # useful to be able to manipulate images in the coded format.
+  #
+  # * `:none` pixels are not coded
+  # * `:labq` pixels encode 3 float CIELAB values as 4 uchar
+  # * `:rad` pixels encode 3 float RGB as 4 uchar (Radiance coding)
+  class Coding < Symbol
+  end
 end

data/lib/vips/compass_direction.rb

@@ -1,17 +1,16 @@
 module Vips
+  # A direction on a compass used for placing images. See {Image#gravity}.
+  #
+  # * `:centre`
+  # * `:north`
+  # * `:east`
+  # * `:south`
+  # * `:west`
+  # * `:"north-east"`
+  # * `:"south-east"`
+  # * `:"south-west"`
+  # * `:"north-west"`
 
-    # A direction on a compass used for placing images. See {Image#gravity}.
-    #
-    # * `:centre`
-    # * `:north`
-    # * `:east`
-    # * `:south`
-    # * `:west`
-    # * `:north-east`
-    # * `"south-east`
-    # * `:south-west`
-    # * `:north-west`
-
-    class CompassDirection < Symbol
-    end
+  class CompassDirection < Symbol
+  end
 end

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

@@ -1,11 +1,10 @@
 module Vips
+  # Operations like {Image#flip} need to be told whether to flip
+  # left-right or top-bottom.
+  #
+  # *   `:horizontal` left-right
+  # *   `:vertical` top-bottom
 
-    # Operations like {Image#flip} need to be told whether to flip 
-    # left-right or top-bottom. 
-    #
-    # *   `:horizontal` left-right 
-    # *   `:vertical` top-bottom
-
-    class Direction < Symbol
-    end
+  class Direction < Symbol
+  end
 end

data/lib/vips/extend.rb

@@ -1,17 +1,16 @@
 module Vips
+  # When the edges of an image are extended, you can specify
+  # how you want the extension done.
+  # See {Image#embed}, {Image#conv}, {Image#affine} and
+  # so on.
+  #
+  # * `:black` new pixels are black, ie. all bits are zero.
+  # * `:copy` each new pixel takes the value of the nearest edge pixel
+  # * `:repeat` the image is tiled to fill the new area
+  # * `:mirror` the image is reflected and tiled to reduce hash edges
+  # * `:white` new pixels are white, ie. all bits are set
+  # * `:background` colour set from the @background property
 
-    # When the edges of an image are extended, you can specify
-    # how you want the extension done. 
-    # See {Image#embed}, {Image#conv}, {Image#affine} and 
-    # so on.
-    #
-    # * `:black` new pixels are black, ie. all bits are zero. 
-    # * `:copy` each new pixel takes the value of the nearest edge pixel
-    # * `:repeat` the image is tiled to fill the new area
-    # * `:mirror` the image is reflected and tiled to reduce hash edges
-    # * `:white` new pixels are white, ie. all bits are set
-    # * `:background` colour set from the @background property
-
-    class Extend < Symbol
-    end
+  class Extend < Symbol
+  end
 end

data/lib/vips/gobject.rb

@@ -4,119 +4,130 @@
 # Author::    John Cupitt  (mailto:jcupitt@gmail.com)
 # License::   MIT
 
-require 'ffi'
-require 'forwardable'
+require "ffi"
+require "forwardable"
 
 module GObject
-
-    # we have a number of things we need to inherit in different ways:
-    #
-    # - we want to be able to subclass GObject in Ruby in a simple way
-    # - the layouts of the nested structs need to inherit
-    # - we need to be able to cast between structs which share a base struct
-    #   without creating new wrappers or messing up refcounting
-    # - we need automatic gobject refcounting
-    #
-    # the solution is to split the class into four areas which we treat
-    # differently:
-    #
-    # - we have a "wrapper" Ruby class to allow easy subclassing ... this has a
-    #   @struct member which holds the actual pointer
-    # - we use "forwardable" to forward the various ffi methods on to the
-    #   @struct member ... we arrange things so that subclasses do not need to
-    #   do the forwarding themselves
-    # - we have two versions of the struct: a plain one which we can use for
-    #   casting that will not change the refcounts
-    # - and a managed one with an unref which we just use for .new
-    # - we separate the struct layout into a separate module to avoid repeating
-    #   ourselves
-
-    class GObject
-        extend Forwardable
-        extend SingleForwardable
-
-        def_instance_delegators :@struct, :[], :to_ptr
-        def_single_delegators :ffi_struct, :ptr
-
-        # the layout of the GObject struct
-        module GObjectLayout
-            def self.included base
-                base.class_eval do
-                    layout :g_type_instance, :pointer,
-                           :ref_count, :uint,
-                           :qdata, :pointer
-                end
-            end
-        end
-
-        # the struct with unref ... manage object lifetime with this
-        class ManagedStruct < FFI::ManagedStruct
-            include GObjectLayout
-
-            def self.release ptr
-                # GLib::logger.debug("GObject::GObject::ManagedStruct.release") {
-                #     "unreffing #{ptr}"
-                # }
-                ::GObject::g_object_unref ptr
-            end
+  # we have a number of things we need to inherit in different ways:
+  #
+  # - we want to be able to subclass GObject in Ruby in a simple way
+  # - the layouts of the nested structs need to inherit
+  # - we need to be able to cast between structs which share a base struct
+  #   without creating new wrappers or messing up refcounting
+  # - we need automatic gobject refcounting
+  #
+  # the solution is to split the class into four areas which we treat
+  # differently:
+  #
+  # - we have a "wrapper" Ruby class to allow easy subclassing ... this has a
+  #   @struct member which holds the actual pointer
+  # - we use "forwardable" to forward the various ffi methods on to the
+  #   @struct member ... we arrange things so that subclasses do not need to
+  #   do the forwarding themselves
+  # - we have two versions of the struct: a plain one which we can use for
+  #   casting that will not change the refcounts
+  # - and a managed one with an unref which we just use for .new
+  # - we separate the struct layout into a separate module to avoid repeating
+  #   ourselves
+
+  class GObject
+    extend Forwardable
+    extend SingleForwardable
+
+    def_instance_delegators :@struct, :[], :to_ptr
+    def_single_delegators :ffi_struct, :ptr
+
+    attr_reader :references
+
+    # the layout of the GObject struct
+    module GObjectLayout
+      def self.included base
+        base.class_eval do
+          layout :g_type_instance, :pointer,
+            :ref_count, :uint,
+            :qdata, :pointer
         end
+      end
+    end
 
-        # the plain struct ... cast with this
-        class Struct < FFI::Struct
-            include GObjectLayout
-
-        end
+    # the struct with unref ... manage object lifetime with this
+    class ManagedStruct < FFI::ManagedStruct
+      include GObjectLayout
 
-        # don't allow ptr == nil, we never want to allocate a GObject struct
-        # ourselves, we just want to wrap GLib-allocated GObjects
-        #
-        # here we use ManagedStruct, not Struct, since this is the ref that will
-        # need the unref
-        def initialize ptr
-            # GLib::logger.debug("GObject::GObject.initialize") {"ptr = #{ptr}"}
-            @struct = ffi_managed_struct.new ptr
-        end
+      def self.release ptr
+        # GLib::logger.debug("GObject::GObject::ManagedStruct.release") {
+        #     "unreffing #{ptr}"
+        # }
+        ::GObject.g_object_unref ptr
+      end
+    end
 
-        # access to the casting struct for this class
-        def ffi_struct
-            self.class.ffi_struct
-        end
+    # the plain struct ... cast with this
+    class Struct < FFI::Struct
+      include GObjectLayout
+    end
 
-        class << self
-            def ffi_struct
-                self.const_get :Struct
-            end
-        end
+    # don't allow ptr == nil, we never want to allocate a GObject struct
+    # ourselves, we just want to wrap GLib-allocated GObjects
+    #
+    # here we use ManagedStruct, not Struct, since this is the ref that will
+    # need the unref
+    def initialize ptr
+      # GLib::logger.debug("GObject::GObject.initialize") {"ptr = #{ptr}"}
+      @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 managed struct for this class
-        def ffi_managed_struct
-            self.class.ffi_managed_struct
-        end
+    # access to the casting struct for this class
+    def ffi_struct
+      self.class.ffi_struct
+    end
 
-        class << self
-            def ffi_managed_struct
-                self.const_get :ManagedStruct
-            end
-        end
+    # get the pointer we were built from ... #to_ptr gets the pointer after we
+    # have wrapped it up with an auto unref
+    attr_reader :ptr
 
+    class << self
+      def ffi_struct
+        const_get :Struct
+      end
     end
 
-    class GParamSpec < FFI::Struct
-        # the first few public fields
-        layout :g_type_instance, :pointer,
-               :name, :string,
-               :flags, :uint,
-               :value_type, :GType,
-               :owner_type, :GType
+    # access to the managed struct for this class
+    def ffi_managed_struct
+      self.class.ffi_managed_struct
     end
 
-    class GParamSpecPtr < FFI::Struct
-        layout :value, GParamSpec.ptr
+    class << self
+      def ffi_managed_struct
+        const_get :ManagedStruct
+      end
     end
-
-    attach_function :g_param_spec_get_blurb, [GParamSpec.ptr], :string
-
-    attach_function :g_object_ref, [:pointer], :void
-    attach_function :g_object_unref, [:pointer], :void
-
+  end
+
+  class GParamSpec < FFI::Struct
+    # the first few public fields
+    layout :g_type_instance, :pointer,
+      :name, :string,
+      :flags, :uint,
+      :value_type, :GType,
+      :owner_type, :GType
+  end
+
+  class GParamSpecPtr < FFI::Struct
+    layout :value, GParamSpec.ptr
+  end
+
+  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