<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on March, 17 2008 by texi2html 1.78 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>General Documentation</title>
<meta name="description" content="General Documentation">
<meta name="keywords" content="General Documentation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.78">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="SEC1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[ < ]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[ << ]</td>
<td valign="middle" align="left">[ Up ]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 1. external libraries </h1>
<p>FFmpeg can be hooked up with a number of external libraries to add support
for more formats. None of them are used by default, their use has to be
explicitly requested by passing the appropriate flags to ‘<tt>./configure</tt>’.
</p>
<hr size="6">
<a name="SEC2"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.1 AMR </h2>
<p>AMR comes in two different flavors, wideband and narrowband. FFmpeg can make
use of the AMR wideband (floating-point mode) and the AMR narrowband
(floating-point mode) reference decoders and encoders.
</p>
<p>Go to <a href="http://www.penguin.cz/~utx/amr">http://www.penguin.cz/~utx/amr</a> and follow the instructions for
installing the libraries. Then pass <code>--enable-libamr-nb</code> and/or
<code>--enable-libamr-wb</code> to configure to enable the libraries.
</p>
<p>Note that libamr is copyrighted without any sort of license grant. This means
that you can use it if you legally obtained it but you are not allowed to
redistribute it in any way. <strong>Any FFmpeg binaries with libamr support
you create are non-free and unredistributable!</strong>
</p>
<hr size="6">
<a name="SEC3"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC2" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC4" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 2. Supported File Formats and Codecs </h1>
<p>You can use the <code>-formats</code> option to have an exhaustive list.
</p>
<hr size="6">
<a name="SEC4"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC3" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 2.1 File Formats </h2>
<p>FFmpeg supports the following file formats through the <code>libavformat</code>
library:
</p>
<table>
<tr><td><p> Supported File Format </p></td><td><p> Encoding </p></td><td><p> Decoding </p></td><td><p> Comments
</p></td></tr>
<tr><td><p> MPEG audio </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MPEG-1 systems </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> muxed audio and video
</p></td></tr>
<tr><td><p> MPEG-2 PS </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> also known as <code>VOB</code> file
</p></td></tr>
<tr><td><p> MPEG-2 TS </p></td><td> </td><td><p> X
</p></td><td><p> also known as DVB Transport Stream
</p></td></tr>
<tr><td><p> ASF</p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> AVI</p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> WAV</p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Macromedia Flash</p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> AVM2 (Flash 9) </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Only embedded audio is decoded.
</p></td></tr>
<tr><td><p> FLV </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Macromedia Flash video files
</p></td></tr>
<tr><td><p> Real Audio and Video </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw AC3 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw MJPEG </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw MPEG video </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw PCM8/16 bits, mulaw/Alaw</p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw CRI ADX audio </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Raw Shorten audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> SUN AU format </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> NUT </p></td><td><p> X </p></td><td><p> X </p></td><td><p> NUT Open Container Format
</p></td></tr>
<tr><td><p> QuickTime </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MPEG-4 </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> MPEG-4 is a variant of QuickTime.
</p></td></tr>
<tr><td><p> Raw MPEG4 video </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> DV </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> 4xm </p></td><td> </td><td><p> X
</p></td><td><p> 4X Technologies format, used in some games.
</p></td></tr>
<tr><td><p> Playstation STR </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Id RoQ </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Used in Quake III, Jedi Knight 2, other computer games.
</p></td></tr>
<tr><td><p> Interplay MVE </p></td><td> </td><td><p> X
</p></td><td><p> Format used in various Interplay computer games.
</p></td></tr>
<tr><td><p> WC3 Movie </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia format used in Origin's Wing Commander III computer game.
</p></td></tr>
<tr><td><p> Sega FILM/CPK </p></td><td> </td><td><p> X
</p></td><td><p> Used in many Sega Saturn console games.
</p></td></tr>
<tr><td><p> Westwood Studios VQA/AUD </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia formats used in Westwood Studios games.
</p></td></tr>
<tr><td><p> Id Cinematic (.cin) </p></td><td> </td><td><p> X
</p></td><td><p> Used in Quake II.
</p></td></tr>
<tr><td><p> FLIC format </p></td><td> </td><td><p> X
</p></td><td><p> .fli/.flc files
</p></td></tr>
<tr><td><p> Sierra VMD </p></td><td> </td><td><p> X
</p></td><td><p> Used in Sierra CD-ROM games.
</p></td></tr>
<tr><td><p> Sierra Online </p></td><td> </td><td><p> X
</p></td><td><p> .sol files used in Sierra Online games.
</p></td></tr>
<tr><td><p> Matroska </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Electronic Arts Multimedia </p></td><td> </td><td><p> X
</p></td><td><p> Used in various EA games; files have extensions like WVE and UV2.
</p></td></tr>
<tr><td><p> Nullsoft Video (NSV) format </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> ADTS AAC audio </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Creative VOC </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Created for the Sound Blaster Pro.
</p></td></tr>
<tr><td><p> American Laser Games MM </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia format used in games like Mad Dog McCree
</p></td></tr>
<tr><td><p> AVS </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia format used by the Creature Shock game.
</p></td></tr>
<tr><td><p> Smacker </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia format used by many games.
</p></td></tr>
<tr><td><p> GXF </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
</p></td></tr>
<tr><td><p> CIN </p></td><td> </td><td><p> X
</p></td><td><p> Multimedia format used by Delphine Software games.
</p></td></tr>
<tr><td><p> MXF </p></td><td> </td><td><p> X
</p></td><td><p> Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
</p></td></tr>
<tr><td><p> SEQ </p></td><td> </td><td><p> X
</p></td><td><p> Tiertex .seq files used in the DOS CDROM version of the game Flashback.
</p></td></tr>
<tr><td><p> DXA </p></td><td> </td><td><p> X
</p></td><td><p> This format is used in non-Windows version of Feeble Files game and
different game cutscenes repacked for use with ScummVM.
</p></td></tr>
<tr><td><p> THP </p></td><td> </td><td><p> X
</p></td><td><p> Used on the Nintendo GameCube.
</p></td></tr>
<tr><td><p> C93 </p></td><td> </td><td><p> X
</p></td><td><p> Used in the game Cyberia from Interplay.
</p></td></tr>
<tr><td><p> Bethsoft VID </p></td><td> </td><td><p> X
</p></td><td><p> Used in some games from Bethesda Softworks.
</p></td></tr>
<tr><td><p> CRYO APC </p></td><td> </td><td><p> X
</p></td><td><p> Audio format used in some games by CRYO Interactive Entertainment.
</p></td></tr>
<tr><td><p> Monkey's Audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> SIFF </p></td><td> </td><td><p> X
</p></td><td><p> Audio and video format used in some games by Beam Software
</p></td></tr>
</table>
<p><code>X</code> means that encoding (resp. decoding) is supported.
</p>
<hr size="6">
<a name="SEC5"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC4" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC6" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 2.2 Image Formats </h2>
<p>FFmpeg can read and write images for each frame of a video sequence. The
following image formats are supported:
</p>
<table>
<tr><td><p> Supported Image Format </p></td><td><p> Encoding </p></td><td><p> Decoding </p></td><td><p> Comments
</p></td></tr>
<tr><td><p> PGM, PPM </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> PAM </p></td><td><p> X </p></td><td><p> X </p></td><td><p> PAM is a PNM extension with alpha support.
</p></td></tr>
<tr><td><p> PGMYUV </p></td><td><p> X </p></td><td><p> X </p></td><td><p> PGM with U and V components in YUV 4:2:0
</p></td></tr>
<tr><td><p> JPEG </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Progressive JPEG is not supported.
</p></td></tr>
<tr><td><p> .Y.U.V </p></td><td><p> X </p></td><td><p> X </p></td><td><p> one raw file per component
</p></td></tr>
<tr><td><p> animated GIF </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Only uncompressed GIFs are generated.
</p></td></tr>
<tr><td><p> PNG </p></td><td><p> X </p></td><td><p> X </p></td><td><p> 2 bit and 4 bit/pixel not supported yet.
</p></td></tr>
<tr><td><p> Targa </p></td><td> </td><td><p> X </p></td><td><p> Targa (.TGA) image format.
</p></td></tr>
<tr><td><p> TIFF </p></td><td><p> X </p></td><td><p> X </p></td><td><p> YUV, JPEG and some extension is not supported yet.
</p></td></tr>
<tr><td><p> SGI </p></td><td><p> X </p></td><td><p> X </p></td><td><p> SGI RGB image format
</p></td></tr>
<tr><td><p> PTX </p></td><td> </td><td><p> X </p></td><td><p> V.Flash PTX format
</p></td></tr>
</table>
<p><code>X</code> means that encoding (resp. decoding) is supported.
</p>
<hr size="6">
<a name="SEC6"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC5" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC7" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 2.3 Video Codecs </h2>
<table>
<tr><td><p> Supported Codec </p></td><td><p> Encoding </p></td><td><p> Decoding </p></td><td><p> Comments
</p></td></tr>
<tr><td><p> MPEG-1 video </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MPEG-2 video </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MPEG-4 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MSMPEG4 V1 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MSMPEG4 V2 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MSMPEG4 V3 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> WMV7 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> WMV8 </p></td><td><p> X </p></td><td><p> X </p></td><td><p> not completely working
</p></td></tr>
<tr><td><p> WMV9 </p></td><td> </td><td><p> X </p></td><td><p> not completely working
</p></td></tr>
<tr><td><p> VC1 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> H.261 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> H.263(+) </p></td><td><p> X </p></td><td><p> X </p></td><td><p> also known as RealVideo 1.0
</p></td></tr>
<tr><td><p> H.264 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> RealVideo 1.0 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> RealVideo 2.0 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> MJPEG </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> lossless MJPEG </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> JPEG-LS </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: MJLS, lossless and near-lossless is supported
</p></td></tr>
<tr><td><p> Apple MJPEG-B </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Sunplus MJPEG </p></td><td> </td><td><p> X </p></td><td><p> fourcc: SP5X
</p></td></tr>
<tr><td><p> DV </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> HuffYUV </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> FFmpeg Video 1 </p></td><td><p> X </p></td><td><p> X </p></td><td><p> experimental lossless codec (fourcc: FFV1)
</p></td></tr>
<tr><td><p> FFmpeg Snow </p></td><td><p> X </p></td><td><p> X </p></td><td><p> experimental wavelet codec (fourcc: SNOW)
</p></td></tr>
<tr><td><p> Asus v1 </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: ASV1
</p></td></tr>
<tr><td><p> Asus v2 </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: ASV2
</p></td></tr>
<tr><td><p> Creative YUV </p></td><td> </td><td><p> X </p></td><td><p> fourcc: CYUV
</p></td></tr>
<tr><td><p> Sorenson Video 1 </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: SVQ1
</p></td></tr>
<tr><td><p> Sorenson Video 3 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: SVQ3
</p></td></tr>
<tr><td><p> On2 VP3 </p></td><td> </td><td><p> X </p></td><td><p> still experimental
</p></td></tr>
<tr><td><p> On2 VP5 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: VP50
</p></td></tr>
<tr><td><p> On2 VP6 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: VP60,VP61,VP62
</p></td></tr>
<tr><td><p> Theora </p></td><td><p> X </p></td><td><p> X </p></td><td><p> still experimental
</p></td></tr>
<tr><td><p> Intel Indeo 3 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> FLV </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Sorenson H.263 used in Flash
</p></td></tr>
<tr><td><p> Flash Screen Video </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: FSV1
</p></td></tr>
<tr><td><p> ATI VCR1 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: VCR1
</p></td></tr>
<tr><td><p> ATI VCR2 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: VCR2
</p></td></tr>
<tr><td><p> Cirrus Logic AccuPak </p></td><td> </td><td><p> X </p></td><td><p> fourcc: CLJR
</p></td></tr>
<tr><td><p> 4X Video </p></td><td> </td><td><p> X </p></td><td><p> Used in certain computer games.
</p></td></tr>
<tr><td><p> Sony Playstation MDEC </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Id RoQ </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Used in Quake III, Jedi Knight 2, other computer games.
</p></td></tr>
<tr><td><p> Xan/WC3 </p></td><td> </td><td><p> X </p></td><td><p> Used in Wing Commander III .MVE files.
</p></td></tr>
<tr><td><p> Interplay Video </p></td><td> </td><td><p> X </p></td><td><p> Used in Interplay .MVE files.
</p></td></tr>
<tr><td><p> Apple Animation </p></td><td><p> X </p></td><td><p> X </p></td><td><p> fourcc: 'rle '
</p></td></tr>
<tr><td><p> Apple Graphics </p></td><td> </td><td><p> X </p></td><td><p> fourcc: 'smc '
</p></td></tr>
<tr><td><p> Apple Video </p></td><td> </td><td><p> X </p></td><td><p> fourcc: rpza
</p></td></tr>
<tr><td><p> Apple QuickDraw </p></td><td> </td><td><p> X </p></td><td><p> fourcc: qdrw
</p></td></tr>
<tr><td><p> Cinepak </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Microsoft RLE </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Microsoft Video-1 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Westwood VQA </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Id Cinematic Video </p></td><td> </td><td><p> X </p></td><td><p> Used in Quake II.
</p></td></tr>
<tr><td><p> Planar RGB </p></td><td> </td><td><p> X </p></td><td><p> fourcc: 8BPS
</p></td></tr>
<tr><td><p> FLIC video </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Duck TrueMotion v1 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: DUCK
</p></td></tr>
<tr><td><p> Duck TrueMotion v2 </p></td><td> </td><td><p> X </p></td><td><p> fourcc: TM20
</p></td></tr>
<tr><td><p> VMD Video </p></td><td> </td><td><p> X </p></td><td><p> Used in Sierra VMD files.
</p></td></tr>
<tr><td><p> MSZH </p></td><td> </td><td><p> X </p></td><td><p> Part of LCL
</p></td></tr>
<tr><td><p> ZLIB </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Part of LCL, encoder experimental
</p></td></tr>
<tr><td><p> TechSmith Camtasia </p></td><td> </td><td><p> X </p></td><td><p> fourcc: TSCC
</p></td></tr>
<tr><td><p> IBM Ultimotion </p></td><td> </td><td><p> X </p></td><td><p> fourcc: ULTI
</p></td></tr>
<tr><td><p> Miro VideoXL </p></td><td> </td><td><p> X </p></td><td><p> fourcc: VIXL
</p></td></tr>
<tr><td><p> QPEG </p></td><td> </td><td><p> X </p></td><td><p> fourccs: QPEG, Q1.0, Q1.1
</p></td></tr>
<tr><td><p> LOCO </p></td><td> </td><td><p> X </p></td><td>
</td></tr>
<tr><td><p> Winnov WNV1 </p></td><td> </td><td><p> X </p></td><td>
</td></tr>
<tr><td><p> Autodesk Animator Studio Codec </p></td><td> </td><td><p> X </p></td><td><p> fourcc: AASC
</p></td></tr>
<tr><td><p> Fraps FPS1 </p></td><td> </td><td><p> X </p></td><td>
</td></tr>
<tr><td><p> CamStudio </p></td><td> </td><td><p> X </p></td><td><p> fourcc: CSCD
</p></td></tr>
<tr><td><p> American Laser Games Video </p></td><td> </td><td><p> X </p></td><td><p> Used in games like Mad Dog McCree
</p></td></tr>
<tr><td><p> ZMBV </p></td><td><p> X </p></td><td><p> X </p></td><td><p> Encoder works only on PAL8
</p></td></tr>
<tr><td><p> AVS Video </p></td><td> </td><td><p> X </p></td><td><p> Video encoding used by the Creature Shock game.
</p></td></tr>
<tr><td><p> Smacker Video </p></td><td> </td><td><p> X </p></td><td><p> Video encoding used in Smacker.
</p></td></tr>
<tr><td><p> RTjpeg </p></td><td> </td><td><p> X </p></td><td><p> Video encoding used in NuppelVideo files.
</p></td></tr>
<tr><td><p> KMVC </p></td><td> </td><td><p> X </p></td><td><p> Codec used in Worms games.
</p></td></tr>
<tr><td><p> VMware Video </p></td><td> </td><td><p> X </p></td><td><p> Codec used in videos captured by VMware.
</p></td></tr>
<tr><td><p> Cin Video </p></td><td> </td><td><p> X </p></td><td><p> Codec used in Delphine Software games.
</p></td></tr>
<tr><td><p> Tiertex Seq Video </p></td><td> </td><td><p> X </p></td><td><p> Codec used in DOS CDROM FlashBack game.
</p></td></tr>
<tr><td><p> DXA Video </p></td><td> </td><td><p> X </p></td><td><p> Codec originally used in Feeble Files game.
</p></td></tr>
<tr><td><p> AVID DNxHD </p></td><td><p> X </p></td><td><p> X </p></td><td><p> aka SMPTE VC3
</p></td></tr>
<tr><td><p> C93 Video </p></td><td> </td><td><p> X </p></td><td><p> Codec used in Cyberia game.
</p></td></tr>
<tr><td><p> THP </p></td><td> </td><td><p> X </p></td><td><p> Used on the Nintendo GameCube.
</p></td></tr>
<tr><td><p> Bethsoft VID </p></td><td> </td><td><p> X </p></td><td><p> Used in some games from Bethesda Softworks.
</p></td></tr>
<tr><td><p> Renderware TXD </p></td><td> </td><td><p> X </p></td><td><p> Texture dictionaries used by the Renderware Engine.
</p></td></tr>
<tr><td><p> AMV </p></td><td> </td><td><p> X </p></td><td><p> Used in Chinese MP3 players.
</p></td></tr>
</table>
<p><code>X</code> means that encoding (resp. decoding) is supported.
</p>
<hr size="6">
<a name="SEC7"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC6" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 2.4 Audio Codecs </h2>
<table>
<tr><td><p> Supported Codec </p></td><td><p> Encoding </p></td><td><p> Decoding </p></td><td><p> Comments
</p></td></tr>
<tr><td><p> MPEG audio layer 2 </p></td><td><p> IX </p></td><td><p> IX
</p></td></tr>
<tr><td><p> MPEG audio layer 1/3 </p></td><td><p> X </p></td><td><p> IX
</p></td><td><p> MP3 encoding is supported through the external library LAME.
</p></td></tr>
<tr><td><p> AC3 </p></td><td><p> IX </p></td><td><p> IX
</p></td><td><p> liba52 is used internally for decoding.
</p></td></tr>
<tr><td><p> Vorbis </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> WMA V1/V2 </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> AAC </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Supported through the external library libfaac/libfaad.
</p></td></tr>
<tr><td><p> Microsoft ADPCM </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> AMV IMA ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in AMV files
</p></td></tr>
<tr><td><p> MS IMA ADPCM </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> QT IMA ADPCM </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> 4X IMA ADPCM </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> G.726 ADPCM </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Duck DK3 IMA ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in some Sega Saturn console games.
</p></td></tr>
<tr><td><p> Duck DK4 IMA ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in some Sega Saturn console games.
</p></td></tr>
<tr><td><p> Westwood Studios IMA ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in Westwood Studios games like Command and Conquer.
</p></td></tr>
<tr><td><p> SMJPEG IMA ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in certain Loki game ports.
</p></td></tr>
<tr><td><p> CD-ROM XA ADPCM </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> CRI ADX ADPCM </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Used in Sega Dreamcast games.
</p></td></tr>
<tr><td><p> Electronic Arts ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in various EA titles.
</p></td></tr>
<tr><td><p> Creative ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
</p></td></tr>
<tr><td><p> THP ADPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used on the Nintendo GameCube.
</p></td></tr>
<tr><td><p> RA144 </p></td><td> </td><td><p> X
</p></td><td><p> Real 14400 bit/s codec
</p></td></tr>
<tr><td><p> RA288 </p></td><td> </td><td><p> X
</p></td><td><p> Real 28800 bit/s codec
</p></td></tr>
<tr><td><p> RADnet </p></td><td><p> X </p></td><td><p> IX
</p></td><td><p> Real low bitrate AC3 codec, liba52 is used for decoding.
</p></td></tr>
<tr><td><p> AMR-NB </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Supported through an external library.
</p></td></tr>
<tr><td><p> AMR-WB </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Supported through an external library.
</p></td></tr>
<tr><td><p> DV audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Id RoQ DPCM </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> Used in Quake III, Jedi Knight 2, other computer games.
</p></td></tr>
<tr><td><p> Interplay MVE DPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in various Interplay computer games.
</p></td></tr>
<tr><td><p> Xan DPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in Origin's Wing Commander IV AVI files.
</p></td></tr>
<tr><td><p> Sierra Online DPCM </p></td><td> </td><td><p> X
</p></td><td><p> Used in Sierra Online game audio files.
</p></td></tr>
<tr><td><p> Apple MACE 3 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Apple MACE 6 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> FLAC lossless audio </p></td><td><p> X </p></td><td><p> X
</p></td></tr>
<tr><td><p> Shorten lossless audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Apple lossless audio </p></td><td> </td><td><p> X
</p></td><td><p> QuickTime fourcc 'alac'
</p></td></tr>
<tr><td><p> FFmpeg Sonic </p></td><td><p> X </p></td><td><p> X
</p></td><td><p> experimental lossy/lossless codec
</p></td></tr>
<tr><td><p> Qdesign QDM2 </p></td><td> </td><td><p> X
</p></td><td><p> there are still some distortions
</p></td></tr>
<tr><td><p> Real COOK </p></td><td> </td><td><p> X
</p></td><td><p> All versions except 5.1 are supported
</p></td></tr>
<tr><td><p> DSP Group TrueSpeech </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> True Audio (TTA) </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Smacker Audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> WavPack Audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Cin Audio </p></td><td> </td><td><p> X
</p></td><td><p> Codec used in Delphine Software games.
</p></td></tr>
<tr><td><p> Intel Music Coder </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Musepack </p></td><td> </td><td><p> X
</p></td><td><p> SV7 and SV8 are supported
</p></td></tr>
<tr><td><p> DT$ Coherent Audio </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> ATRAC 3 </p></td><td> </td><td><p> X
</p></td></tr>
<tr><td><p> Monkey's Audio </p></td><td> </td><td><p> X </p></td><td><p> Only versions 3.97-3.99 are supported
</p></td></tr>
<tr><td><p> Nellymoser ASAO </p></td><td> </td><td><p> X
</p></td></tr>
</table>
<p><code>X</code> means that encoding (resp. decoding) is supported.
</p>
<p><code>I</code> means that an integer-only version is available, too (ensures high
performance on systems without hardware floating point support).
</p>
<hr size="6">
<a name="SEC8"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC7" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC9" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 3. Platform Specific information </h1>
<hr size="6">
<a name="SEC9"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC8" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 3.1 BSD </h2>
<p>BSD make will not build FFmpeg, you need to install and use GNU Make
(‘<tt>gmake</tt>’).
</p>
<hr size="6">
<a name="SEC10"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC9" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC11" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 3.2 Windows </h2>
<p>To get help and instructions for building FFmpeg under Windows, check out
the FFmpeg Windows Help Forum at
<a href="http://arrozcru.no-ip.org/ffmpeg/">http://arrozcru.no-ip.org/ffmpeg/</a>.
</p>
<hr size="6">
<a name="SEC11"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC10" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC12" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 3.2.1 Native Windows compilation </h3>
<p>FFmpeg can be built to run natively on Windows using the MinGW tools. Install
the current versions of MSYS and MinGW from <a href="http://www.mingw.org/">http://www.mingw.org/</a>. Also
install the coreutils package. You can find detailed installation
instructions in the download section and the FAQ.
</p>
<p>Within the MSYS shell, configure and make with:
</p>
<table><tr><td> </td><td><pre class="example">./configure --enable-memalign-hack
make
make install
</pre></td></tr></table>
<p>This will install ‘<tt>ffmpeg.exe</tt>’ along with many other development files
to ‘<tt>/usr/local</tt>’. You may specify another install path using the
<code>--prefix</code> option in ‘<tt>configure</tt>’.
</p>
<p>Notes:
</p>
<ul class="toc">
<li> Use at least bash 3.1. Older versions are known to be fail on the
configure script.
</li><li> In order to compile vhooks, you must have a POSIX-compliant libdl in
your MinGW system. Get dlfcn-win32 from
<a href="http://code.google.com/p/dlfcn-win32">http://code.google.com/p/dlfcn-win32</a>.
</li><li> In order to compile FFplay, you must have the MinGW development library
of SDL. Get it from <a href="http://www.libsdl.org">http://www.libsdl.org</a>.
Edit the ‘<tt>bin/sdl-config</tt>’ script so that it points to the correct prefix
where SDL was installed. Verify that ‘<tt>sdl-config</tt>’ can be launched from
the MSYS command line.
</li><li> The target <code>make wininstaller</code> can be used to create a
Nullsoft-based Windows installer for FFmpeg and FFplay. ‘<tt>SDL.dll</tt>’
must be copied to the FFmpeg directory in order to build the
installer.
</li><li> By using <code>./configure --enable-shared</code> when configuring FFmpeg,
you can build libavutil, libavcodec and libavformat as DLLs.
</li></ul>
<hr size="6">
<a name="SEC12"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC11" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 3.2.2 Microsoft Visual C++ compatibility </h3>
<p>As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
want to use the libav* libraries in your own applications, you can still
compile those applications using MSVC++. But the libav* libraries you link
to <em>must</em> be built with MinGW. However, you will not be able to debug
inside the libav* libraries, since MSVC++ does not recognize the debug
symbols generated by GCC.
We strongly recommend you to move over from MSVC++ to MinGW tools.
</p>
<p>This description of how to use the FFmpeg libraries with MSVC++ is based on
Microsoft Visual C++ 2005 Express Edition. If you have a different version,
you might have to modify the procedures slightly.
</p>
<hr size="6">
<a name="SEC13"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC12" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC12" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 3.2.2.1 Using static libraries </h4>
<p>Assuming you have just built and installed FFmpeg in ‘<tt>/usr/local</tt>’.
</p>
<ol>
<li> Create a new console application ("File / New / Project") and then
select "Win32 Console Application". On the appropriate page of the
Application Wizard, uncheck the "Precompiled headers" option.
</li><li> Write the source code for your application, or, for testing, just
copy the code from an existing sample application into the source file
that MSVC++ has already created for you. For example, you can copy
‘<tt>output_example.c</tt>’ from the FFmpeg distribution.
</li><li> Open the "Project / Properties" dialog box. In the "Configuration"
combo box, select "All Configurations" so that the changes you make will
affect both debug and release builds. In the tree view on the left hand
side, select "C/C++ / General", then edit the "Additional Include
Directories" setting to contain the path where the FFmpeg includes were
installed (i.e. ‘<tt>c:\msys\1.0\local\include</tt>’).
</li><li> Still in the "Project / Properties" dialog box, select
"Linker / General" from the tree view and edit the
"Additional Library Directories" setting to contain the ‘<tt>lib</tt>’
directory where FFmpeg was installed (i.e. ‘<tt>c:\msys\1.0\local\lib</tt>’),
the directory where MinGW libs are installed (i.e. ‘<tt>c:\mingw\lib</tt>’),
and the directory where MinGW's GCC libs are installed
(i.e. ‘<tt>C:\mingw\lib\gcc\mingw32\4.2.1-sjlj</tt>’). Then select
"Linker / Input" from the tree view, and add the files ‘<tt>libavformat.a</tt>’,
‘<tt>libavcodec.a</tt>’, ‘<tt>libavutil.a</tt>’, ‘<tt>libmingwex.a</tt>’,
‘<tt>libgcc.a</tt>’, and any other libraries you used (i.e. ‘<tt>libz.a</tt>’)
to the end of "Additional Dependencies".
</li><li> Now, select "C/C++ / Code Generation" from the tree view. Select
"Debug" in the "Configuration" combo box. Make sure that "Runtime
Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
the "Configuration" combo box and make sure that "Runtime Library" is
set to "Multi-threaded DLL".
</li><li> Click "OK" to close the "Project / Properties" dialog box.
</li><li> MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
Get msinttypes from <a href="http://code.google.com/p/msinttypes/downloads/list">http://code.google.com/p/msinttypes/downloads/list</a>
and install it in MSVC++'s include directory
(i.e. ‘<tt>C:\Program Files\Microsoft Visual Studio 8\VC\include</tt>’).
</li><li> MSVC++ also does not understand the <code>inline</code> keyword used by
FFmpeg, so you must add this line before <code>#include</code>ing libav*:
<table><tr><td> </td><td><pre class="example">#define inline _inline
</pre></td></tr></table>
</li><li> If you used ‘<tt>output_example.c</tt>’ as your sample application,
you will have to edit the <code>#include</code>s to point to the files which
are under the ‘<tt>ffmpeg</tt>’ directory (i.e. <code><ffmpeg/avformat.h></code>).
</li><li> Build your application, everything should work.
</li></ol>
<hr size="6">
<a name="SEC14"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC13" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC15" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC12" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 3.2.2.2 Using shared libraries </h4>
<p>This is how to create DLL and LIB files that are compatible with MSVC++:
</p>
<ol>
<li> Add a call to ‘<tt>vcvars32.bat</tt>’ (which sets up the environment
variables for the Visual C++ tools) as the first line of ‘<tt>msys.bat</tt>’.
The standard location for ‘<tt>vcvars32.bat</tt>’ is
‘<tt>C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat</tt>’,
and the standard location for ‘<tt>msys.bat</tt>’ is ‘<tt>C:\msys\1.0\msys.bat</tt>’.
If this corresponds to your setup, add the following line as the first line
of ‘<tt>msys.bat</tt>’:
<table><tr><td> </td><td><pre class="example">call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
</pre></td></tr></table>
<p>Alternatively, you may start the ‘<tt>Visual Studio 2005 Command Prompt</tt>’,
and run ‘<tt>c:\msys\1.0\msys.bat</tt>’ from there.
</p>
</li><li> Within the MSYS shell, run <code>lib.exe</code>. If you get a help message
from ‘<tt>Microsoft (R) Library Manager</tt>’, this means your environment
variables are set up correctly, the ‘<tt>Microsoft (R) Library Manager</tt>’
is on the path and will be used by FFmpeg to create
MSVC++-compatible import libraries.
</li><li> Build FFmpeg with
<table><tr><td> </td><td><pre class="example">./configure --enable-shared --enable-memalign-hack
make
make install
</pre></td></tr></table>
<p>Your install path (‘<tt>/usr/local/</tt>’ by default) should now have the
necessary DLL and LIB files under the ‘<tt>bin</tt>’ directory.
</p>
</li></ol>
<p>To use those files with MSVC++, do the same as you would do with
the static libraries, as described above. But in Step 4,
you should only need to add the directory where the LIB files are installed
(i.e. ‘<tt>c:\msys\usr\local\bin</tt>’). This is not a typo, the LIB files are
installed in the ‘<tt>bin</tt>’ directory. And instead of adding ‘<tt>libxx.a</tt>’
files, you should add ‘<tt>avcodec.lib</tt>’, ‘<tt>avformat.lib</tt>’, and
‘<tt>avutil.lib</tt>’. There should be no need for ‘<tt>libmingwex.a</tt>’,
‘<tt>libgcc.a</tt>’, and ‘<tt>wsock32.lib</tt>’, nor any other external library
statically linked into the DLLs. The ‘<tt>bin</tt>’ directory contains a bunch
of DLL files, but the ones that are actually used to run your application
are the ones with a major version number in their filenames
(i.e. ‘<tt>avcodec-51.dll</tt>’).
</p>
<hr size="6">
<a name="SEC15"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC14" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC16" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 3.2.3 Cross compilation for Windows with Linux </h3>
<p>You must use the MinGW cross compilation tools available at
<a href="http://www.mingw.org/">http://www.mingw.org/</a>.
</p>
<p>Then configure FFmpeg with the following options:
</p><table><tr><td> </td><td><pre class="example">./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
</pre></td></tr></table>
<p>(you can change the cross-prefix according to the prefix chosen for the
MinGW tools).
</p>
<p>Then you can easily test FFmpeg with Wine
(<a href="http://www.winehq.com/">http://www.winehq.com/</a>).
</p>
<hr size="6">
<a name="SEC16"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC15" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 3.2.4 Compilation under Cygwin </h3>
<p>The main issue with Cygwin is that newlib, its C library, does not
contain llrint(). However, it is possible to leverage the
implementation in MinGW.
</p>
<p>Just install your Cygwin with all the "Base" packages, plus the
following "Devel" ones:
</p><table><tr><td> </td><td><pre class="example">binutils, gcc-core, make, subversion, mingw-runtime
</pre></td></tr></table>
<p>Do not install binutils-20060709-1 (they are buggy on shared builds);
use binutils-20050610-1 instead.
</p>
<p>Then create a small library that just contains llrint():
</p>
<table><tr><td> </td><td><pre class="example">ar x /usr/lib/mingw/libmingwex.a llrint.o
ar cq /usr/local/lib/libllrint.a llrint.o
</pre></td></tr></table>
<p>Then run
</p>
<table><tr><td> </td><td><pre class="example">./configure --enable-static --disable-shared --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
</pre></td></tr></table>
<p>to make a static build or
</p>
<table><tr><td> </td><td><pre class="example">./configure --enable-shared --disable-static --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
</pre></td></tr></table>
<p>to build shared libraries.
</p>
<p>If you want to build FFmpeg with additional libraries, download Cygwin
"Devel" packages for Ogg and Vorbis from any Cygwin packages repository
and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
(<a href="http://cygwinports.dotsrc.org/">http://cygwinports.dotsrc.org/</a>).
</p>
<hr size="6">
<a name="SEC17"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC16" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC18" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 3.2.5 Crosscompilation for Windows under Cygwin </h3>
<p>With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
</p>
<p>Just install your Cygwin as explained before, plus these additional
"Devel" packages:
</p><table><tr><td> </td><td><pre class="example">gcc-mingw-core, mingw-runtime, mingw-zlib
</pre></td></tr></table>
<p>and add some special flags to your configure invocation.
</p>
<p>For a static build run
</p><table><tr><td> </td><td><pre class="example">./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
</pre></td></tr></table>
<p>and for a build with shared libraries
</p><table><tr><td> </td><td><pre class="example">./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
</pre></td></tr></table>
<hr size="6">
<a name="SEC18"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC17" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC19" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 3.3 BeOS </h2>
<p>BeOS support is broken in mysterious ways.
</p>
<hr size="6">
<a name="SEC19"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC18" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 3.4 OS/2 </h2>
<p>For information about compiling FFmpeg on OS/2 see
<a href="http://www.edm2.com/index.php/FFmpeg">http://www.edm2.com/index.php/FFmpeg</a>.
</p>
<hr size="6">
<a name="SEC20"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC19" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC8" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 4. Developers Guide </h1>
<hr size="6">
<a name="SEC21"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC20" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC22" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.1 API </h2>
<ul>
<li> libavcodec is the library containing the codecs (both encoding and
decoding). Look at ‘<tt>libavcodec/apiexample.c</tt>’ to see how to use it.
</li><li> libavformat is the library containing the file format handling (mux and
demux code for several formats). Look at ‘<tt>ffplay.c</tt>’ to use it in a
player. See ‘<tt>output_example.c</tt>’ to use it to generate audio or video
streams.
</li></ul>
<hr size="6">
<a name="SEC22"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC21" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC23" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.2 Integrating libavcodec or libavformat in your program </h2>
<p>You can integrate all the source code of the libraries to link them
statically to avoid any version problem. All you need is to provide a
'config.mak' and a 'config.h' in the parent directory. See the defines
generated by ./configure to understand what is needed.
</p>
<p>You can use libavcodec or libavformat in your commercial program, but
<em>any patch you make must be published</em>. The best way to proceed is
to send your patches to the FFmpeg mailing list.
</p>
<hr size="6">
<a name="Coding-Rules"></a>
<a name="SEC23"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC22" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC24" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.3 Coding Rules </h2>
<p>FFmpeg is programmed in the ISO C90 language with a few additional
features from ISO C99, namely:
</p><ul>
<li>
the ‘<samp>inline</samp>’ keyword;
</li><li>
‘<samp>//</samp>’ comments;
</li><li>
designated struct initializers (‘<samp>struct s x = { .i = 17 };</samp>’)
</li><li>
compound literals (‘<samp>x = (struct s) { 17, 23 };</samp>’)
</li></ul>
<p>These features are supported by all compilers we care about, so we will not
accept patches to remove their use unless they absolutely do not impair
clarity and performance.
</p>
<p>All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
compiles with several other compilers, such as the Compaq ccc compiler
or Sun Studio 9, and we would like to keep it that way unless it would
be exceedingly involved. To ensure compatibility, please do not use any
additional C99 features or GCC extensions. Especially watch out for:
</p><ul>
<li>
mixing statements and declarations;
</li><li>
‘<samp>long long</samp>’ (use ‘<samp>int64_t</samp>’ instead);
</li><li>
‘<samp>__attribute__</samp>’ not protected by ‘<samp>#ifdef __GNUC__</samp>’ or similar;
</li><li>
GCC statement expressions (‘<samp>(x = ({ int y = 4; y; })</samp>’).
</li></ul>
<p>Indent size is 4.
The presentation is the one specified by 'indent -i4 -kr -nut'.
The TAB character is forbidden outside of Makefiles as is any
form of trailing whitespace. Commits containing either will be
rejected by the Subversion repository.
</p>
<p>The main priority in FFmpeg is simplicity and small code size in order to
minimize the bug count.
</p>
<p>Comments: Use the JavaDoc/Doxygen
format (see examples below) so that code documentation
can be generated automatically. All nontrivial functions should have a comment
above them explaining what the function does, even if it is just one sentence.
All structures and their member variables should be documented, too.
</p><table><tr><td> </td><td><pre class="example">/**
* @file mpeg.c
* MPEG codec.
* @author ...
*/
/**
* Summary sentence.
* more text ...
* ...
*/
typedef struct Foobar{
int var1; /**< var1 description */
int var2; ///< var2 description
/** var3 description */
int var3;
} Foobar;
/**
* Summary sentence.
* more text ...
* ...
* @param my_parameter description of my_parameter
* @return return value description
*/
int myfunc(int my_parameter)
...
</pre></td></tr></table>
<p>fprintf and printf are forbidden in libavformat and libavcodec,
please use av_log() instead.
</p>
<p>Casts should be used only when necessary. Unneeded parentheses
should also be avoided if they don't make the code easier to understand.
</p>
<hr size="6">
<a name="SEC24"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC23" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.4 Development Policy </h2>
<ol>
<li>
Contributions should be licensed under the LGPL 2.1, including an
"or any later version" clause, or the MIT license. GPL 2 including
an "or any later version" clause is also acceptable, but LGPL is
preferred.
</li><li>
You must not commit code which breaks FFmpeg! (Meaning unfinished but
enabled code which breaks compilation or compiles but does not work or
breaks the regression tests)
You can commit unfinished stuff (for testing etc), but it must be disabled
(#ifdef etc) by default so it does not interfere with other developers'
work.
</li><li>
You do not have to over-test things. If it works for you, and you think it
should work for others, then commit. If your code has problems
(portability, triggers compiler bugs, unusual environment etc) they will be
reported and eventually fixed.
</li><li>
Do not commit unrelated changes together, split them into self-contained
pieces. Also do not forget that if part B depends on part A, but A does not
depend on B, then A can and should be committed first and separate from B.
Keeping changes well split into self-contained parts makes reviewing and
understanding them on the commit log mailing list easier. This also helps
in case of debugging later on.
Also if you have doubts about splitting or not splitting, do not hesitate to
ask/discuss it on the developer mailing list.
</li><li>
Do not change behavior of the program (renaming options etc) without
first discussing it on the ffmpeg-devel mailing list. Do not remove
functionality from the code. Just improve!
<p> Note: Redundant code can be removed.
</p></li><li>
Do not commit changes to the build system (Makefiles, configure script)
which change behavior, defaults etc, without asking first. The same
applies to compiler warning fixes, trivial looking fixes and to code
maintained by other developers. We usually have a reason for doing things
the way we do. Send your changes as patches to the ffmpeg-devel mailing
list, and if the code maintainers say OK, you may commit. This does not
apply to files you wrote and/or maintain.
</li><li>
We refuse source indentation and other cosmetic changes if they are mixed
with functional changes, such commits will be rejected and removed. Every
developer has his own indentation style, you should not change it. Of course
if you (re)write something, you can use your own style, even though we would
prefer if the indentation throughout FFmpeg was consistent (Many projects
force a given indentation style - we do not.). If you really need to make
indentation changes (try to avoid this), separate them strictly from real
changes.
<p> NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code,
then either do NOT change the indentation of the inner part within (do not
move it to the right)! or do so in a separate commit
</p></li><li>
Always fill out the commit log message. Describe in a few lines what you
changed and why. You can refer to mailing list postings if you fix a
particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
</li><li>
If you apply a patch by someone else, include the name and email address in
the log message. Since the ffmpeg-cvslog mailing list is publicly
archived you should add some SPAM protection to the email address. Send an
answer to ffmpeg-devel (or wherever you got the patch from) saying that
you applied the patch.
</li><li>
When applying patches that have been discussed (at length) on the mailing
list, reference the thread in the log message.
</li><li>
Do NOT commit to code actively maintained by others without permission.
Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
timeframe (12h for build failures and security fixes, 3 days small changes,
1 week for big patches) then commit your patch if you think it is OK.
Also note, the maintainer can simply ask for more time to review!
</li><li>
Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
are sent there and reviewed by all the other developers. Bugs and possible
improvements or general questions regarding commits are discussed there. We
expect you to react if problems with your code are uncovered.
</li><li>
Update the documentation if you change behavior or add features. If you are
unsure how best to do this, send a patch to ffmpeg-devel, the documentation
maintainer(s) will review and commit your stuff.
</li><li>
Try to keep important discussions and requests (also) on the public
developer mailing list, so that all developers can benefit from them.
</li><li>
Never write to unallocated memory, never write over the end of arrays,
always check values read from some untrusted source before using them
as array index or other risky things.
</li><li>
Remember to check if you need to bump versions for the specific libav
parts (libavutil, libavcodec, libavformat) you are changing. You need
to change the version integer and the version string.
Incrementing the first component means no backward compatibility to
previous versions (e.g. removal of a function from the public API).
Incrementing the second component means backward compatible change
(e.g. addition of a function to the public API).
Incrementing the third component means a noteworthy binary compatible
change (e.g. encoder bug fix that matters for the decoder).
</li><li>
If you add a new codec, remember to update the changelog, add it to
the supported codecs table in the documentation and bump the second
component of the ‘<tt>libavcodec</tt>’ version number appropriately. If
it has a fourcc, add it to ‘<tt>libavformat/avienc.c</tt>’, even if it
is only a decoder.
</li><li>
Do not change code to hide warnings without ensuring that the underlying
logic is correct and thus the warning was inappropriate.
</li><li>
If you add a new file, give it a proper license header. Do not copy and
paste it from a random place, use an existing file as template.
</li></ol>
<p>We think our rules are not too hard. If you have comments, contact us.
</p>
<p>Note, these rules are mostly borrowed from the MPlayer project.
</p>
<hr size="6">
<a name="SEC25"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC24" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC26" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.5 Submitting patches </h2>
<p>First, (see section <a href="#SEC23">Coding Rules</a>) above if you did not yet.
</p>
<p>When you submit your patch, try to send a unified diff (diff '-up'
option). We cannot read other diffs :-)
</p>
<p>Also please do not submit a patch which contains several unrelated changes.
Split it into separate, self-contained pieces. This does not mean splitting
file by file. Instead, make the patch as small as possible while still
keeping it as a logical unit that contains an individual change, even
if it spans multiple files. This makes reviewing your patches much easier
for us and greatly increases your chances of getting your patch applied.
</p>
<p>Run the regression tests before submitting a patch so that you can
verify that there are no big problems.
</p>
<p>Patches should be posted as base64 encoded attachments (or any other
encoding which ensures that the patch will not be trashed during
transmission) to the ffmpeg-devel mailing list, see
<a href="http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel">http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel</a>
</p>
<p>It also helps quite a bit if you tell us what the patch does (for example
'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
and has no lrint()')
</p>
<p>Also please if you send several patches, send each patch as a separate mail,
do not attach several unrelated patches to the same mail.
</p>
<hr size="6">
<a name="SEC26"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC25" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC27" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.6 patch submission checklist </h2>
<ol>
<li>
Do the regression tests pass with the patch applied?
</li><li>
Is the patch a unified diff?
</li><li>
Is the patch against latest FFmpeg SVN?
</li><li>
Are you subscribed to ffmpeg-dev?
(the list is subscribers only due to spam)
</li><li>
Have you checked that the changes are minimal, so that the same cannot be
achieved with a smaller patch and/or simpler final code?
</li><li>
If the change is to speed critical code, did you benchmark it?
</li><li>
If you did any benchmarks, did you provide them in the mail?
</li><li>
Have you checked that the patch does not introduce buffer overflows or
other security issues?
</li><li>
Is the patch created from the root of the source tree, so it can be
applied with <code>patch -p0</code>?
</li><li>
Does the patch not mix functional and cosmetic changes?
</li><li>
Did you add tabs or trailing whitespace to the code? Both are forbidden.
</li><li>
Is the patch attached to the email you send?
</li><li>
Is the mime type of the patch correct? It should be text/x-diff or
text/x-patch or at least text/plain and not application/octet-stream.
</li><li>
If the patch fixes a bug, did you provide a verbose analysis of the bug?
</li><li>
If the patch fixes a bug, did you provide enough information, including
a sample, so the bug can be reproduced and the fix can be verified?
Note please do not attach samples >100k to mails but rather provide a
URL, you can upload to ftp://upload.mplayerhq.hu
</li><li>
Did you provide a verbose summary about what the patch does change?
</li><li>
Did you provide a verbose explanation why it changes things like it does?
</li><li>
Did you provide a verbose summary of the user visible advantages and
disadvantages if the patch is applied?
</li><li>
Did you provide an example so we can verify the new feature added by the
patch easily?
</li><li>
If you added a new file, did you insert a license header? It should be
taken from FFmpeg, not randomly copied and pasted from somewhere else.
</li><li>
You should maintain alphabetical order in alphabetically ordered lists as
long as doing so does not break API/ABI compatibility.
</li><li>
Lines with similar content should be aligned vertically when doing so
improves readability.
</li><li>
Did you provide a suggestion for a clear commit log message?
</li><li>
Did you test your decoder or demuxer against damaged data? If no, see
tools/trasher and the noise bitstream filter. Your decoder or demuxer
should not crash or end in a (near) infinite loop when fed damaged data.
</li></ol>
<hr size="6">
<a name="SEC27"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC26" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.7 Patch review process </h2>
<p>All patches posted to ffmpeg-devel will be reviewed, unless they contain a
clear note that the patch is not for SVN.
Reviews and comments will be posted as replies to the patch on the
mailing list. The patch submitter then has to take care of every comment,
that can be by resubmitting a changed patch or by discussion. Resubmitted
patches will themselves be reviewed like any other patch. If at some point
a patch passes review with no comments then it is approved, that can for
simple and small patches happen immediately while large patches will generally
have to be changed and reviewed many times before they are approved.
After a patch is approved it will be committed to the repository.
</p>
<p>We will review all submitted patches, but sometimes we are quite busy so
especially for large patches this can take several weeks.
</p>
<p>When resubmitting patches, please do not make any significant changes
not related to the comments received during review. Such patches will
be rejected. Instead, submit significant changes or new features as
separate patches.
</p>
<hr size="6">
<a name="SEC28"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC27" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[ > ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC20" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.8 Regression tests </h2>
<p>Before submitting a patch (or committing to the repository), you should at least
test that you did not break anything.
</p>
<p>The regression tests build a synthetic video stream and a synthetic
audio stream. These are then encoded and decoded with all codecs or
formats. The CRC (or MD5) of each generated file is recorded in a
result file. A 'diff' is launched to compare the reference results and
the result file.
</p>
<p>The regression tests then go on to test the FFserver code with a
limited set of streams. It is important that this step runs correctly
as well.
</p>
<p>Run 'make test' to test all the codecs and formats.
</p>
<p>Run 'make fulltest' to test all the codecs, formats and FFserver.
</p>
<p>[Of course, some patches may change the results of the regression tests. In
this case, the reference results of the regression tests shall be modified
accordingly].
</p>
<hr size="6">
<a name="SEC_About"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC1" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[Contents]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>About This Document</h1>
<p>
This document was generated on <i>March, 17 2008</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.78</i></a>.
</p>
<p>
The buttons in the navigation panels have the following meaning:
</p>
<table border="1">
<tr>
<th> Button </th>
<th> Name </th>
<th> Go to </th>
<th> From 1.2.3 go to</th>
</tr>
<tr>
<td align="center"> [ < ] </td>
<td align="center">Back</td>
<td>Previous section in reading order</td>
<td>1.2.2</td>
</tr>
<tr>
<td align="center"> [ > ] </td>
<td align="center">Forward</td>
<td>Next section in reading order</td>
<td>1.2.4</td>
</tr>
<tr>
<td align="center"> [ << ] </td>
<td align="center">FastBack</td>
<td>Beginning of this chapter or previous chapter</td>
<td>1</td>
</tr>
<tr>
<td align="center"> [ Up ] </td>
<td align="center">Up</td>
<td>Up section</td>
<td>1.2</td>
</tr>
<tr>
<td align="center"> [ >> ] </td>
<td align="center">FastForward</td>
<td>Next chapter</td>
<td>2</td>
</tr>
<tr>
<td align="center"> [Top] </td>
<td align="center">Top</td>
<td>Cover (top) of document</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Contents] </td>
<td align="center">Contents</td>
<td>Table of contents</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Index] </td>
<td align="center">Index</td>
<td>Index</td>
<td> </td>
</tr>
<tr>
<td align="center"> [ ? ] </td>
<td align="center">About</td>
<td>About (help)</td>
<td> </td>
</tr>
</table>
<p>
where the <strong> Example </strong> assumes that the current position is at <strong> Subsubsection One-Two-Three </strong> of a document of the following structure:
</p>
<ul>
<li> 1. Section One
<ul>
<li>1.1 Subsection One-One
<ul>
<li>...</li>
</ul>
</li>
<li>1.2 Subsection One-Two
<ul>
<li>1.2.1 Subsubsection One-Two-One</li>
<li>1.2.2 Subsubsection One-Two-Two</li>
<li>1.2.3 Subsubsection One-Two-Three
<strong><== Current Position </strong></li>
<li>1.2.4 Subsubsection One-Two-Four</li>
</ul>
</li>
<li>1.3 Subsection One-Three
<ul>
<li>...</li>
</ul>
</li>
<li>1.4 Subsection One-Four</li>
</ul>
</li>
</ul>
<hr size="1">
<p>
<font size="-1">
This document was generated on <i>March, 17 2008</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.78</i></a>.
</font>
<br>
</p>
</body>
</html>
