AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Edited the readme and reorganized the toc (#69)

Browse Source 
* Edited the readme so that it doesn't duplicate information in the official online docs

* rearranged the toc to match the new structure

* moved Docker section
This commit is contained in:
spolifroni-amd
2024-11-08 08:43:46 -05:00
committed by GitHub
parent b414b5ed6c
commit b2973fe98b
2 changed files with 17 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -162
View File
@@ -5,160 +5,20 @@
rocJPEG is a high performance JPEG decode SDK for AMD GPUs. Using the rocJPEG API, you can access the JPEG decoding features available on your GPU.
>[!Note]
>The published documentation is available at [rocJPEG](https://rocm.docs.amd.com/projects/rocJPEG/en/latest/) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the `docs` folder of this repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html)
>The published documentation that includes installation and build instructions is available at [rocJPEG](https://rocm.docs.amd.com/projects/rocJPEG/en/latest/) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the `docs` folder of this repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html)
## Supported JPEG chroma subsampling
# Installation folders
* YUV 4:4:4
* YUV 4:4:0
* YUV 4:2:2
* YUV 4:2:0
* YUV 4:0:0
* Libraries are located in: `/opt/rocm/lib`
* Header files are located in: `/opt/rocm/include/rocjpeg`
* Samples are located in: `/opt/rocm/share/rocjpeg`
* Documentation is located in: `/opt/rocm/share/doc/rocjpeg`
## Prerequisites
# Samples
* Linux distribution
* Ubuntu - `20.04` / `22.04` / `24.04`
* RHEL - `8` / `9`
* SLES - `15-SP5`
Samples that decode JPEG images are available [under `samples` in this repository](samples/). Refer to the individual folders to build and run the samples.
* [ROCm supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html)
> [!IMPORTANT]
> `gfx908` or higher GPU required
* Install ROCm `6.3.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html): Required usecase - rocm
> [!IMPORTANT]
> `sudo amdgpu-install --usecase=rocm`
* Video Acceleration API (VA-API) Version `1.16.0+` - `Libva` is an implementation for VA-API
```shell
sudo apt install libva-amdgpu-dev
```
> [!NOTE]
> RPM Packages for `RHEL`/`SLES` - `libva-amdgpu-devel`
* AMD VA Drivers
```shell
sudo apt install libva2-amdgpu libva-amdgpu-drm2 libva-amdgpu-wayland2 libva-amdgpu-x11-2 mesa-amdgpu-va-drivers
```
> [!NOTE]
> RPM Packages for `RHEL`/`SLES` - `libva-amdgpu mesa-amdgpu-va-drivers`
* CMake `3.5` or later
```shell
sudo apt install cmake
```
* pkg-config
```shell
sudo apt install pkg-config
```
> [!IMPORTANT]
>
> * If using Ubuntu 22.04, you must install `libstdc++-12-dev`
>
> ```shell
> sudo apt install libstdc++-12-dev
> ```
>
>[!NOTE]
>
> * All package installs are shown with the `apt` package manager. Use the appropriate package manager for your operating system.
> * To install rocJPEG with minimum requirements, follow the [quick-start](./docs/install/quick-start.rst) instructions
### Prerequisites setup script for Linux
For your convenience, we provide the setup script,
[rocJPEG-setup.py](rocJPEG-setup.py) which installs all required dependencies. Run this script only once.
**Usage:**
```shell
python rocJPEG-setup.py --rocm_path [ ROCm Installation Path - optional (default:/opt/rocm)]
```
**NOTE:** This script only needs to be executed once.
## Installation instructions
The installation process uses the following steps:
* [ROCm-supported hardware](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) install verification
* Install ROCm `6.3.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with `--usecase=rocm`
* Use either [Package install](#package-install) or [Source install](#source-install) as described below.
### Package install
Install rocJPEG runtime, development, and test packages.
* Runtime package - `rocjpeg` only provides the rocjpeg library `librocjpeg.so`
* Development package - `rocjpeg-dev`/`rocjpeg-devel` provides the library, header files, and samples
* Test package - `rocjpeg-test` provides CTest to verify installation
#### Ubuntu
```shell
sudo apt install rocjpeg rocjpeg-dev rocjpeg-test
```
#### RHEL
```shell
sudo yum install rocjpeg rocjpeg-devel rocjpeg-test
```
#### SLES
```shell
sudo zypper install rocjpeg rocjpeg-devel rocjpeg-test
```
>[!NOTE]
> Package install auto installs all dependencies.
### Source install
```shell
git clone https://github.com/ROCm/rocJPEG.git
cd rocJPEG
mkdir build && cd build
cmake ../
make -j8
sudo make install
```
#### Run tests
```shell
make test
```
**NOTE:** run tests with verbose option `make test ARGS="-VV"`
#### Make package
```shell
sudo make package
```
## Verify installation
The installer will copy
* Libraries into `/opt/rocm/lib`
* Header files into `/opt/rocm/include/rocjpeg`
* Samples folder into `/opt/rocm/share/rocjpeg`
* Documents folder into `/opt/rocm/share/doc/rocjpeg`
### Using sample application
## Verifying your installation using samples and tests
To verify your installation using a sample application, run:
@@ -169,8 +29,6 @@ make -j8
./jpegdecode -i /opt/rocm/share/rocjpeg/images/mug_420.jpg
```
### Using test package
To verify your installation using the `rocjpeg-test` package, run:
```shell
@@ -179,15 +37,6 @@ cmake /opt/rocm/share/rocjpeg/test/
ctest -VV
```
## Samples
The tool provides a few samples to decode JPEG images [here](samples/). Please refer to the individual folders to build and run the samples.
You can access samples to decode your images in our
[GitHub repository](https://github.com/ROCm/rocJPEG/tree/develop/samples). Refer to the
individual folders to build and run the samples.
## Docker
You can find rocJPEG Docker containers in our
[GitHub repository](https://github.com/ROCm/rocJPEG/tree/develop/docker).
# Docker
You can find rocJPEG Docker containers [under `develop/docker` in this repository](https://github.com/ROCm/rocJPEG/tree/develop/docker).
docs/sphinx/_toc.yml.in
+6 -5
View File
@@ -24,6 +24,12 @@ subtrees:
- file: how-to/rocjpeg-decoding-a-jpeg-stream.rst
title: Decoding a JPEG stream with rocJPEG
- caption: Samples
entries:
- url: https://github.com/ROCm/rocJPEG/tree/develop/samples
title: rocJPEG samples on GitHub
- caption: Reference
entries:
- file: reference/rocjpeg-formats-and-architectures.rst
@@ -35,11 +41,6 @@ subtrees:
- file: doxygen/html/annotated
title: rocJPEG data structures
- caption: Samples
entries:
- url: https://github.com/ROCm/rocJPEG/tree/develop/samples
title: rocJPEG samples on GitHub
- caption: About
entries:
- file: license.md