Release v0.20.7

Alpha for colour is between 0-1, not 0-255.

.gitattributes

@@ -0,0 +1 @@
+src/libvips/* linguist-vendored

.gitignore

@@ -1,11 +1,15 @@
 build
 node_modules
-coverage
+/coverage
 test/bench/node_modules
 test/fixtures/output*
 test/leak/libvips.supp
-lib
+test/saliency/report.json
-include
+test/saliency/Image*
-packaging/libvips*
+test/saliency/[Uu]serData*
-packaging/*.log
+!test/saliency/userData.js
+vendor
+.gitattributes
 .DS_Store
+.nyc_output
+package-lock.json

.jshintignore

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

.jshintrc

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

.npmignore

@@ -1,14 +1,15 @@
 build
 node_modules
 coverage
-.jshintignore
+.editorconfig
-.jshintrc
+.gitattributes
 .gitignore
 test
 .travis.yml
 appveyor.yml
-circle.yml
 mkdocs.yml
-lib
+docs/css/
-include
+vendor
-packaging
+.prebuildrc
+.nyc_output
+CONTRIBUTING.md

.prebuildrc

@@ -0,0 +1,4 @@
+{
+  "include-regex": "(sharp\\.node|libvips-cpp\\.dll)",
+  "strip": true
+}

.travis.yml

@@ -1,17 +1,34 @@
 language: node_js
-node_js:
+matrix:
-  - "0.10"
+  include:
-  - "0.12"
+    - os: linux
-  - "4"
+      dist: trusty
-  - "5"
       sudo: false
-addons:
+      node_js: "4"
-  apt:
+    - os: linux
-    sources:
+      dist: trusty
-    - ubuntu-toolchain-r-test
+      sudo: false
-    packages:
+      node_js: "6"
-    - g++-4.8
+    - os: linux
-env:
+      dist: trusty
-  CXX=g++-4.8
+      sudo: false
+      node_js: "8"
+    - os: linux
+      dist: trusty
+      sudo: false
+      node_js: "10"
+    - os: osx
+      osx_image: xcode8.3
+      node_js: "4"
+    - os: osx
+      osx_image: xcode8.3
+      node_js: "6"
+    - os: osx
+      osx_image: xcode8.3
+      node_js: "8"
+    - os: osx
+      osx_image: xcode8.3
+      node_js: "10"
 after_success:
+  - npm install coveralls
   - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

CONTRIBUTING.md

@@ -14,7 +14,7 @@ New bugs are assigned a `triage` label whilst under investigation.
 
 If a [similar request](https://github.com/lovell/sharp/labels/enhancement) exists, it's probably fastest to add a comment to it about your requirement.
 
-Implementation is usually straightforward if _libvips_ [already supports](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/ch03.html) the feature you need.
+Implementation is usually straightforward if _libvips_ [already supports](https://jcupitt.github.io/libvips/API/current/) the feature you need.
 
 ## Submit a Pull Request to fix a bug
 
@@ -41,8 +41,8 @@ Any change that modifies the existing public API should be added to the relevant
 
 | Release | WIP branch |
 | ------: | :--------- |
-| v0.12.0 | look       |
+| v0.21.0 | teeth      |
-| v0.13.0 | mind       |
+| v0.22.0 | uptake     |
 
 Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
 
@@ -62,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
@@ -78,15 +89,11 @@ Requires [Valgrind](http://valgrind.org/).
 npm run test-leak
 ```
 
-### Packaging tests
-
-Tests the installation on a number of Linux-based operating systems.
-Requires docker.
-
-```sh
-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,33 +1,77 @@
 # sharp
 
+```sh
+npm install sharp
+```
+
+```sh
+yarn add 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.
 
-64-bit Windows and recent Linux systems do not require
+Most modern 64-bit OS X, Windows and Linux (glibc) systems running
-the installation of any external runtime dependencies.
+Node versions 4, 6, 8 and 10
+do not require any additional install or runtime dependencies.
 
-Use with OS X is as simple as running `brew install homebrew/science/vips`
+## Examples
-to install the libvips dependency.
+
+```javascript
+const sharp = require('sharp');
+```
+
+```javascript
+sharp(inputBuffer)
+  .resize(320, 240)
+  .toFile('output.webp', (err, info) => ... );
+  // A Promises/A+ promise is returned when callback is not provided.
+```
+
+```javascript
+sharp('input.jpg')
+  .rotate()
+  .resize(200)
+  .toBuffer()
+  .then( data => ... )
+  .catch( err => ... );
+```
+
+```javascript
+const roundedCorners = Buffer.from(
+  '<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)
 
 ### Documentation
 
-Visit [sharp.dimens.io](http://sharp.dimens.io/) for complete
+Visit [sharp.pixelplumbing.com](http://sharp.pixelplumbing.com/) for complete
-[installation instructions](http://sharp.dimens.io/page/install),
+[installation instructions](http://sharp.pixelplumbing.com/page/install),
-[API documentation](http://sharp.dimens.io/page/api),
+[API documentation](http://sharp.pixelplumbing.com/page/api),
-[benchmark tests](http://sharp.dimens.io/page/performance) and
+[benchmark tests](http://sharp.pixelplumbing.com/page/performance) and
-[changelog](http://sharp.dimens.io/page/changelog).
+[changelog](http://sharp.pixelplumbing.com/page/changelog).
 
 ### Contributing
 
@@ -36,7 +80,7 @@ covers reporting bugs, requesting features and submitting code changes.
 
 ### Licence
 
-Copyright 2013, 2014, 2015 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017, 2018 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,14 @@ 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: "8"
+  - nodejs_version: "10"
 install:
   - ps: Install-Product node $env:nodejs_version x64
+  - npm install -g npm@5
   - npm install
 test_script:
-  - npm run-script test-win
+  - npm test

binding.gyp

@@ -1,43 +1,67 @@
 {
   'targets': [{
+    'target_name': 'libvips-cpp',
+    'conditions': [
+      ['OS == "win"', {
+        # Build libvips C++ binding for Windows due to MSVC std library ABI changes
+        'type': 'shared_library',
+        'defines': [
+          'VIPS_CPLUSPLUS_EXPORTS',
+          '_ALLOW_KEYWORD_MACROS'
+        ],
+        'sources': [
+          'src/libvips/cplusplus/VError.cpp',
+          'src/libvips/cplusplus/VInterpolate.cpp',
+          'src/libvips/cplusplus/VImage.cpp'
+        ],
+        'include_dirs': [
+          'vendor/include',
+          'vendor/include/glib-2.0',
+          'vendor/lib/glib-2.0/include'
+        ],
+        'libraries': [
+          '../vendor/lib/libvips.lib',
+          '../vendor/lib/libglib-2.0.lib',
+          '../vendor/lib/libgobject-2.0.lib'
+        ],
+        'configurations': {
+          'Release': {
+            'msvs_settings': {
+              'VCCLCompilerTool': {
+                'ExceptionHandling': 1
+              }
+            },
+            'msvs_disabled_warnings': [
+              4275
+            ]
+          }
+        }
+      }, {
+        # Ignore this target for non-Windows
+        'type': 'none'
+      }]
+    ]
+  }, {
     'target_name': 'sharp',
-    # Nested variables "pattern" borrowed from http://src.chromium.org/viewvc/chrome/trunk/src/build/common.gypi
+    'dependencies': [
-    'variables': {
+      'libvips-cpp'
-      'variables': {
-        'variables': {
-          'conditions': [
-            ['OS != "win"', {
-              # Build the PKG_CONFIG_PATH environment variable with all possible combinations
-              'pkg_config_path': '<!(which brew >/dev/null 2>&1 && eval $(brew --env) && echo $PKG_CONFIG_LIBDIR || true):$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig'
-            }, {
-              'pkg_config_path': ''
-            }]
     ],
-        },
+    'variables': {
-        'conditions': [
-          ['OS != "win"', {
-            # Which version, if any, of libvips is available globally via pkg-config?
-            'global_vips_version': '<!(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --modversion vips 2>/dev/null || true)'
-          }, {
-            'global_vips_version': ''
-          }]
-        ],
-        'pkg_config_path%': '<(pkg_config_path)'
-      },
-      'pkg_config_path%': '<(pkg_config_path)',
       'runtime_link%': 'shared',
       'conditions': [
         ['OS != "win"', {
-          # Does the globally available version of libvips, if any, meet the minimum version requirement?
+          'pkg_config_path': '<!(node -e "console.log(require(\'./lib/libvips\').pkgConfigPath())")',
-          'use_global_vips': '<!(GLOBAL_VIPS_VERSION="<(global_vips_version)" node -e "require(\'./binding\').use_global_vips()")'
+          'use_global_libvips': '<!(node -e "console.log(Boolean(require(\'./lib/libvips\').useGlobalLibvips()).toString())")'
         }, {
-          'use_global_vips': ''
+          'pkg_config_path': '',
+          'use_global_libvips': ''
         }]
       ]
     },
     'sources': [
       'src/common.cc',
       'src/metadata.cc',
+      'src/stats.cc',
       'src/operations.cc',
       'src/pipeline.cc',
       'src/sharp.cc',
@@ -47,62 +71,88 @@
       '<!(node -e "require(\'nan\')")'
     ],
     'conditions': [
-      ['use_global_vips == "true"', {
+      ['use_global_libvips == "true"', {
         # Use pkg-config for include and lib
-        'include_dirs': ['<!(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --cflags vips glib-2.0)'],
+        'include_dirs': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --cflags-only-I vips-cpp vips glib-2.0 | sed s\/-I//g)'],
         'conditions': [
           ['runtime_link == "static"', {
-            'libraries': ['<!(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs vips --static)']
+            'libraries': ['<!@(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs --static vips-cpp)']
           }, {
-            'libraries': ['<!(PKG_CONFIG_PATH="<(pkg_config_path)" pkg-config --libs vips)']
+            '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
+        # Use pre-built libvips stored 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"', {
-            'variables': {
+            'defines': [
-              'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
+              '_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"', {
+            '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': {
+            'defines': [
-              'download_vips': '<!(LDD_VERSION="<!(ldd --version 2>&1 || true)" node -e "require(\'./binding\').download_vips()")'
+              '_GLIBCXX_USE_CXX11_ABI=0'
-            },
+            ],
             'libraries': [
-              '<(module_root_dir)/lib/libvips.so',
+              '../vendor/lib/libvips-cpp.so',
-              '<(module_root_dir)/lib/libglib-2.0.so',
+              '../vendor/lib/libvips.so',
-              '<(module_root_dir)/lib/libgobject-2.0.so',
+              '../vendor/lib/libglib-2.0.so',
+              '../vendor/lib/libgobject-2.0.so',
               # Dependencies of dependencies, included for openSUSE support
-              '<(module_root_dir)/lib/libMagickCore-6.Q16.so',
+              '../vendor/lib/libcairo.so',
-              '<(module_root_dir)/lib/libMagickWand-6.Q16.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\''
             ]
           }]
         ]
@@ -118,6 +168,8 @@
       'CLANG_CXX_LANGUAGE_STANDARD': 'c++11',
       'CLANG_CXX_LIBRARY': 'libc++',
       'MACOSX_DEPLOYMENT_TARGET': '10.7',
+      'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+      'GCC_ENABLE_CPP_RTTI': 'YES',
       'OTHER_CPLUSPLUSFLAGS': [
         '-fexceptions',
         '-Wall',
@@ -130,62 +182,11 @@
           'VCCLCompilerTool': {
             'ExceptionHandling': 1
           }
-        }
+        },
+        'msvs_disabled_warnings': [
+          4275
+        ]
       }
     },
-  }, {
-    'target_name': 'win_copy_dlls',
-    'type': 'none',
-    'dependencies': [
-      'sharp'
-    ],
-    'conditions': [
-      ['OS == "win"', {
-        # Windows lacks support for rpath
-        'copies': [{
-          'destination': '<(module_root_dir)/build/Release',
-          'files': [
-            '<(module_root_dir)/lib/GNU.Gettext.dll',
-            '<(module_root_dir)/lib/libMagickCore-6.Q16-2.dll',
-            '<(module_root_dir)/lib/libMagickWand-6.Q16-2.dll',
-            '<(module_root_dir)/lib/libasprintf-0.dll',
-            '<(module_root_dir)/lib/libcairo-2.dll',
-            '<(module_root_dir)/lib/libcairo-gobject-2.dll',
-            '<(module_root_dir)/lib/libcairo-script-interpreter-2.dll',
-            '<(module_root_dir)/lib/libexif-12.dll',
-            '<(module_root_dir)/lib/libexpat-1.dll',
-            '<(module_root_dir)/lib/libffi-6.dll',
-            '<(module_root_dir)/lib/libfftw3-3.dll',
-            '<(module_root_dir)/lib/libfontconfig-1.dll',
-            '<(module_root_dir)/lib/libfreetype-6.dll',
-            '<(module_root_dir)/lib/libgcc_s_seh-1.dll',
-            '<(module_root_dir)/lib/libgdk_pixbuf-2.0-0.dll',
-            '<(module_root_dir)/lib/libgio-2.0-0.dll',
-            '<(module_root_dir)/lib/libglib-2.0-0.dll',
-            '<(module_root_dir)/lib/libgmodule-2.0-0.dll',
-            '<(module_root_dir)/lib/libgobject-2.0-0.dll',
-            '<(module_root_dir)/lib/libgsf-1-114.dll',
-            '<(module_root_dir)/lib/libgthread-2.0-0.dll',
-            '<(module_root_dir)/lib/libintl-8.dll',
-            '<(module_root_dir)/lib/libjpeg-62.dll',
-            '<(module_root_dir)/lib/liblcms2-2.dll',
-            '<(module_root_dir)/lib/libopenjpeg-1.dll',
-            '<(module_root_dir)/lib/libopenslide-0.dll',
-            '<(module_root_dir)/lib/libpango-1.0-0.dll',
-            '<(module_root_dir)/lib/libpangocairo-1.0-0.dll',
-            '<(module_root_dir)/lib/libpangowin32-1.0-0.dll',
-            '<(module_root_dir)/lib/libpixman-1-0.dll',
-            '<(module_root_dir)/lib/libpng16-16.dll',
-            '<(module_root_dir)/lib/libquadmath-0.dll',
-            '<(module_root_dir)/lib/libsqlite3-0.dll',
-            '<(module_root_dir)/lib/libssp-0.dll',
-            '<(module_root_dir)/lib/libtiff-5.dll',
-            '<(module_root_dir)/lib/libvips-42.dll',
-            '<(module_root_dir)/lib/libxml2-2.dll',
-            '<(module_root_dir)/lib/zlib1.dll'
-          ]
-        }]
-      }]
-    ]
   }]
 }

binding.js

@@ -1,111 +0,0 @@
-'use strict';
-
-var fs = require('fs');
-var path = require('path');
-var zlib = require('zlib');
-
-var semver = require('semver');
-var request = require('request');
-var tar = require('tar');
-
-var tmp = require('os').tmpdir();
-
-var distBaseUrl = 'https://dl.bintray.com/lovell/sharp/';
-
-var vipsHeaderPath = path.join(__dirname, 'include', 'vips', 'vips.h');
-
-// -- Helpers
-
-// Does this file exist?
-var isFile = function(file) {
-  var exists = false;
-  try {
-    exists = fs.statSync(file).isFile();
-  } catch (err) {}
-  return exists;
-};
-
-var unpack = function(tarPath) {
-  var extractor = tar.Extract({
-    path: __dirname
-  });
-  extractor.on('error', error);
-  extractor.on('end', function() {
-    if (!isFile(vipsHeaderPath)) {
-      error('Could not unpack ' + tarPath);
-    }
-  });
-  fs.createReadStream(tarPath).on('error', error)
-    .pipe(zlib.Unzip())
-    .pipe(extractor);
-};
-
-// Error
-var error = function(msg) {
-  if (msg instanceof Error) {
-    msg = msg.message;
-  }
-  process.stderr.write('ERROR: ' + msg + '\n');
-  process.exit(1);
-};
-
-// -- Binary downloaders
-
-module.exports.download_vips = function() {
-  // Has vips been installed locally?
-  if (!isFile(vipsHeaderPath)) {
-    // Ensure 64-bit
-    if (process.arch !== 'x64') {
-      error('ARM and 32-bit systems require manual installation - please see http://sharp.dimens.io/en/stable/install/');
-    }
-    // Ensure libc >= 2.15
-    var lddVersion = process.env.LDD_VERSION;
-    if (lddVersion) {
-      var libcVersion = lddVersion ? lddVersion.split(/\n/)[0].split(' ').slice(-1)[0].trim() : '';
-      if (libcVersion && semver.lt(libcVersion + '.0', '2.13.0')) {
-        error('libc version ' + libcVersion + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
-      }
-    }
-    // Platform-specific .tar.gz
-    var tarFilename = ['libvips', process.env.npm_package_config_libvips, process.platform.substr(0, 3)].join('-') + '.tar.gz';
-    var tarPath = path.join(__dirname, 'packaging', tarFilename);
-    if (isFile(tarPath)) {
-      unpack(tarPath);
-    } else {
-      // Download
-      tarPath = path.join(tmp, tarFilename);
-      var tmpFile = fs.createWriteStream(tarPath).on('finish', function() {
-        unpack(tarPath);
-      });
-      request(distBaseUrl + tarFilename).on('response', function(response) {
-        if (response.statusCode !== 200) {
-          error(distBaseUrl + tarFilename + ' status code ' + response.statusCode);
-        }
-      }).on('error', function(err) {
-        error('Download from ' + distBaseUrl + tarFilename + ' failed: ' + err.message);
-      }).pipe(tmpFile);
-    }
-  }
-};
-
-module.exports.use_global_vips = function() {
-  var useGlobalVips = false;
-  var globalVipsVersion = process.env.GLOBAL_VIPS_VERSION;
-  if (globalVipsVersion) {
-    useGlobalVips = semver.gte(
-      globalVipsVersion,
-      process.env.npm_package_config_libvips
-    );
-  }
-  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 +0,0 @@
-machine:
-  services:
-    - docker
-test:
-  override:
-    - ./packaging/test.sh

docs/api-channel.md

@@ -0,0 +1,99 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## removeAlpha
+
+Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
+
+### Examples
+
+```javascript
+sharp('rgba.png')
+  .removeAlpha()
+  .toFile('rgb.png', function(err, info) {
+    // rgb.png is a 3 channel image without an alpha channel
+  });
+```
+
+Returns **Sharp** 
+
+## extractChannel
+
+Extract a single channel from a multi-channel image.
+
+### Parameters
+
+-   `channel` **([Number][1] \| [String][2])** 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][3]** 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][4]&lt;([String][2] \| [Buffer][5])> | [String][2] \| [Buffer][5])** one or more images (file paths, Buffers).
+-   `options` **[Object][6]** image options, see `sharp()` constructor.
+
+
+-   Throws **[Error][3]** 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][2]** 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][3]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[5]: https://nodejs.org/api/buffer.html
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

docs/api-colour.md

@@ -0,0 +1,97 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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][1] \| [Object][2])** parsed by the [color][3] module to extract values for red, green, blue and alpha.
+
+
+-   Throws **[Error][4]** Invalid parameter
+
+Returns **Sharp** 
+
+## tint
+
+Tint the image using the provided chroma while preserving the image luminance.
+An alpha channel may be present and will be unchanged by the operation.
+
+### Parameters
+
+-   `rgb` **([String][1] \| [Object][2])** parsed by the [color][3] module to extract chroma values.
+
+
+-   Throws **[Error][4]** 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][5]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## grayscale
+
+Alternative spelling of `greyscale`.
+
+### Parameters
+
+-   `grayscale` **[Boolean][5]**  (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][1]?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][6]
+
+
+-   Throws **[Error][4]** Invalid parameters
+
+Returns **Sharp** 
+
+## toColorspace
+
+Alternative spelling of `toColourspace`.
+
+### Parameters
+
+-   `colorspace` **[String][1]?** output colorspace.
+
+
+-   Throws **[Error][4]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[3]: https://www.npmjs.org/package/color
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[6]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568

docs/api-composite.md

@@ -0,0 +1,68 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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`.
+
+If the overlay image contains an alpha channel then composition with premultiplication will occur.
+
+### Parameters
+
+-   `overlay` **([Buffer][1] \| [String][2])** Buffer containing image data or String containing the path to an image file.
+-   `options` **[Object][3]?** 
+    -   `options.gravity` **[String][2]** gravity at which to place the overlay. (optional, default `'centre'`)
+    -   `options.top` **[Number][4]?** the pixel offset from the top edge.
+    -   `options.left` **[Number][4]?** the pixel offset from the left edge.
+    -   `options.tile` **[Boolean][5]** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
+    -   `options.cutout` **[Boolean][5]** 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][4]** integral number representing the DPI for vector overlay image. (optional, default `72`)
+    -   `options.raw` **[Object][3]?** describes overlay when using raw pixel data.
+        -   `options.raw.width` **[Number][4]?** 
+        -   `options.raw.height` **[Number][4]?** 
+        -   `options.raw.channels` **[Number][4]?** 
+    -   `options.create` **[Object][3]?** describes a blank overlay to be created.
+        -   `options.create.width` **[Number][4]?** 
+        -   `options.create.height` **[Number][4]?** 
+        -   `options.create.channels` **[Number][4]?** 3-4
+        -   `options.create.background` **([String][2] \| [Object][3])?** parsed by the [color][6] 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()
+  .webp( { quality: 90 } )
+  .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][7]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://nodejs.org/api/buffer.html
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[6]: https://www.npmjs.org/package/color
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-constructor.md

@@ -0,0 +1,121 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## Sharp
+
+### Parameters
+
+-   `input` **([Buffer][1] \| [String][2])?** 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 not present.
+-   `options` **[Object][3]?** if present, is an Object with optional attributes.
+    -   `options.failOnError` **[Boolean][4]** by default apply a "best effort"
+         to decode images, even if the data is corrupt or invalid. Set this flag to true
+         if you'd rather halt processing and raise an error when loading invalid images. (optional, default `false`)
+    -   `options.density` **[Number][5]** integral number representing the DPI for vector images. (optional, default `72`)
+    -   `options.page` **[Number][5]** page number to extract for multi-page input (GIF, TIFF) (optional, default `0`)
+    -   `options.raw` **[Object][3]?** describes raw pixel input image data. See `raw()` for pixel ordering.
+        -   `options.raw.width` **[Number][5]?** 
+        -   `options.raw.height` **[Number][5]?** 
+        -   `options.raw.channels` **[Number][5]?** 1-4
+    -   `options.create` **[Object][3]?** describes a new image to be created.
+        -   `options.create.width` **[Number][5]?** 
+        -   `options.create.height` **[Number][5]?** 
+        -   `options.create.channels` **[Number][5]?** 3-4
+        -   `options.create.background` **([String][2] \| [Object][3])?** parsed by the [color][6] 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({
+  create: {
+    width: 300,
+    height: 200,
+    channels: 4,
+    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
+  }
+})
+.png()
+.toBuffer()
+.then( ... );
+```
+
+-   Throws **[Error][7]** Invalid parameters
+
+Returns **[Sharp][8]** 
+
+### format
+
+An Object containing nested boolean values representing the available input and output formats/methods.
+
+#### Examples
+
+```javascript
+console.log(sharp.format);
+```
+
+Returns **[Object][3]** 
+
+### 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)');
+});
+```
+
+[1]: https://nodejs.org/api/buffer.html
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[6]: https://www.npmjs.org/package/color
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[8]: #sharp

docs/api-input.md

@@ -0,0 +1,145 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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 (uncached) 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 (EXIF orientation is not taken into consideration)
+-   `height`: Number of pixels high (EXIF orientation is not taken into consideration)
+-   `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][1]
+-   `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
+-   `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...][2]
+-   `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][3] profile data, if present
+-   `iptc`: Buffer containing raw IPTC data, if present
+-   `xmp`: Buffer containing raw XMP data, if present
+
+### Parameters
+
+-   `callback` **[Function][4]?** 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][5]&lt;[Object][6]> | Sharp)** 
+
+## stats
+
+Access to pixel-derived image statistics for every channel in the image.
+A Promise is returned when `callback` is not provided.
+
+-   `channels`: Array of channel statistics for each channel in the image. Each channel statistic contains
+    -   `min` (minimum value in the channel)
+    -   `max` (maximum value in the channel)
+    -   `sum` (sum of all values in a channel)
+    -   `squaresSum` (sum of squared values in a channel)
+    -   `mean` (mean of the values in a channel)
+    -   `stdev` (standard deviation for the values in a channel)
+    -   `minX` (x-coordinate of one of the pixel where the minimum lies)
+    -   `minY` (y-coordinate of one of the pixel where the minimum lies)
+    -   `maxX` (x-coordinate of one of the pixel where the maximum lies)
+    -   `maxY` (y-coordinate of one of the pixel where the maximum lies)
+-   `isOpaque`: Value to identify if the image is opaque or transparent, based on the presence and use of alpha channel
+-   `entropy`: Histogram-based estimation of greyscale entropy, discarding alpha channel if any (experimental)
+
+### Parameters
+
+-   `callback` **[Function][4]?** called with the arguments `(err, stats)`
+
+### Examples
+
+```javascript
+const image = sharp(inputJpg);
+image
+  .stats()
+  .then(function(stats) {
+     // stats contains the channel-wise statistics array and the isOpaque value
+  });
+```
+
+Returns **[Promise][5]&lt;[Object][6]>** 
+
+## 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][7] \| [Boolean][8])** an integral Number of pixels, zero or false to remove limit, true to use default limit.
+
+
+-   Throws **[Error][9]** 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.
+
+The default behaviour _before_ function call is `false`, meaning the libvips access method is not sequential.
+
+### Parameters
+
+-   `sequentialRead` **[Boolean][8]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+[1]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636
+
+[2]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672
+
+[3]: https://www.npmjs.com/package/icc
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-operation.md

@@ -0,0 +1,346 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## rotate
+
+Rotate the output image by either an explicit angle
+or auto-orient based on the EXIF `Orientation` tag.
+
+If an angle is provided, it is converted to a valid 90/180/270deg rotation.
+For example, `-450` will produce a 270deg rotation.
+
+If no angle is provided, it is determined from the 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][1]** angle of rotation, must be a multiple of 90. (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][2]** 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][3]** 
+    -   `options.left` **[Number][1]** zero-indexed offset from left edge
+    -   `options.top` **[Number][1]** zero-indexed offset from top edge
+    -   `options.width` **[Number][1]** dimension of extracted image
+    -   `options.height` **[Number][1]** 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][2]** 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][4]**  (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][4]**  (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][1]?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+-   `flat` **[Number][1]** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
+-   `jagged` **[Number][1]** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
+
+
+-   Throws **[Error][2]** Invalid parameters
+
+Returns **Sharp** 
+
+## median
+
+Apply median filter.
+When used without parameters the default window is 3x3.
+
+### Parameters
+
+-   `size` **[Number][1]** square mask size: size x size (optional, default `3`)
+
+
+-   Throws **[Error][2]** 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][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+
+
+-   Throws **[Error][2]** 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][1] \| [Object][3])** single pixel count to add to all edges or an Object with per-edge counts
+    -   `extend.top` **[Number][1]?** 
+    -   `extend.left` **[Number][1]?** 
+    -   `extend.bottom` **[Number][1]?** 
+    -   `extend.right` **[Number][1]?** 
+
+### 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][2]** Invalid parameters
+
+Returns **Sharp** 
+
+## flatten
+
+Merge alpha transparency channel, if any, with `background`.
+
+### Parameters
+
+-   `flatten` **[Boolean][4]**  (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][1]** value between 1 and 99 representing the percentage similarity. (optional, default `10`)
+
+
+-   Throws **[Error][2]** 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][1]** value between 1.0 and 3.0. (optional, default `2.2`)
+
+
+-   Throws **[Error][2]** Invalid parameters
+
+Returns **Sharp** 
+
+## negate
+
+Produce the "negative" of the image.
+
+### Parameters
+
+-   `negate` **[Boolean][4]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## normalise
+
+Enhance output image contrast by stretching its luminance to cover the full dynamic range.
+
+### Parameters
+
+-   `normalise` **[Boolean][4]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## normalize
+
+Alternative spelling of normalise.
+
+### Parameters
+
+-   `normalize` **[Boolean][4]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+## convolve
+
+Convolve the image with the specified kernel.
+
+### Parameters
+
+-   `kernel` **[Object][3]** 
+    -   `kernel.width` **[Number][1]** width of the kernel in pixels.
+    -   `kernel.height` **[Number][1]** width of the kernel in pixels.
+    -   `kernel.kernel` **[Array][5]&lt;[Number][1]>** Array of length `width*height` containing the kernel values.
+    -   `kernel.scale` **[Number][1]** the scale of the kernel in pixels. (optional, default `sum`)
+    -   `kernel.offset` **[Number][1]** 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][2]** 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][1]** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
+-   `options` **[Object][3]?** 
+    -   `options.greyscale` **[Boolean][4]** convert to single channel greyscale. (optional, default `true`)
+    -   `options.grayscale` **[Boolean][4]** alternative spelling for greyscale. (optional, default `true`)
+
+
+-   Throws **[Error][2]** 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][6] \| [String][7])** Buffer containing image data or String containing the path to an image file.
+-   `operator` **[String][7]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+-   `options` **[Object][3]?** 
+    -   `options.raw` **[Object][3]?** describes operand when using raw pixel data.
+        -   `options.raw.width` **[Number][1]?** 
+        -   `options.raw.height` **[Number][1]?** 
+        -   `options.raw.channels` **[Number][1]?** 
+
+
+-   Throws **[Error][2]** Invalid parameters
+
+Returns **Sharp** 
+
+## linear
+
+Apply the linear formula a \* input + b to the image (levels adjustment)
+
+### Parameters
+
+-   `a` **[Number][1]** multiplier (optional, default `1.0`)
+-   `b` **[Number][1]** offset (optional, default `0.0`)
+
+
+-   Throws **[Error][2]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[6]: https://nodejs.org/api/buffer.html
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

docs/api-output.md

@@ -0,0 +1,317 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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 `Promise` is returned when `callback` is not provided.
+
+### Parameters
+
+-   `fileOut` **[String][1]** the path to write the image data to.
+-   `callback` **[Function][2]?** called on completion with two arguments `(err, info)`.
+    `info` contains the output image `format`, `size` (bytes), `width`, `height`,
+    `channels` and `premultiplied` (indicating if premultiplication was used).
+    When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
+
+### Examples
+
+```javascript
+sharp(input)
+  .toFile('output.png', (err, info) => { ... });
+```
+
+```javascript
+sharp(input)
+  .toFile('output.png')
+  .then(info => { ... })
+  .catch(err => { ... });
+```
+
+-   Throws **[Error][3]** Invalid parameters
+
+Returns **[Promise][4]&lt;[Object][5]>** when no callback is provided
+
+## toBuffer
+
+Write output to a Buffer.
+JPEG, PNG, WebP, TIFF 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`,
+    `channels` and `premultiplied` (indicating if premultiplication was used).
+    When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
+
+A `Promise` is returned when `callback` is not provided.
+
+### Parameters
+
+-   `options` **[Object][5]?** 
+    -   `options.resolveWithObject` **[Boolean][6]?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
+-   `callback` **[Function][2]?** 
+
+### Examples
+
+```javascript
+sharp(input)
+  .toBuffer((err, data, info) => { ... });
+```
+
+```javascript
+sharp(input)
+  .toBuffer()
+  .then(data => { ... })
+  .catch(err => { ... });
+```
+
+```javascript
+sharp(input)
+  .toBuffer({ resolveWithObject: true })
+  .then(({ data, info }) => { ... })
+  .catch(err => { ... });
+```
+
+Returns **[Promise][4]&lt;[Buffer][7]>** 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][5]?** 
+    -   `withMetadata.orientation` **[Number][8]?** value between 1 and 8, used to update the EXIF `Orientation` tag.
+
+### Examples
+
+```javascript
+sharp('input.jpg')
+  .withMetadata()
+  .toFile('output-with-metadata.jpg')
+  .then(info => { ... });
+```
+
+-   Throws **[Error][3]** Invalid parameters
+
+Returns **Sharp** 
+
+## jpeg
+
+Use these JPEG options for output image.
+
+### Parameters
+
+-   `options` **[Object][5]?** output options
+    -   `options.quality` **[Number][8]** quality, integer 1-100 (optional, default `80`)
+    -   `options.progressive` **[Boolean][6]** use progressive (interlace) scan (optional, default `false`)
+    -   `options.chromaSubsampling` **[String][1]** set to '4:4:4' to prevent chroma subsampling when quality &lt;= 90 (optional, default `'4:2:0'`)
+    -   `options.trellisQuantisation` **[Boolean][6]** apply trellis quantisation, requires mozjpeg (optional, default `false`)
+    -   `options.overshootDeringing` **[Boolean][6]** apply overshoot deringing, requires mozjpeg (optional, default `false`)
+    -   `options.optimiseScans` **[Boolean][6]** optimise progressive scans, forces progressive, requires mozjpeg (optional, default `false`)
+    -   `options.optimizeScans` **[Boolean][6]** alternative spelling of optimiseScans (optional, default `false`)
+    -   `options.optimiseCoding` **[Boolean][6]** optimise Huffman coding tables (optional, default `true`)
+    -   `options.optimizeCoding` **[Boolean][6]** alternative spelling of optimiseCoding (optional, default `true`)
+    -   `options.quantisationTable` **[Number][8]** quantization table to use, integer 0-8, requires mozjpeg (optional, default `0`)
+    -   `options.quantizationTable` **[Number][8]** alternative spelling of quantisationTable (optional, default `0`)
+    -   `options.force` **[Boolean][6]** force JPEG output, otherwise attempt to use input format (optional, default `true`)
+
+### Examples
+
+```javascript
+// Convert any input to very high quality JPEG output
+const data = await sharp(input)
+  .jpeg({
+    quality: 100,
+    chromaSubsampling: '4:4:4'
+  })
+  .toBuffer();
+```
+
+-   Throws **[Error][3]** Invalid options
+
+Returns **Sharp** 
+
+## png
+
+Use these PNG options for output image.
+
+PNG output is always full colour at 8 or 16 bits per pixel.
+Indexed PNG input at 1, 2 or 4 bits per pixel is converted to 8 bits per pixel.
+
+### Parameters
+
+-   `options` **[Object][5]?** 
+    -   `options.progressive` **[Boolean][6]** use progressive (interlace) scan (optional, default `false`)
+    -   `options.compressionLevel` **[Number][8]** zlib compression level, 0-9 (optional, default `9`)
+    -   `options.adaptiveFiltering` **[Boolean][6]** use adaptive row filtering (optional, default `false`)
+    -   `options.force` **[Boolean][6]** force PNG output, otherwise attempt to use input format (optional, default `true`)
+
+### Examples
+
+```javascript
+// Convert any input to PNG output
+const data = await sharp(input)
+  .png()
+  .toBuffer();
+```
+
+-   Throws **[Error][3]** Invalid options
+
+Returns **Sharp** 
+
+## webp
+
+Use these WebP options for output image.
+
+### Parameters
+
+-   `options` **[Object][5]?** output options
+    -   `options.quality` **[Number][8]** quality, integer 1-100 (optional, default `80`)
+    -   `options.alphaQuality` **[Number][8]** quality of alpha layer, integer 0-100 (optional, default `100`)
+    -   `options.lossless` **[Boolean][6]** use lossless compression mode (optional, default `false`)
+    -   `options.nearLossless` **[Boolean][6]** use near_lossless compression mode (optional, default `false`)
+    -   `options.force` **[Boolean][6]** force WebP output, otherwise attempt to use input format (optional, default `true`)
+
+### Examples
+
+```javascript
+// Convert any input to lossless WebP output
+const data = await sharp(input)
+  .webp({ lossless: true })
+  .toBuffer();
+```
+
+-   Throws **[Error][3]** Invalid options
+
+Returns **Sharp** 
+
+## tiff
+
+Use these TIFF options for output image.
+
+### Parameters
+
+-   `options` **[Object][5]?** output options
+    -   `options.quality` **[Number][8]** quality, integer 1-100 (optional, default `80`)
+    -   `options.force` **[Boolean][6]** force TIFF output, otherwise attempt to use input format (optional, default `true`)
+    -   `options.compression` **[Boolean][6]** compression options: lzw, deflate, jpeg, ccittfax4 (optional, default `'jpeg'`)
+    -   `options.predictor` **[Boolean][6]** compression predictor options: none, horizontal, float (optional, default `'horizontal'`)
+    -   `options.xres` **[Number][8]** horizontal resolution in pixels/mm (optional, default `1.0`)
+    -   `options.yres` **[Number][8]** vertical resolution in pixels/mm (optional, default `1.0`)
+    -   `options.squash` **[Boolean][6]** squash 8-bit images down to 1 bit (optional, default `false`)
+
+### Examples
+
+```javascript
+// Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output
+sharp('input.svg')
+  .tiff({
+    compression: 'lzw',
+    squash: true
+  })
+  .toFile('1-bpp-output.tiff')
+  .then(info => { ... });
+```
+
+-   Throws **[Error][3]** Invalid options
+
+Returns **Sharp** 
+
+## raw
+
+Force output to be raw, uncompressed uint8 pixel data.
+
+### Examples
+
+```javascript
+// Extract raw RGB pixel data from JPEG input
+const { data, info } = await sharp('input.jpg')
+  .raw()
+  .toBuffer({ resolveWithObject: true });
+```
+
+Returns **Sharp** 
+
+## toFormat
+
+Force output to a given format.
+
+### Parameters
+
+-   `format` **([String][1] \| [Object][5])** as a String or an Object with an 'id' attribute
+-   `options` **[Object][5]** output options
+
+### Examples
+
+```javascript
+// Convert any input to PNG output
+const data = await sharp(input)
+  .toFormat('png')
+  .toBuffer();
+```
+
+-   Throws **[Error][3]** 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.
+
+Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
+
+### Parameters
+
+-   `tile` **[Object][5]?** 
+    -   `tile.size` **[Number][8]** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
+    -   `tile.overlap` **[Number][8]** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
+    -   `tile.angle` **[Number][8]** tile angle of rotation, must be a multiple of 90. (optional, default `0`)
+    -   `tile.depth` **[String][1]?** how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
+    -   `tile.container` **[String][1]** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
+    -   `tile.layout` **[String][1]** 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][3]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[7]: https://nodejs.org/api/buffer.html
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

docs/api-resize.md

@@ -0,0 +1,182 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## resize
+
+Resize image to `width` x `height`.
+By default, the resized image is centre cropped to the exact size specified.
+
+Possible kernels are:
+
+-   `nearest`: Use [nearest neighbour interpolation][1].
+-   `cubic`: Use a [Catmull-Rom spline][2].
+-   `lanczos2`: Use a [Lanczos kernel][3] with `a=2`.
+-   `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+
+### Parameters
+
+-   `width` **[Number][4]?** pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
+-   `height` **[Number][4]?** pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
+-   `options` **[Object][5]?** 
+    -   `options.kernel` **[String][6]** the kernel to use for image reduction. (optional, default `'lanczos3'`)
+    -   `options.fastShrinkOnLoad` **[Boolean][7]** take greater advantage of the JPEG and WebP shrink-on-load feature, which can lead to a slight moiré pattern on some images. (optional, default `true`)
+
+### Examples
+
+```javascript
+sharp(inputBuffer)
+  .resize(200, 300, {
+    kernel: sharp.kernel.nearest
+  })
+  .background('white')
+  .embed()
+  .toFile('output.tiff')
+  .then(function() {
+    // output.tiff is a 200 pixels wide and 300 pixels high image
+    // containing a nearest-neighbour scaled version, embedded on a white canvas,
+    // of the image data in inputBuffer
+  });
+```
+
+-   Throws **[Error][8]** 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][9].
+-   `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
+
+### Parameters
+
+-   `crop` **[String][6]** 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][8]** 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.
+
+### Parameters
+
+-   `embed` **[String][6]** A member of `sharp.gravity` to embed to an edge/corner. (optional, default `'centre'`)
+
+### 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
+  });
+```
+
+-   Throws **[Error][8]** Invalid parameters
+
+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_".
+Use with `max()` to preserve the image's aspect ratio.
+
+The default behaviour _before_ function call is `false`, meaning the image will be enlarged.
+
+### Parameters
+
+-   `withoutEnlargement` **[Boolean][7]**  (optional, default `true`)
+
+Returns **Sharp** 
+
+[1]: http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
+
+[2]: https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline
+
+[3]: https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[9]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29

docs/api-utility.md

@@ -0,0 +1,105 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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][1] \| [Boolean][2])** Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching (optional, default `true`)
+    -   `options.memory` **[Number][3]** is the maximum memory in MB to use for this cache (optional, default `50`)
+    -   `options.files` **[Number][3]** is the maximum number of files to hold open (optional, default `20`)
+    -   `options.items` **[Number][3]** 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][1]** 
+
+## 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][3]?** 
+
+### Examples
+
+```javascript
+const threads = sharp.concurrency(); // 4
+sharp.concurrency(2); // 2
+sharp.concurrency(0); // 4
+```
+
+Returns **[Number][3]** 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][1]** 
+
+## 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][2]**  (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][2]** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

docs/api.md

@@ -1,635 +0,0 @@
-# API
-
-```javascript
-var sharp = require('sharp');
-```
-
-### Input
-
-#### sharp([input])
-
-Constructor to which further methods are chained. `input`, if present, can be one of:
-
-* Buffer containing JPEG, PNG, WebP, GIF* or TIFF image data, or
-* String containing the path to an image file, with most major formats supported.
-
-The object returned implements the
-[stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
-
-JPEG, PNG, WebP, GIF* or TIFF format image data
-can be streamed into the object when `input` is not provided.
-
-JPEG, PNG or WebP format image data can be streamed out from this object.
-
-\* libvips 8.0.0+ is required for Buffer/Stream input of GIF and other `magick` formats.
-
-```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
-  });
-```
-
-#### 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` and `openslide`)
-* `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
-* `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([gravity])
-
-Crop the resized image to the exact size specified, the default behaviour.
-
-`gravity`, if present, is a String or an attribute of the `sharp.gravity` Object e.g. `sharp.gravity.north`.
-
-Possible values are `north`, `northeast`, `east`, `southeast`, `south`, `southwest`, `west`, `northwest`, `center` and `centre`.
-The default gravity is `center`/`centre`.
-
-```javascript
-var transformer = sharp()
-  .resize(300, 200)
-  .crop(sharp.gravity.north)
-  .on('error', function(err) {
-    console.log(err);
-  });
-// Read image data from readableStream, resize and write 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` and `flatten` 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`.
-
-#### 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(path)
-
-_Experimental_
-
-Alpha composite image at `path` over the processed (resized, extracted) image. The dimensions of the two images must match.
-
-* `path` is a String containing the path to an image file with an alpha channel.
-
-```javascript
-sharp('input.png')
-  .rotate(180)
-  .resize(300)
-  .flatten()
-  .background('#ff6600')
-  .overlayWith('overlay.png')
-  .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, 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. The format is 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` and `height`.
-
-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` and `height`.
-
-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()
-
-_Requires libvips 7.42.0+_
-
-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 0 and 7, 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([size], [overlap])
-
-The size and overlap, in pixels, of square Deep Zoom image pyramid tiles.
-
-* `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.
-
-```javascript
-sharp('input.tiff').tile(256).toFile('output.dzi', function(err, info) {
-  // The output.dzi file is the XML format Deep Zoom definition
-  // The output_files directory contains 256x256 pixel 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()
-
-_Requires libvips 7.42.0+_
-
-An advanced setting to disable adaptive row filtering for the lossless PNG output format.
-
-#### trellisQuantisation() / trellisQuantization()
-
-_Requires libvips 8.0.0+ compiled against mozjpeg 3.0+_
-
-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 8.0.0+ compiled against mozjpeg 3.0+_
-
-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 8.0.0+ compiled against mozjpeg 3.0+_
-
-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([memory], [items])
-
-If `memory` or `items` are provided, set the limits of _libvips'_ operation cache.
-
-* `memory` is the maximum memory in MB to use for this cache, with a default value of 100
-* `items` is the maximum number of operations to cache, with a default value of 500
-
-This method always returns cache statistics, useful for determining how much working memory is required for a particular task.
-
-```javascript
-var stats = sharp.cache(); // { current: 75, high: 99, memory: 100, items: 500 }
-sharp.cache(200); // { current: 75, high: 99, memory: 200, items: 500 }
-sharp.cache(50, 200); // { current: 49, high: 99, memory: 50, items: 200}
-```
-
-#### 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 }
-```

docs/changelog.md

@@ -1,8 +1,661 @@
 # Changelog
 
+### v0.20 - "*prebuild*"
+
+Requires libvips v8.6.1.
+
+#### v0.20.7 - 21<sup>st</sup> August 2018
+
+* Use copy+unlink if rename operation fails during installation.
+  [#1345](https://github.com/lovell/sharp/issues/1345)
+
+#### v0.20.6 - 20<sup>th</sup> August 2018
+
+* Add removeAlpha operation to remove alpha channel, if any.
+  [#1248](https://github.com/lovell/sharp/issues/1248)
+
+* Expose mozjpeg quant_table flag.
+  [#1285](https://github.com/lovell/sharp/pull/1285)
+  [@rexxars](https://github.com/rexxars)
+
+* Allow full WebP alphaQuality range of 0-100.
+  [#1290](https://github.com/lovell/sharp/pull/1290)
+  [@sylvaindumont](https://github.com/sylvaindumont)
+
+* Cache libvips binaries to reduce re-install time.
+  [#1301](https://github.com/lovell/sharp/issues/1301)
+
+* Ensure vendor platform mismatch throws error at install time.
+  [#1303](https://github.com/lovell/sharp/issues/1303)
+
+* Improve install time error messages for FreeBSD users.
+  [#1310](https://github.com/lovell/sharp/issues/1310)
+
+* Ensure extractChannel works with 16-bit images.
+  [#1330](https://github.com/lovell/sharp/issues/1330)
+
+* Expose depth option for tile-based output.
+  [#1342](https://github.com/lovell/sharp/pull/1342)
+  [@alundavies](https://github.com/alundavies)
+
+* Add experimental entropy field to stats response.
+
+#### v0.20.5 - 27<sup>th</sup> June 2018
+
+* Expose libjpeg optimize_coding flag.
+  [#1265](https://github.com/lovell/sharp/pull/1265)
+  [@tomlokhorst](https://github.com/tomlokhorst)
+
+#### v0.20.4 - 20<sup>th</sup> June 2018
+
+* Prevent possible rounding error when using shrink-on-load and 90/270 degree rotation.
+  [#1241](https://github.com/lovell/sharp/issues/1241)
+  [@anahit42](https://github.com/anahit42)
+
+* Ensure extractChannel sets correct single-channel colour space interpretation.
+  [#1257](https://github.com/lovell/sharp/issues/1257)
+  [@jeremychone](https://github.com/jeremychone)
+
+#### v0.20.3 - 29<sup>th</sup> May 2018
+
+* Fix tint operation by ensuring LAB interpretation and allowing negative values.
+  [#1235](https://github.com/lovell/sharp/issues/1235)
+  [@wezside](https://github.com/wezside)
+
+#### v0.20.2 - 28<sup>th</sup> April 2018
+
+* Add tint operation to set image chroma.
+  [#825](https://github.com/lovell/sharp/pull/825)
+  [@rikh42](https://github.com/rikh42)
+
+* Add environment variable to ignore globally-installed libvips.
+  [#1165](https://github.com/lovell/sharp/pull/1165)
+  [@oncletom](https://github.com/oncletom)
+
+* Add support for page selection with multi-page input (GIF/TIFF).
+  [#1204](https://github.com/lovell/sharp/pull/1204)
+  [@woolite64](https://github.com/woolite64)
+
+* Add support for Group4 (CCITTFAX4) compression with TIFF output.
+  [#1208](https://github.com/lovell/sharp/pull/1208)
+  [@woolite64](https://github.com/woolite64)
+
+#### v0.20.1 - 17<sup>th</sup> March 2018
+
+* Improve installation experience when a globally-installed libvips below the minimum required version is found.
+  [#1148](https://github.com/lovell/sharp/issues/1148)
+
+* Prevent smartcrop error when cumulative rounding is below target size.
+  [#1154](https://github.com/lovell/sharp/issues/1154)
+  [@ralrom](https://github.com/ralrom)
+
+* Expose libvips' median filter operation.
+  [#1161](https://github.com/lovell/sharp/pull/1161)
+  [@BiancoA](https://github.com/BiancoA)
+
+#### v0.20.0 - 5<sup>th</sup> March 2018
+
+* Add support for prebuilt sharp binaries on common platforms.
+  [#186](https://github.com/lovell/sharp/issues/186)
+
+### v0.19 - "*suit*"
+
+Requires libvips v8.6.1.
+
+#### v0.19.1 - 24<sup>th</sup> February 2018
+
+* Expose libvips' linear transform feature.
+  [#1024](https://github.com/lovell/sharp/pull/1024)
+  [@3epnm](https://github.com/3epnm)
+
+* Expose angle option for tile-based output.
+  [#1121](https://github.com/lovell/sharp/pull/1121)
+  [@BiancoA](https://github.com/BiancoA)
+
+* Prevent crop operation when image already at or below target dimensions.
+  [#1134](https://github.com/lovell/sharp/issues/1134)
+  [@pieh](https://github.com/pieh)
+
+#### v0.19.0 - 11<sup>th</sup> January 2018
+
+* Expose offset coordinates of strategy-based crop.
+  [#868](https://github.com/lovell/sharp/issues/868)
+  [@mirohristov-com](https://github.com/mirohristov-com)
+
+* PNG output now defaults to adaptiveFiltering=false, compressionLevel=9
+  [#872](https://github.com/lovell/sharp/issues/872)
+  [@wmertens](https://github.com/wmertens)
+
+* Add stats feature for pixel-derived image statistics.
+  [#915](https://github.com/lovell/sharp/pull/915)
+  [@rnanwani](https://github.com/rnanwani)
+
+* Add failOnError option to fail-fast on bad input image data.
+  [#976](https://github.com/lovell/sharp/pull/976)
+  [@mceachen](https://github.com/mceachen)
+
+* Resize: switch to libvips' implementation, make fastShrinkOnLoad optional, remove interpolator and centreSampling options.
+  [#977](https://github.com/lovell/sharp/pull/977)
+  [@jardakotesovec](https://github.com/jardakotesovec)
+
+* Attach finish event listener to a clone only for Stream-based input.
+  [#995](https://github.com/lovell/sharp/issues/995)
+  [@whmountains](https://github.com/whmountains)
+
+* Add tilecache before smartcrop to avoid over-computation of previous operations.
+  [#1028](https://github.com/lovell/sharp/issues/1028)
+  [@coffeebite](https://github.com/coffeebite)
+
+* Prevent toFile extension taking precedence over requested format.
+  [#1037](https://github.com/lovell/sharp/issues/1037)
+  [@tomgallagher](https://github.com/tomgallagher)
+
+* Add support for gravity option to existing embed feature.
+  [#1038](https://github.com/lovell/sharp/pull/1038)
+  [@AzureByte](https://github.com/AzureByte)
+
+* Expose IPTC and XMP metadata when available.
+  [#1079](https://github.com/lovell/sharp/pull/1079)
+  [@oaleynik](https://github.com/oaleynik)
+
+* TIFF output: switch default predictor from 'none' to 'horizontal' to match libvips' behaviour.
+
+### v0.18 - "*ridge*"
+
+Requires libvips v8.5.5.
+
+#### v0.18.4 - 18<sup>th</sup> September 2017
+
+* Ensure input Buffer really is marked as Persistent, prevents mark-sweep GC.
+  [#950](https://github.com/lovell/sharp/issues/950)
+  [@lfdoherty](https://github.com/lfdoherty)
+
+#### v0.18.3 - 13<sup>th</sup> September 2017
+
+* Skip shrink-on-load when trimming.
+  [#888](https://github.com/lovell/sharp/pull/888)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Migrate from got to simple-get for basic auth support.
+  [#945](https://github.com/lovell/sharp/pull/945)
+  [@pbomb](https://github.com/pbomb)
+
+#### v0.18.2 - 1<sup>st</sup> July 2017
+
+* Expose libvips' xres and yres properties for TIFF output.
+  [#828](https://github.com/lovell/sharp/pull/828)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Ensure flip and flop operations work with auto-rotate.
+  [#837](https://github.com/lovell/sharp/issues/837)
+  [@rexxars](https://github.com/rexxars)
+
+* Allow binary download URL override via SHARP_DIST_BASE_URL env variable.
+  [#841](https://github.com/lovell/sharp/issues/841)
+
+* Add support for Solus Linux.
+  [#857](https://github.com/lovell/sharp/pull/857)
+  [@ekremkaraca](https://github.com/ekremkaraca)
+
+#### v0.18.1 - 30<sup>th</sup> May 2017
+
+* Remove regression from #781 that could cause incorrect shrink calculation.
+  [#831](https://github.com/lovell/sharp/issues/831)
+  [@suprMax](https://github.com/suprMax)
+
+#### v0.18.0 - 30<sup>th</sup> May 2017
+
+* Remove the previously-deprecated output format "option" functions:
+    quality, progressive, compressionLevel, withoutAdaptiveFiltering,
+    withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
+    overshootDeringing, optimiseScans and optimizeScans.
+
+* Ensure maximum output dimensions are based on the format to be used.
+  [#176](https://github.com/lovell/sharp/issues/176)
+  [@stephanebachelier](https://github.com/stephanebachelier)
+
+* Avoid costly (un)premultiply when using overlayWith without alpha channel.
+  [#573](https://github.com/lovell/sharp/issues/573)
+  [@strarsis](https://github.com/strarsis)
+
+* Include pixel depth (e.g. "uchar") when reading metadata.
+  [#577](https://github.com/lovell/sharp/issues/577)
+  [@moedusa](https://github.com/moedusa)
+
+* Add support for Buffer and Stream-based TIFF output.
+  [#587](https://github.com/lovell/sharp/issues/587)
+  [@strarsis](https://github.com/strarsis)
+
+* Expose warnings from libvips via NODE_DEBUG=sharp environment variable.
+  [#607](https://github.com/lovell/sharp/issues/607)
+  [@puzrin](https://github.com/puzrin)
+
+* Switch to the libvips implementation of "attention" and "entropy" crop strategies.
+  [#727](https://github.com/lovell/sharp/issues/727)
+
+* Improve performance and accuracy of nearest neighbour integral upsampling.
+  [#752](https://github.com/lovell/sharp/issues/752)
+  [@MrIbby](https://github.com/MrIbby)
+
+* Constructor single argument API: allow plain object, reject null/undefined.
+  [#768](https://github.com/lovell/sharp/issues/768)
+  [@kub1x](https://github.com/kub1x)
+
+* Ensure ARM64 pre-built binaries use correct C++11 ABI version.
+  [#772](https://github.com/lovell/sharp/issues/772)
+  [@ajiratech2](https://github.com/ajiratech2)
+
+* Prevent aliasing by using dynamic values for shrink(-on-load).
+  [#781](https://github.com/lovell/sharp/issues/781)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Expose libvips' "squash" parameter to enable 1-bit TIFF output.
+  [#783](https://github.com/lovell/sharp/pull/783)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Add support for rotation using any multiple of +/-90 degrees.
+  [#791](https://github.com/lovell/sharp/pull/791)
+  [@ncoden](https://github.com/ncoden)
+
+* Add "jpg" alias to toFormat as shortened form of "jpeg".
+  [#814](https://github.com/lovell/sharp/pull/814)
+  [@jingsam](https://github.com/jingsam)
+
+### 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.
+  [#128](https://github.com/lovell/sharp/issues/128)
+  [@blowsie](https://github.com/blowsie)
+
+* Add support for Zoomify and Google tile layouts. Breaks existing tile API.
+  [#223](https://github.com/lovell/sharp/issues/223)
+  [@bdunnette](https://github.com/bdunnette)
+
+* Improvements to overlayWith: differing sizes/formats, gravity, buffer input.
+  [#239](https://github.com/lovell/sharp/issues/239)
+  [@chrisriley](https://github.com/chrisriley)
+
+* Add entropy-based crop strategy to remove least interesting edges.
+  [#295](https://github.com/lovell/sharp/issues/295)
+  [@rightaway](https://github.com/rightaway)
+
+* Expose density metadata; set density of images from vector input.
+  [#338](https://github.com/lovell/sharp/issues/338)
+  [@lookfirst](https://github.com/lookfirst)
+
+* Emit post-processing 'info' event for Stream output.
+  [#367](https://github.com/lovell/sharp/issues/367)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Ensure output image EXIF Orientation values are within 1-8 range.
+  [#385](https://github.com/lovell/sharp/pull/385)
+  [@jtobinisaniceguy](https://github.com/jtobinisaniceguy)
+
+* Ensure ratios are not swapped when rotating 90/270 and ignoring aspect.
+  [#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
+
+#### v0.13.1 - 27<sup>th</sup> February 2016
+
+* Fix embedding onto transparent backgrounds; regression introduced in v0.13.0.
+  [#366](https://github.com/lovell/sharp/issues/366)
+  [@diegocsandrim](https://github.com/diegocsandrim)
+
+#### v0.13.0 - 15<sup>th</sup> February 2016
+
+* Improve vector image support by allowing control of density/DPI.
+  Switch pre-built libs from Imagemagick to Graphicsmagick.
+  [#110](https://github.com/lovell/sharp/issues/110)
+  [@bradisbell](https://github.com/bradisbell)
+
+* Add support for raw, uncompressed pixel Buffer/Stream input.
+  [#220](https://github.com/lovell/sharp/issues/220)
+  [@mikemorris](https://github.com/mikemorris)
+
+* Switch from libvips' C to C++ bindings, requires upgrade to v8.2.2.
+  [#299](https://github.com/lovell/sharp/issues/299)
+
+* Control number of open files in libvips' cache; breaks existing `cache` behaviour.
+  [#315](https://github.com/lovell/sharp/issues/315)
+  [@impomezia](https://github.com/impomezia)
+
+* Ensure 16-bit input images can be normalised and embedded onto transparent backgrounds.
+  [#339](https://github.com/lovell/sharp/issues/339)
+  [#340](https://github.com/lovell/sharp/issues/340)
+  [@janaz](https://github.com/janaz)
+
+* Ensure selected format takes precedence over any unknown output filename extension.
+  [#344](https://github.com/lovell/sharp/issues/344)
+  [@ubaltaci](https://github.com/ubaltaci)
+
+* Add support for libvips' PBM, PGM, PPM and FITS image format loaders.
+  [#347](https://github.com/lovell/sharp/issues/347)
+  [@oaleynik](https://github.com/oaleynik)
+
+* Ensure default crop gravity is center/centre.
+  [#351](https://github.com/lovell/sharp/pull/351)
+  [@joelmukuthu](https://github.com/joelmukuthu)
+
+* Improve support for musl libc systems e.g. Alpine Linux.
+  [#354](https://github.com/lovell/sharp/issues/354)
+  [#359](https://github.com/lovell/sharp/pull/359)
+  [@download13](https://github.com/download13)
+  [@wjordan](https://github.com/wjordan)
+
+* Small optimisation when reducing by an integral factor to favour shrink over affine.
+
+* Add support for gamma correction of images with an alpha channel.
+
 ### v0.12 - "*look*"
 
-#### v0.12.0 - TBD
+Requires libvips v8.2.0
+
+#### v0.12.2 - 16<sup>th</sup> January 2016
+
+* Upgrade libvips to v8.2.0 for improved vips_shrink.
+
+* Add pre-compiled libvips for ARMv6+ CPUs.
+
+* Ensure 16-bit input images work with embed option.
+  [#325](https://github.com/lovell/sharp/issues/325)
+  [@janaz](https://github.com/janaz)
+
+* Allow compilation with gmake to provide FreeBSD support.
+  [#326](https://github.com/lovell/sharp/issues/326)
+  [@c0decafe](https://github.com/c0decafe)
+
+* Attempt to remove temporary file after installation.
+  [#331](https://github.com/lovell/sharp/issues/331)
+  [@dtoubelis](https://github.com/dtoubelis)
+
+#### v0.12.1 - 12<sup>th</sup> December 2015
+
+* Allow use of SIMD vector instructions (via liborc) to be toggled on/off.
+  [#172](https://github.com/lovell/sharp/issues/172)
+  [@bkw](https://github.com/bkw)
+  [@puzrin](https://github.com/puzrin)
+
+* Ensure embedded ICC profiles output with perceptual intent.
+  [#321](https://github.com/lovell/sharp/issues/321)
+  [@vlapo](https://github.com/vlapo)
+
+* Use the NPM-configured HTTPS proxy, if any, for binary downloads.
+
+#### v0.12.0 - 23<sup>rd</sup> November 2015
 
 * Bundle pre-compiled libvips and its dependencies for 64-bit Linux and Windows.
   [#42](https://github.com/lovell/sharp/issues/42)

docs/css/extra.css

@@ -0,0 +1,5 @@
+/* Nest document subheadings in navigation */
+ul.subnav ul:not(.subnav) {
+  padding-left: 2em;
+  font-size: 80%;
+}

