derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
70 lines
3.2 KiB
ReStructuredText
70 lines
3.2 KiB
ReStructuredText
.. meta::
|
|
:description: rocDecode documentation and API reference library
|
|
:keywords: rocDecode, ROCm, API, documentation, video, decode, decoding, acceleration
|
|
|
|
********************************************************************
|
|
rocDecode documentation
|
|
********************************************************************
|
|
|
|
rocDecode provides APIs, utilities, and samples that you can use to easily access the video decoding
|
|
features of your media engines (VCNs). It also allows interoperability with other compute engines on
|
|
the GPU using Video Acceleration API (VA-API)/HIP.
|
|
|
|
rocDecode is delivered as part of `TheRock <https://github.com/ROCm/TheRock>`_. The rocDecode source code is located at https://github.com/ROCm/rocm-systems/tree/develop/projects/rocdecode.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install rocDecode <./install/rocDecode-install>`
|
|
* :doc:`Build from source <./install/rocDecode-build-and-install>`
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :doc:`rocDecode decoding pipeline <./conceptual/rocDecode-decoding-pipelines>`
|
|
* :doc:`rocDecode surface memory locations <./conceptual/rocDecode-memory-types>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Understand the rocDecode videodecode.cpp sample <./how-to/using-rocDecode-videodecode-sample>`
|
|
* :doc:`Understand the rocDecode rocdecdecode.cpp sample <./how-to/using-rocDecode-rocdecdecoder>`
|
|
* :doc:`Use the rocDecode RocVideoDecoder <./how-to/using-rocDecode-video-decoder>`
|
|
* :doc:`Use the rocDecode FFmpeg demultiplexer <./how-to/using-rocDecode-ffmpeg>`
|
|
* :doc:`Use the rocDecode bitstream reader APIs <./how-to/using-rocDecode-bitstream>`
|
|
|
|
|
|
.. grid-item-card:: Samples
|
|
|
|
* :doc:`rocDecode samples <./tutorials/rocDecode-samples>`
|
|
|
|
.. grid-item-card:: Reference
|
|
|
|
* :doc:`The rocDecode core APIs <./reference/rocDecode-core-APIs>`
|
|
|
|
* :doc:`The rocDecode parser API <./reference/rocDecode-parser>`
|
|
* :doc:`The rocDecode hardware decoder API <./reference/rocDecode-hw-decoder>`
|
|
* :doc:`The rocDecode software decoder API <./reference/rocDecode-sw-decoder>`
|
|
|
|
* :doc:`The rocDecode utility classes <./reference/rocDecode-utility-classes>`
|
|
|
|
* :doc:`The rocDecode RocVideoDecoder<./reference/rocDecode-util-decoder>`
|
|
* :doc:`The rocDecode demultiplexer <./reference/rocDecode-demux>`
|
|
* :doc:`The rocDecode FFMpeg decoder <./reference/rocDecode-ffmpeg-decoder>`
|
|
|
|
* :doc:`rocDecode logging levels <./reference/rocDecode-logging-control>`
|
|
* :doc:`rocDecode environment variables <./reference/rocDecode-env-vars>`
|
|
* :doc:`rocDecode codec support and hardware capabilities <./reference/rocDecode-formats-and-architectures>`
|
|
* :doc:`API library <../doxygen/html/files>`
|
|
* :doc:`Functions <../doxygen/html/globals>`
|
|
* :doc:`Data structures <../doxygen/html/annotated>`
|
|
|
|
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.
|