Documentation
====================

The following documentation is regenerated nightly, and corresponds to the newest FFmpeg revision.
Consult your locally installed documentation for older versions.

.. toctree::
   :maxdepth: 2

   tools/index
   components/index
   libraries/index
   faq
   general
   platform
   developer
   git-howto
   fate

API Documentation
----------------------------------------------------------

- `Doxygen documentation`_ for current trunk (regenerated nightly);
  documentation for the `4.1`_, `4.0`_, 3.4, 3.3, 3.2, 3.1, 3.0, 2.8, 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0, 1.2, 1.1, 1.0, 0.11, 0.10, 0.9, 0.8, 0.7, 0.6 and 0.5 branches is also available.

.. _Doxygen documentation: https://ffmpeg.org/doxygen/trunk/index.html
.. _4.1: https://ffmpeg.org/doxygen/4.1/index.html
.. _4.0: https://ffmpeg.org/doxygen/4.0/index.html
.. _3.4: https://ffmpeg.org/doxygen/3.4/index.html
.. _3.3: https://ffmpeg.org/doxygen/3.3/index.html
.. _3.2: https://ffmpeg.org/doxygen/3.2/index.html
.. _3.1: https://ffmpeg.org/doxygen/3.1/index.html
.. _3.0: https://ffmpeg.org/doxygen/3.0/index.html
.. _2.8: https://ffmpeg.org/doxygen/2.8/index.html
.. _2.7: https://ffmpeg.org/doxygen/2.7/index.html
.. _2.6: https://ffmpeg.org/doxygen/2.6/index.html
.. _2.5: https://ffmpeg.org/doxygen/2.5/index.html
.. _2.4: https://ffmpeg.org/doxygen/2.4/index.html
.. _2.3: https://ffmpeg.org/doxygen/2.3/index.html
.. _2.2: https://ffmpeg.org/doxygen/2.2/index.html
.. _2.1: https://ffmpeg.org/doxygen/2.1/index.html
.. _2.0: https://ffmpeg.org/doxygen/2.0/index.html
.. _1.2: https://ffmpeg.org/doxygen/1.2/index.html
.. _1.1: https://ffmpeg.org/doxygen/1.1/index.html
.. _1.0: https://ffmpeg.org/doxygen/1.0/index.html
.. _0.1: https://ffmpeg.org/doxygen/0.1/index.html
.. _0.1: https://ffmpeg.org/doxygen/0.1/index.html
.. _0.9: https://ffmpeg.org/doxygen/0.9/index.html
.. _0.8: https://ffmpeg.org/doxygen/0.8/index.html
.. _0.7: https://ffmpeg.org/doxygen/0.7/index.html
.. _0.6: https://ffmpeg.org/doxygen/0.6/index.html
.. _0.5: https://ffmpeg.org/doxygen/0.5/index.html

Community Contributed Documentation
----------------------------------------------------------

.. toctree::
   :maxdepth: 2

- `Official FFmpeg Wiki <https://trac.ffmpeg.org/wiki>`_
- `MultimediaWiki <https://wiki.multimedia.cx/>`_
- `An FFmpeg and SDL Tutorial <http://dranger.com/ffmpeg/>`_ by Stephen Dranger, explains how to write a video player based on FFmpeg.

Books about FFmpeg
----------------------------------------------------------

.. toctree::
   :maxdepth: 2

- `FFmpeg Basics <http://ffmpeg.tv/>`_ by Frantisek Korbel, describes various FFmpeg features and common tasks.
- `FFmpeg Beginner's handbook Chinese Version <http://book.chinaffmpeg.com/>`_ by Steven Liu, describes FFmpeg common use method in Chinese, from command line to API usage.