added a description of the host package (#674)

[ROCm/rocdecode commit: aafedbdc87]
This commit is contained in:
spolifroni-amd
2025-11-21 14:10:35 -05:00
committed by GitHub
parent 577d1e842d
commit 74744b1d93
2 changed files with 35 additions and 12 deletions
@@ -9,14 +9,15 @@ 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-dev``: The rocDecode development package. This package installs a full suite of libraries, header files, and samples. This package needs to be installed to use the rocDecode samples.
* ``rocdecode-test``: A test package that provides a CTest to verify the installation. This package needs to be installed to use the rocDecode samples.
* ``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
========================================
Basic installation without software decoding
==============================================
Use the following commands to install only the rocDecode runtime package:
@@ -41,10 +42,36 @@ Use the following commands to install only the rocDecode runtime package:
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-dev``, ``rocdecode-host``, and ``rocdecode-test``:
Use the following commands to install ``rocdecode``, ``rocdecode-host``, ``rocdecode-dev``, and ``rocdecode-test``:
.. tab-set::
@@ -52,16 +79,15 @@ Use the following commands to install ``rocdecode``, ``rocdecode-dev``, ``rocdec
.. code:: shell
sudo apt install rocdecode rocdecode-dev rocdecode-test rocdecode-host
sudo apt install rocdecode rocdecode-host rocdecode-dev rocdecode-test
.. tab-item:: RHEL
.. code:: shell
sudo yum install rocdecode rocdecode-devel rocdecode-test rocdecode-host
sudo yum install rocdecode rocdecode-host rocdecode-devel rocdecode-test
.. tab-item:: SLES
.. code:: shell
sudo zypper install rocdecode rocdecode-devel rocdecode-test rocdecode-host
sudo zypper install rocdecode rocdecode-host rocdecode-devel rocdecode-test