web/security: add CVEs for the latest releases
[ffmpeg-web.git] / src / documentation
index 7ad23ea..b48cca5 100644 (file)
-<h1>FFmpeg Documentation</h1>
-
-<h2>Reporting Bugs</h2>
 <p>
-Want to report a bug? Help us help you: The FFmpeg
-developers will be able to better diagnose the problem if you follow
-<a href="bugreports.html">these bug reporting guidelines</a>.
+  The following documentation is regenerated nightly, and corresponds to
+  the <a href="download.html">newest FFmpeg revision</a>.
+  Consult your locally installed documentation for older versions.
 </p>
 
-<h2>Command Line Interface (CLI) and Related Usage Documentation</h2>
-<ul>
-<li><a href="ffmpeg.html">FFmpeg Documentation</a></li>
-<li><a href="ffplay.html">FFplay Documentation</a></li>
-<li><a href="ffprobe.html">FFprobe Documentation</a></li>
-<li><a href="ffserver.html">FFserver Documentation</a></li>
-<li><a href="sample.html">Sample ffserver configuration file</a></li>
-</ul>
-
-<h2>General Documentation</h2>
-<ul>
-<li><a href="faq.html">Frequently Asked Questions</a></li>
-<li><a href="general.html">General Documentation</a></li>
-<li><a href="libavfilter.html">Libavfilter Documentation</a></li>
-<li><a href="developer.html">Developer Documentation</a></li>
-<li><a href="http://ffmpeg.zeranoe.com/">FFmpeg Windows Help</a>
-discusses all issues regarding FFmpeg under Windows including a wiki
-and help forums.</li>
-<li><a href="http://stephenjungels.com/jungels.net/articles/ffmpeg-howto.html">FFmpeg on Mac OS X HOWTO</a>
-explains installing and using FFmpeg on Mac OS X.</li>
-<li><a href="http://wiki.multimedia.cx/">MultimediaWiki</a></li>
-</ul>
-
-<h2>API Documentation</h2>
-<ul>
-<li><a href="doxygen/trunk/index.html">Doxygen documentation</a> for current
-trunk (regenerated nightly); documentation for the
-<a href="doxygen/0.6/index.html">0.6</a> and
-<a href="doxygen/0.5/index.html">0.5</a> branches is also available.</li>
-<li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_codec_HOWTO">FFmpeg codec HOWTO</a>,
-describes how to add a codec to libavcodec.</li>
-<li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_demuxer_HOWTO">FFmpeg demuxer HOWTO</a>,
-describes how to add a (de)muxer to libavformat.</li>
-<li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_filter_HOWTO">FFmpeg filter HOWTO</a>,
-describes how to add a filter to libavfilter.</li>
-</ul>
+<br><br>
 
-<h2>Tutorials</h2>
+<div class="row">
+  <div class="col-md-6">
+    <div class="well well-with-icon" id="command-line">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-terminal"></i></span>
+      <h3><strong>Command Line Tools Documentation</strong></h3>
+      <ul>
+        <li><a href="ffmpeg.html">ffmpeg</a>: <tt>ffmpeg</tt> tool</li>
+        <li><a href="ffmpeg-all.html">ffmpeg-all</a>: <tt>ffmpeg</tt> tool and FFmpeg components</li>
+        <li><a href="ffplay.html">ffplay</a>: <tt>ffplay</tt> tool</li>
+        <li><a href="ffplay-all.html">ffplay-all</a>: <tt>ffplay</tt> tool and FFmpeg components</li>
+        <li><a href="ffprobe.html">ffprobe</a>: <tt>ffprobe</tt> tool</li>
+        <li><a href="ffprobe-all.html">ffprobe-all</a>: <tt>ffprobe</tt> tool and FFmpeg components</li>
+        <li><a href="ffserver.html">ffserver</a>: <tt>ffserver</tt> tool</li>
+        <li><a href="ffserver-all.html">ffserver-all</a>: <tt>ffserver</tt> tool and FFmpeg components</li>
+        <li><a href="sample.html">sample <tt>ffserver</tt> configuration file</a></li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+  <div class="col-md-6">
+    <div class="well well-with-icon" id="components">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-sitemap"></i></span>
+      <h3><strong>Components Documentation</strong></h3>
+      <ul>
+        <li><a href="ffmpeg-utils.html">Utilities</a></li>
+        <li><a href="ffmpeg-scaler.html">Video scaling and pixel format converter</a></li>
+        <li><a href="ffmpeg-resampler.html">Audio resampler</a></li>
+        <li><a href="ffmpeg-codecs.html">Encoders and decoders (codecs)</a></li>
+        <li><a href="ffmpeg-bitstream-filters.html">Bitstream filters</a></li>
+        <li><a href="ffmpeg-formats.html">Muxers and demuxers (formats)</a></li>
+        <li><a href="ffmpeg-protocols.html">Protocols</a></li>
+        <li><a href="ffmpeg-devices.html">Input and output devices</a></li>
+        <li><a href="ffmpeg-filters.html">Filters</a></li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+</div> <!-- row -->
+<div class="row">
+  <div class="col-md-6">
+    <div class="well well-with-icon" id="libraries">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-cogs"></i></span>
+      <h3><strong>Libraries Documentation</strong></h3>
+      <ul>
+        <li><a href="libavutil.html">libavutil</a></li>
+        <li><a href="libswscale.html">libswscale</a></li>
+        <li><a href="libswresample.html">libswresample</a></li>
+        <li><a href="libavcodec.html">libavcodec</a></li>
+        <li><a href="libavformat.html">libavformat</a></li>
+        <li><a href="libavdevice.html">libavdevice</a></li>
+        <li><a href="libavfilter.html">libavfilter</a></li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+  <div class="col-md-6">
+    <div class="well well-with-icon" id="more">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-file-text-o"></i></span>
+      <h3><strong>General Documentation</h2></strong></h3>
 <ul>
