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