Difference between revisions of "Compiling ScummVM/MinGW"

Jump to navigation Jump to search
3,845 bytes added ,  18:23, 6 December 2021
no edit summary
(11 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 more complicated to set up. It is recommended that you use [[Compiling_ScummVM/MinGW-w64|MinGW-w64]] or [[Compiling ScummVM/Docker|Docker]] instead, which are 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 GitHub ([https://github.com/libsdl-org/SDL-1.2/tree/99d7f1d1c5492f0fb3c799255042ca7a3f4a5de4 99d7f1d1c5492f0fb3c799255042ca7a3f4a5de4] at the time of writing).
** You need the latest SDL2 development libraries: ([https://www.libsdl.org/release/SDL2-devel-2.0.18-mingw.tar.gz v2.0.18] at the time of writing).
 
* [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/d3fc4db464827a7aa0e5a7c4bcb921709c343c9f d3fc4db464827a7aa0e5a7c4bcb921709c343c9f] 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.
* [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 28: Line 42:
** 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).
** 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, FluidLite and mbedTLS.
** You need the latest Win32 installer.
** You need the latest Win32 installer.


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 52: Line 66:
* [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.4.tar.xz v2.10.4] at the time of writing).
** You need the latest freetype source code ([http://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.xz v2.11.1] 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/acc2183fdcb9af2aca233bcfdafd5f657dce33f8 acc2183fdcb9af2aca233bcfdafd5f657dce33f8] 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)
** 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).
** You need the latest FriBiDi source code ([https://github.com/fribidi/fribidi/releases/tag/v1.0.11 v1.0.11] at the time of writing).


* [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.6/libjpeg-turbo-2.0.6.tar.gz/download v2.0.6] 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.2.tar.gz/download v2.1.2] 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://tls.mbed.org/ mbedTLS]. Optional, for cloud support.
** You need the latest mbedTLS source code ([https://github.com/ARMmbed/mbedtls/archive/v3.0.0.tar.gz v3.0.0] at the time of writing).


* [https://curl.se/ libcurl]. Optional, for cloud support.
* [https://curl.se/ libcurl]. Optional, for cloud support.
** You need the latest libcurl source code ([https://curl.se/download/curl-7.75.0.tar.xz 7.75.0] at the time of writing).
** You need the latest libcurl source code ([https://curl.se/download/curl-7.80.0.tar.xz v7.80.0] at the time of writing).


* [http://glew.sourceforge.net GLEW]. Optional, for hardware acceleration in 3D games.
* [https://github.com/nigels-com/glew GLEW]. Optional, for hardware acceleration in 3D games.
** You need the latest GLEW source code ([https://sourceforge.net/projects/glew/files/glew/2.1.0/ v2.1.0] at the time of writing).
** 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 80: Line 100:
** [http://downloads.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 137: 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 145: 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 172: Line 189:
=== libmad ===
=== libmad ===


Unzip the libmad archive in a folder, open MSYS and 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 200: 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 247: 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 271: Line 264:
=== freetype ===
=== 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:
Unzip the freetype archive in a folder, open MSYS, go to the freetype folder and apply the following patch:
 
<syntaxhighlight lang="diff">
diff --git a/builds/windows/ftsystem.c b/builds/windows/ftsystem.c
index 1ebadd49ff8254414906ef1538b4b54ac0950941..20fe9f1916849ead5e472076a0e1b1625f0e17d6 100644
--- a/builds/windows/ftsystem.c
+++ b/builds/windows/ftsystem.c
@@ -233,6 +233,10 @@
                        dwFlagsAndAttributes, hTemplateFile );
  }
+#endif /* _WIN32_WCE */
+
+#if defined _WIN32_WCE || defined _WIN32_WINDOWS || \
+    !defined _WIN32_WINNT || _WIN32_WINNT <= 0x0400
  FT_LOCAL_DEF( BOOL )
  GetFileSizeEx( HANDLE        hFile,
@@ -248,7 +252,7 @@
      return TRUE;
  }
-#endif /* _WIN32_WCE */
+#endif
  /* documentation is in ftobjs.h */
</syntaxhighlight>
 
Then issue these commands to compile and install the library:


  ./configure --disable-shared --prefix=/mingw
  ./configure --disable-shared --prefix=/mingw
Line 341: Line 363:


  ./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 347: Line 432:
=== libcurl ===
=== 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:
Unzip the curl archive in a folder, open MSYS, go to the curl folder and apply the following patch:
 
<syntaxhighlight lang="diff">
--- lib/vtls/schannel_verify.c.orig    2021-11-01 09:40:00 +0000
+++ lib/vtls/schannel_verify.c  2021-12-06 15:19:38 +0000
@@ -222,11 +222,12 @@
{
  CURLcode result;
  HANDLE ca_file_handle = INVALID_HANDLE_VALUE;
-  LARGE_INTEGER file_size;
+  ULARGE_INTEGER file_size;
  char *ca_file_buffer = NULL;
  TCHAR *ca_file_tstr = NULL;
  size_t ca_file_bufsize = 0;
  DWORD total_bytes_read = 0;
+  DWORD last_error = NO_ERROR;
 
  ca_file_tstr = curlx_convert_UTF8_to_tchar((char *)ca_file);
  if(!ca_file_tstr) {
@@ -261,12 +262,14 @@
    goto cleanup;
  }
 
-  if(!GetFileSizeEx(ca_file_handle, &file_size)) {
+  file_size.u.LowPart = GetFileSize(ca_file_handle, &file_size.u.HighPart);
+  last_error = GetLastError();
+  if(file_size.u.LowPart == INVALID_FILE_SIZE && last_error != NO_ERROR) {
    char buffer[STRERROR_LEN];
    failf(data,
          "schannel: failed to determine size of CA file '%s': %s",
          ca_file,
-          Curl_winapi_strerror(GetLastError(), buffer, sizeof(buffer)));
+          Curl_winapi_strerror(last_error, buffer, sizeof(buffer)));
    result = CURLE_SSL_CACERT_BADFILE;
    goto cleanup;
  }
</syntaxhighlight>
 
Then 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-schannel --with-mbedtls --disable-pthreads --disable-ldap
  make
  make
  make install
  make install
Line 382: Line 505:
Then issue these commands to compile and install the library:
Then issue these commands to compile and install the library:


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




Line 397: Line 520:
== Compiling with Console/Text Output ==
== Compiling with Console/Text Output ==


By default ScummVM is compiled as a Windows subsystem application with no console output. If you need the console, you will need to apply the following patch:
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 following flag when running the configure script:
<syntaxhighlight lang="diff">
./configure --disable-windows-console
diff --git a/configure b/configure
 
index 838c759b75..04cfd361dd 100755
== Compiling with Windows 95/98/ME support ==
--- a/configure
+++ b/configure
@@ -6070,6 +6070,9 @@ case $_host_os in
append_var CXXFLAGS "-fdata-sections"
append_var LDFLAGS "-Wl,--gc-sections"
;;
+ mingw*)
+ LIBS=`echo $LIBS | sed -e 's/-mconsole//g' -e 's/-mwindows//g'`
+ ;;
n64)
# Move some libs down here, otherwise some symbols requires by libvorbis aren't found
# during linking stage
</syntaxhighlight>


Save it to your root directory and apply it with <code>patch -p1 -i path-to-patch.diff</code>.
By default, ScummVM builds using this method require Windows XP or later. If you want compatibility with older versions of Windows, use the following commands to compile ScummVM:
SDL_CONFIG=sdl-config ./configure --disable-windows-unicode --disable-flac --disable-libcurl
make


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