Open main menu
ScummVM :: Wiki

Difference between revisions of "Compiling ScummVM/Windows CE"

Compiling ScummVM/Windows CE (view source)

Revision as of 00:24, 5 December 2011

1,854 bytes removed ,  00:24, 5 December 2011
no edit summary
Line 1: Line 1:
So you want to roll your own binary for the ScummVM [[Windows CE]] port?
So you want to roll your own binary for the ScummVM [[Windows CE]] port?
The first thing to ask yourself is do you really need to compile it?
The first thing to ask yourself is do you really need to compile it?
The official PocketScumm binaries are "good enough" for more than the average user.
The official ScummVM for Windows CE binaries are "good enough" for more than the average user.
Also, bear in mind that the compilation procedure is seldom as simple as
Also, bear in mind that the compilation procedure is seldom as simple as
unpack-build and that, probably, you'll have to know your way around
unpack-build and that, probably, you'll have to know your way around
projects, makefiles and editing appropriately the source files.<br/>
makefiles and editing appropriately the source files.<br/>
Still reading? Good :-)<br/>
Still reading? Good :-)<br/>
Many people are put off by the sheer volume of work which has to take place
Many people are put off by the sheer volume of work which has to take place
Line 10: Line 10:
Things are not that bad though as, hopefully, this document tries to describe.
Things are not that bad though as, hopefully, this document tries to describe.
More than often you may find that once you set up you build environment
More than often you may find that once you set up you build environment
right, there's only minimal work to be done to build any version of PocketScumm.
right, there's only minimal work to be done to build any version of ScummVM for Windows CE.
Alright, ready? Let's go :-)
Alright, ready? Let's go :-)


== Get your gear together ==
== Get your gear together ==
The first thing you need to do is decide on the compiler and grab all required
libraries.


=== Compilers ===
=== Compilers ===
Over the years, the compiler used to build ScummVM WinCE has changed several times. The following lists which version requires which compiler(s):
Over the years, the compiler used to build ScummVM WinCE has changed several times. The following lists which version requires which compiler(s):


