ruby-vips 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 778544294cf437d6ec6b1e98451846c0a3d6f529
-  data.tar.gz: da2043e2d35d9ecb2186baafd8b4fdd0191d90ee
+  metadata.gz: 3053302bf9707cbd283b0b8c1cf7add20cbe94bf
+  data.tar.gz: fc1c109a20fbd505a2e97227d02b8274c7385571
 SHA512:
-  metadata.gz: 9c0e6b38cf8210d107113133c6d326f79b1acc12a393c30a094f5625a510081d4f444875d19836cabfd89aa09fe7f1d15b2bd633c9a29ed0ae3c3b09138ea524
-  data.tar.gz: 40017a9f53fb333671758bac8dfd0c1beae876b811962fe1d188044b404bbbfb91070404807fdd5b8327a37cb1aef92d1a3c48bea44b4d87eeec72bdf4a4e06d
+  metadata.gz: b7a50b059950e254e5743d193e565296721cd35d23278ec2480f86a6e049770eb1a06ee670d2f2e4163611d29442d4c3080b5b7352caeb10bcaa84e661202ce0
+  data.tar.gz: 0626521b21f79c42fe423a373cbfb67eb36296f6b692f039a9a0c997af142e7d2ffd65cdfe66fffcc952d4a9d95d0e4c7b1566e279e83f00cc407e82620a00b3

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## master
 
+## Version 2.0.8 (2017-09-14)
+
+* add `thumb.rb` example, and verify we run stably and in constant memory 
+* cleanups and polish [Nakilon]
+* add `composite` convenience method 
+* add `Vips::concurrency_set` and `Vips::vector_set`
+
 ## Version 2.0.7 (2017-09-08)
 
 * disable the logging for now, it could deadlock

data/VERSION

@@ -1 +1 @@
-2.0.7
+2.0.8

data/example/thumb.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# batch-process a lot of files
+#
+# this should run in constant memory -- if it doesn't, something has broken
+
+require 'vips'
+
+# benchmark thumbnail via a memory buffer
+def via_memory(filename, thumbnail_width) 
+    data = IO.binread(filename)
+
+    thumb = Vips::Image.thumbnail_buffer data, thumbnail_width, crop: 'centre'
+
+    thumb.write_to_buffer '.jpg'
+end
+
+# benchmark thumbnail via files
+def via_files(filename, thumbnail_width) 
+    thumb = Vips::Image.thumbnail filename, thumbnail_width, crop: 'centre'
+
+    thumb.write_to_buffer '.jpg'
+end
+
+ARGV.each do |filename|
+    puts "processing #{filename} ..."
+    thumb = via_memory(filename, 500)
+    # thumb = via_files(filename, 500)
+end
+
+

data/lib/vips.rb

@@ -71,7 +71,7 @@ module GLib
     end
 
     def self.remove_log_handler
-        if @glib_log_handler_id != 0 and @glib_log_domain
+        if @glib_log_handler_id != 0 && @glib_log_domain
             g_log_remove_handler @glib_log_domain, @glib_log_handler_id
             @glib_log_handler_id = nil
         end
@@ -510,6 +510,8 @@ module Vips
     # in any case libvips does this for us
 
     attach_function :vips_leak_set, [:int], :void
+    attach_function :vips_vector_set_enabled, [:int], :void
+    attach_function :vips_concurrency_set, [:int], :void
 
     # Turn libvips leak testing on and off. Handy for debugging ruby-vips, not
     # very useful for user code. 
@@ -540,6 +542,19 @@ module Vips
         vips_cache_set_max_files size
     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. 
+    def self.concurrency_set n
+        vips_concurrency_set n
+    end
+
+    # Enable or disable SIMD and the run-time compiler. 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_set enabled
+        vips_vector_set_enabled(enabled ? 1 : 0)
+    end
+
     # Deprecated compatibility function.
     #
     # Don't use this, instead change {GLib::logger.level}.
@@ -557,7 +572,7 @@ module Vips
         major = version(0)
         minor = version(1)
 
-        major > x or (major == x and minor >= y)
+        major > x || (major == x && minor >= y)
     end
 
     LIBRARY_VERSION = Vips::version_string

data/lib/vips/gvalue.rb

@@ -23,6 +23,30 @@ module GObject
         layout :gtype, :GType, 
                :data, [:ulong_long, 2]
 
