Difference between revisions of "Compiling ScummVM/MinGW"

Compiling ScummVM/MinGW (view source)

Revision as of 08:47, 23 November 2018

3,543 bytes removed , 08:47, 23 November 2018

→‎SDL: Add note about needing to edit sdl-config / pkg-config outputs for MinGW toolchains

Digitall

TrustedUser

574

edits

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