1. Common requirements
    1. Specific requirements for GNU/Linux
    2. Specific requirements for MacOS X
    3. Specific requirements for Windows
      1. Optional
      2. using Visual C++ compiler
      3. using MinGW compiler
  2. Building
    1. OWBuild
    2. Windows
      1. Environment variables
        1. Qt
        2. Platform SDK
        3. DirectX SDK
      2. Build based on Makefile
        1. with Visual C++
        2. with MinGW
    3. Linux
      1. GNU/Linux
      2. Fedora
    4. MacOS X
    5. CMake
      1. CMake standard options
      2. CMake options defined for QuteCom
      3. Browsing/editing CMake options
  3. Running
    1. Windows
    2. GNU/Linux
    3. MacOS X
  4. Installation

Common requirements

In order to build QuteCom, you need to install several components:

  • A C++ compiler
  • CMake >= 2.4.4.
  • Qt >= 4.2 with support for STL, exceptions and RTTI.
  • Boost >= 1.33 with support for:
    • unit tests
    • threading
    • serialization
    • program options
    • signals
    • date time
  • GLib >= 2.10.3

There are also some platform specific requirements listed below.

Specific requirements for GNU/Linux

The default compiler is gcc 4.0.

GCC 4.1 and Boost 1.33.x do not play nicely together, so if your version of Boost is 1.33.x **you should not use GCC 4.1**. See this mailing list post http://dev.openwengo.com/pipermail/wengophone-devel/2006-December/004731.html for more information. If GCC 4.0 is not available on your distro, you can use GCC 3.4.

Other components:

(i) We provide internal copies of the source code for these libraries if you don't have them on your system.

Note that these version numbers are version we know works correctly. If you build and run QuteCom successfully with an older version, please let us know.

Specific requirements for MacOS X

GLib and GNU TLS can be installed using Fink or MacPorts.

Specific requirements for Windows

For Windows, dlls for most dependencies are included in Subversion, so you don't need to install them manually.

There is a Windows installer for Boost libraries here

For installer you need NSIS http://nsis.sf.net (installation to default directory)

You can use either Visual C++ or MinGW to build QuteCom.

Optional

QuteCom CoipManager can produce python bindings. It requires SIP and PyQt libraries.

Sip >= 4.7.6

PyQt >= 4.4.2

using Visual C++ compiler

The most mature compiler supported is Visual C++ 2003 (version 7.1).

Visual C++ 2005 (version 8.0) is supported as well.

Visual Studio 2008 hasn't been tested yet.

Qt 4.x Open Source Edition supports only MinGW. This patch http://sourceforge.net/project/showfiles.php?group_id=49109&package_id=165202 contributed by the Qt/Win project, adds support for Visual C++. For Qt 4.4 or upper version, it's necessary to compile Qt sources. Just follow INSTALL instructions included in Qt sources.

Microsoft Platform SDK for Windows Server 2003 R2 headers and libraries are required. You can download from a web installer or fully do it from microsoft site.

Microsoft DirectX SDK headers are required. Microsoft makes a release each month of his SDK. Build has been done with Microsoft DirectX SDK August 2007 and fully succeed on our set test. Previous link is a direct download of DirectX SDK August 2007.

using MinGW compiler

MinGW 5.2 can now be used to build the whole software. Please feel free to raise any issue you may have with MinGW on the qutecom-deve mailing list. When using MinGW, you must install the Python Win32 extensions.


Building

First, you need to configure compilation, using CMake. Go inside the build dir, then make sure the Qt4 version of the qmake binary is in your path.

OWBuild

Windows

Environment variables

Environment variables must be set before performing any build. This can be done globally (in advanced panel of computer) or manually set in prompt command.

Qt

Create QTDIR environment variable which value is path of your root Qt directory,

or manually set: 

SET QTDIR=C:\Qt\qt-win-opensource-src-4.4.0

Platform SDK

