Difference between revisions of "Compiling ScummVM/MinGW"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (→‎MinGW and MSYS: fix g++ link)
 
(63 intermediate revisions by 13 users not shown)
Line 1: Line 1:
== Compiling ScummVM with Minimalist GNU for Windows (MINGW) ==
{| 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"
|Compiling with MinGW is not working out of the box. It is recommended that you use [[Compiling_ScummVM/MinGW-w64|MinGW-w64]] instead, which is far easier to set up and get working.
|}
 
== 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 [https://osdn.net/projects/mingw/ MinGW homepage]. See also [[Compiling_ScummVM/MinGW-w64|MinGW-w64]].
 
'''Please note:''' as of January 2011, versions of MinGW past 4.2.1 will have trouble passing the configure test for ScummVM due to a bug in MinGW. Therefore, it's recommended that you either use version 4.2.1 or alternatively you could try TDM gcc[http://tdm-gcc.tdragon.net/], which works at least up to version 4.3.3.


== Things needed ==
== Things needed ==
Line 11: Line 17:
=== MinGW and MSYS ===
=== MinGW and MSYS ===


Download MinGW:  
* Download and install the latest [https://osdn.net/projects/mingw/releases/ 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 ===


*[http://sourceforge.net/projects/mingw/files/MinGW/BaseSystem/GNU-Binutils/binutils-2.19/binutils-2.19-2-mingw32-bin.tar.gz/download binutils]
* [https://www.libsdl.org/download-2.0.php SDL2].
*[http://sourceforge.net/projects/mingw/files/MinGW/BaseSystem/GCC/Version4/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-core-4.2.1-sjlj-2.tar.gz/download gcc-core]
** You need the latest SDL2 development libraries: ([https://www.libsdl.org/release/SDL2-devel-2.0.14-mingw.tar.gz v2.0.14] at the time of writing).
*[http://sourceforge.net/projects/mingw/files/MinGW/BaseSystem/GCC/Version4/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-g%2B%2B-4.2.1-sjlj-2.tar.gz/download gcc-g++]
*[http://sourceforge.net/projects/mingw/files/MinGW/BaseSystem/RuntimeLibrary/MinGW-RT/mingwrt-3.18/mingwrt-3.18-mingw32-dev.tar.gz/download mingw-runtime 3.18]
*[http://sourceforge.net/projects/mingw/files/MinGW/BaseSystem/RuntimeLibrary/Win32-API/w32api-3.14/w32api-3.14-mingw32-dev.tar.gz/download w32api 3.14]


Download MSYS and the MSYS Developer Tools:
* [https://github.com/libsdl-org/SDL-1.2 SDL 1.2]. For Windows 95/98/ME support
** You need the latest SDL 1.2 source code revision from GitHub ([https://github.com/libsdl-org/SDL-1.2/tree/d06a1eb74acf96ded8898b8507cc568c862c9d74 d06a1eb74acf96ded8898b8507cc568c862c9d74] at the time of writing).


*[http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/msys-core/msys-1.0.10/MSYS-1.0.10.exe/download MSYS 1.0.10]
* [https://www.libsdl.org/projects/SDL_net/ SDL2_net]. Optional, for network support.
*[http://sourceforge.net/projects/mingw/files/MSYS/Supplementary%20Tools/msysDTK-1.0.1/msysDTK-1.0.1.exe/download msysDTK]
** You need the latest SDL2_net source code ([https://www.libsdl.org/projects/SDL_net/release/SDL2_net-2.0.1.tar.gz v2.0.1] at the time of writing).


Check the "'''Installing MinGW and MSYS'''" section below for instructions on how to create your ScummVM compilation environment
* [https://www.libsdl.org/projects/SDL_net/release-1.2.html SDL_net 1.2]. Optional, for network support on Windows 95/98/ME.
** You need the latest SDL_net source code ([https://www.libsdl.org/projects/SDL_net/release/SDL_net-1.2.8.tar.gz v1.2.8] at the time of writing).


=== Libraries needed ===
* [https://sourceforge.net/projects/pkgconfiglite/ pkg-config-lite].
** You need the latest Win32 binary ([https://sourceforge.net/projects/pkgconfiglite/files/0.28-1/pkg-config-lite-0.28-1_bin-win32.zip/download v0.28-1] at the time of writing).


* [http://www.libsdl.org/download-1.2.php SDL 1.2].  
* [http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D NASM]. Optional, for faster compile of scalers
You need the latest Development Libraries file for Mingw32.  
** You need the latest Win32 binary ([http://www.nasm.us/pub/nasm/releasebuilds/2.15.05/win32/ v2.15.05] at the time of writing).


* [http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D NASM] Optional, for faster compile of scalers
* [https://cmake.org/ CMake]. Optional, for compiling libjpeg-turbo.
You need the latest Win32 binary ([http://www.nasm.us/pub/nasm/releasebuilds/2.09.04/win32/ 2.09.04] at the time of writing).
** You need the latest Win32 installer.


* [http://flac.sourceforge.net/download.html FLAC]. Optional, for FLAC support
* [https://xiph.org/flac/download.html FLAC]. Optional, for FLAC support
You need the 1.1.3 source code, as later versions aren't supported under MinGW.
** You need the latest flac source code ([http://downloads.xiph.org/releases/flac/flac-1.3.3.tar.xz v1.3.3] at the time of writing).


* [http://downloads.xiph.org/releases/ogg/ libogg] and [http://downloads.xiph.org/releases/vorbis/ libvorbis] Optional, for OGG support
* [http://downloads.xiph.org/releases/ogg/ libogg] and [http://downloads.xiph.org/releases/vorbis/ libvorbis] Optional, for OGG support
You need the latest libogg and libvorbis (not vorbis) source code.
** You need the latest libogg source code ([https://downloads.xiph.org/releases/ogg/libogg-1.3.5.tar.xz v1.3.5] at the time of writing).
** You need the latest libvorbis (not vorbis) source code ([https://downloads.xiph.org/releases/vorbis/libvorbis-1.3.7.tar.xz v1.3.7] at the time of writing).


* [ftp://ftp.mars.org/pub/mpeg/ libmad] Optional, for MP3 support
* [ftp://ftp.mars.org/pub/mpeg/ libmad] Optional, for MP3 support
You need the latest libmad source code.
** You need the latest libmad source code ([ftp://ftp.mars.org/pub/mpeg/libmad-0.15.1b.tar.gz v0.15.1b] at the time of writing).
 
* [http://libmpeg2.sourceforge.net/ libmpeg2] Optional, for MPEG2 cutscene support.
** You need the latest libmpeg2 source code, ([http://libmpeg2.sourceforge.net/files/libmpeg2-0.5.1.tar.gz v0.5.1] at the time of writing).
 
* [http://downloads.xiph.org/releases/theora/ libtheora]. Optional, for Broken Sword 2.5.
** You need the latest libtheora source code ([https://downloads.xiph.org/releases/theora/libtheora-1.1.1.tar.bz2 v1.1.1] at the time of writing).
 
* [https://github.com/knik0/faad2 libfaad2]. Optional, for AAC support.
** You need the latest libfaad2 source code ([https://github.com/knik0/faad2/releases/tag/2_10_0 v2.10.0] at the time of writing).


* [http://www.zlib.net/ zlib]. Optional, for compressed saved games.
* [http://www.libpng.org/pub/png/libpng.html libpng]. Optional, for PNG support.
You need the latest zlib source code.
** You need the latest libpng source code ([https://download.sourceforge.net/libpng/libpng-1.6.37.tar.xz v1.6.37] at the time of writing).


* [http://libpng.org/pub/png/libpng.html libpng]. Optional, for Broken Sword 2.5.
* [http://giflib.sourceforge.net/ giflib]. Optional, for GIF support.
You need the latest libpng source code.
** You need at least [https://downloads.sourceforge.net/giflib/giflib-5.1.4.tar.gz v5.1.4].


* [http://downloads.xiph.org/releases/theora/ libtheora]. Optional, for Broken Sword 2.5.
* [http://download.savannah.gnu.org/releases/freetype/ freetype]. Optional, for TTF support.
You need the latest libtheora source code.
** You need the latest freetype source code ([http://download.savannah.gnu.org/releases/freetype/freetype-2.10.4.tar.xz v2.10.4] at the time of writing).


=== Precompiled libraries ===
* [https://github.com/divideconcept/FluidLite FluidLite]. Optional, for soundfont MIDI support.
To ease the whole process, a package of all the needed precompiled libraries has been created.
** You need the latest FluidLite source code revision from GitHub ([https://github.com/divideconcept/FluidLite/tree/37e812d31d9f6b712e4385f6134084b5803a74a3 37e812d31d9f6b712e4385f6134084b5803a74a3] at the time of writing).
All you need to do is:
* Download the precompiled libraries and the [http://www.libsdl.org/release/SDL-1.2.14-win32.zip latest SDL runtime library] - latest version is 1.2.14 at the time this was written, you can find the latest version [http://www.libsdl.org/download-1.2.php here]. Precompiled libraries:
** [http://robertmegone.com/scummvm/build/scummvm-required-libs-mingw.zip Precompiled libraries]


== Installing MinGW and MSYS ==
* [https://github.com/fribidi/fribidi FriBiDi]. Optional, for bidirectional text in languages that need it (e.g. Hebrew)
** You need the latest FriBiDi source code ([https://github.com/fribidi/fribidi/releases/tag/v1.0.10 v1.0.10] at the time of writing).


Both MinGW and MSYS need to be installed and working to compile ScummVM.  
* [https://libjpeg-turbo.org/ libjpeg-turbo]. Optional, for JPEG support.
** You need the latest libjpeg-turbo source code ([https://sourceforge.net/projects/libjpeg-turbo/files/2.1.0/libjpeg-turbo-2.1.0.tar.gz/download v2.1.0] at the time of writing).


* Create a directory called mingw in the root directory of drive (ie C:\MinGW\ )
* [http://liba52.sourceforge.net/ liba52]. Optional, for AC-3 support.
* Extract the mingw packages to the mingw directory, in the following order!
** You need the latest liba52 source code ([http://liba52.sourceforge.net/files/a52dec-0.7.4.tar.gz v0.7.4] at the time of writing).
** gcc-core
** gcc-g++
** binutils (Overwrite any existing files)
** mingw-runtime
** w32api
* 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


* [https://tls.mbed.org/ mbedTLS]. Optional, for cloud support.
** You need the latest mbedTLS source code ([https://github.com/ARMmbed/mbedtls/archive/v2.26.0.tar.gz v2.26.0] at the time of writing).


=== Additional information about MinGW and Windows Vista ===
* [https://curl.se/ libcurl]. Optional, for cloud support.
** You need the latest libcurl source code ([https://curl.se/download/curl-7.77.0.tar.xz v7.77.0] at the time of writing).


In order to get MinGW properly working under Windows Vista, you need to do the following:
* [https://github.com/nigels-com/glew GLEW]. Optional, for hardware acceleration in 3D games.
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.  
** You need the latest GLEW source code ([https://github.com/nigels-com/glew/tree/glew-2.2.0 v2.2.0] at the time of writing).


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
==== 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 [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://downloads.scummvm.org/frs/build/scummvm-required-libs-mingw.zip Precompiled libraries]
* Extract them to your MinGW directory (e.g. C:\MinGW)


== 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".
For more information, check the [http://www.mingw.org/mingwfaq.shtml#faq-msys MinGW FAQ page]




Line 121: Line 139:
=== 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".  
Unzip the nasm archive in a folder, and copy both files to MinGW's bin directory.


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 ===
=== pkg-config-lite ===


SDL is already compiled and needs no further changes, so we can skip the compilation step for it
Unzip the pkg-config-lite archive in a folder, and copy the "bin" and "share" to MinGW's root directory.




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.
=== SDL1 ===


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


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


Unzip the source code in a folder, open MSYS, go to the zlib folder and issue this command to compile the library:
Note the README [http://www.libsdl.org/extras/win32/mingw32/README.txt here], especially the need to include the DirectX development headers 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.


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
=== SDL2 ===


Note that a prebuilt version of SDL2 is required since MinGW32 doesn't have all the necessary Windows SDK headers.


You can do this using Explorer or by typing these commands in MSYS inside the zlib folder:
Unzip the SDL2 archive in a folder, open MSYS, go to the SDL2 folder and issue this command to install the library:


  cp -p libz.a /mingw/lib
  make install-package arch=i686-w64-mingw32 prefix=/mingw
cp -p zlib.h zconf.h /mingw/include




=== libogg ===
=== libogg ===


libogg should be compiled before libvorbis and libFLAC
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 the library:
 
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
  ./configure --disable-shared --prefix=/mingw
  make
  make
 
  make install
To install the library, type:
  make install prefix=/mingw




=== 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 and install the library:


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


To install the library, type:
make install prefix=/mingw


=== libmad ===
Unzip the libmad archive in a folder, open MSYS and go to the libmad folder and issue these commands to compile and install the library:
sed -i '/-fforce-mem/d' configure
./configure --disable-shared --prefix=/mingw
make
make install


=== libmad ===


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


  ./configure --disable-shared
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
 
  make install
To install the library, type:
  make install prefix=/mingw




=== 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 and install the library:


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


To install the library, type:
 
  make install prefix=/mingw
=== FluidLite ===
 
Unzip the fluidlite archive in a folder, open MSYS, go to the fluidlite folder and issue these commands to compile and install the library:
 
  cmake -G "MSYS Makefiles" -DFLUIDLITE_BUILD_SHARED=OFF -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
make
make install




=== 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 and install the library:


  ./configure --disable-shared
  ./configure --disable-shared --prefix=/mingw
make pnglibconf.h
sed -i 's/\x0D//' pnglibconf.h
  make
  make
make install
=== giflib ===
Unzip the giflib archive in a folder, open MSYS, go to the giflib folder and issue these commands to compile and install the library:


To install the library, type:
  ./configure --disable-shared --prefix=/mingw
  make install prefix=/mingw
make
make install




=== 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 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:
./bootstrap
./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 apply the following patch:
 
<syntaxhighlight lang="diff">
--- fribidi.pc.in.orig  2020-07-05 20:17:23 +0100
+++ fribidi.pc.in      2020-08-30 17:17:43 +0100
@@ -9,5 +9,4 @@
Description: Unicode Bidirectional Algorithm Library
Version: @VERSION@
Libs: -L${libdir} -lfribidi
-Cflags: -I${includedir}/@PACKAGE@
-CFLAGS.private: -DFRIBIDI_LIB_STATIC
+Cflags: -I${includedir}/@PACKAGE@ -DFRIBIDI_LIB_STATIC
</syntaxhighlight>
 
Then 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 -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
make
make install
 
 
=== liba52 ===
 
Unzip the liba52 archive into a folder, open MSYS, go to the liba52 folder and issue these commands to compile and install the library:
 
rm -f autotools/{config.guess,config.sub,install-sh,ltmain.sh,missing,mkinstalldirs} {autotools,doc,include,liba52,libao,src,test,vc++,.}/Makefile.in include/config.h.in include/stamp-h.in aclocal.m4 configure
sed -i -e '/AC_C_ALWAYS_INLINE/d' -e 's/-mcpu/-mtune/' configure.in
autoreconf -fi
./configure --disable-shared --prefix=/mingw
make
make install
 
 
=== SDL_net ===
 
Unzip the SDL_net archive in a folder, open MSYS, go to the SDL_net folder and apply the following patch:
 
<syntaxhighlight lang="diff">
--- SDL_net.pc.in.orig  2012-01-15 16:20:10 +0000
+++ SDL_net.pc.in      2020-08-30 17:42:19 +0100
@@ -7,5 +7,5 @@
Description: net library for Simple DirectMedia Layer
Version: @VERSION@
Requires: sdl >= @SDL_VERSION@
-Libs: -L${libdir} -lSDL_net
+Libs: -L${libdir} -lSDL_net @INETLIB@
Cflags: -I${includedir}/SDL
</syntaxhighlight>
 
Then issue these commands to compile and install the library:


  ./configure --disable-shared --disable-examples
  ./configure --disable-shared --prefix=/mingw
  make
  make
make install
=== SDL2_net ===
Unzip the SDL2_net archive in a folder, open MSYS, go to the SDL2_net folder and apply the following patch:
<syntaxhighlight lang="diff">
--- SDL2_net.pc.in.orig 2016-01-03 07:57:09 +0000
+++ SDL2_net.pc.in      2020-08-30 17:45:28 +0100
@@ -7,5 +7,5 @@
Description: net library for Simple DirectMedia Layer
Version: @VERSION@
Requires: sdl2 >= @SDL_VERSION@
-Libs: -L${libdir} -lSDL2_net
+Libs: -L${libdir} -lSDL2_net @INETLIB@
Cflags: -I${includedir}/SDL2
EOF
</syntaxhighlight>
Then issue these commands to compile and install the library:
./configure --disable-shared --prefix=/mingw
make
make install
=== mbedTLS ===
Unzip the mbedTLS archive in a folder, open MSYS, go to the mbedtls folder and apply the following patch:
<syntaxhighlight lang="diff">
--- library/platform_util.c.orig        2020-12-10 12:55:25 +0000
+++ library/platform_util.c    2021-03-08 23:59:37 +0000
@@ -92,9 +92,11 @@
  * threading.h. However, this macro is not part of the Mbed TLS public API, so
  * we keep it private by only defining it in this file
  */
-#if ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) )
+#if ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) || \
+      ( defined(__MINGW32__) && !defined(__MINGW64_VERSION_MAJOR) )
#define PLATFORM_UTIL_USE_GMTIME
-#endif /* ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) */
+#endif /* ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) || \
+            (defined(__MINGW32__) && !defined(__MINGW64_VERSION_MAJOR) ) */
#endif /* !( ( defined(_POSIX_VERSION) && _POSIX_VERSION >= 200809L ) ||    \
              ( defined(_POSIX_THREAD_SAFE_FUNCTIONS ) &&                    \
@@ -103,7 +105,7 @@
struct tm *mbedtls_platform_gmtime_r( const mbedtls_time_t *tt,
                                      struct tm *tm_buf )
{
-#if defined(_WIN32) && !defined(EFIX64) && !defined(EFI32)
+#if defined(_WIN32) && !defined(PLATFORM_UTIL_USE_GMTIME)
    return( ( gmtime_s( tm_buf, tt ) == 0 ) ? tm_buf : NULL );
#elif !defined(PLATFORM_UTIL_USE_GMTIME)
    return( gmtime_r( tt, tm_buf ) );
</syntaxhighlight>
Then issue these commands to compile and install the library:
CPPFLAGS=-D_WIN32_WINNT=0x400 cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release -DENABLE_PROGRAMS=OFF -DENABLE_TESTING=OFF .
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:
CPPFLAGS=-D_WIN32_WINNT=0x400 ./configure --disable-shared --prefix=/mingw --with-winssl --with-mbedtls --disable-pthreads --disable-ldap
make
make install
=== GLEW ===
Unzip the GLEW archive in a folder, open MSYS, go to the GLEW folder and apply the following patch:
<syntaxhighlight lang="diff">
--- config/Makefile.mingw.orig  2017-07-31 12:25:39 +0100
+++ config/Makefile.mingw      2020-12-10 20:23:36 +0000
@@ -5,8 +5,7 @@
LN :=
LDFLAGS.GL = -lopengl32 -lgdi32 -luser32 -lkernel32
LDFLAGS.EXTRA = -L/mingw/lib
-CFLAGS.EXTRA  += -fno-builtin -fno-stack-protector
-LDFLAGS.EXTRA += -nostdlib
+CFLAGS.EXTRA  += -fno-builtin -fno-stack-protector -Wno-cast-function-type
WARN = -Wall -W
POPT = -O2
BIN.SUFFIX = .exe
@@ -14,4 +13,4 @@
LIB.DEVLNK    = lib$(NAME).dll.a  # for mingw this is the dll import lib
LIB.SHARED    = $(NAME).dll
LIB.STATIC    = lib$(NAME).a      # the static lib will be broken
-LDFLAGS.SO    = -shared -Wl,-soname,$(LIB.SONAME) -Wl,--out-implib,lib/$(LIB.DEVLNK)
+LDFLAGS.SO    = -nostdlib -shared -Wl,-soname,$(LIB.SONAME) -Wl,--out-implib,lib/$(LIB.DEVLNK)
</syntaxhighlight>
Then issue these commands to compile and install the library:
make install.all GLEW_PREFIX=/mingw GLEW_DEST=/mingw GLEW_NO_GLU=-DGLEW_NO_GLU


To install the library, type:
make install prefix=/mingw


== Compiling ScummVM ==
== Compiling ScummVM ==
Line 223: Line 450:


  strip scummvm.exe
  strip scummvm.exe
== Compiling with Console/Text Output ==
By default ScummVM now compiles with console output. If for some reason you do NOT want console output (which was the default behavior until recently), use the follow flag when running the configure script:
./configure --disable-windows-console


== Ready to go! ==
== Ready to go! ==


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

Latest revision as of 20:20, 9 August 2021

NOTE
Compiling with MinGW is not working out of the box. It is recommended that you use MinGW-w64 instead, which is far easier to set up and get working.

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. See also MinGW-w64.

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

  • SDL2.
    • You need the latest SDL2 development libraries: (v2.0.14 at the time of writing).
  • SDL2_net. Optional, for network support.
    • You need the latest SDL2_net source code (v2.0.1 at the time of writing).
  • SDL_net 1.2. Optional, for network support on Windows 95/98/ME.
    • You need the latest SDL_net source code (v1.2.8 at the time of writing).
  • NASM. Optional, for faster compile of scalers
    • You need the latest Win32 binary (v2.15.05 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.5 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.10.0 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).
  • giflib. Optional, for GIF support.
  • freetype. Optional, for TTF support.
    • You need the latest freetype source code (v2.10.4 at the time of writing).
  • 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.1.0 at the time of writing).
  • liba52. Optional, for AC-3 support.
    • You need the latest liba52 source code (v0.7.4 at the time of writing).
  • mbedTLS. Optional, for cloud support.
    • You need the latest mbedTLS source code (v2.26.0 at the time of writing).
  • libcurl. Optional, for cloud support.
    • You need the latest libcurl source code (v7.77.0 at the time of writing).
  • GLEW. Optional, for hardware acceleration in 3D games.
    • You need the latest GLEW source code (v2.2.0 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:
  • Extract them to your MinGW directory (e.g. C:\MinGW)

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".


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.


SDL1

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

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

Note the README here, especially the need to include the DirectX development headers from here to ensure that the "dsound" rather than the "waveout" / "winmm" fallback audio driver is used.


SDL2

Note that a prebuilt version of SDL2 is required since MinGW32 doesn't have all the necessary Windows SDK headers.

Unzip the SDL2 archive in a folder, open MSYS, go to the SDL2 folder and issue this command to install the library:

make install-package arch=i686-w64-mingw32 prefix=/mingw


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 and go to the libmad folder and issue these commands to compile and install the library:

sed -i '/-fforce-mem/d' configure
./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


FluidLite

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

cmake -G "MSYS Makefiles" -DFLUIDLITE_BUILD_SHARED=OFF -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
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


giflib

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

./configure --disable-shared --prefix=/mingw
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:

./bootstrap
./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 apply the following patch:

--- fribidi.pc.in.orig  2020-07-05 20:17:23 +0100
+++ fribidi.pc.in       2020-08-30 17:17:43 +0100
@@ -9,5 +9,4 @@
 Description: Unicode Bidirectional Algorithm Library
 Version: @VERSION@
 Libs: -L${libdir} -lfribidi
-Cflags: -I${includedir}/@PACKAGE@
-CFLAGS.private: -DFRIBIDI_LIB_STATIC
+Cflags: -I${includedir}/@PACKAGE@ -DFRIBIDI_LIB_STATIC

Then 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 -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
make
make install


liba52

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

rm -f autotools/{config.guess,config.sub,install-sh,ltmain.sh,missing,mkinstalldirs} {autotools,doc,include,liba52,libao,src,test,vc++,.}/Makefile.in include/config.h.in include/stamp-h.in aclocal.m4 configure
sed -i -e '/AC_C_ALWAYS_INLINE/d' -e 's/-mcpu/-mtune/' configure.in
autoreconf -fi
./configure --disable-shared --prefix=/mingw
make
make install


SDL_net

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

--- SDL_net.pc.in.orig  2012-01-15 16:20:10 +0000
+++ SDL_net.pc.in       2020-08-30 17:42:19 +0100
@@ -7,5 +7,5 @@
 Description: net library for Simple DirectMedia Layer
 Version: @VERSION@
 Requires: sdl >= @SDL_VERSION@
-Libs: -L${libdir} -lSDL_net
+Libs: -L${libdir} -lSDL_net @INETLIB@
 Cflags: -I${includedir}/SDL

Then issue these commands to compile and install the library:

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


SDL2_net

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

--- SDL2_net.pc.in.orig 2016-01-03 07:57:09 +0000
+++ SDL2_net.pc.in      2020-08-30 17:45:28 +0100
@@ -7,5 +7,5 @@
 Description: net library for Simple DirectMedia Layer
 Version: @VERSION@
 Requires: sdl2 >= @SDL_VERSION@
-Libs: -L${libdir} -lSDL2_net
+Libs: -L${libdir} -lSDL2_net @INETLIB@
 Cflags: -I${includedir}/SDL2
EOF

Then issue these commands to compile and install the library:

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


mbedTLS

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

--- library/platform_util.c.orig        2020-12-10 12:55:25 +0000
+++ library/platform_util.c     2021-03-08 23:59:37 +0000
@@ -92,9 +92,11 @@
  * threading.h. However, this macro is not part of the Mbed TLS public API, so
  * we keep it private by only defining it in this file
  */
-#if ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) )
+#if ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) || \
+      ( defined(__MINGW32__) && !defined(__MINGW64_VERSION_MAJOR) )
 #define PLATFORM_UTIL_USE_GMTIME
-#endif /* ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) */
+#endif /* ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) || \
+             (defined(__MINGW32__) && !defined(__MINGW64_VERSION_MAJOR) ) */

 #endif /* !( ( defined(_POSIX_VERSION) && _POSIX_VERSION >= 200809L ) ||     \
              ( defined(_POSIX_THREAD_SAFE_FUNCTIONS ) &&                     \
@@ -103,7 +105,7 @@
 struct tm *mbedtls_platform_gmtime_r( const mbedtls_time_t *tt,
                                       struct tm *tm_buf )
 {
-#if defined(_WIN32) && !defined(EFIX64) && !defined(EFI32)
+#if defined(_WIN32) && !defined(PLATFORM_UTIL_USE_GMTIME)
     return( ( gmtime_s( tm_buf, tt ) == 0 ) ? tm_buf : NULL );
 #elif !defined(PLATFORM_UTIL_USE_GMTIME)
     return( gmtime_r( tt, tm_buf ) );

Then issue these commands to compile and install the library:

CPPFLAGS=-D_WIN32_WINNT=0x400 cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release -DENABLE_PROGRAMS=OFF -DENABLE_TESTING=OFF .
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:

CPPFLAGS=-D_WIN32_WINNT=0x400 ./configure --disable-shared --prefix=/mingw --with-winssl --with-mbedtls --disable-pthreads --disable-ldap
make
make install


GLEW

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

--- config/Makefile.mingw.orig  2017-07-31 12:25:39 +0100
+++ config/Makefile.mingw       2020-12-10 20:23:36 +0000
@@ -5,8 +5,7 @@
 LN :=
 LDFLAGS.GL = -lopengl32 -lgdi32 -luser32 -lkernel32
 LDFLAGS.EXTRA = -L/mingw/lib
-CFLAGS.EXTRA  += -fno-builtin -fno-stack-protector
-LDFLAGS.EXTRA += -nostdlib
+CFLAGS.EXTRA  += -fno-builtin -fno-stack-protector -Wno-cast-function-type
 WARN = -Wall -W
 POPT = -O2
 BIN.SUFFIX = .exe
@@ -14,4 +13,4 @@
 LIB.DEVLNK    = lib$(NAME).dll.a   # for mingw this is the dll import lib
 LIB.SHARED    = $(NAME).dll
 LIB.STATIC    = lib$(NAME).a       # the static lib will be broken
-LDFLAGS.SO    = -shared -Wl,-soname,$(LIB.SONAME) -Wl,--out-implib,lib/$(LIB.DEVLNK)
+LDFLAGS.SO    = -nostdlib -shared -Wl,-soname,$(LIB.SONAME) -Wl,--out-implib,lib/$(LIB.DEVLNK)

Then issue these commands to compile and install the library:

make install.all GLEW_PREFIX=/mingw GLEW_DEST=/mingw GLEW_NO_GLU=-DGLEW_NO_GLU


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

Compiling with Console/Text Output

By default ScummVM now compiles with console output. If for some reason you do NOT want console output (which was the default behavior until recently), use the follow flag when running the configure script:

./configure --disable-windows-console

Ready to go!

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