-<li><a href="http://www.inb.uni-luebeck.de/~boehme/using_libavcodec.html">Using libavformat and libavcodec</a> by
-Martin B√∂hme, a good overview of the FFmpeg APIs.</li>
-<li><a href="http://dranger.com/ffmpeg/">An FFmpeg and SDL Tutorial</a>
-by Stephen Dranger, explains how to write a video player based on FFmpeg.</li>
+  <li><a href="faq.html">Frequently Asked Questions</a></li>
+  <li><a href="general.html">Supported External Libraries, Formats, Codecs or Features</a></li>
+  <li><a href="platform.html">Platform Specific Information</a></li>
+  <li><a href="developer.html">Developer Documentation</a></li>
+  <li><a href="git-howto.html">Git How-To</a></li>
+  <li><a href="fate.html">FATE FFmpeg Automated Testing Environment</a></li>
 </ul>
+</div>
+</div> <!-- col -->
+</div> <!-- row -->
+<div class="row">
+  <div class="col-md-6">
+    <div class="well well-with-icon">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-puzzle-piece"></i></span>
+      <h3><strong>API Documentation</strong></h3>
+      <ul>
+        <li><a href="doxygen/trunk/index.html">Doxygen documentation</a> for current
+          trunk (regenerated nightly); documentation for the
+          <a href="doxygen/2.8/index.html">2.8</a>,
+          <a href="doxygen/2.7/index.html">2.7</a>,
+          <a href="doxygen/2.6/index.html">2.6</a>,
+          <a href="doxygen/2.5/index.html">2.5</a>,
+          <a href="doxygen/2.4/index.html">2.4</a>,
+          <a href="doxygen/2.3/index.html">2.3</a>,
+          <a href="doxygen/2.2/index.html">2.2</a>,
+          <a href="doxygen/2.1/index.html">2.1</a>,
+          <a href="doxygen/2.0/index.html">2.0</a>,
+          <a href="doxygen/1.2/index.html">1.2</a>,
+          <a href="doxygen/1.1/index.html">1.1</a>,
+          <a href="doxygen/1.0/index.html">1.0</a>,
+          <a href="doxygen/0.11/index.html">0.11</a>,
+          <a href="doxygen/0.10/index.html">0.10</a>,
+          <a href="doxygen/0.9/index.html">0.9</a>,
+          <a href="doxygen/0.8/index.html">0.8</a>,
+          <a href="doxygen/0.7/index.html">0.7</a>,
+          <a href="doxygen/0.6/index.html">0.6</a> and
+          <a href="doxygen/0.5/index.html">0.5</a> branches is also available.</li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+  <div class="col-md-6">
+    <div class="well well-with-icon">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-users"></i></span>
+      <h3><strong>Community Contributed Documentation</strong></h3>
+      <ul>
+        <li><a href="http://trac.ffmpeg.org/wiki">Official FFmpeg Wiki</a></li>
+        <li><a href="http://wiki.multimedia.cx/">MultimediaWiki</a></li>
+        <li><a href="http://dranger.com/ffmpeg/">An FFmpeg and SDL Tutorial</a>
+          by Stephen Dranger, explains how to write a video player based on FFmpeg
+          (<a href="https://github.com/chelyaev/ffmpeg-tutorial">updated source code</a>).</li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+</div> <!-- row -->
+<div class="row">
+  <div class="col-md-6">
+    <div class="well well-with-icon">
+      <span class="pull-right"><i class="fa fa-5x fa-fw fa-book"></i></span>
+      <h3><strong>Books about FFmpeg</strong></h3>
+      <ul>
+        <li><a href="http://ffmpeg.tv">FFmpeg Basics</a> by Frantisek Korbel,
+          describes various FFmpeg features and common tasks.</li>
+      </ul>
+    </div>
+  </div> <!-- col -->
+</div> <!-- row -->