Add or create (it doesn't exist by default) following system variables through advanced properties of windows:

name: INCLUDE, value: C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Include name: LIB, value: C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Lib

or manually set: 

set INCLUDE=%INCLUDE%;C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Include
set LIB=%LIB%;C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Lib

DirectX SDK

Add or create system variable INCLUDE of value C:\Program Files\Microsoft DirectX SDK (version date)\Include

or manually set: 

set INCLUDE=%INCLUDE;C:\Program Files\Microsoft DirectX SDK (version date)\Include

Build based on Makefile

with Visual C++

    cmake -DCMAKE_BUILD_TYPE=Debug -G "NMake Makefiles" ..
    nmake

or 

% cd build
% build_nmake_release.bat
% nmake

To build the installer run:

% nmake install

with MinGW

    cmake -DCMAKE_BUILD_TYPE=Debug -G "MinGW Makefiles" ..
    make

More detailed instruction can be found here: HowToBuildFromSource-Windows-MinGW

Note: If python bindings are enabled, SIP and PyQt libraries must be compiled and installed. Follow installation instructions from SIP and PyQt documentation.

Linux

GNU/Linux

    cd /path/to/qutecom/build
    cmake -DCMAKE_BUILD_TYPE=Debug /path/to/qutecom  or ./build_make.sh
    make

Fedora

specific commands to install libraries on Fedora: FedoraPlatformSupport

MacOS X

    mkdir /path/to/qutecom/builddir
    cd /path/to/qutecom/builddir
    cmake -DCMAKE_BUILD_TYPE=Debug /path/to/qutecom
    make

CMake

CMake standard options

Here is a list of the most interesting options provided out of the box by CMake.

  • CMAKE_BUILD_TYPE: The type of build (can be Debug Release MinSizeRel RelWithDebInfo)
  • CMAKE_INSTALL_PREFIX: The prefix to use when running make install (Default to /usr/local on GNU/Linux and MacOS X)
  • CMAKE_C_COMPILER: The path to the C compiler
  • CMAKE_CXX_COMPILER: The path to the C++ compiler

CMake options defined for QuteCom

QuteCom CMake options are defined in three files:

  • DefineWengoOptions.cmake: QuteCom options
  • libs/3rdparty/CMakeLists.txt: Whether to use internal or system versions of libraries
  • libs/3rdparty/portaudio/CMakeLists.txt: PortAudio options

Here is a short description of the most useful ones:

  • COPY_DATA_FILES_ON_CONFIGURE: Whether you want CMake to copy data files to the build dir when running
  • GNU/Linux options:
    • ENABLE_CRASHREPORT: If ON (the default), intercept crashes and provide a graphical interface to report information to QuteCom on crash. If OFF, just quit and dump core.
  • Windows options:
    • OWSOUND_PORTAUDIO_SUPPORT: If ON (the default), use PortAudio. If OFF, use WinMM.

Browsing/editing CMake options

In addition to passing options on the command line, you can browse and edit CMake options using cmakesetup (Windows) or ccmake (GNU/Linux and MacOS X).

  • Go to the build dir
  • On Windows: run 'cmakesetup'
  • On GNU/Linux and MacOS X: run 'ccmake .'


Running

QuteCom binary can be found in the 'build/debug' dir.

Windows

If you have problems with missing DLLs you can try use dependency walker.

GNU/Linux

If you haven't installed QuteCom (using 'make install'), you need to use the --resources option to indicate where resources are located, like this: 

        cd build/debug
        ./qutecom --resources /path/to/qutecom-2.2/qutecom/resources

MacOS X

On MacOS X, the result of the compilation is a MacOS X bundle, named QuteCom.app. You can start it with 'open debug/QuteCom.app'.

This is fine, but you won't see any logging information. If you want to see logging information you can either:

- Start QuteCom with gdb:

  • 'gdb debug/QuteCom.app'
  • Type r(return) to start

- Run this command: 'tail -f debug/QuteCom.app/Content/MacOS/log-main.txt'


Installation

On GNU/Linux, 'make install' will install the application to the destination defined by the CMAKE_INSTALL_PREFIX option.

On Windows, 'make install' will produce an NSIS based setup program.

On MacOS X, 'make install' will produce a MacOS X bundle.

This page has been written from http://trac.qutecom.com/browser/INSTALL.txt