forked from lagadic/visp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tutorial-install-win8.1-msvc.doc
282 lines (187 loc) · 17.9 KB
/
tutorial-install-win8.1-msvc.doc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/**
\page tutorial-install-win81-msvc Tutorial: Installation from source on Windows 8.1 with Visual C++ 2013
\tableofcontents
In this tutorial you will learn how to install ViSP from source on Windows 8.1 with Visual C++. These steps have been tested on Windows 8.1 (64 bit), with CMake 3.3.2 and Visual Studio Express 2013 but should work with any other version as well.
\note Concerning ViSP installation, we provide also other \ref tutorial.
\section install_win81_msvc_required Install prerequisities
- Visual Studio C++. Note that ViSP can also be build with Visual Studio Express that could be downloaded from http:https://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products . In this tutorial we use Visual Studio Express 2013.
\note If you want to use Visual Studio Express, you have to install <b>Express 2013 for Windows Desktop</b>. The \b Desktop version is important to work with CMake.
- CMake 2.8.3 or higher that could be download at : http:https://www.cmake.org. To install CMake, download the latest binary distribution installer for Windows. You will find it under <a href="https://cmake.org/download/">"Windows (Win32 Installer)"</a>. Install CMake just by double clicking on the binary cmake-x.y.z-win32-x86.exe you downloaded.
\section install_win81_msvc_3rdparty Install 3rd parties
ViSP is interfaced with several 3rd party libraries. The <a href="http:https://visp.inria.fr/software-architecture">complete list is provided here</a>.
\subsection install_win81_msvc_3rdparty_recommended Recommended 3rd parties
We recommend to install the following:
\subsubsection install_win81_msvc_3rdparty_gdi Windows SDK 3rd party
We recommend to install the "Windows Software Development Kit (SDK) for windows 8.1" to get the Graphical Device Interface (GDI) capabilities. The GDI is used in ViSP to display images in a window thanks to vpDisplayGDI class.
- This SDK can be downloaded from https://msdn.microsoft.com/en-us/windows/desktop/bg162891.aspx
\subsubsection install_win81_msvc_3rdparty_opencv OpenCV 3rd party
We recommend also to install OpenCV.
- From http:https://opencv.org/downloads.html download the latest OpenCV for Windows version. In our case we install \c opencv-3.0.0.exe pre-build SDK in \c C:\\OpenCV. The installer opencv-3.0.0.exe extracted all the material in \c C:\\OpenCV\\opencv.
\note OpenCV 3.0.0 windows installer contains pre-build libraries compatible with Visual C++ 2013 (in \c C:\\OpenCV\\opencv\\build\\x86\\vc12 and in \c C:\\OpenCV\\opencv\\build\\x64\\vc12 for the Win64 compiler) and also libraries compatible with Visual C++ 2012 (in \c C:\\OpenCV\\opencv\\build\\x86\\vc11 and in \c C:\\OpenCV\\opencv\\build\\x64\\vc11 for the Win64 compiler). With any other compiler version you need to build yourself OpenCV from source.
\note There is an <a href="http:https://docs.opencv.org/doc/tutorials/introduction/windows_install/windows_install.html#windows-install-prebuild">OpenCV tutorial: Installation Using the Pre-build Libraries</a> that may help if you encounter some difficulties.
- Now in order that ViSP detects OpenCV you have to set \c OpenCV_DIR environment variable. Start up a command window (in your "Start" menu click on "Run" and type in \c cmd.exe) and enter:
\code
setx OpenCV_DIR C:\OpenCV\opencv\build
\endcode
where \c C:\\OpenCV\\opencv\\build is where you have the build directory (extracted or built). Inside this folder you should have a file named \c OpenCVConfig.cmake.
- You have also to add the location of OpenCV libraries in the PATH environment variable following the indications mentioned in \ref install_win81_msvc_env_var.
\subsection install_win81_msvc_3rdparty_other Other optional 3rd parties
We give also the way to install other 3rd party libraries to enable specific capabilities.
\subsubsection install_win81_msvc_3rdparty_ogre Ogre3D 3rd party
\warning Ogre3D installation from source code described in this section is reserved to expert users.
If you are interested in augmented reality (see vpAROgre), or if you want to enable advanced visibility computation during model-based tracking (see vpMbTracker::setOgreVisibilityTest() and \ref tutorial-tracking-mb) we recommend to install Ogre3D. You can check if a <a href="http:https://www.ogre3d.org/download/sdk">prebuild SDK</A> matches your Visual C++ version, and follow the <a href="http:https://www.ogre3d.org/tikiwiki/Installing+the+Ogre+SDK">SDK installation instructions</a>. You can also install the lastest release from source. Based on our experience, this is what we recommend.
Ogre source code is hosted on <a href="https://bitbucket.org/sinbad/ogre">BitBucket</a>. On Ogre wiki you will find useful information to <a href="http:https://www.ogre3d.org/tikiwiki/tiki-index.php?page=Building+Ogre">build and install Ogre from source</a>. Hereafter we give the main steps.
<b>Ogre prerequisities</b>
- To build Ogre on Windows you will need to install the DirectX SDK. Since Windows 8, DirectX is no longer a standalone package, rather it is bundled in the Windows 8.x SDK. The latest version is the <a href="https://msdn.microsoft.com/en-us/windows/desktop/bg162891.aspx">Windows 8.1 SDK</a>.
- To get the Ogre source code but also the source code of all the dependencies hosted on BitBucket and available with Mercurial, you have to install <a href="http:https://tortoisehg.bitbucket.org">TortoiseHg</a>.
<b>Getting Ogre dependencies</b>
- A repository containing Ogre dependencies source code is available <a href="https://bitbucket.org/cabalistic/ogredeps">here at BitBucket</a>.
- Open an explorer window, and enter in TortoiseHg Clone menu. Select as source https://bitbucket.org/cabalistic/ogredeps and as destination \c C:\\Ogre\\ogredeps as in the next image:
\image html img-win8.1-ogredeps-tortoisehg.jpg
- Click on Clone button to get dependencies source code in \c C:\\Ogre\\ogredeps
<b>Building Ogre dependencies</b>
- To build the dependencies, open CMake GUI and set source code location pointing to \c C:\\Ogre\\ogredeps and build location pointing to \c C:\\Ogre\\ogredeps\\build. Select Visual Studio 12 2013 Win64 as generator, click on "Configure" button twice and then on "Generate" button. You should have something similar to the next image:
\image html img-win8.1-cmake-ogredeps.jpg
- Open \c C:\\Ogre\\ogredeps\\build\\OGREDEPS.sln solution file with Visual C++.
- In Visual, select Debug configuration and build INSTALL project:
\image html img-win8.1-msvc-build-ogredeps.jpg
\note If the build fails due to the environment variable DXSDK_DIR that is not set, see \ref known_issues_win81_msvc_ogredeps for a work arround.
- In Visual, select also Release configuration and build again INSTALL project.
- Now in \c C:\\Ogre\\ogredeps\\build\\ogredeps\\bin you will find the Cg and OIS dependencies build in Debug and Release:
\image html img-win8.1-ogredeps-explorer.jpg
- To finish dependencies installation, set OGRE_DEPENDENCIES_DIR environment variable pointing to \c C:\\Ogre\\ogredeps\\build\\ogredeps
\code
setx OGRE_DEPENDENCIES_DIR C:\Ogre\ogredeps\build\ogredeps
\endcode
<b>Getting Ogre source</b>
- From <a href="http:https://www.ogre3d.org/download/source">Ogre download page</a>, identify the last release. In our case Ogre 1.9 that is on <a href="https://bitbucket.org/sinbad/ogre/branches">BitBucket repository</a> under branch v1-9.
- Open an explorer window, and enter in TortoiseHg Clone menu. Select as source https://bitbucket.org/sinbad/ogre, as destination \c C:\\Ogre\\ogre and select revision v1-9 corresponding to the branch of the latest release as presented in the next image:
\image html img-win8.1-ogre-tortoisehg.jpg
- Click on Clone button to get Ogre source code in \c C:\\Ogre\\ogre
<b>Building Ogre source</b>
- Close and re-open CMake Gui. Set source code location pointing to \c C:\\Ogre\\ogre and build location pointing to \c C:\\Ogre\\ogre\\build. Select Visual Studio 12 2013 Win64 as generator, click on "Configure" button and then on "Generate" button. You should have something similar to the next image:
\image html img-win8.1-cmake-ogre.jpg
\note As shown in the previous image, Ogre installation folder is set to \c C:\\Ogre\\ogre\\build\\sdk.
- Open \c C:\\Ogre\\ogre\\build\\OGRE.sln solution file with Visual C++.
- In Visual, select Debug configuration and build INSTALL project.
- In Visual, select also Release configuration and build again INSTALL project.
- Now in \c C:\\Ogre\\ogre\\build\\sdk\\bin you will find all the libraries in Debug and Release configuration, including Cg and OIS dependencies there where build previously.
\image html img-win8.1-ogre-explorer.jpg
- To finish Ogre installation set OGRE_HOME environment variables to \c C:\\Ogre\\ogre\\build\\sdk location.
\code
setx OGRE_HOME C:\Ogre\ogre\build\sdk
\endcode
\section install_win81_msvc_install_visp Install ViSP from source code
\subsection install_win81_msvc_get_source Getting ViSP source code
There are different ways to get ViSP source code.
- You can download the <a href="http:https://visp.inria.fr/download">latest release</a> as a zip or a tarball. Once visp-x.y.z.tar.gz or visp-x.y.z.zip is downloaded, uncompress the file using for example <a href="http:https://www.win-rar.com">WinRAR</a>
- You can also download a <a href="http:https://visp.inria.fr/download#snapshot">daily snapshot</a>. Once visp-snapshot-yyyy-mm-dd.tar.gz is downloaded, uncompress the file using for example <a href="http:https://www.win-rar.com">WinRAR</a>
- Or you get the cutting-edge ViSP from <a href="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/lagadic/visp">GitHub repository</a> using the git command line (see \ref install_win7_tip_git):
\code
C:\ViSP> git clone https://github.com/lagadic/visp.git
\endcode
We suppose now that ViSP source is in a directory denoted \<source_dir\>, for example \c C:\\ViSP\\visp
\subsection install_win81_msvc_config Configuring ViSP from source
The goal of the configuration step is now to use CMake to produce a Visual Studio C++ solution that will be located in \<binary_dir\>, for example \c C:\\ViSP\\visp-build.
- Launch CMake (cmake-gui) and complete the \<source_dir\> and \<binary_dir\> locations as in the next image.
\image html img-cmake-win8.1-msvc-launch.jpg
- Click then on "Configure" button.
\image html img-cmake-win8.1-create-build-folder.jpg
- Click on "Yes" to create the \c C:\\ViSP\\visp-build folder.
- Select then your compiler, for example here Visual Studio Express 2013 Win64, and click on "Finish" button.
\image html img-cmake-win8.1-msvc-version.jpg
- This will start CMake configuration. As shown in the next image, GDI (Graphical Device Interface), OpenCV, Ogre and OpenMP 3rd parties are automatically detected.
\image html img-cmake-win8.1-config.jpg
- As given in the previous image, note also that the installation folder is set to \c C:\\ViSP\\visp-build\\install.
\warning If you want to change the installation forder to \c C:/Program \c Files \c (x86)/ViSP, make sure that you have administrator privileges to write in that folder.
- Click then on "Configure" button. All the red lines should disappear.
\image html img-cmake-win8.1-config-end.jpg
\note The default configuration lead to the creation of a shared library (with \c .dll extension). This is the default configuration that is recommended. If you want to create rather a static library (with \c .lib extension) you have to uncheck the \c BUILD_SHARED_LIBS option to disable DLL creation.
- To finish the configuration, click on "Generate" button.
\image html img-cmake-win8.1-msvc-generate.jpg
- Once the generation is done, in \c C:/ViSP/visp-build folder you have the Visual Studio \c VISP.sln generated solution file.
\image html img-win8.1-msvc-solution.jpg
\subsection install_win81_msvc_build Building ViSP from source
- To build ViSP just double click on \c C:/ViSP/visp-build/VISP.sln solution file. This action will open ViSP project in Visual Studio C++. As shown in the next image, by default, Visual Studio position the solution configuration to \c Debug.
\image html img-win8.1-msvc-open.jpg
- Enter menu "BUILD/Build Solution" to build ViSP.
\image html img-win8.1-msvc-build.jpg
- At the end of the build process you should have the following indicating that all the build succeeded.
\image html img-win8.1-msvc-build-end.jpg
- Now to install ViSP, build "INSTALL" project. To this end, apply a left click on "INSTALL" to select the project, then a right click to enter in the "Build" menu.
\image html img-win8.1-msvc-install.jpg
- At the end of the installation, you should have the following.
\image html img-win8.1-msvc-install-end.jpg
- As shown in the previous image, all the headers but also the generated library are copied in \c C:/ViSP/visp-build/install folder.
- This ends ViSP installation with \c Debug configuration.
- We recommend now to do the same with \c Release settings. As shown in the next image, select the \c Release configuration.
\image html img-win8.1-msvc-release.jpg
- Now, as previously, build and install ViSP again.
- At the end, in \c C:/ViSP/visp-build/install/x64/vc12/bin folder you have two versions of ViSP DLL libraries corresponding to ViSP modules; the one suffixed by "d" with debug information, the other one optimized with release compiler options.
\image html img-win8.1-explorer-install-end.jpg
\subsection install_win81_msvc_env_var Setting up PATH variable
If you built static libraries then you are done. Otherwise, if you follow this tutorial step by step you need to add the bin folders path to the systems path. This is because you will use ViSP and OpenCV libraries in form of "Dynamic-link libraries" (also known as DLL). Inside these are stored all the algorithms and information the libraries contains. The operating system will load them only on demand, during runtime. However, to do this he needs to know where they are. The systems \c PATH variable contains a list of folders where DLLs can be found. Add ViSP and OpenCV libraries path to this and the OS will know where to look if he ever needs the libraries. Otherwise, you will need to copy the used DLLs right beside the applications executable file (exe) for the OS to find it.
To modify the PATH var and add the path to ViSP library, open a cmd terminal and run:
\code
C:\> echo %PATH%
C:\> setx PATH "%PATH%;C:\ViSP\visp-build\install\x64\vc12\bin"
\endcode
Then to add the path to OpenCV 3rd party libraries location, close and re-open a cmd-terminal and run:
\code
C:\> echo %PATH%
C:\> setx PATH "%PATH%;C:\OpenCV\opencv\build\x64\vc12\bin"
\endcode
If installed, you have also to add the location of Ogre 3rd party libraries to the path. Close and re-open a cmd terminal to run:
\code
C:\> echo %PATH%
C:\> setx PATH "%PATH%;C:\Ogre\ogre\build\sdk\bin\release"
C:\> setx PATH "%PATH%;C:\Ogre\ogre\build\sdk\bin\debug"
\endcode
Then close and re-open a cmd terminal to check if the PATH var was well positioned.
\code
C:\> echo %PATH%
\endcode
\section install_win81_msvc_dataset Install ViSP dataset
Some ViSP examples and tests require data (images, video, models) that are not part of ViSP source code but available in a separate archive named \c ViSP-images-x.y.z.zip. This archive could be downloaded from http:https://visp.inria.fr/download page. We provide here after the way to install these data if you want to run ViSP examples.
Download ViSP-images-x.y.z.zip from http:https://visp.inria.fr/download and uncompress it for example in \c C:/ViSP.
\image html img-win8.1-visp-images.jpg
ViSP examples and tests are able to detect automatically the location of the requested data if you position an environment variable called \c VISP_INPUT_IMAGE_PATH. In our case, this variable should be set to \c C:\\ViSP.
\code
setx VISP_INPUT_IMAGE_PATH C:\ViSP
\endcode
\note For historical reasons \c VISP_INPUT_IMAGE_PATH should not contain the folder \c ViSP-images, but the parent folder.
From now, you can try to run ViSP examples and tests. For example, if you want to run \c \<binary dir\>/example/device/display/Debug/displayGDI.exe, open a command window, enter in the right folder, and run:
\image html img-win8.1-cmd-displayGDI.jpg
\section known_issues_win81_msvc Known issues
\subsection known_issues_win81_msvc_ogredeps Unable to build ogredeps: DXSDK_DIR missing
During ogredeps build as described in \ref install_win81_msvc_3rdparty_ogre installation you may get in Visual C++ the following error when building SDL2 project:
\code
error: DIRECTX requires $DXSDK_DIR environment variable to be set
\endcode
\image html img-win8.1-msvc-ogredeps-issue.jpg
To fix the issue:
- Quit Visual C++ and start again CMake over ogredeps project
- Disable SDL2 dependency build turning \c OGREDEPS_BUILD_SDL2 option off
\image html img-win8.1-cmake-ogredeps-issue.jpg
- Configure and generate again the project
- Open \c C:\\Ogre\\ogredeps\\build\\OGREDEPS.sln solution file with Visual C++ and try a new build as described in \ref install_win81_msvc_3rdparty_ogre
\subsection known_issues_win81_msvc_ogre_mbtracker Model-based trackers are not working with Ogre visibility ckeck
If you run \c mbtEdgeTracking.exe, \c mbtKltTracking.exe or \c mbtEdgeKltTracking.exe enabling Ogre visibility check (using "-o" option), you may encounter the following issue:
\code
C:\ViSP\visp-build\example\Tracking\Debug> mbtEdgeTracking.exe -c -o
...
OGRE EXCEPTION(6:FileNotFoundException): Cannot locate resource VTFInstancing.cg in resource group General
...
*** Initializing OIS ***
\endcode
and then a wonderful runtime issue as in the next image:
\image html img-win8.1-msvc-mbtracker-ogre-issue.jpg
It means maybe that Ogre version is not compatible with DirectX 11. This can be checked adding "-w" option to the command line:
\code
C:\ViSP\visp-build\example\Tracking\Debug> mbtEdgeTracking.exe -c -o -w
\endcode
Now the binary should open the Ogre configuration window where you have to select "OpenGL Rendering Subsystem" instead of "Direct3D11 Rendering Subsystem". Press then OK to continue and start the tracking of the cube.
\image html img-win8.1-msvc-mbtracker-ogre-opengl.jpg
\section install_win81_msvc_next Next tutorial
You are now ready to see the next \ref tutorial-getting-started that will show you how to use ViSP as a 3rd party to build your own project.
*/