Skip to content

nichtich/IIIF

Repository files navigation

NAME

IIIF - IIIF Image API implementation

MetaCPAN Release Linux Build Status Windows Build Status Coverage Status Kwalitee Score

DESCRIPTION

Package IIIF provides an implementation of IIIF ImageAPI based on the ImageMagick command line application: Requests to get a specific segment of an image are mapped to command line arguments of ImageMagick to perform the requested segment extraction. See "EXAMPLES" in i3f for examples.

FEATURES

  • Full IIIF ImageAPI 3.0 level 2 compliance
  • Support abbreviated requests (e.g. 300,200 to select size, 90/gray to select rotation and quality...).
  • Web service (IIIF::ImageAPI) and command line client (i3f)
  • fully passing the IIIF Image API Validator with all Level 2 features (except some inexplicable test failures with PDF, WebP, and JP2 format).
  • works with ImageMagick 6 (tested on Ubuntu Linux) and ImageMagick 7 (tested on Windows)
  • 100% test coverage on statement level, (>90% on branch level and >70% on condition level).

INSTALLATION

See also "REQUIREMENTS" in IIIF::Magick for additional installation for optional features.

UNIX

Most Unixes include system Perl by default. You should also install ImageMagick and cpanminus. For instance at Ubuntu Linux:

sudo apt-get install imagemagick cpanminus

To speed up installation of Perl dependencies of this package, optionally:

sudo apt-get install libplack-perl libplack-middleware-crossorigin-perl

And for optional support of WebP format:

sudo apt-get install webp libwebp-dev

Then install IIIF with Perl package manager:

cpanm IIIF

WINDOWS

Install ImageMagick and Perl, for instance with Chocolatey:

choco install imagemagick.tool
choco install strawberryperl

Then install IIIF with Perl package manager:

cpanm IIIF

MODULES

  • IIIF::Request

    parse and express an IIIF Image API request build of region, size, rotation, quality, and format

  • IIIF::Magick

    get image information and convert images as specified with IIIF Image API request using ImageMagick

  • IIIF::ImageAPI

    provide a Plack web service to access images via IIIF Image API

SCRIPTS

This module provides the command line script i3f to apply IIIF Image API requests without a web service.

SEE ALSO

LICENSE

Copyright (C) Jakob Voß.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Jakob Voß voss@gbv.de

About

IIIF Image API implementation in Perl based on ImageMagick

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages