Hacking:Building/Windows

From GIMP Developer Wiki
Revision as of 16:24, 28 December 2012 by Scl (Talk | contribs)

Jump to: navigation, search

A developer can build and develop GIMP using Windows. One reason to do so is to fix any GIMP bugs specific to the Windows platform. However, there is already a package of GIMP for Windows (at: GIMP Windows installers by Jernej Simončič.). A GIMP debugger or developer would still need to submit patches to the GIMP development team.

Building GIMP natively under Windows using MinGW

MinGW is an open source Linux environment available on the Windows platform.

Partha discusses building GIMP on and for the Windows platform using MinGW.

Cross-Compiling GIMP under UNIX using MinGW-w64

Experience shows that working with the MinGW environment on a UNIX machine provides a much faster compilation, and you are still able to compile for any Windows target (32 and 64 bits).

NOTE: the following procedure should be distribution-independent and does not rely on your package management system, even though it uses some OpenSuse packages. It would probably work on OSX or any other UNIX as well (add a note on the list below if you know this procedure works on another OS).

Has been known to work on at least: Ubuntu 12.04LST and Mageia 2 distribution.

Source of the original procedure from an email by Victor Oliveira.

Create a separate environment prefix

You obviously don't want to mix your Windows binaries with your normal distribution (and also you want to avoid ever having to use root). For instance you can choose:

$ mkdir $HOME/w64/

$ cd $HOME/w64

Install mingw-w64

The original MinGW projects can only compile for Windows 32 bits. Hence this procedure relies on the newer MinGW-w64 project.

If your distribution provides the mingw-w64 tools, you may install them with your package manager. Otherwise you can download directly on SourceForge the last daily snapshot from the project.

For instance if you are on Linux 64 bits and want to compile for Windows 64 bits, you should download mingw-w64-bin_x86_64-linux_20121031.tar.bz2. Note that you can install alongside mingw-w32-bin_x86_64-linux_20121031.tar.bz2 if you want to be able to cross-compile for Windows 32 bits as well.

$ tar xjf mingw-w64-bin_x86_64-linux_20121031.tar.bz2

This will extract all the cross-compiling tools and generate a prefix tree inside your $HOME/w64.

Install GIMP Dependencies

The default environment provided by MinGW does not have the huge list of dependencies that GIMP requires. Fortunately the email linked above has bash script named grab-stuff.sh (which calls itself a python3 script named "download-mingw-rpm.py", so you have to download both and have python3), which downloads pre-compiled version of all needed dependencies for cross-compiling (it uses OpenSuse repositories as source, but it does not mean at all you need rpm support).

From the root of your cross-compiling prefix ($HOME/w64) run:

$ bash grab-stuff.sh

You will notice in particular a new usr/ folder, and inside i686-w64-mingw32/ and x86_64-w64-mingw32/ sub-folders.

Set your cross-compiling environment

Chose your target. For building Windows 64 bits executable for instance:

$ export HOST=x86_64-w64-mingw32

For 32 bits:

$ export HOST=i686-w64-mingw32

Create a dependencies prefix:

$ export DEP_PREFIX=$HOME/w64/usr/$HOST/sys-root/mingw/

And an installation prefix, that you chose earlier:

$ export PREFIX=$HOME/w64

You don't want any library linked from your normal Linux environment, so let's reset pkg-config:

$ export PKG_CONFIG_LIBDIR=

$ export PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig:$DEP_PREFIX/lib/pkgconfig

$ export LD_LIBRARY_PATH=$PREFIX/lib:$DEP_PREFIX/lib

Used tools though may still use the old path as well, but preferably the downloaded MinGW:

$ export PATH=$PREFIX/bin:$DEP_PREFIX/bin:$PATH

NOTE: this step is useless if you installed MinGW-w64 from your distribution.

Finally let's add some compilation flags:

$ export ACLOCAL_FLAGS="-I $DEP_PREFIX/share/aclocal"

$ export CFLAGS="-I$DEP_PREFIX/include -I$PREFIX/include"

$ export LDFLAGS="-L$DEP_PREFIX/lib -L$PREFIX/lib"

