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