Hugin Compiling Windows

From PanoTools.org Wiki
(Difference between revisions)
Jump to: navigation, search
(Deciding on the toolchain)
(updated build instructions for use with freely downloadable Microsoft Visual C++ 2008 Express Edition,)
Line 13: Line 13:
 
Currently, there are two methods for building hugin. Both are based on the CMake build system.
 
Currently, there are two methods for building hugin. Both are based on the CMake build system.
  
# Compilation with Microsoft Visual Studio .NET. MSVC 2003 or later is required. The recommended method is to download [http://www.microsoft.com/express/vc/ MSVC 2008 Express], and install it.
+
# Compilation with Microsoft Visual Studio .NET. MSVC 2003 or later is required. The recommended method is to download [http://www.microsoft.com/express/vc/ Microsoft Visual C++ 2008 Express Edition], and install it. For convinience I provide a ''Hugin SDK'' with precompiled libraries for MSVC 2008. It is recommended to use these, rather than to compile your own libraries.
 
# Compilation with MinGW32. This does not require the Microsoft compiler and even allows cross compilation of binaries for windows on a linux machine. Until now, only the cross compilation approach has been tried, but a building on a native system should also be possible.
 
# Compilation with MinGW32. This does not require the Microsoft compiler and even allows cross compilation of binaries for windows on a linux machine. Until now, only the cross compilation approach has been tried, but a building on a native system should also be possible.
  
The following additional programs are also required for building hugin:
+
The following additional programs are also required for building a hugin installer package:
  
 +
# [http://www.cmake.org CMake] Note that Microsoft Visual C++ 2008 Express Edition is not supported by CMake 2.4. Download the [http://www.cmake.org/HTML/Download.html#cvs Nightly CVS Windows Binary], until CMake 2.5 is released.
 
# [http://enblend.sf.net enblend 3.1]
 
# [http://enblend.sf.net enblend 3.1]
# [http://sf.net/projects/unxutils GNU make], required by hugin, not for building hugin.
+
# [http://sf.net/projects/unxutils GNU make], required by hugin, not for building hugin. (included in ''Hugin SDK'')
 
# [http://warsetup.jgaa.com/ War Setup 3]
 
# [http://warsetup.jgaa.com/ War Setup 3]
# [http://gnuwin32.sourceforge.net/packages/gettext.htm msgfmt], available as part of the GnuWin32 gettext package
+
# GNU gettext. (included in ''Hugin SDK'')
  
For both approaches, the hardest task is the compilation of the libraries required by hugin. This mainly includes wxWidgets, boost, libpano13 and OpenEXR.
+
For both MSVC and MinGW32 approaches, the hardest task is the compilation of the libraries required by hugin. This mainly includes wxWidgets, boost, libpano13 and OpenEXR.
  
= Building with Microsoft Visual Studio .Net 2003 (or later) =
+
= Building with Microsoft Visual C++ 2008 Express Edition =
  
 
For simpler installation (and less headaches during building) I have build everything against the older, multithreaded runtime libraries (\MT option), and linked all exectuables statically.
 
For simpler installation (and less headaches during building) I have build everything against the older, multithreaded runtime libraries (\MT option), and linked all exectuables statically.
Line 35: Line 36:
 
=== Downloading precompiled dependencies ===
 
=== Downloading precompiled dependencies ===
  
