TeiaCareVideoIO

Welcome to TeiaCareVideoIO!

TeiaCareVideoIO is a C++ video encoder and decoder library.

Getting Started

Create a virtual environment

python -m pip install --upgrade pip
python -m venv .venv

# Linux/MacOS
echo "export CONAN_USER_HOME=$PWD" >> .venv/bin/activate
source .venv/bin/activate

# Windows
echo set CONAN_USER_HOME=%CD%>>.venv\Scripts\activate.bat
.venv\Scripts\activate.bat

pip install -r scripts/requirements.txt
pre-commit install

Setup Build Environment (Windows Only)

When building from command line on Windows it is necessary to activate the Visual Studio Developer Command Prompt. Depending on the version of Visual Studio compiler and on its install location it is required to run vcvars64.bat script the set the development environment properly. Note: using Visual Studio IDE or the CMake extension for VSCode this step is already managed in the background, so no action is required.

Examples:

# Visual Studio 2022 - Build Tools
"C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build\vcvars64.bat"

# Visual Studio 2019 - Enterprise
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"

Dependencies Setup

This script must be executed in order to setup the conan packages (note that 3rd party libs are only required for unit tests, examples and benchmarks).

python scripts/conan/setup.py <Debug|Release|DebWithRelInfo> <COMPILER_NAME> <COMPILER_VERSION>

Configure, Build and Install

This script configures, builds and installs the library.

python scripts/cmake.py <Debug|Release|DebWithRelInfo> <COMPILER_NAME> <COMPILER_VERSION>

Install FFmpeg for Examples and Unit Tests

Examples and Unit Tests execution requires video data generation. In order to generate such data it is required to install FFmpeg using your OS package manager such as:

# Windows, using chocolatey
choco install ffmpeg -y

# Windows, using winget
winget install ffmpeg

# Linux
sudo apt-get install -y ffmpeg

# MacOS
brew install ffmpeg

Once FFmpeg is installed and available on the path run the following python script:

python scripts/tests/generate_test_data.py

Examples

# Build all the examples
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --examples --warnings

# Run all the examples
python scripts/tools/run_examples.py install/examples

Examples are installed in $PWD/install/examples.

Unit Tests and Code Coverage

# Build Unit Tests with Code Coverage enabled (if supported)
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --coverage --warnings

# Run Unit Tests
python scripts/tools/run_unit_tests.py <Debug|Release|RelWithDebInfo>

# Run Code Covergae
python scripts/tools/run_coverage.py <COMPILER_NAME> <COMPILER_VERSION>

Note that code coverage is not available on Windows.

Unit tests results are available in $PWD/results/unit_tests. Coverage results are available in $PWD/results/coverage.

Sanitizers

Address Sanitizer

# Build Unit Tests with Address Sanitizer enabled (if supported)
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --address_sanitizer --unit_tests

# Run Unit Tests with Address Sanitizer
python scripts/tools/run_sanitizer.py --address_sanitizer install/unit_tests/teiacare_video_io_unit_tests

Note that Address Sanitizer is supported only on Linux.

Thread Sanitizer

# Build Unit Tests with Thread Sanitizer enabled (if supported)
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --thread_sanitizer --unit_tests

# Run Unit Tests with Thread Sanitizer
python scripts/tools/run_sanitizer.py --thread_sanitizer install/unit_tests/teiacare_video_io_unit_tests

Note that Thread Sanitizer is supported only on Linux.

Benchmarks

# Build Benkmarks
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --benchmarks --warnings

# Run Benchmarks
python scripts/tools/run_benchmarks.py <COMPILER_NAME> <COMPILER_VERSION>

Benchmarks are installed in $PWD/install/benchmarks.

Code Formatting

• clang-format

clang-format can be installed via pip using the provided scripts/requirements.txt

python scripts/tools/run_clang_format.py -r -i video_io

Code Analysis

• clang-tidy

clang-tidy can be installed via pip using the provided scripts/requirements.txt

python scripts/tools/run_clang_tidy.py -header-filter=.* video_io

• cppcheck

First install and setup cppcheck from your OS package manager.

# Linux
sudo apt install cppcheck

# Windows
winget install cppcheck

Then run CppCheck using the provided python script:

python scripts/tools/run_cppcheck.py <Debug|Release|RelWithDebInfo>

Generate Documentation

First install and setup Doxygen from your OS package manager.

# Linux
apt-get install doxygen graphviz

# Windows
winget install doxygen

Then run Doxygen using the provided python script:

python scripts/tools/run_doxygen.py

Documentation is now installed in $PWD/docs.

Conan Package

Local Install

Create, test and install local package.

Notes:

1. The install directory path must be a valid Conan cache (i.e. ".conan" folder) located in the current directory. So, in order to install the package in a desired repository folder, it is required to run this script from the repository folder directly.
2. The Conan package tests are automatically run during package creation. The directory test_package contains a test project that is built to validate the proper package creation.

# Create the Conan package locally
python scripts/conan/create.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION>

# Build and install the test package executable
python test_package/build.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION>

# Run the test package executable
$PWD/install/test_package/teiacare_sdk_test_package

Artifactory Upload

In order to upload a Conan package to TeiaCare Artifactory server it is required to setup you local Conan client once with the following commands:

# Add TeiaCare Artifactory remote to local Conan client
conan remote add teiacare $(artifactory.url)/teiacare

# Authenticate with Artifactory credentials
conan user $(artifactory.username) -p $(artifactory.password) -r teiacare

Now it is possible to create and upload a Conan package with the following commands:

# Create the Conan package locally
python scripts/conan/create.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION>

# Upload the package to Artifactory on the teicare remote
python scripts/conan/upload.py teiacare teiacare_video_io

Contributing

In order to contribute to TeiaCareVideoIO, please follow our contribution guidelines.

License

This project is licensed under the Apache License, Version 2.0. Copyright © 2024 TeiaCare

Video Streaming Integration Test (RTSP)

# Start mediamtx proxy stream
docker run --network=host -e MTX_PROTOCOLS=tcp -p 8554:8554 bluenviron/mediamtx

# Stream a local video to the proxy
ffmpeg -nostdin -stream_loop -1 -re -i "<PATH/TO/LOCAL/VIDEO>" -an -f rtsp -rtsp_transport tcp rtsp://localhost:8554/live

# Run a video reader example application
./video_reader_imgui_player rtsp://localhost:8554/live
./video_reader_opengl_player rtsp://localhost:8554/live