BuildingWindows

From Mumble Wiki
Revision as of 13:59, 2 August 2007 by Tonke (talk | contribs) (Download Mumble SVN)
Jump to: navigation, search

Building Mumble on Windows

Mumble has quite a few dependencies for building on Windows, and as the feature set grows, so does the list of dependencies. This page will try to detail the steps required to set up a Win32 build environment.

The paths used here equal the defaults assumed in the Mumble build files. You are free to change them, but you'll then need to change the mumble.pro file as well.

Also note, that if you are submitting a bug report for a selfbuilt executable, we expect you to either

  • Follow these instructions to the letter

or

  • Report any deviations from these instructions

Deviations means anything, from "I installed to the D: drive" to "I changed the gcc build options for Qt" or "I used another version of Speex".

Preparations

Create C:\dev, and inside that directory create a file prep.bat containing:

@echo off
SET QTDIR=C:\dev\Qt4.3.0
SET DBUSDIR=C:\dev\dbus
SET PATH=C:\dev\MinGW\bin;%QTDIR%\bin;%DBUSDIR%\bin;%PATH%

Start a new command shell (run cmd.exe) and

C:
CD \dev
prep.bat

Whenever something appears

like this

you're supposed to enter it in that command shell (or copy it from this webpage and rightclick in the command window and select Paste). When you later want to compile things, remember to call prep.bat first to set paths correctly.

Using your computer while compiling

Compilation is a almost 100% CPU bound job. The windows task switcher doesn't really understand that this isn't really an interactive application, and hence will happily make your entire desktop quite laggy just to gain 1% on the compile time. It is therefore recommended to open your task manager (Ctrl-Alt-Del), switch to Processes, locate cmd.exe, rightclick, Set Priority, BelowNormal. And answer Yes. Doing so will make sure your interactive things get priority. Note, however, that if you do other 100% cpu bound things (like play resource-intensive games), compilation will halt until you're done.

TortoiseSVN

Download the most recent version of TortoiseSVN at http://tortoisesvn.net/downloads and install it. The defaults are fine.

Download Mumble SVN

Open c:\dev, rightclick and SVN Checkout...

Repository is

https://mumble.svn.sourceforge.net/svnroot/mumble/trunk

checkout to C:\dev\mumble\

MinGW

Create a directory c:\dev\MinGW

Download the following files:

and unzip them all to the C:\dev\MinGW directory. GDB is an installer, install it to C:\dev\MinGW

cd \dev\MinGW\bin
copy mingw32-make.exe make.exe

Boost

Download http://prdownloads.sf.net/boost/boost_1_33_1.zip?download and http://prdownloads.sf.net/boost/boost-jam-3.1.13-1-ntx86.zip?download and unzip both to C:\dev\

cd \dev\boost_1_33_1
copy ..\boost-jam-3.1.13-1-ntx86\bjam.exe
bjam -s"TOOLS=mingw" --prefix=C:\dev\Boost install

This might take a while, but when done you'll have Boost installed. Note that none of the other build dependencies do themselves depend on boost, so if you want you can just continue in a new command shell (but remember to call prep.bat). Once all is done, you can safely delete the boost_1_33_1 and boost-jam directories.

Microsoft Speech SDK

Go to http://www.microsoft.com/speech/download/sdk51/ and a bit down on the page is a download button for SpeechSDK51.exe. Download and install it to C:\dev\SpeechSDK

Microsoft DirectX SDK

Go to http://msdn.microsoft.com/directx/sdk/ and download the latest SDK. Install it to c:\dev\DXSDK\

WinDBUS

At the moment, WinDBUS is broken. It just doesn't work. Or the Qt bindings doesn't work. Take your pick. Anyway, bottom line is, where it below says "-qdbus" for configure, ignore that for the time being until WinDBus is ubroken.

OpenSSL

Either

Precompile library

Download Win32 OpenSSL v0.9.8e (or newer) from http://www.slproweb.com/products/Win32OpenSSL.html Install to C:\dev\OpenSSL

Copy everything from C:\dev\OpenSSL\lib\MinGW\ to C:\dev\MinGW\lib

Similarily, copy the openssl directory from C:\dev\OpenSSL\include to C:\dev\MinGW\include

or..

Compile OpenSSL

Download the latest OpenSSL source, unpack it to c:\dev\openssl

Download and install ActiverPerl.

Open a new shell (so the path is correct), go to c:\dev\openssl\

ms\mingw

Qt

Download ftp://ftp.trolltech.com/qt/source/qt-win-opensource-src-4.3.0.zip and unzip to C:\dev. Rename the directory from qt-win-opensource-src-4.3.0 to Qt4.3.0

Go to C:\dev\Qt4.3.0\mkspecs\win32-g++ and open the file qmake.conf. Change the following lines:

QMAKE_CFLAGS_RELEASE	= -O2
QMAKE_CFLAGS_DEBUG	= -g

into

QMAKE_CFLAGS_RELEASE	= -O3 -march=pentium3 -mtune=pentium4 -mmmx -msse
QMAKE_CFLAGS_DEBUG	= -g -march=pentium3 -mtune=pentium4 -mmmx -msse

This will enable MMX and SSE instructions, and will also make sure Qt is tuned for modern architectures. It will also remove the exception threading support, which removes a few runtime dependencies.

So far, so good. However, in order to use SSE in threads, we'll need to make sure the thread stack is aligned, something neither the Windows runtime, the MinGW runtime or Qt does for us. So we'll hack this into Qt by fudging it's thread creation.

Open C:\dev\Qt4.3.0\src\corelib\thread\qthread_win.cpp in an editor. Locate the line which says

void QThread::start(Priority priority)

before this line, enter the following:

static unsigned int __attribute__((noinline, stdcall)) f_prime (void *p)
{
	return QThreadPrivate::start(p);
}
unsigned int __attribute__ ((stdcall)) QThreadStackAligned (void *p)
{
   (void)__builtin_return_address(1); // to force call frame
   asm volatile ("andl $-16,%%esp" ::: "%esp");
   return f_prime (p);
}

then, inside the ::start() function, change the line

   d->handle = (Qt::HANDLE) _beginthreadex(NULL, d->stackSize, QThreadPrivate::start,
                                           this, CREATE_SUSPENDED, &(d->id));

to read

   d->handle = (Qt::HANDLE) _beginthreadex(NULL, d->stackSize, QThreadStackAligned,
                                           this, CREATE_SUSPENDED, &(d->id));


then it's time to compile Qt

cd \dev\Qt4.3.0
configure -debug-and-release -qt-sql-sqlite -no-qt3support -no-exceptions -qt-zlib -qt-libpng -qt-libjpeg -openssl
make

This will also take quite a while.

Speex

Go to C:\dev\mumble, rightclick and SVN Checkout. Repository is http://svn.xiph.org/trunk/speex. Checkout to C:\dev\mumble\speex.

Speex will be built together with mumble and murmur.

Building Mumble and Murmur

Once all of the above is done... Open C:\dev\mumble\src\mumble\mumble.pro and remove the line which says CONFIG += asio. That is only needed for ASIO support, which requires downloads of proprietary ASIO SDK to compile.

Note that this builds the debug versions, which is what we strongly recommend to use while developing. If you want to send the binary to someone else, use make release instead, which will result in a much smaller binary with fewer dependencies.

cd \dev\mumble
qmake
make clean
make