nithinaditya / tmiv-installation

Test Model for MPEG Immersive Video (TMIV) Build and Installation Instructions

TMIV is a ISO C++17 conformant and requires the following external libraries:

• The {fmt} library for string formatting
• The Catch2 test framework
• The HEVC test model (HM)

Minimal prerequisites are:

• C++17 compiler and build tools
• CMake 3.14 or newer

Obtain all external libraries

Catch2 testing framework

1. Visit this URL: https://github.com/catchorg/Catch2/tree/v2.11.1
2. Download ZIP or clone the repo resulting in a directory /Workspace/Catch2-2.11.1 such that the file /Workspace/Catch2-2.11.1/README.md exists.

{fmt} string formatting library

1. Visit this URL: https://github.com/fmtlib/fmt/tree/7.0.3
2. Download ZIP or clone the repo resulting in a directory /Workspace/fmt-7.0.3 such that the file /Workspace/fmt-7.0.3/README.md exists.

HEVC test model (HM)

1. Visit this URL: https://vcgit.hhi.fraunhofer.de/jct-vc/HM/-/tree/HM-16.16
2. Download ZIP or clone the repo resulting in a directory /Workspace/HM-HM-16.16 such that the file /Workspace/HM-HM-16.16/README exists.
3. Rename that directory to /Workspace/HM-16.16.

Fraunhofer Versatile Video Encoder (VVenC)

1. Visit this URL: https://github.com/fraunhoferhhi/vvenc/tree/v0.2.0.0
2. Download ZIP or clone the repo resulting in a directory /Workspace/vvenc-0.2.0.0 such that the file /Workspace/vvenc-0.2.0.0/README.md exists.

Fraunhofer Versatile Video Decoder (VVdeC)

1. Visit this URL: https://github.com/fraunhoferhhi/vvdec/tree/v0.2.0.0
2. Download ZIP or clone the repo resulting in a directory /Workspace/vvdec-0.2.0.0 such that the file /Workspace/vvdec-0.2.0.0/README.md exists.

The TMIV project

1. Clone this repo resulting in a directory /Workspace/tmiv-installation such that the file /Workspace/tmiv-installation/README.md exists.
2. Rename to /Workspace/tmiv to match with the following instructions.

Building and installing TMIV

To build and install TMIV into the directory /Workspace/tmiv_install with sources in the directory /Workspace/tmiv, execute:

mkdir /Workspace/tmiv_build
cd /Workspace/tmiv_build
cmake -DCMAKE_INSTALL_PREFIX=/Workspace/tmiv_install -DCMAKE_BUILD_TYPE=Release /Workspace/tmiv
cmake --build . --parallel --config Release
cmake --build . --parallel --config Release --target install

The intermediate directory /Workspace/tmiv_build may be deleted when the installation has completed.

Installation result

After installation, the TMIV executables Encoder, Decoder and Renderer will be available under the directory /Workspace/tmiv_install/bin. By default TMIV only builds the HM modules that are required for TMIV (TLibCommon and TLibDecoder). When HM_BUILD_TAPPDECODER and HM_BUILD_TAPPENCODER are selected, then the TAppDecoder and TAppEncoder tools respectively will also be installed to this directory. TMIV per default builds vvencFFapp and vvdecapp from the Fraunhofer VVC implementations.