GIPS: The GLSL Image Processing System

An image processing application that applies filters written in the OpenGL Shading Language (GLSL).

This means two things:

All filters run on the GPU.
Immediate, real-time feedback when changing parameters.

Multiple filters can be combined into a pipeline.

GIPS uses standard GLSL fragment shaders for all image processing operations, with a few customizations.

GIPS runs on Windows and Linux operating systems, and quite possibly others too.

GIPS requires a GPU that's capable of OpenGL 3.3, and suitable drivers. Every GPU made after 2007 should support that; on Windows systems, however, the vendor drivers must be installed. (The drivers installed automatically by Windows often don't support OpenGL.)

Usage Tips

The usage of the program should be somewhat self-explanatory. Here are some specific hints for the non-obvious things:

The view can be zoomed with the mouse wheel, and panned by clicking and dragging with the left or middle mouse button.
Use drag & drop from a file manager to load an image into GIPS.
The filters / shaders that are visible in the "Add Filter" menu are taken from the shaders subdirectory of the directory where the gips(.exe) executable is located, plus %AppData%\GIPS\shaders on Windows, or ~/.config/gips/shaders, ~/.local/share/gips/shaders, /usr/share/gips/shaders and /usr/local/share/gips/shaders on Linux.
- Shader files must have one of the extensions .glsl, .frag or .fs to be recognized.
- New shaders can be put there any time, they will appear immediately when the menu is opened the next time.
- Alternatively, drag & drop a shader file (from any directory) to add it to the filter pipeline.
- See the "Shader Format" document for details on writing filters.
The header bars for each filter have right-click context menus. Using these,
- filters can be removed from the pipeline
- filters can be moved up/down in the pipeline
- filters from the shaders subdirectory can be added at any position in the pipeline
Filters can be individually turned on and off using a button in their header bar.
The "show" button in the filter header bar is used to set the point in the pipeline from which the output that is shown on-screen (and saved to the file) is taken from.
Ctrl+click a parameter slider to enter a value with the keyboard. This way, it's also possible to input values outside of the slider's range.
Press F5 to reload the shaders.
Press Ctrl+F5 to reload the shaders and the input image.
The current pipeline (i.e. the list of filters and their parameters) can be saved and loaded.
Press Ctrl+C to to copy the current pipeline (as text) and the current image into the clipboard.
- Note that alpha isn't preserved properly for the image.
Press Ctrl+V to paste a GIPS pipeline from the clipboard (if it contains one), or replace the current input image with the clipboard contents.
- Note that not all image source applications export the alpha channel. (For example, GIMP and Affinity Photo do, Photoshop doesn't; also, Photoshop won't export more than 3620x3620 pixels at all.)

Limitations

Currently, GIPS is in "Minimum Viable Prototype" state; this means:

filters can't change the image size
filters always have exactly one input and one output
filter pipeline is strictly linear, no node graphs
the only supported channel format is RGBA
no tiling: only images up to the maximum texture size supported by the GPU can be processed

Building

First, ensure you have all the submodules checked out (use git clone --recursive or git submodule update --init).

GIPS is written in C++11 and uses the CMake build system.

Linux

Make sure that a compiler (GCC or Clang), CMake, Ninja, and the X11 and OpenGL development libraries are installed; At runtime, the zenity program must be available in order to make the save/load dialogs work.

For example, on Debian/Ubuntu systems, this should install everything that's needed:

sudo apt install build-essential cmake ninja-build libgl-dev libwayland-dev libx11-dev libxrandr-dev libxinerama-dev libxkbcommon-dev libxcursor-dev libxi-dev zenity

After that, you can just run make release; it creates a _build directory, runs CMake and finally Ninja. The executable (gips) will be placed in the source directory, not in the build directory.

Windows

Visual Studio 2019 (any edition, including the IDE-less Build Tools) is required. Older versions of Visual Studio might also work, but are untested. GCC / MinGW does not work currently due to an issue in a third-party library.

A simple bootstrapping script is provided; just run win32build.sh, and everything else should happen automatically:

the Visual Studio installation is detected (for this, the vswhere tool is downloaded and used)
a local copy of CMake is downloaded if there's no system-wide CMake installation
a copy of Ninja is downloaded and used
CMake and Ninja are called

At the end of this process, a freshly-built gips.exe should have appeared in the source directory. Since GLFW is used as a static library, it should not require any non-standard DLLs.

Using CMake directly, generating projects for Visual Studio is also possible, but it's only really useful for Debug builds: due to a CMake limitation, Release builds will be generated as console executables.

Credits

GIPS is written by Martin J. Fiedler (keyj@emphy.de).

Used third-party software:

GLFW for window and OpenGL context creation and event handling
Dear ImGui for the user interface
the OpenGL function loader has been generated with GLAD
Sean Barrett's STB libs for image file I/O
Sam Hocevar's Portable File Dialogs
Timothy Lottes' FXAA algorithm is part of the example shaders
the documentation in the pre-built packages is converted from Markdown to HTML using Pandoc

kajott / GIPS