README

Zoomify is a stand-alone library to generate tiles of big images in order to zoom them instantly. The tiles are created with the Zoomify format and they can be used with OpenSeadragon, OpenLayers and various viewers.

It is integrated in the module IIIF Server of the open source digital library Omeka S to create images compliant with the specifications of the International Image Interoperability Framework.

This library is available as a packagist package.

Usage

Direct use without the factory

// Setup the Zoomify library.
$zoomify = new \DanielKm\Zoomify\Zoomify($config);

// Process a source file and save tiles in a destination folder.
$result = $zoomify->process($source, $destination);

Direct invocation with the factory

// Setup the Zoomify library.
$factory = new \DanielKm\Zoomify\ZoomifyFactory;
$zoomify = $factory($config);

// Process a source file and save tiles in a destination folder.
$result = $zoomify->process($source, $destination);

Config

Example

$config = [
    'tileSize' => 512,
    'tileOverlap' => 1,
    'tileQuality' => 100,
    'destinationRemove' => true,
    'processor' => 'Vips',
];

Supported image libraries

The format of the image source can be anything that is managed by the image library:

• Command line vips Vips (>=8.0)
• Composer library php-vips with PHP extension ext-vips or ext-ffi
• Command line magick / convert ImageMagick (>=6.0)
• PHP extension Imagick (>=6.5.6)
• PHP Extension GD (>=2.0)

The PHP library exif should be installed (generally enabled by default).

History

The Zoomify viewer was a popular viewer to display large images in the past with Flash (and now without it, of course). It’s still used in various places, because it’s not only a viewer, but a tile builder too and it has some enterprise features. Its popularity was related to the fact that an extension was added to a popular commercial image application. An old description of the format can be found here.

The Zoomify class is a port of the ZoomifyImage python script to a PHP class. The original python script was written by Adam Smith, and was ported to PHP (in the form of ZoomifyFileProcessor) by Wes Wright. The port to Imagick was done by Daniel Berthereau for the Bibliothèque patrimoniale of Mines ParisTech in the plugin OpenLayers Zoom for Omeka Classic.

Ported from Python to PHP by Wes Wright Cleanup for Drupal by Karim Ratib (kratib@open-craft.com) Cleanup for Omeka Classic by Daniel Berthereau Conversion to ImageMagick by Daniel Berthereau Set as a stand-alone library in Packagist and integrated in Omeka S.

Some code is shared with the Deepzoom Library.

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Troubleshooting

See the online issues page on GitLab.

License

This library is licensed under the GNU/GPL v3.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Copyright

• Copyright 2005 Adam Smith (asmith@agile-software.com)
• Copyright Wes Wright (http://greengaloshes.cc)
• Copyright Justin Henry (http://greengaloshes.cc)
• Copyright 2014-2026 Daniel Berthereau (see Daniel-KM)