+        # convert an enum value (str/symb/int) into an int ready for libvips
+        def self.from_nick(gtype, value)
+            value = value.to_s if value.is_a? Symbol
+
+            if value.is_a? String
+                value = Vips::vips_enum_from_nick "ruby-vips", gtype, value
+                if value == -1
+                    raise Vips::Error
+                end
+            end
+
+            value
+        end
+
+        # convert an int enum back into a symbol
+        def self.to_nick(gtype, enum_value)
+            enum_name = Vips::vips_enum_nick gtype, enum_value
+            if enum_name == nil
+                raise Vips::Error
+            end
+
+            enum_name.to_sym
+        end
+
         def self.release ptr
             # GLib::logger.debug("GObject::GValue::release") {"ptr = #{ptr}"}
             ::GObject::g_value_unset ptr 
@@ -82,14 +106,14 @@ module GObject
                 ::Vips::vips_value_set_ref_string self, value
 
             when Vips::ARRAY_INT_TYPE
-                value = [value] if not value.is_a? Array
+                value = [value] unless value.is_a? Array
 
                 Vips::vips_value_set_array_int self, nil, value.length
                 ptr = Vips::vips_value_get_array_int self, nil
                 ptr.write_array_of_int32 value
 
             when Vips::ARRAY_DOUBLE_TYPE
-                value = [value] if not value.is_a? Array
+                value = [value] unless value.is_a? Array
 
                 # this will allocate an array in the gvalue
                 Vips::vips_value_set_array_double self, nil, value.length
@@ -100,7 +124,7 @@ module GObject
                 ptr.write_array_of_double value
 
             when Vips::ARRAY_IMAGE_TYPE
-                value = [value] if not value.is_a? Array
+                value = [value] unless value.is_a? Array
 
                 Vips::vips_value_set_array_image self, value.length
                 ptr = Vips::vips_value_get_array_image self, nil
@@ -121,17 +145,8 @@ module GObject
                     ::GObject::g_value_set_flags self, value
 
                 when GENUM_TYPE
-                    value = value.to_s if value.is_a? Symbol
-
-                    if value.is_a? String
-                        value = Vips::vips_enum_from_nick "ruby-vips", 
-                            self[:gtype], value
-                        if value == -1
-                            raise Vips::Error
-                        end
-                    end
-
-                    ::GObject::g_value_set_enum self, value
+                    enum_value = GValue.from_nick(self[:gtype], value)
+                    ::GObject::g_value_set_enum self, enum_value
 
                 when GOBJECT_TYPE
                     ::GObject::g_value_set_object self, value
@@ -200,14 +215,8 @@ module GObject
                     result = ::GObject::g_value_get_flags self
 
                 when GENUM_TYPE
-                    enum_value = ::GObject::g_value_get_enum self
-                    # this returns a static string, no need to worry about 
-                    # lifetime
-                    enum_name = Vips::vips_enum_nick self[:gtype], enum_value
-                    if enum_name == nil
-                        raise Vips::Error
-                    end
-                    result = enum_name.to_sym
+                    enum_value = ::GObject::g_value_get_enum(self)
+                    result = GValue.to_nick self[:gtype], enum_value
 
                 when GOBJECT_TYPE
                     obj = ::GObject::g_value_get_object self

data/lib/vips/image.rb

@@ -82,14 +82,12 @@ module Vips
         end
 
         def self.complex? format
-            format_number = Vips::vips_enum_from_nick "complex?", 
-                BAND_FORMAT_TYPE, format.to_s
+            format_number = GObject::GValue.from_nick BAND_FORMAT_TYPE, format
             Vips::vips_band_format_iscomplex(format_number) != 0
         end
 
         def self.float? format
-            format_number = Vips::vips_enum_from_nick "float?", 
-                BAND_FORMAT_TYPE, format.to_s
+            format_number = GObject::GValue.from_nick BAND_FORMAT_TYPE, format
             Vips::vips_band_format_isfloat(format_number) != 0
         end
 
@@ -99,12 +97,12 @@ module Vips
         def self.run_cmplx image, &block
             original_format = image.format
 
-            if not Image::complex? image.format
+            unless Image::complex? image.format
                 if image.bands % 2 != 0
                     raise Error, "not an even number of bands"
                 end
 
-                if not Image::float? image.format
+                unless Image::float? image.format
                     image = image.cast :float 
                 end
 
