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