Compiling ScummVM/MinGW

Compiling ScummVM with Minimalist GNU for Windows (MinGW)

MinGW is "a collection of freely available and freely distributable Windows specific header files and import libraries combined with GNU toolsets that allow one to produce native Windows programs that do not rely on any 3rd-party C runtime DLLs".

More information can be found at the MinGW homepage

Things needed

MinGW and MSYS

Download and install the latest MinGW Installation Manager (mingw-get-setup.exe)
From the list of packages shown, check mingw-developer-toolkit-bin, mingw32-base-bin and mingw32-gcc-g++-bin, as well as mingw32-libz-dev from the "MinGW Libraries" section (right-click > Mark for Installation)
Click the Installation > Apply Changes menu to install MinGW and MSYS
Once installation is complete, you can run MSYS from inside the MinGW directory (by default C:\MinGW\msys\1.0\msys.bat)

Libraries needed

SDL 1.2.
- You need the latest Development Libraries file for Mingw32.

SDL_net 1.2. Optional, for network support.
- You need the latest SDL_net source code (v1.2.8 at the time of writing).

pkg-config-lite.
- You need the latest Win32 binary (v0.28-1 at the time of writing).

NASM. Optional, for faster compile of scalers
- You need the latest Win32 binary (v2.15.03 at the time of writing).

CMake. Optional, for compiling libjpeg-turbo.
- You need the latest Win32 installer.

FLAC. Optional, for FLAC support
- You need the latest flac source code (v1.3.3 at the time of writing).

libogg and libvorbis Optional, for OGG support
- You need the latest libogg source code (v1.3.4 at the time of writing).
- You need the latest libvorbis (not vorbis) source code (v1.3.7 at the time of writing).

libmad Optional, for MP3 support
- You need the latest libmad source code (v0.15.1b at the time of writing).

libmpeg2 Optional, for MPEG2 cutscene support.
- You need the latest libmpeg2 source code, (v0.5.1 at the time of writing).

libtheora. Optional, for Broken Sword 2.5.
- You need the latest libtheora source code (v1.1.1 at the time of writing).

libfaad2. Optional, for AAC support.
- You need the latest libfaad2 source code (v2.9.2 at the time of writing).

libpng. Optional, for PNG support.
- You need the latest libpng source code (v1.6.37 at the time of writing).

freetype. Optional, for TTF support.
- You need the latest freetype source code (v2.10.2 at the time of writing).

fluidsynth. Optional, for soundfont MIDI support.
- You need at least v1.0.9. Newer versions than this should work, but require GTK's glib and CMAKE to build.

FriBiDi. Optional, for bidirectional text in languages that need it (e.g. Hebrew)
- You need the latest FriBiDi source code (v1.0.10 at the time of writing).

libjpeg-turbo. Optional, for JPEG support.
- You need the latest libjpeg-turbo source code (v2.0.5 at the time of writing).

libcurl. Optional, for cloud support.
- You need the latest libcurl source code (v7.71.1 at the time of writing).

Precompiled libraries

To ease the whole process, a package of all the needed precompiled libraries has been created. All you need to do is:

Download the precompiled libraries and the latest SDL runtime library - latest version is 1.2.15 at the time this was written, you can find the latest version here. Precompiled libraries:
- Precompiled libraries
Extract them to your MinGW directory (e.g. C:\MinGW)

Additional information about MinGW and Windows Vista

In order to get MinGW properly working under Windows Vista, you need to do the following: Go to Control Panel->System, and click on "Advanced System Settings" to the left. Then click on "Environment variables" and on the bottom window ("System variables"), select the "Path" variable and edit it. This variable tells windows where to look for binaries when it can't find them in the current folder. You'll find a lot of directories there separated by semicolons.

Make sure that the MinGW bin directory is included in the path (e.g. C:\MinGW\bin), which should already be included there from the MinGW installer. Also, make sure that the libexec path is included too (e.g. C:\MinGW\libexec\gcc\mingw32\3.4.2), which is needed in Vista to get MinGW properly working

MSYS primer

From the developer's webpage: "MSYS or Minimal SYStem is a POSIX and Bourne shell environment use with MinGW. It provides a hand picked set of tools to allow a typical configuration script with Bourne syntax to execute. This allows most of the GNU packages to create a Makefile just from executing the typical configure script which can then be used to build the package using the native MinGW version of GCC".

For more information, check the MinGW FAQ page

MSYS commands can be confusing for people using Windows, as MSYS emulates a Bourne shell environment, which is found in most Unix/Linux distributions. The available commands can be viewed by typing "help" in the command prompt. Help on a specific command is available by typing "help" followed by the command, e.g. "help alias".

