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