Homepage from diego biurrun, robert swain and others, with small changes by me
[ffmpeg-web.git] / src / documentation
1 <h1>FFmpeg Documentation</h1>
2
3 <h2>Reporting Bugs</h2>
4 <p>
5 Want to report a bug? Help us help you: The FFmpeg
6 developers will be able to better diagnose the problem if you follow
7 <a href="bugreports.html">these bug reporting guidelines</a>.
8 </p>
9
10 <h2>General Documentation</h2>
11 <ul>
12 <li><a href="faq.html">Frequently Asked Questions</a></li>
13 <li><a href="general.html">General Documentation</a></li>
14 <li><a href="libavfilter.html">Libavfilter Documentation</a></li>
15 <li><a href="developer.html">Developer Documentation</a></li>
16 <li><a href="http://ffmpeg.arrozcru.org/">FFmpeg Windows Help</a>
17 discusses all issues regarding FFmpeg under Windows including a wiki
18 and help forums.</li>
19 <li><a href="http://stephenjungels.com/jungels.net/articles/ffmpeg-howto.html">FFmpeg on Mac OS X HOWTO</a>
20 explains installing and using FFmpeg on Mac OS X.</li>
21 </ul>
22
23 <h2>Command Line Interface (CLI) and Related Usage Documentation</h2>
24 <ul>
25 <li><a href="ffmpeg.html">FFmpeg Documentation</a></li>
26 <li><a href="ffplay.html">FFplay Documentation</a></li>
27 <li><a href="ffprobe.html">FFprobe Documentation</a></li>
28 <li><a href="ffserver.html">FFserver Documentation</a></li>
29 <li><a href="sample.html">Sample ffserver configuration file</a></li>
30 </ul>
31
32 <h2>API Documentation</h2>
33 <ul>
34 <li><a href="doxygen/trunk/index.html">Doxygen documentation</a> for current
35 trunk (regenerated nightly); documentation for the
36 <a href="doxygen/0.6/index.html">0.6</a> and
37 <a href="doxygen/0.5/index.html">0.5</a> branches is also available.</li>
38 <li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_codec_HOWTO">FFmpeg codec HOWTO</a>,
39 describes how to add a codec to libavcodec.</li>
40 <li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_demuxer_HOWTO">FFmpeg demuxer HOWTO</a>,
41 describes how to add a (de)muxer to libavformat.</li>
42 <li><a href="http://wiki.multimedia.cx/index.php?title=FFmpeg_filter_HOWTO">FFmpeg filter HOWTO</a>,
43 describes how to add a filter to libavfilter.</li>
44 </ul>
45
46 <h2>Tutorials</h2>
47 <ul>
48 <li><a href="http://www.inb.uni-luebeck.de/~boehme/using_libavcodec.html">Using libavformat and libavcodec</a> by
49 Martin B√∂hme, a good overview of the FFmpeg APIs.</li>
50 <li><a href="http://dranger.com/ffmpeg/">An FFmpeg and SDL Tutorial</a>
51 by Stephen Dranger, explains how to write a video player based on FFmpeg.</li>
52 </ul>