Add 'projects/rocdecode/' from commit 'b0bab079403eda171f9056409fa96b0908f61073'

git-subtree-dir: projects/rocdecode git-subtree-mainline: 5d609c1e57 git-subtree-split: b0bab07940
2026-01-30 20:33:26 +00:00
@@ -0,0 +1,55 @@
+.. meta::
+  :description: Build and install rocDecode with the source code
+  :keywords: install, building, rocDecode, AMD, ROCm, source code, developer
+
+********************************************************************
+Building and installing rocDecode from source code
+********************************************************************
+
+If you will be contributing to the rocDecode code base, or if you want to preview new features, build rocDecode from its source code.
+
+If you will not be previewing features or contributing to the code base, use the :doc:`package installers <./rocDecode-package-install>` to install rocDecode. 
+
+Before building rocDecode, use `rocDecode-setup.py <https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py>`_ to install all the required prerequisites:
+
+.. code:: shell
+
+  python3 rocDecode-setup.py  [--rocm_path ROCM_INSTALLATION_PATH; default=/opt/rocm]
+                              [--runtime {ON|OFF}; default=ON]
+                              [--developer {ON|OFF}; default=OFF]
+
+.. note:: 
+
+  Never run ``rocDecode-setup.py`` with ``--runtime OFF``.  
+  
+  ``--developer ON`` is required to use the code samples.
+
+Build and install rocDecode using the following commands:
+
+.. code:: shell
+
+  git clone https://github.com/ROCm/rocDecode.git
+  cd rocDecode
+  mkdir build && cd build
+  cmake ../
+  make -j8
+  sudo make install
+
+After installation, the rocDecode libraries will be copied to ``/opt/rocm/lib`` and the rocDecode header files will be copied to ``/opt/rocm/include/rocdecode``.
+
+Build and install the rocDecode test module. This module is required if you'll be using the rocDecode samples, and can only be installed if ``rocDecode-setup.py`` was run with ``--developer ON``.
+
+.. code:: shell
+
+  mkdir rocdecode-test && cd rocdecode-test
+  cmake /opt/rocm/share/rocdecode/test/
+  ctest -VV
+
+Run ``make test`` to test your build. To run the test with the verbose option, run ``make test ARGS="-VV"``. 
+
+To create a package installer for rocDecode, run:
+
+.. code:: shell
+
+  sudo make package
+
@@ -0,0 +1,93 @@
+.. meta::
+  :description: Installing rocDecode with the package installer
+  :keywords: install, rocDecode, AMD, ROCm, basic, development, package
+
+********************************************************************
+Installing rocDecode with the package installer
+********************************************************************
+
+Three rocDecode packages are available:
+
+* ``rocdecode``: The rocDecode runtime package. This is the basic rocDecode package. It must always be installed.
+* ``rocdecode-host``: The rocDecode software decoding package. This package must be installed to use the FFmpeg software decoder.
+* ``rocdecode-dev``: The rocDecode development package. This package installs a full suite of libraries, header files, and samples. This package must be installed to use the rocDecode samples.
+* ``rocdecode-test``: A test package that provides a CTest to verify the installation. This package must be installed to use the rocDecode samples.
+
+All the required prerequisites are installed when the package installation method is used.
+
+
+Basic installation without software decoding
+==============================================
+
+Use the following commands to install only the rocDecode runtime package:
+
+.. tab-set::
+ 
+  .. tab-item:: Ubuntu
+
+    .. code:: shell
+
+      sudo apt install rocdecode
+
+  .. tab-item:: RHEL
+
+    .. code:: shell
+
+      sudo yum install rocdecode
+
+  .. tab-item:: SLES
+
+    .. code:: shell
+
+      sudo zypper install rocdecode
+
+
+Basic installation with software decoding
+==============================================
+
+Use the following commands to install the rocDecode runtime package and the host decoding package:
+
+.. tab-set::
+ 
+  .. tab-item:: Ubuntu
+
+    .. code:: shell
+
+      sudo apt install rocdecode rocdecode-host
+
+  .. tab-item:: RHEL
+
+    .. code:: shell
+
+      sudo yum install rocdecode rocdecode-host
+
+  .. tab-item:: SLES
+
+    .. code:: shell
+
+      sudo zypper install rocdecode rocdecode-host
+
+
+Complete installation
+========================================
+
+Use the following commands to install ``rocdecode``, ``rocdecode-host``, ``rocdecode-dev``, and ``rocdecode-test``:
+
+.. tab-set::
+
+  .. tab-item:: Ubuntu
+
+    .. code:: shell
+
+      sudo apt install rocdecode rocdecode-host rocdecode-dev rocdecode-test 
+
+  .. tab-item:: RHEL
+
+    .. code:: shell
+
+      sudo yum install rocdecode rocdecode-host rocdecode-devel rocdecode-test
+  .. tab-item:: SLES
+
+    .. code:: shell
+
+      sudo zypper install rocdecode rocdecode-host rocdecode-devel rocdecode-test
@@ -0,0 +1,41 @@
+.. meta::
+  :description: rocDecode Installation Prerequisites
+  :keywords: install, rocDecode, AMD, ROCm, prerequisites, dependencies, requirements
+
+********************************************************************
+rocDecode prerequisites
+********************************************************************
+
+rocDecode requires ROCm running on `GPUs based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_.
+
+ROCm must be installed using the AMDGPU installer with the ``rocm`` usecase:
+
+.. code:: shell
+
+  sudo amdgpu-install --usecase=rocm
+
+rocDecode has been tested on the following Linux environments:
+  
+* Ubuntu 22.04 and 24.04
+* RHEL 8 and 9
+* SLES 15 SP7
+
+See `Supported operating systems <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems>`_ for the complete list of ROCm supported Linux environments.
+
+The following prerequisites are installed by the package installer. If you are building and installing using the source code, use the `rocDecode-setup.py <https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py>`_ to install these prerequisites. 
+
+.. note:: 
+
+  To use the rocDecode samples, the ``rocdecode``, ``rocdecode-dev``, ``rocdecode-host``, and ``rocdecode-test`` packages need to be installed.
+  
+  If you're installing using the rocDecode source code, the ``rocDecode-setup.py`` script must be run with ``--developer`` set to ``ON``.
+
+* Libva-amdgpu-dev, an AMD implementation for Video Acceleration API (VA-API)
+* AMD VA Drivers
+* CMake version 3.10 or later
+* AMD Clang++ Version 18.0.0 or later
+* pkg-config
+* FFmpeg runtime and headers
+* libstdc++-12-dev for installations on Ubuntu 22.04 
+* HIP, specifically the ``hip-dev`` package
+