Compiling

This page describes how to build MRPT from sources. If you want instead to install the binaries and getting quickly into developing your MRPT-based applications, go to the download page and grab the binaries for your system or install via apt in Ubuntu.

1. Dependencies
2. Build using cmake
- Using the console
- Using cmake-gui
3. CMake build options
4. Special instructions for other compilers

1. Dependencies 

Minimum compiler requisites:

A modern C++17 compiler: gcc (>=7) or clang (>=4).
Windows: Visual Studio 2017 version 15.3 or newer.
cmake (>=3.8)
Eigen (>=3.3) required.
Other libraries: See External library dependencies and build options
On SIMD optimizations, read: doxid-simd

Windows

CMake (Mandatory)

Install the CMake build system from here.

wxWidgets (Optional, but recommended)

In addition to the following notes, read the wxWidgets wiki.

From the latest wxWidgets release, download either:

precompiled binaries: the wxWidgets-3.x.x_Headers.7z file, and one of wxMSW-3.x.x-vcXXX_Dev.7z or wxMSW-3.x.x_gccXXX_Dev.7z files depending on your compiler, its version and the target architecture (x86 if not specified or x64). Unpack both files into the same directory so that include and lib directories are at the same level after unpacking. and (as .zip or .7z) from its download page. Decompress it in a directory where CMake can easily find it (e.g. C:\wxWidgets); or
the source code file wxWidgets-3.x.x.7z (more work to do, but compatibility is ensured with all compilers).

OpenCV (Optional, but strongly recommended)

Download the latest OpenCV release either as source code and compile it, or (easier) install the provided opencv-x.y.z-vcZZ.exe installer.

FFmpeg for Win32 (Optional)

These libraries are optional, you will need them only if you plan to read from video files or IP cameras using mrpt::hwdrivers::CFFMPEG_InputStream.

Directly download and decompress anywhere in your disk the latest Win32 builds from here. Then, when running CMake (cmake-gui) for MRPT, enable MRPT_HAS_FFMPEG_WIN32, press “Configure” and then set FFMPEG_WIN32_ROOT_DIR to the directory where FFmpeg binaries have been uncompressed (e.g. c:\ffmpeg-r16537-gpl-lshared-win32).

The FFmpeg DLLs will be required at runtime by programs compiled with MRPT under Windows, so make sure the directory FFMPEG/bin is in the system PATH.

PCL, the Point Cloud Library (Optional)

Download, build and install PCL as explained in the official web.

At present, only a little functionality is provided for interaction of MRPT with PCL (check out the changelogs for details).

WinPCap (libpcap for Windows)

Used to read/write PCAP files in the Velodyne sensor classes. Download and install the WinPCap development packages and set the (advanced CMake variables) PCAP_INCLUDE_DIR and PCAP_LIBRARY to WpdPacl/Include and wpcap.lib, respectivaly.

2. Build using cmake 

Using the console 

The usual cmake stuff:

cd mrpt
mkdir build
cd build
cmake ..
cmake --build .
# To run tests:
make test_legacy  # or "make test" to see less details

Using cmake-gui 

Open cmake-gui (Available for Windows/Linux) and set the “source dir” to the root directory of the MRPT source package you have downloaded.
Set the “binary directory” to a new, empty directory where to generate the project files.
Press “configure”, check for errors, tune the options as required (read below for a description of some options) and finally click “Generate”.
Click on “open project” and build as usual.

3. CMake build options 

For all platforms/compilers:

MRPT_BUILD_APPLICATIONS : By default ON, if unchecked the applications won’t be built. Useful if you only want to build MRPT libraries. Notice that you can also always use the MRPT_BUILD_DIR/libs/MRPT_ALL_LIB.* solution (or Makefile) to achieve the same.
BUILD_xSENS: Whether to use the CMT library for interfacing xSens inertial sensors. Default is ON.
MRPT_BUILD_EXAMPLES: Whether you want to compile all the examples in the “/samples” directory. Default is OFF.
MRPT_WITH_KINECT: By default ON. Uncheck if you don’t have the required dependencies (read above for your OS).
BUILD_SHARED_LIBS: Build static libraries if set to OFF, or dynamic libraries (.so/.dll) otherwise. Default is ON, and it’s strongly recommended to always use shared libs unless you have special need for static ones.
MRPT_EIGEN_USE_EMBEDDED_VERSION: By default O, instructs MRPT to use the Eigen headers in MRPT/otherlibs/eigen3/. Uncheck if you have Eigen installed in the system and it’s visible through pkg-config. It’s recommended to uncheck this option if you have eigen3 installed in your system (today, eigen3 it’s not yet in any distro repository, that’s why it’s ON by default).
MRPT_ALWAYS_CHECKS_DEBUG: If set to ON, additional security checks will be performed at run-time in many classes. Default is OFF.
MRPT_ALWAYS_CHECKS_DEBUG_MATRICES: If set to ON, additional security checks will be performed at run-time in several Matrix operations. Default is ON.
MRPT_ENABLE_EMBEDDED_ENABLED_PROFILER: If enabled, all code blocks within macros “MRPT_BEGIN/MRPT_END” will be profiled and the statistics dumped to the console at the end of execution of any program. Default is OFF.
MRPT_HAS_ASIAN_FONTS: Enables Asian fonts in mrpt::img::CCanvas (see this page), but increases library size by 1.5Mb. Default is ON.
MRPT_HAS_SVS: To enable integration of the Videre SVS libraries to interface their stereo cameras. You’ll need the vendor libraries installed in the system before to enable this option. After setting this option to “ON”, the new configuration fields “SVS_ROOT_DIR” will appear and will be tried to be set pointing to the directory where the library is (As of Aug/2010, this option only works in GNU/Linux).
MRPT_OCCUPANCY_GRID_CELLSIZE: Can be either 8 or 16 (bits). The size of each cell in the class mrpt::slam::COccupancyGridMap2D. Default is 8 bits. More on this here.

For Windows only:

MRPT_HAS_FFMPEG_WIN32: Enable this and (after running “Configure”) then set FFMPEG_WIN32_ROOT_DIR to the directory where FFmpeg binaries have been uncompressed (e.g. “c:ffmpeg-r16537-gpl-lshared-win32”).
MRPT_HAS_BUMBLEBEE: To enable integration of the Bumblebee stereo camera SDK. You’ll need the vendor provided “Triclops” and “Digiclops” libraries. After setting this option to “ON”, the new configuration fields “BUMBLEBEE_DIGICLOPS_ROOT_DIR” and “BUMBLEBEE_TRICLOPS_ROOT_DIR” will appear where the correct corresponding paths must be entered.

For GNU GCC compiler only:

MRPT_ENABLE_LIBSTD_PARALLEL_MODE: Enables the GNU libstdc++ parallel mode (See http://gcc.gnu.org/onlinedocs/libstdc++/manual/parallel_mode.html. Default is OFF.
MRPT_ENABLE_PROFILING: Enables generation of information required for profiling. Default is OFF.
MRPT_OPTIMIZE_NATIVE: Enables optimization for the current architecture (-mtune=native). Default is OFF for old GCC versions, ON for 4.2+. If you have an old version of GCC (<4.2), this option cannot be set since it’s not recognized by the compiler. Instead, set USER_EXTRA_CPP_FLAGS to the optimization flags for your platform, for example: -march=pentium4.

Compiling

1. Dependencies

2. Build using cmake

Using the console

Using cmake-gui

3. CMake build options

4. Special instructions for other compilers

1. Dependencies 

2. Build using cmake 

Using the console 

Using cmake-gui 

3. CMake build options 

4. Special instructions for other compilers 