Difference between revisions of "Compiling ScummVM/MinGW"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Solved a minor broken link.)
(→‎SDL: Add note about needing to edit sdl-config / pkg-config outputs for MinGW toolchains)
 
(13 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Compiling ScummVM with Minimalist GNU for Windows (MINGW) and MINimal System 2 (MSYS2) ==
+
== 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".  
 
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 [http://www.mingw.org/ MinGW homepage]
 
More information can be found at the [http://www.mingw.org/ MinGW homepage]
 
{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
 
|- align="center"
 
| '''NOTE'''
 
|- style="margin-left:1em; background:#ffffff;"
 
|- style="background:#ffffff"
 
| This guide covers '''only''' the compilation under MinGW64 and MSYS2, and makes heavy use of the pacman package manager, which may not be available under other MinGW setups.
 
 
For an older version of the guide, please go to [[Compiling_ScummVM/MinGW#Compilation in older versions of MinGW and MSYS | the bottom of this page]].
 
|}
 
  
 
== Things needed ==
 
== Things needed ==
  
=== Setup MinGW and MSYS ===
+
=== MinGW and MSYS ===
 
 
'''NOTE:''' This guide is a vast simplification of that found [https://sourceforge.net/p/msys2/wiki/MSYS2%20installation/ here]. While this article should be enough, we recommend you read through the entire guide.
 
 
 
==== Download ====
 
'''Download''' and '''execute''' the MSYS2 bundle for your architecture: [https://sourceforge.net/projects/msys2/files/Base/x86_64/ 64-bit] or [https://sourceforge.net/projects/msys2/files/Base/i686/ 32-bit]
 
 
 
==== Update the core of MSYS2 ====
 
In the installation folder run msys2-shell.bat, which should open a MSYS2 terminal.
 
Type the following command, to update the core dependencies of the environment:
 
 
 
<syntax type="bash">
 
$> update-core
 
</syntax>
 
 
 
Restart the MSYS2 terminal.
 
Type the following command, to update the managed packages:
 
<syntax type="bash">
 
$> pacman -Su
 
</syntax>
 
 
 
==== Download and install the compilation toolchain====
 
In the MSYS2 terminal, type:
 
<syntax type="bash">
 
$> pacman -S mingw-w64-<env>-toolchain
 
</syntax>
 
where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively).
 
 
 
This command will fetch and install the packages needed for compiling, including (but not limited to) GCC 5.x, GDB, and libwinpthread-git.
 
 
 
==== Install make ====
 
In order to compile properly the project utilizes Makefiles, which are build configuration files that the compiler uses to compile, link and solve dependencies. "make" is the software that runs the Makefiles.
 
 
 
MSYS2 does not support make out of the box, but it has it's own implementation. Install it by typing:
 
 
 
<syntax type="bash">
 
$> pacman -S make
 
</syntax>
 
 
 
=== Install the needed libraries ===
 
In order to compile properly, ScummVM needs you to have certain libraries installed. All the libraries in the list can be installed with similar commands:
 
<syntax type="bash">
 
$> pacman -S mingw-w64-<env>-<library>
 
</syntax>
 
where <env> is the environment as previously stated, and <library> is the name of the library, as stated in the list (e.g. pacman -S mingw-w64-x86_64-SDL):
 
 
 
* [http://www.libsdl.org/download-1.2.php SDL] Mandatory.
 
 
 
* [http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D nasm] Optional, for faster compile of scalers.
 
 
 
* [http://flac.sourceforge.net/download.html flac]. Optional, for FLAC support.
 
 
 
* [http://downloads.xiph.org/releases/ogg/ libogg] and [http://downloads.xiph.org/releases/vorbis/ libvorbis] Optional, for OGG support.
 
 
 
* [ftp://ftp.mars.org/pub/mpeg/ libmad] Optional, for MP3 support.
 
 
 
* [http://libmpeg2.sourceforge.net/ libmpeg2] Optional, for MPEG2 cutscene support.
 
 
 
* [http://www.zlib.net/ zlib]. Optional, for compressed saved games.
 
 
 
* [http://downloads.xiph.org/releases/theora/ libtheora]. Optional, for Broken Sword 2.5.
 
 
 
* [http://www.audiocoding.com/downloads.html libfaad2]. Optional, for AAC support.
 
 
 
* [http://www.libpng.org/pub/png/libpng.html libpng]. Optional, for PNG support.
 
 
 
* [http://download.savannah.gnu.org/releases/freetype/ freetype]. Optional, for TTF support.
 
 
 
* [http://sourceforge.net/apps/trac/fluidsynth fluidsynth]. Optional, for soundfont MIDI support.
 
 
 
=== Let's get compiling! ===
 
 
 
Finally, we are ready to compile the project!
 
To do that, just open a MSYS2 console, [http://gvsigce.sourceforge.net/wiki/index.php/Getting_started_with_MSYS#Navigating_the_file_system navigate] to the source folder where you have cloned scummvm.git, and type the following commands:
 
<syntax type="bash">
 
$> ./configure # Executes a bash script that helps you configure.
 
$> make # Executes the make program, which triggers the compilation.
 
</syntax>
 
 
 
If everything went well, you should have a big executable in the compilation folder, named scummvm.exe. The size of the executable comes from the debug symbols embedded in the file, so you can run the following command to shrink it:
 
<syntax type="bash">
 
$> strip scummvm.exe
 
</syntax>
 
 
 
== Ready to go! ==
 
 
 
OK this should be all of it (hopefully), so you should be good to go.
 
 
 
== Common Issues ==
 
 
 
* If the executable compiles correctly, but you get a "somelibrary.dll missing" error when executing it, you just need to add the following path to your PATH variable: <installdir>/msys<env>/mingw64/bin/
 
 
 
== Compilation in older versions of MinGW and MSYS ==
 
 
 
==== MinGW and MSYS ====
 
  
 
Download MinGW:  
 
Download MinGW:  
Line 122: Line 18:
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gmp/gmp-5.0.1-1/gmp-5.0.1-1-mingw32-dev.tar.lzma/download gmp dev]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gmp/gmp-5.0.1-1/gmp-5.0.1-1-mingw32-dev.tar.lzma/download gmp dev]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/gcc-4.6.2-1/libgomp-4.6.2-1-mingw32-dll-1.tar.lzma/download gmp dll]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/gcc-4.6.2-1/libgomp-4.6.2-1-mingw32-dll-1.tar.lzma/download gmp dll]
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/gcc-4.6.2-1/libgomp-4.6.2-1-mingw32-dll-1.tar.lzma/download gomp]
 
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gettext/gettext-0.17-1/libintl-0.17-1-mingw32-dll-8.tar.lzma/download iconv]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gettext/gettext-0.17-1/libintl-0.17-1-mingw32-dll-8.tar.lzma/download iconv]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-mingw32-dev.tar.lzma/download intl dev]  
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-mingw32-dev.tar.lzma/download intl dev]  
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-mingw32-dll-2.tar.lzma/download intl dll]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-mingw32-dll-2.tar.lzma/download intl dll]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gmp/gmp-5.0.1-1/libgmp-5.0.1-1-mingw32-dll-10.tar.lzma/download libgmp]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/gmp/gmp-5.0.1-1/libgmp-5.0.1-1-mingw32-dll-10.tar.lzma/download libgmp]
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mingw-rt/mingwrt-3.18/mingwrt-3.18-mingw32-dev.tar.gz/download mingw-runtime dev]
+
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mingwrt/mingwrt-3.18/mingwrt-3.18-mingw32-dev.tar.gz/download mingw-runtime dev]
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mingw-rt/mingwrt-3.18/mingwrt-3.18-mingw32-dll.tar.gz/download mingw-runtime  dll]
+
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mingwrt/mingwrt-3.18/mingwrt-3.18-mingw32-dll.tar.gz/download mingw-runtime  dll]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mpc/mpc-0.8.1-1/mpc-0.8.1-1-mingw32-dev.tar.lzma/download mpc dev]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mpc/mpc-0.8.1-1/mpc-0.8.1-1-mingw32-dev.tar.lzma/download mpc dev]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mpc/mpc-0.8.1-1/libmpc-0.8.1-1-mingw32-dll-2.tar.lzma/download mpc dll]
 