Note that MSYS uses forward slashes between folder names, not backward slashes, as is the case with Windows. Additionally, some special characters like the space need to be escaped with a backward slash("\"). Drives are mounted to folders, so drive "C:" would be under folder "/c". Therefore, to switch to directory:

C:\Program Files\Test Folder

we would switch to:

/c/Program\ Files/Test\ Folder

The basic commands you'll need are:

cd - changes the current drive and directory
pwd - shows the current drive and directory
ls - lists files in a folder
make - makefile, used to compile projects
strip - remove debug information from executable files

Note that if you wish to run a file from the current folder, you need to specify it before the file name, i.e. if you wish to run "test" from the current folder, you should type:

./test

Building the libraries

Now, we need to compile the required libraries and tools.

NASM

Unzip the nasm archive in a folder, and copy both files to MinGW's bin directory.

pkg-config-lite

Unzip the pkg-config-lite archive in a folder, and copy the "bin" and "share" to MinGW's root directory.

SDL

SDL is already provided in compiled development archives, so we can skip the compilation step for it

This can be found from here, going to the latest stable download and choosing the Development Libraries - MinGW 32/64-bit option.

After extracting the contents of this archive in a folder, copy all the files in the 'include/SDL' folder to MinGW's include folder, copy all the files in the 'lib' folder to MinGW's lib folder and copy all the files in the 'bin' folder to MinGW's bin folder.

It may be necessary to modify the bin/sdl2-config and lib/pkgconfig/sdl2.pc files (located under the mingw directory) which are just text. These files provide the compiler option information to ScummmVM and SDL2 is passing the -mwindows compiler option by default which will result in a valid executable, but with broken console / command-line output. These should be removed or replaced by -mconsole (though this will affect all SDL compiled binaries made by the MinGW toolchain). ScummVM's configure script should deal automatically with this issue in future as the upstream SDL project has indicated that removing this "forced" option is a WONTFIX issue.

If you do wish to recompile SDL from source code, please note the following:

Check that the libSDL source file src/main/win32/version.rc contains the correct version. This was incorrectly listed as v1.2.14 for the v1.2.15 release, needed an additional patch.
Note the README here, especially the need to include the DirectX development header and libraries from here to ensure that the "dsound" rather than the "waveout" / "winmm" fallback audio driver is used.

libogg

libogg should be compiled before libvorbis, libtheora and libFLAC.

Unzip the libogg archive in a folder, open MSYS, go to the libogg folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libvorbis

Unzip the libvorbis archive in a folder, open MSYS, go to the libvorbis folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libmad

Unzip the libmad archive in a folder, open MSYS, go to the libmad folder If you are using gcc 4.4 or higher, run the following command:

sed -i '/-fforce-mem/d' configure

Then issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libmpeg2

Unzip the libmpeg2 archive into a folder, open MSYS, go to the libmpeg2 folder and issue these commands to compile and install the library:

sed -i -e '/AC_C_ALWAYS_INLINE/d' -e 's/-mcpu/-mtune/' configure.ac
./bootstrap
./configure --disable-sdl --disable-shared --prefix=/mingw
make
make install

FLAC

Unzip the flac archive in a folder, open MSYS, go to the flac folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

FluidSynth

We use fluidsynth 1.0.9, since later versions requires GTK.

Unzip the fluidsynth archive in a folder, open MSYS, go to the fluidsynth folder and apply the following patch:

--- include/fluidsynth.h
+++ include/fluidsynth.h
@@ -28,13 +28,7 @@
 #endif
 
 #if defined(WIN32)
-#if defined(FLUIDSYNTH_DLL_EXPORTS)
-#define FLUIDSYNTH_API __declspec(dllexport)
-#elif defined(FLUIDSYNTH_NOT_A_DLL)
-#define FLUIDSYNTH_API 
-#else
-#define FLUIDSYNTH_API __declspec(dllimport)
-#endif
+#define FLUIDSYNTH_API
 
 #elif defined(MACOS9)
 #define FLUIDSYNTH_API __declspec(export)

Then issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libpng

Unzip the libpng archive in a folder, open MSYS, go to the libpng folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make pnglibconf.h
sed -i 's/\x0D//' pnglibconf.h
make
make install

libtheora

Unzip the libtheora archive in a folder, open MSYS, go to the libtheora folder and issue these commands to compile and install the library:

./configure --disable-shared --disable-examples --prefix=/mingw
make
make install

libfaad2

Unzip the libfaad2 archive in a folder, open MSYS, go to the libfaad2 folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

freetype

Unzip the freetype archive in a folder, open MSYS, go to the freetype folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

fribidi

Unzip the fribidi archive in a folder, open MSYS, go to the fribidi folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libjpeg-turbo

Unzip the libjpeg-turbo archive in a folder, open MSYS, go to the libjpeg-turbo folder and issue these commands to compile and install the library:

cmake -G "MSYS Makefiles" -DENABLE_SHARED=OFF -D-DCMAKE_INSTALL_PREFIX=$PREFIX -DCMAKE_BUILD_TYPE=Release .
make
make install

SDL_net

Unzip the SDL_net archive in a folder, open MSYS, go to the SDL_net folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw
make
make install

libcurl

Unzip the curl archive in a folder, open MSYS, go to the curl folder and issue these commands to compile and install the library:

./configure --disable-shared --prefix=/mingw --with-winssl --disable-pthreads --disable-ldap
make
make install