* Versions '''before''' 0.9.0 use the Microsoft Embedded Visual C development environment. More specifically you can use either [http://www.microsoft.com/downloads/details.aspx?familyid=f663bf48-31ee-4cbe-aac5-0affd5fb27dd&displaylang=en evc3] or [http://www.microsoft.com/downloads/details.aspx?familyid=4a4ed1f4-91d3-4dbe-986e-a812984318e5&displaylang=en evc4] for those versions. Most of the following instructions for building with VS2005 adhere to these builds as well.
* Versions '''before''' 0.9.0 use the Microsoft Embedded Visual C development environment. More specifically you could use either [http://www.microsoft.com/downloads/details.aspx?familyid=f663bf48-31ee-4cbe-aac5-0affd5fb27dd&displaylang=en evc3] or [http://www.microsoft.com/downloads/details.aspx?familyid=4a4ed1f4-91d3-4dbe-986e-a812984318e5&displaylang=en evc4] for those versions.
* Version 0.9.x supports two ways to compile:
* Version 0.9.x supported two ways to compile:
** Using [http://msdn.microsoft.com/windowsmobile/downloads/tools/install/default.aspx Microsoft Visual Studio 2005], or
** Using [http://msdn.microsoft.com/windowsmobile/downloads/tools/install/default.aspx Microsoft Visual Studio 2005], or
** Using the [http://download.videolan.org/pub/testing/wince/ Windows CE GCC cross compiler] developed by the [http://www.videolan.org/vlc/ VLC] team ('''do not''' rush to download and install this compiler. It needs to be rebuilt first. More on this [[Compiling_ScummVM/Windows_CE/Old_GCC|on this page]]).
** Using the [http://download.videolan.org/pub/testing/wince/ Windows CE GCC cross compiler] developed by the [http://www.videolan.org/vlc/ VLC] team ('''do not''' rush to download and install this compiler. It needs to be rebuilt first. More on this [[Compiling_ScummVM/Windows_CE/Old_GCC|on this page]]).
* Version 0.10.x builds with the VLC GCC cross compiler.
* Version 0.10.x builds with the VLC GCC cross compiler.
* Version 0.11.x and newer use the [http://cegcc.sf.net/ cegcc] GCC cross compiler. We try not to break builds with VS2005 but this can in no way be guaranteed as we do not longer use those tools. With some minor tweaking the code should be able to compile with VS tools too.
* Version 0.11.x and newer use the [http://cegcc.sf.net/ cegcc] GCC cross compiler.
* Version 1.0 and newer use the [http://cegcc.sf.net/ mingw32ce] GCC cross compiler. This is only compiler being supported now. You may succeed in compiling with VS2005, but this is beyond the scope of these instructions.


Why all these compiler changes? There are absolutely critical reasons for switching between them.  
Why all these compiler changes? There are absolutely critical reasons for switching between them.  
Line 38: Line 36:
Also, note that [http://msdn.microsoft.com/vstudio/express/ Visual Studio Express] (which is free) does
Also, note that [http://msdn.microsoft.com/vstudio/express/ Visual Studio Express] (which is free) does
not support Windows CE (at least at the time of writing this).
not support Windows CE (at least at the time of writing this).
Further, the latest change from our semi-custom VLC GCC port to cegcc is mandated because building dlls which are required by the plugins is broken in the former. Fortunately we do not perceive any more compiler changes in the future. CEGCC is well maintained and even if it is not updated in the future (which seems unlikely) it is a darn good wince cross compiler as it is :-)
Further, the change from our semi-custom VLC GCC port to cegcc was mandated because building dlls which are required by the plugins is broken in the former. Finally we have switched to mingw32ce, which does not use the unix compatibility layer which cegcc brings along as we don't need it.


=== Libraries ===
=== Libraries ===
Line 45: Line 43:
These are:
These are:


* [http://flac.sourceforge.net/ FLAC] 1.1.0
* [http://wss.co.uk/pinknoise/tremolo/ Tremolo] 0.7
: Lossless audio compression for sound files.
: Tremolo is an ARM optimized version of the Tremor lib from [http://www.xiph.org/ xiph.org]. For those that don't know, the Tremor lib is an integer only library for doing Ogg Vorbis decompression.
* [http://libmpeg2.sourceforge.net/ mpeg2dec] 0.4.0
* [http://www.underbit.com/products/mad/ mad] 0.15.1b
: Decoding of MPEG-2 video content.
* [http://www.xiph.org/vorbis/ Tremor]
: Fixed point implementation of the OGG Vorbis algorithm, also for sound files.
* [http://www.underbit.com/products/mad/ mad] 0.14.2b
: MP3 sound files.
: MP3 sound files.
* [http://www.libsdl.org/ SDL] 1.2.6
* [http://www.libsdl.org/ SDL] 1.2.6
: Handles all backend screen drawing.
: Handles all backend screen drawing.
* [http://www.zlib.net/ zlib] 1.2.1
* [http://www.zlib.net/ zlib] 1.2.5
: Compressing/Decompressing files.
: Compressing/Decompressing files.


[[user:Arisme|Arisme]] has done and excellent job in porting all these libraries to Windows CE,
[[user:Arisme|Arisme]] and [[user:Jubanka|Knakos]] have done an excellent job in porting all these libraries to Windows CE, along the process of porting ScummVM itself. Lately, this job is being done by [[user:CeRiAl|CeRiAl]].
along the process of porting ScummVM itself.


For Microsoft toolchain builds, you can find all of them on [http://arisme.free.fr/ports/ his webpage]
Furthermore, the libraries need to be patched in order to successfully compile.
both in source/patch form and as pre-built binaries.
The patches are available [http://pocketinsanity.org/scummvm/libraries/ here] and are '''accumulated'''.
Usually, you don't need to rebuild these libraries so we recommend to use
the binaries.
To relieve you even further from the hassle, we have prepared a precompiled lib/header
pack which is available [http://users.uoa.gr/~knakos/scummvm/libraries/old/vs2005_libpack.zip here].
This package contains all that is peripheral to ScummVM and is required for builds.
 
For GCC toolchain builds, the libraries need to be further patched in order
to successfully compile.
The patches are available [http://users.uoa.gr/~knakos/scummvm/libraries/ here] and are '''accumulated'''.
This means that are direct patches to the original source versions of the libraries,
This means that are direct patches to the original source versions of the libraries,
that they include Arisme's patches and are ''not'' incremental to them.
that they include Arisme's, Knakos' and CeRiAl's patches and are ''not'' incremental to them.
A precompiled lib/header pack is available for GCC builds as well and
A precompiled lib/header pack is available as well and
you can find it right [http://users.uoa.gr/~knakos/scummvm/libraries/release-1-0-0rc1/wince-gcc-libs.tar.bz2 here].
you can find it right [http://pocketinsanity.org/scummvm/libraries/release-1-5-0/wince-gcc-libs.tar.bz2 here].


Please note that many of those libraries have been officially ported to WinCE
Please note that some of those libraries have been officially ported to WinCE
after the work done by Arisme or, newer versions are available for them.
after the work done by Arisme/Knakos/CeRiAl or, newer versions are available for them.
We generally cannot comment on how well they will work with ScummVM.
We generally cannot comment on how well they will work with ScummVM.
The more adventurous of you may want to give them a shot, but we find
The more adventurous of you may want to give them a shot, but we find
that these work well enough for our purposes.
that these work well enough for our purposes.


== Compiling using Microsoft tools ==
== Compiling using the mingw32ce GCC toolchain ==
 
* Build libraries from source
If you downloaded prebuilt libraries, you may skip this step.
We will not document the process of compiling individual libraries.
Generally, you should download the source and patch from Arisme's site,
perform the patch and use the included project files to build.
 
* Place library files in appropriate places.
You need two things: The library header files (*.h) and the actual
libraries (*.lib).
There's no place in particular where it would be good to put these files.
Just make sure that the VS compiler's ''additional include directories''
option points additionally to the directory (-ies) where your library
header files live, and the linker's ''additional library directories''
to the *.lib files directory (-ies).
For ScummVM 0.9.1, the VS2005 files assume that the directories <tt>lib</tt>
and <tt>libinclude</tt> are situated in <tt>backends/wince/missing</tt>.
 
* Open the Project
For versions older than 0.9.1, project files can be found in directories
<tt>dists/msevc3</tt> and <tt>dists/msevc4</tt> of the source tree.
For 0.9.1 the project files are in <tt>dists/msvc8-wince</tt>.
Open <tt>PocketScumm.vcw</tt> or <tt>PocketScumm.sln</tt>, whatever is applicable.
In the workspace that opens you should be able to see several projects,
the main one being the "scummvm" project and the others being the
scummvm engines which are built as libraries.<br/>
A common problem which occurs here stems from the requirement
that the project files '''have to''' be in ''CR/LF'' format, or else
the tools will error out with various errors while opening them.
(This unfortunately happens as tagging usually takes place on
a non-Windows machine ( :-) ), plus some shortcomings of CVS.
Hopefully SVN remedies this.)<br/>
Another point to note is that evc4 can "import" evc3 project files
and VS2005 can import project files from both.
 
* Build
Press F7 :-)<br/>
This is not a fool proof procedure. You may get from zero fatal compilation
errors to several thousand.
Please be patient and try to make sense of what the tool is reporting.
More than often, the very first '''error''' the tool reports is the
one you should attend to before re-trying the build.
If you can't make heads or tails out of it, you may try asking for help
in the [http://forums.scummvm.org/viewforum.php?f=6 forums], but '''*please*''' refrain from
asking if you don't know what you're doing here.
The developers cannot be burdened with the task of answering questions
for your specific build setup; the community although may provide you with answers.
 
== Compiling using the GCC toolchain ==


First, you need to download and install the [http://cegcc.sf.net/ cegcc] cross compiler. More specifically, you need the mingw32 variety (without the posix layer emulation that is). The package also includes a working gdb debugger for debugging the applications.
First, you need to download and install the [http://cegcc.sf.net/ mingw32ce] cross compiler. More specifically, you need the mingw32ce variety (without the posix layer emulation that is). You may optionally also download a working gdb debugger there for debugging the applications. Version 0.59.1 is the recommended version, your milage may vary with other versions. It's also recommended, though not mandatory, to install the toolchain to /opt/mingw32ce (in the following example we use this directory).


=== ScummVM ===
=== ScummVM ===
Line 141: Line 76:
* Build libraries from source
* Build libraries from source
You may skip this step if you downloaded the prebuilt library package.
You may skip this step if you downloaded the prebuilt library package.
Download the original library source tarball (those in Arisme's site are OK).
Download the original library source tarballs.
As an exception, get the Tremor snapshot from
Download the patches from [http://pocketinsanity.org/scummvm/libraries/ here] and patch the libraries.
[http://users.uoa.gr/~knakos/scummvm/libraries/tremor_2006_10_29.tar.bz2 here].
Please note that there is no patch available for zlib 1.2.5 as patching it is not needed any more (yay!).
Download the diffs from [http://users.uoa.gr/~knakos/scummvm/libraries/ here] and patch the libraries.
You need to ''configure'' and ''make'' each library,
You need to ''configure'' and ''make'' each library,
except the SDL library which sports a customly created (and lame :-) )
except for the SDL and Tremolo libraries which both sport a customly created (and lame :-) )
Makefile.
Makefile.
It should be sufficient to set the PATH to the following to make the toolchain usable:
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
|<tt>export PATH=/opt/mingw32ce/bin:$PATH</tt>
|}
Here are the typical parameters to the configure scripts:
Here are the typical parameters to the configure scripts:


:* FLAC:
* mad:
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
|<tt>CFLAGS="-D__stdcall= -D_WIN32_WCE=300 -I/usr/local/wince/cross-tools/include" LDFLAGS=-L/usr/local/wince/cross-tools/lib  CC=arm-wince-pe-gcc ./configure --host=arm-wince-pe --target=arm-wince-pe --without-ogg --without-xmms -without-libiconv --without-id3lib</tt>
|<tt>./configure --host=arm-mingw32ce --target=arm-mingw32ce</tt>
|}
|}


:*mad:
* libz:
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
|<tt>CFLAGS="-D__stdcall= -D_OFF_T_ -I/usr/local/wince/cross-tools/include" LDFLAGS=-L/usr/local/wince/cross-tools/lib  CC=arm-wince-pe-gcc ./configure --host=arm-wince-pe --target=arm-wince-pe --disable-nls</tt>
|<tt>CC=arm-mingw32ce-gcc AR=arm-mingw32ce-ar RANLIB=arm-mingw32ce-ranlib ./configure</tt>
|}
|}


:*mpeg2dec:
You just <tt>make</tt> each library after configuring.<br/>
The SDL and Tremolo libraries have no configuration script - you just <tt>make</tt>
 
* Place the library and include files in an appropriate place. In this example, we use /opt/mingw32ce/libraries
to keep them seperate from the toolchain's libs and headers.
Here is an overview of the needed files, where to find them inside the specific library sourcetree, and where to put them:
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
|<tt>CFLAGS="-D__stdcall= -D_OFF_T_ -I/usr/local/wince/cross-tools/include" LDFLAGS=-L/usr/local/wince/cross-tools/lib  CC=arm-wince-pe-gcc ./configure --host=arm-wince-pe --target=arm-wince-pe</tt>
|<tt><pre>mad:
/path_to_patched_mad_sources/.libs/libmad.a -> /opt/mingw32ce/libraries/lib
/path_to_patched_mad_sources/mad.h -> /opt/mingw32ce/libraries/include
 
Tremolo:
/path_to_patched_tremolo_sources/libtremolo.a -> /opt/mingw32ce/libraries/lib
/path_to_patched_tremolo_sources/config_types.h -> /opt/mingw32ce/libraries/include/tremolo
/path_to_patched_tremolo_sources/ivorbiscodec.h -> /opt/mingw32ce/libraries/include/tremolo
/path_to_patched_tremolo_sources/ivorbisfile.h -> /opt/mingw32ce/libraries/include/tremolo
/path_to_patched_tremolo_sources/ogg.h -> /opt/mingw32ce/libraries/include/tremolo
/path_to_patched_tremolo_sources/os_types.h -> /opt/mingw32ce/libraries/include/tremolo
 
zlib:
/path_to_zlib_sources/libz.a -> /opt/mingw32ce/libraries/lib
/path_to_zlib_sources/z*.h -> /opt/mingw32ce/libraries/include
 
SDL:
/path_to_patched_sdl_sources/libSDL.a -> /opt/mingw32ce/libraries/lib
/path_to_patched_sdl_sources/include/* -> /opt/mingw32ce/libraries/include/SDL/*</pre></tt>
|}
|}


:*Tremor:
* Build
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
Please note that it may be needed to change the line "<tt>_host_alias=arm-wince-mingw32ce</tt>" to "<tt>_host_alias=arm-mingw32ce</tt>" in the ScummVM configure script if the compiler is not found.
|<tt>CFLAGS="-D__stdcall= -D_OFF_T_ -I/usr/local/wince/cross-tools/include" LDFLAGS=-L/usr/local/wince/cross-tools/lib  CC=arm-wince-pe-gcc ./autogen.sh --host=arm-wince-pe --target=arm-wince-pe</tt>
For ScummVM we recommend a so called "out of source tree" build, so change to the ScummVM source directory and create a directory for that and run the configure script as following:
|}


:*libz:
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
|<tt>CFLAGS="-D__stdcall= -D_OFF_T_ -D_WIN32_WCE -D_MSC_VER=666" CC=arm-wince-pe-gcc AR="arm-wince-pe-ar cru" RANLIB=arm-wince-pe-ranlib ./configure --libdir=/usr/local/wince/cross-tools/lib --includedir=/usr/local/wince/cross-tools/include</tt>
|<tt><pre>mkdir build-mingw32ce
cd build-mingw32ce
LDFLAGS="-L/opt/mingw32ce/libraries/lib" CXXFLAGS="-I/opt/mingw32ce/libraries/include -I/opt/mingw32ce/libraries/include/SDL" \
../configure --host=wince</pre></tt>
|}
|}
''Try <tt>make libz.a</tt> for libz. Also DrMcCoy reported that he had to include "<tt>typedef long _off_t; typedef _off_t  off_t;</tt>" into <tt>unistd.h</tt>''


''WARNING: These instructions have been written with the VLC GCC compiler in mind. Exact command lines may differ slightly from these shown aboe''
Of course you may use additional configuration switches like "<tt>--enable-release</tt>" or "<tt>--enable-engine(s)=xxx/--disable--engine(s)=yyy</tt>" as you like.


The libraries should now be automatically be detected by the configuration script, check the output for the following lines; if they're present everything should be ok:


You may also have to do some minor manual edits to the config.h files.
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
(''libmad's one springs to mind, in which you have to undefine HAVE_STDINT_H'')
|<tt><pre>Checking for Tremor... yes
Checking for MAD... yes
Checking for zlib... yes
Backend... wince, savegame timestamp, HQ scalers</pre></tt>
|}


You just <tt>make</tt> each library after configuring.
Finally do a <tt>make</tt> and after a while you should have a nice and shiny <tt>scummvm.exe</tt>.
The SDL library has no configuration script - you just <tt>make</tt>
It's additionally recommended to do an "<tt>arm-mingw32ce-strip scummvm.exe</tt>" as the executable size is quite big (&gt; 85MB).


* Place library files in appropriate places.
Copy the resulting <tt>scummvm.exe</tt> along with the following files into a fresh folder on your device/emulator and give it a go:
Take a look at the Makefile to check out where the headers and libs are expected.
{| style="padding: 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em"
Currently they need to be under <tt>backends/platform/wince/libs/</tt> in directories
|<tt><pre>gui/themes/scummclassic.zip
<tt>include</tt> and <tt>lib</tt>.
gui/themes/scummmodern.zip
Also note that the Makefile expects the libraries to have somewhat more "funky" names than their default.
gui/themes/translations.dat
This has been done for compatibility reasons with the evc built libs.
dists/pred.dic
Just rename the libraries according to the Makefile, or edit the Makefile to match the default naming.
dists/engine-data/drascula.dat
 
dists/engine-data/hugo.dat
* Build
dists/engine-data/kyra.dat
cd into <tt>backends/platform/wince/</tt>, edit the Makefile to your needs (usually you don't have to do this). Finally type <tt>make dist</tt>, irrespectively whether you have enabled a plugin build or not, which invokes the required build automatically.
dists/engine-data/lure.dat
dists/engine-data/queen.tbl
dists/engine-data/sky.cpt
dists/engine-data/teenagent.dat
dists/engine-data/toon.dat</pre></tt>
|}
CeRiAl
1

edit

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/17254"