Compiling ScummVM/Visual Studio/Compiling Libraries

From ScummVM :: Wiki
< Compiling ScummVM‎ | Visual Studio
Revision as of 03:23, 18 May 2024 by SentryWasBored (talk | contribs) (updated vcpkg section with relevant information)
Jump to navigation Jump to search

Using vcpkg package manager

If you're using Visual Studio 2015 or later, vcpkg is the simplest way to get the libraries compiled. It works similar to Linux package managers, but everything is locally compiled from source, so you always get binaries for the specific compiler and architecture you're using.

After following their installation instructions, just run the following command from the vcpkg folder to build the libraries: 

vcpkg install curl faad2 fluidsynth freetype fribidi giflib libflac libjpeg-turbo libmad libmikmod libmpeg2 libogg libpng libtheora libvorbis libvpx sdl2 sdl2-net zlib discord-rpc

Any missing libraries are optional and currently not available in vcpkg, so you will have to build them yourself if you want to enable them.

By default this will create x86 DLLs. If you want a different target, you can add "--triplet <triplet>" to the command, for example:

  • x64-windows: x64 DLLs
  • x86-windows-static-md: x86 static LIBs

Note:

when using vcpkg to compile libraries, it is important to pass the --vcpkg flag to create_project.exe during repository setup as newer versions of SDL2 locate libraries at <SDL/SDL.h> instead of <SDL.h>

not every library is compatible with every target, but they should all work as x86/x64 DLLs.

Manually compiling the needed libraries for Visual Studio yourself

Building libraries for use with Visual Studio is a complicated process. Many libraries only feature out-dated project files or have incompatible configurations for their project files. On this page we give a general introduction of the settings we used for building the libraries with Visual Studio 2015 Community Edition. Afterwards, we give a more detailed view on the process of building each individual library.

We used the following settings when compiling the libraries:

  • Run-Time Library: We use the "Multi-Threaded DLL" run-time library. For Debug configurations we use the "Multi-Threaded Debug DLL" (option "/MDd"). For Release configurations we use the "Multi-Threaded DLL" (option "/MD").
  • Link-time Code Generation: We disable LTCG for all configurations (option "/LTCG:OFF").
  • Whole Program Optimization: We disable WPO for all configurations (option "/GL-").

Please assure that any libraries you build use exactly the same configuration settings.

Special Instructions for Libraries

Here, we will take a look at libraries which need special handling when built with Visual Studio.

SDL 1.2

We used the following patch when compiling SDL 1.2, which is required for x64 support. The patch was gladly taken from the SDL mailing list. 

--- src/video/windx5/SDL_dx5video.c	Tue Oct 13 00:07:16 2009
+++ src/video/windx5/SDL_dx5video.c	Tue Nov 03 21:14:38 2009
@@ -332,7 +332,7 @@
 	{ &GUID_Key, 255, 0x8000FF0C, 0x00000000 },
 };
 
-const DIDATAFORMAT c_dfDIKeyboard = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), 0x00000002, 256, 256, KBD_fmt };
+const DIDATAFORMAT c_dfDIKeyboard = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), DIDF_RELAXIS, 256, sizeof(KBD_fmt)/sizeof(KBD_fmt[0]), KBD_fmt };
 
 
 /* Mouse */
@@ -347,7 +347,7 @@
 	{ NULL,       15, 0x80FFFF0C, 0x00000000 },
 };
 
-const DIDATAFORMAT c_dfDIMouse = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), 0x00000002, 16, 7, PTR_fmt };
+const DIDATAFORMAT c_dfDIMouse = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), DIDF_RELAXIS, sizeof(DIMOUSESTATE), sizeof(PTR_fmt)/sizeof(PTR_fmt[0]), PTR_fmt };
 
 static DIOBJECTDATAFORMAT PTR2_fmt[] = {
 	{ &GUID_XAxis, 0, 0x00FFFF03, 0x00000000 },
@@ -363,7 +363,7 @@
 	{ NULL,       19, 0x80FFFF0C, 0x00000000 }
 };
 
-const DIDATAFORMAT c_dfDIMouse2 = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), 0x00000002, 20, 11, PTR2_fmt };
+const DIDATAFORMAT c_dfDIMouse2 = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), DIDF_RELAXIS, sizeof(DIMOUSESTATE), sizeof(PTR2_fmt)/sizeof(PTR2_fmt[0]), PTR2_fmt };
 
 
 /* Joystick */
@@ -415,7 +415,7 @@
 	{ NULL, 79, 0x80FFFF0C, 0x00000000 },
 };
 
-const DIDATAFORMAT c_dfDIJoystick = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), 0x00000001, 80, 44, JOY_fmt };
+const DIDATAFORMAT c_dfDIJoystick = { sizeof(DIDATAFORMAT), sizeof(DIOBJECTDATAFORMAT), DIDF_ABSAXIS, sizeof(DIJOYSTATE), sizeof(JOY_fmt)/sizeof(JOY_fmt[0]), JOY_fmt };
 
 
 /* Initialization/Query functions */

After adding a new x64 configuration option in the project files, you may also need to remove "/MACHINE:I386" as additional linker command in Project->Properties, Configuration Properties->Linker->Command Line.

zlib

We used a custom project file when building zlib to get the old standard library name "zlib.lib". It can be found inside a zip file in the "patches/" directory of our pre-built library package. The project file was created for zlib 1.2.8.

libogg

We use the "libogg_static" solution to create a library for static linking.

libvorbis

You will need to use the "vorbis_static" solution. It should feature working x86 (Win32) and x64 (x64) targets by default.

