rocm-systems/docs/index.rst

.. 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 code is open and hosted at `<https://github.com/ROCm/rocDecode>`_.


.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Install

    * :doc:`Quick start <./install/quick-start>`
    * :doc:`rocDecode installation <./install/install>`


The documentation is structured as follows:

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Tutorials

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

  .. grid-item-card:: How to

    * :doc:`Using rocDecode <how-to/using-rocdecode>`

  .. grid-item-card:: Conceptual

     * :doc:`Video decoding pipeline <./conceptual/video-decoding-pipeline>`
  
  .. grid-item-card:: Reference

    * :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.