README.md

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](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.

>[!Note]
>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)

# Installation folders

* 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`

# Samples

Samples that decode JPEG images are available [under `samples` in this repository](samples/). Refer to the individual folders to build and run the samples.

## Verifying your installation using samples and tests

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
```

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
```

# Docker

You can find rocJPEG Docker containers [under `develop/docker` in this repository](https://github.com/ROCm/rocJPEG/tree/develop/docker).
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00			`[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)`

Fix README image (#6 ) 2024-03-27 17:58:37 -06:00			`<p align="center"><img width="70%" src="docs/data/AMD_rocJPEG_Logo.png" /></p>`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
			`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.`

Prepare documentation (#57 ) 2024-10-22 17:23:18 -04:00			`>[!Note]`
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			>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)
Prepare documentation (#57 ) 2024-10-22 17:23:18 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			`# Installation folders`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			* 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`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			`# Samples`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			Samples that decode JPEG images are available [under `samples` in this repository](samples/). Refer to the individual folders to build and run the samples.
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			`## Verifying your installation using samples and tests`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
			`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`
Add a new sample (jpegDecodeMultiThreads) for jpeg decoding using multiple threads (#18 ) 2024-05-03 12:16:43 -04:00			`./jpegdecode -i /opt/rocm/share/rocjpeg/images/mug_420.jpg`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00			```

			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`
			```

Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			`# Docker`
Initial commit of the rocJPEG library (#1 ) 2024-03-25 17:05:31 -04:00
Edited the readme and reorganized the toc (#69 ) 2024-11-08 08:43:46 -05:00			You can find rocJPEG Docker containers [under `develop/docker` in this repository](https://github.com/ROCm/rocJPEG/tree/develop/docker).