Commit | Line | Data |
---|---|---|
d0e1cd3d DB |
1 | \input texinfo @c -*- texinfo -*- |
2 | ||
3 | @settitle General Documentation | |
4 | @titlepage | |
5 | @sp 7 | |
6 | @center @titlefont{General Documentation} | |
7 | @sp 3 | |
8 | @end titlepage | |
9 | ||
10 | ||
11 | @chapter external libraries | |
12 | ||
13 | FFmpeg can be hooked up with a number of external libraries to add support | |
14 | for more formats. None of them are used by default, their use has to be | |
15 | explicitly requested by passing the appropriate flags to @file{./configure}. | |
16 | ||
87a84431 | 17 | @section OpenCORE AMR |
d0e1cd3d | 18 | |
87a84431 DB |
19 | FFmpeg can make use of the OpenCORE libraries for AMR-NB |
20 | decoding/encoding and AMR-WB decoding. | |
0b175caa | 21 | |
1eb0811e | 22 | Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for |
0b175caa DB |
23 | installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or |
24 | @code{--enable-libopencore-amrwb} to configure to enable the libraries. | |
25 | ||
26 | Note that OpenCORE is under the Apache License 2.0 (see | |
27 | @url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is | |
28 | incompatible with the LGPL version 2.1 and GPL version 2. You have to | |
29 | upgrade FFmpeg's license to LGPL version 3 (or if you have enabled | |
30 | GPL components, GPL version 3) to use it. | |
31 | ||
d0e1cd3d DB |
32 | |
33 | @chapter Supported File Formats and Codecs | |
34 | ||
0584b718 | 35 | You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list. |
d0e1cd3d DB |
36 | |
37 | @section File Formats | |
38 | ||
39 | FFmpeg supports the following file formats through the @code{libavformat} | |
40 | library: | |
41 | ||
42 | @multitable @columnfractions .4 .1 .1 .4 | |
b3de4544 | 43 | @item Name @tab Encoding @tab Decoding @tab Comments |
64c2f20a | 44 | @item 4xm @tab @tab X |
c6b2dc34 | 45 | @tab 4X Technologies format, used in some games. |
f0b19bd3 | 46 | @item 8088flex TMV @tab @tab X |
574b183d | 47 | @item Adobe Filmstrip @tab X @tab X |
39271be4 | 48 | @item Audio IFF (AIFF) @tab X @tab X |
64c2f20a DB |
49 | @item American Laser Games MM @tab @tab X |
50 | @tab Multimedia format used in games like Mad Dog McCree. | |
39271be4 | 51 | @item 3GPP AMR @tab X @tab X |
c6b2dc34 DB |
52 | @item ASF @tab X @tab X |
53 | @item AVI @tab X @tab X | |
39271be4 | 54 | @item AVISynth @tab @tab X |
c6b2dc34 | 55 | @item AVS @tab @tab X |
d698c5d3 | 56 | @tab Multimedia format used by the Creature Shock game. |
913c3e2c DB |
57 | @item Beam Software SIFF @tab @tab X |
58 | @tab Audio and video format used in some games by Beam Software. | |
59 | @item Bethesda Softworks VID @tab @tab X | |
d698c5d3 | 60 | @tab Used in some games from Bethesda Softworks. |
2e375df5 PR |
61 | @item Bink @tab @tab X |
62 | @tab Multimedia format used by many games. | |
913c3e2c DB |
63 | @item Brute Force & Ignorance @tab @tab X |
64 | @tab Used in the game Flash Traffic: City of Angels. | |
65 | @item Interplay C93 @tab @tab X | |
d698c5d3 | 66 | @tab Used in the game Cyberia from Interplay. |
913c3e2c | 67 | @item Delphine Software International CIN @tab @tab X |
d698c5d3 | 68 | @tab Multimedia format used by Delphine Software games. |
a3d995c1 MT |
69 | @item CD+G @tab @tab X |
70 | @tab Video format used by CD+G karaoke disks | |
5f14b565 PR |
71 | @item Core Audio Format @tab @tab X |
72 | @tab Apple Core Audio Format | |
39271be4 | 73 | @item CRC testing format @tab X @tab |
913c3e2c | 74 | @item Creative Voice @tab X @tab X |
d698c5d3 | 75 | @tab Created for the Sound Blaster Pro. |
64c2f20a DB |
76 | @item CRYO APC @tab @tab X |
77 | @tab Audio format used in some games by CRYO Interactive Entertainment. | |
39271be4 | 78 | @item D-Cinema audio @tab X @tab X |
e6565055 | 79 | @item Deluxe Paint Animation @tab @tab X |
913c3e2c | 80 | @item DV video @tab X @tab X |
c6b2dc34 | 81 | @item DXA @tab @tab X |
d698c5d3 DB |
82 | @tab This format is used in the non-Windows version of the Feeble Files |
83 | game and different game cutscenes repacked for use with ScummVM. | |
39271be4 | 84 | @item Electronic Arts cdata @tab @tab X |
c6b2dc34 | 85 | @item Electronic Arts Multimedia @tab @tab X |
d698c5d3 | 86 | @tab Used in various EA games; files have extensions like WVE and UV2. |
39271be4 DB |
87 | @item FFM (FFserver live feed) @tab X @tab X |
88 | @item Flash (SWF) @tab X @tab X | |
913c3e2c DB |
89 | @item Flash 9 (AVM2) @tab X @tab X |
90 | @tab Only embedded audio is decoded. | |
91 | @item FLI/FLC/FLX animation @tab @tab X | |
d698c5d3 | 92 | @tab .fli/.flc files |
dd2d651d | 93 | @item Flash Video (FLV) @tab @tab X |
d698c5d3 | 94 | @tab Macromedia Flash video files |
39271be4 | 95 | @item framecrc testing format @tab X @tab |
055dc116 SG |
96 | @item FunCom ISS @tab @tab X |
97 | @tab Audio format used in various games from FunCom like The Longest Journey. | |
39271be4 | 98 | @item GIF Animation @tab X @tab |
c6b2dc34 | 99 | @item GXF @tab X @tab X |
d698c5d3 | 100 | @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley |
64c2f20a | 101 | playout servers. |
dd2d651d | 102 | @item id Quake II CIN video @tab @tab X |
76ec3939 | 103 | @item id RoQ @tab X @tab X |
d698c5d3 | 104 | @tab Used in Quake III, Jedi Knight 2, other computer games. |
ab1eff9c | 105 | @item IEC61937 encapsulation @tab X @tab |
c6b2dc34 | 106 | @item IFF @tab @tab X |
d698c5d3 | 107 | @tab Interchange File Format |
c6b2dc34 | 108 | @item Interplay MVE @tab @tab X |
d698c5d3 | 109 | @tab Format used in various Interplay computer games. |
7c3c53c8 RP |
110 | @item IV8 @tab @tab X |
111 | @tab A format generated by IndigoVision 8000 video server. | |
173bb37f DC |
112 | @item IVF (On2) @tab @tab X |
113 | @tab A format used by libvpx | |
c6b2dc34 | 114 | @item LMLM4 @tab @tab X |
d698c5d3 | 115 | @tab Used by Linux Media Labs MPEG-4 PCI boards |
64c2f20a | 116 | @item Matroska @tab X @tab X |
39271be4 | 117 | @item Matroska audio @tab X @tab |
913c3e2c | 118 | @item MAXIS XA @tab @tab X |
d698c5d3 | 119 | @tab Used in Sim City 3000; file extension .xa. |
61dc238b | 120 | @item MD Studio @tab @tab X |
64c2f20a | 121 | @item Monkey's Audio @tab @tab X |
822cc8f7 | 122 | @item Motion Pixels MVI @tab @tab X |
913c3e2c DB |
123 | @item MOV/QuickTime/MP4 @tab X @tab X |
124 | @tab 3GP, 3GP2, PSP, iPod variants supported | |
4d973c68 DB |
125 | @item MP2 @tab X @tab X |
126 | @item MP3 @tab X @tab X | |
913c3e2c DB |
127 | @item MPEG-1 System @tab X @tab X |
128 | @tab muxed audio and video, VCD format supported | |
129 | @item MPEG-PS (program stream) @tab X @tab X | |
130 | @tab also known as @code{VOB} file, SVCD and DVD format supported | |
131 | @item MPEG-TS (transport stream) @tab X @tab X | |
d698c5d3 | 132 | @tab also known as DVB Transport Stream |
c6b2dc34 | 133 | @item MPEG-4 @tab X @tab X |
d698c5d3 | 134 | @tab MPEG-4 is a variant of QuickTime. |
39271be4 | 135 | @item MIME multipart JPEG @tab X @tab |
bac4c85c | 136 | @item MSN TCP webcam @tab @tab X |
d698c5d3 | 137 | @tab Used by MSN Messenger webcam streams. |
39271be4 DB |
138 | @item MTV @tab @tab X |
139 | @item Musepack @tab @tab X | |
140 | @item Musepack SV8 @tab @tab X | |
913c3e2c DB |
141 | @item Material eXchange Format (MXF) @tab X @tab X |
142 | @tab SMPTE 377M, used by D-Cinema, broadcast industry. | |
a9d3c669 BC |
143 | @item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X |
144 | @tab SMPTE 386M, D-10/IMX Mapping. | |
913c3e2c DB |
145 | @item NC camera feed @tab @tab X |
146 | @tab NC (AVIP NC4600) camera streams | |
ade29f99 JR |
147 | @item NTT TwinVQ (VQF) @tab @tab X |
148 | @tab Nippon Telegraph and Telephone Corporation TwinVQ. | |
913c3e2c | 149 | @item Nullsoft Streaming Video @tab @tab X |
39271be4 | 150 | @item NuppelVideo @tab @tab X |
c6b2dc34 | 151 | @item NUT @tab X @tab X |
d698c5d3 | 152 | @tab NUT Open Container Format |
39271be4 | 153 | @item Ogg @tab X @tab X |
913c3e2c | 154 | @item TechnoTrend PVA @tab @tab X |
d698c5d3 | 155 | @tab Used by TechnoTrend DVB PCI boards. |
cdce0fb8 | 156 | @item QCP @tab @tab X |
43dedc1e | 157 | @item raw ADTS (AAC) @tab X @tab X |
76ec3939 | 158 | @item raw AC-3 @tab X @tab X |
adc5abf7 | 159 | @item raw Chinese AVS video @tab @tab X |
43dedc1e DB |
160 | @item raw CRI ADX @tab X @tab X |
161 | @item raw Dirac @tab X @tab X | |
162 | @item raw DNxHD @tab X @tab X | |
163 | @item raw DTS @tab X @tab X | |
164 | @item raw E-AC-3 @tab X @tab X | |
165 | @item raw FLAC @tab X @tab X | |
166 | @item raw GSM @tab @tab X | |
167 | @item raw H.261 @tab X @tab X | |
168 | @item raw H.263 @tab X @tab X | |
169 | @item raw H.264 @tab X @tab X | |
170 | @item raw Ingenient MJPEG @tab @tab X | |
76ec3939 | 171 | @item raw MJPEG @tab X @tab X |
43dedc1e DB |
172 | @item raw MLP @tab @tab X |
173 | @item raw MPEG @tab @tab X | |
174 | @item raw MPEG-1 @tab @tab X | |
175 | @item raw MPEG-2 @tab @tab X | |
176 | @item raw MPEG-4 @tab X @tab X | |
177 | @item raw NULL @tab X @tab | |
81b55ee5 | 178 | @item raw video @tab X @tab X |
43dedc1e DB |
179 | @item raw id RoQ @tab X @tab |
180 | @item raw Shorten @tab @tab X | |
23d9cc45 | 181 | @item raw TrueHD @tab X @tab X |
43dedc1e DB |
182 | @item raw VC-1 @tab @tab X |
183 | @item raw PCM A-law @tab X @tab X | |
184 | @item raw PCM mu-law @tab X @tab X | |
185 | @item raw PCM signed 8 bit @tab X @tab X | |
186 | @item raw PCM signed 16 bit big-endian @tab X @tab X | |
187 | @item raw PCM signed 16 bit little-endian @tab X @tab X | |
188 | @item raw PCM signed 24 bit big-endian @tab X @tab X | |
189 | @item raw PCM signed 24 bit little-endian @tab X @tab X | |
190 | @item raw PCM signed 32 bit big-endian @tab X @tab X | |
191 | @item raw PCM signed 32 bit little-endian @tab X @tab X | |
192 | @item raw PCM unsigned 8 bit @tab X @tab X | |
193 | @item raw PCM unsigned 16 bit big-endian @tab X @tab X | |
194 | @item raw PCM unsigned 16 bit little-endian @tab X @tab X | |
195 | @item raw PCM unsigned 24 bit big-endian @tab X @tab X | |
196 | @item raw PCM unsigned 24 bit little-endian @tab X @tab X | |
197 | @item raw PCM unsigned 32 bit big-endian @tab X @tab X | |
198 | @item raw PCM unsigned 32 bit little-endian @tab X @tab X | |
199 | @item raw PCM floating-point 32 bit big-endian @tab X @tab X | |
200 | @item raw PCM floating-point 32 bit little-endian @tab X @tab X | |
201 | @item raw PCM floating-point 64 bit big-endian @tab X @tab X | |
202 | @item raw PCM floating-point 64 bit little-endian @tab X @tab X | |
39271be4 | 203 | @item RDT @tab @tab X |
913c3e2c | 204 | @item REDCODE R3D @tab @tab X |
7eb68edb | 205 | @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio. |
64c2f20a | 206 | @item RealMedia @tab X @tab X |
39271be4 | 207 | @item Redirector @tab @tab X |
913c3e2c | 208 | @item Renderware TeXture Dictionary @tab @tab X |
c6b2dc34 | 209 | @item RL2 @tab @tab X |
d698c5d3 | 210 | @tab Audio and video format used in some games by Entertainment Software Partners. |
39271be4 | 211 | @item RPL/ARMovie @tab @tab X |
e8723e24 | 212 | @item Lego Mindstorms RSO @tab X @tab X |
6bf22e18 S |
213 | @item RTMP @tab X @tab X |
214 | @tab Output is performed by publishing stream to RTMP server | |
39271be4 | 215 | @item RTP @tab @tab X |
6f5a3d0a | 216 | @item RTSP @tab X @tab X |
39271be4 | 217 | @item SDP @tab @tab X |
c6b2dc34 | 218 | @item Sega FILM/CPK @tab @tab X |
d698c5d3 | 219 | @tab Used in many Sega Saturn console games. |
913c3e2c | 220 | @item Sierra SOL @tab @tab X |
d698c5d3 | 221 | @tab .sol files used in Sierra Online games. |
c6b2dc34 | 222 | @item Sierra VMD @tab @tab X |
d698c5d3 | 223 | @tab Used in Sierra CD-ROM games. |
c6b2dc34 | 224 | @item Smacker @tab @tab X |
d698c5d3 | 225 | @tab Multimedia format used by many games. |
913c3e2c DB |
226 | @item Sony OpenMG (OMA) @tab @tab X |
227 | @tab Audio format used in Sony Sonic Stage and Sony Vegas. | |
228 | @item Sony PlayStation STR @tab @tab X | |
740e89cf | 229 | @item Sony Wave64 (W64) @tab @tab X |
cbfe5bee | 230 | @item SoX native format @tab X @tab X |
64c2f20a | 231 | @item SUN AU format @tab X @tab X |
5a717094 | 232 | @item Text files @tab @tab X |
c6b2dc34 | 233 | @item THP @tab @tab X |
d698c5d3 | 234 | @tab Used on the Nintendo GameCube. |
913c3e2c DB |
235 | @item Tiertex Limited SEQ @tab @tab X |
236 | @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback. | |
39271be4 DB |
237 | @item True Audio @tab @tab X |
238 | @item VC-1 test bitstream @tab X @tab X | |
c6b2dc34 | 239 | @item WAV @tab X @tab X |
39271be4 | 240 | @item WavPack @tab @tab X |
316d6c15 | 241 | @item WebM @tab X @tab X |
913c3e2c | 242 | @item Wing Commander III movie @tab @tab X |
d698c5d3 | 243 | @tab Multimedia format used in Origin's Wing Commander III computer game. |
913c3e2c DB |
244 | @item Westwood Studios audio @tab @tab X |
245 | @tab Multimedia format used in Westwood Studios games. | |
246 | @item Westwood Studios VQA @tab @tab X | |
247 | @tab Multimedia format used in Westwood Studios games. | |
39271be4 | 248 | @item YUV4MPEG pipe @tab X @tab X |
148bcae9 | 249 | @item Psygnosis YOP @tab @tab X |
d0e1cd3d DB |
250 | @end multitable |
251 | ||
252 | @code{X} means that encoding (resp. decoding) is supported. | |
253 | ||
254 | @section Image Formats | |
255 | ||
256 | FFmpeg can read and write images for each frame of a video sequence. The | |
257 | following image formats are supported: | |
258 | ||
259 | @multitable @columnfractions .4 .1 .1 .4 | |
b3de4544 | 260 | @item Name @tab Encoding @tab Decoding @tab Comments |
9db80acb DV |
261 | @item .Y.U.V @tab X @tab X |
262 | @tab one raw file per component | |
263 | @item animated GIF @tab X @tab X | |
264 | @tab Only uncompressed GIFs are generated. | |
f2937cc6 DV |
265 | @item BMP @tab X @tab X |
266 | @tab Microsoft BMP image | |
94d3d6a4 JC |
267 | @item DPX @tab @tab X |
268 | @tab Digital Picture Exchange | |
9db80acb DV |
269 | @item JPEG @tab X @tab X |
270 | @tab Progressive JPEG is not supported. | |
271 | @item JPEG 2000 @tab @tab E | |
272 | @tab decoding supported through external library libopenjpeg | |
f2937cc6 DV |
273 | @item JPEG-LS @tab X @tab X |
274 | @item LJPEG @tab X @tab | |
275 | @tab Lossless JPEG | |
ddea12a6 | 276 | @item PAM @tab X @tab X |
9db80acb | 277 | @tab PAM is a PNM extension with alpha support. |
ddea12a6 | 278 | @item PBM @tab X @tab X |
f2937cc6 | 279 | @tab Portable BitMap image |
effcedf7 | 280 | @item PCX @tab X @tab X |
9db80acb | 281 | @tab PC Paintbrush |
ddea12a6 | 282 | @item PGM @tab X @tab X |
314511ab | 283 | @tab Portable GrayMap image |
ddea12a6 | 284 | @item PGMYUV @tab X @tab X |
9db80acb | 285 | @tab PGM with U and V components in YUV 4:2:0 |
a526d619 PR |
286 | @item PIC @tab @tab X |
287 | @tab Pictor/PC Paint | |
9db80acb DV |
288 | @item PNG @tab X @tab X |
289 | @tab 2/4 bpp not supported yet | |
ddea12a6 | 290 | @item PPM @tab X @tab X |
314511ab | 291 | @tab Portable PixelMap image |
9db80acb DV |
292 | @item PTX @tab @tab X |
293 | @tab V.Flash PTX format | |
9db80acb DV |
294 | @item SGI @tab X @tab X |
295 | @tab SGI RGB image format | |
a1c5b6ec JR |
296 | @item Sun Rasterfile @tab @tab X |
297 | @tab Sun RAS image format | |
9db80acb DV |
298 | @item TIFF @tab X @tab X |
299 | @tab YUV, JPEG and some extension is not supported yet. | |
a1c5b6ec JR |
300 | @item Truevision Targa @tab X @tab X |
301 | @tab Targa (.TGA) image format | |
d0e1cd3d DB |
302 | @end multitable |
303 | ||
304 | @code{X} means that encoding (resp. decoding) is supported. | |
305 | ||
9a77d59a JM |
306 | @code{E} means that support is provided through an external library. |
307 | ||
d0e1cd3d DB |
308 | @section Video Codecs |
309 | ||
310 | @multitable @columnfractions .4 .1 .1 .4 | |
b3de4544 | 311 | @item Name @tab Encoding @tab Decoding @tab Comments |
9510f59a | 312 | @item 4X Movie @tab @tab X |
d698c5d3 | 313 | @tab Used in certain computer games. |
f0b19bd3 | 314 | @item 8088flex TMV @tab @tab X |
9510f59a DB |
315 | @item 8SVX exponential @tab @tab X |
316 | @item 8SVX fibonacci @tab @tab X | |
913c3e2c | 317 | @item American Laser Games MM @tab @tab X |
d698c5d3 | 318 | @tab Used in games like Mad Dog McCree. |
a1c5b6ec | 319 | @item AMV Video @tab @tab X |
d698c5d3 | 320 | @tab Used in Chinese MP3 players. |
5a717094 | 321 | @item ANSI/ASCII art @tab @tab X |
d66d8b83 DB |
322 | @item Apple MJPEG-B @tab @tab X |
323 | @item Apple QuickDraw @tab @tab X | |
d698c5d3 | 324 | @tab fourcc: qdrw |
d66d8b83 | 325 | @item Asus v1 @tab X @tab X |
d698c5d3 | 326 | @tab fourcc: ASV1 |
d66d8b83 | 327 | @item Asus v2 @tab X @tab X |
d698c5d3 | 328 | @tab fourcc: ASV2 |
d66d8b83 | 329 | @item ATI VCR1 @tab @tab X |
d698c5d3 | 330 | @tab fourcc: VCR1 |
d66d8b83 | 331 | @item ATI VCR2 @tab @tab X |
d698c5d3 | 332 | @tab fourcc: VCR2 |
588f8cd8 | 333 | @item Auravision Aura @tab @tab X |
ce293510 | 334 | @item Auravision Aura 2 @tab @tab X |
dd2d651d | 335 | @item Autodesk Animator Flic video @tab @tab X |
d66d8b83 | 336 | @item Autodesk RLE @tab @tab X |
d698c5d3 | 337 | @tab fourcc: AASC |
9510f59a | 338 | @item AVS (Audio Video Standard) video @tab @tab X |
d698c5d3 | 339 | @tab Video encoding used by the Creature Shock game. |
68dddf53 | 340 | @item Beam Software VB @tab @tab X |
9510f59a | 341 | @item Bethesda VID video @tab @tab X |
d698c5d3 | 342 | @tab Used in some games from Bethesda Softworks. |
342c7dfd KS |
343 | @item Bink Video @tab @tab X |
344 | @tab Support for version 'b' is missing. | |
9510f59a DB |
345 | @item Brute Force & Ignorance @tab @tab X |
346 | @tab Used in the game Flash Traffic: City of Angels. | |
bac4c85c | 347 | @item C93 video @tab @tab X |
d698c5d3 | 348 | @tab Codec used in Cyberia game. |
d66d8b83 | 349 | @item CamStudio @tab @tab X |
d698c5d3 | 350 | @tab fourcc: CSCD |
a3d995c1 MT |
351 | @item CD+G @tab @tab X |
352 | @tab Video codec for CD+G karaoke disks | |
9510f59a DB |
353 | @item Chinese AVS video @tab @tab X |
354 | @tab AVS1-P2, JiZhun profile | |
355 | @item Delphine Software International CIN video @tab @tab X | |
356 | @tab Codec used in Delphine Software International games. | |
d66d8b83 DB |
357 | @item Cinepak @tab @tab X |
358 | @item Cirrus Logic AccuPak @tab @tab X | |
d698c5d3 | 359 | @tab fourcc: CLJR |
9510f59a | 360 | @item Creative YUV (CYUV) @tab @tab X |
82ced5a9 | 361 | @item Dirac @tab E @tab E |
360f980b | 362 | @tab supported through external libdirac/libschroedinger libraries |
a1ae40fd | 363 | @item Deluxe Paint Animation @tab @tab X |
9510f59a DB |
364 | @item DNxHD @tab X @tab X |
365 | @tab aka SMPTE VC3 | |
68dddf53 | 366 | @item Duck TrueMotion 1.0 @tab @tab X |
d698c5d3 | 367 | @tab fourcc: DUCK |
68dddf53 | 368 | @item Duck TrueMotion 2.0 @tab @tab X |
d698c5d3 | 369 | @tab fourcc: TM20 |
9510f59a DB |
370 | @item DV (Digital Video) @tab X @tab X |
371 | @item Feeble Files/ScummVM DXA @tab @tab X | |
d698c5d3 | 372 | @tab Codec originally used in Feeble Files game. |
9510f59a | 373 | @item Electronic Arts CMV video @tab @tab X |
d698c5d3 | 374 | @tab Used in NHL 95 game. |
c63ea92b | 375 | @item Electronic Arts Madcow video @tab @tab X |
dd2d651d DB |
376 | @item Electronic Arts TGV video @tab @tab X |
377 | @item Electronic Arts TGQ video @tab @tab X | |
378 | @item Electronic Arts TQI video @tab @tab X | |
379 | @item Escape 124 @tab @tab X | |
f4258b13 | 380 | @item FFmpeg video codec #1 @tab X @tab X |
d698c5d3 | 381 | @tab experimental lossless codec (fourcc: FFV1) |
dd2d651d | 382 | @item Flash Screen Video v1 @tab X @tab X |
d698c5d3 | 383 | @tab fourcc: FSV1 |
dd2d651d | 384 | @item Flash Video (FLV) @tab X @tab X |
d698c5d3 | 385 | @tab Sorenson H.263 used in Flash |
dd2d651d | 386 | @item Fraps @tab @tab X |
d66d8b83 | 387 | @item H.261 @tab X @tab X |
dd2d651d DB |
388 | @item H.263 / H.263-1996 @tab X @tab X |
389 | @item H.263+ / H.263-1998 / H.263 version 2 @tab X @tab X | |
390 | @item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 @tab E @tab X | |
360f980b | 391 | @tab encoding supported through external library libx264 |
dd2d651d | 392 | @item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (VDPAU acceleration) @tab E @tab X |
d66d8b83 | 393 | @item HuffYUV @tab X @tab X |
dd2d651d | 394 | @item HuffYUV FFmpeg variant @tab X @tab X |
d66d8b83 | 395 | @item IBM Ultimotion @tab @tab X |
d698c5d3 | 396 | @tab fourcc: ULTI |
bac4c85c | 397 | @item id Cinematic video @tab @tab X |
d698c5d3 | 398 | @tab Used in Quake II. |
a1c5b6ec | 399 | @item id RoQ video @tab X @tab X |
d698c5d3 | 400 | @tab Used in Quake III, Jedi Knight 2, other computer games. |
b9e06ddd PR |
401 | @item IFF ILBM @tab @tab X |
402 | @tab IFF interlaved bitmap | |
403 | @item IFF ByteRun1 @tab @tab X | |
404 | @tab IFF run length encoded bitmap | |
dd2d651d DB |
405 | @item Intel H.263 @tab @tab X |
406 | @item Intel Indeo 2 @tab @tab X | |
d66d8b83 | 407 | @item Intel Indeo 3 @tab @tab X |
5bebe94d | 408 | @item Intel Indeo 5 @tab @tab X |
dd2d651d | 409 | @item Interplay C93 @tab @tab X |
9510f59a | 410 | @tab Used in the game Cyberia from Interplay. |
dd2d651d | 411 | @item Interplay MVE video @tab @tab X |
d698c5d3 | 412 | @tab Used in Interplay .MVE files. |
dd2d651d | 413 | @item Karl Morton's video codec @tab @tab X |
d698c5d3 | 414 | @tab Codec used in Worms games. |
bf354122 DV |
415 | @item Kega Game Video (KGV1) @tab @tab X |
416 | @tab Kega emulator screen capture codec. | |
dd2d651d DB |
417 | @item LCL (LossLess Codec Library) MSZH @tab @tab X |
418 | @item LCL (LossLess Codec Library) ZLIB @tab E @tab E | |
d66d8b83 DB |
419 | @item LOCO @tab @tab X |
420 | @item lossless MJPEG @tab X @tab X | |
421 | @item Microsoft RLE @tab @tab X | |
dd2d651d | 422 | @item Microsoft Video 1 @tab @tab X |
d66d8b83 | 423 | @item Mimic @tab @tab X |
d698c5d3 | 424 | @tab Used in MSN Messenger Webcam streams. |
d66d8b83 | 425 | @item Miro VideoXL @tab @tab X |
d698c5d3 | 426 | @tab fourcc: VIXL |
eacf8613 | 427 | @item MJPEG (Motion JPEG) @tab X @tab X |
dd2d651d DB |
428 | @item Motion Pixels video @tab @tab X |
429 | @item MPEG-1 video @tab X @tab X | |
430 | @item MPEG-1/2 video XvMC (X-Video Motion Compensation) @tab @tab X | |
431 | @item MPEG-1/2 video (VDPAU acceleration) @tab @tab X | |
432 | @item MPEG-2 video @tab X @tab X | |
433 | @item MPEG-4 part 2 @tab X @tab X | |
434 | @ libxvidcore can be used alternatively for encoding. | |
f7af2c1d | 435 | @item MPEG-4 part 2 Microsoft variant version 1 @tab @tab X |
dd2d651d DB |
436 | @item MPEG-4 part 2 Microsoft variant version 2 @tab X @tab X |
437 | @item MPEG-4 part 2 Microsoft variant version 3 @tab X @tab X | |
eacf8613 | 438 | @item Nintendo Gamecube THP video @tab @tab X |
641992de DB |
439 | @item NuppelVideo/RTjpeg @tab @tab X |
440 | @tab Video encoding used in NuppelVideo files. | |
d66d8b83 | 441 | @item On2 VP3 @tab @tab X |
d698c5d3 | 442 | @tab still experimental |
d66d8b83 | 443 | @item On2 VP5 @tab @tab X |
d698c5d3 | 444 | @tab fourcc: VP50 |
d66d8b83 | 445 | @item On2 VP6 @tab @tab X |
d698c5d3 | 446 | @tab fourcc: VP60,VP61,VP62 |
3b636f21 DC |
447 | @item VP8 @tab E @tab X |
448 | @tab fourcc: VP80, encoding supported through external library libvpx | |
d66d8b83 | 449 | @item planar RGB @tab @tab X |
d698c5d3 | 450 | @tab fourcc: 8BPS |
a1c5b6ec | 451 | @item Q-team QPEG @tab @tab X |
d698c5d3 | 452 | @tab fourccs: QPEG, Q1.0, Q1.1 |
9510f59a | 453 | @item QuickTime 8BPS video @tab @tab X |
a1c5b6ec JR |
454 | @item QuickTime Animation (RLE) video @tab X @tab X |
455 | @tab fourcc: 'rle ' | |
456 | @item QuickTime Graphics (SMC) @tab @tab X | |
457 | @tab fourcc: 'smc ' | |
458 | @item QuickTime video (RPZA) @tab @tab X | |
459 | @tab fourcc: rpza | |
4aaab0a3 | 460 | @item R210 Quicktime Uncompressed RGB 10-bit @tab @tab X |
a1c5b6ec | 461 | @item Raw Video @tab X @tab X |
d0e1cd3d DB |
462 | @item RealVideo 1.0 @tab X @tab X |
463 | @item RealVideo 2.0 @tab X @tab X | |
6beb8b26 KS |
464 | @item RealVideo 3.0 @tab @tab X |
465 | @tab still far from ideal | |
11c0f9ec | 466 | @item RealVideo 4.0 @tab @tab X |
68dddf53 | 467 | @item Renderware TXD (TeXture Dictionary) @tab @tab X |
d698c5d3 | 468 | @tab Texture dictionaries used by the Renderware Engine. |
a1c5b6ec JR |
469 | @item RL2 video @tab @tab X |
470 | @tab used in some games by Entertainment Software Partners | |
68dddf53 JR |
471 | @item Sierra VMD video @tab @tab X |
472 | @tab Used in Sierra VMD files. | |
bac4c85c | 473 | @item Smacker video @tab @tab X |
d698c5d3 | 474 | @tab Video encoding used in Smacker. |
68dddf53 | 475 | @item SMPTE VC-1 @tab @tab X |
d66d8b83 | 476 | @item Snow @tab X @tab X |
d698c5d3 | 477 | @tab experimental wavelet codec (fourcc: SNOW) |
eacf8613 | 478 | @item Sony PlayStation MDEC (Motion DECoder) @tab @tab X |
a1c5b6ec | 479 | @item Sorenson Vector Quantizer 1 @tab X @tab X |
d698c5d3 | 480 | @tab fourcc: SVQ1 |
a1c5b6ec | 481 | @item Sorenson Vector Quantizer 3 @tab @tab X |
d698c5d3 | 482 | @tab fourcc: SVQ3 |
a1c5b6ec | 483 | @item Sunplus JPEG (SP5X) @tab @tab X |
d698c5d3 | 484 | @tab fourcc: SP5X |
68dddf53 | 485 | @item TechSmith Screen Capture Codec @tab @tab X |
d698c5d3 | 486 | @tab fourcc: TSCC |
82ced5a9 | 487 | @item Theora @tab E @tab X |
360f980b | 488 | @tab encoding supported through external library libtheora |
a1c5b6ec | 489 | @item Tiertex Limited SEQ video @tab @tab X |
d698c5d3 | 490 | @tab Codec used in DOS CD-ROM FlashBack game. |
ca0bb1c4 | 491 | @item V210 Quicktime Uncompressed 4:2:2 10-bit @tab X @tab X |
eacf8613 | 492 | @item VMware Screen Codec / VMware Video @tab @tab X |
d698c5d3 | 493 | @tab Codec used in videos captured by VMware. |
eacf8613 | 494 | @item Westwood Studios VQA (Vector Quantized Animation) video @tab @tab X |
dd2d651d | 495 | @item Windows Media Video 7 @tab X @tab X |
eacf8613 | 496 | @item Windows Media Video 8 @tab X @tab X |
68dddf53 JR |
497 | @item Windows Media Video 9 @tab @tab X |
498 | @tab not completely working | |
eacf8613 JR |
499 | @item Wing Commander III / Xan @tab @tab X |
500 | @tab Used in Wing Commander III .MVE files. | |
d66d8b83 DB |
501 | @item Winnov WNV1 @tab @tab X |
502 | @item WMV7 @tab X @tab X | |
39271be4 | 503 | @item YAMAHA SMAF @tab X @tab X |
148bcae9 | 504 | @item Psygnosis YOP Video @tab @tab X |
d66d8b83 | 505 | @item ZLIB @tab X @tab X |
d698c5d3 | 506 | @tab part of LCL, encoder experimental |
eacf8613 | 507 | @item Zip Motion Blocks Video @tab X @tab X |
d698c5d3 | 508 | @tab Encoder works only in PAL8. |
d0e1cd3d DB |
509 | @end multitable |
510 | ||
511 | @code{X} means that encoding (resp. decoding) is supported. | |
512 | ||
82ced5a9 DB |
513 | @code{E} means that support is provided through an external library. |
514 | ||
d0e1cd3d DB |
515 | @section Audio Codecs |
516 | ||
485ec4f1 | 517 | @multitable @columnfractions .4 .1 .1 .4 |
b3de4544 | 518 | @item Name @tab Encoding @tab Decoding @tab Comments |
16d81b27 | 519 | @item 8SVX audio @tab @tab X |
82ced5a9 | 520 | @item AAC @tab E @tab X |
360f980b | 521 | @tab encoding supported through external library libfaac |
c76d1bb2 | 522 | @item AC-3 @tab IX @tab X |
fd75cedd DB |
523 | @item ADPCM 4X Movie @tab @tab X |
524 | @item ADPCM CDROM XA @tab @tab X | |
525 | @item ADPCM Creative Technology @tab @tab X | |
526 | @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2 | |
527 | @item ADPCM Electronic Arts @tab @tab X | |
528 | @tab Used in various EA titles. | |
529 | @item ADPCM Electronic Arts Maxis CDROM XS @tab @tab X | |
530 | @tab Used in Sim City 3000. | |
531 | @item ADPCM Electronic Arts R1 @tab @tab X | |
532 | @item ADPCM Electronic Arts R2 @tab @tab X | |
533 | @item ADPCM Electronic Arts R3 @tab @tab X | |
534 | @item ADPCM Electronic Arts XAS @tab @tab X | |
535 | @item ADPCM G.726 @tab X @tab X | |
536 | @item ADPCM IMA AMV @tab @tab X | |
537 | @tab Used in AMV files | |
538 | @item ADPCM IMA Electronic Arts EACS @tab @tab X | |
539 | @item ADPCM IMA Electronic Arts SEAD @tab @tab X | |
540 | @item ADPCM IMA Funcom @tab @tab X | |
541 | @item ADPCM IMA QuickTime @tab X @tab X | |
542 | @item ADPCM IMA Loki SDL MJPEG @tab @tab X | |
543 | @item ADPCM IMA WAV @tab X @tab X | |
544 | @item ADPCM IMA Westwood @tab @tab X | |
545 | @item ADPCM ISS IMA @tab @tab X | |
546 | @tab Used in FunCom games. | |
547 | @item ADPCM IMA Duck DK3 @tab @tab X | |
548 | @tab Used in some Sega Saturn console games. | |
549 | @item ADPCM IMA Duck DK4 @tab @tab X | |
550 | @tab Used in some Sega Saturn console games. | |
551 | @item ADPCM Microsoft @tab X @tab X | |
552 | @item ADPCM MS IMA @tab X @tab X | |
553 | @item ADPCM Nintendo Gamecube THP @tab @tab X | |
554 | @item ADPCM QT IMA @tab X @tab X | |
555 | @item ADPCM SEGA CRI ADX @tab X @tab X | |
556 | @tab Used in Sega Dreamcast games. | |
557 | @item ADPCM Shockwave Flash @tab X @tab X | |
558 | @item ADPCM SMJPEG IMA @tab @tab X | |
559 | @tab Used in certain Loki game ports. | |
560 | @item ADPCM Sound Blaster Pro 2-bit @tab @tab X | |
561 | @item ADPCM Sound Blaster Pro 2.6-bit @tab @tab X | |
562 | @item ADPCM Sound Blaster Pro 4-bit @tab @tab X | |
563 | @item ADPCM Westwood Studios IMA @tab @tab X | |
564 | @tab Used in Westwood Studios games like Command and Conquer. | |
565 | @item ADPCM Yamaha @tab X @tab X | |
2bcaf2fe | 566 | @item AMR-NB @tab E @tab X |
4fe3edaa | 567 | @tab encoding supported through external library libopencore-amrnb |
fc1206a4 DB |
568 | @item AMR-WB @tab @tab E |
569 | @tab decoding supported through external library libopencore-amrwb | |
833e90dd | 570 | @item Apple lossless audio @tab X @tab X |
d698c5d3 | 571 | @tab QuickTime fourcc 'alac' |
61dc238b | 572 | @item Atrac 1 @tab @tab X |
9510f59a | 573 | @item Atrac 3 @tab @tab X |
c0d3f516 PR |
574 | @item Bink Audio @tab @tab X |
575 | @tab Used in Bink and Smacker files in many games. | |
9510f59a | 576 | @item Delphine Software International CIN audio @tab @tab X |
d698c5d3 | 577 | @tab Codec used in Delphine Software International games. |
9510f59a DB |
578 | @item COOK @tab @tab X |
579 | @tab All versions except 5.1 are supported. | |
9510f59a | 580 | @item DCA (DTS Coherent Acoustics) @tab @tab X |
12dd57fd DB |
581 | @item DPCM id RoQ @tab X @tab X |
582 | @tab Used in Quake III, Jedi Knight 2, other computer games. | |
583 | @item DPCM Interplay @tab @tab X | |
584 | @tab Used in various Interplay computer games. | |
585 | @item DPCM Sierra Online @tab @tab X | |
586 | @tab Used in Sierra Online game audio files. | |
587 | @item DPCM Sol @tab @tab X | |
588 | @item DPCM Xan @tab @tab X | |
eff9011d | 589 | @tab Used in Origin's Wing Commander IV AVI files. |
16d81b27 | 590 | @item DSP Group TrueSpeech @tab @tab X |
16d81b27 | 591 | @item DV audio @tab @tab X |
44723c84 | 592 | @item Enhanced AC-3 @tab @tab X |
dd2d651d | 593 | @item FLAC (Free Lossless Audio Codec) @tab X @tab IX |
dd2d651d | 594 | @item G.729 @tab @tab X |
b576934d RD |
595 | @item GSM @tab E @tab X |
596 | @tab encoding supported through external library libgsm | |
597 | @item GSM Microsoft variant @tab E @tab X | |
598 | @tab encoding supported through external library libgsm | |
dd2d651d | 599 | @item IMC (Intel Music Coder) @tab @tab X |
dd2d651d DB |
600 | @item MACE (Macintosh Audio Compression/Expansion) 3:1 @tab @tab X |
601 | @item MACE (Macintosh Audio Compression/Expansion) 6:1 @tab @tab X | |
9ba4821d RP |
602 | @item MLP (Meridian Lossless Packing) @tab @tab X |
603 | @tab Used in DVD-Audio discs. | |
16d81b27 | 604 | @item Monkey's Audio @tab @tab X |
d698c5d3 | 605 | @tab Only versions 3.97-3.99 are supported. |
dd2d651d DB |
606 | @item MP1 (MPEG audio layer 1) @tab @tab IX |
607 | @item MP2 (MPEG audio layer 2) @tab IX @tab IX | |
608 | @item MP3 (MPEG audio layer 3) @tab E @tab IX | |
609 | @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported | |
99971952 | 610 | @item MPEG-4 Audio Lossless Coding (ALS) @tab @tab X |
dd2d651d DB |
611 | @item Musepack SV7 @tab @tab X |
612 | @item Musepack SV8 @tab @tab X | |
641992de | 613 | @item Nellymoser Asao @tab X @tab X |
641992de DB |
614 | @item PCM A-law @tab X @tab X |
615 | @item PCM mu-law @tab X @tab X | |
616 | @item PCM 16-bit little-endian planar @tab @tab X | |
617 | @item PCM 32-bit floating point big-endian @tab X @tab X | |
618 | @item PCM 32-bit floating point little-endian @tab X @tab X | |
619 | @item PCM 64-bit floating point big-endian @tab X @tab X | |
620 | @item PCM 64-bit floating point little-endian @tab X @tab X | |
621 | @item PCM D-Cinema audio signed 24-bit @tab X @tab X | |
622 | @item PCM signed 8-bit @tab X @tab X | |
623 | @item PCM signed 16-bit big-endian @tab X @tab X | |
624 | @item PCM signed 16-bit little-endian @tab X @tab X | |
625 | @item PCM signed 24-bit big-endian @tab X @tab X | |
626 | @item PCM signed 24-bit little-endian @tab X @tab X | |
627 | @item PCM signed 32-bit big-endian @tab X @tab X | |
628 | @item PCM signed 32-bit little-endian @tab X @tab X | |
5dd3707b | 629 | @item PCM signed 16/20/24-bit big-endian in MPEG-TS @tab @tab X |
641992de DB |
630 | @item PCM unsigned 8-bit @tab X @tab X |
631 | @item PCM unsigned 16-bit big-endian @tab X @tab X | |
632 | @item PCM unsigned 16-bit little-endian @tab X @tab X | |
633 | @item PCM unsigned 24-bit big-endian @tab X @tab X | |
634 | @item PCM unsigned 24-bit little-endian @tab X @tab X | |
635 | @item PCM unsigned 32-bit big-endian @tab X @tab X | |
636 | @item PCM unsigned 32-bit little-endian @tab X @tab X | |
637 | @item PCM Zork @tab X @tab X | |
73b458e3 | 638 | @item QCELP / PureVoice @tab @tab X |
a1c5b6ec | 639 | @item QDesign Music Codec 2 @tab @tab X |
d698c5d3 | 640 | @tab There are still some distortions. |
d31ba231 | 641 | @item RealAudio 1.0 (14.4K) @tab X @tab X |
d698c5d3 | 642 | @tab Real 14400 bit/s codec |
a1c5b6ec | 643 | @item RealAudio 2.0 (28.8K) @tab @tab X |
d698c5d3 | 644 | @tab Real 28800 bit/s codec |
a1c5b6ec | 645 | @item RealAudio 3.0 (dnet) @tab IX @tab X |
a692130f | 646 | @tab Real low bitrate AC-3 codec |
7bd3096f | 647 | @item RealAudio SIPR / ACELP.NET @tab @tab X |
bac4c85c | 648 | @item Shorten @tab @tab X |
68dddf53 JR |
649 | @item Sierra VMD audio @tab @tab X |
650 | @tab Used in Sierra VMD files. | |
bac4c85c | 651 | @item Smacker audio @tab @tab X |
e6fa1ca5 JR |
652 | @item Sonic @tab X @tab X |
653 | @tab experimental codec | |
654 | @item Sonic lossless @tab X @tab X | |
655 | @tab experimental codec | |
82ced5a9 | 656 | @item Speex @tab @tab E |
360f980b | 657 | @tab supported through external library libspeex |
16d81b27 | 658 | @item True Audio (TTA) @tab @tab X |
9ba4821d RP |
659 | @item TrueHD @tab @tab X |
660 | @tab Used in HD-DVD and Blu-Ray discs. | |
7bd47335 | 661 | @item TwinVQ (VQF flavor) @tab @tab X |
dd2d651d | 662 | @item Vorbis @tab E @tab X |
19fcd66c | 663 | @tab A native but very primitive encoder exists. |
bac4c85c | 664 | @item WavPack @tab @tab X |
eacf8613 JR |
665 | @item Westwood Audio (SND1) @tab @tab X |
666 | @item Windows Media Audio 1 @tab X @tab X | |
667 | @item Windows Media Audio 2 @tab X @tab X | |
c1061cc7 | 668 | @item Windows Media Audio Pro @tab @tab X |
fa65584f | 669 | @item Windows Media Audio Voice @tab @tab X |
d0e1cd3d DB |
670 | @end multitable |
671 | ||
672 | @code{X} means that encoding (resp. decoding) is supported. | |
673 | ||
82ced5a9 DB |
674 | @code{E} means that support is provided through an external library. |
675 | ||
d0e1cd3d DB |
676 | @code{I} means that an integer-only version is available, too (ensures high |
677 | performance on systems without hardware floating point support). | |
678 | ||
bd3151f2 DB |
679 | @section Subtitle Formats |
680 | ||
000bbebb | 681 | @multitable @columnfractions .4 .1 .1 .1 .1 |
9afc2917 | 682 | @item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding |
913c3e2c | 683 | @item SSA/ASS @tab X @tab X |
9afc2917 DB |
684 | @item DVB @tab X @tab X @tab X @tab X |
685 | @item DVD @tab X @tab X @tab X @tab X | |
c58b82a2 | 686 | @item PGS @tab @tab @tab @tab X |
ba2c508d | 687 | @item SubRip (SRT) @tab X @tab X |
a4276ba2 | 688 | @item XSUB @tab @tab @tab X @tab X |
bd3151f2 DB |
689 | @end multitable |
690 | ||
691 | @code{X} means that the feature is supported. | |
692 | ||
fbd52050 DB |
693 | @section Network Protocols |
694 | ||
000bbebb | 695 | @multitable @columnfractions .4 .1 |
fbd52050 DB |
696 | @item Name @tab Support |
697 | @item file @tab X | |
698 | @item Gopher @tab X | |
699 | @item HTTP @tab X | |
a2403986 | 700 | @item MMS @tab X |
fbd52050 DB |
701 | @item pipe @tab X |
702 | @item RTP @tab X | |
703 | @item TCP @tab X | |
704 | @item UDP @tab X | |
705 | @end multitable | |
706 | ||
707 | @code{X} means that the protocol is supported. | |
708 | ||
709 | ||
fa3f2a35 DB |
710 | @section Input/Output Devices |
711 | ||
712 | @multitable @columnfractions .4 .1 .1 | |
713 | @item Name @tab Input @tab Output | |
714 | @item ALSA @tab X @tab X | |
fa3f2a35 DB |
715 | @item BKTR @tab X @tab |
716 | @item DV1394 @tab X @tab | |
80ff8a16 | 717 | @item JACK @tab X @tab |
fa3f2a35 DB |
718 | @item LIBDC1394 @tab X @tab |
719 | @item OSS @tab X @tab X | |
720 | @item Video4Linux @tab X @tab | |
721 | @item Video4Linux2 @tab X @tab | |
722 | @item VfW capture @tab X @tab | |
723 | @item X11 grabbing @tab X @tab | |
724 | @end multitable | |
725 | ||
23869b4a | 726 | @code{X} means that input/output is supported. |
fa3f2a35 DB |
727 | |
728 | ||
d0e1cd3d DB |
729 | @chapter Platform Specific information |
730 | ||
6a36798f MK |
731 | @section DOS |
732 | ||
733 | Using a cross-compiler is preferred for various reasons. | |
734 | ||
735 | @subsection DJGPP | |
736 | ||
737 | FFmpeg cannot be compiled because of broken system headers, add | |
738 | @code{--extra-cflags=-U__STRICT_ANSI__} to the configure options as a | |
739 | workaround. | |
740 | ||
bee694bc MK |
741 | @section OS/2 |
742 | ||
743 | For information about compiling FFmpeg on OS/2 see | |
744 | @url{http://www.edm2.com/index.php/FFmpeg}. | |
745 | ||
746 | @section Unix-like | |
747 | ||
1e4dd198 DB |
748 | Some parts of FFmpeg cannot be built with version 2.15 of the GNU |
749 | assembler which is still provided by a few AMD64 distributions. To | |
750 | make sure your compiler really uses the required version of gas | |
751 | after a binutils upgrade, run: | |
752 | ||
753 | @example | |
754 | $(gcc -print-prog-name=as) --version | |
755 | @end example | |
756 | ||
757 | If not, then you should install a different compiler that has no | |
758 | hard-coded path to gas. In the worst case pass @code{--disable-asm} | |
759 | to configure. | |
760 | ||
bee694bc | 761 | @subsection BSD |
d0e1cd3d DB |
762 | |
763 | BSD make will not build FFmpeg, you need to install and use GNU Make | |
764 | (@file{gmake}). | |
765 | ||
bee694bc | 766 | @subsubsection FreeBSD |
54dab567 DB |
767 | |
768 | FreeBSD will not compile out-of-the-box due to broken system headers. | |
769 | Passing @code{--extra-cflags=-D__BSD_VISIBLE} to configure will work | |
770 | around the problem. This may have unexpected sideeffects, so use it at | |
771 | your own risk. If you care about FreeBSD, please make an attempt at | |
772 | getting the system headers fixed. | |
773 | ||
bee694bc | 774 | @subsection (Open)Solaris |
3fd427cd DB |
775 | |
776 | GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}), | |
e69decae | 777 | standard Solaris Make will not work. When building with a non-c99 front-end |
ee945547 | 778 | (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o} |
e69decae MK |
779 | or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options |
780 | since the libc is not c99-compliant by default. The probes performed by | |
781 | configure may raise an exception leading to the death of configure itself | |
782 | due to a bug in the system shell. Simply invoke a different shell such as | |
783 | bash directly to work around this: | |
784 | ||
785 | @example | |
786 | bash ./configure | |
787 | @end example | |
3fd427cd | 788 | |
377723b2 MR |
789 | @subsection Darwin (MacOS X, iPhone) |
790 | ||
791 | MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from | |
792 | @url{http://github.com/yuvi/gas-preprocessor} to build the optimized | |
793 | assembler functions. | |
794 | ||
d0e1cd3d DB |
795 | @section Windows |
796 | ||
46a845d0 | 797 | To get help and instructions for building FFmpeg under Windows, check out |
d0e1cd3d | 798 | the FFmpeg Windows Help Forum at |
ab5ce4ae | 799 | @url{http://ffmpeg.arrozcru.org/}. |
d0e1cd3d DB |
800 | |
801 | @subsection Native Windows compilation | |
802 | ||
c1989552 | 803 | FFmpeg can be built to run natively on Windows using the MinGW tools. Install |
126cadc7 RP |
804 | the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}. |
805 | You can find detailed installation | |
d0e1cd3d DB |
806 | instructions in the download section and the FAQ. |
807 | ||
126cadc7 RP |
808 | FFmpeg does not build out-of-the-box with the packages the automated MinGW |
809 | installer provides. It also requires coreutils to be installed and many other | |
810 | packages updated to the latest version. The minimum version for some packages | |
811 | are listed below: | |
812 | ||
813 | @itemize | |
814 | @item bash 3.1 | |
815 | @item msys-make 3.81-2 (note: not mingw32-make) | |
2014b51c | 816 | @item w32api 3.13 |
126cadc7 RP |
817 | @item mingw-runtime 3.15 |
818 | @end itemize | |
819 | ||
44be8d42 | 820 | FFmpeg automatically passes @code{-fno-common} to the compiler to work around |
0f898714 DB |
821 | a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}). |
822 | ||
c1989552 | 823 | Within the MSYS shell, configure and make with: |
d0e1cd3d | 824 | |
c1989552 | 825 | @example |
1a04d4c7 | 826 | ./configure --enable-memalign-hack |
c1989552 RP |
827 | make |
828 | make install | |
829 | @end example | |
d0e1cd3d | 830 | |
c1989552 RP |
831 | This will install @file{ffmpeg.exe} along with many other development files |
832 | to @file{/usr/local}. You may specify another install path using the | |
833 | @code{--prefix} option in @file{configure}. | |
d0e1cd3d | 834 | |
c1989552 | 835 | Notes: |
d0e1cd3d | 836 | |
c1989552 | 837 | @itemize |
d0e1cd3d | 838 | |
b94ca208 RP |
839 | @item Building natively using MSYS can be sped up by disabling implicit rules |
840 | in the Makefile by calling @code{make -r} instead of plain @code{make}. This | |
841 | speed up is close to non-existent for normal one-off builds and is only | |
842 | noticeable when running make for a second time (for example in | |
843 | @code{make install}). | |
844 | ||
c1989552 RP |
845 | @item In order to compile FFplay, you must have the MinGW development library |
846 | of SDL. Get it from @url{http://www.libsdl.org}. | |
847 | Edit the @file{bin/sdl-config} script so that it points to the correct prefix | |
848 | where SDL was installed. Verify that @file{sdl-config} can be launched from | |
849 | the MSYS command line. | |
d0e1cd3d | 850 | |
d0e1cd3d | 851 | @item By using @code{./configure --enable-shared} when configuring FFmpeg, |
c1989552 | 852 | you can build libavutil, libavcodec and libavformat as DLLs. |
d0e1cd3d DB |
853 | |
854 | @end itemize | |
855 | ||
c1989552 | 856 | @subsection Microsoft Visual C++ compatibility |
d0e1cd3d | 857 | |
c1989552 RP |
858 | As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you |
859 | want to use the libav* libraries in your own applications, you can still | |
860 | compile those applications using MSVC++. But the libav* libraries you link | |
861 | to @emph{must} be built with MinGW. However, you will not be able to debug | |
862 | inside the libav* libraries, since MSVC++ does not recognize the debug | |
863 | symbols generated by GCC. | |
864 | We strongly recommend you to move over from MSVC++ to MinGW tools. | |
d0e1cd3d | 865 | |
c1989552 RP |
866 | This description of how to use the FFmpeg libraries with MSVC++ is based on |
867 | Microsoft Visual C++ 2005 Express Edition. If you have a different version, | |
868 | you might have to modify the procedures slightly. | |
d0e1cd3d | 869 | |
c1989552 | 870 | @subsubsection Using static libraries |
d0e1cd3d | 871 | |
c1989552 | 872 | Assuming you have just built and installed FFmpeg in @file{/usr/local}. |
d0e1cd3d DB |
873 | |
874 | @enumerate | |
875 | ||
876 | @item Create a new console application ("File / New / Project") and then | |
877 | select "Win32 Console Application". On the appropriate page of the | |
878 | Application Wizard, uncheck the "Precompiled headers" option. | |
879 | ||
880 | @item Write the source code for your application, or, for testing, just | |
881 | copy the code from an existing sample application into the source file | |
c1989552 | 882 | that MSVC++ has already created for you. For example, you can copy |
d95a0c67 | 883 | @file{libavformat/output-example.c} from the FFmpeg distribution. |
d0e1cd3d DB |
884 | |
885 | @item Open the "Project / Properties" dialog box. In the "Configuration" | |
886 | combo box, select "All Configurations" so that the changes you make will | |
887 | affect both debug and release builds. In the tree view on the left hand | |
888 | side, select "C/C++ / General", then edit the "Additional Include | |
c1989552 RP |
889 | Directories" setting to contain the path where the FFmpeg includes were |
890 | installed (i.e. @file{c:\msys\1.0\local\include}). | |
f010d377 RP |
891 | Do not add MinGW's include directory here, or the include files will |
892 | conflict with MSVC's. | |
c1989552 RP |
893 | |
894 | @item Still in the "Project / Properties" dialog box, select | |
895 | "Linker / General" from the tree view and edit the | |
896 | "Additional Library Directories" setting to contain the @file{lib} | |
897 | directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}), | |
898 | the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}), | |
899 | and the directory where MinGW's GCC libs are installed | |
900 | (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select | |
901 | "Linker / Input" from the tree view, and add the files @file{libavformat.a}, | |
902 | @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a}, | |
903 | @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a}) | |
904 | to the end of "Additional Dependencies". | |
d0e1cd3d DB |
905 | |
906 | @item Now, select "C/C++ / Code Generation" from the tree view. Select | |
907 | "Debug" in the "Configuration" combo box. Make sure that "Runtime | |
908 | Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in | |
909 | the "Configuration" combo box and make sure that "Runtime Library" is | |
910 | set to "Multi-threaded DLL". | |
911 | ||
c1989552 RP |
912 | @item Click "OK" to close the "Project / Properties" dialog box. |
913 | ||
914 | @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg. | |
915 | Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list} | |
916 | and install it in MSVC++'s include directory | |
917 | (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}). | |
918 | ||
919 | @item MSVC++ also does not understand the @code{inline} keyword used by | |
920 | FFmpeg, so you must add this line before @code{#include}ing libav*: | |
921 | @example | |
922 | #define inline _inline | |
923 | @end example | |
924 | ||
c1989552 RP |
925 | @item Build your application, everything should work. |
926 | ||
927 | @end enumerate | |
928 | ||
929 | @subsubsection Using shared libraries | |
930 | ||
931 | This is how to create DLL and LIB files that are compatible with MSVC++: | |
932 | ||
933 | @enumerate | |
934 | ||
935 | @item Add a call to @file{vcvars32.bat} (which sets up the environment | |
936 | variables for the Visual C++ tools) as the first line of @file{msys.bat}. | |
937 | The standard location for @file{vcvars32.bat} is | |
938 | @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}, | |
939 | and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}. | |
940 | If this corresponds to your setup, add the following line as the first line | |
941 | of @file{msys.bat}: | |
942 | ||
943 | @example | |
944 | call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat" | |
945 | @end example | |
946 | ||
947 | Alternatively, you may start the @file{Visual Studio 2005 Command Prompt}, | |
948 | and run @file{c:\msys\1.0\msys.bat} from there. | |
949 | ||
950 | @item Within the MSYS shell, run @code{lib.exe}. If you get a help message | |
951 | from @file{Microsoft (R) Library Manager}, this means your environment | |
952 | variables are set up correctly, the @file{Microsoft (R) Library Manager} | |
953 | is on the path and will be used by FFmpeg to create | |
954 | MSVC++-compatible import libraries. | |
955 | ||
956 | @item Build FFmpeg with | |
957 | ||
958 | @example | |
959 | ./configure --enable-shared --enable-memalign-hack | |
960 | make | |
961 | make install | |
962 | @end example | |
963 | ||
964 | Your install path (@file{/usr/local/} by default) should now have the | |
965 | necessary DLL and LIB files under the @file{bin} directory. | |
d0e1cd3d DB |
966 | |
967 | @end enumerate | |
968 | ||
c1989552 RP |
969 | To use those files with MSVC++, do the same as you would do with |
970 | the static libraries, as described above. But in Step 4, | |
971 | you should only need to add the directory where the LIB files are installed | |
972 | (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are | |
973 | installed in the @file{bin} directory. And instead of adding @file{libxx.a} | |
974 | files, you should add @file{avcodec.lib}, @file{avformat.lib}, and | |
975 | @file{avutil.lib}. There should be no need for @file{libmingwex.a}, | |
976 | @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library | |
977 | statically linked into the DLLs. The @file{bin} directory contains a bunch | |
978 | of DLL files, but the ones that are actually used to run your application | |
979 | are the ones with a major version number in their filenames | |
980 | (i.e. @file{avcodec-51.dll}). | |
981 | ||
d0e1cd3d DB |
982 | @subsection Cross compilation for Windows with Linux |
983 | ||
984 | You must use the MinGW cross compilation tools available at | |
985 | @url{http://www.mingw.org/}. | |
986 | ||
987 | Then configure FFmpeg with the following options: | |
988 | @example | |
989 | ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc- | |
990 | @end example | |
991 | (you can change the cross-prefix according to the prefix chosen for the | |
992 | MinGW tools). | |
993 | ||
994 | Then you can easily test FFmpeg with Wine | |
995 | (@url{http://www.winehq.com/}). | |
996 | ||
997 | @subsection Compilation under Cygwin | |
998 | ||
2f821b03 VP |
999 | Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack |
1000 | llrint() in its C library. | |
d0e1cd3d | 1001 | |
2f821b03 | 1002 | Install your Cygwin with all the "Base" packages, plus the |
d0e1cd3d DB |
1003 | following "Devel" ones: |
1004 | @example | |
2f821b03 | 1005 | binutils, gcc4-core, make, subversion, mingw-runtime, texi2html |
71ecc16b RP |
1006 | @end example |
1007 | ||
1008 | And the following "Utils" one: | |
1009 | @example | |
1010 | diffutils | |
d0e1cd3d DB |
1011 | @end example |
1012 | ||
d0e1cd3d DB |
1013 | Then run |
1014 | ||
1015 | @example | |
2f821b03 | 1016 | ./configure --enable-static --disable-shared |
d0e1cd3d DB |
1017 | @end example |
1018 | ||
2f821b03 VP |
1019 | to make a static build. |
1020 | ||
1021 | The current @code{gcc4-core} package is buggy and needs this flag to build | |
1022 | shared libraries: | |
d0e1cd3d DB |
1023 | |
1024 | @example | |
2f821b03 | 1025 | ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions |
d0e1cd3d DB |
1026 | @end example |
1027 | ||
d0e1cd3d | 1028 | If you want to build FFmpeg with additional libraries, download Cygwin |
5dd9799d VP |
1029 | "Devel" packages for Ogg and Vorbis from any Cygwin packages repository: |
1030 | @example | |
1031 | libogg-devel, libvorbis-devel | |
1032 | @end example | |
1033 | ||
1034 | These library packages are only available from Cygwin Ports | |
be8497b0 | 1035 | (@url{http://sourceware.org/cygwinports/}) : |
5dd9799d VP |
1036 | |
1037 | @example | |
6a74b127 | 1038 | yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel, |
5dd9799d VP |
1039 | libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel, |
1040 | libxvidcore-devel | |
1041 | @end example | |
1042 | ||
1043 | The recommendation for libnut and x264 is to build them from source by | |
1044 | yourself, as they evolve too quickly for Cygwin Ports to be up to date. | |
d0e1cd3d | 1045 | |
cdf51395 VP |
1046 | Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means |
1047 | of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports. | |
1048 | ||
d0e1cd3d DB |
1049 | @subsection Crosscompilation for Windows under Cygwin |
1050 | ||
1051 | With Cygwin you can create Windows binaries that do not need the cygwin1.dll. | |
1052 | ||
1053 | Just install your Cygwin as explained before, plus these additional | |
1054 | "Devel" packages: | |
1055 | @example | |
1056 | gcc-mingw-core, mingw-runtime, mingw-zlib | |
1057 | @end example | |
1058 | ||
1059 | and add some special flags to your configure invocation. | |
1060 | ||
1061 | For a static build run | |
1062 | @example | |
1063 | ./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin | |
1064 | @end example | |
1065 | ||
1066 | and for a build with shared libraries | |
1067 | @example | |
1068 | ./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin | |
1069 | @end example | |
1070 | ||
d0e1cd3d | 1071 | @bye |