rocPyDecode is a Python binding library that connects Python with AMD’s rocDecode and rocJPEG C/C++ APIs, enabling seamless function calls and data exchange between the two languages. It serves as a high-level wrapper, making the video and image decoding capabilities of rocDecode and rocJPEG accessible from Python.

rocPyDecode includes rocPyJpegDecode when the underlying rocJPEG library is available on the system, providing JPEG-specific decoding support through Python. The library supports multi-VCN configurations via batch decoding, making it well-suited for high-throughput and parallelized image and video processing workloads.

• Linux
  • Ubuntu - 22.04 / 24.04

• GPU: AMD Radeon™ Graphics / AMD Instinct™ Accelerators

• Install ROCm 7.0.0 or later with amdgpu-install: Required usecase:rocm

• AMD Clang++ Version 18.0.0 or later - installed with ROCm

• CMake 3.15 or higher

  sudo apt install cmake

• rocDecode 1.0.0 or higher

  sudo apt install rocdecode-dev

• rocJPEG 1.0.0 or higher

  sudo apt install rocjpeg-dev

• DLPack

  sudo apt install libdlpack-dev

• Python3 and Python3 PIP

  sudo apt install python3-dev python3-pip

• PyBind11

  sudo apt install python3-pybind11

• numpy

   sudo apt install python3-numpy

• pkg-config

  sudo apt install pkg-config

• FFmpeg

  sudo apt install libavcodec-dev libavformat-dev libavutil-dev

For your convenience, we provide the setup script, rocPyDecode-requirements.py, which installs all required dependencies. Run this script only once on bare metal, if using docker please see below instructions.

python3 rocPyDecode-requirements.py

The installation process uses the following steps:

• ROCm-supported hardware install verification

• Install ROCm 7.0.0 or later with amdgpu-install with --usecase=rocm

Install rocPyDecode runtime, and test packages.

• Runtime package - rocpydecode only provides the python bindings for rocDecode
• Test package - rocpydecode-test provides ctest to verify installation

sudo apt-get install rocpydecode rocpydecode-test

To build rocPyDecode from source and install, follow the steps below:

• Clone rocPyDecode source code

git clone https://github.com/ROCm/rocPyDecode.git

• Build rocPyDecode with the CMake

  • run the requirements script to install all the dependencies required:

  cd rocPyDecode
  python3 rocPyDecode-requirements.py

  • run the below commands to build rocPyDecode:

  mkdir build && cd build
  cmake ../
  make -j8
  sudo make install

• run tests - test option instructions

make test

This will run python samples and show pass/fail.

python3 -m pip install --upgrade pip
python3 -m pip install -i https://test.pypi.org/simple hip-python

mkdir rocpydecode-test && cd rocpydecode-test
cmake ../rocPyDecode/tests
ctest -VV

Test package will install ctest module to test rocPyDecode. Follow below steps to test package install

mkdir rocpydecode-test && cd rocpydecode-test
cmake /opt/rocm/share/rocpydecode/tests
ctest -VV

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/rocm/lib
export PYTHONPATH=/opt/rocm/lib:$PYTHONPATH

• Sample scripts and instructions to run them can be found here

Run the following code to build our documentation locally.

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 page.

• Linux distribution
  • Ubuntu - 22.04 / 24.04
• ROCm: rocm-core - 7.0.0+
• AMD Clang++ - Version 18.0.0+
• CMake - Version 3.15+
• rocdecode-dev - 1.0.0+
• rocjpeg-dev - 1.0.0+
• libdlpack-dev - 0.6-1
• python3-pybind11 - 2.9.1-2
• FFmpeg - 4.4.2 / 6.1.1