Aryan Salmanpour
216 líneas
5.4 KiB
Markdown
216 líneas
5.4 KiB
Markdown
[](https://opensource.org/licenses/MIT)
|
|
|
|
<p align="center"><img width="70%" src="docs/data/AMD_rocJPEG_Logo.png" /></p>
|
|
|
|
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.
|
|
|
|
## Supported JPEG chroma subsampling
|
|
|
|
* YUV 4:4:4
|
|
* YUV 4:4:0
|
|
* YUV 4:2:2
|
|
* YUV 4:2:0
|
|
* YUV 4:0:0
|
|
|
|
## Prerequisites
|
|
|
|
* Linux distribution
|
|
* Ubuntu - `20.04` / `22.04`
|
|
* RHEL - `8` / `9`
|
|
* SLES - `15-SP5`
|
|
|
|
* [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.1.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.5.0+` - `Libva` is an implementation for VA-API
|
|
```shell
|
|
sudo apt install libva-dev
|
|
```
|
|
> [!NOTE]
|
|
> RPM Packages for `RHEL`/`SLES` - `libva-devel`
|
|
|
|
* AMD VA Drivers
|
|
```shell
|
|
sudo apt install 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
|
|
> ```
|
|
>
|
|
> * Additional RPM Packages required for `RHEL`/`SLES` - `libdrm-amdgpu mesa-amdgpu-dri-drivers`
|
|
|
|
>[!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.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=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
|
|
|
|
To verify your installation using a sample application, run:
|
|
|
|
```shell
|
|
mkdir rocjpeg-sample && cd rocjpeg-sample
|
|
cmake /opt/rocm/share/rocjpeg/samples/jpegDecode/
|
|
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
|
|
mkdir rocjpeg-test && cd rocjpeg-test
|
|
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).
|
|
|
|
## Documentation
|
|
|
|
Run the following code to build our documentation locally.
|
|
|
|
```shell
|
|
cd docs
|
|
pip3 install -r sphinx/requirements.txt
|
|
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
|
|
```
|
|
|
|
For more information on documentation builds, refer to the
|
|
[Building documentation](https://rocm.docs.amd.com/en/latest/contribute/building.html)
|
|
page.
|
|
|
|
## Tested configurations
|
|
|
|
* Linux
|
|
* Ubuntu - `20.04` / `22.04`
|
|
* RHEL - `8` / `9`
|
|
* ROCm:
|
|
* rocm-core - `6.2.0.60200-14004`
|
|
* amdgpu-core - `6.2.60200-1775523`
|
|
* libva-dev - `2.7.0-2` / `2.14.0-1`
|
|
* mesa-amdgpu-va-drivers - `24.1.0.60200-1775523`
|
|
* mesa-amdgpu-dri-drivers - `24.1.0.60200-1775523`
|
|
* rocJPEG Setup Script - `V1.2.0`
|