Slidescape

Slidescape is a whole-slide image viewer for digital pathology.

How to build

Windows

You can build the program using CMake and the MinGW-w64 toolchain.

You may wish to install nasm so that the SIMD-optimized assembly code in libjpeg-turbo can be compiled.

All library code is included with the source code distribution (there are no other external dependencies).

Linux / macOS

Make sure the build tools cmake and (optionally) nasm are installed.

The following libraries are required: SDL2 (on Linux and macOS), GLEW (Linux only).

mkdir build && cd build
cmake ..
cd ..
cmake --build build --target slidescape -- -j
./slidescape

Supported image formats

The viewer has built-in support for:

• Tiled TIFF and BigTIFF (including generic and Philips TIFF variants).
• Philips iSyntax.

Slidescape can also detect and load the OpenSlide library at runtime. If OpenSlide is present, the Aperio, Hamamatsu, Leica, MIRAX, Sakura, Trestle, and Ventana formats can additionally be loaded.

To enable OpenSlide support on Windows, download (or compile) the 64-bit binaries and put all of the DLL files together in an openslide/ folder, and put that folder in the same location as slidescape.exe.

To enable OpenSlide support on Linux, install the openslide library, either using a package manager or by building and installing it manually. The program will try to locate libopenslide.so, either in the default system library paths or in /usr/local/lib/.

To enable OpenSlide support on macOS, install the openslide library using Homebrew or MacPorts. The program will try to locate libopenslide.dylib in the default install path: either /usr/local/opt/openslide/lib/ for Homebrew, or /opt/local/lib/ for MacPorts.

Credits

Slidescape embeds code from the following projects, under their respective licenses:

• Dear ImGui (graphical interface library)
• FreeType (font renderer)
• libjpeg-turbo (JPEG image codec)
• Mbed TLS (SSL/TLS and cryptography library)
• Yxml (XML parser)
• json.h (JSON parser)
• linmath.h (linear math library)
• stb_image.h (image loader)
• OpenJPEG (discrete wavelet transform)
• LZ4 (compression algorithm)
• base64.c (base64 decoder)
• cityhash (byte swap operations)
• stb_ds.h (typesafe dynamic array and hash tables for C)
• ltalloc (fast memory allocator)
• glad (OpenGL loader)
• Keycode (library for platform-independent keyboard input handling)
• ImGuiFileDialog (file dialog for dear ImGui)

Uses SDL2 and GLEW on Linux/macOS.

The application icon was made by Freepik from Flaticon.

License

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 3 of the License, or (at your option) any later version.

See LICENSE.txt for more information.