Difference between revisions of "Compiling ScummVM/MinGW"

Jump to navigation Jump to search
no edit summary
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{| 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) ==
== 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]].


== Things needed ==
== Things needed ==
Line 16: Line 24:
=== Libraries needed ===
=== Libraries needed ===


* [http://www.libsdl.org/download-1.2.php SDL 1.2].  
* [https://www.libsdl.org/download-2.0.php SDL2].
** You need the latest SDL 1.2 source code revision from Mercurial ([https://hg.libsdl.org/SDL/archive/1bffae6992b0.tar.bz2 1bffae6992b0] at the time of writing).
** 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).


* [https://www.libsdl.org/projects/SDL_net/release-1.2.html SDL_net 1.2]. Optional, for network support.
* [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).
 
* [https://www.libsdl.org/projects/SDL_net/ SDL2_net]. Optional, for network support.
** 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).
 
* [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).
** 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).


Line 26: Line 40:


* [http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D NASM]. Optional, for faster compile of scalers
* [http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D NASM]. Optional, for faster compile of scalers
** You need the latest Win32 binary ([http://www.nasm.us/pub/nasm/releasebuilds/2.15.03/win32/ v2.15.03] at the time of writing).
** 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).


* [https://cmake.org/ CMake]. Optional, for compiling libjpeg-turbo.
* [https://cmake.org/ CMake]. Optional, for compiling libjpeg-turbo.
Line 35: Line 49:


* [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 source code ([https://downloads.xiph.org/releases/ogg/libogg-1.3.4.tar.xz v1.3.4] at the time of writing).
** 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).
** 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).


Line 48: Line 62:


* [https://github.com/knik0/faad2 libfaad2]. Optional, for AAC support.
* [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_9_2 v2.9.2] at the time of writing).
** 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.libpng.org/pub/png/libpng.html libpng]. Optional, for PNG support.
* [http://www.libpng.org/pub/png/libpng.html libpng]. Optional, for PNG support.
** 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).
** 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://giflib.sourceforge.net/ giflib]. Optional, for GIF support.
** You need at least [https://downloads.sourceforge.net/giflib/giflib-5.1.4.tar.gz v5.1.4].


* [http://download.savannah.gnu.org/releases/freetype/ freetype]. Optional, for TTF support.
* [http://download.savannah.gnu.org/releases/freetype/ freetype]. Optional, for TTF support.
** You need the latest freetype source code ([http://download.savannah.gnu.org/releases/freetype/freetype-2.10.2.tar.xz v2.10.2] at the time of writing).
** 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).


* [http://www.fluidsynth.org/ fluidsynth]. Optional, for soundfont MIDI support.
* [https://github.com/divideconcept/FluidLite FluidLite]. Optional, for soundfont MIDI support.
** You need at least [https://sourceforge.net/projects/fluidsynth/files/older%20releases/fluidsynth-1.0.9.tar.gz/download v1.0.9]. Newer versions than this should work, but require GTK's glib and CMAKE to build.
** You need the latest FluidLite source code revision from GitHub ([https://github.com/divideconcept/FluidLite/tree/37e812d31d9f6b712e4385f6134084b5803a74a3 37e812d31d9f6b712e4385f6134084b5803a74a3] at the time of writing).


* [https://github.com/fribidi/fribidi FriBiDi]. Optional, for bidirectional text in languages that need it (e.g. Hebrew)
* [https://github.com/fribidi/fribidi FriBiDi]. Optional, for bidirectional text in languages that need it (e.g. Hebrew)
Line 63: Line 80:


* [https://libjpeg-turbo.org/ libjpeg-turbo]. Optional, for JPEG support.
* [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.0.5/libjpeg-turbo-2.0.5.tar.gz/download v2.0.5] at the time of writing).
** 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).


* [http://liba52.sourceforge.net/ liba52]. Optional, for AC-3 support.
* [http://liba52.sourceforge.net/ liba52]. Optional, for AC-3 support.
** 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).
** 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).


* [https://curl.haxx.se/ libcurl]. Optional, for cloud support.
* [https://tls.mbed.org/ mbedTLS]. Optional, for cloud support.
** You need the latest libcurl source code ([https://curl.haxx.se/download/curl-7.71.1.tar.xz v7.71.1] at the time of writing).
** 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).
 
* [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).
 
* [https://github.com/nigels-com/glew GLEW]. Optional, for hardware acceleration in 3D games.
** 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).


==== Precompiled libraries ====
==== Precompiled libraries ====
Line 75: Line 98:
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://www.scummvm.org/frs/build/scummvm-required-libs-mingw.zip 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)
* 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 ==
== 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 134: Line 147:




=== SDL ===
=== 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:
Unzip the SDL archive in a folder, open MSYS, go to the SDL folder and issue these commands to compile and install the library:
Line 142: Line 155:
  make install
  make install


It may be necessary to modify the bin/sdl-config and lib/pkgconfig/sdl.pc files  (located under the mingw directory) which are just text. These files provide the compiler option information to ScummmVM and SDL 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.
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.


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




Line 169: Line 189:
=== 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 and go to the libmad folder and issue these commands to compile and install the library:
  sed -i '/-fforce-mem/d' configure
  sed -i '/-fforce-mem/d' configure
Then issue these commands to compile and install the library:
  ./configure --disable-shared --prefix=/mingw
  ./configure --disable-shared --prefix=/mingw
  make
  make
Line 197: Line 215:




=== FluidSynth ===
=== FluidLite ===


We use fluidsynth 1.0.9, since later versions requires GTK.
Unzip the fluidlite archive in a folder, open MSYS, go to the fluidlite folder and issue these commands to compile and install the library:


Unzip the fluidsynth archive in a folder, open MSYS, go to the fluidsynth folder and apply the following patch:
cmake -G "MSYS Makefiles" -DFLUIDLITE_BUILD_SHARED=OFF -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
 
<syntaxhighlight lang="diff">
--- 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)
--- fluidsynth.pc.in
+++ fluidsynth.pc.in
@@ -7,4 +7,5 @@
Description: Software SoundFont synth
Version: @VERSION@
Libs: -L${libdir} -lfluidsynth
+Libs.private: @LIBFLUID_LIBS@
Cflags: -I${includedir}
</syntaxhighlight>
 
Then issue these commands to compile and install the library:
./configure --disable-shared --prefix=/mingw
  make
  make
  make install
  make install
Line 244: Line 231:
  make pnglibconf.h
  make pnglibconf.h
  sed -i 's/\x0D//' 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
  make install
  make install
Line 302: Line 298:
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:
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=$PREFIX -DCMAKE_BUILD_TYPE=Release .
  cmake -G "MSYS Makefiles" -DENABLE_SHARED=OFF -DCMAKE_INSTALL_PREFIX=/mingw -DCMAKE_BUILD_TYPE=Release .
  make
  make
  make install
  make install
Line 338: Line 334:


  ./configure --disable-shared --prefix=/mingw
  ./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:
<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
  make install
  make install
Line 346: Line 405:
Unzip the curl archive in a folder, open MSYS, go to the curl folder and issue these commands to compile and install the library:
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
  CPPFLAGS=-D_WIN32_WINNT=0x400 ./configure --disable-shared --prefix=/mingw --with-winssl --with-mbedtls --disable-pthreads --disable-ldap
  make
  make
  make install
  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




Line 360: 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.
213

edits

Navigation menu