vtk-streaming 0.1.0

This module provides classes to encode and stream frames from a VTK OpenGL render window using video codecs.

VTKStreaming

This module provides classes to encode and stream frames from a VTK OpenGL render window using video codecs. It supports video encoding with VP9 (through libvpx) and H.264/H.265 (through NVENC).

Requirements

1. Clone and build VTK 9.2+ from source.
2. If you plan on developing/running tests, git-lfs is needed to download the test images, videos. Simply execute git lfs install in your terminal and you're all set.
3. nasm - an assembler is needed to compile x86_64/arm64 assembly sources from libvpx library. You may download nasm binaries for linux, windows and mac from nasm.us and append the PATH variable with the location of nasm on your filesystem. Alternative link - https://www.nasm.us/pub/nasm/stable/.

If your system has a supported nvidia gpu, libvpx is not required and you may skip the last requirement and set the CMake flag VTKSTREAMING_USE_LIBVPX=OFF.

Instructions

1. Clone the repository, setup git hooks if you intend to contribute.

   git clone https://gitlab.kitware.com/async/vtkstreaming.git
   ./Utilities/SetupForDevelopment.sh
   

2. Configure with CMake against VTK. Point VTK_DIR to either the build tree location or /path/to/vtk/install/lib/cmake/vtk-x.y where x.y is the major and minor version of VTK. Ex: vtk-9.2.

   cmake -S . -B build -DVTK_DIR=/path/to/vtk/install/lib/cmake/vtk-x.y
   

3. Build

   cmake --build build
   

4. Run unit tests.

   ctest --test-dir build
   

   Note: If you're linking against shared libraries on windows, do not forget to add the location of VTK binaries to the PATH environment variable.