@@ -114,7 +112,7 @@ module Vips
 
             image = block.(image)
 
-            if not Image::complex? original_format
+            unless Image::complex? original_format
                 new_format = image.format == :dpcomplex ? :double : :float
                 image = image.copy format: new_format, bands: image.bands * 2
             end
@@ -324,17 +322,17 @@ module Vips
         def self.new_from_array array, scale = 1, offset = 0
             # we accept a 1D array and assume height == 1, or a 2D array
             # and check all lines are the same length
-            if not array.is_a? Array
+            unless array.is_a? Array
                 raise Vips::Error, "Argument is not an array."
             end
 
             if array[0].is_a? Array
                 height = array.length
                 width = array[0].length
-                if not array.all? {|x| x.is_a? Array}
+                unless array.all? {|x| x.is_a? Array}
                     raise Vips::Error, "Not a 2D array."
                 end
-                if not array.all? {|x| x.length == width}
+                unless array.all? {|x| x.length == width}
                     raise Vips::Error, "Array not rectangular."
                 end
                 array = array.flatten
@@ -343,7 +341,7 @@ module Vips
                 width = array.length
             end
 
-            if not array.all? {|x| x.is_a? Numeric}
+            unless array.all? {|x| x.is_a? Numeric}
                 raise Vips::Error, "Not all array elements are Numeric."
             end
 
@@ -477,7 +475,7 @@ module Vips
         def get_typeof name
             # on libvips before 8.5, property types must be searched first,
             # since vips_image_get_typeof returned built-in enums as int
-            if not Vips::at_least_libvips?(8, 5)
+            unless Vips::at_least_libvips?(8, 5)
                 gtype = parent_get_typeof name
                 return gtype if gtype != 0
             end
@@ -501,7 +499,7 @@ module Vips
         def get name
             # with old libvips, we must fetch properties (as opposed to
             # metadata) via VipsObject
-            if not Vips::at_least_libvips?(8, 5)
+            unless Vips::at_least_libvips?(8, 5)
                 return super if parent_get_typeof(name) != 0
             end
 
@@ -518,7 +516,7 @@ module Vips
         # @return [[String]] array of field names 
         def get_fields
             # vips_image_get_fields() was added in libvips 8.5
-            return [] if not Vips.respond_to? :vips_image_get_fields
+            return [] unless Vips.respond_to? :vips_image_get_fields
 
             array = Vips::vips_image_get_fields self
 
@@ -885,8 +883,7 @@ module Vips
         # @return [Image] extracted band(s)
         def [] index
             if index.is_a? Range
-                n = index.end - index.begin
-                n += 1 if not index.exclude_end?
+                n = index.size
                 extract_band index.begin, n: n
             elsif index.is_a? Numeric
                 extract_band index 
@@ -921,12 +918,10 @@ module Vips
             array = memory.unpack(template)
 
             # gather band elements together
-            pixel_array = []
-            array.each_slice(bands) {|pixel| pixel_array << pixel}
+            pixel_array = array.each_slice(bands).to_a
 
             # build rows 
-            row_array = []
-            pixel_array.each_slice(width) {|row| row_array << row}
+            row_array = pixel_array.each_slice(width).to_a
 
             return row_array
         end
@@ -977,7 +972,7 @@ module Vips
         #
         # @return [Array<Image>] Array of n one-band images
         def bandsplit
-            (0...bands).map {|i| extract_band(i)}
+            (0...bands).map {|i| extract_band i}
         end
 
         # Join a set of images bandwise.
@@ -985,20 +980,39 @@ module Vips
         # @param other [Image, Array<Image>, Real, Array<Real>] bands to append
         # @return [Image] many band image
         def bandjoin other
-            if not other.is_a? Array
+            unless other.is_a? Array
                 other = [other]
             end
 
             # if other is just Numeric, we can use bandjoin_const
-            not_all_real = (other.map {|x| not x.is_a?(Numeric)}).include?(true)
+            not_all_real = !other.all?{|x| x.is_a? Numeric}
 
             if not_all_real
                 Vips::Image.bandjoin([self] + other)
             else
-                bandjoin_const(other)
+                bandjoin_const other
             end
         end
 
