Release v0.23.3

Real-world code will register a catch handler

.cirrus.yml

@@ -0,0 +1,13 @@
+freebsd_instance:
+  image_family: freebsd-12-0
+
+task:
+  prerequisites_script:
+    - sed -i '' 's/quarterly/latest/g' /etc/pkg/FreeBSD.conf
+    - pkg update -f
+    - pkg upgrade -y
+    - pkg install -y pkgconf vips libnghttp2 node npm
+  install_script:
+    - npm install --unsafe-perm
+  test_script:
+    - npm test

.gitattributes

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

.github/CONTRIBUTING.md

@@ -12,9 +12,12 @@ New bugs are assigned a `triage` label whilst under investigation.
 
 ## Submit a new feature request
 
-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.
+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://libvips.github.io/libvips/API/current/func-list.html)
+the feature you need.
 
 ## Submit a Pull Request to fix a bug
 
@@ -41,18 +44,18 @@ Any change that modifies the existing public API should be added to the relevant
 
 | Release | WIP branch |
 | ------: | :--------- |
-| v0.18.0 | ridge      |
+| v0.24.0 | wit        |
-| v0.19.0 | suit       |
+| v0.25.0 | yield      |
 
 Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
 
 ### Add a new public method
 
-The API tries to be as fluent as possible. Image processing concepts follow the naming conventions from _libvips_ and, to a lesser extent, _ImageMagick_.
+The API tries to be as fluent as possible.
+Image processing concepts follow the naming conventions from libvips and, to a lesser extent, ImageMagick.
 
