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