This document describes how to build from the source code in this repo. Please note: this repo contains only headers, dispatcher, examples, and tools. In most cases an implementation must also be installed.
To build this project you will need:
- A compiler with C++11 support
- CMake 3.10 or newer
On Windows, you will also need:
- Visual Studio Build Tools 2019
- Visual C++ ATL for x86 and x64
- Visual Studio 2019
- C++ ATL for latest 'X' build tools (x86 & x64)
Build the project with the following commands:
Linux:
cd <vpl-repo-clone-location>
export VPL_INSTALL_DIR=`pwd`/../_vplinstall
mkdir _build
mkdir $VPL_INSTALL_DIR
cd _build
cmake .. -DCMAKE_INSTALL_PREFIX=$VPL_INSTALL_DIR
cmake --build . --config Release
cmake --build . --config Release --target install
Windows DOS cmd prompt:
cd <vpl-repo-clone-location>
set VPL_INSTALL_DIR=%cd%\..\_vplinstall
mkdir _build
mkdir %VPL_INSTALL_DIR%
cd _build
cmake .. -DCMAKE_INSTALL_PREFIX=%VPL_INSTALL_DIR%
cmake --build . --config Release
cmake --build . --config Release --target install
You can find the build output in the location chosen for CMAKE_INSTALL_PREFIX, VPL_INSTALL_DIR.
Additionally, helper scripts are available in the script folder to run these cmake commands.
For more details see script/README.md
You can build the project using the helper scripts with the following commands.
First, set VPL_INSTALL_DIR if you wish to override the defaults and supply your own build/install location.
cd <vpl-repo-clone-location>
script/bootstrap
script/build
script/install
The build script can take an additional argument for 32-bit builds in Windows:
script/build -A x86_32
Note that on Linux the default vpl install location is /usr/local and may require sudo for write access
Note that on Windows there may be an error with the following message:
Cannot open include file: 'atlbase.h': No such file or directory
Ensure that the ATL build tools are installed through Visual Studio and that the path to the file is on the include path that the Visual Studio compiler uses
The base package is limited to the dispatcher and samples. To use oneVPL for video processing you need to install at least one implementation. Current implementations:
- oneVPL-cpu for use on CPU
- oneVPL-intel-gpu for use on Intel Xe graphics and newer
- Media SDK for use on legacy Intel graphics
Follow the instructions on the respective repos to install the desired implementation
You can build oneVPL base and CPU implementation with the End-To-End scripts provided in the scripts folder. Refer to the script/README.md for more details regarding the scripts.
These scripts assume oneVPL and oneVPL-cpu are cloned into the same parent folder. They also assume that the prerequisites have been met for their respective platform
Note: .bat versions are also provided for Windows.
Note: On Windows the e2e scripts need to first clean intermediate build results that were built outside the script
Use the following commands to run the e2e scripts:
cd <vpl-root>
oneVPL/script/e2e/bootstrap
oneVPL/script/e2e/build
Optionally you may set the environment variables VPL_INSTALL_DIR and VPL_BUILD_DEPENDENCIES to specify a location to install the project and to store the built dependencies respectivly.
cd <vpl-root>
export VPL_BUILD_DEPENDENCIES=<dependencies-cache>
export VPL_INSTALL_DIR=<vpl-install-location>
oneVPL/script/e2e/bootstrap
oneVPL/script/e2e/build
You can also clear build results by calling the clean script. Note, if VPL_INSTALL_DIR is set it will be cleared too.
cd <vpl-root>
oneVPL/script/e2e/clean
A complete rebuild can be forced by cleaning and then rebuilding.
cd <vpl-root>
export VPL_BUILD_DEPENDENCIES=<dependencies-cache>
export VPL_INSTALL_DIR=<vpl-install-location>
oneVPL/script/e2e/clean
oneVPL/script/e2e/bootstrap
oneVPL/script/e2e/build