tlRender is an open source library for building playback and review applications for visual effects, film, and animation.
The library can render and playback timelines with multiple video clips, image sequences, audio clips, and transitions. Examples are provided for integrating the library with Qt and OpenGL applications.
The library is written in C++ and uses the CMake build system.
These screenshots show an example application built with tlRender. The application is comparing two images with a wipe and horizontal layout.
Features:
- Support for timelines, image sequences, movies, and audio files
- A/B comparison with wipe, overlay, and difference modes
- Color management with OpenColorIO
- Multi-track audio with variable speed and reverse playback
- Experimental support for USD files
- Available for Linux, macOS, and Windows
A CMake super build script is provided to build all of the dependencies from source except for Qt. If building with Qt is enabled, it needs to be installed separately.
Required dependencies:
Optional dependencies:
Dependencies:
- CMake 3.31
Install system packages (Debian based systems):
sudo apt-get install xorg-dev libglu1-mesa-dev mesa-common-dev mesa-utils libasound2-dev libpulse-dev
Install system packages (Rocky 9):
sudo dnf install libX11-devel libXrandr-devel libXinerama-devel libXcursor-devel libXi-devel mesa-libGL-devel pipewire-devel
Clone the repository:
git clone https://github.com/darbyjohnston/tlRender.git
Run CMake with the super build script:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH=$PWD/Release/install -DCMAKE_BUILD_TYPE=Release
Start the build:
cmake --build Release -j 4 --config Release
Try running the tlplay application:
export LD_LIBRARY_PATH=$PWD/Release/install/lib:$LD_LIBRARY_PATH
./Release/tlRender/src/tlRender-build/bin/tlplay/tlplay tlRender/etc/SampleData/MultipleClips.otio
To build with Qt 6 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT6:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH="$PWD/Release/install;$HOME/Qt/6.5.3/gcc_64" -DTLRENDER_QT6=ON -DCMAKE_BUILD_TYPE=Release
To build with Qt 5 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT5:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH="$PWD/Release/install;$HOME/Qt/5.15.2/gcc_64" -DTLRENDER_QT5=ON -DCMAKE_BUILD_TYPE=Release
To build with only the minimal required dependencies:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH=$PWD/Release/install -DCMAKE_BUILD_TYPE=Release -DTLRENDER_OCIO=OFF -DTLRENDER_AUDIO=OFF -DTLRENDER_JPEG=OFF -DTLRENDER_TIFF=OFF -DTLRENDER_STB=OFF -DTLRENDER_PNG=OFF -DTLRENDER_EXR=OFF -DTLRENDER_FFMPEG=OFF -DTLRENDER_PROGRAMS=OFF -DTLRENDER_EXAMPLES=OFF -DTLRENDER_TESTS=OFF
Example running gcovr for code coverage:
gcovr -r ../../../../lib --html --object-directory lib --html-details --output gcov.html lib/tlCore lib/tlIO lib/tlTimeline
Dependencies:
- Xcode
- CMake 3.31
Clone the repository:
git clone https://github.com/darbyjohnston/tlRender.git
Run CMake with the super build script:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH=$PWD/Release/install -DCMAKE_BUILD_TYPE=Release
Start the build:
cmake --build Release -j 4 --config Release
Try running the tlplay application:
./Release/tlRender/src/tlRender-build/bin/tlplay/tlplay tlRender/etc/SampleData/MultipleClips.otio
To build with Qt 6 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT6:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH="$PWD/Release/install;$HOME/Qt/6.5.3/macos" -DTLRENDER_QT6=ON -DCMAKE_BUILD_TYPE=Release
To build with Qt 5 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT5:
cmake -S tlRender/etc/SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=$PWD/Release/install -DCMAKE_PREFIX_PATH="$PWD/Release/install;$HOME/Qt/5.15.2/clang_64" -DTLRENDER_QT5=ON -DCMAKE_BUILD_TYPE=Release
The CMake variable CMAKE_OSX_ARCHITECTURES can be used to specify the build
architecture:
-DCMAKE_OSX_ARCHITECTURES=x86_64
-DCMAKE_OSX_ARCHITECTURES=arm64
These aliases are convenient for switching between architectures:
alias arm="env /usr/bin/arch -arm64 /bin/zsh --login"
alias intel="env /usr/bin/arch -x86_64 /bin/zsh --login"
Dependencies:
- Visual Studio 2022
- CMake 3.31
- MSYS2 (https://www.msys2.org) for compiling FFmpeg.
- Strawberry Perl (https://strawberryperl.com/) for compiling network support.
- Python 3.11 for compiling USD.
Open the Visual Studio command console "x64 Native Tools Command Prompt for VS 2022". This can be found in the Start menu, in the "Visual Studio 2022" folder.
Clone the repository:
git clone https://github.com/darbyjohnston/tlRender.git
Run CMake with the super build script:
cmake -S tlRender\etc\SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=%CD%\Release\install -DCMAKE_PREFIX_PATH=%CD%\Release\install -DCMAKE_BUILD_TYPE=Release
Start the build:
cmake --build Release -j 4 --config Release
Try running the tlplay application:
set PATH=%CD%\Release\install\bin;%PATH%
.\Release\tlRender\src\tlRender-build\bin\tlplay\Release\tlplay tlRender\etc\SampleData\MultipleClips.otio
To build with Qt 6 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT6:
cmake -S tlRender\etc\SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=%CD%\Release\install -DCMAKE_PREFIX_PATH="%CD%\Release\install;C:\Qt\6.5.3\msvc2019_64" -DTLRENDER_QT6=ON -DCMAKE_BUILD_TYPE=Release
To build with Qt 5 add the Qt location to CMAKE_PREFIX_PATH (place double
quotes around the list of paths) and enable TLRENDER_QT5:
cmake -S tlRender\etc\SuperBuild -B Release -DCMAKE_INSTALL_PREFIX=%CD%\Release\install -DCMAKE_PREFIX_PATH="%CD%\Release\install;C:\Qt\5.15.2\msvc2019_64" -DTLRENDER_QT5=ON -DCMAKE_BUILD_TYPE=Release