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