Difference between revisions of "Installing/Windows Build"

From Sumo
Jump to navigation Jump to search
Line 17: Line 17:
 
==Libraries==
 
==Libraries==
 
===Xerces-C===
 
===Xerces-C===
Up to (and including) SUMO 0.10.3 (precisely up to svn revision 6993) SUMO used Xerces-C 2.8 by default, now it uses Xerces-C 3.0.1. The changes needed to compile with a different Xerces version should be limited to changing [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/src/windows_config.h src/windows_config.h], [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/build/msvc10/Win32.props build/msvc10/Win32.props] and / or [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/build/msvc10/x64.props build/msvc10/x64.props].
+
Up to (and including) SUMO 0.10.3 (precisely up to svn revision 6993) SUMO used Xerces-C 2.8 by default, now it uses Xerces-C 3.1.1. The changes needed to compile with a different Xerces version should be limited to changing [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/src/windows_config.h src/windows_config.h], [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/build/msvc10/Win32.props build/msvc10/Win32.props] and / or [http://apps.sourceforge.net/trac/sumo/browser/trunk/sumo/build/msvc10/x64.props build/msvc10/x64.props].
 
*You just need to install [http://www.apache.org/dist/xerces/c/3/binaries/xerces-c-3.1.1-x86-windows-vc-10.0.zip the binary Xerces 3.1.1 distribution] or its [http://www.apache.org/dist/xerces/c/3/binaries/xerces-c-3.1.1-x86_64-windows-vc-10.0.zip 64bit version] for the 64bit build.
 
*You just need to install [http://www.apache.org/dist/xerces/c/3/binaries/xerces-c-3.1.1-x86-windows-vc-10.0.zip the binary Xerces 3.1.1 distribution] or its [http://www.apache.org/dist/xerces/c/3/binaries/xerces-c-3.1.1-x86_64-windows-vc-10.0.zip 64bit version] for the 64bit build.
 
*Create a environment variable XERCES pointing to your xerces-c directory, e.g.
 
*Create a environment variable XERCES pointing to your xerces-c directory, e.g.
Line 82: Line 82:
  
 
If you do or download a 64bit build, the name of the environment variable needs to be PROJ_GDAL_64.
 
If you do or download a 64bit build, the name of the environment variable needs to be PROJ_GDAL_64.
 +
 +
===ffmpeg===
 +
This is only needed, if you want to save videos directly from the sumo-gui (it currently works with the internal version only).
 +
*You just need to install [http://ffmpeg.zeranoe.com/builds/ the binary ffmpeg distributions] in the Shared and the Dev flavor. Also be sure to download all the platforms (32 and/or 64 bit) you need.
 +
*Unzip the Dev version and create a environment variable FFMPEG pointing to the  directory, e.g.
 +
set FFMPEG=D:\libs\ffmpeg-2.8.3-win32-dev.
 +
*Unzip the Share version and copy the dll-files from the bin directory to some directory which is in your PATH (last resort: into Windows' system32 directory).
 +
*For the 64bit build the name of the variable is FFMPEG_64, e.g.
 +
set FFMPEG_64=D:\libs\ffmpeg-2.8.3-win64-dev.
 +
*Probably due to a bug in Visual Studio 2010 the resulting sumo-gui works only if debugging symbols are generated (which is the default for the Debug and the Fastbuild but not for the Release)! If your executable does not start or complains about missing symbols, double check whether it is enabled in the linker settings (currently it is for the 64 bit internal release).
  
 
==SUMO==
 
==SUMO==

Revision as of 18:23, 15 December 2015

This document describes how to build SUMO under MS-Windows using only freely available (this does not mean "open source") tools. Instructions on how to build SUMO on Windows using an Open Source toolchain are included in our building on Linux pages. Please note that You may also download pre-build Windows binaries.

Please read the whole document before you start, there are some detours and shortcuts included.

If you do not need the GUI, you can skip everything concerning Fox. If you do not need precise geodata conversion, you can skip everything concerning GDAL, Proj and FWTools.

  • Download Visual C++ 2010 Express Edition (or a newer one). (There is no need to install a separate Platform SDK any longer.) If you are using Windows 8 be sure to download Visual Studio Express for Windows Desktop and not Visual Studio Express for Windows 8. Please install all the available Service Packs for visual Studio 2010 as well.
  • Download Python for Windows and install it. It is used to dynamically include the SVN revision into compilation. (The build will work without it, but you may see nasty warnings and even editor windows popping up.) Python 3 won't work, we use Python 2.7.
  • Download the Xerces-C prebuilt binaries for your Visual Studio version (for VS 2010 you need the *windows-vc-10.0.zip), the Fox sources (Version 1.6.36 is confirmed to work) and either the binary packages provided at http://www.gisinternals.com/release.php or PROJ and GDAL sources separately. You may also try FWTools (see below).
  • Note on installation paths: MSVC seems to have difficulties with include and library paths containing spaces (for instance C:\Program Files). Thus try to avoid installing any of the following libraries in such paths.

Please note that for compiling from svn either Python has to be installed on your system (which is a good idea, because also many SUMO tools are Python scripts) or you have to undefine HAVE_VERSION_H in src/windows_config.h.


Libraries

Xerces-C

Up to (and including) SUMO 0.10.3 (precisely up to svn revision 6993) SUMO used Xerces-C 2.8 by default, now it uses Xerces-C 3.1.1. The changes needed to compile with a different Xerces version should be limited to changing src/windows_config.h, build/msvc10/Win32.props and / or build/msvc10/x64.props.

set XERCES=D:\libs\xerces-c-3.1.1-x86-windows-vc-10.0.
  • Copy dll-files %XERCES%\bin\xerces-c_3_1.dll and %XERCES%\bin\xerces-c_3_1D.dll to some directory which is in your PATH (last resort: into Windows' system32 directory).
  • For the 64bit build the name of the variable is XERCES_64

Fox

  • If you do not need a GUI, you can skip this section.
  • Up to (and including) SUMO 0.10.3 (precisely up to svn revision 7025) SUMO used Fox 1.4, now it uses Fox 1.6. The building instructions are the same just replace 1.6 by 1.4 (and FOX16 by FOX14) wherever you need it.
  • Go to the Fox directory and open the VC project e.g. D:\libs\fox-1.6.36\windows\vcpp\win32.dsw.
    • If you are using the Visual Studio 10.0 Express version, it cannot convert the project directly, you will need an intermediate Visual Studio 8.0 conversion
  • Confirm the conversion to VC 10.0 and build the foxdll project as "release and debug" (if you think you might wish to use the Visual Studio debugger) version. If you want to build for the 64bit platform you need to add a new configuration to the foxdll project using the Configuration Manager.
  • You might get approximately 240 warnings and one error, which can be ignored.
  • Errors on not finding windows.h mean the SDK was not installed properly.
  • Create an environment variable FOX16 pointing to your Fox directory, e.g.
set FOX16=D:\libs\fox-1.6.36.
  • Copy dll-files %FOX16%\libs\fox-1.6.36\lib\FOXDLL-1.6.dll and %FOX16%\lib\FOXDLLD-1.6.dll to some directory which is in your PATH (last resort: into Windows' system32 directory).

PNG support in Fox

  • Warning: This is a little advanced, we were successful with libpng 1.5.2 and zlib 1.2.5
  • download zlib sources and libpng sources from [1]
  • unzip all zips
  • there is no need to build zlib
  • build pnglib by first adapting the path in <libpng>\projects\vstudio\zlib.props and then use the vstudio.sln from the same dir to build the libpng project
  • you will get a png lib and a dll in <libpng>\projects\vstudio\Debug\
  • if you want to be really sure, you can build the pngtest project as well and check the output
  • Open the Fox project solution and edit properties of foxdll
    • in the C++/General section add the <libpng> dir to the include path
    • in the C++/Preprocessor section add the HAVE_PNG_H define
    • in the Linker/Input section add the .lib file to the input
  • recompile fox and put the resulting dll together with libpng dll in your path

JPEG support in Fox

  • Warning: This is a little advanced, we were successful with jpeg 8d, the jpeg 8c which can be found at the fox-toolkit site was broken
  • download libjpeg sources from [2] and unzip it
  • open a visual studio command prompt, cd to the jpeg dir and execute
nmake /f makefile.vc setup-v10
nmake /f makefile.vc
  • you will get a libjpeg lib (and no dll!) in the <jpeg> dir
  • Open the Fox project solution and edit properties of foxdll
    • in the C++/General section add the <jpeg> dir to the include path
    • in the C++/Preprocessor section add the HAVE_JPEG_H define
    • in the Linker/Input section add the .lib file to the input
  • recompile foxdll (see above) and put the resulting dll (which has jpeg support linked statically inside) in your path

PROJ and GDAL

If you do not need transformation of geocoordinates you can disable PROJ and GDAL in build/msvc10/Win32.props and / or build/msvc10/x64.props (remove the UserMacros lines referencing the relevant *.lib files and remove the Preprocessor definitions HAVE_PROJ and/or HAVE_GDAL) and skip this section. Otherwise you have the choice between downloading the binary packages by Tamas Szekeres (preferred choice), the FWTools distribution (a little outdated) or compiling for yourself (for the adventurous). Building from source should only be necessary if you want a 64bit build or if you want to ship a copy of the SUMO executable(s) without the need to ship the FWTools as well.

Tamas Szekeres binary packages at http://www.gisinternals.com/release.php

  • Choose the latest stable release and then the binaries zip and the libs zip (links valid for MSVC10 as of 31/8/2015)
  • unzip the zips in a directory of your choice (lets say D:\libs\proj_gdal) and set PROJ_GDAL=D:\libs\proj_gdal.
  • Add %PROJ_GDAL%\bin to your PATH (or copy the contents to some directory in your PATH).

FWTools (very outdated)

  • Just execute the binary and select a target directory.
  • Create a environment variable PROJ_GDAL pointing to that directory, e.g.
set PROJ_GDAL=D:\libs\FWTools1.1.3.
  • Add %PROJ_GDAL%\bin to your PATH (or copy the contents to some directory in your PATH).

Building from source

If you want to build PROJ and GDAL yourself for some reason, please follow the relevant build instructions for PROJ and for GDAL. You then should install in a common directory and let the PROJ_GDAL variable point to it as above. You should also copy proj.dll and gdal*.dll to a directory in your PATH.

If you do or download a 64bit build, the name of the environment variable needs to be PROJ_GDAL_64.

ffmpeg

This is only needed, if you want to save videos directly from the sumo-gui (it currently works with the internal version only).

  • You just need to install the binary ffmpeg distributions in the Shared and the Dev flavor. Also be sure to download all the platforms (32 and/or 64 bit) you need.
  • Unzip the Dev version and create a environment variable FFMPEG pointing to the directory, e.g.
set FFMPEG=D:\libs\ffmpeg-2.8.3-win32-dev.
  • Unzip the Share version and copy the dll-files from the bin directory to some directory which is in your PATH (last resort: into Windows' system32 directory).
  • For the 64bit build the name of the variable is FFMPEG_64, e.g.
set FFMPEG_64=D:\libs\ffmpeg-2.8.3-win64-dev.
  • Probably due to a bug in Visual Studio 2010 the resulting sumo-gui works only if debugging symbols are generated (which is the default for the Debug and the Fastbuild but not for the Release)! If your executable does not start or complains about missing symbols, double check whether it is enabled in the linker settings (currently it is for the 64 bit internal release).

SUMO

Configuration

  • If you installed all libraries and defined the environment variables correctly there is no need for further configuration and you can skip to the build section.
  • The Visual Studio build is configured using .props files in the build/msvc10 subdirectory. If you change some settings which should apply to all subprojects, be sure to edit those files (either with a text editor or the property manager of Visual Studio) and not the project configuration (.vcxproj).
  • If you do not like to define the places of the includes and libraries via environment variables you can enter the location directly into x64.props or Win32.props (or both, depending on your target platforms). You should also disable PROJ and GDAL in those files (if you don't need them) by setting the value for the appropriate "LIB" Usermacro to the empty string.

Build

  • Open the project sumo\build\msvc10\prj.sln and build the configurations you need.

Test

  • If you plan to extend SUMO yourself, or just want to know whether everything compiled OK, it is strongly recommended to have a look at Developer/Tests. This tool makes it easier to check whether some existing functionality was broken by the extensions.

Troubleshooting

Linker reports something similar to "LINK : fatal error LNK1104: cannot open file 'C:\Program.obj'"

You probably have installed a library to a path containing white spaces in its name. In such a case, the according environment variable should be embedded in quotes (").
Example: set FOX="D:\my libs\fox-1.6.36".

Failure on pre-build event

If Visual Studio reports a failed pre-build event you can safely ignore this, unless you are building from the subversion repository. In this case you should probably install Python. Even if python is installed the file associations may be broken which causes the generation of src/version.h vial tools/build/version.py to fail. Either repair your file associations or undefine HAVE_VERSION_H in src/windows_config.h


Available configurations

The release build is used for the distribution of sumo. The Fastbuild is suitable for frequent recompilation and the Debug build allows all debugging features. Keep in mind that Texttest usually picks up the release build.

  • Release: All optimizations, assertions disabled, no debugging symbols, links against external release libs
  • Fastbuild: Fewer optimizations, assertions disabled, debugging symbols included, links against external release libs
  • Debug: No optimizations, assertions enabled, debugging symbols included, links against external debug libs

Naming Conventions: executables, built with 64bit build carry the '64' suffix. The Debug build additionally carries the suffix 'D' whereas the Fastbuild uses the 'F' suffix.