NOTE: if you installed MinGW-w64 from your distribution, the "-L$DEP_PREFIX/lib" or "-I$DEP_PREFIX/include" will have to be replaced by your distribution default profile, likely respectively "-L/usr/x86_64-w64-mingw32/lib" and "-I/usr/x86_64-w64-mingw32/include".

You will probably want to save these values if you have to cross-compile again for Windows. The best is to save them in a file "env-64.sh" (and env-32.sh), that you can source at anytime.

Build BABL

You can use released versions if they have a version big enough. As the time of writing this, GIMP from git requires BABL and GEGL from git as well.

$ cd src/

$ git clone git://git.gnome.org/babl

$ cd babl

$ ./autogen.sh --prefix=$PREFIX --host=$HOST --enable-introspection=no

$ make

$ make install

Build GEGL

$ cd ..

$ git clone git://git.gnome.org/gegl

$ cd gegl

$ ./autogen.sh --prefix=$PREFIX --host=$HOST --enable-introspection=no --disable-docs

$ make

$ make install

Build any optional dependency

This step is not necessary if you compile GIMP with the minimum set of dependency as indicated at the next section.

Nevertheless if for instance, you needed compression support (hence be able to load and save your images in various compressed format), you would need zlib,libbzip2 and liblzma installed. In particular the cross-compilation environment described on this page has no pre-compiled liblzma. You would need to cross-compile it first yourself.

In my case xz-5.0.4 worked well.

$ cd ..

$ wget http://tukaani.org/xz/xz-5.0.4.tar.xz

$ tar xf xz-5.0.4.tar.xz

$ rm xz-5.0.4.tar.xz

$ cd xz-5.0.4

$ ./configure --prefix=$PREFIX --host=$HOST

$ make

$ make install

Finally obviously in the next step, remove the --without-liblzma option on the autogen.sh command line before compiling GIMP.

You should be able to do similar things for other optional features that you would want on your cross-compiled GIMP.

Build GIMP

$ cd ..

$ git clone git://git.gnome.org/gimp

$ cd gimp

$ ./autogen.sh --prefix=$PREFIX --host=$HOST --enable-introspection=no --disable-docs --without-libjpeg --disable-python --without-xmc --without-dbus --without-libzma

$ make

$ make install

Install On Windows

To test your compiled installation, I found nothing better than moving the whole tree (in my case $HOME/w64) into Windows, because libraries are dynamically linked, then run $HOME/w64/bin/gimp-2.9.exe under Windows.

If you really want to build a self contained GIMP, you should compile everything as static libraries. GIMP will probably still rely on some external files though, for instance what you find under $HOME/w64/share/gimp/2.0/. Maybe other things. But this will have to be tested if needed.


Troubleshooting

Running gimp-2.x.exe on Windows fails. Error messages about a missing entry point in libglib-2.0-0.dll or a missing bzip2.dll are shown.

Cause:

The missing dll files are in the MinGW binary folder, which is separate from the GIMP folders.

Solution:

To export the GIMP build to Windows properly, use the following steps:

1. On Windows create a folder for the GIMP build, like GIMP-Master.

2. Copy all files from $HOME/w64/$HOST/sys-root/mingw to the newly created folder.

3. Copy all files from your $PREFIX folder to the newly created folder. There are duplicate subfolders, for instance bin, share etc., in both directories. If your filemanager asks you to overwrite them, then confirm.

It's important to keep this order to ensure you overwrite older BABL and GEGL from the grab-stuff.sh script by the newer ones from your build.

At the end you have merged your MinGW installation and the GIMP build to a running GIMP on Windows build. (It also contains the unnecessary MinGW binaries, which are not needed anymore to run GIMP. But for testing purposes you have a running GIMP installation.)

Building GIMP using Microsoft tools

?


Building GIMP plug-ins using Microsoft tools

How to build a GIMP plug-in with Visual Studio

Packaging third-party GIMP plug-ins for Windows

Users on the Windows and Mac OSX platforms expect software to be packaged in a self-installing file (an installer). Even though GIMP plugins (whether scripts in Python or Scheme, or executables in the C language) are relatively easy to install, you might want to package them using an installer such as Inno Setup.