Release v0.17.3

Dependency version bumps and doc refresh

.gitignore

@@ -4,8 +4,13 @@ coverage
 test/bench/node_modules
 test/fixtures/output*
 test/leak/libvips.supp
-lib
+test/saliency/report.json
-include
+test/saliency/Image*
+test/saliency/[Uu]serData*
+!test/saliency/userData.js
+vendor
 packaging/libvips*
 packaging/*.log
+!packaging/build
 .DS_Store
+.nyc_output

.jshintignore

@@ -1,3 +0,0 @@
-node_modules
-test/bench/node_modules
-coverage

.jshintrc

@@ -1,12 +0,0 @@
-{
-  "strict": true,
-  "node": true,
-  "maxparams": 4,
-  "maxcomplexity": 13,
-  "globals": {
-    "beforeEach": true,
-    "afterEach": true,
-    "describe": true,
-    "it": true
-  }
-}

.npmignore

@@ -2,14 +2,13 @@ build
 node_modules
 coverage
 .editorconfig
-.jshintignore
-.jshintrc
 .gitignore
 test
 .travis.yml
 appveyor.yml
 circle.yml
 mkdocs.yml
-lib
+vendor
-include
 packaging
+preinstall.sh
+.nyc_output

.travis.yml

@@ -1,9 +1,8 @@
 language: node_js
 node_js:
-  - "0.10"
-  - "0.12"
   - "4"
-  - "5"
+  - "6"
+  - "7"
 os:
   - linux
   - osx
@@ -14,9 +13,9 @@ addons:
     - ubuntu-toolchain-r-test
     packages:
     - g++-4.8
-osx_image: xcode7.3
+osx_image: xcode8
 before_install:
   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then export CXX=g++-4.8; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install homebrew/science/vips; fi
 after_success:
+  - npm install coveralls
   - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

CONTRIBUTING.md

@@ -41,9 +41,8 @@ Any change that modifies the existing public API should be added to the relevant
 
 | Release | WIP branch |
 | ------: | :--------- |
-| v0.15.0 | outfit     |
+| v0.18.0 | ridge      |
-| v0.16.0 | pencil     |
+| v0.19.0 | suit       |
-| v0.17.0 | quill      |
 
 Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
 
@@ -63,6 +62,17 @@ A method to be removed should be deprecated in the next major version then remov
 
 By way of example, the [bilinearInterpolation method](https://github.com/lovell/sharp/blob/v0.6.0/index.js#L155) present in v0.5.0 was deprecated in v0.6.0 and removed in v0.7.0.
 
+## Documentation
+
+The public API is documented with [JSDoc](http://usejsdoc.org/) annotated comments.
+
+These can be converted to Markdown by running:
+```sh
+npm run docs
+```
+
+Please include documentation updates in any Pull Request that modifies the public API.
+
 ## Run the tests
 
 ### Functional tests and static code analysis
@@ -90,4 +100,9 @@ npm run test-packaging
 
 ## Finally
 
-Please feel free to ask any questions via a [new issue](https://github.com/lovell/sharp/issues/new) or contact me by [e-mail](https://github.com/lovell/sharp/blob/master/package.json#L4).
+Please feel free to ask any questions via a
+[new issue](https://github.com/lovell/sharp/issues/new).
+
+If you're unable to post details publicly, please
+[e-mail](https://github.com/lovell/sharp/blob/master/package.json#L4)
+for private, paid consulting.

README.md

@@ -1,23 +1,61 @@
 # sharp
 
+```sh
+npm install sharp
+```
+
 The typical use case for this high speed Node.js module
-is to convert large images of many formats to
+is to convert large images in common formats to
 smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.
 
-Resizing an image is typically 4x faster than using the
+Resizing an image is typically 4x-5x faster than using the
 quickest ImageMagick and GraphicsMagick settings.
 
 Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
-Bicubic interpolation with Lanczos anti-alias filtering ensures quality is not sacrificed for speed.
+Lanczos resampling ensures quality is not sacrificed for speed.
 
 As well as image resizing, operations such as
 rotation, extraction, compositing and gamma correction are available.
 
-Most Windows (x64), Linux and ARMv6+ systems do not require
+OS X, Windows (x64), Linux (x64, ARM) systems do not require
 the installation of any external runtime dependencies.
 
-Use with OS X is as simple as running `brew install homebrew/science/vips`
+## Examples
-to install the libvips dependency.
+
+```javascript
+import sharp from 'sharp';
+```
+
+```javascript
+sharp(inputBuffer)
+  .resize(320, 240)
+  .toFile('output.webp', (err, info) => ... );
+```
+
+```javascript
+sharp('input.jpg')
+  .rotate()
+  .resize(200)
+  .toBuffer()
+  .then( data => ... )
+  .catch( err => ... );
+```
+
+```javascript
+const roundedCorners = new Buffer(
+  '<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>'
+);
+
+const roundedCornerResizer =
+  sharp()
+    .resize(200, 200)
+    .overlayWith(roundedCorners, { cutout: true })
+    .png();
+
+readableStream
+  .pipe(roundedCornerResizer)
+  .pipe(writableStream);
+```
 
 [![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
 
@@ -36,7 +74,7 @@ covers reporting bugs, requesting features and submitting code changes.
 
 ### Licence
 
-Copyright 2013, 2014, 2015, 2016 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

appveyor.yml

@@ -3,13 +3,13 @@ version: "{build}"
 build: off
 platform: x64
 environment:
-  VIPS_WARNING: 0
   matrix:
-  - nodejs_version: "0.12"
   - nodejs_version: "4"
-  - nodejs_version: "5"
+  - nodejs_version: "6"
+  - nodejs_version: "7"
 install:
   - ps: Install-Product node $env:nodejs_version x64
+  - npm install -g npm@latest
   - npm install
 test_script:
-  - npm run-script test-win
+  - npm test

binding.gyp

@@ -9,7 +9,8 @@
           'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
         },
         'defines': [
-          'VIPS_CPLUSPLUS_EXPORTS'
+          'VIPS_CPLUSPLUS_EXPORTS',
+          '_ALLOW_KEYWORD_MACROS'
         ],
         'sources': [
           'src/libvips/cplusplus/VError.cpp',
@@ -17,14 +18,14 @@
           'src/libvips/cplusplus/VImage.cpp'
         ],
         'include_dirs': [
-          '<(module_root_dir)/include',
+          'vendor/include',
-          '<(module_root_dir)/include/glib-2.0',
+          'vendor/include/glib-2.0',
-          '<(module_root_dir)/lib/glib-2.0/include'
+          'vendor/lib/glib-2.0/include'
         ],
         'libraries': [
-          '<(module_root_dir)/lib/libvips.lib',
+          '../vendor/lib/libvips.lib',
-          '<(module_root_dir)/lib/libglib-2.0.lib',
+          '../vendor/lib/libglib-2.0.lib',
-          '<(module_root_dir)/lib/libgobject-2.0.lib'
+          '../vendor/lib/libgobject-2.0.lib'
         ],
         'configurations': {
           'Release': {
@@ -90,9 +91,6 @@
       'src/sharp.cc',
       'src/utilities.cc'
     ],
-    'defines': [
-      '_GLIBCXX_USE_CXX11_ABI=0'
-    ],
     'include_dirs': [
       '<!(node -e "require(\'nan\')")'
     ],
@@ -105,52 +103,86 @@
             'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs --static vips-cpp)']
           }, {
             'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs vips-cpp)']
+          }],
+          ['OS == "linux"', {
+            'defines': [
+              # Inspect libvips-cpp.so to determine which C++11 ABI version was used and set _GLIBCXX_USE_CXX11_ABI accordingly. This is quite horrible.
+              '_GLIBCXX_USE_CXX11_ABI=<!(if readelf -Ws "$(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --variable libdir vips-cpp)/libvips-cpp.so" | c++filt | grep -qF __cxx11;then echo "1";else echo "0";fi)'
+            ]
           }]
         ]
       }, {
         # Attempt to download pre-built libvips and install locally within node_modules
         'include_dirs': [
-          '<(module_root_dir)/include',
+          'vendor/include',
-          '<(module_root_dir)/include/glib-2.0',
+          'vendor/include/glib-2.0',
-          '<(module_root_dir)/lib/glib-2.0/include'
+          'vendor/lib/glib-2.0/include'
         ],
         'conditions': [
           ['OS == "win"', {
+            'defines': [
+              '_ALLOW_KEYWORD_MACROS'
+            ],
             'libraries': [
-              '<(module_root_dir)/lib/libvips.lib',
+              '../vendor/lib/libvips.lib',
-              '<(module_root_dir)/lib/libglib-2.0.lib',
+              '../vendor/lib/libglib-2.0.lib',
-              '<(module_root_dir)/lib/libgobject-2.0.lib'
+              '../vendor/lib/libgobject-2.0.lib'
+            ]
+          }],
+          ['OS == "mac"', {
+            'variables': {
+              'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
+            },
+            'libraries': [
+              '../vendor/lib/libvips-cpp.42.dylib',
+              '../vendor/lib/libvips.42.dylib',
+              '../vendor/lib/libglib-2.0.0.dylib',
+              '../vendor/lib/libgobject-2.0.0.dylib',
+              # Ensure runtime linking is relative to sharp.node
+              '-rpath \'@loader_path/../../vendor/lib\''
             ]
           }],
           ['OS == "linux"', {
             'variables': {
               'download_vips': '<!(LDD_VERSION="<!(ldd --version 2>&1 || true)" node -e "require(\'./binding\').download_vips()")'
             },
+            'defines': [
+              '_GLIBCXX_USE_CXX11_ABI=0'
+            ],
             'libraries': [
-              '<(module_root_dir)/lib/libvips-cpp.so',
+              '../vendor/lib/libvips-cpp.so',
-              '<(module_root_dir)/lib/libvips.so',
+              '../vendor/lib/libvips.so',
-              '<(module_root_dir)/lib/libglib-2.0.so',
+              '../vendor/lib/libglib-2.0.so',
-              '<(module_root_dir)/lib/libgobject-2.0.so',
+              '../vendor/lib/libgobject-2.0.so',
               # Dependencies of dependencies, included for openSUSE support
-              '<(module_root_dir)/lib/libGraphicsMagick.so',
+              '../vendor/lib/libcairo.so',
-              '<(module_root_dir)/lib/libGraphicsMagickWand.so',
+              '../vendor/lib/libcroco-0.6.so',
-              '<(module_root_dir)/lib/libexif.so',
+              '../vendor/lib/libexif.so',
-              '<(module_root_dir)/lib/libgio-2.0.so',
+              '../vendor/lib/libffi.so',
-              '<(module_root_dir)/lib/libgmodule-2.0.so',
+              '../vendor/lib/libfontconfig.so',
-              '<(module_root_dir)/lib/libgsf-1.so',
+              '../vendor/lib/libfreetype.so',
-              '<(module_root_dir)/lib/libjpeg.so',
+              '../vendor/lib/libgdk_pixbuf-2.0.so',
-              '<(module_root_dir)/lib/libpng.so',
+              '../vendor/lib/libgif.so',
-              '<(module_root_dir)/lib/libtiff.so',
+              '../vendor/lib/libgio-2.0.so',
-              '<(module_root_dir)/lib/libwebp.so',
+              '../vendor/lib/libgmodule-2.0.so',
-              '<(module_root_dir)/lib/libz.so',
+              '../vendor/lib/libgsf-1.so',
-              '<(module_root_dir)/lib/libffi.so',
+              '../vendor/lib/libgthread-2.0.so',
-              '<(module_root_dir)/lib/libgthread-2.0.so',
+              '../vendor/lib/libharfbuzz.so',
-              '<(module_root_dir)/lib/liblcms2.so',
+              '../vendor/lib/libjpeg.so',
-              '<(module_root_dir)/lib/libpng16.so',
+              '../vendor/lib/liblcms2.so',
-              '<(module_root_dir)/lib/libxml2.so',
+              '../vendor/lib/liborc-0.4.so',
-              '<(module_root_dir)/lib/liborc-0.4.so',
+              '../vendor/lib/libpango-1.0.so',
+              '../vendor/lib/libpangocairo-1.0.so',
+              '../vendor/lib/libpangoft2-1.0.so',
+              '../vendor/lib/libpixman-1.so',
+              '../vendor/lib/libpng.so',
+              '../vendor/lib/librsvg-2.so',
+              '../vendor/lib/libtiff.so',
+              '../vendor/lib/libwebp.so',
+              '../vendor/lib/libxml2.so',
+              '../vendor/lib/libz.so',
               # Ensure runtime linking is relative to sharp.node
-              '-Wl,-rpath=\'$${ORIGIN}/../../lib\''
+              '-Wl,--disable-new-dtags -Wl,-rpath=\'$${ORIGIN}/../../vendor/lib\''
             ]
           }]
         ]
@@ -167,6 +199,7 @@
       'CLANG_CXX_LIBRARY': 'libc++',
       'MACOSX_DEPLOYMENT_TARGET': '10.7',
       'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+      'GCC_ENABLE_CPP_RTTI': 'YES',
       'OTHER_CPLUSPLUSFLAGS': [
         '-fexceptions',
         '-Wall',
@@ -195,46 +228,48 @@
       ['OS == "win"', {
         # Windows lacks support for rpath
         'copies': [{
-          'destination': '<(module_root_dir)/build/Release',
+          'destination': 'build/Release',
           'files': [
-            '<(module_root_dir)/lib/GNU.Gettext.dll',
+            'vendor/lib/GNU.Gettext.dll',
-            '<(module_root_dir)/lib/libMagickCore-6.Q16-2.dll',
+            'vendor/lib/libasprintf-0.dll',
-            '<(module_root_dir)/lib/libMagickWand-6.Q16-2.dll',
+            'vendor/lib/libcairo-2.dll',
-            '<(module_root_dir)/lib/libasprintf-0.dll',
+            'vendor/lib/libcairo-gobject-2.dll',
-            '<(module_root_dir)/lib/libcairo-2.dll',
+            'vendor/lib/libcairo-script-interpreter-2.dll',
-            '<(module_root_dir)/lib/libcairo-gobject-2.dll',
+            'vendor/lib/libcharset-1.dll',
-            '<(module_root_dir)/lib/libcairo-script-interpreter-2.dll',
+            'vendor/lib/libcroco-0.6-3.dll',
-            '<(module_root_dir)/lib/libexif-12.dll',
+            'vendor/lib/libexif-12.dll',
-            '<(module_root_dir)/lib/libexpat-1.dll',
+            'vendor/lib/libexpat-1.dll',
-            '<(module_root_dir)/lib/libffi-6.dll',
+            'vendor/lib/libffi-6.dll',
-            '<(module_root_dir)/lib/libfftw3-3.dll',
+            'vendor/lib/libfftw3-3.dll',
-            '<(module_root_dir)/lib/libfontconfig-1.dll',
+            'vendor/lib/libfontconfig-1.dll',
-            '<(module_root_dir)/lib/libfreetype-6.dll',
+            'vendor/lib/libfreetype-6.dll',
-            '<(module_root_dir)/lib/libgcc_s_seh-1.dll',
+            'vendor/lib/libgcc_s_seh-1.dll',
-            '<(module_root_dir)/lib/libgdk_pixbuf-2.0-0.dll',
+            'vendor/lib/libgdk_pixbuf-2.0-0.dll',
-            '<(module_root_dir)/lib/libgio-2.0-0.dll',
+            'vendor/lib/libgif-7.dll',
-            '<(module_root_dir)/lib/libglib-2.0-0.dll',
+            'vendor/lib/libgio-2.0-0.dll',
-            '<(module_root_dir)/lib/libgmodule-2.0-0.dll',
+            'vendor/lib/libglib-2.0-0.dll',
-            '<(module_root_dir)/lib/libgobject-2.0-0.dll',
+            'vendor/lib/libgmodule-2.0-0.dll',
-            '<(module_root_dir)/lib/libgsf-1-114.dll',
+            'vendor/lib/libgobject-2.0-0.dll',
-            '<(module_root_dir)/lib/libgthread-2.0-0.dll',
+            'vendor/lib/libgsf-1-114.dll',
-            '<(module_root_dir)/lib/libintl-8.dll',
+            'vendor/lib/libgthread-2.0-0.dll',
-            '<(module_root_dir)/lib/libjpeg-62.dll',
+            'vendor/lib/libiconv-2.dll',
-            '<(module_root_dir)/lib/liblcms2-2.dll',
+            'vendor/lib/libintl-8.dll',
-            '<(module_root_dir)/lib/libopenjp2.dll',
+            'vendor/lib/libjpeg-62.dll',
-            '<(module_root_dir)/lib/libopenslide-0.dll',
+            'vendor/lib/liblcms2-2.dll',
-            '<(module_root_dir)/lib/libpango-1.0-0.dll',
+            'vendor/lib/libpango-1.0-0.dll',
-            '<(module_root_dir)/lib/libpangocairo-1.0-0.dll',
+            'vendor/lib/libpangocairo-1.0-0.dll',
-            '<(module_root_dir)/lib/libpangowin32-1.0-0.dll',
+            'vendor/lib/libpangowin32-1.0-0.dll',
-            '<(module_root_dir)/lib/libpixman-1-0.dll',
+            'vendor/lib/libpixman-1-0.dll',
-            '<(module_root_dir)/lib/libpng16-16.dll',
+            'vendor/lib/libpng16-16.dll',
-            '<(module_root_dir)/lib/libquadmath-0.dll',
+            'vendor/lib/libquadmath-0.dll',
-            '<(module_root_dir)/lib/libsqlite3-0.dll',
+            'vendor/lib/librsvg-2-2.dll',
-            '<(module_root_dir)/lib/libssp-0.dll',
+            'vendor/lib/libssp-0.dll',
-            '<(module_root_dir)/lib/libtiff-5.dll',
+            'vendor/lib/libstdc++-6.dll',
-            '<(module_root_dir)/lib/libvips-42.dll',
+            'vendor/lib/libtiff-5.dll',
-            '<(module_root_dir)/lib/libxml2-2.dll',
+            'vendor/lib/libvips-42.dll',
-            '<(module_root_dir)/lib/zlib1.dll'
+            'vendor/lib/libwebp-6.dll',
+            'vendor/lib/libxml2-2.dll',
+            'vendor/lib/zlib1.dll'
           ]
         }]
       }]

binding.js

@@ -1,50 +1,58 @@
 'use strict';
 
-var fs = require('fs');
+const fs = require('fs');
-var path = require('path');
+const os = require('os');
-var zlib = require('zlib');
+const path = require('path');
+const zlib = require('zlib');
 
-var semver = require('semver');
+const caw = require('caw');
-var request = require('request');
+const got = require('got');
-var tar = require('tar');
+const semver = require('semver');
+const tar = require('tar');
 
-var tmp = require('os').tmpdir();
+const distBaseUrl = 'https://dl.bintray.com/lovell/sharp/';
 
-var distBaseUrl = 'https://dl.bintray.com/lovell/sharp/';
+// Use NPM-provided environment variable where available, falling back to require-based method for Electron
+const minimumLibvipsVersion = process.env.npm_package_config_libvips || require('./package.json').config.libvips;
 
-var vipsHeaderPath = path.join(__dirname, 'include', 'vips', 'vips.h');
+const platform = process.env.npm_config_platform || process.platform;
+
+const arch = process.env.npm_config_arch || process.arch;
 
 // -- Helpers
 
 // Does this file exist?
-var isFile = function(file) {
+const isFile = function (file) {
-  var exists = false;
   try {
-    exists = fs.statSync(file).isFile();
+    return fs.statSync(file).isFile();
   } catch (err) {}
-  return exists;
 };
 
-var unpack = function(tarPath, done) {
+const unpack = function (tarPath, done) {
-  var extractor = tar.Extract({
+  const extractor = tar.Extract({ path: path.join(__dirname, 'vendor') });
-    path: __dirname
+  if (done) {
-  });
+    extractor.on('end', done);
+  }
   extractor.on('error', error);
-  extractor.on('end', function() {
+  fs.createReadStream(tarPath)
-    if (!isFile(vipsHeaderPath)) {
+    .on('error', error)
-      error('Could not unpack ' + tarPath);
-    }
-    if (typeof done === 'function') {
-      done();
-    }
-  });
-  fs.createReadStream(tarPath).on('error', error)
     .pipe(zlib.Unzip())
     .pipe(extractor);
 };
 
+const platformId = function () {
+  const platformId = [platform];
+  if (arch === 'arm' || arch === 'armhf' || arch === 'arch64') {
+    const armVersion = (arch === 'arch64') ? '8' : process.env.npm_config_armv || process.config.variables.arm_version || '6';
+    platformId.push('armv' + armVersion);
+  } else {
+    platformId.push(arch);
+  }
+  return platformId.join('-');
+};
+
 // Error
-var error = function(msg) {
+const error = function (msg) {
   if (msg instanceof Error) {
     msg = msg.message;
   }
@@ -54,18 +62,19 @@ var error = function(msg) {
 
 // -- Binary downloaders
 
-module.exports.download_vips = function() {
+module.exports.download_vips = function () {
   // Has vips been installed locally?
+  const vipsHeaderPath = path.join(__dirname, 'vendor', 'include', 'vips', 'vips.h');
   if (!isFile(vipsHeaderPath)) {
     // Ensure Intel 64-bit or ARM
-    if (process.arch === 'ia32') {
+    if (arch === 'ia32') {
       error('Intel Architecture 32-bit systems require manual installation - please see http://sharp.dimens.io/en/stable/install/');
     }
     // Ensure glibc >= 2.15
-    var lddVersion = process.env.LDD_VERSION;
+    const lddVersion = process.env.LDD_VERSION;
     if (lddVersion) {
       if (/(glibc|gnu libc)/i.test(lddVersion)) {
-        var glibcVersion = lddVersion ? lddVersion.split(/\n/)[0].split(' ').slice(-1)[0].trim() : '';
+        const glibcVersion = lddVersion ? lddVersion.split(/\n/)[0].split(' ').slice(-1)[0].trim() : '';
         if (glibcVersion && semver.lt(glibcVersion + '.0', '2.13.0')) {
           error('glibc version ' + glibcVersion + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
         }
@@ -74,58 +83,47 @@ module.exports.download_vips = function() {
       }
     }
     // Arch/platform-specific .tar.gz
-    var platform = (process.arch === 'arm') ? 'arm' : process.platform.substr(0, 3);
+    const tarFilename = ['libvips', minimumLibvipsVersion, platformId()].join('-') + '.tar.gz';
-    var tarFilename = ['libvips', process.env.npm_package_config_libvips, platform].join('-') + '.tar.gz';
+    const tarPathLocal = path.join(__dirname, 'packaging', tarFilename);
-    var tarPath = path.join(__dirname, 'packaging', tarFilename);
+    if (isFile(tarPathLocal)) {
-    if (isFile(tarPath)) {
+      unpack(tarPathLocal);
-      unpack(tarPath);
     } else {
       // Download to per-process temporary file
-      tarPath = path.join(tmp, process.pid + '-' + tarFilename);
+      const tarPathTemp = path.join(os.tmpdir(), process.pid + '-' + tarFilename);
-      var tmpFile = fs.createWriteStream(tarPath).on('finish', function() {
+      const tmpFile = fs.createWriteStream(tarPathTemp).on('finish', function () {
-        unpack(tarPath, function() {
+        unpack(tarPathTemp, function () {
           // Attempt to remove temporary file
           try {
-            fs.unlinkSync(tarPath);
+            fs.unlinkSync(tarPathTemp);
           } catch (err) {}
         });
       });
-      var options = {
+      const gotOpt = {
-        url: distBaseUrl + tarFilename
+        agent: caw(null, {
+          protocol: 'https'
+        })
       };
-      if (process.env.npm_config_https_proxy) {
+      const url = distBaseUrl + tarFilename;
-        // Use the NPM-configured HTTPS proxy
+      got.stream(url, gotOpt).on('response', function (response) {
-        options.proxy = process.env.npm_config_https_proxy;
-      }
-      request(options).on('response', function(response) {
         if (response.statusCode !== 200) {
-          error(distBaseUrl + tarFilename + ' status code ' + response.statusCode);
+          error(url + ' status code ' + response.statusCode);
         }
-      }).on('error', function(err) {
+      }).on('error', function (err) {
-        error('Download from ' + distBaseUrl + tarFilename + ' failed: ' + err.message);
+        error('Download of ' + url + ' failed: ' + err.message);
       }).pipe(tmpFile);
     }
   }
 };
 
-module.exports.use_global_vips = function() {
+module.exports.use_global_vips = function () {
-  var useGlobalVips = false;
+  const globalVipsVersion = process.env.GLOBAL_VIPS_VERSION;
-  var globalVipsVersion = process.env.GLOBAL_VIPS_VERSION;
   if (globalVipsVersion) {
-    useGlobalVips = semver.gte(
+    const useGlobalVips = semver.gte(
       globalVipsVersion,
-      process.env.npm_package_config_libvips
+      minimumLibvipsVersion
     );
+    process.stdout.write(useGlobalVips ? 'true' : 'false');
+  } else {
+    process.stdout.write('false');
   }
-  if (process.platform === 'darwin' && !useGlobalVips) {
-    if (globalVipsVersion) {
-      error(
-        'Found libvips ' + globalVipsVersion + ' but require ' + process.env.npm_package_config_libvips +
-        '\nPlease upgrade libvips by running: brew update && brew upgrade'
-      );
-    } else {
-      error('Please install libvips by running: brew install homebrew/science/vips --with-webp --with-graphicsmagick');
-    }
-  }
-  process.stdout.write(useGlobalVips ? 'true' : 'false');
 };

circle.yml

@@ -1,6 +1,8 @@
 machine:
+  node:
+    version: v4.6.1
   services:
     - docker
 test:
   override:
-    - ./packaging/test.sh
+    - ./packaging/test-linux-x64.sh

docs/api-channel.md

@@ -0,0 +1,77 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [extractChannel](#extractchannel)
+-   [joinChannel](#joinchannel)
+-   [bandbool](#bandbool)
+
+## extractChannel
+
+Extract a single channel from a multi-channel image.
+
+**Parameters**
+
+-   `channel` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** zero-indexed band number to extract, or `red`, `green` or `blue` as alternative to `0`, `1` or `2` respectively.
+
+**Examples**
+
+```javascript
+sharp(input)
+  .extractChannel('green')
+  .toFile('input_green.jpg', function(err, info) {
+    // info.channels === 1
+    // input_green.jpg contains the green channel of the input image
+   });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid channel
+
+Returns **Sharp** 
+
+## joinChannel
+
+Join one or more channels to the image.
+The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
+By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
+Channel ordering follows vips convention:
+
+-   sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
+-   CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
+
+Buffers may be any of the image formats supported by sharp: JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data.
+For raw pixel input, the `options` object should contain a `raw` attribute, which follows the format of the attribute of the same name in the `sharp()` constructor.
+
+**Parameters**
+
+-   `images` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))> | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** one or more images (file paths, Buffers).
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** image options, see `sharp()` constructor.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## bandbool
+
+Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
+
+**Parameters**
+
+-   `boolOp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+
+**Examples**
+
+```javascript
+sharp('3-channel-rgb-input.png')
+  .bandbool(sharp.bool.and)
+  .toFile('1-channel-output.png', function (err, info) {
+    // The output will be a single channel image where each pixel `P = R & G & B`.
+    // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
+    // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 

docs/api-colour.md

@@ -0,0 +1,79 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [background](#background)
+-   [greyscale](#greyscale)
+-   [grayscale](#grayscale)
+-   [toColourspace](#tocolourspace)
+-   [toColorspace](#tocolorspace)
+
+## background
+
+Set the background for the `embed`, `flatten` and `extend` operations.
+The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
+
+Delegates to the _color_ module, which can throw an Error
+but is liberal in what it accepts, clipping values to sensible min/max.
+The alpha value is a float between `0` (transparent) and `1` (opaque).
+
+**Parameters**
+
+-   `rgba` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameter
+
+Returns **Sharp** 
+
+## greyscale
+
+Convert to 8-bit greyscale; 256 shades of grey.
+This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
+By default the output image will be web-friendly sRGB and contain three (identical) color channels.
+This may be overridden by other sharp operations such as `toColourspace('b-w')`,
+which will produce an output image containing one color channel.
+An alpha channel may be present, and will be unchanged by the operation.
+
+**Parameters**
+
+-   `greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## grayscale
+
+Alternative spelling of `greyscale`.
+
+**Parameters**
+
+-   `grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## toColourspace
+
+Set the output colourspace.
+By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
+
+**Parameters**
+
+-   `colourspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## toColorspace
+
+Alternative spelling of `toColourspace`.
+
+**Parameters**
+
+-   `colorspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colorspace.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 

docs/api-composite.md

@@ -0,0 +1,57 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [overlayWith](#overlaywith)
+
+## overlayWith
+
+Overlay (composite) an image over the processed (resized, extracted etc.) image.
+
+The overlay image must be the same size or smaller than the processed image.
+If both `top` and `left` options are provided, they take precedence over `gravity`.
+
+**Parameters**
+
+-   `overlay` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.gravity` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** gravity at which to place the overlay. (optional, default `'centre'`)
+    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the top edge.
+    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the left edge.
+    -   `options.tile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
+    -   `options.cutout` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another. (optional, default `false`)
+    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** integral number representing the DPI for vector overlay image. (optional, default `72`)
+    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes overlay when using raw pixel data.
+        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a blank overlay to be created.
+        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
+        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+
+**Examples**
+
+```javascript
+sharp('input.png')
+  .rotate(180)
+  .resize(300)
+  .flatten()
+  .background('#ff6600')
+  .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
+  .sharpen()
+  .withMetadata()
+  .quality(90)
+  .webp()
+  .toBuffer()
+  .then(function(outputBuffer) {
+    // outputBuffer contains upside down, 300px wide, alpha channel flattened
+    // onto orange background, composited with overlay.png with SE gravity,
+    // sharpened, with metadata, 90% quality WebP image data. Phew!
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 

docs/api-constructor.md

@@ -0,0 +1,108 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [Sharp](#sharp)
+    -   [format](#format)
+    -   [versions](#versions)
+-   [queue](#queue)
+
+## Sharp
+
+**Parameters**
+
+-   `input` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))?** if present, can be
+     a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
+     a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
+     JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when null or undefined.
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** if present, is an Object with optional attributes.
+    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** integral number representing the DPI for vector images. (optional, default `72`)
+    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes raw pixel input image data. See `raw()` for pixel ordering.
+        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 1-4
+    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a new image to be created.
+        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
+        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+
+**Examples**
+
+```javascript
+sharp('input.jpg')
+  .resize(300, 200)
+  .toFile('output.jpg', function(err) {
+    // output.jpg is a 300 pixels wide and 200 pixels high image
+    // containing a scaled and cropped version of input.jpg
+  });
+```
+
+```javascript
+// Read image data from readableStream,
+// resize to 300 pixels wide,
+// emit an 'info' event with calculated dimensions
+// and finally write image data to writableStream
+var transformer = sharp()
+  .resize(300)
+  .on('info', function(info) {
+    console.log('Image height is ' + info.height);
+  });
+readableStream.pipe(transformer).pipe(writableStream);
+```
+
+```javascript
+// Create a blank 300x200 PNG image of semi-transluent red pixels
+sharp(null, {
+  create: {
+    width: 300,
+    height: 200,
+    channels: 4,
+    background: { r: 255, g: 0, b: 0, alpha: 128 }
+  }
+})
+.png()
+.toBuffer()
+.then( ... );
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **[Sharp](#sharp)** 
+
+### format
+
+An Object containing nested boolean values representing the available input and output formats/methods.
+
+**Examples**
+
+```javascript
+console.log(sharp.format());
+```
+
+Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+### versions
+
+An Object containing the version numbers of libvips and its dependencies.
+
+**Examples**
+
+```javascript
+console.log(sharp.versions);
+```
+
+## queue
+
+An EventEmitter that emits a `change` event when a task is either:
+
+-   queued, waiting for _libuv_ to provide a worker thread
+-   complete
+
+**Examples**
+
+```javascript
+sharp.queue.on('change', function(queueLength) {
+  console.log('Queue contains ' + queueLength + ' task(s)');
+});
+```

docs/api-input.md

@@ -0,0 +1,93 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [clone](#clone)
+-   [metadata](#metadata)
+-   [limitInputPixels](#limitinputpixels)
+-   [sequentialRead](#sequentialread)
+
+## clone
+
+Take a "snapshot" of the Sharp instance, returning a new instance.
+Cloned instances inherit the input of their parent instance.
+This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
+
+**Examples**
+
+```javascript
+const pipeline = sharp().rotate();
+pipeline.clone().resize(800, 600).pipe(firstWritableStream);
+pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
+readableStream.pipe(pipeline);
+// firstWritableStream receives auto-rotated, resized readableStream
+// secondWritableStream receives auto-rotated, extracted region of readableStream
+```
+
+Returns **Sharp** 
+
+## metadata
+
+Fast access to image metadata without decoding any compressed image data.
+A Promises/A+ promise is returned when `callback` is not provided.
+
+-   `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
+-   `width`: Number of pixels wide
+-   `height`: Number of pixels high
+-   `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+-   `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
+-   `density`: Number of pixels per inch (DPI), if present
+-   `hasProfile`: Boolean indicating the presence of an embedded ICC profile
+-   `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
+-   `orientation`: Number value of the EXIF Orientation header, if present
+-   `exif`: Buffer containing raw EXIF data, if present
+-   `icc`: Buffer containing raw [ICC](https://www.npmjs.com/package/icc) profile data, if present
+
+**Parameters**
+
+-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called with the arguments `(err, metadata)`
+
+**Examples**
+
+```javascript
+const image = sharp(inputJpg);
+image
+  .metadata()
+  .then(function(metadata) {
+    return image
+      .resize(Math.round(metadata.width / 2))
+      .webp()
+      .toBuffer();
+  })
+  .then(function(data) {
+    // data contains a WebP image half the width and height of the original JPEG
+  });
+```
+
+Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)> | Sharp)** 
+
+## limitInputPixels
+
+Do not process input images where the number of pixels (width _ height) exceeds this limit.
+Assumes image dimensions contained in the input metadata can be trusted.
+The default limit is 268402689 (0x3FFF _ 0x3FFF) pixels.
+
+**Parameters**
+
+-   `limit` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** an integral Number of pixels, zero or false to remove limit, true to use default limit.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid limit
+
+Returns **Sharp** 
+
+## sequentialRead
+
+An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
+This will reduce memory usage and can improve performance on some systems.
+
+**Parameters**
+
+-   `sequentialRead` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 

docs/api-operation.md

@@ -0,0 +1,320 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [rotate](#rotate)
+-   [extract](#extract)
+-   [flip](#flip)
+-   [flop](#flop)
+-   [sharpen](#sharpen)
+-   [blur](#blur)
+-   [extend](#extend)
+-   [flatten](#flatten)
+-   [trim](#trim)
+-   [gamma](#gamma)
+-   [negate](#negate)
+-   [normalise](#normalise)
+-   [normalize](#normalize)
+-   [convolve](#convolve)
+-   [threshold](#threshold)
+-   [boolean](#boolean)
+
+## rotate
+
+Rotate the output image by either an explicit angle
+or auto-orient based on the EXIF `Orientation` tag.
+
+Use this method without angle to determine the angle from EXIF data.
+Mirroring is supported and may infer the use of a flip operation.
+
+The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.
+
+Method order is important when both rotating and extracting regions,
+for example `rotate(x).extract(y)` will produce a different result to `extract(y).rotate(x)`.
+
+**Parameters**
+
+-   `angle` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 0, 90, 180 or 270. (optional, default `auto`)
+
+**Examples**
+
+```javascript
+const pipeline = sharp()
+  .rotate()
+  .resize(null, 200)
+  .toBuffer(function (err, outputBuffer, info) {
+    // outputBuffer contains 200px high JPEG image data,
+    // auto-rotated using EXIF Orientation tag
+    // info.width and info.height contain the dimensions of the resized image
+  });
+readableStream.pipe(pipeline);
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## extract
+
+Extract a region of the image.
+
+-   Use `extract` before `resize` for pre-resize extraction.
+-   Use `extract` after `resize` for post-resize extraction.
+-   Use `extract` before and after for both.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from left edge
+    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from top edge
+    -   `options.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
+    -   `options.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
+
+**Examples**
+
+```javascript
+sharp(input)
+  .extract({ left: left, top: top, width: width, height: height })
+  .toFile(output, function(err) {
+    // Extract a region of the input image, saving in the same format.
+  });
+```
+
+```javascript
+sharp(input)
+  .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
+  .resize(width, height)
+  .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
+  .toFile(output, function(err) {
+    // Extract a region, resize, then extract from the resized image
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## flip
+
+Flip the image about the vertical Y axis. This always occurs after rotation, if any.
+The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.
+
+**Parameters**
+
+-   `flip` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## flop
+
+Flop the image about the horizontal X axis. This always occurs after rotation, if any.
+The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.
+
+**Parameters**
+
+-   `flop` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## sharpen
+
+Sharpen the image.
+When used without parameters, performs a fast, mild sharpen of the output image.
+When a `sigma` is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space.
+Separate control over the level of sharpening in "flat" and "jagged" areas is available.
+
+**Parameters**
+
+-   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+-   `flat` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
+-   `jagged` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## blur
+
+Blur the image.
+When used without parameters, performs a fast, mild blur of the output image.
+When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
+
+**Parameters**
+
+-   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## extend
+
+Extends/pads the edges of the image with the colour provided to the `background` method.
+This operation will always occur after resizing and extraction, if any.
+
+**Parameters**
+
+-   `extend` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** single pixel count to add to all edges or an Object with per-edge counts
+    -   `extend.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `extend.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `extend.bottom` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `extend.right` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+
+**Examples**
+
+```javascript
+// Resize to 140 pixels wide, then add 10 transparent pixels
+// to the top, left and right edges and 20 to the bottom edge
+sharp(input)
+  .resize(140)
+  .background({r: 0, g: 0, b: 0, alpha: 0})
+  .extend({top: 10, bottom: 20, left: 10, right: 10})
+  ...
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## flatten
+
+Merge alpha transparency channel, if any, with `background`.
+
+**Parameters**
+
+-   `flatten` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## trim
+
+Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
+
+**Parameters**
+
+-   `tolerance` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1 and 99 representing the percentage similarity. (optional, default `10`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## gamma
+
+Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of `1/gamma`
+then increasing the encoding (brighten) post-resize at a factor of `gamma`.
+This can improve the perceived brightness of a resized image in non-linear colour spaces.
+JPEG and WebP input images will not take advantage of the shrink-on-load performance optimisation
+when applying a gamma correction.
+
+**Parameters**
+
+-   `gamma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1.0 and 3.0. (optional, default `2.2`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## negate
+
+Produce the "negative" of the image.
+
+**Parameters**
+
+-   `negate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## normalise
+
+Enhance output image contrast by stretching its luminance to cover the full dynamic range.
+
+**Parameters**
+
+-   `normalise` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## normalize
+
+Alternative spelling of normalise.
+
+**Parameters**
+
+-   `normalize` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## convolve
+
+Convolve the image with the specified kernel.
+
+**Parameters**
+
+-   `kernel` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+    -   `kernel.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
+    -   `kernel.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
+    -   `kernel.kernel` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Array of length `width*height` containing the kernel values.
+    -   `kernel.scale` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the scale of the kernel in pixels. (optional, default `sum`)
+    -   `kernel.offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the offset of the kernel in pixels. (optional, default `0`)
+
+**Examples**
+
+```javascript
+sharp(input)
+  .convolve({
+    width: 3,
+    height: 3,
+    kernel: [-1, 0, 1, -2, 0, 2, -1, 0, 1]
+  })
+  .raw()
+  .toBuffer(function(err, data, info) {
+    // data contains the raw pixel data representing the convolution
+    // of the input image with the horizontal Sobel operator
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## threshold
+
+Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
+
+**Parameters**
+
+-   `threshold` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** convert to single channel greyscale. (optional, default `true`)
+    -   `options.grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling for greyscale. (optional, default `true`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## boolean
+
+Perform a bitwise boolean operation with operand image.
+
+This operation creates an output image where each pixel is the result of
+the selected bitwise boolean `operation` between the corresponding pixels of the input images.
+
+**Parameters**
+
+-   `operand` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
+-   `operator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes operand when using raw pixel data.
+        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 

docs/api-output.md

@@ -0,0 +1,197 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [toFile](#tofile)
+-   [toBuffer](#tobuffer)
+-   [withMetadata](#withmetadata)
+-   [jpeg](#jpeg)
+-   [png](#png)
+-   [webp](#webp)
+-   [tiff](#tiff)
+-   [raw](#raw)
+-   [toFormat](#toformat)
+-   [tile](#tile)
+
+## toFile
+
+Write output image data to a file.
+
+If an explicit output format is not selected, it will be inferred from the extension,
+with JPEG, PNG, WebP, TIFF, DZI, and libvips' V format supported.
+Note that raw pixel data is only supported for buffer output.
+
+A Promises/A+ promise is returned when `callback` is not provided.
+
+**Parameters**
+
+-   `fileOut` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the path to write the image data to.
+-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called on completion with two arguments `(err, info)`.
+    `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** when no callback is provided
+
+## toBuffer
+
+Write output to a Buffer.
+JPEG, PNG, WebP, and RAW output are supported.
+By default, the format will match the input image, except GIF and SVG input which become PNG output.
+
+`callback`, if present, gets three arguments `(err, data, info)` where:
+
+-   `err` is an error, if any.
+-   `data` is the output image data.
+-   `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+    A Promise is returned when `callback` is not provided.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.resolveWithObject` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
+-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** 
+
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Buffer](https://nodejs.org/api/buffer.html)>** when no callback is provided
+
+## withMetadata
+
+Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
+The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
+This will also convert to and add a web-friendly sRGB ICC profile.
+
+**Parameters**
+
+-   `withMetadata` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `withMetadata.orientation` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1 and 8, used to update the EXIF `Orientation` tag.
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## jpeg
+
+Use these JPEG options for output image.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use progressive (interlace) scan (optional, default `false`)
+    -   `options.chromaSubsampling` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** set to '4:4:4' to prevent chroma subsampling when quality &lt;= 90 (optional, default `'4:2:0'`)
+    -   `options.trellisQuantisation` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** apply trellis quantisation, requires mozjpeg (optional, default `false`)
+    -   `options.overshootDeringing` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** apply overshoot deringing, requires mozjpeg (optional, default `false`)
+    -   `options.optimiseScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optimise progressive scans, forces progressive, requires mozjpeg (optional, default `false`)
+    -   `options.optimizeScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling of optimiseScans (optional, default `false`)
+    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force JPEG output, otherwise attempt to use input format (optional, default `true`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+
+Returns **Sharp** 
+
+## png
+
+Use these PNG options for output image.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use progressive (interlace) scan (optional, default `false`)
+    -   `options.compressionLevel` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** zlib compression level (optional, default `6`)
+    -   `options.adaptiveFiltering` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use adaptive row filtering (optional, default `true`)
+    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force PNG output, otherwise attempt to use input format (optional, default `true`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+
+Returns **Sharp** 
+
+## webp
+
+Use these WebP options for output image.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.alphaQuality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality of alpha layer, integer 0-100 (optional, default `100`)
+    -   `options.lossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use lossless compression mode (optional, default `false`)
+    -   `options.nearLossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use near_lossless compression mode (optional, default `false`)
+    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force WebP output, otherwise attempt to use input format (optional, default `true`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+
+Returns **Sharp** 
+
+## tiff
+
+Use these TIFF options for output image.
+
+**Parameters**
+
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force TIFF output, otherwise attempt to use input format (optional, default `true`)
+    -   `options.compression` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression options: lzw, deflate, jpeg (optional, default `'jpeg'`)
+    -   `options.predictor` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression predictor options: none, horizontal, float (optional, default `'none'`)
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+
+Returns **Sharp** 
+
+## raw
+
+Force output to be raw, uncompressed uint8 pixel data.
+
+Returns **Sharp** 
+
+## toFormat
+
+Force output to a given format.
+
+**Parameters**
+
+-   `format` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** as a String or an Object with an 'id' attribute
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options
+
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** unsupported format or options
+
+Returns **Sharp** 
+
+## tile
+
+Use tile-based deep zoom (image pyramid) output.
+Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
+Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
+
+**Parameters**
+
+-   `tile` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `tile.size` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
+    -   `tile.overlap` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
+    -   `tile.container` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
+    -   `tile.layout` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** filesystem layout, possible values are `dz`, `zoomify` or `google`. (optional, default `'dz'`)
+
+**Examples**
+
+```javascript
+sharp('input.tiff')
+  .png()
+  .tile({
+    size: 512
+  })
+  .toFile('output.dz', function(err, info) {
+    // output.dzi is the Deep Zoom XML definition
+    // output_files contains 512x512 tiles grouped by zoom level
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 

docs/api-resize.md

@@ -0,0 +1,177 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [resize](#resize)
+-   [crop](#crop)
+-   [embed](#embed)
+-   [max](#max)
+-   [min](#min)
+-   [ignoreAspectRatio](#ignoreaspectratio)
+-   [withoutEnlargement](#withoutenlargement)
+
+## resize
+
+Resize image to `width` x `height`.
+By default, the resized image is centre cropped to the exact size specified.
+
+Possible reduction kernels are:
+
+-   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+-   `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
+-   `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
+-   `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+
+Possible enlargement interpolators are:
+
+-   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+-   `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
+-   `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
+-   `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
+-   `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
+-   `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
+
+**Parameters**
+
+-   `width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use `null` or `undefined` to auto-scale the width to match the height.
+-   `height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels high the resultant image should be, between 1 and 16383. Use `null` or `undefined` to auto-scale the height to match the width.
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+    -   `options.kernel` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** the kernel to use for image reduction. (optional, default `'lanczos3'`)
+    -   `options.interpolator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** the interpolator to use for image enlargement. (optional, default `'bicubic'`)
+    -   `options.centreSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use \*magick centre sampling convention instead of corner sampling. (optional, default `false`)
+    -   `options.centerSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling of centreSampling. (optional, default `false`)
+
+**Examples**
+
+```javascript
+sharp(inputBuffer)
+  .resize(200, 300, {
+    kernel: sharp.kernel.lanczos2,
+    interpolator: sharp.interpolator.nohalo
+  })
+  .background('white')
+  .embed()
+  .toFile('output.tiff')
+  .then(function() {
+    // output.tiff is a 200 pixels wide and 300 pixels high image
+    // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
+    // of the image data in inputBuffer
+  });
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## crop
+
+Crop the resized image to the exact size specified, the default behaviour.
+
+Possible attributes of the optional `sharp.gravity` are `north`, `northeast`, `east`, `southeast`, `south`,
+`southwest`, `west`, `northwest`, `center` and `centre`.
+
+The experimental strategy-based approach resizes so one dimension is at its target length
+then repeatedly ranks edge regions, discarding the edge with the lowest score based on the selected strategy.
+
+-   `entropy`: focus on the region with the highest [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29).
+-   `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
+
+**Parameters**
+
+-   `crop` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically. (optional, default `'centre'`)
+
+**Examples**
+
+```javascript
+const transformer = sharp()
+  .resize(200, 200)
+  .crop(sharp.strategy.entropy)
+  .on('error', function(err) {
+    console.log(err);
+  });
+// Read image data from readableStream
+// Write 200px square auto-cropped image data to writableStream
+readableStream.pipe(transformer).pipe(writableStream);
+```
+
+-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+
+Returns **Sharp** 
+
+## embed
+
+Preserving aspect ratio, resize the image to the maximum `width` or `height` specified
+then embed on a background of the exact `width` and `height` specified.
+
+If the background contains an alpha value then WebP and PNG format output images will
+contain an alpha channel, even when the input image does not.
+
+**Examples**
+
+```javascript
+sharp('input.gif')
+  .resize(200, 300)
+  .background({r: 0, g: 0, b: 0, alpha: 0})
+  .embed()
+  .toFormat(sharp.format.webp)
+  .toBuffer(function(err, outputBuffer) {
+    if (err) {
+      throw err;
+    }
+    // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
+    // containing a scaled version, embedded on a transparent canvas, of input.gif
+  });
+```
+
+Returns **Sharp** 
+
+## max
+
+Preserving aspect ratio, resize the image to be as large as possible
+while ensuring its dimensions are less than or equal to the `width` and `height` specified.
+
+Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+
+**Examples**
+
+```javascript
+sharp(inputBuffer)
+  .resize(200, 200)
+  .max()
+  .toFormat('jpeg')
+  .toBuffer()
+  .then(function(outputBuffer) {
+    // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
+    // than 200 pixels regardless of the inputBuffer image dimensions
+  });
+```
+
+Returns **Sharp** 
+
+## min
+
+Preserving aspect ratio, resize the image to be as small as possible
+while ensuring its dimensions are greater than or equal to the `width` and `height` specified.
+
+Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+
+Returns **Sharp** 
+
+## ignoreAspectRatio
+
+Ignoring the aspect ratio of the input, stretch the image to
+the exact `width` and/or `height` provided via `resize`.
+
+Returns **Sharp** 
+
+## withoutEnlargement
+
+Do not enlarge the output image if the input image width _or_ height are already less than the required dimensions.
+This is equivalent to GraphicsMagick's `>` geometry option:
+"_change the dimensions of the image only if its width or height exceeds the geometry specification_".
+
+**Parameters**
+
+-   `withoutEnlargement` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+
+Returns **Sharp** 

docs/api-utility.md

@@ -0,0 +1,106 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [cache](#cache)
+-   [concurrency](#concurrency)
+-   [counters](#counters)
+-   [simd](#simd)
+
+## cache
+
+Gets, or when options are provided sets, the limits of _libvips'_ operation cache.
+Existing entries in the cache will be trimmed after any change in limits.
+This method always returns cache statistics,
+useful for determining how much working memory is required for a particular task.
+
+**Parameters**
+
+-   `options` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
+    -   `options.memory` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum memory in MB to use for this cache (optional, default `50`)
+    -   `options.files` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum number of files to hold open (optional, default `20`)
+    -   `options.items` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum number of operations to cache (optional, default `100`)
+
+**Examples**
+
+```javascript
+const stats = sharp.cache();
+```
+
+```javascript
+sharp.cache( { items: 200 } );
+sharp.cache( { files: 0 } );
+sharp.cache(false);
+```
+
+Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+## concurrency
+
+Gets, or when a concurrency is provided sets,
+the number of threads _libvips'_ should create to process each image.
+The default value is the number of CPU cores.
+A value of `0` will reset to this default.
+
+The maximum number of images that can be processed in parallel
+is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
+
+This method always returns the current concurrency.
+
+**Parameters**
+
+-   `concurrency` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+
+**Examples**
+
+```javascript
+const threads = sharp.concurrency(); // 4
+sharp.concurrency(2); // 2
+sharp.concurrency(0); // 4
+```
+
+Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** concurrency
+
+## counters
+
+Provides access to internal task counters.
+
+-   queue is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool.
+-   process is the number of resize tasks currently being processed.
+
+**Examples**
+
+```javascript
+const counters = sharp.counters(); // { queue: 2, process: 4 }
+```
+
+Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+## simd
+
+Get and set use of SIMD vector unit instructions.
+Requires libvips to have been compiled with liborc support.
+
+Improves the performance of `resize`, `blur` and `sharpen` operations
+by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
+
+This feature is currently off by default but future versions may reverse this.
+Versions of liborc prior to 0.4.25 are known to segfault under heavy load.
+
+**Parameters**
+
+-   `simd` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `false`)
+
+**Examples**
+
+```javascript
+const simd = sharp.simd();
+// simd is `true` if SIMD is currently enabled
+```
+
+```javascript
+const simd = sharp.simd(true);
+// attempts to enable the use of SIMD, returning true if available
+```
+
+Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 

docs/api.md

@@ -1,733 +0,0 @@
-# API
-
-```javascript
-var sharp = require('sharp');
-```
-
-### Input
-
-#### sharp([input], [options])
-
-Constructor to which further methods are chained.
-
-`input`, if present, can be one of:
-
-* Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
-* String containing the path to an image file, with most major formats supported.
-
-JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data
-can be streamed into the object when `input` is `null` or `undefined`.
-
-`options`, if present, is an Object with the following optional attributes:
-
-* `density` an integral number representing the DPI for vector images, defaulting to 72.
-* `raw` an Object containing `width`, `height` and `channels` when providing uncompressed data. See `raw()` for pixel ordering.
-
-The object returned by the constructor implements the
-[stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
-
-JPEG, PNG or WebP format image data can be streamed out from this object.
-When using Stream based output, derived attributes are available from the `info` event.
-
-```javascript
-sharp('input.jpg')
-  .resize(300, 200)
-  .toFile('output.jpg', function(err) {
-    // output.jpg is a 300 pixels wide and 200 pixels high image
-    // containing a scaled and cropped version of input.jpg
-  });
-```
-
-```javascript
-// Read image data from readableStream,
-// resize to 300 pixels wide,
-// emit an 'info' event with calculated dimensions
-// and finally write image data to writableStream
-var transformer = sharp()
-  .resize(300)
-  .on('info', function(info) {
-    console.log('Image height is ' + info.height);
-  });
-readableStream.pipe(transformer).pipe(writableStream);
-```
-
-#### metadata([callback])
-
-Fast access to image metadata without decoding any compressed image data.
-
-`callback`, if present, gets the arguments `(err, metadata)` where `metadata` has the attributes:
-
-* `format`: Name of decoder to be used to decompress image data e.g. `jpeg`, `png`, `webp` (for file-based input additionally `tiff`, `magick`, `openslide`, `ppm`, `fits`)
-* `width`: Number of pixels wide
-* `height`: Number of pixels high
-* `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `scrgb`, `cmyk`, `lab`, `xyz`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L522)
-* `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
-* `density`: Number of pixels per inch (DPI), if present
-* `hasProfile`: Boolean indicating the presence of an embedded ICC profile
-* `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
-* `orientation`: Number value of the EXIF Orientation header, if present
-* `exif`: Buffer containing raw EXIF data, if present
-* `icc`: Buffer containing raw [ICC](https://www.npmjs.com/package/icc) profile data, if present
-
-A Promises/A+ promise is returned when `callback` is not provided.
-
-```javascript
-var image = sharp(inputJpg);
-image
-  .metadata()
-  .then(function(metadata) {
-    return image
-      .resize(Math.round(metadata.width / 2))
-      .webp()
-      .toBuffer();
-  })
-  .then(function(data) {
-    // data contains a WebP image half the width and height of the original JPEG
-  });
-```
-
-#### clone()
-
-Takes a "snapshot" of the instance, returning a new instance.
-Cloned instances inherit the input of their parent instance.
-
-This allows multiple output Streams
-and therefore multiple processing pipelines
-to share a single input Stream.
-
-```javascript
-var pipeline = sharp().rotate();
-pipeline.clone().resize(800, 600).pipe(firstWritableStream);
-pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
-readableStream.pipe(pipeline);
-// firstWritableStream receives auto-rotated, resized readableStream
-// secondWritableStream receives auto-rotated, extracted region of readableStream
-```
-
-#### sequentialRead()
-
-An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
-This will reduce memory usage and can improve performance on some systems.
-
-#### limitInputPixels(pixels)
-
-Do not process input images where the number of pixels (width * height) exceeds this limit.
-
-`pixels` is the integral Number of pixels, with a value between 1 and the default 268402689 (0x3FFF * 0x3FFF).
-
-### Resizing
-
-#### resize([width], [height])
-
-Scale output to `width` x `height`. By default, the resized image is cropped to the exact size specified.
-
-`width` is the integral Number of pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use `null` or `undefined` to auto-scale the width to match the height.
-
-`height` is the integral Number of pixels high the resultant image should be, between 1 and 16383. Use `null` or `undefined` to auto-scale the height to match the width.
-
-#### crop([option])
-
-Crop the resized image to the exact size specified, the default behaviour.
-
-`option`, if present, is an attribute of:
-
-* `sharp.gravity` e.g. `sharp.gravity.north`, to crop to an edge or corner, or
-* `sharp.strategy` e.g. `sharp.strategy.entropy`, to crop dynamically.
-
-Possible attributes of `sharp.gravity` are
-`north`, `northeast`, `east`, `southeast`, `south`,
-`southwest`, `west`, `northwest`, `center` and `centre`.
-
-Possible attributes of the experimental `sharp.strategy` are:
-
-* `entropy`: resize so one dimension is at its target size
-then repeatedly remove pixels from the edge with the lowest
-[Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29)
-until it too reaches the target size.
-
-The default crop option is a `center`/`centre` gravity.
-
-```javascript
-var transformer = sharp()
-  .resize(200, 200)
-  .crop(sharp.strategy.entropy)
-  .on('error', function(err) {
-    console.log(err);
-  });
-// Read image data from readableStream
-// Write 200px square auto-cropped image data to writableStream
-readableStream.pipe(transformer).pipe(writableStream);
-```
-
-#### embed()
-
-Preserving aspect ratio, resize the image to the
-maximum `width` or `height` specified
-then embed on a background of the exact
-`width` and `height` specified.
-
-If the background contains an alpha value
-then WebP and PNG format output images will
-contain an alpha channel,
-even when the input image does not.
-
-```javascript
-sharp('input.gif')
-  .resize(200, 300)
-  .background({r: 0, g: 0, b: 0, a: 0})
-  .embed()
-  .toFormat(sharp.format.webp)
-  .toBuffer(function(err, outputBuffer) {
-    if (err) {
-      throw err;
-    }
-    // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
-    // containing a scaled version, embedded on a transparent canvas, of input.gif
-  });
-```
-
-#### max()
-
-Preserving aspect ratio,
-resize the image to be as large as possible
-while ensuring its dimensions are less than or equal to
-the `width` and `height` specified.
-
-Both `width` and `height` must be provided via
-`resize` otherwise the behaviour will default to `crop`.
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 200)
-  .max()
-  .toFormat('jpeg')
-  .toBuffer()
-  .then(function(outputBuffer) {
-    // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
-    // than 200 pixels regardless of the inputBuffer image dimensions
-  });
-```
-
-#### min()
-
-Preserving aspect ratio,
-resize the image to be as small as possible
-while ensuring its dimensions are greater than or equal to
-the `width` and `height` specified.
-
-Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
-
-#### withoutEnlargement()
-
-Do not enlarge the output image
-if the input image width *or* height
-are already less than the required dimensions.
-
-This is equivalent to GraphicsMagick's `>` geometry option:
-"*change the dimensions of the image only
-if its width or height exceeds the geometry specification*".
-
-#### ignoreAspectRatio()
-
-Ignoring the aspect ratio of the input, stretch the image to the exact `width` and/or `height` provided via `resize`.
-
-#### interpolateWith(interpolator)
-
-Use the given interpolator for image resizing, where `interpolator` is an attribute of the `sharp.interpolator` Object e.g. `sharp.interpolator.bicubic`.
-
-The default interpolator is `bicubic`, providing a general-purpose interpolator that is both fast and of good quality.
-
-Possible interpolators, in order of performance, are:
-
-* `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation), suitable for image enlargement only.
-* `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
-* `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
-* `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
-* `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
-* `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
-
-[Compare the output of these interpolators](https://github.com/lovell/sharp/tree/master/test/interpolators)
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 300)
-  .interpolateWith(sharp.interpolator.nohalo)
-  .background('white')
-  .embed()
-  .toFile('output.tiff')
-  .then(function() {
-    // output.tiff is a 200 pixels wide and 300 pixels high image
-    // containing a nohalo scaled version, embedded on a white canvas,
-    // of the image data in inputBuffer
-  });
-```
-
-### Operations
-
-#### extract({ left: left, top: top, width: width, height: height })
-
-Extract a region of the image. Can be used with or without a `resize` operation.
-
-`left` and `top` are the offset, in pixels, from the top-left corner.
-
-`width` and `height` are the dimensions of the extracted image.
-
-Use `extract` before `resize` for pre-resize extraction. Use `extract` after `resize` for post-resize extraction. Use `extract` before and after for both.
-
-```javascript
-sharp(input)
-  .extract({ left: left, top: top, width: width, height: height })
-  .toFile(output, function(err) {
-    // Extract a region of the input image, saving in the same format.
-  });
-```
-
-```javascript
-sharp(input)
-  .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
-  .resize(width, height)
-  .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
-  .toFile(output, function(err) {
-    // Extract a region, resize, then extract from the resized image
-  });
-```
-
-#### background(rgba)
-
-Set the background for the `embed`, `flatten` and `extend` operations.
-
-`rgba` is parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
-
-The alpha value is a float between `0` (transparent) and `1` (opaque).
-
-The default background is `{r: 0, g: 0, b: 0, a: 1}`, black without transparency.
-
-#### flatten()
-
-Merge alpha transparency channel, if any, with `background`.
-
-#### extend(extension)
-
-Extends/pads the edges of the image with `background`, where `extension` is one of:
-
-* a Number representing the pixel count to add to each edge, or
-* an Object containing `top`, `left`, `bottom` and `right` attributes, each a Number of pixels to add to that edge.
-
-This operation will always occur after resizing and extraction, if any.
-
-```javascript
-// Resize to 140 pixels wide, then add 10 transparent pixels
-// to the top, left and right edges and 20 to the bottom edge
-sharp(input)
-  .resize(140)
-  .background({r: 0, g: 0, b: 0, a: 0})
-  .extend({top: 10, bottom: 20, left: 10, right: 10})
-  ...
-```
-
-#### negate()
-
-Produces the "negative" of the image.  White => Black, Black => White, Blue => Yellow, etc.
-
-#### rotate([angle])
-
-Rotate the output image by either an explicit angle or auto-orient based on the EXIF `Orientation` tag.
-
-`angle`, if present, is a Number with a value of `0`, `90`, `180` or `270`.
-
-Use this method without `angle` to determine the angle from EXIF data. Mirroring is supported and may infer the use of a `flip` operation.
-
-Method order is important when both rotating and extracting regions, for example `rotate(x).extract(y)` will produce a different result to `extract(y).rotate(x)`.
-
-The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.
-
-```javascript
-var pipeline = sharp()
-  .rotate()
-  .resize(null, 200)
-  .progressive()
-  .toBuffer(function(err, outputBuffer, info) {
-    if (err) {
-      throw err;
-    }
-    // outputBuffer contains 200px high progressive JPEG image data,
-    // auto-rotated using EXIF Orientation tag
-    // info.width and info.height contain the dimensions of the resized image
-  });
-readableStream.pipe(pipeline);
-```
-
-#### flip()
-
-Flip the image about the vertical Y axis. This always occurs after rotation, if any.
-The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.
-
-#### flop()
-
-Flop the image about the horizontal X axis. This always occurs after rotation, if any.
-The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.
-
-#### blur([sigma])
-
-When used without parameters, performs a fast, mild blur of the output image. This typically reduces performance by 10%.
-
-When a `sigma` is provided, performs a slower, more accurate Gaussian blur. This typically reduces performance by 25%.
-
-* `sigma`, if present, is a Number between 0.3 and 1000 representing the approximate blur radius in pixels.
-
-#### sharpen([radius], [flat], [jagged])
-
-When used without parameters, performs a fast, mild sharpen of the output image. This typically reduces performance by 10%.
-
-When a `radius` is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space. Separate control over the level of sharpening in "flat" and "jagged" areas is available. This typically reduces performance by 50%.
-
-* `radius`, if present, is an integral Number representing the sharpen mask radius in pixels.
-* `flat`, if present, is a Number representing the level of sharpening to apply to "flat" areas, defaulting to a value of 1.0.
-* `jagged`, if present, is a Number representing the level of sharpening to apply to "jagged" areas, defaulting to a value of 2.0.
-
-#### threshold([threshold])
-
-Converts all pixels in the image to greyscale white or black.  Any pixel greather-than-or-equal-to the threshold (0..255) will be white.  All others will be black.
-
-* `threshold`, if present, is a Number, representing the level above which pixels will be forced to white.
-
-#### gamma([gamma])
-
-Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of `1/gamma` then increasing the encoding (brighten) post-resize at a factor of `gamma`.
-
-`gamma`, if present, is a Number between 1 and 3. The default value is `2.2`, a suitable approximation for sRGB images.
-
-This can improve the perceived brightness of a resized image in non-linear colour spaces.
-
-JPEG input images will not take advantage of the shrink-on-load performance optimisation when applying a gamma correction.
-
-#### grayscale() / greyscale()
-
-Convert to 8-bit greyscale; 256 shades of grey.
-
-This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
-
-The output image will still be web-friendly sRGB and contain three (identical) channels.
-
-#### normalize() / normalise()
-
-Enhance output image contrast by stretching its luminance to cover the full dynamic range. This typically reduces performance by 30%.
-
-#### overlayWith(image, [options])
-
-Overlay (composite) a image containing an alpha channel over the processed (resized, extracted etc.) image.
-
-`image` is one of the following, and must be the same size or smaller than the processed image:
-
-* Buffer containing PNG, WebP, GIF or SVG image data, or
-* String containing the path to an image file, with most major transparency formats supported.
-
-`options`, if present, is an Object with the following optional attributes:
-
-* `gravity` is a String or an attribute of the `sharp.gravity` Object e.g. `sharp.gravity.north` at which to place the overlay, defaulting to `center`/`centre`.
-
-```javascript
-sharp('input.png')
-  .rotate(180)
-  .resize(300)
-  .flatten()
-  .background('#ff6600')
-  .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
-  .sharpen()
-  .withMetadata()
-  .quality(90)
-  .webp()
-  .toBuffer()
-  .then(function(outputBuffer) {
-    // outputBuffer contains upside down, 300px wide, alpha channel flattened
-    // onto orange background, composited with overlay.png with SE gravity,
-    // sharpened, with metadata, 90% quality WebP image data. Phew!
-  });
-```
-
-### Output
-
-#### toFile(path, [callback])
-
-`path` is a String containing the path to write the image data to.
-
-If an explicit output format is not selected, it will be inferred from the extension, with JPEG, PNG, WebP, TIFF and DZI supported.
-
-`callback`, if present, is called with two arguments `(err, info)` where:
-
-* `err` contains an error message, if any.
-* `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
-
-A Promises/A+ promise is returned when `callback` is not provided.
-
-#### toBuffer([callback])
-
-Write image data to a Buffer, the format of which will match the input image by default. JPEG, PNG and WebP are supported.
-
-`callback`, if present, gets three arguments `(err, buffer, info)` where:
-
-* `err` is an error message, if any.
-* `buffer` is the output image data.
-* `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
-
-A Promises/A+ promise is returned when `callback` is not provided.
-
-#### jpeg()
-
-Use JPEG format for the output image.
-
-#### png()
-
-Use PNG format for the output image.
-
-#### webp()
-
-Use WebP format for the output image.
-
-#### raw()
-
-Provide raw, uncompressed uint8 (unsigned char) image data for Buffer and Stream based output.
-
-The number of channels depends on the input image and selected options.
-
-* 1 channel for images converted to `greyscale()`, with each byte representing one pixel.
-* 3 channels for colour images without alpha transparency, with bytes ordered \[red, green, blue, red, green, blue, etc.\]).
-* 4 channels for colour images with alpha transparency, with bytes ordered \[red, green, blue, alpha, red, green, blue, alpha, etc.\].
-
-#### toFormat(format)
-
-Convenience method for the above output format methods, where `format` is either:
-
-* an attribute of the `sharp.format` Object e.g. `sharp.format.jpeg`, or
-* a String containing `jpeg`, `png`, `webp` or `raw`.
-
-#### quality(quality)
-
-The output quality to use for lossy JPEG, WebP and TIFF output formats. The default quality is `80`.
-
-`quality` is a Number between 1 and 100.
-
-#### progressive()
-
-Use progressive (interlace) scan for JPEG and PNG output. This typically reduces compression performance by 30% but results in an image that can be rendered sooner when decompressed.
-
-#### withMetadata([metadata])
-
-Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
-This will also convert to and add the latest web-friendly v2 sRGB ICC profile.
-
-The optional `metadata` parameter, if present, is an Object with the attributes to update.
-New attributes cannot be inserted, only existing attributes updated.
-
-* `orientation` is an integral Number between 1 and 8, used to update the value of the EXIF `Orientation` tag.
-This has no effect if the input image does not have an EXIF `Orientation` tag.
-
-The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
-
-#### tile(options)
-
-The size, overlap and directory layout to use when generating square Deep Zoom image pyramid tiles.
-
-`options` is an Object with one or more of the following attributes:
-
-* `size` is an integral Number between 1 and 8192. The default value is 256 pixels.
-* `overlap` is an integral Number between 0 and 8192. The default value is 0 pixels.
-* `layout` is a String, with value `dz`, `zoomify` or `google`. The default value is `dz`.
-
-```javascript
-sharp('input.tiff')
-  .tile({
-    size: 512
-  })
-  .toFile('output.dzi', function(err, info) {
-    // output.dzi is the Deep Zoom XML definition
-    // output_files contains 512x512 tiles grouped by zoom level
-  });
-```
-
-#### withoutChromaSubsampling()
-
-Disable the use of [chroma subsampling](http://en.wikipedia.org/wiki/Chroma_subsampling) with JPEG output (4:4:4).
-
-This can improve colour representation at higher quality settings (90+),
-but usually increases output file size and typically reduces performance by 25%.
-
-The default behaviour is to use chroma subsampling (4:2:0).
-
-#### compressionLevel(compressionLevel)
-
-An advanced setting for the _zlib_ compression level of the lossless PNG output format. The default level is `6`.
-
-`compressionLevel` is a Number between 0 and 9.
-
-#### withoutAdaptiveFiltering()
-
-An advanced setting to disable adaptive row filtering for the lossless PNG output format.
-
-#### trellisQuantisation() / trellisQuantization()
-
-_Requires libvips to have been compiled with mozjpeg support_
-
-An advanced setting to apply the use of
-[trellis quantisation](http://en.wikipedia.org/wiki/Trellis_quantization) with JPEG output.
-Reduces file size and slightly increases relative quality at the cost of increased compression time.
-
-#### overshootDeringing()
-
-_Requires libvips to have been compiled with mozjpeg support_
-
-An advanced setting to reduce the effects of
-[ringing](http://en.wikipedia.org/wiki/Ringing_%28signal%29) in JPEG output,
-in particular where black text appears on a white background (or vice versa).
-
-#### optimiseScans() / optimizeScans()
-
-_Requires libvips to have been compiled with mozjpeg support_
-
-An advanced setting for progressive (interlace) JPEG output.
-Calculates which spectrum of DCT coefficients uses the fewest bits.
-Usually reduces file size at the cost of increased compression time.
-
-### Attributes
-
-#### format
-
-An Object containing nested boolean values
-representing the available input and output formats/methods,
-for example:
-
-```javascript
-> console.dir(sharp.format);
-
-{ jpeg: { id: 'jpeg',
-    input: { file: true, buffer: true, stream: true },
-    output: { file: true, buffer: true, stream: true } },
-  png: { id: 'png',
-    input: { file: true, buffer: true, stream: true },
-    output: { file: true, buffer: true, stream: true } },
-  webp: { id: 'webp',
-    input: { file: true, buffer: true, stream: true },
-    output: { file: true, buffer: true, stream: true } },
-  tiff: { id: 'tiff',
-    input: { file: true, buffer: true, stream: true },
-    output: { file: true, buffer: false, stream: false } },
-  magick: { id: 'magick',
-    input: { file: true, buffer: true, stream: true },
-    output: { file: false, buffer: false, stream: false } },
-  raw: { id: 'raw',
-    input: { file: false, buffer: false, stream: false },
-    output: { file: false, buffer: true, stream: true } } }
-```
-
-#### queue
-
-An EventEmitter that emits a `change` event when a task is either:
-
-* queued, waiting for _libuv_ to provide a worker thread
-* complete
-
-```javascript
-sharp.queue.on('change', function(queueLength) {
-  console.log('Queue contains ' + queueLength + ' task(s)');
-});
-```
-
-#### versions
-
-An Object containing the version numbers of libvips and, on Linux, its dependencies.
-
-```javascript
-> console.log(sharp.versions);
-
-{ zlib: '1.2.8',
-  ffi: '3.2.1',
-  glib: '2.46.2',
-  xml: '2.9.2',
-  gsf: '1.14.34',
-  exif: '0.6.21',
-  jpeg: '1.4.2',
-  png: '1.6.19',
-  lcms: '2.7',
-  webp: '0.4.4',
-  tiff: '4.0.6',
-  magick: '6.9.2-6',
-  orc: '0.4.24',
-  vips: '8.1.1' }
-```
-
-### Utilities
-
-#### sharp.cache([options])
-
-If `options` is provided, sets the limits of _libvips'_ operation cache.
-
-* `options.memory` is the maximum memory in MB to use for this cache, with a default value of 50
-* `options.files` is the maximum number of files to hold open, with a default value of 20
-* `options.items` is the maximum number of operations to cache, with a default value of 100
-
-`options` can also be a boolean, where `true` enables the default cache settings and `false` disables all caching.
-
-This method always returns cache statistics, useful for determining how much working memory is required for a particular task.
-
-```javascript
-var stats = sharp.cache();
-```
-
-```javascript
-sharp.cache( { items: 200 } );
-sharp.cache( { files: 0 } );
-sharp.cache(false);
-```
-
-#### sharp.concurrency([threads])
-
-`threads`, if provided, is the Number of threads _libvips'_ should create for processing each image. The default value is the number of CPU cores. A value of `0` will reset to this default.
-
-This method always returns the current concurrency.
-
-```javascript
-var threads = sharp.concurrency(); // 4
-sharp.concurrency(2); // 2
-sharp.concurrency(0); // 4
-```
-
-The maximum number of images that can be processed in parallel is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
-
-#### sharp.counters()
-
-Provides access to internal task counters.
-
-* `queue` is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool.
-* `process` is the number of resize tasks currently being processed.
-
-```javascript
-var counters = sharp.counters(); // { queue: 2, process: 4 }
-```
-
-#### sharp.simd([enable])
-
-_Requires libvips to have been compiled with liborc support_
-
-Improves the performance of `resize`, `blur` and `sharpen` operations
-by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
-
-* `enable`, if present, is a boolean where `true` enables and `false` disables the use of SIMD.
-
-This method always returns the current state.
-
-This feature is currently disabled by default
-but future versions may enable it by default.
-
-When enabled, versions of liborc prior to 0.4.24
-and versions of libvips prior to 8.2.0
-have been known to crash under heavy load.
-
-```javascript
-var simd = sharp.simd();
-// simd is `true` if SIMD is currently enabled
-```
-
-```javascript
-var simd = sharp.simd(true);
-// attempts to enable the use of SIMD, returning true if available
-```

docs/changelog.md

@@ -1,9 +1,272 @@
 # Changelog
 
+### v0.17 - "*quill*"
+
+Requires libvips v8.4.2.
+
+#### v0.17.3 - 1<sup>st</sup> April 2017
+
+* Allow toBuffer to optionally resolve a Promise with both info and data.
+  [#143](https://github.com/lovell/sharp/issues/143)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Create blank image of given width, height, channels and background.
+  [#470](https://github.com/lovell/sharp/issues/470)
+  [@pjarts](https://github.com/pjarts)
+
+* Add support for the "nearest" kernel for image reductions.
+  [#732](https://github.com/lovell/sharp/pull/732)
+  [@alice0meta](https://github.com/alice0meta)
+
+* Add support for TIFF compression and predictor options.
+  [#738](https://github.com/lovell/sharp/pull/738)
+  [@kristojorg](https://github.com/kristojorg)
+
+#### v0.17.2 - 11<sup>th</sup> February 2017
+
+* Ensure Readable side of Stream can start flowing after Writable side has finished.
+  [#671](https://github.com/lovell/sharp/issues/671)
+  [@danhaller](https://github.com/danhaller)
+
+* Expose WebP alpha quality, lossless and near-lossless output options.
+  [#685](https://github.com/lovell/sharp/pull/685)
+  [@rnanwani](https://github.com/rnanwani)
+
+#### v0.17.1 - 15<sup>th</sup> January 2017
+
+* Improve error messages for invalid parameters.
+  [@spikeon](https://github.com/spikeon)
+  [#644](https://github.com/lovell/sharp/pull/644)
+
+* Simplify expression for finding vips-cpp libdir.
+  [#656](https://github.com/lovell/sharp/pull/656)
+
+* Allow HTTPS-over-HTTP proxy when downloading pre-compiled dependencies.
+  [@wangzhiwei1888](https://github.com/wangzhiwei1888)
+  [#679](https://github.com/lovell/sharp/issues/679)
+
+#### v0.17.0 - 11<sup>th</sup> December 2016
+
+* Drop support for versions of Node prior to v4.
+
+* Deprecate the following output format "option" functions:
+    quality, progressive, compressionLevel, withoutAdaptiveFiltering,
+    withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
+    overshootDeringing, optimiseScans and optimizeScans.
+  Access to these is now via output format functions, for example `quality(n)`
+    is now `jpeg({quality: n})` and/or `webp({quality: n})`.
+
+* Autoconvert GIF and SVG input to PNG output if no other format is specified.
+
+* Expose libvips' "centre" resize option to mimic \*magick's +0.5px convention.
+  [#568](https://github.com/lovell/sharp/issues/568)
+
+* Ensure support for embedded base64 PNG and JPEG images within an SVG.
+  [#601](https://github.com/lovell/sharp/issues/601)
+  [@dynamite-ready](https://github.com/dynamite-ready)
+
+* Ensure premultiply operation occurs before box filter shrink.
+  [#605](https://github.com/lovell/sharp/issues/605)
+  [@CmdrShepardsPie](https://github.com/CmdrShepardsPie)
+  [@teroparvinen](https://github.com/teroparvinen)
+
+* Add support for PNG and WebP tile-based output formats (in addition to JPEG).
+  [#622](https://github.com/lovell/sharp/pull/622)
+  [@ppaskaris](https://github.com/ppaskaris)
+
+* Allow use of extend with greyscale input.
+  [#623](https://github.com/lovell/sharp/pull/623)
+  [@ppaskaris](https://github.com/ppaskaris)
+
+* Allow non-RGB input to embed/extend onto background with an alpha channel.
+  [#646](https://github.com/lovell/sharp/issues/646)
+  [@DaGaMs](https://github.com/DaGaMs)
+
+### v0.16 - "*pencil*"
+
+Requires libvips v8.3.3
+
+#### v0.16.2 - 22<sup>nd</sup> October 2016
+
+* Restrict readelf usage to Linux only when detecting global libvips version.
+  [#602](https://github.com/lovell/sharp/issues/602)
+  [@caoko](https://github.com/caoko)
+
+#### v0.16.1 - 13<sup>th</sup> October 2016
+
+* C++11 ABI version is now auto-detected, remove sharp-cxx11 installation flag.
+
+* Add experimental 'attention' crop strategy.
+  [#295](https://github.com/lovell/sharp/issues/295)
+
+* Include .node extension for Meteor's require() implementation.
+  [#537](https://github.com/lovell/sharp/issues/537)
+  [@isjackwild](https://github.com/isjackwild)
+
+* Ensure convolution kernel scale is clamped to a minimum value of 1.
+  [#561](https://github.com/lovell/sharp/issues/561)
+  [@abagshaw](https://github.com/abagshaw)
+
+* Correct calculation of y-axis placement when overlaying image at a fixed point.
+  [#566](https://github.com/lovell/sharp/issues/566)
+  [@Nateowami](https://github.com/Nateowami)
+
+#### v0.16.0 - 18<sup>th</sup> August 2016
+
+* Add pre-compiled libvips for OS X, ARMv7 and ARMv8.
+  [#312](https://github.com/lovell/sharp/issues/312)
+
+* Ensure boolean, bandbool, extractChannel ops occur before sRGB conversion.
+  [#504](https://github.com/lovell/sharp/pull/504)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Recalculate factors after WebP shrink-on-load to avoid round-to-zero errors.
+  [#508](https://github.com/lovell/sharp/issues/508)
+  [@asilvas](https://github.com/asilvas)
+
+* Prevent boolean errors during extract operation.
+  [#511](https://github.com/lovell/sharp/pull/511)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add joinChannel and toColourspace/toColorspace operations.
+  [#513](https://github.com/lovell/sharp/pull/513)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add support for raw pixel data with boolean and withOverlay operations.
+  [#516](https://github.com/lovell/sharp/pull/516)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Prevent bandbool creating a single channel sRGB image.
+  [#519](https://github.com/lovell/sharp/pull/519)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Ensure ICC profiles are removed from PNG output unless withMetadata used.
+  [#521](https://github.com/lovell/sharp/issues/521)
+  [@ChrisPinewood](https://github.com/ChrisPinewood)
+
+* Add alpha channels, if missing, to overlayWith images.
+  [#540](https://github.com/lovell/sharp/pull/540)
+  [@cmtt](https://github.com/cmtt)
+
+* Remove deprecated interpolateWith method - use resize(w, h, { interpolator: ... })
+  [#310](https://github.com/lovell/sharp/issues/310)
+
+### v0.15 - "*outfit*"
+
+Requires libvips v8.3.1
+
+#### v0.15.1 - 12<sup>th</sup> July 2016
+
+* Concat Stream-based input in single operation for ~+3% perf and less GC.
+  [#429](https://github.com/lovell/sharp/issues/429)
+  [@papandreou](https://github.com/papandreou)
+
+* Add alpha channel, if required, before extend operation.
+  [#439](https://github.com/lovell/sharp/pull/439)
+  [@frulo](https://github.com/frulo)
+
+* Allow overlay image to be repeated across entire image via tile option.
+  [#443](https://github.com/lovell/sharp/pull/443)
+  [@lemnisk8](https://github.com/lemnisk8)
+
+* Add cutout option to overlayWith feature, applies only the alpha channel of the overlay image.
+  [#448](https://github.com/lovell/sharp/pull/448)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Ensure scaling factors are calculated independently to prevent rounding errors.
+  [#452](https://github.com/lovell/sharp/issues/452)
+  [@puzrin](https://github.com/puzrin)
+
+* Add --sharp-cxx11 flag to compile with gcc's new C++11 ABI.
+  [#456](https://github.com/lovell/sharp/pull/456)
+  [@kapouer](https://github.com/kapouer)
+
+* Add top/left offset support to overlayWith operation.
+  [#473](https://github.com/lovell/sharp/pull/473)
+  [@rnanwani](https://github.com/rnanwani)
+
+* Add convolve operation for kernel-based convolution.
+  [#479](https://github.com/lovell/sharp/pull/479)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add greyscale option to threshold operation for colourspace conversion control.
+  [#480](https://github.com/lovell/sharp/pull/480)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Ensure ICC profiles are licenced for distribution.
+  [#486](https://github.com/lovell/sharp/issues/486)
+  [@kapouer](https://github.com/kapouer)
+
+* Allow images with an alpha channel to work with LAB-colourspace based sharpen.
+  [#490](https://github.com/lovell/sharp/issues/490)
+  [@jwagner](https://github.com/jwagner)
+
+* Add trim operation to remove "boring" edges.
+  [#492](https://github.com/lovell/sharp/pull/492)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Add bandbool feature for channel-wise boolean operations.
+  [#496](https://github.com/lovell/sharp/pull/496)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add extractChannel operation to extract a channel from an image.
+  [#497](https://github.com/lovell/sharp/pull/497)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add ability to read and write native libvips .v files.
+  [#500](https://github.com/lovell/sharp/pull/500)
+  [@mhirsch](https://github.com/mhirsch)
+
+* Add boolean feature for bitwise image operations.
+  [#501](https://github.com/lovell/sharp/pull/501)
+  [@mhirsch](https://github.com/mhirsch)
+
+#### v0.15.0 - 21<sup>st</sup> May 2016
+
+* Use libvips' new Lanczos 3 kernel as default for image reduction.
+  Deprecate interpolateWith method, now provided as a resize option.
+  [#310](https://github.com/lovell/sharp/issues/310)
+  [@jcupitt](https://github.com/jcupitt)
+
+* Take advantage of libvips v8.3 features.
+  Add support for libvips' new GIF and SVG loaders.
+  Pre-built binaries now include giflib and librsvg, exclude *magick.
+  Use shrink-on-load for WebP input.
+  Break existing sharpen API to accept sigma and improve precision.
+  [#369](https://github.com/lovell/sharp/issues/369)
+
+* Remove unnecessary (un)premultiply operations when not resizing/compositing.
+  [#413](https://github.com/lovell/sharp/issues/413)
+  [@jardakotesovec](https://github.com/jardakotesovec)
+
 ### v0.14 - "*needle*"
 
 Requires libvips v8.2.3
 
+#### v0.14.1 - 16<sup>th</sup> April 2016
+
+* Allow removal of limitation on input pixel count via limitInputPixels. Use with care.
+  [#250](https://github.com/lovell/sharp/issues/250)
+  [#316](https://github.com/lovell/sharp/pull/316)
+  [@anandthakker](https://github.com/anandthakker)
+  [@kentongray](https://github.com/kentongray)
+
+* Use final output image for metadata passed to callback.
+  [#399](https://github.com/lovell/sharp/pull/399)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Add support for writing tiled images to a zip container.
+  [#402](https://github.com/lovell/sharp/pull/402)
+  [@felixbuenemann](https://github.com/felixbuenemann)
+
+* Allow use of embed with 1 and 2 channel images.
+  [#411](https://github.com/lovell/sharp/issues/411)
+  [@janaz](https://github.com/janaz)
+
+* Improve Electron compatibility by allowing node-gyp rebuilds without npm.
+  [#412](https://github.com/lovell/sharp/issues/412)
+  [@nouh](https://github.com/nouh)
+
 #### v0.14.0 - 2<sup>nd</sup> April 2016
 
 * Add ability to extend (pad) the edges of an image.
@@ -38,6 +301,9 @@ Requires libvips v8.2.3
   [#387](https://github.com/lovell/sharp/issues/387)
   [@kleisauke](https://github.com/kleisauke)
 
+* Remove deprecated style of calling extract API. Breaks calls using positional arguments.
+  [#276](https://github.com/lovell/sharp/issues/276)
+
 ### v0.13 - "*mind*"
 
 Requires libvips v8.2.2

docs/index.md

@@ -1,30 +1,26 @@
 # sharp
 
 The typical use case for this high speed Node.js module
-is to convert large images of many formats to
+is to convert large images in common formats to
 smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.
 
-Resizing an image is typically 4x faster than using the
+Resizing an image is typically 4x-5x faster than using the
 quickest ImageMagick and GraphicsMagick settings.
 
 Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
-Bicubic interpolation with Lanczos anti-alias filtering ensures quality is not sacrificed for speed.
+Lanczos resampling ensures quality is not sacrificed for speed.
 
 As well as image resizing, operations such as
 rotation, extraction, compositing and gamma correction are available.
 
-Most Windows (x64), Linux and ARMv6+ systems do not require
+OS X, Windows (x64), Linux (x64, ARM) systems do not require
 the installation of any external runtime dependencies.
 
-Use with OS X is as simple as running `brew install homebrew/science/vips`
-to install the libvips dependency.
-
 [![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
 
 ### Formats
 
-This module supports reading JPEG, PNG, WebP, TIFF, OpenSlide,
+This module supports reading JPEG, PNG, WebP, TIFF, GIF and SVG images.
-GIF and most other libmagick-supported formats.
 
 Output images can be in JPEG, PNG and WebP formats as well as uncompressed raw pixel data.
 
@@ -89,12 +85,26 @@ the help and code contributions of the following people:
 * [Alaric Holloway](https://github.com/skedastik)
 * [Bernhard K. Weisshuhn](https://github.com/bkw)
 * [David A. Carley](https://github.com/dacarley)
+* [John Tobin](https://github.com/jtobinisaniceguy)
+* [Kenton Gray](https://github.com/kentongray)
+* [Felix Bünemann](https://github.com/felixbuenemann)
+* [Samy Al Zahrani](https://github.com/salzhrani)
+* [Chintan Thakkar](https://github.com/lemnisk8)
+* [F. Orlando Galashan](https://github.com/frulo)
+* [Kleis Auke Wolthuizen](https://github.com/kleisauke)
+* [Matt Hirsch](https://github.com/mhirsch)
+* [Rahul Nanwani](https://github.com/rnanwani)
+* [Matthias Thoemmes](https://github.com/cmtt)
+* [Patrick Paskaris](https://github.com/ppaskaris)
+* [Jérémy Lal](https://github.com/kapouer)
+* [Alice Monday](https://github.com/alice0meta)
+* [Kristo Jorgenson](https://github.com/kristojorg)
 
 Thank you!
 
 ### Licence
 
-Copyright 2013, 2014, 2015 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

docs/install.md

@@ -4,49 +4,49 @@
 npm install sharp
 ```
 
+```sh
+yarn add sharp
+```
+
 ### Prerequisites
 
-* C++11 compatible compiler such as gcc 4.6+ (Node v4+ requires gcc 4.8+), clang 3.0+ or MSVC 2013
+* Node v4+
-* [node-gyp](https://github.com/TooTallNate/node-gyp#installation)
+* C++11 compatible compiler such as gcc 4.8+, clang 3.0+ or MSVC 2013+
+* [node-gyp](https://github.com/TooTallNate/node-gyp#installation) and its dependencies (includes Python)
 
 ### Linux
 
 [![Ubuntu 14.04 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
 [![Linux Build Status](https://circleci.com/gh/lovell/sharp.svg?style=svg&circle-token=6cb6d1d287a51af83722b19ed8885377fbc85e5c)](https://circleci.com/gh/lovell/sharp)
 
-libvips and its dependencies are fetched and stored within `node_modules/sharp/lib` during `npm install`.
+libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 6MB.
+This involves an automated HTTPS download of approximately 6.5MB.
 
 Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work", e.g.:
 
 * Debian 7, 8
-* Ubuntu 12.04, 14.04, 14.10, 15.04, 15.10
+* Ubuntu 12.04, 14.04, 16.04
 * Centos 7
-* Fedora 21, 22, 23
+* Fedora
 * openSUSE 13.2
-* Archlinux 2015.06.01
+* Archlinux
 * Raspbian Jessie
-* Amazon Linux 2015.03, 2015.09
+* Amazon Linux 2016.03, 2016.09
 
-To use your own version of libvips instead of the provided binaries, make sure it is
+To use a globally-installed version of libvips instead of the provided binaries,
-at least the version listed under `config.libvips` in the `package.json` file that it
+make sure it is at least the version listed under `config.libvips` in the `package.json` file
-can be located using `pkg-config`. If you are using non-stadard paths (anything other
+and that it can be located using `pkg-config --modversion vips-cpp`.
-than `/usr` or `/usr/local`), you might need to set `PKG_CONFIG_PATH` during `npm install`
+
+If you are using non-stadard paths (anything other than `/usr` or `/usr/local`),
+you might need to set `PKG_CONFIG_PATH` during `npm install`
 and `LD_LIBRARY_PATH` at runtime.
 
-You can print the detected vips version using: `pkg-config --modversion vips-cpp`
-
 This allows the use of newer versions of libvips with older versions of sharp.
 
-For older Linux-based operating systems and 32-bit Intel CPUs,
+For 32-bit Intel CPUs and older Linux-based operating systems such as Centos 6,
-a system-wide installation of the most suitable version of
+it is recommended to install a system-wide installation of libvips from source:
-libvips and its dependencies can be achieved by running
-the following command as a user with `sudo` access
-(requires `curl` and `pkg-config`):
 
-```sh
+https://github.com/jcupitt/libvips#building-libvips-from-a-source-tarball
-curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | sudo bash -
-```
 
 For Linux-based operating systems such as Alpine that use musl libc,
 the smaller stack size means libvips' cache should be disabled
@@ -54,40 +54,23 @@ via `sharp.cache(false)` to avoid a stack overflow.
 
 ### Mac OS
 
-[![OS X 10.9.5 Build Status](https://travis-ci.org/lovell/sharp-osx-ci.png?branch=master)](https://travis-ci.org/lovell/sharp-osx-ci)
+[![OS X 10.9.5 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
 
-libvips must be installed before `npm install` is run.
+libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This can be achieved via homebrew:
+This involves an automated HTTPS download of approximately 6.3MB.
 
-```sh
+To use your own version of libvips instead of the provided binaries, make sure it is
-brew install homebrew/science/vips
+at least the version listed under `config.libvips` in the `package.json` file and
-```
+that it can be located using `pkg-config --modversion vips-cpp`.
 
-For GIF input and WebP output suppport use:
+### Windows x64
-
-```sh
-brew install homebrew/science/vips --with-imagemagick --with-webp
-```
-
-A missing or incorrectly configured _Xcode Command Line Tools_ installation
-[can lead](https://github.com/lovell/sharp/issues/80) to a
-`library not found for -ljpeg` error.
-If so, please try: `xcode-select --install`.
-
-The _gettext_ dependency of _libvips_
-[can lead](https://github.com/lovell/sharp/issues/9)
-to a `library not found for -lintl` error.
-If so, please try `brew link gettext --force`.
-
-### Windows
 
 [![Windows x64 Build Status](https://ci.appveyor.com/api/projects/status/pgtul704nkhhg6sg)](https://ci.appveyor.com/project/lovell/sharp)
 
-libvips and its dependencies are fetched and stored within `node_modules\sharp` during `npm install`.
+libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
 This involves an automated HTTPS download of approximately 9MB.
 
 Only 64-bit (x64) `node.exe` is supported.
-The WebP format is currently unavailable on Windows.
 
 ### FreeBSD
 
@@ -100,9 +83,11 @@ cd /usr/ports/graphics/vips/ && make install clean
 
 ### Heroku
 
-[Alessandro Tagliapietra](https://github.com/alex88) maintains an
+libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
-[Heroku buildpack for libvips](https://github.com/alex88/heroku-buildpack-vips)
+This involves an automated HTTPS download of approximately 6.5MB.
-and its dependencies.
+
+Set [NODE_MODULES_CACHE](https://devcenter.heroku.com/articles/nodejs-support#cache-behavior)
+to `false` when using the `yarn` package manager.
 
 ### Docker
 
@@ -128,12 +113,11 @@ do this on a system similar to the [Lambda Execution Environment](http://docs.aw
 small t2.micro instance using the AMI ID listed in the previous link, ssh into it as ec2-user
 and follow the instructions below.
 
-Install depencies:
+Install dependencies:
 
 ```sh
-sudo yum-config-manager --enable epel
+curl -s https://rpm.nodesource.com/setup_4.x | sudo bash -
-sudo yum install -y nodejs gcc-c++
+sudo yum install -y gcc-c++ nodejs
-curl -s https://www.npmjs.com/install.sh | sudo sh
 ```
 
 Copy your code and package.json to the instance using `scp` and create a deployment package:
@@ -144,7 +128,7 @@ npm install
 zip -ur9 ../sharp-lambda-example.zip index.js node_modules
 ```
 
-You can now download your deployment ZIP using `scp` and upload it to Lambda.
+You can now download your deployment ZIP using `scp` and upload it to Lambda. Be sure to set your Lambda runtime to Node.js 4.3.
 
 **Performance Tip:** To get the best performance on Lambda choose the largest memory available because this also gives you the most cpu time (a 1536 MB function is 12x faster than a 128 MB function).
 
@@ -152,3 +136,86 @@ You can now download your deployment ZIP using `scp` and upload it to Lambda.
 
 * [gulp-responsive](https://www.npmjs.com/package/gulp-responsive)
 * [grunt-sharp](https://www.npmjs.com/package/grunt-sharp)
+
+### CLI tools
+
+* [sharp-cli](https://www.npmjs.com/package/sharp-cli)
+
+### Security
+
+Many users of this module process untrusted, user-supplied images,
+but there are aspects of security to consider when doing so.
+
+It is possible to compile libvips with support for various third-party image loaders.
+Each of these libraries has undergone differing levels of security testing.
+
+Whilst tools such as [American Fuzzy Lop](http://lcamtuf.coredump.cx/afl/)
+and [Valgrind](http://valgrind.org/) have been used to test
+the most popular web-based formats, as well as libvips itself,
+you are advised to perform your own testing and sandboxing.
+
+ImageMagick in particular has a relatively large attack surface,
+which can be partially mitigated with a
+[policy.xml](http://www.imagemagick.org/script/resources.php)
+configuration file to prevent the use of coders known to be vulnerable.
+
+```xml
+<policymap>
+  <policy domain="coder" rights="none" pattern="EPHEMERAL" />
+  <policy domain="coder" rights="none" pattern="URL" />
+  <policy domain="coder" rights="none" pattern="HTTPS" />
+  <policy domain="coder" rights="none" pattern="MVG" />
+  <policy domain="coder" rights="none" pattern="MSL" />
+  <policy domain="coder" rights="none" pattern="TEXT" />
+  <policy domain="coder" rights="none" pattern="SHOW" />
+  <policy domain="coder" rights="none" pattern="WIN" />
+  <policy domain="coder" rights="none" pattern="PLT" />
+</policymap>
+```
+
+Set the `MAGICK_CONFIGURE_PATH` environment variable
+to the directory containing the `policy.xml` file.
+
+### Licences
+
+If a global installation of libvips that meets the
+minimum version requirement cannot be found,
+this module will download a pre-compiled bundle of libvips
+and its dependencies on Linux and Windows machines.
+
+Should you need to manually download and inspect these files,
+you can do so via https://dl.bintray.com/lovell/sharp/
+
+This module is licensed under the terms of the
+[Apache 2.0 Licence](https://github.com/lovell/sharp/blob/master/LICENSE).
+
+The libraries downloaded and used by this module
+are done so under the terms of the following licences,
+all of which are compatible with the Apache 2.0 Licence.
+
+Use of libraries under the terms of the LGPLv3 is via the
+"any later version" clause of the LGPLv2 or LGPLv2.1.
+
+| Library       | Used under the terms of                                                                                  |
+|---------------|----------------------------------------------------------------------------------------------------------|
+| cairo         | Mozilla Public License 2.0                                                                               |
+| fontconfig    | [fontconfig Licence](https://cgit.freedesktop.org/fontconfig/tree/COPYING) (BSD-like)                    |
+| freetype      | [freetype Licence](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/FTL.TXT) (BSD-like) |
+| giflib        | MIT Licence                                                                                              |
+| glib          | LGPLv3                                                                                                   |
+| harfbuzz      | MIT Licence                                                                                              |
+| lcms          | MIT Licence                                                                                              |
+| libcroco      | LGPLv3                                                                                                   |
+| libexif       | LGPLv3                                                                                                   |
+| libffi        | MIT Licence                                                                                              |
+| libgsf        | LGPLv3                                                                                                   |
+| libjpeg-turbo | [zlib License, IJG License](https://github.com/libjpeg-turbo/libjpeg-turbo/blob/master/LICENSE.md)       |
+| libpng        | [libpng License](http://www.libpng.org/pub/png/src/libpng-LICENSE.txt)                                   |
+| librsvg       | LGPLv3                                                                                                   |
+| libtiff       | [libtiff License](http://www.libtiff.org/misc.html) (BSD-like)                                           |
+| libvips       | LGPLv3                                                                                                   |
+| libwebp       | New BSD License                                                                                          |
+| libxml2       | MIT Licence                                                                                              |
+| pango         | LGPLv3                                                                                                   |
+| pixman        | MIT Licence                                                                                              |
+| zlib          | [zlib Licence](https://github.com/madler/zlib/blob/master/zlib.h)                                        |

docs/performance.md

@@ -2,42 +2,45 @@
 
 ### Test environment
 
-* AWS EC2 [c4.xlarge](http://aws.amazon.com/ec2/instance-types/#c4) (4x E5-2666 v3 @2.90GHz)
+* AWS EC2 eu-central-1 [c4.xlarge](http://aws.amazon.com/ec2/instance-types/#c4) (4x E5-2666 v3 @ 2.90GHz)
-* Amazon Linux 2015.09.1
+* Ubuntu 16.04.1 LTS (HVM, SSD, 20161115, ami-82cf0aed)
-* Node.js v5.5.0
+* Node.js v6.9.1
 
 ### The contenders
 
-* [jimp](https://www.npmjs.com/package/jimp) v0.2.20 - Image processing in pure JavaScript. Bilinear interpolation only.
+* [jimp](https://www.npmjs.com/package/jimp) v0.2.27 - Image processing in pure JavaScript. Bilinear interpolation only.
-* [lwip](https://www.npmjs.com/package/lwip) v0.0.8 - Wrapper around CImg, compiles dependencies from source.
+* [lwip](https://www.npmjs.com/package/lwip) v0.0.9 - Wrapper around CImg. Compiles outdated, insecure dependencies from source.
-* [imagemagick-native](https://www.npmjs.com/package/imagemagick-native) @47c7329 - Wrapper around libmagick++, supports Buffers only.
+* [mapnik](https://www.npmjs.org/package/mapnik) v3.5.14 - Whilst primarily a map renderer, Mapnik contains bitmap image utilities.
+* [imagemagick-native](https://www.npmjs.com/package/imagemagick-native) v1.9.3 - Wrapper around libmagick++, supports Buffers only.
 * [imagemagick](https://www.npmjs.com/package/imagemagick) v0.1.3 - Supports filesystem only and "*has been unmaintained for a long time*".
-* [gm](https://www.npmjs.com/package/gm) v1.21.0 - Fully featured wrapper around GraphicsMagick's `gm` command line utility.
+* [gm](https://www.npmjs.com/package/gm) v1.23.0 - Fully featured wrapper around GraphicsMagick's `gm` command line utility.
-* sharp v0.13.0 / libvips v8.2.2 - Caching within libvips disabled to ensure a fair comparison.
+* sharp v0.17.0 / libvips v8.4.2 - Caching within libvips disabled to ensure a fair comparison.
 
 ### The task
 
-Decompress a 2725x2225 JPEG image, resize to 720x480 using bicubic interpolation (where available), then compress to JPEG.
+Decompress a 2725x2225 JPEG image,
+resize to 720x588 using Lanczos 3 resampling (where available),
+then compress to JPEG at a "quality" setting of 80.
 
 ### Results
 
 | Module             | Input  | Output | Ops/sec | Speed-up |
 | :----------------- | :----- | :----- | ------: | -------: |
-| jimp (bilinear)    | file   | file   |    1.04 |      1.0 |
+| jimp (bilinear)    | buffer | buffer |    1.06 |      1.0 |
-| jimp (bilinear)    | buffer | buffer |    1.07 |      1.0 |
+| lwip               | buffer | buffer |    1.87 |      1.8 |
-| lwip               | file   | file   |    1.13 |      1.1 |
+| mapnik             | buffer | buffer |    2.91 |      2.7 |
-| lwip               | buffer | buffer |    1.13 |      1.1 |
+| imagemagick-native | buffer | buffer |    4.03 |      3.8 |
-| imagemagick-native | buffer | buffer |    1.65 |      1.6 |
+| imagemagick        | file   | file   |    7.10 |      6.7 |
-| imagemagick        | file   | file   |    5.02 |      4.8 |
+| gm                 | buffer | buffer |    7.08 |      6.7 |
-| gm                 | buffer | buffer |    5.36 |      5.2 |
+| gm                 | file   | file   |    7.10 |      6.7 |
-| gm                 | file   | file   |    5.39 |      5.2 |
+| sharp              | stream | stream |   27.61 |     26.0 |
-| sharp              | stream | stream |   22.00 |     21.2 |
+| sharp              | file   | file   |   28.41 |     26.8 |
-| sharp              | file   | file   |   22.87 |     22.0 |
+| sharp              | buffer | file   |   28.71 |     27.1 |
-| sharp              | file   | buffer |   23.03 |     22.1 |
+| sharp              | file   | buffer |   28.60 |     27.0 |
-| sharp              | buffer | file   |   23.10 |     22.2 |
+| sharp              | buffer | buffer |   29.08 |     27.4 |
-| sharp              | buffer | buffer |   23.21 |     22.3 |
 
-Greater performance can be expected with caching enabled (default) and using 8+ core machines.
+Greater libvips performance can be expected with caching enabled (default)
+and using 8+ core machines, especially those with larger L1/L2 CPU caches.
 
 The I/O limits of the relevant (de)compression library will generally determine maximum throughput.
 

lib/channel.js

@@ -0,0 +1,113 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Boolean operations for bandbool.
+ * @private
+ */
+const bool = {
+  and: 'and',
+  or: 'or',
+  eor: 'eor'
+};
+
+/**
+ * Extract a single channel from a multi-channel image.
+ *
+ * @example
+ * sharp(input)
+ *   .extractChannel('green')
+ *   .toFile('input_green.jpg', function(err, info) {
+ *     // info.channels === 1
+ *     // input_green.jpg contains the green channel of the input image
+ *    });
+ *
+ * @param {Number|String} channel - zero-indexed band number to extract, or `red`, `green` or `blue` as alternative to `0`, `1` or `2` respectively.
+ * @returns {Sharp}
+ * @throws {Error} Invalid channel
+ */
+function extractChannel (channel) {
+  if (channel === 'red') {
+    channel = 0;
+  } else if (channel === 'green') {
+    channel = 1;
+  } else if (channel === 'blue') {
+    channel = 2;
+  }
+  if (is.integer(channel) && is.inRange(channel, 0, 4)) {
+    this.options.extractChannel = channel;
+  } else {
+    throw new Error('Cannot extract invalid channel ' + channel);
+  }
+  return this;
+}
+
+/**
+ * Join one or more channels to the image.
+ * The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
+ * By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
+ * Channel ordering follows vips convention:
+ * - sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
+ * - CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
+ *
+ * Buffers may be any of the image formats supported by sharp: JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data.
+ * For raw pixel input, the `options` object should contain a `raw` attribute, which follows the format of the attribute of the same name in the `sharp()` constructor.
+ *
+ * @param {Array<String|Buffer>|String|Buffer} images - one or more images (file paths, Buffers).
+ * @param {Object} options - image options, see `sharp()` constructor.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function joinChannel (images, options) {
+  if (Array.isArray(images)) {
+    images.forEach(function (image) {
+      this.options.joinChannelIn.push(this._createInputDescriptor(image, options));
+    }, this);
+  } else {
+    this.options.joinChannelIn.push(this._createInputDescriptor(images, options));
+  }
+  return this;
+}
+
+/**
+ * Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
+ *
+ * @example
+ * sharp('3-channel-rgb-input.png')
+ *   .bandbool(sharp.bool.and)
+ *   .toFile('1-channel-output.png', function (err, info) {
+ *     // The output will be a single channel image where each pixel `P = R & G & B`.
+ *     // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
+ *     // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
+ *   });
+ *
+ * @param {String} boolOp - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function bandbool (boolOp) {
+  if (is.string(boolOp) && is.inArray(boolOp, ['and', 'or', 'eor'])) {
+    this.options.bandBoolOp = boolOp;
+  } else {
+    throw new Error('Invalid bandbool operation ' + boolOp);
+  }
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with channel-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  // Public instance functions
+  [
+    extractChannel,
+    joinChannel,
+    bandbool
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+  // Class attributes
+  Sharp.bool = bool;
+};

lib/colour.js

@@ -0,0 +1,108 @@
+'use strict';
+
+const color = require('color');
+const is = require('./is');
+
+/**
+ * Colourspaces.
+ * @private
+ */
+const colourspace = {
+  multiband: 'multiband',
+  'b-w': 'b-w',
+  bw: 'b-w',
+  cmyk: 'cmyk',
+  srgb: 'srgb'
+};
+
+/**
+ * Set the background for the `embed`, `flatten` and `extend` operations.
+ * The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
+ *
+ * Delegates to the _color_ module, which can throw an Error
+ * but is liberal in what it accepts, clipping values to sensible min/max.
+ * The alpha value is a float between `0` (transparent) and `1` (opaque).
+ *
+ * @param {String|Object} rgba - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameter
+ */
+function background (rgba) {
+  const colour = color(rgba);
+  this.options.background = [
+    colour.red(),
+    colour.green(),
+    colour.blue(),
+    Math.round(colour.alpha() * 255)
+  ];
+  return this;
+}
+
+/**
+ * Convert to 8-bit greyscale; 256 shades of grey.
+ * This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
+ * By default the output image will be web-friendly sRGB and contain three (identical) color channels.
+ * This may be overridden by other sharp operations such as `toColourspace('b-w')`,
+ * which will produce an output image containing one color channel.
+ * An alpha channel may be present, and will be unchanged by the operation.
+ * @param {Boolean} [greyscale=true]
+ * @returns {Sharp}
+ */
+function greyscale (greyscale) {
+  this.options.greyscale = is.bool(greyscale) ? greyscale : true;
+  return this;
+}
+
+/**
+ * Alternative spelling of `greyscale`.
+ * @param {Boolean} [grayscale=true]
+ * @returns {Sharp}
+ */
+function grayscale (grayscale) {
+  return this.greyscale(grayscale);
+}
+
+/**
+ * Set the output colourspace.
+ * By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
+ * @param {String} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function toColourspace (colourspace) {
+  if (!is.string(colourspace)) {
+    throw new Error('Invalid output colourspace ' + colourspace);
+  }
+  this.options.colourspace = colourspace;
+  return this;
+}
+
+/**
+ * Alternative spelling of `toColourspace`.
+ * @param {String} [colorspace] - output colorspace.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function toColorspace (colorspace) {
+  return this.toColourspace(colorspace);
+}
+
+/**
+ * Decorate the Sharp prototype with colour-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  // Public instance functions
+  [
+    background,
+    greyscale,
+    grayscale,
+    toColourspace,
+    toColorspace
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+  // Class attributes
+  Sharp.colourspace = colourspace;
+  Sharp.colorspace = colourspace;
+};

lib/composite.js

@@ -0,0 +1,98 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Overlay (composite) an image over the processed (resized, extracted etc.) image.
+ *
+ * The overlay image must be the same size or smaller than the processed image.
+ * If both `top` and `left` options are provided, they take precedence over `gravity`.
+ *
+ * @example
+ * sharp('input.png')
+ *   .rotate(180)
+ *   .resize(300)
+ *   .flatten()
+ *   .background('#ff6600')
+ *   .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
+ *   .sharpen()
+ *   .withMetadata()
+ *   .quality(90)
+ *   .webp()
+ *   .toBuffer()
+ *   .then(function(outputBuffer) {
+ *     // outputBuffer contains upside down, 300px wide, alpha channel flattened
+ *     // onto orange background, composited with overlay.png with SE gravity,
+ *     // sharpened, with metadata, 90% quality WebP image data. Phew!
+ *   });
+ *
+ * @param {(Buffer|String)} overlay - Buffer containing image data or String containing the path to an image file.
+ * @param {Object} [options]
+ * @param {String} [options.gravity='centre'] - gravity at which to place the overlay.
+ * @param {Number} [options.top] - the pixel offset from the top edge.
+ * @param {Number} [options.left] - the pixel offset from the left edge.
+ * @param {Boolean} [options.tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
+ * @param {Boolean} [options.cutout=false] - set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another.
+ * @param {Number} [options.density=72] - integral number representing the DPI for vector overlay image.
+ * @param {Object} [options.raw] - describes overlay when using raw pixel data.
+ * @param {Number} [options.raw.width]
+ * @param {Number} [options.raw.height]
+ * @param {Number} [options.raw.channels]
+ * @param {Object} [options.create] - describes a blank overlay to be created.
+ * @param {Number} [options.create.width]
+ * @param {Number} [options.create.height]
+ * @param {Number} [options.create.channels] - 3-4
+ * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function overlayWith (overlay, options) {
+  this.options.overlay = this._createInputDescriptor(overlay, options, {
+    allowStream: false
+  });
+  if (is.object(options)) {
+    if (is.defined(options.tile)) {
+      if (is.bool(options.tile)) {
+        this.options.overlayTile = options.tile;
+      } else {
+        throw new Error('Invalid overlay tile ' + options.tile);
+      }
+    }
+    if (is.defined(options.cutout)) {
+      if (is.bool(options.cutout)) {
+        this.options.overlayCutout = options.cutout;
+      } else {
+        throw new Error('Invalid overlay cutout ' + options.cutout);
+      }
+    }
+    if (is.defined(options.left) || is.defined(options.top)) {
+      if (
+        is.integer(options.left) && is.inRange(options.left, 0, this.constructor.maximum.width) &&
+        is.integer(options.top) && is.inRange(options.top, 0, this.constructor.maximum.height)
+      ) {
+        this.options.overlayXOffset = options.left;
+        this.options.overlayYOffset = options.top;
+      } else {
+        throw new Error('Invalid overlay left ' + options.left + ' and/or top ' + options.top);
+      }
+    }
+    if (is.defined(options.gravity)) {
+      if (is.integer(options.gravity) && is.inRange(options.gravity, 0, 8)) {
+        this.options.overlayGravity = options.gravity;
+      } else if (is.string(options.gravity) && is.integer(this.constructor.gravity[options.gravity])) {
+        this.options.overlayGravity = this.constructor.gravity[options.gravity];
+      } else {
+        throw new Error('Unsupported overlay gravity ' + options.gravity);
+      }
+    }
+  }
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with composite-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  Sharp.prototype.overlayWith = overlayWith;
+};

lib/constructor.js

@@ -0,0 +1,231 @@
+'use strict';
+
+const path = require('path');
+const util = require('util');
+const stream = require('stream');
+const events = require('events');
+const semver = require('semver');
+const sharp = require('../build/Release/sharp.node');
+
+// Versioning
+let versions = {
+  vips: sharp.libvipsVersion()
+};
+(function () {
+  // Does libvips meet minimum requirement?
+  const libvipsVersionMin = require('../package.json').config.libvips;
+  /* istanbul ignore if */
+  if (semver.lt(versions.vips, libvipsVersionMin)) {
+    throw new Error('Found libvips ' + versions.vips + ' but require at least ' + libvipsVersionMin);
+  }
+  // Include versions of dependencies, if present
+  try {
+    versions = require('../vendor/lib/versions.json');
+  } catch (err) {}
+})();
+
+/**
+ * @class Sharp
+ *
+ * Constructor factory to create an instance of `sharp`, to which further methods are chained.
+ *
+ * JPEG, PNG or WebP format image data can be streamed out from this object.
+ * When using Stream based output, derived attributes are available from the `info` event.
+ *
+ * Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
+ *
+ * @example
+ * sharp('input.jpg')
+ *   .resize(300, 200)
+ *   .toFile('output.jpg', function(err) {
+ *     // output.jpg is a 300 pixels wide and 200 pixels high image
+ *     // containing a scaled and cropped version of input.jpg
+ *   });
+ *
+ * @example
+ * // Read image data from readableStream,
+ * // resize to 300 pixels wide,
+ * // emit an 'info' event with calculated dimensions
+ * // and finally write image data to writableStream
+ * var transformer = sharp()
+ *   .resize(300)
+ *   .on('info', function(info) {
+ *     console.log('Image height is ' + info.height);
+ *   });
+ * readableStream.pipe(transformer).pipe(writableStream);
+ *
+ * @example
+ * // Create a blank 300x200 PNG image of semi-transluent red pixels
+ * sharp(null, {
+ *   create: {
+ *     width: 300,
+ *     height: 200,
+ *     channels: 4,
+ *     background: { r: 255, g: 0, b: 0, alpha: 128 }
+ *   }
+ * })
+ * .png()
+ * .toBuffer()
+ * .then( ... );
+ *
+ * @param {(Buffer|String)} [input] - if present, can be
+ *  a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
+ *  a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
+ *  JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when null or undefined.
+ * @param {Object} [options] - if present, is an Object with optional attributes.
+ * @param {Number} [options.density=72] - integral number representing the DPI for vector images.
+ * @param {Object} [options.raw] - describes raw pixel input image data. See `raw()` for pixel ordering.
+ * @param {Number} [options.raw.width]
+ * @param {Number} [options.raw.height]
+ * @param {Number} [options.raw.channels] - 1-4
+ * @param {Object} [options.create] - describes a new image to be created.
+ * @param {Number} [options.create.width]
+ * @param {Number} [options.create.height]
+ * @param {Number} [options.create.channels] - 3-4
+ * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+const Sharp = function (input, options) {
+  if (!(this instanceof Sharp)) {
+    return new Sharp(input, options);
+  }
+  stream.Duplex.call(this);
+  this.options = {
+    // input options
+    sequentialRead: false,
+    limitInputPixels: maximum.pixels,
+    // ICC profiles
+    iccProfilePath: path.join(__dirname, 'icc') + path.sep,
+    // resize options
+    topOffsetPre: -1,
+    leftOffsetPre: -1,
+    widthPre: -1,
+    heightPre: -1,
+    topOffsetPost: -1,
+    leftOffsetPost: -1,
+    widthPost: -1,
+    heightPost: -1,
+    width: -1,
+    height: -1,
+    canvas: 'crop',
+    crop: 0,
+    angle: 0,
+    rotateBeforePreExtract: false,
+    flip: false,
+    flop: false,
+    extendTop: 0,
+    extendBottom: 0,
+    extendLeft: 0,
+    extendRight: 0,
+    withoutEnlargement: false,
+    kernel: 'lanczos3',
+    interpolator: 'bicubic',
+    centreSampling: false,
+    // operations
+    background: [0, 0, 0, 255],
+    flatten: false,
+    negate: false,
+    blurSigma: 0,
+    sharpenSigma: 0,
+    sharpenFlat: 1,
+    sharpenJagged: 2,
+    threshold: 0,
+    thresholdGrayscale: true,
+    trimTolerance: 0,
+    gamma: 0,
+    greyscale: false,
+    normalise: 0,
+    booleanBufferIn: null,
+    booleanFileIn: '',
+    joinChannelIn: [],
+    extractChannel: -1,
+    colourspace: 'srgb',
+    // overlay
+    overlayGravity: 0,
+    overlayXOffset: -1,
+    overlayYOffset: -1,
+    overlayTile: false,
+    overlayCutout: false,
+    // output
+    fileOut: '',
+    formatOut: 'input',
+    streamOut: false,
+    withMetadata: false,
+    withMetadataOrientation: -1,
+    resolveWithObject: false,
+    // output format
+    jpegQuality: 80,
+    jpegProgressive: false,
+    jpegChromaSubsampling: '4:2:0',
+    jpegTrellisQuantisation: false,
+    jpegOvershootDeringing: false,
+    jpegOptimiseScans: false,
+    pngProgressive: false,
+    pngCompressionLevel: 6,
+    pngAdaptiveFiltering: true,
+    webpQuality: 80,
+    webpAlphaQuality: 100,
+    webpLossless: false,
+    webpNearLossless: false,
+    tiffQuality: 80,
+    tiffCompression: 'jpeg',
+    tiffPredictor: 'none',
+    tileSize: 256,
+    tileOverlap: 0,
+    // Function to notify of queue length changes
+    queueListener: function (queueLength) {
+      queue.emit('change', queueLength);
+    }
+  };
+  this.options.input = this._createInputDescriptor(input, options, { allowStream: true });
+  return this;
+};
+util.inherits(Sharp, stream.Duplex);
+
+/**
+ * Pixel limits.
+ * @member
+ * @private
+ */
+const maximum = {
+  width: 0x3FFF,
+  height: 0x3FFF,
+  pixels: Math.pow(0x3FFF, 2)
+};
+Sharp.maximum = maximum;
+
+/**
+ * An EventEmitter that emits a `change` event when a task is either:
+ * - queued, waiting for _libuv_ to provide a worker thread
+ * - complete
+ * @member
+ * @example
+ * sharp.queue.on('change', function(queueLength) {
+ *   console.log('Queue contains ' + queueLength + ' task(s)');
+ * });
+ */
+const queue = new events.EventEmitter();
+Sharp.queue = queue;
+
+/**
+ * An Object containing nested boolean values representing the available input and output formats/methods.
+ * @example
+ * console.log(sharp.format());
+ * @returns {Object}
+ */
+Sharp.format = sharp.format();
+
+/**
+ * An Object containing the version numbers of libvips and its dependencies.
+ * @member
+ * @example
+ * console.log(sharp.versions);
+ */
+Sharp.versions = versions;
+
+/**
+ * Export constructor.
+ * @private
+ */
+module.exports = Sharp;

lib/index.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const Sharp = require('./constructor');
+[
+  'input',
+  'resize',
+  'composite',
+  'operation',
+  'colour',
+  'channel',
+  'output',
+  'utility'
+].forEach(function (decorator) {
+  require('./' + decorator)(Sharp);
+});
+
+module.exports = Sharp;

lib/input.js

@@ -0,0 +1,283 @@
+'use strict';
+
+const util = require('util');
+const color = require('color');
+const is = require('./is');
+const sharp = require('../build/Release/sharp.node');
+
+/**
+ * Create Object containing input and input-related options.
+ * @private
+ */
+function _createInputDescriptor (input, inputOptions, containerOptions) {
+  const inputDescriptor = {};
+  if (is.string(input)) {
+    // filesystem
+    inputDescriptor.file = input;
+  } else if (is.buffer(input)) {
+    // Buffer
+    inputDescriptor.buffer = input;
+  } else if (!is.defined(input) && is.object(containerOptions) && containerOptions.allowStream) {
+    // Stream
+    inputDescriptor.buffer = [];
+  } else {
+    throw new Error('Unsupported input ' + typeof input);
+  }
+  if (is.object(inputOptions)) {
+    // Density
+    if (is.defined(inputOptions.density)) {
+      if (is.integer(inputOptions.density) && is.inRange(inputOptions.density, 1, 2400)) {
+        inputDescriptor.density = inputOptions.density;
+      } else {
+        throw new Error('Invalid density (1 to 2400) ' + inputOptions.density);
+      }
+    }
+    // Raw pixel input
+    if (is.defined(inputOptions.raw)) {
+      if (
+        is.object(inputOptions.raw) &&
+        is.integer(inputOptions.raw.width) && is.inRange(inputOptions.raw.width, 1, this.constructor.maximum.width) &&
+        is.integer(inputOptions.raw.height) && is.inRange(inputOptions.raw.height, 1, this.constructor.maximum.height) &&
+        is.integer(inputOptions.raw.channels) && is.inRange(inputOptions.raw.channels, 1, 4)
+      ) {
+        inputDescriptor.rawWidth = inputOptions.raw.width;
+        inputDescriptor.rawHeight = inputOptions.raw.height;
+        inputDescriptor.rawChannels = inputOptions.raw.channels;
+      } else {
+        throw new Error('Expected width, height and channels for raw pixel input');
+      }
+    }
+    // Create new image
+    if (is.defined(inputOptions.create)) {
+      if (
+        is.object(inputOptions.create) &&
+        is.integer(inputOptions.create.width) && is.inRange(inputOptions.create.width, 1, this.constructor.maximum.width) &&
+        is.integer(inputOptions.create.height) && is.inRange(inputOptions.create.height, 1, this.constructor.maximum.height) &&
+        is.integer(inputOptions.create.channels) && is.inRange(inputOptions.create.channels, 3, 4) &&
+        is.defined(inputOptions.create.background)
+      ) {
+        inputDescriptor.createWidth = inputOptions.create.width;
+        inputDescriptor.createHeight = inputOptions.create.height;
+        inputDescriptor.createChannels = inputOptions.create.channels;
+        const background = color(inputOptions.create.background);
+        inputDescriptor.createBackground = [
+          background.red(),
+          background.green(),
+          background.blue(),
+          Math.round(background.alpha() * 255)
+        ];
+        delete inputDescriptor.buffer;
+      } else {
+        throw new Error('Expected width, height, channels and background to create a new input image');
+      }
+    }
+  } else if (is.defined(inputOptions)) {
+    throw new Error('Invalid input options ' + inputOptions);
+  }
+  return inputDescriptor;
+}
+
+/**
+ * Handle incoming Buffer chunk on Writable Stream.
+ * @private
+ * @param {Buffer} chunk
+ * @param {String} encoding - unused
+ * @param {Function} callback
+ */
+function _write (chunk, encoding, callback) {
+  /* istanbul ignore else */
+  if (Array.isArray(this.options.input.buffer)) {
+    /* istanbul ignore else */
+    if (is.buffer(chunk)) {
+      if (this.options.input.buffer.length === 0) {
+        const that = this;
+        this.on('finish', function () {
+          that.streamInFinished = true;
+        });
+      }
+      this.options.input.buffer.push(chunk);
+      callback();
+    } else {
+      callback(new Error('Non-Buffer data on Writable Stream'));
+    }
+  } else {
+    callback(new Error('Unexpected data on Writable Stream'));
+  }
+}
+
+/**
+ * Flattens the array of chunks accumulated in input.buffer.
+ * @private
+ */
+function _flattenBufferIn () {
+  if (this._isStreamInput()) {
+    this.options.input.buffer = Buffer.concat(this.options.input.buffer);
+  }
+}
+
+/**
+ * Are we expecting Stream-based input?
+ * @private
+ * @returns {Boolean}
+ */
+function _isStreamInput () {
+  return Array.isArray(this.options.input.buffer);
+}
+
+/**
+ * Take a "snapshot" of the Sharp instance, returning a new instance.
+ * Cloned instances inherit the input of their parent instance.
+ * This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
+ *
+ * @example
+ * const pipeline = sharp().rotate();
+ * pipeline.clone().resize(800, 600).pipe(firstWritableStream);
+ * pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
+ * readableStream.pipe(pipeline);
+ * // firstWritableStream receives auto-rotated, resized readableStream
+ * // secondWritableStream receives auto-rotated, extracted region of readableStream
+ *
+ * @returns {Sharp}
+ */
+function clone () {
+  const that = this;
+  // Clone existing options
+  const clone = this.constructor.call();
+  util._extend(clone.options, this.options);
+  // Pass 'finish' event to clone for Stream-based input
+  this.on('finish', function () {
+    // Clone inherits input data
+    that._flattenBufferIn();
+    clone.options.bufferIn = that.options.bufferIn;
+    clone.emit('finish');
+  });
+  return clone;
+}
+
+/**
+ * Fast access to image metadata without decoding any compressed image data.
+ * A Promises/A+ promise is returned when `callback` is not provided.
+ *
+ * - `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
+ * - `width`: Number of pixels wide
+ * - `height`: Number of pixels high
+ * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+ * - `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
+ * - `density`: Number of pixels per inch (DPI), if present
+ * - `hasProfile`: Boolean indicating the presence of an embedded ICC profile
+ * - `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
+ * - `orientation`: Number value of the EXIF Orientation header, if present
+ * - `exif`: Buffer containing raw EXIF data, if present
+ * - `icc`: Buffer containing raw [ICC](https://www.npmjs.com/package/icc) profile data, if present
+ *
+ * @example
+ * const image = sharp(inputJpg);
+ * image
+ *   .metadata()
+ *   .then(function(metadata) {
+ *     return image
+ *       .resize(Math.round(metadata.width / 2))
+ *       .webp()
+ *       .toBuffer();
+ *   })
+ *   .then(function(data) {
+ *     // data contains a WebP image half the width and height of the original JPEG
+ *   });
+ *
+ * @param {Function} [callback] - called with the arguments `(err, metadata)`
+ * @returns {Promise<Object>|Sharp}
+ */
+function metadata (callback) {
+  const that = this;
+  if (is.fn(callback)) {
+    if (this._isStreamInput()) {
+      this.on('finish', function () {
+        that._flattenBufferIn();
+        sharp.metadata(that.options, callback);
+      });
+    } else {
+      sharp.metadata(this.options, callback);
+    }
+    return this;
+  } else {
+    if (this._isStreamInput()) {
+      return new Promise(function (resolve, reject) {
+        that.on('finish', function () {
+          that._flattenBufferIn();
+          sharp.metadata(that.options, function (err, metadata) {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(metadata);
+            }
+          });
+        });
+      });
+    } else {
+      return new Promise(function (resolve, reject) {
+        sharp.metadata(that.options, function (err, metadata) {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(metadata);
+          }
+        });
+      });
+    }
+  }
+}
+
+/**
+ * Do not process input images where the number of pixels (width * height) exceeds this limit.
+ * Assumes image dimensions contained in the input metadata can be trusted.
+ * The default limit is 268402689 (0x3FFF * 0x3FFF) pixels.
+ * @param {(Number|Boolean)} limit - an integral Number of pixels, zero or false to remove limit, true to use default limit.
+ * @returns {Sharp}
+ * @throws {Error} Invalid limit
+*/
+function limitInputPixels (limit) {
+  // if we pass in false we represent the integer as 0 to disable
+  if (limit === false) {
+    limit = 0;
+  } else if (limit === true) {
+    limit = this.constructor.maximum.pixels;
+  }
+  if (is.integer(limit) && limit >= 0) {
+    this.options.limitInputPixels = limit;
+  } else {
+    throw new Error('Invalid pixel limit (0 to ' + this.constructor.maximum.pixels + ') ' + limit);
+  }
+  return this;
+}
+
+/**
+ * An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
+ * This will reduce memory usage and can improve performance on some systems.
+ * @param {Boolean} [sequentialRead=true]
+ * @returns {Sharp}
+ */
+function sequentialRead (sequentialRead) {
+  this.options.sequentialRead = is.bool(sequentialRead) ? sequentialRead : true;
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with input-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    // Private
+    _createInputDescriptor,
+    _write,
+    _flattenBufferIn,
+    _isStreamInput,
+    // Public
+    clone,
+    metadata,
+    limitInputPixels,
+    sequentialRead
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+};

lib/is.js

@@ -0,0 +1,110 @@
+'use strict';
+
+/**
+ * Is this value defined and not null?
+ * @private
+ */
+const defined = function (val) {
+  return typeof val !== 'undefined' && val !== null;
+};
+
+/**
+ * Is this value an object?
+ * @private
+ */
+const object = function (val) {
+  return typeof val === 'object';
+};
+
+/**
+ * Is this value a function?
+ * @private
+ */
+const fn = function (val) {
+  return typeof val === 'function';
+};
+
+/**
+ * Is this value a boolean?
+ * @private
+ */
+const bool = function (val) {
+  return typeof val === 'boolean';
+};
+
+/**
+ * Is this value a Buffer object?
+ * @private
+ */
+const buffer = function (val) {
+  return object(val) && val instanceof Buffer;
+};
+
+/**
+ * Is this value a non-empty string?
+ * @private
+ */
+const string = function (val) {
+  return typeof val === 'string' && val.length > 0;
+};
+
+/**
+ * Is this value a real number?
+ * @private
+ */
+const number = function (val) {
+  return typeof val === 'number' && !Number.isNaN(val);
+};
+
+/**
+ * Is this value an integer?
+ * @private
+ */
+const integer = function (val) {
+  return number(val) && val % 1 === 0;
+};
+
+/**
+ * Is this value within an inclusive given range?
+ * @private
+ */
+const inRange = function (val, min, max) {
+  return val >= min && val <= max;
+};
+
+/**
+ * Is this value within the elements of an array?
+ * @private
+ */
+const inArray = function (val, list) {
+  return list.indexOf(val) !== -1;
+};
+
+/**
+ * Create an Error with a message relating to an invalid parameter.
+ *
+ * @param {String} name - parameter name.
+ * @param {String} expected - description of the type/value/range expected.
+ * @param {*} actual - the value received.
+ * @returns {Error} Containing the formatted message.
+ * @private
+ */
+const invalidParameterError = function (name, expected, actual) {
+  return new Error(
+    `Expected ${expected} for ${name} but received ${actual} of type ${typeof actual}`
+  );
+};
+
+module.exports = {
+  defined: defined,
+  object: object,
+  fn: fn,
+  bool: bool,
+  buffer: buffer,
+  string: string,
+  number: number,
+  integer: integer,
+  inRange: inRange,
+  inArray: inArray,
+  invalidParameterError: invalidParameterError
+};

lib/operation.js

@@ -0,0 +1,431 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Rotate the output image by either an explicit angle
+ * or auto-orient based on the EXIF `Orientation` tag.
+ *
+ * Use this method without angle to determine the angle from EXIF data.
+ * Mirroring is supported and may infer the use of a flip operation.
+ *
+ * The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.
+ *
+ * Method order is important when both rotating and extracting regions,
+ * for example `rotate(x).extract(y)` will produce a different result to `extract(y).rotate(x)`.
+ *
+ * @example
+ * const pipeline = sharp()
+ *   .rotate()
+ *   .resize(null, 200)
+ *   .toBuffer(function (err, outputBuffer, info) {
+ *     // outputBuffer contains 200px high JPEG image data,
+ *     // auto-rotated using EXIF Orientation tag
+ *     // info.width and info.height contain the dimensions of the resized image
+ *   });
+ * readableStream.pipe(pipeline);
+ *
+ * @param {Number} [angle=auto] 0, 90, 180 or 270.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function rotate (angle) {
+  if (!is.defined(angle)) {
+    this.options.angle = -1;
+  } else if (is.integer(angle) && is.inArray(angle, [0, 90, 180, 270])) {
+    this.options.angle = angle;
+  } else {
+    throw new Error('Unsupported angle (0, 90, 180, 270) ' + angle);
+  }
+  return this;
+}
+
+/**
+ * Extract a region of the image.
+ *
+ * - Use `extract` before `resize` for pre-resize extraction.
+ * - Use `extract` after `resize` for post-resize extraction.
+ * - Use `extract` before and after for both.
+ *
+ * @example
+ * sharp(input)
+ *   .extract({ left: left, top: top, width: width, height: height })
+ *   .toFile(output, function(err) {
+ *     // Extract a region of the input image, saving in the same format.
+ *   });
+ * @example
+ * sharp(input)
+ *   .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
+ *   .resize(width, height)
+ *   .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
+ *   .toFile(output, function(err) {
+ *     // Extract a region, resize, then extract from the resized image
+ *   });
+ *
+ * @param {Object} options
+ * @param {Number} options.left - zero-indexed offset from left edge
+ * @param {Number} options.top - zero-indexed offset from top edge
+ * @param {Number} options.width - dimension of extracted image
+ * @param {Number} options.height - dimension of extracted image
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function extract (options) {
+  const suffix = this.options.width === -1 && this.options.height === -1 ? 'Pre' : 'Post';
+  ['left', 'top', 'width', 'height'].forEach(function (name) {
+    const value = options[name];
+    if (is.integer(value) && value >= 0) {
+      this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
+    } else {
+      throw new Error('Non-integer value for ' + name + ' of ' + value);
+    }
+  }, this);
+  // Ensure existing rotation occurs before pre-resize extraction
+  if (suffix === 'Pre' && this.options.angle !== 0) {
+    this.options.rotateBeforePreExtract = true;
+  }
+  return this;
+}
+
+/**
+ * Flip the image about the vertical Y axis. This always occurs after rotation, if any.
+ * The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.
+ * @param {Boolean} [flip=true]
+ * @returns {Sharp}
+ */
+function flip (flip) {
+  this.options.flip = is.bool(flip) ? flip : true;
+  return this;
+}
+
+/**
+ * Flop the image about the horizontal X axis. This always occurs after rotation, if any.
+ * The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.
+ * @param {Boolean} [flop=true]
+ * @returns {Sharp}
+ */
+function flop (flop) {
+  this.options.flop = is.bool(flop) ? flop : true;
+  return this;
+}
+
+/**
+ * Sharpen the image.
+ * When used without parameters, performs a fast, mild sharpen of the output image.
+ * When a `sigma` is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space.
+ * Separate control over the level of sharpening in "flat" and "jagged" areas is available.
+ *
+ * @param {Number} [sigma] - the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+ * @param {Number} [flat=1.0] - the level of sharpening to apply to "flat" areas.
+ * @param {Number} [jagged=2.0] - the level of sharpening to apply to "jagged" areas.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function sharpen (sigma, flat, jagged) {
+  if (!is.defined(sigma)) {
+    // No arguments: default to mild sharpen
+    this.options.sharpenSigma = -1;
+  } else if (is.bool(sigma)) {
+    // Boolean argument: apply mild sharpen?
+    this.options.sharpenSigma = sigma ? -1 : 0;
+  } else if (is.number(sigma) && is.inRange(sigma, 0.01, 10000)) {
+    // Numeric argument: specific sigma
+    this.options.sharpenSigma = sigma;
+    // Control over flat areas
+    if (is.defined(flat)) {
+      if (is.number(flat) && is.inRange(flat, 0, 10000)) {
+        this.options.sharpenFlat = flat;
+      } else {
+        throw new Error('Invalid sharpen level for flat areas (0.0 - 10000.0) ' + flat);
+      }
+    }
+    // Control over jagged areas
+    if (is.defined(jagged)) {
+      if (is.number(jagged) && is.inRange(jagged, 0, 10000)) {
+        this.options.sharpenJagged = jagged;
+      } else {
+        throw new Error('Invalid sharpen level for jagged areas (0.0 - 10000.0) ' + jagged);
+      }
+    }
+  } else {
+    throw new Error('Invalid sharpen sigma (0.01 - 10000) ' + sigma);
+  }
+  return this;
+}
+
+/**
+ * Blur the image.
+ * When used without parameters, performs a fast, mild blur of the output image.
+ * When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
+ * @param {Number} [sigma] a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function blur (sigma) {
+  if (!is.defined(sigma)) {
+    // No arguments: default to mild blur
+    this.options.blurSigma = -1;
+  } else if (is.bool(sigma)) {
+    // Boolean argument: apply mild blur?
+    this.options.blurSigma = sigma ? -1 : 0;
+  } else if (is.number(sigma) && is.inRange(sigma, 0.3, 1000)) {
+    // Numeric argument: specific sigma
+    this.options.blurSigma = sigma;
+  } else {
+    throw new Error('Invalid blur sigma (0.3 - 1000.0) ' + sigma);
+  }
+  return this;
+}
+
+/**
+ * Extends/pads the edges of the image with the colour provided to the `background` method.
+ * This operation will always occur after resizing and extraction, if any.
+ *
+ * @example
+ * // Resize to 140 pixels wide, then add 10 transparent pixels
+ * // to the top, left and right edges and 20 to the bottom edge
+ * sharp(input)
+ *   .resize(140)
+ *   .background({r: 0, g: 0, b: 0, alpha: 0})
+ *   .extend({top: 10, bottom: 20, left: 10, right: 10})
+ *   ...
+ *
+ * @param {(Number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
+ * @param {Number} [extend.top]
+ * @param {Number} [extend.left]
+ * @param {Number} [extend.bottom]
+ * @param {Number} [extend.right]
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+*/
+function extend (extend) {
+  if (is.integer(extend) && extend > 0) {
+    this.options.extendTop = extend;
+    this.options.extendBottom = extend;
+    this.options.extendLeft = extend;
+    this.options.extendRight = extend;
+  } else if (
+    is.object(extend) &&
+    is.integer(extend.top) && extend.top >= 0 &&
+    is.integer(extend.bottom) && extend.bottom >= 0 &&
+    is.integer(extend.left) && extend.left >= 0 &&
+    is.integer(extend.right) && extend.right >= 0
+  ) {
+    this.options.extendTop = extend.top;
+    this.options.extendBottom = extend.bottom;
+    this.options.extendLeft = extend.left;
+    this.options.extendRight = extend.right;
+  } else {
+    throw new Error('Invalid edge extension ' + extend);
+  }
+  return this;
+}
+
+/**
+ * Merge alpha transparency channel, if any, with `background`.
+ * @param {Boolean} [flatten=true]
+ * @returns {Sharp}
+ */
+function flatten (flatten) {
+  this.options.flatten = is.bool(flatten) ? flatten : true;
+  return this;
+}
+
+/**
+ * Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
+ * @param {Number} [tolerance=10] value between 1 and 99 representing the percentage similarity.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function trim (tolerance) {
+  if (!is.defined(tolerance)) {
+    this.options.trimTolerance = 10;
+  } else if (is.integer(tolerance) && is.inRange(tolerance, 1, 99)) {
+    this.options.trimTolerance = tolerance;
+  } else {
+    throw new Error('Invalid trim tolerance (1 to 99) ' + tolerance);
+  }
+  return this;
+}
+
+/**
+ * Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of `1/gamma`
+ * then increasing the encoding (brighten) post-resize at a factor of `gamma`.
+ * This can improve the perceived brightness of a resized image in non-linear colour spaces.
+ * JPEG and WebP input images will not take advantage of the shrink-on-load performance optimisation
+ * when applying a gamma correction.
+ * @param {Number} [gamma=2.2] value between 1.0 and 3.0.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function gamma (gamma) {
+  if (!is.defined(gamma)) {
+    // Default gamma correction of 2.2 (sRGB)
+    this.options.gamma = 2.2;
+  } else if (is.number(gamma) && is.inRange(gamma, 1, 3)) {
+    this.options.gamma = gamma;
+  } else {
+    throw new Error('Invalid gamma correction (1.0 to 3.0) ' + gamma);
+  }
+  return this;
+}
+
+/**
+ * Produce the "negative" of the image.
+ * @param {Boolean} [negate=true]
+ * @returns {Sharp}
+ */
+function negate (negate) {
+  this.options.negate = is.bool(negate) ? negate : true;
+  return this;
+}
+
+/**
+ * Enhance output image contrast by stretching its luminance to cover the full dynamic range.
+ * @param {Boolean} [normalise=true]
+ * @returns {Sharp}
+ */
+function normalise (normalise) {
+  this.options.normalise = is.bool(normalise) ? normalise : true;
+  return this;
+}
+
+/**
+ * Alternative spelling of normalise.
+ * @param {Boolean} [normalize=true]
+ * @returns {Sharp}
+ */
+function normalize (normalize) {
+  return this.normalise(normalize);
+}
+
+/**
+ * Convolve the image with the specified kernel.
+ *
+ * @example
+ * sharp(input)
+ *   .convolve({
+ *     width: 3,
+ *     height: 3,
+ *     kernel: [-1, 0, 1, -2, 0, 2, -1, 0, 1]
+ *   })
+ *   .raw()
+ *   .toBuffer(function(err, data, info) {
+ *     // data contains the raw pixel data representing the convolution
+ *     // of the input image with the horizontal Sobel operator
+ *   });
+ *
+ * @param {Object} kernel
+ * @param {Number} kernel.width - width of the kernel in pixels.
+ * @param {Number} kernel.height - width of the kernel in pixels.
+ * @param {Array<Number>} kernel.kernel - Array of length `width*height` containing the kernel values.
+ * @param {Number} [kernel.scale=sum] - the scale of the kernel in pixels.
+ * @param {Number} [kernel.offset=0] - the offset of the kernel in pixels.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function convolve (kernel) {
+  if (!is.object(kernel) || !Array.isArray(kernel.kernel) ||
+      !is.integer(kernel.width) || !is.integer(kernel.height) ||
+      !is.inRange(kernel.width, 3, 1001) || !is.inRange(kernel.height, 3, 1001) ||
+      kernel.height * kernel.width !== kernel.kernel.length
+     ) {
+    // must pass in a kernel
+    throw new Error('Invalid convolution kernel');
+  }
+  // Default scale is sum of kernel values
+  if (!is.integer(kernel.scale)) {
+    kernel.scale = kernel.kernel.reduce(function (a, b) {
+      return a + b;
+    }, 0);
+  }
+  // Clip scale to a minimum value of 1
+  if (kernel.scale < 1) {
+    kernel.scale = 1;
+  }
+  if (!is.integer(kernel.offset)) {
+    kernel.offset = 0;
+  }
+  this.options.convKernel = kernel;
+  return this;
+}
+
+/**
+ * Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
+ * @param {Number} [threshold=128] - a value in the range 0-255 representing the level at which the threshold will be applied.
+ * @param {Object} [options]
+ * @param {Boolean} [options.greyscale=true] - convert to single channel greyscale.
+ * @param {Boolean} [options.grayscale=true] - alternative spelling for greyscale.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function threshold (threshold, options) {
+  if (!is.defined(threshold)) {
+    this.options.threshold = 128;
+  } else if (is.bool(threshold)) {
+    this.options.threshold = threshold ? 128 : 0;
+  } else if (is.integer(threshold) && is.inRange(threshold, 0, 255)) {
+    this.options.threshold = threshold;
+  } else {
+    throw new Error('Invalid threshold (0 to 255) ' + threshold);
+  }
+  if (!is.object(options) || options.greyscale === true || options.grayscale === true) {
+    this.options.thresholdGrayscale = true;
+  } else {
+    this.options.thresholdGrayscale = false;
+  }
+  return this;
+}
+
+/**
+ * Perform a bitwise boolean operation with operand image.
+ *
+ * This operation creates an output image where each pixel is the result of
+ * the selected bitwise boolean `operation` between the corresponding pixels of the input images.
+ *
+ * @param {Buffer|String} operand - Buffer containing image data or String containing the path to an image file.
+ * @param {String} operator - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+ * @param {Object} [options]
+ * @param {Object} [options.raw] - describes operand when using raw pixel data.
+ * @param {Number} [options.raw.width]
+ * @param {Number} [options.raw.height]
+ * @param {Number} [options.raw.channels]
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function boolean (operand, operator, options) {
+  this.options.boolean = this._createInputDescriptor(operand, options);
+  if (is.string(operator) && is.inArray(operator, ['and', 'or', 'eor'])) {
+    this.options.booleanOp = operator;
+  } else {
+    throw new Error('Invalid boolean operator ' + operator);
+  }
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with operation-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    rotate,
+    extract,
+    flip,
+    flop,
+    sharpen,
+    blur,
+    extend,
+    flatten,
+    trim,
+    gamma,
+    negate,
+    normalise,
+    normalize,
+    convolve,
+    threshold,
+    boolean
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+};

lib/output.js

@@ -0,0 +1,581 @@
+'use strict';
+
+const util = require('util');
+const is = require('./is');
+const sharp = require('../build/Release/sharp.node');
+
+/**
+ * Write output image data to a file.
+ *
+ * If an explicit output format is not selected, it will be inferred from the extension,
+ * with JPEG, PNG, WebP, TIFF, DZI, and libvips' V format supported.
+ * Note that raw pixel data is only supported for buffer output.
+ *
+ * A Promises/A+ promise is returned when `callback` is not provided.
+ *
+ * @param {String} fileOut - the path to write the image data to.
+ * @param {Function} [callback] - called on completion with two arguments `(err, info)`.
+ * `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+ * @returns {Promise<Object>} - when no callback is provided
+ * @throws {Error} Invalid parameters
+ */
+function toFile (fileOut, callback) {
+  if (!fileOut || fileOut.length === 0) {
+    const errOutputInvalid = new Error('Invalid output');
+    if (is.fn(callback)) {
+      callback(errOutputInvalid);
+    } else {
+      return Promise.reject(errOutputInvalid);
+    }
+  } else {
+    if (this.options.input.file === fileOut) {
+      const errOutputIsInput = new Error('Cannot use same file for input and output');
+      if (is.fn(callback)) {
+        callback(errOutputIsInput);
+      } else {
+        return Promise.reject(errOutputIsInput);
+      }
+    } else {
+      this.options.fileOut = fileOut;
+      return this._pipeline(callback);
+    }
+  }
+  return this;
+}
+
+/**
+ * Write output to a Buffer.
+ * JPEG, PNG, WebP, and RAW output are supported.
+ * By default, the format will match the input image, except GIF and SVG input which become PNG output.
+ *
+ * `callback`, if present, gets three arguments `(err, data, info)` where:
+ * - `err` is an error, if any.
+ * - `data` is the output image data.
+ * - `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+ * A Promise is returned when `callback` is not provided.
+ *
+ * @param {Object} [options]
+ * @param {Boolean} [options.resolveWithObject] Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
+ * @param {Function} [callback]
+ * @returns {Promise<Buffer>} - when no callback is provided
+ */
+function toBuffer (options, callback) {
+  if (is.object(options)) {
+    if (is.bool(options.resolveWithObject)) {
+      this.options.resolveWithObject = options.resolveWithObject;
+    }
+  }
+  return this._pipeline(is.fn(options) ? options : callback);
+}
+
+/**
+ * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
+ * The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
+ * This will also convert to and add a web-friendly sRGB ICC profile.
+ * @param {Object} [withMetadata]
+ * @param {Number} [withMetadata.orientation] value between 1 and 8, used to update the EXIF `Orientation` tag.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function withMetadata (withMetadata) {
+  this.options.withMetadata = is.bool(withMetadata) ? withMetadata : true;
+  if (is.object(withMetadata)) {
+    if (is.defined(withMetadata.orientation)) {
+      if (is.integer(withMetadata.orientation) && is.inRange(withMetadata.orientation, 1, 8)) {
+        this.options.withMetadataOrientation = withMetadata.orientation;
+      } else {
+        throw new Error('Invalid orientation (1 to 8) ' + withMetadata.orientation);
+      }
+    }
+  }
+  return this;
+}
+
+/**
+ * Use these JPEG options for output image.
+ * @param {Object} [options] - output options
+ * @param {Number} [options.quality=80] - quality, integer 1-100
+ * @param {Boolean} [options.progressive=false] - use progressive (interlace) scan
+ * @param {String} [options.chromaSubsampling='4:2:0'] - set to '4:4:4' to prevent chroma subsampling when quality <= 90
+ * @param {Boolean} [options.trellisQuantisation=false] - apply trellis quantisation, requires mozjpeg
+ * @param {Boolean} [options.overshootDeringing=false] - apply overshoot deringing, requires mozjpeg
+ * @param {Boolean} [options.optimiseScans=false] - optimise progressive scans, forces progressive, requires mozjpeg
+ * @param {Boolean} [options.optimizeScans=false] - alternative spelling of optimiseScans
+ * @param {Boolean} [options.force=true] - force JPEG output, otherwise attempt to use input format
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+function jpeg (options) {
+  if (is.object(options)) {
+    if (is.defined(options.quality)) {
+      if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+        this.options.jpegQuality = options.quality;
+      } else {
+        throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+      }
+    }
+    if (is.defined(options.progressive)) {
+      this._setBooleanOption('jpegProgressive', options.progressive);
+    }
+    if (is.defined(options.chromaSubsampling)) {
+      if (is.string(options.chromaSubsampling) && is.inArray(options.chromaSubsampling, ['4:2:0', '4:4:4'])) {
+        this.options.jpegChromaSubsampling = options.chromaSubsampling;
+      } else {
+        throw new Error('Invalid chromaSubsampling (4:2:0, 4:4:4) ' + options.chromaSubsampling);
+      }
+    }
+    options.trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
+    if (is.defined(options.trellisQuantisation)) {
+      this._setBooleanOption('jpegTrellisQuantisation', options.trellisQuantisation);
+    }
+    if (is.defined(options.overshootDeringing)) {
+      this._setBooleanOption('jpegOvershootDeringing', options.overshootDeringing);
+    }
+    options.optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
+    if (is.defined(options.optimiseScans)) {
+      this._setBooleanOption('jpegOptimiseScans', options.optimiseScans);
+      if (options.optimiseScans) {
+        this.options.jpegProgressive = true;
+      }
+    }
+  }
+  return this._updateFormatOut('jpeg', options);
+}
+
+/**
+ * Use these PNG options for output image.
+ * @param {Object} [options]
+ * @param {Boolean} [options.progressive=false] - use progressive (interlace) scan
+ * @param {Number} [options.compressionLevel=6] - zlib compression level
+ * @param {Boolean} [options.adaptiveFiltering=true] - use adaptive row filtering
+ * @param {Boolean} [options.force=true] - force PNG output, otherwise attempt to use input format
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+function png (options) {
+  if (is.object(options)) {
+    if (is.defined(options.progressive)) {
+      this._setBooleanOption('pngProgressive', options.progressive);
+    }
+    if (is.defined(options.compressionLevel)) {
+      if (is.integer(options.compressionLevel) && is.inRange(options.compressionLevel, 0, 9)) {
+        this.options.pngCompressionLevel = options.compressionLevel;
+      } else {
+        throw new Error('Invalid compressionLevel (integer, 0-9) ' + options.compressionLevel);
+      }
+    }
+    if (is.defined(options.adaptiveFiltering)) {
+      this._setBooleanOption('pngAdaptiveFiltering', options.adaptiveFiltering);
+    }
+  }
+  return this._updateFormatOut('png', options);
+}
+
+/**
+ * Use these WebP options for output image.
+ * @param {Object} [options] - output options
+ * @param {Number} [options.quality=80] - quality, integer 1-100
+ * @param {Number} [options.alphaQuality=100] - quality of alpha layer, integer 0-100
+ * @param {Boolean} [options.lossless=false] - use lossless compression mode
+ * @param {Boolean} [options.nearLossless=false] - use near_lossless compression mode
+ * @param {Boolean} [options.force=true] - force WebP output, otherwise attempt to use input format
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+function webp (options) {
+  if (is.object(options) && is.defined(options.quality)) {
+    if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+      this.options.webpQuality = options.quality;
+    } else {
+      throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+    }
+  }
+  if (is.object(options) && is.defined(options.alphaQuality)) {
+    if (is.integer(options.alphaQuality) && is.inRange(options.alphaQuality, 1, 100)) {
+      this.options.webpAlphaQuality = options.alphaQuality;
+    } else {
+      throw new Error('Invalid webp alpha quality (integer, 1-100) ' + options.alphaQuality);
+    }
+  }
+  if (is.object(options) && is.defined(options.lossless)) {
+    this._setBooleanOption('webpLossless', options.lossless);
+  }
+  if (is.object(options) && is.defined(options.nearLossless)) {
+    this._setBooleanOption('webpNearLossless', options.nearLossless);
+  }
+  return this._updateFormatOut('webp', options);
+}
+
+/**
+ * Use these TIFF options for output image.
+ * @param {Object} [options] - output options
+ * @param {Number} [options.quality=80] - quality, integer 1-100
+ * @param {Boolean} [options.force=true] - force TIFF output, otherwise attempt to use input format
+ * @param {Boolean} [options.compression='jpeg'] - compression options: lzw, deflate, jpeg
+ * @param {Boolean} [options.predictor='none'] - compression predictor options: none, horizontal, float
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+function tiff (options) {
+  if (is.object(options) && is.defined(options.quality)) {
+    if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+      this.options.tiffQuality = options.quality;
+    } else {
+      throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+    }
+  }
+  // compression
+  if (is.defined(options) && is.defined(options.compression)) {
+    if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'none'])) {
+      this.options.tiffCompression = options.compression;
+    } else {
+      const message = `Invalid compression option "${options.compression}". Should be one of: lzw, deflate, jpeg, none`;
+      throw new Error(message);
+    }
+  }
+  // predictor
+  if (is.defined(options) && is.defined(options.predictor)) {
+    if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
+      this.options.tiffPredictor = options.predictor;
+    } else {
+      const message = `Invalid predictor option "${options.predictor}". Should be one of: none, horizontal, float`;
+      throw new Error(message);
+    }
+  }
+  return this._updateFormatOut('tiff', options);
+}
+
+/**
+ * Force output to be raw, uncompressed uint8 pixel data.
+ * @returns {Sharp}
+ */
+function raw () {
+  return this._updateFormatOut('raw');
+}
+
+/**
+ * Force output to a given format.
+ * @param {(String|Object)} format - as a String or an Object with an 'id' attribute
+ * @param {Object} options - output options
+ * @returns {Sharp}
+ * @throws {Error} unsupported format or options
+ */
+function toFormat (format, options) {
+  if (is.object(format) && is.string(format.id)) {
+    format = format.id;
+  }
+  if (!is.inArray(format, ['jpeg', 'png', 'webp', 'tiff', 'raw'])) {
+    throw new Error('Unsupported output format ' + format);
+  }
+  return this[format](options);
+}
+
+/**
+ * Use tile-based deep zoom (image pyramid) output.
+ * Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
+ * Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
+ *
+ * @example
+ *  sharp('input.tiff')
+ *   .png()
+ *   .tile({
+ *     size: 512
+ *   })
+ *   .toFile('output.dz', function(err, info) {
+ *     // output.dzi is the Deep Zoom XML definition
+ *     // output_files contains 512x512 tiles grouped by zoom level
+ *   });
+ *
+ * @param {Object} [tile]
+ * @param {Number} [tile.size=256] tile size in pixels, a value between 1 and 8192.
+ * @param {Number} [tile.overlap=0] tile overlap in pixels, a value between 0 and 8192.
+ * @param {String} [tile.container='fs'] tile container, with value `fs` (filesystem) or `zip` (compressed file).
+ * @param {String} [tile.layout='dz'] filesystem layout, possible values are `dz`, `zoomify` or `google`.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function tile (tile) {
+  if (is.object(tile)) {
+    // Size of square tiles, in pixels
+    if (is.defined(tile.size)) {
+      if (is.integer(tile.size) && is.inRange(tile.size, 1, 8192)) {
+        this.options.tileSize = tile.size;
+      } else {
+        throw new Error('Invalid tile size (1 to 8192) ' + tile.size);
+      }
+    }
+    // Overlap of tiles, in pixels
+    if (is.defined(tile.overlap)) {
+      if (is.integer(tile.overlap) && is.inRange(tile.overlap, 0, 8192)) {
+        if (tile.overlap > this.options.tileSize) {
+          throw new Error('Tile overlap ' + tile.overlap + ' cannot be larger than tile size ' + this.options.tileSize);
+        }
+        this.options.tileOverlap = tile.overlap;
+      } else {
+        throw new Error('Invalid tile overlap (0 to 8192) ' + tile.overlap);
+      }
+    }
+    // Container
+    if (is.defined(tile.container)) {
+      if (is.string(tile.container) && is.inArray(tile.container, ['fs', 'zip'])) {
+        this.options.tileContainer = tile.container;
+      } else {
+        throw new Error('Invalid tile container ' + tile.container);
+      }
+    }
+    // Layout
+    if (is.defined(tile.layout)) {
+      if (is.string(tile.layout) && is.inArray(tile.layout, ['dz', 'google', 'zoomify'])) {
+        this.options.tileLayout = tile.layout;
+      } else {
+        throw new Error('Invalid tile layout ' + tile.layout);
+      }
+    }
+  }
+  // Format
+  if (is.inArray(this.options.formatOut, ['jpeg', 'png', 'webp'])) {
+    this.options.tileFormat = this.options.formatOut;
+  } else if (this.options.formatOut !== 'input') {
+    throw new Error('Invalid tile format ' + this.options.formatOut);
+  }
+  return this._updateFormatOut('dz');
+}
+
+/**
+ * Update the output format unless options.force is false,
+ * in which case revert to input format.
+ * @private
+ * @param {String} formatOut
+ * @param {Object} [options]
+ * @param {Boolean} [options.force=true] - force output format, otherwise attempt to use input format
+ * @returns {Sharp}
+ */
+function _updateFormatOut (formatOut, options) {
+  this.options.formatOut = (is.object(options) && options.force === false) ? 'input' : formatOut;
+  return this;
+}
+
+/**
+ * Update a Boolean attribute of the this.options Object.
+ * @private
+ * @param {String} key
+ * @param {Boolean} val
+ * @throws {Error} Invalid key
+ */
+function _setBooleanOption (key, val) {
+  if (is.bool(val)) {
+    this.options[key] = val;
+  } else {
+    throw new Error('Invalid ' + key + ' (boolean) ' + val);
+  }
+}
+
+/**
+ * Called by a WriteableStream to notify us it is ready for data.
+ * @private
+ */
+function _read () {
+  if (!this.options.streamOut) {
+    this.options.streamOut = true;
+    this._pipeline();
+  }
+}
+
+/**
+ * Invoke the C++ image processing pipeline
+ * Supports callback, stream and promise variants
+ * @private
+ */
+function _pipeline (callback) {
+  const that = this;
+  if (typeof callback === 'function') {
+    // output=file/buffer
+    if (this._isStreamInput()) {
+      // output=file/buffer, input=stream
+      this.on('finish', function () {
+        that._flattenBufferIn();
+        sharp.pipeline(that.options, callback);
+      });
+    } else {
+      // output=file/buffer, input=file/buffer
+      sharp.pipeline(this.options, callback);
+    }
+    return this;
+  } else if (this.options.streamOut) {
+    // output=stream
+    if (this._isStreamInput()) {
+      // output=stream, input=stream
+      if (this.streamInFinished) {
+        this._flattenBufferIn();
+        sharp.pipeline(this.options, function (err, data, info) {
+          if (err) {
+            that.emit('error', err);
+          } else {
+            that.emit('info', info);
+            that.push(data);
+          }
+          that.push(null);
+        });
+      } else {
+        this.on('finish', function () {
+          that._flattenBufferIn();
+          sharp.pipeline(that.options, function (err, data, info) {
+            if (err) {
+              that.emit('error', err);
+            } else {
+              that.emit('info', info);
+              that.push(data);
+            }
+            that.push(null);
+          });
+        });
+      }
+    } else {
+      // output=stream, input=file/buffer
+      sharp.pipeline(this.options, function (err, data, info) {
+        if (err) {
+          that.emit('error', err);
+        } else {
+          that.emit('info', info);
+          that.push(data);
+        }
+        that.push(null);
+      });
+    }
+    return this;
+  } else {
+    // output=promise
+    if (this._isStreamInput()) {
+      // output=promise, input=stream
+      return new Promise(function (resolve, reject) {
+        that.on('finish', function () {
+          that._flattenBufferIn();
+          sharp.pipeline(that.options, function (err, data, info) {
+            if (err) {
+              reject(err);
+            } else {
+              if (that.options.resolveWithObject) {
+                resolve({ data: data, info: info });
+              } else {
+                resolve(data);
+              }
+            }
+          });
+        });
+      });
+    } else {
+      // output=promise, input=file/buffer
+      return new Promise(function (resolve, reject) {
+        sharp.pipeline(that.options, function (err, data, info) {
+          if (err) {
+            reject(err);
+          } else {
+            if (that.options.resolveWithObject) {
+              resolve({ data: data, info: info });
+            } else {
+              resolve(data);
+            }
+          }
+        });
+      });
+    }
+  }
+}
+
+// Deprecated output options
+/* istanbul ignore next */
+const quality = util.deprecate(function (quality) {
+  const formatOut = this.options.formatOut;
+  const options = { quality: quality };
+  this.jpeg(options).webp(options).tiff(options);
+  this.options.formatOut = formatOut;
+  return this;
+}, 'quality: use jpeg({ quality: ... }), webp({ quality: ... }) and/or tiff({ quality: ... }) instead');
+/* istanbul ignore next */
+const progressive = util.deprecate(function (progressive) {
+  const formatOut = this.options.formatOut;
+  const options = { progressive: (progressive !== false) };
+  this.jpeg(options).png(options);
+  this.options.formatOut = formatOut;
+  return this;
+}, 'progressive: use jpeg({ progressive: ... }) and/or png({ progressive: ... }) instead');
+/* istanbul ignore next */
+const compressionLevel = util.deprecate(function (compressionLevel) {
+  const formatOut = this.options.formatOut;
+  this.png({ compressionLevel: compressionLevel });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'compressionLevel: use png({ compressionLevel: ... }) instead');
+/* istanbul ignore next */
+const withoutAdaptiveFiltering = util.deprecate(function (withoutAdaptiveFiltering) {
+  const formatOut = this.options.formatOut;
+  this.png({ adaptiveFiltering: (withoutAdaptiveFiltering === false) });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'withoutAdaptiveFiltering: use png({ adaptiveFiltering: ... }) instead');
+/* istanbul ignore next */
+const withoutChromaSubsampling = util.deprecate(function (withoutChromaSubsampling) {
+  const formatOut = this.options.formatOut;
+  this.jpeg({ chromaSubsampling: (withoutChromaSubsampling === false) ? '4:2:0' : '4:4:4' });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'withoutChromaSubsampling: use jpeg({ chromaSubsampling: "4:4:4" }) instead');
+/* istanbul ignore next */
+const trellisQuantisation = util.deprecate(function (trellisQuantisation) {
+  const formatOut = this.options.formatOut;
+  this.jpeg({ trellisQuantisation: (trellisQuantisation !== false) });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'trellisQuantisation: use jpeg({ trellisQuantisation: ... }) instead');
+/* istanbul ignore next */
+const overshootDeringing = util.deprecate(function (overshootDeringing) {
+  const formatOut = this.options.formatOut;
+  this.jpeg({ overshootDeringing: (overshootDeringing !== false) });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'overshootDeringing: use jpeg({ overshootDeringing: ... }) instead');
+/* istanbul ignore next */
+const optimiseScans = util.deprecate(function (optimiseScans) {
+  const formatOut = this.options.formatOut;
+  this.jpeg({ optimiseScans: (optimiseScans !== false) });
+  this.options.formatOut = formatOut;
+  return this;
+}, 'optimiseScans: use jpeg({ optimiseScans: ... }) instead');
+
+/**
+ * Decorate the Sharp prototype with output-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    // Public
+    toFile,
+    toBuffer,
+    withMetadata,
+    jpeg,
+    png,
+    webp,
+    tiff,
+    raw,
+    toFormat,
+    tile,
+    // Private
+    _updateFormatOut,
+    _setBooleanOption,
+    _read,
+    _pipeline
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+  // Deprecated
+  Sharp.prototype.quality = quality;
+  Sharp.prototype.progressive = progressive;
+  Sharp.prototype.compressionLevel = compressionLevel;
+  Sharp.prototype.withoutAdaptiveFiltering = withoutAdaptiveFiltering;
+  Sharp.prototype.withoutChromaSubsampling = withoutChromaSubsampling;
+  Sharp.prototype.trellisQuantisation = trellisQuantisation;
+  Sharp.prototype.trellisQuantization = trellisQuantisation;
+  Sharp.prototype.overshootDeringing = overshootDeringing;
+  Sharp.prototype.optimiseScans = optimiseScans;
+  Sharp.prototype.optimizeScans = optimiseScans;
+};

lib/resize.js

@@ -0,0 +1,306 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Weighting to apply to image crop.
+ * @member
+ * @private
+ */
+const gravity = {
+  center: 0,
+  centre: 0,
+  north: 1,
+  east: 2,
+  south: 3,
+  west: 4,
+  northeast: 5,
+  southeast: 6,
+  southwest: 7,
+  northwest: 8
+};
+
+/**
+ * Strategies for automagic crop behaviour.
+ * @member
+ * @private
+ */
+const strategy = {
+  entropy: 16,
+  attention: 17
+};
+
+/**
+ * Reduction kernels.
+ * @member
+ * @private
+ */
+const kernel = {
+  nearest: 'nearest',
+  cubic: 'cubic',
+  lanczos2: 'lanczos2',
+  lanczos3: 'lanczos3'
+};
+
+/**
+ * Enlargement interpolators.
+ * @member
+ * @private
+ */
+const interpolator = {
+  nearest: 'nearest',
+  bilinear: 'bilinear',
+  bicubic: 'bicubic',
+  nohalo: 'nohalo',
+  lbb: 'lbb',
+  locallyBoundedBicubic: 'lbb',
+  vsqbs: 'vsqbs',
+  vertexSplitQuadraticBasisSpline: 'vsqbs'
+};
+
+/**
+ * Resize image to `width` x `height`.
+ * By default, the resized image is centre cropped to the exact size specified.
+ *
+ * Possible reduction kernels are:
+ * - `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+ * - `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
+ * - `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
+ * - `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+ *
+ * Possible enlargement interpolators are:
+ * - `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+ * - `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
+ * - `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
+ * - `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
+ * - `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
+ * - `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
+ *
+ * @example
+ * sharp(inputBuffer)
+ *   .resize(200, 300, {
+ *     kernel: sharp.kernel.lanczos2,
+ *     interpolator: sharp.interpolator.nohalo
+ *   })
+ *   .background('white')
+ *   .embed()
+ *   .toFile('output.tiff')
+ *   .then(function() {
+ *     // output.tiff is a 200 pixels wide and 300 pixels high image
+ *     // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
+ *     // of the image data in inputBuffer
+ *   });
+ *
+ * @param {Number} [width] - pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use `null` or `undefined` to auto-scale the width to match the height.
+ * @param {Number} [height] - pixels high the resultant image should be, between 1 and 16383. Use `null` or `undefined` to auto-scale the height to match the width.
+ * @param {Object} [options]
+ * @param {String} [options.kernel='lanczos3'] - the kernel to use for image reduction.
+ * @param {String} [options.interpolator='bicubic'] - the interpolator to use for image enlargement.
+ * @param {Boolean} [options.centreSampling=false] - use *magick centre sampling convention instead of corner sampling.
+ * @param {Boolean} [options.centerSampling=false] - alternative spelling of centreSampling.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function resize (width, height, options) {
+  if (is.defined(width)) {
+    if (is.integer(width) && is.inRange(width, 1, this.constructor.maximum.width)) {
+      this.options.width = width;
+    } else {
+      throw is.invalidParameterError('width', `integer between 1 and ${this.constructor.maximum.width}`, width);
+    }
+  } else {
+    this.options.width = -1;
+  }
+  if (is.defined(height)) {
+    if (is.integer(height) && is.inRange(height, 1, this.constructor.maximum.height)) {
+      this.options.height = height;
+    } else {
+      throw is.invalidParameterError('height', `integer between 1 and ${this.constructor.maximum.height}`, height);
+    }
+  } else {
+    this.options.height = -1;
+  }
+  if (is.object(options)) {
+    // Kernel
+    if (is.defined(options.kernel)) {
+      if (is.string(kernel[options.kernel])) {
+        this.options.kernel = kernel[options.kernel];
+      } else {
+        throw is.invalidParameterError('kernel', 'valid kernel name', options.kernel);
+      }
+    }
+    // Interpolator
+    if (is.defined(options.interpolator)) {
+      if (is.string(interpolator[options.interpolator])) {
+        this.options.interpolator = interpolator[options.interpolator];
+      } else {
+        throw is.invalidParameterError('interpolator', 'valid interpolator name', options.interpolator);
+      }
+    }
+    // Centre sampling
+    options.centreSampling = is.bool(options.centerSampling) ? options.centerSampling : options.centreSampling;
+    if (is.defined(options.centreSampling)) {
+      this._setBooleanOption('centreSampling', options.centreSampling);
+    }
+  }
+  return this;
+}
+
+/**
+ * Crop the resized image to the exact size specified, the default behaviour.
+ *
+ * Possible attributes of the optional `sharp.gravity` are `north`, `northeast`, `east`, `southeast`, `south`,
+ * `southwest`, `west`, `northwest`, `center` and `centre`.
+ *
+ * The experimental strategy-based approach resizes so one dimension is at its target length
+ * then repeatedly ranks edge regions, discarding the edge with the lowest score based on the selected strategy.
+ * - `entropy`: focus on the region with the highest [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29).
+ * - `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
+ *
+ * @example
+ * const transformer = sharp()
+ *   .resize(200, 200)
+ *   .crop(sharp.strategy.entropy)
+ *   .on('error', function(err) {
+ *     console.log(err);
+ *   });
+ * // Read image data from readableStream
+ * // Write 200px square auto-cropped image data to writableStream
+ * readableStream.pipe(transformer).pipe(writableStream);
+ *
+ * @param {String} [crop='centre'] - A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function crop (crop) {
+  this.options.canvas = 'crop';
+  if (!is.defined(crop)) {
+    // Default
+    this.options.crop = gravity.center;
+  } else if (is.integer(crop) && is.inRange(crop, 0, 8)) {
+    // Gravity (numeric)
+    this.options.crop = crop;
+  } else if (is.string(crop) && is.integer(gravity[crop])) {
+    // Gravity (string)
+    this.options.crop = gravity[crop];
+  } else if (is.integer(crop) && crop >= strategy.entropy) {
+    // Strategy
+    this.options.crop = crop;
+  } else if (is.string(crop) && is.integer(strategy[crop])) {
+    // Strategy (string)
+    this.options.crop = strategy[crop];
+  } else {
+    throw is.invalidParameterError('crop', 'valid crop id/name/strategy', crop);
+  }
+  return this;
+}
+
+/**
+ * Preserving aspect ratio, resize the image to the maximum `width` or `height` specified
+ * then embed on a background of the exact `width` and `height` specified.
+ *
+ * If the background contains an alpha value then WebP and PNG format output images will
+ * contain an alpha channel, even when the input image does not.
+ *
+ * @example
+ * sharp('input.gif')
+ *   .resize(200, 300)
+ *   .background({r: 0, g: 0, b: 0, alpha: 0})
+ *   .embed()
+ *   .toFormat(sharp.format.webp)
+ *   .toBuffer(function(err, outputBuffer) {
+ *     if (err) {
+ *       throw err;
+ *     }
+ *     // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
+ *     // containing a scaled version, embedded on a transparent canvas, of input.gif
+ *   });
+ *
+ * @returns {Sharp}
+ */
+function embed () {
+  this.options.canvas = 'embed';
+  return this;
+}
+
+/**
+ * Preserving aspect ratio, resize the image to be as large as possible
+ * while ensuring its dimensions are less than or equal to the `width` and `height` specified.
+ *
+ * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+ *
+ * @example
+ * sharp(inputBuffer)
+ *   .resize(200, 200)
+ *   .max()
+ *   .toFormat('jpeg')
+ *   .toBuffer()
+ *   .then(function(outputBuffer) {
+ *     // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
+ *     // than 200 pixels regardless of the inputBuffer image dimensions
+ *   });
+ *
+ * @returns {Sharp}
+ */
+function max () {
+  this.options.canvas = 'max';
+  return this;
+}
+
+/**
+ * Preserving aspect ratio, resize the image to be as small as possible
+ * while ensuring its dimensions are greater than or equal to the `width` and `height` specified.
+ *
+ * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
+ *
+ * @returns {Sharp}
+ */
+function min () {
+  this.options.canvas = 'min';
+  return this;
+}
+
+/**
+ * Ignoring the aspect ratio of the input, stretch the image to
+ * the exact `width` and/or `height` provided via `resize`.
+ * @returns {Sharp}
+ */
+function ignoreAspectRatio () {
+  this.options.canvas = 'ignore_aspect';
+  return this;
+}
+
+/**
+ * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
+ * This is equivalent to GraphicsMagick's `>` geometry option:
+ * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
+ * @param {Boolean} [withoutEnlargement=true]
+ * @returns {Sharp}
+*/
+function withoutEnlargement (withoutEnlargement) {
+  this.options.withoutEnlargement = is.bool(withoutEnlargement) ? withoutEnlargement : true;
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with resize-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    resize,
+    crop,
+    embed,
+    max,
+    min,
+    ignoreAspectRatio,
+    withoutEnlargement
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+  // Class attributes
+  Sharp.gravity = gravity;
+  Sharp.strategy = strategy;
+  Sharp.kernel = kernel;
+  Sharp.interpolator = interpolator;
+};

lib/utility.js

@@ -0,0 +1,116 @@
+'use strict';
+
+const is = require('./is');
+const sharp = require('../build/Release/sharp.node');
+
+/**
+ * Gets, or when options are provided sets, the limits of _libvips'_ operation cache.
+ * Existing entries in the cache will be trimmed after any change in limits.
+ * This method always returns cache statistics,
+ * useful for determining how much working memory is required for a particular task.
+ *
+ * @example
+ * const stats = sharp.cache();
+ * @example
+ * sharp.cache( { items: 200 } );
+ * sharp.cache( { files: 0 } );
+ * sharp.cache(false);
+ *
+ * @param {Object|Boolean} options - Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
+ * @param {Number} [options.memory=50] - is the maximum memory in MB to use for this cache
+ * @param {Number} [options.files=20] - is the maximum number of files to hold open
+ * @param {Number} [options.items=100] - is the maximum number of operations to cache
+ * @returns {Object}
+ */
+function cache (options) {
+  if (is.bool(options)) {
+    if (options) {
+      // Default cache settings of 50MB, 20 files, 100 items
+      return sharp.cache(50, 20, 100);
+    } else {
+      return sharp.cache(0, 0, 0);
+    }
+  } else if (is.object(options)) {
+    return sharp.cache(options.memory, options.files, options.items);
+  } else {
+    return sharp.cache();
+  }
+}
+cache(true);
+
+/**
+ * Gets, or when a concurrency is provided sets,
+ * the number of threads _libvips'_ should create to process each image.
+ * The default value is the number of CPU cores.
+ * A value of `0` will reset to this default.
+ *
+ * The maximum number of images that can be processed in parallel
+ * is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
+ *
+ * This method always returns the current concurrency.
+ *
+ * @example
+ * const threads = sharp.concurrency(); // 4
+ * sharp.concurrency(2); // 2
+ * sharp.concurrency(0); // 4
+ *
+ * @param {Number} [concurrency]
+ * @returns {Number} concurrency
+ */
+function concurrency (concurrency) {
+  return sharp.concurrency(is.integer(concurrency) ? concurrency : null);
+}
+
+/**
+ * Provides access to internal task counters.
+ * - queue is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool.
+ * - process is the number of resize tasks currently being processed.
+ *
+ * @example
+ * const counters = sharp.counters(); // { queue: 2, process: 4 }
+ *
+ * @returns {Object}
+ */
+function counters () {
+  return sharp.counters();
+}
+
+/**
+ * Get and set use of SIMD vector unit instructions.
+ * Requires libvips to have been compiled with liborc support.
+ *
+ * Improves the performance of `resize`, `blur` and `sharpen` operations
+ * by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
+ *
+ * This feature is currently off by default but future versions may reverse this.
+ * Versions of liborc prior to 0.4.25 are known to segfault under heavy load.
+ *
+ * @example
+ * const simd = sharp.simd();
+ * // simd is `true` if SIMD is currently enabled
+ * @example
+ * const simd = sharp.simd(true);
+ * // attempts to enable the use of SIMD, returning true if available
+ *
+ * @param {Boolean} [simd=false]
+ * @returns {Boolean}
+ */
+function simd (simd) {
+  return sharp.simd(is.bool(simd) ? simd : null);
+}
+simd(false);
+
+/**
+ * Decorate the Sharp class with utility-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    cache,
+    concurrency,
+    counters,
+    simd
+  ].forEach(function (f) {
+    Sharp[f.name] = f;
+  });
+};

mkdocs.yml

@@ -1,17 +1,25 @@
 site_name: sharp
-site_url: http://sharp.dimens.io/
+site_url: http://sharp.pixelplumbing.com/
 repo_url: https://github.com/lovell/sharp
-site_description: The fastest Node.js module for resizing JPEG, PNG, WebP and TIFF images. Uses the libvips library.
+site_description: High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images
-copyright: <a href="https://dimens.io/">dimens.io</a>
+copyright: <a href="https://pixelplumbing.com/">pixelplumbing.com</a>
-google_analytics: ['UA-13034748-12', 'sharp.dimens.io']
+google_analytics: ['UA-13034748-12', 'sharp.pixelplumbing.com']
 theme: readthedocs
 markdown_extensions:
   - toc:
       permalink: True
-dev_addr: 0.0.0.0:10101
 pages:
   - Home: index.md
   - Installation: install.md
-  - API: api.md
+  - API:
+    - Constructor: api-constructor.md
+    - Input: api-input.md
+    - Output: api-output.md
+    - "Resizing images": api-resize.md
+    - "Compositing images": api-composite.md
+    - "Image operations": api-operation.md
+    - "Colour manipulation": api-colour.md
+    - "Channel manipulation": api-channel.md
+    - Utilities: api-utility.md
   - Performance: performance.md
   - Changelog: changelog.md

package.json

@@ -1,7 +1,9 @@
 {
   "name": "sharp",
-  "version": "0.14.0",
+  "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images",
+  "version": "0.17.3",
   "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://github.com/lovell/sharp",
   "contributors": [
     "Pierre Inglebert <pierre.inglebert@gmail.com>",
     "Jonathan Ong <jonathanrichardong@gmail.com>",
@@ -19,18 +21,29 @@
     "Bernhard K. Weisshuhn <bkw@codingforce.com>",
     "Chris Riley <criley@primedia.com>",
     "David Carley <dacarley@gmail.com>",
-    "John Tobin <john@limelightmobileinc.com>"
+    "John Tobin <john@limelightmobileinc.com>",
+    "Kenton Gray <kentongray@gmail.com>",
+    "Felix Bünemann <Felix.Buenemann@gmail.com>",
+    "Samy Al Zahrani <samyalzahrany@gmail.com>",
+    "Chintan Thakkar <lemnisk8@gmail.com>",
+    "F. Orlando Galashan <frulo@gmx.de>",
+    "Kleis Auke Wolthuizen <info@kleisauke.nl>",
+    "Matt Hirsch <mhirsch@media.mit.edu>",
+    "Matthias Thoemmes <thoemmes@gmail.com>",
+    "Patrick Paskaris <patrick@paskaris.gr>",
+    "Jérémy Lal <kapouer@melix.org>",
+    "Rahul Nanwani <r.nanwani@gmail.com>",
+    "Alice Monday <alice0meta@gmail.com>",
+    "Kristo Jorgenson <kristo.jorgenson@gmail.com>"
   ],
-  "description": "High performance Node.js module to resize JPEG, PNG, WebP and TIFF images using the libvips library",
   "scripts": {
-    "clean": "rm -rf node_modules/ build/ include/ lib/ coverage/ test/fixtures/output.*",
+    "clean": "rm -rf node_modules/ build/ vendor/ coverage/ test/fixtures/output.*",
-    "test": "VIPS_WARNING=0 node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- --slow=5000 --timeout=30000 ./test/unit/*.js",
+    "test": "semistandard && cc && cross-env VIPS_WARNING=0 nyc --reporter=lcov --branches=99 mocha --slow=5000 --timeout=60000 ./test/unit/*.js",
-    "test-win": "node ./node_modules/mocha/bin/mocha --slow=5000 --timeout=30000 ./test/unit/*.js",
     "test-leak": "./test/leak/leak.sh",
-    "test-packaging": "./packaging/test.sh",
+    "test-packaging": "./packaging/test-linux-x64.sh",
-    "test-clean": "rm -rf coverage/ test/fixtures/output.* && npm install && npm test"
+    "docs": "for m in constructor input resize composite operation colour channel output utility; do documentation build --shallow --format=md lib/$m.js >docs/api-$m.md; done"
   },
-  "main": "index.js",
+  "main": "lib/index.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/lovell/sharp"
@@ -40,7 +53,10 @@
     "png",
     "webp",
     "tiff",
+    "gif",
+    "svg",
     "dzi",
+    "image",
     "resize",
     "thumbnail",
     "crop",
@@ -48,30 +64,44 @@
     "vips"
   ],
   "dependencies": {
-    "bluebird": "^3.3.4",
+    "caw": "^2.0.0",
-    "color": "^0.11.1",
+    "color": "^1.0.3",
-    "nan": "^2.2.1",
+    "got": "^6.7.1",
-    "semver": "^5.1.0",
+    "nan": "^2.5.1",
-    "request": "^2.69.0",
+    "semver": "^5.3.0",
     "tar": "^2.2.1"
   },
   "devDependencies": {
-    "async": "^1.5.2",
+    "async": "^2.2.0",
-    "coveralls": "^2.11.9",
+    "bufferutil": "^3.0.0",
-    "exif-reader": "^1.0.0",
+    "cc": "^1.0.0",
-    "icc": "^0.0.2",
+    "cross-env": "^4.0.0",
-    "istanbul": "^0.4.2",
+    "documentation": "^4.0.0-beta.18",
-    "mocha": "^2.4.5",
+    "exif-reader": "^1.0.2",
-    "mocha-jshint": "^2.3.1",
+    "icc": "^1.0.0",
-    "node-cpplint": "^0.4.0",
+    "mocha": "^3.2.0",
-    "rimraf": "^2.5.2",
+    "nyc": "^10.2.0",
-    "bufferutil": "^1.2.1"
+    "rimraf": "^2.5.4",
+    "semistandard": "^10.0.0",
+    "unzip": "^0.1.11"
   },
   "license": "Apache-2.0",
   "config": {
-    "libvips": "8.2.3"
+    "libvips": "8.4.2"
   },
   "engines": {
-    "node": ">=0.10"
+    "node": ">=4"
+  },
+  "semistandard": {
+    "env": [
+      "mocha"
+    ]
+  },
+  "cc": {
+    "linelength": "120",
+    "filter": [
+      "build/include",
+      "runtime/indentation_namespace"
+    ]
   }
 }

packaging/README.md

@@ -0,0 +1,57 @@
+# Packaging scripts
+
+libvips and its dependencies are provided as pre-compiled shared libraries
+for the most common operating systems and CPU architectures.
+
+During `npm install`, these binaries are fetched as tarballs from
+[Bintray](https://dl.bintray.com/lovell/sharp/) via HTTPS
+and stored locally within `node_modules/sharp`.
+
+## Using a custom tarball
+
+A custom tarball stored on the local filesystem can be used instead.
+Place it in the following location, where `x.y.z` is the libvips version,
+`platform` is the value of `process.platform` and
+`arch` is the value of `process.arch` (plus the version number for ARM).
+
+`node_modules/sharp/packaging/libvips-x.y.z-platform-arch.tar.gz`
+
+For example, for libvips v8.3.3 on an ARMv6 Linux machine, use:
+
+`node_modules/sharp/packaging/libvips-8.3.3-linux-armv6.tar.gz`
+
+Remove any `sharp/lib` and `sharp/include` directories
+before running `npm install` again.
+
+## Creating a tarball
+
+Most people will not need to do this; proceed with caution.
+
+The `packaging` directory contains the top-level [build script](build.sh).
+
+### Linux
+
+One [build script](build/lin.sh) is used to (cross-)compile
+the same shared libraries within multiple containers.
+
+* [x64](linux-x64/Dockerfile)
+* [ARMv6](linux-armv6/Dockerfile)
+* [ARMv7-A](linux-armv7/Dockerfile)
+* [ARMv8-A](linux-armv8/Dockerfile)
+
+The QEMU user mode emulation binaries are required to build for
+the ARMv6 platform as the Debian armhf cross-compiler erroneously
+generates unsupported Thumb 2 instructions.
+
+```sh
+sudo apt-get install qemu-user-static
+```
+
+### Windows
+
+The output of libvips' [build-win64](https://github.com/jcupitt/build-win64)
+"web" target is [post-processed](build/win.sh) within a [container](win32-x64/Dockerfile).
+
+### OS X
+
+See [package-libvips-darwin](https://github.com/lovell/package-libvips-darwin).

packaging/arm-build.sh

@@ -1,34 +0,0 @@
-#!/bin/sh
-
-if [ $# -lt 1 ]; then
-  echo "Usage: $0 IP"
-  echo "Build libvips for ARM using Docker, where IP is"
-  echo "the address of a Raspberry Pi running HypriotOS"
-  exit 1
-fi
-IP="$1"
-
-echo "Verifying connectivity to $IP"
-if ! ping -c 1 $IP; then
-  echo "Could not connect to $IP"
-  exit 1
-fi
-
-if ! type sshpass >/dev/null; then
-  echo "Please install sshpass"
-  exit 1
-fi
-
-export SSHPASS=hypriot
-
-echo "Copying arm/Dockerfile and arm/build.sh to device"
-sshpass -e scp -o PreferredAuthentications=password -r arm root@${IP}:/root
-
-echo "Building Raspbian-based container"
-sshpass -e ssh -o PreferredAuthentications=password -t root@${IP} "docker build -t vips-dev-arm arm"
-
-echo "Running arm/build.sh within container"
-sshpass -e ssh -o PreferredAuthentications=password -t root@${IP} "docker run -i -t --rm -v \${PWD}/arm:/arm vips-dev-arm sh -c 'cd /arm && ./build.sh' | tee arm/build.log"
-
-echo "Copying resultant tar.gz file from device"
-sshpass -e scp -o PreferredAuthentications=password root@${IP}:/root/arm/*.tar.gz .

packaging/arm/Dockerfile

@@ -1,5 +0,0 @@
-FROM resin/rpi-raspbian:jessie
-MAINTAINER Lovell Fuller <npm@lovell.info>
-
-# Build dependencies
-RUN apt-get update && apt-get install -y build-essential autoconf libtool nasm gtk-doc-tools texinfo curl

packaging/arm/build.sh

@@ -1,137 +0,0 @@
-#!/bin/sh
-
-# To be run inside a Raspbian container
-
-# Working directories
-DEPS=/deps
-TARGET=/target
-mkdir ${DEPS}
-mkdir ${TARGET}
-
-# Common build paths and flags
-export PKG_CONFIG_PATH="${PKG_CONFIG_PATH}:${TARGET}/lib/pkgconfig"
-export PATH="${PATH}:${TARGET}/bin"
-export CPPFLAGS="-I${TARGET}/include"
-export LDFLAGS="-L${TARGET}/lib"
-export CFLAGS="-O3"
-export CXXFLAGS="-O3"
-
-# Dependency version numbers
-VERSION_ZLIB=1.2.8
-VERSION_FFI=3.2.1
-VERSION_GLIB=2.47.6
-VERSION_XML2=2.9.3
-VERSION_GSF=1.14.34
-VERSION_EXIF=0.6.21
-VERSION_LCMS2=2.7
-VERSION_GM=1.3.23
-VERSION_JPEG=1.4.2
-VERSION_PNG16=1.6.21
-VERSION_WEBP=0.5.0
-VERSION_TIFF=4.0.6
-VERSION_ORC=0.4.25
-VERSION_VIPS=8.2.3
-
-mkdir ${DEPS}/zlib
-curl -Ls http://zlib.net/zlib-${VERSION_ZLIB}.tar.xz | tar xJC ${DEPS}/zlib --strip-components=1
-cd ${DEPS}/zlib
-./configure --prefix=${TARGET} && make install
-rm ${TARGET}/lib/libz.a
-
-mkdir ${DEPS}/ffi
-curl -Ls ftp://sourceware.org/pub/libffi/libffi-${VERSION_FFI}.tar.gz | tar xzC ${DEPS}/ffi --strip-components=1
-cd ${DEPS}/ffi
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-builddir && make install-strip
-
-mkdir ${DEPS}/glib
-curl -Ls https://download.gnome.org/sources/glib/2.47/glib-${VERSION_GLIB}.tar.xz | tar xJC ${DEPS}/glib --strip-components=1
-cd ${DEPS}/glib
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-pcre=internal && make install-strip
-
-mkdir ${DEPS}/xml2
-curl -Ls http://xmlsoft.org/sources/libxml2-${VERSION_XML2}.tar.gz | tar xzC ${DEPS}/xml2 --strip-components=1
-cd ${DEPS}/xml2
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --without-python --with-zlib=${TARGET} && make install-strip
-
-mkdir ${DEPS}/gsf
-curl -Ls https://download.gnome.org/sources/libgsf/1.14/libgsf-${VERSION_GSF}.tar.xz | tar xJC ${DEPS}/gsf --strip-components=1
-cd ${DEPS}/gsf
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/exif
-curl -Ls http://heanet.dl.sourceforge.net/project/libexif/libexif/${VERSION_EXIF}/libexif-${VERSION_EXIF}.tar.bz2 | tar xjC ${DEPS}/exif --strip-components=1
-cd ${DEPS}/exif
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/lcms2
-curl -Ls http://heanet.dl.sourceforge.net/project/lcms/lcms/${VERSION_LCMS2}/lcms2-${VERSION_LCMS2}.tar.gz | tar xzC ${DEPS}/lcms2 --strip-components=1
-cd ${DEPS}/lcms2
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/gm
-curl -Ls http://heanet.dl.sourceforge.net/project/graphicsmagick/graphicsmagick/${VERSION_GM}/GraphicsMagick-${VERSION_GM}.tar.xz | tar xJC ${DEPS}/gm --strip-components=1
-cd ${DEPS}/gm
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --without-magick-plus-plus && make install-strip
-
-mkdir ${DEPS}/jpeg
-curl -Ls http://heanet.dl.sourceforge.net/project/libjpeg-turbo/${VERSION_JPEG}/libjpeg-turbo-${VERSION_JPEG}.tar.gz | tar xzC ${DEPS}/jpeg --strip-components=1
-cd ${DEPS}/jpeg
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-jpeg8 --without-turbojpeg && make install-strip
-
-mkdir ${DEPS}/png16
-curl -Ls http://heanet.dl.sourceforge.net/project/libpng/libpng16/${VERSION_PNG16}/libpng-${VERSION_PNG16}.tar.xz | tar xJC ${DEPS}/png16 --strip-components=1
-cd ${DEPS}/png16
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/webp
-curl -Ls http://downloads.webmproject.org/releases/webp/libwebp-${VERSION_WEBP}.tar.gz | tar xzC ${DEPS}/webp --strip-components=1
-cd ${DEPS}/webp
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/tiff
-curl -Ls http://download.osgeo.org/libtiff/tiff-${VERSION_TIFF}.tar.gz | tar xzC ${DEPS}/tiff --strip-components=1
-cd ${DEPS}/tiff
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-rm ${TARGET}/lib/libtiffxx*
-
-mkdir ${DEPS}/orc
-curl -Ls http://gstreamer.freedesktop.org/data/src/orc/orc-${VERSION_ORC}.tar.xz | tar xJC ${DEPS}/orc --strip-components=1
-cd ${DEPS}/orc
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-mkdir ${DEPS}/vips
-curl -Ls http://www.vips.ecs.soton.ac.uk/supported/8.2/vips-${VERSION_VIPS}.tar.gz | tar xzC ${DEPS}/vips --strip-components=1
-cd ${DEPS}/vips
-./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-debug --disable-introspection --without-python --without-fftw --with-magickpackage=GraphicsMagick \
-  --with-zip-includes=${TARGET}/include --with-zip-libraries=${TARGET}/lib \
-  --with-jpeg-includes=${TARGET}/include --with-jpeg-libraries=${TARGET}/lib \
-  && make install-strip
-
-# Remove the old C++ bindings
-cd ${TARGET}/include
-rm -rf vips/vipsc++.h vips/vipscpp.h
-cd ${TARGET}/lib
-rm -rf pkgconfig .libs *.la libvipsCC*
-
-# Create JSON file of version numbers
-cd ${TARGET}
-echo "{\n\
-  \"exif\": \"${VERSION_EXIF}\",\n\
-  \"ffi\": \"${VERSION_FFI}\",\n\
-  \"glib\": \"${VERSION_GLIB}\",\n\
-  \"gsf\": \"${VERSION_GSF}\",\n\
-  \"jpeg\": \"${VERSION_JPEG}\",\n\
-  \"lcms\": \"${VERSION_LCMS2}\",\n\
-  \"gm\": \"${VERSION_GM}\",\n\
-  \"orc\": \"${VERSION_ORC}\",\n\
-  \"png\": \"${VERSION_PNG16}\",\n\
-  \"tiff\": \"${VERSION_TIFF}\",\n\
-  \"vips\": \"${VERSION_VIPS}\"\n\
-  \"webp\": \"${VERSION_WEBP}\",\n\
-  \"xml\": \"${VERSION_XML2}\",\n\
-  \"zlib\": \"${VERSION_ZLIB}\",\n\
-}" >lib/versions.json
-
-# Create .tar.gz
-GZIP=-9 tar czf /arm/libvips-${VERSION_VIPS}-arm.tar.gz include lib

packaging/build.sh

@@ -1,30 +1,43 @@
 #!/bin/sh
+set -e
 
-VERSION_VIPS=8.2.3
+if [ $# -lt 1 ]; then
+  echo
+  echo "Usage: $0 VERSION [PLATFORM]"
+  echo "Build shared libraries for libvips and its dependencies via containers"
+  echo
+  echo "Please specify the libvips VERSION, e.g. 8.3.3"
+  echo
+  echo "Optionally build for only one PLATFORM, defaults to building for all"
+  echo "Possible values for PLATFORM are: win32-x64, linux-x64, linux-armv6,"
+  echo "linux-armv7, linux-armv8"
+  echo
+  exit 1
+fi
+VERSION_VIPS="$1"
+PLATFORM="${2:-all}"
 
 # Is docker available?
-
 if ! type docker >/dev/null; then
   echo "Please install docker"
   exit 1
 fi
 
-# TODO: docker v1.9.0 will allow build-time args - https://github.com/docker/docker/pull/15182
+# Windows (x64)
+if [ $PLATFORM = "all" ] || [ $PLATFORM = "win32-x64" ]; then
+  echo "Building win32-x64..."
+  docker build -t vips-dev-win32-x64 win32-x64
+  docker run --rm -e "VERSION_VIPS=${VERSION_VIPS}" -v $PWD:/packaging vips-dev-win32-x64 sh -c "/packaging/build/win.sh"
+fi
 
-# Windows
+# Linux (x64, ARMv6, ARMv7, ARMv8)
-
+for flavour in linux-x64 linux-armv6 linux-armv7 linux-armv8; do
-docker build -t vips-dev-win win
+  if [ $PLATFORM = "all" ] || [ $PLATFORM = $flavour ]; then
-WIN_CONTAINER_ID=$(docker run -d vips-dev-win)
+    echo "Building $flavour..."
-docker cp "${WIN_CONTAINER_ID}:/libvips-${VERSION_VIPS}-win.tar.gz" .
+    docker build -t vips-dev-$flavour $flavour
-docker rm "${WIN_CONTAINER_ID}"
+    docker run --rm -e "VERSION_VIPS=${VERSION_VIPS}" -v $PWD:/packaging vips-dev-$flavour sh -c "/packaging/build/lin.sh"
-
+  fi
-# Linux
+done
-
-docker build -t vips-dev-lin lin
-LIN_CONTAINER_ID=$(docker run -d vips-dev-lin)
-docker cp "${LIN_CONTAINER_ID}:/libvips-${VERSION_VIPS}-lin.tar.gz" .
-docker rm "${LIN_CONTAINER_ID}"
-
-# Checksums
 
+# Display checksums
 sha256sum *.tar.gz

packaging/build/lin.sh

@@ -0,0 +1,239 @@
+#!/bin/sh
+set -e
+
+# Working directories
+DEPS=/deps
+TARGET=/target
+mkdir ${DEPS}
+mkdir ${TARGET}
+
+# Common build paths and flags
+export PKG_CONFIG_PATH="${PKG_CONFIG_PATH}:${TARGET}/lib/pkgconfig"
+export PATH="${PATH}:${TARGET}/bin"
+export CPPFLAGS="-I${TARGET}/include"
+export LDFLAGS="-L${TARGET}/lib"
+export CFLAGS="${FLAGS}"
+export CXXFLAGS="${FLAGS}"
+
+# Dependency version numbers
+VERSION_ZLIB=1.2.10
+VERSION_FFI=3.2.1
+VERSION_GLIB=2.50.1
+VERSION_XML2=2.9.4
+VERSION_GSF=1.14.40
+VERSION_EXIF=0.6.21
+VERSION_LCMS2=2.8
+VERSION_JPEG=1.5.1
+VERSION_PNG16=1.6.28
+VERSION_WEBP=0.5.1
+VERSION_TIFF=4.0.6
+VERSION_ORC=0.4.26
+VERSION_GDKPIXBUF=2.36.0
+VERSION_FREETYPE=2.7
+VERSION_FONTCONFIG=2.12.1
+VERSION_HARFBUZZ=1.3.2
+VERSION_PIXMAN=0.34.0
+VERSION_CAIRO=1.14.6
+VERSION_PANGO=1.40.3
+VERSION_CROCO=0.6.11
+VERSION_SVG=2.40.16
+VERSION_GIF=5.1.4
+
+# Least out-of-sync Sourceforge mirror
+SOURCEFORGE_MIRROR=netix
+
+mkdir ${DEPS}/zlib
+curl -Ls http://zlib.net/zlib-${VERSION_ZLIB}.tar.xz | tar xJC ${DEPS}/zlib --strip-components=1
+cd ${DEPS}/zlib
+./configure --prefix=${TARGET} --uname=linux
+make install
+rm ${TARGET}/lib/libz.a
+
+mkdir ${DEPS}/ffi
+curl -Ls ftp://sourceware.org/pub/libffi/libffi-${VERSION_FFI}.tar.gz | tar xzC ${DEPS}/ffi --strip-components=1
+cd ${DEPS}/ffi
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-builddir
+make install-strip
+
+mkdir ${DEPS}/glib
+curl -Ls https://download.gnome.org/sources/glib/2.50/glib-${VERSION_GLIB}.tar.xz | tar xJC ${DEPS}/glib --strip-components=1
+cd ${DEPS}/glib
+echo glib_cv_stack_grows=no >>glib.cache
+echo glib_cv_uscore=no >>glib.cache
+./configure --cache-file=glib.cache --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-pcre=internal --disable-libmount
+make install-strip
+
+mkdir ${DEPS}/xml2
+curl -Ls http://xmlsoft.org/sources/libxml2-${VERSION_XML2}.tar.gz | tar xzC ${DEPS}/xml2 --strip-components=1
+cd ${DEPS}/xml2
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
+  --without-python --without-debug --without-docbook --without-ftp --without-html --without-legacy \
+  --without-pattern --without-push --without-regexps --without-schemas --without-schematron --with-zlib=${TARGET}
+make install-strip
+
+mkdir ${DEPS}/gsf
+curl -Ls https://download.gnome.org/sources/libgsf/1.14/libgsf-${VERSION_GSF}.tar.xz | tar xJC ${DEPS}/gsf --strip-components=1
+cd ${DEPS}/gsf
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/exif
+curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/libexif/libexif/${VERSION_EXIF}/libexif-${VERSION_EXIF}.tar.bz2 | tar xjC ${DEPS}/exif --strip-components=1
+cd ${DEPS}/exif
+autoreconf -fiv
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/lcms2
+curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/lcms/lcms/${VERSION_LCMS2}/lcms2-${VERSION_LCMS2}.tar.gz | tar xzC ${DEPS}/lcms2 --strip-components=1
+cd ${DEPS}/lcms2
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/jpeg
+curl -Ls https://github.com/libjpeg-turbo/libjpeg-turbo/archive/${VERSION_JPEG}.tar.gz | tar xzC ${DEPS}/jpeg --strip-components=1
+cd ${DEPS}/jpeg
+autoreconf -fiv
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-jpeg8 --without-turbojpeg
+make install-strip
+
+mkdir ${DEPS}/png16
+curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/libpng/libpng16/${VERSION_PNG16}/libpng-${VERSION_PNG16}.tar.xz | tar xJC ${DEPS}/png16 --strip-components=1
+cd ${DEPS}/png16
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/webp
+curl -Ls http://downloads.webmproject.org/releases/webp/libwebp-${VERSION_WEBP}.tar.gz | tar xzC ${DEPS}/webp --strip-components=1
+cd ${DEPS}/webp
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-neon
+make install-strip
+
+mkdir ${DEPS}/tiff
+curl -Ls http://download.osgeo.org/libtiff/tiff-${VERSION_TIFF}.tar.gz | tar xzC ${DEPS}/tiff --strip-components=1
+cd ${DEPS}/tiff
+# Apply patches for various libtiff security vulnerabilities reported since v4.0.6
+VERSION_TIFF_GIT_MASTER_SHA=$(curl -Ls https://api.github.com/repos/vadz/libtiff/git/refs/heads/master | jq -r '.object.sha' | head -c7)
+curl -Ls https://github.com/vadz/libtiff/compare/Release-v4-0-6...master.patch | patch -p1 -t || true
+if [ -n "${CHOST}" ]; then autoreconf -fiv; fi
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-mdi --disable-pixarlog --disable-cxx
+make install-strip
+
+mkdir ${DEPS}/orc
+curl -Ls http://gstreamer.freedesktop.org/data/src/orc/orc-${VERSION_ORC}.tar.xz | tar xJC ${DEPS}/orc --strip-components=1
+cd ${DEPS}/orc
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+cd ${TARGET}/lib
+rm -rf liborc-test-*
+
+mkdir ${DEPS}/gdkpixbuf
+curl -Ls https://download.gnome.org/sources/gdk-pixbuf/2.36/gdk-pixbuf-${VERSION_GDKPIXBUF}.tar.xz | tar xJC ${DEPS}/gdkpixbuf --strip-components=1
+cd ${DEPS}/gdkpixbuf
+LD_LIBRARY_PATH=${TARGET}/lib \
+./configure --cache-file=gdkpixbuf.cache --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-introspection --disable-modules --disable-gio-sniffing --without-libtiff --without-gdiplus --with-included-loaders=png,jpeg
+make install-strip
+
+mkdir ${DEPS}/freetype
+curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/freetype/freetype2/${VERSION_FREETYPE}/freetype-${VERSION_FREETYPE}.tar.gz | tar xzC ${DEPS}/freetype --strip-components=1
+cd ${DEPS}/freetype
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static
+make install
+
+mkdir ${DEPS}/fontconfig
+curl -Ls https://www.freedesktop.org/software/fontconfig/release/fontconfig-${VERSION_FONTCONFIG}.tar.bz2 | tar xjC ${DEPS}/fontconfig --strip-components=1
+cd ${DEPS}/fontconfig
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --enable-libxml2 --sysconfdir=/etc
+make install-strip
+
+mkdir ${DEPS}/harfbuzz
+curl -Ls https://www.freedesktop.org/software/harfbuzz/release/harfbuzz-${VERSION_HARFBUZZ}.tar.bz2 | tar xjC ${DEPS}/harfbuzz --strip-components=1
+cd ${DEPS}/harfbuzz
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/pixman
+curl -Ls http://cairographics.org/releases/pixman-${VERSION_PIXMAN}.tar.gz | tar xzC ${DEPS}/pixman --strip-components=1
+cd ${DEPS}/pixman
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-libpng --disable-arm-iwmmxt
+make install-strip
+
+mkdir ${DEPS}/cairo
+curl -Ls http://cairographics.org/releases/cairo-${VERSION_CAIRO}.tar.xz | tar xJC ${DEPS}/cairo --strip-components=1
+cd ${DEPS}/cairo
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
+  --disable-xlib --disable-xcb --disable-quartz --disable-win32 --disable-egl --disable-glx --disable-wgl \
+  --disable-script --disable-ps --disable-gobject --disable-trace --disable-interpreter
+make install-strip
+
+mkdir ${DEPS}/pango
+curl -Ls https://download.gnome.org/sources/pango/1.40/pango-${VERSION_PANGO}.tar.xz | tar xJC ${DEPS}/pango --strip-components=1
+cd ${DEPS}/pango
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/croco
+curl -Ls https://download.gnome.org/sources/libcroco/0.6/libcroco-${VERSION_CROCO}.tar.xz | tar xJC ${DEPS}/croco --strip-components=1
+cd ${DEPS}/croco
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/svg
+curl -Ls https://download.gnome.org/sources/librsvg/2.40/librsvg-${VERSION_SVG}.tar.xz | tar xJC ${DEPS}/svg --strip-components=1
+cd ${DEPS}/svg
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-introspection --disable-tools --disable-pixbuf-loader
+make install-strip
+
+mkdir ${DEPS}/gif
+curl -Ls http://${SOURCEFORGE_MIRROR}.dl.sourceforge.net/project/giflib/giflib-${VERSION_GIF}.tar.gz | tar xzC ${DEPS}/gif --strip-components=1
+cd ${DEPS}/gif
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
+make install-strip
+
+mkdir ${DEPS}/vips
+curl -Ls http://www.vips.ecs.soton.ac.uk/supported/8.4/vips-${VERSION_VIPS}.tar.gz | tar xzC ${DEPS}/vips --strip-components=1
+cd ${DEPS}/vips
+./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
+  --disable-debug --disable-introspection --without-python --without-fftw \
+  --without-magick --without-pangoft2 --without-ppm --without-analyze --without-radiance \
+  --with-zip-includes=${TARGET}/include --with-zip-libraries=${TARGET}/lib \
+  --with-jpeg-includes=${TARGET}/include --with-jpeg-libraries=${TARGET}/lib
+make install-strip
+
+# Remove the old C++ bindings
+cd ${TARGET}/include
+rm -rf vips/vipsc++.h vips/vipscpp.h
+cd ${TARGET}/lib
+rm -rf pkgconfig .libs *.la libvipsCC*
+
+# Create JSON file of version numbers
+cd ${TARGET}
+echo "{\n\
+  \"cairo\": \"${VERSION_CAIRO}\",\n\
+  \"croco\": \"${VERSION_CROCO}\",\n\
+  \"exif\": \"${VERSION_EXIF}\",\n\
+  \"ffi\": \"${VERSION_FFI}\",\n\
+  \"fontconfig\": \"${VERSION_FONTCONFIG}\",\n\
+  \"freetype\": \"${VERSION_FREETYPE}\",\n\
+  \"gdkpixbuf\": \"${VERSION_GDKPIXBUF}\",\n\
+  \"gif\": \"${VERSION_GIF}\",\n\
+  \"glib\": \"${VERSION_GLIB}\",\n\
+  \"gsf\": \"${VERSION_GSF}\",\n\
+  \"harfbuzz\": \"${VERSION_HARFBUZZ}\",\n\
+  \"jpeg\": \"${VERSION_JPEG}\",\n\
+  \"lcms\": \"${VERSION_LCMS2}\",\n\
+  \"orc\": \"${VERSION_ORC}\",\n\
+  \"pango\": \"${VERSION_PANGO}\",\n\
+  \"pixman\": \"${VERSION_PIXMAN}\",\n\
+  \"png\": \"${VERSION_PNG16}\",\n\
+  \"svg\": \"${VERSION_SVG}\",\n\
+  \"tiff\": \"${VERSION_TIFF}-${VERSION_TIFF_GIT_MASTER_SHA}\",\n\
+  \"vips\": \"${VERSION_VIPS}\",\n\
+  \"webp\": \"${VERSION_WEBP}\",\n\
+  \"xml\": \"${VERSION_XML2}\",\n\
+  \"zlib\": \"${VERSION_ZLIB}\"\n\
+}" >lib/versions.json
+
+# Create .tar.gz
+tar czf /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz include lib
+advdef --recompress --shrink-insane /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz

packaging/build/win.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+
+# Fetch and unzip
+mkdir /vips
+cd /vips
+curl -L -O https://github.com/lovell/build-win64/releases/download/v${VERSION_VIPS}/vips-dev-w64-web-${VERSION_VIPS}.zip
+unzip vips-dev-w64-web-${VERSION_VIPS}.zip
+
+# Clean and zip
+cd /vips/vips-dev-8.4
+rm bin/libvipsCC-42.dll bin/libvips-cpp-42.dll bin/libgsf-win32-1-114.dll
+cp bin/*.dll lib/
+cp -r lib64/* lib/
+
+# Temp patch for __declspec ordering
+curl -L -o include/vips/VImage8.h https://raw.githubusercontent.com/lovell/libvips/e1aef0445bf123d2de000bc7f2ef97b9f788eea0/cplusplus/include/vips/VImage8.h
+
+echo "Creating tarball"
+tar czf /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz include lib/glib-2.0 lib/libvips.lib lib/libglib-2.0.lib lib/libgobject-2.0.lib lib/*.dll
+echo "Shrinking tarball"
+advdef --recompress --shrink-insane /packaging/libvips-${VERSION_VIPS}-${PLATFORM}.tar.gz

packaging/lin/Dockerfile

@@ -1,139 +0,0 @@
-FROM debian:wheezy
-MAINTAINER Lovell Fuller <npm@lovell.info>
-
-# Build dependencies
-RUN apt-get update && apt-get install -y build-essential autoconf libtool nasm gtk-doc-tools texinfo
-
-# Create working directories
-ENV DEPS=/deps \
-    TARGET=/target
-RUN mkdir ${DEPS} && mkdir ${TARGET}
-
-# Common build paths and flags
-ENV PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:${TARGET}/lib/pkgconfig \
-    PATH=${PATH}:${TARGET}/bin \
-    CPPFLAGS=-I${TARGET}/include \
-    LDFLAGS=-L${TARGET}/lib \
-    CFLAGS="-O3" \
-    CXXFLAGS="-O3"
-
-# Dependency version numbers
-ENV VERSION_ZLIB=1.2.8 \
-    VERSION_FFI=3.2.1 \
-    VERSION_GLIB=2.47.6 \
-    VERSION_XML2=2.9.3 \
-    VERSION_GSF=1.14.34 \
-    VERSION_EXIF=0.6.21 \
-    VERSION_LCMS2=2.7 \
-    VERSION_GM=1.3.23 \
-    VERSION_JPEG=1.4.2 \
-    VERSION_PNG16=1.6.21 \
-    VERSION_WEBP=0.5.0 \
-    VERSION_TIFF=4.0.6 \
-    VERSION_ORC=0.4.25 \
-    VERSION_VIPS=8.2.3
-
-RUN mkdir ${DEPS}/zlib
-RUN curl -Ls http://zlib.net/zlib-${VERSION_ZLIB}.tar.xz | tar xJC ${DEPS}/zlib --strip-components=1
-WORKDIR ${DEPS}/zlib
-RUN ./configure --prefix=${TARGET} && make install
-RUN rm ${TARGET}/lib/libz.a
-
-RUN mkdir ${DEPS}/ffi
-RUN curl -Ls ftp://sourceware.org/pub/libffi/libffi-${VERSION_FFI}.tar.gz | tar xzC ${DEPS}/ffi --strip-components=1
-WORKDIR ${DEPS}/ffi
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --disable-builddir && make install-strip
-
-RUN mkdir ${DEPS}/glib
-RUN curl -Ls https://download.gnome.org/sources/glib/2.47/glib-${VERSION_GLIB}.tar.xz | tar xJC ${DEPS}/glib --strip-components=1
-WORKDIR ${DEPS}/glib
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-pcre=internal && make install-strip
-
-RUN mkdir ${DEPS}/xml2
-RUN curl -Ls http://xmlsoft.org/sources/libxml2-${VERSION_XML2}.tar.gz | tar xzC ${DEPS}/xml2 --strip-components=1
-WORKDIR ${DEPS}/xml2
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --without-python --with-zlib=${TARGET} && make install-strip
-
-RUN mkdir ${DEPS}/gsf
-RUN curl -Ls https://download.gnome.org/sources/libgsf/1.14/libgsf-${VERSION_GSF}.tar.xz | tar xJC ${DEPS}/gsf --strip-components=1
-WORKDIR ${DEPS}/gsf
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/exif
-RUN curl -Ls http://heanet.dl.sourceforge.net/project/libexif/libexif/${VERSION_EXIF}/libexif-${VERSION_EXIF}.tar.bz2 | tar xjC ${DEPS}/exif --strip-components=1
-WORKDIR ${DEPS}/exif
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/lcms2
-RUN curl -Ls http://heanet.dl.sourceforge.net/project/lcms/lcms/${VERSION_LCMS2}/lcms2-${VERSION_LCMS2}.tar.gz | tar xzC ${DEPS}/lcms2 --strip-components=1
-WORKDIR ${DEPS}/lcms2
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/gm
-RUN curl -Ls http://heanet.dl.sourceforge.net/project/graphicsmagick/graphicsmagick/${VERSION_GM}/GraphicsMagick-${VERSION_GM}.tar.xz | tar xJC ${DEPS}/gm --strip-components=1
-WORKDIR ${DEPS}/gm
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --without-magick-plus-plus && make install-strip
-
-RUN mkdir ${DEPS}/jpeg
-RUN curl -Ls http://heanet.dl.sourceforge.net/project/libjpeg-turbo/${VERSION_JPEG}/libjpeg-turbo-${VERSION_JPEG}.tar.gz | tar xzC ${DEPS}/jpeg --strip-components=1
-WORKDIR ${DEPS}/jpeg
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --with-jpeg8 --without-turbojpeg && make install-strip
-
-RUN mkdir ${DEPS}/png16
-RUN curl -Ls http://heanet.dl.sourceforge.net/project/libpng/libpng16/${VERSION_PNG16}/libpng-${VERSION_PNG16}.tar.xz | tar xJC ${DEPS}/png16 --strip-components=1
-WORKDIR ${DEPS}/png16
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/webp
-RUN curl -Ls http://downloads.webmproject.org/releases/webp/libwebp-${VERSION_WEBP}.tar.gz | tar xzC ${DEPS}/webp --strip-components=1
-WORKDIR ${DEPS}/webp
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/tiff
-RUN curl -Ls http://download.osgeo.org/libtiff/tiff-${VERSION_TIFF}.tar.gz | tar xzC ${DEPS}/tiff --strip-components=1
-WORKDIR ${DEPS}/tiff
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-RUN rm ${TARGET}/lib/libtiffxx*
-
-RUN mkdir ${DEPS}/orc
-RUN curl -Ls http://gstreamer.freedesktop.org/data/src/orc/orc-${VERSION_ORC}.tar.xz | tar xJC ${DEPS}/orc --strip-components=1
-WORKDIR ${DEPS}/orc
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking && make install-strip
-
-RUN mkdir ${DEPS}/vips
-RUN curl -Ls http://www.vips.ecs.soton.ac.uk/supported/8.2/vips-${VERSION_VIPS}.tar.gz | tar xzC ${DEPS}/vips --strip-components=1
-WORKDIR ${DEPS}/vips
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking \
-  --disable-debug --disable-introspection --without-python --without-fftw --with-magickpackage=GraphicsMagick \
-  --with-zip-includes=${TARGET}/include --with-zip-libraries=${TARGET}/lib \
-  --with-jpeg-includes=${TARGET}/include --with-jpeg-libraries=${TARGET}/lib \
-  && make install-strip
-
-# Remove the old C++ bindings
-WORKDIR ${TARGET}/include
-RUN rm -rf vips/vipsc++.h vips/vipscpp.h
-WORKDIR ${TARGET}/lib
-RUN rm -rf pkgconfig .libs *.la libvipsCC*
-
-# Create JSON file of version numbers
-WORKDIR ${TARGET}
-RUN echo "{\n\
-  \"exif\": \"${VERSION_EXIF}\",\n\
-  \"ffi\": \"${VERSION_FFI}\",\n\
-  \"glib\": \"${VERSION_GLIB}\",\n\
-  \"gsf\": \"${VERSION_GSF}\",\n\
-  \"jpeg\": \"${VERSION_JPEG}\",\n\
-  \"lcms\": \"${VERSION_LCMS2}\",\n\
-  \"gm\": \"${VERSION_GM}\",\n\
-  \"orc\": \"${VERSION_ORC}\",\n\
-  \"png\": \"${VERSION_PNG16}\",\n\
-  \"tiff\": \"${VERSION_TIFF}\",\n\
-  \"vips\": \"${VERSION_VIPS}\"\n\
-  \"webp\": \"${VERSION_WEBP}\",\n\
-  \"xml\": \"${VERSION_XML2}\",\n\
-  \"zlib\": \"${VERSION_ZLIB}\",\n\
-}" >lib/versions.json
-
-# Create .tar.gz
-WORKDIR ${TARGET}
-RUN GZIP=-9 tar czf /libvips-${VERSION_VIPS}-lin.tar.gz include lib

packaging/linux-armv6/Dockerfile

@@ -0,0 +1,15 @@
+FROM socialdefect/raspbian-jessie-core
+MAINTAINER Lovell Fuller <npm@lovell.info>
+
+# Create Rasbian-based container suitable for compiling Linux ARMv6 binaries
+# Requires the QEMU user mode emulation binaries on the host machine
+
+# Build dependencies
+RUN \
+  apt-get update && \
+  apt-get install -y build-essential curl autoconf libtool nasm gtk-doc-tools texinfo advancecomp libglib2.0-dev jq
+
+# Compiler settings
+ENV \
+  PLATFORM=linux-armv6 \
+  FLAGS="-Os"

packaging/linux-armv7/Dockerfile

@@ -0,0 +1,20 @@
+FROM debian:jessie
+MAINTAINER Lovell Fuller <npm@lovell.info>
+
+# Create Debian-based container suitable for cross-compiling Linux ARMv7-A binaries
+
+# Build dependencies
+RUN \
+  apt-get update && \
+  apt-get install -y curl && \
+  echo "deb http://emdebian.org/tools/debian/ jessie main" | tee /etc/apt/sources.list.d/crosstools.list && \
+  curl http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add - && \
+  dpkg --add-architecture armhf && \
+  apt-get update && \
+  apt-get install -y crossbuild-essential-armhf autoconf libtool nasm gtk-doc-tools texinfo advancecomp libglib2.0-dev jq
+
+# Compiler settings
+ENV \
+  PLATFORM=linux-armv7 \
+  CHOST=arm-linux-gnueabihf \
+  FLAGS="-marm -march=armv7-a -mfpu=neon-vfpv4 -mfloat-abi=hard -Os"

packaging/linux-armv8/Dockerfile

@@ -0,0 +1,18 @@
+FROM debian:stretch
+MAINTAINER Lovell Fuller <npm@lovell.info>
+
+# Create Debian-based container suitable for cross-compiling Linux ARMv8-A binaries
+
+# Build dependencies
+RUN \
+  apt-get update && \
+  apt-get install -y curl && \
+  dpkg --add-architecture arm64 && \
+  apt-get update && \
+  apt-get install -y crossbuild-essential-arm64 autoconf libtool nasm gtk-doc-tools texinfo advancecomp libglib2.0-dev jq
+
+# Compiler settings
+ENV \
+  PLATFORM=linux-armv8 \
+  CHOST=aarch64-linux-gnu \
+  FLAGS="-march=armv8-a -Os"

packaging/linux-x64/Dockerfile

@@ -0,0 +1,16 @@
+FROM debian:wheezy
+MAINTAINER Lovell Fuller <npm@lovell.info>
+
+# Create Debian-based container suitable for building Linux x64 binaries
+
+# Build dependencies
+RUN \
+  echo "deb http://ftp.debian.org/debian wheezy-backports main" | tee /etc/apt/sources.list.d/wheezy-backports.list && \
+  apt-get update && \
+  apt-get install -y build-essential autoconf libtool nasm gtk-doc-tools texinfo advancecomp && \
+  apt-get -t wheezy-backports install -y jq
+
+# Compiler settings
+ENV \
+  PLATFORM="linux-x64" \
+  FLAGS="-O3"

packaging/test-linux-arm.sh

@@ -22,7 +22,7 @@ fi
 export SSHPASS=hypriot
 
 echo "Copying sharp source to device"
-sshpass -e scp -o PreferredAuthentications=password -r ../../sharp root@${IP}:/root/sharp
+sshpass -e scp -o PreferredAuthentications=password -r ../../sharp pirate@${IP}:/home/pirate/sharp
 
 echo "Compile and test within container"
-sshpass -e ssh -o PreferredAuthentications=password -t root@${IP} "docker run -i -t --rm -v \${PWD}/sharp:/s hypriot/rpi-node:5 sh -c 'cd /s && npm install --unsafe-perm && npm test'"
+sshpass -e ssh -o PreferredAuthentications=password -t pirate@${IP} "docker run --rm -v \${PWD}/sharp:/s hypriot/rpi-node:6 sh -c 'cd /s && npm install --unsafe-perm && npm test'"

packaging/test-linux-x64.sh

@@ -6,34 +6,33 @@ if ! type docker >/dev/null; then
   exit 1
 fi
 
+version_node=6.3.0
+
 test="npm run clean; npm install --unsafe-perm; npm test"
 
 # Debian 7, 8
-# Ubuntu 12.04, 14.04
+# Ubuntu 14.04
-for dist in wheezy jessie precise trusty; do
+for dist in wheezy jessie trusty; do
   echo "Testing $dist..."
-  if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/$dist:0.12 >packaging/$dist.log 2>&1 sh -c "cd /v; ./packaging/test/debian.sh; $test";
+  if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/$dist:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; ./packaging/test/debian.sh; $test";
   then echo "$dist OK"
   else echo "$dist fail" && cat packaging/$dist.log
   fi
 done
 
-# Centos 6
-echo "Testing centos6..."
-if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/centos6:0.12 >packaging/centos6.log 2>&1 sh -c "cd /v; source ./packaging/test/centos6.sh; ./preinstall.sh; $test";
-then echo "centos6 OK"
-else echo "centos6 fail" && cat packaging/centos6.log
-fi
-
 # Centos 7
-# Fedora 20, 21
+echo "Testing centos7..."
-for dist in centos7 fedora20 fedora21; do
+if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/centos7:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
-  echo "Testing $dist..."
+then echo "centos7 OK"
-  if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/$dist:0.12 >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
+else echo "centos7 fail" && cat packaging/$dist.log
-  then echo "$dist OK"
+fi
-  else echo "$dist fail" && cat packaging/$dist.log
+
-  fi
+# Fedora 22
-done
+echo "Testing fedora22..."
+if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/fedora22:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
+then echo "fedora22 OK"
+else echo "fedora22 fail" && cat packaging/$dist.log
+fi
 
 # openSUSE 13.2
 echo "Testing opensuse..."
@@ -44,7 +43,7 @@ fi
 
 # Archlinux 2015.06.01
 echo "Testing archlinux..."
-if docker run -i -t --rm -v $PWD:/v base/archlinux:2015.06.01 >packaging/archlinux.log 2>&1 sh -c "cd /v; ./packaging/test/archlinux.sh; $test";
+if docker run -i -t --rm -v $PWD:/v pritunl/archlinux:latest >packaging/archlinux.log 2>&1 sh -c "cd /v; ./packaging/test/archlinux.sh; $test";
 then echo "archlinux OK"
 else echo "archlinux fail" && cat packaging/archlinux.log
 fi

packaging/test/alpine.sh

@@ -3,5 +3,5 @@
 # Install build dependencies
 apk add --update make gcc g++ python nodejs
 
-# Install libvips with build headers and dependencies
+# Install libvips from aports/testing
-apk add libvips-dev --update --repository https://s3.amazonaws.com/wjordan-apk --allow-untrusted
+apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing vips-dev

packaging/test/centos6.sh

@@ -1,8 +0,0 @@
-#!/bin/sh
-
-# Install C++11 compatible version of g++ on Centos 6
-curl -o /etc/yum.repos.d/devtools-1.1.repo http://people.centos.org/tru/devtools-1.1/devtools-1.1.repo
-yum install -y devtoolset-1.1
-export CC=/opt/centos/devtoolset-1.1/root/usr/bin/gcc
-export CPP=/opt/centos/devtoolset-1.1/root/usr/bin/cpp
-export CXX=/opt/centos/devtoolset-1.1/root/usr/bin/c++

packaging/win/Dockerfile

@@ -1,20 +0,0 @@
-FROM ubuntu:precise
-MAINTAINER Lovell Fuller <npm@lovell.info>
-
-RUN apt-get update && apt-get install -y curl zip
-
-ENV VERSION_VIPS=8.2.3
-
-# Fetch and unzip
-RUN mkdir /vips
-WORKDIR /vips
-RUN curl -O http://www.vips.ecs.soton.ac.uk/supported/8.2/win32/vips-dev-w64-8.2.zip
-RUN unzip vips-dev-w64-8.2.zip
-
-# Clean and zip
-WORKDIR /vips/vips-dev-8.2
-RUN rm bin/libvipsCC-42.dll bin/libvips-cpp-42.dll bin/libgsf-win32-1-114.dll bin/libstdc++-6.dll
-RUN cp bin/*.dll lib/
-RUN cp -r lib64/* lib/
-
-RUN GZIP=-9 tar czf /libvips-${VERSION_VIPS}-win.tar.gz include lib/glib-2.0 lib/libvips.lib lib/libglib-2.0.lib lib/libgobject-2.0.lib lib/*.dll

packaging/win32-x64/Dockerfile

@@ -0,0 +1,8 @@
+FROM debian:jessie
+MAINTAINER Lovell Fuller <npm@lovell.info>
+
+# Create Debian-based container suitable for post-processing Windows x64 binaries
+
+RUN apt-get update && apt-get install -y curl zip advancecomp
+
+ENV PLATFORM=win32-x64

preinstall.sh

@@ -1,322 +0,0 @@
-#!/bin/sh
-
-# This script is no longer required on most
-# 64-bit Linux systems when using sharp v0.12.0+
-
-# See http://sharp.dimens.io/page/install#linux
-
-# If you really need this script, it will attempt to
-# globally install libvips if not already available.
-
-# Supports:
-# * Debian Linux
-#   * Debian 7, 8
-#   * Ubuntu 12.04, 14.04, 14.10, 15.04, 15.10
-#   * Mint 13, 17
-#   * Elementary 0.3
-# * Red Hat Linux
-#   * RHEL/Centos/Scientific 6, 7
-#   * Fedora 21, 22, 23
-#   * Amazon Linux 2015.03, 2015.09
-# * OpenSuse 13
-
-vips_version_minimum=8.2.3
-vips_version_latest_major_minor=8.2
-vips_version_latest_patch=3
-
-openslide_version_minimum=3.4.0
-openslide_version_latest_major_minor=3.4
-openslide_version_latest_patch=1
-
-install_libvips_from_source() {
-  echo "Compiling libvips $vips_version_latest_major_minor.$vips_version_latest_patch from source"
-  curl -O http://www.vips.ecs.soton.ac.uk/supported/$vips_version_latest_major_minor/vips-$vips_version_latest_major_minor.$vips_version_latest_patch.tar.gz
-  tar zvxf vips-$vips_version_latest_major_minor.$vips_version_latest_patch.tar.gz
-  cd vips-$vips_version_latest_major_minor.$vips_version_latest_patch
-  ./configure --disable-debug --disable-docs --disable-static --disable-introspection --disable-dependency-tracking --enable-cxx=yes --without-python --without-orc --without-fftw $1
-  make
-  make install
-  cd ..
-  rm -rf vips-$vips_version_latest_major_minor.$vips_version_latest_patch
-  rm vips-$vips_version_latest_major_minor.$vips_version_latest_patch.tar.gz
-  ldconfig
-  echo "Installed libvips $(PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig pkg-config --modversion vips)"
-}
-
-install_libopenslide_from_source() {
-  echo "Compiling openslide $openslide_version_latest_major_minor.$openslide_version_latest_patch from source"
-  curl -O -L https://github.com/openslide/openslide/releases/download/v$openslide_version_latest_major_minor.$openslide_version_latest_patch/openslide-$openslide_version_latest_major_minor.$openslide_version_latest_patch.tar.gz
-  tar xzvf openslide-$openslide_version_latest_major_minor.$openslide_version_latest_patch.tar.gz
-  cd openslide-$openslide_version_latest_major_minor.$openslide_version_latest_patch
-  PKG_CONFIG_PATH=$pkg_config_path ./configure $1
-  make
-  make install
-  cd ..
-  rm -rf openslide-$openslide_version_latest_major_minor.$openslide_version_latest_patch
-  rm openslide-$openslide_version_latest_major_minor.$openslide_version_latest_patch.tar.gz
-  ldconfig
-  echo "Installed libopenslide $openslide_version_latest_major_minor.$openslide_version_latest_patch"
-}
-
-sorry() {
-  echo "Sorry, I don't yet know how to install lib$1 on $2"
-  exit 1
-}
-
-pkg_config_path="$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig"
-
-check_if_library_exists() {
-  PKG_CONFIG_PATH=$pkg_config_path pkg-config --exists $1
-  if [ $? -eq 0 ]; then
-    version_found=$(PKG_CONFIG_PATH=$pkg_config_path pkg-config --modversion $1)
-    PKG_CONFIG_PATH=$pkg_config_path pkg-config --atleast-version=$2 $1
-    if [ $? -eq 0 ]; then
-      # Found suitable version of libvips
-      echo "Found lib$1 $version_found"
-      return 1
-    fi
-    echo "Found lib$1 $version_found but require $2"
-  else
-    echo "Could not find lib$1 using a PKG_CONFIG_PATH of '$pkg_config_path'"
-  fi
-  return 0
-}
-
-enable_openslide=0
-# Is libvips already installed, and is it at least the minimum required version?
-if [ $# -eq 1 ]; then
-  if [ "$1" = "--with-openslide" ]; then
-    echo "Installing vips with openslide support"
-    enable_openslide=1
-  else
-    echo "Sorry, $1 is not supported. Did you mean --with-openslide?"
-    exit 1
-  fi
-fi
-
-if ! type pkg-config >/dev/null; then
-  sorry "vips" "a system without pkg-config"
-fi
-
-openslide_exists=0
-if [ $enable_openslide -eq 1 ]; then
-  check_if_library_exists "openslide" "$openslide_version_minimum"
-  openslide_exists=$?
-fi
-
-check_if_library_exists "vips" "$vips_version_minimum"
-vips_exists=$?
-if [ $vips_exists -eq 1 ] && [ $enable_openslide -eq 1 ]; then
-  if [ $openslide_exists -eq 1 ]; then
-    # Check if vips compiled with openslide support
-    vips_with_openslide=`vips list classes | grep -i opensli`
-    if [ -z $vips_with_openslide ]; then
-      echo "Vips compiled without openslide support."
-    else
-      exit 0
-    fi
-  fi
-elif [ $vips_exists -eq 1 ] && [ $enable_openslide -eq 0 ]; then
-  exit 0
-fi
-
-# Verify root/sudo access
-if [ "$(id -u)" -ne "0" ]; then
-  echo "Sorry, I need root/sudo access to continue"
-  exit 1
-fi
-
-# Deprecation warning
-if [ "$(arch)" == "x86_64" ]; then
-  echo "This script is no longer required on most 64-bit Linux systems when using sharp v0.12.0+"
-fi
-
-# OS-specific installations of libopenslide follows
-# Either openslide does not exist, or vips is installed without openslide support
-if [ $enable_openslide -eq 1 ] && [ -z $vips_with_openslide ] && [ $openslide_exists -eq 0 ]; then
-  if [ -f /etc/debian_version ]; then
-    # Debian Linux
-    DISTRO=$(lsb_release -c -s)
-    echo "Detected Debian Linux '$DISTRO'"
-    case "$DISTRO" in
-      jessie|vivid|wily)
-        # Debian 8, Ubuntu 15
-        echo "Installing libopenslide via apt-get"
-        apt-get install -y libopenslide-dev
-        ;;
-      trusty|utopic|qiana|rebecca|rafaela|freya)
-        # Ubuntu 14, Mint 17
-        echo "Installing libopenslide dependencies via apt-get"
-        apt-get install -y automake build-essential curl zlib1g-dev libopenjpeg-dev libpng12-dev libjpeg-dev libtiff5-dev libgdk-pixbuf2.0-dev libxml2-dev libsqlite3-dev libcairo2-dev libglib2.0-dev sqlite3 libsqlite3-dev
-        install_libopenslide_from_source
-        ;;
-      precise|wheezy|maya)
-        # Debian 7, Ubuntu 12.04, Mint 13
-        echo "Installing libopenslide dependencies via apt-get"
-        apt-get install -y automake build-essential curl zlib1g-dev libopenjpeg-dev libpng12-dev libjpeg-dev libtiff5-dev libgdk-pixbuf2.0-dev libxml2-dev libsqlite3-dev libcairo2-dev libglib2.0-dev sqlite3 libsqlite3-dev
-        install_libopenslide_from_source
-        ;;
-      *)
-        # Unsupported Debian-based OS
-        sorry "openslide" "Debian-based $DISTRO"
-        ;;
-    esac
-  elif [ -f /etc/redhat-release ]; then
-    # Red Hat Linux
-    RELEASE=$(cat /etc/redhat-release)
-    echo "Detected Red Hat Linux '$RELEASE'"
-    case $RELEASE in
-      "Red Hat Enterprise Linux release 7."*|"CentOS Linux release 7."*|"Scientific Linux release 7."*)
-        # RHEL/CentOS 7
-        echo "Installing libopenslide dependencies via yum"
-        yum groupinstall -y "Development Tools"
-        yum install -y tar curl libpng-devel libjpeg-devel libxml2-devel zlib-devel openjpeg-devel libtiff-devel gdk-pixbuf2-devel sqlite-devel cairo-devel glib2-devel
-        install_libopenslide_from_source "--prefix=/usr"
-        ;;
-      "Red Hat Enterprise Linux release 6."*|"CentOS release 6."*|"Scientific Linux release 6."*)
-        # RHEL/CentOS 6
-        echo "Installing libopenslide dependencies via yum"
-        yum groupinstall -y "Development Tools"
-        yum install -y tar curl libpng-devel libjpeg-devel libxml2-devel zlib-devel openjpeg-devel libtiff-devel gdk-pixbuf2-devel sqlite-devel cairo-devel glib2-devel
-        install_libopenslide_from_source "--prefix=/usr"
-        ;;
-      "Fedora release 21 "*|"Fedora release 22 "*)
-        # Fedora 21, 22
-        echo "Installing libopenslide via yum"
-        yum install -y openslide-devel
-        ;;
-      *)
-        # Unsupported RHEL-based OS
-        sorry "openslide" "$RELEASE"
-        ;;
-    esac
-  elif [ -f /etc/os-release ]; then
-    RELEASE=$(cat /etc/os-release | grep VERSION)
-    echo "Detected OpenSuse Linux '$RELEASE'"
-    case $RELEASE in
-      *"13.2"*)
-      echo "Installing libopenslide via zypper"
-      zypper --gpg-auto-import-keys install -y libopenslide-devel
-      ;;
-    esac
-  elif [ -f /etc/SuSE-brand ]; then
-    RELEASE=$(cat /etc/SuSE-brand | grep VERSION)
-    echo "Detected OpenSuse Linux '$RELEASE'"
-    case $RELEASE in
-      *"13.1")
-      echo "Installing libopenslide dependencies via zypper"
-      zypper --gpg-auto-import-keys install -y --type pattern devel_basis
-      zypper --gpg-auto-import-keys install -y tar curl libpng16-devel libjpeg-turbo libjpeg8-devel libxml2-devel zlib-devel openjpeg-devel libtiff-devel libgdk_pixbuf-2_0-0 sqlite3-devel cairo-devel glib2-devel
-      install_libopenslide_from_source
-      ;;
-    esac
-  else
-    # Unsupported OS
-    sorry "openslide" "$(uname -a)"
-  fi
-fi
-
-# OS-specific installations of libvips follows
-
-if [ -f /etc/debian_version ]; then
-  # Debian Linux
-  DISTRO=$(lsb_release -c -s)
-  echo "Detected Debian Linux '$DISTRO'"
-  case "$DISTRO" in
-    jessie|trusty|utopic|vivid|wily|xenial|qiana|rebecca|rafaela|freya)
-      # Debian 8, Ubuntu 14.04+, Mint 17
-      echo "Installing libvips dependencies via apt-get"
-      apt-get install -y automake build-essential gobject-introspection gtk-doc-tools libglib2.0-dev libjpeg-dev libpng12-dev libwebp-dev libtiff5-dev libexif-dev libgsf-1-dev liblcms2-dev libxml2-dev swig libmagickcore-dev curl
-      install_libvips_from_source
-      ;;
-    precise|wheezy|maya)
-      # Debian 7, Ubuntu 12.04, Mint 13
-      echo "Installing libvips dependencies via apt-get"
-      add-apt-repository -y ppa:lyrasis/precise-backports
-      apt-get update
-      apt-get install -y automake build-essential gobject-introspection gtk-doc-tools libglib2.0-dev libjpeg-dev libpng12-dev libwebp-dev libtiff4-dev libexif-dev libgsf-1-dev liblcms2-dev libxml2-dev swig libmagickcore-dev curl
-      install_libvips_from_source
-      ;;
-    *)
-      # Unsupported Debian-based OS
-      sorry "vips" "Debian-based $DISTRO"
-      ;;
-  esac
-elif [ -f /etc/redhat-release ]; then
-  # Red Hat Linux
-  RELEASE=$(cat /etc/redhat-release)
-  echo "Detected Red Hat Linux '$RELEASE'"
-  case $RELEASE in
-    "Red Hat Enterprise Linux release 7."*|"CentOS Linux release 7."*|"Scientific Linux release 7."*)
-      # RHEL/CentOS 7
-      echo "Installing libvips dependencies via yum"
-      yum groupinstall -y "Development Tools"
-      yum install -y tar curl gtk-doc libxml2-devel libjpeg-turbo-devel libpng-devel libtiff-devel libexif-devel libgsf-devel lcms2-devel ImageMagick-devel gobject-introspection-devel libwebp-devel
-      install_libvips_from_source "--prefix=/usr"
-      ;;
-    "Red Hat Enterprise Linux release 6."*|"CentOS release 6."*|"Scientific Linux release 6."*)
-      # RHEL/CentOS 6
-      echo "Installing libvips dependencies via yum"
-      yum groupinstall -y "Development Tools"
-      yum install -y tar curl gtk-doc libxml2-devel libjpeg-turbo-devel libpng-devel libtiff-devel libexif-devel libgsf-devel lcms-devel ImageMagick-devel
-      yum install -y http://li.nux.ro/download/nux/dextop/el6/x86_64/nux-dextop-release-0-2.el6.nux.noarch.rpm
-      yum install -y --enablerepo=nux-dextop gobject-introspection-devel
-      yum install -y http://rpms.famillecollet.com/enterprise/remi-release-6.rpm
-      yum install -y --enablerepo=remi libwebp-devel
-      install_libvips_from_source "--prefix=/usr"
-      ;;
-    "Fedora"*)
-      # Fedora 21, 22, 23
-      echo "Installing libvips dependencies via yum"
-      yum groupinstall -y "Development Tools"
-      yum install -y gcc-c++ gtk-doc libxml2-devel libjpeg-turbo-devel libpng-devel libtiff-devel libexif-devel lcms-devel ImageMagick-devel gobject-introspection-devel libwebp-devel curl
-      install_libvips_from_source "--prefix=/usr"
-      ;;
-    *)
-      # Unsupported RHEL-based OS
-      sorry "vips" "$RELEASE"
-      ;;
-  esac
-elif [ -f /etc/system-release ]; then
-  # Probably Amazon Linux
-  RELEASE=$(cat /etc/system-release)
-  case $RELEASE in
-    "Amazon Linux AMI release 2015.03"|"Amazon Linux AMI release 2015.09")
-      # Amazon Linux
-      echo "Detected '$RELEASE'"
-      echo "Installing libvips dependencies via yum"
-      yum groupinstall -y "Development Tools"
-      yum install -y gtk-doc libxml2-devel libjpeg-turbo-devel libpng-devel libtiff-devel libexif-devel libgsf-devel lcms2-devel ImageMagick-devel gobject-introspection-devel libwebp-devel curl
-      install_libvips_from_source "--prefix=/usr"
-      ;;
-    *)
-      # Unsupported Amazon Linux version
-      sorry "vips" "$RELEASE"
-      ;;
-  esac
-elif [ -f /etc/os-release ]; then
-  RELEASE=$(cat /etc/os-release | grep VERSION)
-  echo "Detected OpenSuse Linux '$RELEASE'"
-  case $RELEASE in
-    *"13.2"*)
-    echo "Installing libvips dependencies via zypper"
-    zypper --gpg-auto-import-keys install -y --type pattern devel_basis
-    zypper --gpg-auto-import-keys install -y tar curl gtk-doc libxml2-devel libjpeg-turbo libjpeg8-devel libpng16-devel libtiff-devel libexif-devel liblcms2-devel ImageMagick-devel gobject-introspection-devel libwebp-devel
-    install_libvips_from_source
-    ;;
-  esac
-elif [ -f /etc/SuSE-brand ]; then
-  RELEASE=$(cat /etc/SuSE-brand | grep VERSION)
-  echo "Detected OpenSuse Linux '$RELEASE'"
-  case $RELEASE in
-    *"13.1")
-    echo "Installing libvips dependencies via zypper"
-    zypper --gpg-auto-import-keys install -y --type pattern devel_basis
-    zypper --gpg-auto-import-keys install -y tar curl gtk-doc libxml2-devel libjpeg-turbo libjpeg8-devel libpng16-devel libtiff-devel libexif-devel liblcms2-devel ImageMagick-devel gobject-introspection-devel libwebp-devel
-    install_libvips_from_source
-    ;;
-  esac
-else
-  # Unsupported OS
-  sorry "vips" "$(uname -a)"
-fi

src/common.cc

@@ -1,32 +1,78 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #include <cstdlib>
 #include <string>
 #include <string.h>
+#include <vector>
+
+#include <node.h>
+#include <node_buffer.h>
+#include <nan.h>
 #include <vips/vips8>
 
 #include "common.h"
 
-// Verify platform and compiler compatibility
-
-#if (VIPS_MAJOR_VERSION < 8 || (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 2))
-#error libvips version 8.2.0+ required - see sharp.dimens.io/page/install
-#endif
-
-#if ((!defined(__clang__)) && defined(__GNUC__) && (__GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6)))
-#error GCC version 4.6+ is required for C++11 features - see sharp.dimens.io/page/install#prerequisites
-#endif
-
-#if (defined(__clang__) && defined(__has_feature))
-#if (!__has_feature(cxx_range_for))
-#error clang version 3.0+ is required for C++11 features - see sharp.dimens.io/page/install#prerequisites
-#endif
-#endif
-
-#define EXIF_IFD0_ORIENTATION "exif-ifd0-Orientation"
-
 using vips::VImage;
 
 namespace sharp {
 
+  // Convenience methods to access the attributes of a v8::Object
+  bool HasAttr(v8::Handle<v8::Object> obj, std::string attr) {
+    return Nan::Has(obj, Nan::New(attr).ToLocalChecked()).FromJust();
+  }
+  std::string AttrAsStr(v8::Handle<v8::Object> obj, std::string attr) {
+    return *Nan::Utf8String(Nan::Get(obj, Nan::New(attr).ToLocalChecked()).ToLocalChecked());
+  }
+
+  // Create an InputDescriptor instance from a v8::Object describing an input image
+  InputDescriptor* CreateInputDescriptor(
+    v8::Handle<v8::Object> input, std::vector<v8::Local<v8::Object>> buffersToPersist
+  ) {
+    Nan::HandleScope();
+    InputDescriptor *descriptor = new InputDescriptor;
+    if (HasAttr(input, "file")) {
+      descriptor->file = AttrAsStr(input, "file");
+    } else if (HasAttr(input, "buffer")) {
+      v8::Local<v8::Object> buffer = AttrAs<v8::Object>(input, "buffer");
+      descriptor->bufferLength = node::Buffer::Length(buffer);
+      descriptor->buffer = node::Buffer::Data(buffer);
+      buffersToPersist.push_back(buffer);
+    }
+    // Density for vector-based input
+    if (HasAttr(input, "density")) {
+      descriptor->density = AttrTo<uint32_t>(input, "density");
+    }
+    // Raw pixel input
+    if (HasAttr(input, "rawChannels")) {
+      descriptor->rawChannels = AttrTo<uint32_t>(input, "rawChannels");
+      descriptor->rawWidth = AttrTo<uint32_t>(input, "rawWidth");
+      descriptor->rawHeight = AttrTo<uint32_t>(input, "rawHeight");
+    }
+    // Create new image
+    if (HasAttr(input, "createChannels")) {
+      descriptor->createChannels = AttrTo<uint32_t>(input, "createChannels");
+      descriptor->createWidth = AttrTo<uint32_t>(input, "createWidth");
+      descriptor->createHeight = AttrTo<uint32_t>(input, "createHeight");
+      v8::Local<v8::Object> createBackground = AttrAs<v8::Object>(input, "createBackground");
+      for (unsigned int i = 0; i < 4; i++) {
+        descriptor->createBackground[i] = AttrTo<double>(createBackground, i);
+      }
+    }
+    return descriptor;
+  }
+
   // How many tasks are in the queue?
   volatile int counterQueue = 0;
 
@@ -52,6 +98,12 @@ namespace sharp {
   bool IsDz(std::string const &str) {
     return EndsWith(str, ".dzi") || EndsWith(str, ".DZI");
   }
+  bool IsDzZip(std::string const &str) {
+    return EndsWith(str, ".zip") || EndsWith(str, ".ZIP") || EndsWith(str, ".szi") || EndsWith(str, ".SZI");
+  }
+  bool IsV(std::string const &str) {
+    return EndsWith(str, ".v") || EndsWith(str, ".V") || EndsWith(str, ".vips") || EndsWith(str, ".VIPS");
+  }
 
   /*
     Provide a string identifier for the given image type.
@@ -63,10 +115,14 @@ namespace sharp {
       case ImageType::PNG: id = "png"; break;
       case ImageType::WEBP: id = "webp"; break;
       case ImageType::TIFF: id = "tiff"; break;
+      case ImageType::GIF: id = "gif"; break;
+      case ImageType::SVG: id = "svg"; break;
+      case ImageType::PDF: id = "pdf"; break;
       case ImageType::MAGICK: id = "magick"; break;
       case ImageType::OPENSLIDE: id = "openslide"; break;
       case ImageType::PPM: id = "ppm"; break;
       case ImageType::FITS: id = "fits"; break;
+      case ImageType::VIPS: id = "v"; break;
       case ImageType::RAW: id = "raw"; break;
       case ImageType::UNKNOWN: id = "unknown"; break;
     }
@@ -89,6 +145,12 @@ namespace sharp {
         imageType = ImageType::WEBP;
       } else if (EndsWith(loader, "TiffBuffer")) {
         imageType = ImageType::TIFF;
+      } else if (EndsWith(loader, "GifBuffer")) {
+        imageType = ImageType::GIF;
+      } else if (EndsWith(loader, "SvgBuffer")) {
+        imageType = ImageType::SVG;
+      } else if (EndsWith(loader, "PdfBuffer")) {
+        imageType = ImageType::PDF;
       } else if (EndsWith(loader, "MagickBuffer")) {
         imageType = ImageType::MAGICK;
       }
@@ -114,10 +176,18 @@ namespace sharp {
         imageType = ImageType::OPENSLIDE;
       } else if (EndsWith(loader, "TiffFile")) {
         imageType = ImageType::TIFF;
+      } else if (EndsWith(loader, "GifFile")) {
+        imageType = ImageType::GIF;
+      } else if (EndsWith(loader, "SvgFile")) {
+        imageType = ImageType::SVG;
+      } else if (EndsWith(loader, "PdfFile")) {
+        imageType = ImageType::PDF;
       } else if (EndsWith(loader, "Ppm")) {
         imageType = ImageType::PPM;
       } else if (EndsWith(loader, "Fits")) {
         imageType = ImageType::FITS;
+      } else if (EndsWith(loader, "Vips")) {
+        imageType = ImageType::VIPS;
       } else if (EndsWith(loader, "Magick") || EndsWith(loader, "MagickFile")) {
         imageType = ImageType::MAGICK;
       }
@@ -125,6 +195,87 @@ namespace sharp {
     return imageType;
   }
 
+  /*
+    Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
+  */
+  std::tuple<VImage, ImageType> OpenInput(InputDescriptor *descriptor, VipsAccess accessMethod) {
+    VImage image;
+    ImageType imageType;
+    if (descriptor->buffer != nullptr) {
+      if (descriptor->rawChannels > 0) {
+        // Raw, uncompressed pixel data
+        image = VImage::new_from_memory(descriptor->buffer, descriptor->bufferLength,
+          descriptor->rawWidth, descriptor->rawHeight, descriptor->rawChannels, VIPS_FORMAT_UCHAR);
+        if (descriptor->rawChannels < 3) {
+          image.get_image()->Type = VIPS_INTERPRETATION_B_W;
+        } else {
+          image.get_image()->Type = VIPS_INTERPRETATION_sRGB;
+        }
+        imageType = ImageType::RAW;
+      } else {
+        // Compressed data
+        imageType = DetermineImageType(descriptor->buffer, descriptor->bufferLength);
+        if (imageType != ImageType::UNKNOWN) {
+          try {
+            vips::VOption *option = VImage::option()->set("access", accessMethod);
+            if (imageType == ImageType::SVG || imageType == ImageType::PDF) {
+              option->set("dpi", static_cast<double>(descriptor->density));
+            }
+            if (imageType == ImageType::MAGICK) {
+              option->set("density", std::to_string(descriptor->density).data());
+            }
+            image = VImage::new_from_buffer(descriptor->buffer, descriptor->bufferLength, nullptr, option);
+            if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
+              SetDensity(image, descriptor->density);
+            }
+          } catch (...) {
+            throw vips::VError("Input buffer has corrupt header");
+          }
+        } else {
+          throw vips::VError("Input buffer contains unsupported image format");
+        }
+      }
+    } else {
+      if (descriptor->createChannels > 0) {
+        // Create new image
+        std::vector<double> background = {
+          descriptor->createBackground[0],
+          descriptor->createBackground[1],
+          descriptor->createBackground[2]
+        };
+        if (descriptor->createChannels == 4) {
+          background.push_back(descriptor->createBackground[3]);
+        }
+        image = VImage::new_matrix(descriptor->createWidth, descriptor->createHeight).new_from_image(background);
+        image.get_image()->Type = VIPS_INTERPRETATION_sRGB;
+        imageType = ImageType::RAW;
+      } else {
+        // From filesystem
+        imageType = DetermineImageType(descriptor->file.data());
+        if (imageType != ImageType::UNKNOWN) {
+          try {
+            vips::VOption *option = VImage::option()->set("access", accessMethod);
+            if (imageType == ImageType::SVG || imageType == ImageType::PDF) {
+              option->set("dpi", static_cast<double>(descriptor->density));
+            }
+            if (imageType == ImageType::MAGICK) {
+              option->set("density", std::to_string(descriptor->density).data());
+            }
+            image = VImage::new_from_file(descriptor->file.data(), option);
+            if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
+              SetDensity(image, descriptor->density);
+            }
+          } catch (...) {
+            throw vips::VError("Input file has corrupt header");
+          }
+        } else {
+          throw vips::VError("Input file is missing or of an unsupported image format");
+        }
+      }
+    }
+    return std::make_tuple(image, imageType);
+  }
+
   /*
     Does this image have an embedded profile?
   */
@@ -142,8 +293,7 @@ namespace sharp {
     return (
       (bands == 2 && interpretation == VIPS_INTERPRETATION_B_W) ||
       (bands == 4 && interpretation != VIPS_INTERPRETATION_CMYK) ||
-      (bands == 5 && interpretation == VIPS_INTERPRETATION_CMYK)
+      (bands == 5 && interpretation == VIPS_INTERPRETATION_CMYK));
-    );
   }
 
   /*
@@ -151,11 +301,8 @@ namespace sharp {
   */
   int ExifOrientation(VImage image) {
     int orientation = 0;
-    if (image.get_typeof(EXIF_IFD0_ORIENTATION) != 0) {
+    if (image.get_typeof(VIPS_META_ORIENTATION) != 0) {
-      char const *exif = image.get_string(EXIF_IFD0_ORIENTATION);
+      orientation = image.get_int(VIPS_META_ORIENTATION);
-      if (exif != nullptr) {
-        orientation = atoi(&exif[0]);
-      }
     }
     return orientation;
   }
@@ -164,16 +311,14 @@ namespace sharp {
     Set EXIF Orientation of image.
   */
   void SetExifOrientation(VImage image, int const orientation) {
-    char exif[3];
+    image.set(VIPS_META_ORIENTATION, orientation);
-    g_snprintf(exif, sizeof(exif), "%d", orientation);
-    image.set(EXIF_IFD0_ORIENTATION, exif);
   }
 
   /*
     Remove EXIF Orientation from image.
   */
   void RemoveExifOrientation(VImage image) {
-    SetExifOrientation(image, 0);
+    vips_image_remove(image.get_image(), VIPS_META_ORIENTATION);
   }
 
   /*
@@ -259,4 +404,86 @@ namespace sharp {
     return std::make_tuple(left, top);
   }
 
+  /*
+    Calculate the (left, top) coordinates of the output image
+    within the input image, applying the given x and y offsets.
+  */
+  std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
+    int const outWidth, int const outHeight, int const x, int const y) {
+
+    // default values
+    int left = 0;
+    int top = 0;
+
+    // assign only if valid
+    if (x >= 0 && x < (inWidth - outWidth)) {
+      left = x;
+    } else if (x >= (inWidth - outWidth)) {
+      left = inWidth - outWidth;
+    }
+
+    if (y >= 0 && y < (inHeight - outHeight)) {
+      top = y;
+    } else if (y >= (inHeight - outHeight)) {
+      top = inHeight - outHeight;
+    }
+
+    // the resulting left and top could have been outside the image after calculation from bottom/right edges
+    if (left < 0) {
+      left = 0;
+    }
+    if (top < 0) {
+      top = 0;
+    }
+
+    return std::make_tuple(left, top);
+  }
+
+  /*
+    Are pixel values in this image 16-bit integer?
+  */
+  bool Is16Bit(VipsInterpretation const interpretation) {
+    return interpretation == VIPS_INTERPRETATION_RGB16 || interpretation == VIPS_INTERPRETATION_GREY16;
+  }
+
+  /*
+    Return the image alpha maximum. Useful for combining alpha bands. scRGB
+    images are 0 - 1 for image data, but the alpha is 0 - 255.
+  */
+  double MaximumImageAlpha(VipsInterpretation const interpretation) {
+    return Is16Bit(interpretation) ? 65535.0 : 255.0;
+  }
+
+  /*
+    Get boolean operation type from string
+  */
+  VipsOperationBoolean GetBooleanOperation(std::string const opStr) {
+    return static_cast<VipsOperationBoolean>(
+      vips_enum_from_nick(nullptr, VIPS_TYPE_OPERATION_BOOLEAN, opStr.data()));
+  }
+
+  /*
+    Get interpretation type from string
+  */
+  VipsInterpretation GetInterpretation(std::string const typeStr) {
+    return static_cast<VipsInterpretation>(
+      vips_enum_from_nick(nullptr, VIPS_TYPE_INTERPRETATION, typeStr.data()));
+  }
+
+  /*
+    Convert RGBA value to another colourspace
+  */
+  std::vector<double> GetRgbaAsColourspace(std::vector<double> const rgba, VipsInterpretation const interpretation) {
+    int const bands = static_cast<int>(rgba.size());
+    if (bands < 3 || interpretation == VIPS_INTERPRETATION_sRGB || interpretation == VIPS_INTERPRETATION_RGB) {
+      return rgba;
+    } else {
+      VImage pixel = VImage::new_matrix(1, 1);
+      pixel.set("bands", bands);
+      pixel = pixel.new_from_image(rgba);
+      pixel = pixel.colourspace(interpretation, VImage::option()->set("source_space", VIPS_INTERPRETATION_sRGB));
+      return pixel(0, 0);
+    }
+  }
+
 }  // namespace sharp

src/common.h

@@ -1,26 +1,111 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #ifndef SRC_COMMON_H_
 #define SRC_COMMON_H_
 
 #include <string>
 #include <tuple>
+#include <vector>
 
+#include <node.h>
+#include <nan.h>
 #include <vips/vips8>
 
+// Verify platform and compiler compatibility
+
+#if (VIPS_MAJOR_VERSION < 8 || (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 4))
+#error libvips version 8.4.x required - see sharp.dimens.io/page/install
+#endif
+
+#if ((!defined(__clang__)) && defined(__GNUC__) && (__GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6)))
+#error GCC version 4.6+ is required for C++11 features - see sharp.dimens.io/page/install#prerequisites
+#endif
+
+#if (defined(__clang__) && defined(__has_feature))
+#if (!__has_feature(cxx_range_for))
+#error clang version 3.0+ is required for C++11 features - see sharp.dimens.io/page/install#prerequisites
+#endif
+#endif
+
 using vips::VImage;
 
 namespace sharp {
 
+  struct InputDescriptor {
+    std::string name;
+    std::string file;
+    char *buffer;
+    size_t bufferLength;
+    int density;
+    int rawChannels;
+    int rawWidth;
+    int rawHeight;
+    int createChannels;
+    int createWidth;
+    int createHeight;
+    double createBackground[4];
+
+    InputDescriptor():
+      buffer(nullptr),
+      bufferLength(0),
+      density(72),
+      rawChannels(0),
+      rawWidth(0),
+      rawHeight(0),
+      createChannels(0),
+      createWidth(0),
+      createHeight(0) {
+        createBackground[0] = 0.0;
+        createBackground[1] = 0.0;
+        createBackground[2] = 0.0;
+        createBackground[3] = 255.0;
+      }
+  };
+
+  // Convenience methods to access the attributes of a v8::Object
+  bool HasAttr(v8::Handle<v8::Object> obj, std::string attr);
+  std::string AttrAsStr(v8::Handle<v8::Object> obj, std::string attr);
+  template<typename T> v8::Local<T> AttrAs(v8::Handle<v8::Object> obj, std::string attr) {
+    return Nan::Get(obj, Nan::New(attr).ToLocalChecked()).ToLocalChecked().As<T>();
+  }
+  template<typename T> T AttrTo(v8::Handle<v8::Object> obj, std::string attr) {
+    return Nan::To<T>(Nan::Get(obj, Nan::New(attr).ToLocalChecked()).ToLocalChecked()).FromJust();
+  }
+  template<typename T> T AttrTo(v8::Handle<v8::Object> obj, int attr) {
+    return Nan::To<T>(Nan::Get(obj, attr).ToLocalChecked()).FromJust();
+  }
+
+  // Create an InputDescriptor instance from a v8::Object describing an input image
+  InputDescriptor* CreateInputDescriptor(
+    v8::Handle<v8::Object> input, std::vector<v8::Local<v8::Object>> buffersToPersist);
+
   enum class ImageType {
-    UNKNOWN,
     JPEG,
     PNG,
     WEBP,
     TIFF,
+    GIF,
+    SVG,
+    PDF,
     MAGICK,
     OPENSLIDE,
     PPM,
     FITS,
-    RAW
+    VIPS,
+    RAW,
+    UNKNOWN
   };
 
   // How many tasks are in the queue?
@@ -35,6 +120,8 @@ namespace sharp {
   bool IsWebp(std::string const &str);
   bool IsTiff(std::string const &str);
   bool IsDz(std::string const &str);
+  bool IsDzZip(std::string const &str);
+  bool IsV(std::string const &str);
 
   /*
     Provide a string identifier for the given image type.
@@ -51,6 +138,11 @@ namespace sharp {
   */
   ImageType DetermineImageType(char const *file);
 
+  /*
+    Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
+  */
+  std::tuple<VImage, ImageType> OpenInput(InputDescriptor *descriptor, VipsAccess accessMethod);
+
   /*
     Does this image have an embedded profile?
   */
@@ -104,6 +196,39 @@ namespace sharp {
   std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
     int const outWidth, int const outHeight, int const gravity);
 
+  /*
+    Calculate the (left, top) coordinates of the output image
+    within the input image, applying the given x and y offsets of the output image.
+  */
+  std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
+    int const outWidth, int const outHeight, int const x, int const y);
+
+  /*
+    Are pixel values in this image 16-bit integer?
+  */
+  bool Is16Bit(VipsInterpretation const interpretation);
+
+  /*
+    Return the image alpha maximum. Useful for combining alpha bands. scRGB
+    images are 0 - 1 for image data, but the alpha is 0 - 255.
+  */
+  double MaximumImageAlpha(VipsInterpretation const interpretation);
+
+  /*
+    Get boolean operation type from string
+  */
+  VipsOperationBoolean GetBooleanOperation(std::string const opStr);
+
+  /*
+    Get interpretation type from string
+  */
+  VipsInterpretation GetInterpretation(std::string const typeStr);
+
+  /*
+    Convert RGBA value to another colourspace
+  */
+  std::vector<double> GetRgbaAsColourspace(std::vector<double> const rgba, VipsInterpretation const interpretation);
+
 }  // namespace sharp
 
 #endif  // SRC_COMMON_H_

src/libvips/cplusplus/VImage.cpp

@@ -2,6 +2,10 @@
  *
  * 30/12/14
  * 	- allow set enum value from string
+ * 10/6/16
+ * 	- missing implementation of VImage::write()
+ * 11/6/16
+ * 	- added arithmetic assignment overloads, += etc. 
  */
 
 /*
@@ -457,7 +461,7 @@ VImage::call_option_string( const char *operation_name,
 {
 	VipsOperation *operation;
 
-	VIPS_DEBUG_MSG( "vips_call_by_name: starting for %s ...\n", 
+	VIPS_DEBUG_MSG( "call_option_string: starting for %s ...\n", 
 		operation_name );
 
 	if( !(operation = vips_operation_new( operation_name )) ) {
@@ -485,6 +489,7 @@ VImage::call_option_string( const char *operation_name,
 	 */
 	if( vips_cache_operation_buildp( &operation ) ) {
 		vips_object_unref_outputs( VIPS_OBJECT( operation ) );
+		g_object_unref( operation ); 
 		delete options; 
 		throw( VError() ); 
 	}
@@ -566,7 +571,7 @@ VImage::new_from_image( std::vector<double> pixel )
 	VImage onepx = VImage::black( 1, 1, 
 		VImage::option()->set( "bands", bands() ) ); 
 
-	onepx = onepx.linear( to_vectorv( 1, 1.0 ), pixel ).cast( format() );
+	onepx = (onepx + pixel).cast( format() );
 
 	VImage big = onepx.embed( 0, 0, width(), height(), 
 		VImage::option()->set( "extend", VIPS_EXTEND_COPY ) ); 
@@ -612,6 +617,15 @@ VImage::new_matrixv( int width, int height, ... )
 	return( matrix ); 
 }
 
+VImage
+VImage::write( VImage out )
+{
+	if( vips_image_write( this->get_image(), out.get_image() ) )
+		throw VError(); 
+
+	return( out ); 
+}
+
 void 
 VImage::write_to_file( const char *name, VOption *options )
 {
@@ -711,4 +725,680 @@ VImage::maxpos( VOption *options )
 	return( std::complex<double>( x, y ) ); 
 }
 
+// Operator overloads
+
+VImage 
+VImage::operator[]( int index ) 
+{
+	return( this->extract_band( index ) ); 
+}
+
+std::vector<double> 
+VImage::operator()( int x, int y )
+{
+	return( this->getpoint( x, y ) ); 
+}
+
+VImage 
+operator+( VImage a, VImage b ) 
+{
+	return( a.add( b ) );
+}
+
+VImage 
+operator+( double a, VImage b ) 
+{
+	return( b.linear( 1.0, a ) ); 
+}
+
+VImage 
+operator+( VImage a, double b ) 
+{ 
+	return( a.linear( 1.0, b ) ); 
+}
+
+VImage 
+operator+( std::vector<double> a, VImage b ) 
+{
+	return( b.linear( 1.0, a ) ); 
+}
+
+VImage 
+operator+( VImage a, std::vector<double> b ) 
+{ 
+	return( a.linear( 1.0, b ) ); 
+}
+
+VImage & 
+operator+=( VImage a, const VImage b )
+{
+	return( a = a + b ); 
+}
+
+VImage & 
+operator+=( VImage a, const double b )
+{
+	return( a = a + b ); 
+}
+
+VImage & 
+operator+=( VImage a, std::vector<double> b )
+{
+	return( a = a + b ); 
+}
+
+VImage 
+operator-( VImage a, VImage b ) 
+{
+	return( a.subtract( b ) );
+}
+
+VImage 
+operator-( double a, VImage b ) 
+{
+	return( b.linear( -1.0, a ) ); 
+}
+
+VImage 
+operator-( VImage a, double b ) 
+{ 
+	return( a.linear( 1.0, -b ) ); 
+}
+
+VImage 
+operator-( std::vector<double> a, VImage b ) 
+{
+	return( b.linear( -1.0, a ) ); 
+}
+
+VImage 
+operator-( VImage a, std::vector<double> b ) 
+{ 
+	return( a.linear( 1.0, vips::negate( b ) ) ); 
+}
+
+VImage & 
+operator-=( VImage a, const VImage b )
+{
+	return( a = a - b ); 
+}
+
+VImage & 
+operator-=( VImage a, const double b )
+{
+	return( a = a - b ); 
+}
+
+VImage & 
+operator-=( VImage a, std::vector<double> b )
+{
+	return( a = a - b ); 
+}
+
+VImage 
+operator-( VImage a ) 
+{ 
+	return( a * -1 );
+}
+
+VImage 
+operator*( VImage a, VImage b ) 
+{
+	return( a.multiply( b ) );
+}
+
+VImage 
+operator*( double a, VImage b ) 
+{
+	return( b.linear( a, 0.0 ) ); 
+}
+
+VImage 
+operator*( VImage a, double b ) 
+{ 
+	return( a.linear( b, 0.0 ) ); 
+}
+
+VImage 
+operator*( std::vector<double> a, VImage b ) 
+{
+	return( b.linear( a, 0.0 ) ); 
+}
+
+VImage 
+operator*( VImage a, std::vector<double> b ) 
+{ 
+	return( a.linear( b, 0.0 ) ); 
+}
+
+VImage & 
+operator*=( VImage a, const VImage b )
+{
+	return( a = a * b ); 
+}
+
+VImage & 
+operator*=( VImage a, const double b )
+{
+	return( a = a * b ); 
+}
+
+VImage & 
+operator*=( VImage a, std::vector<double> b )
+{
+	return( a = a * b ); 
+}
+
+VImage 
+operator/( VImage a, VImage b ) 
+{
+	return( a.divide( b ) );
+}
+
+VImage 
+operator/( double a, VImage b ) 
+{
+	return( b.pow( -1.0 ).linear( a, 0.0 ) ); 
+}
+
+VImage 
+operator/( VImage a, double b ) 
+{ 
+	return( a.linear( 1.0 / b, 0.0 ) ); 
+}
+
+VImage 
+operator/( std::vector<double> a, VImage b ) 
+{
+	return( b.pow( -1.0 ).linear( a, 0.0 ) ); 
+}
+
+VImage 
+operator/( VImage a, std::vector<double> b ) 
+{ 
+	return( a.linear( vips::invert( b ), 0.0 ) ); 
+}
+
+VImage & 
+operator/=( VImage a, const VImage b )
+{
+	return( a = a / b ); 
+}
+
+VImage & 
+operator/=( VImage a, const double b )
+{
+	return( a = a / b ); 
+}
+
+VImage & 
+operator/=( VImage a, std::vector<double> b )
+{
+	return( a = a / b ); 
+}
+
+VImage 
+operator%( VImage a, VImage b ) 
+{
+	return( a.remainder( b ) );
+}
+
+VImage 
+operator%( VImage a, double b ) 
+{ 
+	return( a.remainder_const( to_vector( b ) ) ); 
+}
+
+VImage 
+operator%( VImage a, std::vector<double> b ) 
+{ 
+	return( a.remainder_const( b ) ); 
+}
+
+VImage & 
+operator%=( VImage a, const VImage b )
+{
+	return( a = a % b ); 
+}
+
+VImage & 
+operator%=( VImage a, const double b )
+{
+	return( a = a % b ); 
+}
+
+VImage & 
+operator%=( VImage a, std::vector<double> b )
+{
+	return( a = a % b ); 
+}
+
+VImage 
+operator<( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_LESS ) );
+}
+
+VImage 
+operator<( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_MORE ) );
+}
+
+VImage 
+operator<( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_LESS ) );
+}
+
+VImage 
+operator<( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_MORE ) );
+}
+
+VImage 
+operator<( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_LESS ) );
+}
+
+VImage 
+operator<=( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_LESSEQ ) );
+}
+
+VImage 
+operator<=( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_MOREEQ ) );
+}
+
+VImage 
+operator<=( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_LESSEQ ) );
+}
+
+VImage 
+operator<=( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_MOREEQ ) );
+}
+
+VImage 
+operator<=( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_LESSEQ ) );
+}
+
+VImage 
+operator>( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_MORE ) );
+}
+
+VImage 
+operator>( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_LESS ) );
+}
+
+VImage 
+operator>( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_MORE ) );
+}
+
+VImage 
+operator>( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_LESS ) );
+}
+
+VImage 
+operator>( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_MORE ) );
+}
+
+VImage 
+operator>=( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_MOREEQ ) );
+}
+
+VImage 
+operator>=( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_LESSEQ ) );
+}
+
+VImage 
+operator>=( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_MOREEQ ) );
+}
+
+VImage 
+operator>=( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_LESSEQ ) );
+}
+
+VImage 
+operator>=( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_MOREEQ ) );
+}
+
+VImage 
+operator==( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_EQUAL ) );
+}
+
+VImage 
+operator==( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_EQUAL ) );
+}
+
+VImage 
+operator==( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_EQUAL ) );
+}
+
+VImage 
+operator==( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_EQUAL ) );
+}
+
+VImage 
+operator==( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_EQUAL ) );
+}
+
+VImage 
+operator!=( VImage a, VImage b ) 
+{
+	return( a.relational( b, VIPS_OPERATION_RELATIONAL_NOTEQ ) );
+}
+
+VImage 
+operator!=( double a, VImage b ) 
+{
+	return( b.relational_const( to_vector( a ), 
+		VIPS_OPERATION_RELATIONAL_NOTEQ ) );
+}
+
+VImage 
+operator!=( VImage a, double b ) 
+{ 
+	return( a.relational_const( to_vector( b ), 
+		VIPS_OPERATION_RELATIONAL_NOTEQ ) );
+}
+
+VImage 
+operator!=( std::vector<double> a, VImage b ) 
+{
+	return( b.relational_const( a, 
+		VIPS_OPERATION_RELATIONAL_NOTEQ ) );
+}
+
+VImage 
+operator!=( VImage a, std::vector<double> b ) 
+{ 
+	return( a.relational_const( b, 
+		VIPS_OPERATION_RELATIONAL_NOTEQ ) );
+}
+
+VImage 
+operator&( VImage a, VImage b ) 
+{
+	return( a.boolean( b, VIPS_OPERATION_BOOLEAN_AND ) );
+}
+
+VImage 
+operator&( double a, VImage b ) 
+{
+	return( b.boolean_const( to_vector( a ), 
+		VIPS_OPERATION_BOOLEAN_AND ) );
+}
+
+VImage 
+operator&( VImage a, double b ) 
+{ 
+	return( a.boolean_const( to_vector( b ), 
+		VIPS_OPERATION_BOOLEAN_AND ) );
+}
+
+VImage 
+operator&( std::vector<double> a, VImage b ) 
+{
+	return( b.boolean_const( a, VIPS_OPERATION_BOOLEAN_AND ) );
+}
+
+VImage 
+operator&( VImage a, std::vector<double> b ) 
+{ 
+	return( a.boolean_const( b, VIPS_OPERATION_BOOLEAN_AND ) );
+}
+
+VImage & 
+operator&=( VImage a, const VImage b )
+{
+	return( a = a & b ); 
+}
+
+VImage & 
+operator&=( VImage a, const double b )
+{
+	return( a = a & b ); 
+}
+
+VImage & 
+operator&=( VImage a, std::vector<double> b )
+{
+	return( a = a & b ); 
+}
+
+VImage 
+operator|( VImage a, VImage b ) 
+{
+	return( a.boolean( b, VIPS_OPERATION_BOOLEAN_OR ) );
+}
+
+VImage 
+operator|( double a, VImage b ) 
+{
+	return( b.boolean_const( to_vector( a ), 
+		VIPS_OPERATION_BOOLEAN_OR ) );
+}
+
+VImage 
+operator|( VImage a, double b ) 
+{ 
+	return( a.boolean_const( to_vector( b ), 
+		VIPS_OPERATION_BOOLEAN_OR ) );
+}
+
+VImage 
+operator|( std::vector<double> a, VImage b ) 
+{
+	return( b.boolean_const( a, VIPS_OPERATION_BOOLEAN_OR ) );
+}
+
+VImage 
+operator|( VImage a, std::vector<double> b ) 
+{ 
+	return( a.boolean_const( b, VIPS_OPERATION_BOOLEAN_OR ) );
+}
+
+VImage & 
+operator|=( VImage a, const VImage b )
+{
+	return( a = a | b ); 
+}
+
+VImage & 
+operator|=( VImage a, const double b )
+{
+	return( a = a | b ); 
+}
+
+VImage & 
+operator|=( VImage a, std::vector<double> b )
+{
+	return( a = a | b ); 
+}
+
+VImage 
+operator^( VImage a, VImage b ) 
+{
+	return( a.boolean( b, VIPS_OPERATION_BOOLEAN_EOR ) );
+}
+
+VImage 
+operator^( double a, VImage b ) 
+{
+	return( b.boolean_const( to_vector( a ), 
+		VIPS_OPERATION_BOOLEAN_EOR ) );
+}
+
+VImage 
+operator^( VImage a, double b ) 
+{ 
+	return( a.boolean_const( to_vector( b ), 
+		VIPS_OPERATION_BOOLEAN_EOR ) );
+}
+
+VImage 
+operator^( std::vector<double> a, VImage b ) 
+{
+	return( b.boolean_const( a, VIPS_OPERATION_BOOLEAN_EOR ) );
+}
+
+VImage 
+operator^( VImage a, std::vector<double> b ) 
+{ 
+	return( a.boolean_const( b, VIPS_OPERATION_BOOLEAN_EOR ) );
+}
+
+VImage & 
+operator^=( VImage a, const VImage b )
+{
+	return( a = a ^ b ); 
+}
+
+VImage & 
+operator^=( VImage a, const double b )
+{
+	return( a = a ^ b ); 
+}
+
+VImage & 
+operator^=( VImage a, std::vector<double> b )
+{
+	return( a = a ^ b ); 
+}
+
+VImage 
+operator<<( VImage a, VImage b ) 
+{
+	return( a.boolean( b, VIPS_OPERATION_BOOLEAN_LSHIFT ) );
+}
+
+VImage 
+operator<<( VImage a, double b ) 
+{ 
+	return( a.boolean_const( to_vector( b ), 
+		VIPS_OPERATION_BOOLEAN_LSHIFT ) ); 
+}
+
+VImage 
+operator<<( VImage a, std::vector<double> b ) 
+{ 
+	return( a.boolean_const( b, VIPS_OPERATION_BOOLEAN_LSHIFT ) ); 
+}
+
+VImage & 
+operator<<=( VImage a, const VImage b )
+{
+	return( a = a << b ); 
+}
+
+VImage & 
+operator<<=( VImage a, const double b )
+{
+	return( a = a << b ); 
+}
+
+VImage & 
+operator<<=( VImage a, std::vector<double> b )
+{
+	return( a = a << b ); 
+}
+
+VImage 
+operator>>( VImage a, VImage b ) 
+{
+	return( a.boolean( b, VIPS_OPERATION_BOOLEAN_RSHIFT ) );
+}
+
+VImage 
+operator>>( VImage a, double b ) 
+{ 
+	return( a.boolean_const( to_vector( b ), 
+		VIPS_OPERATION_BOOLEAN_RSHIFT ) ); 
+}
+
+VImage 
+operator>>( VImage a, std::vector<double> b ) 
+{ 
+	return( a.boolean_const( b, VIPS_OPERATION_BOOLEAN_RSHIFT ) ); 
+}
+
+VImage & 
+operator>>=( VImage a, const VImage b )
+{
+	return( a = a << b ); 
+}
+
+VImage & 
+operator>>=( VImage a, const double b )
+{
+	return( a = a << b ); 
+}
+
+VImage & 
+operator>>=( VImage a, std::vector<double> b )
+{
+	return( a = a << b ); 
+}
+
 VIPS_NAMESPACE_END

src/libvips/cplusplus/vips-operators.cpp

@@ -1,5 +1,5 @@
 // bodies for vips operations
-// Sat Jan  9 15:05:58 GMT 2016
+// Thu 18 Aug 16:01:57 BST 2016
 // this file is generated automatically, do not edit!
 
 void VImage::system( char * cmd_format , VOption *options )
@@ -1321,26 +1321,28 @@ VImage VImage::fractsurf( int width , int height , double fractal_dimension , VO
     return( out );
 }
 
-VImage VImage::radload( char * filename , VOption *options )
+VImage VImage::worley( int width , int height , VOption *options )
 {
     VImage out;
 
-    call( "radload" ,
+    call( "worley" ,
         (options ? options : VImage::option()) ->
-            set( "filename", filename ) ->
+            set( "out", &out ) ->
-            set( "out", &out ) );
+            set( "width", width ) ->
+            set( "height", height ) );
 
     return( out );
 }
 
-VImage VImage::ppmload( char * filename , VOption *options )
+VImage VImage::perlin( int width , int height , VOption *options )
 {
     VImage out;
 
-    call( "ppmload" ,
+    call( "perlin" ,
         (options ? options : VImage::option()) ->
-            set( "filename", filename ) ->
+            set( "out", &out ) ->
-            set( "out", &out ) );
+            set( "width", width ) ->
+            set( "height", height ) );
 
     return( out );
 }
@@ -1369,18 +1371,6 @@ VImage VImage::matrixload( char * filename , VOption *options )
     return( out );
 }
 
-VImage VImage::analyzeload( char * filename , VOption *options )
-{
-    VImage out;
-
-    call( "analyzeload" ,
-        (options ? options : VImage::option()) ->
-            set( "filename", filename ) ->
-            set( "out", &out ) );
-
-    return( out );
-}
-
 VImage VImage::rawload( char * filename , int width , int height , int bands , VOption *options )
 {
     VImage out;
@@ -1408,6 +1398,114 @@ VImage VImage::vipsload( char * filename , VOption *options )
     return( out );
 }
 
+VImage VImage::analyzeload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "analyzeload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::ppmload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "ppmload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::radload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "radload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::pdfload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "pdfload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::pdfload_buffer( VipsBlob * buffer , VOption *options )
+{
+    VImage out;
+
+    call( "pdfload_buffer" ,
+        (options ? options : VImage::option()) ->
+            set( "buffer", buffer ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::svgload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "svgload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::svgload_buffer( VipsBlob * buffer , VOption *options )
+{
+    VImage out;
+
+    call( "svgload_buffer" ,
+        (options ? options : VImage::option()) ->
+            set( "buffer", buffer ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::gifload( char * filename , VOption *options )
+{
+    VImage out;
+
+    call( "gifload" ,
+        (options ? options : VImage::option()) ->
+            set( "filename", filename ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
+VImage VImage::gifload_buffer( VipsBlob * buffer , VOption *options )
+{
+    VImage out;
+
+    call( "gifload_buffer" ,
+        (options ? options : VImage::option()) ->
+            set( "buffer", buffer ) ->
+            set( "out", &out ) );
+
+    return( out );
+}
+
 VImage VImage::pngload( char * filename , VOption *options )
 {
     VImage out;
@@ -1576,22 +1674,6 @@ VImage VImage::openexrload( char * filename , VOption *options )
     return( out );
 }
 
-void VImage::radsave( char * filename , VOption *options )
-{
-    call( "radsave" ,
-        (options ? options : VImage::option()) ->
-            set( "in", *this ) ->
-            set( "filename", filename ) );
-}
-
-void VImage::ppmsave( char * filename , VOption *options )
-{
-    call( "ppmsave" ,
-        (options ? options : VImage::option()) ->
-            set( "in", *this ) ->
-            set( "filename", filename ) );
-}
-
 void VImage::csvsave( char * filename , VOption *options )
 {
     call( "csvsave" ,
@@ -1639,6 +1721,34 @@ void VImage::vipssave( char * filename , VOption *options )
             set( "filename", filename ) );
 }
 
+void VImage::ppmsave( char * filename , VOption *options )
+{
+    call( "ppmsave" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "filename", filename ) );
+}
+
+void VImage::radsave( char * filename , VOption *options )
+{
+    call( "radsave" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "filename", filename ) );
+}
+
+VipsBlob * VImage::radsave_buffer( VOption *options )
+{
+    VipsBlob * buffer;
+
+    call( "radsave_buffer" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "buffer", &buffer ) );
+
+    return( buffer );
+}
+
 void VImage::dzsave( char * filename , VOption *options )
 {
     call( "dzsave" ,
@@ -1743,7 +1853,7 @@ VImage VImage::mapim( VImage index , VOption *options )
     return( out );
 }
 
-VImage VImage::shrink( double xshrink , double yshrink , VOption *options )
+VImage VImage::shrink( double hshrink , double vshrink , VOption *options )
 {
     VImage out;
 
@@ -1751,13 +1861,13 @@ VImage VImage::shrink( double xshrink , double yshrink , VOption *options )
         (options ? options : VImage::option()) ->
             set( "in", *this ) ->
             set( "out", &out ) ->
-            set( "xshrink", xshrink ) ->
+            set( "hshrink", hshrink ) ->
-            set( "yshrink", yshrink ) );
+            set( "vshrink", vshrink ) );
 
     return( out );
 }
 
-VImage VImage::shrinkh( int xshrink , VOption *options )
+VImage VImage::shrinkh( int hshrink , VOption *options )
 {
     VImage out;
 
@@ -1765,12 +1875,12 @@ VImage VImage::shrinkh( int xshrink , VOption *options )
         (options ? options : VImage::option()) ->
             set( "in", *this ) ->
             set( "out", &out ) ->
-            set( "xshrink", xshrink ) );
+            set( "hshrink", hshrink ) );
 
     return( out );
 }
 
-VImage VImage::shrinkv( int yshrink , VOption *options )
+VImage VImage::shrinkv( int vshrink , VOption *options )
 {
     VImage out;
 
@@ -1778,21 +1888,47 @@ VImage VImage::shrinkv( int yshrink , VOption *options )
         (options ? options : VImage::option()) ->
             set( "in", *this ) ->
             set( "out", &out ) ->
-            set( "yshrink", yshrink ) );
+            set( "vshrink", vshrink ) );
 
     return( out );
 }
 
-VImage VImage::shrink2( double xshrink , double yshrink , VOption *options )
+VImage VImage::reduceh( double hshrink , VOption *options )
 {
     VImage out;
 
-    call( "shrink2" ,
+    call( "reduceh" ,
         (options ? options : VImage::option()) ->
             set( "in", *this ) ->
             set( "out", &out ) ->
-            set( "xshrink", xshrink ) ->
+            set( "hshrink", hshrink ) );
-            set( "yshrink", yshrink ) );
+
+    return( out );
+}
+
+VImage VImage::reducev( double vshrink , VOption *options )
+{
+    VImage out;
+
+    call( "reducev" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "vshrink", vshrink ) );
+
+    return( out );
+}
+
+VImage VImage::reduce( double hshrink , double vshrink , VOption *options )
+{
+    VImage out;
+
+    call( "reduce" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "hshrink", hshrink ) ->
+            set( "vshrink", vshrink ) );
 
     return( out );
 }
@@ -2377,6 +2513,45 @@ VImage VImage::conv( VImage mask , VOption *options )
     return( out );
 }
 
+VImage VImage::conva( VImage mask , VOption *options )
+{
+    VImage out;
+
+    call( "conva" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "mask", mask ) );
+
+    return( out );
+}
+
+VImage VImage::convf( VImage mask , VOption *options )
+{
+    VImage out;
+
+    call( "convf" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "mask", mask ) );
+
+    return( out );
+}
+
+VImage VImage::convi( VImage mask , VOption *options )
+{
+    VImage out;
+
+    call( "convi" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "mask", mask ) );
+
+    return( out );
+}
+
 VImage VImage::compass( VImage mask , VOption *options )
 {
     VImage out;
@@ -2403,6 +2578,19 @@ VImage VImage::convsep( VImage mask , VOption *options )
     return( out );
 }
 
+VImage VImage::convasep( VImage mask , VOption *options )
+{
+    VImage out;
+
+    call( "convasep" ,
+        (options ? options : VImage::option()) ->
+            set( "in", *this ) ->
+            set( "out", &out ) ->
+            set( "mask", mask ) );
+
+    return( out );
+}
+
 VImage VImage::fastcor( VImage ref , VOption *options )
 {
     VImage out;

src/metadata.cc

@@ -1,135 +1,68 @@
-#include <node.h>
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-#include <vips/vips8>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
-#include "nan.h"
+#include <numeric>
+#include <vector>
+
+#include <node.h>
+#include <nan.h>
+#include <vips/vips8>
 
 #include "common.h"
 #include "metadata.h"
 
-using v8::Handle;
+class MetadataWorker : public Nan::AsyncWorker {
-using v8::Local;
-using v8::Value;
-using v8::Object;
-using v8::Number;
-using v8::String;
-using v8::Boolean;
-using v8::Function;
-using v8::Exception;
-
-using Nan::AsyncQueueWorker;
-using Nan::AsyncWorker;
-using Nan::Callback;
-using Nan::HandleScope;
-using Nan::Utf8String;
-using Nan::Has;
-using Nan::Get;
-using Nan::Set;
-using Nan::New;
-using Nan::NewBuffer;
-using Nan::Null;
-using Nan::Error;
-
-using vips::VImage;
-using vips::VError;
-
-using sharp::ImageType;
-using sharp::ImageTypeId;
-using sharp::DetermineImageType;
-using sharp::HasProfile;
-using sharp::HasAlpha;
-using sharp::ExifOrientation;
-using sharp::HasDensity;
-using sharp::GetDensity;
-using sharp::FreeCallback;
-using sharp::counterQueue;
-
-struct MetadataBaton {
-  // Input
-  std::string fileIn;
-  char *bufferIn;
-  size_t bufferInLength;
-  // Output
-  std::string format;
-  int width;
-  int height;
-  std::string space;
-  int channels;
-  int density;
-  bool hasProfile;
-  bool hasAlpha;
-  int orientation;
-  char *exif;
-  size_t exifLength;
-  char *icc;
-  size_t iccLength;
-  std::string err;
-
-  MetadataBaton():
-    bufferInLength(0),
-    density(0),
-    orientation(0),
-    exifLength(0),
-    iccLength(0) {}
-};
-
-class MetadataWorker : public AsyncWorker {
  public:
-  MetadataWorker(Callback *callback, MetadataBaton *baton, const Local<Object> &bufferIn) :
+  MetadataWorker(
-    AsyncWorker(callback), baton(baton) {
+    Nan::Callback *callback, MetadataBaton *baton,
-      if (baton->bufferInLength > 0) {
+    std::vector<v8::Local<v8::Object>> const buffersToPersist)
-        SaveToPersistent("bufferIn", bufferIn);
+    : Nan::AsyncWorker(callback), baton(baton), buffersToPersist(buffersToPersist) {
-      }
+    // Protect Buffer objects from GC, keyed on index
-    }
+    std::accumulate(buffersToPersist.begin(), buffersToPersist.end(), 0,
+      [this](uint32_t index, v8::Local<v8::Object> const buffer) -> uint32_t {
+        SaveToPersistent(index, buffer);
+        return index + 1;
+      });
+  }
   ~MetadataWorker() {}
 
   void Execute() {
     // Decrement queued task counter
-    g_atomic_int_dec_and_test(&counterQueue);
+    g_atomic_int_dec_and_test(&sharp::counterQueue);
 
-    ImageType imageType = ImageType::UNKNOWN;
+    vips::VImage image;
-    VImage image;
+    sharp::ImageType imageType = sharp::ImageType::UNKNOWN;
-    if (baton->bufferInLength > 0) {
+    try {
-      // From buffer
+      std::tie(image, imageType) = OpenInput(baton->input, VIPS_ACCESS_SEQUENTIAL);
-      imageType = DetermineImageType(baton->bufferIn, baton->bufferInLength);
+    } catch (vips::VError const &err) {
-      if (imageType != ImageType::UNKNOWN) {
+      (baton->err).append(err.what());
-        try {
-          image = VImage::new_from_buffer(baton->bufferIn, baton->bufferInLength, nullptr);
-        } catch (...) {
-          (baton->err).append("Input buffer has corrupt header");
-          imageType = ImageType::UNKNOWN;
-        }
-      } else {
-        (baton->err).append("Input buffer contains unsupported image format");
-      }
-    } else {
-      // From file
-      imageType = DetermineImageType(baton->fileIn.data());
-      if (imageType != ImageType::UNKNOWN) {
-        try {
-          image = VImage::new_from_file(baton->fileIn.data());
-        } catch (...) {
-          (baton->err).append("Input file has corrupt header");
-          imageType = ImageType::UNKNOWN;
-        }
-      } else {
-        (baton->err).append("Input file is missing or of an unsupported image format");
-      }
     }
-    if (imageType != ImageType::UNKNOWN) {
+    if (imageType != sharp::ImageType::UNKNOWN) {
       // Image type
-      baton->format = ImageTypeId(imageType);
+      baton->format = sharp::ImageTypeId(imageType);
       // VipsImage attributes
       baton->width = image.width();
       baton->height = image.height();
       baton->space = vips_enum_nick(VIPS_TYPE_INTERPRETATION, image.interpretation());
       baton->channels = image.bands();
-      if (HasDensity(image)) {
+      if (sharp::HasDensity(image)) {
-        baton->density = GetDensity(image);
+        baton->density = sharp::GetDensity(image);
       }
-      baton->hasProfile = HasProfile(image);
+      baton->hasProfile = sharp::HasProfile(image);
       // Derived attributes
-      baton->hasAlpha = HasAlpha(image);
+      baton->hasAlpha = sharp::HasAlpha(image);
-      baton->orientation = ExifOrientation(image);
+      baton->orientation = sharp::ExifOrientation(image);
       // EXIF
       if (image.get_typeof(VIPS_META_EXIF_NAME) == VIPS_TYPE_BLOB) {
         size_t exifLength;
@@ -147,53 +80,56 @@ class MetadataWorker : public AsyncWorker {
         baton->iccLength = iccLength;
       }
     }
+
     // Clean up
     vips_error_clear();
     vips_thread_shutdown();
   }
 
-  void HandleOKCallback () {
+  void HandleOKCallback() {
-    HandleScope();
+    using Nan::New;
+    using Nan::Set;
+    Nan::HandleScope();
 
-    Local<Value> argv[2] = { Null(), Null() };
+    v8::Local<v8::Value> argv[2] = { Nan::Null(), Nan::Null() };
     if (!baton->err.empty()) {
-      // Error
+      argv[0] = Nan::Error(baton->err.data());
-      argv[0] = Error(baton->err.data());
     } else {
       // Metadata Object
-      Local<Object> info = New<Object>();
+      v8::Local<v8::Object> info = New<v8::Object>();
-      Set(info, New("format").ToLocalChecked(), New<String>(baton->format).ToLocalChecked());
+      Set(info, New("format").ToLocalChecked(), New<v8::String>(baton->format).ToLocalChecked());
-      Set(info, New("width").ToLocalChecked(), New<Number>(baton->width));
+      Set(info, New("width").ToLocalChecked(), New<v8::Uint32>(baton->width));
-      Set(info, New("height").ToLocalChecked(), New<Number>(baton->height));
+      Set(info, New("height").ToLocalChecked(), New<v8::Uint32>(baton->height));
-      Set(info, New("space").ToLocalChecked(), New<String>(baton->space).ToLocalChecked());
+      Set(info, New("space").ToLocalChecked(), New<v8::String>(baton->space).ToLocalChecked());
-      Set(info, New("channels").ToLocalChecked(), New<Number>(baton->channels));
+      Set(info, New("channels").ToLocalChecked(), New<v8::Uint32>(baton->channels));
       if (baton->density > 0) {
-        Set(info, New("density").ToLocalChecked(), New<Number>(baton->density));
+        Set(info, New("density").ToLocalChecked(), New<v8::Uint32>(baton->density));
       }
-      Set(info, New("hasProfile").ToLocalChecked(), New<Boolean>(baton->hasProfile));
+      Set(info, New("hasProfile").ToLocalChecked(), New<v8::Boolean>(baton->hasProfile));
-      Set(info, New("hasAlpha").ToLocalChecked(), New<Boolean>(baton->hasAlpha));
+      Set(info, New("hasAlpha").ToLocalChecked(), New<v8::Boolean>(baton->hasAlpha));
       if (baton->orientation > 0) {
-        Set(info, New("orientation").ToLocalChecked(), New<Number>(baton->orientation));
+        Set(info, New("orientation").ToLocalChecked(), New<v8::Uint32>(baton->orientation));
       }
       if (baton->exifLength > 0) {
         Set(info,
           New("exif").ToLocalChecked(),
-          NewBuffer(baton->exif, baton->exifLength, FreeCallback, nullptr).ToLocalChecked()
+          Nan::NewBuffer(baton->exif, baton->exifLength, sharp::FreeCallback, nullptr).ToLocalChecked());
-        );
       }
       if (baton->iccLength > 0) {
         Set(info,
           New("icc").ToLocalChecked(),
-          NewBuffer(baton->icc, baton->iccLength, FreeCallback, nullptr).ToLocalChecked()
+          Nan::NewBuffer(baton->icc, baton->iccLength, sharp::FreeCallback, nullptr).ToLocalChecked());
-        );
       }
       argv[1] = info;
     }
 
-    // Dispose of Persistent wrapper around input Buffer so it can be garbage collected
+    // Dispose of Persistent wrapper around input Buffers so they can be garbage collected
-    if (baton->bufferInLength > 0) {
+    std::accumulate(buffersToPersist.begin(), buffersToPersist.end(), 0,
-      GetFromPersistent("bufferIn");
+      [this](uint32_t index, v8::Local<v8::Object> const buffer) -> uint32_t {
-    }
+        GetFromPersistent(index);
+        return index + 1;
+      });
+    delete baton->input;
     delete baton;
 
     // Return to JavaScript
@@ -202,32 +138,27 @@ class MetadataWorker : public AsyncWorker {
 
  private:
   MetadataBaton* baton;
+  std::vector<v8::Local<v8::Object>> buffersToPersist;
 };
 
 /*
   metadata(options, callback)
 */
 NAN_METHOD(metadata) {
-  HandleScope();
+  // Input Buffers must not undergo GC compaction during processing
+  std::vector<v8::Local<v8::Object>> buffersToPersist;
 
   // V8 objects are converted to non-V8 types held in the baton struct
   MetadataBaton *baton = new MetadataBaton;
-  Local<Object> options = info[0].As<Object>();
+  v8::Local<v8::Object> options = info[0].As<v8::Object>();
 
-  // Input filename
+  // Input
-  baton->fileIn = *Utf8String(Get(options, New("fileIn").ToLocalChecked()).ToLocalChecked());
+  baton->input = sharp::CreateInputDescriptor(sharp::AttrAs<v8::Object>(options, "input"), buffersToPersist);
-  // Input Buffer object
-  Local<Object> bufferIn;
-  if (node::Buffer::HasInstance(Get(options, New("bufferIn").ToLocalChecked()).ToLocalChecked())) {
-    bufferIn = Get(options, New("bufferIn").ToLocalChecked()).ToLocalChecked().As<Object>();
-    baton->bufferInLength = node::Buffer::Length(bufferIn);
-    baton->bufferIn = node::Buffer::Data(bufferIn);
-  }
 
   // Join queue for worker thread
-  Callback *callback = new Callback(info[1].As<Function>());
+  Nan::Callback *callback = new Nan::Callback(info[1].As<v8::Function>());
-  AsyncQueueWorker(new MetadataWorker(callback, baton, bufferIn));
+  Nan::AsyncQueueWorker(new MetadataWorker(callback, baton, buffersToPersist));
 
   // Increment queued task counter
-  g_atomic_int_inc(&counterQueue);
+  g_atomic_int_inc(&sharp::counterQueue);
 }

src/metadata.h

@@ -1,7 +1,58 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #ifndef SRC_METADATA_H_
 #define SRC_METADATA_H_
 
-#include "nan.h"
+#include <string>
+#include <nan.h>
+
+#include "./common.h"
+
+struct MetadataBaton {
+  // Input
+  sharp::InputDescriptor *input;
+  // Output
+  std::string format;
+  int width;
+  int height;
+  std::string space;
+  int channels;
+  int density;
+  bool hasProfile;
+  bool hasAlpha;
+  int orientation;
+  char *exif;
+  size_t exifLength;
+  char *icc;
+  size_t iccLength;
+  std::string err;
+
+  MetadataBaton():
+    input(nullptr),
+    width(0),
+    height(0),
+    channels(0),
+    density(0),
+    hasProfile(false),
+    hasAlpha(false),
+    orientation(0),
+    exif(nullptr),
+    exifLength(0),
+    icc(nullptr),
+    iccLength(0) {}
+};
 
 NAN_METHOD(metadata);
 

src/operations.cc

@@ -1,5 +1,23 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #include <algorithm>
+#include <functional>
+#include <memory>
 #include <tuple>
+#include <vector>
+
 #include <vips/vips8>
 
 #include "common.h"
@@ -15,6 +33,46 @@ namespace sharp {
     Assumes alpha channels are already premultiplied and will be unpremultiplied after.
    */
   VImage Composite(VImage src, VImage dst, const int gravity) {
+    if (IsInputValidForComposition(src, dst)) {
+      // Enlarge overlay src, if required
+      if (src.width() < dst.width() || src.height() < dst.height()) {
+        // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
+        int left;
+        int top;
+        std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), src.width(), src.height(), gravity);
+        // Embed onto transparent background
+        std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
+        src = src.embed(left, top, dst.width(), dst.height(), VImage::option()
+          ->set("extend", VIPS_EXTEND_BACKGROUND)
+          ->set("background", background));
+      }
+      return CompositeImage(src, dst);
+    }
+    // If the input was not valid for composition the return the input image itself
+    return dst;
+  }
+
+  VImage Composite(VImage src, VImage dst, const int x, const int y) {
+    if (IsInputValidForComposition(src, dst)) {
+      // Enlarge overlay src, if required
+      if (src.width() < dst.width() || src.height() < dst.height()) {
+        // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
+        int left;
+        int top;
+        std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), src.width(), src.height(), x, y);
+        // Embed onto transparent background
+        std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
+        src = src.embed(left, top, dst.width(), dst.height(), VImage::option()
+          ->set("extend", VIPS_EXTEND_BACKGROUND)
+          ->set("background", background));
+      }
+      return CompositeImage(src, dst);
+    }
+    // If the input was not valid for composition the return the input image itself
+    return dst;
+  }
+
+  bool IsInputValidForComposition(VImage src, VImage dst) {
     using sharp::CalculateCrop;
     using sharp::HasAlpha;
 
@@ -28,20 +86,10 @@ namespace sharp {
       throw VError("Overlay image must have same dimensions or smaller");
     }
 
-    // Enlarge overlay src, if required
+    return true;
-    if (src.width() < dst.width() || src.height() < dst.height()) {
+  }
-      // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
-      int left;
-      int top;
-      std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), src.width(), src.height(), gravity);
-      // Embed onto transparent background
-      std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
-      src = src.embed(left, top, dst.width(), dst.height(), VImage::option()
-        ->set("extend", VIPS_EXTEND_BACKGROUND)
-        ->set("background", background)
-      );
-    }
 
+  VImage CompositeImage(VImage src, VImage dst) {
     // Split src into non-alpha and alpha channels
     VImage srcWithoutAlpha = src.extract_band(0, VImage::option()->set("n", src.bands() - 1));
     VImage srcAlpha = src[src.bands() - 1] * (1.0 / 255.0);
@@ -81,10 +129,68 @@ namespace sharp {
     return outRGBPremultiplied.bandjoin(outAlphaNormalized * 255.0);
   }
 
+  /*
+    Cutout src over dst with given gravity.
+   */
+  VImage Cutout(VImage mask, VImage dst, const int gravity) {
+    using sharp::CalculateCrop;
+    using sharp::HasAlpha;
+    using sharp::MaximumImageAlpha;
+
+    bool maskHasAlpha = HasAlpha(mask);
+
+    if (!maskHasAlpha && mask.bands() > 1) {
+      throw VError("Overlay image must have an alpha channel or one band");
+    }
+    if (!HasAlpha(dst)) {
+      throw VError("Image to be overlaid must have an alpha channel");
+    }
+    if (mask.width() > dst.width() || mask.height() > dst.height()) {
+      throw VError("Overlay image must have same dimensions or smaller");
+    }
+
+    // Enlarge overlay mask, if required
+    if (mask.width() < dst.width() || mask.height() < dst.height()) {
+      // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
+      int left;
+      int top;
+      std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), mask.width(), mask.height(), gravity);
+      // Embed onto transparent background
+      std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
+      mask = mask.embed(left, top, dst.width(), dst.height(), VImage::option()
+              ->set("extend", VIPS_EXTEND_BACKGROUND)
+              ->set("background", background));
+    }
+
+    // we use the mask alpha if it has alpha
+    if (maskHasAlpha) {
+      mask = mask.extract_band(mask.bands() - 1, VImage::option()->set("n", 1));;
+    }
+
+    // Split dst into an optional alpha
+    VImage dstAlpha = dst.extract_band(dst.bands() - 1, VImage::option()->set("n", 1));
+
+    // we use the dst non-alpha
+    dst = dst.extract_band(0, VImage::option()->set("n", dst.bands() - 1));
+
+    // the range of the mask and the image need to match .. one could be
+    // 16-bit, one 8-bit
+    double const dstMax = MaximumImageAlpha(dst.interpretation());
+    double const maskMax = MaximumImageAlpha(mask.interpretation());
+
+    // combine the new mask and the existing alpha ... there are
+    // many ways of doing this, mult is the simplest
+    mask = dstMax * ((mask / maskMax) * (dstAlpha / dstMax));
+
+    // append the mask to the image data ... the mask might be float now,
+    // we must cast the format down to match the image data
+    return dst.bandjoin(mask.cast(dst.format()));
+  }
+
   /*
    * Stretch luminance to cover full dynamic range.
    */
-  VImage Normalize(VImage image) {
+  VImage Normalise(VImage image) {
     // Get original colourspace
     VipsInterpretation typeBeforeNormalize = image.interpretation();
     if (typeBeforeNormalize == VIPS_INTERPRETATION_RGB) {
@@ -135,10 +241,10 @@ namespace sharp {
   }
 
   /*
-   * Gaussian blur (use sigma <0 for fast blur)
+   * Gaussian blur. Use sigma of -1.0 for fast blur.
    */
   VImage Blur(VImage image, double const sigma) {
-    if (sigma < 0.0) {
+    if (sigma == -1.0) {
       // Fast, mild blur - averages neighbouring pixels
       VImage blur = VImage::new_matrixv(3, 3,
         1.0, 1.0, 1.0,
@@ -153,10 +259,30 @@ namespace sharp {
   }
 
   /*
-   * Sharpen flat and jagged areas. Use radius of -1 for fast sharpen.
+   * Convolution with a kernel.
    */
-  VImage Sharpen(VImage image, int const radius, double const flat, double const jagged) {
+  VImage Convolve(VImage image, int const width, int const height,
-    if (radius == -1) {
+    double const scale, double const offset,
+    std::unique_ptr<double[]> const &kernel_v
+  ) {
+    VImage kernel = VImage::new_from_memory(
+      kernel_v.get(),
+      width * height * sizeof(double),
+      width,
+      height,
+      1,
+      VIPS_FORMAT_DOUBLE);
+    kernel.set("scale", scale);
+    kernel.set("offset", offset);
+
+    return image.conv(kernel);
+  }
+
+  /*
+   * Sharpen flat and jagged areas. Use sigma of -1.0 for fast sharpen.
+   */
+  VImage Sharpen(VImage image, double const sigma, double const flat, double const jagged) {
+    if (sigma == -1.0) {
       // Fast, mild sharpen
       VImage sharpen = VImage::new_matrixv(3, 3,
         -1.0, -1.0, -1.0,
@@ -166,75 +292,120 @@ namespace sharp {
       return image.conv(sharpen);
     } else {
       // Slow, accurate sharpen in LAB colour space, with control over flat vs jagged areas
+      VipsInterpretation colourspaceBeforeSharpen = image.interpretation();
+      if (colourspaceBeforeSharpen == VIPS_INTERPRETATION_RGB) {
+        colourspaceBeforeSharpen = VIPS_INTERPRETATION_sRGB;
+      }
       return image.sharpen(
-        VImage::option()->set("radius", radius)->set("m1", flat)->set("m2", jagged)
+        VImage::option()->set("sigma", sigma)->set("m1", flat)->set("m2", jagged))
-      );
+        .colourspace(colourspaceBeforeSharpen);
     }
   }
 
+  /*
+    Calculate the Shannon entropy
+  */
+  double EntropyStrategy::operator()(VImage image) {
+    return image.hist_find().hist_entropy();
+  }
+
+  /*
+    Calculate the intensity of edges, skin tone and saturation
+  */
+  double AttentionStrategy::operator()(VImage image) {
+    // Flatten RGBA onto a mid-grey background
+    if (image.bands() == 4 && HasAlpha(image)) {
+      double const midgrey = sharp::Is16Bit(image.interpretation()) ? 32768.0 : 128.0;
+      std::vector<double> background { midgrey, midgrey, midgrey };
+      image = image.flatten(VImage::option()->set("background", background));
+    }
+    // Convert to LAB colourspace
+    VImage lab = image.colourspace(VIPS_INTERPRETATION_LAB);
+    VImage l = lab[0];
+    VImage a = lab[1];
+    VImage b = lab[2];
+    // Edge detect luminosity with the Sobel operator
+    VImage sobel = vips::VImage::new_matrixv(3, 3,
+      -1.0, 0.0, 1.0,
+      -2.0, 0.0, 2.0,
+      -1.0, 0.0, 1.0);
+    VImage edges = l.conv(sobel).abs() + l.conv(sobel.rot90()).abs();
+    // Skin tone chroma thresholds trained with http://humanae.tumblr.com/
+    VImage skin = (a >= 3) & (a <= 22) & (b >= 4) & (b <= 31);
+    // Chroma >~50% saturation
+    VImage lch = lab.colourspace(VIPS_INTERPRETATION_LCH);
+    VImage c = lch[1];
+    VImage saturation = c > 60;
+    // Find maximum in combined saliency mask
+    VImage mask = edges + skin + saturation;
+    return mask.max();
+  }
+
   /*
     Calculate crop area based on image entropy
   */
-  std::tuple<int, int> EntropyCrop(VImage image, int const outWidth, int const outHeight) {
+  std::tuple<int, int> Crop(
+    VImage image, int const outWidth, int const outHeight, std::function<double(VImage)> strategy
+  ) {
     int left = 0;
     int top = 0;
     int const inWidth = image.width();
     int const inHeight = image.height();
     if (inWidth > outWidth) {
-      // Reduce width by repeated removing slices from edge with lowest entropy
+      // Reduce width by repeated removing slices from edge with lowest score
       int width = inWidth;
-      double leftEntropy = 0.0;
+      double leftScore = 0.0;
-      double rightEntropy = 0.0;
+      double rightScore = 0.0;
       // Max width of each slice
       int const maxSliceWidth = static_cast<int>(ceil((inWidth - outWidth) / 8.0));
       while (width > outWidth) {
         // Width of current slice
         int const slice = std::min(width - outWidth, maxSliceWidth);
-        if (leftEntropy == 0.0) {
+        if (leftScore == 0.0) {
-          // Update entropy of left slice
+          // Update score of left slice
-          leftEntropy = Entropy(image.extract_area(left, 0, slice, inHeight));
+          leftScore = strategy(image.extract_area(left, 0, slice, inHeight));
         }
-        if (rightEntropy == 0.0) {
+        if (rightScore == 0.0) {
-          // Update entropy of right slice
+          // Update score of right slice
-          rightEntropy = Entropy(image.extract_area(width - slice - 1, 0, slice, inHeight));
+          rightScore = strategy(image.extract_area(width - slice - 1, 0, slice, inHeight));
         }
-        // Keep slice with highest entropy
+        // Keep slice with highest score
-        if (leftEntropy >= rightEntropy) {
+        if (leftScore >= rightScore) {
           // Discard right slice
-          rightEntropy = 0.0;
+          rightScore = 0.0;
         } else {
           // Discard left slice
-          leftEntropy = 0.0;
+          leftScore = 0.0;
           left = left + slice;
         }
         width = width - slice;
       }
     }
     if (inHeight > outHeight) {
-      // Reduce height by repeated removing slices from edge with lowest entropy
+      // Reduce height by repeated removing slices from edge with lowest score
       int height = inHeight;
-      double topEntropy = 0.0;
+      double topScore = 0.0;
-      double bottomEntropy = 0.0;
+      double bottomScore = 0.0;
       // Max height of each slice
       int const maxSliceHeight = static_cast<int>(ceil((inHeight - outHeight) / 8.0));
       while (height > outHeight) {
         // Height of current slice
         int const slice = std::min(height - outHeight, maxSliceHeight);
-        if (topEntropy == 0.0) {
+        if (topScore == 0.0) {
-          // Update entropy of top slice
+          // Update score of top slice
-          topEntropy = Entropy(image.extract_area(0, top, inWidth, slice));
+          topScore = strategy(image.extract_area(0, top, inWidth, slice));
         }
-        if (bottomEntropy == 0.0) {
+        if (bottomScore == 0.0) {
-          // Update entropy of bottom slice
+          // Update score of bottom slice
-          bottomEntropy = Entropy(image.extract_area(0, height - slice - 1, inWidth, slice));
+          bottomScore = strategy(image.extract_area(0, height - slice - 1, inWidth, slice));
         }
-        // Keep slice with highest entropy
+        // Keep slice with highest score
-        if (topEntropy >= bottomEntropy) {
+        if (topScore >= bottomScore) {
           // Discard bottom slice
-          bottomEntropy = 0.0;
+          bottomScore = 0.0;
         } else {
           // Discard top slice
-          topEntropy = 0.0;
+          topScore = 0.0;
           top = top + slice;
         }
         height = height - slice;
@@ -244,10 +415,94 @@ namespace sharp {
   }
 
   /*
-    Calculate the Shannon entropy for an image
+    Insert a tile cache to prevent over-computation of any previous operations in the pipeline
   */
-  double Entropy(VImage image) {
+  VImage TileCache(VImage image, double const factor) {
-    return image.hist_find().hist_entropy();
+    int tile_width;
+    int tile_height;
+    int scanline_count;
+    vips_get_tile_size(image.get_image(), &tile_width, &tile_height, &scanline_count);
+    double const need_lines = 1.2 * scanline_count / factor;
+    return image.tilecache(VImage::option()
+      ->set("tile_width", image.width())
+      ->set("tile_height", 10)
+      ->set("max_tiles", static_cast<int>(round(1.0 + need_lines / 10.0)))
+      ->set("access", VIPS_ACCESS_SEQUENTIAL)
+      ->set("threaded", TRUE));
+  }
+
+  VImage Threshold(VImage image, double const threshold, bool const thresholdGrayscale) {
+    if (!thresholdGrayscale) {
+      return image >= threshold;
+    }
+    return image.colourspace(VIPS_INTERPRETATION_B_W) >= threshold;
+  }
+
+  /*
+    Perform boolean/bitwise operation on image color channels - results in one channel image
+  */
+  VImage Bandbool(VImage image, VipsOperationBoolean const boolean) {
+    image = image.bandbool(boolean);
+    return image.copy(VImage::option()->set("interpretation", VIPS_INTERPRETATION_B_W));
+  }
+
+  /*
+    Perform bitwise boolean operation between images
+  */
+  VImage Boolean(VImage image, VImage imageR, VipsOperationBoolean const boolean) {
+    return image.boolean(imageR, boolean);
+  }
+
+  VImage Trim(VImage image, int const tolerance) {
+    using sharp::MaximumImageAlpha;
+    // An equivalent of ImageMagick's -trim in C++ ... 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.
+
+    // find the value of the pixel at (0, 0) ... we will search for all pixels
+    // significantly different from this
+    std::vector<double> background = image(0, 0);
+
+    double const max = MaximumImageAlpha(image.interpretation());
+
+    // we need to smooth the image, subtract the background from every pixel, take
+    // the absolute value of the difference, then threshold
+    VImage mask = (image.median(3) - background).abs() > (max * tolerance / 100);
+
+    // sum mask rows and columns, then search for the first non-zero sum in each
+    // direction
+    VImage rows;
+    VImage columns = mask.project(&rows);
+
+    VImage profileLeftV;
+    VImage profileLeftH = columns.profile(&profileLeftV);
+
+    VImage profileRightV;
+    VImage profileRightH = columns.fliphor().profile(&profileRightV);
+
+    VImage profileTopV;
+    VImage profileTopH = rows.profile(&profileTopV);
+
+    VImage profileBottomV;
+    VImage profileBottomH = rows.flipver().profile(&profileBottomV);
+
+    int left = static_cast<int>(floor(profileLeftV.min()));
+    int right = columns.width() - static_cast<int>(floor(profileRightV.min()));
+    int top = static_cast<int>(floor(profileTopH.min()));
+    int bottom = rows.height() - static_cast<int>(floor(profileBottomH.min()));
+
+    int width = right - left;
+    int height = bottom - top;
+
+    if (width <= 0 || height <= 0) {
+      throw VError("Unexpected error while trimming. Try to lower the tolerance");
+    }
+
+    // and now crop the original image
+    return image.extract_area(left, top, width, height);
   }
 
 }  // namespace sharp

src/operations.h

@@ -1,6 +1,23 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #ifndef SRC_OPERATIONS_H_
 #define SRC_OPERATIONS_H_
 
+#include <algorithm>
+#include <functional>
+#include <memory>
 #include <tuple>
 #include <vips/vips8>
 
@@ -14,10 +31,31 @@ namespace sharp {
    */
   VImage Composite(VImage src, VImage dst, const int gravity);
 
+  /*
+    Alpha composite src over dst with given x and y offsets.
+    Assumes alpha channels are already premultiplied and will be unpremultiplied after.
+   */
+  VImage Composite(VImage src, VImage dst, const int x, const int y);
+
+  /*
+    Check if the src and dst Images for composition operation are valid
+  */
+  bool IsInputValidForComposition(VImage src, VImage dst);
+
+  /*
+    Given a valid src and dst, returns the composite of the two images
+  */
+  VImage CompositeImage(VImage src, VImage dst);
+
+  /*
+    Cutout src over dst with given gravity.
+  */
+  VImage Cutout(VImage src, VImage dst, const int gravity);
+
   /*
    * Stretch luminance to cover full dynamic range.
    */
-  VImage Normalize(VImage image);
+  VImage Normalise(VImage image);
 
   /*
    * Gamma encoding/decoding
@@ -25,24 +63,61 @@ namespace sharp {
   VImage Gamma(VImage image, double const exponent);
 
   /*
-   * Gaussian blur. Use sigma of -1 for fast blur.
+   * Gaussian blur. Use sigma of -1.0 for fast blur.
    */
   VImage Blur(VImage image, double const sigma);
 
   /*
-   * Sharpen flat and jagged areas. Use radius of -1 for fast sharpen.
+   * Convolution with a kernel.
    */
-  VImage Sharpen(VImage image, int const radius, double const flat, double const jagged);
+  VImage Convolve(VImage image, int const width, int const height,
+    double const scale, double const offset, std::unique_ptr<double[]> const &kernel_v);
 
   /*
-    Calculate crop area based on image entropy
+   * Sharpen flat and jagged areas. Use sigma of -1.0 for fast sharpen.
-  */
+   */
-  std::tuple<int, int> EntropyCrop(VImage image, int const outWidth, int const outHeight);
+  VImage Sharpen(VImage image, double const sigma, double const flat, double const jagged);
 
   /*
-    Calculate the Shannon entropy for an image
+    Crop strategy functors
   */
-  double Entropy(VImage image);
+  struct EntropyStrategy {
+    double operator()(VImage image);
+  };
+  struct AttentionStrategy {
+    double operator()(VImage image);
+  };
+
+  /*
+    Calculate crop area based on given strategy (Entropy, Attention)
+  */
+  std::tuple<int, int> Crop(
+    VImage image, int const outWidth, int const outHeight, std::function<double(VImage)> strategy);
+
+  /*
+    Insert a tile cache to prevent over-computation of any previous operations in the pipeline
+  */
+  VImage TileCache(VImage image, double const factor);
+
+  /*
+    Threshold an image
+  */
+  VImage Threshold(VImage image, double const threshold, bool const thresholdColor);
+
+  /*
+    Perform boolean/bitwise operation on image color channels - results in one channel image
+  */
+  VImage Bandbool(VImage image, VipsOperationBoolean const boolean);
+
+  /*
+    Perform bitwise boolean operation between images
+  */
+  VImage Boolean(VImage image, VImage imageR, VipsOperationBoolean const boolean);
+
+  /*
+    Trim an image
+  */
+  VImage Trim(VImage image, int const tolerance);
 
 }  // namespace sharp
 

src/pipeline.h

@@ -1,9 +1,28 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #ifndef SRC_PIPELINE_H_
 #define SRC_PIPELINE_H_
 
+#include <memory>
+#include <string>
+#include <vector>
+
+#include <nan.h>
 #include <vips/vips8>
 
-#include "nan.h"
+#include "./common.h"
 
 NAN_METHOD(pipeline);
 
@@ -16,23 +35,20 @@ enum class Canvas {
 };
 
 struct PipelineBaton {
-  std::string fileIn;
+  sharp::InputDescriptor *input;
-  char *bufferIn;
-  size_t bufferInLength;
   std::string iccProfilePath;
   int limitInputPixels;
-  int density;
-  int rawWidth;
-  int rawHeight;
-  int rawChannels;
   std::string formatOut;
   std::string fileOut;
   void *bufferOut;
   size_t bufferOutLength;
-  std::string overlayFileIn;
+  sharp::InputDescriptor *overlay;
-  char *overlayBufferIn;
-  size_t overlayBufferInLength;
   int overlayGravity;
+  int overlayXOffset;
+  int overlayYOffset;
+  bool overlayTile;
+  bool overlayCutout;
+  std::vector<sharp::InputDescriptor *> joinChannelIn;
   int topOffsetPre;
   int leftOffsetPre;
   int widthPre;
@@ -46,18 +62,24 @@ struct PipelineBaton {
   int channels;
   Canvas canvas;
   int crop;
+  int cropCalcLeft;
+  int cropCalcTop;
+  std::string kernel;
   std::string interpolator;
+  bool centreSampling;
   double background[4];
   bool flatten;
   bool negate;
   double blurSigma;
-  int sharpenRadius;
+  double sharpenSigma;
   double sharpenFlat;
   double sharpenJagged;
   int threshold;
+  bool thresholdGrayscale;
+  int trimTolerance;
   double gamma;
   bool greyscale;
-  bool normalize;
+  bool normalise;
   int angle;
   bool rotateBeforePreExtract;
   bool flip;
@@ -66,50 +88,73 @@ struct PipelineBaton {
   int extendBottom;
   int extendLeft;
   int extendRight;
-  bool progressive;
   bool withoutEnlargement;
   VipsAccess accessMethod;
-  int quality;
+  int jpegQuality;
-  int compressionLevel;
+  bool jpegProgressive;
-  bool withoutAdaptiveFiltering;
+  std::string jpegChromaSubsampling;
-  bool withoutChromaSubsampling;
+  bool jpegTrellisQuantisation;
-  bool trellisQuantisation;
+  bool jpegOvershootDeringing;
-  bool overshootDeringing;
+  bool jpegOptimiseScans;
-  bool optimiseScans;
+  bool pngProgressive;
+  int pngCompressionLevel;
+  bool pngAdaptiveFiltering;
+  int webpQuality;
+  int webpAlphaQuality;
+  bool webpNearLossless;
+  bool webpLossless;
+  int tiffQuality;
+  VipsForeignTiffCompression tiffCompression;
+  VipsForeignTiffPredictor tiffPredictor;
   std::string err;
   bool withMetadata;
   int withMetadataOrientation;
+  std::unique_ptr<double[]> convKernel;
+  int convKernelWidth;
+  int convKernelHeight;
+  double convKernelScale;
+  double convKernelOffset;
+  sharp::InputDescriptor *boolean;
+  VipsOperationBoolean booleanOp;
+  VipsOperationBoolean bandBoolOp;
+  int extractChannel;
+  VipsInterpretation colourspace;
   int tileSize;
   int tileOverlap;
+  VipsForeignDzContainer tileContainer;
   VipsForeignDzLayout tileLayout;
+  std::string tileFormat;
 
   PipelineBaton():
-    bufferInLength(0),
+    input(nullptr),
     limitInputPixels(0),
-    density(72),
-    rawWidth(0),
-    rawHeight(0),
-    rawChannels(0),
-    formatOut(""),
-    fileOut(""),
     bufferOutLength(0),
-    overlayBufferInLength(0),
+    overlay(nullptr),
     overlayGravity(0),
+    overlayXOffset(-1),
+    overlayYOffset(-1),
+    overlayTile(false),
+    overlayCutout(false),
     topOffsetPre(-1),
     topOffsetPost(-1),
     channels(0),
     canvas(Canvas::CROP),
     crop(0),
+    cropCalcLeft(-1),
+    cropCalcTop(-1),
+    centreSampling(false),
     flatten(false),
     negate(false),
     blurSigma(0.0),
-    sharpenRadius(0),
+    sharpenSigma(0.0),
     sharpenFlat(1.0),
     sharpenJagged(2.0),
     threshold(0),
+    thresholdGrayscale(true),
+    trimTolerance(0),
     gamma(0.0),
     greyscale(false),
-    normalize(false),
+    normalise(false),
     angle(0),
     flip(false),
     flop(false),
@@ -117,19 +162,34 @@ struct PipelineBaton {
     extendBottom(0),
     extendLeft(0),
     extendRight(0),
-    progressive(false),
     withoutEnlargement(false),
-    quality(80),
+    jpegQuality(80),
-    compressionLevel(6),
+    jpegProgressive(false),
-    withoutAdaptiveFiltering(false),
+    jpegChromaSubsampling("4:2:0"),
-    withoutChromaSubsampling(false),
+    jpegTrellisQuantisation(false),
-    trellisQuantisation(false),
+    jpegOvershootDeringing(false),
-    overshootDeringing(false),
+    jpegOptimiseScans(false),
-    optimiseScans(false),
+    pngProgressive(false),
+    pngCompressionLevel(6),
+    pngAdaptiveFiltering(true),
+    webpQuality(80),
+    tiffQuality(80),
+    tiffCompression(VIPS_FOREIGN_TIFF_COMPRESSION_JPEG),
+    tiffPredictor(VIPS_FOREIGN_TIFF_PREDICTOR_NONE),
     withMetadata(false),
     withMetadataOrientation(-1),
+    convKernelWidth(0),
+    convKernelHeight(0),
+    convKernelScale(0.0),
+    convKernelOffset(0.0),
+    boolean(nullptr),
+    booleanOp(VIPS_OPERATION_BOOLEAN_LAST),
+    bandBoolOp(VIPS_OPERATION_BOOLEAN_LAST),
+    extractChannel(-1),
+    colourspace(VIPS_INTERPRETATION_LAST),
     tileSize(256),
     tileOverlap(0),
+    tileContainer(VIPS_FOREIGN_DZ_CONTAINER_FS),
     tileLayout(VIPS_FOREIGN_DZ_LAYOUT_DZ) {
       background[0] = 0.0;
       background[1] = 0.0;

src/sharp.cc

@@ -1,7 +1,20 @@
-#include <node.h>
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-#include <vips/vips8>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
-#include "nan.h"
+#include <node.h>
+#include <nan.h>
+#include <vips/vips8>
 
 #include "common.h"
 #include "metadata.h"

src/utilities.cc

@@ -1,10 +1,25 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #include <cmath>
+#include <string>
+
 #include <node.h>
+#include <nan.h>
 #include <vips/vips8>
 #include <vips/vector.h>
 
-#include "nan.h"
-
 #include "common.h"
 #include "operations.h"
 #include "utilities.h"
@@ -45,14 +60,11 @@ NAN_METHOD(cache) {
   // Get memory stats
   Local<Object> memory = New<Object>();
   Set(memory, New("current").ToLocalChecked(),
-    New<Integer>(static_cast<int>(round(vips_tracked_get_mem() / 1048576)))
+    New<Integer>(static_cast<int>(round(vips_tracked_get_mem() / 1048576))));
-  );
   Set(memory, New("high").ToLocalChecked(),
-    New<Integer>(static_cast<int>(round(vips_tracked_get_mem_highwater() / 1048576)))
+    New<Integer>(static_cast<int>(round(vips_tracked_get_mem_highwater() / 1048576))));
-  );
   Set(memory, New("max").ToLocalChecked(),
-    New<Integer>(static_cast<int>(round(vips_cache_get_max_mem() / 1048576)))
+    New<Integer>(static_cast<int>(round(vips_cache_get_max_mem() / 1048576))));
-  );
   // Get file stats
   Local<Object> files = New<Object>();
   Set(files, New("current").ToLocalChecked(), New<Integer>(vips_tracked_get_files()));
@@ -138,7 +150,9 @@ NAN_METHOD(format) {
 
   // Which load/save operations are available for each compressed format?
   Local<Object> format = New<Object>();
-  for (std::string f : {"jpeg", "png", "webp", "tiff", "magick", "openslide", "dz"}) {
+  for (std::string f : {
+    "jpeg", "png", "webp", "tiff", "magick", "openslide", "dz", "ppm", "fits", "gif", "svg", "pdf", "v"
+  }) {
     // Input
     Local<Boolean> hasInputFile =
       New<Boolean>(vips_type_find("VipsOperation", (f + "load").c_str()));

src/utilities.h

@@ -1,7 +1,21 @@
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 #ifndef SRC_UTILITIES_H_
 #define SRC_UTILITIES_H_
 
-#include "nan.h"
+#include <nan.h>
 
 NAN_METHOD(cache);
 NAN_METHOD(concurrency);

test/bench/package.json

@@ -8,17 +8,18 @@
     "test": "VIPS_WARNING=0 node perf && node random && node parallel"
   },
   "devDependencies": {
-    "async": "^1.5.2",
+    "async": "^2.1.4",
-    "benchmark": "^2.1.0",
+    "benchmark": "^2.1.2",
-    "gm": "^1.21.0",
+    "gm": "^1.23.0",
     "imagemagick": "^0.1.3",
-    "imagemagick-native": "^1.9.2",
+    "imagemagick-native": "^1.9.3",
-    "jimp": "^0.2.20",
+    "jimp": "^0.2.27",
-    "lwip": "^0.0.8",
+    "lwip": "^0.0.9",
-    "semver": "^5.1.0"
+    "mapnik": "^3.5.14",
+    "semver": "^5.3.0"
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=0.10"
+    "node": ">=4"
   }
 }

test/bench/parallel.js

@@ -2,43 +2,43 @@
 
 process.env.UV_THREADPOOL_SIZE = 64;
 
-var assert = require('assert');
+const assert = require('assert');
-var async = require('async');
+const async = require('async');
 
-var sharp = require('../../index');
+const sharp = require('../../');
-var fixtures = require('../fixtures');
+const fixtures = require('../fixtures');
 
-var width = 720;
+const width = 720;
-var height = 480;
+const height = 480;
 
 sharp.concurrency(1);
 sharp.simd(true);
 
-var timer = setInterval(function() {
+const timer = setInterval(function () {
   console.dir(sharp.counters());
 }, 100);
 
-async.mapSeries([1, 1, 2, 4, 8, 16, 32, 64], function(parallelism, next) {
+async.mapSeries([1, 1, 2, 4, 8, 16, 32, 64], function (parallelism, next) {
-  var start = new Date().getTime();
+  const start = new Date().getTime();
   async.times(parallelism,
-    function(id, callback) {
+    function (id, callback) {
-      /*jslint unused: false */
+      /* jslint unused: false */
-      sharp(fixtures.inputJpg).resize(width, height).toBuffer(function(err, buffer) {
+      sharp(fixtures.inputJpg).resize(width, height).toBuffer(function (err, buffer) {
         buffer = null;
         callback(err, new Date().getTime() - start);
       });
     },
-    function(err, ids) {
+    function (err, ids) {
       assert(!err);
       assert(ids.length === parallelism);
-      var mean = ids.reduce(function(a, b) {
+      const mean = ids.reduce(function (a, b) {
         return a + b;
       }) / ids.length;
       console.log(parallelism + ' parallel calls: fastest=' + ids[0] + 'ms slowest=' + ids[ids.length - 1] + 'ms mean=' + mean + 'ms');
       next();
     }
   );
-}, function() {
+}, function () {
   clearInterval(timer);
   console.dir(sharp.counters());
 });

test/bench/random.js

@@ -1,28 +1,26 @@
 'use strict';
 
-var imagemagick = require('imagemagick');
+const imagemagick = require('imagemagick');
-var gm = require('gm');
+const gm = require('gm');
-var assert = require('assert');
+const assert = require('assert');
-var Benchmark = require('benchmark');
+const Benchmark = require('benchmark');
 
-var sharp = require('../../index');
+const sharp = require('../../');
-var fixtures = require('../fixtures');
+const fixtures = require('../fixtures');
 
+sharp.cache(false);
 sharp.simd(true);
 
-var min = 320;
+const min = 320;
-var max = 960;
+const max = 960;
 
-// Nearest equivalent to bilinear
+const randomDimension = function () {
-var magickFilter = 'Triangle';
+  return Math.ceil((Math.random() * (max - min)) + min);
-
-var randomDimension = function() {
-  return Math.ceil(Math.random() * (max - min) + min);
 };
 
 new Benchmark.Suite('random').add('imagemagick', {
   defer: true,
-  fn: function(deferred) {
+  fn: function (deferred) {
     imagemagick.resize({
       srcPath: fixtures.inputJpg,
       dstPath: fixtures.outputJpg,
@@ -30,8 +28,8 @@ new Benchmark.Suite('random').add('imagemagick', {
       width: randomDimension(),
       height: randomDimension(),
       format: 'jpg',
-      filter: magickFilter
+      filter: 'Lanczos'
-    }, function(err) {
+    }, function (err) {
       if (err) {
         throw err;
       } else {
@@ -41,10 +39,10 @@ new Benchmark.Suite('random').add('imagemagick', {
   }
 }).add('gm', {
   defer: true,
-  fn: function(deferred) {
+  fn: function (deferred) {
     gm(fixtures.inputJpg)
       .resize(randomDimension(), randomDimension())
-      .filter(magickFilter)
+      .filter('Lanczos')
       .quality(80)
       .toBuffer(function (err, buffer) {
         if (err) {
@@ -57,20 +55,21 @@ new Benchmark.Suite('random').add('imagemagick', {
   }
 }).add('sharp', {
   defer: true,
-  fn: function(deferred) {
+  fn: function (deferred) {
-    sharp(fixtures.inputJpg).resize(randomDimension(), randomDimension()).toBuffer(function(err, buffer) {
+    sharp(fixtures.inputJpg)
-      if (err) {
+      .resize(randomDimension(), randomDimension())
-        throw err;
+      .toBuffer(function (err, buffer) {
-      } else {
+        if (err) {
-        assert.notStrictEqual(null, buffer);
+          throw err;
-        deferred.resolve();
+        } else {
-      }
+          assert.notStrictEqual(null, buffer);
-    });
+          deferred.resolve();
+        }
+      });
   }
-}).on('cycle', function(event) {
+}).on('cycle', function (event) {
   console.log(String(event.target));
-}).on('complete', function() {
+}).on('complete', function () {
-  var winner = this.filter('fastest').map('name');
+  const winner = this.filter('fastest').map('name');
   assert.strictEqual('sharp', String(winner), 'sharp was slower than ' + winner);
-  console.dir(sharp.cache());
 }).run();