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