*[http://sourceforge.net/projects/mingw/files/MinGW/Base/mpc/mpc-0.8.1-1/libmpc-0.8.1-1-mingw32-dll-2.tar.lzma/download mpc dll]
Line 145: Line 40:
 
Check the "'''Installing MinGW and MSYS'''" section below for instructions on how to create your ScummVM compilation environment
 
Check the "'''Installing MinGW and MSYS'''" section below for instructions on how to create your ScummVM compilation environment
  
==== Libraries needed ====
+
=== Libraries needed ===
  
 
* [http://www.libsdl.org/download-1.2.php SDL 1.2].  
 
* [http://www.libsdl.org/download-1.2.php SDL 1.2].  
Line 183: Line 78:
 
** You need at least v1.0.9. Newer versions than this should work, but require GTK's glib and CMAKE to build.
 
** You need at least v1.0.9. Newer versions than this should work, but require GTK's glib and CMAKE to build.
  
==== Precompiled libraries ====
+
=== Precompiled libraries ===
 
To ease the whole process, a package of all the needed precompiled libraries has been created.  
 
To ease the whole process, a package of all the needed precompiled libraries has been created.  
 
All you need to do is:
 
All you need to do is:
 
* Download the precompiled libraries and the [http://www.libsdl.org/release/SDL-1.2.15-win32.zip latest SDL runtime library] - latest version is 1.2.15 at the time this was written, you can find the latest version [http://www.libsdl.org/download-1.2.php here]. Precompiled libraries:
 
* Download the precompiled libraries and the [http://www.libsdl.org/release/SDL-1.2.15-win32.zip latest SDL runtime library] - latest version is 1.2.15 at the time this was written, you can find the latest version [http://www.libsdl.org/download-1.2.php here]. Precompiled libraries:
** [http://sourceforge.net/projects/scummvm/files/build/scummvm-required-libs-mingw.zip/download Precompiled libraries]
+
** [http://www.scummvm.org/frs/build/scummvm-required-libs-mingw.zip Precompiled libraries]
  
=== Installing MinGW and MSYS ===
+
== Installing MinGW and MSYS ==
  
 
Both MinGW and MSYS need to be installed and working to compile ScummVM.  
 
Both MinGW and MSYS need to be installed and working to compile ScummVM.  
Line 199: Line 94:
  
  
==== Additional information about MinGW and Windows Vista ====
+
=== Additional information about MinGW and Windows Vista ===
  
 
In order to get MinGW properly working under Windows Vista, you need to do the following:
 
In order to get MinGW properly working under Windows Vista, you need to do the following:
Line 206: Line 101:
 
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
 
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 ===
+
== 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".
 
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".
Line 240: Line 135:
  
  
=== Building the libraries ===
+
== Building the libraries ==
  
 
Now, we need to compile the required libraries and tools.
 
Now, we need to compile the required libraries and tools.
  
  
==== NASM ====
+
=== NASM ===
  
 
First of all, we need nasm. So unzip the nasm archive in a directory, and copy both files to MinGW's bin directory. Alternatively, you can include the folder you unzipped the files in your system path. To do this, go to Control Panel->System, Advanced tab->environment variables and edit the "PATH" variable in the system variables list, adding the folder where you placed the aforementioned files. Directories in the system path are split with a semicolon (;), e.g. "C:\MinGW\msys\1.0\bin;C:\MinGW\bin;C:\nasm".  
 
First of all, we need nasm. So unzip the nasm archive in a directory, and copy both files to MinGW's bin directory. Alternatively, you can include the folder you unzipped the files in your system path. To do this, go to Control Panel->System, Advanced tab->environment variables and edit the "PATH" variable in the system variables list, adding the folder where you placed the aforementioned files. Directories in the system path are split with a semicolon (;), e.g. "C:\MinGW\msys\1.0\bin;C:\MinGW\bin;C:\nasm".  
Line 251: Line 146:
 
Note that changes to the PATH will be reflected on newly opened command prompts only, so if you got any open already, close them to avoid confusion
 
Note that changes to the PATH will be reflected on newly opened command prompts only, so if you got any open already, close them to avoid confusion
  
==== SDL ====
+
=== SDL ===
  
SDL is already compiled and needs no further changes, so we can skip the compilation step for it
+
SDL is already provided in compiled development archives, so we can skip the compilation step for it
  
After extracting the contents of the SDL 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.
+
This can be found from [https://www.libsdl.org 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/sdl-config and lib/pkgconfig/sdl2.pc files 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:
 
If you do wish to recompile SDL from source code, please note the following:
Line 261: Line 160:
 
* Note the README [http://www.libsdl.org/extras/win32/mingw32/README.txt here], especially the need to include the DirectX development header and libraries from [http://www.libsdl.org/extras/win32/common/directx-devel.tar.gz here] to ensure that the "dsound" rather than the "waveout" / "winmm" fallback audio driver is used.
 
* Note the README [http://www.libsdl.org/extras/win32/mingw32/README.txt here], especially the need to include the DirectX development header and libraries from [http://www.libsdl.org/extras/win32/common/directx-devel.tar.gz here] to ensure that the "dsound" rather than the "waveout" / "winmm" fallback audio driver is used.
  
==== zlib ====
+
=== zlib ===
  
 
Unzip the source code in a folder, open MSYS, go to the zlib folder and issue this command to compile the library:
 
Unzip the source code in a folder, open MSYS, go to the zlib folder and issue this command to compile the library:
Line 276: Line 175:
  
  
==== libogg ====
+
=== libogg ===
  
 
libogg should be compiled before libvorbis and libFLAC
 
libogg should be compiled before libvorbis and libFLAC
Line 288: Line 187:
  
  
==== libvorbis ====
+
=== libvorbis ===
  
 
Unzip the libvorbis archive in a folder, open MSYS, go to the libvorbis folder and issue these commands to compile the library:
 
Unzip the libvorbis archive in a folder, open MSYS, go to the libvorbis folder and issue these commands to compile the library:
Line 299: Line 198:
  
  
==== libmad ====
+
=== 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:
 
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:
Line 312: Line 211:
  
  
==== libmpeg2 ====
+
=== libmpeg2 ===
  
 
Unzip the libmpeg2 archive into a folder. Open MSYS, go to the libmpeg2 folder.
 
Unzip the libmpeg2 archive into a folder. Open MSYS, go to the libmpeg2 folder.
Line 324: Line 223:
  
 
Note that if you are compiling x64 i.e. for a 64-bit target, then currently (v0.5.1), the following patch is needed:
 
Note that if you are compiling x64 i.e. for a 64-bit target, then currently (v0.5.1), the following patch is needed:
<syntax type="diff">
+
<syntaxhighlight lang="diff">
 
--- libvo/video_out_dx.c.orig  2014-02-17 16:38:24.000000000 +0100
 
--- libvo/video_out_dx.c.orig  2014-02-17 16:38:24.000000000 +0100
 
+++ libvo/video_out_dx.c        2014-02-17 16:39:34.000000000 +0100
 
+++ libvo/video_out_dx.c        2014-02-17 16:39:34.000000000 +0100
Line 341: Line 240:
 
       * We need to use SetWindowLongPtr when it is available in mingw */
 
       * We need to use SetWindowLongPtr when it is available in mingw */
 
-    SetWindowLong (instance->window, GWL_USERDATA, (LONG) instance);
 
-    SetWindowLong (instance->window, GWL_USERDATA, (LONG) instance);
+    SetWindowLongPtr (instance->window, GWLP_USERDATA, (LONG) instance);
+
+    SetWindowLongPtr (instance->window, GWLP_USERDATA, (LONG_PTR) instance);
 
   
 
   
 
     ShowWindow (instance->window, SW_SHOW);
 
     ShowWindow (instance->window, SW_SHOW);
</syntax>
+
</syntaxhighlight>
  
==== FLAC ====
+
=== FLAC ===
  
 
Unzip the flac archive in a folder, open MSYS, go to the flac folder and issue these commands to compile the library:
 
Unzip the flac archive in a folder, open MSYS, go to the flac folder and issue these commands to compile the library:
Line 357: Line 256:
  
  
==== FluidSynth ====
+
=== FluidSynth ===
  
 
We use fluidsynth 1.0.9, since later versions requires GTK.
 
We use fluidsynth 1.0.9, since later versions requires GTK.
Line 363: Line 262:
 
Unzip the fluidsynth archive in a folder, open MSYS, go to the fluidsynth folder and apply the following patch:
 
Unzip the fluidsynth archive in a folder, open MSYS, go to the fluidsynth folder and apply the following patch:
  
<syntax type="diff">
+
<syntaxhighlight lang="diff">
 
--- include/fluidsynth.h
 
--- include/fluidsynth.h
 
+++ include/fluidsynth.h
 
+++ include/fluidsynth.h
Line 381: Line 280:
 
  #elif defined(MACOS9)
 
  #elif defined(MACOS9)
 
  #define FLUIDSYNTH_API __declspec(export)
 
  #define FLUIDSYNTH_API __declspec(export)
</syntax>
+
</syntaxhighlight>
  
 
Then issue these commands to compile the library:
 
Then issue these commands to compile the library:
Line 390: Line 289:
 
  make install prefix=/mingw
 
  make install prefix=/mingw
  
==== libpng ====
+
=== libpng ===
  
 
Unzip the libpng archive in a folder, open MSYS, go to the libpng folder and issue these commands to compile the library:
 
Unzip the libpng archive in a folder, open MSYS, go to the libpng folder and issue these commands to compile the library:
Line 401: Line 300:
  
  
==== libtheora ====
+
=== libtheora ===
  
 
Unzip the libtheora archive in a folder, open MSYS, go to the libtheora folder and issue these commands to compile the library:
 
Unzip the libtheora archive in a folder, open MSYS, go to the libtheora folder and issue these commands to compile the library:
Line 412: Line 311:
  
  
==== libfaad2 ====
+
=== libfaad2 ===
  
 
Unzip the libfaad2 archive in a folder, open MSYS, go to the libfaad2 folder and apply the following patch:
 
Unzip the libfaad2 archive in a folder, open MSYS, go to the libfaad2 folder and apply the following patch:
  
<syntax type="diff">
+
<syntaxhighlight lang="diff">
 
--- frontend/main.c
 
--- frontend/main.c
 
+++ frontend/main.c
 
+++ frontend/main.c
Line 429: Line 328:
 
  #include <time.h>
 
  #include <time.h>
 
  #endif
 
  #endif
</syntax>
+
</syntaxhighlight>
  
 
Then issue these commands to compile the library:
 
Then issue these commands to compile the library:
Line 439: Line 338:
  
  
==== freetype ====
+
=== freetype ===
  
 
Unzip the freetype archive in a folder, open MSYS, go to the freetype folder and issue these commands to compile the library:
 
Unzip the freetype archive in a folder, open MSYS, go to the freetype folder and issue these commands to compile the library:
Line 449: Line 348:
 
  make install prefix=/mingw
 
  make install prefix=/mingw
  
=== Compiling ScummVM ===
+
== Compiling ScummVM ==
  
 
To compile ScummVM, issue the following commands inside the scummvm folder (where Makefile resides):
 
To compile ScummVM, issue the following commands inside the scummvm folder (where Makefile resides):
Line 458: Line 357:
  
 
  strip scummvm.exe
 
  strip scummvm.exe
 +
 +
== Ready to go! ==
 +
 +
OK this should be all of it (thankfully), so you should be good to go.

Latest revision as of 10:47, 23 November 2018

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 MinGW:

Download MSYS and the MSYS Developer Tools:

Check the "Installing MinGW and MSYS" section below for instructions on how to create your ScummVM compilation environment

Libraries needed

  • SDL 1.2.
    • You need the latest Development Libraries file for Mingw32.
  • NASM Optional, for faster compile of scalers
    • You need the latest Win32 binary (2.10.07 at the time of writing).
  • FLAC. Optional, for FLAC support
    • You need the latest flac source code.
  • libogg and libvorbis Optional, for OGG support
    • You need the latest libogg and libvorbis (not vorbis) source code.
  • libmad Optional, for MP3 support
    • You need the latest libmad source code.
  • libmpeg2 Optional, for MPEG2 cutscene support.
    • You need the latest libmpeg2 source code, currently v0.5.1.
  • zlib. Optional, for compressed saved games.
    • You need the latest zlib source code.
  • libtheora. Optional, for Broken Sword 2.5.
    • You need the latest libtheora source code.
  • libfaad2. Optional, for AAC support.
    • You need the latest libfaad2 source code.
  • libpng. Optional, for PNG support.
    • You need the latest libpng source code.
  • freetype. Optional, for TTF support.
    • You need the latest freetype source code.
  • 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.

Precompiled libraries

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

Installing MinGW and MSYS

Both MinGW and MSYS need to be installed and working to compile ScummVM.

  • Create a directory called mingw in the root directory of drive (ie C:\MinGW\ )
  • Extract all the mingw packages to the mingw directory
  • Then, install MSYS. After installation, a new console window will appear, asking if you wish to proceed with the post install. Answer 'y' to that prompt. You will then be asked if you have MinGW installed. Answer 'y' to that and then type in the path of your MinGW directory using forward slashes (e.g. C:/MinGW). Make sure that there is no "make" utility in the MinGW bin folder, as this will clash with the make utility in MSYS. With the recent packages described in the section above, you shouldn't have that problem.
  • After both MinGW and MSYS are installed correctly, install MSYS DTK


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

First of all, we need nasm. So unzip the nasm archive in a directory, and copy both files to MinGW's bin directory. Alternatively, you can include the folder you unzipped the files in your system path. To do this, go to Control Panel->System, Advanced tab->environment variables and edit the "PATH" variable in the system variables list, adding the folder where you placed the aforementioned files. Directories in the system path are split with a semicolon (;), e.g. "C:\MinGW\msys\1.0\bin;C:\MinGW\bin;C:\nasm".

Note that changes to the PATH will be reflected on newly opened command prompts only, so if you got any open already, close them to avoid confusion

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/sdl-config and lib/pkgconfig/sdl2.pc files 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.

zlib

Unzip the source code in a folder, open MSYS, go to the zlib folder and issue this command to compile the library:

make -f win32/makefile.gcc

After compilation, copy zlib.h and zconf.h inside MinGW's include folder and libz.a inside MinGW's lib folder


You can do this using Explorer or by typing these commands in MSYS inside the zlib folder:

cp -p libz.a /mingw/lib
cp -p zlib.h zconf.h /mingw/include


libogg

libogg should be compiled before libvorbis and libFLAC Unzip the libogg archive in a folder, open MSYS, go to the libogg folder and issue these commands to compile the library:

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

To install the library, type:

make install prefix=/mingw


libvorbis

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

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

To install the library, type:

make install prefix=/mingw


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 the library:

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

To install the library, type:

make install prefix=/mingw


libmpeg2

Unzip the libmpeg2 archive into a folder. Open MSYS, go to the libmpeg2 folder.

Then issue these commands to compile the library:

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

To install the library, type:

make install prefix=/mingw

Note that if you are compiling x64 i.e. for a 64-bit target, then currently (v0.5.1), the following patch is needed:

--- libvo/video_out_dx.c.orig   2014-02-17 16:38:24.000000000 +0100
+++ libvo/video_out_dx.c        2014-02-17 16:39:34.000000000 +0100
@@ -92,7 +92,7 @@
     switch (message) {
 
     case WM_WINDOWPOSCHANGED:
-       instance = (dx_instance_t *) GetWindowLong (hwnd, GWL_USERDATA);
+       instance = (dx_instance_t *) GetWindowLongPtr (hwnd, GWLP_USERDATA);
 
        /* update the window position and size */
        point_window.x = 0;
@@ -173,7 +173,7 @@
     /* store a directx_instance pointer into the window local storage
      * (for later use in event_handler).
      * We need to use SetWindowLongPtr when it is available in mingw */
-    SetWindowLong (instance->window, GWL_USERDATA, (LONG) instance);
+    SetWindowLongPtr (instance->window, GWLP_USERDATA, (LONG_PTR) instance);
 
     ShowWindow (instance->window, SW_SHOW);

FLAC

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

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

To install the library, type:

make install prefix=/mingw


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 the library:

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

To install the library, type:

make install prefix=/mingw

libpng

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

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

To install the library, type:

make install prefix=/mingw


libtheora

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

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

To install the library, type:

make install prefix=/mingw


libfaad2

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

--- frontend/main.c	
+++ frontend/main.c
@@ -31,7 +31,9 @@
 #ifdef _WIN32
 #define WIN32_LEAN_AND_MEAN
 #include <windows.h>
+#ifndef __MINGW32__
 #define off_t __int64
+#endif
 #else
 #include <time.h>
 #endif

Then issue these commands to compile the library:

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

To install the library, type:

make install prefix=/mingw


freetype

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

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

To install the library, type:

make install prefix=/mingw

Compiling ScummVM

To compile ScummVM, issue the following commands inside the scummvm folder (where Makefile resides):

./configure
make

After compilation, you'll end up with a very big scummvm.exe (around 16MB). This is because debug symbols and information are embedded by default in the exe file, making it very big. To remove all the unneeded debug information from the executable, thus reducing its size by about 12MB, go to the folder where the compiled scummvm.exe file is and run the following command:

strip scummvm.exe

Ready to go!

OK this should be all of it (thankfully), so you should be good to go.