ruby-vips 0.3.14 → 1.0.0

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "ruby-vips"
+  gem.homepage = "http://github.com/jcupitt/ruby-vips"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby extension for the vips image processing library.}
+  gem.description = %Q{ruby-vips is a ruby extension for vips. It is extremely fast and it can process huge images without requiring the entire image to be loaded into memory.}
+  gem.email = "jcupitt@gmail.com"
+  gem.authors = ["John Cupitt"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require "github/markup"
+require "redcarpet"
+require "yard"
+require "yard/rake/yardoc_task"
+
+YARD::Rake::YardocTask.new do |yard|
+end

data/TODO

@@ -1,38 +1,14 @@
-- add something to make a memory image, useful in some cases, eg. making very
-  large image mosaics
+- need something like ruby-vips occasional GC stuff, we can fill memory before
+  a GC is triggered
 
-- support vips_resize()
+- mail about the getpoint unimplemented error
 
-- support vips_flatten(), see 
+  http://sourceforge.net/p/ruby-gnome2/mailman/ruby-gnome2-devel-en/thread/CAGNS0RuZ5N6bha3M7B0%2BYf2M9-oni44idzZO17mtQiykS%2BmJKQ%40mail.gmail.com/#msg34790843
 
-	https://github.com/jcupitt/ruby-vips/issues/45
+- still missing a few enum docs
 
+- add complex constants, eg. 
 
-btw, there's a method called to_memory in JPEGWriter and PNGWriter, that works
-cool to retrieve the VIPS::Image as a memory buffer, will be cool if this
-method is moved up to Writer and then it handles the correct to_memory method
-using the image headers.
+	Complex(1, 2)
+	=> (1+2i)
 
-add from_memory? or should the open method accept a blob in place of a path?
-
-
-
-
-TODO
-* Verify that all memory gets released when vips ops return errors. Namely,
-  make sure that the allocated IMAGEs get released via ruby's free callbacks.
-* Allow for injecting ruby code into an image transformation pipeline (may be
-  slow to call out to ruby with every read, but may be worthwhile for fun custom
-  image processors).
-* Tap into VIPS callback system to allow progress updates, etc.
-* Allow for creating a ruby endpoint to the pipeline could be useful for
-  streaming.
-* Image#to_a
-* look into other.h, audit all libvips methods and make sure they are all
-  implemented
-* JRuby support
-* Optional extensions to core Ruby classes, allowing operations such as
-  [1, 2, 3] & im . This could be optionally enabled by requiring e.g.
-  vips/core_ext
-* Put groups of image operations into modules, breaking docs into themes and
-  possibly allowing for selective loading of image ops.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/example/annotate.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+im = Vips::Image.new_from_file ARGV[0], :access => :sequential
+
+left_text = Vips::Image.text "left corner", :dpi => 300
+left = left_text.embed 50, 50, im.width, 150 
+
+right_text = Vips::Image.text "right corner", :dpi => 300
+right = right_text.embed im.width - right_text.width - 50, 50, im.width, 150
+
+footer = (left | right).ifthenelse(0, [255, 0, 0], :blend => true)
+
+im = im.insert footer, 0, im.height, :expand => true   
+
+im.write_to_file ARGV[1]

data/example/daltonize8.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+
+# daltonize an image with ruby-vips
+# based on
+# http://scien.stanford.edu/pages/labsite/2005/psych221/projects/05/ofidaner/colorblindness_project.htm
+# see
+# http://libvips.blogspot.co.uk/2013/05/daltonize-in-ruby-vips-carrierwave-and.html
+# for a discussion of this code
+
+require 'vips'
+
+#Vips.set_debug true
+
+# matrices to convert D65 XYZ to and from bradford cone space
+xyz_to_brad = [
+    [0.8951,  0.2664, -0.1614],
+    [-0.7502,  1.7135,  0.0367],
+    [0.0389, -0.0685,  1.0296]
+]
+brad_to_xyz = [
+    [0.987, -0.147, 0.16],
+    [0.432, 0.5184, 0.0493],
+    [-0.0085, 0.04, 0.968]
+]
+
+im = Vips::Image.new_from_file ARGV[0]
+
+# remove any alpha channel before processing
+alpha = nil
+if im.bands == 4
+    alpha = im[3]
+    im = im.extract_band 0, :n => 3 
+end
+
+begin
+    # import to XYZ with lcms
+    # if there's no profile there, we'll fall back to the thing below
+    xyz = im.icc_import :embedded => true, :pcs => :xyz 
+rescue Vips::Error
+    # nope .. use the built-in converter instead
+    xyz = im.colourspace :xyz
+end
+
+brad = xyz.recomb xyz_to_brad 
+
+# through the Deuteranope matrix
+# we need rows to sum to 1 in Bradford space --- the matrix in the original
+# Python code sums to 1.742
+deut = brad.recomb [
+    [1, 0, 0],
+    [0.7, 0, 0.3],
+    [0, 0, 1]
+]
+
+xyz = deut.recomb brad_to_xyz 
+
+# .. and back to sRGB 
+rgb = xyz.colourspace :srgb
+
+# so this is the colour error 
+err = im - rgb
+
+# add the error back to other channels to make a compensated image
+im = im + err.recomb([
+    [0, 0, 0], 
+    [0.7, 1, 0],
+    [0.7, 0, 1]
+])
+
+# reattach any alpha we saved above
+if alpha
+    im = im.bandjoin(alpha)
+end
+
+im.write_to_file ARGV[1] 

data/example/example1.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+
+require 'vips'
+$vips_debug = true
+
+puts ""
+puts "starting up:"
+
+# this makes vips keep a list of all active objects which we can print out
+Vips::leak_set true
+
+# disable the operation cache
+Vips::cache_set_max 0
+
+puts ""
+puts "creating object:"
+x = Vips::Image.new
+Vips::Object::print_all
+
+puts ""
+puts "freeing object:"
+x = nil
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "creating operation:"
+op = Vips::Operation.new "black"
+Vips::Object::print_all
+op.set_property "width", 200
+op.set_property "height", 300
+
+puts ""
+puts "after operation init:"
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "operation lookup:"
+op2 = Vips::cache_operation_lookup op
+if op2
+    puts "cache hit"
+    op = op2
+    op2 = nil
+else
+    puts "cache miss ... building"
+    if not op.build
+        puts "*** build error"
+    end
+    Vips::cache_operation_add op
+end
+
+puts ""
+puts "after build:"
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "fetching output:"
+im = op.get_property "out"
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "fetching output again:"
+im2 = op.get_property "out"
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "freeing operation:"
+op.unref_outputs
+op = nil
+op2 = nil
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "shutting down:"
+im = nil
+im2 = nil
+GC.start
+Vips::shutdown
+GC.start

data/example/example2.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+puts ""
+puts "starting up:"
+
+# this makes vips keep a list of all active objects which we can print out
+Vips::leak_set true
+
+# disable the operation cache
+Vips::cache_set_max 0
+
+n = 100
+
+n.times do |i|
+    puts ""
+    puts "call #{i} ..."
+    out = Vips::call "black", 200, 300
+    if out.width != 200 or out.height != 300
+        puts "bad image result from black"
+    end
+end
+
+puts ""
+puts "after #{n} calls:"
+GC.start
+Vips::Object::print_all
+
+puts ""
+puts "shutting down:"

data/example/example3.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+# this makes vips keep a list of all active objects 
+# Vips::leak_set true
+
+# disable the operation cache
+# Vips::cache_set_max 0
+
+# turn on debug logging
+#Vips.set_debug true
+
+10000.times do |i|
+    puts "loop #{i} ..."
+    im = Vips::Image.new_from_file ARGV[0]
+    im = im.embed 100, 100, 3000, 3000, :extend => :mirror
+    im.write_to_file "x.v"
+end

data/example/example4.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+# this makes vips keep a list of all active objects 
+Vips::leak_set true
+
+# disable the operation cache
+#Vips::cache_set_max 0
+
+# turn on debug logging
+#Vips.set_debug true
+
+ARGV.each do |filename|
+    im = Vips::Image.new_from_file filename
+    profile = im.get_value "icc-profile-data"
+    puts "profile has #{profile.length} bytes"
+end

data/example/example5.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require 'vips'
+
+# this makes vips keep a list of all active objects 
+# Vips::leak_set true
+
+# disable the operation cache
+# Vips::cache_set_max 0
+
+# turn on debug logging
+#Vips.set_debug true
+
+if ARGV.length < 2
+    raise "usage: #{$PROGRAM_NAME}: input-file output-file"
+end
+
+im = Vips::Image.new_from_file ARGV[0], :access => :sequential
+
+im *= [1, 2, 1]
+
+# we want to be able to specify a scale for the convolution mask, so we have to
+# make it ourselves
+# if you are OK with scale=1, you can just pass the array directly to .conv()
+mask = Vips::Image.new_from_array [
+    [-1, -1, -1],
+    [-1, 16, -1],
+    [-1, -1, -1]], 8
+im = im.conv mask
+
+im.write_to_file ARGV[1]

data/example/trim8.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+
+# An equivalent of ImageMagick's -trim in ruby-vips ... automatically remove
+# "boring" image edges.
+
+# We use .project to sum the rows and columns of a 0/255 mask image, the first
+# non-zero row or column is the object edge. We make the mask image with an
+# amount-different-from-background image plus a threshold.
+
+require 'vips'
+
+im = Vips::Image.new_from_file ARGV[0]
+
+# find the value of the pixel at (0, 0) ... we will search for all pixels 
+# significantly different from this
+background = im.getpoint(0, 0)
+
+# we need to smooth the image, subtract the background from every pixel, take 
+# the absolute value of the difference, then threshold
+mask = (im.median - background).abs > 10
+
+# sum mask rows and columns, then search for the first non-zero sum in each
+# direction
+columns, rows = mask.project
+
+first_column, first_row = columns.profile
+left = first_row.min
+
+first_column, first_row = columns.fliphor.profile
+right = columns.width - first_row.min
+
+first_column, first_row = rows.profile
+top = first_column.min
+
+first_column, first_row = rows.flipver.profile
+bottom = rows.height - first_column.min
+
+# and now crop the original image
+im = im.crop left, top, right - left, bottom - top
+
+im.write_to_file ARGV[1]

data/example/watermark.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+
+require 'vips'
+ 
+im = Vips::Image.new_from_file ARGV[0], :access => :sequential
+ 
+text = Vips::Image.text ARGV[2], :width => 500, :dpi => 300
+text = (text * 0.3).cast(:uchar)
+text = text.embed 100, 100, text.width + 200, text.width + 200
+text = text.replicate 1 + im.width / text.width, 1 + im.height / text.height
+text = text.crop 0, 0, im.width, im.height
+
+# we want to blend into the visible part of the image and leave any alpha
+# channels untouched ... we need to split im into two parts
+
+# guess how many bands from the start of im contain visible colour information
+if im.bands >= 4 and im.interpretation == :cmyk
+    # cmyk image
+    n_visible_bands = 4
+    text_colour = [0, 255, 0, 0]
+elsif im.bands >= 3
+    # rgb image
+    n_visible_bands = 3
+    text_colour = [255, 0, 0]
+else
+    # mono image
+    n_visible_bands = 1
+    text_colour = 255
+end
+
+# split into image and alpha
+if im.bands - n_visible_bands > 0
+    alpha = im.extract_band n_visible_bands, :n => im.bands - n_visible_bands
+    im = im.extract_band 0, :n => n_visible_bands
+else
+    alpha = nil
+end
+
+marked = text.ifthenelse text_colour, im, :blend => true
+
+# reattach alpha
+marked = marked.bandjoin alpha  if alpha
+ 
+marked.write_to_file ARGV[1]