+        # Composite a set of images with a set of blend modes.
+        #
+        # @param other [Image, Array<Image>, Real, Array<Real>] bands to append
+        # @return [Image] many band image
+        def composite other, mode, opts = {}
+            unless other.is_a? Array
+                other = [other]
+            end
+            unless mode.is_a? Array
+                mode = [mode]
+            end
+
+            mode = mode.map do |x|
+                GObject::GValue.from_nick Vips::BLEND_MODE_TYPE, x
+            end
+
+            Vips::Image.composite([self] + other, mode, opts)
+        end
+
         # Return the coordinates of the image maximum.
         #
         # @return [Real, Real, Real] maximum value, x coordinate of maximum, y
@@ -1244,10 +1258,10 @@ module Vips
         def ifthenelse(th, el, opts = {}) 
             match_image = [th, el, self].find {|x| x.is_a? Vips::Image}
 
-            if not th.is_a? Vips::Image
+            unless th.is_a? Vips::Image
                 th = Operation.imageize match_image, th
             end
-            if not el.is_a? Vips::Image
+            unless el.is_a? Vips::Image
                 el = Operation.imageize match_image, el
             end
 
@@ -1278,7 +1292,7 @@ module Vips
 
     def self.generate_yard
         # these have hand-written methods, see above
-        no_generate = ["scale", "bandjoin", "ifthenelse"]
+        no_generate = ["scale", "bandjoin", "composite", "ifthenelse"]
 
         # map gobject's type names to Ruby
         map_go_to_ruby = {
@@ -1312,7 +1326,7 @@ module Vips
                 next if (arg_flags & ARGUMENT_CONSTRUCT) == 0 
                 next if (arg_flags & ARGUMENT_DEPRECATED) != 0
 
-                name = pspec[:name].gsub("-", "_")
+                name = pspec[:name].tr("-", "_")
                 # 'in' as a param name confuses yard
                 name = "im" if name == "in"
                 gtype = pspec[:value_type]
@@ -1321,10 +1335,9 @@ module Vips
                 if map_go_to_ruby.include? type_name
                     type_name = map_go_to_ruby[type_name] 
                 end
-                if fundamental == GObject::GFLAGS_TYPE or 
+                if fundamental == GObject::GFLAGS_TYPE ||
                     fundamental == GObject::GENUM_TYPE
-                    type_name =~ /Vips(.*)/
-                    type_name = "Vips::" + $~[1]
+                    type_name = "Vips::" + type_name[/Vips(.*)/, 1]
                 end
                 blurb = GObject::g_param_spec_get_blurb pspec
                 value = {:name => name, 
@@ -1337,7 +1350,7 @@ module Vips
                     if (arg_flags & ARGUMENT_REQUIRED) != 0 
                         # note the first required input image, if any ... we 
                         # will be a method of this instance
-                        if not member_x and gtype == Vips::IMAGE_TYPE
+                        if !member_x && gtype == Vips::IMAGE_TYPE
                             member_x = value
                         else
                             required_input << value
@@ -1348,10 +1361,10 @@ module Vips
                 end
 
                 # MODIFY INPUT args count as OUTPUT as well
-                if (arg_flags & ARGUMENT_OUTPUT) != 0 or
-                    ((arg_flags & ARGUMENT_INPUT) != 0 and
+                if (arg_flags & ARGUMENT_OUTPUT) != 0 ||
+                    ((arg_flags & ARGUMENT_INPUT) != 0 &&
                      (arg_flags & ARGUMENT_MODIFY) != 0)
-                    if (arg_flags & ARGUMENT_REQUIRED) != 0 and
+                    if (arg_flags & ARGUMENT_REQUIRED) != 0
                         required_output << value
                     else
                         optional_output << value
@@ -1361,7 +1374,7 @@ module Vips
             end
 
             print "# @!method "
-            print "self." if not member_x 
+            print "self." unless member_x 
             print "#{nickname}("
             print required_input.map{|x| x[:name]}.join(", ")
             print ", " if required_input.length > 0

data/lib/vips/object.rb

@@ -32,6 +32,13 @@ module Vips
     INTERPRETATION_TYPE = Vips::vips_interpretation_get_type
     CODING_TYPE = Vips::vips_coding_get_type
 
+    if Vips::at_least_libvips?(8, 6)
+        attach_function :vips_blend_mode_get_type, [], :GType
+        BLEND_MODE_TYPE = Vips::vips_blend_mode_get_type
+    else
+        BLEND_MODE_TYPE = nil
+    end
+
     private
 
     attach_function :vips_enum_from_nick, [:string, :GType, :string], :int
@@ -125,7 +132,7 @@ module Vips
         # return a gtype, raise an error on not found
         def get_typeof_error name
             pspec = get_pspec name
-            raise Vips::Error if not pspec
+            raise Vips::Error unless pspec
 
             pspec[:value][:value_type]
         end
@@ -133,7 +140,7 @@ module Vips
         # return a gtype, 0 on not found
         def get_typeof name
             pspec = get_pspec name
-            if not pspec
+            unless pspec
                 Vips::vips_error_clear 
                 return 0
             end

data/lib/vips/operation.rb

@@ -98,7 +98,7 @@ module Vips
                 if (flags & ARGUMENT_CONSTRUCT) != 0 
                     # names can include - as punctuation, but we always use _ in
                     # Ruby
-                    name = pspec[:name].gsub("-", "_")
+                    name = pspec[:name].tr("-", "_")
 
                     args << [name, flags] 
                 end
@@ -125,7 +125,8 @@ module Vips
 
             # 2D array values become tiny 2D images
             # if there's nothing to match to, we also make a 2D image
-            if (value.is_a? Array and value[0].is_a? Array) or match_image == nil
+            if (value.is_a?(Array) && value[0].is_a?(Array)) || 
+                match_image == nil
                 return Image.new_from_array value
             else
                 # we have a 1D array ... use that as a pixel constant and
@@ -240,7 +241,7 @@ module Vips
                 next if (flags & ARGUMENT_DEPRECATED) != 0
 
                 if (flags & ARGUMENT_INPUT) != 0 
-                    if (flags & ARGUMENT_REQUIRED) != 0 and
+                    if (flags & ARGUMENT_REQUIRED) != 0 
                         required_input << [name, flags]
                     else
                         optional_input[name] = flags
@@ -248,10 +249,10 @@ module Vips
                 end
 
                 # MODIFY INPUT args count as OUTPUT as well
-                if (flags & ARGUMENT_OUTPUT) != 0 or
-                    ((flags & ARGUMENT_INPUT) != 0 and
+                if (flags & ARGUMENT_OUTPUT) != 0 ||
+                    ((flags & ARGUMENT_INPUT) != 0 &&
                      (flags & ARGUMENT_MODIFY) != 0)
-                    if (flags & ARGUMENT_REQUIRED) != 0 and
+                    if (flags & ARGUMENT_REQUIRED) != 0
                         required_output << [name, flags]
                     else
                         optional_output[name] = flags
@@ -262,11 +263,11 @@ module Vips
 
             # so we should have been supplied with n_required_input values, or
             # n_required_input + 1 if there's a hash of options at the end
-            if not supplied.is_a? Array
+            unless supplied.is_a? Array
                 raise Vips::Error, "unable to call #{name}: " + 
                     "argument array is not an array"
             end
-            if not optional.is_a? Hash
+            unless optional.is_a? Hash
                 raise Vips::Error, "unable to call #{name}: " + 
                     "optional arguments are not a hash"
             end
@@ -281,8 +282,8 @@ module Vips
             optional.each do |key, value|
                 arg_name = key.to_s
 
-                if not optional_input.has_key? arg_name and
-                    not optional_output.has_key? arg_name 
+                unless optional_input.has_key?(arg_name) ||
+                    optional_output.has_key?(arg_name)
                     raise Vips::Error, "unable to call #{name}: " + 
                         "unknown option #{arg_name}"
                 end

data/lib/vips/version.rb

@@ -1,4 +1,4 @@
 module Vips
-    VERSION = "2.0.7"
+    VERSION = "2.0.8"
 end
 

data/ruby-vips.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", ["~> 11.0"]
   spec.add_development_dependency "rspec", ["~> 3.3"]
-  spec.add_development_dependency "yard", ["~> 0.8"]
+  spec.add_development_dependency "yard", ["~> 0.9.11"]
   spec.add_development_dependency "redcarpet", ["~> 3.3"]
   spec.add_development_dependency "github-markup", ["~> 1.4"]
   spec.add_development_dependency "bundler", ["~> 1.0"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-vips
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - John Cupitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,7 @@ files:
 - example/example4.rb
 - example/example5.rb
 - example/inheritance_with_refcount.rb
+- example/thumb.rb
 - example/trim8.rb
 - example/watermark.rb
 - example/wobble.rb