Files
rocm-systems/docs/index.rst
T
spolifroni-amd dcddb9d5ea added howto use for the utility classes (#511)
* added howto use for the utility classes

* Update docs/conceptual/rocDecode-memory-types.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/conceptual/rocDecode-memory-types.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocDecode-bitstream.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocDecode-bitstream.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocDecode-bitstream.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocDecode-bitstream.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocdecode.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocdecode.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update using-rocDecode-ffmpeg.rst

* key frame -> keyframe

* `api` -> ``api``

* must -> need to

* added a sample walkthrough; removed the bitstream reader info; streamlined info

* Update docs/how-to/using-rocDecode-videodecode-sample.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocDecode-videodecode-sample.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/how-to/using-rocdecode.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update rocDecode-samples.rst

* Update docs/how-to/using-rocdecode.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* updated tables and other minor things

* updated with Leo's suggestion

* Update using-rocDecode-ffmpeg.rst

* added detail to information about the frame buffers

* small changes based on feedback

* updated

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
Co-authored-by: Lakshmi Kumar <lakshmi.kumar@amd.com>
2025-03-11 11:16:45 -04:00

57 خطوط
2.4 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. To learn more, see :doc:`what-is-rocDecode`
The rocDecode public repository is located at `https://github.com/ROCm/rocDecode <https://github.com/ROCm/rocDecode>`_.
.. grid:: 2
:gutter: 3
.. grid-item-card:: Install
* :doc:`Installing rocDecode with the package installer <./install/rocDecode-package-install>`
* :doc:`Building and installing rocDecode from source code <./install/rocDecode-build-and-install>`
* `rocDecode Docker containers <https://github.com/ROCm/rocDecode/tree/develop/docker>`_
.. grid:: 2
:gutter: 3
.. grid-item-card:: Conceptual
* :doc:`Video decoding pipeline <./conceptual/video-decoding-pipeline>`
* :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:`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 core APIs <./how-to/using-rocdecode>`
.. grid-item-card:: Samples
* :doc:`rocDecode samples <./tutorials/rocDecode-samples>`
.. grid-item-card:: Reference
* :doc:`rocDecode codec support and hardware capabilities <./reference/rocDecode-formats-and-architectures>`
* :doc:`rocDecode tested configurations <./reference/rocDecode-tested-configurations>`
* :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.