docs/index.md

@@ -1,32 +1,29 @@
 # 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
+Resizing an image is typically 4x-5x faster than using the
-the quickest ImageMagick and GraphicsMagick settings.
+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.
 
-64-bit Windows and recent Linux systems do not require
+Most 64-bit OS X, Windows and Linux (glibc) systems running
-the installation of any external runtime dependencies.
+Node versions 4, 6, 8 and 10
-
+do not require any additional install or 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 other libmagick-supported formats.
 
-Output images can be in JPEG, PNG and WebP formats as well as uncompressed raw pixel data.
+Output images can be in JPEG, PNG, WebP and TIFF formats as well as uncompressed raw pixel data.
 
 Streams, Buffer objects and the filesystem can be used for input and output.
 
@@ -50,7 +47,7 @@ are held in memory and processed at a time,
 taking full advantage of multiple CPU cores and L1/L2/L3 cache.
 
 Everything remains non-blocking thanks to _libuv_,
-no child processes are spawned and Promises/A+ are supported.
+no child processes are spawned and Promises/async/await are supported.
 
 ### Optimal
 
@@ -59,9 +56,9 @@ without having to use separate command line tools like
 [jpegoptim](https://github.com/tjko/jpegoptim) and
 [jpegtran](http://jpegclub.org/jpegtran/).
 
-PNG filtering can be disabled,
+PNG filtering is disabled by default,
 which for diagrams and line art often produces the same result
-as [pngcrush](http://pmt.sourceforge.net/pngcrush/).
+as [pngcrush](https://pmt.sourceforge.io/pngcrush/).
 
 ### Contributing
 
@@ -89,12 +86,42 @@ 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)
+* [Yves Bos](https://github.com/YvesBos)
+* [Nicolas Coden](https://github.com/ncoden)
+* [Matt Parrish](https://github.com/pbomb)
+* [Matthew McEachen](https://github.com/mceachen)
+* [Jarda Kotěšovec](https://github.com/jardakotesovec)
+* [Kenric D'Souza](https://github.com/AzureByte)
+* [Oleh Aleinyk](https://github.com/oaleynik)
+* [Marcel Bretschneider](https://github.com/3epnm)
+* [Andrea Bianco](https://github.com/BiancoA)
+* [Rik Heywood](https://github.com/rikh42)
+* [Thomas Parisot](https://github.com/oncletom)
+* [Nathan Graves](https://github.com/woolite64)
+* [Tom Lokhorst](https://github.com/tomlokhorst)
+* [Espen Hovlandsdal](https://github.com/rexxars)
+* [Sylvain Dumont](https://github.com/sylvaindumont)
+* [Alun Davies](https://github.com/alundavies)
 
 Thank you!
 
 ### Licence
 
-Copyright 2013, 2014, 2015 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017, 2018 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,84 +4,124 @@
 npm install sharp
 ```
 
-### Prerequisites
+```sh
+yarn add sharp
+```
 
-* C++11 compatible compiler such as gcc 4.6+ (Node v4+ requires gcc 4.8+), clang 3.0+ or MSVC 2013
+## Prerequisites
-* [node-gyp](https://github.com/TooTallNate/node-gyp#installation)
+
+* Node v4.5.0+
+
+### Building from source
+
+Pre-compiled binaries for sharp are provided for use with
+Node versions 4, 6, 8 and 10 on
+64-bit Windows, OS X and Linux platforms.
+
+Sharp will be built from source at install time when:
+
+* a globally-installed libvips is detected,
+* pre-compiled binaries do not exist for the current platform and Node version, or
+* when the `npm install --build-from-source` flag is used.
+
+Building from source requires:
+
+* 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)
+
+## libvips
 
 ### Linux
 
-[![Ubuntu 14.04 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
+[![Ubuntu 16.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` 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 7MB.
 
-Most recent 64-bit Linux-based operating systems should "just work", e.g.:
+Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work", e.g.:
 
-* Debian 7, 8
+* Debian 7+
-* Ubuntu 12.04, 14.04, 14.10, 15.04, 15.10
+* Ubuntu 14.04+
-* Centos 7
+* Centos 7+
-* Fedora 20, 21
+* Fedora
-* openSUSE 13.2
+* openSUSE 13.2+
-* Archlinux 2015.06.01
+* Archlinux
+* Raspbian Jessie
+* Amazon Linux
+* Solus
+
+To use a globally-installed version of libvips instead of the provided binaries,
+make sure it is 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`.
+
+If you are using non-standard 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.
 
-Preference will be given to an existing globally-installed (via `pkg-config`)
-version of libvips that meets the minimum version requirement.
 This allows the use of newer versions of libvips with older versions of sharp.
 
-For older and 32-bit Linux-based operating systems,
+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
+https://jcupitt.github.io/libvips/install.html#building-libvips-from-a-source-tarball
-(requires `curl` and `pkg-config`):
+
+#### Alpine Linux
+
+libvips is available in the
+[testing repository](https://pkgs.alpinelinux.org/packages?name=vips-dev):
 
 ```sh
-curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | sudo bash -
+apk add vips-dev fftw-dev --update-cache --repository https://dl-3.alpinelinux.org/alpine/edge/testing/
 ```
 
+The smaller stack size of musl libc means
+libvips may need to be used without a cache
+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.12 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 7MB.
 
-```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.
+This involves an automated HTTPS download of approximately 12MB.
 
 Only 64-bit (x64) `node.exe` is supported.
-The WebP format is currently unavailable on Windows.
+
+### FreeBSD
+
+libvips must be installed before `npm install` is run.
+
+This can be achieved via package or ports:
+
+```sh
+pkg install -y pkgconf vips
+```
+
+```sh
+cd /usr/ports/graphics/vips/ && make install clean
+```
+
+FreeBSD's gcc v4 and v5 need `CXXFLAGS=-D_GLIBCXX_USE_C99` set for C++11 support due to
+https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=193528
 
 ### 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 7MB.
-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
 
@@ -99,8 +139,147 @@ docker pull marcbachmann/libvips
 docker pull wjordan/libvips
 ```
 
+[Tailor Brands](https://github.com/TailorBrands) maintain
+[Debian-based Dockerfiles for libvips and nodejs](https://github.com/TailorBrands/docker-libvips).
+
+```sh
+docker pull tailor/docker-libvips
+```
+
+### AWS Lambda
+
+A [deployment package](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html) for the
+[Lambda Execution Environment](http://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html)
+can be built using Docker.
+
+```sh
+rm -rf node_modules/sharp
+docker run -v "$PWD":/var/task lambci/lambda:build-nodejs6.10 npm install
+```
+
+Set the Lambda runtime to Node.js 6.10.
+
+To get the best performance select the largest memory available. A 1536 MB function provides ~12x more CPU time than a 128 MB function.
+
+### NW.js
+
+Run the `nw-gyp` tool after installation.
+
+```sh
+cd node-modules/sharp
+nw-gyp rebuild --arch=x64 --target=[your nw version]
+node node_modules/sharp/install/dll-copy
+```
+
+See also http://docs.nwjs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/
+
 ### Build tools
 
 * [gulp-responsive](https://www.npmjs.com/package/gulp-responsive)
-* [gulp-sharp](https://www.npmjs.com/package/gulp-sharp)
 * [grunt-sharp](https://www.npmjs.com/package/grunt-sharp)
+
+### Coding tools
+
+* [Sharp TypeScript Types](https://www.npmjs.com/package/@types/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.
+
+### Pre-compiled libvips binaries
+
+This module will attempt to download a pre-compiled bundle of libvips
+and its dependencies on Linux and Windows machines under either of these
+conditions:
+
+1. If a global installation of libvips that meets the
+minimum version requirement cannot be found;
+1. If `SHARP_IGNORE_GLOBAL_LIBVIPS` environment variable is set.
+
+```sh
+SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install sharp
+```
+
+Should you need to manually download and inspect these files,
+you can do so via https://github.com/lovell/sharp-libvips/releases
+
+Should you wish to install these from your own location,
+set the `SHARP_DIST_BASE_URL` environment variable, e.g.
+
+```sh
+SHARP_DIST_BASE_URL="https://hostname/path/" npm install sharp
+```
+
+to use `https://hostname/path/libvips-x.y.z-platform.tar.gz`.
+
+### Licences
+
+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                                                                               |
+| expat         | MIT Licence                                                                                              |
+| 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,60 +2,66 @@
 
 ### Test environment
 
-* AWS EC2 [c4.xlarge](http://aws.amazon.com/ec2/instance-types/#c4) (4x E5-2666 v3 @2.90GHz)
+* AWS EC2 eu-west-1 [c5.large](https://aws.amazon.com/ec2/instance-types/c5/) (2x Xeon Platinum 8124M CPU @ 3.00GHz)
-* Amazon Linux 2015.09.1
+* Ubuntu 17.10 (hvm:ebs-ssd, 20180102, ami-0741d47e)
-* Node.js v5.1.0
+* Node.js v8.9.4
 
 ### The contenders
 
-* [jimp](https://www.npmjs.com/package/jimp) v0.2.19 - Image processing in pure JavaScript. Bilinear interpolation only.
+* [jimp](https://www.npmjs.com/package/jimp) v0.2.28 - 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.
+* [pajk-lwip](https://www.npmjs.com/package/pajk-lwip) v0.2.0 (fork) - Wrapper around CImg that compiles dependencies from source.
-* [imagemagick-native](https://www.npmjs.com/package/imagemagick-native) @5ab570e - Wrapper around libmagick++, supports Buffers only.
+* [mapnik](https://www.npmjs.org/package/mapnik) v3.6.2 - 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.1 - Fully featured wrapper around GraphicsMagick's `gm` command line utility.
-* sharp v0.12.0 / libvips v8.1.1 - Caching within libvips disabled to ensure a fair comparison.
+* [images](https://www.npmjs.com/package/images) v3.0.1 - Compiles dependencies from source. Provides bicubic interpolation.
+* sharp v0.19.0 / libvips v8.6.1 - 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               | file   | file   |    0.99 |      1.0 |
+| jimp (bilinear)    | buffer | buffer |    1.14 |      1.0 |
-| jimp               | buffer | buffer |    1.05 |      1.1 |
+| lwip               | buffer | buffer |    1.86 |      1.6 |
-| lwip               | file   | file   |    1.13 |      1.1 |
+| mapnik             | buffer | buffer |    3.34 |      2.9 |
-| lwip               | buffer | buffer |    1.13 |      1.1 |
+| imagemagick-native | buffer | buffer |    4.13 |      3.6 |
-| imagemagick-native | buffer | buffer |    1.67 |      1.7 |
+| gm                 | buffer | buffer |    4.21 |      3.7 |
-| imagemagick        | file   | file   |    5.19 |      5.2 |
+| gm                 | file   | file   |    4.27 |      3.7 |
-| gm                 | buffer | buffer |    5.56 |      5.6 |
+| imagemagick        | file   | file   |    4.67 |      4.1 |
-| gm                 | file   | file   |    5.59 |      5.6 |
+| images (bicubic)   | file   | file   |    6.22 |      5.5 |
-| sharp              | stream | stream |   21.91 |     22.1 |
+| sharp              | stream | stream |   24.43 |     21.4 |
-| sharp              | file   | file   |   22.79 |     23.0 |
+| sharp              | file   | file   |   25.97 |     22.7 |
-| sharp              | file   | buffer |   22.91 |     23.1 |
+| sharp              | file   | buffer |   26.00 |     22.8 |
-| sharp              | buffer | file   |   23.03 |     23.3 |
+| sharp              | buffer | file   |   26.33 |     23.0 |
-| sharp              | buffer | buffer |   23.15 |     23.4 |
+| sharp              | buffer | buffer |   26.43 |     23.1 |
 
-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.
 
 ### Benchmark test prerequisites
 
-Requires both _ImageMagick_ and _GraphicsMagick_:
+Requires _ImageMagick_, _GraphicsMagick_ and _Mapnik_:
 
 ```sh
 brew install imagemagick
 brew install graphicsmagick
+brew install mapnik
 ```
 
 ```sh
-sudo apt-get install imagemagick libmagick++-dev graphicsmagick
+sudo apt-get install imagemagick libmagick++-dev graphicsmagick mapnik-dev
 ```
 
 ```sh
-sudo yum install ImageMagick-devel ImageMagick-c++-devel GraphicsMagick
+sudo yum install ImageMagick-devel ImageMagick-c++-devel GraphicsMagick mapnik-devel
 ```
 
 ### Running the benchmark test

index.js

@@ -1,865 +0,0 @@
-'use strict';
-
-var path = require('path');
-var util = require('util');
-var stream = require('stream');
-var events = require('events');
-
-var semver = require('semver');
-var color = require('color');
-var BluebirdPromise = require('bluebird');
-
-var sharp = require('./build/Release/sharp');
-
-// Versioning
-var versions = {
-  vips: sharp.libvipsVersion()
-};
-(function() {
-  // Does libvips meet minimum requirement?
-  var libvipsVersionMin = require('./package.json').config.libvips;
-  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('./lib/versions.json');
-  } catch (err) {}
-})();
-
-// Limits
-var maximum = {
-  width: 0x3FFF,
-  height: 0x3FFF,
-  pixels: Math.pow(0x3FFF, 2)
-};
-
-// Constructor-factory
-var Sharp = function(input) {
-  if (!(this instanceof Sharp)) {
-    return new Sharp(input);
-  }
-  stream.Duplex.call(this);
-  this.options = {
-    // input options
-    bufferIn: null,
-    streamIn: false,
-    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',
-    gravity: 0,
-    angle: 0,
-    rotateBeforePreExtract: false,
-    flip: false,
-    flop: false,
-    withoutEnlargement: false,
-    interpolator: 'bicubic',
-    // operations
-    background: [0, 0, 0, 255],
-    flatten: false,
-    negate: false,
-    blurSigma: 0,
-    sharpenRadius: 0,
-    sharpenFlat: 1,
-    sharpenJagged: 2,
-    threshold: 0,
-    gamma: 0,
-    greyscale: false,
-    normalize: 0,
-    // overlay
-    overlayPath: '',
-    // output options
-    output: '__input',
-    progressive: false,
-    quality: 80,
-    compressionLevel: 6,
-    withoutAdaptiveFiltering: false,
-    withoutChromaSubsampling: false,
-    trellisQuantisation: false,
-    overshootDeringing: false,
-    optimiseScans: false,
-    streamOut: false,
-    withMetadata: false,
-    withMetadataOrientation: -1,
-    tileSize: 256,
-    tileOverlap: 0,
-    // Function to notify of queue length changes
-    queueListener: function(queueLength) {
-      module.exports.queue.emit('change', queueLength);
-    }
-  };
-  if (typeof input === 'string') {
-    // input=file
-    this.options.fileIn = input;
-  } else if (typeof input === 'object' && input instanceof Buffer) {
-    // input=buffer
-    this.options.bufferIn = input;
-  } else if (typeof input === 'undefined') {
-    // input=stream
-    this.options.streamIn = true;
-  } else {
-    throw new Error('Unsupported input ' + typeof input);
-  }
-  return this;
-};
-module.exports = Sharp;
-util.inherits(Sharp, stream.Duplex);
-
-/*
-  EventEmitter singleton emits queue length 'change' events
-*/
-module.exports.queue = new events.EventEmitter();
-
-/*
-  Supported image formats
-*/
-module.exports.format = sharp.format();
-
-/*
-  Version numbers of libvips and its dependencies
-*/
-module.exports.versions = versions;
-
-/*
-  Handle incoming chunk on Writable Stream
-*/
-Sharp.prototype._write = function(chunk, encoding, callback) {
-  /*jslint unused: false */
-  if (this.options.streamIn) {
-    if (typeof chunk === 'object' && chunk instanceof Buffer) {
-      if (this.options.bufferIn instanceof Buffer) {
-        // Append to existing Buffer
-        this.options.bufferIn = Buffer.concat(
-          [this.options.bufferIn, chunk],
-          this.options.bufferIn.length + chunk.length
-        );
-      } else {
-        // Create new Buffer
-        this.options.bufferIn = new Buffer(chunk.length);
-        chunk.copy(this.options.bufferIn);
-      }
-      callback();
-    } else {
-      callback(new Error('Non-Buffer data on Writable Stream'));
-    }
-  } else {
-    callback(new Error('Unexpected data on Writable Stream'));
-  }
-};
-
-// Crop this part of the resized image (Center/Centre, North, East, South, West)
-module.exports.gravity = {
-  'center': 0,
-  'centre': 0,
-  'north': 1,
-  'east': 2,
-  'south': 3,
-  'west': 4,
-  'northeast': 5,
-  'southeast': 6,
-  'southwest': 7,
-  'northwest': 8
-};
-
-Sharp.prototype.crop = function(gravity) {
-  this.options.canvas = 'crop';
-  if (typeof gravity === 'number' && !Number.isNaN(gravity) && gravity >= 0 && gravity <= 8) {
-    this.options.gravity = gravity;
-  } else if (typeof gravity === 'string' && typeof module.exports.gravity[gravity] === 'number') {
-    this.options.gravity = module.exports.gravity[gravity];
-  } else {
-    throw new Error('Unsupported crop gravity ' + gravity);
-  }
-  return this;
-};
-
-Sharp.prototype.extract = function(options) {
-  if (!options || typeof options !== 'object') {
-    // Legacy extract(top,left,width,height) syntax
-    options = {
-      left: arguments[1],
-      top: arguments[0],
-      width: arguments[2],
-      height: arguments[3]
-    };
-  }
-  var suffix = this.options.width === -1 && this.options.height === -1 ? 'Pre' : 'Post';
-  ['left', 'top', 'width', 'height'].forEach(function (name) {
-    var value = options[name];
-    if (typeof value === 'number' && !Number.isNaN(value) && value % 1 === 0 && 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;
-};
-
-/*
-  Set the background colour for embed and flatten operations.
-  Delegates to the 'Color' module, which can throw an Error
-  but is liberal in what it accepts, clamping values to sensible min/max.
-*/
-Sharp.prototype.background = function(rgba) {
-  var colour = color(rgba);
-  this.options.background = colour.rgbArray();
-  this.options.background.push(colour.alpha() * 255);
-  return this;
-};
-
-Sharp.prototype.embed = function() {
-  this.options.canvas = 'embed';
-  return this;
-};
-
-Sharp.prototype.max = function() {
-  this.options.canvas = 'max';
-  return this;
-};
-
-Sharp.prototype.min = function() {
-  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 the resize method.
-*/
-Sharp.prototype.ignoreAspectRatio = function() {
-  this.options.canvas = 'ignore_aspect';
-  return this;
-};
-
-Sharp.prototype.flatten = function(flatten) {
-  this.options.flatten = (typeof flatten === 'boolean') ? flatten : true;
-  return this;
-};
-
-Sharp.prototype.negate = function(negate) {
-  this.options.negate = (typeof negate === 'boolean') ? negate : true;
-  return this;
-};
-
-Sharp.prototype.overlayWith = function(overlayPath) {
-  if (typeof overlayPath !== 'string') {
-    throw new Error('The overlay path must be a string');
-  }
-  if (overlayPath === '') {
-    throw new Error('The overlay path cannot be empty');
-  }
-  this.options.overlayPath = overlayPath;
-  return this;
-};
-
-/*
-  Rotate output image by 0, 90, 180 or 270 degrees
-  Auto-rotation based on the EXIF Orientation tag is represented by an angle of -1
-*/
-Sharp.prototype.rotate = function(angle) {
-  if (typeof angle === 'undefined') {
-    this.options.angle = -1;
-  } else if (!Number.isNaN(angle) && [0, 90, 180, 270].indexOf(angle) !== -1) {
-    this.options.angle = angle;
-  } else {
-    throw new Error('Unsupported angle (0, 90, 180, 270) ' + angle);
-  }
-  return this;
-};
-
-/*
-  Flip the image vertically, about the Y axis
-*/
-Sharp.prototype.flip = function(flip) {
-  this.options.flip = (typeof flip === 'boolean') ? flip : true;
-  return this;
-};
-
-/*
-  Flop the image horizontally, about the X axis
-*/
-Sharp.prototype.flop = function(flop) {
-  this.options.flop = (typeof flop === 'boolean') ? flop : true;
-  return this;
-};
-
-/*
-  Do not enlarge the output if the input 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"
-*/
-Sharp.prototype.withoutEnlargement = function(withoutEnlargement) {
-  this.options.withoutEnlargement = (typeof withoutEnlargement === 'boolean') ? withoutEnlargement : true;
-  return this;
-};
-
-/*
-  Blur the output image.
-  Call without a sigma to use a fast, mild blur.
-  Call with a sigma to use a slower, more accurate Gaussian blur.
-*/
-Sharp.prototype.blur = function(sigma) {
-  if (typeof sigma === 'undefined') {
-    // No arguments: default to mild blur
-    this.options.blurSigma = -1;
-  } else if (typeof sigma === 'boolean') {
-    // Boolean argument: apply mild blur?
-    this.options.blurSigma = sigma ? -1 : 0;
-  } else if (typeof sigma === 'number' && !Number.isNaN(sigma) && sigma >= 0.3 && sigma <= 1000) {
-    // Numeric argument: specific sigma
-    this.options.blurSigma = sigma;
-  } else {
-    throw new Error('Invalid blur sigma (0.3 to 1000.0) ' + sigma);
-  }
-  return this;
-};
-
-/*
-  Sharpen the output image.
-  Call without a radius to use a fast, mild sharpen.
-  Call with a radius to use a slow, accurate sharpen using the L of LAB colour space.
-    radius - size of mask in pixels, must be integer
-    flat - level of "flat" area sharpen, default 1
-    jagged - level of "jagged" area sharpen, default 2
-*/
-Sharp.prototype.sharpen = function(radius, flat, jagged) {
-  if (typeof radius === 'undefined') {
-    // No arguments: default to mild sharpen
-    this.options.sharpenRadius = -1;
-  } else if (typeof radius === 'boolean') {
-    // Boolean argument: apply mild sharpen?
-    this.options.sharpenRadius = radius ? -1 : 0;
-  } else if (typeof radius === 'number' && !Number.isNaN(radius) && (radius % 1 === 0) && radius >= 1) {
-    // Numeric argument: specific radius
-    this.options.sharpenRadius = radius;
-    // Control over flat areas
-    if (typeof flat !== 'undefined' && flat !== null) {
-      if (typeof flat === 'number' && !Number.isNaN(flat) && flat >= 0) {
-        this.options.sharpenFlat = flat;
-      } else {
-        throw new Error('Invalid sharpen level for flat areas ' + flat + ' (expected >= 0)');
-      }
-    }
-    // Control over jagged areas
-    if (typeof jagged !== 'undefined' && jagged !== null) {
-      if (typeof jagged === 'number' && !Number.isNaN(jagged) && jagged >= 0) {
-        this.options.sharpenJagged = jagged;
-      } else {
-        throw new Error('Invalid sharpen level for jagged areas ' + jagged + ' (expected >= 0)');
-      }
-    }
-  } else {
-    throw new Error('Invalid sharpen radius ' + radius + ' (expected integer >= 1)');
-  }
-  return this;
-};
-
-Sharp.prototype.threshold = function(threshold) {
-  if (typeof threshold === 'undefined') {
-    this.options.threshold = 128;
-  } else if (typeof threshold === 'boolean') {
-    this.options.threshold = threshold ? 128 : 0;
-  } else if (typeof threshold === 'number' && !Number.isNaN(threshold) && (threshold % 1 === 0) && threshold >= 0 && threshold <= 255) {
-    this.options.threshold = threshold;
-  } else {
-    throw new Error('Invalid threshold (0 to 255) ' + threshold);
-  }
-  return this;
-};
-
-/*
-  Set the interpolator to use for the affine transformation
-*/
-module.exports.interpolator = {
-  nearest: 'nearest',
-  bilinear: 'bilinear',
-  bicubic: 'bicubic',
-  nohalo: 'nohalo',
-  locallyBoundedBicubic: 'lbb',
-  vertexSplitQuadraticBasisSpline: 'vsqbs'
-};
-Sharp.prototype.interpolateWith = function(interpolator) {
-  var isValid = false;
-  for (var key in module.exports.interpolator) {
-    if (module.exports.interpolator[key] === interpolator) {
-      isValid = true;
-      break;
-    }
-  }
-  if (isValid) {
-    this.options.interpolator = interpolator;
-  } else {
-    throw new Error('Invalid interpolator ' + interpolator);
-  }
-  return this;
-};
-
-/*
-  Darken image pre-resize (1/gamma) and brighten post-resize (gamma).
-  Improves brightness of resized image in non-linear colour spaces.
-*/
-Sharp.prototype.gamma = function(gamma) {
-  if (typeof gamma === 'undefined') {
-    // Default gamma correction of 2.2 (sRGB)
-    this.options.gamma = 2.2;
-  } else if (!Number.isNaN(gamma) && gamma >= 1 && gamma <= 3) {
-    this.options.gamma = gamma;
-  } else {
-    throw new Error('Invalid gamma correction (1.0 to 3.0) ' + gamma);
-  }
-  return this;
-};
-
-/*
-  Enhance output image contrast by stretching its luminance to cover the full dynamic range
-*/
-Sharp.prototype.normalize = function(normalize) {
-  this.options.normalize = (typeof normalize === 'boolean') ? normalize : true;
-  return this;
-};
-Sharp.prototype.normalise = Sharp.prototype.normalize;
-
-/*
-  Convert to greyscale
-*/
-Sharp.prototype.greyscale = function(greyscale) {
-  this.options.greyscale = (typeof greyscale === 'boolean') ? greyscale : true;
-  return this;
-};
-Sharp.prototype.grayscale = Sharp.prototype.greyscale;
-
-Sharp.prototype.progressive = function(progressive) {
-  this.options.progressive = (typeof progressive === 'boolean') ? progressive : true;
-  return this;
-};
-
-Sharp.prototype.sequentialRead = function(sequentialRead) {
-  this.options.sequentialRead = (typeof sequentialRead === 'boolean') ? sequentialRead : true;
-  return this;
-};
-
-Sharp.prototype.quality = function(quality) {
-  if (!Number.isNaN(quality) && quality >= 1 && quality <= 100 && quality % 1 === 0) {
-    this.options.quality = quality;
-  } else {
-    throw new Error('Invalid quality (1 to 100) ' + quality);
-  }
-  return this;
-};
-
-/*
-  zlib compression level for PNG output
-*/
-Sharp.prototype.compressionLevel = function(compressionLevel) {
-  if (!Number.isNaN(compressionLevel) && compressionLevel >= 0 && compressionLevel <= 9) {
-    this.options.compressionLevel = compressionLevel;
-  } else {
-    throw new Error('Invalid compressionLevel (0 to 9) ' + compressionLevel);
-  }
-  return this;
-};
-
-/*
-  Disable the use of adaptive row filtering for PNG output
-*/
-Sharp.prototype.withoutAdaptiveFiltering = function(withoutAdaptiveFiltering) {
-  this.options.withoutAdaptiveFiltering = (typeof withoutAdaptiveFiltering === 'boolean') ? withoutAdaptiveFiltering : true;
-  return this;
-};
-
-/*
-  Disable the use of chroma subsampling for JPEG output
-*/
-Sharp.prototype.withoutChromaSubsampling = function(withoutChromaSubsampling) {
-  this.options.withoutChromaSubsampling = (typeof withoutChromaSubsampling === 'boolean') ? withoutChromaSubsampling : true;
-  return this;
-};
-
-/*
-  Apply trellis quantisation to JPEG output - requires mozjpeg 3.0+
-*/
-Sharp.prototype.trellisQuantisation = function(trellisQuantisation) {
-  this.options.trellisQuantisation = (typeof trellisQuantisation === 'boolean') ? trellisQuantisation : true;
-  return this;
-};
-Sharp.prototype.trellisQuantization = Sharp.prototype.trellisQuantisation;
-
-/*
-  Apply overshoot deringing to JPEG output - requires mozjpeg 3.0+
-*/
-Sharp.prototype.overshootDeringing = function(overshootDeringing) {
-  this.options.overshootDeringing = (typeof overshootDeringing === 'boolean') ? overshootDeringing : true;
-  return this;
-};
-
-/*
-  Optimise scans in progressive JPEG output - requires mozjpeg 3.0+
-*/
-Sharp.prototype.optimiseScans = function(optimiseScans) {
-  this.options.optimiseScans = (typeof optimiseScans === 'boolean') ? optimiseScans : true;
-  if (this.options.optimiseScans) {
-    this.progressive();
-  }
-  return this;
-};
-Sharp.prototype.optimizeScans = Sharp.prototype.optimiseScans;
-
-/*
-  Include all metadata (EXIF, XMP, IPTC) from the input image in the output image
-  Optionally provide an Object with attributes to update:
-    orientation: numeric value for EXIF Orientation tag
-*/
-Sharp.prototype.withMetadata = function(withMetadata) {
-  this.options.withMetadata = (typeof withMetadata === 'boolean') ? withMetadata : true;
-  if (typeof withMetadata === 'object') {
-    if ('orientation' in withMetadata) {
-      if (
-        typeof withMetadata.orientation === 'number' &&
-        !Number.isNaN(withMetadata.orientation) &&
-        withMetadata.orientation % 1 === 0 &&
-        withMetadata.orientation >= 0 &&
-        withMetadata.orientation <= 7
-      ) {
-        this.options.withMetadataOrientation = withMetadata.orientation;
-      } else {
-        throw new Error('Invalid orientation (0 to 7) ' + withMetadata.orientation);
-      }
-    }
-  }
-  return this;
-};
-
-/*
-  Tile size and overlap for Deep Zoom output
-*/
-Sharp.prototype.tile = function(size, overlap) {
-  // Size of square tiles, in pixels
-  if (typeof size !== 'undefined' && size !== null) {
-    if (!Number.isNaN(size) && size % 1 === 0 && size >= 1 && size <= 8192) {
-      this.options.tileSize = size;
-    } else {
-      throw new Error('Invalid tile size (1 to 8192) ' + size);
-    }
-  }
-  // Overlap of tiles, in pixels
-  if (typeof overlap !== 'undefined' && overlap !== null) {
-    if (!Number.isNaN(overlap) && overlap % 1 === 0 && overlap >= 0 && overlap <= 8192) {
-      if (overlap > this.options.tileSize) {
-        throw new Error('Tile overlap ' + overlap + ' cannot be larger than tile size ' + this.options.tileSize);
-      }
-      this.options.tileOverlap = overlap;
-    } else {
-      throw new Error('Invalid tile overlap (0 to 8192) ' + overlap);
-    }
-  }
-  return this;
-};
-
-Sharp.prototype.resize = function(width, height) {
-  if (!width) {
-    this.options.width = -1;
-  } else {
-    if (typeof width === 'number' && !Number.isNaN(width) && width % 1 === 0 && width > 0 && width <= maximum.width) {
-      this.options.width = width;
-    } else {
-      throw new Error('Invalid width (1 to ' + maximum.width + ') ' + width);
-    }
-  }
-  if (!height) {
-    this.options.height = -1;
-  } else {
-    if (typeof height === 'number' && !Number.isNaN(height) && height % 1 === 0 && height > 0 && height <= maximum.height) {
-      this.options.height = height;
-    } else {
-      throw new Error('Invalid height (1 to ' + maximum.height + ') ' + height);
-    }
-  }
-  return this;
-};
-
-/*
-  Limit the total number of pixels for input images
-  Assumes the image dimensions contained in the file header can be trusted
-*/
-Sharp.prototype.limitInputPixels = function(limit) {
-  if (typeof limit === 'number' && !Number.isNaN(limit) && limit % 1 === 0 && limit > 0) {
-    this.options.limitInputPixels = limit;
-  } else {
-    throw new Error('Invalid pixel limit (1 to ' + maximum.pixels + ') ' + limit);
-  }
-  return this;
-};
-
-/*
-  Write output image data to a file
-*/
-Sharp.prototype.toFile = function(output, callback) {
-  if (!output || output.length === 0) {
-    var errOutputInvalid = new Error('Invalid output');
-    if (typeof callback === 'function') {
-      callback(errOutputInvalid);
-    } else {
-      return BluebirdPromise.reject(errOutputInvalid);
-    }
-  } else {
-    if (this.options.fileIn === output) {
-      var errOutputIsInput = new Error('Cannot use same file for input and output');
-      if (typeof callback === 'function') {
-        callback(errOutputIsInput);
-      } else {
-        return BluebirdPromise.reject(errOutputIsInput);
-      }
-    } else {
-      this.options.output = output;
-      return this._pipeline(callback);
-    }
-  }
-  return this;
-};
-
-/*
-  Write output to a Buffer
-*/
-Sharp.prototype.toBuffer = function(callback) {
-  return this._pipeline(callback);
-};
-
-/*
-  Force JPEG output
-*/
-Sharp.prototype.jpeg = function() {
-  this.options.output = '__jpeg';
-  return this;
-};
-
-/*
-  Force PNG output
-*/
-Sharp.prototype.png = function() {
-  this.options.output = '__png';
-  return this;
-};
-
-/*
-  Force WebP output
-*/
-Sharp.prototype.webp = function() {
-  this.options.output = '__webp';
-  return this;
-};
-
-/*
-  Force raw, uint8 output
-*/
-Sharp.prototype.raw = function() {
-  this.options.output = '__raw';
-  return this;
-};
-
-/*
-  Force output to a given format
-  @param format is either the id as a String or an Object with an 'id' attribute
-*/
-Sharp.prototype.toFormat = function(format) {
-  var id = format;
-  if (typeof format === 'object') {
-    id = format.id;
-  }
-  if (typeof id === 'string' && typeof module.exports.format[id] === 'object' && typeof this[id] === 'function') {
-    this[id]();
-  } else {
-    throw new Error('Unsupported format ' + format);
-  }
-  return this;
-};
-
-/*
-  Used by a Writable Stream to notify that it is ready for data
-*/
-Sharp.prototype._read = function() {
-  if (!this.options.streamOut) {
-    this.options.streamOut = true;
-    this._pipeline();
-  }
-};
-
-/*
-  Invoke the C++ image processing pipeline
-  Supports callback, stream and promise variants
-*/
-Sharp.prototype._pipeline = function(callback) {
-  var that = this;
-  if (typeof callback === 'function') {
-    // output=file/buffer
-    if (this.options.streamIn) {
-      // output=file/buffer, input=stream
-      this.on('finish', function() {
-        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.options.streamIn) {
-      // output=stream, input=stream
-      this.on('finish', function() {
-        sharp.pipeline(that.options, function(err, data) {
-          if (err) {
-            that.emit('error', err);
-          } else {
-            that.push(data);
-          }
-          that.push(null);
-        });
-      });
-    } else {
-      // output=stream, input=file/buffer
-      sharp.pipeline(this.options, function(err, data) {
-        if (err) {
-          that.emit('error', err);
-        } else {
-          that.push(data);
-        }
-        that.push(null);
-      });
-    }
-    return this;
-  } else {
-    // output=promise
-    if (this.options.streamIn) {
-      // output=promise, input=stream
-      return new BluebirdPromise(function(resolve, reject) {
-        that.on('finish', function() {
-          sharp.pipeline(that.options, function(err, data) {
-            if (err) {
-              reject(err);
-            } else {
-              resolve(data);
-            }
-          });
-        });
-      });
-    } else {
-      // output=promise, input=file/buffer
-      return new BluebirdPromise(function(resolve, reject) {
-        sharp.pipeline(that.options, function(err, data) {
-          if (err) {
-            reject(err);
-          } else {
-            resolve(data);
-          }
-        });
-      });
-    }
-  }
-};
-
-/*
-  Reads the image header and returns metadata
-  Supports callback, stream and promise variants
-*/
-Sharp.prototype.metadata = function(callback) {
-  var that = this;
-  if (typeof callback === 'function') {
-    if (this.options.streamIn) {
-      this.on('finish', function() {
-        sharp.metadata(that.options, callback);
-      });
-    } else {
-      sharp.metadata(this.options, callback);
-    }
-    return this;
-  } else {
-    if (this.options.streamIn) {
-      return new BluebirdPromise(function(resolve, reject) {
-        that.on('finish', function() {
-          sharp.metadata(that.options, function(err, metadata) {
-            if (err) {
-              reject(err);
-            } else {
-              resolve(metadata);
-            }
-          });
-        });
-      });
-    } else {
-      return new BluebirdPromise(function(resolve, reject) {
-        sharp.metadata(that.options, function(err, metadata) {
-          if (err) {
-            reject(err);
-          } else {
-            resolve(metadata);
-          }
-        });
-      });
-    }
-  }
-};
-
-/*
-  Clone new instance using existing options.
-  Cloned instances share the same input.
-*/
-Sharp.prototype.clone = function() {
-  // Clone existing options
-  var clone = new Sharp();
-  util._extend(clone.options, this.options);
-  clone.streamIn = false;
-  // Pass 'finish' event to clone for Stream-based input
-  this.on('finish', function() {
-    // Clone inherits input data
-    clone.options.bufferIn = this.options.bufferIn;
-    clone.emit('finish');
-  });
-  return clone;
-};
-
-/*
-  Get and set cache memory and item limits
-*/
-module.exports.cache = function(memory, items) {
-  if (typeof memory !== 'number' || Number.isNaN(memory)) {
-    memory = null;
-  }
-  if (typeof items !== 'number' || Number.isNaN(items)) {
-    items = null;
-  }
-  return sharp.cache(memory, items);
-};
-
-/*
-  Get and set size of thread pool
-*/
-module.exports.concurrency = function(concurrency) {
-  if (typeof concurrency !== 'number' || Number.isNaN(concurrency)) {
-    concurrency = null;
-  }
-  return sharp.concurrency(concurrency);
-};
-
-/*
-  Get internal counters
-*/
-module.exports.counters = function() {
-  return sharp.counters();
-};

install/dll-copy.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+const copyFileSync = require('fs-copy-file-sync');
+const npmLog = require('npmlog');
+
+if (process.platform === 'win32') {
+  const buildDir = path.join(__dirname, '..', 'build');
+  const buildReleaseDir = path.join(buildDir, 'Release');
+  npmLog.info('sharp', `Creating ${buildReleaseDir}`);
+  try {
+    fs.mkdirSync(buildDir);
+    fs.mkdirSync(buildReleaseDir);
+  } catch (err) {}
+  const vendorLibDir = path.join(__dirname, '..', 'vendor', 'lib');
+  npmLog.info('sharp', `Copying DLLs from ${vendorLibDir} to ${buildReleaseDir}`);
+  try {
+    fs
+      .readdirSync(vendorLibDir)
+      .filter(function (filename) {
+        return /\.dll$/.test(filename);
+      })
+      .forEach(function (filename) {
+        copyFileSync(
+          path.join(vendorLibDir, filename),
+          path.join(buildReleaseDir, filename)
+        );
+      });
+  } catch (err) {
+    npmLog.error('sharp', err.message);
+  }
+}

install/libvips.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const detectLibc = require('detect-libc');
+const npmLog = require('npmlog');
+const semver = require('semver');
+const simpleGet = require('simple-get');
+const tar = require('tar');
+const copyFileSync = require('fs-copy-file-sync');
+
+const agent = require('../lib/agent');
+const libvips = require('../lib/libvips');
+const platform = require('../lib/platform');
+
+const minimumLibvipsVersion = libvips.minimumLibvipsVersion;
+const distBaseUrl = process.env.SHARP_DIST_BASE_URL || `https://github.com/lovell/sharp-libvips/releases/download/v${minimumLibvipsVersion}/`;
+
+const extractTarball = function (tarPath) {
+  const vendorPath = path.join(__dirname, '..', 'vendor');
+  if (!fs.existsSync(vendorPath)) {
+    fs.mkdirSync(vendorPath);
+  }
+  tar
+    .extract({
+      file: tarPath,
+      cwd: vendorPath,
+      strict: true
+    })
+    .catch(function (err) {
+      throw err;
+    });
+};
+
+try {
+  const useGlobalLibvips = libvips.useGlobalLibvips();
+  if (useGlobalLibvips) {
+    const globalLibvipsVersion = libvips.globalLibvipsVersion();
+    npmLog.info('sharp', `Detected globally-installed libvips v${globalLibvipsVersion}`);
+    npmLog.info('sharp', 'Building from source via node-gyp');
+    process.exit(1);
+  } else if (libvips.hasVendoredLibvips()) {
+    npmLog.info('sharp', `Using existing vendored libvips v${minimumLibvipsVersion}`);
+  } else {
+    // Is this arch/platform supported?
+    const arch = process.env.npm_config_arch || process.arch;
+    const platformAndArch = platform();
+    if (platformAndArch === 'win32-ia32') {
+      throw new Error('Windows x86 (32-bit) node.exe is not supported');
+    }
+    if (arch === 'ia32') {
+      throw new Error(`Intel Architecture 32-bit systems require manual installation of libvips >= ${minimumLibvipsVersion}`);
+    }
+    if (platformAndArch === 'freebsd-x64') {
+      throw new Error(`FreeBSD systems require manual installation of libvips >= ${minimumLibvipsVersion}`);
+    }
+    if (detectLibc.isNonGlibcLinux) {
+      throw new Error(`Use with ${detectLibc.family} libc requires manual installation of libvips >= ${minimumLibvipsVersion}`);
+    }
+    if (detectLibc.family === detectLibc.GLIBC && detectLibc.version && semver.lt(`${detectLibc.version}.0`, '2.13.0')) {
+      throw new Error(`Use with glibc version ${detectLibc.version} requires manual installation of libvips >= ${minimumLibvipsVersion}`);
+    }
+    // Download to per-process temporary file
+    const tarFilename = ['libvips', minimumLibvipsVersion, platformAndArch].join('-') + '.tar.gz';
+    const tarPathCache = path.join(libvips.cachePath(), tarFilename);
+    if (fs.existsSync(tarPathCache)) {
+      npmLog.info('sharp', `Using cached ${tarPathCache}`);
+      extractTarball(tarPathCache);
+    } else {
+      const tarPathTemp = path.join(os.tmpdir(), `${process.pid}-${tarFilename}`);
+      const tmpFile = fs.createWriteStream(tarPathTemp);
+      const url = distBaseUrl + tarFilename;
+      npmLog.info('sharp', `Downloading ${url}`);
+      simpleGet({ url: url, agent: agent() }, function (err, response) {
+        if (err) {
+          throw err;
+        }
+        if (response.statusCode !== 200) {
+          throw new Error(`Status ${response.statusCode}`);
+        }
+        response.pipe(tmpFile);
+      });
+      tmpFile.on('close', function () {
+        try {
+          // Attempt to rename
+          fs.renameSync(tarPathTemp, tarPathCache);
+        } catch (err) {
+          // Fall back to copy and unlink
+          copyFileSync(tarPathTemp, tarPathCache);
+          fs.unlinkSync(tarPathTemp);
+        }
+        extractTarball(tarPathCache);
+      });
+    }
+  }
+} catch (err) {
+  npmLog.error('sharp', err.message);
+  npmLog.error('sharp', 'Please see http://sharp.pixelplumbing.com/page/install');
+  process.exit(1);
+}

lib/agent.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const url = require('url');
+const tunnelAgent = require('tunnel-agent');
+
+const is = require('./is');
+
+const proxies = [
+  'HTTPS_PROXY',
+  'https_proxy',
+  'HTTP_PROXY',
+  'http_proxy',
+  'npm_config_https_proxy',
+  'npm_config_proxy'
+];
+
+function env (key) {
+  return process.env[key];
+}
+
+module.exports = function () {
+  try {
+    const proxy = url.parse(proxies.map(env).find(is.string));
+    const tunnel = proxy.protocol === 'https:'
+      ? tunnelAgent.httpsOverHttps
+      : tunnelAgent.httpsOverHttp;
+    return tunnel({
+      proxy: {
+        port: Number(proxy.port),
+        host: proxy.hostname,
+        proxyAuth: proxy.auth
+      }
+    });
+  } catch (err) {
+    return null;
+  }
+};

lib/channel.js

@@ -0,0 +1,131 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Boolean operations for bandbool.
+ * @private
+ */
+const bool = {
+  and: 'and',
+  or: 'or',
+  eor: 'eor'
+};
+
+/**
+ * Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
+ *
+ * @example
+ * sharp('rgba.png')
+ *   .removeAlpha()
+ *   .toFile('rgb.png', function(err, info) {
+ *     // rgb.png is a 3 channel image without an alpha channel
+ *   });
+ *
+ * @returns {Sharp}
+ */
+function removeAlpha () {
+  this.options.removeAlpha = true;
+  return this;
+}
+
+/**
+ * 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
+  [
+    removeAlpha,
+    extractChannel,
+    joinChannel,
+    bandbool
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+  // Class attributes
+  Sharp.bool = bool;
+};

lib/colour.js

@@ -0,0 +1,124 @@
+'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;
+}
+
+/**
+ * Tint the image using the provided chroma while preserving the image luminance.
+ * An alpha channel may be present and will be unchanged by the operation.
+ *
+ * @param {String|Object} rgb - parsed by the [color](https://www.npmjs.org/package/color) module to extract chroma values.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameter
+ */
+function tint (rgb) {
+  const colour = color(rgb);
+  this.options.tintA = colour.a();
+  this.options.tintB = colour.b();
+  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,
+    tint,
+    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,96 @@
+'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`.
+ *
+ * If the overlay image contains an alpha channel then composition with premultiplication will occur.
+ *
+ * @example
+ * sharp('input.png')
+ *   .rotate(180)
+ *   .resize(300)
+ *   .flatten()
+ *   .background('#ff6600')
+ *   .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
+ *   .sharpen()
+ *   .withMetadata()
+ *   .webp( { quality: 90 } )
+ *   .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) && options.left >= 0 && is.integer(options.top) && options.top >= 0) {
+        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,260 @@
+'use strict';
+
+const path = require('path');
+const util = require('util');
+const stream = require('stream');
+const events = require('events');
+const semver = require('semver');
+const is = require('./is');
+const platform = require('./platform');
+const sharp = require('../build/Release/sharp.node');
+
+// Vendor platform
+(function () {
+  let vendorPlatformId;
+  try {
+    vendorPlatformId = require('../vendor/platform.json');
+  } catch (err) {
+    return;
+  }
+  const currentPlatformId = platform();
+  /* istanbul ignore if */
+  if (currentPlatformId !== vendorPlatformId) {
+    throw new Error(`'${vendorPlatformId}' binaries cannot be used on the '${currentPlatformId}' platform. Please remove the 'node_modules/sharp/vendor' directory and run 'npm rebuild'.`);
+  }
+})();
+
+// 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/versions.json');
+  } catch (err) {}
+})();
+
+// Use NODE_DEBUG=sharp to enable libvips warnings
+const debuglog = util.debuglog('sharp');
+
+/**
+ * @class Sharp
+ *
+ * Constructor factory to create an instance of `sharp`, to which further methods are chained.
+ *
+ * JPEG, PNG, WebP or TIFF 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({
+ *   create: {
+ *     width: 300,
+ *     height: 200,
+ *     channels: 4,
+ *     background: { r: 255, g: 0, b: 0, alpha: 0.5 }
+ *   }
+ * })
+ * .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 not present.
+ * @param {Object} [options] - if present, is an Object with optional attributes.
+ * @param {Boolean} [options.failOnError=false] - by default apply a "best effort"
+ *  to decode images, even if the data is corrupt or invalid. Set this flag to true
+ *  if you'd rather halt processing and raise an error when loading invalid images.
+ * @param {Number} [options.density=72] - integral number representing the DPI for vector images.
+ * @param {Number} [options.page=0] - page number to extract for multi-page input (GIF, TIFF)
+ * @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 (arguments.length === 1 && !is.defined(input)) {
+    throw new Error('Invalid input');
+  }
+  if (!(this instanceof Sharp)) {
+    return new Sharp(input, options);
+  }
+  stream.Duplex.call(this);
+  this.options = {
+    // input options
+    sequentialRead: false,
+    limitInputPixels: Math.pow(0x3FFF, 2),
+    // 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,
+    embed: 0,
+    useExifOrientation: false,
+    angle: 0,
+    rotateBeforePreExtract: false,
+    flip: false,
+    flop: false,
+    extendTop: 0,
+    extendBottom: 0,
+    extendLeft: 0,
+    extendRight: 0,
+    withoutEnlargement: false,
+    kernel: 'lanczos3',
+    fastShrinkOnLoad: true,
+    // operations
+    background: [0, 0, 0, 255],
+    tintA: 128,
+    tintB: 128,
+    flatten: false,
+    negate: false,
+    medianSize: 0,
+    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,
+    removeAlpha: false,
+    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,
+    jpegOptimiseCoding: true,
+    jpegQuantisationTable: 0,
+    pngProgressive: false,
+    pngCompressionLevel: 9,
+    pngAdaptiveFiltering: false,
+    webpQuality: 80,
+    webpAlphaQuality: 100,
+    webpLossless: false,
+    webpNearLossless: false,
+    tiffQuality: 80,
+    tiffCompression: 'jpeg',
+    tiffPredictor: 'horizontal',
+    tiffSquash: false,
+    tiffXres: 1.0,
+    tiffYres: 1.0,
+    tileSize: 256,
+    tileOverlap: 0,
+    linearA: 1,
+    linearB: 0,
+    // Function to notify of libvips warnings
+    debuglog: debuglog,
+    // 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);
+
+/**
+ * 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,13 @@
+'use strict';
+
+const Sharp = require('./constructor');
+require('./input')(Sharp);
+require('./resize')(Sharp);
+require('./composite')(Sharp);
+require('./operation')(Sharp);
+require('./colour')(Sharp);
+require('./channel')(Sharp);
+require('./output')(Sharp);
+require('./utility')(Sharp);
+
+module.exports = Sharp;

lib/input.js

@@ -0,0 +1,377 @@
+'use strict';
+
+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 = { failOnError: false };
+  if (is.string(input)) {
+    // filesystem
+    inputDescriptor.file = input;
+  } else if (is.buffer(input)) {
+    // Buffer
+    inputDescriptor.buffer = input;
+  } else if (is.plainObject(input) && !is.defined(inputOptions)) {
+    // Plain Object descriptor, e.g. create
+    inputOptions = 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)) {
+    // Fail on error
+    if (is.defined(inputOptions.failOnError)) {
+      if (is.bool(inputOptions.failOnError)) {
+        inputDescriptor.failOnError = inputOptions.failOnError;
+      } else {
+        throw new Error('Invalid failOnError (boolean) ' + inputOptions.failOnError);
+      }
+    }
+    // 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) && inputOptions.raw.width > 0 &&
+        is.integer(inputOptions.raw.height) && inputOptions.raw.height > 0 &&
+        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');
+      }
+    }
+    // Page input for multi-page TIFF
+    if (is.defined(inputOptions.page)) {
+      if (is.integer(inputOptions.page) && is.inRange(inputOptions.page, 0, 100000)) {
+        inputDescriptor.page = inputOptions.page;
+      }
+    }
+    // Create new image
+    if (is.defined(inputOptions.create)) {
+      if (
+        is.object(inputOptions.create) &&
+        is.integer(inputOptions.create.width) && inputOptions.create.width > 0 &&
+        is.integer(inputOptions.create.height) && inputOptions.create.height > 0 &&
+        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();
+  clone.options = Object.assign({}, this.options);
+  // Pass 'finish' event to clone for Stream-based input
+  if (this._isStreamInput()) {
+    this.on('finish', function () {
+      // Clone inherits input data
+      that._flattenBufferIn();
+      clone.options.bufferIn = that.options.bufferIn;
+      clone.emit('finish');
+    });
+  }
+  return clone;
+}
+
+/**
+ * Fast access to (uncached) 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 (EXIF orientation is not taken into consideration)
+ * - `height`: Number of pixels high (EXIF orientation is not taken into consideration)
+ * - `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#L636)
+ * - `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
+ * - `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672)
+ * - `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
+ * - `iptc`: Buffer containing raw IPTC data, if present
+ * - `xmp`: Buffer containing raw XMP 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);
+          }
+        });
+      });
+    }
+  }
+}
+
+/**
+ * Access to pixel-derived image statistics for every channel in the image.
+ * A Promise is returned when `callback` is not provided.
+ *
+ * - `channels`: Array of channel statistics for each channel in the image. Each channel statistic contains
+ *     - `min` (minimum value in the channel)
+ *     - `max` (maximum value in the channel)
+ *     - `sum` (sum of all values in a channel)
+ *     - `squaresSum` (sum of squared values in a channel)
+ *     - `mean` (mean of the values in a channel)
+ *     - `stdev` (standard deviation for the values in a channel)
+ *     - `minX` (x-coordinate of one of the pixel where the minimum lies)
+ *     - `minY` (y-coordinate of one of the pixel where the minimum lies)
+ *     - `maxX` (x-coordinate of one of the pixel where the maximum lies)
+ *     - `maxY` (y-coordinate of one of the pixel where the maximum lies)
+ * - `isOpaque`: Value to identify if the image is opaque or transparent, based on the presence and use of alpha channel
+ * - `entropy`: Histogram-based estimation of greyscale entropy, discarding alpha channel if any (experimental)
+ *
+ * @example
+ * const image = sharp(inputJpg);
+ * image
+ *   .stats()
+ *   .then(function(stats) {
+ *      // stats contains the channel-wise statistics array and the isOpaque value
+ *   });
+ *
+ * @param {Function} [callback] - called with the arguments `(err, stats)`
+ * @returns {Promise<Object>}
+ */
+function stats (callback) {
+  const that = this;
+  if (is.fn(callback)) {
+    if (this._isStreamInput()) {
+      this.on('finish', function () {
+        that._flattenBufferIn();
+        sharp.stats(that.options, callback);
+      });
+    } else {
+      sharp.stats(this.options, callback);
+    }
+    return this;
+  } else {
+    if (this._isStreamInput()) {
+      return new Promise(function (resolve, reject) {
+        that.on('finish', function () {
+          that._flattenBufferIn();
+          sharp.stats(that.options, function (err, stats) {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(stats);
+            }
+          });
+        });
+      });
+    } else {
+      return new Promise(function (resolve, reject) {
+        sharp.stats(that.options, function (err, stats) {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(stats);
+          }
+        });
+      });
+    }
+  }
+}
+
+/**
+ * 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 = Math.pow(0x3FFF, 2);
+  }
+  if (is.integer(limit) && limit >= 0) {
+    this.options.limitInputPixels = limit;
+  } else {
+    throw is.invalidParameterError('limitInputPixels', 'integer', 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.
+ *
+ * The default behaviour *before* function call is `false`, meaning the libvips access method is not sequential.
+ *
+ * @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,
+    stats,
+    limitInputPixels,
+    sequentialRead
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+};

lib/is.js

@@ -0,0 +1,119 @@
+'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 plain object?
+ * @private
+ */
+const plainObject = function (val) {
+  return object(val) && Object.prototype.toString.call(val) === '[object 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,
+  plainObject: plainObject,
+  fn: fn,
+  bool: bool,
+  buffer: buffer,
+  string: string,
+  number: number,
+  integer: integer,
+  inRange: inRange,
+  inArray: inArray,
+  invalidParameterError: invalidParameterError
+};

lib/libvips.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const spawnSync = require('child_process').spawnSync;
+const semver = require('semver');
+const platform = require('./platform');
+
+const env = process.env;
+const minimumLibvipsVersion = env.npm_package_config_libvips || require('../package.json').config.libvips;
+
+const spawnSyncOptions = {
+  encoding: 'utf8',
+  shell: true
+};
+
+const cachePath = function () {
+  const npmCachePath = env.npm_config_cache || (env.APPDATA ? path.join(env.APPDATA, 'npm-cache') : path.join(os.homedir(), '.npm'));
+  if (!fs.existsSync(npmCachePath)) {
+    fs.mkdirSync(npmCachePath);
+  }
+  const libvipsCachePath = path.join(npmCachePath, '_libvips');
+  if (!fs.existsSync(libvipsCachePath)) {
+    fs.mkdirSync(libvipsCachePath);
+  }
+  return libvipsCachePath;
+};
+
+const globalLibvipsVersion = function () {
+  if (process.platform !== 'win32') {
+    const globalLibvipsVersion = spawnSync(`PKG_CONFIG_PATH="${pkgConfigPath()}" pkg-config --modversion vips-cpp`, spawnSyncOptions).stdout || '';
+    return globalLibvipsVersion.trim();
+  } else {
+    return '';
+  }
+};
+
+const hasVendoredLibvips = function () {
+  const currentPlatformId = platform();
+  let vendorPlatformId;
+  try {
+    vendorPlatformId = require(path.join(__dirname, '..', 'vendor', 'platform.json'));
+  } catch (err) {}
+  if (vendorPlatformId) {
+    if (currentPlatformId === vendorPlatformId) {
+      return true;
+    } else {
+      throw new Error(`'${vendorPlatformId}' binaries cannot be used on the '${currentPlatformId}' platform. Please remove the 'node_modules/sharp/vendor' directory and run 'npm install'.`);
+    }
+  }
+  return false;
+};
+
+const pkgConfigPath = function () {
+  if (process.platform !== 'win32') {
+    const brewPkgConfigPath = spawnSync('which brew >/dev/null 2>&1 && eval $(brew --env) && echo $PKG_CONFIG_LIBDIR', spawnSyncOptions).stdout || '';
+    return [brewPkgConfigPath.trim(), env.PKG_CONFIG_PATH, '/usr/local/lib/pkgconfig', '/usr/lib/pkgconfig']
+      .filter(function (p) { return !!p; })
+      .join(':');
+  } else {
+    return '';
+  }
+};
+
+const useGlobalLibvips = function () {
+  if (Boolean(env.SHARP_IGNORE_GLOBAL_LIBVIPS) === true) {
+    return false;
+  }
+
+  const globalVipsVersion = globalLibvipsVersion();
+  return !!globalVipsVersion && semver.gte(globalVipsVersion, minimumLibvipsVersion);
+};
+
+module.exports = {
+  minimumLibvipsVersion: minimumLibvipsVersion,
+  cachePath: cachePath,
+  globalLibvipsVersion: globalLibvipsVersion,
+  hasVendoredLibvips: hasVendoredLibvips,
+  pkgConfigPath: pkgConfigPath,
+  useGlobalLibvips: useGlobalLibvips
+};

lib/operation.js

@@ -0,0 +1,483 @@
+'use strict';
+
+const is = require('./is');
+
+/**
+ * Rotate the output image by either an explicit angle
+ * or auto-orient based on the EXIF `Orientation` tag.
+ *
+ * If an angle is provided, it is converted to a valid 90/180/270deg rotation.
+ * For example, `-450` will produce a 270deg rotation.
+ *
+ * If no angle is provided, it is determined from the 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] angle of rotation, must be a multiple of 90.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function rotate (angle) {
+  if (!is.defined(angle)) {
+    this.options.useExifOrientation = true;
+  } else if (is.integer(angle) && !(angle % 90)) {
+    this.options.angle = angle;
+  } else {
+    throw new Error('Unsupported angle: angle must be a positive/negative multiple of 90 ' + 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 % 360) !== 0 || this.options.useExifOrientation === true)) {
+    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;
+}
+
+/**
+ * Apply median filter.
+ * When used without parameters the default window is 3x3.
+ * @param {Number} [size=3] square mask size: size x size
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function median (size) {
+  if (!is.defined(size)) {
+    // No arguments: default to 3x3
+    this.options.medianSize = 3;
+  } else if (is.integer(size) && is.inRange(size, 1, 1000)) {
+    // Numeric argument: specific sigma
+    this.options.medianSize = size;
+  } else {
+    throw new Error('Invalid median size ' + size);
+  }
+  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;
+}
+
+/**
+ * Apply the linear formula a * input + b to the image (levels adjustment)
+ * @param {Number} [a=1.0] multiplier
+ * @param {Number} [b=0.0] offset
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function linear (a, b) {
+  if (!is.defined(a)) {
+    this.options.linearA = 1.0;
+  } else if (is.number(a)) {
+    this.options.linearA = a;
+  } else {
+    throw new Error('Invalid linear transform multiplier ' + a);
+  }
+
+  if (!is.defined(b)) {
+    this.options.linearB = 0.0;
+  } else if (is.number(b)) {
+    this.options.linearB = b;
+  } else {
+    throw new Error('Invalid linear transform offset ' + b);
+  }
+
+  return this;
+}
+
+/**
+ * Decorate the Sharp prototype with operation-related functions.
+ * @private
+ */
+module.exports = function (Sharp) {
+  [
+    rotate,
+    extract,
+    flip,
+    flop,
+    sharpen,
+    median,
+    blur,
+    extend,
+    flatten,
+    trim,
+    gamma,
+    negate,
+    normalise,
+    normalize,
+    convolve,
+    threshold,
+    boolean,
+    linear
+  ].forEach(function (f) {
+    Sharp.prototype[f.name] = f;
+  });
+};

lib/output.js

@@ -0,0 +1,664 @@
+'use strict';
+
+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 `Promise` is returned when `callback` is not provided.
+ *
+ * @example
+ * sharp(input)
+ *   .toFile('output.png', (err, info) => { ... });
+ *
+ * @example
+ * sharp(input)
+ *   .toFile('output.png')
+ *   .then(info => { ... })
+ *   .catch(err => { ... });
+ *
+ * @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`,
+ * `channels` and `premultiplied` (indicating if premultiplication was used).
+ * When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
+ * @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, TIFF 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`,
+ * `channels` and `premultiplied` (indicating if premultiplication was used).
+ * When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
+ *
+ * A `Promise` is returned when `callback` is not provided.
+ *
+ * @example
+ * sharp(input)
+ *   .toBuffer((err, data, info) => { ... });
+ *
+ * @example
+ * sharp(input)
+ *   .toBuffer()
+ *   .then(data => { ... })
+ *   .catch(err => { ... });
+ *
+ * @example
+ * sharp(input)
+ *   .toBuffer({ resolveWithObject: true })
+ *   .then(({ data, info }) => { ... })
+ *   .catch(err => { ... });
+ *
+ * @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.
+ *
+ * @example
+ * sharp('input.jpg')
+ *   .withMetadata()
+ *   .toFile('output-with-metadata.jpg')
+ *   .then(info => { ... });
+ *
+ * @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.
+ *
+ * @example
+ * // Convert any input to very high quality JPEG output
+ * const data = await sharp(input)
+ *   .jpeg({
+ *     quality: 100,
+ *     chromaSubsampling: '4:4:4'
+ *   })
+ *   .toBuffer();
+ *
+ * @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.optimiseCoding=true] - optimise Huffman coding tables
+ * @param {Boolean} [options.optimizeCoding=true] - alternative spelling of optimiseCoding
+ * @param {Number} [options.quantisationTable=0] - quantization table to use, integer 0-8, requires mozjpeg
+ * @param {Number} [options.quantizationTable=0] - alternative spelling of quantisationTable
+ * @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;
+      }
+    }
+    options.optimiseCoding = is.bool(options.optimizeCoding) ? options.optimizeCoding : options.optimiseCoding;
+    if (is.defined(options.optimiseCoding)) {
+      this._setBooleanOption('jpegOptimiseCoding', options.optimiseCoding);
+    }
+    options.quantisationTable = is.number(options.quantizationTable) ? options.quantizationTable : options.quantisationTable;
+    if (is.defined(options.quantisationTable)) {
+      if (is.integer(options.quantisationTable) && is.inRange(options.quantisationTable, 0, 8)) {
+        this.options.jpegQuantisationTable = options.quantisationTable;
+      } else {
+        throw new Error('Invalid quantisation table (integer, 0-8) ' + options.quantisationTable);
+      }
+    }
+  }
+  return this._updateFormatOut('jpeg', options);
+}
+
+/**
+ * Use these PNG options for output image.
+ *
+ * PNG output is always full colour at 8 or 16 bits per pixel.
+ * Indexed PNG input at 1, 2 or 4 bits per pixel is converted to 8 bits per pixel.
+ *
+ * @example
+ * // Convert any input to PNG output
+ * const data = await sharp(input)
+ *   .png()
+ *   .toBuffer();
+ *
+ * @param {Object} [options]
+ * @param {Boolean} [options.progressive=false] - use progressive (interlace) scan
+ * @param {Number} [options.compressionLevel=9] - zlib compression level, 0-9
+ * @param {Boolean} [options.adaptiveFiltering=false] - 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.
+ *
+ * @example
+ * // Convert any input to lossless WebP output
+ * const data = await sharp(input)
+ *   .webp({ lossless: true })
+ *   .toBuffer();
+ *
+ * @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, 0, 100)) {
+      this.options.webpAlphaQuality = options.alphaQuality;
+    } else {
+      throw new Error('Invalid webp alpha quality (integer, 0-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.
+ *
+ * @example
+ * // Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output
+ * sharp('input.svg')
+ *   .tiff({
+ *     compression: 'lzw',
+ *     squash: true
+ *   })
+ *   .toFile('1-bpp-output.tiff')
+ *   .then(info => { ... });
+ *
+ * @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, ccittfax4
+ * @param {Boolean} [options.predictor='horizontal'] - compression predictor options: none, horizontal, float
+ * @param {Number} [options.xres=1.0] - horizontal resolution in pixels/mm
+ * @param {Number} [options.yres=1.0] - vertical resolution in pixels/mm
+ * @param {Boolean} [options.squash=false] - squash 8-bit images down to 1 bit
+ * @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);
+    }
+  }
+  if (is.object(options) && is.defined(options.squash)) {
+    if (is.bool(options.squash)) {
+      this.options.tiffSquash = options.squash;
+    } else {
+      throw new Error('Invalid Value for squash ' + options.squash + ' Only Boolean Values allowed for options.squash.');
+    }
+  }
+  // resolution
+  if (is.object(options) && is.defined(options.xres)) {
+    if (is.number(options.xres)) {
+      this.options.tiffXres = options.xres;
+    } else {
+      throw new Error('Invalid Value for xres ' + options.xres + ' Only numeric values allowed for options.xres');
+    }
+  }
+  if (is.object(options) && is.defined(options.yres)) {
+    if (is.number(options.yres)) {
+      this.options.tiffYres = options.yres;
+    } else {
+      throw new Error('Invalid Value for yres ' + options.yres + ' Only numeric values allowed for options.yres');
+    }
+  }
+  // compression
+  if (is.defined(options) && is.defined(options.compression)) {
+    if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'ccittfax4', 'none'])) {
+      this.options.tiffCompression = options.compression;
+    } else {
+      const message = `Invalid compression option "${options.compression}". Should be one of: lzw, deflate, jpeg, ccittfax4, 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.
+ *
+ * @example
+ * // Extract raw RGB pixel data from JPEG input
+ * const { data, info } = await sharp('input.jpg')
+ *   .raw()
+ *   .toBuffer({ resolveWithObject: true });
+ *
+ * @returns {Sharp}
+ */
+function raw () {
+  return this._updateFormatOut('raw');
+}
+
+/**
+ * Force output to a given format.
+ *
+ * @example
+ * // Convert any input to PNG output
+ * const data = await sharp(input)
+ *   .toFormat('png')
+ *   .toBuffer();
+ *
+ * @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 (format === 'jpg') format = 'jpeg';
+  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.
+ *
+ * Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
+ *
+ * @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 {Number} [tile.angle=0] tile angle of rotation, must be a multiple of 90.
+ * @param {String} [tile.depth] how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
+ * @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);
+      }
+    }
+
+    // Angle of rotation,
+    if (is.defined(tile.angle)) {
+      if (is.integer(tile.angle) && !(tile.angle % 90)) {
+        this.options.tileAngle = tile.angle;
+      } else {
+        throw new Error('Unsupported angle: angle must be a positive/negative multiple of 90 ' + tile.angle);
+      }
+    }
+
+    // Depth of tiles
+    if (is.defined(tile.depth)) {
+      if (is.string(tile.depth) && is.inArray(tile.depth, ['onepixel', 'onetile', 'one'])) {
+        this.options.tileDepth = tile.depth;
+      } else {
+        throw new Error("Invalid tile depth '" + tile.depth + "', should be one of 'onepixel', 'onetile' or 'one'");
+      }
+    }
+  }
+  // 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);
+            }
+          }
+        });
+      });
+    }
+  }
+}
+
+/**
+ * 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;
+  });
+};

lib/platform.js

@@ -0,0 +1,15 @@
+'use strict';
+
+module.exports = function () {
+  const arch = process.env.npm_config_arch || process.arch;
+  const platform = process.env.npm_config_platform || process.platform;
+
+  const platformId = [platform];
+  if (arch === 'arm' || arch === 'armhf' || arch === 'arm64') {
+    const armVersion = (arch === 'arm64') ? '8' : process.env.npm_config_armv || process.config.variables.arm_version || '6';
+    platformId.push(`armv${armVersion}`);
+  } else {
+    platformId.push(arch);
+  }
+  return platformId.join('-');
+};

lib/resize.js

@@ -0,0 +1,288 @@
+'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'
+};
+
+/**
+ * Resize image to `width` x `height`.
+ * By default, the resized image is centre cropped to the exact size specified.
+ *
+ * Possible 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).
+ *
+ * @example
+ * sharp(inputBuffer)
+ *   .resize(200, 300, {
+ *     kernel: sharp.kernel.nearest
+ *   })
+ *   .background('white')
+ *   .embed()
+ *   .toFile('output.tiff')
+ *   .then(function() {
+ *     // output.tiff is a 200 pixels wide and 300 pixels high image
+ *     // containing a nearest-neighbour scaled version, embedded on a white canvas,
+ *     // of the image data in inputBuffer
+ *   });
+ *
+ * @param {Number} [width] - pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
+ * @param {Number} [height] - pixels high the resultant image should be. 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 {Boolean} [options.fastShrinkOnLoad=true] - take greater advantage of the JPEG and WebP shrink-on-load feature, which can lead to a slight moiré pattern on some images.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function resize (width, height, options) {
+  if (is.defined(width)) {
+    if (is.integer(width) && width > 0) {
+      this.options.width = width;
+    } else {
+      throw is.invalidParameterError('width', 'positive integer', width);
+    }
+  } else {
+    this.options.width = -1;
+  }
+  if (is.defined(height)) {
+    if (is.integer(height) && height > 0) {
+      this.options.height = height;
+    } else {
+      throw is.invalidParameterError('height', 'positive integer', 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);
+      }
+    }
+    // Shrink on load
+    if (is.defined(options.fastShrinkOnLoad)) {
+      this._setBooleanOption('fastShrinkOnLoad', options.fastShrinkOnLoad);
+    }
+  }
+  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
+ *   });
+ * @param {String} [embed='centre'] - A member of `sharp.gravity` to embed to an edge/corner.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function embed (embed) {
+  this.options.canvas = 'embed';
+
+  if (!is.defined(embed)) {
+    // Default
+    this.options.embed = gravity.center;
+  } else if (is.integer(embed) && is.inRange(embed, 0, 8)) {
+    // Gravity (numeric)
+    this.options.embed = embed;
+  } else if (is.string(embed) && is.integer(gravity[embed])) {
+    // Gravity (string)
+    this.options.embed = gravity[embed];
+  } else {
+    throw is.invalidParameterError('embed', 'valid embed id/name', 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*".
+ * Use with `max()` to preserve the image's aspect ratio.
+ *
+ * The default behaviour *before* function call is `false`, meaning the image will be enlarged.
+ *
+ * @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;
+};

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=true] - 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,27 @@
 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
+extra_css:
+  - css/extra.css
 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.12.0",
+  "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images",
+  "version": "0.20.7",
   "author": "Lovell Fuller <npm@lovell.info>",
+  "homepage": "https://github.com/lovell/sharp",
   "contributors": [
     "Pierre Inglebert <pierre.inglebert@gmail.com>",
     "Jonathan Ong <jonathanrichardong@gmail.com>",
@@ -18,18 +20,49 @@
     "Alaric Holloway <alaric.holloway@gmail.com>",
     "Bernhard K. Weisshuhn <bkw@codingforce.com>",
     "Chris Riley <criley@primedia.com>",
-    "David Carley <dacarley@gmail.com>"
+    "David Carley <dacarley@gmail.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>",
+    "YvesBos <yves_bos@outlook.com>",
+    "Guy Maliar <guy@tailorbrands.com>",
+    "Nicolas Coden <nicolas@ncoden.fr>",
+    "Matt Parrish <matt.r.parrish@gmail.com>",
+    "Marcel Bretschneider <marcel.bretschneider@gmail.com>",
+    "Matthew McEachen <matthew+github@mceachen.org>",
+    "Jarda Kotěšovec <jarda.kotesovec@gmail.com>",
+    "Kenric D'Souza <kenric.dsouza@gmail.com>",
+    "Oleh Aleinyk <oleg.aleynik@gmail.com>",
+    "Marcel Bretschneider <marcel.bretschneider@gmail.com>",
+    "Andrea Bianco <andrea.bianco@unibas.ch>",
+    "Rik Heywood <rik@rik.org>",
+    "Thomas Parisot <hi@oncletom.io>",
+    "Nathan Graves <nathanrgraves+github@gmail.com>",
+    "Tom Lokhorst <tom@lokhorst.eu>",
+    "Espen Hovlandsdal <espen@hovlandsdal.com>",
+    "Sylvain Dumont <sylvain.dumont35@gmail.com>",
+    "Alun Davies <alun.owain.davies@googlemail.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.*",
+    "install": "(node install/libvips && node install/dll-copy && prebuild-install) || (node-gyp rebuild && node install/dll-copy)",
-    "test": "VIPS_WARNING=0 node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- --slow=5000 --timeout=30000 ./test/unit/*.js",
+    "clean": "rm -rf node_modules/ build/ vendor/ coverage/ test/fixtures/output.*",
-    "test-win": "node ./node_modules/mocha/bin/mocha --slow=5000 --timeout=30000 ./test/unit/*.js",
+    "test": "semistandard && cc && nyc --reporter=lcov --branches=99 mocha --slow=5000 --timeout=60000 ./test/unit/*.js && prebuild-ci",
+    "coverage": "./test/coverage/report.sh",
     "test-leak": "./test/leak/leak.sh",
-    "test-packaging": "./packaging/test.sh",
+    "docs": "for m in constructor input resize composite operation colour channel output utility; do documentation build --shallow --format=md --markdown-toc=false lib/$m.js >docs/api-$m.md; done"
-    "test-clean": "rm -rf coverage/ test/fixtures/output.* && npm install && npm test"
   },
-  "main": "index.js",
+  "main": "lib/index.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/lovell/sharp"
@@ -39,38 +72,62 @@
     "png",
     "webp",
     "tiff",
+    "gif",
+    "svg",
     "dzi",
+    "image",
     "resize",
     "thumbnail",
     "crop",
+    "embed",
     "libvips",
     "vips"
   ],
   "dependencies": {
-    "bluebird": "^3.0.5",
+    "color": "^3.0.0",
-    "color": "^0.10.1",
+    "detect-libc": "^1.0.3",
-    "nan": "^2.1.0",
+    "nan": "^2.10.0",
-    "semver": "^5.1.0",
+    "fs-copy-file-sync": "^1.1.1",
-    "request": "^2.67.0",
+    "npmlog": "^4.1.2",
-    "tar": "^2.2.1"
+    "prebuild-install": "^4.0.0",
+    "semver": "^5.5.1",
+    "simple-get": "^2.8.1",
+    "tar": "^4.4.6",
+    "tunnel-agent": "^0.6.0"
   },
   "devDependencies": {
-    "async": "^1.5.0",
+    "async": "^2.6.1",
-    "coveralls": "^2.11.4",
+    "cc": "^1.0.2",
-    "exif-reader": "^1.0.0",
+    "decompress-zip": "^0.3.1",
-    "icc": "^0.0.2",
+    "documentation": "^8.1.1",
-    "istanbul": "^0.4.0",
+    "exif-reader": "^1.0.2",
-    "mocha": "^2.3.4",
+    "icc": "^1.0.0",
-    "mocha-jshint": "^2.2.5",
+    "mocha": "^5.2.0",
-    "node-cpplint": "^0.4.0",
+    "nyc": "^12.0.2",
-    "rimraf": "^2.4.4",
+    "prebuild": "^7.6.2",
-    "bufferutil": "^1.2.1"
+    "prebuild-ci": "^2.2.3",
+    "rimraf": "^2.6.2",
+    "semistandard": "^12.0.1"
   },
   "license": "Apache-2.0",
   "config": {
-    "libvips": "8.1.1"
+    "libvips": "8.6.1"
   },
   "engines": {
-    "node": ">=0.10"
+    "node": ">=4.5.0"
+  },
+  "semistandard": {
+    "env": [
+      "mocha"
+    ]
+  },
+  "cc": {
+    "linelength": "120",
+    "filter": [
+      "build/c++11",
+      "build/include",
+      "runtime/indentation_namespace",
+      "runtime/references"
+    ]
   }
 }

packaging/build.sh

@@ -1,28 +0,0 @@
-#!/bin/sh
-
-# 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
-
-docker build -t vips-dev-win win
-WIN_CONTAINER_ID=$(docker run -d vips-dev-win)
-docker cp $WIN_CONTAINER_ID:/libvips-8.1.1-win.tar.gz .
-docker rm $WIN_CONTAINER_ID
-
-# Linux
-
-docker build -t vips-dev-lin lin
-LIN_CONTAINER_ID=$(docker run -d vips-dev-lin)
-docker cp $LIN_CONTAINER_ID:/libvips-8.1.1-lin.tar.gz .
-docker rm $LIN_CONTAINER_ID
-
-# Checksums
-
-sha256sum *.tar.gz

packaging/lin/Dockerfile

@@ -1,137 +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
-
-# Working directories
-ENV DEPS /deps
-ENV TARGET /target
-RUN mkdir ${DEPS} && mkdir ${TARGET}
-
-# Common build paths and flags
-ENV PKG_CONFIG_PATH ${PKG_CONFIG_PATH}:${TARGET}/lib/pkgconfig
-ENV PATH ${PATH}:${TARGET}/bin
-ENV CPPFLAGS -I${TARGET}/include
-ENV LDFLAGS -L${TARGET}/lib
-
-# Dependency version numbers
-ENV VERSION_ZLIB 1.2.8
-ENV VERSION_FFI 3.2.1
-ENV VERSION_GLIB 2.46.2
-ENV VERSION_XML2 2.9.2
-ENV VERSION_GSF 1.14.34
-ENV VERSION_EXIF 0.6.21
-ENV VERSION_JPEG 1.4.2
-ENV VERSION_PNG16 1.6.19
-ENV VERSION_LCMS2 2.7
-ENV VERSION_WEBP 0.4.4
-ENV VERSION_TIFF 4.0.6
-ENV VERSION_MAGICK 6.9.2-6
-ENV VERSION_ORC 0.4.24
-ENV VERSION_VIPS 8.1.1
-
-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 http://ftp.gnome.org/pub/gnome/sources/glib/2.46/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 && 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 http://ftp.gnome.org/pub/GNOME/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://kent.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}/jpeg
-RUN curl -Ls http://kent.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://kent.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}/lcms2
-RUN curl -Ls http://kent.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}/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 /deps/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}/magick
-RUN curl -Ls http://www.imagemagick.org/download/releases/ImageMagick-${VERSION_MAGICK}.tar.xz | tar xJC ${DEPS}/magick --strip-components=1
-WORKDIR ${DEPS}/magick
-RUN ./configure --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking --without-magick-plus-plus && make install-strip
-
-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.1/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-zip-includes=${TARGET}/include --with-zip-libraries=${TARGET}/lib \
-  --with-jpeg-includes=${TARGET}/include --with-jpeg-libraries=${TARGET}/lib \
-  && make install-strip
-
-# Remove the C++ bindings
-WORKDIR ${TARGET}/include
-RUN rm -rf vips/vipsc++.h vips/vipscpp.h vips/V*.h
-WORKDIR ${TARGET}/lib
-RUN rm -rf pkgconfig .libs *.la libvipsCC* libvips-cpp.*
-
-# Create JSON file of version numbers
-WORKDIR ${TARGET}
-RUN echo "{\n\
-  \"zlib\": \"${VERSION_ZLIB}\",\n\
-  \"ffi\": \"${VERSION_FFI}\",\n\
-  \"glib\": \"${VERSION_GLIB}\",\n\
-  \"xml\": \"${VERSION_XML2}\",\n\
-  \"gsf\": \"${VERSION_GSF}\",\n\
-  \"exif\": \"${VERSION_EXIF}\",\n\
-  \"jpeg\": \"${VERSION_JPEG}\",\n\
-  \"png\": \"${VERSION_PNG16}\",\n\
-  \"lcms\": \"${VERSION_LCMS2}\",\n\
-  \"webp\": \"${VERSION_WEBP}\",\n\
-  \"tiff\": \"${VERSION_TIFF}\",\n\
-  \"magick\": \"${VERSION_MAGICK}\",\n\
-  \"orc\": \"${VERSION_ORC}\",\n\
-  \"vips\": \"${VERSION_VIPS}\"\n\
-}" >lib/versions.json
-
-# Create .tar.gz
-WORKDIR ${TARGET}
-RUN GZIP=-9 tar czf /libvips-${VERSION_VIPS}-lin.tar.gz include lib

packaging/test.sh

@@ -1,50 +0,0 @@
-#!/bin/sh
-
-# Verify docker is available
-if ! type docker >/dev/null; then
-  echo "Please install docker"
-  exit 1
-fi
-
-test="npm run clean; NODE_ENV=development npm install --unsafe-perm; npm test"
-
-# Debian 7, 8
-# Ubuntu 12.04, 14.04
-for dist in wheezy jessie precise trusty; do
-  echo "Testing $dist..."
-  if docker run -i -t --rm -v $PWD:/v nodesource/$dist:0.12 >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 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
-for dist in centos7 fedora20 fedora21; do
-  echo "Testing $dist..."
-  if docker run -i -t --rm -v $PWD:/v nodesource/$dist:0.12 >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
-  then echo "$dist OK"
-  else echo "$dist fail" && cat packaging/$dist.log
-  fi
-done
-
-# openSUSE 13.2
-echo "Testing opensuse..."
-if docker run -i -t --rm -v $PWD:/v opensuse:13.2 >packaging/opensuse.log 2>&1 /bin/sh -c "cd /v; ./packaging/test/opensuse.sh; $test";
-then echo "opensuse OK"
-else echo "opensuse fail" && cat packaging/opensuse.log
-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";
-then echo "archlinux OK"
-else echo "archlinux fail" && cat packaging/archlinux.log
-fi

packaging/test/archlinux.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-# Install Node.js on Archlinux
-pacman -Sy --noconfirm gcc make python2 nodejs npm | cat
-ln -s /usr/bin/python2 /usr/bin/python

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/test/debian.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-# Install pkg-config on Debian/Ubuntu
-apt-get update
-apt-get install -y pkg-config

packaging/test/opensuse.sh

@@ -1,7 +0,0 @@
-#!/bin/sh
-
-# Install Node.js on openSUSE 13.2
-zypper addrepo http://download.opensuse.org/repositories/devel:languages:nodejs/openSUSE_13.2/devel:languages:nodejs.repo
-zypper --gpg-auto-import-keys refresh
-zypper --non-interactive install gcc-c++ make nodejs-devel nodejs-npm
-npm install -g npm

packaging/win/Dockerfile

@@ -1,16 +0,0 @@
-FROM ubuntu:precise
-MAINTAINER Lovell Fuller <npm@lovell.info>
-
-RUN apt-get update && apt-get install -y curl zip
-
-# Fetch and unzip
-RUN mkdir /vips
-WORKDIR /vips
-RUN curl -O http://www.vips.ecs.soton.ac.uk/supported/8.1/win32/vips-dev-w64-8.1.1-3.zip
-RUN unzip vips-dev-w64-8.1.1-3.zip
-
-# Clean and zip
-WORKDIR /vips/vips-dev-8.1.1
-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 GZIP=-9 tar czf /libvips-8.1.1-win.tar.gz include lib/glib-2.0 lib/libvips.lib lib/libglib-2.0.lib lib/libgobject-2.0.lib lib/*.dll

preinstall.sh

@@ -1,326 +0,0 @@
-#!/bin/sh
-
-# Ensures libvips is installed and attempts to install it if not
-# Currently 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
-#   * Amazon Linux 2015.03, 2015.09
-# * OpenSuse 13
-
-vips_version_minimum=7.40.0
-vips_version_latest_major_minor=8.1
-vips_version_latest_patch=1
-
-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
-
-# 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|vivid|wily)
-      # Debian 8, Ubuntu 15
-      if [ $enable_openslide -eq 1 ]; then
-        echo "Recompiling vips with openslide support"
-        install_libvips_from_source
-      else
-        echo "Installing libvips via apt-get"
-        apt-get install -y libvips-dev libgsf-1-dev
-      fi
-      ;;
-    trusty|utopic|qiana|rebecca|rafaela|freya)
-      # Ubuntu 14, 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 release 21 "*|"Fedora release 22 "*)
-      # Fedora 21, 22
-      if [ $enable_openslide -eq 1 ]; then
-        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
-        echo "Compiling vips with openslide support"
-        install_libvips_from_source "--prefix=/usr"
-      else
-        echo "Installing libvips via yum"
-        yum install -y vips-devel
-      fi
-      ;;
-    *)
-      # 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,30 +1,85 @@
+// 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 <vips/vips.h>
+#include <vector>
+#include <queue>
+#include <mutex>
+
+#include <node.h>
+#include <node_buffer.h>
+#include <nan.h>
+#include <vips/vips8>
 
 #include "common.h"
 
-// Verify platform and compiler compatibility
+using vips::VImage;
-
-#if (VIPS_MAJOR_VERSION < 8 || (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 1 && VIPS_PATCH_VERSION < 1))
-#error libvips version 8.1.1+ required - see http://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 http://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 http://sharp.dimens.io/page/install#prerequisites
-#endif
-#endif
-
-#define EXIF_IFD0_ORIENTATION "exif-ifd0-Orientation"
 
 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);
+    }
+    descriptor->failOnError = AttrTo<bool>(input, "failOnError");
+    // 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");
+    }
+    // Page input for multi-page TIFF
+    if (HasAttr(input, "page")) {
+      descriptor->page = AttrTo<uint32_t>(input, "page");
+    }
+    // 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;
 
@@ -50,6 +105,36 @@ 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.
+  */
+  std::string ImageTypeId(ImageType const imageType) {
+    std::string id;
+    switch (imageType) {
+      case ImageType::JPEG: id = "jpeg"; break;
+      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;
+    }
+    return id;
+  }
 
   /*
     Determine image format of a buffer.
@@ -58,7 +143,7 @@ namespace sharp {
     ImageType imageType = ImageType::UNKNOWN;
     char const *load = vips_foreign_find_load_buffer(buffer, length);
     if (load != NULL) {
-      std::string loader = load;
+      std::string const loader = load;
       if (EndsWith(loader, "JpegBuffer")) {
         imageType = ImageType::JPEG;
       } else if (EndsWith(loader, "PngBuffer")) {
@@ -67,6 +152,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;
       }
@@ -74,13 +165,6 @@ namespace sharp {
     return imageType;
   }
 
-  /*
-    Initialise and return a VipsImage from a buffer. Supports JPEG, PNG, WebP and TIFF.
-  */
-  VipsImage* InitImage(void *buffer, size_t const length, VipsAccess const access) {
-    return vips_image_new_from_buffer(buffer, length, nullptr, "access", access, nullptr);
-  }
-
   /*
     Determine image format, reads the first few bytes of the file
   */
@@ -88,7 +172,7 @@ namespace sharp {
     ImageType imageType = ImageType::UNKNOWN;
     char const *load = vips_foreign_find_load(file);
     if (load != nullptr) {
-      std::string loader = load;
+      std::string const loader = load;
       if (EndsWith(loader, "JpegFile")) {
         imageType = ImageType::JPEG;
       } else if (EndsWith(loader, "Png")) {
@@ -99,6 +183,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;
       }
@@ -107,42 +203,123 @@ namespace sharp {
   }
 
   /*
-    Initialise and return a VipsImage from a file.
+    Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
   */
-  VipsImage* InitImage(char const *file, VipsAccess const access) {
+  std::tuple<VImage, ImageType> OpenInput(InputDescriptor *descriptor, VipsAccess accessMethod) {
-    return vips_image_new_from_file(file, "access", access, nullptr);
+    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)
+              ->set("fail", descriptor->failOnError);
+            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());
+            }
+            if (imageType == ImageType::TIFF) {
+             option->set("page", descriptor->page);
+            }
+            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)
+              ->set("fail", descriptor->failOnError);
+            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());
+            }
+            if (imageType == ImageType::TIFF) {
+             option->set("page", descriptor->page);
+            }
+            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?
   */
-  bool HasProfile(VipsImage *image) {
+  bool HasProfile(VImage image) {
-    return (vips_image_get_typeof(image, VIPS_META_ICC_NAME) > 0) ? TRUE : FALSE;
+    return (image.get_typeof(VIPS_META_ICC_NAME) != 0) ? TRUE : FALSE;
   }
 
   /*
     Does this image have an alpha channel?
     Uses colour space interpretation with number of channels to guess this.
   */
-  bool HasAlpha(VipsImage *image) {
+  bool HasAlpha(VImage image) {
+    int const bands = image.bands();
+    VipsInterpretation const interpretation = image.interpretation();
     return (
-      (image->Bands == 2 && image->Type == VIPS_INTERPRETATION_B_W) ||
+      (bands == 2 && interpretation == VIPS_INTERPRETATION_B_W) ||
-      (image->Bands == 4 && image->Type != VIPS_INTERPRETATION_CMYK) ||
+      (bands == 4 && interpretation != VIPS_INTERPRETATION_CMYK) ||
-      (image->Bands == 5 && image->Type == VIPS_INTERPRETATION_CMYK)
+      (bands == 5 && interpretation == VIPS_INTERPRETATION_CMYK));
-    );
   }
 
   /*
     Get EXIF Orientation of image, if any.
   */
-  int ExifOrientation(VipsImage const *image) {
+  int ExifOrientation(VImage image) {
     int orientation = 0;
-    const char *exif;
+    if (image.get_typeof(VIPS_META_ORIENTATION) != 0) {
-    if (
+      orientation = image.get_int(VIPS_META_ORIENTATION);
-      vips_image_get_typeof(image, EXIF_IFD0_ORIENTATION) != 0 &&
-      !vips_image_get_string(image, EXIF_IFD0_ORIENTATION, &exif)
-    ) {
-      orientation = atoi(&exif[0]);
     }
     return orientation;
   }
@@ -150,31 +327,58 @@ namespace sharp {
   /*
     Set EXIF Orientation of image.
   */
-  void SetExifOrientation(VipsImage *image, int const orientation) {
+  void SetExifOrientation(VImage image, int const orientation) {
-    char exif[3];
+    image.set(VIPS_META_ORIENTATION, orientation);
-    g_snprintf(exif, sizeof(exif), "%d", orientation);
-    vips_image_set_string(image, EXIF_IFD0_ORIENTATION, exif);
   }
 
   /*
     Remove EXIF Orientation from image.
   */
-  void RemoveExifOrientation(VipsImage *image) {
+  void RemoveExifOrientation(VImage image) {
-    SetExifOrientation(image, 0);
+    vips_image_remove(image.get_image(), VIPS_META_ORIENTATION);
   }
 
   /*
-    Returns the window size for the named interpolator. For example,
+    Does this image have a non-default density?
-    a window size of 3 means a 3x3 pixel grid is used for the calculation.
   */
-  int InterpolatorWindowSize(char const *name) {
+  bool HasDensity(VImage image) {
-    VipsInterpolate *interpolator = vips_interpolate_new(name);
+    return image.xres() > 1.0;
-    if (interpolator == nullptr) {
+  }
-      return -1;
+
+  /*
+    Get pixels/mm resolution as pixels/inch density.
+  */
+  int GetDensity(VImage image) {
+    return static_cast<int>(round(image.xres() * 25.4));
+  }
+
+  /*
+    Set pixels/mm resolution based on a pixels/inch density.
+  */
+  void SetDensity(VImage image, const int density) {
+    const double pixelsPerMm = static_cast<double>(density) / 25.4;
+    image.set("Xres", pixelsPerMm);
+    image.set("Yres", pixelsPerMm);
+    image.set(VIPS_META_RESOLUTION_UNIT, "in");
+  }
+
+  /*
+    Check the proposed format supports the current dimensions.
+  */
+  void AssertImageTypeDimensions(VImage image, ImageType const imageType) {
+    if (imageType == ImageType::JPEG) {
+      if (image.width() > 65535 || image.height() > 65535) {
+        throw vips::VError("Processed image is too large for the JPEG format");
+      }
+    } else if (imageType == ImageType::PNG) {
+      if (image.width() > 2147483647 || image.height() > 2147483647) {
+        throw vips::VError("Processed image is too large for the PNG format");
+      }
+    } else if (imageType == ImageType::WEBP) {
+      if (image.width() > 16383 || image.height() > 16383) {
+        throw vips::VError("Processed image is too large for the WebP format");
+      }
     }
-    int window_size = vips_interpolate_get_window_size(interpolator);
-    g_object_unref(interpolator);
-    return window_size;
   }
 
   /*
@@ -186,4 +390,220 @@ namespace sharp {
     }
   }
 
+  /*
+    Temporary buffer of warnings
+  */
+  std::queue<std::string> vipsWarnings;
+  std::mutex vipsWarningsMutex;
+
+  /*
+    Called with warnings from the glib-registered "VIPS" domain
+  */
+  void VipsWarningCallback(char const* log_domain, GLogLevelFlags log_level, char const* message, void* ignore) {
+    std::lock_guard<std::mutex> lock(vipsWarningsMutex);
+    vipsWarnings.emplace(message);
+  }
+
+  /*
+    Pop the oldest warning message from the queue
+  */
+  std::string VipsWarningPop() {
+    std::string warning;
+    std::lock_guard<std::mutex> lock(vipsWarningsMutex);
+    if (!vipsWarnings.empty()) {
+      warning = vipsWarnings.front();
+      vipsWarnings.pop();
+    }
+    return warning;
+  }
+
+  /*
+    Calculate the (left, top) coordinates of the output image
+    within the input image, applying the given gravity during an embed.
+
+    @Azurebyte: We are basically swapping the inWidth and outWidth, inHeight and outHeight from the CalculateCrop function.
+  */
+  std::tuple<int, int> CalculateEmbedPosition(int const inWidth, int const inHeight,
+    int const outWidth, int const outHeight, int const gravity) {
+
+    int left = 0;
+    int top = 0;
+    switch (gravity) {
+      case 1:
+        // North
+        left = (outWidth - inWidth) / 2;
+        break;
+      case 2:
+        // East
+        left = outWidth - inWidth;
+        top = (outHeight - inHeight) / 2;
+        break;
+      case 3:
+        // South
+        left = (outWidth - inWidth) / 2;
+        top = outHeight - inHeight;
+        break;
+      case 4:
+        // West
+        top = (outHeight - inHeight) / 2;
+        break;
+      case 5:
+        // Northeast
+        left = outWidth - inWidth;
+        break;
+      case 6:
+        // Southeast
+        left = outWidth - inWidth;
+        top = outHeight - inHeight;
+        break;
+      case 7:
+        // Southwest
+        top = outHeight - inHeight;
+        break;
+      case 8:
+        // Northwest
+        // Which is the default is 0,0 so we do not assign anything here.
+        break;
+      default:
+        // Centre
+        left = (outWidth - inWidth) / 2;
+        top = (outHeight - inHeight) / 2;
+    }
+    return std::make_tuple(left, top);
+  }
+
+  /*
+    Calculate the (left, top) coordinates of the output image
+    within the input image, applying the given gravity during a crop.
+  */
+  std::tuple<int, int> CalculateCrop(int const inWidth, int const inHeight,
+    int const outWidth, int const outHeight, int const gravity) {
+
+    int left = 0;
+    int top = 0;
+    switch (gravity) {
+      case 1:
+        // North
+        left = (inWidth - outWidth + 1) / 2;
+        break;
+      case 2:
+        // East
+        left = inWidth - outWidth;
+        top = (inHeight - outHeight + 1) / 2;
+        break;
+      case 3:
+        // South
+        left = (inWidth - outWidth + 1) / 2;
+        top = inHeight - outHeight;
+        break;
+      case 4:
+        // West
+        top = (inHeight - outHeight + 1) / 2;
+        break;
+      case 5:
+        // Northeast
+        left = inWidth - outWidth;
+        break;
+      case 6:
+        // Southeast
+        left = inWidth - outWidth;
+        top = inHeight - outHeight;
+        break;
+      case 7:
+        // Southwest
+        top = inHeight - outHeight;
+        break;
+      case 8:
+        // Northwest
+        break;
+      default:
+        // Centre
+        left = (inWidth - outWidth + 1) / 2;
+        top = (inHeight - outHeight + 1) / 2;
+    }
+    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,18 +1,115 @@
+// 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 < 6))
+#error libvips version 8.6.1+ is required - see sharp.pixelplumbing.com/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.pixelplumbing.com/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.pixelplumbing.com/page/install#prerequisites
+#endif
+#endif
+
+using vips::VImage;
 
 namespace sharp {
 
+  struct InputDescriptor {
+    std::string name;
+    std::string file;
+    char *buffer;
+    bool failOnError;
+    size_t bufferLength;
+    int density;
+    int rawChannels;
+    int rawWidth;
+    int rawHeight;
+    int page;
+    int createChannels;
+    int createWidth;
+    int createHeight;
+    double createBackground[4];
+
+    InputDescriptor():
+      buffer(nullptr),
+      failOnError(FALSE),
+      bufferLength(0),
+      density(72),
+      rawChannels(0),
+      rawWidth(0),
+      rawHeight(0),
+      page(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
+    OPENSLIDE,
+    PPM,
+    FITS,
+    VIPS,
+    RAW,
+    UNKNOWN
   };
 
   // How many tasks are in the queue?
@@ -27,6 +124,13 @@ 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.
+  */
+  std::string ImageTypeId(ImageType const imageType);
 
   /*
     Determine image format of a buffer.
@@ -39,52 +143,118 @@ namespace sharp {
   ImageType DetermineImageType(char const *file);
 
   /*
-    Initialise and return a VipsImage from a buffer. Supports JPEG, PNG, WebP and TIFF.
+    Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
   */
-  VipsImage* InitImage(void *buffer, size_t const length, VipsAccess const access);
+  std::tuple<VImage, ImageType> OpenInput(InputDescriptor *descriptor, VipsAccess accessMethod);
-
-  /*
-    Initialise and return a VipsImage from a file.
-  */
-  VipsImage* InitImage(char const *file, VipsAccess const access);
 
   /*
     Does this image have an embedded profile?
   */
-  bool HasProfile(VipsImage *image);
+  bool HasProfile(VImage image);
 
   /*
     Does this image have an alpha channel?
     Uses colour space interpretation with number of channels to guess this.
   */
-  bool HasAlpha(VipsImage *image);
+  bool HasAlpha(VImage image);
 
   /*
     Get EXIF Orientation of image, if any.
   */
-  int ExifOrientation(VipsImage const *image);
+  int ExifOrientation(VImage image);
 
   /*
     Set EXIF Orientation of image.
   */
-  void SetExifOrientation(VipsImage *image, int const orientation);
+  void SetExifOrientation(VImage image, int const orientation);
 
   /*
     Remove EXIF Orientation from image.
   */
-  void RemoveExifOrientation(VipsImage *image);
+  void RemoveExifOrientation(VImage image);
 
   /*
-    Returns the window size for the named interpolator. For example,
+    Does this image have a non-default density?
-    a window size of 3 means a 3x3 pixel grid is used for the calculation.
   */
-  int InterpolatorWindowSize(char const *name);
+  bool HasDensity(VImage image);
+
+  /*
+    Get pixels/mm resolution as pixels/inch density.
+  */
+  int GetDensity(VImage image);
+
+  /*
+    Set pixels/mm resolution based on a pixels/inch density.
+  */
+  void SetDensity(VImage image, const int density);
+
+  /*
+    Check the proposed format supports the current dimensions.
+  */
+  void AssertImageTypeDimensions(VImage image, ImageType const imageType);
 
   /*
     Called when a Buffer undergoes GC, required to support mixed runtime libraries in Windows
   */
   void FreeCallback(char* data, void* hint);
 
+  /*
+    Called with warnings from the glib-registered "VIPS" domain
+  */
+  void VipsWarningCallback(char const* log_domain, GLogLevelFlags log_level, char const* message, void* ignore);
+
+  /*
+    Pop the oldest warning message from the queue
+  */
+  std::string VipsWarningPop();
+
+  /*
+    Calculate the (left, top) coordinates of the output image
+    within the input image, applying the given gravity during an embed.
+  */
+  std::tuple<int, int> CalculateEmbedPosition(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 gravity.
+  */
+  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/VError.cpp

@@ -0,0 +1,52 @@
+// Code for error type
+
+/*
+
+    Copyright (C) 1991-2001 The National Gallery
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301  USA
+
+ */
+
+/*
+
+    These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
+
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif /*HAVE_CONFIG_H*/
+#include <vips/intl.h>
+
+#include <iostream>
+
+#include <vips/vips8>
+
+VIPS_NAMESPACE_START
+
+std::ostream &operator<<( std::ostream &file, const VError &err )
+{
+	err.ostream_print( file );
+	return( file );
+}
+
+void VError::ostream_print( std::ostream &file ) const
+{
+	file << _what;
+}
+
+VIPS_NAMESPACE_END

src/libvips/cplusplus/VInterpolate.cpp

@@ -0,0 +1,76 @@
+/* Object part of VInterpolate class
+ */
+
+/*
+
+    Copyright (C) 1991-2001 The National Gallery
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301  USA
+
+ */
+
+/*
+
+    These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
+
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif /*HAVE_CONFIG_H*/
+#include <vips/intl.h>
+
+#include <vips/vips8>
+
+#include <vips/debug.h>
+
+/*
+#define VIPS_DEBUG
+#define VIPS_DEBUG_VERBOSE
+ */
+
+VIPS_NAMESPACE_START
+
+VInterpolate 
+VInterpolate::new_from_name( const char *name, VOption *options )
+{
+	VipsInterpolate *interp;
+
+	if( !(interp = vips_interpolate_new( name )) ) {
+		delete options; 
+		throw VError(); 
+	}
+	delete options; 
+
+	VInterpolate out( interp ); 
+
+	return( out ); 
+}
+
+VOption *
+VOption::set( const char *name, VInterpolate value )
+{
+	Pair *pair = new Pair( name );
+
+	pair->input = true;
+	g_value_init( &pair->value, VIPS_TYPE_INTERPOLATE );
+	g_value_set_object( &pair->value, value.get_interpolate() );
+	options.push_back( pair );
+
+	return( this );
+}
+
+VIPS_NAMESPACE_END

src/metadata.cc

@@ -1,233 +1,206 @@
-#include <node.h>
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-#include <vips/vips.h>
+//
+// 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 sharp::ImageType;
-using sharp::DetermineImageType;
-using sharp::InitImage;
-using sharp::HasProfile;
-using sharp::HasAlpha;
-using sharp::ExifOrientation;
-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;
-  bool hasProfile;
-  bool hasAlpha;
-  int orientation;
-  char *exif;
-  size_t exifLength;
-  char *icc;
-  size_t iccLength;
-  std::string err;
-
-  MetadataBaton():
-    bufferInLength(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, Nan::Callback *debuglog,
-      if (baton->bufferInLength > 0) {
+    std::vector<v8::Local<v8::Object>> const buffersToPersist) :
-        SaveToPersistent("bufferIn", bufferIn);
+    Nan::AsyncWorker(callback, "sharp:MetadataWorker"),
-      }
+    baton(baton), debuglog(debuglog),
+    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;
-    VipsImage *image = nullptr;
+    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());
-        image = InitImage(baton->bufferIn, baton->bufferInLength, VIPS_ACCESS_RANDOM);
-        if (image == nullptr) {
-          (baton->err).append("Input buffer has corrupt header");
-          imageType = ImageType::UNKNOWN;
     }
-      } else {
+    if (imageType != sharp::ImageType::UNKNOWN) {
-        (baton->err).append("Input buffer contains unsupported image format");
-      }
-    } else {
-      // From file
-      imageType = DetermineImageType(baton->fileIn.data());
-      if (imageType != ImageType::UNKNOWN) {
-        image = InitImage(baton->fileIn.data(), VIPS_ACCESS_RANDOM);
-        if (image == nullptr) {
-          (baton->err).append("Input file has corrupt header");
-          imageType = ImageType::UNKNOWN;
-        }
-      } else {
-        (baton->err).append("Input file is of an unsupported image format");
-      }
-    }
-    if (image != nullptr && imageType != ImageType::UNKNOWN) {
       // Image type
-      switch (imageType) {
+      baton->format = sharp::ImageTypeId(imageType);
-        case ImageType::JPEG: baton->format = "jpeg"; break;
-        case ImageType::PNG: baton->format = "png"; break;
-        case ImageType::WEBP: baton->format = "webp"; break;
-        case ImageType::TIFF: baton->format = "tiff"; break;
-        case ImageType::MAGICK: baton->format = "magick"; break;
-        case ImageType::OPENSLIDE: baton->format = "openslide"; break;
-        case ImageType::UNKNOWN: break;
-      }
       // VipsImage attributes
-      baton->width = image->Xsize;
+      baton->width = image.width();
-      baton->height = image->Ysize;
+      baton->height = image.height();
-      baton->space = vips_enum_nick(VIPS_TYPE_INTERPRETATION, image->Type);
+      baton->space = vips_enum_nick(VIPS_TYPE_INTERPRETATION, image.interpretation());
-      baton->channels = image->Bands;
+      baton->channels = image.bands();
-      baton->hasProfile = HasProfile(image);
+      baton->depth = vips_enum_nick(VIPS_TYPE_BAND_FORMAT, image.format());
+      if (sharp::HasDensity(image)) {
+        baton->density = sharp::GetDensity(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 (vips_image_get_typeof(image, VIPS_META_EXIF_NAME) == VIPS_TYPE_BLOB) {
+      if (image.get_typeof(VIPS_META_EXIF_NAME) == VIPS_TYPE_BLOB) {
-        void* exif;
         size_t exifLength;
-        if (!vips_image_get_blob(image, VIPS_META_EXIF_NAME, &exif, &exifLength)) {
+        void const *exif = image.get_blob(VIPS_META_EXIF_NAME, &exifLength);
-          baton->exifLength = exifLength;
         baton->exif = static_cast<char*>(g_malloc(exifLength));
         memcpy(baton->exif, exif, exifLength);
-        }
+        baton->exifLength = exifLength;
       }
       // ICC profile
-      if (vips_image_get_typeof(image, VIPS_META_ICC_NAME) == VIPS_TYPE_BLOB) {
+      if (image.get_typeof(VIPS_META_ICC_NAME) == VIPS_TYPE_BLOB) {
-        void* icc;
         size_t iccLength;
-        if (!vips_image_get_blob(image, VIPS_META_ICC_NAME, &icc, &iccLength)) {
+        void const *icc = image.get_blob(VIPS_META_ICC_NAME, &iccLength);
-          baton->iccLength = iccLength;
         baton->icc = static_cast<char*>(g_malloc(iccLength));
         memcpy(baton->icc, icc, iccLength);
+        baton->iccLength = iccLength;
+      }
+      // IPTC
+      if (image.get_typeof(VIPS_META_IPTC_NAME) == VIPS_TYPE_BLOB) {
+        size_t iptcLength;
+        void const *iptc = image.get_blob(VIPS_META_IPTC_NAME, &iptcLength);
+        baton->iptc = static_cast<char *>(g_malloc(iptcLength));
+        memcpy(baton->iptc, iptc, iptcLength);
+        baton->iptcLength = iptcLength;
+      }
+      // XMP
+      if (image.get_typeof(VIPS_META_XMP_NAME) == VIPS_TYPE_BLOB) {
+        size_t xmpLength;
+        void const *xmp = image.get_blob(VIPS_META_XMP_NAME, &xmpLength);
+        baton->xmp = static_cast<char *>(g_malloc(xmpLength));
+        memcpy(baton->xmp, xmp, xmpLength);
+        baton->xmpLength = xmpLength;
       }
     }
-      // Drop image reference
+
-      g_object_unref(image);
-    }
     // Clean up
     vips_error_clear();
     vips_thread_shutdown();
   }
 
   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));
-      Set(info, New("hasProfile").ToLocalChecked(), New<Boolean>(baton->hasProfile));
+      Set(info, New("depth").ToLocalChecked(), New<v8::String>(baton->depth).ToLocalChecked());
-      Set(info, New("hasAlpha").ToLocalChecked(), New<Boolean>(baton->hasAlpha));
+      if (baton->density > 0) {
+        Set(info, New("density").ToLocalChecked(), New<v8::Uint32>(baton->density));
+      }
+      Set(info, New("hasProfile").ToLocalChecked(), New<v8::Boolean>(baton->hasProfile));
+      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());
-        );
+      }
+      if (baton->iptcLength > 0) {
+        Set(info,
+          New("iptc").ToLocalChecked(),
+          Nan::NewBuffer(baton->iptc, baton->iptcLength, sharp::FreeCallback, nullptr).ToLocalChecked());
+      }
+      if (baton->xmpLength > 0) {
+        Set(info,
+          New("xmp").ToLocalChecked(),
+          Nan::NewBuffer(baton->xmp, baton->xmpLength, 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;
 
+    // Handle warnings
+    std::string warning = sharp::VipsWarningPop();
+    while (!warning.empty()) {
+      v8::Local<v8::Value> message[1] = { New(warning).ToLocalChecked() };
+      debuglog->Call(1, message, async_resource);
+      warning = sharp::VipsWarningPop();
+    }
+
     // Return to JavaScript
-    callback->Call(2, argv);
+    callback->Call(2, argv, async_resource);
   }
 
  private:
   MetadataBaton* baton;
+  Nan::Callback *debuglog;
+  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;
+  // Function to notify of libvips warnings
-  if (node::Buffer::HasInstance(Get(options, New("bufferIn").ToLocalChecked()).ToLocalChecked())) {
+  Nan::Callback *debuglog = new Nan::Callback(sharp::AttrAs<v8::Function>(options, "debuglog"));
-    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, debuglog, buffersToPersist));
 
   // Increment queued task counter
-  g_atomic_int_inc(&counterQueue);
+  g_atomic_int_inc(&sharp::counterQueue);
 }

src/metadata.h

@@ -1,7 +1,67 @@
+// 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;
+  std::string depth;
+  int density;
+  bool hasProfile;
+  bool hasAlpha;
+  int orientation;
+  char *exif;
+  size_t exifLength;
+  char *icc;
+  size_t iccLength;
+  char *iptc;
+  size_t iptcLength;
+  char *xmp;
+  size_t xmpLength;
+  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),
+    iptc(nullptr),
+    iptcLength(0),
+    xmp(nullptr),
+    xmpLength(0) {}
+};
 
 NAN_METHOD(metadata);
 

src/operations.cc

@@ -1,66 +1,77 @@
-#include <vips/vips.h>
+// 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"
 #include "operations.h"
 
+using vips::VImage;
+using vips::VError;
+
 namespace sharp {
 
   /*
-    Alpha composite src over dst
+    Removes alpha channel, if any.
+  */
+  VImage RemoveAlpha(VImage image) {
+    if (HasAlpha(image)) {
+      image = image.extract_band(0, VImage::option()->set("n", image.bands() - 1));
+    }
+    return image;
+  }
+
+  /*
+    Composite overlayImage over image at given position
     Assumes alpha channels are already premultiplied and will be unpremultiplied after
    */
-  int Composite(VipsObject *context, VipsImage *src, VipsImage *dst, VipsImage **out) {
+  VImage Composite(VImage image, VImage overlayImage, int const left, int const top) {
-    using sharp::HasAlpha;
+    if (HasAlpha(overlayImage)) {
+      // Alpha composite
+      if (overlayImage.width() < image.width() || overlayImage.height() < image.height()) {
+        // Enlarge overlay
+        std::vector<double> const background { 0.0, 0.0, 0.0, 0.0 };
+        overlayImage = overlayImage.embed(left, top, image.width(), image.height(), VImage::option()
+          ->set("extend", VIPS_EXTEND_BACKGROUND)
+          ->set("background", background));
+      }
+      return AlphaComposite(image, overlayImage);
+    } else {
+      if (HasAlpha(image)) {
+        // Add alpha channel to overlayImage so channels match
+        double const multiplier = sharp::Is16Bit(overlayImage.interpretation()) ? 256.0 : 1.0;
+        overlayImage = overlayImage.bandjoin(
+          VImage::new_matrix(overlayImage.width(), overlayImage.height()).new_from_image(255 * multiplier));
+      }
+      return image.insert(overlayImage, left, top);
+    }
+  }
 
-    // Split src into non-alpha and alpha
+  VImage AlphaComposite(VImage dst, VImage src) {
-    VipsImage *srcWithoutAlpha;
+    // Split src into non-alpha and alpha channels
-    if (vips_extract_band(src, &srcWithoutAlpha, 0, "n", src->Bands - 1, nullptr))
+    VImage srcWithoutAlpha = src.extract_band(0, VImage::option()->set("n", src.bands() - 1));
-      return -1;
+    VImage srcAlpha = src[src.bands() - 1] * (1.0 / 255.0);
-    vips_object_local(context, srcWithoutAlpha);
-    VipsImage *srcAlpha;
-    if (vips_extract_band(src, &srcAlpha, src->Bands - 1, "n", 1, nullptr))
-      return -1;
-    vips_object_local(context, srcAlpha);
 
     // Split dst into non-alpha and alpha channels
-    VipsImage *dstWithoutAlpha;
+    VImage dstWithoutAlpha = dst.extract_band(0, VImage::option()->set("n", dst.bands() - 1));
-    VipsImage *dstAlpha;
+    VImage dstAlpha = dst[dst.bands() - 1] * (1.0 / 255.0);
-    if (HasAlpha(dst)) {
-      // Non-alpha: extract all-but-last channel
-      if (vips_extract_band(dst, &dstWithoutAlpha, 0, "n", dst->Bands - 1, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, dstWithoutAlpha);
-      // Alpha: Extract last channel
-      if (vips_extract_band(dst, &dstAlpha, dst->Bands - 1, "n", 1, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, dstAlpha);
-    } else {
-      // Non-alpha: Copy reference
-      dstWithoutAlpha = dst;
-      // Alpha: Use blank, opaque (0xFF) image
-      VipsImage *black;
-      if (vips_black(&black, dst->Xsize, dst->Ysize, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, black);
-      if (vips_invert(black, &dstAlpha, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, dstAlpha);
-    }
-
-    // Compute normalized input alpha channels:
-    VipsImage *srcAlphaNormalized;
-    if (vips_linear1(srcAlpha, &srcAlphaNormalized, 1.0 / 255.0, 0.0, nullptr))
-      return -1;
-    vips_object_local(context, srcAlphaNormalized);
-
-    VipsImage *dstAlphaNormalized;
-    if (vips_linear1(dstAlpha, &dstAlphaNormalized, 1.0 / 255.0, 0.0, nullptr))
-      return -1;
-    vips_object_local(context, dstAlphaNormalized);
 
     //
     // Compute normalized output alpha channel:
@@ -72,22 +83,8 @@ namespace sharp {
     // out_a = src_a + dst_a * (1 - src_a)
     //                         ^^^^^^^^^^^
     //                            t0
-    //                 ^^^^^^^^^^^^^^^^^^^
+    VImage t0 = srcAlpha.linear(-1.0, 1.0);
-    //                         t1
+    VImage outAlphaNormalized = srcAlpha + dstAlpha * t0;
-    VipsImage *t0;
-    if (vips_linear1(srcAlphaNormalized, &t0, -1.0, 1.0, nullptr))
-      return -1;
-    vips_object_local(context, t0);
-
-    VipsImage *t1;
-    if (vips_multiply(dstAlphaNormalized, t0, &t1, nullptr))
-      return -1;
-    vips_object_local(context, t1);
-
-    VipsImage *outAlphaNormalized;
-    if (vips_add(srcAlphaNormalized, t1, &outAlphaNormalized, nullptr))
-      return -1;
-    vips_object_local(context, outAlphaNormalized);
 
     //
     // Compute output RGB channels:
@@ -101,182 +98,294 @@ namespace sharp {
     // premultiplied RGBA image as reversal of premultiplication is handled
     // externally.
     //
-    VipsImage *t2;
+    VImage outRGBPremultiplied = srcWithoutAlpha + dstWithoutAlpha * t0;
-    if (vips_multiply(dstWithoutAlpha, t0, &t2, nullptr))
-      return -1;
-    vips_object_local(context, t2);
-
-    VipsImage *outRGBPremultiplied;
-    if (vips_add(srcWithoutAlpha, t2, &outRGBPremultiplied, nullptr))
-      return -1;
-    vips_object_local(context, outRGBPremultiplied);
-
-    // Denormalize output alpha channel:
-    VipsImage *outAlpha;
-    if (vips_linear1(outAlphaNormalized, &outAlpha, 255.0, 0.0, nullptr))
-      return -1;
-    vips_object_local(context, outAlpha);
 
     // Combine RGB and alpha channel into output image:
-    return vips_bandjoin2(outRGBPremultiplied, outAlpha, out, nullptr);
+    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()));
+  }
+
+  /*
+   * Tint an image using the specified chroma, preserving the original image luminance
+   */
+  VImage Tint(VImage image, double const a, double const b) {
+    // Get original colourspace
+    VipsInterpretation typeBeforeTint = image.interpretation();
+    if (typeBeforeTint == VIPS_INTERPRETATION_RGB) {
+      typeBeforeTint = VIPS_INTERPRETATION_sRGB;
+    }
+    // Extract luminance
+    VImage luminance = image.colourspace(VIPS_INTERPRETATION_LAB)[0];
+    // Create the tinted version by combining the L from the original and the chroma from the tint
+    std::vector<double> chroma {a, b};
+    VImage tinted = luminance
+      .bandjoin(chroma)
+      .copy(VImage::option()->set("interpretation", VIPS_INTERPRETATION_LAB))
+      .colourspace(typeBeforeTint);
+    // Attach original alpha channel, if any
+    if (HasAlpha(image)) {
+      // Extract original alpha channel
+      VImage alpha = image[image.bands() - 1];
+      // Join alpha channel to normalised image
+      tinted = tinted.bandjoin(alpha);
+    }
+    return tinted;
   }
 
   /*
    * Stretch luminance to cover full dynamic range.
    */
-  int Normalize(VipsObject *context, VipsImage *image, VipsImage **out) {
+  VImage Normalise(VImage image) {
     // Get original colourspace
-    VipsInterpretation typeBeforeNormalize = image->Type;
+    VipsInterpretation typeBeforeNormalize = image.interpretation();
     if (typeBeforeNormalize == VIPS_INTERPRETATION_RGB) {
       typeBeforeNormalize = VIPS_INTERPRETATION_sRGB;
     }
     // Convert to LAB colourspace
-    VipsImage *lab;
+    VImage lab = image.colourspace(VIPS_INTERPRETATION_LAB);
-    if (vips_colourspace(image, &lab, VIPS_INTERPRETATION_LAB, nullptr)) {
-      return -1;
-    }
-    vips_object_local(context, lab);
     // Extract luminance
-    VipsImage *luminance;
+    VImage luminance = lab[0];
-    if (vips_extract_band(lab, &luminance, 0, "n", 1, nullptr)) {
-      return -1;
-    }
-    vips_object_local(context, luminance);
-    // Extract chroma
-    VipsImage *chroma;
-    if (vips_extract_band(lab, &chroma, 1, "n", 2, nullptr)) {
-      return -1;
-    }
-    vips_object_local(context, chroma);
     // Find luminance range
-    VipsImage *stats;
+    VImage stats = luminance.stats();
-    if (vips_stats(luminance, &stats, nullptr)) {
+    double min = stats(0, 0)[0];
-      return -1;
+    double max = stats(1, 0)[0];
-    }
-    vips_object_local(context, stats);
-    double min = *VIPS_MATRIX(stats, 0, 0);
-    double max = *VIPS_MATRIX(stats, 1, 0);
     if (min != max) {
+      // Extract chroma
+      VImage chroma = lab.extract_band(1, VImage::option()->set("n", 2));
+      // Calculate multiplication factor and addition
       double f = 100.0 / (max - min);
       double a = -(min * f);
-      // Scale luminance
+      // Scale luminance, join to chroma, convert back to original colourspace
-      VipsImage *luminance100;
+      VImage normalized = luminance.linear(f, a).bandjoin(chroma).colourspace(typeBeforeNormalize);
-      if (vips_linear1(luminance, &luminance100, f, a, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, luminance100);
-      // Join scaled luminance to chroma
-      VipsImage *normalizedLab;
-      if (vips_bandjoin2(luminance100, chroma, &normalizedLab, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, normalizedLab);
-      // Convert to original colourspace
-      VipsImage *normalized;
-      if (vips_colourspace(normalizedLab, &normalized, typeBeforeNormalize, nullptr)) {
-        return -1;
-      }
-      vips_object_local(context, normalized);
       // Attach original alpha channel, if any
       if (HasAlpha(image)) {
         // Extract original alpha channel
-        VipsImage *alpha;
+        VImage alpha = image[image.bands() - 1];
-        if (vips_extract_band(image, &alpha, image->Bands - 1, "n", 1, nullptr)) {
-          return -1;
-        }
-        vips_object_local(context, alpha);
         // Join alpha channel to normalised image
-        VipsImage *normalizedAlpha;
+        return normalized.bandjoin(alpha);
-        if (vips_bandjoin2(normalized, alpha, &normalizedAlpha, nullptr)) {
-          return -1;
-        }
-        vips_object_local(context, normalizedAlpha);
-        *out = normalizedAlpha;
       } else {
-        *out = normalized;
+        return normalized;
       }
-    } else {
-      // Cannot normalise zero-range image
-      *out = image;
     }
-    return 0;
+    return image;
   }
 
   /*
-   * Gaussian blur (use sigma <0 for fast blur)
+   * Gamma encoding/decoding
    */
-  int Blur(VipsObject *context, VipsImage *image, VipsImage **out, double sigma) {
+  VImage Gamma(VImage image, double const exponent) {
-    VipsImage *blurred;
+    if (HasAlpha(image)) {
-    if (sigma < 0.0) {
+      // Separate alpha channel
+      VImage alpha = image[image.bands() - 1];
+      return RemoveAlpha(image).gamma(VImage::option()->set("exponent", exponent)).bandjoin(alpha);
+    } else {
+      return image.gamma(VImage::option()->set("exponent", exponent));
+    }
+  }
+
+  /*
+   * Gaussian blur. Use sigma of -1.0 for fast blur.
+   */
+  VImage Blur(VImage image, double const sigma) {
+    if (sigma == -1.0) {
       // Fast, mild blur - averages neighbouring pixels
-      VipsImage *blur = vips_image_new_matrixv(3, 3,
+      VImage blur = VImage::new_matrixv(3, 3,
         1.0, 1.0, 1.0,
         1.0, 1.0, 1.0,
         1.0, 1.0, 1.0);
-      vips_image_set_double(blur, "scale", 9);
+      blur.set("scale", 9.0);
-      vips_object_local(context, blur);
+      return image.conv(blur);
-      if (vips_conv(image, &blurred, blur, nullptr)) {
-        return -1;
-      }
     } else {
       // Slower, accurate Gaussian blur
-      // Create Gaussian function for standard deviation
+      return image.gaussblur(sigma);
-      VipsImage *gaussian;
-      if (vips_gaussmat(&gaussian, sigma, 0.2, "separable", TRUE, "integer", TRUE, nullptr)) {
-        return -1;
     }
-      vips_object_local(context, gaussian);
-      // Apply Gaussian function
-      if (vips_convsep(image, &blurred, gaussian, "precision", VIPS_PRECISION_INTEGER, nullptr)) {
-        return -1;
-      }
-    }
-    vips_object_local(context, blurred);
-    *out = blurred;
-    return 0;
   }
 
   /*
-   * Sharpen flat and jagged areas. Use radius of -1 for fast sharpen.
+   * Convolution with a kernel.
    */
-  int Sharpen(VipsObject *context, VipsImage *image, VipsImage **out, int radius, double flat, double jagged) {
+  VImage Convolve(VImage image, int const width, int const height,
-    VipsImage *sharpened;
+    double const scale, double const offset,
-    if (radius == -1) {
+    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
-      VipsImage *sharpen = vips_image_new_matrixv(3, 3,
+      VImage sharpen = VImage::new_matrixv(3, 3,
         -1.0, -1.0, -1.0,
         -1.0, 32.0, -1.0,
         -1.0, -1.0, -1.0);
-      vips_image_set_double(sharpen, "scale", 24);
+      sharpen.set("scale", 24.0);
-      vips_object_local(context, sharpen);
+      return image.conv(sharpen);
-      if (vips_conv(image, &sharpened, sharpen, nullptr)) {
-        return -1;
-      }
     } else {
       // Slow, accurate sharpen in LAB colour space, with control over flat vs jagged areas
-      if (vips_sharpen(image, &sharpened, "radius", radius, "m1", flat, "m2", jagged, nullptr)) {
+      VipsInterpretation colourspaceBeforeSharpen = image.interpretation();
-        return -1;
+      if (colourspaceBeforeSharpen == VIPS_INTERPRETATION_RGB) {
+        colourspaceBeforeSharpen = VIPS_INTERPRETATION_sRGB;
       }
+      return image.sharpen(
+        VImage::option()->set("sigma", sigma)->set("m1", flat)->set("m2", jagged))
+        .colourspace(colourspaceBeforeSharpen);
     }
-    vips_object_local(context, sharpened);
-    *out = sharpened;
-    return 0;
   }
 
-  int Threshold(VipsObject *context, VipsImage *image, VipsImage **out, int threshold) {
+  VImage Threshold(VImage image, double const threshold, bool const thresholdGrayscale) {
-      VipsImage *greyscale;
+    if (!thresholdGrayscale) {
-      if (vips_colourspace(image, &greyscale, VIPS_INTERPRETATION_B_W, nullptr)) {
+      return image >= threshold;
-        return -1;
+    }
+    return image.colourspace(VIPS_INTERPRETATION_B_W) >= threshold;
   }
-      vips_object_local(context, greyscale);
-      image = greyscale;
 
-      VipsImage *thresholded;
+  /*
-      if (vips_moreeq_const1(image, &thresholded, threshold, nullptr)) {
+    Perform boolean/bitwise operation on image color channels - results in one channel image
-          return -1;
+  */
+  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);
+  }
+
+  /*
+   * Calculate (a * in + b)
+   */
+  VImage Linear(VImage image, double const a, double const b) {
+    if (HasAlpha(image)) {
+      // Separate alpha channel
+      VImage alpha = image[image.bands() - 1];
+      return RemoveAlpha(image).linear(a, b).bandjoin(alpha);
+    } else {
+      return image.linear(a, b);
     }
-      vips_object_local(context, thresholded);
-      *out = thresholded;
-      return 0;
   }
 }  // namespace sharp

src/operations.h

@@ -1,34 +1,112 @@
+// 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>
+
+using vips::VImage;
+
 namespace sharp {
 
   /*
-    Composite images `src` and `dst` with premultiplied alpha channel and output
+    Removes alpha channel, if any.
-    image with premultiplied alpha.
   */
-  int Composite(VipsObject *context, VipsImage *src, VipsImage *dst, VipsImage **out);
+  VImage RemoveAlpha(VImage image);
+
+  /*
+    Alpha composite src over dst with given gravity.
+    Assumes alpha channels are already premultiplied and will be unpremultiplied after.
+   */
+  VImage Composite(VImage src, VImage dst, const int gravity);
+
+  /*
+    Composite overlayImage over image at given position
+   */
+  VImage Composite(VImage image, VImage overlayImage, int const x, int const y);
+
+  /*
+    Alpha composite overlayImage over image, assumes matching dimensions
+  */
+  VImage AlphaComposite(VImage image, VImage overlayImage);
+
+  /*
+    Cutout src over dst with given gravity.
+  */
+  VImage Cutout(VImage src, VImage dst, const int gravity);
+
+  /*
+   * Tint an image using the specified chroma, preserving the original image luminance
+   */
+  VImage Tint(VImage image, double const a, double const b);
 
   /*
    * Stretch luminance to cover full dynamic range.
    */
-  int Normalize(VipsObject *context, VipsImage *image, VipsImage **out);
+  VImage Normalise(VImage image);
 
   /*
-   * Gaussian blur. Use sigma of -1 for fast blur.
+   * Gamma encoding/decoding
    */
-  int Blur(VipsObject *context, VipsImage *image, VipsImage **out, double sigma);
+  VImage Gamma(VImage image, double const exponent);
 
   /*
-   * Sharpen flat and jagged areas. Use radius of -1 for fast sharpen.
+   * Gaussian blur. Use sigma of -1.0 for fast blur.
    */
-  int Sharpen(VipsObject *context, VipsImage *image, VipsImage **out, int radius, double flat, double jagged);
+  VImage Blur(VImage image, double const sigma);
 
   /*
-   * Perform thresholding on an image.  If the image is not greyscale, will convert before thresholding.
+   * Convolution with a kernel.
-   * Pixels with a greyscale value greater-than-or-equal-to `threshold` will be pure white.  All others will be pure black.
    */
-  int Threshold(VipsObject *context, VipsImage *image, VipsImage **out, int threshold);
+  VImage Convolve(VImage image, int const width, int const height,
+    double const scale, double const offset, std::unique_ptr<double[]> const &kernel_v);
+
+  /*
+   * 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);
+
+  /*
+    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);
+
+  /*
+   * Linear adjustment (a * in + b)
+   */
+  VImage Linear(VImage image, double const a, double const b);
+
 }  // namespace sharp
 
 #endif  // SRC_OPERATIONS_H_

src/pipeline.h

@@ -1,8 +1,233 @@
+// 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 "nan.h"
+#include <memory>
+#include <string>
+#include <vector>
+
+#include <nan.h>
+#include <vips/vips8>
+
+#include "./common.h"
 
 NAN_METHOD(pipeline);
 
+enum class Canvas {
+  CROP,
+  EMBED,
+  MAX,
+  MIN,
+  IGNORE_ASPECT
+};
+
+struct PipelineBaton {
+  sharp::InputDescriptor *input;
+  std::string iccProfilePath;
+  int limitInputPixels;
+  std::string formatOut;
+  std::string fileOut;
+  void *bufferOut;
+  size_t bufferOutLength;
+  sharp::InputDescriptor *overlay;
+  int overlayGravity;
+  int overlayXOffset;
+  int overlayYOffset;
+  bool overlayTile;
+  bool overlayCutout;
+  std::vector<sharp::InputDescriptor *> joinChannelIn;
+  int topOffsetPre;
+  int leftOffsetPre;
+  int widthPre;
+  int heightPre;
+  int topOffsetPost;
+  int leftOffsetPost;
+  int widthPost;
+  int heightPost;
+  int width;
+  int height;
+  int channels;
+  Canvas canvas;
+  int crop;
+  int embed;
+  bool hasCropOffset;
+  int cropOffsetLeft;
+  int cropOffsetTop;
+  bool premultiplied;
+  std::string kernel;
+  bool fastShrinkOnLoad;
+  double background[4];
+  double tintA;
+  double tintB;
+  bool flatten;
+  bool negate;
+  double blurSigma;
+  int medianSize;
+  double sharpenSigma;
+  double sharpenFlat;
+  double sharpenJagged;
+  int threshold;
+  bool thresholdGrayscale;
+  int trimTolerance;
+  double linearA;
+  double linearB;
+  double gamma;
+  bool greyscale;
+  bool normalise;
+  bool useExifOrientation;
+  int angle;
+  bool rotateBeforePreExtract;
+  bool flip;
+  bool flop;
+  int extendTop;
+  int extendBottom;
+  int extendLeft;
+  int extendRight;
+  bool withoutEnlargement;
+  VipsAccess accessMethod;
+  int jpegQuality;
+  bool jpegProgressive;
+  std::string jpegChromaSubsampling;
+  bool jpegTrellisQuantisation;
+  int jpegQuantisationTable;
+  bool jpegOvershootDeringing;
+  bool jpegOptimiseScans;
+  bool jpegOptimiseCoding;
+  bool pngProgressive;
+  int pngCompressionLevel;
+  bool pngAdaptiveFiltering;
+  int webpQuality;
+  int webpAlphaQuality;
+  bool webpNearLossless;
+  bool webpLossless;
+  int tiffQuality;
+  VipsForeignTiffCompression tiffCompression;
+  VipsForeignTiffPredictor tiffPredictor;
+  bool tiffSquash;
+  double tiffXres;
+  double tiffYres;
+  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;
+  bool removeAlpha;
+  VipsInterpretation colourspace;
+  int tileSize;
+  int tileOverlap;
+  VipsForeignDzContainer tileContainer;
+  VipsForeignDzLayout tileLayout;
+  std::string tileFormat;
+  int tileAngle;
+  VipsForeignDzDepth tileDepth;
+
+  PipelineBaton():
+    input(nullptr),
+    limitInputPixels(0),
+    bufferOutLength(0),
+    overlay(nullptr),
+    overlayGravity(0),
+    overlayXOffset(-1),
+    overlayYOffset(-1),
+    overlayTile(false),
+    overlayCutout(false),
+    topOffsetPre(-1),
+    topOffsetPost(-1),
+    channels(0),
+    canvas(Canvas::CROP),
+    crop(0),
+    embed(0),
+    hasCropOffset(false),
+    cropOffsetLeft(0),
+    cropOffsetTop(0),
+    premultiplied(false),
+    tintA(128.0),
+    tintB(128.0),
+    flatten(false),
+    negate(false),
+    blurSigma(0.0),
+    medianSize(0),
+    sharpenSigma(0.0),
+    sharpenFlat(1.0),
+    sharpenJagged(2.0),
+    threshold(0),
+    thresholdGrayscale(true),
+    trimTolerance(0),
+    linearA(1.0),
+    linearB(0.0),
+    gamma(0.0),
+    greyscale(false),
+    normalise(false),
+    useExifOrientation(false),
+    angle(0),
+    flip(false),
+    flop(false),
+    extendTop(0),
+    extendBottom(0),
+    extendLeft(0),
+    extendRight(0),
+    withoutEnlargement(false),
+    jpegQuality(80),
+    jpegProgressive(false),
+    jpegChromaSubsampling("4:2:0"),
+    jpegTrellisQuantisation(false),
+    jpegQuantisationTable(0),
+    jpegOvershootDeringing(false),
+    jpegOptimiseScans(false),
+    jpegOptimiseCoding(true),
+    pngProgressive(false),
+    pngCompressionLevel(9),
+    pngAdaptiveFiltering(false),
+    webpQuality(80),
+    tiffQuality(80),
+    tiffCompression(VIPS_FOREIGN_TIFF_COMPRESSION_JPEG),
+    tiffPredictor(VIPS_FOREIGN_TIFF_PREDICTOR_HORIZONTAL),
+    tiffSquash(false),
+    tiffXres(1.0),
+    tiffYres(1.0),
+    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),
+    removeAlpha(false),
+    colourspace(VIPS_INTERPRETATION_LAST),
+    tileSize(256),
+    tileOverlap(0),
+    tileContainer(VIPS_FOREIGN_DZ_CONTAINER_FS),
+    tileLayout(VIPS_FOREIGN_DZ_LAYOUT_DZ),
+    tileAngle(0),
+    tileDepth(VIPS_FOREIGN_DZ_DEPTH_LAST){
+      background[0] = 0.0;
+      background[1] = 0.0;
+      background[2] = 0.0;
+      background[3] = 255.0;
+    }
+};
+
 #endif  // SRC_PIPELINE_H_

src/sharp.cc

@@ -1,19 +1,32 @@
-#include <node.h>
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-#include <vips/vips.h>
+//
+// 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"
 #include "pipeline.h"
 #include "utilities.h"
+#include "stats.h"
 
 NAN_MODULE_INIT(init) {
   vips_init("sharp");
 
-  // Set libvips operation cache limits
+  g_log_set_handler("VIPS", static_cast<GLogLevelFlags>(G_LOG_LEVEL_WARNING),
-  vips_cache_set_max_mem(100 * 1024 * 1024); // 100 MB
+    static_cast<GLogFunc>(sharp::VipsWarningCallback), nullptr);
-  vips_cache_set_max(500); // 500 operations
 
   // Methods available to JavaScript
   Nan::Set(target, Nan::New("metadata").ToLocalChecked(),
@@ -26,12 +39,16 @@ NAN_MODULE_INIT(init) {
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(concurrency)).ToLocalChecked());
   Nan::Set(target, Nan::New("counters").ToLocalChecked(),
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(counters)).ToLocalChecked());
+  Nan::Set(target, Nan::New("simd").ToLocalChecked(),
+    Nan::GetFunction(Nan::New<v8::FunctionTemplate>(simd)).ToLocalChecked());
   Nan::Set(target, Nan::New("libvipsVersion").ToLocalChecked(),
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(libvipsVersion)).ToLocalChecked());
   Nan::Set(target, Nan::New("format").ToLocalChecked(),
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(format)).ToLocalChecked());
   Nan::Set(target, Nan::New("_maxColourDistance").ToLocalChecked(),
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(_maxColourDistance)).ToLocalChecked());
+  Nan::Set(target, Nan::New("stats").ToLocalChecked(),
+    Nan::GetFunction(Nan::New<v8::FunctionTemplate>(stats)).ToLocalChecked());
 }
 
 NODE_MODULE(sharp, init)

src/stats.cc

@@ -0,0 +1,192 @@
+// 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 <numeric>
+#include <vector>
+#include <iostream>
+
+#include <node.h>
+#include <nan.h>
+#include <vips/vips8>
+
+#include "common.h"
+#include "stats.h"
+
+class StatsWorker : public Nan::AsyncWorker {
+ public:
+  StatsWorker(
+    Nan::Callback *callback, StatsBaton *baton, Nan::Callback *debuglog,
+    std::vector<v8::Local<v8::Object>> const buffersToPersist) :
+    Nan::AsyncWorker(callback, "sharp:StatsWorker"),
+    baton(baton), debuglog(debuglog),
+    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;
+      });
+  }
+  ~StatsWorker() {}
+
+  const int STAT_MIN_INDEX = 0;
+  const int STAT_MAX_INDEX = 1;
+  const int STAT_SUM_INDEX = 2;
+  const int STAT_SQ_SUM_INDEX = 3;
+  const int STAT_MEAN_INDEX = 4;
+  const int STAT_STDEV_INDEX = 5;
+  const int STAT_MINX_INDEX = 6;
+  const int STAT_MINY_INDEX = 7;
+  const int STAT_MAXX_INDEX = 8;
+  const int STAT_MAXY_INDEX = 9;
+
+  void Execute() {
+    // Decrement queued task counter
+    g_atomic_int_dec_and_test(&sharp::counterQueue);
+    using Nan::New;
+    using Nan::Set;
+    using sharp::MaximumImageAlpha;
+
+    vips::VImage image;
+    sharp::ImageType imageType = sharp::ImageType::UNKNOWN;
+
+    try {
+      std::tie(image, imageType) = OpenInput(baton->input, baton->accessMethod);
+    } catch (vips::VError const &err) {
+      (baton->err).append(err.what());
+    }
+    if (imageType != sharp::ImageType::UNKNOWN) {
+      try {
+        vips::VImage stats = image.stats();
+        int const bands = image.bands();
+        for (int b = 1; b <= bands; b++) {
+          ChannelStats cStats(static_cast<int>(stats.getpoint(STAT_MIN_INDEX, b).front()),
+                              static_cast<int>(stats.getpoint(STAT_MAX_INDEX, b).front()),
+                              stats.getpoint(STAT_SUM_INDEX, b).front(), stats.getpoint(STAT_SQ_SUM_INDEX, b).front(),
+                              stats.getpoint(STAT_MEAN_INDEX, b).front(), stats.getpoint(STAT_STDEV_INDEX, b).front(),
+                              static_cast<int>(stats.getpoint(STAT_MINX_INDEX, b).front()),
+                              static_cast<int>(stats.getpoint(STAT_MINY_INDEX, b).front()),
+                              static_cast<int>(stats.getpoint(STAT_MAXX_INDEX, b).front()),
+                              static_cast<int>(stats.getpoint(STAT_MAXY_INDEX, b).front()));
+          baton->channelStats.push_back(cStats);
+        }
+        // Image is not opaque when alpha layer is present and contains a non-mamixa value
+        if (sharp::HasAlpha(image)) {
+          double const minAlpha = static_cast<double>(stats.getpoint(STAT_MIN_INDEX, bands).front());
+          if (minAlpha != MaximumImageAlpha(image.interpretation())) {
+            baton->isOpaque = false;
+          }
+        }
+        // Estimate entropy via histogram of greyscale value frequency
+        baton->entropy = std::abs(image.colourspace(VIPS_INTERPRETATION_B_W)[0].hist_find().hist_entropy());
+      } catch (vips::VError const &err) {
+        (baton->err).append(err.what());
+      }
+    }
+
+    // Clean up
+    vips_error_clear();
+    vips_thread_shutdown();
+  }
+
+  void HandleOKCallback() {
+    using Nan::New;
+    using Nan::Set;
+    Nan::HandleScope();
+
+    v8::Local<v8::Value> argv[2] = { Nan::Null(), Nan::Null() };
+    if (!baton->err.empty()) {
+      argv[0] = Nan::Error(baton->err.data());
+    } else {
+      // Stats Object
+      v8::Local<v8::Object> info = New<v8::Object>();
+      v8::Local<v8::Array> channels = New<v8::Array>();
+
+      std::vector<ChannelStats>::iterator it;
+      int i = 0;
+      for (it=baton->channelStats.begin() ; it < baton->channelStats.end(); it++, i++) {
+        v8::Local<v8::Object> channelStat = New<v8::Object>();
+        Set(channelStat, New("min").ToLocalChecked(), New<v8::Number>(it->min));
+        Set(channelStat, New("max").ToLocalChecked(), New<v8::Number>(it->max));
+        Set(channelStat, New("sum").ToLocalChecked(), New<v8::Number>(it->sum));
+        Set(channelStat, New("squaresSum").ToLocalChecked(), New<v8::Number>(it->squaresSum));
+        Set(channelStat, New("mean").ToLocalChecked(), New<v8::Number>(it->mean));
+        Set(channelStat, New("stdev").ToLocalChecked(), New<v8::Number>(it->stdev));
+        Set(channelStat, New("minX").ToLocalChecked(), New<v8::Number>(it->minX));
+        Set(channelStat, New("minY").ToLocalChecked(), New<v8::Number>(it->minY));
+        Set(channelStat, New("maxX").ToLocalChecked(), New<v8::Number>(it->maxX));
+        Set(channelStat, New("maxY").ToLocalChecked(), New<v8::Number>(it->maxY));
+        channels->Set(i, channelStat);
+      }
+
+      Set(info, New("channels").ToLocalChecked(), channels);
+      Set(info, New("isOpaque").ToLocalChecked(), New<v8::Boolean>(baton->isOpaque));
+      Set(info, New("entropy").ToLocalChecked(), New<v8::Number>(baton->entropy));
+      argv[1] = info;
+    }
+
+    // Dispose of Persistent wrapper around input Buffers so they can be garbage collected
+    std::accumulate(buffersToPersist.begin(), buffersToPersist.end(), 0,
+      [this](uint32_t index, v8::Local<v8::Object> const buffer) -> uint32_t {
+        GetFromPersistent(index);
+        return index + 1;
+      });
+    delete baton->input;
+    delete baton;
+
+    // Handle warnings
+    std::string warning = sharp::VipsWarningPop();
+    while (!warning.empty()) {
+      v8::Local<v8::Value> message[1] = { New(warning).ToLocalChecked() };
+      debuglog->Call(1, message, async_resource);
+      warning = sharp::VipsWarningPop();
+    }
+
+    // Return to JavaScript
+    callback->Call(2, argv, async_resource);
+  }
+
+ private:
+  StatsBaton* baton;
+  Nan::Callback *debuglog;
+  std::vector<v8::Local<v8::Object>> buffersToPersist;
+};
+
+/*
+  stats(options, callback)
+*/
+NAN_METHOD(stats) {
+  using sharp::AttrTo;
+
+  // 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
+  StatsBaton *baton = new StatsBaton;
+  v8::Local<v8::Object> options = info[0].As<v8::Object>();
+
+  // Input
+  baton->input = sharp::CreateInputDescriptor(sharp::AttrAs<v8::Object>(options, "input"), buffersToPersist);
+  baton->accessMethod = AttrTo<bool>(options, "sequentialRead") ? VIPS_ACCESS_SEQUENTIAL : VIPS_ACCESS_RANDOM;
+
+  // Function to notify of libvips warnings
+  Nan::Callback *debuglog = new Nan::Callback(sharp::AttrAs<v8::Function>(options, "debuglog"));
+
+  // Join queue for worker thread
+  Nan::Callback *callback = new Nan::Callback(info[1].As<v8::Function>());
+  Nan::AsyncQueueWorker(new StatsWorker(callback, baton, debuglog, buffersToPersist));
+
+  // Increment queued task counter
+  g_atomic_int_inc(&sharp::counterQueue);
+}

src/stats.h

@@ -0,0 +1,67 @@
+// 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_STATS_H_
+#define SRC_STATS_H_
+
+#include <string>
+#include <nan.h>
+
+#include "./common.h"
+
+struct ChannelStats {
+  // stats per channel
+  int min;
+  int max;
+  double sum;
+  double squaresSum;
+  double mean;
+  double stdev;
+  int minX;
+  int minY;
+  int maxX;
+  int maxY;
+
+  ChannelStats():
+    min(0), max(0), sum(0), squaresSum(0), mean(0), stdev(0)
+    , minX(0), minY(0), maxX(0), maxY(0) {}
+
+    ChannelStats(int minVal, int maxVal, double sumVal, double squaresSumVal,
+                  double meanVal, double stdevVal, int minXVal, int minYVal, int maxXVal, int maxYVal):
+    min(minVal), max(maxVal), sum(sumVal), squaresSum(squaresSumVal),
+    mean(meanVal), stdev(stdevVal), minX(minXVal), minY(minYVal), maxX(maxXVal), maxY(maxYVal) {}
+};
+
+struct StatsBaton {
+  // Input
+  sharp::InputDescriptor *input;
+  VipsAccess accessMethod;
+
+  // Output
+  std::vector<ChannelStats> channelStats;
+  bool isOpaque;
+  double entropy;
+
+  std::string err;
+
+  StatsBaton():
+    input(nullptr),
+    isOpaque(true),
+    entropy(0.0)
+    {}
+};
+
+NAN_METHOD(stats);
+
+#endif  // SRC_STATS_H_

src/utilities.cc

@@ -1,8 +1,24 @@
-#include <cmath>
+// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
-#include <node.h>
+//
-#include <vips/vips.h>
+// 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 <cmath>
+#include <string>
+
+#include <node.h>
+#include <nan.h>
+#include <vips/vips8>
+#include <vips/vector.h>
 
 #include "common.h"
 #include "operations.h"
@@ -23,33 +39,46 @@ using Nan::To;
 using Nan::Utf8String;
 
 /*
-  Get and set cache memory and item limits
+  Get and set cache limits
 */
 NAN_METHOD(cache) {
   HandleScope();
 
-  // Set cache memory limit
+  // Set memory limit
   if (info[0]->IsInt32()) {
     vips_cache_set_max_mem(To<int32_t>(info[0]).FromJust() * 1048576);
   }
-
+  // Set file limit
-  // Set cache items limit
   if (info[1]->IsInt32()) {
-    vips_cache_set_max(To<int32_t>(info[1]).FromJust());
+    vips_cache_set_max_files(To<int32_t>(info[1]).FromJust());
+  }
+  // Set items limit
+  if (info[2]->IsInt32()) {
+    vips_cache_set_max(To<int32_t>(info[2]).FromJust());
   }
 
-  // Get cache statistics
+  // Get memory stats
+  Local<Object> memory = New<Object>();
+  Set(memory, New("current").ToLocalChecked(),
+    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))));
+  Set(memory, New("max").ToLocalChecked(),
+    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()));
+  Set(files, New("max").ToLocalChecked(), New<Integer>(vips_cache_get_max_files()));
+
+  // Get item stats
+  Local<Object> items = New<Object>();
+  Set(items, New("current").ToLocalChecked(), New<Integer>(vips_cache_get_size()));
+  Set(items, New("max").ToLocalChecked(), New<Integer>(vips_cache_get_max()));
+
   Local<Object> cache = New<Object>();
-  Set(cache, New("current").ToLocalChecked(),
+  Set(cache, New("memory").ToLocalChecked(), memory);
-    New<Integer>(static_cast<int>(round(vips_tracked_get_mem() / 1048576)))
+  Set(cache, New("files").ToLocalChecked(), files);
-  );
+  Set(cache, New("items").ToLocalChecked(), items);
-  Set(cache, New("high").ToLocalChecked(),
-    New<Integer>(static_cast<int>(round(vips_tracked_get_mem_highwater() / 1048576)))
-  );
-  Set(cache, New("memory").ToLocalChecked(),
-    New<Integer>(static_cast<int>(round(vips_cache_get_max_mem() / 1048576)))
-  );
-  Set(cache, New("items").ToLocalChecked(), New<Integer>(vips_cache_get_max()));
   info.GetReturnValue().Set(cache);
 }
 
@@ -81,6 +110,20 @@ NAN_METHOD(counters) {
   info.GetReturnValue().Set(counters);
 }
 
+/*
+  Get and set use of SIMD vector unit instructions
+*/
+NAN_METHOD(simd) {
+  HandleScope();
+
+  // Set state
+  if (info[0]->IsBoolean()) {
+    vips_vector_set_enabled(To<bool>(info[0]).FromJust());
+  }
+  // Get state
+  info.GetReturnValue().Set(New<Boolean>(vips_vector_isenabled()));
+}
+
 /*
   Get libvips version
 */
@@ -107,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()));
@@ -141,19 +186,17 @@ NAN_METHOD(format) {
   Local<String> rawId = New("raw").ToLocalChecked();
   Set(raw, attrId, rawId);
   Set(format, rawId, raw);
-  // No support for raw input yet, so always false
+  Local<Boolean> supported = New<Boolean>(true);
   Local<Boolean> unsupported = New<Boolean>(false);
   Local<Object> rawInput = New<Object>();
   Set(rawInput, attrFile, unsupported);
-  Set(rawInput, attrBuffer, unsupported);
+  Set(rawInput, attrBuffer, supported);
-  Set(rawInput, attrStream, unsupported);
+  Set(rawInput, attrStream, supported);
   Set(raw, attrInput, rawInput);
-  // Raw output via Buffer/Stream is available in libvips >= 7.42.0
-  Local<Boolean> hasOutputBufferRaw = New<Boolean>(vips_version(0) >= 8 || (vips_version(0) == 7 && vips_version(1) >= 42));
   Local<Object> rawOutput = New<Object>();
   Set(rawOutput, attrFile, unsupported);
-  Set(rawOutput, attrBuffer, hasOutputBufferRaw);
+  Set(rawOutput, attrBuffer, supported);
-  Set(rawOutput, attrStream, hasOutputBufferRaw);
+  Set(rawOutput, attrStream, supported);
   Set(raw, attrOutput, rawOutput);
 
   info.GetReturnValue().Set(format);
@@ -165,101 +208,64 @@ NAN_METHOD(format) {
   between two images of the same dimensions and number of channels.
 */
 NAN_METHOD(_maxColourDistance) {
+  using vips::VImage;
+  using vips::VError;
   using sharp::DetermineImageType;
   using sharp::ImageType;
-  using sharp::InitImage;
   using sharp::HasAlpha;
 
   HandleScope();
 
-  // Create "hook" VipsObject to hang image references from
-  VipsObject *hook = reinterpret_cast<VipsObject*>(vips_image_new());
-
   // Open input files
-  VipsImage *image1 = nullptr;
+  VImage image1;
   ImageType imageType1 = DetermineImageType(*Utf8String(info[0]));
   if (imageType1 != ImageType::UNKNOWN) {
-    image1 = InitImage(*Utf8String(info[0]), VIPS_ACCESS_SEQUENTIAL);
+    try {
-    if (image1 == nullptr) {
+      image1 = VImage::new_from_file(*Utf8String(info[0]));
-      g_object_unref(hook);
+    } catch (...) {
       return ThrowError("Input file 1 has corrupt header");
-    } else {
-      vips_object_local(hook, image1);
     }
   } else {
-    g_object_unref(hook);
     return ThrowError("Input file 1 is of an unsupported image format");
   }
-  VipsImage *image2 = nullptr;
+  VImage image2;
   ImageType imageType2 = DetermineImageType(*Utf8String(info[1]));
   if (imageType2 != ImageType::UNKNOWN) {
-    image2 = InitImage(*Utf8String(info[1]), VIPS_ACCESS_SEQUENTIAL);
+    try {
-    if (image2 == nullptr) {
+      image2 = VImage::new_from_file(*Utf8String(info[1]));
-      g_object_unref(hook);
+    } catch (...) {
       return ThrowError("Input file 2 has corrupt header");
-    } else {
-      vips_object_local(hook, image2);
     }
   } else {
-    g_object_unref(hook);
     return ThrowError("Input file 2 is of an unsupported image format");
   }
-
   // Ensure same number of channels
-  if (image1->Bands != image2->Bands) {
+  if (image1.bands() != image2.bands()) {
-    g_object_unref(hook);
     return ThrowError("mismatchedBands");
   }
   // Ensure same dimensions
-  if (image1->Xsize != image2->Xsize || image1->Ysize != image2->Ysize) {
+  if (image1.width() != image2.width() || image1.height() != image2.height()) {
-    g_object_unref(hook);
     return ThrowError("mismatchedDimensions");
   }
 
+  double maxColourDistance;
+  try {
     // Premultiply and remove alpha
     if (HasAlpha(image1)) {
-    VipsImage *imagePremultiplied1;
+      image1 = image1.premultiply().extract_band(1, VImage::option()->set("n", image1.bands() - 1));
-    if (vips_premultiply(image1, &imagePremultiplied1, nullptr)) {
-      g_object_unref(hook);
-      return ThrowError(vips_error_buffer());
-    }
-    vips_object_local(hook, imagePremultiplied1);
-    VipsImage *imagePremultipliedNoAlpha1;
-    if (vips_extract_band(image1, &imagePremultipliedNoAlpha1, 1, "n", image1->Bands - 1, nullptr)) {
-      g_object_unref(hook);
-      return ThrowError(vips_error_buffer());
-    }
-    vips_object_local(hook, imagePremultipliedNoAlpha1);
-    image1 = imagePremultipliedNoAlpha1;
     }
     if (HasAlpha(image2)) {
-    VipsImage *imagePremultiplied2;
+      image2 = image2.premultiply().extract_band(1, VImage::option()->set("n", image2.bands() - 1));
-    if (vips_premultiply(image2, &imagePremultiplied2, nullptr)) {
-      g_object_unref(hook);
-      return ThrowError(vips_error_buffer());
-    }
-    vips_object_local(hook, imagePremultiplied2);
-    VipsImage *imagePremultipliedNoAlpha2;
-    if (vips_extract_band(image2, &imagePremultipliedNoAlpha2, 1, "n", image2->Bands - 1, nullptr)) {
-      g_object_unref(hook);
-      return ThrowError(vips_error_buffer());
-    }
-    vips_object_local(hook, imagePremultipliedNoAlpha2);
-    image2 = imagePremultipliedNoAlpha2;
     }
     // Calculate colour distance
-  VipsImage *difference;
+    maxColourDistance = image1.dE00(image2).max();
-  if (vips_dE00(image1, image2, &difference, nullptr)) {
+  } catch (VError err) {
-    g_object_unref(hook);
+    return ThrowError(err.what());
-    return ThrowError(vips_error_buffer());
   }
-  vips_object_local(hook, difference);
+
-  // Extract maximum distance
+  // Clean up libvips' per-request data and threads
-  double maxColourDistance;
+  vips_error_clear();
-  if (vips_max(difference, &maxColourDistance, nullptr)) {
+  vips_thread_shutdown();
-    g_object_unref(hook);
+
-    return ThrowError(vips_error_buffer());
-  }
-  g_object_unref(hook);
   info.GetReturnValue().Set(New<Number>(maxColourDistance));
 }

src/utilities.h

@@ -1,11 +1,26 @@
+// 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);
 NAN_METHOD(counters);
+NAN_METHOD(simd);
 NAN_METHOD(libvipsVersion);
 NAN_METHOD(format);
 NAN_METHOD(_maxColourDistance);

test/bench/package.json

@@ -8,17 +8,19 @@
     "test": "node perf && node random && node parallel"
   },
   "devDependencies": {
-    "async": "^1.5.0",
+    "async": "^2.6.0",
-    "benchmark": "^1.0.0",
+    "benchmark": "^2.1.4",
-    "gm": "^1.21.0",
+    "gm": "^1.23.1",
     "imagemagick": "^0.1.3",
-    "imagemagick-native": "elad/node-imagemagick-native",
+    "imagemagick-native": "^1.9.3",
-    "jimp": "^0.2.19",
+    "images": "^3.0.1",
-    "lwip": "^0.0.8",
+    "jimp": "^0.2.28",
-    "semver": "^5.1.0"
+    "mapnik": "^3.6.2",
+    "pajk-lwip": "^0.2.0",
+    "semver": "^5.4.1"
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=0.10"
+    "node": ">=4"
   }
 }

test/bench/parallel.js

@@ -2,23 +2,24 @@
 
 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) {
-  var start = new Date().getTime();
+  const start = new Date().getTime();
   async.times(parallelism,
     function (id, callback) {
       /* jslint unused: false */
@@ -30,7 +31,8 @@ async.mapSeries([1, 1, 2, 4, 8, 16, 32, 64], function(parallelism, next) {
     function (err, ids) {
       assert(!err);
       assert(ids.length === parallelism);
-      var mean = ids.reduce(function(a, b) {
+      ids.sort();
+      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');

test/bench/random.js

@@ -1,21 +1,21 @@
 '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');
 
-var min = 320;
+sharp.cache(false);
-var max = 960;
+sharp.simd(true);
 
-// Nearest equivalent to bilinear
+const min = 320;
-var magickFilter = 'Triangle';
+const max = 960;
 
-var randomDimension = function() {
+const randomDimension = function () {
-  return Math.ceil(Math.random() * (max - min) + min);
+  return Math.ceil((Math.random() * (max - min)) + min);
 };
 
 new Benchmark.Suite('random').add('imagemagick', {
@@ -28,7 +28,7 @@ new Benchmark.Suite('random').add('imagemagick', {
       width: randomDimension(),
       height: randomDimension(),
       format: 'jpg',
-      filter: magickFilter
+      filter: 'Lanczos'
     }, function (err) {
       if (err) {
         throw err;
@@ -42,7 +42,7 @@ new Benchmark.Suite('random').add('imagemagick', {
   fn: function (deferred) {
     gm(fixtures.inputJpg)
       .resize(randomDimension(), randomDimension())
-      .filter(magickFilter)
+      .filter('Lanczos')
       .quality(80)
       .toBuffer(function (err, buffer) {
         if (err) {
@@ -56,7 +56,9 @@ new Benchmark.Suite('random').add('imagemagick', {
 }).add('sharp', {
   defer: true,
   fn: function (deferred) {
-    sharp(fixtures.inputJpg).resize(randomDimension(), randomDimension()).toBuffer(function(err, buffer) {
+    sharp(fixtures.inputJpg)
+      .resize(randomDimension(), randomDimension())
+      .toBuffer(function (err, buffer) {
         if (err) {
           throw err;
         } else {
@@ -68,7 +70,6 @@ new Benchmark.Suite('random').add('imagemagick', {
 }).on('cycle', function (event) {
   console.log(String(event.target));
 }).on('complete', function () {
-  var winner = this.filter('fastest').pluck('name');
+  const winner = this.filter('fastest').map('name');
   assert.strictEqual('sharp', String(winner), 'sharp was slower than ' + winner);
-  console.dir(sharp.cache());
 }).run();

test/coverage/report.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+CPPFLAGS="--coverage" LDFLAGS="--coverage" npm rebuild
+npm test
+geninfo --no-external --base-directory src --output-file coverage/sharp.info build/Release/obj.target/sharp/src
+genhtml --title sharp --demangle-cpp --output-directory coverage/sharp coverage/*.info

test/fixtures/Wikimedia-logo.svg

@@ -1,17 +0,0 @@
-<?xml version="1.0" standalone="yes"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1"
-   id="Wikimedia logo"
-   viewBox="-599 -599 1198 1198" width="1024" height="1024">
-<defs>
-  <clipPath id="mask">
-    <path d="M 47.5,-87.5 v 425 h -95 v -425 l -552,-552 v 1250 h 1199 v -1250 z" />
-  </clipPath>
-</defs>
-<g clip-path="url(#mask)">
-  <circle id="green parts" fill="#396" r="336.5"/>
-  <circle id="blue arc" fill="none" stroke="#069" r="480.25" stroke-width="135.5" />
-</g>
-<circle fill="#900" cy="-379.5" r="184.5" id="red circle"/>
-</svg>

test/fixtures/check.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+      <path d="M30,76q6-14,13-26q6-12,14-23q8-12,13-17q3-4,6-6q1-1,5-2q8-1,12-1q1,0,1,1q0,1-1,2q-13,11-27,33q-14,21-24,44q-4,9-5,11q-1,2-9,2q-5,0-6-1q-1-1-5-6q-5-8-12-15q-3-4-3-6q0-2,4-5q3-2,6-2q3,0,8,3q5,4,10,14z" fill="green" />
+</svg>