libvips/README.md

293 lines
8.9 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
[![Build Status](https://travis-ci.org/jcupitt/libvips.svg?branch=master)](https://travis-ci.org/jcupitt/libvips)
2015-09-30 12:37:42 +02:00
[![Coverity Status](https://scan.coverity.com/projects/6503/badge.svg)](https://scan.coverity.com/projects/jcupitt-libvips)
2015-01-26 15:58:49 +01:00
libvips is a 2D image processing library. Compared to
similar libraries, [libvips runs quickly and uses little
2014-03-20 13:22:04 +01:00
memory](http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use).
2015-02-18 11:36:19 +01:00
libvips is licensed under the LGPL 2.1+.
2014-03-20 13:22:04 +01:00
2016-04-07 10:42:24 +02:00
It has around 300 operations covering arithmetic, histograms,
convolutions, morphological operations, frequency filtering, colour,
resampling, statistics and others. It supports a large range of numeric
formats, from 8-bit int to 128-bit complex. It supports a good range of
image formats, including JPEG, TIFF, PNG, WebP, FITS, Matlab, OpenEXR,
PDF, SVG, HDR, PPM, CSV, GIF, Analyze, DeepZoom, and OpenSlide. It can
also load images via ImageMagick or GraphicsMagick.
2014-03-20 13:22:04 +01:00
2015-10-23 10:45:20 +02:00
It has APIs for
[C](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-c.html)
and
[C++](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-cpp.html)
and comes with a [Python
binding](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-python.html)
and a [command-line
interface](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-cli.html).
Bindings are available for [Ruby](https://rubygems.org/gems/ruby-vips),
2017-01-06 09:43:09 +01:00
[PHP](https://github.com/jcupitt/php-vips),
[Go](https://github.com/davidbyttow/govips),
2015-10-23 10:45:20 +02:00
JavaScript and others. There is full
2015-01-26 15:58:49 +01:00
[documentation](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/index.html).
2015-10-23 10:45:20 +02:00
There are several GUIs as well, see the [VIPS
website](http://www.vips.ecs.soton.ac.uk).
2007-08-29 18:23:50 +02:00
2012-06-29 13:36:56 +02:00
There are packages for most unix-like operating systems and binaries for
2011-01-06 15:18:00 +01:00
Windows and OS X.
2008-03-26 17:56:51 +01:00
# Building libvips from a source tarball
2007-08-29 18:23:50 +02:00
We keep pre-baked tarballs of releases on the vips website:
2016-04-07 10:45:03 +02:00
http://www.vips.ecs.soton.ac.uk/supported/current/
Untar, then in the libvips directory you should just be able to do:
2007-08-29 18:23:50 +02:00
2009-08-27 15:07:58 +02:00
$ ./configure
2015-05-05 14:50:43 +02:00
Check the summary at the end of `configure` carefully.
libvips must have `build-essential`, `pkg-config`, `glib2.0-dev`, and
`libxml2-dev`.
For the vips8 Python binding, you must have
`gobject-introspection`, `python-gi-dev`, and `libgirepository1.0-dev`.
2015-10-23 10:45:20 +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
2015-10-23 10:45:20 +02:00
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:
2009-08-27 15:07:58 +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
2012-06-29 13:20:50 +02:00
We have detailed guides on the wiki for [building on
Windows](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows)
and [building on OS
X](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_OS_X).
2007-08-29 18:23:50 +02:00
2014-11-26 12:07:10 +01:00
# Building libvips from git
2009-08-27 15:07:58 +02:00
Checkout the latest sources with:
2012-06-29 13:36:56 +02:00
$ git clone git://github.com/jcupitt/libvips.git
2009-08-27 15:07:58 +02:00
2015-05-05 14:50:43 +02:00
Building from git needs more packages, you'll need at least `swig`, `gtk-doc`
and `gobject-introspection`, see the dependencies section below. For example:
2009-08-27 15:07:58 +02:00
2014-11-26 12:07:10 +01:00
$ brew install gtk-doc swig
2009-08-27 15:07:58 +02:00
2014-11-26 12:07:10 +01:00
Then build the build system with:
2016-08-05 16:00:37 +02:00
$ ./autogen.sh
2014-11-26 12:07:10 +01:00
Debug build:
$ CFLAGS="-g -Wall" CXXFLAGS="-g -Wall" \
./configure --prefix=/home/john/vips --enable-debug
$ make
$ make install
2013-07-15 23:01:00 +02:00
Leak check:
$ export G_DEBUG=gc-friendly
2014-01-14 13:21:21 +01:00
$ valgrind --suppressions=libvips.supp \
2013-07-15 23:01:00 +02:00
--leak-check=yes \
vips ... > vips-vg.log 2>&1
Memory error debug:
$ valgrind --vgdb=yes --vgdb-error=0 vips ...
2014-01-14 13:21:21 +01:00
valgrind threading check:
$ valgrind --tool=helgrind vips ... > vips-vg.log 2>&1
2013-11-22 11:12:54 +01:00
Clang build:
$ CC=clang CXX=clang++ ./configure --prefix=/home/john/vips
2013-11-22 12:27:29 +01:00
Clang static analysis:
$ scan-build ./configure --disable-introspection
2013-11-22 12:27:29 +01:00
$ scan-build -o scan -v make
$ scan-view scan/2013-11-22-2
2013-11-22 12:27:29 +01:00
2013-11-22 11:12:54 +01:00
Clang dynamic analysis:
$ FLAGS="-O1 -g -fsanitize=address"
$ FLAGS="$FLAGS -fno-omit-frame-pointer -fno-optimize-sibling-calls"
2013-11-22 11:12:54 +01:00
$ CC=clang CXX=clang++ LD=clang \
CFLAGS="$FLAGS" CXXFLAGS="$FLAGS" LDFLAGS=-fsanitize=address \
./configure --prefix=/home/john/vips
2013-11-22 11:12:54 +01:00
$ FLAGS="-O1 -g -fsanitize=thread"
$ FLAGS="$FLAGS -fPIC -pie"
$ FLAGS="$FLAGS -fno-omit-frame-pointer -fno-optimize-sibling-calls"
2013-11-22 11:12:54 +01:00
$ CC=clang CXX=clang++ LD=clang \
CFLAGS="$FLAGS" CXXFLAGS="$FLAGS" \
2013-11-22 15:50:40 +01:00
LDFLAGS="-fsanitize=thread -fPIC -pie" \
./configure --prefix=/home/john/vips
2013-11-22 11:12:54 +01:00
2013-12-05 15:40:42 +01:00
Build with the GCC auto-vectorizer and diagnostics (or just -O3):
$ FLAGS="-O2 -msse4.2 -ffast-math"
$ FLAGS="$FLAGS -ftree-vectorize -fdump-tree-vect-details"
$ CFLAGS="$FLAGS" CXXFLAGS="$FLAGS" \
./configure --prefix=/home/john/vips
2014-03-20 15:52:06 +01:00
Static analysis with:
$ cppcheck --force --enable=style . &> cppcheck.log
2012-06-29 13:20:50 +02:00
# Dependencies
2007-08-29 18:23:50 +02:00
2015-05-05 14:50:43 +02:00
libvips has to have `gettext`, `glib2.0-dev` and `libxml2-dev`. Other
dependencies are optional, see below.
2007-08-29 18:23:50 +02:00
2012-06-29 13:20:50 +02: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
2016-05-09 15:06:44 +02:00
libtiff, giflib and libjpeg do not usually use `pkg-config` so libvips looks for
2015-07-10 13:44:02 +02:00
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
2008-10-11 23:29:16 +02:00
./configure --prefix=/Users/john/vips \
2016-05-09 15:06:44 +02:00
--with-giflib-includes=/opt/local/include \
--with-giflib-libraries=/opt/local/lib \
2008-10-11 23:29:16 +02:00
--with-tiff-includes=/opt/local/include \
--with-tiff-libraries=/opt/local/lib \
--with-jpeg-includes=/opt/local/include \
--with-jpeg-libraries=/opt/local/lib
or perhaps:
CFLAGS="-g -Wall -I/opt/local/include -L/opt/local/lib" \
CXXFLAGS="-g -Wall -I/opt/local/include -L/opt/local/lib" \
./configure --without-python --prefix=/Users/john/vips
2007-08-29 18:23:50 +02:00
to get libvips to see your builds.
2007-08-29 18:23:50 +02:00
2015-07-10 13:44:02 +02:00
### vips8 Python binding
2015-05-05 14:50:43 +02:00
If `gobject-introspection`, `python-gi-dev`, and `libgirepository1.0-dev` are
available, libvips will install the vips8 Python binding.
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.
### libpoppler
The usual PDF loader. If this is not present, vips will try to load PDFs
via imagemagick instead.
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
2015-07-10 13:44:02 +02:00
### lcms2, lcms
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()`
are available for transforming images with ICC profiles. If `lcms2` is
available it is used in preference to `lcms`, since it is faster.
2012-06-29 13:20:50 +02:00
2015-07-10 13:44:02 +02:00
### Large files
2012-06-29 13:20:50 +02:00
libvips uses the standard autoconf tests to work out how to support
2015-05-05 14:50:43 +02:00
large files (>2GB) on your system. Any reasonably recent unix should
2012-06-29 13:20:50 +02:00
be OK.
2015-07-10 13:44:02 +02:00
### libpng
2012-06-29 13:20:50 +02:00
2012-06-29 13:36:56 +02:00
If present, libvips can load and save png files.
2007-08-29 18:23:50 +02:00
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, but if you are rolling your own, you'll need to pass
this flag to configure.
2016-05-09 15:06:44 +02:00
If you are going to be using libvips with untrusted images, perhaps in a
web-server, for example, you should consider the security implications of
using a package with such a large attack surface. You might prefer not to
enable Magick support.
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.
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
2015-07-10 13:44:02 +02:00
### swig, python, python-dev
2011-12-08 20:49:53 +01:00
2015-05-05 14:50:43 +02:00
If available, we build the vips7 python binding.
2007-08-29 18:23:50 +02:00
2012-06-29 13:20:50 +02:00
# Disclaimer
2007-08-29 18:23:50 +02:00
2012-06-29 13:20:50 +02:00
No guarantees of performance accompany this software, nor is any
2007-08-29 18:23:50 +02:00
responsibility assumed on the part of the authors. Please read the licence
agreement.