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