@note To use the OpenCV library you have two options: @ref tutorial_windows_install_prebuilt or
@ref tutorial_windows_install_build. While the first one is easier to complete, it only works if you are coding
with the latest Microsoft Visual Studio IDE and doesn't take advantage of the most advanced
with the latest Microsoft Visual Studio IDE and do not take advantage of the most advanced
technologies we integrate into our library. .. _Windows_Install_Prebuild:
Installation by Using the Pre-built Libraries {#tutorial_windows_install_prebuilt}
...
...
@@ -70,7 +70,7 @@ of them, you need to download and install them on your system.
you have in your system's CPU.
-[Intel Integrated Performance Primitives (*IPP*)](http://software.intel.com/en-us/articles/intel-ipp/) may be used to improve the performance
of color conversion, Haar training and DFT functions of the OpenCV library. Watch out, since
this isn't a free service.
this is not a free service.
-[Intel IPP Asynchronous C/C++](http://software.intel.com/en-us/intel-ipp-preview) is currently focused delivering Intel Graphics
support for advanced image processing and computer vision functions.
- OpenCV offers a somewhat fancier and more useful graphical user interface, than the default one
...
...
@@ -89,7 +89,7 @@ of them, you need to download and install them on your system.
*OpenCV documentation*.
Now we will describe the steps to follow for a full build (using all the above frameworks, tools and
libraries). If you do not need the support for some of these you can just freely skip this section.
libraries). If you do not need the support for some of these, you can just freely skip this section.
### Building the library
...
...
@@ -102,19 +102,19 @@ libraries). If you do not need the support for some of these you can just freely
which you need only to unpack to get access to the console version of Git. Supposing that for
some of us it could be quite enough.
-# Install [TortoiseGit](http://code.google.com/p/tortoisegit/wiki/Download). Choose the 32 or 64 bit version according to the type of OS you work in.
While installing, locate your msysgit (if it doesn't do that automatically). Follow the
While installing, locate your msysgit (if it does not do that automatically). Follow the
wizard -- the default options are OK for the most part.
-# Choose a directory in your file system, where you will download the OpenCV libraries to. I
recommend creating a new one that has short path and no special charachters in it, for example
`D:/OpenCV`. For this tutorial I'll suggest you do so. If you use your own path and know, what
you're doing -- it's OK.
recommend creating a new one that has short path and no special characters in it, for example
`D:/OpenCV`. For this tutorial, I will suggest you do so. If you use your own path and know, what
you are doing -- it is OK.
-# Clone the repository to the selected directory. After clicking *Clone* button, a window will
appear where you can select from what repository you want to download source files
(<https://github.com/opencv/opencv.git>) and to what directory (`D:/OpenCV`).
-# Push the OK button and be patient as the repository is quite a heavy download. It will take
some time depending on your Internet connection.
-# In this section I will cover installing the 3rd party libraries.
-# In this section, I will cover installing the 3rd party libraries.
-# Download the [Python libraries](http://www.python.org/downloads/) and install it with the default options. You will need a
couple other python extensions. Luckily installing all these may be automated by a nice tool
called [Setuptools](http://pypi.python.org/pypi/setuptools#downloads). Download and install
...
...
@@ -129,7 +129,7 @@ libraries). If you do not need the support for some of these you can just freely
it inside a directory on your system. For example let there be `D:/OpenCV/dep`. For installing
the [Intel Integrated Performance Primitives (*IPP*)](http://software.intel.com/en-us/articles/intel-ipp/)
the story is the same. For
exctracting the archives I recommend using the [7-Zip](http://www.7-zip.org/) application.
extracting the archives, I recommend using the [7-Zip](http://www.7-zip.org/) application.
...
...
@@ -209,8 +209,8 @@ libraries). If you do not need the support for some of these you can just freely
Select all the packages you want to use and press again the *Configure* button. For an easier
overview of the build options make sure the *Grouped* option under the binary directory
selection is turned on. For some of the packages CMake may not find all of the required files or
directories. In case of these CMake will throw an error in its output window (located at the
bottom of the GUI) and set its field values, to not found constants. For example:
directories. In case of these, CMake will throw an error in its output window (located at the
bottom of the GUI) and set its field values to not found constants. For example:
...
...
@@ -229,14 +229,14 @@ libraries). If you do not need the support for some of these you can just freely
Furthermore, you need to select what part of OpenCV you want to build.
- *BUILD_DOCS* -\> It creates two projects for building the documentation of OpenCV (there
will be a separate project for building the HTML and the PDF files). Note that these aren't
will be a separate project for building the HTML and the PDF files). Note that these are not
built together with the solution. You need to make an explicit build project command on
these to do so.
- *BUILD_EXAMPLES* -\> OpenCV comes with many example applications from which you may learn
most of the libraries capabilities. This will also come handy to easily try out if OpenCV is
fully functional on your computer.
- *BUILD_PACKAGE* -\> Prior to version 2.3 with this you could build a project that will
build an OpenCV installer. With this you can easily install your OpenCV flavor on other
build an OpenCV installer. With this, you can easily install your OpenCV flavor on other
systems. For the latest source files of OpenCV, it generates a new project that simply
creates a zip archive with OpenCV sources.
- *BUILD_SHARED_LIBS* -\> With this you can control to build DLL files (when turned on) or
...
...
@@ -245,11 +245,11 @@ libraries). If you do not need the support for some of these you can just freely
test projects is also a good way to try out, that the modules work just as expected on your
system too.
- *BUILD_PERF_TESTS* -\> There are also performance tests for many OpenCV functions. If
you're concerned about performance, build them and run.
you are concerned about performance, build them and run.
- *BUILD_opencv_python* -\> Self-explanatory. Create the binaries to use OpenCV from the
Python language.
Press again the *Configure* button and ensure no errors are reported. If this is the case you
Press again the *Configure* button and ensure no errors are reported. If this is the case, you
can tell CMake to create the project files by pushing the *Generate* button. Go to the build
directory and open the created **OpenCV** solution. Depending on just how much of the above
options you have selected the solution may contain quite a lot of projects so be tolerant on the
...
...
@@ -258,16 +258,16 @@ libraries). If you do not need the support for some of these you can just freely
In the end you can observe the built binary files inside the bin directory:
In the end, you can observe the built binary files inside the bin directory:
For the documentation, you need to explicitly issue the build commands on the *doxygen* project for
the HTML docuementation. It will call *Doxygen* to do
the HTML documentation. It will call *Doxygen* to do
all the hard work. You can find the generated documentation inside the `build/doc/doxygen/html`.
To collect the header and the binary files, that you will use during your own projects, into a
separate directory (simillary to how the pre-built binaries ship) you need to explicitly build
separate directory (similarly to how the pre-built binaries ship) you need to explicitly build
the *Install* project.
...
...
@@ -278,13 +278,13 @@ libraries). If you do not need the support for some of these you can just freely
To test your build just go into the `Build/bin/Debug` or `Build/bin/Release` directory and start
a couple of applications like the *contours.exe*. If they run, you are done. Otherwise,
something definitely went awfully wrong. In this case you should contact us at our [Q&A forum](http://answers.opencv.org/).
If everything is okay the *contours.exe* output should resemble the following image (if
If everything is okay, the *contours.exe* output should resemble the following image (if
built with Qt support):
@note
If you use the GPU module (CUDA libraries) make sure you also upgrade to the latest drivers of
If you use the GPU module (CUDA libraries), make sure you also upgrade to the latest drivers of
your GPU. Error messages containing invalid entries in (or cannot find) the nvcuda.dll are
caused mostly by old video card drivers. For testing the GPU (if built) run the
*performance_gpu.exe* sample application.
...
...
@@ -295,15 +295,17 @@ Set the OpenCV environment variable and add it to the systems path {#tutorial_wi
First we set an environment variable to make easier our work. This will hold the build directory of
our OpenCV library that we use in our projects. Start up a command window and enter:
@code
setx -m OPENCV_DIR D:\OpenCV\Build\x86\vc10 (suggested for Visual Studio 2010 - 32 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x64\vc10 (suggested for Visual Studio 2010 - 64 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x86\vc11 (suggested for Visual Studio 2012 - 32 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x64\vc11 (suggested for Visual Studio 2012 - 64 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x86\vc12 (suggested for Visual Studio 2013 - 32 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x64\vc12 (suggested for Visual Studio 2013 - 64 bit Windows)
setx -m OPENCV_DIR D:\OpenCV\Build\x64\vc14 (suggested for Visual Studio 2015 - 64 bit Windows)
@endcode
Here the directory is where you have your OpenCV binaries (*extracted* or *built*). You can have
different platform (e.g. x64 instead of x86) or compiler type, so substitute appropriate value.
Inside this you should have two folders called *lib* and *bin*. The -m should be added if you wish
Inside this, you should have two folders called *lib* and *bin*. The -m should be added if you wish
to make the settings computer wise, instead of user wise.
If you built static libraries then you are done. Otherwise, you need to add the *bin* folders path
...
...
@@ -314,7 +316,7 @@ However, to do this the operating system needs to know where they are. The syste
a list of folders where DLLs can be found. Add the OpenCV library path to this and the OS will know
where to look if he ever needs the OpenCV binaries. Otherwise, you will need to copy the used DLLs
right beside the applications executable file (*exe*) for the OS to find it, which is highly
unpleasent if you work on many projects. To do this start up again the [PathEditor](http://www.redfernplace.com/software-projects/patheditor/) and add the
unpleasant if you work on many projects. To do this start up again the [PathEditor](http://www.redfernplace.com/software-projects/patheditor/) and add the
following new entry (right click in the application to bring up the menu):
@code
%OPENCV_DIR%\bin
...
...
@@ -325,7 +327,7 @@ following new entry (right click in the application to bring up the menu):
Save it to the registry and you are done. If you ever change the location of your build directories
or want to try out your applicaton with a different build all you will need to do is to update the
or want to try out your application with a different build, all you will need to do is to update the
OPENCV_DIR variable via the *setx* command inside a command window.
Now you can continue reading the tutorials with the @ref tutorial_windows_visual_studio_Opencv section.
