Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #56

Merged
merged 3 commits into from
Sep 18, 2024
Merged

update docs #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7472b6a
update docs
AryanSalmanpour Sep 18, 2024
5711639
remove extra line
AryanSalmanpour Sep 18, 2024
600aa06
clean up
AryanSalmanpour Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 19 additions & 32 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,26 @@
# rocJPEG changelog

Documentation for rocJPEG is available at
[https://rocm.docs.amd.com/projects/rocJPEG/en/latest/](TBD)
[https://rocm.docs.amd.com/projects/rocJPEG/en/latest/](https://rocm.docs.amd.com/projects/rocJPEG/en/latest/)

## rocJPEG 0.3.0 (Unreleased)

## Additions

* Changelog.md

## Optimizations

* Setup Script - Error Check install & cleanup
## rocJPEG 0.6.0

### Changes

* Dependencies - Updates to core dependencies
* LibVA Headers - Use public headers
* mesa-amdgpu-va-drivers - RPM Package available on RPM from ROCm 6.2
* add the RocJpegDecodeParams struct for passing the decode parameters

### Fixes

* Package deps
* RHEL/SLES - Additional required packages `mesa-amdgpu-dri-drivers libdrm-amdgpu`

### Tested configurations

* Linux
* Ubuntu - `20.04` / `22.04`
* RHEL - `8` / `9`
* ROCm:
* rocm-core - `6.1.0.60100-64`
* amdgpu-core - `1:6.1.60100-1741643`
* libva-dev - `2.7.0-2` / `2.14.0-1`
* mesa-amdgpu-va-drivers - `1:24.1.0`
* mesa-amdgpu-dri-drivers - `24.1.0.60200`
* rocJPEG Setup Script - `V2.1.0`
* Supported initial enablement of the rocJPEG library
* Supported JPEG chroma subsampling:
* YUV 4:4:4
* YUV 4:4:0
* YUV 4:2:2
* YUV 4:2:0
* YUV 4:0:0
* Supported various output image format:
* Native (i.e., native unchanged output from VCN Hardware, it can be either packed YUV or planar YUV)​
* YUV planar​
* Y only​
* RGB​
* RGB planar
* Supported single-image and batch-image decoding​
* Supported Different partition modes on MI300 series​
* Supported region-of-interest (ROI) decoding​
* Supported color space conversion from YUV to RGB
24 changes: 14 additions & 10 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ rocJPEG provides APIs and samples that you can use to easily access the JPEG dec
features of your media engines (VCNs). It also allows interoperability with other compute engines on
the GPU using Video Acceleration API (VA-API)/HIP. To learn more, see :doc:`what-is-rocJPEG`

You can access rocJPEG code on our `GitHub repository <https://github.com/ROCm/rocJPEG>`_.

Our documentation is structured as follows:
The code is open and hosted at `GitHub repository <https://github.com/ROCm/rocJPEG>`_.

.. grid:: 2
:gutter: 3
Expand All @@ -22,22 +20,28 @@ Our documentation is structured as follows:
* :doc:`Quick-start <./install/quick-start>`
* :doc:`rocJPEG installation <./install/install>`

.. grid-item-card:: API reference
The documentation is structured as follows:

* :doc:`API library <../doxygen/html/files>`
* :doc:`Functions <../doxygen/html/globals>`
* :doc:`Data structures <../doxygen/html/annotated>`
.. grid:: 2
:gutter: 3

.. grid-item-card:: Tutorials

* `GitHub samples <https://github.com/ROCm/rocJPEG/tree/develop/samples>`_

.. grid-item-card:: How to

* :doc:`Use rocJPEG <how-to/using-rocjpeg>`

.. grid-item-card:: Tutorials
.. grid-item-card:: API reference

* :doc:`API library <../doxygen/html/files>`
* :doc:`Functions <../doxygen/html/globals>`
* :doc:`Data structures <../doxygen/html/annotated>`

* `GitHub samples <https://github.com/ROCm/rocJPEG/tree/develop/samples>`_

To contribute to the documentation, refer to
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.

You can find licensing information on the
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
31 changes: 8 additions & 23 deletions docs/install/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,6 @@ Installation
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
========================================

Expand Down Expand Up @@ -196,23 +187,17 @@ 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.

.. code:: 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
:doc:`Building documentation <rocm:contribute/building>` page.

Hardware capabilities
===================================================

* Supported JPEG chroma subsampling

* YUV 4:4:4
* YUV 4:4:0
* YUV 4:2:2
* YUV 4:2:0
* YUV 4:0:0

The following table shows the capabilities of the VCN and total number of JPEG cores for each supported GPU
architecture.

Expand Down