[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

rocDecode is a high-performance video decode SDK for AMD GPUs. Using the rocDecode API, you can access the video decoding features available on your GPU. ## Supported codecs * H.265 (HEVC) - 8 bit, and 10 bit * H.264 (AVC) - 8 bit ## Prerequisites * Linux distribution * Ubuntu - `20.04` / `22.04` * RHEL - `8` / `9` * [ROCm-supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) > [!IMPORTANT] > `gfx908` or higher GPU required * Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html): Required usecase - rocm > [!IMPORTANT] > `sudo amdgpu-install --usecase=rocm` * [Video Acceleration API](https://en.wikipedia.org/wiki/Video_Acceleration_API) Version `1.5.0+` - `Libva` is an implementation for VA-API ```shell sudo apt install libva-dev ``` > [!NOTE] > RPM Packages for `RHEL`/`SLES` - `libva-devel` * AMD VA Drivers ```shell sudo apt install mesa-amdgpu-va-drivers ``` * CMake `3.5` or later ```shell sudo apt install cmake ``` * [pkg-config](https://en.wikipedia.org/wiki/Pkg-config) ```shell sudo apt install pkg-config ``` * [FFmpeg](https://ffmpeg.org/about.html) runtime and headers - for tests and samples ```shell sudo apt install ffmpeg libavcodec-dev libavformat-dev libavutil-dev ``` > [!IMPORTANT] > * On `Ubuntu 22.04` - Additional package required: `libstdc++-12-dev` > > ```shell > sudo apt install libstdc++-12-dev > ``` > > * On `RHEL`/`SLES` - Additional packages required: `libdrm-amdgpu` and `mesa-amdgpu-dri-drivers` > > ```shell > sudo yum install libdrm-amdgpu mesa-amdgpu-dri-drivers > ``` >[!NOTE] > * All package installs are shown with the `apt` package manager. Use the appropriate package manager for your operating system. > * To install rocDecode with minimum requirements, follow the [quick-start](./docs/install/quick-start.rst) instructions ### Prerequisites setup script For your convenience, we provide the setup script, [rocDecode-setup.py](https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py), which installs all required dependencies. Run this script only once. ```shell python3 rocDecode-setup.py --rocm_path [ ROCm Installation Path - optional (default:/opt/rocm)] --developer [ Setup Developer Options - optional (default:OFF) [options:ON/OFF]] ``` ## Installation instructions The installation process uses the following steps: * [ROCm-supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) install verification * Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with `--usecase=rocm` * Use **either** [package install](#package-install) **or** [source install](#source-install) as described below. ### Package install To install rocDecode runtime, development, and test packages, run the line of code for your operating system. * Runtime package - `rocdecode` only provides the rocdecode library `librocdecode.so` * Development package - `rocdecode-dev`/`rocdecode-devel` provides the library, header files, and samples * Test package - `rocdecode-test` provides CTest to verify installation #### Ubuntu ```shell sudo apt install rocdecode rocdecode-dev rocdecode-test ``` #### RHEL ```shell sudo yum install rocdecode rocdecode-devel rocdecode-test ``` #### SLES ```shell sudo zypper install rocdecode rocdecode-devel rocdecode-test ``` >[!NOTE] > Package install auto installs all dependencies. > [!IMPORTANT] > `RHEL`/`SLES` package install requires manual `FFMPEG` dev install ### Source install To build rocDecode from source and install, run: ```shell git clone https://github.com/ROCm/rocDecode.git cd rocDecode python3 rocDecode-setup.py mkdir build && cd build cmake ../ make -j8 sudo make install ``` #### Run tests ```shell make test ``` > [!IMPORTANT] > make test requires `FFMPEG` dev install >[!NOTE] > To run tests with verbose option, use `make test ARGS="-VV"`. #### Make package ```shell sudo make package ``` ## Verify installation The installer copies: * Libraries into `/opt/rocm/lib` * Header files into `/opt/rocm/include/rocdecode` * Samples folder into `/opt/rocm/share/rocdecode` * Documents folder into `/opt/rocm/share/doc/rocdecode` ### Using sample application To verify your installation using a sample application, run: ```shell mkdir rocdecode-sample && cd rocdecode-sample cmake /opt/rocm/share/rocdecode/samples/videoDecode/ make -j8 ./videodecode -i /opt/rocm/share/rocdecode/video/AMD_driving_virtual_20-H265.mp4 ``` ### Using test package To verify your installation using the `rocdecode-test` package, run: ```shell mkdir rocdecode-test && cd rocdecode-test cmake /opt/rocm/share/rocdecode/test/ ctest -VV ``` ## Samples You can access samples to decode your videos in our [GitHub repository](https://github.com/ROCm/rocDecode/tree/develop/samples). Refer to the individual folders to build and run the samples. [FFmpeg](https://ffmpeg.org/about.html) is required for sample applications and `make test`. To install FFmpeg, refer to the instructions listed for your operating system: * Ubuntu: ```shell sudo apt install ffmpeg libavcodec-dev libavformat-dev libavutil-dev ``` * RHEL/SLES: Install ffmpeg development packages manually or use `rocDecode-setup.py` script ## Docker You can find rocDecode Docker containers in our [GitHub repository](https://github.com/ROCm/rocDecode/tree/develop/docker). ## Documentation Run the following code to build our documentation locally. ```shell cd docs pip3 install -r sphinx/requirements.txt python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html ``` For more information on documentation builds, refer to the [Building documentation](https://rocm.docs.amd.com/en/latest/contribute/building.html) page. ## Tested configurations * Linux * Ubuntu - `20.04` / `22.04` * RHEL - `8` / `9` * ROCm: * rocm-core - `6.1.0.60100-64` * amdgpu-core - `1:6.1.60100-1741643` * libva-dev - `2.7.0-2` / `2.14.0-1` * mesa-amdgpu-va-drivers - `1:24.1.0` * mesa-amdgpu-dri-drivers - `24.1.0.60200` * FFmpeg - `4.2.7` / `4.4.2-0` * rocDecode Setup Script - `V2.0.0`