Note: You need to assure that the headers (and libraries in case you build a dynamically linked libvorbis) of libogg are in the paths MSVC searches.

Note: The static solution can be bugged and produce a library named "libvorbisfile.lib" instead of "libvorbisfile_static.lib". You will need to fix the target name in the project settings.

Note: You'll need vorbis, vorbisfile and also vorbisenc for ScummVM tools.

libtheora

You will need to use the "libtheora_static" solution.

Note: The static solution can be bugged and produce a library named "libtheora.lib" instead of "libtheora_static.lib". You will need to fix the target name in the project settings.

libmad

You can use the "libmad" solution.

Note for x64: When you want to build a x64 library for libmad you will need to create your own x64 config for it. You can do so by easy conversion of the existing libmad solution files for x86. For Release mode you will also need to edit the preprocessor definitons via: Properties -> Configuration Properties -> C/C++ -> Preprocessor -> Preprocessor Definitions: there you will need to replace "FPM_INTEL" with "FPM_64BIT".

You will also need to apply the following patch to mad.h: 

--- mad.h	Tue Nov 03 18:29:06 2009
+++ mad.h	Tue Nov 03 18:29:14 2009
@@ -24,7 +24,11 @@
 extern "C" {
 # endif
 
+#ifdef _WIN64
+# define FPM_64BIT
+#else
 # define FPM_INTEL
+#endif

FLAC

Open the FLAC solution and build "libFLAC_static" and "win_utf8_io_static".

libfaad

We used the following patch when compiling libfaad to adjust for changes in the MSVC runtime: 

diff -ru '--exclude=*vcx*' '--exclude=*sln*' sources.orig/faad2-2.7/libfaad/common.h sources/faad2-2.7/libfaad/common.h
--- sources.orig/faad2-2.7/libfaad/common.h	2009-02-05 01:51:03.000000000 +0100
+++ sources/faad2-2.7/libfaad/common.h	2016-03-09 20:27:08.851178000 +0100
@@ -315,7 +315,7 @@
 
   #if defined(_WIN32) && !defined(__MINGW32__)
     #define HAS_LRINTF
-    static INLINE int lrintf(float f)
+    /*static INLINE int lrintf(float f)
     {
         int i;
         __asm
@@ -324,7 +324,7 @@
             fistp i
         }
         return i;
-    }
+    }*/
   #elif (defined(__i386__) && defined(__GNUC__) && \
 	!defined(__CYGWIN__) && !defined(__MINGW32__))
     #ifndef HAVE_LRINTF
diff -ru '--exclude=*vcx*' '--exclude=*sln*' sources.orig/faad2-2.7/libfaad/mp4.c sources/faad2-2.7/libfaad/mp4.c
--- sources.orig/faad2-2.7/libfaad/mp4.c	2009-02-06 04:39:58.000000000 +0100
+++ sources/faad2-2.7/libfaad/mp4.c	2016-03-09 20:27:09.200404900 +0100
@@ -32,6 +32,7 @@
 #include "structs.h"
 
 #include <stdlib.h>
+#include <string.h>
 
 #include "bits.h"
 #include "mp4.h"
diff -ru '--exclude=*vcx*' '--exclude=*sln*' sources.orig/faad2-2.7/libfaad/ps_dec.c sources/faad2-2.7/libfaad/ps_dec.c
--- sources.orig/faad2-2.7/libfaad/ps_dec.c	2009-01-26 23:32:31.000000000 +0100
+++ sources/faad2-2.7/libfaad/ps_dec.c	2016-03-09 20:27:09.233469100 +0100
@@ -33,6 +33,7 @@
 #ifdef PS_DEC
 
 #include <stdlib.h>
+#include <string.h>
 #include "ps_dec.h"
 #include "ps_tables.h"
 
diff -ru '--exclude=*vcx*' '--exclude=*sln*' sources.orig/faad2-2.7/libfaad/sbr_hfadj.c sources/faad2-2.7/libfaad/sbr_hfadj.c
--- sources.orig/faad2-2.7/libfaad/sbr_hfadj.c	2008-09-20 00:50:20.000000000 +0200
+++ sources/faad2-2.7/libfaad/sbr_hfadj.c	2016-03-09 20:27:09.400963200 +0100
@@ -40,6 +40,8 @@
 
 #include "sbr_noise.h"
 
+#include <string.h>
+
 
 /* static function declarations */
 static uint8_t estimate_current_envelope(sbr_info *sbr, sbr_hfadj_info *adj,
diff -ru '--exclude=*vcx*' '--exclude=*sln*' sources.orig/faad2-2.7/libfaad/sbr_syntax.c sources/faad2-2.7/libfaad/sbr_syntax.c
--- sources.orig/faad2-2.7/libfaad/sbr_syntax.c	2009-01-26 23:32:31.000000000 +0100
+++ sources/faad2-2.7/libfaad/sbr_syntax.c	2016-03-09 20:27:09.458518400 +0100
@@ -48,6 +48,8 @@
 #endif
 #include "analysis.h"
 
+#include <string.h>
+
 /* static function declarations */
 /* static function declarations */
 static void sbr_header(bitfile *ld, sbr_info *sbr);

Note for x64: When you want to build a x64 library for libfaad you will need to create your own x64 config for it. You can do so by easy conversion of the existing libfaad solution files for x86.

libmpeg2

We used a custom solution to build libmpeg2. It can be found inside a zip file in the "patches/" directory of our pre-built library package. The project file was created for libmpeg 0.5.1.

Retrieved from "https://wiki.scummvm.org/index.php?title=Compiling_ScummVM/Visual_Studio/Compiling_Libraries&oldid=41296"