From aafedbdc879cad2e64b3481b4600c9aca6edbc03 Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Fri, 21 Nov 2025 14:10:35 -0500 Subject: [PATCH] added a description of the host package (#674) --- .../using-rocDecode-videodecode-sample.rst | 3 -- docs/install/rocDecode-package-install.rst | 44 +++++++++++++++---- 2 files changed, 35 insertions(+), 12 deletions(-) diff --git a/docs/how-to/using-rocDecode-videodecode-sample.rst b/docs/how-to/using-rocDecode-videodecode-sample.rst index 12e5ac6bdd..2a91a8d12f 100644 --- a/docs/how-to/using-rocDecode-videodecode-sample.rst +++ b/docs/how-to/using-rocDecode-videodecode-sample.rst @@ -94,9 +94,6 @@ The FFMpeg demuxer is used to demultiplex the input stream unless the ``-no_ffmp VideoDemuxer *demuxer; demuxer = new VideoDemuxer(input_file_path.c_str()); - -.. code:: C++ - The ``GetCodecId`` and ``GetBitDepth`` functions are used to obtain the video stream's codec and bit depth. The ``AVCodec2RocDecVideoCodec`` utility function converts the codec returned from the demuxer to its corresponding ``rocDecVideoCodec_enum`` value. .. code:: C++ diff --git a/docs/install/rocDecode-package-install.rst b/docs/install/rocDecode-package-install.rst index ff3c5d5ccb..a9e6f93bbe 100644 --- a/docs/install/rocDecode-package-install.rst +++ b/docs/install/rocDecode-package-install.rst @@ -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