Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 2 additions & 0 deletions docs/development/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,8 @@ These artifacts are built if any project features requiring them are enabled:
- `rand`: Random number generator libraries.
- `rccl`: Collective communication libraries.
- `MIOpen`: MIOpen kernel-select/fusion library.
- `rocdecode`: Video decode library (Linux only).
- `rocjpeg`: JPEG decode library (Linux only).

> [!NOTE]
> After adding a new artifact via `therock_provide_artifact()`, you may need to update `install_rocm_from_artifacts.py` to allow CI workflows and users to selectively install it. <br>
Expand Down
3 changes: 3 additions & 0 deletions docs/development/build_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ Sub-project directories:
projects like [hipBLASLt](https://github.com/ROCm/hipBLASLt).
- [`ml-libs/`](/ml-libs/) : Machine learning library sub-projects like
[MIOpen](https://github.com/ROCm/MIOpen).
- [`media-libs/`](/media-libs/) : Media decoding library sub-projects like
[rocDecode](https://github.com/ROCm/rocm-systems/tree/develop/projects/rocdecode)
and [rocJPEG](https://github.com/ROCm/rocm-systems/tree/develop/projects/rocjpeg).
- [`profiler/`](/profiler/) : Profiler sub-projects

Note that there is nothing in the build system which ensures naming consistency,
Expand Down
17 changes: 17 additions & 0 deletions docs/development/installing_artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ Choose one of these options to specify where to install from:
| `--prim` | Flag | Include primitives artifacts |
| `--rand` | Flag | Include random number generator artifacts |
| `--rccl` | Flag | Include RCCL artifacts |
| `--rocdecode` | Flag | Include rocDecode artifacts (Linux only) |
| `--rocjpeg` | Flag | Include rocJPEG artifacts (Linux only) |
| `--rocwmma` | Flag | Include rocWMMA artifacts |
| `--tests` | Flag | Include test artifacts for enabled components |

> [!NOTE]
> `--rocdecode` and `--rocjpeg` require `sysdeps-amd-mesa` and are only
> available on Linux.

### Utility Options

| Option | Type | Description |
Expand Down Expand Up @@ -289,6 +295,17 @@ python build_tools/install_rocm_from_artifacts.py \
--run-github-repo ROCm/rocm-libraries
```

### Install Media Libraries from CI Run (Linux only)

Install rocDecode and rocJPEG artifacts from a CI run:

```bash
python build_tools/install_rocm_from_artifacts.py \
--run-id 19588907671 \
--amdgpu-family gfx110X-all \
--rocdecode --rocjpeg
```

### Install from Dev Tarball

Install a development build using a commit hash version:
Expand Down
3 changes: 3 additions & 0 deletions docs/development/windows_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ mainline, in open source, using MSVC, etc.).
| | | | | |
| comm-libs | [rccl](https://github.com/ROCm/rocm-systems/tree/develop/projects/rccl) | rocm-systems | ❌ | Unsupported |
| | | | | |
| media-libs | [rocDecode](https://github.com/ROCm/rocm-systems/tree/develop/projects/rocdecode) | rocm-systems | ❌ | Linux only (requires VA-API / Mesa) |
| media-libs | [rocJPEG](https://github.com/ROCm/rocm-systems/tree/develop/projects/rocjpeg) | rocm-systems | ❌ | Linux only (requires VA-API / Mesa) |
| | | | | |
| math-libs | [rocRAND](https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocrand) | rocm-libraries | ✅ | |
| math-libs | [hipRAND](https://github.com/ROCm/rocm-libraries/tree/develop/projects/hiprand) | rocm-libraries | ✅ | |
| math-libs | [rocPRIM](https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocprim) | rocm-libraries | ✅ | |
Expand Down
30 changes: 30 additions & 0 deletions media-libs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ROCm Media Libraries

This directory contains media decoding libraries for AMD GPUs.

- **rocDecode** -- high-performance video decoding using VA-API
- **rocJPEG** -- high-performance JPEG decoding using VA-API

Both libraries depend on AMD Mesa for VA-API support and are only available
on Linux.

## Dependencies

Media libraries require the `THEROCK_ENABLE_SYSDEPS_AMD_MESA` option to be
enabled, which provides the bundled Mesa VA-API driver. Each library can also
be individually controlled:

- `-DTHEROCK_ENABLE_ROCDECODE=ON`
- `-DTHEROCK_ENABLE_ROCJPEG=ON`

Or disabled as a group:

- `-DTHEROCK_ENABLE_MEDIA_LIBS=OFF`

## Source Layout

The source code for both libraries lives in the
[rocm-systems](https://github.com/ROCm/rocm-systems) repository:

- `rocm-systems/projects/rocdecode`
- `rocm-systems/projects/rocjpeg`
1 change: 1 addition & 0 deletions media-libs/artifact-rocdecode.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# rocdecode
[components.dbg."media-libs/rocdecode/stage"]
[components.dev."media-libs/rocdecode/stage"]
[components.doc."media-libs/rocdecode/stage"]
Comment thread
kiritigowda marked this conversation as resolved.
[components.lib."media-libs/rocdecode/stage"]
[components.test."media-libs/rocdecode/stage"]
include = [
Expand Down
1 change: 1 addition & 0 deletions media-libs/artifact-rocjpeg.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# rocjpeg
[components.dbg."media-libs/rocjpeg/stage"]
[components.dev."media-libs/rocjpeg/stage"]
[components.doc."media-libs/rocjpeg/stage"]
Comment thread
kiritigowda marked this conversation as resolved.
[components.lib."media-libs/rocjpeg/stage"]
[components.test."media-libs/rocjpeg/stage"]
include = [
Expand Down
Loading