-Most methods have optional parameters and assume sensible defaults. Methods with mandatory parameters often have names like `doSomethingWith(X)`.
+Most methods have optional parameters and assume sensible defaults.
-
+Please ensure backwards compatibility where possible.
-Please ensure backwards compatibility where possible. Methods to modify previously default behaviour often have names like `withoutOptionY()` or `withExtraZ()`.
 
 Feel free to create a [new issue](https://github.com/lovell/sharp/issues/new) to gather feedback on a potential API change.
 
@@ -60,7 +63,7 @@ Feel free to create a [new issue](https://github.com/lovell/sharp/issues/new) to
 
 A method to be removed should be deprecated in the next major version then removed in the following major version.
 
-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.
+By way of example, the `background()` method present in v0.20.0 was deprecated in v0.21.0 and removed in v0.22.0.
 
 ## Documentation
 
@@ -89,20 +92,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).
 
 If you're unable to post details publicly, please
-[e-mail](https://github.com/lovell/sharp/blob/master/package.json#L4)
+[e-mail](https://github.com/lovell/sharp/blob/master/package.json#L5)
 for private, paid consulting.

.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: libvips

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Suggest an idea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+What are you trying to achieve?
+
+Have you searched for similar feature requests?
+
+What would you expect the API to look like?
+
+What alternatives have you considered?
+
+Is there a sample image that helps explain?

.github/ISSUE_TEMPLATE/installation.md

@@ -0,0 +1,18 @@
+---
+name: Installation
+about: Something went wrong **installing** sharp
+title: ''
+labels: installation
+assignees: ''
+
+---
+
+Did you see the [documentation relating to installation](https://sharp.pixelplumbing.com/en/stable/install/)?
+
+Have you ensured the platform and version of Node.js used for `npm install` is the same as the platform and version of Node.js used at runtime?
+
+If you are installing as a `root` or `sudo` user, have you tried with the `npm install --unsafe-perm` flag?
+
+What is the complete output of running `npm install --verbose sharp`? Have you checked this output for useful error messages?
+
+What is the output of running `npx envinfo --binaries --languages --system --utilities`?

.github/ISSUE_TEMPLATE/possible-bug.md

@@ -0,0 +1,20 @@
+---
+name: Possible bug
+about: Something unexpected occurred **using** sharp
+title: ''
+labels: triage
+assignees: ''
+
+---
+
+<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
+
+What is the output of running `npx envinfo --binaries --languages --system --utilities`?
+
+What are the steps to reproduce?
+
+What is the expected behaviour?
+
+Are you able to provide a standalone code sample, without other dependencies, that demonstrates this problem?
+
+Are you able to provide a sample image that helps explain the problem?

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,18 @@
+---
+name: Question
+about: For help understanding an existing feature
+title: ''
+labels: question
+assignees: ''
+
+---
+
+<!-- If this issue relates to installation, please use https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md instead. -->
+
+What are you trying to achieve?
+
+Have you searched for similar questions?
+
+Are you able to provide a standalone code sample that demonstrates this question?
+
+Are you able to provide a sample image that helps explain the question?

.gitignore

@@ -1,6 +1,6 @@
 build
 node_modules
-coverage
+/coverage
 test/bench/node_modules
 test/fixtures/output*
 test/leak/libvips.supp
@@ -9,8 +9,9 @@ test/saliency/Image*
 test/saliency/[Uu]serData*
 !test/saliency/userData.js
 vendor
-packaging/libvips*
+.gitattributes
-packaging/*.log
-!packaging/build
 .DS_Store
 .nyc_output
+.vscode/
+package-lock.json
+.idea

.npmignore

@@ -1,14 +0,0 @@
-build
-node_modules
-coverage
-.editorconfig
-.gitignore
-test
-.travis.yml
-appveyor.yml
-circle.yml
-mkdocs.yml
-vendor
-packaging
-preinstall.sh
-.nyc_output

.prebuildrc

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

.travis.yml

@@ -1,21 +1,91 @@
-language: node_js
+matrix:
-node_js:
+  include:
-  - "4"
+    - name: "Linux (glibc) - Node 8"
-  - "6"
+      os: linux
-  - "7"
+      dist: trusty
-os:
+      sudo: false
-  - linux
+      language: node_js
-  - osx
+      node_js: "8"
-sudo: false
+    - name: "Linux (glibc) - Node 10"
-addons:
+      os: linux
-  apt:
+      dist: trusty
-    sources:
+      sudo: false
-    - ubuntu-toolchain-r-test
+      language: node_js
-    packages:
+      node_js: "10"
-    - g++-4.8
+    - name: "Linux (glibc) - Node 12"
-osx_image: xcode8
+      os: linux
-before_install:
+      dist: trusty
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then export CXX=g++-4.8; fi
+      sudo: false
-after_success:
+      language: node_js
-  - npm install coveralls
+      node_js: "12"
-  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
+    - name: "Linux (glibc) - Node 13"
+      os: linux
+      dist: trusty
+      sudo: false
+      language: node_js
+      node_js: "13"
+      after_success:
+        - npm install coveralls
+        - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
+    - name: "Linux (musl) - Node 8"
+      os: linux
+      dist: trusty
+      sudo: true
+      language: minimal
+      before_install:
+        - sudo docker run -dit --name sharp --env CI --env PREBUILD_TOKEN --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:8-alpine
+        - sudo docker exec sharp apk add build-base git python2 --update-cache
+      install: sudo docker exec sharp sh -c "npm install --unsafe-perm"
+      script: sudo docker exec sharp sh -c "npm test"
+    - name: "Linux (musl) - Node 10"
+      os: linux
+      dist: trusty
+      sudo: true
+      language: minimal
+      before_install:
+        - sudo docker run -dit --name sharp --env CI --env PREBUILD_TOKEN --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:10-alpine
+        - sudo docker exec sharp apk add build-base git python2 --update-cache
+      install: sudo docker exec sharp sh -c "npm install --unsafe-perm"
+      script: sudo docker exec sharp sh -c "npm test"
+    - name: "Linux (musl) - Node 12"
+      os: linux
+      dist: trusty
+      sudo: true
+      language: minimal
+      before_install:
+        - sudo docker run -dit --name sharp --env CI --env PREBUILD_TOKEN --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:12.0-alpine
+        - sudo docker exec sharp apk add build-base git python2 --update-cache
+      install: sudo docker exec sharp sh -c "npm install --unsafe-perm"
+      script: sudo docker exec sharp sh -c "npm test"
+    - name: "Linux (musl) - Node 13"
+      os: linux
+      dist: trusty
+      sudo: true
+      language: minimal
+      before_install:
+        - sudo docker run -dit --name sharp --env CI --env PREBUILD_TOKEN --volume "${PWD}:/mnt/sharp" --workdir /mnt/sharp node:13.0-alpine
+        - sudo docker exec sharp apk add build-base git python2 --update-cache
+      install: sudo docker exec sharp sh -c "npm install --unsafe-perm"
+      script: sudo docker exec sharp sh -c "npm test"
+    - name: "OS X - Node 8"
+      os: osx
+      osx_image: xcode9.2
+      language: node_js
+      node_js: "8"
+    - name: "OS X - Node 10"
+      os: osx
+      osx_image: xcode9.2
+      language: node_js
+      node_js: "10"
+    - name: "OS X - Node 12"
+      os: osx
+      osx_image: xcode9.2
+      language: node_js
+      node_js: "12"
+    - name: "OS X - Node 13"
+      os: osx
+      osx_image: xcode10
+      language: node_js
+      node_js: "13"
+cache:
+  npm: false

README.md

@@ -1,5 +1,7 @@
 # sharp
 
+<img src="https://raw.githubusercontent.com/lovell/sharp/master/docs/image/sharp-logo.svg?sanitize=true" width="160" height="160" alt="sharp logo" align="right">
+
 ```sh
 npm install sharp
 ```
@@ -9,7 +11,8 @@ 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-5x faster than using the
-quickest ImageMagick and GraphicsMagick settings.
+quickest ImageMagick and GraphicsMagick settings
+due to its use of [libvips](https://github.com/libvips/libvips).
 
 Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
 Lanczos resampling ensures quality is not sacrificed for speed.
@@ -17,39 +20,64 @@ 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.
 
-OS X, Windows (x64), Linux (x64, ARM) systems do not require
+Most modern 64-bit OS X, Windows and Linux systems running
-the installation of any external runtime dependencies.
+Node versions 8, 10, 12 and 13
+do not require any additional install or runtime dependencies.
 
 ## Examples
 
 ```javascript
-import sharp from 'sharp';
+const sharp = require('sharp');
 ```
 
+### Callback
+
 ```javascript
 sharp(inputBuffer)
   .resize(320, 240)
-  .toFile('output.webp', (err, info) => ... );
+  .toFile('output.webp', (err, info) => { ... });
 ```
 
+### Promise
+
 ```javascript
 sharp('input.jpg')
   .rotate()
   .resize(200)
   .toBuffer()
-  .then( data => ... )
+  .then( data => { ... })
-  .catch( err => ... );
+  .catch( err => { ... });
 ```
 
+### Async/await
+
 ```javascript
-const roundedCorners = new Buffer(
+const semiTransparentRedPng = await sharp({
+  create: {
+    width: 48,
+    height: 48,
+    channels: 4,
+    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
+  }
+})
+  .png()
+  .toBuffer();
+```
+
+### Stream
+
+```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 })
+    .composite([{
+      input: roundedCorners,
+      blend: 'dest-in'
+    }])
     .png();
 
 readableStream
@@ -57,29 +85,29 @@ readableStream
   .pipe(writableStream);
 ```
 
-[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
+[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.svg?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](https://sharp.pixelplumbing.com/) for complete
-[installation instructions](http://sharp.dimens.io/page/install),
+[installation instructions](https://sharp.pixelplumbing.com/page/install),
-[API documentation](http://sharp.dimens.io/page/api),
+[API documentation](https://sharp.pixelplumbing.com/page/api),
-[benchmark tests](http://sharp.dimens.io/page/performance) and
+[benchmark tests](https://sharp.pixelplumbing.com/page/performance) and
-[changelog](http://sharp.dimens.io/page/changelog).
+[changelog](https://sharp.pixelplumbing.com/page/changelog).
 
 ### Contributing
 
-A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
+A [guide for contributors](https://github.com/lovell/sharp/blob/master/.github/CONTRIBUTING.md)
 covers reporting bugs, requesting features and submitting code changes.
 
-### Licence
+### Licensing
 
-Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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](http://www.apache.org/licenses/LICENSE-2.0.html)
+[https://www.apache.org/licenses/LICENSE-2.0](https://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,

appveyor.yml

@@ -4,12 +4,13 @@ build: off
 platform: x64
 environment:
   matrix:
-  - nodejs_version: "4"
+  - nodejs_version: "8"
-  - nodejs_version: "6"
+  - nodejs_version: "10"
-  - nodejs_version: "7"
+  - nodejs_version: "12"
+  - nodejs_version: "13"
 install:
-  - ps: Install-Product node $env:nodejs_version x64
+  - ps: Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version) x64
-  - npm install -g npm@latest
+  - npm install -g npm@6
   - npm install
 test_script:
   - npm test

binding.gyp

@@ -5,9 +5,6 @@
       ['OS == "win"', {
         # Build libvips C++ binding for Windows due to MSVC std library ABI changes
         'type': 'shared_library',
-        'variables': {
-          'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
-        },
         'defines': [
           'VIPS_CPLUSPLUS_EXPORTS',
           '_ALLOW_KEYWORD_MACROS'
@@ -49,43 +46,22 @@
     'dependencies': [
       'libvips-cpp'
     ],
-    # Nested variables "pattern" borrowed from http://src.chromium.org/viewvc/chrome/trunk/src/build/common.gypi
     'variables': {
-      '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': ''
-            }]
-          ],
-        },
-        '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-cpp 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',
@@ -95,7 +71,7 @@
       '<!(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-only-I vips-cpp vips glib-2.0 | sed s\/-I//g)'],
         'conditions': [
@@ -112,7 +88,7 @@
           }]
         ]
       }, {
-        # Attempt to download pre-built libvips and install locally within node_modules
+        # Use pre-built libvips stored locally within node_modules
         'include_dirs': [
           'vendor/include',
           'vendor/include/glib-2.0',
@@ -121,7 +97,8 @@
         'conditions': [
           ['OS == "win"', {
             'defines': [
-              '_ALLOW_KEYWORD_MACROS'
+              '_ALLOW_KEYWORD_MACROS',
+              '_FILE_OFFSET_BITS=64'
             ],
             'libraries': [
               '../vendor/lib/libvips.lib',
@@ -130,9 +107,6 @@
             ]
           }],
           ['OS == "mac"', {
-            'variables': {
-              'download_vips': '<!(node -e "require(\'./binding\').download_vips()")'
-            },
             'libraries': [
               '../vendor/lib/libvips-cpp.42.dylib',
               '../vendor/lib/libvips.42.dylib',
@@ -143,9 +117,6 @@
             ]
           }],
           ['OS == "linux"', {
-            'variables': {
-              'download_vips': '<!(LDD_VERSION="<!(ldd --version 2>&1 || true)" node -e "require(\'./binding\').download_vips()")'
-            },
             'defines': [
               '_GLIBCXX_USE_CXX11_ABI=0'
             ],
@@ -158,9 +129,11 @@
               '../vendor/lib/libcairo.so',
               '../vendor/lib/libcroco-0.6.so',
               '../vendor/lib/libexif.so',
+              '../vendor/lib/libexpat.so',
               '../vendor/lib/libffi.so',
               '../vendor/lib/libfontconfig.so',
               '../vendor/lib/libfreetype.so',
+              '../vendor/lib/libfribidi.so',
               '../vendor/lib/libgdk_pixbuf-2.0.so',
               '../vendor/lib/libgif.so',
               '../vendor/lib/libgio-2.0.so',
@@ -179,6 +152,8 @@
               '../vendor/lib/librsvg-2.so',
               '../vendor/lib/libtiff.so',
               '../vendor/lib/libwebp.so',
+              '../vendor/lib/libwebpdemux.so',
+              '../vendor/lib/libwebpmux.so',
               '../vendor/lib/libxml2.so',
               '../vendor/lib/libz.so',
               # Ensure runtime linking is relative to sharp.node
@@ -208,71 +183,24 @@
     },
     'configurations': {
       'Release': {
-        'msvs_settings': {
+        'conditions': [
-          'VCCLCompilerTool': {
+          ['OS == "linux"', {
-            'ExceptionHandling': 1
+            'cflags_cc': [
-          }
+              '-Wno-cast-function-type'
-        },
+            ]
-        'msvs_disabled_warnings': [
+          }],
-          4275
+          ['OS == "win"', {
+            'msvs_settings': {
+              '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': 'build/Release',
-          'files': [
-            'vendor/lib/GNU.Gettext.dll',
-            'vendor/lib/libasprintf-0.dll',
-            'vendor/lib/libcairo-2.dll',
-            'vendor/lib/libcairo-gobject-2.dll',
-            'vendor/lib/libcairo-script-interpreter-2.dll',
-            'vendor/lib/libcharset-1.dll',
-            'vendor/lib/libcroco-0.6-3.dll',
-            'vendor/lib/libexif-12.dll',
-            'vendor/lib/libexpat-1.dll',
-            'vendor/lib/libffi-6.dll',
-            'vendor/lib/libfftw3-3.dll',
-            'vendor/lib/libfontconfig-1.dll',
-            'vendor/lib/libfreetype-6.dll',
-            'vendor/lib/libgcc_s_seh-1.dll',
-            'vendor/lib/libgdk_pixbuf-2.0-0.dll',
-            'vendor/lib/libgif-7.dll',
-            'vendor/lib/libgio-2.0-0.dll',
-            'vendor/lib/libglib-2.0-0.dll',
-            'vendor/lib/libgmodule-2.0-0.dll',
-            'vendor/lib/libgobject-2.0-0.dll',
-            'vendor/lib/libgsf-1-114.dll',
-            'vendor/lib/libgthread-2.0-0.dll',
-            'vendor/lib/libiconv-2.dll',
-            'vendor/lib/libintl-8.dll',
-            'vendor/lib/libjpeg-62.dll',
-            'vendor/lib/liblcms2-2.dll',
-            'vendor/lib/libpango-1.0-0.dll',
-            'vendor/lib/libpangocairo-1.0-0.dll',
-            'vendor/lib/libpangowin32-1.0-0.dll',
-            'vendor/lib/libpixman-1-0.dll',
-            'vendor/lib/libpng16-16.dll',
-            'vendor/lib/libquadmath-0.dll',
-            'vendor/lib/librsvg-2-2.dll',
-            'vendor/lib/libssp-0.dll',
-            'vendor/lib/libstdc++-6.dll',
-            'vendor/lib/libtiff-5.dll',
-            'vendor/lib/libvips-42.dll',
-            'vendor/lib/libwebp-6.dll',
-            'vendor/lib/libxml2-2.dll',
-            'vendor/lib/zlib1.dll'
-          ]
-        }]
-      }]
-    ]
   }]
 }

binding.js

@@ -1,129 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const zlib = require('zlib');
-
-const caw = require('caw');
-const got = require('got');
-const semver = require('semver');
-const tar = require('tar');
-
-const distBaseUrl = 'https://dl.bintray.com/lovell/sharp/';
-
-// Use NPM-provided environment variable where available, falling back to require-based method for Electron
-const minimumLibvipsVersion = process.env.npm_package_config_libvips || require('./package.json').config.libvips;
-
-const platform = process.env.npm_config_platform || process.platform;
-
-const arch = process.env.npm_config_arch || process.arch;
-
-// -- Helpers
-
-// Does this file exist?
-const isFile = function (file) {
-  try {
-    return fs.statSync(file).isFile();
-  } catch (err) {}
-};
-
-const unpack = function (tarPath, done) {
-  const extractor = tar.Extract({ path: path.join(__dirname, 'vendor') });
-  if (done) {
-    extractor.on('end', done);
-  }
-  extractor.on('error', error);
-  fs.createReadStream(tarPath)
-    .on('error', error)
-    .pipe(zlib.Unzip())
-    .pipe(extractor);
-};
-
-const platformId = function () {
-  const platformId = [platform];
-  if (arch === 'arm' || arch === 'armhf' || arch === 'arch64') {
-    const armVersion = (arch === 'arch64') ? '8' : process.env.npm_config_armv || process.config.variables.arm_version || '6';
-    platformId.push('armv' + armVersion);
-  } else {
-    platformId.push(arch);
-  }
-  return platformId.join('-');
-};
-
-// Error
-const 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?
-  const vipsHeaderPath = path.join(__dirname, 'vendor', 'include', 'vips', 'vips.h');
-  if (!isFile(vipsHeaderPath)) {
-    // Ensure Intel 64-bit or ARM
-    if (arch === 'ia32') {
-      error('Intel Architecture 32-bit systems require manual installation - please see http://sharp.dimens.io/en/stable/install/');
-    }
-    // Ensure glibc >= 2.15
-    const lddVersion = process.env.LDD_VERSION;
-    if (lddVersion) {
-      if (/(glibc|gnu libc)/i.test(lddVersion)) {
-        const glibcVersion = lddVersion ? lddVersion.split(/\n/)[0].split(' ').slice(-1)[0].trim() : '';
-        if (glibcVersion && semver.lt(glibcVersion + '.0', '2.13.0')) {
-          error('glibc version ' + glibcVersion + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
-        }
-      } else {
-        error(lddVersion.split(/\n/)[0] + ' requires manual installation - please see http://sharp.dimens.io/en/stable/install/');
-      }
-    }
-    // Arch/platform-specific .tar.gz
-    const tarFilename = ['libvips', minimumLibvipsVersion, platformId()].join('-') + '.tar.gz';
-    const tarPathLocal = path.join(__dirname, 'packaging', tarFilename);
-    if (isFile(tarPathLocal)) {
-      unpack(tarPathLocal);
-    } else {
-      // Download to per-process temporary file
-      const tarPathTemp = path.join(os.tmpdir(), process.pid + '-' + tarFilename);
-      const tmpFile = fs.createWriteStream(tarPathTemp).on('finish', function () {
-        unpack(tarPathTemp, function () {
-          // Attempt to remove temporary file
-          try {
-            fs.unlinkSync(tarPathTemp);
-          } catch (err) {}
-        });
-      });
-      const gotOpt = {
-        agent: caw(null, {
-          protocol: 'https'
-        })
-      };
-      const url = distBaseUrl + tarFilename;
-      got.stream(url, gotOpt).on('response', function (response) {
-        if (response.statusCode !== 200) {
-          error(url + ' status code ' + response.statusCode);
-        }
-      }).on('error', function (err) {
-        error('Download of ' + url + ' failed: ' + err.message);
-      }).pipe(tmpFile);
-    }
-  }
-};
-
-module.exports.use_global_vips = function () {
-  const globalVipsVersion = process.env.GLOBAL_VIPS_VERSION;
-  if (globalVipsVersion) {
-    const useGlobalVips = semver.gte(
-      globalVipsVersion,
-      minimumLibvipsVersion
-    );
-    process.stdout.write(useGlobalVips ? 'true' : 'false');
-  } else {
-    process.stdout.write('false');
-  }
-};

circle.yml

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

docs/api-channel.md

@@ -1,20 +1,46 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
+## removeAlpha
 
--   [extractChannel](#extractchannel)
+Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
--   [joinChannel](#joinchannel)
+
--   [bandbool](#bandbool)
+### 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** 
+
+## ensureAlpha
+
+Ensure alpha channel, if missing. The added alpha channel will be fully opaque. This is a no-op if the image already has an alpha channel.
+
+### Examples
+
+```javascript
+sharp('rgb.jpg')
+  .ensureAlpha()
+  .toFile('rgba.png', function(err, info) {
+    // rgba.png is a 4 channel image with a fully opaque alpha channel
+  });
+```
+
+Returns **Sharp** 
 
 ## extractChannel
 
 Extract a single channel from a multi-channel image.
 
-**Parameters**
+### Parameters
 
--   `channel` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** zero-indexed band number to extract, or `red`, `green` or `blue` as alternative to `0`, `1` or `2` respectively.
+-   `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**
+### Examples
 
 ```javascript
 sharp(input)
@@ -25,7 +51,7 @@ sharp(input)
    });
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid channel
+-   Throws **[Error][3]** Invalid channel
 
 Returns **Sharp** 
 
@@ -42,13 +68,13 @@ Channel ordering follows vips convention:
 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**
+### Parameters
 
--   `images` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))> | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** one or more images (file paths, Buffers).
+-   `images` **([Array][4]&lt;([String][2] \| [Buffer][5])> | [String][2] \| [Buffer][5])** one or more images (file paths, Buffers).
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** image options, see `sharp()` constructor.
+-   `options` **[Object][6]** image options, see `sharp()` constructor.
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][3]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -56,11 +82,11 @@ Returns **Sharp**
 
 Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
 
-**Parameters**
+### Parameters
 
--   `boolOp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+-   `boolOp` **[String][2]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
 
-**Examples**
+### Examples
 
 ```javascript
 sharp('3-channel-rgb-input.png')
@@ -72,6 +98,18 @@ sharp('3-channel-rgb-input.png')
   });
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   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

@@ -1,28 +1,16 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
+## tint
 
--   [background](#background)
+Tint the image using the provided chroma while preserving the image luminance.
--   [greyscale](#greyscale)
+An alpha channel may be present and will be unchanged by the operation.
--   [grayscale](#grayscale)
--   [toColourspace](#tocolourspace)
--   [toColorspace](#tocolorspace)
 
-## background
+### Parameters
 
-Set the background for the `embed`, `flatten` and `extend` operations.
+-   `rgb` **([String][1] \| [Object][2])** parsed by the [color][3] module to extract chroma values.
-The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
-
-Delegates to the _color_ module, which can throw an Error
-but is liberal in what it accepts, clipping values to sensible min/max.
-The alpha value is a float between `0` (transparent) and `1` (opaque).
-
-**Parameters**
-
--   `rgba` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameter
+-   Throws **[Error][4]** Invalid parameter
 
 Returns **Sharp** 
 
@@ -35,9 +23,9 @@ 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**
+### Parameters
 
--   `greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `greyscale` **[Boolean][5]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -45,9 +33,9 @@ Returns **Sharp**
 
 Alternative spelling of `greyscale`.
 
-**Parameters**
+### Parameters
 
--   `grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `grayscale` **[Boolean][5]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -56,12 +44,12 @@ Returns **Sharp**
 Set the output colourspace.
 By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
 
-**Parameters**
+### Parameters
 
--   `colourspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+-   `colourspace` **[String][1]?** output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][6]
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][4]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -69,11 +57,23 @@ Returns **Sharp**
 
 Alternative spelling of `toColourspace`.
 
-**Parameters**
+### Parameters
 
--   `colorspace` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** output colorspace.
+-   `colorspace` **[String][1]?** output colorspace.
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   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/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568

docs/api-composite.md

@@ -1,49 +1,54 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
+## composite
 
--   [overlayWith](#overlaywith)
+Composite image(s) over the processed (resized, extracted etc.) image.
 
-## overlayWith
+The images to composite must be the same size or smaller than the processed image.
-
-Overlay (composite) an image over the processed (resized, extracted etc.) image.
-
-The overlay image must be the same size or smaller than the processed image.
 If both `top` and `left` options are provided, they take precedence over `gravity`.
 
-**Parameters**
+The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
+`dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,
+`xor`, `add`, `saturate`, `multiply`, `screen`, `overlay`, `darken`, `lighten`,
+`colour-dodge`, `color-dodge`, `colour-burn`,`color-burn`,
+`hard-light`, `soft-light`, `difference`, `exclusion`.
 
--   `overlay` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
+More information about blend modes can be found at
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+[https://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsBlendMode][1]
-    -   `options.gravity` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** gravity at which to place the overlay. (optional, default `'centre'`)
+and [https://www.cairographics.org/operators/][2]
-    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the top edge.
-    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the pixel offset from the left edge.
-    -   `options.tile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
-    -   `options.cutout` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another. (optional, default `false`)
-    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** integral number representing the DPI for vector overlay image. (optional, default `72`)
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes overlay when using raw pixel data.
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a blank overlay to be created.
-        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
-        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
 
-**Examples**
+### Parameters
+
+-   `images` **[Array][3]&lt;[Object][4]>** Ordered list of images to composite
+    -   `images[].input` **([Buffer][5] \| [String][6])?** Buffer containing image data, String containing the path to an image file, or Create object (see bellow)
+        -   `images[].input.create` **[Object][4]?** describes a blank overlay to be created.
+            -   `images[].input.create.width` **[Number][7]?** 
+            -   `images[].input.create.height` **[Number][7]?** 
+            -   `images[].input.create.channels` **[Number][7]?** 3-4
+            -   `images[].input.create.background` **([String][6] \| [Object][4])?** parsed by the [color][8] module to extract values for red, green, blue and alpha.
+    -   `images[].blend` **[String][6]** how to blend this image with the image below. (optional, default `'over'`)
+    -   `images[].gravity` **[String][6]** gravity at which to place the overlay. (optional, default `'centre'`)
+    -   `images[].top` **[Number][7]?** the pixel offset from the top edge.
+    -   `images[].left` **[Number][7]?** the pixel offset from the left edge.
+    -   `images[].tile` **[Boolean][9]** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
+    -   `images[].premultiplied` **[Boolean][9]** set to true to avoid premultipling the image below. Equivalent to the `--premultiplied` vips option. (optional, default `false`)
+    -   `images[].density` **[Number][7]** number representing the DPI for vector overlay image. (optional, default `72`)
+    -   `images[].raw` **[Object][4]?** describes overlay when using raw pixel data.
+        -   `images[].raw.width` **[Number][7]?** 
+        -   `images[].raw.height` **[Number][7]?** 
+        -   `images[].raw.channels` **[Number][7]?** 
+
+### Examples
 
 ```javascript
 sharp('input.png')
   .rotate(180)
   .resize(300)
-  .flatten()
+  .flatten( { background: '#ff6600' } )
-  .background('#ff6600')
+  .composite([{ input: 'overlay.png', gravity: 'southeast' }])
-  .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
   .sharpen()
   .withMetadata()
-  .quality(90)
+  .webp( { quality: 90 } )
-  .webp()
   .toBuffer()
   .then(function(outputBuffer) {
     // outputBuffer contains upside down, 300px wide, alpha channel flattened
@@ -52,6 +57,26 @@ sharp('input.png')
   });
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][10]** Invalid parameters
 
 Returns **Sharp** 
+
+[1]: https://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsBlendMode
+
+[2]: https://www.cairographics.org/operators/
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[5]: https://nodejs.org/api/buffer.html
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[8]: https://www.npmjs.org/package/color
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-constructor.md

@@ -1,33 +1,30 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [Sharp](#sharp)
-    -   [format](#format)
-    -   [versions](#versions)
--   [queue](#queue)
-
 ## Sharp
 
-**Parameters**
+### Parameters
 
--   `input` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))?** if present, can be
+-   `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.
+     a String containing the filesystem path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
-     JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when null or undefined.
+     JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** if present, is an Object with optional attributes.
+-   `options` **[Object][3]?** if present, is an Object with optional attributes.
-    -   `options.density` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** integral number representing the DPI for vector images. (optional, default `72`)
+    -   `options.failOnError` **[Boolean][4]** by default halt processing and raise an error when loading invalid images.
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes raw pixel input image data. See `raw()` for pixel ordering.
+         Set this flag to `false` if you'd rather apply a "best effort" to decode images, even if the data is corrupt or invalid. (optional, default `true`)
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `options.density` **[Number][5]** number representing the DPI for vector images. (optional, default `72`)
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+    -   `options.pages` **[Number][5]** number of pages to extract for multi-page input (GIF, TIFF, PDF), use -1 for all pages. (optional, default `1`)
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 1-4
+    -   `options.page` **[Number][5]** page number to start extracting from for multi-page input (GIF, TIFF, PDF), zero based. (optional, default `0`)
-    -   `options.create` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes a new image to be created.
+    -   `options.raw` **[Object][3]?** describes raw pixel input image data. See `raw()` for pixel ordering.
-        -   `options.create.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.width` **[Number][5]?** 
-        -   `options.create.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.height` **[Number][5]?** 
-        -   `options.create.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 3-4
+        -   `options.raw.channels` **[Number][5]?** 1-4
-        -   `options.create.background` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
+    -   `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**
+### Examples
 
 ```javascript
 sharp('input.jpg')
@@ -53,12 +50,12 @@ readableStream.pipe(transformer).pipe(writableStream);
 
 ```javascript
 // Create a blank 300x200 PNG image of semi-transluent red pixels
-sharp(null, {
+sharp({
   create: {
     width: 300,
     height: 200,
     channels: 4,
-    background: { r: 255, g: 0, b: 0, alpha: 128 }
+    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
   }
 })
 .png()
@@ -66,27 +63,27 @@ sharp(null, {
 .then( ... );
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][7]** Invalid parameters
 
-Returns **[Sharp](#sharp)** 
+Returns **[Sharp][8]** 
 
 ### format
 
 An Object containing nested boolean values representing the available input and output formats/methods.
 
-**Examples**
+#### Examples
 
 ```javascript
-console.log(sharp.format());
+console.log(sharp.format);
 ```
 
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+Returns **[Object][3]** 
 
 ### versions
 
 An Object containing the version numbers of libvips and its dependencies.
 
-**Examples**
+#### Examples
 
 ```javascript
 console.log(sharp.versions);
@@ -99,10 +96,26 @@ An EventEmitter that emits a `change` event when a task is either:
 -   queued, waiting for _libuv_ to provide a worker thread
 -   complete
 
-**Examples**
+### 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

@@ -1,19 +1,12 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [clone](#clone)
--   [metadata](#metadata)
--   [limitInputPixels](#limitinputpixels)
--   [sequentialRead](#sequentialread)
-
 ## clone
 
 Take a "snapshot" of the Sharp instance, returning a new instance.
 Cloned instances inherit the input of their parent instance.
 This allows multiple output Streams and therefore multiple processing pipelines to share a single input Stream.
 
-**Examples**
+### Examples
 
 ```javascript
 const pipeline = sharp().rotate();
@@ -28,26 +21,35 @@ Returns **Sharp**
 
 ## metadata
 
-Fast access to image metadata without decoding any compressed image data.
+Fast access to (uncached) image metadata without decoding any compressed image data.
-A Promises/A+ promise is returned when `callback` is not provided.
+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
+-   `size`: Total size of image in bytes, for Stream and Buffer input only
--   `height`: Number of pixels high
+-   `width`: Number of pixels wide (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#L568)
+-   `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
+-   `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK
+-   `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan
+-   `pages`: Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP
+-   `pageHeight`: Number of pixels high each page in this PDF image will be.
+-   `pagePrimary`: Number of the primary page in a HEIF image
 -   `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
+-   `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**
+### Parameters
 
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called with the arguments `(err, metadata)`
+-   `callback` **[Function][4]?** called with the arguments `(err, metadata)`
 
-**Examples**
+### Examples
 
 ```javascript
 const image = sharp(inputJpg);
@@ -64,20 +66,56 @@ image
   });
 ```
 
-Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)> | Sharp)** 
+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.
+Do not process input images where the number of pixels (width x height) exceeds this limit.
 Assumes image dimensions contained in the input metadata can be trusted.
-The default limit is 268402689 (0x3FFF _ 0x3FFF) pixels.
+The default limit is 268402689 (0x3FFF x 0x3FFF) pixels.
 
-**Parameters**
+### Parameters
 
--   `limit` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** an integral Number of pixels, zero or false to remove limit, true to use default limit.
+-   `limit` **([Number][7] \| [Boolean][8])** an integral Number of pixels, zero or false to remove limit, true to use default limit.
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid limit
+-   Throws **[Error][9]** Invalid limit
 
 Returns **Sharp** 
 
@@ -86,8 +124,28 @@ Returns **Sharp**
 An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
 This will reduce memory usage and can improve performance on some systems.
 
-**Parameters**
+The default behaviour _before_ function call is `false`, meaning the libvips access method is not sequential.
 
--   `sequentialRead` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+### Parameters
+
+-   `sequentialRead` **[Boolean][8]**  (optional, default `true`)
 
 Returns **Sharp** 
+
+[1]: https://github.com/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636
+
+[2]: https://github.com/libvips/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

@@ -1,30 +1,17 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [rotate](#rotate)
--   [extract](#extract)
--   [flip](#flip)
--   [flop](#flop)
--   [sharpen](#sharpen)
--   [blur](#blur)
--   [extend](#extend)
--   [flatten](#flatten)
--   [trim](#trim)
--   [gamma](#gamma)
--   [negate](#negate)
--   [normalise](#normalise)
--   [normalize](#normalize)
--   [convolve](#convolve)
--   [threshold](#threshold)
--   [boolean](#boolean)
-
 ## rotate
 
 Rotate the output image by either an explicit angle
 or auto-orient based on the EXIF `Orientation` tag.
 
-Use this method without angle to determine the angle from EXIF data.
+If an angle is provided, it is converted to a valid positive degree rotation.
+For example, `-450` will produce a 270deg rotation.
+
+When rotating by an angle other than a multiple of 90,
+the background colour can be provided with the `background` option.
+
+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.
@@ -32,11 +19,13 @@ 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**
+### Parameters
 
--   `angle` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 0, 90, 180 or 270. (optional, default `auto`)
+-   `angle` **[Number][1]** angle of rotation. (optional, default `auto`)
+-   `options` **[Object][2]?** if present, is an Object with optional attributes.
+    -   `options.background` **([String][3] \| [Object][2])** parsed by the [color][4] module to extract values for red, green, blue and alpha. (optional, default `"#000000"`)
 
-**Examples**
+### Examples
 
 ```javascript
 const pipeline = sharp()
@@ -50,47 +39,7 @@ const pipeline = sharp()
 readableStream.pipe(pipeline);
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## extract
-
-Extract a region of the image.
-
--   Use `extract` before `resize` for pre-resize extraction.
--   Use `extract` after `resize` for post-resize extraction.
--   Use `extract` before and after for both.
-
-**Parameters**
-
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-    -   `options.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from left edge
-    -   `options.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** zero-indexed offset from top edge
-    -   `options.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
-    -   `options.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of extracted image
-
-**Examples**
-
-```javascript
-sharp(input)
-  .extract({ left: left, top: top, width: width, height: height })
-  .toFile(output, function(err) {
-    // Extract a region of the input image, saving in the same format.
-  });
-```
-
-```javascript
-sharp(input)
-  .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
-  .resize(width, height)
-  .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
-  .toFile(output, function(err) {
-    // Extract a region, resize, then extract from the resized image
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
 
 Returns **Sharp** 
 
@@ -99,9 +48,9 @@ Returns **Sharp**
 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**
+### Parameters
 
--   `flip` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `flip` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -110,9 +59,9 @@ Returns **Sharp**
 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**
+### Parameters
 
--   `flop` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `flop` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -123,14 +72,28 @@ 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**
+### Parameters
 
--   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+-   `sigma` **[Number][1]?** the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
--   `flat` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
+-   `flat` **[Number][1]** the level of sharpening to apply to "flat" areas. (optional, default `1.0`)
--   `jagged` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
+-   `jagged` **[Number][1]** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** 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][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -140,64 +103,23 @@ 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**
+### Parameters
 
--   `sigma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+-   `sigma` **[Number][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
-
-Returns **Sharp** 
-
-## extend
-
-Extends/pads the edges of the image with the colour provided to the `background` method.
-This operation will always occur after resizing and extraction, if any.
-
-**Parameters**
-
--   `extend` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** single pixel count to add to all edges or an Object with per-edge counts
-    -   `extend.top` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.left` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.bottom` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-    -   `extend.right` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
-
-**Examples**
-
-```javascript
-// Resize to 140 pixels wide, then add 10 transparent pixels
-// to the top, left and right edges and 20 to the bottom edge
-sharp(input)
-  .resize(140)
-  .background({r: 0, g: 0, b: 0, alpha: 0})
-  .extend({top: 10, bottom: 20, left: 10, right: 10})
-  ...
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
 
 Returns **Sharp** 
 
 ## flatten
 
-Merge alpha transparency channel, if any, with `background`.
+Merge alpha transparency channel, if any, with a background.
 
-**Parameters**
+### Parameters
 
--   `flatten` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `options` **[Object][2]?** 
-
+    -   `options.background` **([String][3] \| [Object][2])** background colour, parsed by the [color][4] module, defaults to black. (optional, default `{r:0,g:0,b:0}`)
-Returns **Sharp** 
-
-## trim
-
-Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
-
-**Parameters**
-
--   `tolerance` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1 and 99 representing the percentage similarity. (optional, default `10`)
-
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
 
 Returns **Sharp** 
 
@@ -209,12 +131,15 @@ This can improve the perceived brightness of a resized image in non-linear colou
 JPEG and WebP input images will not take advantage of the shrink-on-load performance optimisation
 when applying a gamma correction.
 
-**Parameters**
+Supply a second argument to use a different output gamma value, otherwise the first value is used in both cases.
 
--   `gamma` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1.0 and 3.0. (optional, default `2.2`)
+### Parameters
+
+-   `gamma` **[Number][1]** value between 1.0 and 3.0. (optional, default `2.2`)
+-   `gammaOut` **[Number][1]?** value between 1.0 and 3.0. (optional, defaults to same as `gamma`)
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -222,9 +147,9 @@ Returns **Sharp**
 
 Produce the "negative" of the image.
 
-**Parameters**
+### Parameters
 
--   `negate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `negate` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -232,9 +157,9 @@ Returns **Sharp**
 
 Enhance output image contrast by stretching its luminance to cover the full dynamic range.
 
-**Parameters**
+### Parameters
 
--   `normalise` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `normalise` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -242,9 +167,9 @@ Returns **Sharp**
 
 Alternative spelling of normalise.
 
-**Parameters**
+### Parameters
 
--   `normalize` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+-   `normalize` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -252,16 +177,16 @@ Returns **Sharp**
 
 Convolve the image with the specified kernel.
 
-**Parameters**
+### Parameters
 
--   `kernel` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+-   `kernel` **[Object][2]** 
-    -   `kernel.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
+    -   `kernel.width` **[Number][1]** width of the kernel in pixels.
-    -   `kernel.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of the kernel in pixels.
+    -   `kernel.height` **[Number][1]** width of the kernel in pixels.
-    -   `kernel.kernel` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Array of length `width*height` containing the kernel values.
+    -   `kernel.kernel` **[Array][7]&lt;[Number][1]>** Array of length `width*height` containing the kernel values.
-    -   `kernel.scale` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the scale of the kernel in pixels. (optional, default `sum`)
+    -   `kernel.scale` **[Number][1]** the scale of the kernel in pixels. (optional, default `sum`)
-    -   `kernel.offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** the offset of the kernel in pixels. (optional, default `0`)
+    -   `kernel.offset` **[Number][1]** the offset of the kernel in pixels. (optional, default `0`)
 
-**Examples**
+### Examples
 
 ```javascript
 sharp(input)
@@ -277,7 +202,7 @@ sharp(input)
   });
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -285,15 +210,15 @@ Returns **Sharp**
 
 Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
 
-**Parameters**
+### Parameters
 
--   `threshold` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
+-   `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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+-   `options` **[Object][2]?** 
-    -   `options.greyscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** convert to single channel greyscale. (optional, default `true`)
+    -   `options.greyscale` **[Boolean][6]** convert to single channel greyscale. (optional, default `true`)
-    -   `options.grayscale` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling for greyscale. (optional, default `true`)
+    -   `options.grayscale` **[Boolean][6]** alternative spelling for greyscale. (optional, default `true`)
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -304,17 +229,111 @@ 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**
+### Parameters
 
--   `operand` **([Buffer](https://nodejs.org/api/buffer.html) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Buffer containing image data or String containing the path to an image file.
+-   `operand` **([Buffer][8] \| [String][3])** Buffer containing image data or String containing the path to an image file.
--   `operator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+-   `operator` **[String][3]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+-   `options` **[Object][2]?** 
-    -   `options.raw` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** describes operand when using raw pixel data.
+    -   `options.raw` **[Object][2]?** describes operand when using raw pixel data.
-        -   `options.raw.width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.width` **[Number][1]?** 
-        -   `options.raw.height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.height` **[Number][1]?** 
-        -   `options.raw.channels` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+        -   `options.raw.channels` **[Number][1]?** 
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][5]** 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][5]** Invalid parameters
+
+Returns **Sharp** 
+
+## recomb
+
+Recomb the image with the specified matrix.
+
+### Parameters
+
+-   `inputMatrix`  
+-   `3x3` **[Array][7]&lt;[Array][7]&lt;[Number][1]>>** Recombination matrix
+
+### Examples
+
+```javascript
+sharp(input)
+  .recomb([
+   [0.3588, 0.7044, 0.1368],
+   [0.2990, 0.5870, 0.1140],
+   [0.2392, 0.4696, 0.0912],
+  ])
+  .raw()
+  .toBuffer(function(err, data, info) {
+    // data contains the raw pixel data after applying the recomb
+    // With this example input, a sepia filter has been applied
+  });
+```
+
+-   Throws **[Error][5]** Invalid parameters
+
+Returns **Sharp** 
+
+## modulate
+
+Transforms the image using brightness, saturation and hue rotation.
+
+### Parameters
+
+-   `options` **[Object][2]?** 
+    -   `options.brightness` **[Number][1]?** Brightness multiplier
+    -   `options.saturation` **[Number][1]?** Saturation multiplier
+    -   `options.hue` **[Number][1]?** Degrees for hue rotation
+
+### Examples
+
+```javascript
+sharp(input)
+  .modulate({
+    brightness: 2 // increase lightness by a factor of 2
+  });
+
+sharp(input)
+  .modulate({
+    hue: 180 // hue-rotate by 180 degrees
+  });
+
+// decreate brightness and saturation while also hue-rotating by 90 degrees
+sharp(input)
+  .modulate({
+    brightness: 0.5,
+    saturation: 0.5,
+    hue: 90
+  });
+```
+
+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/Object
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[4]: https://www.npmjs.org/package/color
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[8]: https://nodejs.org/api/buffer.html

docs/api-output.md

@@ -1,18 +1,5 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [toFile](#tofile)
--   [toBuffer](#tobuffer)
--   [withMetadata](#withmetadata)
--   [jpeg](#jpeg)
--   [png](#png)
--   [webp](#webp)
--   [tiff](#tiff)
--   [raw](#raw)
--   [toFormat](#toformat)
--   [tile](#tile)
-
 ## toFile
 
 Write output image data to a file.
@@ -21,39 +8,85 @@ If an explicit output format is not selected, it will be inferred from the exten
 with JPEG, PNG, WebP, TIFF, DZI, and libvips' V format supported.
 Note that raw pixel data is only supported for buffer output.
 
-A Promises/A+ promise is returned when `callback` is not provided.
+By default all metadata will be removed, which includes EXIF-based orientation.
+See [withMetadata][1] for control over this.
 
-**Parameters**
+A `Promise` is returned when `callback` is not provided.
 
--   `fileOut` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the path to write the image data to.
+### Parameters
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called on completion with two arguments `(err, info)`.
-    `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
 
+-   `fileOut` **[String][2]** the path to write the image data to.
+-   `callback` **[Function][3]?** 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`.
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+### Examples
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** when no callback is provided
+```javascript
+sharp(input)
+  .toFile('output.png', (err, info) => { ... });
+```
+
+```javascript
+sharp(input)
+  .toFile('output.png')
+  .then(info => { ... })
+  .catch(err => { ... });
+```
+
+-   Throws **[Error][4]** Invalid parameters
+
+Returns **[Promise][5]&lt;[Object][6]>** when no callback is provided
 
 ## toBuffer
 
 Write output to a Buffer.
-JPEG, PNG, WebP, and RAW output are supported.
+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.
+
+If no explicit format is set, the output format will match the input image, except GIF and SVG input which become PNG output.
+
+By default all metadata will be removed, which includes EXIF-based orientation.
+See [withMetadata][1] for control over this.
 
 `callback`, if present, gets three arguments `(err, data, info)` where:
 
 -   `err` is an error, if any.
 -   `data` is the output image data.
--   `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+-   `info` contains the output image `format`, `size` (bytes), `width`, `height`,
-    A Promise is returned when `callback` is not provided.
+    `channels` and `premultiplied` (indicating if premultiplication was used).
+    When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
 
-**Parameters**
+A `Promise` is returned when `callback` is not provided.
 
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+### Parameters
-    -   `options.resolveWithObject` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** 
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Buffer](https://nodejs.org/api/buffer.html)>** when no callback is provided
+-   `options` **[Object][6]?** 
+    -   `options.resolveWithObject` **[Boolean][7]?** Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
+-   `callback` **[Function][3]?** 
+
+### 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][5]&lt;[Buffer][8]>** when no callback is provided
 
 ## withMetadata
 
@@ -61,13 +94,21 @@ 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**
+### Parameters
 
--   `withMetadata` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+-   `options` **[Object][6]?** 
-    -   `withMetadata.orientation` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** value between 1 and 8, used to update the EXIF `Orientation` tag.
+    -   `options.orientation` **[Number][9]?** value between 1 and 8, used to update the EXIF `Orientation` tag.
 
+### Examples
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+```javascript
+sharp('input.jpg')
+  .withMetadata()
+  .toFile('output-with-metadata.jpg')
+  .then(info => { ... });
+```
+
+-   Throws **[Error][4]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -75,20 +116,35 @@ Returns **Sharp**
 
 Use these JPEG options for output image.
 
-**Parameters**
+### Parameters
 
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+-   `options` **[Object][6]?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.quality` **[Number][9]** quality, integer 1-100 (optional, default `80`)
-    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use progressive (interlace) scan (optional, default `false`)
+    -   `options.progressive` **[Boolean][7]** use progressive (interlace) scan (optional, default `false`)
-    -   `options.chromaSubsampling` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** set to '4:4:4' to prevent chroma subsampling when quality &lt;= 90 (optional, default `'4:2:0'`)
+    -   `options.chromaSubsampling` **[String][2]** set to '4:4:4' to prevent chroma subsampling when quality &lt;= 90 (optional, default `'4:2:0'`)
-    -   `options.trellisQuantisation` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** apply trellis quantisation, requires mozjpeg (optional, default `false`)
+    -   `options.trellisQuantisation` **[Boolean][7]** apply trellis quantisation, requires libvips compiled with support for mozjpeg (optional, default `false`)
-    -   `options.overshootDeringing` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** apply overshoot deringing, requires mozjpeg (optional, default `false`)
+    -   `options.overshootDeringing` **[Boolean][7]** apply overshoot deringing, requires libvips compiled with support for mozjpeg (optional, default `false`)
-    -   `options.optimiseScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optimise progressive scans, forces progressive, requires mozjpeg (optional, default `false`)
+    -   `options.optimiseScans` **[Boolean][7]** optimise progressive scans, forces progressive, requires libvips compiled with support for mozjpeg (optional, default `false`)
-    -   `options.optimizeScans` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling of optimiseScans (optional, default `false`)
+    -   `options.optimizeScans` **[Boolean][7]** alternative spelling of optimiseScans (optional, default `false`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force JPEG output, otherwise attempt to use input format (optional, default `true`)
+    -   `options.optimiseCoding` **[Boolean][7]** optimise Huffman coding tables (optional, default `true`)
+    -   `options.optimizeCoding` **[Boolean][7]** alternative spelling of optimiseCoding (optional, default `true`)
+    -   `options.quantisationTable` **[Number][9]** quantization table to use, integer 0-8, requires libvips compiled with support for mozjpeg (optional, default `0`)
+    -   `options.quantizationTable` **[Number][9]** alternative spelling of quantisationTable (optional, default `0`)
+    -   `options.force` **[Boolean][7]** force JPEG output, otherwise attempt to use input format (optional, default `true`)
 
+### Examples
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+```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][4]** Invalid options
 
 Returns **Sharp** 
 
@@ -96,16 +152,32 @@ Returns **Sharp**
 
 Use these PNG options for output image.
 
-**Parameters**
+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.
 
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+### Parameters
-    -   `options.progressive` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use progressive (interlace) scan (optional, default `false`)
-    -   `options.compressionLevel` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** zlib compression level (optional, default `6`)
-    -   `options.adaptiveFiltering` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use adaptive row filtering (optional, default `true`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force PNG output, otherwise attempt to use input format (optional, default `true`)
 
+-   `options` **[Object][6]?** 
+    -   `options.progressive` **[Boolean][7]** use progressive (interlace) scan (optional, default `false`)
+    -   `options.compressionLevel` **[Number][9]** zlib compression level, 0-9 (optional, default `9`)
+    -   `options.adaptiveFiltering` **[Boolean][7]** use adaptive row filtering (optional, default `false`)
+    -   `options.palette` **[Boolean][7]** quantise to a palette-based image with alpha transparency support, requires libvips compiled with support for libimagequant (optional, default `false`)
+    -   `options.quality` **[Number][9]** use the lowest number of colours needed to achieve given quality, requires libvips compiled with support for libimagequant (optional, default `100`)
+    -   `options.colours` **[Number][9]** maximum number of palette entries, requires libvips compiled with support for libimagequant (optional, default `256`)
+    -   `options.colors` **[Number][9]** alternative spelling of `options.colours`, requires libvips compiled with support for libimagequant (optional, default `256`)
+    -   `options.dither` **[Number][9]** level of Floyd-Steinberg error diffusion, requires libvips compiled with support for libimagequant (optional, default `1.0`)
+    -   `options.force` **[Boolean][7]** force PNG output, otherwise attempt to use input format (optional, default `true`)
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+### Examples
+
+```javascript
+// Convert any input to PNG output
+const data = await sharp(input)
+  .png()
+  .toBuffer();
+```
+
+-   Throws **[Error][4]** Invalid options
 
 Returns **Sharp** 
 
@@ -113,17 +185,27 @@ Returns **Sharp**
 
 Use these WebP options for output image.
 
-**Parameters**
+### Parameters
 
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+-   `options` **[Object][6]?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.quality` **[Number][9]** quality, integer 1-100 (optional, default `80`)
-    -   `options.alphaQuality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality of alpha layer, integer 0-100 (optional, default `100`)
+    -   `options.alphaQuality` **[Number][9]** quality of alpha layer, integer 0-100 (optional, default `100`)
-    -   `options.lossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use lossless compression mode (optional, default `false`)
+    -   `options.lossless` **[Boolean][7]** use lossless compression mode (optional, default `false`)
-    -   `options.nearLossless` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use near_lossless compression mode (optional, default `false`)
+    -   `options.nearLossless` **[Boolean][7]** use near_lossless compression mode (optional, default `false`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force WebP output, otherwise attempt to use input format (optional, default `true`)
+    -   `options.smartSubsample` **[Boolean][7]** use high quality chroma subsampling (optional, default `false`)
+    -   `options.reductionEffort` **[Number][9]** level of CPU effort to reduce file size, integer 0-6 (optional, default `4`)
+    -   `options.force` **[Boolean][7]** force WebP output, otherwise attempt to use input format (optional, default `true`)
 
+### Examples
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+```javascript
+// Convert any input to lossless WebP output
+const data = await sharp(input)
+  .webp({ lossless: true })
+  .toBuffer();
+```
+
+-   Throws **[Error][4]** Invalid options
 
 Returns **Sharp** 
 
@@ -131,16 +213,58 @@ Returns **Sharp**
 
 Use these TIFF options for output image.
 
-**Parameters**
+### Parameters
 
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** output options
+-   `options` **[Object][6]?** output options
-    -   `options.quality` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** quality, integer 1-100 (optional, default `80`)
+    -   `options.quality` **[Number][9]** quality, integer 1-100 (optional, default `80`)
-    -   `options.force` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** force TIFF output, otherwise attempt to use input format (optional, default `true`)
+    -   `options.force` **[Boolean][7]** force TIFF output, otherwise attempt to use input format (optional, default `true`)
-    -   `options.compression` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression options: lzw, deflate, jpeg (optional, default `'jpeg'`)
+    -   `options.compression` **[Boolean][7]** compression options: lzw, deflate, jpeg, ccittfax4 (optional, default `'jpeg'`)
-    -   `options.predictor` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** compression predictor options: none, horizontal, float (optional, default `'none'`)
+    -   `options.predictor` **[Boolean][7]** compression predictor options: none, horizontal, float (optional, default `'horizontal'`)
+    -   `options.pyramid` **[Boolean][7]** write an image pyramid (optional, default `false`)
+    -   `options.tile` **[Boolean][7]** write a tiled tiff (optional, default `false`)
+    -   `options.tileWidth` **[Boolean][7]** horizontal tile size (optional, default `256`)
+    -   `options.tileHeight` **[Boolean][7]** vertical tile size (optional, default `256`)
+    -   `options.xres` **[Number][9]** horizontal resolution in pixels/mm (optional, default `1.0`)
+    -   `options.yres` **[Number][9]** vertical resolution in pixels/mm (optional, default `1.0`)
+    -   `options.squash` **[Boolean][7]** 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][4]** Invalid options
+
+Returns **Sharp** 
+
+## heif
+
+Use these HEIF options for output image.
+
+Support for HEIF (HEIC/AVIF) is experimental.
+Do not use this in production systems.
+
+Requires a custom, globally-installed libvips compiled with support for libheif.
+
+Most versions of libheif support only the patent-encumbered HEVC compression format.
+
+### Parameters
+
+-   `options` **[Object][6]?** output options
+    -   `options.quality` **[Number][9]** quality, integer 1-100 (optional, default `80`)
+    -   `options.compression` **[Boolean][7]** compression format: hevc, avc, jpeg, av1 (optional, default `'hevc'`)
+    -   `options.lossless` **[Boolean][7]** use lossless compression (optional, default `false`)
 
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid options
+-   Throws **[Error][4]** Invalid options
 
 Returns **Sharp** 
 
@@ -148,19 +272,36 @@ Returns **Sharp**
 
 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**
+### Parameters
 
--   `format` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** as a String or an Object with an 'id' attribute
+-   `format` **([String][2] \| [Object][6])** as a String or an Object with an 'id' attribute
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options
+-   `options` **[Object][6]** output options
 
+### Examples
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** unsupported format or options
+```javascript
+// Convert any input to PNG output
+const data = await sharp(input)
+  .toFormat('png')
+  .toBuffer();
+```
+
+-   Throws **[Error][4]** unsupported format or options
 
 Returns **Sharp** 
 
@@ -170,15 +311,21 @@ Use tile-based deep zoom (image pyramid) output.
 Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
 Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
 
-**Parameters**
+Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
 
--   `tile` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+### Parameters
-    -   `tile.size` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
-    -   `tile.overlap` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
-    -   `tile.container` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
-    -   `tile.layout` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** filesystem layout, possible values are `dz`, `zoomify` or `google`. (optional, default `'dz'`)
 
-**Examples**
+-   `options` **[Object][6]?** 
+    -   `options.size` **[Number][9]** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
+    -   `options.overlap` **[Number][9]** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
+    -   `options.angle` **[Number][9]** tile angle of rotation, must be a multiple of 90. (optional, default `0`)
+    -   `options.background` **([String][2] \| [Object][6])** background colour, parsed by the [color][10] module, defaults to white without transparency. (optional, default `{r:255,g:255,b:255,alpha:1}`)
+    -   `options.depth` **[String][2]?** how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
+    -   `options.skipBlanks` **[Number][9]** threshold to skip tile generation, a value 0 - 255 for 8-bit images or 0 - 65535 for 16-bit images (optional, default `-1`)
+    -   `options.container` **[String][2]** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
+    -   `options.layout` **[String][2]** filesystem layout, possible values are `dz`, `zoomify` or `google`. (optional, default `'dz'`)
+
+### Examples
 
 ```javascript
 sharp('input.tiff')
@@ -192,6 +339,26 @@ sharp('input.tiff')
   });
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
+-   Throws **[Error][4]** Invalid parameters
 
 Returns **Sharp** 
+
+[1]: #withmetadata
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+
+[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/Boolean
+
+[8]: https://nodejs.org/api/buffer.html
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[10]: https://www.npmjs.org/package/color

docs/api-resize.md

@@ -1,177 +1,236 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [resize](#resize)
--   [crop](#crop)
--   [embed](#embed)
--   [max](#max)
--   [min](#min)
--   [ignoreAspectRatio](#ignoreaspectratio)
--   [withoutEnlargement](#withoutenlargement)
-
 ## resize
 
-Resize image to `width` x `height`.
+Resize image to `width`, `height` or `width x height`.
-By default, the resized image is centre cropped to the exact size specified.
 
-Possible reduction kernels are:
+When both a `width` and `height` are provided, the possible methods by which the image should **fit** these are:
 
--   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+-   `cover`: Crop to cover both provided dimensions (the default).
--   `cubic`: Use a [Catmull-Rom spline](https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline).
+-   `contain`: Embed within both provided dimensions.
--   `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
+-   `fill`: Ignore the aspect ratio of the input and stretch to both provided dimensions.
--   `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+-   `inside`: Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
+-   `outside`: Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified.
+    Some of these values are based on the [object-fit][1] CSS property.
 
-Possible enlargement interpolators are:
+When using a `fit` of `cover` or `contain`, the default **position** is `centre`. Other options are:
 
--   `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
+-   `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.
--   `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
+-   `sharp.gravity`: `north`, `northeast`, `east`, `southeast`, `south`, `southwest`, `west`, `northwest`, `center` or `centre`.
--   `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
+-   `sharp.strategy`: `cover` only, dynamically crop using either the `entropy` or `attention` strategy.
--   `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
+    Some of these values are based on the [object-position][2] CSS property.
--   `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
--   `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
-
-**Parameters**
-
--   `width` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use `null` or `undefined` to auto-scale the width to match the height.
--   `height` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** pixels high the resultant image should be, between 1 and 16383. Use `null` or `undefined` to auto-scale the height to match the width.
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-    -   `options.kernel` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** the kernel to use for image reduction. (optional, default `'lanczos3'`)
-    -   `options.interpolator` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** the interpolator to use for image enlargement. (optional, default `'bicubic'`)
-    -   `options.centreSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** use \*magick centre sampling convention instead of corner sampling. (optional, default `false`)
-    -   `options.centerSampling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** alternative spelling of centreSampling. (optional, default `false`)
-
-**Examples**
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 300, {
-    kernel: sharp.kernel.lanczos2,
-    interpolator: sharp.interpolator.nohalo
-  })
-  .background('white')
-  .embed()
-  .toFile('output.tiff')
-  .then(function() {
-    // output.tiff is a 200 pixels wide and 300 pixels high image
-    // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
-    // of the image data in inputBuffer
-  });
-```
-
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## crop
-
-Crop the resized image to the exact size specified, the default behaviour.
-
-Possible attributes of the optional `sharp.gravity` are `north`, `northeast`, `east`, `southeast`, `south`,
-`southwest`, `west`, `northwest`, `center` and `centre`.
 
 The experimental strategy-based approach resizes so one dimension is at its target length
 then repeatedly ranks edge regions, discarding the edge with the lowest score based on the selected strategy.
 
--   `entropy`: focus on the region with the highest [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_%28information_theory%29).
+-   `entropy`: focus on the region with the highest [Shannon entropy][3].
 -   `attention`: focus on the region with the highest luminance frequency, colour saturation and presence of skin tones.
 
-**Parameters**
+Possible interpolation kernels are:
 
--   `crop` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically. (optional, default `'centre'`)
+-   `nearest`: Use [nearest neighbour interpolation][4].
+-   `cubic`: Use a [Catmull-Rom spline][5].
+-   `mitchell`: Use a [Mitchell-Netravali spline][6].
+-   `lanczos2`: Use a [Lanczos kernel][7] with `a=2`.
+-   `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
 
-**Examples**
+### Parameters
+
+-   `width` **[Number][8]?** pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
+-   `height` **[Number][8]?** pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
+-   `options` **[Object][9]?** 
+    -   `options.width` **[String][10]?** alternative means of specifying `width`. If both are present this take priority.
+    -   `options.height` **[String][10]?** alternative means of specifying `height`. If both are present this take priority.
+    -   `options.fit` **[String][10]** how the image should be resized to fit both provided dimensions, one of `cover`, `contain`, `fill`, `inside` or `outside`. (optional, default `'cover'`)
+    -   `options.position` **[String][10]** position, gravity or strategy to use when `fit` is `cover` or `contain`. (optional, default `'centre'`)
+    -   `options.background` **([String][10] \| [Object][9])** background colour when using a `fit` of `contain`, parsed by the [color][11] module, defaults to black without transparency. (optional, default `{r:0,g:0,b:0,alpha:1}`)
+    -   `options.kernel` **[String][10]** the kernel to use for image reduction. (optional, default `'lanczos3'`)
+    -   `options.withoutEnlargement` **[Boolean][12]** do not enlarge if the width _or_ height are already less than the specified dimensions, equivalent to GraphicsMagick's `>` geometry option. (optional, default `false`)
+    -   `options.fastShrinkOnLoad` **[Boolean][12]** 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(input)
+  .resize({ width: 100 })
+  .toBuffer()
+  .then(data => {
+    // 100 pixels wide, auto-scaled height
+  });
+```
+
+```javascript
+sharp(input)
+  .resize({ height: 100 })
+  .toBuffer()
+  .then(data => {
+    // 100 pixels high, auto-scaled width
+  });
+```
+
+```javascript
+sharp(input)
+  .resize(200, 300, {
+    kernel: sharp.kernel.nearest,
+    fit: 'contain',
+    position: 'right top',
+    background: { r: 255, g: 255, b: 255, alpha: 0.5 }
+  })
+  .toFile('output.png')
+  .then(() => {
+    // output.png is a 200 pixels wide and 300 pixels high image
+    // containing a nearest-neighbour scaled version
+    // contained within the north-east corner of a semi-transparent white canvas
+  });
+```
 
 ```javascript
 const transformer = sharp()
-  .resize(200, 200)
+  .resize({
-  .crop(sharp.strategy.entropy)
+    width: 200,
-  .on('error', function(err) {
+    height: 200,
-    console.log(err);
+    fit: sharp.fit.cover,
+    position: sharp.strategy.entropy
   });
 // Read image data from readableStream
 // Write 200px square auto-cropped image data to writableStream
-readableStream.pipe(transformer).pipe(writableStream);
+readableStream
+  .pipe(transformer)
+  .pipe(writableStream);
 ```
 
--   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
-
-Returns **Sharp** 
-
-## embed
-
-Preserving aspect ratio, resize the image to the maximum `width` or `height` specified
-then embed on a background of the exact `width` and `height` specified.
-
-If the background contains an alpha value then WebP and PNG format output images will
-contain an alpha channel, even when the input image does not.
-
-**Examples**
-
 ```javascript
-sharp('input.gif')
+sharp(input)
-  .resize(200, 300)
+  .resize(200, 200, {
-  .background({r: 0, g: 0, b: 0, alpha: 0})
+    fit: sharp.fit.inside,
-  .embed()
+    withoutEnlargement: true
-  .toFormat(sharp.format.webp)
+  })
-  .toBuffer(function(err, outputBuffer) {
-    if (err) {
-      throw err;
-    }
-    // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
-    // containing a scaled version, embedded on a transparent canvas, of input.gif
-  });
-```
-
-Returns **Sharp** 
-
-## max
-
-Preserving aspect ratio, resize the image to be as large as possible
-while ensuring its dimensions are less than or equal to the `width` and `height` specified.
-
-Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
-
-**Examples**
-
-```javascript
-sharp(inputBuffer)
-  .resize(200, 200)
-  .max()
   .toFormat('jpeg')
   .toBuffer()
   .then(function(outputBuffer) {
-    // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
+    // outputBuffer contains JPEG image data
-    // than 200 pixels regardless of the inputBuffer image dimensions
+    // no wider and no higher than 200 pixels
+    // and no larger than the input image
   });
 ```
 
-Returns **Sharp** 
+-   Throws **[Error][13]** Invalid parameters
-
-## 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
+## extend
 
-Ignoring the aspect ratio of the input, stretch the image to
+Extends/pads the edges of the image with the provided background colour.
-the exact `width` and/or `height` provided via `resize`.
+This operation will always occur after resizing and extraction, if any.
+
+### Parameters
+
+-   `extend` **([Number][8] \| [Object][9])** single pixel count to add to all edges or an Object with per-edge counts
+    -   `extend.top` **[Number][8]?** 
+    -   `extend.left` **[Number][8]?** 
+    -   `extend.bottom` **[Number][8]?** 
+    -   `extend.right` **[Number][8]?** 
+    -   `extend.background` **([String][10] \| [Object][9])** background colour, parsed by the [color][11] module, defaults to black without transparency. (optional, default `{r:0,g:0,b:0,alpha: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)
+  .extend({
+    top: 10,
+    bottom: 20,
+    left: 10,
+    right: 10,
+    background: { r: 0, g: 0, b: 0, alpha: 0 }
+  })
+  ...
+```
+
+-   Throws **[Error][13]** Invalid parameters
 
 Returns **Sharp** 
 
-## withoutEnlargement
+## extract
 
-Do not enlarge the output image if the input image width _or_ height are already less than the required dimensions.
+Extract a region of the image.
-This is equivalent to GraphicsMagick's `>` geometry option:
-"_change the dimensions of the image only if its width or height exceeds the geometry specification_".
 
-**Parameters**
+-   Use `extract` before `resize` for pre-resize extraction.
+-   Use `extract` after `resize` for post-resize extraction.
+-   Use `extract` before and after for both.
 
--   `withoutEnlargement` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `true`)
+### Parameters
+
+-   `options` **[Object][9]** describes the region to extract using integral pixel values
+    -   `options.left` **[Number][8]** zero-indexed offset from left edge
+    -   `options.top` **[Number][8]** zero-indexed offset from top edge
+    -   `options.width` **[Number][8]** width of region to extract
+    -   `options.height` **[Number][8]** height of region to extract
+
+### 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][13]** Invalid parameters
 
 Returns **Sharp** 
+
+## trim
+
+Trim "boring" pixels from all edges that contain values similar to the top-left pixel.
+Images consisting entirely of a single colour will calculate "boring" using the alpha channel, if any.
+
+The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
+
+### Parameters
+
+-   `threshold` **[Number][8]** the allowed difference from the top-left pixel, a number greater than zero. (optional, default `10`)
+
+
+-   Throws **[Error][13]** Invalid parameters
+
+Returns **Sharp** 
+
+[1]: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
+
+[2]: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
+
+[3]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29
+
+[4]: http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
+
+[5]: https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline
+
+[6]: https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf
+
+[7]: https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[11]: https://www.npmjs.org/package/color
+
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

docs/api-utility.md

@@ -1,27 +1,20 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### Table of Contents
-
--   [cache](#cache)
--   [concurrency](#concurrency)
--   [counters](#counters)
--   [simd](#simd)
-
 ## cache
 
-Gets, or when options are provided sets, the limits of _libvips'_ operation cache.
+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**
+### Parameters
 
--   `options` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
+-   `options` **([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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum memory in MB to use for this cache (optional, default `50`)
+    -   `options.memory` **[Number][3]** is the maximum memory in MB to use for this cache (optional, default `50`)
-    -   `options.files` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum number of files to hold open (optional, default `20`)
+    -   `options.files` **[Number][3]** is the maximum number of files to hold open (optional, default `20`)
-    -   `options.items` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is the maximum number of operations to cache (optional, default `100`)
+    -   `options.items` **[Number][3]** is the maximum number of operations to cache (optional, default `100`)
 
-**Examples**
+### Examples
 
 ```javascript
 const stats = sharp.cache();
@@ -33,11 +26,11 @@ sharp.cache( { files: 0 } );
 sharp.cache(false);
 ```
 
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+Returns **[Object][1]** 
 
 ## concurrency
 
-Gets, or when a concurrency is provided sets,
+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.
@@ -47,11 +40,11 @@ is limited by libuv's `UV_THREADPOOL_SIZE` environment variable.
 
 This method always returns the current concurrency.
 
-**Parameters**
+### Parameters
 
--   `concurrency` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** 
+-   `concurrency` **[Number][3]?** 
 
-**Examples**
+### Examples
 
 ```javascript
 const threads = sharp.concurrency(); // 4
@@ -59,7 +52,7 @@ sharp.concurrency(2); // 2
 sharp.concurrency(0); // 4
 ```
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** concurrency
+Returns **[Number][3]** concurrency
 
 ## counters
 
@@ -68,13 +61,13 @@ 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**
+### Examples
 
 ```javascript
 const counters = sharp.counters(); // { queue: 2, process: 4 }
 ```
 
-Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+Returns **[Object][1]** 
 
 ## simd
 
@@ -84,23 +77,26 @@ 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.
+### Parameters
-Versions of liborc prior to 0.4.25 are known to segfault under heavy load.
 
-**Parameters**
+-   `simd` **[Boolean][2]**  (optional, default `true`)
 
--   `simd` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**  (optional, default `false`)
+### Examples
-
-**Examples**
 
 ```javascript
 const simd = sharp.simd();
-// simd is `true` if SIMD is currently enabled
+// simd is `true` if the runtime use of liborc is currently enabled
 ```
 
 ```javascript
-const simd = sharp.simd(true);
+const simd = sharp.simd(false);
-// attempts to enable the use of SIMD, returning true if available
+// prevent libvips from using liborc at runtime
 ```
 
-Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+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/changelog.md

@@ -1,5 +1,495 @@
 # Changelog
 
+### v0.23 - "*vision*"
+
+Requires libvips v8.8.1.
+
+#### v0.23.3 - 17<sup>th</sup> November 2019
+
+* Ensure `trim` operation supports images contained in the alpha channel.
+  [#1597](https://github.com/lovell/sharp/issues/1597)
+
+* Ensure tile `overlap` option works as expected.
+  [#1921](https://github.com/lovell/sharp/pull/1921)
+  [@rustyguts](https://github.com/rustyguts)
+
+* Allow compilation on FreeBSD and variants (broken since v0.23.0)
+  [#1952](https://github.com/lovell/sharp/pull/1952)
+  [@pouya-eghbali](https://github.com/pouya-eghbali)
+
+* Ensure `modulate` and other colour-based operations can co-exist.
+  [#1958](https://github.com/lovell/sharp/issues/1958)
+
+#### v0.23.2 - 28<sup>th</sup> October 2019
+
+* Add `background` option to tile output operation.
+  [#1924](https://github.com/lovell/sharp/pull/1924)
+  [@neave](https://github.com/neave)
+
+* Add support for Node.js 13.
+  [#1932](https://github.com/lovell/sharp/pull/1932)
+  [@MayhemYDG](https://github.com/MayhemYDG)
+
+#### v0.23.1 - 26<sup>th</sup> September 2019
+
+* Ensure `sharp.format.vips` is present and correct (filesystem only).
+  [#1813](https://github.com/lovell/sharp/issues/1813)
+
+* Ensure invalid `width` and `height` provided as options to `resize` throw.
+  [#1817](https://github.com/lovell/sharp/issues/1817)
+
+* Allow use of 'heic' and 'heif' identifiers with `toFormat`.
+  [#1834](https://github.com/lovell/sharp/pull/1834)
+  [@jaubourg](https://github.com/jaubourg)
+
+* Add `premultiplied` option to `composite` operation.
+  [#1835](https://github.com/lovell/sharp/pull/1835)
+  [@Andargor](https://github.com/Andargor)
+
+* Allow instance reuse with differing `toBuffer` options.
+  [#1860](https://github.com/lovell/sharp/pull/1860)
+  [@RaboliotTheGrey](https://github.com/RaboliotTheGrey)
+
+* Ensure image is at least 3x3 pixels before attempting trim operation.
+
+#### v0.23.0 - 29<sup>th</sup> July 2019
+
+* Remove `overlayWith` previously deprecated in v0.22.0.
+
+* Add experimental support for HEIF images. Requires libvips compiled with libheif.
+  [#1105](https://github.com/lovell/sharp/issues/1105)
+
+* Expose libwebp `smartSubsample` and `reductionEffort` options.
+  [#1545](https://github.com/lovell/sharp/issues/1545)
+
+* Add experimental support for Worker Threads.
+  [#1558](https://github.com/lovell/sharp/issues/1558)
+
+* Use libvips' built-in CMYK and sRGB profiles when required.
+  [#1619](https://github.com/lovell/sharp/issues/1619)
+
+* Drop support for Node.js versions 6 and 11.
+  [#1674](https://github.com/lovell/sharp/issues/1674)
+
+* Expose `skipBlanks` option for tile-based output.
+  [#1687](https://github.com/lovell/sharp/pull/1687)
+  [@RaboliotTheGrey](https://github.com/RaboliotTheGrey)
+
+* Allow use of `failOnError` option with Stream-based input.
+  [#1691](https://github.com/lovell/sharp/issues/1691)
+
+* Fix rotate/extract ordering for non-90 angles.
+  [#1755](https://github.com/lovell/sharp/pull/1755)
+  [@iovdin](https://github.com/iovdin)
+
+### v0.22 - "*uptake*"
+
+Requires libvips v8.7.4.
+
+#### v0.22.1 - 25<sup>th</sup> April 2019
+
+* Add `modulate` operation for brightness, saturation and hue.
+  [#1601](https://github.com/lovell/sharp/pull/1601)
+  [@Goues](https://github.com/Goues)
+
+* Improve help messaging should `require("sharp")` fail.
+  [#1638](https://github.com/lovell/sharp/pull/1638)
+  [@sidharthachatterjee](https://github.com/sidharthachatterjee)
+
+* Add support for Node 12.
+  [#1668](https://github.com/lovell/sharp/issues/1668)
+
+#### v0.22.0 - 18<sup>th</sup> March 2019
+
+* Remove functions previously deprecated in v0.21.0:
+    `background`, `crop`, `embed`, `ignoreAspectRatio`, `max`, `min` and `withoutEnlargement`.
+
+* Add `composite` operation supporting multiple images and blend modes; deprecate `overlayWith`.
+  [#728](https://github.com/lovell/sharp/issues/728)
+
+* Add support for `pages` input option for multi-page input.
+  [#1566](https://github.com/lovell/sharp/issues/1566)
+
+* Allow Stream-based input of raw pixel data.
+  [#1579](https://github.com/lovell/sharp/issues/1579)
+
+* Add support for `page` input option to GIF and PDF.
+  [#1595](https://github.com/lovell/sharp/pull/1595)
+  [@ramiel](https://github.com/ramiel)
+
+### v0.21 - "*teeth*"
+
+Requires libvips v8.7.0.
+
+#### v0.21.3 - 19<sup>th</sup> January 2019
+
+* Input image decoding now fails fast, set `failOnError` to change this behaviour.
+
+* Failed filesystem-based input now separates missing file and invalid format errors.
+  [#1542](https://github.com/lovell/sharp/issues/1542)
+
+#### v0.21.2 - 13<sup>th</sup> January 2019
+
+* Ensure all metadata is removed from PNG output unless `withMetadata` used.
+
+* Ensure shortest edge is at least one pixel after resizing.
+  [#1003](https://github.com/lovell/sharp/issues/1003)
+
+* Add `ensureAlpha` operation to add an alpha channel, if missing.
+  [#1153](https://github.com/lovell/sharp/issues/1153)
+
+* Expose `pages` and `pageHeight` metadata for multi-page input images.
+  [#1205](https://github.com/lovell/sharp/issues/1205)
+
+* Expose PNG output options requiring libimagequant.
+  [#1484](https://github.com/lovell/sharp/issues/1484)
+
+* Expose underlying error message for invalid input.
+  [#1505](https://github.com/lovell/sharp/issues/1505)
+
+* Prevent mutatation of options passed to `jpeg`.
+  [#1516](https://github.com/lovell/sharp/issues/1516)
+
+* Ensure forced output format applied correctly when output chaining.
+  [#1528](https://github.com/lovell/sharp/issues/1528)
+
+#### v0.21.1 - 7<sup>th</sup> December 2018
+
+* Install: support `sharp_dist_base_url` npm config, like existing `SHARP_DIST_BASE_URL`.
+  [#1422](https://github.com/lovell/sharp/pull/1422)
+  [@SethWen](https://github.com/SethWen)
+
+* Ensure `channel` metadata is correct for raw, greyscale output.
+  [#1425](https://github.com/lovell/sharp/issues/1425)
+
+* Add support for the "mitchell" kernel for image reductions.
+  [#1438](https://github.com/lovell/sharp/pull/1438)
+  [@Daiz](https://github.com/Daiz)
+
+* Allow separate parameters for gamma encoding and decoding.
+  [#1439](https://github.com/lovell/sharp/pull/1439)
+  [@Daiz](https://github.com/Daiz)
+
+* Build prototype with `Object.assign` to allow minification.
+  [#1475](https://github.com/lovell/sharp/pull/1475)
+  [@jaubourg](https://github.com/jaubourg)
+
+* Expose libvips' recombination matrix operation.
+  [#1477](https://github.com/lovell/sharp/pull/1477)
+  [@fromkeith](https://github.com/fromkeith)
+
+* Expose libvips' pyramid/tile options for TIFF output.
+  [#1483](https://github.com/lovell/sharp/pull/1483)
+  [@mbklein](https://github.com/mbklein)
+
+#### v0.21.0 - 4<sup>th</sup> October 2018
+
+* Deprecate the following resize-related functions:
+    `crop`, `embed`, `ignoreAspectRatio`, `max`, `min` and `withoutEnlargement`.
+  Access to these is now via options passed to the `resize` function.
+  For example:
+    `embed('north')` is now `resize(width, height, { fit: 'contain', position: 'north' })`,
+    `crop('attention')` is now `resize(width, height, { fit: 'cover', position: 'attention' })`,
+    `max().withoutEnlargement()` is now `resize(width, height, { fit: 'inside', withoutEnlargement: true })`.
+  [#1135](https://github.com/lovell/sharp/issues/1135)
+
+* Deprecate the `background` function.
+    Per-operation `background` options added to `resize`, `extend` and `flatten` operations.
+  [#1392](https://github.com/lovell/sharp/issues/1392)
+
+* Add `size` to `metadata` response (Stream and Buffer input only).
+  [#695](https://github.com/lovell/sharp/issues/695)
+
+* Switch from custom trim operation to `vips_find_trim`.
+  [#914](https://github.com/lovell/sharp/issues/914)
+
+* Add `chromaSubsampling` and `isProgressive` properties to `metadata` response.
+  [#1186](https://github.com/lovell/sharp/issues/1186)
+
+* Drop Node 4 support.
+  [#1212](https://github.com/lovell/sharp/issues/1212)
+
+* Enable SIMD convolution by default.
+  [#1213](https://github.com/lovell/sharp/issues/1213)
+
+* Add experimental prebuilt binaries for musl-based Linux.
+  [#1379](https://github.com/lovell/sharp/issues/1379)
+
+* Add support for arbitrary rotation angle via vips_rotate.
+  [#1385](https://github.com/lovell/sharp/pull/1385)
+  [@freezy](https://github.com/freezy)
+
+### v0.20 - "*prebuild*"
+
+Requires libvips v8.6.1.
+
+#### v0.20.8 - 5<sup>th</sup> September 2018
+
+* Avoid race conditions when creating directories during installation.
+  [#1358](https://github.com/lovell/sharp/pull/1358)
+  [@ajhool](https://github.com/ajhool)
+
+* Accept floating point values for input density parameter.
+  [#1362](https://github.com/lovell/sharp/pull/1362)
+  [@aeirola](https://github.com/aeirola)
+
+#### 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.

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/image/sharp-logo.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="86 86 550 550">
+<!-- Copyright 2019 Lovell Fuller. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License. -->
+<path fill="none" stroke="#9c0" stroke-width="80" d="M258.411 285.777l200.176-26.8M244.113 466.413L451.44 438.66M451.441 438.66V238.484M451.441 88.363v171.572l178.725-23.917M270.323 255.602V477.22M272.71 634.17V462.591L93.984 486.515"/>
+<path fill="none" stroke="#090" stroke-width="80" d="M451.441 610.246V438.66l178.725-23.91M269.688 112.59v171.58L90.964 308.093"/>
+</svg>

docs/index.md

@@ -1,11 +1,14 @@
 # sharp
 
+<img src="image/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
+
 The typical use case for this high speed Node.js module
 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-5x faster than using the
-quickest ImageMagick and GraphicsMagick settings.
+quickest ImageMagick and GraphicsMagick settings
+due to its use of [libvips](https://github.com/libvips/libvips).
 
 Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
 Lanczos resampling ensures quality is not sacrificed for speed.
@@ -13,8 +16,9 @@ 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.
 
-OS X, Windows (x64), Linux (x64, ARM) systems do not require
+Most modern 64-bit OS X, Windows and Linux systems running
-the installation of any external runtime dependencies.
+Node versions 8, 10, 12 and 13
+do not require any additional install or runtime dependencies.
 
 [![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.png?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master)
 
@@ -22,7 +26,7 @@ the installation of any external runtime dependencies.
 
 This module supports reading JPEG, PNG, WebP, TIFF, GIF and SVG images.
 
-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.
 
@@ -36,7 +40,7 @@ and [Leaflet](https://github.com/turban/Leaflet.Zoomify).
 ### Fast
 
 This module is powered by the blazingly fast
-[libvips](https://github.com/jcupitt/libvips) image processing library,
+[libvips](https://github.com/libvips/libvips) image processing library,
 originally created in 1989 at Birkbeck College
 and currently maintained by
 [John Cupitt](https://github.com/jcupitt).
@@ -46,7 +50,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
 
@@ -55,13 +59,13 @@ 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
 
-A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
+A [guide for contributors](https://github.com/lovell/sharp/blob/master/.github/CONTRIBUTING.md)
 covers reporting bugs, requesting features and submitting code changes.
 
 ### Credits
@@ -99,17 +103,45 @@ the help and code contributions of the following people:
 * [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)
+* [Aidan Hoolachan](https://github.com/ajhool)
+* [Axel Eirola](https://github.com/aeirola)
+* [Freezy](https://github.com/freezy)
+* [Julian Aubourg](https://github.com/jaubourg)
+* [Keith Belovay](https://github.com/fromkeith)
+* [Michael B. Klein](https://github.com/mbklein)
+* [Jakub Michálek](https://github.com/Goues)
+* [Ilya Ovdin](https://github.com/iovdin)
+* [Andargor](https://github.com/Andargor)
+* [Nicolas Stepien](https://github.com/MayhemYDG)
+* [Paul Neave](https://github.com/neave)
+* [Brendan Kennedy](https://github.com/rustyguts)
 
 Thank you!
 
-### Licence
+### Licensing
 
-Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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](http://www.apache.org/licenses/LICENSE-2.0.html)
+[https://www.apache.org/licenses/LICENSE-2.0](https://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,

docs/install.md

@@ -8,56 +8,86 @@ npm install sharp
 yarn add sharp
 ```
 
-### Prerequisites
+## Prerequisites
+
+* Node.js v8.5.0+
+
+### Building from source
+
+Pre-compiled binaries for sharp are provided for use with
+Node versions 8, 10, 12 and 13 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:
 
-* Node v4+
 * 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)
+* [node-gyp](https://github.com/nodejs/node-gyp#installation) and its dependencies (includes Python 2.7)
+
+## 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/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 6.5MB.
+This involves an automated HTTPS download of approximately 10MB.
 
-Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work", e.g.:
+Most Linux-based (glibc, musl) operating systems running on x64 and ARMv6+ CPUs should "just work", e.g.:
 
-* Debian 7, 8
+* Debian 8+
-* Ubuntu 12.04, 14.04, 16.04
+* Ubuntu 14.04+
-* Centos 7
+* Red Hat Enterprise 7+
-* Fedora
+* CentOS 7+
-* openSUSE 13.2
+* Alpine 3.10+
+* Fedora 21+
+* openSUSE 13.2+
 * Archlinux
 * Raspbian Jessie
-* Amazon Linux 2016.03, 2016.09
+* 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-stadard paths (anything other than `/usr` or `/usr/local`),
+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.
 
 This allows the use of newer versions of libvips with older versions of sharp.
 
-For 32-bit Intel CPUs and older Linux-based operating systems such as Centos 6,
+For 32-bit Intel CPUs and older Linux-based operating systems such as
-it is recommended to install a system-wide installation of libvips from source:
+those based on Red Hat Enterprise 6 (e.g. CentOS 6)
+compiling libvips from source is recommended.
 
-https://github.com/jcupitt/libvips#building-libvips-from-a-source-tarball
+[https://libvips.github.io/libvips/install.html#building-libvips-from-a-source-tarball](https://libvips.github.io/libvips/install.html#building-libvips-from-a-source-tarball)
 
-For Linux-based operating systems such as Alpine that use musl libc,
+#### Alpine Linux
-the smaller stack size means libvips' cache should be disabled
+
+libvips is available in the
+[community repository](https://pkgs.alpinelinux.org/packages?name=vips-dev):
+
+```sh
+apk add --upgrade --no-cache vips-dev build-base \
+  --repository https://alpine.global.ssl.fastly.net/alpine/v3.10/community/
+```
+
+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.png?branch=master)](https://travis-ci.org/lovell/sharp)
+[![OS X 10.12 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
 
 libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 6.3MB.
+This involves an automated HTTPS download of approximately 8MB.
 
 To use your own 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
@@ -68,23 +98,30 @@ that it can be located using `pkg-config --modversion vips-cpp`.
 [![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\vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 9MB.
+This involves an automated HTTPS download of approximately 10MB.
+If you are having issues during installation consider removing the directory
+`C:\Users\[user]\AppData\Roaming\npm-cache\_libvips`.
 
 Only 64-bit (x64) `node.exe` is supported.
 
 ### FreeBSD
 
 libvips must be installed before `npm install` is run.
-This can be achieved via [FreshPorts](https://www.freshports.org/graphics/vips/):
+
+This can be achieved via package or ports:
+
+```sh
+pkg install -y pkgconf vips
+```
 
 ```sh
 cd /usr/ports/graphics/vips/ && make install clean
 ```
 
-### Heroku
+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
 
-libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
+### Heroku
-This involves an automated HTTPS download of approximately 6.5MB.
 
 Set [NODE_MODULES_CACHE](https://devcenter.heroku.com/articles/nodejs-support#cache-behavior)
 to `false` when using the `yarn` package manager.
@@ -105,38 +142,59 @@ 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
 
-In order to use sharp on AWS Lambda, you need to [create a deployment package](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html). Because sharp
+Set the Lambda runtime to `nodejs10.x`.
-downloads and links libraries for the current platform during `npm install` you have to
-do this on a system similar to the [Lambda Execution Environment](http://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html). The easiest ways to do this, is to setup a
-small t2.micro instance using the AMI ID listed in the previous link, ssh into it as ec2-user
-and follow the instructions below.
 
-Install dependencies:
+The binaries in the `node_modules` directory of the
+[deployment package](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html)
+must be for the Linux x64 platform/architecture.
+
+On non-Linux machines such as OS X and Windows run the following:
 
 ```sh
-curl -s https://rpm.nodesource.com/setup_4.x | sudo bash -
+rm -rf node_modules/sharp
-sudo yum install -y gcc-c++ nodejs
+npm install --arch=x64 --platform=linux --target=10.15.0 sharp
 ```
 
-Copy your code and package.json to the instance using `scp` and create a deployment package:
+Alternatively a Docker container closely matching the Lambda runtime can be used:
 
 ```sh
-cd sharp-lambda-example
+rm -rf node_modules/sharp
-npm install
+docker run -v "$PWD":/var/task lambci/lambda:build-nodejs10.x npm install sharp
-zip -ur9 ../sharp-lambda-example.zip index.js node_modules
 ```
 
-You can now download your deployment ZIP using `scp` and upload it to Lambda. Be sure to set your Lambda runtime to Node.js 4.3.
+To get the best performance select the largest memory available.
+A 1536 MB function provides ~12x more CPU time than a 128 MB function.
 
-**Performance Tip:** To get the best performance on Lambda choose the largest memory available because this also gives you the most cpu time (a 1536 MB function is 12x faster than a 128 MB function).
+### 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
+```
+
+[http://docs.nwjs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/](http://docs.nwjs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/)
 
 ### Build tools
 
 * [gulp-responsive](https://www.npmjs.com/package/gulp-responsive)
 * [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)
@@ -154,38 +212,45 @@ 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,
+### Pre-compiled libvips binaries
-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
+This module will attempt to download a pre-compiled bundle of libvips
-<policymap>
+and its dependencies on Linux and Windows machines under either of these
-  <policy domain="coder" rights="none" pattern="EPHEMERAL" />
+conditions:
-  <policy domain="coder" rights="none" pattern="URL" />
+
-  <policy domain="coder" rights="none" pattern="HTTPS" />
+1. If a global installation of libvips that meets the
-  <policy domain="coder" rights="none" pattern="MVG" />
+minimum version requirement cannot be found;
-  <policy domain="coder" rights="none" pattern="MSL" />
+1. If `SHARP_IGNORE_GLOBAL_LIBVIPS` environment variable is set.
-  <policy domain="coder" rights="none" pattern="TEXT" />
+
-  <policy domain="coder" rights="none" pattern="SHOW" />
+```sh
-  <policy domain="coder" rights="none" pattern="WIN" />
+SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install sharp
-  <policy domain="coder" rights="none" pattern="PLT" />
-</policymap>
 ```
 
-Set the `MAGICK_CONFIGURE_PATH` environment variable
+Should you need to manually download and inspect these files,
-to the directory containing the `policy.xml` file.
+you can do so via
+[https://github.com/lovell/sharp-libvips/releases](https://github.com/lovell/sharp-libvips/releases)
+
+Should you wish to install these from your own location,
+set the `sharp_dist_base_url` npm config option, e.g.
+
+```sh
+npm config set sharp_dist_base_url "https://hostname/path/"
+npm install sharp
+```
+
+or 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`.
+
+To install the prebuilt sharp binaries from a custom URL, please see
+[https://github.com/prebuild/prebuild-install#custom-binaries](https://github.com/prebuild/prebuild-install#custom-binaries)
 
 ### Licences
 
-If a global installation of libvips that meets the
-minimum version requirement cannot be found,
-this module will download a pre-compiled bundle of libvips
-and its dependencies on Linux and Windows machines.
-
-Should you need to manually download and inspect these files,
-you can do so via https://dl.bintray.com/lovell/sharp/
-
 This module is licensed under the terms of the
 [Apache 2.0 Licence](https://github.com/lovell/sharp/blob/master/LICENSE).
 
@@ -199,8 +264,11 @@ Use of libraries under the terms of the LGPLv3 is via the
 | 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) |
+| fribidi       | LGPLv3                                                                                                   |
+| gettext       | LGPLv3                                                                                                   |
 | giflib        | MIT Licence                                                                                              |
 | glib          | LGPLv3                                                                                                   |
 | harfbuzz      | MIT Licence                                                                                              |

docs/performance.md

@@ -2,19 +2,17 @@
 
 ### Test environment
 
-* AWS EC2 eu-central-1 [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)
-* Ubuntu 16.04.1 LTS (HVM, SSD, 20161115, ami-82cf0aed)
+* Ubuntu 18.04 (hvm-ssd/ubuntu-bionic-18.04-amd64-server-20180912 ami-00035f41c82244dab)
-* Node.js v6.9.1
+* Node.js v12.10.0
 
 ### The contenders
 
-* [jimp](https://www.npmjs.com/package/jimp) v0.2.27 - Image processing in pure JavaScript. Bilinear interpolation only.
+* [jimp](https://www.npmjs.com/package/jimp) v0.8.4 - Image processing in pure JavaScript. Provides bicubic interpolation.
-* [lwip](https://www.npmjs.com/package/lwip) v0.0.9 - Wrapper around CImg. Compiles outdated, insecure dependencies from source.
+* [mapnik](https://www.npmjs.org/package/mapnik) v4.3.1 - Whilst primarily a map renderer, Mapnik contains bitmap image utilities.
-* [mapnik](https://www.npmjs.org/package/mapnik) v3.5.14 - Whilst primarily a map renderer, Mapnik contains bitmap image utilities.
-* [imagemagick-native](https://www.npmjs.com/package/imagemagick-native) v1.9.3 - Wrapper around libmagick++, supports Buffers only.
 * [imagemagick](https://www.npmjs.com/package/imagemagick) v0.1.3 - Supports filesystem only and "*has been unmaintained for a long time*".
-* [gm](https://www.npmjs.com/package/gm) v1.23.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.17.0 / libvips v8.4.2 - Caching within libvips disabled to ensure a fair comparison.
+* sharp v0.23.1 / libvips v8.8.1 - Caching within libvips disabled to ensure a fair comparison.
 
 ### The task
 
@@ -26,18 +24,14 @@ then compress to JPEG at a "quality" setting of 80.
 
 | Module             | Input  | Output | Ops/sec | Speed-up |
 | :----------------- | :----- | :----- | ------: | -------: |
-| jimp (bilinear)    | buffer | buffer |    1.06 |      1.0 |
+| jimp               | buffer | buffer |    0.66 |      1.0 |
-| lwip               | buffer | buffer |    1.87 |      1.8 |
+| mapnik             | buffer | buffer |    3.31 |      5.0 |
-| mapnik             | buffer | buffer |    2.91 |      2.7 |
+| gm                 | buffer | buffer |    3.79 |      5.7 |
-| imagemagick-native | buffer | buffer |    4.03 |      3.8 |
+| gm                 | file   | file   |    3.82 |      5.8 |
-| imagemagick        | file   | file   |    7.10 |      6.7 |
+| imagemagick        | file   | file   |    4.17 |      6.3 |
-| gm                 | buffer | buffer |    7.08 |      6.7 |
+| sharp              | stream | stream |   25.81 |     39.1 |
-| gm                 | file   | file   |    7.10 |      6.7 |
+| sharp              | file   | file   |   26.76 |     40.5 |
-| sharp              | stream | stream |   27.61 |     26.0 |
+| sharp              | buffer | buffer |   28.06 |     42.5 |
-| sharp              | file   | file   |   28.41 |     26.8 |
-| sharp              | buffer | file   |   28.71 |     27.1 |
-| sharp              | file   | buffer |   28.60 |     27.0 |
-| sharp              | buffer | buffer |   29.08 |     27.4 |
 
 Greater libvips performance can be expected with caching enabled (default)
 and using 8+ core machines, especially those with larger L1/L2 CPU caches.
@@ -46,19 +40,20 @@ The I/O limits of the relevant (de)compression library will generally determine
 
 ### 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 libmapnik-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

install/dll-copy.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+const libvips = require('../lib/libvips');
+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 {
+    libvips.mkdirSync(buildDir);
+    libvips.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) {
+        fs.copyFileSync(
+          path.join(vendorLibDir, filename),
+          path.join(buildReleaseDir, filename)
+        );
+      });
+  } catch (err) {
+    npmLog.error('sharp', err.message);
+  }
+}

install/libvips.js

@@ -0,0 +1,113 @@
+'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 agent = require('../lib/agent');
+const libvips = require('../lib/libvips');
+const platform = require('../lib/platform');
+
+const minimumLibvipsVersion = libvips.minimumLibvipsVersion;
+const distBaseUrl = process.env.npm_config_sharp_dist_base_url || process.env.SHARP_DIST_BASE_URL || `https://github.com/lovell/sharp-libvips/releases/download/v${minimumLibvipsVersion}/`;
+
+const fail = function (err) {
+  npmLog.error('sharp', err.message);
+  if (err.code === 'EACCES') {
+    npmLog.info('sharp', 'Are you trying to install as a root or sudo user? Try again with the --unsafe-perm flag');
+  }
+  npmLog.info('sharp', 'Attempting to build from source via node-gyp but this may fail due to the above error');
+  npmLog.info('sharp', 'Please see https://sharp.pixelplumbing.com/page/install for required dependencies');
+  process.exit(1);
+};
+
+const extractTarball = function (tarPath) {
+  const vendorPath = path.join(__dirname, '..', 'vendor');
+  libvips.mkdirSync(vendorPath);
+  tar
+    .extract({
+      file: tarPath,
+      cwd: vendorPath,
+      strict: true
+    })
+    .catch(function (err) {
+      if (/unexpected end of file/.test(err.message)) {
+        npmLog.error('sharp', `Please delete ${tarPath} as it is not a valid tarball`);
+      }
+      fail(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' || platformAndArch === 'openbsd-x64' || platformAndArch === 'sunos-x64') {
+      throw new Error(`BSD/SunOS systems require manual installation of libvips >= ${minimumLibvipsVersion}`);
+    }
+    if (detectLibc.family === detectLibc.GLIBC && detectLibc.version && semver.lt(`${detectLibc.version}.0`, '2.17.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) {
+          fail(err);
+        } else if (response.statusCode === 404) {
+          fail(new Error(`Prebuilt libvips binaries are not yet available for ${platformAndArch}`));
+        } else if (response.statusCode !== 200) {
+          fail(new Error(`Status ${response.statusCode} ${response.statusMessage}`));
+        } else {
+          response
+            .on('error', fail)
+            .pipe(tmpFile);
+        }
+      });
+      tmpFile
+        .on('error', fail)
+        .on('close', function () {
+          try {
+            // Attempt to rename
+            fs.renameSync(tarPathTemp, tarPathCache);
+          } catch (err) {
+            // Fall back to copy and unlink
+            fs.copyFileSync(tarPathTemp, tarPathCache);
+            fs.unlinkSync(tarPathTemp);
+          }
+          extractTarball(tarPathCache);
+        });
+    }
+  }
+} catch (err) {
+  fail(err);
+}

lib/agent.js

@@ -0,0 +1,40 @@
+'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 = new url.URL(proxies.map(env).find(is.string));
+    const tunnel = proxy.protocol === 'https:'
+      ? tunnelAgent.httpsOverHttps
+      : tunnelAgent.httpsOverHttp;
+    const proxyAuth = proxy.username && proxy.password
+      ? `${proxy.username}:${proxy.password}`
+      : null;
+    return tunnel({
+      proxy: {
+        port: Number(proxy.port),
+        host: proxy.hostname,
+        proxyAuth
+      }
+    });
+  } catch (err) {
+    return null;
+  }
+};

lib/channel.js

@@ -12,6 +12,40 @@ const bool = {
   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;
+}
+
+/**
+ * Ensure alpha channel, if missing. The added alpha channel will be fully opaque. This is a no-op if the image already has an alpha channel.
+ *
+ * @example
+ * sharp('rgb.jpg')
+ *   .ensureAlpha()
+ *   .toFile('rgba.png', function(err, info) {
+ *     // rgba.png is a 4 channel image with a fully opaque alpha channel
+ *   });
+ *
+ * @returns {Sharp}
+ */
+function ensureAlpha () {
+  this.options.ensureAlpha = true;
+  return this;
+}
+
 /**
  * Extract a single channel from a multi-channel image.
  *
@@ -38,7 +72,7 @@ function extractChannel (channel) {
   if (is.integer(channel) && is.inRange(channel, 0, 4)) {
     this.options.extractChannel = channel;
   } else {
-    throw new Error('Cannot extract invalid channel ' + channel);
+    throw is.invalidParameterError('channel', 'integer or one of: red, green, blue', channel);
   }
   return this;
 }
@@ -90,7 +124,7 @@ 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);
+    throw is.invalidParameterError('boolOp', 'one of: and, or, eor', boolOp);
   }
   return this;
 }
@@ -100,13 +134,13 @@ function bandbool (boolOp) {
  * @private
  */
 module.exports = function (Sharp) {
-  // Public instance functions
+  Object.assign(Sharp.prototype, {
-  [
+    // Public instance functions
+    removeAlpha,
+    ensureAlpha,
     extractChannel,
     joinChannel,
     bandbool
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
   // Class attributes
   Sharp.bool = bool;

lib/colour.js

@@ -16,25 +16,17 @@ const colourspace = {
 };
 
 /**
- * Set the background for the `embed`, `flatten` and `extend` operations.
+ * Tint the image using the provided chroma while preserving the image luminance.
- * The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
+ * An alpha channel may be present and will be unchanged by the operation.
  *
- * Delegates to the _color_ module, which can throw an Error
+ * @param {String|Object} rgb - parsed by the [color](https://www.npmjs.org/package/color) module to extract chroma values.
- * 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) {
+function tint (rgb) {
-  const colour = color(rgba);
+  const colour = color(rgb);
-  this.options.background = [
+  this.options.tintA = colour.a();
-    colour.red(),
+  this.options.tintB = colour.b();
-    colour.green(),
-    colour.blue(),
-    Math.round(colour.alpha() * 255)
-  ];
   return this;
 }
 
@@ -65,13 +57,13 @@ function grayscale (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)
+ * @param {String} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/libvips/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);
+    throw is.invalidParameterError('colourspace', 'string', colourspace);
   }
   this.options.colourspace = colourspace;
   return this;
@@ -87,20 +79,43 @@ function toColorspace (colorspace) {
   return this.toColourspace(colorspace);
 }
 
+/**
+ * Update a colour attribute of the this.options Object.
+ * @private
+ * @param {String} key
+ * @param {String|Object} value
+ * @throws {Error} Invalid value
+ */
+function _setBackgroundColourOption (key, value) {
+  if (is.defined(value)) {
+    if (is.object(value) || is.string(value)) {
+      const colour = color(value);
+      this.options[key] = [
+        colour.red(),
+        colour.green(),
+        colour.blue(),
+        Math.round(colour.alpha() * 255)
+      ];
+    } else {
+      throw is.invalidParameterError('background', 'object or string', value);
+    }
+  }
+}
+
 /**
  * Decorate the Sharp prototype with colour-related functions.
  * @private
  */
 module.exports = function (Sharp) {
-  // Public instance functions
+  Object.assign(Sharp.prototype, {
-  [
+    // Public
-    background,
+    tint,
     greyscale,
     grayscale,
     toColourspace,
-    toColorspace
+    toColorspace,
-  ].forEach(function (f) {
+    // Private
-    Sharp.prototype[f.name] = f;
+    _setBackgroundColourOption
   });
   // Class attributes
   Sharp.colourspace = colourspace;

lib/composite.js

@@ -3,22 +3,65 @@
 const is = require('./is');
 
 /**
- * Overlay (composite) an image over the processed (resized, extracted etc.) image.
+ * Blend modes.
+ * @member
+ * @private
+ */
+const blend = {
+  clear: 'clear',
+  source: 'source',
+  over: 'over',
+  in: 'in',
+  out: 'out',
+  atop: 'atop',
+  dest: 'dest',
+  'dest-over': 'dest-over',
+  'dest-in': 'dest-in',
+  'dest-out': 'dest-out',
+  'dest-atop': 'dest-atop',
+  xor: 'xor',
+  add: 'add',
+  saturate: 'saturate',
+  multiply: 'multiply',
+  screen: 'screen',
+  overlay: 'overlay',
+  darken: 'darken',
+  lighten: 'lighten',
+  'colour-dodge': 'colour-dodge',
+  'color-dodge': 'colour-dodge',
+  'colour-burn': 'colour-burn',
+  'color-burn': 'colour-burn',
+  'hard-light': 'hard-light',
+  'soft-light': 'soft-light',
+  difference: 'difference',
+  exclusion: 'exclusion'
+};
+
+/**
+ * Composite image(s) over the processed (resized, extracted etc.) image.
  *
- * The overlay image must be the same size or smaller than the processed image.
+ * The images to composite must be the same size or smaller than the processed image.
  * If both `top` and `left` options are provided, they take precedence over `gravity`.
  *
+ * The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
+ * `dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,
+ * `xor`, `add`, `saturate`, `multiply`, `screen`, `overlay`, `darken`, `lighten`,
+ * `colour-dodge`, `color-dodge`, `colour-burn`,`color-burn`,
+ * `hard-light`, `soft-light`, `difference`, `exclusion`.
+ *
+ * More information about blend modes can be found at
+ * https://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsBlendMode
+ * and https://www.cairographics.org/operators/
+ *
  * @example
  * sharp('input.png')
  *   .rotate(180)
  *   .resize(300)
- *   .flatten()
+ *   .flatten( { background: '#ff6600' } )
- *   .background('#ff6600')
+ *   .composite([{ input: 'overlay.png', gravity: 'southeast' }])
- *   .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
  *   .sharpen()
  *   .withMetadata()
- *   .quality(90)
+ *   .webp( { quality: 90 } )
- *   .webp()
  *   .toBuffer()
  *   .then(function(outputBuffer) {
  *     // outputBuffer contains upside down, 300px wide, alpha channel flattened
@@ -26,66 +69,96 @@ const is = require('./is');
  *     // 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[]} images - Ordered list of images to composite
- * @param {Object} [options]
+ * @param {Buffer|String} [images[].input] - Buffer containing image data, String containing the path to an image file, or Create object (see bellow)
- * @param {String} [options.gravity='centre'] - gravity at which to place the overlay.
+ * @param {Object} [images[].input.create] - describes a blank overlay to be created.
- * @param {Number} [options.top] - the pixel offset from the top edge.
+ * @param {Number} [images[].input.create.width]
- * @param {Number} [options.left] - the pixel offset from the left edge.
+ * @param {Number} [images[].input.create.height]
- * @param {Boolean} [options.tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
+ * @param {Number} [images[].input.create.channels] - 3-4
- * @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 {String|Object} [images[].input.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
- * @param {Number} [options.density=72] - integral number representing the DPI for vector overlay image.
+ * @param {String} [images[].blend='over'] - how to blend this image with the image below.
- * @param {Object} [options.raw] - describes overlay when using raw pixel data.
+ * @param {String} [images[].gravity='centre'] - gravity at which to place the overlay.
- * @param {Number} [options.raw.width]
+ * @param {Number} [images[].top] - the pixel offset from the top edge.
- * @param {Number} [options.raw.height]
+ * @param {Number} [images[].left] - the pixel offset from the left edge.
- * @param {Number} [options.raw.channels]
+ * @param {Boolean} [images[].tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
- * @param {Object} [options.create] - describes a blank overlay to be created.
+ * @param {Boolean} [images[].premultiplied=false] - set to true to avoid premultipling the image below. Equivalent to the `--premultiplied` vips option.
- * @param {Number} [options.create.width]
+ * @param {Number} [images[].density=72] - number representing the DPI for vector overlay image.
- * @param {Number} [options.create.height]
+ * @param {Object} [images[].raw] - describes overlay when using raw pixel data.
- * @param {Number} [options.create.channels] - 3-4
+ * @param {Number} [images[].raw.width]
- * @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.
+ * @param {Number} [images[].raw.height]
+ * @param {Number} [images[].raw.channels]
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function overlayWith (overlay, options) {
+function composite (images) {
-  this.options.overlay = this._createInputDescriptor(overlay, options, {
+  if (!Array.isArray(images)) {
-    allowStream: false
+    throw is.invalidParameterError('images to composite', 'array', images);
-  });
-  if (is.object(options)) {
-    if (is.defined(options.tile)) {
-      if (is.bool(options.tile)) {
-        this.options.overlayTile = options.tile;
-      } else {
-        throw new Error('Invalid overlay tile ' + options.tile);
-      }
-    }
-    if (is.defined(options.cutout)) {
-      if (is.bool(options.cutout)) {
-        this.options.overlayCutout = options.cutout;
-      } else {
-        throw new Error('Invalid overlay cutout ' + options.cutout);
-      }
-    }
-    if (is.defined(options.left) || is.defined(options.top)) {
-      if (
-        is.integer(options.left) && is.inRange(options.left, 0, this.constructor.maximum.width) &&
-        is.integer(options.top) && is.inRange(options.top, 0, this.constructor.maximum.height)
-      ) {
-        this.options.overlayXOffset = options.left;
-        this.options.overlayYOffset = options.top;
-      } else {
-        throw new Error('Invalid overlay left ' + options.left + ' and/or top ' + options.top);
-      }
-    }
-    if (is.defined(options.gravity)) {
-      if (is.integer(options.gravity) && is.inRange(options.gravity, 0, 8)) {
-        this.options.overlayGravity = options.gravity;
-      } else if (is.string(options.gravity) && is.integer(this.constructor.gravity[options.gravity])) {
-        this.options.overlayGravity = this.constructor.gravity[options.gravity];
-      } else {
-        throw new Error('Unsupported overlay gravity ' + options.gravity);
-      }
-    }
   }
+  this.options.composite = images.map(image => {
+    if (!is.object(image)) {
+      throw is.invalidParameterError('image to composite', 'object', image);
+    }
+    const { raw, density } = image;
+    const inputOptions = (raw || density) ? { raw, density } : undefined;
+    const composite = {
+      input: this._createInputDescriptor(image.input, inputOptions, { allowStream: false }),
+      blend: 'over',
+      tile: false,
+      left: -1,
+      top: -1,
+      gravity: 0,
+      premultiplied: false
+    };
+    if (is.defined(image.blend)) {
+      if (is.string(blend[image.blend])) {
+        composite.blend = blend[image.blend];
+      } else {
+        throw is.invalidParameterError('blend', 'valid blend name', image.blend);
+      }
+    }
+    if (is.defined(image.tile)) {
+      if (is.bool(image.tile)) {
+        composite.tile = image.tile;
+      } else {
+        throw is.invalidParameterError('tile', 'boolean', image.tile);
+      }
+    }
+    if (is.defined(image.left)) {
+      if (is.integer(image.left) && image.left >= 0) {
+        composite.left = image.left;
+      } else {
+        throw is.invalidParameterError('left', 'positive integer', image.left);
+      }
+    }
+    if (is.defined(image.top)) {
+      if (is.integer(image.top) && image.top >= 0) {
+        composite.top = image.top;
+      } else {
+        throw is.invalidParameterError('top', 'positive integer', image.top);
+      }
+    }
+    if (composite.left !== composite.top && Math.min(composite.left, composite.top) === -1) {
+      throw new Error('Expected both left and top to be set');
+    }
+    if (is.defined(image.gravity)) {
+      if (is.integer(image.gravity) && is.inRange(image.gravity, 0, 8)) {
+        composite.gravity = image.gravity;
+      } else if (is.string(image.gravity) && is.integer(this.constructor.gravity[image.gravity])) {
+        composite.gravity = this.constructor.gravity[image.gravity];
+      } else {
+        throw is.invalidParameterError('gravity', 'valid gravity', image.gravity);
+      }
+    }
+    if (is.defined(image.premultiplied)) {
+      if (is.bool(image.premultiplied)) {
+        composite.premultiplied = image.premultiplied;
+      } else {
+        throw is.invalidParameterError('premultiplied', 'boolean', image.premultiplied);
+      }
+    }
+
+    return composite;
+  });
   return this;
 }
 
@@ -94,5 +167,6 @@ function overlayWith (overlay, options) {
  * @private
  */
 module.exports = function (Sharp) {
-  Sharp.prototype.overlayWith = overlayWith;
+  Sharp.prototype.composite = composite;
+  Sharp.blend = blend;
 };

lib/constructor.js

@@ -1,35 +1,43 @@
 '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 sharp = require('../build/Release/sharp.node');
 
-// Versioning
+require('./libvips').hasVendoredLibvips();
-let versions = {
+
-  vips: sharp.libvipsVersion()
+let sharp;
-};
+/* istanbul ignore next */
-(function () {
+try {
-  // Does libvips meet minimum requirement?
+  sharp = require('../build/Release/sharp.node');
-  const libvipsVersionMin = require('../package.json').config.libvips;
+} catch (err) {
-  /* istanbul ignore if */
+  // Bail early if bindings aren't available
-  if (semver.lt(versions.vips, libvipsVersionMin)) {
+  const help = ['', 'Something went wrong installing the "sharp" module', '', err.message, ''];
-    throw new Error('Found libvips ' + versions.vips + ' but require at least ' + libvipsVersionMin);
+  if (/NODE_MODULE_VERSION/.test(err.message)) {
+    help.push('- Ensure the version of Node.js used at install time matches that used at runtime');
+  } else if (/invalid ELF header/.test(err.message)) {
+    help.push(`- Ensure "${process.platform}" is used at install time as well as runtime`);
+  } else {
+    help.push('- Remove the "node_modules/sharp" directory, run "npm install" and look for errors');
   }
-  // Include versions of dependencies, if present
+  help.push(
-  try {
+    '- Consult the installation documentation at https://sharp.pixelplumbing.com/en/stable/install/',
-    versions = require('../vendor/lib/versions.json');
+    '- Search for this error at https://github.com/lovell/sharp/issues', ''
-  } catch (err) {}
+  );
-})();
+  console.error(help.join('\n'));
+  process.exit(1);
+}
+
+// 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 or WebP format image data can be streamed out from this object.
+ * 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.
@@ -56,12 +64,12 @@ let versions = {
  *
  * @example
  * // Create a blank 300x200 PNG image of semi-transluent red pixels
- * sharp(null, {
+ * sharp({
  *   create: {
  *     width: 300,
  *     height: 200,
  *     channels: 4,
- *     background: { r: 255, g: 0, b: 0, alpha: 128 }
+ *     background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  *   }
  * })
  * .png()
@@ -70,10 +78,14 @@ let versions = {
  *
  * @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.
+ *  a String containing the filesystem path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
- *  JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when null or undefined.
+ *  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 {Number} [options.density=72] - integral number representing the DPI for vector images.
+ * @param {Boolean} [options.failOnError=true] - by default halt processing and raise an error when loading invalid images.
+ *  Set this flag to `false` if you'd rather apply a "best effort" to decode images, even if the data is corrupt or invalid.
+ * @param {Number} [options.density=72] - number representing the DPI for vector images.
+ * @param {Number} [options.pages=1] - number of pages to extract for multi-page input (GIF, TIFF, PDF), use -1 for all pages.
+ * @param {Number} [options.page=0] - page number to start extracting from for multi-page input (GIF, TIFF, PDF), zero based.
  * @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]
@@ -87,6 +99,9 @@ let versions = {
  * @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);
   }
@@ -94,9 +109,7 @@ const Sharp = function (input, options) {
   this.options = {
     // input options
     sequentialRead: false,
-    limitInputPixels: maximum.pixels,
+    limitInputPixels: Math.pow(0x3FFF, 2),
-    // ICC profiles
-    iccProfilePath: path.join(__dirname, 'icc') + path.sep,
     // resize options
     topOffsetPre: -1,
     leftOffsetPre: -1,
@@ -109,8 +122,12 @@ const Sharp = function (input, options) {
     width: -1,
     height: -1,
     canvas: 'crop',
-    crop: 0,
+    position: 0,
+    resizeBackground: [0, 0, 0, 255],
+    useExifOrientation: false,
     angle: 0,
+    rotationAngle: 0,
+    rotationBackground: [0, 0, 0, 255],
     rotateBeforePreExtract: false,
     flip: false,
     flop: false,
@@ -118,35 +135,39 @@ const Sharp = function (input, options) {
     extendBottom: 0,
     extendLeft: 0,
     extendRight: 0,
+    extendBackground: [0, 0, 0, 255],
     withoutEnlargement: false,
     kernel: 'lanczos3',
-    interpolator: 'bicubic',
+    fastShrinkOnLoad: true,
-    centreSampling: false,
     // operations
-    background: [0, 0, 0, 255],
+    tintA: 128,
+    tintB: 128,
     flatten: false,
+    flattenBackground: [0, 0, 0],
     negate: false,
+    medianSize: 0,
     blurSigma: 0,
     sharpenSigma: 0,
     sharpenFlat: 1,
     sharpenJagged: 2,
     threshold: 0,
     thresholdGrayscale: true,
-    trimTolerance: 0,
+    trimThreshold: 0,
     gamma: 0,
+    gammaOut: 0,
     greyscale: false,
     normalise: 0,
+    brightness: 1,
+    saturation: 1,
+    hue: 0,
     booleanBufferIn: null,
     booleanFileIn: '',
     joinChannelIn: [],
     extractChannel: -1,
+    removeAlpha: false,
+    ensureAlpha: false,
     colourspace: 'srgb',
-    // overlay
+    composite: [],
-    overlayGravity: 0,
-    overlayXOffset: -1,
-    overlayYOffset: -1,
-    overlayTile: false,
-    overlayCutout: false,
     // output
     fileOut: '',
     formatOut: 'input',
@@ -161,18 +182,42 @@ const Sharp = function (input, options) {
     jpegTrellisQuantisation: false,
     jpegOvershootDeringing: false,
     jpegOptimiseScans: false,
+    jpegOptimiseCoding: true,
+    jpegQuantisationTable: 0,
     pngProgressive: false,
-    pngCompressionLevel: 6,
+    pngCompressionLevel: 9,
-    pngAdaptiveFiltering: true,
+    pngAdaptiveFiltering: false,
+    pngPalette: false,
+    pngQuality: 100,
+    pngColours: 256,
+    pngDither: 1,
     webpQuality: 80,
     webpAlphaQuality: 100,
     webpLossless: false,
     webpNearLossless: false,
+    webpSmartSubsample: false,
+    webpReductionEffort: 4,
     tiffQuality: 80,
     tiffCompression: 'jpeg',
-    tiffPredictor: 'none',
+    tiffPredictor: 'horizontal',
+    tiffPyramid: false,
+    tiffSquash: false,
+    tiffTile: false,
+    tiffTileHeight: 256,
+    tiffTileWidth: 256,
+    tiffXres: 1.0,
+    tiffYres: 1.0,
+    heifQuality: 80,
+    heifLossless: false,
+    heifCompression: 'hevc',
     tileSize: 256,
     tileOverlap: 0,
+    tileSkipBlanks: -1,
+    tileBackground: [255, 255, 255, 255],
+    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);
@@ -183,18 +228,6 @@ const Sharp = function (input, options) {
 };
 util.inherits(Sharp, stream.Duplex);
 
-/**
- * Pixel limits.
- * @member
- * @private
- */
-const maximum = {
-  width: 0x3FFF,
-  height: 0x3FFF,
-  pixels: Math.pow(0x3FFF, 2)
-};
-Sharp.maximum = maximum;
-
 /**
  * An EventEmitter that emits a `change` event when a task is either:
  * - queued, waiting for _libuv_ to provide a worker thread
@@ -211,7 +244,7 @@ Sharp.queue = queue;
 /**
  * An Object containing nested boolean values representing the available input and output formats/methods.
  * @example
- * console.log(sharp.format());
+ * console.log(sharp.format);
  * @returns {Object}
  */
 Sharp.format = sharp.format();
@@ -222,7 +255,12 @@ Sharp.format = sharp.format();
  * @example
  * console.log(sharp.versions);
  */
-Sharp.versions = versions;
+Sharp.versions = {
+  vips: sharp.libvipsVersion()
+};
+try {
+  Sharp.versions = require('../vendor/versions.json');
+} catch (err) {}
 
 /**
  * Export constructor.

lib/index.js

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

lib/input.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const util = require('util');
 const color = require('color');
 const is = require('./is');
 const sharp = require('../build/Release/sharp.node');
@@ -10,13 +9,20 @@ const sharp = require('../build/Release/sharp.node');
  * @private
  */
 function _createInputDescriptor (input, inputOptions, containerOptions) {
-  const inputDescriptor = {};
+  const inputDescriptor = { failOnError: true };
   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;
+    if (is.plainObject(inputOptions.raw) || is.bool(inputOptions.failOnError)) {
+      // Raw Stream
+      inputDescriptor.buffer = [];
+    }
   } else if (!is.defined(input) && is.object(containerOptions) && containerOptions.allowStream) {
     // Stream
     inputDescriptor.buffer = [];
@@ -24,20 +30,28 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     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 is.invalidParameterError('failOnError', 'boolean', inputOptions.failOnError);
+      }
+    }
     // Density
     if (is.defined(inputOptions.density)) {
-      if (is.integer(inputOptions.density) && is.inRange(inputOptions.density, 1, 2400)) {
+      if (is.inRange(inputOptions.density, 1, 2400)) {
         inputDescriptor.density = inputOptions.density;
       } else {
-        throw new Error('Invalid density (1 to 2400) ' + inputOptions.density);
+        throw is.invalidParameterError('density', 'number between 1 and 2400', inputOptions.density);
       }
     }
     // Raw pixel input
     if (is.defined(inputOptions.raw)) {
       if (
         is.object(inputOptions.raw) &&
-        is.integer(inputOptions.raw.width) && is.inRange(inputOptions.raw.width, 1, this.constructor.maximum.width) &&
+        is.integer(inputOptions.raw.width) && inputOptions.raw.width > 0 &&
-        is.integer(inputOptions.raw.height) && is.inRange(inputOptions.raw.height, 1, this.constructor.maximum.height) &&
+        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;
@@ -47,12 +61,27 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
         throw new Error('Expected width, height and channels for raw pixel input');
       }
     }
+    // Multi-page input (GIF, TIFF, PDF)
+    if (is.defined(inputOptions.pages)) {
+      if (is.integer(inputOptions.pages) && is.inRange(inputOptions.pages, -1, 100000)) {
+        inputDescriptor.pages = inputOptions.pages;
+      } else {
+        throw is.invalidParameterError('pages', 'integer between -1 and 100000', inputOptions.pages);
+      }
+    }
+    if (is.defined(inputOptions.page)) {
+      if (is.integer(inputOptions.page) && is.inRange(inputOptions.page, 0, 100000)) {
+        inputDescriptor.page = inputOptions.page;
+      } else {
+        throw is.invalidParameterError('page', 'integer between 0 and 100000', inputOptions.page);
+      }
+    }
     // Create new image
     if (is.defined(inputOptions.create)) {
       if (
         is.object(inputOptions.create) &&
-        is.integer(inputOptions.create.width) && is.inRange(inputOptions.create.width, 1, this.constructor.maximum.width) &&
+        is.integer(inputOptions.create.width) && inputOptions.create.width > 0 &&
-        is.integer(inputOptions.create.height) && is.inRange(inputOptions.create.height, 1, this.constructor.maximum.height) &&
+        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)
       ) {
@@ -90,9 +119,8 @@ function _write (chunk, encoding, callback) {
     /* istanbul ignore else */
     if (is.buffer(chunk)) {
       if (this.options.input.buffer.length === 0) {
-        const that = this;
+        this.on('finish', () => {
-        this.on('finish', function () {
+          this.streamInFinished = true;
-          that.streamInFinished = true;
         });
       }
       this.options.input.buffer.push(chunk);
@@ -140,35 +168,45 @@ function _isStreamInput () {
  * @returns {Sharp}
  */
 function clone () {
-  const that = this;
   // Clone existing options
   const clone = this.constructor.call();
-  util._extend(clone.options, this.options);
+  clone.options = Object.assign({}, this.options);
   // Pass 'finish' event to clone for Stream-based input
-  this.on('finish', function () {
+  if (this._isStreamInput()) {
-    // Clone inherits input data
+    this.on('finish', () => {
-    that._flattenBufferIn();
+      // Clone inherits input data
-    clone.options.bufferIn = that.options.bufferIn;
+      this._flattenBufferIn();
-    clone.emit('finish');
+      clone.options.bufferIn = this.options.bufferIn;
-  });
+      clone.emit('finish');
+    });
+  }
   return clone;
 }
 
 /**
- * Fast access to image metadata without decoding any compressed image data.
+ * Fast access to (uncached) image metadata without decoding any compressed image data.
- * A Promises/A+ promise is returned when `callback` is not provided.
+ * 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
+ * - `size`: Total size of image in bytes, for Stream and Buffer input only
- * - `height`: Number of pixels high
+ * - `width`: Number of pixels wide (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#L568)
+ * - `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/libvips/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/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672)
  * - `density`: Number of pixels per inch (DPI), if present
+ * - `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK
+ * - `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan
+ * - `pages`: Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP
+ * - `pageHeight`: Number of pixels high each page in this PDF image will be.
+ * - `pagePrimary`: Number of the primary page in a HEIF image
  * - `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);
@@ -188,12 +226,11 @@ function clone () {
  * @returns {Promise<Object>|Sharp}
  */
 function metadata (callback) {
-  const that = this;
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
-      this.on('finish', function () {
+      this.on('finish', () => {
-        that._flattenBufferIn();
+        this._flattenBufferIn();
-        sharp.metadata(that.options, callback);
+        sharp.metadata(this.options, callback);
       });
     } else {
       sharp.metadata(this.options, callback);
@@ -201,10 +238,10 @@ function metadata (callback) {
     return this;
   } else {
     if (this._isStreamInput()) {
-      return new Promise(function (resolve, reject) {
+      return new Promise((resolve, reject) => {
-        that.on('finish', function () {
+        this.on('finish', () => {
-          that._flattenBufferIn();
+          this._flattenBufferIn();
-          sharp.metadata(that.options, function (err, metadata) {
+          sharp.metadata(this.options, (err, metadata) => {
             if (err) {
               reject(err);
             } else {
@@ -214,8 +251,8 @@ function metadata (callback) {
         });
       });
     } else {
-      return new Promise(function (resolve, reject) {
+      return new Promise((resolve, reject) => {
-        sharp.metadata(that.options, function (err, metadata) {
+        sharp.metadata(this.options, (err, metadata) => {
           if (err) {
             reject(err);
           } else {
@@ -228,9 +265,77 @@ function metadata (callback) {
 }
 
 /**
- * Do not process input images where the number of pixels (width * height) exceeds this limit.
+ * 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) {
+  if (is.fn(callback)) {
+    if (this._isStreamInput()) {
+      this.on('finish', () => {
+        this._flattenBufferIn();
+        sharp.stats(this.options, callback);
+      });
+    } else {
+      sharp.stats(this.options, callback);
+    }
+    return this;
+  } else {
+    if (this._isStreamInput()) {
+      return new Promise((resolve, reject) => {
+        this.on('finish', function () {
+          this._flattenBufferIn();
+          sharp.stats(this.options, (err, stats) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(stats);
+            }
+          });
+        });
+      });
+    } else {
+      return new Promise((resolve, reject) => {
+        sharp.stats(this.options, (err, stats) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(stats);
+          }
+        });
+      });
+    }
+  }
+}
+
+/**
+ * Do not process input images where the number of pixels (width x height) exceeds this limit.
  * Assumes image dimensions contained in the input metadata can be trusted.
- * The default limit is 268402689 (0x3FFF * 0x3FFF) pixels.
+ * The default limit is 268402689 (0x3FFF x 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
@@ -240,12 +345,12 @@ function limitInputPixels (limit) {
   if (limit === false) {
     limit = 0;
   } else if (limit === true) {
-    limit = this.constructor.maximum.pixels;
+    limit = Math.pow(0x3FFF, 2);
   }
   if (is.integer(limit) && limit >= 0) {
     this.options.limitInputPixels = limit;
   } else {
-    throw new Error('Invalid pixel limit (0 to ' + this.constructor.maximum.pixels + ') ' + limit);
+    throw is.invalidParameterError('limitInputPixels', 'integer', limit);
   }
   return this;
 }
@@ -253,6 +358,9 @@ function limitInputPixels (limit) {
 /**
  * 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}
  */
@@ -266,7 +374,7 @@ function sequentialRead (sequentialRead) {
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     // Private
     _createInputDescriptor,
     _write,
@@ -275,9 +383,8 @@ module.exports = function (Sharp) {
     // Public
     clone,
     metadata,
+    stats,
     limitInputPixels,
     sequentialRead
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
 };

lib/is.js

@@ -16,6 +16,14 @@ 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
@@ -98,6 +106,7 @@ const invalidParameterError = function (name, expected, actual) {
 module.exports = {
   defined: defined,
   object: object,
+  plainObject: plainObject,
   fn: fn,
   bool: bool,
   buffer: buffer,

lib/libvips.js

@@ -0,0 +1,103 @@
+'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 || /* istanbul ignore next */
+  require('../package.json').config.libvips;
+
+const spawnSyncOptions = {
+  encoding: 'utf8',
+  shell: true
+};
+
+const mkdirSync = function (dirPath) {
+  try {
+    fs.mkdirSync(dirPath);
+  } catch (err) {
+    /* istanbul ignore if */
+    if (err.code !== 'EEXIST') {
+      throw err;
+    }
+  }
+};
+
+const cachePath = function () {
+  const npmCachePath = env.npm_config_cache || /* istanbul ignore next */
+    (env.APPDATA ? path.join(env.APPDATA, 'npm-cache') : path.join(os.homedir(), '.npm'));
+  mkdirSync(npmCachePath);
+  const libvipsCachePath = path.join(npmCachePath, '_libvips');
+  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();
+  const vendorPath = path.join(__dirname, '..', 'vendor');
+  let vendorVersionId;
+  let vendorPlatformId;
+  try {
+    vendorVersionId = require(path.join(vendorPath, 'versions.json')).vips;
+    vendorPlatformId = require(path.join(vendorPath, 'platform.json'));
+  } catch (err) {}
+  /* istanbul ignore if */
+  if (vendorVersionId && vendorVersionId !== minimumLibvipsVersion) {
+    throw new Error(`Found vendored libvips v${vendorVersionId} but require v${minimumLibvipsVersion}. Please remove the 'node_modules/sharp/vendor' directory and run 'npm install'.`);
+  }
+  /* istanbul ignore else */
+  if (vendorPlatformId) {
+    /* istanbul ignore else */
+    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'.`);
+    }
+  } else {
+    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 && /* istanbul ignore next */
+    semver.gte(globalVipsVersion, minimumLibvipsVersion);
+};
+
+module.exports = {
+  minimumLibvipsVersion: minimumLibvipsVersion,
+  cachePath: cachePath,
+  globalLibvipsVersion: globalLibvipsVersion,
+  hasVendoredLibvips: hasVendoredLibvips,
+  pkgConfigPath: pkgConfigPath,
+  useGlobalLibvips: useGlobalLibvips,
+  mkdirSync: mkdirSync
+};

lib/operation.js

@@ -1,12 +1,19 @@
 'use strict';
 
+const color = require('color');
 const is = require('./is');
 
 /**
  * Rotate the output image by either an explicit angle
  * or auto-orient based on the EXIF `Orientation` tag.
  *
- * Use this method without angle to determine the angle from EXIF data.
+ * If an angle is provided, it is converted to a valid positive degree rotation.
+ * For example, `-450` will produce a 270deg rotation.
+ *
+ * When rotating by an angle other than a multiple of 90,
+ * the background colour can be provided with the `background` option.
+ *
+ * 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.
@@ -25,64 +32,30 @@ const is = require('./is');
  *   });
  * readableStream.pipe(pipeline);
  *
- * @param {Number} [angle=auto] 0, 90, 180 or 270.
+ * @param {Number} [angle=auto] angle of rotation.
+ * @param {Object} [options] - if present, is an Object with optional attributes.
+ * @param {String|Object} [options.background="#000000"] 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 rotate (angle) {
+function rotate (angle, options) {
   if (!is.defined(angle)) {
-    this.options.angle = -1;
+    this.options.useExifOrientation = true;
-  } else if (is.integer(angle) && is.inArray(angle, [0, 90, 180, 270])) {
+  } else if (is.integer(angle) && !(angle % 90)) {
     this.options.angle = angle;
-  } else {
+  } else if (is.number(angle)) {
-    throw new Error('Unsupported angle (0, 90, 180, 270) ' + angle);
+    this.options.rotationAngle = angle;
-  }
+    if (is.object(options) && options.background) {
-  return this;
+      const backgroundColour = color(options.background);
-}
+      this.options.rotationBackground = [
-
+        backgroundColour.red(),
-/**
+        backgroundColour.green(),
- * Extract a region of the image.
+        backgroundColour.blue(),
- *
+        Math.round(backgroundColour.alpha() * 255)
- * - 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);
+  } else {
-  // Ensure existing rotation occurs before pre-resize extraction
+    throw is.invalidParameterError('angle', 'numeric', angle);
-  if (suffix === 'Pre' && this.options.angle !== 0) {
-    this.options.rotateBeforePreExtract = true;
   }
   return this;
 }
@@ -136,7 +109,7 @@ function sharpen (sigma, flat, jagged) {
       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);
+        throw is.invalidParameterError('flat', 'number between 0 and 10000', flat);
       }
     }
     // Control over jagged areas
@@ -144,11 +117,31 @@ function sharpen (sigma, flat, 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);
+        throw is.invalidParameterError('jagged', 'number between 0 and 10000', jagged);
       }
     }
   } else {
-    throw new Error('Invalid sharpen sigma (0.01 - 10000) ' + sigma);
+    throw is.invalidParameterError('sigma', 'number between 0.01 and 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 is.invalidParameterError('size', 'integer between 1 and 1000', size);
   }
   return this;
 }
@@ -172,78 +165,21 @@ function blur (sigma) {
     // Numeric argument: specific sigma
     this.options.blurSigma = sigma;
   } else {
-    throw new Error('Invalid blur sigma (0.3 - 1000.0) ' + sigma);
+    throw is.invalidParameterError('sigma', 'number between 0.3 and 1000', sigma);
   }
   return this;
 }
 
 /**
- * Extends/pads the edges of the image with the colour provided to the `background` method.
+ * Merge alpha transparency channel, if any, with a background.
- * This operation will always occur after resizing and extraction, if any.
+ * @param {Object} [options]
- *
+ * @param {String|Object} [options.background={r: 0, g: 0, b: 0}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black.
- * @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) {
+function flatten (options) {
-  this.options.flatten = is.bool(flatten) ? flatten : true;
+  this.options.flatten = is.bool(options) ? options : true;
-  return this;
+  if (is.object(options)) {
-}
+    this._setBackgroundColourOption('flattenBackground', options.background);
-
-/**
- * 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;
 }
@@ -254,18 +190,30 @@ function trim (tolerance) {
  * 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.
+ *
+ * Supply a second argument to use a different output gamma value, otherwise the first value is used in both cases.
+ *
  * @param {Number} [gamma=2.2] value between 1.0 and 3.0.
+ * @param {Number} [gammaOut] value between 1.0 and 3.0. (optional, defaults to same as `gamma`)
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function gamma (gamma) {
+function gamma (gamma, gammaOut) {
   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);
+    throw is.invalidParameterError('gamma', 'number between 1.0 and 3.0', gamma);
+  }
+  if (!is.defined(gammaOut)) {
+    // Default gamma correction for output is same as input
+    this.options.gammaOut = this.options.gamma;
+  } else if (is.number(gammaOut) && is.inRange(gammaOut, 1, 3)) {
+    this.options.gammaOut = gammaOut;
+  } else {
+    throw is.invalidParameterError('gammaOut', 'number between 1.0 and 3.0', gammaOut);
   }
   return this;
 }
@@ -329,7 +277,7 @@ function convolve (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');
   }
@@ -367,7 +315,7 @@ function threshold (threshold, options) {
   } else if (is.integer(threshold) && is.inRange(threshold, 0, 255)) {
     this.options.threshold = threshold;
   } else {
-    throw new Error('Invalid threshold (0 to 255) ' + threshold);
+    throw is.invalidParameterError('threshold', 'integer between 0 and 255', threshold);
   }
   if (!is.object(options) || options.greyscale === true || options.grayscale === true) {
     this.options.thresholdGrayscale = true;
@@ -398,7 +346,125 @@ function boolean (operand, operator, options) {
   if (is.string(operator) && is.inArray(operator, ['and', 'or', 'eor'])) {
     this.options.booleanOp = operator;
   } else {
-    throw new Error('Invalid boolean operator ' + operator);
+    throw is.invalidParameterError('operator', 'one of: and, or, eor', 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 is.invalidParameterError('a', 'numeric', a);
+  }
+  if (!is.defined(b)) {
+    this.options.linearB = 0.0;
+  } else if (is.number(b)) {
+    this.options.linearB = b;
+  } else {
+    throw is.invalidParameterError('b', 'numeric', b);
+  }
+  return this;
+}
+
+/**
+ * Recomb the image with the specified matrix.
+ *
+ * @example
+ * sharp(input)
+ *   .recomb([
+ *    [0.3588, 0.7044, 0.1368],
+ *    [0.2990, 0.5870, 0.1140],
+ *    [0.2392, 0.4696, 0.0912],
+ *   ])
+ *   .raw()
+ *   .toBuffer(function(err, data, info) {
+ *     // data contains the raw pixel data after applying the recomb
+ *     // With this example input, a sepia filter has been applied
+ *   });
+ *
+ * @param {Array<Array<Number>>} 3x3 Recombination matrix
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function recomb (inputMatrix) {
+  if (!Array.isArray(inputMatrix) || inputMatrix.length !== 3 ||
+      inputMatrix[0].length !== 3 ||
+      inputMatrix[1].length !== 3 ||
+      inputMatrix[2].length !== 3
+  ) {
+    // must pass in a kernel
+    throw new Error('Invalid recombination matrix');
+  }
+  this.options.recombMatrix = [
+    inputMatrix[0][0], inputMatrix[0][1], inputMatrix[0][2],
+    inputMatrix[1][0], inputMatrix[1][1], inputMatrix[1][2],
+    inputMatrix[2][0], inputMatrix[2][1], inputMatrix[2][2]
+  ].map(Number);
+  return this;
+}
+
+/**
+ * Transforms the image using brightness, saturation and hue rotation.
+ *
+ * @example
+ * sharp(input)
+ *   .modulate({
+ *     brightness: 2 // increase lightness by a factor of 2
+ *   });
+ *
+ * sharp(input)
+ *   .modulate({
+ *     hue: 180 // hue-rotate by 180 degrees
+ *   });
+ *
+ * // decreate brightness and saturation while also hue-rotating by 90 degrees
+ * sharp(input)
+ *   .modulate({
+ *     brightness: 0.5,
+ *     saturation: 0.5,
+ *     hue: 90
+ *   });
+ *
+ * @param {Object} [options]
+ * @param {Number} [options.brightness] Brightness multiplier
+ * @param {Number} [options.saturation] Saturation multiplier
+ * @param {Number} [options.hue] Degrees for hue rotation
+ * @returns {Sharp}
+ */
+function modulate (options) {
+  if (!is.plainObject(options)) {
+    throw is.invalidParameterError('options', 'plain object', options);
+  }
+  if ('brightness' in options) {
+    if (is.number(options.brightness) && options.brightness >= 0) {
+      this.options.brightness = options.brightness;
+    } else {
+      throw is.invalidParameterError('brightness', 'number above zero', options.brightness);
+    }
+  }
+  if ('saturation' in options) {
+    if (is.number(options.saturation) && options.saturation >= 0) {
+      this.options.saturation = options.saturation;
+    } else {
+      throw is.invalidParameterError('saturation', 'number above zero', options.saturation);
+    }
+  }
+  if ('hue' in options) {
+    if (is.integer(options.hue)) {
+      this.options.hue = options.hue % 360;
+    } else {
+      throw is.invalidParameterError('hue', 'number', options.hue);
+    }
   }
   return this;
 }
@@ -408,24 +474,23 @@ function boolean (operand, operator, options) {
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     rotate,
-    extract,
     flip,
     flop,
     sharpen,
+    median,
     blur,
-    extend,
     flatten,
-    trim,
     gamma,
     negate,
     normalise,
     normalize,
     convolve,
     threshold,
-    boolean
+    boolean,
-  ].forEach(function (f) {
+    linear,
-    Sharp.prototype[f.name] = f;
+    recomb,
+    modulate
   });
 };

lib/output.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const util = require('util');
 const is = require('./is');
 const sharp = require('../build/Release/sharp.node');
 
@@ -11,17 +10,32 @@ const sharp = require('../build/Release/sharp.node');
  * with JPEG, PNG, WebP, TIFF, DZI, and libvips' V format supported.
  * Note that raw pixel data is only supported for buffer output.
  *
- * A Promises/A+ promise is returned when `callback` is not provided.
+ * By default all metadata will be removed, which includes EXIF-based orientation.
+ * See {@link withMetadata} for control over this.
+ *
+ * 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` and `channels`.
+ * `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');
+    const errOutputInvalid = new Error('Missing output file path');
     if (is.fn(callback)) {
       callback(errOutputInvalid);
     } else {
@@ -45,14 +59,37 @@ function toFile (fileOut, callback) {
 
 /**
  * Write output to a Buffer.
- * JPEG, PNG, WebP, and RAW output are supported.
+ * 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.
+ *
+ * If no explicit format is set, the output format will match the input image, except GIF and SVG input which become PNG output.
+ *
+ * By default all metadata will be removed, which includes EXIF-based orientation.
+ * See {@link withMetadata} for control over this.
  *
  * `callback`, if present, gets three arguments `(err, data, info)` where:
  * - `err` is an error, if any.
  * - `data` is the output image data.
- * - `info` contains the output image `format`, `size` (bytes), `width`, `height` and `channels`.
+ * - `info` contains the output image `format`, `size` (bytes), `width`, `height`,
- * A Promise is returned when `callback` is not provided.
+ * `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`.
@@ -61,9 +98,9 @@ function toFile (fileOut, callback) {
  */
 function toBuffer (options, callback) {
   if (is.object(options)) {
-    if (is.bool(options.resolveWithObject)) {
+    this._setBooleanOption('resolveWithObject', options.resolveWithObject);
-      this.options.resolveWithObject = options.resolveWithObject;
+  } else if (this.options.resolveWithObject) {
-    }
+    this.options.resolveWithObject = false;
   }
   return this._pipeline(is.fn(options) ? options : callback);
 }
@@ -72,19 +109,26 @@ function toBuffer (options, callback) {
  * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
  * The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
  * This will also convert to and add a web-friendly sRGB ICC profile.
- * @param {Object} [withMetadata]
+ *
- * @param {Number} [withMetadata.orientation] value between 1 and 8, used to update the EXIF `Orientation` tag.
+ * @example
+ * sharp('input.jpg')
+ *   .withMetadata()
+ *   .toFile('output-with-metadata.jpg')
+ *   .then(info => { ... });
+ *
+ * @param {Object} [options]
+ * @param {Number} [options.orientation] value between 1 and 8, used to update the EXIF `Orientation` tag.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function withMetadata (withMetadata) {
+function withMetadata (options) {
-  this.options.withMetadata = is.bool(withMetadata) ? withMetadata : true;
+  this.options.withMetadata = is.bool(options) ? options : true;
-  if (is.object(withMetadata)) {
+  if (is.object(options)) {
-    if (is.defined(withMetadata.orientation)) {
+    if (is.defined(options.orientation)) {
-      if (is.integer(withMetadata.orientation) && is.inRange(withMetadata.orientation, 1, 8)) {
+      if (is.integer(options.orientation) && is.inRange(options.orientation, 1, 8)) {
-        this.options.withMetadataOrientation = withMetadata.orientation;
+        this.options.withMetadataOrientation = options.orientation;
       } else {
-        throw new Error('Invalid orientation (1 to 8) ' + withMetadata.orientation);
+        throw is.invalidParameterError('orientation', 'integer between 1 and 8', options.orientation);
       }
     }
   }
@@ -93,14 +137,28 @@ function withMetadata (withMetadata) {
 
 /**
  * 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.trellisQuantisation=false] - apply trellis quantisation, requires libvips compiled with support for mozjpeg
- * @param {Boolean} [options.overshootDeringing=false] - apply overshoot deringing, requires mozjpeg
+ * @param {Boolean} [options.overshootDeringing=false] - apply overshoot deringing, requires libvips compiled with support for mozjpeg
- * @param {Boolean} [options.optimiseScans=false] - optimise progressive scans, forces progressive, requires mozjpeg
+ * @param {Boolean} [options.optimiseScans=false] - optimise progressive scans, forces progressive, requires libvips compiled with support for 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 libvips compiled with support for 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
@@ -111,7 +169,7 @@ function jpeg (options) {
       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);
+        throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
       }
     }
     if (is.defined(options.progressive)) {
@@ -121,33 +179,60 @@ function jpeg (options) {
       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);
+        throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
       }
     }
-    options.trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
+    const trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
-    if (is.defined(options.trellisQuantisation)) {
+    if (is.defined(trellisQuantisation)) {
-      this._setBooleanOption('jpegTrellisQuantisation', options.trellisQuantisation);
+      this._setBooleanOption('jpegTrellisQuantisation', trellisQuantisation);
     }
     if (is.defined(options.overshootDeringing)) {
       this._setBooleanOption('jpegOvershootDeringing', options.overshootDeringing);
     }
-    options.optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
+    const optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
-    if (is.defined(options.optimiseScans)) {
+    if (is.defined(optimiseScans)) {
-      this._setBooleanOption('jpegOptimiseScans', options.optimiseScans);
+      this._setBooleanOption('jpegOptimiseScans', optimiseScans);
-      if (options.optimiseScans) {
+      if (optimiseScans) {
         this.options.jpegProgressive = true;
       }
     }
+    const optimiseCoding = is.bool(options.optimizeCoding) ? options.optimizeCoding : options.optimiseCoding;
+    if (is.defined(optimiseCoding)) {
+      this._setBooleanOption('jpegOptimiseCoding', optimiseCoding);
+    }
+    const quantisationTable = is.number(options.quantizationTable) ? options.quantizationTable : options.quantisationTable;
+    if (is.defined(quantisationTable)) {
+      if (is.integer(quantisationTable) && is.inRange(quantisationTable, 0, 8)) {
+        this.options.jpegQuantisationTable = quantisationTable;
+      } else {
+        throw is.invalidParameterError('quantisationTable', 'integer between 0 and 8', 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=6] - zlib compression level
+ * @param {Number} [options.compressionLevel=9] - zlib compression level, 0-9
- * @param {Boolean} [options.adaptiveFiltering=true] - use adaptive row filtering
+ * @param {Boolean} [options.adaptiveFiltering=false] - use adaptive row filtering
+ * @param {Boolean} [options.palette=false] - quantise to a palette-based image with alpha transparency support, requires libvips compiled with support for libimagequant
+ * @param {Number} [options.quality=100] - use the lowest number of colours needed to achieve given quality, requires libvips compiled with support for libimagequant
+ * @param {Number} [options.colours=256] - maximum number of palette entries, requires libvips compiled with support for libimagequant
+ * @param {Number} [options.colors=256] - alternative spelling of `options.colours`, requires libvips compiled with support for libimagequant
+ * @param {Number} [options.dither=1.0] - level of Floyd-Steinberg error diffusion, requires libvips compiled with support for libimagequant
  * @param {Boolean} [options.force=true] - force PNG output, otherwise attempt to use input format
  * @returns {Sharp}
  * @throws {Error} Invalid options
@@ -161,23 +246,59 @@ function png (options) {
       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);
+        throw is.invalidParameterError('compressionLevel', 'integer between 0 and 9', options.compressionLevel);
       }
     }
     if (is.defined(options.adaptiveFiltering)) {
       this._setBooleanOption('pngAdaptiveFiltering', options.adaptiveFiltering);
     }
+    if (is.defined(options.palette)) {
+      this._setBooleanOption('pngPalette', options.palette);
+      if (this.options.pngPalette) {
+        if (is.defined(options.quality)) {
+          if (is.integer(options.quality) && is.inRange(options.quality, 0, 100)) {
+            this.options.pngQuality = options.quality;
+          } else {
+            throw is.invalidParameterError('quality', 'integer between 0 and 100', options.quality);
+          }
+        }
+        const colours = options.colours || options.colors;
+        if (is.defined(colours)) {
+          if (is.integer(colours) && is.inRange(colours, 2, 256)) {
+            this.options.pngColours = colours;
+          } else {
+            throw is.invalidParameterError('colours', 'integer between 2 and 256', colours);
+          }
+        }
+        if (is.defined(options.dither)) {
+          if (is.number(options.dither) && is.inRange(options.dither, 0, 1)) {
+            this.options.pngDither = options.dither;
+          } else {
+            throw is.invalidParameterError('dither', 'number between 0.0 and 1.0', options.dither);
+          }
+        }
+      }
+    }
   }
   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.smartSubsample=false] - use high quality chroma subsampling
+ * @param {Number} [options.reductionEffort=4] - level of CPU effort to reduce file size, integer 0-6
  * @param {Boolean} [options.force=true] - force WebP output, otherwise attempt to use input format
  * @returns {Sharp}
  * @throws {Error} Invalid options
@@ -187,14 +308,14 @@ function webp (options) {
     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);
+      throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
     }
   }
   if (is.object(options) && is.defined(options.alphaQuality)) {
-    if (is.integer(options.alphaQuality) && is.inRange(options.alphaQuality, 1, 100)) {
+    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, 1-100) ' + options.alphaQuality);
+      throw is.invalidParameterError('alphaQuality', 'integer between 0 and 100', options.alphaQuality);
     }
   }
   if (is.object(options) && is.defined(options.lossless)) {
@@ -203,71 +324,209 @@ function webp (options) {
   if (is.object(options) && is.defined(options.nearLossless)) {
     this._setBooleanOption('webpNearLossless', options.nearLossless);
   }
+  if (is.object(options) && is.defined(options.smartSubsample)) {
+    this._setBooleanOption('webpSmartSubsample', options.smartSubsample);
+  }
+  if (is.object(options) && is.defined(options.reductionEffort)) {
+    if (is.integer(options.reductionEffort) && is.inRange(options.reductionEffort, 0, 6)) {
+      this.options.webpReductionEffort = options.reductionEffort;
+    } else {
+      throw is.invalidParameterError('reductionEffort', 'integer between 0 and 6', options.reductionEffort);
+    }
+  }
   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
+ * @param {Boolean} [options.compression='jpeg'] - compression options: lzw, deflate, jpeg, ccittfax4
- * @param {Boolean} [options.predictor='none'] - compression predictor options: none, horizontal, float
+ * @param {Boolean} [options.predictor='horizontal'] - compression predictor options: none, horizontal, float
+ * @param {Boolean} [options.pyramid=false] - write an image pyramid
+ * @param {Boolean} [options.tile=false] - write a tiled tiff
+ * @param {Boolean} [options.tileWidth=256] - horizontal tile size
+ * @param {Boolean} [options.tileHeight=256] - vertical tile size
+ * @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.object(options)) {
-    if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+    if (is.defined(options.quality)) {
-      this.options.tiffQuality = options.quality;
+      if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
-    } else {
+        this.options.tiffQuality = options.quality;
-      throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+      } else {
+        throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
+      }
     }
-  }
+    if (is.defined(options.squash)) {
-  // compression
+      this._setBooleanOption('tiffSquash', options.squash);
-  if (is.defined(options) && is.defined(options.compression)) {
-    if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'none'])) {
-      this.options.tiffCompression = options.compression;
-    } else {
-      const message = `Invalid compression option "${options.compression}". Should be one of: lzw, deflate, jpeg, none`;
-      throw new Error(message);
     }
-  }
+    // tiling
-  // predictor
+    if (is.defined(options.tile)) {
-  if (is.defined(options) && is.defined(options.predictor)) {
+      this._setBooleanOption('tiffTile', options.tile);
-    if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
+    }
-      this.options.tiffPredictor = options.predictor;
+    if (is.defined(options.tileWidth)) {
-    } else {
+      if (is.integer(options.tileWidth) && options.tileWidth > 0) {
-      const message = `Invalid predictor option "${options.predictor}". Should be one of: none, horizontal, float`;
+        this.options.tiffTileWidth = options.tileWidth;
-      throw new Error(message);
+      } else {
+        throw is.invalidParameterError('tileWidth', 'integer greater than zero', options.tileWidth);
+      }
+    }
+    if (is.defined(options.tileHeight)) {
+      if (is.integer(options.tileHeight) && options.tileHeight > 0) {
+        this.options.tiffTileHeight = options.tileHeight;
+      } else {
+        throw is.invalidParameterError('tileHeight', 'integer greater than zero', options.tileHeight);
+      }
+    }
+    // pyramid
+    if (is.defined(options.pyramid)) {
+      this._setBooleanOption('tiffPyramid', options.pyramid);
+    }
+    // resolution
+    if (is.defined(options.xres)) {
+      if (is.number(options.xres) && options.xres > 0) {
+        this.options.tiffXres = options.xres;
+      } else {
+        throw is.invalidParameterError('xres', 'number greater than zero', options.xres);
+      }
+    }
+    if (is.defined(options.yres)) {
+      if (is.number(options.yres) && options.yres > 0) {
+        this.options.tiffYres = options.yres;
+      } else {
+        throw is.invalidParameterError('yres', 'number greater than zero', options.yres);
+      }
+    }
+    // compression
+    if (is.defined(options.compression)) {
+      if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'ccittfax4', 'none'])) {
+        this.options.tiffCompression = options.compression;
+      } else {
+        throw is.invalidParameterError('compression', 'one of: lzw, deflate, jpeg, ccittfax4, none', options.compression);
+      }
+    }
+    // predictor
+    if (is.defined(options.predictor)) {
+      if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
+        this.options.tiffPredictor = options.predictor;
+      } else {
+        throw is.invalidParameterError('predictor', 'one of: none, horizontal, float', options.predictor);
+      }
     }
   }
   return this._updateFormatOut('tiff', options);
 }
 
+/**
+ * Use these HEIF options for output image.
+ *
+ * Support for HEIF (HEIC/AVIF) is experimental.
+ * Do not use this in production systems.
+ *
+ * Requires a custom, globally-installed libvips compiled with support for libheif.
+ *
+ * Most versions of libheif support only the patent-encumbered HEVC compression format.
+ *
+ * @param {Object} [options] - output options
+ * @param {Number} [options.quality=80] - quality, integer 1-100
+ * @param {Boolean} [options.compression='hevc'] - compression format: hevc, avc, jpeg, av1
+ * @param {Boolean} [options.lossless=false] - use lossless compression
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+function heif (options) {
+  if (!this.constructor.format.heif.output.buffer) {
+    throw new Error('The heif operation requires libvips to have been installed with support for libheif');
+  }
+  if (is.object(options)) {
+    if (is.defined(options.quality)) {
+      if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+        this.options.heifQuality = options.quality;
+      } else {
+        throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
+      }
+    }
+    if (is.defined(options.lossless)) {
+      if (is.bool(options.lossless)) {
+        this.options.heifLossless = options.lossless;
+      } else {
+        throw is.invalidParameterError('lossless', 'boolean', options.lossless);
+      }
+    }
+    if (is.defined(options.compression)) {
+      if (is.string(options.compression) && is.inArray(options.compression, ['hevc', 'avc', 'jpeg', 'av1'])) {
+        this.options.heifCompression = options.compression;
+      } else {
+        throw is.invalidParameterError('compression', 'one of: hevc, avc, jpeg, av1', options.compression);
+      }
+    }
+  }
+  return this._updateFormatOut('heif', 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');
 }
 
+const formats = new Map([
+  ['heic', 'heif'],
+  ['heif', 'heif'],
+  ['jpeg', 'jpeg'],
+  ['jpg', 'jpeg'],
+  ['png', 'png'],
+  ['raw', 'raw'],
+  ['tiff', 'tiff'],
+  ['webp', 'webp']
+]);
+
 /**
  * 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)) {
+  const actualFormat = formats.get(is.object(format) && is.string(format.id) ? format.id : format);
-    format = format.id;
+  if (!actualFormat) {
+    throw is.invalidParameterError('format', `one of: ${[...formats.keys()].join(', ')}`, format);
   }
-  if (!is.inArray(format, ['jpeg', 'png', 'webp', 'tiff', 'raw'])) {
+  return this[actualFormat](options);
-    throw new Error('Unsupported output format ' + format);
-  }
-  return this[format](options);
 }
 
 /**
@@ -275,6 +534,8 @@ function toFormat (format, options) {
  * 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()
@@ -286,57 +547,89 @@ function toFormat (format, options) {
  *     // output_files contains 512x512 tiles grouped by zoom level
  *   });
  *
- * @param {Object} [tile]
+ * @param {Object} [options]
- * @param {Number} [tile.size=256] tile size in pixels, a value between 1 and 8192.
+ * @param {Number} [options.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} [options.overlap=0] tile overlap in pixels, a value between 0 and 8192.
- * @param {String} [tile.container='fs'] tile container, with value `fs` (filesystem) or `zip` (compressed file).
+ * @param {Number} [options.angle=0] tile angle of rotation, must be a multiple of 90.
- * @param {String} [tile.layout='dz'] filesystem layout, possible values are `dz`, `zoomify` or `google`.
+ * @param {String|Object} [options.background={r: 255, g: 255, b: 255, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to white without transparency.
+ * @param {String} [options.depth] how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
+ * @param {Number} [options.skipBlanks=-1] threshold to skip tile generation, a value 0 - 255 for 8-bit images or 0 - 65535 for 16-bit images
+ * @param {String} [options.container='fs'] tile container, with value `fs` (filesystem) or `zip` (compressed file).
+ * @param {String} [options.layout='dz'] filesystem layout, possible values are `dz`, `zoomify` or `google`.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function tile (tile) {
+function tile (options) {
-  if (is.object(tile)) {
+  if (is.object(options)) {
     // Size of square tiles, in pixels
-    if (is.defined(tile.size)) {
+    if (is.defined(options.size)) {
-      if (is.integer(tile.size) && is.inRange(tile.size, 1, 8192)) {
+      if (is.integer(options.size) && is.inRange(options.size, 1, 8192)) {
-        this.options.tileSize = tile.size;
+        this.options.tileSize = options.size;
       } else {
-        throw new Error('Invalid tile size (1 to 8192) ' + tile.size);
+        throw is.invalidParameterError('size', 'integer between 1 and 8192', options.size);
       }
     }
     // Overlap of tiles, in pixels
-    if (is.defined(tile.overlap)) {
+    if (is.defined(options.overlap)) {
-      if (is.integer(tile.overlap) && is.inRange(tile.overlap, 0, 8192)) {
+      if (is.integer(options.overlap) && is.inRange(options.overlap, 0, 8192)) {
-        if (tile.overlap > this.options.tileSize) {
+        if (options.overlap > this.options.tileSize) {
-          throw new Error('Tile overlap ' + tile.overlap + ' cannot be larger than tile size ' + this.options.tileSize);
+          throw is.invalidParameterError('overlap', `<= size (${this.options.tileSize})`, options.overlap);
         }
-        this.options.tileOverlap = tile.overlap;
+        this.options.tileOverlap = options.overlap;
       } else {
-        throw new Error('Invalid tile overlap (0 to 8192) ' + tile.overlap);
+        throw is.invalidParameterError('overlap', 'integer between 0 and 8192', options.overlap);
       }
     }
     // Container
-    if (is.defined(tile.container)) {
+    if (is.defined(options.container)) {
-      if (is.string(tile.container) && is.inArray(tile.container, ['fs', 'zip'])) {
+      if (is.string(options.container) && is.inArray(options.container, ['fs', 'zip'])) {
-        this.options.tileContainer = tile.container;
+        this.options.tileContainer = options.container;
       } else {
-        throw new Error('Invalid tile container ' + tile.container);
+        throw is.invalidParameterError('container', 'one of: fs, zip', options.container);
       }
     }
     // Layout
-    if (is.defined(tile.layout)) {
+    if (is.defined(options.layout)) {
-      if (is.string(tile.layout) && is.inArray(tile.layout, ['dz', 'google', 'zoomify'])) {
+      if (is.string(options.layout) && is.inArray(options.layout, ['dz', 'google', 'zoomify'])) {
-        this.options.tileLayout = tile.layout;
+        this.options.tileLayout = options.layout;
       } else {
-        throw new Error('Invalid tile layout ' + tile.layout);
+        throw is.invalidParameterError('layout', 'one of: dz, google, zoomify', options.layout);
       }
     }
+    // Angle of rotation,
+    if (is.defined(options.angle)) {
+      if (is.integer(options.angle) && !(options.angle % 90)) {
+        this.options.tileAngle = options.angle;
+      } else {
+        throw is.invalidParameterError('angle', 'positive/negative multiple of 90', options.angle);
+      }
+    }
+    // Background colour
+    this._setBackgroundColourOption('tileBackground', options.background);
+    // Depth of tiles
+    if (is.defined(options.depth)) {
+      if (is.string(options.depth) && is.inArray(options.depth, ['onepixel', 'onetile', 'one'])) {
+        this.options.tileDepth = options.depth;
+      } else {
+        throw is.invalidParameterError('depth', 'one of: onepixel, onetile, one', options.depth);
+      }
+    }
+    // Threshold to skip blank tiles
+    if (is.defined(options.skipBlanks)) {
+      if (is.integer(options.skipBlanks) && is.inRange(options.skipBlanks, -1, 65535)) {
+        this.options.tileSkipBlanks = options.skipBlanks;
+      } else {
+        throw is.invalidParameterError('skipBlanks', 'integer between -1 and 255/65535', options.skipBlanks);
+      }
+    } else if (is.defined(options.layout) && options.layout === 'google') {
+      this.options.tileSkipBlanks = 5;
+    }
   }
   // 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);
+    throw is.invalidParameterError('format', 'one of: jpeg, png, webp', this.options.formatOut);
   }
   return this._updateFormatOut('dz');
 }
@@ -351,7 +644,9 @@ function tile (tile) {
  * @returns {Sharp}
  */
 function _updateFormatOut (formatOut, options) {
-  this.options.formatOut = (is.object(options) && options.force === false) ? 'input' : formatOut;
+  if (!(is.object(options) && options.force === false)) {
+    this.options.formatOut = formatOut;
+  }
   return this;
 }
 
@@ -366,7 +661,7 @@ function _setBooleanOption (key, val) {
   if (is.bool(val)) {
     this.options[key] = val;
   } else {
-    throw new Error('Invalid ' + key + ' (boolean) ' + val);
+    throw is.invalidParameterError(key, 'boolean', val);
   }
 }
 
@@ -375,6 +670,7 @@ function _setBooleanOption (key, val) {
  * @private
  */
 function _read () {
+  /* istanbul ignore else */
   if (!this.options.streamOut) {
     this.options.streamOut = true;
     this._pipeline();
@@ -387,14 +683,13 @@ function _read () {
  * @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 () {
+      this.on('finish', () => {
-        that._flattenBufferIn();
+        this._flattenBufferIn();
-        sharp.pipeline(that.options, callback);
+        sharp.pipeline(this.options, callback);
       });
     } else {
       // output=file/buffer, input=file/buffer
@@ -405,41 +700,31 @@ function _pipeline (callback) {
     // output=stream
     if (this._isStreamInput()) {
       // output=stream, input=stream
-      if (this.streamInFinished) {
+      this.once('finish', () => {
         this._flattenBufferIn();
-        sharp.pipeline(this.options, function (err, data, info) {
+        sharp.pipeline(this.options, (err, data, info) => {
           if (err) {
-            that.emit('error', err);
+            this.emit('error', err);
           } else {
-            that.emit('info', info);
+            this.emit('info', info);
-            that.push(data);
+            this.push(data);
           }
-          that.push(null);
+          this.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);
-          });
         });
+      });
+      if (this.streamInFinished) {
+        this.emit('finish');
       }
     } else {
       // output=stream, input=file/buffer
-      sharp.pipeline(this.options, function (err, data, info) {
+      sharp.pipeline(this.options, (err, data, info) => {
         if (err) {
-          that.emit('error', err);
+          this.emit('error', err);
         } else {
-          that.emit('info', info);
+          this.emit('info', info);
-          that.push(data);
+          this.push(data);
         }
-        that.push(null);
+        this.push(null);
       });
     }
     return this;
@@ -447,15 +732,15 @@ function _pipeline (callback) {
     // output=promise
     if (this._isStreamInput()) {
       // output=promise, input=stream
-      return new Promise(function (resolve, reject) {
+      return new Promise((resolve, reject) => {
-        that.on('finish', function () {
+        this.once('finish', () => {
-          that._flattenBufferIn();
+          this._flattenBufferIn();
-          sharp.pipeline(that.options, function (err, data, info) {
+          sharp.pipeline(this.options, (err, data, info) => {
             if (err) {
               reject(err);
             } else {
-              if (that.options.resolveWithObject) {
+              if (this.options.resolveWithObject) {
-                resolve({ data: data, info: info });
+                resolve({ data, info });
               } else {
                 resolve(data);
               }
@@ -465,12 +750,12 @@ function _pipeline (callback) {
       });
     } else {
       // output=promise, input=file/buffer
-      return new Promise(function (resolve, reject) {
+      return new Promise((resolve, reject) => {
-        sharp.pipeline(that.options, function (err, data, info) {
+        sharp.pipeline(this.options, (err, data, info) => {
           if (err) {
             reject(err);
           } else {
-            if (that.options.resolveWithObject) {
+            if (this.options.resolveWithObject) {
               resolve({ data: data, info: info });
             } else {
               resolve(data);
@@ -482,72 +767,12 @@ function _pipeline (callback) {
   }
 }
 
-// Deprecated output options
-/* istanbul ignore next */
-const quality = util.deprecate(function (quality) {
-  const formatOut = this.options.formatOut;
-  const options = { quality: quality };
-  this.jpeg(options).webp(options).tiff(options);
-  this.options.formatOut = formatOut;
-  return this;
-}, 'quality: use jpeg({ quality: ... }), webp({ quality: ... }) and/or tiff({ quality: ... }) instead');
-/* istanbul ignore next */
-const progressive = util.deprecate(function (progressive) {
-  const formatOut = this.options.formatOut;
-  const options = { progressive: (progressive !== false) };
-  this.jpeg(options).png(options);
-  this.options.formatOut = formatOut;
-  return this;
-}, 'progressive: use jpeg({ progressive: ... }) and/or png({ progressive: ... }) instead');
-/* istanbul ignore next */
-const compressionLevel = util.deprecate(function (compressionLevel) {
-  const formatOut = this.options.formatOut;
-  this.png({ compressionLevel: compressionLevel });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'compressionLevel: use png({ compressionLevel: ... }) instead');
-/* istanbul ignore next */
-const withoutAdaptiveFiltering = util.deprecate(function (withoutAdaptiveFiltering) {
-  const formatOut = this.options.formatOut;
-  this.png({ adaptiveFiltering: (withoutAdaptiveFiltering === false) });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'withoutAdaptiveFiltering: use png({ adaptiveFiltering: ... }) instead');
-/* istanbul ignore next */
-const withoutChromaSubsampling = util.deprecate(function (withoutChromaSubsampling) {
-  const formatOut = this.options.formatOut;
-  this.jpeg({ chromaSubsampling: (withoutChromaSubsampling === false) ? '4:2:0' : '4:4:4' });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'withoutChromaSubsampling: use jpeg({ chromaSubsampling: "4:4:4" }) instead');
-/* istanbul ignore next */
-const trellisQuantisation = util.deprecate(function (trellisQuantisation) {
-  const formatOut = this.options.formatOut;
-  this.jpeg({ trellisQuantisation: (trellisQuantisation !== false) });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'trellisQuantisation: use jpeg({ trellisQuantisation: ... }) instead');
-/* istanbul ignore next */
-const overshootDeringing = util.deprecate(function (overshootDeringing) {
-  const formatOut = this.options.formatOut;
-  this.jpeg({ overshootDeringing: (overshootDeringing !== false) });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'overshootDeringing: use jpeg({ overshootDeringing: ... }) instead');
-/* istanbul ignore next */
-const optimiseScans = util.deprecate(function (optimiseScans) {
-  const formatOut = this.options.formatOut;
-  this.jpeg({ optimiseScans: (optimiseScans !== false) });
-  this.options.formatOut = formatOut;
-  return this;
-}, 'optimiseScans: use jpeg({ optimiseScans: ... }) instead');
-
 /**
  * Decorate the Sharp prototype with output-related functions.
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     // Public
     toFile,
     toBuffer,
@@ -556,6 +781,7 @@ module.exports = function (Sharp) {
     png,
     webp,
     tiff,
+    heif,
     raw,
     toFormat,
     tile,
@@ -564,18 +790,5 @@ module.exports = function (Sharp) {
     _setBooleanOption,
     _read,
     _pipeline
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
-  // Deprecated
-  Sharp.prototype.quality = quality;
-  Sharp.prototype.progressive = progressive;
-  Sharp.prototype.compressionLevel = compressionLevel;
-  Sharp.prototype.withoutAdaptiveFiltering = withoutAdaptiveFiltering;
-  Sharp.prototype.withoutChromaSubsampling = withoutChromaSubsampling;
-  Sharp.prototype.trellisQuantisation = trellisQuantisation;
-  Sharp.prototype.trellisQuantization = trellisQuantisation;
-  Sharp.prototype.overshootDeringing = overshootDeringing;
-  Sharp.prototype.optimiseScans = optimiseScans;
-  Sharp.prototype.optimizeScans = optimiseScans;
 };

lib/platform.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const detectLibc = require('detect-libc');
+
+const env = process.env;
+
+module.exports = function () {
+  const arch = env.npm_config_arch || process.arch;
+  const platform = env.npm_config_platform || process.platform;
+  /* istanbul ignore next */
+  const libc = (platform === 'linux' && detectLibc.isNonGlibcLinux) ? detectLibc.family : '';
+
+  const platformId = [`${platform}${libc}`];
+
+  if (arch === 'arm') {
+    platformId.push(`armv${env.npm_config_arm_version || process.config.variables.arm_version || '6'}`);
+  } else if (arch === 'arm64') {
+    platformId.push(`arm64v${env.npm_config_arm_version || '8'}`);
+  } else {
+    platformId.push(arch);
+  }
+
+  return platformId.join('-');
+};

lib/resize.js

@@ -3,7 +3,7 @@
 const is = require('./is');
 
 /**
- * Weighting to apply to image crop.
+ * Weighting to apply when using contain/cover fit.
  * @member
  * @private
  */
@@ -21,7 +21,23 @@ const gravity = {
 };
 
 /**
- * Strategies for automagic crop behaviour.
+ * Position to apply when using contain/cover fit.
+ * @member
+ * @private
+ */
+const position = {
+  top: 1,
+  right: 2,
+  bottom: 3,
+  left: 4,
+  'right top': 5,
+  'right bottom': 6,
+  'left bottom': 7,
+  'left top': 8
+};
+
+/**
+ * Strategies for automagic cover behaviour.
  * @member
  * @private
  */
@@ -38,89 +54,199 @@ const strategy = {
 const kernel = {
   nearest: 'nearest',
   cubic: 'cubic',
+  mitchell: 'mitchell',
   lanczos2: 'lanczos2',
   lanczos3: 'lanczos3'
 };
 
 /**
- * Enlargement interpolators.
+ * Methods by which an image can be resized to fit the provided dimensions.
  * @member
  * @private
  */
-const interpolator = {
+const fit = {
-  nearest: 'nearest',
+  contain: 'contain',
-  bilinear: 'bilinear',
+  cover: 'cover',
-  bicubic: 'bicubic',
+  fill: 'fill',
-  nohalo: 'nohalo',
+  inside: 'inside',
-  lbb: 'lbb',
+  outside: 'outside'
-  locallyBoundedBicubic: 'lbb',
-  vsqbs: 'vsqbs',
-  vertexSplitQuadraticBasisSpline: 'vsqbs'
 };
 
 /**
- * Resize image to `width` x `height`.
+ * Map external fit property to internal canvas property.
- * By default, the resized image is centre cropped to the exact size specified.
+ * @member
+ * @private
+ */
+const mapFitToCanvas = {
+  contain: 'embed',
+  cover: 'crop',
+  fill: 'ignore_aspect',
+  inside: 'max',
+  outside: 'min'
+};
+
+/**
+ * Resize image to `width`, `height` or `width x height`.
  *
- * Possible reduction kernels are:
+ * When both a `width` and `height` are provided, the possible methods by which the image should **fit** these are:
+ * - `cover`: Crop to cover both provided dimensions (the default).
+ * - `contain`: Embed within both provided dimensions.
+ * - `fill`: Ignore the aspect ratio of the input and stretch to both provided dimensions.
+ * - `inside`: Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
+ * - `outside`: Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified.
+ * Some of these values are based on the [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property.
+ *
+ * When using a `fit` of `cover` or `contain`, the default **position** is `centre`. Other options are:
+ * - `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.
+ * - `sharp.gravity`: `north`, `northeast`, `east`, `southeast`, `south`, `southwest`, `west`, `northwest`, `center` or `centre`.
+ * - `sharp.strategy`: `cover` only, dynamically crop using either the `entropy` or `attention` strategy.
+ * Some of these values are based on the [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) CSS property.
+ *
+ * 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.
+ *
+ * Possible interpolation 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).
+ * - `mitchell`: Use a [Mitchell-Netravali spline](https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf).
  * - `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
  * - `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
  *
- * Possible enlargement interpolators are:
- * - `nearest`: Use [nearest neighbour interpolation](http://en.wikipedia.org/wiki/Nearest-neighbor_interpolation).
- * - `bilinear`: Use [bilinear interpolation](http://en.wikipedia.org/wiki/Bilinear_interpolation), faster than bicubic but with less smooth results.
- * - `vertexSplitQuadraticBasisSpline`: Use the smoother [VSQBS interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/vsqbs.cpp#L48) to prevent "staircasing" when enlarging.
- * - `bicubic`: Use [bicubic interpolation](http://en.wikipedia.org/wiki/Bicubic_interpolation) (the default).
- * - `locallyBoundedBicubic`: Use [LBB interpolation](https://github.com/jcupitt/libvips/blob/master/libvips/resample/lbb.cpp#L100), which prevents some "[acutance](http://en.wikipedia.org/wiki/Acutance)" but typically reduces performance by a factor of 2.
- * - `nohalo`: Use [Nohalo interpolation](http://eprints.soton.ac.uk/268086/), which prevents acutance but typically reduces performance by a factor of 3.
- *
  * @example
- * sharp(inputBuffer)
+ * sharp(input)
- *   .resize(200, 300, {
+ *   .resize({ width: 100 })
- *     kernel: sharp.kernel.lanczos2,
+ *   .toBuffer()
- *     interpolator: sharp.interpolator.nohalo
+ *   .then(data => {
- *   })
+ *     // 100 pixels wide, auto-scaled height
- *   .background('white')
- *   .embed()
- *   .toFile('output.tiff')
- *   .then(function() {
- *     // output.tiff is a 200 pixels wide and 300 pixels high image
- *     // containing a lanczos2/nohalo scaled version, embedded on a white canvas,
- *     // of the image data in inputBuffer
  *   });
  *
- * @param {Number} [width] - pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use `null` or `undefined` to auto-scale the width to match the height.
+ * @example
- * @param {Number} [height] - pixels high the resultant image should be, between 1 and 16383. Use `null` or `undefined` to auto-scale the height to match the width.
+ * sharp(input)
+ *   .resize({ height: 100 })
+ *   .toBuffer()
+ *   .then(data => {
+ *     // 100 pixels high, auto-scaled width
+ *   });
+ *
+ * @example
+ * sharp(input)
+ *   .resize(200, 300, {
+ *     kernel: sharp.kernel.nearest,
+ *     fit: 'contain',
+ *     position: 'right top',
+ *     background: { r: 255, g: 255, b: 255, alpha: 0.5 }
+ *   })
+ *   .toFile('output.png')
+ *   .then(() => {
+ *     // output.png is a 200 pixels wide and 300 pixels high image
+ *     // containing a nearest-neighbour scaled version
+ *     // contained within the north-east corner of a semi-transparent white canvas
+ *   });
+ *
+ * @example
+ * const transformer = sharp()
+ *   .resize({
+ *     width: 200,
+ *     height: 200,
+ *     fit: sharp.fit.cover,
+ *     position: sharp.strategy.entropy
+ *   });
+ * // Read image data from readableStream
+ * // Write 200px square auto-cropped image data to writableStream
+ * readableStream
+ *   .pipe(transformer)
+ *   .pipe(writableStream);
+ *
+ * @example
+ * sharp(input)
+ *   .resize(200, 200, {
+ *     fit: sharp.fit.inside,
+ *     withoutEnlargement: true
+ *   })
+ *   .toFormat('jpeg')
+ *   .toBuffer()
+ *   .then(function(outputBuffer) {
+ *     // outputBuffer contains JPEG image data
+ *     // no wider and no higher than 200 pixels
+ *     // and no larger than the input image
+ *   });
+ *
+ * @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.width] - alternative means of specifying `width`. If both are present this take priority.
+ * @param {String} [options.height] - alternative means of specifying `height`. If both are present this take priority.
+ * @param {String} [options.fit='cover'] - how the image should be resized to fit both provided dimensions, one of `cover`, `contain`, `fill`, `inside` or `outside`.
+ * @param {String} [options.position='centre'] - position, gravity or strategy to use when `fit` is `cover` or `contain`.
+ * @param {String|Object} [options.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour when using a `fit` of `contain`, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
  * @param {String} [options.kernel='lanczos3'] - the kernel to use for image reduction.
- * @param {String} [options.interpolator='bicubic'] - the interpolator to use for image enlargement.
+ * @param {Boolean} [options.withoutEnlargement=false] - do not enlarge if the width *or* height are already less than the specified dimensions, equivalent to GraphicsMagick's `>` geometry option.
- * @param {Boolean} [options.centreSampling=false] - use *magick centre sampling convention instead of corner sampling.
+ * @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.
- * @param {Boolean} [options.centerSampling=false] - alternative spelling of centreSampling.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
 function resize (width, height, options) {
   if (is.defined(width)) {
-    if (is.integer(width) && is.inRange(width, 1, this.constructor.maximum.width)) {
+    if (is.object(width) && !is.defined(options)) {
+      options = width;
+    } else if (is.integer(width) && width > 0) {
       this.options.width = width;
     } else {
-      throw is.invalidParameterError('width', `integer between 1 and ${this.constructor.maximum.width}`, width);
+      throw is.invalidParameterError('width', 'positive integer', width);
     }
   } else {
     this.options.width = -1;
   }
   if (is.defined(height)) {
-    if (is.integer(height) && is.inRange(height, 1, this.constructor.maximum.height)) {
+    if (is.integer(height) && height > 0) {
       this.options.height = height;
     } else {
-      throw is.invalidParameterError('height', `integer between 1 and ${this.constructor.maximum.height}`, height);
+      throw is.invalidParameterError('height', 'positive integer', height);
     }
   } else {
     this.options.height = -1;
   }
   if (is.object(options)) {
+    // Width
+    if (is.defined(options.width)) {
+      if (is.integer(options.width) && options.width > 0) {
+        this.options.width = options.width;
+      } else {
+        throw is.invalidParameterError('width', 'positive integer', options.width);
+      }
+    }
+    // Height
+    if (is.defined(options.height)) {
+      if (is.integer(options.height) && options.height > 0) {
+        this.options.height = options.height;
+      } else {
+        throw is.invalidParameterError('height', 'positive integer', options.height);
+      }
+    }
+    // Fit
+    if (is.defined(options.fit)) {
+      const canvas = mapFitToCanvas[options.fit];
+      if (is.string(canvas)) {
+        this.options.canvas = canvas;
+      } else {
+        throw is.invalidParameterError('fit', 'valid fit', options.fit);
+      }
+    }
+    // Position
+    if (is.defined(options.position)) {
+      const pos = is.integer(options.position)
+        ? options.position
+        : strategy[options.position] || position[options.position] || gravity[options.position];
+      if (is.integer(pos) && (is.inRange(pos, 0, 8) || is.inRange(pos, 16, 17))) {
+        this.options.position = pos;
+      } else {
+        throw is.invalidParameterError('position', 'valid position/gravity/strategy', options.position);
+      }
+    }
+    // Background
+    this._setBackgroundColourOption('resizeBackground', options.background);
     // Kernel
     if (is.defined(options.kernel)) {
       if (is.string(kernel[options.kernel])) {
@@ -129,156 +255,134 @@ function resize (width, height, options) {
         throw is.invalidParameterError('kernel', 'valid kernel name', options.kernel);
       }
     }
-    // Interpolator
+    // Without enlargement
-    if (is.defined(options.interpolator)) {
+    if (is.defined(options.withoutEnlargement)) {
-      if (is.string(interpolator[options.interpolator])) {
+      this._setBooleanOption('withoutEnlargement', options.withoutEnlargement);
-        this.options.interpolator = interpolator[options.interpolator];
-      } else {
-        throw is.invalidParameterError('interpolator', 'valid interpolator name', options.interpolator);
-      }
     }
-    // Centre sampling
+    // Shrink on load
-    options.centreSampling = is.bool(options.centerSampling) ? options.centerSampling : options.centreSampling;
+    if (is.defined(options.fastShrinkOnLoad)) {
-    if (is.defined(options.centreSampling)) {
+      this._setBooleanOption('fastShrinkOnLoad', options.fastShrinkOnLoad);
-      this._setBooleanOption('centreSampling', options.centreSampling);
     }
   }
   return this;
 }
 
 /**
- * Crop the resized image to the exact size specified, the default behaviour.
+ * Extends/pads the edges of the image with the provided background colour.
- *
+ * This operation will always occur after resizing and extraction, if any.
- * 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 to 140 pixels wide, then add 10 transparent pixels
- *   .resize(200, 200)
+ * // to the top, left and right edges and 20 to the bottom edge
- *   .crop(sharp.strategy.entropy)
+ * sharp(input)
- *   .on('error', function(err) {
+ *   .resize(140)
- *     console.log(err);
+ *   .extend({
- *   });
+ *     top: 10,
- * // Read image data from readableStream
+ *     bottom: 20,
- * // Write 200px square auto-cropped image data to writableStream
+ *     left: 10,
- * readableStream.pipe(transformer).pipe(writableStream);
+ *     right: 10,
+ *     background: { r: 0, g: 0, b: 0, alpha: 0 }
+ *   })
+ *   ...
  *
- * @param {String} [crop='centre'] - A member of `sharp.gravity` to crop to an edge/corner or `sharp.strategy` to crop dynamically.
+ * @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]
+ * @param {String|Object} [extend.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
+ * @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;
+    this._setBackgroundColourOption('extendBackground', extend.background);
+  } else {
+    throw is.invalidParameterError('extend', 'integer or object', extend);
+  }
+  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 - describes the region to extract using integral pixel values
+ * @param {Number} options.left - zero-indexed offset from left edge
+ * @param {Number} options.top - zero-indexed offset from top edge
+ * @param {Number} options.width - width of region to extract
+ * @param {Number} options.height - height of region to extract
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function crop (crop) {
+function extract (options) {
-  this.options.canvas = 'crop';
+  const suffix = this.options.width === -1 && this.options.height === -1 ? 'Pre' : 'Post';
-  if (!is.defined(crop)) {
+  ['left', 'top', 'width', 'height'].forEach(function (name) {
-    // Default
+    const value = options[name];
-    this.options.crop = gravity.center;
+    if (is.integer(value) && value >= 0) {
-  } else if (is.integer(crop) && is.inRange(crop, 0, 8)) {
+      this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
-    // Gravity (numeric)
+    } else {
-    this.options.crop = crop;
+      throw is.invalidParameterError(name, 'integer', value);
-  } else if (is.string(crop) && is.integer(gravity[crop])) {
+    }
-    // Gravity (string)
+  }, this);
-    this.options.crop = gravity[crop];
+  // Ensure existing rotation occurs before pre-resize extraction
-  } else if (is.integer(crop) && crop >= strategy.entropy) {
+  if (suffix === 'Pre' && ((this.options.angle % 360) !== 0 || this.options.useExifOrientation === true || this.options.rotationAngle !== 0)) {
-    // Strategy
+    this.options.rotateBeforePreExtract = true;
-    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
+ * Trim "boring" pixels from all edges that contain values similar to the top-left pixel.
- * then embed on a background of the exact `width` and `height` specified.
+ * Images consisting entirely of a single colour will calculate "boring" using the alpha channel, if any.
  *
- * If the background contains an alpha value then WebP and PNG format output images will
+ * The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
- * 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 {Number} [threshold=10] the allowed difference from the top-left pixel, a number greater than zero.
  * @returns {Sharp}
+ * @throws {Error} Invalid parameters
  */
-function embed () {
+function trim (threshold) {
-  this.options.canvas = 'embed';
+  if (!is.defined(threshold)) {
-  return this;
+    this.options.trimThreshold = 10;
-}
+  } else if (is.number(threshold) && threshold > 0) {
-
+    this.options.trimThreshold = threshold;
-/**
+  } else {
- * Preserving aspect ratio, resize the image to be as large as possible
+    throw is.invalidParameterError('threshold', 'number greater than zero', threshold);
- * while ensuring its dimensions are less than or equal to the `width` and `height` specified.
+  }
- *
- * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
- *
- * @example
- * sharp(inputBuffer)
- *   .resize(200, 200)
- *   .max()
- *   .toFormat('jpeg')
- *   .toBuffer()
- *   .then(function(outputBuffer) {
- *     // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
- *     // than 200 pixels regardless of the inputBuffer image dimensions
- *   });
- *
- * @returns {Sharp}
- */
-function max () {
-  this.options.canvas = 'max';
-  return this;
-}
-
-/**
- * Preserving aspect ratio, resize the image to be as small as possible
- * while ensuring its dimensions are greater than or equal to the `width` and `height` specified.
- *
- * Both `width` and `height` must be provided via `resize` otherwise the behaviour will default to `crop`.
- *
- * @returns {Sharp}
- */
-function min () {
-  this.options.canvas = 'min';
-  return this;
-}
-
-/**
- * Ignoring the aspect ratio of the input, stretch the image to
- * the exact `width` and/or `height` provided via `resize`.
- * @returns {Sharp}
- */
-function ignoreAspectRatio () {
-  this.options.canvas = 'ignore_aspect';
-  return this;
-}
-
-/**
- * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
- * This is equivalent to GraphicsMagick's `>` geometry option:
- * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
- * @param {Boolean} [withoutEnlargement=true]
- * @returns {Sharp}
-*/
-function withoutEnlargement (withoutEnlargement) {
-  this.options.withoutEnlargement = is.bool(withoutEnlargement) ? withoutEnlargement : true;
   return this;
 }
 
@@ -287,20 +391,16 @@ function withoutEnlargement (withoutEnlargement) {
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     resize,
-    crop,
+    extend,
-    embed,
+    extract,
-    max,
+    trim
-    min,
-    ignoreAspectRatio,
-    withoutEnlargement
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
   // Class attributes
   Sharp.gravity = gravity;
   Sharp.strategy = strategy;
   Sharp.kernel = kernel;
-  Sharp.interpolator = interpolator;
+  Sharp.fit = fit;
+  Sharp.position = position;
 };

lib/utility.js

@@ -4,7 +4,7 @@ const is = require('./is');
 const sharp = require('../build/Release/sharp.node');
 
 /**
- * Gets, or when options are provided sets, the limits of _libvips'_ operation 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.
@@ -16,7 +16,7 @@ const sharp = require('../build/Release/sharp.node');
  * sharp.cache( { files: 0 } );
  * sharp.cache(false);
  *
- * @param {Object|Boolean} options - Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
+ * @param {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
@@ -39,7 +39,7 @@ function cache (options) {
 cache(true);
 
 /**
- * Gets, or when a concurrency is provided sets,
+ * 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.
@@ -82,23 +82,20 @@ function counters () {
  * 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
+ * // simd is `true` if the runtime use of liborc is currently enabled
  * @example
- * const simd = sharp.simd(true);
+ * const simd = sharp.simd(false);
- * // attempts to enable the use of SIMD, returning true if available
+ * // prevent libvips from using liborc at runtime
  *
- * @param {Boolean} [simd=false]
+ * @param {Boolean} [simd=true]
  * @returns {Boolean}
  */
 function simd (simd) {
   return sharp.simd(is.bool(simd) ? simd : null);
 }
-simd(false);
+simd(true);
 
 /**
  * Decorate the Sharp class with utility-related functions.

mkdocs.yml

@@ -1,10 +1,12 @@
 site_name: sharp
-site_url: http://sharp.pixelplumbing.com/
+site_url: https://sharp.pixelplumbing.com/
 repo_url: https://github.com/lovell/sharp
 site_description: High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images
 copyright: <a href="https://pixelplumbing.com/">pixelplumbing.com</a>
 google_analytics: ['UA-13034748-12', 'sharp.pixelplumbing.com']
 theme: readthedocs
+extra_css:
+  - css/extra.css
 markdown_extensions:
   - toc:
       permalink: True

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images",
-  "version": "0.17.3",
+  "version": "0.23.3",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://github.com/lovell/sharp",
   "contributors": [
@@ -34,16 +34,57 @@
     "Jérémy Lal <kapouer@melix.org>",
     "Rahul Nanwani <r.nanwani@gmail.com>",
     "Alice Monday <alice0meta@gmail.com>",
-    "Kristo Jorgenson <kristo.jorgenson@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>",
+    "Aidan Hoolachan <ajhoolachan21@gmail.com>",
+    "Axel Eirola <axel.eirola@iki.fi>",
+    "Freezy <freezy@xbmc.org>",
+    "Daiz <taneli.vatanen@gmail.com>",
+    "Julian Aubourg <j@ubourg.net>",
+    "Keith Belovay <keith@picthrive.com>",
+    "Michael B. Klein <mbklein@gmail.com>",
+    "Jordan Prudhomme <jordan@raboland.fr>",
+    "Ilya Ovdin <iovdin@gmail.com>",
+    "Andargor <andargor@yahoo.com>",
+    "Paul Neave <paul.neave@gmail.com>",
+    "Brendan Kennedy <brenwken@gmail.com>"
   ],
   "scripts": {
-    "clean": "rm -rf node_modules/ build/ vendor/ coverage/ test/fixtures/output.*",
+    "install": "(node install/libvips && node install/dll-copy && prebuild-install) || (node-gyp rebuild && node install/dll-copy)",
-    "test": "semistandard && cc && cross-env VIPS_WARNING=0 nyc --reporter=lcov --branches=99 mocha --slow=5000 --timeout=60000 ./test/unit/*.js",
+    "clean": "rm -rf node_modules/ build/ vendor/ .nyc_output/ coverage/ test/fixtures/output.*",
+    "test": "semistandard && cpplint && npm run test-unit && npm run test-licensing && prebuild-ci",
+    "test-unit": "nyc --reporter=lcov --branches=99 mocha --slow=5000 --timeout=60000 ./test/unit/*.js",
+    "test-licensing": "license-checker --production --summary --onlyAllow=\"Apache-2.0;BSD;ISC;MIT\"",
+    "test-coverage": "./test/coverage/report.sh",
     "test-leak": "./test/leak/leak.sh",
-    "test-packaging": "./packaging/test-linux-x64.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"
-    "docs": "for m in constructor input resize composite operation colour channel output utility; do documentation build --shallow --format=md lib/$m.js >docs/api-$m.md; done"
   },
   "main": "lib/index.js",
+  "files": [
+    "binding.gyp",
+    "docs/**",
+    "!docs/css/**",
+    "install/**",
+    "lib/**",
+    "src/**"
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/lovell/sharp"
@@ -60,37 +101,46 @@
     "resize",
     "thumbnail",
     "crop",
+    "embed",
     "libvips",
     "vips"
   ],
   "dependencies": {
-    "caw": "^2.0.0",
+    "color": "^3.1.2",
-    "color": "^1.0.3",
+    "detect-libc": "^1.0.3",
-    "got": "^6.7.1",
+    "nan": "^2.14.0",
-    "nan": "^2.5.1",
+    "npmlog": "^4.1.2",
-    "semver": "^5.3.0",
+    "prebuild-install": "^5.3.3",
-    "tar": "^2.2.1"
+    "semver": "^6.3.0",
+    "simple-get": "^3.1.0",
+    "tar": "^5.0.5",
+    "tunnel-agent": "^0.6.0"
   },
   "devDependencies": {
-    "async": "^2.2.0",
+    "async": "^3.1.0",
-    "bufferutil": "^3.0.0",
+    "cc": "^2.0.1",
-    "cc": "^1.0.0",
+    "decompress-zip": "^0.3.2",
-    "cross-env": "^4.0.0",
+    "documentation": "^12.1.4",
-    "documentation": "^4.0.0-beta.18",
+    "exif-reader": "^1.0.3",
-    "exif-reader": "^1.0.2",
     "icc": "^1.0.0",
-    "mocha": "^3.2.0",
+    "license-checker": "^25.0.1",
-    "nyc": "^10.2.0",
+    "mocha": "^6.2.2",
-    "rimraf": "^2.5.4",
+    "mock-fs": "^4.10.3",
-    "semistandard": "^10.0.0",
+    "nyc": "^14.1.1",
-    "unzip": "^0.1.11"
+    "prebuild": "^9.1.1",
+    "prebuild-ci": "^3.1.0",
+    "rimraf": "^3.0.0",
+    "semistandard": "^14.2.0"
   },
   "license": "Apache-2.0",
   "config": {
-    "libvips": "8.4.2"
+    "libvips": "8.8.1"
   },
   "engines": {
-    "node": ">=4"
+    "node": ">=8.5.0"
+  },
+  "funding": {
+    "url": "https://opencollective.com/libvips"
   },
   "semistandard": {
     "env": [
@@ -100,8 +150,7 @@
   "cc": {
     "linelength": "120",
     "filter": [
-      "build/include",
+      "build/include"
-      "runtime/indentation_namespace"
     ]
   }
 }

packaging/README.md

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

packaging/build.sh

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

packaging/build/lin.sh

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

packaging/build/win.sh

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

packaging/linux-armv6/Dockerfile

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

packaging/linux-armv7/Dockerfile

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

packaging/linux-armv8/Dockerfile

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

packaging/linux-x64/Dockerfile

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

packaging/test-linux-arm.sh

@@ -1,28 +0,0 @@
-#!/bin/sh
-
-if [ $# -lt 1 ]; then
-  echo "Usage: $0 IP"
-  echo "Test sharp on ARM using Docker, where IP is"
-  echo "the address of a Raspberry Pi running HypriotOS"
-  exit 1
-fi
-IP="$1"
-
-echo "Verifying connectivity to $IP"
-if ! ping -c 1 $IP; then
-  echo "Could not connect to $IP"
-  exit 1
-fi
-
-if ! type sshpass >/dev/null; then
-  echo "Please install sshpass"
-  exit 1
-fi
-
-export SSHPASS=hypriot
-
-echo "Copying sharp source to device"
-sshpass -e scp -o PreferredAuthentications=password -r ../../sharp pirate@${IP}:/home/pirate/sharp
-
-echo "Compile and test within container"
-sshpass -e ssh -o PreferredAuthentications=password -t pirate@${IP} "docker run --rm -v \${PWD}/sharp:/s hypriot/rpi-node:6 sh -c 'cd /s && npm install --unsafe-perm && npm test'"

packaging/test-linux-x64.sh

@@ -1,56 +0,0 @@
-#!/bin/sh
-
-# Verify docker is available
-if ! type docker >/dev/null; then
-  echo "Please install docker"
-  exit 1
-fi
-
-version_node=6.3.0
-
-test="npm run clean; npm install --unsafe-perm; npm test"
-
-# Debian 7, 8
-# Ubuntu 14.04
-for dist in wheezy jessie trusty; do
-  echo "Testing $dist..."
-  if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/$dist:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; ./packaging/test/debian.sh; $test";
-  then echo "$dist OK"
-  else echo "$dist fail" && cat packaging/$dist.log
-  fi
-done
-
-# Centos 7
-echo "Testing centos7..."
-if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/centos7:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
-then echo "centos7 OK"
-else echo "centos7 fail" && cat packaging/$dist.log
-fi
-
-# Fedora 22
-echo "Testing fedora22..."
-if docker run -i -t --rm -v $PWD:/v -e "NODE_ENV=development" nodesource/fedora22:$version_node >packaging/$dist.log 2>&1 sh -c "cd /v; $test";
-then echo "fedora22 OK"
-else echo "fedora22 fail" && cat packaging/$dist.log
-fi
-
-# openSUSE 13.2
-echo "Testing opensuse..."
-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 pritunl/archlinux:latest >packaging/archlinux.log 2>&1 sh -c "cd /v; ./packaging/test/archlinux.sh; $test";
-then echo "archlinux OK"
-else echo "archlinux fail" && cat packaging/archlinux.log
-fi
-
-# Alpine
-echo "Testing alpine..."
-if docker run -i -t --rm -v $PWD:/v -e "SHARP_TEST_WITHOUT_CACHE=0" alpine:edge >packaging/alpine.log 2>&1 sh -c "cd /v; ./packaging/test/alpine.sh; $test";
-then echo "alpine OK"
-else echo "alpine fail" && cat packaging/alpine.log
-fi

packaging/test/alpine.sh

@@ -1,7 +0,0 @@
-#!/bin/sh
-
-# Install build dependencies
-apk add --update make gcc g++ python nodejs
-
-# Install libvips from aports/testing
-apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing vips-dev

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/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 npm
-npm install -g npm

packaging/win32-x64/Dockerfile

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

src/common.cc

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -16,6 +16,8 @@
 #include <string>
 #include <string.h>
 #include <vector>
+#include <queue>
+#include <mutex>  // NOLINT(build/c++11)
 
 #include <node.h>
 #include <node_buffer.h>
@@ -29,16 +31,24 @@ using vips::VImage;
 namespace sharp {
 
   // Convenience methods to access the attributes of a v8::Object
-  bool HasAttr(v8::Handle<v8::Object> obj, std::string attr) {
+  bool HasAttr(v8::Local<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) {
+  std::string AttrAsStr(v8::Local<v8::Object> obj, std::string attr) {
     return *Nan::Utf8String(Nan::Get(obj, Nan::New(attr).ToLocalChecked()).ToLocalChecked());
   }
+  std::vector<double> AttrAsRgba(v8::Local<v8::Object> obj, std::string attr) {
+    v8::Local<v8::Object> background = AttrAs<v8::Object>(obj, attr);
+    std::vector<double> rgba(4);
+    for (unsigned int i = 0; i < 4; i++) {
+      rgba[i] = AttrTo<double>(background, i);
+    }
+    return rgba;
+  }
 
   // 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
+    v8::Local<v8::Object> input, std::vector<v8::Local<v8::Object>> &buffersToPersist
   ) {
     Nan::HandleScope();
     InputDescriptor *descriptor = new InputDescriptor;
@@ -50,9 +60,10 @@ namespace sharp {
       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");
+      descriptor->density = AttrTo<double>(input, "density");
     }
     // Raw pixel input
     if (HasAttr(input, "rawChannels")) {
@@ -60,15 +71,19 @@ namespace sharp {
       descriptor->rawWidth = AttrTo<uint32_t>(input, "rawWidth");
       descriptor->rawHeight = AttrTo<uint32_t>(input, "rawHeight");
     }
+    // Multi-page input (GIF, TIFF, PDF)
+    if (HasAttr(input, "pages")) {
+      descriptor->pages = AttrTo<int32_t>(input, "pages");
+    }
+    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");
+      descriptor->createBackground = AttrAsRgba(input, "createBackground");
-      for (unsigned int i = 0; i < 4; i++) {
-        descriptor->createBackground[i] = AttrTo<double>(createBackground, i);
-      }
     }
     return descriptor;
   }
@@ -95,6 +110,15 @@ namespace sharp {
   bool IsTiff(std::string const &str) {
     return EndsWith(str, ".tif") || EndsWith(str, ".tiff") || EndsWith(str, ".TIF") || EndsWith(str, ".TIFF");
   }
+  bool IsHeic(std::string const &str) {
+    return EndsWith(str, ".heic") || EndsWith(str, ".HEIC");
+  }
+  bool IsHeif(std::string const &str) {
+    return EndsWith(str, ".heif") || EndsWith(str, ".HEIF") || IsHeic(str) || IsAvif(str);
+  }
+  bool IsAvif(std::string const &str) {
+    return EndsWith(str, ".avif") || EndsWith(str, ".AVIF");
+  }
   bool IsDz(std::string const &str) {
     return EndsWith(str, ".dzi") || EndsWith(str, ".DZI");
   }
@@ -117,14 +141,16 @@ namespace sharp {
       case ImageType::TIFF: id = "tiff"; break;
       case ImageType::GIF: id = "gif"; break;
       case ImageType::SVG: id = "svg"; break;
+      case ImageType::HEIF: id = "heif"; 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::VIPS: id = "vips"; break;
       case ImageType::RAW: id = "raw"; break;
       case ImageType::UNKNOWN: id = "unknown"; break;
+      case ImageType::MISSING: id = "missing"; break;
     }
     return id;
   }
@@ -149,6 +175,8 @@ namespace sharp {
         imageType = ImageType::GIF;
       } else if (EndsWith(loader, "SvgBuffer")) {
         imageType = ImageType::SVG;
+      } else if (EndsWith(loader, "HeifBuffer")) {
+        imageType = ImageType::HEIF;
       } else if (EndsWith(loader, "PdfBuffer")) {
         imageType = ImageType::PDF;
       } else if (EndsWith(loader, "MagickBuffer")) {
@@ -180,6 +208,8 @@ namespace sharp {
         imageType = ImageType::GIF;
       } else if (EndsWith(loader, "SvgFile")) {
         imageType = ImageType::SVG;
+      } else if (EndsWith(loader, "HeifFile")) {
+        imageType = ImageType::HEIF;
       } else if (EndsWith(loader, "PdfFile")) {
         imageType = ImageType::PDF;
       } else if (EndsWith(loader, "Ppm")) {
@@ -191,10 +221,25 @@ namespace sharp {
       } else if (EndsWith(loader, "Magick") || EndsWith(loader, "MagickFile")) {
         imageType = ImageType::MAGICK;
       }
+    } else {
+      if (EndsWith(vips::VError().what(), " not found\n")) {
+        imageType = ImageType::MISSING;
+      }
     }
     return imageType;
   }
 
+  /*
+    Does this image type support multiple pages?
+  */
+  bool ImageTypeSupportsPage(ImageType imageType) {
+    return
+      imageType == ImageType::GIF ||
+      imageType == ImageType::TIFF ||
+      imageType == ImageType::HEIF ||
+      imageType == ImageType::PDF;
+  }
+
   /*
     Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
   */
@@ -217,19 +262,25 @@ namespace sharp {
         imageType = DetermineImageType(descriptor->buffer, descriptor->bufferLength);
         if (imageType != ImageType::UNKNOWN) {
           try {
-            vips::VOption *option = VImage::option()->set("access", accessMethod);
+            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));
+              option->set("dpi", descriptor->density);
             }
             if (imageType == ImageType::MAGICK) {
               option->set("density", std::to_string(descriptor->density).data());
             }
+            if (ImageTypeSupportsPage(imageType)) {
+              option->set("n", descriptor->pages);
+              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 (...) {
+          } catch (vips::VError const &err) {
-            throw vips::VError("Input buffer has corrupt header");
+            throw vips::VError(std::string("Input buffer has corrupt header: ") + err.what());
           }
         } else {
           throw vips::VError("Input buffer contains unsupported image format");
@@ -252,24 +303,33 @@ namespace sharp {
       } else {
         // From filesystem
         imageType = DetermineImageType(descriptor->file.data());
+        if (imageType == ImageType::MISSING) {
+          throw vips::VError("Input file is missing");
+        }
         if (imageType != ImageType::UNKNOWN) {
           try {
-            vips::VOption *option = VImage::option()->set("access", accessMethod);
+            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));
+              option->set("dpi", descriptor->density);
             }
             if (imageType == ImageType::MAGICK) {
               option->set("density", std::to_string(descriptor->density).data());
             }
+            if (ImageTypeSupportsPage(imageType)) {
+              option->set("n", descriptor->pages);
+              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 (...) {
+          } catch (vips::VError const &err) {
-            throw vips::VError("Input file has corrupt header");
+            throw vips::VError(std::string("Input file has corrupt header: ") + err.what());
           }
         } else {
-          throw vips::VError("Input file is missing or of an unsupported image format");
+          throw vips::VError("Input file contains unsupported image format");
         }
       }
     }
@@ -338,13 +398,28 @@ namespace sharp {
   /*
     Set pixels/mm resolution based on a pixels/inch density.
   */
-  void SetDensity(VImage image, const int density) {
+  void SetDensity(VImage image, const double density) {
-    const double pixelsPerMm = static_cast<double>(density) / 25.4;
+    const double pixelsPerMm = 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::WEBP) {
+      if (image.width() > 16383 || image.height() > 16383) {
+        throw vips::VError("Processed image is too large for the WebP format");
+      }
+    }
+  }
+
   /*
     Called when a Buffer undergoes GC, required to support mixed runtime libraries in Windows
   */
@@ -354,9 +429,91 @@ 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.
+    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) {
@@ -390,9 +547,11 @@ namespace sharp {
         // Southeast
         left = inWidth - outWidth;
         top = inHeight - outHeight;
+        break;
       case 7:
         // Southwest
         top = inHeight - outHeight;
+        break;
       case 8:
         // Northwest
         break;
@@ -486,4 +645,40 @@ namespace sharp {
     }
   }
 
+  /*
+    Apply the alpha channel to a given colour
+  */
+  std::tuple<VImage, std::vector<double>> ApplyAlpha(VImage image, std::vector<double> colour) {
+    // Scale up 8-bit values to match 16-bit input image
+    double const multiplier = sharp::Is16Bit(image.interpretation()) ? 256.0 : 1.0;
+    // Create alphaColour colour
+    std::vector<double> alphaColour;
+    if (image.bands() > 2) {
+      alphaColour = {
+        multiplier * colour[0],
+        multiplier * colour[1],
+        multiplier * colour[2]
+      };
+    } else {
+      // Convert sRGB to greyscale
+      alphaColour = { multiplier * (
+        0.2126 * colour[0] +
+        0.7152 * colour[1] +
+        0.0722 * colour[2])
+      };
+    }
+    // Add alpha channel to alphaColour colour
+    if (colour[3] < 255.0 || HasAlpha(image)) {
+      alphaColour.push_back(colour[3] * multiplier);
+    }
+    // Ensure alphaColour colour uses correct colourspace
+    alphaColour = sharp::GetRgbaAsColourspace(alphaColour, image.interpretation());
+    // Add non-transparent alpha channel, if required
+    if (colour[3] < 255.0 && !HasAlpha(image)) {
+      image = image.bandjoin(
+        VImage::new_matrix(image.width(), image.height()).new_from_image(255 * multiplier));
+    }
+    return std::make_tuple(image, alphaColour);
+  }
+
 }  // namespace sharp

src/common.h

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -25,17 +25,17 @@
 
 // Verify platform and compiler compatibility
 
-#if (VIPS_MAJOR_VERSION < 8 || (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 4))
+#if (VIPS_MAJOR_VERSION < 8 || (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 8))
-#error libvips version 8.4.x required - see sharp.dimens.io/page/install
+#error libvips version 8.8.0+ 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.dimens.io/page/install#prerequisites
+#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.dimens.io/page/install#prerequisites
+#error clang version 3.0+ is required for C++11 features - see sharp.pixelplumbing.com/page/install#prerequisites
 #endif
 #endif
 
@@ -43,53 +43,56 @@ using vips::VImage;
 
 namespace sharp {
 
-  struct InputDescriptor {
+  struct InputDescriptor {  // NOLINT(runtime/indentation_namespace)
     std::string name;
     std::string file;
     char *buffer;
+    bool failOnError;
     size_t bufferLength;
-    int density;
+    double density;
     int rawChannels;
     int rawWidth;
     int rawHeight;
+    int pages;
+    int page;
     int createChannels;
     int createWidth;
     int createHeight;
-    double createBackground[4];
+    std::vector<double> createBackground;
 
     InputDescriptor():
       buffer(nullptr),
+      failOnError(TRUE),
       bufferLength(0),
-      density(72),
+      density(72.0),
       rawChannels(0),
       rawWidth(0),
       rawHeight(0),
+      pages(1),
+      page(0),
       createChannels(0),
       createWidth(0),
-      createHeight(0) {
+      createHeight(0),
-        createBackground[0] = 0.0;
+      createBackground{ 0.0, 0.0, 0.0, 255.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);
+  bool HasAttr(v8::Local<v8::Object> obj, std::string attr);
-  std::string AttrAsStr(v8::Handle<v8::Object> obj, std::string attr);
+  std::string AttrAsStr(v8::Local<v8::Object> obj, std::string attr);
-  template<typename T> v8::Local<T> AttrAs(v8::Handle<v8::Object> obj, std::string attr) {
+  std::vector<double> AttrAsRgba(v8::Local<v8::Object> obj, std::string attr);
+  template<typename T> v8::Local<T> AttrAs(v8::Local<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) {
+  template<typename T> T AttrTo(v8::Local<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) {
+  template<typename T> T AttrTo(v8::Local<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);
+    v8::Local<v8::Object> input, std::vector<v8::Local<v8::Object>> &buffersToPersist);  // NOLINT(runtime/references)
 
   enum class ImageType {
     JPEG,
@@ -98,6 +101,7 @@ namespace sharp {
     TIFF,
     GIF,
     SVG,
+    HEIF,
     PDF,
     MAGICK,
     OPENSLIDE,
@@ -105,7 +109,8 @@ namespace sharp {
     FITS,
     VIPS,
     RAW,
-    UNKNOWN
+    UNKNOWN,
+    MISSING
   };
 
   // How many tasks are in the queue?
@@ -119,6 +124,9 @@ namespace sharp {
   bool IsPng(std::string const &str);
   bool IsWebp(std::string const &str);
   bool IsTiff(std::string const &str);
+  bool IsHeic(std::string const &str);
+  bool IsHeif(std::string const &str);
+  bool IsAvif(std::string const &str);
   bool IsDz(std::string const &str);
   bool IsDzZip(std::string const &str);
   bool IsV(std::string const &str);
@@ -138,6 +146,11 @@ namespace sharp {
   */
   ImageType DetermineImageType(char const *file);
 
+  /*
+    Does this image type support multiple pages?
+  */
+  bool ImageTypeSupportsPage(ImageType imageType);
+
   /*
     Open an image from the given InputDescriptor (filesystem, compressed buffer, raw pixel data)
   */
@@ -182,13 +195,35 @@ namespace sharp {
   /*
     Set pixels/mm resolution based on a pixels/inch density.
   */
-  void SetDensity(VImage image, const int density);
+  void SetDensity(VImage image, const double 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.
@@ -229,6 +264,11 @@ namespace sharp {
   */
   std::vector<double> GetRgbaAsColourspace(std::vector<double> const rgba, VipsInterpretation const interpretation);
 
+  /*
+    Apply the alpha channel to a given colour
+   */
+  std::tuple<VImage, std::vector<double>> ApplyAlpha(VImage image, std::vector<double> colour);
+
 }  // namespace sharp
 
 #endif  // SRC_COMMON_H_

src/libvips/cplusplus/VError.cpp

@@ -32,8 +32,6 @@
 #endif /*HAVE_CONFIG_H*/
 #include <vips/intl.h>
 
-#include <iostream>
-
 #include <vips/vips8>
 
 VIPS_NAMESPACE_START

src/metadata.cc

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -25,9 +25,11 @@
 class MetadataWorker : public Nan::AsyncWorker {
  public:
   MetadataWorker(
-    Nan::Callback *callback, MetadataBaton *baton,
+    Nan::Callback *callback, MetadataBaton *baton, Nan::Callback *debuglog,
-    std::vector<v8::Local<v8::Object>> const buffersToPersist)
+    std::vector<v8::Local<v8::Object>> const buffersToPersist) :
-    : Nan::AsyncWorker(callback), baton(baton), buffersToPersist(buffersToPersist) {
+    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 {
@@ -56,9 +58,28 @@ class MetadataWorker : public Nan::AsyncWorker {
       baton->height = image.height();
       baton->space = vips_enum_nick(VIPS_TYPE_INTERPRETATION, image.interpretation());
       baton->channels = image.bands();
+      baton->depth = vips_enum_nick(VIPS_TYPE_BAND_FORMAT, image.format());
       if (sharp::HasDensity(image)) {
         baton->density = sharp::GetDensity(image);
       }
+      if (image.get_typeof("jpeg-chroma-subsample") == VIPS_TYPE_REF_STRING) {
+        baton->chromaSubsampling = image.get_string("jpeg-chroma-subsample");
+      }
+      if (image.get_typeof("interlaced") == G_TYPE_INT) {
+        baton->isProgressive = image.get_int("interlaced") == 1;
+      }
+      if (image.get_typeof("palette-bit-depth") == G_TYPE_INT) {
+        baton->paletteBitDepth = image.get_int("palette-bit-depth");
+      }
+      if (image.get_typeof(VIPS_META_N_PAGES) == G_TYPE_INT) {
+        baton->pages = image.get_int(VIPS_META_N_PAGES);
+      }
+      if (image.get_typeof(VIPS_META_PAGE_HEIGHT) == G_TYPE_INT) {
+        baton->pageHeight = image.get_int(VIPS_META_PAGE_HEIGHT);
+      }
+      if (image.get_typeof("heif-primary") == G_TYPE_INT) {
+        baton->pagePrimary = image.get_int("heif-primary");
+      }
       baton->hasProfile = sharp::HasProfile(image);
       // Derived attributes
       baton->hasAlpha = sharp::HasAlpha(image);
@@ -79,6 +100,22 @@ class MetadataWorker : public Nan::AsyncWorker {
         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;
+      }
     }
 
     // Clean up
@@ -98,13 +135,35 @@ class MetadataWorker : public Nan::AsyncWorker {
       // Metadata Object
       v8::Local<v8::Object> info = New<v8::Object>();
       Set(info, New("format").ToLocalChecked(), New<v8::String>(baton->format).ToLocalChecked());
+      if (baton->input->bufferLength > 0) {
+        Set(info, New("size").ToLocalChecked(), New<v8::Uint32>(static_cast<uint32_t>(baton->input->bufferLength)));
+      }
       Set(info, New("width").ToLocalChecked(), New<v8::Uint32>(baton->width));
       Set(info, New("height").ToLocalChecked(), New<v8::Uint32>(baton->height));
       Set(info, New("space").ToLocalChecked(), New<v8::String>(baton->space).ToLocalChecked());
       Set(info, New("channels").ToLocalChecked(), New<v8::Uint32>(baton->channels));
+      Set(info, New("depth").ToLocalChecked(), New<v8::String>(baton->depth).ToLocalChecked());
       if (baton->density > 0) {
         Set(info, New("density").ToLocalChecked(), New<v8::Uint32>(baton->density));
       }
+      if (!baton->chromaSubsampling.empty()) {
+        Set(info,
+          New("chromaSubsampling").ToLocalChecked(),
+          New<v8::String>(baton->chromaSubsampling).ToLocalChecked());
+      }
+      Set(info, New("isProgressive").ToLocalChecked(), New<v8::Boolean>(baton->isProgressive));
+      if (baton->paletteBitDepth > 0) {
+        Set(info, New("paletteBitDepth").ToLocalChecked(), New<v8::Uint32>(baton->paletteBitDepth));
+      }
+      if (baton->pages > 0) {
+        Set(info, New("pages").ToLocalChecked(), New<v8::Uint32>(baton->pages));
+      }
+      if (baton->pageHeight > 0) {
+        Set(info, New("pageHeight").ToLocalChecked(), New<v8::Uint32>(baton->pageHeight));
+      }
+      if (baton->pagePrimary > -1) {
+        Set(info, New("pagePrimary").ToLocalChecked(), New<v8::Uint32>(baton->pagePrimary));
+      }
       Set(info, New("hasProfile").ToLocalChecked(), New<v8::Boolean>(baton->hasProfile));
       Set(info, New("hasAlpha").ToLocalChecked(), New<v8::Boolean>(baton->hasAlpha));
       if (baton->orientation > 0) {
@@ -120,6 +179,16 @@ class MetadataWorker : public Nan::AsyncWorker {
           New("icc").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;
     }
 
@@ -132,12 +201,21 @@ class MetadataWorker : public Nan::AsyncWorker {
     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;
 };
 
@@ -155,9 +233,12 @@ NAN_METHOD(metadata) {
   // Input
   baton->input = sharp::CreateInputDescriptor(sharp::AttrAs<v8::Object>(options, "input"), buffersToPersist);
 
+  // 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 MetadataWorker(callback, baton, buffersToPersist));
+  Nan::AsyncQueueWorker(new MetadataWorker(callback, baton, debuglog, buffersToPersist));
 
   // Increment queued task counter
   g_atomic_int_inc(&sharp::counterQueue);

src/metadata.h

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -29,7 +29,14 @@ struct MetadataBaton {
   int height;
   std::string space;
   int channels;
+  std::string depth;
   int density;
+  std::string chromaSubsampling;
+  bool isProgressive;
+  int paletteBitDepth;
+  int pages;
+  int pageHeight;
+  int pagePrimary;
   bool hasProfile;
   bool hasAlpha;
   int orientation;
@@ -37,6 +44,10 @@ struct MetadataBaton {
   size_t exifLength;
   char *icc;
   size_t iccLength;
+  char *iptc;
+  size_t iptcLength;
+  char *xmp;
+  size_t xmpLength;
   std::string err;
 
   MetadataBaton():
@@ -45,13 +56,22 @@ struct MetadataBaton {
     height(0),
     channels(0),
     density(0),
+    isProgressive(false),
+    paletteBitDepth(0),
+    pages(0),
+    pageHeight(0),
+    pagePrimary(-1),
     hasProfile(false),
     hasAlpha(false),
     orientation(0),
     exif(nullptr),
     exifLength(0),
     icc(nullptr),
-    iccLength(0) {}
+    iccLength(0),
+    iptc(nullptr),
+    iptcLength(0),
+    xmp(nullptr),
+    xmpLength(0) {}
 };
 
 NAN_METHOD(metadata);

src/operations.cc

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -29,162 +29,52 @@ using vips::VError;
 namespace sharp {
 
   /*
-    Alpha composite src over dst with given gravity.
+    Removes alpha channel, if any.
-    Assumes alpha channels are already premultiplied and will be unpremultiplied after.
+  */
-   */
+  VImage RemoveAlpha(VImage image) {
-  VImage Composite(VImage src, VImage dst, const int gravity) {
+    if (HasAlpha(image)) {
-    if (IsInputValidForComposition(src, dst)) {
+      image = image.extract_band(0, VImage::option()->set("n", image.bands() - 1));
-      // Enlarge overlay src, if required
-      if (src.width() < dst.width() || src.height() < dst.height()) {
-        // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
-        int left;
-        int top;
-        std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), src.width(), src.height(), gravity);
-        // Embed onto transparent background
-        std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
-        src = src.embed(left, top, dst.width(), dst.height(), VImage::option()
-          ->set("extend", VIPS_EXTEND_BACKGROUND)
-          ->set("background", background));
-      }
-      return CompositeImage(src, dst);
     }
-    // If the input was not valid for composition the return the input image itself
+    return image;
-    return dst;
-  }
-
-  VImage Composite(VImage src, VImage dst, const int x, const int y) {
-    if (IsInputValidForComposition(src, dst)) {
-      // Enlarge overlay src, if required
-      if (src.width() < dst.width() || src.height() < dst.height()) {
-        // Calculate the (left, top) coordinates of the output image within the input image, applying the given gravity.
-        int left;
-        int top;
-        std::tie(left, top) = CalculateCrop(dst.width(), dst.height(), src.width(), src.height(), x, y);
-        // Embed onto transparent background
-        std::vector<double> background { 0.0, 0.0, 0.0, 0.0 };
-        src = src.embed(left, top, dst.width(), dst.height(), VImage::option()
-          ->set("extend", VIPS_EXTEND_BACKGROUND)
-          ->set("background", background));
-      }
-      return CompositeImage(src, dst);
-    }
-    // If the input was not valid for composition the return the input image itself
-    return dst;
-  }
-
-  bool IsInputValidForComposition(VImage src, VImage dst) {
-    using sharp::CalculateCrop;
-    using sharp::HasAlpha;
-
-    if (!HasAlpha(src)) {
-      throw VError("Overlay image must have an alpha channel");
-    }
-    if (!HasAlpha(dst)) {
-      throw VError("Image to be overlaid must have an alpha channel");
-    }
-    if (src.width() > dst.width() || src.height() > dst.height()) {
-      throw VError("Overlay image must have same dimensions or smaller");
-    }
-
-    return true;
-  }
-
-  VImage CompositeImage(VImage src, VImage dst) {
-    // Split src into non-alpha and alpha channels
-    VImage srcWithoutAlpha = src.extract_band(0, VImage::option()->set("n", src.bands() - 1));
-    VImage srcAlpha = src[src.bands() - 1] * (1.0 / 255.0);
-
-    // Split dst into non-alpha and alpha channels
-    VImage dstWithoutAlpha = dst.extract_band(0, VImage::option()->set("n", dst.bands() - 1));
-    VImage dstAlpha = dst[dst.bands() - 1] * (1.0 / 255.0);
-
-    //
-    // Compute normalized output alpha channel:
-    //
-    // References:
-    // - http://en.wikipedia.org/wiki/Alpha_compositing#Alpha_blending
-    // - https://github.com/jcupitt/ruby-vips/issues/28#issuecomment-9014826
-    //
-    // out_a = src_a + dst_a * (1 - src_a)
-    //                         ^^^^^^^^^^^
-    //                            t0
-    VImage t0 = srcAlpha.linear(-1.0, 1.0);
-    VImage outAlphaNormalized = srcAlpha + dstAlpha * t0;
-
-    //
-    // Compute output RGB channels:
-    //
-    // Wikipedia:
-    // out_rgb = (src_rgb * src_a + dst_rgb * dst_a * (1 - src_a)) / out_a
-    //                                                ^^^^^^^^^^^
-    //                                                    t0
-    //
-    // Omit division by `out_a` since `Compose` is supposed to output a
-    // premultiplied RGBA image as reversal of premultiplication is handled
-    // externally.
-    //
-    VImage outRGBPremultiplied = srcWithoutAlpha + dstWithoutAlpha * t0;
-
-    // Combine RGB and alpha channel into output image:
-    return outRGBPremultiplied.bandjoin(outAlphaNormalized * 255.0);
   }
 
   /*
-    Cutout src over dst with given gravity.
+    Ensures alpha channel, if missing.
+  */
+  VImage EnsureAlpha(VImage image) {
+    if (!HasAlpha(image)) {
+      std::vector<double> alpha;
+      alpha.push_back(sharp::MaximumImageAlpha(image.interpretation()));
+      image = image.bandjoin_const(alpha);
+    }
+    return image;
+  }
+
+  /*
+   * Tint an image using the specified chroma, preserving the original image luminance
    */
-  VImage Cutout(VImage mask, VImage dst, const int gravity) {
+  VImage Tint(VImage image, double const a, double const b) {
-    using sharp::CalculateCrop;
+    // Get original colourspace
-    using sharp::HasAlpha;
+    VipsInterpretation typeBeforeTint = image.interpretation();
-    using sharp::MaximumImageAlpha;
+    if (typeBeforeTint == VIPS_INTERPRETATION_RGB) {
-
+      typeBeforeTint = VIPS_INTERPRETATION_sRGB;
-    bool maskHasAlpha = HasAlpha(mask);
-
-    if (!maskHasAlpha && mask.bands() > 1) {
-      throw VError("Overlay image must have an alpha channel or one band");
     }
-    if (!HasAlpha(dst)) {
+    // Extract luminance
-      throw VError("Image to be overlaid must have an alpha channel");
+    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);
     }
-    if (mask.width() > dst.width() || mask.height() > dst.height()) {
+    return tinted;
-      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()));
   }
 
   /*
@@ -231,10 +121,8 @@ namespace sharp {
   VImage Gamma(VImage image, double const exponent) {
     if (HasAlpha(image)) {
       // Separate alpha channel
-      VImage imageWithoutAlpha = image.extract_band(0,
-        VImage::option()->set("n", image.bands() - 1));
       VImage alpha = image[image.bands() - 1];
-      return imageWithoutAlpha.gamma(VImage::option()->set("exponent", exponent)).bandjoin(alpha);
+      return RemoveAlpha(image).gamma(VImage::option()->set("exponent", exponent)).bandjoin(alpha);
     } else {
       return image.gamma(VImage::option()->set("exponent", exponent));
     }
@@ -278,6 +166,48 @@ namespace sharp {
     return image.conv(kernel);
   }
 
+  /*
+   * Recomb with a Matrix of the given bands/channel size.
+   * Eg. RGB will be a 3x3 matrix.
+   */
+  VImage Recomb(VImage image, std::unique_ptr<double[]> const &matrix) {
+    double *m = matrix.get();
+    return image
+      .colourspace(VIPS_INTERPRETATION_sRGB)
+      .recomb(image.bands() == 3
+        ? VImage::new_from_memory(
+          m, 9 * sizeof(double), 3, 3, 1, VIPS_FORMAT_DOUBLE
+        )
+        : VImage::new_matrixv(4, 4,
+          m[0], m[1], m[2], 0.0,
+          m[3], m[4], m[5], 0.0,
+          m[6], m[7], m[8], 0.0,
+          0.0, 0.0, 0.0, 1.0));
+  }
+
+  VImage Modulate(VImage image, double const brightness, double const saturation, int const hue) {
+    if (HasAlpha(image)) {
+      // Separate alpha channel
+      VImage alpha = image[image.bands() - 1];
+      return RemoveAlpha(image)
+        .colourspace(VIPS_INTERPRETATION_LCH)
+        .linear(
+          { brightness, saturation, 1},
+          { 0.0, 0.0, static_cast<double>(hue) }
+        )
+        .colourspace(VIPS_INTERPRETATION_sRGB)
+        .bandjoin(alpha);
+    } else {
+      return image
+        .colourspace(VIPS_INTERPRETATION_LCH)
+        .linear(
+          { brightness, saturation, 1 },
+          { 0.0, 0.0, static_cast<double>(hue) }
+        )
+        .colourspace(VIPS_INTERPRETATION_sRGB);
+    }
+  }
+
   /*
    * Sharpen flat and jagged areas. Use sigma of -1.0 for fast sharpen.
    */
@@ -302,135 +232,6 @@ namespace sharp {
     }
   }
 
-  /*
-    Calculate the Shannon entropy
-  */
-  double EntropyStrategy::operator()(VImage image) {
-    return image.hist_find().hist_entropy();
-  }
-
-  /*
-    Calculate the intensity of edges, skin tone and saturation
-  */
-  double AttentionStrategy::operator()(VImage image) {
-    // Flatten RGBA onto a mid-grey background
-    if (image.bands() == 4 && HasAlpha(image)) {
-      double const midgrey = sharp::Is16Bit(image.interpretation()) ? 32768.0 : 128.0;
-      std::vector<double> background { midgrey, midgrey, midgrey };
-      image = image.flatten(VImage::option()->set("background", background));
-    }
-    // Convert to LAB colourspace
-    VImage lab = image.colourspace(VIPS_INTERPRETATION_LAB);
-    VImage l = lab[0];
-    VImage a = lab[1];
-    VImage b = lab[2];
-    // Edge detect luminosity with the Sobel operator
-    VImage sobel = vips::VImage::new_matrixv(3, 3,
-      -1.0, 0.0, 1.0,
-      -2.0, 0.0, 2.0,
-      -1.0, 0.0, 1.0);
-    VImage edges = l.conv(sobel).abs() + l.conv(sobel.rot90()).abs();
-    // Skin tone chroma thresholds trained with http://humanae.tumblr.com/
-    VImage skin = (a >= 3) & (a <= 22) & (b >= 4) & (b <= 31);
-    // Chroma >~50% saturation
-    VImage lch = lab.colourspace(VIPS_INTERPRETATION_LCH);
-    VImage c = lch[1];
-    VImage saturation = c > 60;
-    // Find maximum in combined saliency mask
-    VImage mask = edges + skin + saturation;
-    return mask.max();
-  }
-
-  /*
-    Calculate crop area based on image entropy
-  */
-  std::tuple<int, int> Crop(
-    VImage image, int const outWidth, int const outHeight, std::function<double(VImage)> strategy
-  ) {
-    int left = 0;
-    int top = 0;
-    int const inWidth = image.width();
-    int const inHeight = image.height();
-    if (inWidth > outWidth) {
-      // Reduce width by repeated removing slices from edge with lowest score
-      int width = inWidth;
-      double leftScore = 0.0;
-      double rightScore = 0.0;
-      // Max width of each slice
-      int const maxSliceWidth = static_cast<int>(ceil((inWidth - outWidth) / 8.0));
-      while (width > outWidth) {
-        // Width of current slice
-        int const slice = std::min(width - outWidth, maxSliceWidth);
-        if (leftScore == 0.0) {
-          // Update score of left slice
-          leftScore = strategy(image.extract_area(left, 0, slice, inHeight));
-        }
-        if (rightScore == 0.0) {
-          // Update score of right slice
-          rightScore = strategy(image.extract_area(width - slice - 1, 0, slice, inHeight));
-        }
-        // Keep slice with highest score
-        if (leftScore >= rightScore) {
-          // Discard right slice
-          rightScore = 0.0;
-        } else {
-          // Discard left slice
-          leftScore = 0.0;
-          left = left + slice;
-        }
-        width = width - slice;
-      }
-    }
-    if (inHeight > outHeight) {
-      // Reduce height by repeated removing slices from edge with lowest score
-      int height = inHeight;
-      double topScore = 0.0;
-      double bottomScore = 0.0;
-      // Max height of each slice
-      int const maxSliceHeight = static_cast<int>(ceil((inHeight - outHeight) / 8.0));
-      while (height > outHeight) {
-        // Height of current slice
-        int const slice = std::min(height - outHeight, maxSliceHeight);
-        if (topScore == 0.0) {
-          // Update score of top slice
-          topScore = strategy(image.extract_area(0, top, inWidth, slice));
-        }
-        if (bottomScore == 0.0) {
-          // Update score of bottom slice
-          bottomScore = strategy(image.extract_area(0, height - slice - 1, inWidth, slice));
-        }
-        // Keep slice with highest score
-        if (topScore >= bottomScore) {
-          // Discard bottom slice
-          bottomScore = 0.0;
-        } else {
-          // Discard top slice
-          topScore = 0.0;
-          top = top + slice;
-        }
-        height = height - slice;
-      }
-    }
-    return std::make_tuple(left, top);
-  }
-
-  /*
-    Insert a tile cache to prevent over-computation of any previous operations in the pipeline
-  */
-  VImage TileCache(VImage image, double const factor) {
-    int tile_width;
-    int tile_height;
-    int scanline_count;
-    vips_get_tile_size(image.get_image(), &tile_width, &tile_height, &scanline_count);
-    double const need_lines = 1.2 * scanline_count / factor;
-    return image.tilecache(VImage::option()
-      ->set("tile_width", image.width())
-      ->set("tile_height", 10)
-      ->set("max_tiles", static_cast<int>(round(1.0 + need_lines / 10.0)))
-      ->set("access", VIPS_ACCESS_SEQUENTIAL)
-      ->set("threaded", TRUE));
-  }
-
   VImage Threshold(VImage image, double const threshold, bool const thresholdGrayscale) {
     if (!thresholdGrayscale) {
       return image >= threshold;
@@ -453,56 +254,48 @@ namespace sharp {
     return image.boolean(imageR, boolean);
   }
 
-  VImage Trim(VImage image, int const tolerance) {
+  /*
-    using sharp::MaximumImageAlpha;
+    Trim an image
-    // An equivalent of ImageMagick's -trim in C++ ... automatically remove
+  */
-    // "boring" image edges.
+  VImage Trim(VImage image, double const threshold) {
-
+    if (image.width() < 3 && image.height() < 3) {
-    // We use .project to sum the rows and columns of a 0/255 mask image, the first
+      throw VError("Image to trim must be at least 3x3 pixels");
-    // non-zero row or column is the object edge. We make the mask image with an
+    }
-    // amount-different-from-background image plus a threshold.
+    // Top-left pixel provides the background colour
-
+    VImage background = image.extract_area(0, 0, 1, 1);
-    // find the value of the pixel at (0, 0) ... we will search for all pixels
+    if (HasAlpha(background)) {
-    // significantly different from this
+      background = background.flatten();
-    std::vector<double> background = image(0, 0);
+    }
-
+    int left, top, width, height;
-    double const max = MaximumImageAlpha(image.interpretation());
+    left = image.find_trim(&top, &width, &height, VImage::option()
-
+      ->set("background", background(0, 0))
-    // we need to smooth the image, subtract the background from every pixel, take
+      ->set("threshold", threshold));
-    // the absolute value of the difference, then threshold
+    if (width == 0 || height == 0) {
-    VImage mask = (image.median(3) - background).abs() > (max * tolerance / 100);
+      if (HasAlpha(image)) {
-
+        // Search alpha channel
-    // sum mask rows and columns, then search for the first non-zero sum in each
+        VImage alpha = image[image.bands() - 1];
-    // direction
+        VImage backgroundAlpha = alpha.extract_area(0, 0, 1, 1);
-    VImage rows;
+        left = alpha.find_trim(&top, &width, &height, VImage::option()
-    VImage columns = mask.project(&rows);
+          ->set("background", backgroundAlpha(0, 0))
-
+          ->set("threshold", threshold));
-    VImage profileLeftV;
+      }
-    VImage profileLeftH = columns.profile(&profileLeftV);
+      if (width == 0 || height == 0) {
-
+        throw VError("Unexpected error while trimming. Try to lower the tolerance");
-    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);
+    }
+  }
 }  // namespace sharp

src/operations.h

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -26,31 +26,19 @@ using vips::VImage;
 namespace sharp {
 
   /*
-    Alpha composite src over dst with given gravity.
+    Removes alpha channel, if any.
-    Assumes alpha channels are already premultiplied and will be unpremultiplied after.
+  */
+  VImage RemoveAlpha(VImage image);
+
+  /*
+    Ensures alpha channel, if missing.
+  */
+  VImage EnsureAlpha(VImage image);
+
+  /*
+   * Tint an image using the specified chroma, preserving the original image luminance
    */
-  VImage Composite(VImage src, VImage dst, const int gravity);
+  VImage Tint(VImage image, double const a, double const b);
-
-  /*
-    Alpha composite src over dst with given x and y offsets.
-    Assumes alpha channels are already premultiplied and will be unpremultiplied after.
-   */
-  VImage Composite(VImage src, VImage dst, const int x, const int y);
-
-  /*
-    Check if the src and dst Images for composition operation are valid
-  */
-  bool IsInputValidForComposition(VImage src, VImage dst);
-
-  /*
-    Given a valid src and dst, returns the composite of the two images
-  */
-  VImage CompositeImage(VImage src, VImage dst);
-
-  /*
-    Cutout src over dst with given gravity.
-  */
-  VImage Cutout(VImage src, VImage dst, const int gravity);
 
   /*
    * Stretch luminance to cover full dynamic range.
@@ -78,27 +66,6 @@ namespace sharp {
    */
   VImage Sharpen(VImage image, double const sigma, double const flat, double const jagged);
 
-  /*
-    Crop strategy functors
-  */
-  struct EntropyStrategy {
-    double operator()(VImage image);
-  };
-  struct AttentionStrategy {
-    double operator()(VImage image);
-  };
-
-  /*
-    Calculate crop area based on given strategy (Entropy, Attention)
-  */
-  std::tuple<int, int> Crop(
-    VImage image, int const outWidth, int const outHeight, std::function<double(VImage)> strategy);
-
-  /*
-    Insert a tile cache to prevent over-computation of any previous operations in the pipeline
-  */
-  VImage TileCache(VImage image, double const factor);
-
   /*
     Threshold an image
   */
@@ -117,7 +84,23 @@ namespace sharp {
   /*
     Trim an image
   */
-  VImage Trim(VImage image, int const tolerance);
+  VImage Trim(VImage image, double const threshold);
+
+  /*
+   * Linear adjustment (a * in + b)
+   */
+  VImage Linear(VImage image, double const a, double const b);
+
+  /*
+   * Recomb with a Matrix of the given bands/channel size.
+   * Eg. RGB will be a 3x3 matrix.
+   */
+  VImage Recomb(VImage image, std::unique_ptr<double[]> const &matrix);
+
+  /*
+   * Modulate brightness, saturation and hue
+   */
+  VImage Modulate(VImage image, double const brightness, double const saturation, int const hue);
 
 }  // namespace sharp
 

src/pipeline.h

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -34,20 +34,33 @@ enum class Canvas {
   IGNORE_ASPECT
 };
 
+struct Composite {
+  sharp::InputDescriptor *input;
+  VipsBlendMode mode;
+  int gravity;
+  int left;
+  int top;
+  bool tile;
+  bool premultiplied;
+
+  Composite():
+    input(nullptr),
+    mode(VIPS_BLEND_MODE_OVER),
+    gravity(0),
+    left(-1),
+    top(-1),
+    tile(false),
+    premultiplied(false) {}
+};
+
 struct PipelineBaton {
   sharp::InputDescriptor *input;
-  std::string iccProfilePath;
   int limitInputPixels;
   std::string formatOut;
   std::string fileOut;
   void *bufferOut;
   size_t bufferOutLength;
-  sharp::InputDescriptor *overlay;
+  std::vector<Composite *> composite;
-  int overlayGravity;
-  int overlayXOffset;
-  int overlayYOffset;
-  bool overlayTile;
-  bool overlayCutout;
   std::vector<sharp::InputDescriptor *> joinChannelIn;
   int topOffsetPre;
   int leftOffsetPre;
@@ -61,26 +74,42 @@ struct PipelineBaton {
   int height;
   int channels;
   Canvas canvas;
-  int crop;
+  int position;
-  int cropCalcLeft;
+  std::vector<double> resizeBackground;
-  int cropCalcTop;
+  bool hasCropOffset;
+  int cropOffsetLeft;
+  int cropOffsetTop;
+  bool premultiplied;
   std::string kernel;
-  std::string interpolator;
+  bool fastShrinkOnLoad;
-  bool centreSampling;
+  double tintA;
-  double background[4];
+  double tintB;
   bool flatten;
+  std::vector<double> flattenBackground;
   bool negate;
   double blurSigma;
+  double brightness;
+  double saturation;
+  int hue;
+  int medianSize;
   double sharpenSigma;
   double sharpenFlat;
   double sharpenJagged;
   int threshold;
   bool thresholdGrayscale;
-  int trimTolerance;
+  double trimThreshold;
+  int trimOffsetLeft;
+  int trimOffsetTop;
+  double linearA;
+  double linearB;
   double gamma;
+  double gammaOut;
   bool greyscale;
   bool normalise;
+  bool useExifOrientation;
   int angle;
+  double rotationAngle;
+  std::vector<double> rotationBackground;
   bool rotateBeforePreExtract;
   bool flip;
   bool flop;
@@ -88,24 +117,43 @@ struct PipelineBaton {
   int extendBottom;
   int extendLeft;
   int extendRight;
+  std::vector<double> extendBackground;
   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;
+  bool pngPalette;
+  int pngQuality;
+  int pngColours;
+  double pngDither;
   int webpQuality;
   int webpAlphaQuality;
   bool webpNearLossless;
   bool webpLossless;
+  bool webpSmartSubsample;
+  int webpReductionEffort;
   int tiffQuality;
   VipsForeignTiffCompression tiffCompression;
   VipsForeignTiffPredictor tiffPredictor;
+  bool tiffPyramid;
+  bool tiffSquash;
+  bool tiffTile;
+  int tiffTileHeight;
+  int tiffTileWidth;
+  double tiffXres;
+  double tiffYres;
+  int heifQuality;
+  int heifCompression;  // TODO(libvips 8.9.0): VipsForeignHeifCompression
+  bool heifLossless;
   std::string err;
   bool withMetadata;
   int withMetadataOrientation;
@@ -118,64 +166,103 @@ struct PipelineBaton {
   VipsOperationBoolean booleanOp;
   VipsOperationBoolean bandBoolOp;
   int extractChannel;
+  bool removeAlpha;
+  bool ensureAlpha;
   VipsInterpretation colourspace;
   int tileSize;
   int tileOverlap;
   VipsForeignDzContainer tileContainer;
   VipsForeignDzLayout tileLayout;
   std::string tileFormat;
+  int tileAngle;
+  std::vector<double> tileBackground;
+  int tileSkipBlanks;
+  VipsForeignDzDepth tileDepth;
+  std::unique_ptr<double[]> recombMatrix;
 
   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),
+    position(0),
-    cropCalcLeft(-1),
+    resizeBackground{ 0.0, 0.0, 0.0, 255.0 },
-    cropCalcTop(-1),
+    hasCropOffset(false),
-    centreSampling(false),
+    cropOffsetLeft(0),
+    cropOffsetTop(0),
+    premultiplied(false),
+    tintA(128.0),
+    tintB(128.0),
     flatten(false),
+    flattenBackground{ 0.0, 0.0, 0.0 },
     negate(false),
     blurSigma(0.0),
+    brightness(1.0),
+    saturation(1.0),
+    hue(0),
+    medianSize(0),
     sharpenSigma(0.0),
     sharpenFlat(1.0),
     sharpenJagged(2.0),
     threshold(0),
     thresholdGrayscale(true),
-    trimTolerance(0),
+    trimThreshold(0.0),
+    trimOffsetLeft(0),
+    trimOffsetTop(0),
+    linearA(1.0),
+    linearB(0.0),
     gamma(0.0),
     greyscale(false),
     normalise(false),
+    useExifOrientation(false),
     angle(0),
+    rotationAngle(0.0),
+    rotationBackground{ 0.0, 0.0, 0.0, 255.0 },
     flip(false),
     flop(false),
     extendTop(0),
     extendBottom(0),
     extendLeft(0),
     extendRight(0),
+    extendBackground{ 0.0, 0.0, 0.0, 255.0 },
     withoutEnlargement(false),
     jpegQuality(80),
     jpegProgressive(false),
     jpegChromaSubsampling("4:2:0"),
     jpegTrellisQuantisation(false),
+    jpegQuantisationTable(0),
     jpegOvershootDeringing(false),
     jpegOptimiseScans(false),
+    jpegOptimiseCoding(true),
     pngProgressive(false),
-    pngCompressionLevel(6),
+    pngCompressionLevel(9),
-    pngAdaptiveFiltering(true),
+    pngAdaptiveFiltering(false),
+    pngPalette(false),
+    pngQuality(100),
+    pngColours(256),
+    pngDither(1.0),
     webpQuality(80),
+    webpAlphaQuality(100),
+    webpNearLossless(false),
+    webpLossless(false),
+    webpSmartSubsample(false),
+    webpReductionEffort(4),
     tiffQuality(80),
     tiffCompression(VIPS_FOREIGN_TIFF_COMPRESSION_JPEG),
-    tiffPredictor(VIPS_FOREIGN_TIFF_PREDICTOR_NONE),
+    tiffPredictor(VIPS_FOREIGN_TIFF_PREDICTOR_HORIZONTAL),
+    tiffPyramid(false),
+    tiffSquash(false),
+    tiffTile(false),
+    tiffTileHeight(256),
+    tiffTileWidth(256),
+    tiffXres(1.0),
+    tiffYres(1.0),
+    heifQuality(80),
+    heifCompression(1),  // TODO(libvips 8.9.0): VIPS_FOREIGN_HEIF_COMPRESSION_HEVC
+    heifLossless(false),
     withMetadata(false),
     withMetadataOrientation(-1),
     convKernelWidth(0),
@@ -186,16 +273,17 @@ struct PipelineBaton {
     booleanOp(VIPS_OPERATION_BOOLEAN_LAST),
     bandBoolOp(VIPS_OPERATION_BOOLEAN_LAST),
     extractChannel(-1),
+    removeAlpha(false),
+    ensureAlpha(false),
     colourspace(VIPS_INTERPRETATION_LAST),
     tileSize(256),
     tileOverlap(0),
     tileContainer(VIPS_FOREIGN_DZ_CONTAINER_FS),
-    tileLayout(VIPS_FOREIGN_DZ_LAYOUT_DZ) {
+    tileLayout(VIPS_FOREIGN_DZ_LAYOUT_DZ),
-      background[0] = 0.0;
+    tileAngle(0),
-      background[1] = 0.0;
+    tileBackground{ 255.0, 255.0, 255.0, 255.0 },
-      background[2] = 0.0;
+    tileSkipBlanks(-1),
-      background[3] = 255.0;
+    tileDepth(VIPS_FOREIGN_DZ_DEPTH_LAST) {}
-    }
 };
 
 #endif  // SRC_PIPELINE_H_

src/sharp.cc

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -20,10 +20,14 @@
 #include "metadata.h"
 #include "pipeline.h"
 #include "utilities.h"
+#include "stats.h"
 
 NAN_MODULE_INIT(init) {
   vips_init("sharp");
 
+  g_log_set_handler("VIPS", static_cast<GLogLevelFlags>(G_LOG_LEVEL_WARNING),
+    static_cast<GLogFunc>(sharp::VipsWarningCallback), nullptr);
+
   // Methods available to JavaScript
   Nan::Set(target, Nan::New("metadata").ToLocalChecked(),
     Nan::GetFunction(Nan::New<v8::FunctionTemplate>(metadata)).ToLocalChecked());
@@ -43,6 +47,8 @@ NAN_MODULE_INIT(init) {
     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)
+NAN_MODULE_WORKER_ENABLED(sharp, init)

src/stats.cc

@@ -0,0 +1,192 @@
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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));
+        Set(channels, 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, 2018, 2019 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,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.
@@ -150,8 +150,9 @@ NAN_METHOD(format) {
 
   // Which load/save operations are available for each compressed format?
   Local<Object> format = New<Object>();
-  for (std::string f : {
+  for (std::string const f : {
-    "jpeg", "png", "webp", "tiff", "magick", "openslide", "dz", "ppm", "fits", "gif", "svg", "pdf", "v"
+    "jpeg", "png", "webp", "tiff", "magick", "openslide", "dz",
+    "ppm", "fits", "gif", "svg", "heif", "pdf", "vips"
   }) {
     // Input
     Local<Boolean> hasInputFile =
@@ -259,7 +260,7 @@ NAN_METHOD(_maxColourDistance) {
     }
     // Calculate colour distance
     maxColourDistance = image1.dE00(image2).max();
-  } catch (VError err) {
+  } catch (VError const &err) {
     return ThrowError(err.what());
   }
 

src/utilities.h

@@ -1,4 +1,4 @@
-// Copyright 2013, 2014, 2015, 2016, 2017 Lovell Fuller and contributors.
+// Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.

test/bench/package.json

@@ -5,21 +5,19 @@
   "author": "Lovell Fuller <npm@lovell.info>",
   "description": "Benchmark and performance tests for sharp",
   "scripts": {
-    "test": "VIPS_WARNING=0 node perf && node random && node parallel"
+    "test": "node perf && node random && node parallel"
   },
   "devDependencies": {
-    "async": "^2.1.4",
+    "async": "^3.1.0",
-    "benchmark": "^2.1.2",
+    "benchmark": "^2.1.4",
-    "gm": "^1.23.0",
+    "gm": "^1.23.1",
     "imagemagick": "^0.1.3",
-    "imagemagick-native": "^1.9.3",
+    "jimp": "^0.8.4",
-    "jimp": "^0.2.27",
+    "mapnik": "^4.3.1",
-    "lwip": "^0.0.9",
+    "semver": "^6.3.0"
-    "mapnik": "^3.5.14",
-    "semver": "^5.3.0"
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=4"
+    "node": ">=8.5.0"
   }
 }

test/bench/parallel.js

@@ -31,6 +31,7 @@ async.mapSeries([1, 1, 2, 4, 8, 16, 32, 64], function (parallelism, next) {
     function (err, ids) {
       assert(!err);
       assert(ids.length === parallelism);
+      ids.sort();
       const mean = ids.reduce(function (a, b) {
         return a + b;
       }) / ids.length;

test/bench/perf.js

@@ -7,23 +7,11 @@ const assert = require('assert');
 const Benchmark = require('benchmark');
 
 // Contenders
+const sharp = require('../../');
 const gm = require('gm');
 const imagemagick = require('imagemagick');
 const mapnik = require('mapnik');
 const jimp = require('jimp');
-const sharp = require('../../');
-let imagemagickNative;
-try {
-  imagemagickNative = require('imagemagick-native');
-} catch (err) {
-  console.log('Excluding imagemagick-native');
-}
-let lwip;
-try {
-  lwip = require('lwip');
-} catch (err) {
-  console.log('Excluding lwip');
-}
 
 const fixtures = require('../fixtures');
 
@@ -32,11 +20,9 @@ const height = 588;
 
 // Disable libvips cache to ensure tests are as fair as they can be
 sharp.cache(false);
-// Enable use of SIMD
-sharp.simd(true);
 
 async.series({
-  'jpeg': function (callback) {
+  jpeg: function (callback) {
     const inputJpgBuffer = fs.readFileSync(fixtures.inputJpg);
     const jpegSuite = new Benchmark.Suite('jpeg');
     // jimp
@@ -48,7 +34,7 @@ async.series({
             throw err;
           } else {
             image
-              .resize(width, height)
+              .resize(width, height, jimp.RESIZE_BICUBIC)
               .quality(80)
               .getBuffer(jimp.MIME_JPEG, function (err) {
                 if (err) {
@@ -68,7 +54,7 @@ async.series({
             throw err;
           } else {
             image
-              .resize(width, height)
+              .resize(width, height, jimp.RESIZE_BICUBIC)
               .quality(80)
               .write(fixtures.outputJpg, function (err) {
                 if (err) {
@@ -81,51 +67,6 @@ async.series({
         });
       }
     });
-    // lwip
-    if (typeof lwip !== 'undefined') {
-      jpegSuite.add('lwip-file-file', {
-        defer: true,
-        fn: function (deferred) {
-          lwip.open(fixtures.inputJpg, function (err, image) {
-            if (err) {
-              throw err;
-            }
-            image.resize(width, height, 'lanczos', function (err, image) {
-              if (err) {
-                throw err;
-              }
-              image.writeFile(fixtures.outputJpg, {quality: 80}, function (err) {
-                if (err) {
-                  throw err;
-                }
-                deferred.resolve();
-              });
-            });
-          });
-        }
-      }).add('lwip-buffer-buffer', {
-        defer: true,
-        fn: function (deferred) {
-          lwip.open(inputJpgBuffer, 'jpg', function (err, image) {
-            if (err) {
-              throw err;
-            }
-            image.resize(width, height, 'lanczos', function (err, image) {
-              if (err) {
-                throw err;
-              }
-              image.toBuffer('jpg', {quality: 80}, function (err, buffer) {
-                if (err) {
-                  throw err;
-                }
-                assert.notStrictEqual(null, buffer);
-                deferred.resolve();
-              });
-            });
-          });
-        }
-      });
-    }
     // mapnik
     jpegSuite.add('mapnik-file-file', {
       defer: true,
@@ -145,7 +86,7 @@ async.series({
     }).add('mapnik-buffer-buffer', {
       defer: true,
       fn: function (deferred) {
-        mapnik.Image.fromBytes(inputJpgBuffer, function (err, img) {
+        mapnik.Image.fromBytes(inputJpgBuffer, { max_size: 3000 }, function (err, img) {
           if (err) throw err;
           img
             .resize(width, height, {
@@ -179,29 +120,6 @@ async.series({
         });
       }
     });
-    // imagemagick-native
-    if (typeof imagemagickNative !== 'undefined') {
-      jpegSuite.add('imagemagick-native-buffer-buffer', {
-        defer: true,
-        fn: function (deferred) {
-          imagemagickNative.convert({
-            srcData: inputJpgBuffer,
-            quality: 80,
-            width: width,
-            height: height,
-            format: 'JPEG',
-            filter: 'Lanczos'
-          }, function (err, buffer) {
-            if (err) {
-              throw err;
-            } else {
-              assert.notStrictEqual(null, buffer);
-              deferred.resolve();
-            }
-          });
-        }
-      });
-    }
     // gm
     jpegSuite.add('gm-buffer-file', {
       defer: true,
@@ -342,6 +260,9 @@ async.series({
           .then(function (buffer) {
             assert.notStrictEqual(null, buffer);
             deferred.resolve();
+          })
+          .catch(function (err) {
+            throw err;
           });
       }
     }).on('cycle', function (event) {
@@ -555,8 +476,10 @@ async.series({
       defer: true,
       fn: function (deferred) {
         sharp(inputJpgBuffer)
-          .resize(width, height)
+          .resize(width, height, {
-          .crop(sharp.strategy.entropy)
+            fit: 'cover',
+            position: sharp.strategy.entropy
+          })
           .toBuffer(function (err, buffer) {
             if (err) {
               throw err;
@@ -570,8 +493,10 @@ async.series({
       defer: true,
       fn: function (deferred) {
         sharp(inputJpgBuffer)
-          .resize(width, height)
+          .resize(width, height, {
-          .crop(sharp.strategy.attention)
+            fit: 'cover',
+            position: sharp.strategy.attention
+          })
           .toBuffer(function (err, buffer) {
             if (err) {
               throw err;
@@ -587,7 +512,7 @@ async.series({
       callback(null, this.filter('fastest').map('name'));
     }).run();
   },
-  // Comparitive speed of kernels
+  // Comparative speed of kernels
   kernels: function (callback) {
     const inputJpgBuffer = fs.readFileSync(fixtures.inputJpg);
     (new Benchmark.Suite('kernels')).add('sharp-cubic', {
@@ -682,31 +607,6 @@ async.series({
         });
       }
     });
-    // lwip
-    if (typeof lwip !== 'undefined') {
-      pngSuite.add('lwip-buffer-buffer', {
-        defer: true,
-        fn: function (deferred) {
-          lwip.open(inputPngBuffer, 'png', function (err, image) {
-            if (err) {
-              throw err;
-            }
-            image.resize(width, height, 'lanczos', function (err, image) {
-              if (err) {
-                throw err;
-              }
-              image.toBuffer('png', function (err, buffer) {
-                if (err) {
-                  throw err;
-                }
-                assert.notStrictEqual(null, buffer);
-                deferred.resolve();
-              });
-            });
-          });
-        }
-      });
-    }
     // mapnik
     pngSuite.add('mapnik-file-file', {
       defer: true,
@@ -733,7 +633,7 @@ async.series({
     }).add('mapnik-buffer-buffer', {
       defer: true,
       fn: function (deferred) {
-        mapnik.Image.fromBytes(inputPngBuffer, function (err, img) {
+        mapnik.Image.fromBytes(inputPngBuffer, { max_size: 3000 }, function (err, img) {
           if (err) throw err;
           img.premultiply(function (err, img) {
             if (err) throw err;
@@ -772,22 +672,6 @@ async.series({
         });
       }
     });
-    // imagemagick-native
-    if (typeof imagemagickNative !== 'undefined') {
-      pngSuite.add('imagemagick-native-buffer-buffer', {
-        defer: true,
-        fn: function (deferred) {
-          imagemagickNative.convert({
-            srcData: inputPngBuffer,
-            width: width,
-            height: height,
-            format: 'PNG',
-            filter: 'Lanczos'
-          });
-          deferred.resolve();
-        }
-      });
-    }
     // gm
     pngSuite.add('gm-file-file', {
       defer: true,
@@ -889,12 +773,12 @@ async.series({
             }
           });
       }
-    }).add('sharp-withoutAdaptiveFiltering', {
+    }).add('sharp-adaptiveFiltering', {
       defer: true,
       fn: function (deferred) {
         sharp(inputPngBuffer)
           .resize(width, height)
-          .png({ adaptiveFiltering: false })
+          .png({ adaptiveFiltering: true })
           .toBuffer(function (err, buffer) {
             if (err) {
               throw err;
@@ -957,7 +841,7 @@ async.series({
     }).add('sharp-file-buffer', {
       defer: true,
       fn: function (deferred) {
-        sharp(fixtures.inputWebp)
+        sharp(fixtures.inputWebP)
           .resize(width, height)
           .toBuffer(function (err, buffer) {
             if (err) {

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