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