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