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