openjpeg-decoder-service

A java based jp2 decoder service.

This service uses openjpeg 2.3 for decoding.

It intends to be compliant to the IIIF image API 2.1, level 1.

Quick start using docker

To try out the service locally you can download a sample .jp2 and run the following commands

wget https://github.com/KBNLresearch/openjpeg-decoder-service/raw/master/src/test/resources/balloon.jp2
docker run -v `pwd`:/mount -p9080:9080 -it --rm renevanderark/openjpeg-decoder-service

Then visit: http://localhost:9080/iiif-service/balloon.jp2/full/pct:25/0/default.jpg to see if it works.

The docker command mounts your current working directory to the container to locate your jp2 files.

Compiling and running the service locally without docker

This service uses a recent version of openjpeg which should be built from source on your own distribution before compiling this service.

The Dockerfile on this repository illustrates how this can be done, but I will list the steps in this section as well:

sudo apt-get install git-core cmake g++ maven

git clone https://github.com/uclouvain/openjpeg.git
cd openjpeg
git checkout tags/v2.3.1

cmake . -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS:bool=on -DCMAKE_CXX_COMPILER=/usr/bin/cc
make
sudo make install
sudo ldconfig

cd /path/to/openjpeg-decoder-service
JAVA_HOME=/path/to/java-8-jdk mvn clean package

java -jar target/openjpeg-decoder-service-2.0.2.jar server sample-conf.yaml

Then visit: http://localhost:9080/iiif-service/balloon.jp2/full/pct:25/0/default.jpg to see if it works.

Configuration options

In this directory there are some sample yaml (dropwizard) configurations. The service can - without adaptations - only be configured to decode local files: sample-conf.yaml

Other configurable options involve cache settings and multi-threading options, which should be tweaked by you on your own environment.

When experimenting with this service in a productive environment it is essential to check out a stable (tagged) version and assign enough memory, for instance:

java -Xms2g -Xmx8g -jar target/openjpeg-decoder-service-2.0.2.jar server sample-conf.yaml