libvips/README.md

306 lines
11 KiB
Markdown
Raw Normal View History

2012-06-29 13:20:50 +02:00
# libvips : an image processing library
2007-08-29 18:23:50 +02:00
2018-09-21 18:05:47 +02:00
[![Build Status](https://travis-ci.org/libvips/libvips.svg?branch=master)](https://travis-ci.org/libvips/libvips)
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/libvips.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=2&q=proj:libvips)
2019-12-07 17:59:33 +01:00
[![Coverity Status](https://scan.coverity.com/projects/6503/badge.svg)](https://scan.coverity.com/projects/jcupitt-libvips)
2020-12-24 18:56:31 +01:00
[![Test](https://github.com/libvips/libvips/workflows/Test/badge.svg)](https://github.com/libvips/libvips/actions?query=workflow%3ATest)
2015-09-30 12:37:42 +02:00
# Introduction
2018-08-17 18:52:45 +02:00
libvips is a [demand-driven, horizontally
2018-09-21 18:05:47 +02:00
threaded](https://github.com/libvips/libvips/wiki/Why-is-libvips-quick)
2018-08-17 18:52:45 +02:00
image processing library. Compared to similar
libraries, [libvips runs quickly and uses little
2018-09-21 18:05:47 +02:00
memory](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
2018-08-17 18:52:45 +02:00
libvips is licensed under the [LGPL
2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html).
It has around [300
operations](http://libvips.github.io/libvips/API/current/func-list.html)
covering arithmetic, histograms, convolution, morphological
operations, frequency filtering, colour, resampling,
statistics and others. It supports a large range of [numeric
2019-02-10 06:31:33 +01:00
types](http://libvips.github.io/libvips/API/current/VipsImage.html#VipsBandFormat),
2018-08-17 18:52:45 +02:00
from 8-bit int to 128-bit complex. Images can have any number of bands.
2019-06-15 14:14:26 +02:00
It supports a good range of image formats, including JPEG, TIFF, PNG,
WebP, HEIC, FITS, Matlab, OpenEXR, PDF, SVG, HDR, PPM / PGM / PFM, CSV,
GIF, Analyze, NIfTI, DeepZoom, and OpenSlide. It can also load images via
ImageMagick or GraphicsMagick, letting it work with formats like DICOM.
It comes with bindings for
[C](http://libvips.github.io/libvips/API/current/using-from-c.html),
[C++](http://libvips.github.io/libvips/API/current/using-from-cpp.html),
and the
[command-line](http://libvips.github.io/libvips/API/current/using-cli.html).
Full bindings are available for [Ruby](https://rubygems.org/gems/ruby-vips),
2018-08-17 18:52:45 +02:00
[Python](https://pypi.python.org/pypi/pyvips),
2018-09-21 18:05:47 +02:00
[PHP](https://github.com/libvips/php-vips),
2019-02-10 06:31:33 +01:00
[C# / .NET](https://www.nuget.org/packages/NetVips),
2018-08-17 18:52:45 +02:00
[Go](https://github.com/davidbyttow/govips), and
2018-09-21 18:05:47 +02:00
[Lua](https://github.com/libvips/lua-vips). libvips
is used as an image processing engine by [sharp
(on node.js)](https://www.npmjs.org/package/sharp),
[bimg](https://github.com/h2non/bimg), [sharp
for Go](https://github.com/DAddYE/vips), [Ruby on
Rails](http://edgeguides.rubyonrails.org/active_storage_overview.html),
2018-08-17 18:52:45 +02:00
[carrierwave-vips](https://github.com/eltiare/carrierwave-vips),
[mediawiki](http://www.mediawiki.org/wiki/Extension:VipsScaler),
[PhotoFlow](https://github.com/aferrero2707/PhotoFlow) and others.
2018-09-21 18:05:47 +02:00
The official libvips GUI is [nip2](https://github.com/libvips/nip2),
2018-08-17 18:52:45 +02:00
a strange combination of a spreadsheet and an photo editor.
2007-08-29 18:23:50 +02:00
2019-06-15 14:21:43 +02:00
# Install
2008-03-26 17:56:51 +01:00
2019-07-18 09:43:41 +02:00
There are packages for most Unix-like operating systems, including
macOS. Check your package manager.
2019-06-15 14:21:43 +02:00
There are binaries for Windows in
[releases](https://github.com/libvips/libvips/releases).
The [libvips website](https://libvips.github.io/libvips) has [detailed
install notes](https://libvips.github.io/libvips/install.html).
2007-08-29 18:23:50 +02:00
2019-06-15 14:21:43 +02:00
# Building libvips from a source tarball
2019-06-15 14:21:43 +02:00
We keep pre-baked tarballs in
[releases](https://github.com/libvips/libvips/releases).
Untar, then in the libvips directory you should just be able to do:
2007-08-29 18:23:50 +02:00
2019-08-15 03:37:31 +02:00
./configure
2015-05-05 14:50:43 +02:00
2018-07-07 17:22:17 +02:00
Check the summary at the end of `configure` carefully. libvips must have
2020-03-27 12:42:58 +01:00
`build-essential`, `pkg-config`, `libglib2.0-dev`, `libexpat1-dev`.
2015-05-05 14:50:43 +02:00
2018-07-07 17:22:17 +02:00
You'll need the dev packages for the file format support you want. For basic
jpeg and tiff support, you'll need `libtiff5-dev`, `libjpeg-turbo8-dev`,
and `libgsf-1-dev`. See the **Dependencies** section below for a full list
of the things that libvips can be configured to use.
2015-05-05 14:50:43 +02:00
Once `configure` is looking OK, compile and install with the usual:
2019-08-15 03:37:31 +02:00
make
sudo make install
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
By default this will install files to `/usr/local`.
2007-08-29 18:23:50 +02:00
2018-07-07 17:22:17 +02:00
# Testing
2019-08-15 03:37:31 +02:00
Run the test suite with:
2018-07-07 17:22:17 +02:00
2019-08-15 03:37:31 +02:00
make check
Run a specific test with:
2019-08-15 03:37:31 +02:00
pytest test/test-suite/test_foreign.py -k test_tiff
2018-07-07 17:22:17 +02:00
2014-11-26 12:07:10 +01:00
# Building libvips from git
2009-08-27 15:07:58 +02:00
2019-06-15 14:21:43 +02:00
Clone the latest sources with:
2009-08-27 15:07:58 +02:00
2019-08-15 03:37:31 +02:00
git clone git://github.com/libvips/libvips.git
2009-08-27 15:07:58 +02:00
2019-06-15 14:21:43 +02:00
Building from git needs more packages -- you'll need at least `gtk-doc`
2015-05-05 14:50:43 +02:00
and `gobject-introspection`, see the dependencies section below. For example:
2009-08-27 15:07:58 +02:00
2019-08-15 03:37:31 +02:00
brew install gtk-doc
2009-08-27 15:07:58 +02:00
2020-02-11 16:20:12 +01:00
Then generate the build system with:
2019-08-15 03:37:31 +02:00
./autogen.sh --prefix=/home/john/vips
2014-11-26 12:07:10 +01:00
Debug build:
2019-08-15 03:37:31 +02:00
CFLAGS="-g -Wall" CXXFLAGS="-g -Wall" \
./configure --prefix=/home/john/vips --enable-debug
make
make install
2012-06-29 13:20:50 +02:00
# Dependencies
2007-08-29 18:23:50 +02:00
2020-03-27 12:42:58 +01:00
libvips has to have `libglib2.0-dev` and `libexpat1-dev`. Other dependencies
2019-12-07 18:02:26 +01:00
are optional.
2007-08-29 18:23:50 +02:00
2019-12-07 18:02:26 +01:00
## Optional dependencies
2007-08-29 18:23:50 +02:00
2012-06-29 13:20:50 +02:00
If suitable versions are found, libvips will add support for the following
2012-06-29 13:36:56 +02:00
libraries automatically. See `./configure --help` for a set of flags to
control library detection. Packages are generally found with `pkg-config`,
so make sure that is working.
2007-08-29 18:23:50 +02:00
2019-08-15 03:37:31 +02:00
Libraries like giflib and nifti do not use `pkg-config` so libvips will also
look for them in the default path and in `$prefix`. If you have installed
your own versions of these libraries in a different location, libvips will
not see them. Use switches to libvips configure like:
2007-08-29 18:23:50 +02:00
./configure --prefix=/Users/john/vips \
2019-08-15 03:37:31 +02:00
--with-giflib-includes=/opt/local/include \
--with-giflib-libraries=/opt/local/lib
2008-10-11 23:29:16 +02:00
or perhaps:
CFLAGS="-g -Wall -I/opt/local/include -L/opt/local/lib" \
2019-04-27 12:41:26 +02:00
CXXFLAGS="-g -Wall -I/opt/local/include -L/opt/local/lib" \
./configure --prefix=/Users/john/vips
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### libjpeg
2012-06-29 13:20:50 +02:00
2015-07-10 13:44:02 +02:00
The IJG JPEG library. Use the `-turbo` version if you can.
2012-06-29 13:20:50 +02:00
2015-07-10 13:44:02 +02:00
### libexif
2012-06-29 13:20:50 +02:00
2012-06-29 13:36:56 +02:00
If available, libvips adds support for EXIF metadata in JPEG files.
2012-06-29 13:20:50 +02:00
2016-03-08 10:00:57 +01:00
### giflib
The standard gif loader. If this is not present, vips will try to load gifs
via imagemagick instead.
### librsvg
The usual SVG loader. If this is not present, vips will try to load SVGs
via imagemagick instead.
2018-04-07 18:36:52 +02:00
### PDFium
2020-12-24 06:44:07 +01:00
If present, libvips will attempt to load PDFs with PDFium. Download the
prebuilt pdfium binary from:
https://github.com/bblanchon/pdfium-binaries
Untar to the libvips install prefix, for example:
cd ~/vips
tar xf ~/pdfium-linux.tgz
Create a `pdfium.pc` like this (update the version number):
VIPSHOME=/home/john/vips
cat > $VIPSHOME/lib/pkgconfig/pdfium.pc << EOF
prefix=$VIPSHOME
exec_prefix=\${prefix}
libdir=\${exec_prefix}/lib
includedir=\${prefix}/include
Name: pdfium
Description: pdfium
Version: 4290
Requires:
Libs: -L\${libdir} -lpdfium
Cflags: -I\${includedir}
EOF
2018-04-07 18:36:52 +02:00
If PDFium is not detected, libvips will look for poppler-glib instead.
2019-04-27 12:41:26 +02:00
### poppler-glib
2016-03-08 10:00:57 +01:00
2019-04-27 12:41:26 +02:00
The Poppler PDF renderer, with a glib API. If this is not present, vips
will try to load PDFs via imagemagick.
2016-03-08 10:00:57 +01:00
2015-07-10 13:44:02 +02:00
### libgsf-1
2015-07-10 13:44:02 +02:00
If available, libvips adds support for creating image pyramids with `dzsave`.
2015-07-10 13:44:02 +02:00
### libtiff
2012-06-29 13:20:50 +02:00
The TIFF library. It needs to be built with support for JPEG and
ZIP compression. 3.4b037 and later are known to be OK.
2015-07-10 13:44:02 +02:00
### fftw3
2012-06-29 13:20:50 +02:00
2015-07-10 13:44:02 +02:00
If libvips finds this library, it uses it for fourier transforms.
2012-06-29 13:20:50 +02:00
2019-04-27 12:41:26 +02:00
### lcms2
2012-06-29 13:20:50 +02:00
2015-07-10 13:44:02 +02:00
If present, `vips_icc_import()`, `vips_icc_export()` and `vips_icc_transform()`
2019-04-27 12:41:26 +02:00
are available for transforming images with ICC profiles.
2012-06-29 13:20:50 +02:00
2020-12-27 17:26:38 +01:00
### libspng
If present, libvips will load PNG files using libspng. At the moment, libpng
is still necessary for save.
2015-07-10 13:44:02 +02:00
### libpng
2012-06-29 13:20:50 +02:00
2020-12-27 17:26:38 +01:00
If libspng is not present and libpng is, libvips will load PNG files with
libpng. It will always save PNG files with libpng.
2007-08-29 18:23:50 +02:00
2018-08-07 16:07:38 +02:00
### libimagequant
If present, libvips can write 8-bit palette-ised PNGs.
2015-07-10 13:44:02 +02:00
### ImageMagick, or optionally GraphicsMagick
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
If available, libvips adds support for loading all libMagick-supported
image file types. Use `--with-magickpackage=GraphicsMagick` to build against
graphicsmagick instead.
2007-08-29 18:23:50 +02:00
2016-05-05 10:14:58 +02:00
Imagemagick 6.9+ needs to have been built with `--with-modules`. Most packaged
IMs are, I think.
2016-05-05 10:14:58 +02:00
2016-05-09 15:06:44 +02:00
If you are going to be using libvips with untrusted images, perhaps in a
2019-04-27 12:41:26 +02:00
web server, for example, you should consider the security implications of
enabling a package with such a large attack surface.
2016-05-09 15:06:44 +02:00
2015-07-10 13:44:02 +02:00
### pangoft2
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
If available, libvips adds support for text rendering. You need the
package pangoft2 in `pkg-config --list-all`.
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### orc-0.4
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
If available, vips will accelerate some operations with this run-time
compiler.
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### matio
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
If available, vips can load images from Matlab save files.
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### cfitsio
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
If available, vips can load FITS images.
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### libwebp
2015-01-26 15:58:49 +01:00
If available, vips can load and save WebP images.
2018-08-07 16:07:38 +02:00
### libniftiio
2020-02-11 16:20:12 +01:00
If available, vips can load and save NIfTI images.
2018-08-07 16:07:38 +02:00
2015-07-10 13:44:02 +02:00
### OpenEXR
2011-01-06 15:18:00 +01:00
2012-06-29 13:36:56 +02:00
If available, libvips will directly read (but not write, sadly)
OpenEXR images.
2011-01-06 15:18:00 +01:00
2015-07-10 13:44:02 +02:00
### OpenSlide
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
If available, libvips can load OpenSlide-supported virtual slide
files: Aperio, Hamamatsu, Leica, MIRAX, Sakura, Trestle, and Ventana.
2007-08-29 18:23:50 +02:00
2019-04-27 12:41:26 +02:00
### libheif
If available, libvips can load and save HEIC images.
2019-12-07 17:59:33 +01:00
# Contributors
### Code Contributors
2019-12-07 17:59:33 +01:00
This project exists thanks to all the people who contribute.
2019-12-07 17:59:33 +01:00
<a href="https://github.com/libvips/libvips/graphs/contributors"><img src="https://opencollective.com/libvips/contributors.svg?width=890&button=false" /></a>
2019-12-07 17:59:33 +01:00
### Organizations
2019-12-07 18:02:26 +01:00
Support this project with your organization. Your logo will show up here with a link to your website.
<a href="https://opencollective.com/libvips/organization/0/website"><img src="https://opencollective.com/libvips/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/1/website"><img src="https://opencollective.com/libvips/organization/1/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/2/website"><img src="https://opencollective.com/libvips/organization/2/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/3/website"><img src="https://opencollective.com/libvips/organization/3/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/4/website"><img src="https://opencollective.com/libvips/organization/4/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/5/website"><img src="https://opencollective.com/libvips/organization/5/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/6/website"><img src="https://opencollective.com/libvips/organization/6/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/7/website"><img src="https://opencollective.com/libvips/organization/7/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/8/website"><img src="https://opencollective.com/libvips/organization/8/avatar.svg"></a>
<a href="https://opencollective.com/libvips/organization/9/website"><img src="https://opencollective.com/libvips/organization/9/avatar.svg"></a>