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