uvgRTP RTP library uses CMake to generate build files and you must use 64-bit compiler to build uvgRTP. uvgRTP supports building with GCC, MinGW and Microsoft Visual Studio.
uvgRTP has one optional dependency in Crypto++.
uvgRTP uses Crypto++ for the SRTP/ZRTP support. With compilers that support C++17, uvgRTP uses __has_include to detect if Crypto++ is present in the file system. Thus, SRTP/ZRTP functionality is automatically disabled if crypto++ is not found in the system. If you use compiler that doesn't support __has_include, or if you have Crypto++ available but would like to disable SRTP/ZRTP anyway, you may compile uvgRTP with -DDISABLE_CRYPTO=1. See the instructions below for more details.
Install CMake and make sure it is found in PATH. On Windows, you can use Git Bash or other command terminals to the run the CMake commands.
First, create a folder for build configuration:
mkdir build && cd build
Then generate build configuration with CMake using the following command:
cmake ..
Alternatively, if you want to disable Crypto++, use command:
cmake -DDISABLE_CRYPTO=1 ..
If you are using MinGW for your compilation, add the generate parameter the generate the MinGW build configuration:
cmake -G"MinGW Makefiles" ..
NOTE: There are problems with a specific version of Visual Studio 2017 compilation due to Creators Updates resulting in target platform x64 not being available. Please use another version of Visual Studio or some other way of compiling uvgRTP if you face this issue.
After you have created the build files with CMake, open the solution and build the x64 version of uvgRTP. If you want to include Crypto++ and it is not found in PATH, you may add its headers to uvgrtp -> Properties -> C/C++ -> General -> Additional Include Directories to make sure it is included.
Add the compiled uvgRTP library and the headers in the include folder of uvgRTP (and Crypto++ library if desired) to the Visual Studio project properties of the application.
NOTE: Some application dependencies (such as Qt) may require a specific build configuration of Crypto++ to work. See more details here.
If you are using a system that does not provide build type selection later, you may need to select Debug build with:
cmake -DCMAKE_BUILD_TYPE=Debug ..
The default build type is Release.
After generating the build configuration, run the following commands to compile and install uvgRTP:
make
sudo make install
If you have compiled uvgRTP to use Crypto++, use the following command for linking:
g++ main.cc -luvgrtp -lpthread -lcryptopp
Or if you are not using Crypto++:
g++ main.cc -luvgrtp -lpthread
It is possible to silence all prints coming from uvgRTP by enabling following parameter:
cmake -DDISABLE_PRINTS=1 ..
The release commit can be specified in CMake. This slightly changes how the version is printed. This feature is mostly useful for distributing release versions. Use the following command:
cmake -DRELEASE_COMMIT=1 ..