ruby-vips8 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a53c0bc2ee35537831ff8ac3de36af784fcd063b
+  data.tar.gz: d9e83f55493934fbe42b2f004884ebdf5b6e8632
+SHA512:
+  metadata.gz: 0507b95ff7aa019f3b5b8de8227cde46e990730778c20740a74ccf1e4efb4a5b52142b2974affc48e560583976d5b755463f61906cc1d11ed2a0a6317a0daae3
+  data.tar.gz: a29eb8203ee77fbb096e5e18b06db20ef22608e4400e8eaa3ad5d819fa54a4c6b81468f35b34fcfc1af67c90d40a9322c4edbee471cd119e88473f4bde5a28a0

data/.rspec

@@ -0,0 +1 @@
+--color

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--markup-provider=redcarpet 
+--markup=markdown 
+--main=README.md
+--title="ruby-vips8 documentation"
+lib/**/*.rb
+-
+LICENSE.txt
+CHANGELOG.md
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# master 
+
+# Version 0.1
+
+* first upload [John Cupitt]

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+# runtime deps
+gem "gobject-introspection", "~> 3.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+    gem "rspec", "~> 3.3"
+    gem "yard", "~> 0.8"
+    gem "redcarpet", "~> 3.3"
+    gem "github-markup", "~> 1.4"
+    gem "bundler", "~> 1.0"
+    gem "jeweler", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github-markup (1.4.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    glib2 (3.0.7)
+      pkg-config
+    gobject-introspection (3.0.7)
+      glib2 (= 3.0.7)
+    hashie (3.4.3)
+    highline (1.7.8)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pkg-config (1.1.7)
+    rack (1.6.4)
+    rake (10.5.0)
+    rdoc (4.2.1)
+      json (~> 1.4)
+    redcarpet (3.3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  github-markup (~> 1.4)
+  gobject-introspection (~> 3.0)
+  jeweler (~> 2.0)
+  redcarpet (~> 3.3)
+  rspec (~> 3.3)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Cupitt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,170 @@
+# ruby-vips8
+
+This gem provides a Ruby binding for the [vips image processing
+library](http://www.vips.ecs.soton.ac.uk). It wraps version 8 of the API.
+The older vips7-based [ruby-vips](https://github.com/jcupitt/ruby-vips)
+gem is still being maintained.
+
+`ruby-vips8` is fast and it can work without needing the 
+entire image to be loaded into memory. 
+`ruby-vips8` allows you to set up pipelines that don't get executed until you
+output the image to disk or to a string. This means you can create,
+manipulate, and pass around Image objects without incurring any memory or CPU
+costs. The image is not actually processed until you write the image to memory
+or to disk.
+
+For example, the benchmark at 
+[vips-benchmarks](https://github.com/stanislaw/vips-benchmarks) loads a large
+image, crops, shrinks, sharpens and saves again, and repeats 10 times. 
+
+```text
+real time in seconds, fastest of three runs
+benchmark       tiff	jpeg
+ruby-vips.rb    2.77	2.98	
+ruby-vips8.rb   2.97	3.29	
+image-magick    8.18	9.71	
+rmagick.rb      9.22	10.06	
+image_sci.rb    9.39	7.20	
+
+peak memory use in bytes
+benchmark       peak RSS
+ruby-vips.rb    107340
+ruby-vips8.rb   117604
+image_sci.rb    146536
+rmagick.rb      3352020
+```
+
+See also [benchmarks at the official libvips
+website](http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use).
+There's a handy blog post explaining [how libvips opens
+files](http://libvips.blogspot.co.uk/2012/06/how-libvips-opens-file.html)
+which gives some more background.
+
+## Requirements
+
+  * OS X or Linux
+  * libvips 8.2 and later
+
+## Installation prerequisites
+
+### OS X 
+
+Install [homebrew](http://mxcl.github.com/homebrew) and enter:
+
+```bash
+$ brew install homebrew/science/vips
+```
+
+To verify that your vips install is working, try:
+
+```bash
+$ vips --version
+vips-8.2.1
+```
+
+Make sure you have `Vips-8.0.typelib` on your `GI_TYPELIB_PATH`. Enter
+something like:
+
+```bash
+$ export GI_TYPELIB_PATH=/usr/local/lib/girepository-1.0
+```
+
+### Other platforms
+
+You need to install libvips from source since 8.2 has not been packaged yet
+(Jan 2016).
+
+Download a tarball from the 
+[libvips website](http://www.vips.ecs.soton.ac.uk/supported/current), or build
+from [the git repository](https://github.com/jcupitt/libvips) and see the
+README.
+
+## Installing the gem.
+
+```bash
+$ gem install ruby-vips8
+```
+
+or include it in Gemfile:
+
+```ruby
+gem 'ruby-vips8'
+```
+
+And take a look in `examples/`. There is full yard documentation, take a look
+there too.
+
+# Example
+
+```ruby
+require 'vips8'
+
+im = Vips::Image.new_from_file filename
+
+# put im at position (100, 100) in a 3000 x 3000 pixel image, 
+# make the other pixels in the image by mirroring im up / down / 
+# left / right, see
+# http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/libvips-conversion.html#vips-embed
+im = im.embed 100, 100, 3000, 3000, :extend => :mirror
+im.write_to_file output_filename
+
+# multiply the green (middle) band by 2, leave the other two alone
+im *= [1, 2, 1]
+
+# make an image from an array constant, convolve with it
+mask = Vips::Image.new_from_array [
+    [-1, -1, -1],
+    [-1, 16, -1],
+    [-1, -1, -1]], 8
+im = im.conv mask
+```
+
+# What's wrong with ruby-vips?
+
+There's an existing Ruby binding for vips
+[here](https://github.com/jcupitt/ruby-vips). It was written by a Ruby
+expert, it works well, it includes a test-suite, and has pretty full
+documentation. Why do another?
+
+ruby-vips is based on the old vips7 API. There's now vips8, which adds several
+very useful new features:
+
+* [GObject](https://developer.gnome.org/gobject/stable/)-based API with full
+  introspection. You can discover the vips8 API at runtime. This means that if
+  libvips gets a new operator, any binding that goes via vips8 will 
+  get the new thing immediately. With vips7, whenever libvips was changed, all
+  the bindings needed to be changed too.
+
+* No C required. Thanks to
+  [gobject-introspection](https://wiki.gnome.org/Projects/GObjectIntrospection)
+  you can write the binding in Ruby itself, there's no need for any C. This
+  makes it a lot smaller and more portable. 
+
+* vips7 probably won't get new features. vips7 doesn't really exist any more:
+  the API is still there, but now just a thin compatibility layer over vips8.
+  New features may well not get added to the vips7 API.
+
+There are some more minor pluses as well:
+
+* Named and optional arguments. vips8 lets you have optional and required
+  arguments, both input and output, and optional arguments can have default
+  values. 
+
+* Operation cache. vips8 keeps track of the last 1,000 or so operations and
+  will automatically reuse results when it can. This can give a huge speedup
+  in some cases.
+
+* vips8 is much simpler and more regular. For example, 
+  ruby-vips had to work hard to offer a nice loader system, but that's all
+  built into vips8. It can do things like load and save formatted images to 
+  and from memory buffers as well, which just wasn't possible before. 
+
+This binding adds some extra useful features over the old `ruby-vips` binding.
+
+* Full set of arithmetic operator overloads.
+
+* Automatic constant expansion. You can write things like
+  `image.bandjoin(255)` and the 255 will be automatically expanded to an image 
+  and attached as an extra band. You can mix int, float, scalar, vector and
+  image constants freely.
+

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-vips8"
+  gem.homepage = "http://github.com/jcupitt/ruby-vips8"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby extension for the vips8 image processing library.}
+  gem.description = %Q{ruby-vips8 is a ruby extension for vips8. 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

@@ -0,0 +1,11 @@
+- mail about the getpoint unimplemented error
+
+  http://sourceforge.net/p/ruby-gnome2/mailman/ruby-gnome2-devel-en/thread/CAGNS0RuZ5N6bha3M7B0%2BYf2M9-oni44idzZO17mtQiykS%2BmJKQ%40mail.gmail.com/#msg34790843
+
+- still missing a few enum docs
+
+- add complex constants, eg. 
+
+	Complex(1, 2)
+	=> (1+2i)
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/example/annotate.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'vips8'
+
+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-vips8
+# 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 'vips8'
+
+#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]