55rocDecode is a high-performance video decode SDK for AMD GPUs. Using the rocDecode API, you can
66access the video decoding features available on your GPU.
77
8- ## Tested configurations
9-
10- * Linux
11- * Ubuntu - ` 20.04 ` / ` 22.04 `
12- * RHEL - ` 8 ` / ` 9 `
13- * SLES - ` 15-SP4 `
14- * ROCm:
15- * rocm-core - ` 6.1.0.60100-28 `
16- * amdgpu-core - ` 1:6.1.60100-1731559 `
17- * FFmpeg - ` 4.2.7 ` / ` 4.4.2-0 `
18- * rocDecode Setup Script - ` V1.4 `
19-
208## Supported codecs
219
2210* H.265 (HEVC) - 8 bit, and 10 bit
@@ -28,13 +16,13 @@ access the video decoding features available on your GPU.
2816 * RHEL - ` 8 ` / ` 9 `
2917 * SLES - ` 15-SP4 `
3018
31- * [ ROCm-supported hardware] ( https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html ) (` gfx908 ` or higher required)
19+ * [ ROCm-supported hardware] ( https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html )
20+ > [ !IMPORTANT]
21+ > ` gfx908 ` or higher GPU required
3222
33- * Install ROCm ` 6.1.0 ` or later with
34- [ amdgpu-install] ( https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html )
35- * Run: ` --usecase=multimediasdk,rocm --no-32 `
36- * To install rocDecode with minimum requirements, follow the
37- [ quick-start] ( ./docs/install/quick-start.rst ) instructions
23+ * 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 )
24+ > [ !IMPORTANT]
25+ > * ` --usecase=multimediasdk,rocm --no-32 `
3826
3927* CMake ` 3.5 ` or later
4028
@@ -54,15 +42,16 @@ access the video decoding features available on your GPU.
5442 sudo apt install ffmpeg libavcodec-dev libavformat-dev libavutil-dev
5543 ```
5644
57- * If using Ubuntu 22.04, you must install ` libstdc++-12-dev `
45+ > [ !IMPORTANT]
46+ > If using Ubuntu 22.04, you must install ` libstdc++-12-dev `
5847
5948 ``` shell
6049 sudo apt install libstdc++-12-dev
6150 ```
6251
6352> [ !NOTE]
64- > All package installs are shown with the ` apt ` package manager. Use the appropriate package
65- > manager for your operating system.
53+ > * All package installs are shown with the ` apt ` package manager. Use the appropriate package manager for your operating system.
54+ > * To install rocDecode with minimum requirements, follow the [ quick-start ] ( ./docs/install/quick-start.rst ) instructions
6655
6756### Prerequisites setup script
6857
@@ -77,26 +66,36 @@ which installs all required dependencies. Run this script only once.
7766
7867# # Installation instructions
7968
80- To install rocDecode, you can use [Package install](# package-install) or [Source install](#source-install).
69+ The installation process uses the following steps:
70+
71+ * [ROCm-supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) install verification
72+
73+ * 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= multimediasdk,rocm --no-32`
74+
75+ * Use either [Package install](# package-install) or [Source install](#source-install) as described below.
8176
8277# ## Package install
8378
8479To install rocDecode runtime, development, and test packages, run the line of code for your operating
8580system.
8681
87- * Ubuntu
82+ * Runtime package - ` rocdecode` only provides the rocdecode library ` librocdecode.so`
83+ * Development package - ` rocdecode-dev` /` rocdecode-devel` provides the library, header files, and samples
84+ * Test package - ` rocdecode-test` provides CTest to verify installation
85+
86+ # ### Ubuntu
8887
8988 ` ` ` shell
9089 sudo apt install rocdecode rocdecode-dev rocdecode-test
9190 ` ` `
9291
93- * RHEL
92+ # ### RHEL
9493
9594 ` ` ` shell
9695 sudo yum install rocdecode rocdecode-devel rocdecode-test
9796 ` ` `
9897
99- * SLES
98+ # ### SLES
10099
101100 ` ` ` shell
102101 sudo zypper install rocdecode rocdecode-devel rocdecode-test
@@ -105,9 +104,8 @@ system.
105104> [! NOTE]
106105> Package install auto installs all dependencies.
107106
108- * Runtime package - ` rocdecode` only provides the rocdecode library ` librocdecode.so`
109- * Development package - ` rocdecode-dev` /` rocdecode-devel` provides the library, header files, and samples
110- * Test package - ` rocdecode-test` provides CTest to verify installation
107+ > [! IMPORTANT]
108+ > ` RHEL` /` SLES` package install requires manual ` FFMPEG` dev install
111109
112110# ## Source install
113111
@@ -122,13 +120,16 @@ make -j8
122120sudo make install
123121` ` `
124122
125- Run tests (this requires FFmpeg dev install) :
123+ Run tests:
126124
127125 ` ` ` shell
128126 make test
129127 ` ` `
128+ > [! IMPORTANT]
129+ > make test requires ` FFMPEG` dev install
130130
131- To run tests with verbose option, use ` make test ARGS=" -VV" ` .
131+ > [! NOTE]
132+ > To run tests with verbose option, use ` make test ARGS=" -VV" ` .
132133
133134Make package:
134135
@@ -145,7 +146,8 @@ The installer copies:
145146* Samples folder into ` /opt/rocm/share/rocdecode`
146147* Documents folder into ` /opt/rocm/share/doc/rocdecode`
147148
148- * To verify your installation using a sample application, run:
149+ # ## Using sample application
150+ To verify your installation using a sample application, run:
149151
150152 ` ` ` shell
151153 mkdir rocdecode-sample && cd rocdecode-sample
@@ -154,16 +156,15 @@ The installer copies:
154156 ./videodecode -i /opt/rocm/share/rocdecode/video/AMD_driving_virtual_20-H265.mp4
155157 ` ` `
156158
157- * To verify your installation using the ` rocdecode-test` package, run:
159+ # ## Using test package
160+ To verify your installation using the ` rocdecode-test` package, run:
158161
159162 ` ` ` shell
160163 mkdir rocdecode-test && cd rocdecode-test
161164 cmake /opt/rocm/share/rocdecode/test/
162165 ctest -VV
163166 ` ` `
164167
165- This test package installs the CTest module.
166-
167168# # Samples
168169
169170You can access samples to decode your videos in our
@@ -201,3 +202,15 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
201202For more information on documentation builds, refer to the
202203[Building documentation](https://rocm.docs.amd.com/en/latest/contribute/building.html)
203204page.
205+
206+ # # Tested configurations
207+
208+ * Linux
209+ * Ubuntu - ` 20.04` / ` 22.04`
210+ * RHEL - ` 8` / ` 9`
211+ * SLES - ` 15-SP4`
212+ * ROCm:
213+ * rocm-core - ` 6.1.0.60100-28`
214+ * amdgpu-core - ` 1:6.1.60100-1731559`
215+ * FFmpeg - ` 4.2.7` / ` 4.4.2-0`
216+ * rocDecode Setup Script - ` V1.4`
0 commit comments