Difference between revisions of "Compiling ScummVM/MinGW"

Jump to navigation Jump to search
no edit summary
(13 intermediate revisions by 2 users not shown)
Line 3: Line 3:
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 16:
=== 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 Development Libraries file for Mingw32.  
** 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/27d991f356a2712feba0d7749f11807849665491 27d991f356a2712feba0d7749f11807849665491] 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 32:


* [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 48: Line 54:


* [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.
* [http://www.fluidsynth.org/ fluidsynth]. Optional, for soundfont MIDI support.
Line 63: Line 72:


* [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.0.6/libjpeg-turbo-2.0.6.tar.gz/download v2.0.6] at the time of writing).
 
* [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).


* [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.76.0.tar.xz v7.76.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 72: Line 90:
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 131: Line 139:




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


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


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


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.
Note that a prebuilt version of SDL2 is required since MinGW32 doesn't have all the necessary Windows SDK headers.


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


If you do wish to recompile SDL from source code, please note the following:
make install-package arch=i686-w64-mingw32 prefix=$PREFIX
* 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 [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.




Line 168: Line 181:
=== 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 225: Line 236:
  Description: Software SoundFont synth
  Description: Software SoundFont synth
  Version: @VERSION@
  Version: @VERSION@
  Libs: -L\${libdir} -lfluidsynth
  Libs: -L${libdir} -lfluidsynth
+Libs.private: @LIBFLUID_LIBS@
+Libs.private: @LIBFLUID_LIBS@
  Cflags: -I\${includedir}
  Cflags: -I${includedir}
</syntaxhighlight>
</syntaxhighlight>


Line 243: Line 254:
  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 276: Line 296:
=== fribidi ===
=== fribidi ===


Unzip the fribidi archive in a folder, open MSYS, go to the fribidi folder and issue these commands to compile and install the library:
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
  ./configure --disable-shared --prefix=/mingw
Line 287: Line 321:
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 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
  make install
  make install
Line 294: Line 340:
=== SDL_net ===
=== SDL_net ===


Unzip the SDL_net archive in a folder, open MSYS, go to the SDL_net folder and issue these commands to compile and install the library:
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 --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=$PREFIX -DCMAKE_BUILD_TYPE=Release -DENABLE_PROGRAMS=OFF -DENABLE_TESTING=OFF .
  make
  make
  make install
  make install
Line 305: Line 428:
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=$PREFIX GLEW_DEST=$PREFIX GLEW_NO_GLU=-DGLEW_NO_GLU




Line 319: Line 473:


  strip scummvm.exe
  strip scummvm.exe
== 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:
<syntaxhighlight lang="diff">
diff --git a/configure b/configure
index 838c759b75..04cfd361dd 100755
--- 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>.


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