README.md
1# Fraunhofer Versatile Video Decoder (VVdeC)
2
3Versatile Video Coding (VVC) is the most recent international video coding standard, developed by the Joint Video Experts Team (JVET) of the ITU-T Video Coding Experts Group (VCEG) and the ISO/IEC Moving Picture Experts Group (MPEG). VVC is the successor of the High Efficiency Video Coding (HEVC) standard and will be released by ITU-T as H.266 and by ISO/IEC as MPEG-I Part 3 (ISO/IEC 23090-3). The new standard targets a 50% bit-rate reduction over HEVC at the same visual quality. In addition, VVC proves to be truly versatile by including tools for efficient coding of video content in emerging applications, e.g. high dynamic range (HDR), adaptive streaming, computer generated content as well as immersive applications like 360 degree video and augmented reality (AR).
4
5The Fraunhofer Versatile Video Decoder (VVdeC) is a fast VVC x86 software decoder implementation. The decoder supports most standard features available in the Main10 profile, with support for some high-level features still pending.
6
7# How to build VVdeC?
8
9The software uses CMake to create platform-specific build files.
10A working CMake installation is required for building the software.
11Download CMake from http://www.cmake.org/ and install it. The following targets are supported: Windows (Visual Studio), Linux (gcc) and MacOS (clang).
12
13## Building using CMake
14
15Open a command prompt on your system and change into the root directory of this project (location of this README.md file).
16
17Create a build directory in the root directory:
18
19 mkdir build
20
21After that use one of the following cmake commands. Feel free to change the commands to satisfy your needs.
22
23Windows sample for Visual Studio 2017 64 Bit:
24
25 cd build
26 cmake .. -G "Visual Studio 15 2017 Win64"
27
28Linux Release Makefile sample:
29
30 cd build
31 cmake .. -DCMAKE_BUILD_TYPE=Release
32
33Linux Debug Makefile sample:
34
35 cd build
36 cmake .. -DCMAKE_BUILD_TYPE=Debug
37
38MacOS-X Xcode sample:
39
40 cd build
41 cmake .. -G "Xcode"
42
43Available CMake switches:
44* VVDEC_ENABLE_BITSTREAM_DOWNLOAD: enables downloading of conformance bitstreams for testing
45* VVDEC_ENABLE_INSTALL: enables creation of the install-target
46
47## Building using plain make
48
49The project includes an easy to use make interface which bundles the most important use-cases.
50
51Remarks:
52* You still need to install CMake to use the make tool
53* For Windows, you can install the make command as a part gnuwin32
54
55Open a command prompt on your system and change into the root directory of this project (location of this README.md file).
56
57To use the default system compiler simply call:
58
59 make all
60
61The project includes a simple test suite based on [JVET conformance bitstreams](https://www.itu.int/wftp3/av-arch/jvet-site/bitstream_exchange/VVC/). To enable it, call the make command with the following argument:
62
63 make enable-bitstream-download=1 ...
64
65To generate a solution for the default builder on your system simply call:
66
67 make configure
68
69To run the simple conformance test suite (if the bitstreams are downloaded and available) call:
70
71 make test
72
73The above call only tests the sequences that are know to work. To run a test over all conformance sequences with supported profile call:
74
75 make test-all
76
77# Contributing
78
79Feel free to contribute. To do so:
80
81* Fork the current-most state of the master branch
82* Apply the desired changes
83* Create a pull-request to the upstream repository
84
85# License
86
87Please see [LICENSE.txt](./LICENSE.txt) file for the terms of use of the contents of this repository.
88
89For more information, please contact: vvc@hhi.fraunhofer.de
90
91**Copyright (c) 2018-2021 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.**
92
93**All rights reserved.**
94