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