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