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