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