AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1c4e9bb5f50ea32dcffc9bf549aaa91f748f9eac
rocm-systems/projects/rocdecode/docs/index.rst
T
Lisa c1c9e06e7e Documentation - 6.1 Updates (Lisa edits) (#260) 
* Update video-decoding-pipeline.md

changed image alignment to left from center

* Update Create-a-decoder-using-rocDecCreateDecoder().md

language edits

* Update Create-parser-object-using-rocDecCreateVideoParser().md

Language edits

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

expanded SEI

* Update Decode-the-frame-using-rocDecDecodeFrame().md

language edits

* Update Destroy-the-decoder.md

* Update Decode-the-frame-using-rocDecDecodeFrame().md

* Update Destroy-the-parser-using-rocDecDestroyVideoParser().md

* Update Parse-video-data-using-rocDecParseVideoData().md

language and spacing edits

* Update Prepare-the-decoded-frame-for-further-processing.md

language and spacing edits

* Update Query-decode-capabilities-using-rocDecGetDecoderCaps().md

Language and spacing edits.

* Update Query-the-decoding-status.md

language edits and spacing

* Update Reconfigure-the-decorder.md

language edits and spacing fixes

* Update Use-rocDecode-API.md

language and spacing edits

* Update Use-rocDecode-API.md

* Update Destroy-the-decoder.md

updated to RocDecoder

* Update Parse-video-data-using-rocDecParseVideoData().md

Added link for callback

* Update Reconfigure-the-decorder.md

Corrected to  RocDecoder

* Delete docs/tutorial directory

Tutorial not required for the user guide.

* Add files via upload

* Delete docs/data/VideoDecoderPipeline.PNG

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update README.md

* resolve conflicts

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update install.md

* Update install.md

Minor language edits.

* Update install.md

* Update install.md

* Update install.md

* Update install.md

* Update README.md

Updated link to 
https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py

* Update _toc.yml.in

* Update index.md

* Update index.md

* Update index.md

corrections to index.md

* Update index.md

* Update index.md

* Create index.md

* Update index.md

Updated for installation and how to. Reference has header files. Need confirmation.

* Update index.md

* Update index.md

Changed AMD's rocDecode SDK Library to rocDecode SDK

* Update what-is-rocDecode.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Docs - Update config

* Docs - yml updates

* Docs - Updates

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

Added installation content

* Update _toc.yml.in

* Update install.md

changed heading to Installation

* Update index.md

* Update what-is-rocDecode.md

removed installation content

* Update what-is-rocDecode.md

Updated product name

* Update install.md

* Update _toc.yml.in

* Update Create-a-decoder-using-rocDecCreateDecoder.md

* Update Create-parser-object-using-rocDecCreateVideoParser.md

* Update Decode-the-frame-using-rocDecDecodeFrame.md

* Update Destroy-the-decoder.md

* Update Destroy-the-parser-using-rocDecDestroyVideoParser.md

* Update Parse-video-data-using-rocDecParseVideoData.md

* Update Prepare-the-decoded-frame-for-further-processing.md

* Update Query-decode-capabilities-using-rocDecGetDecoderCaps.md

* Update Query-the-decoding-status.md

* Update Reconfigure-the-decorder.md

* Update Use-rocDecode-API.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update index.md

* Update index.md

* Index - Change to RST

* Fix - index

* Update conf.py

copyright

* Cleanup - Index

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

Added concept

* Add files via upload

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Rename VideoDecoderPipeline (1).png to VideoDecoderPipelinetest.png

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Rename VideoDecoderPipeline.png to VideoDecoderPipelinetest.png

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update index.md

Added a numbered list of actions.

* Update index.md

add links

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

corrected the order of steps.

* Update index.rst

Corrected the order of tasks

* Update _toc.yml.in

Reorder the how to

* Update install.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

updated image path

* Update index.rst

Fixed Reconfigure the decoder <https://github.com/ROCm/rocDecode/blob/master/docs/how-to/Reconfigure-the-decorder.html>`_to
Reconfigure the decoder <https://github.com/ROCm/rocDecode/blob/master/docs/how-to/Reconfigure-the-decoder.html>`_

* Rename Reconfigure-the-decorder.md to Reconfigure-the-decoder.md

Corrected the page name to Reconfigure the decoder

* Update index.rst

Updated to relative links

* Update index.rst

Updated index.rst

* Update index.rst

* Update index.md

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

updated ref to doc

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Add files via upload

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

* Update index.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update install.md

* Update install.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update index.md

* Update index.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update install.md

* Update install.md

* Update what-is-rocDecode.md

* Update index.md

* restructure & edits

* udpate readme

* cleanup

* verbiage

* minor fixes

* update changelog

* update changelog

* update title

* add metadata

* more metadata

* convert to RST

* intersphinx test

* edits, install reorg, address comments

* verbiage

* update requirements

* remove extraneous note

* Update docs/sphinx/requirements.in

* clean up install info

* update readme

* update readme

* update requirements

* formatting

* revert requirements

* Docs - Update Requirements

* requirements

* Update requirements

* Fix typo in requirements

pip-compile error

---------

Co-authored-by: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Co-authored-by: Kiriti Gowda <kiritigowda@gmail.com>
Co-authored-by: Pavel Tcherniaev <Pavel.Tcherniaev@amd.com>
Co-authored-by: Sam Wu <sjwu@ualberta.ca>
Co-authored-by: kiritigowda <kiriti.nageshgowda@amd.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>

[ROCm/rocdecode commit: 8a10f8be18]
2024-02-27 16:42:03 -05:00

48 line
1.6 KiB
ReStructuredText
Raw Blame History

.. meta::
:description: rocDecode documentation and API reference library
:keywords: rocDecode, ROCm, API, documentation
********************************************************************
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.
You can access rocDecode code on our `GitHub repository <https://github.com/ROCm/rocDecode>`_.
Our documentation is structured as follows:
.. grid:: 2
:gutter: 3
.. grid-item-card:: Install
* :doc:`Quick-start <./install/quick-start>`
* :doc:`rocDecode installation <./install/install>`
.. grid-item-card:: API reference
* :doc:`Functions <../doxygen/html/globals>`
* :doc:`Data structures <../doxygen/html/annotated>`
* :doc:`File list <../doxygen/html/files>`
.. grid-item-card:: How to
* :doc:`Use rocDecode <how-to/using-rocdecode>`
.. grid-item-card:: Conceptual
* :doc:`Video decoding pipeline <./conceptual/video-decoding-pipeline>`
.. grid-item-card:: Tutorials
* `GitHub samples <https://github.com/ROCm/rocDecode/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.
Reference in New Issue View Git Blame Copy Permalink