Easy way, download the libraries I (Pablo d'Angelo) have used from http://hugin.panotools.org/sdk/MSVC/hugin_enblend_sdk_msvc2003_v2. I have uses MSVC 2003 to create these, they might work with newer versions of MSVC, except the boost libraries. I'm sure at least boost will only work with the compiler it has been build with, and thus needs to be recompiled if you use MSVC 2005 or later.
+
This is the recommended approach.
  
If you using this compiler, you can skip building the dependencies and continue with building hugin itself.
+
Download the [http://hugin.panotools.org/sdk/MSVC/hugin_enblend_sdk_msvc2008_v1.zip ''Hugin SDK'']. and unzip it. Continue with [[#Building Hugin]].
 
+
If you are using Visual C++ 7.1 (Visual Studio 2003) or 8.0 (Visual Studio 2005), you can save a lot of time and aggravation by getting precompiled Boost libraries from [http://www.boost-consulting.com/products/free BoostConsulting].  You first download an installer program, which when run lets you choose which library variants you want to install.  For Hugin you need the multithreaded static libraries, built for the static Microsoft C runtime with the compiler you intend to use.  If you already have a Boost installation, you can just add these libraries to it, otherwise install the Boost headers too. 
+
 
+
Windows Boost libraries are named according to version, compiler and MS runtime variant (multi|single thread, static|dll) so take care that the Hugin build uses the right names.  Example:
+
  libboost_date_time-vc80-mt-s-1_34_1.lib
+
prefix 'lib' shows this is a static link library, not the import library for a Boost dll; 'vc80' says built with VC8.0; 'mt-s' built for release version of the Microsoft multithread static C runtime LIBCMT (i.e. with compiler switch '/MT') (the debug version has 'mt-sgd'); '1_34_1' built from Boost version 1.34.1 source.
+
  
 
=== Build all required dependencies from scratch ===
 
=== Build all required dependencies from scratch ===
Line 67: Line 62:
 
   #define ZIP_SUPPORT
 
   #define ZIP_SUPPORT
  
near line 90 to support ZIP compressed tiff files. To avoid nasty popup messages with the
+
near line 90 to support ZIP compressed tiff files (update: wxWidgets ships with an ancient version of libtiff, so LZW will still be disabled. The ''Hugin SDK'' additionally contains libtiff 3.8.2). To avoid nasty popup messages with the
 
command line tools we are going to build, additionally add:
 
command line tools we are going to build, additionally add:
  
Line 81: Line 76:
  
 
I never had trouble using the makefiles, maybe thats a MSVC 2005 issue? -- Pablo d'Angelo
 
I never had trouble using the makefiles, maybe thats a MSVC 2005 issue? -- Pablo d'Angelo
 
  
 
==== Building boost ====
 
==== Building boost ====
Line 90: Line 84:
  
 
This will build the boost thread library.
 
This will build the boost thread library.
 +
 +
If you are using Visual C++ 7.1 (Visual Studio 2003) or 8.0 (Visual Studio 2005), you can save a lot of time and aggravation by getting precompiled Boost libraries from [http://www.boost-consulting.com/products/free BoostConsulting].  You first download an installer program, which when run lets you choose which library variants you want to install.  For Hugin you need the multithreaded static libraries, built for the static Microsoft C runtime with the compiler you intend to use.  If you already have a Boost installation, you can just add these libraries to it, otherwise install the Boost headers too. 
 +
 +
Windows Boost libraries are named according to version, compiler and MS runtime variant (multi|single thread, static|dll) so take care that the Hugin build uses the right names.  Example:
 +
  libboost_date_time-vc80-mt-s-1_34_1.lib
 +
prefix 'lib' shows this is a static link library, not the import library for a Boost dll; 'vc80' says built with VC8.0; 'mt-s' built for release version of the Microsoft multithread static C runtime LIBCMT (i.e. with compiler switch '/MT') (the debug version has 'mt-sgd'); '1_34_1' built from Boost version 1.34.1 source.
 +
  
 
==== Building OpenEXR ====
 
==== Building OpenEXR ====
Line 116: Line 117:
 
=== Building Hugin ===
 
=== Building Hugin ===
  
Use SVN to retrieve the latest hugin sourcecode, run CMakeSetup and use this procedure:
+
Use SVN to retrieve the latest hugin sourcecode (svn root is: https://hugin.svn.sourceforge.net/svnroot/hugin/hugin/trunk), and save it to src/hugin-trunk. Remember the SVN revision, it will be needed later.
  
Place all dependencies alongside the hugin source directory. Example:
+
Place all dependencies alongside the hugin-trunk source directory. Example (versions might be slightly outdated):
  
 
  src/
 
  src/
Line 130: Line 131:
 
   make/make.exe
 
   make/make.exe
  
In this setup, the cmake build system will pick up most of the dependencies automatically. Otherwise the paths to
+
 
each dependency will have to specified manually during the following cmake step
+
Run CMakeSetup to create the MSVC project files.
 +
run CMakeSetup and use this procedure:
 +
 
 +
 
 +
If you use the ''Hugin SDK'' or have a 100% identical directory structure, CMakeSetup will pick up the dependencies automatically.
 +
Otherwise the paths to each dependency will have to specified manually during the following cmake step
  
 
# Run cmake, select hugin source and build directories. Do not choose the same directories for both source and build.
 
# Run cmake, select hugin source and build directories. Do not choose the same directories for both source and build.
# Press '''Configure''
+
# Press '''Configure''.
# fill out red fields, select appropriate library and include paths, if required. The msgfmt program can be found in the gettext package installed earlier. GNU make is also required, a Win32 port can be downloaded from http://sourceforge.net/projects/unxutils. zlib, jpeg, png and tiff libraries from the wxWidgets build can be reused. Their includes are in wxWidgets/src/(zlib|jpeg|png|tiff), and the libs are in wxWidgets/lib/vclib/wx*.lib
+
# If building is done using an SVN checkout, the SVN revision number needs to be specified manually. Press '''Configure'' again.
# If building is done using an SVN checkout, the SVN revision number needs to be specified manually.
+
# CMake will pick up the dependencies and show them to you. Press '''Configure''' again. Now the '''Ok''' button should be available. If CMake had problems picking up all dependencies (for example, if you build your own libraries). CMake will prompt you if it misses something. After some iterations, all dependencies should be picked up.
# Press '''Configure'''
+
# Press the '''Ok''' button.
# If more warnings and red lines appear, goto 3.
+
# Adjust some compiler settings in the CMAKE_C*_FLAGS entries.
+
#* Reduce debug level from \Zl to \Zd (otherwise the debug files become bigger than MSVC can handle).
+
 
# Once all fields have been filled out, the "Ok" button should be available. Press it and open the generated hugin.sln file with MSVC. Switch to Build Type to Release and start the build (press F7). After quite some time hugin should be build. In order to run hugin, it needs to be installed so that data files are in the right place. This is done by building the '''INSTALL''' project. The binaries and all required files will be installed into INSTALL/FILES subdirectory of the build directory specified during the CMake step.
 
# Once all fields have been filled out, the "Ok" button should be available. Press it and open the generated hugin.sln file with MSVC. Switch to Build Type to Release and start the build (press F7). After quite some time hugin should be build. In order to run hugin, it needs to be installed so that data files are in the right place. This is done by building the '''INSTALL''' project. The binaries and all required files will be installed into INSTALL/FILES subdirectory of the build directory specified during the CMake step.
 +
# A NSIS installer can be build by building the '''PACKAGE''' target (NSIS needs to be installed for this).
 
# Creating the .msi installer by opening INSTALL/hugin.warsetup with the WarSetup program available from http://warsetup.jgaa.com/ and clicking on the '''Build''' button.
 
# Creating the .msi installer by opening INSTALL/hugin.warsetup with the WarSetup program available from http://warsetup.jgaa.com/ and clicking on the '''Build''' button.
  
Line 149: Line 153:
  
  
<small>--[[User:Pablo|pablo]] 10:32, 28 October 2007 (CET)</small>
+
<small>--[[User:Pablo|pablo]] 18:10, 13 January 2008 (CET)</small>
 
[[Category:Software:Hugin]]
 
[[Category:Software:Hugin]]
 
[[Category:Software:Platform:Windows]]
 
[[Category:Software:Platform:Windows]]

Revision as of 19:10, 13 January 2008

NOTE: this is work in progress and not finished yet. Please add clarifications or comments for the individual steps.

Contents

Why do I want to compile hugin?

If you want to fiddle with the hugin code, test new features or help squashing bugs, and do all that on Windows, this is the guide for you. Be warned that building hugin on Windows is not a piece of cake, so only try if you know the dark sides with all the development tools involved.

For normal testers it is better to use the binary snapshots we will offer during the preparation period for hugin 0.7. This guide is designed to be a help for people who have expressed interest in build Windows version of the current hugin code on a regular basis.

This guide will describe two ways of building the latest trunk. It does not apply to the hugin code prior to 2007/10/27.

Deciding on the toolchain

Currently, there are two methods for building hugin. Both are based on the CMake build system.

  1. Compilation with Microsoft Visual Studio .NET. MSVC 2003 or later is required. The recommended method is to download Microsoft Visual C++ 2008 Express Edition, and install it. For convinience I provide a Hugin SDK with precompiled libraries for MSVC 2008. It is recommended to use these, rather than to compile your own libraries.
  2. Compilation with MinGW32. This does not require the Microsoft compiler and even allows cross compilation of binaries for windows on a linux machine. Until now, only the cross compilation approach has been tried, but a building on a native system should also be possible.

The following additional programs are also required for building a hugin installer package:

  1. CMake Note that Microsoft Visual C++ 2008 Express Edition is not supported by CMake 2.4. Download the Nightly CVS Windows Binary, until CMake 2.5 is released.
  2. enblend 3.1
  3. GNU make, required by hugin, not for building hugin. (included in Hugin SDK)
  4. War Setup 3
  5. GNU gettext. (included in Hugin SDK)

For both MSVC and MinGW32 approaches, the hardest task is the compilation of the libraries required by hugin. This mainly includes wxWidgets, boost, libpano13 and OpenEXR.

Building with Microsoft Visual C++ 2008 Express Edition

For simpler installation (and less headaches during building) I have build everything against the older, multithreaded runtime libraries (\MT option), and linked all exectuables statically.

Getting the dependencies

It is tempting to download precompiled libraries from the different projects, and use those. Be prepared that they might have been created with different compiler setting (Especially with a different runtime libraries). This can lead to hard to find and nasty problems and amount to days of depressing work (I speak from experience).

Downloading precompiled dependencies

This is the recommended approach.

Download the Hugin SDK. and unzip it. Continue with #Building Hugin.

Build all required dependencies from scratch

Download the source packages. Newer versions might work, too.

1. Download wxWidgets from http://www.wxwidgets.org, I used 2.8.4, but later version should work, too

2. Download boost from http://www.boost.org, I used 1.34_1

3. Download OpenEXR source (IlmBase and OpenEXR) from http://www.openexr.com/

4. Download panorama tools source (pano13), from http://panotools.sf.net. Use version 2.9.12 or later. Latest SVN is even better.

5. Download and install gettext installer package from http://gnuwin32.sf.net

Unpack the source packages.

Building wxWidgets

1. Open libs/wxWidgets/src/tiff/tiffconf.h in your favorite editor, and add

  #define ZIP_SUPPORT

near line 90 to support ZIP compressed tiff files (update: wxWidgets ships with an ancient version of libtiff, so LZW will still be disabled. The Hugin SDK additionally contains libtiff 3.8.2). To avoid nasty popup messages with the command line tools we are going to build, additionally add:

  #define TIF_PLATFORM_CONSOLE

2. build wxWidgets: start the MSVC command line shell (from the startmenu) and cd to the wxWidgets/build/msw. To build Unicode debug release libraries, execute the following commands:

 cd wxWidgets*/build/msw
 nmake -f makefile.vc BUILD=debug UNICODE=1 SHARED=0 RUNTIME_LIBS=static
 nmake -f makefile.vc BUILD=release UNICODE=1 SHARED=0 RUNTIME_LIBS=static

It may be more reliable to build the wxWidgets libraries with the distributed MSVC projects, as described here. When I used the commandline method several libraries were built wrong, or not at all. -- TKSharpless

I never had trouble using the makefiles, maybe thats a MSVC 2005 issue? -- Pablo d'Angelo

Building boost

Refer to the boost documentation for details, especially Build binaries from source. Download bjam exectable and place it in the boost directory. Open the MSVC Command line prompt located in Start Menu -> Programs Microsoft Visual Studio -> Utilities, change directory to the boost dir and issue

  bjam stage --with-thread

This will build the boost thread library.

If you are using Visual C++ 7.1 (Visual Studio 2003) or 8.0 (Visual Studio 2005), you can save a lot of time and aggravation by getting precompiled Boost libraries from BoostConsulting. You first download an installer program, which when run lets you choose which library variants you want to install. For Hugin you need the multithreaded static libraries, built for the static Microsoft C runtime with the compiler you intend to use. If you already have a Boost installation, you can just add these libraries to it, otherwise install the Boost headers too.

Windows Boost libraries are named according to version, compiler and MS runtime variant (multi|single thread, static|dll) so take care that the Hugin build uses the right names. Example:

 libboost_date_time-vc80-mt-s-1_34_1.lib

prefix 'lib' shows this is a static link library, not the import library for a Boost dll; 'vc80' says built with VC8.0; 'mt-s' built for release version of the Microsoft multithread static C runtime LIBCMT (i.e. with compiler switch '/MT') (the debug version has 'mt-sgd'); '1_34_1' built from Boost version 1.34.1 source.


Building OpenEXR

This is a tricky one, because the MSVC project files have been set up for DLL builds with the \MD runtime, and a custom program is used to prepare the DLLs. For the all static windows binaries, quite some changes to the MSVC project files are needed.

Build according to README_win in ilmbase-1.0.0 but changed the runtime of all projects to MT.

For all projects do:

  • set each project to static lib
  • remove OPENEXR_DLL, _USEDLL and *_EXPORTS defines
  • set runtime to MT
  • disable SSE2, to generate binaries that run on all platforms
  • remove the createDLL part of the post-build command, but keep the call to install*.cmd, such as ..\..\..\installIlmImf.cmd $(IntDir)

Apply the same procedure to the openexr-1.6 source code. Here only the IlmImf and IlmImfTest projects are needed by Hugin. Follow the same process as for IlmBase, but additionally add include path for the zlib library (inside the wxWidget/src/zlib) to the IlmImf project, and wxWidget/libs/_vc/wxzlib.lib to the IlmImfTest linker options. The tests should run without errors.

It is a good idea to create new target configurations, say HuginRelease and HuginDebug, with the Visual Studio Configuration Manager, and apply the above changes to them, so that you don't lose the original project settings. This also makes the Hugin-appropriate libraries easy to find as they will be built in directories named for the configurations. They should be installed in directories named that way, too; the install commands make those directories in the Deploy/... tree, but fail to copy the static libraries there because the dll library names are built into them. However it is easy enough to copy the libs from the build folders by hand. The ilmbase libraries must be in the Deploy tree before IlmImf is built. -- TKSharpless


Building Panotools

Building Pano13 with MSVC is described on a separate page.

Building Hugin

Use SVN to retrieve the latest hugin sourcecode (svn root is: https://hugin.svn.sourceforge.net/svnroot/hugin/hugin/trunk), and save it to src/hugin-trunk. Remember the SVN revision, it will be needed later.

Place all dependencies alongside the hugin-trunk source directory. Example (versions might be slightly outdated):

src/
  hugin-trunk
  OpenExr
  STLport-5.1.4
  boost_1_34_1
  enblend-3.1
  libpano/pano13
  wxMSW-2.8.6
  make/make.exe


Run CMakeSetup to create the MSVC project files.

run CMakeSetup and use this procedure:


If you use the Hugin SDK or have a 100% identical directory structure, CMakeSetup will pick up the dependencies automatically. Otherwise the paths to each dependency will have to specified manually during the following cmake step

  1. Run cmake, select hugin source and build directories. Do not choose the same directories for both source and build.
  2. Press 'Configure.
  3. If building is done using an SVN checkout, the SVN revision number needs to be specified manually. Press 'Configure again.
  4. CMake will pick up the dependencies and show them to you. Press Configure again. Now the Ok button should be available. If CMake had problems picking up all dependencies (for example, if you build your own libraries). CMake will prompt you if it misses something. After some iterations, all dependencies should be picked up.
  5. Press the Ok button.
  6. Once all fields have been filled out, the "Ok" button should be available. Press it and open the generated hugin.sln file with MSVC. Switch to Build Type to Release and start the build (press F7). After quite some time hugin should be build. In order to run hugin, it needs to be installed so that data files are in the right place. This is done by building the INSTALL project. The binaries and all required files will be installed into INSTALL/FILES subdirectory of the build directory specified during the CMake step.
  7. A NSIS installer can be build by building the PACKAGE target (NSIS needs to be installed for this).
  8. Creating the .msi installer by opening INSTALL/hugin.warsetup with the WarSetup program available from http://warsetup.jgaa.com/ and clicking on the Build button.

Building using MinGW

I have managed to build the older, pre GSoC 2007 version with MinGW, but still having some problems with the new trunk. Once these are resolved, I will provide instructions


--pablo 18:10, 13 January 2008 (CET)

Personal tools
Namespaces

Variants
Actions
Navigation
tools
Tools