general.texi 55.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
\input texinfo @c -*- texinfo -*-

@settitle General Documentation
@titlepage
@sp 7
@center @titlefont{General Documentation}
@sp 3
@end titlepage


@chapter external libraries

FFmpeg can be hooked up with a number of external libraries to add support
for more formats. None of them are used by default, their use has to be
explicitly requested by passing the appropriate flags to @file{./configure}.

@section AMR

Diego Biurrun's avatar
Diego Biurrun committed
19 20 21
AMR comes in two different flavors, wideband and narrowband. FFmpeg can make
use of the AMR wideband (floating-point mode) and the AMR narrowband
(floating-point mode) reference decoders and encoders.
22 23 24 25 26

Go to @url{http://www.penguin.cz/~utx/amr} and follow the instructions for
installing the libraries. Then pass @code{--enable-libamr-nb} and/or
@code{--enable-libamr-wb} to configure to enable the libraries.

27 28 29 30 31
Note that libamr is copyrighted without any sort of license grant. This means
that you can use it if you legally obtained it but you are not allowed to
redistribute it in any way. @strong{Any FFmpeg binaries with libamr support
you create are non-free and unredistributable!}

32 33 34 35 36 37 38 39 40 41 42

@chapter Supported File Formats and Codecs

You can use the @code{-formats} option to have an exhaustive list.

@section File Formats

FFmpeg supports the following file formats through the @code{libavformat}
library:

@multitable @columnfractions .4 .1 .1 .4
43
@item Name @tab Encoding @tab Decoding @tab Comments
Diego Biurrun's avatar
Diego Biurrun committed
44
@item 4xm                       @tab   @tab X
45
    @tab 4X Technologies format, used in some games.
46
@item Audio IFF (AIFF)          @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
47 48
@item American Laser Games MM   @tab   @tab X
    @tab Multimedia format used in games like Mad Dog McCree.
49
@item 3GPP AMR                  @tab X @tab X
50 51
@item ASF                       @tab X @tab X
@item AVI                       @tab X @tab X
52
@item AVISynth                  @tab   @tab X
53
@item AVS                       @tab   @tab X
54
    @tab Multimedia format used by the Creature Shock game.
55 56 57
@item Beam Software SIFF        @tab   @tab X
    @tab Audio and video format used in some games by Beam Software.
@item Bethesda Softworks VID    @tab   @tab X
58
    @tab Used in some games from Bethesda Softworks.
59 60 61
@item Brute Force & Ignorance   @tab   @tab X
    @tab Used in the game Flash Traffic: City of Angels.
@item Interplay C93             @tab   @tab X
62
    @tab Used in the game Cyberia from Interplay.
63
@item Delphine Software International CIN @tab   @tab X
64
    @tab Multimedia format used by Delphine Software games.
65
@item CRC testing format        @tab X @tab
66
@item Creative Voice            @tab X @tab X
67
    @tab Created for the Sound Blaster Pro.
Diego Biurrun's avatar
Diego Biurrun committed
68 69
@item CRYO APC                  @tab   @tab X
    @tab Audio format used in some games by CRYO Interactive Entertainment.
70
@item D-Cinema audio            @tab X @tab X
71
@item DV video                  @tab X @tab X
72
@item DXA                       @tab   @tab X
73 74
    @tab This format is used in the non-Windows version of the Feeble Files
         game and different game cutscenes repacked for use with ScummVM.
75
@item Electronic Arts cdata  @tab    @tab X
76
@item Electronic Arts Multimedia  @tab    @tab X
77
    @tab Used in various EA games; files have extensions like WVE and UV2.
78 79
@item FFM (FFserver live feed)  @tab X @tab X
@item Flash (SWF)               @tab X @tab X
80 81 82
@item Flash 9 (AVM2)            @tab X @tab X
    @tab Only embedded audio is decoded.
@item FLI/FLC/FLX animation     @tab   @tab X
83
    @tab .fli/.flc files
84
@item Flash Video (FLV)         @tab   @tab X
85
    @tab Macromedia Flash video files
86
@item framecrc testing format   @tab X @tab
87 88
@item FunCom ISS                @tab   @tab X
    @tab Audio format used in various games from FunCom like The Longest Journey.
89
@item GIF Animation             @tab X @tab
90
@item GXF                       @tab X @tab X
91
    @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
Diego Biurrun's avatar
Diego Biurrun committed
92
         playout servers.
93
@item id Quake II CIN video     @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
94
@item id RoQ                    @tab X @tab X
95
    @tab Used in Quake III, Jedi Knight 2, other computer games.
96
@item IFF                       @tab   @tab X
97
    @tab Interchange File Format
98
@item Interplay MVE             @tab   @tab X
99
    @tab Format used in various Interplay computer games.
100
@item LMLM4                     @tab   @tab X
101
    @tab Used by Linux Media Labs MPEG-4 PCI boards
Diego Biurrun's avatar
Diego Biurrun committed
102
@item Matroska                  @tab X @tab X
103
@item Matroska audio            @tab X @tab
104
@item MAXIS XA                  @tab   @tab X
105
    @tab Used in Sim City 3000; file extension .xa.
Diego Biurrun's avatar
Diego Biurrun committed
106
@item Monkey's Audio            @tab   @tab X
107
@item Motion Pixels MVI         @tab   @tab X
108 109
@item MOV/QuickTime/MP4         @tab X @tab X
    @tab 3GP, 3GP2, PSP, iPod variants supported
110 111
@item MP2                       @tab X @tab X
@item MP3                       @tab X @tab X
112 113 114 115 116
@item MPEG-1 System             @tab X @tab X
    @tab muxed audio and video, VCD format supported
@item MPEG-PS (program stream)  @tab X @tab X
    @tab also known as @code{VOB} file, SVCD and DVD format supported
@item MPEG-TS (transport stream) @tab X @tab X
117
    @tab also known as DVB Transport Stream
118
@item MPEG-4                    @tab X @tab X
119
    @tab MPEG-4 is a variant of QuickTime.
120
@item MIME multipart JPEG       @tab X @tab
121
@item MSN TCP webcam            @tab   @tab X
122
    @tab Used by MSN Messenger webcam streams.
123 124 125
@item MTV                       @tab   @tab X
@item Musepack                  @tab   @tab X
@item Musepack SV8              @tab   @tab X
126 127
@item Material eXchange Format (MXF) @tab X @tab X
    @tab SMPTE 377M, used by D-Cinema, broadcast industry.
128 129
@item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
    @tab SMPTE 386M, D-10/IMX Mapping.
130 131
@item NC camera feed            @tab   @tab X
    @tab NC (AVIP NC4600) camera streams
132 133
@item NTT TwinVQ (VQF)          @tab   @tab X
    @tab Nippon Telegraph and Telephone Corporation TwinVQ.
134
@item Nullsoft Streaming Video  @tab   @tab X
135
@item NuppelVideo               @tab   @tab X
136
@item NUT                       @tab X @tab X
137
    @tab NUT Open Container Format
138
@item Ogg                       @tab X @tab X
139
@item TechnoTrend PVA           @tab   @tab X
140
    @tab Used by TechnoTrend DVB PCI boards.
141
@item raw ADTS (AAC)            @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
142
@item raw AC-3                  @tab X @tab X
143
@item raw Chinese AVS video     @tab   @tab X
144 145 146 147 148 149 150 151 152 153 154
@item raw CRI ADX               @tab X @tab X
@item raw Dirac                 @tab X @tab X
@item raw DNxHD                 @tab X @tab X
@item raw DTS                   @tab X @tab X
@item raw E-AC-3                @tab X @tab X
@item raw FLAC                  @tab X @tab X
@item raw GSM                   @tab   @tab X
@item raw H.261                 @tab X @tab X
@item raw H.263                 @tab X @tab X
@item raw H.264                 @tab X @tab X
@item raw Ingenient MJPEG       @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
155
@item raw MJPEG                 @tab X @tab X
156 157 158 159 160 161
@item raw MLP                   @tab   @tab X
@item raw MPEG                  @tab   @tab X
@item raw MPEG-1                @tab   @tab X
@item raw MPEG-2                @tab   @tab X
@item raw MPEG-4                @tab X @tab X
@item raw NULL                  @tab X @tab
Diego Biurrun's avatar
Diego Biurrun committed
162
@item raw video                 @tab X @tab X
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
@item raw id RoQ                @tab X @tab
@item raw Shorten               @tab   @tab X
@item raw VC-1                  @tab   @tab X
@item raw PCM A-law             @tab X @tab X
@item raw PCM mu-law            @tab X @tab X
@item raw PCM signed 8 bit      @tab X @tab X
@item raw PCM signed 16 bit big-endian  @tab X @tab X
@item raw PCM signed 16 bit little-endian  @tab X @tab X
@item raw PCM signed 24 bit big-endian  @tab X @tab X
@item raw PCM signed 24 bit little-endian  @tab X @tab X
@item raw PCM signed 32 bit big-endian  @tab X @tab X
@item raw PCM signed 32 bit little-endian  @tab X @tab X
@item raw PCM unsigned 8 bit    @tab X @tab X
@item raw PCM unsigned 16 bit big-endian  @tab X @tab X
@item raw PCM unsigned 16 bit little-endian  @tab X @tab X
@item raw PCM unsigned 24 bit big-endian  @tab X @tab X
@item raw PCM unsigned 24 bit little-endian  @tab X @tab X
@item raw PCM unsigned 32 bit big-endian  @tab X @tab X
@item raw PCM unsigned 32 bit little-endian  @tab X @tab X
@item raw PCM floating-point 32 bit big-endian  @tab X @tab X
@item raw PCM floating-point 32 bit little-endian  @tab X @tab X
@item raw PCM floating-point 64 bit big-endian  @tab X @tab X
@item raw PCM floating-point 64 bit little-endian  @tab X @tab X
186
@item RDT                       @tab   @tab X
187
@item REDCODE R3D               @tab   @tab X
Baptiste Coudurier's avatar
Baptiste Coudurier committed
188
    @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
Diego Biurrun's avatar
Diego Biurrun committed
189
@item RealMedia                 @tab X @tab X
190
@item Redirector                @tab   @tab X
191
@item Renderware TeXture Dictionary @tab   @tab X
192
@item RL2                       @tab   @tab X
193
    @tab Audio and video format used in some games by Entertainment Software Partners.
194 195 196 197
@item RPL/ARMovie               @tab   @tab X
@item RTP                       @tab   @tab X
@item RTSP                      @tab   @tab X
@item SDP                       @tab   @tab X
198
@item Sega FILM/CPK             @tab   @tab X
199
    @tab Used in many Sega Saturn console games.
200
@item Sierra SOL                @tab   @tab X
201
    @tab .sol files used in Sierra Online games.
202
@item Sierra VMD                @tab   @tab X
203
    @tab Used in Sierra CD-ROM games.
204
@item Smacker                   @tab   @tab X
205
    @tab Multimedia format used by many games.
206 207 208
@item Sony OpenMG (OMA)         @tab   @tab X
    @tab Audio format used in Sony Sonic Stage and Sony Vegas.
@item Sony PlayStation STR      @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
209
@item SUN AU format             @tab X @tab X
210
@item THP                       @tab   @tab X
211
    @tab Used on the Nintendo GameCube.
212 213
@item Tiertex Limited SEQ       @tab   @tab X
    @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
214 215
@item True Audio                @tab   @tab X
@item VC-1 test bitstream       @tab X @tab X
216
@item WAV                       @tab X @tab X
217
@item WavPack                   @tab   @tab X
218
@item Wing Commander III movie  @tab   @tab X
219
    @tab Multimedia format used in Origin's Wing Commander III computer game.
220 221 222 223
@item Westwood Studios audio    @tab   @tab X
    @tab Multimedia format used in Westwood Studios games.
@item Westwood Studios VQA      @tab   @tab X
    @tab Multimedia format used in Westwood Studios games.
224
@item YUV4MPEG pipe             @tab X @tab X
225 226 227 228 229 230 231 232 233 234
@end multitable

@code{X} means that encoding (resp. decoding) is supported.

@section Image Formats

FFmpeg can read and write images for each frame of a video sequence. The
following image formats are supported:

@multitable @columnfractions .4 .1 .1 .4
235
@item Name @tab Encoding @tab Decoding @tab Comments
236 237 238 239
@item .Y.U.V       @tab X @tab X
    @tab one raw file per component
@item animated GIF @tab X @tab X
    @tab Only uncompressed GIFs are generated.
240 241
@item BMP          @tab X @tab X
    @tab Microsoft BMP image
242 243 244 245
@item JPEG         @tab X @tab X
    @tab Progressive JPEG is not supported.
@item JPEG 2000    @tab   @tab E
    @tab decoding supported through external library libopenjpeg
246 247 248
@item JPEG-LS      @tab X @tab X
@item LJPEG        @tab X @tab
    @tab Lossless JPEG
249
@item PAM          @tab X @tab X
250
    @tab PAM is a PNM extension with alpha support.
251
@item PBM          @tab X @tab X
252
    @tab Portable BitMap image
253 254
@item PCX          @tab   @tab X
    @tab PC Paintbrush
255
@item PGM          @tab X @tab X
256
    @tab Portable GrayMap image
257
@item PGMYUV       @tab X @tab X
258 259 260
    @tab PGM with U and V components in YUV 4:2:0
@item PNG          @tab X @tab X
    @tab 2/4 bpp not supported yet
261
@item PPM          @tab X @tab X
262
    @tab Portable PixelMap image
263 264 265 266
@item PTX          @tab   @tab X
    @tab V.Flash PTX format
@item SGI          @tab X @tab X
    @tab SGI RGB image format
267 268
@item Sun Rasterfile  @tab   @tab X
    @tab Sun RAS image format
269 270
@item TIFF         @tab X @tab X
    @tab YUV, JPEG and some extension is not supported yet.
271 272
@item Truevision Targa  @tab X @tab X
    @tab Targa (.TGA) image format
273 274 275 276
@end multitable

@code{X} means that encoding (resp. decoding) is supported.

277 278
@code{E} means that support is provided through an external library.

279 280 281
@section Video Codecs

@multitable @columnfractions .4 .1 .1 .4
282
@item Name @tab Encoding @tab Decoding @tab Comments
283
@item 4X Movie               @tab     @tab  X
284
    @tab Used in certain computer games.
285 286
@item 8SVX exponential       @tab     @tab  X
@item 8SVX fibonacci         @tab     @tab  X
287
@item American Laser Games MM  @tab    @tab X
288
    @tab Used in games like Mad Dog McCree.
289
@item AMV Video              @tab     @tab  X
290
    @tab Used in Chinese MP3 players.
291 292
@item Apple MJPEG-B          @tab     @tab  X
@item Apple QuickDraw        @tab     @tab  X
293
    @tab fourcc: qdrw
294
@item Asus v1                @tab  X  @tab  X
295
    @tab fourcc: ASV1
296
@item Asus v2                @tab  X  @tab  X
297
    @tab fourcc: ASV2
298
@item ATI VCR1               @tab     @tab  X
299
    @tab fourcc: VCR1
300
@item ATI VCR2               @tab     @tab  X
301
    @tab fourcc: VCR2
302
@item Autodesk Animator Flic video  @tab     @tab  X
303
@item Autodesk RLE           @tab     @tab  X
304
    @tab fourcc: AASC
305
@item AVS (Audio Video Standard) video  @tab     @tab  X
306
    @tab Video encoding used by the Creature Shock game.
307
@item Beam Software VB       @tab     @tab  X
308
@item Bethesda VID video     @tab     @tab  X
309
    @tab Used in some games from Bethesda Softworks.
310 311
@item Brute Force & Ignorance   @tab   @tab X
    @tab Used in the game Flash Traffic: City of Angels.
312
@item C93 video              @tab     @tab  X
313
    @tab Codec used in Cyberia game.
314
@item CamStudio              @tab     @tab  X
315
    @tab fourcc: CSCD
316 317 318 319
@item Chinese AVS video      @tab     @tab  X
    @tab AVS1-P2, JiZhun profile
@item Delphine Software International CIN video  @tab     @tab  X
    @tab Codec used in Delphine Software International games.
320 321
@item Cinepak                @tab     @tab  X
@item Cirrus Logic AccuPak   @tab     @tab  X
322
    @tab fourcc: CLJR
323
@item Creative YUV (CYUV)    @tab     @tab  X
324
@item Dirac                  @tab  E  @tab  E
325
    @tab supported through external libdirac/libschroedinger libraries
326 327
@item DNxHD                  @tab   X @tab  X
    @tab aka SMPTE VC3
328
@item Duck TrueMotion 1.0   @tab     @tab  X
329
    @tab fourcc: DUCK
330
@item Duck TrueMotion 2.0    @tab     @tab  X
331
    @tab fourcc: TM20
332 333
@item DV (Digital Video)     @tab  X  @tab  X
@item Feeble Files/ScummVM DXA  @tab     @tab  X
334
    @tab Codec originally used in Feeble Files game.
335
@item Electronic Arts CMV video  @tab     @tab  X
336
    @tab Used in NHL 95 game.
337 338 339 340 341
@item Electronic Arts TGV video  @tab     @tab  X
@item Electronic Arts TGQ video  @tab     @tab  X
@item Electronic Arts TQI video  @tab     @tab  X
@item Escape 124             @tab     @tab  X
@item FFmpeg codec #1        @tab  X  @tab  X
342
    @tab experimental lossless codec (fourcc: FFV1)
343
@item Flash Screen Video v1  @tab  X  @tab  X
344
    @tab fourcc: FSV1
345
@item Flash Video (FLV)      @tab  X  @tab  X
346
    @tab Sorenson H.263 used in Flash
347
@item Fraps                  @tab     @tab  X
348
@item H.261                  @tab  X  @tab  X
349 350 351
@item H.263 / H.263-1996     @tab  X  @tab  X
@item H.263+ / H.263-1998 / H.263 version 2  @tab  X  @tab  X
@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10  @tab  E  @tab  X
352
    @tab encoding supported through external library libx264
353
@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (VDPAU acceleration)  @tab  E  @tab  X
354
@item HuffYUV                @tab  X  @tab  X
355
@item HuffYUV FFmpeg variant @tab  X  @tab  X
356
@item IBM Ultimotion         @tab     @tab  X
357
    @tab fourcc: ULTI
358
@item id Cinematic video     @tab     @tab  X
359
    @tab Used in Quake II.
360
@item id RoQ video           @tab  X  @tab  X
361
    @tab Used in Quake III, Jedi Knight 2, other computer games.
362 363
@item Intel H.263            @tab     @tab  X
@item Intel Indeo 2          @tab     @tab  X
364
@item Intel Indeo 3          @tab     @tab  X
365
@item Interplay C93          @tab     @tab  X
366
    @tab Used in the game Cyberia from Interplay.
367
@item Interplay MVE video    @tab     @tab  X
368
    @tab Used in Interplay .MVE files.
369
@item Karl Morton's video codec  @tab     @tab  X
370
    @tab Codec used in Worms games.
371 372
@item LCL (LossLess Codec Library) MSZH  @tab     @tab  X
@item LCL (LossLess Codec Library) ZLIB  @tab  E  @tab  E
373 374 375
@item LOCO                   @tab     @tab  X
@item lossless MJPEG         @tab  X  @tab  X
@item Microsoft RLE          @tab     @tab  X
376
@item Microsoft Video 1      @tab     @tab  X
377
@item Mimic                  @tab     @tab  X
378
    @tab Used in MSN Messenger Webcam streams.
379
@item Miro VideoXL           @tab     @tab  X
380
    @tab fourcc: VIXL
381
@item MJPEG (Motion JPEG)    @tab  X  @tab  X
382 383 384 385 386 387 388 389 390 391
@item Motion Pixels video    @tab     @tab  X
@item MPEG-1 video           @tab  X  @tab  X
@item MPEG-1/2 video XvMC (X-Video Motion Compensation)  @tab     @tab  X
@item MPEG-1/2 video (VDPAU acceleration)  @tab     @tab  X
@item MPEG-2 video           @tab  X  @tab  X
@item MPEG-4 part 2          @tab  X  @tab  X
    @ libxvidcore can be used alternatively for encoding.
@item MPEG-4 part 2 Microsoft variant version 1  @tab  X  @tab  X
@item MPEG-4 part 2 Microsoft variant version 2  @tab  X  @tab  X
@item MPEG-4 part 2 Microsoft variant version 3  @tab  X  @tab  X
392
@item Nintendo Gamecube THP video  @tab     @tab  X
393 394
@item NuppelVideo/RTjpeg     @tab     @tab  X
    @tab Video encoding used in NuppelVideo files.
395
@item On2 VP3                @tab     @tab  X
396
    @tab still experimental
397
@item On2 VP5                @tab     @tab  X
398
    @tab fourcc: VP50
399
@item On2 VP6                @tab     @tab  X
400
    @tab fourcc: VP60,VP61,VP62
401
@item planar RGB             @tab     @tab  X
402
    @tab fourcc: 8BPS
403
@item Q-team QPEG            @tab     @tab  X
404
    @tab fourccs: QPEG, Q1.0, Q1.1
405
@item QuickTime 8BPS video   @tab     @tab  X
406 407 408 409 410 411 412
@item QuickTime Animation (RLE) video  @tab  X  @tab  X
    @tab fourcc: 'rle '
@item QuickTime Graphics (SMC)  @tab     @tab  X
    @tab fourcc: 'smc '
@item QuickTime video (RPZA) @tab     @tab  X
    @tab fourcc: rpza
@item Raw Video              @tab  X  @tab  X
413 414
@item RealVideo 1.0          @tab  X  @tab  X
@item RealVideo 2.0          @tab  X  @tab  X
Kostya Shishkov's avatar
Kostya Shishkov committed
415 416
@item RealVideo 3.0          @tab     @tab  X
    @tab still far from ideal
Kostya Shishkov's avatar
Kostya Shishkov committed
417
@item RealVideo 4.0          @tab     @tab  X
418
@item Renderware TXD (TeXture Dictionary)  @tab     @tab  X
419
    @tab Texture dictionaries used by the Renderware Engine.
420 421
@item RL2 video              @tab     @tab  X
    @tab used in some games by Entertainment Software Partners
422 423
@item Sierra VMD video       @tab     @tab  X
    @tab Used in Sierra VMD files.
424
@item Smacker video          @tab     @tab  X
425
    @tab Video encoding used in Smacker.
426
@item SMPTE VC-1             @tab     @tab  X
427
@item Snow                   @tab  X  @tab  X
428
    @tab experimental wavelet codec (fourcc: SNOW)
429
@item Sony PlayStation MDEC (Motion DECoder)  @tab     @tab  X
430
@item Sorenson Vector Quantizer 1  @tab  X  @tab  X
431
    @tab fourcc: SVQ1
432
@item Sorenson Vector Quantizer 3  @tab     @tab  X
433
    @tab fourcc: SVQ3
434
@item Sunplus JPEG (SP5X)    @tab     @tab  X
435
    @tab fourcc: SP5X
436
@item TechSmith Screen Capture Codec  @tab     @tab  X
437
    @tab fourcc: TSCC
438
@item Theora                 @tab  E  @tab  X
439
    @tab encoding supported through external library libtheora
440
@item Tiertex Limited SEQ video  @tab     @tab  X
441
    @tab Codec used in DOS CD-ROM FlashBack game.
442
@item VMware Screen Codec / VMware Video  @tab     @tab  X
443
    @tab Codec used in videos captured by VMware.
444
@item Westwood Studios VQA (Vector Quantized Animation) video  @tab     @tab  X
445
@item Windows Media Video 7  @tab  X  @tab  X
446
@item Windows Media Video 8  @tab  X  @tab  X
447 448
@item Windows Media Video 9  @tab     @tab  X
    @tab not completely working
449 450
@item Wing Commander III / Xan  @tab     @tab  X
    @tab Used in Wing Commander III .MVE files.
451 452
@item Winnov WNV1            @tab     @tab  X
@item WMV7                   @tab  X  @tab  X
453
@item YAMAHA SMAF            @tab  X  @tab  X
454
@item ZLIB                   @tab  X  @tab  X
455
    @tab part of LCL, encoder experimental
456
@item Zip Motion Blocks Video  @tab   X @tab  X
457
    @tab Encoder works only in PAL8.
458 459 460 461
@end multitable

@code{X} means that encoding (resp. decoding) is supported.

462 463
@code{E} means that support is provided through an external library.

464 465
@section Audio Codecs

466
@multitable @columnfractions .4 .1 .1 .4
467
@item Name @tab Encoding @tab Decoding @tab Comments
468
@item 8SVX audio             @tab     @tab  X
469
@item AAC                    @tab  E  @tab  X
470
    @tab encoding supported through external library libfaac
Justin Ruggles's avatar
Justin Ruggles committed
471
@item AC-3                   @tab IX  @tab  X
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
@item ADPCM 4X Movie         @tab     @tab  X
@item ADPCM CDROM XA         @tab     @tab  X
@item ADPCM Creative Technology @tab     @tab  X
    @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
@item ADPCM Electronic Arts  @tab     @tab  X
    @tab Used in various EA titles.
@item ADPCM Electronic Arts Maxis CDROM XS  @tab     @tab  X
    @tab Used in Sim City 3000.
@item ADPCM Electronic Arts R1  @tab     @tab  X
@item ADPCM Electronic Arts R2  @tab     @tab  X
@item ADPCM Electronic Arts R3  @tab     @tab  X
@item ADPCM Electronic Arts XAS @tab     @tab  X
@item ADPCM G.726            @tab  X  @tab  X
@item ADPCM IMA AMV          @tab     @tab  X
    @tab Used in AMV files
@item ADPCM IMA Electronic Arts EACS  @tab     @tab  X
@item ADPCM IMA Electronic Arts SEAD  @tab     @tab  X
@item ADPCM IMA Funcom       @tab     @tab  X
@item ADPCM IMA QuickTime    @tab  X  @tab  X
@item ADPCM IMA Loki SDL MJPEG  @tab     @tab  X
@item ADPCM IMA WAV          @tab  X  @tab  X
@item ADPCM IMA Westwood     @tab     @tab  X
@item ADPCM ISS IMA          @tab     @tab  X
    @tab Used in FunCom games.
@item ADPCM IMA Duck DK3     @tab     @tab  X
    @tab Used in some Sega Saturn console games.
@item ADPCM IMA Duck DK4     @tab     @tab  X
    @tab Used in some Sega Saturn console games.
@item ADPCM Microsoft        @tab  X  @tab  X
@item ADPCM MS IMA           @tab  X  @tab  X
@item ADPCM Nintendo Gamecube THP  @tab     @tab  X
@item ADPCM QT IMA           @tab  X  @tab  X
@item ADPCM SEGA CRI ADX     @tab  X  @tab  X
    @tab Used in Sega Dreamcast games.
@item ADPCM Shockwave Flash  @tab  X  @tab  X
@item ADPCM SMJPEG IMA       @tab     @tab  X
    @tab Used in certain Loki game ports.
@item ADPCM Sound Blaster Pro 2-bit  @tab     @tab  X
@item ADPCM Sound Blaster Pro 2.6-bit  @tab     @tab  X
@item ADPCM Sound Blaster Pro 4-bit  @tab     @tab  X
@item ADPCM Westwood Studios IMA @tab     @tab  X
    @tab Used in Westwood Studios games like Command and Conquer.
@item ADPCM Yamaha           @tab  X  @tab  X
515
@item AMR-NB                 @tab  E  @tab  E
516
    @tab supported through external library libamrnb
517
@item AMR-WB                 @tab  E  @tab  E
518
    @tab supported through external library libamrwb
519
@item Apple lossless audio   @tab  X  @tab  X
520
    @tab QuickTime fourcc 'alac'
521 522
@item Atrac 3                @tab     @tab  X
@item Delphine Software International CIN audio  @tab     @tab  X
523
    @tab Codec used in Delphine Software International games.
524 525 526
@item COOK                   @tab     @tab  X
    @tab All versions except 5.1 are supported.
@item DCA (DTS Coherent Acoustics)  @tab     @tab  X
527 528 529 530 531 532 533 534
@item DPCM id RoQ            @tab  X  @tab  X
    @tab Used in Quake III, Jedi Knight 2, other computer games.
@item DPCM Interplay         @tab     @tab  X
    @tab Used in various Interplay computer games.
@item DPCM Sierra Online     @tab     @tab  X
    @tab Used in Sierra Online game audio files.
@item DPCM Sol               @tab     @tab  X
@item DPCM Xan               @tab     @tab  X
535 536
@item DSP Group TrueSpeech   @tab     @tab  X
@item DV audio               @tab     @tab  X
537
@item Enhanced AC-3          @tab     @tab  X
538 539
@item FLAC (Free Lossless Audio Codec)  @tab  X  @tab  IX
@item G.729                  @tab     @tab  X
540
@item GSM                    @tab  E  @tab  E
541
    @tab supported through external library libgsm
542
@item GSM Microsoft variant  @tab  E  @tab  E
543
    @tab supported through external library libgsm
544 545 546 547
@item IMC (Intel Music Coder)  @tab     @tab  X
@item MACE (Macintosh Audio Compression/Expansion) 3:1  @tab     @tab  X
@item MACE (Macintosh Audio Compression/Expansion) 6:1  @tab     @tab  X
@item MLP(Meridian Lossless Packing)/TrueHD  @tab     @tab  X
548
    @tab Used in DVD-Audio and Blu-Ray discs.
549
@item Monkey's Audio         @tab     @tab  X
550
    @tab Only versions 3.97-3.99 are supported.
551 552 553 554 555 556
@item MP1 (MPEG audio layer 1)  @tab     @tab IX
@item MP2 (MPEG audio layer 2)  @tab IX  @tab IX
@item MP3 (MPEG audio layer 3)  @tab  E  @tab IX
    @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
@item Musepack SV7           @tab     @tab  X
@item Musepack SV8           @tab     @tab  X
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
@item Nellymoser Asao        @tab  X  @tab  X
@item PCM A-law              @tab  X  @tab  X
@item PCM mu-law             @tab  X  @tab  X
@item PCM 16-bit little-endian planar  @tab     @tab  X
@item PCM 32-bit floating point big-endian  @tab  X  @tab  X
@item PCM 32-bit floating point little-endian  @tab  X  @tab  X
@item PCM 64-bit floating point big-endian  @tab  X  @tab  X
@item PCM 64-bit floating point little-endian  @tab  X  @tab  X
@item PCM D-Cinema audio signed 24-bit   @tab  X  @tab  X
@item PCM signed 8-bit       @tab  X  @tab  X
@item PCM signed 16-bit big-endian  @tab  X  @tab  X
@item PCM signed 16-bit little-endian  @tab  X  @tab  X
@item PCM signed 24-bit big-endian  @tab  X  @tab  X
@item PCM signed 24-bit little-endian  @tab  X  @tab  X
@item PCM signed 32-bit big-endian  @tab  X  @tab  X
@item PCM signed 32-bit little-endian  @tab  X  @tab  X
@item PCM unsigned 8-bit     @tab  X  @tab  X
@item PCM unsigned 16-bit big-endian  @tab  X  @tab  X
@item PCM unsigned 16-bit little-endian  @tab  X  @tab  X
@item PCM unsigned 24-bit big-endian  @tab  X  @tab  X
@item PCM unsigned 24-bit little-endian  @tab  X  @tab  X
@item PCM unsigned 32-bit big-endian  @tab  X  @tab  X
@item PCM unsigned 32-bit little-endian  @tab  X  @tab  X
@item PCM Zork               @tab  X  @tab  X
581
@item QCELP / PureVoice      @tab     @tab  X
582
@item QDesign Music Codec 2  @tab     @tab  X
583
    @tab There are still some distortions.
584
@item RealAudio 1.0 (14.4K)  @tab     @tab  X
585
    @tab Real 14400 bit/s codec
586
@item RealAudio 2.0 (28.8K)  @tab     @tab  X
587
    @tab Real 28800 bit/s codec
588
@item RealAudio 3.0 (dnet)   @tab IX  @tab  X
Justin Ruggles's avatar
Justin Ruggles committed
589
    @tab Real low bitrate AC-3 codec
590
@item Shorten                @tab     @tab  X
591 592
@item Sierra VMD audio       @tab     @tab  X
    @tab Used in Sierra VMD files.
593
@item Smacker audio          @tab     @tab  X
Justin Ruggles's avatar
Justin Ruggles committed
594 595 596 597
@item Sonic                  @tab  X  @tab  X
    @tab experimental codec
@item Sonic lossless         @tab  X  @tab  X
    @tab experimental codec
598
@item Speex                  @tab     @tab  E
599
    @tab supported through external library libspeex
600
@item True Audio (TTA)       @tab     @tab  X
601 602
@item Vorbis                 @tab  E  @tab  X
    @ A native but very primitive encoder exists.
603
@item WavPack                @tab     @tab  X
604 605 606
@item Westwood Audio (SND1)  @tab     @tab  X
@item Windows Media Audio 1  @tab  X  @tab  X
@item Windows Media Audio 2  @tab  X  @tab  X
607
    @tab Used in Origin's Wing Commander IV AVI files.
608 609 610 611
@end multitable

@code{X} means that encoding (resp. decoding) is supported.

612 613
@code{E} means that support is provided through an external library.

614 615 616
@code{I} means that an integer-only version is available, too (ensures high
performance on systems without hardware floating point support).

Diego Biurrun's avatar
Diego Biurrun committed
617 618
@section Subtitle Formats

619
@multitable @columnfractions .4 .1 .1 .1 .1
620
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
621
@item SSA/ASS      @tab X @tab X
622 623 624
@item DVB          @tab X @tab X @tab X @tab X
@item DVD          @tab X @tab X @tab X @tab X
@item XSUB         @tab   @tab   @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
625 626 627 628
@end multitable

@code{X} means that the feature is supported.

629 630
@section Network Protocols

631
@multitable @columnfractions .4 .1
632 633 634 635 636 637 638 639 640 641 642 643 644
@item Name         @tab Support
@item file         @tab X
@item Gopher       @tab X
@item HTTP         @tab X
@item pipe         @tab X
@item RTP          @tab X
@item TCP          @tab X
@item UDP          @tab X
@end multitable

@code{X} means that the protocol is supported.


645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
@section Input/Output Devices

@multitable @columnfractions .4 .1 .1
@item Name              @tab Input  @tab Output
@item ALSA              @tab X      @tab X
@item BEOS audio        @tab X      @tab X
@item BKTR              @tab X      @tab
@item DV1394            @tab X      @tab
@item LIBDC1394         @tab X      @tab
@item OSS               @tab X      @tab X
@item Video4Linux       @tab X      @tab
@item Video4Linux2      @tab X      @tab
@item VfW capture       @tab X      @tab
@item X11 grabbing      @tab X      @tab
@end multitable

661
@code{X} means that input/output is supported.
662 663


664 665 666 667 668 669 670 671 672
@chapter Platform Specific information

@section BSD

BSD make will not build FFmpeg, you need to install and use GNU Make
(@file{gmake}).

@section Windows

673
To get help and instructions for building FFmpeg under Windows, check out
674
the FFmpeg Windows Help Forum at
675
@url{http://ffmpeg.arrozcru.org/}.
676 677 678

@subsection Native Windows compilation

679
FFmpeg can be built to run natively on Windows using the MinGW tools. Install
680 681
the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
You can find detailed installation
682 683
instructions in the download section and the FAQ.

684 685 686 687 688 689 690 691
FFmpeg does not build out-of-the-box with the packages the automated MinGW
installer provides. It also requires coreutils to be installed and many other
packages updated to the latest version. The minimum version for some packages
are listed below:

@itemize
@item bash 3.1
@item msys-make 3.81-2 (note: not mingw32-make)
692
@item w32api 3.13
693 694 695
@item mingw-runtime 3.15
@end itemize

696 697 698
You will also need to pass @code{-fno-common} to the compiler to work around
a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).

699
Within the MSYS shell, configure and make with:
700

701
@example
702
./configure --enable-memalign-hack --extra-cflags=-fno-common
703 704 705
make
make install
@end example
706

707 708 709
This will install @file{ffmpeg.exe} along with many other development files
to @file{/usr/local}. You may specify another install path using the
@code{--prefix} option in @file{configure}.
710

711
Notes:
712

713
@itemize
714

715 716 717 718 719
@item In order to compile FFplay, you must have the MinGW development library
of SDL. Get it from @url{http://www.libsdl.org}.
Edit the @file{bin/sdl-config} script so that it points to the correct prefix
where SDL was installed. Verify that @file{sdl-config} can be launched from
the MSYS command line.
720 721

@item By using @code{./configure --enable-shared} when configuring FFmpeg,
722
you can build libavutil, libavcodec and libavformat as DLLs.
723 724 725

@end itemize

726
@subsection Microsoft Visual C++ compatibility
727

728 729 730 731 732 733 734
As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
want to use the libav* libraries in your own applications, you can still
compile those applications using MSVC++. But the libav* libraries you link
to @emph{must} be built with MinGW. However, you will not be able to debug
inside the libav* libraries, since MSVC++ does not recognize the debug
symbols generated by GCC.
We strongly recommend you to move over from MSVC++ to MinGW tools.
735

736 737 738
This description of how to use the FFmpeg libraries with MSVC++ is based on
Microsoft Visual C++ 2005 Express Edition. If you have a different version,
you might have to modify the procedures slightly.
739

740
@subsubsection Using static libraries
741

742
Assuming you have just built and installed FFmpeg in @file{/usr/local}.
743 744 745 746 747 748 749 750 751

@enumerate

@item Create a new console application ("File / New / Project") and then
select "Win32 Console Application". On the appropriate page of the
Application Wizard, uncheck the "Precompiled headers" option.

@item Write the source code for your application, or, for testing, just
copy the code from an existing sample application into the source file
752 753
that MSVC++ has already created for you. For example, you can copy
@file{output_example.c} from the FFmpeg distribution.
754 755 756 757 758

@item Open the "Project / Properties" dialog box. In the "Configuration"
combo box, select "All Configurations" so that the changes you make will
affect both debug and release builds. In the tree view on the left hand
side, select "C/C++ / General", then edit the "Additional Include
759 760
Directories" setting to contain the path where the FFmpeg includes were
installed (i.e. @file{c:\msys\1.0\local\include}).
761 762
Do not add MinGW's include directory here, or the include files will
conflict with MSVC's.
763 764 765 766 767 768 769 770 771 772 773 774

@item Still in the "Project / Properties" dialog box, select
"Linker / General" from the tree view and edit the
"Additional Library Directories" setting to contain the @file{lib}
directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
and the directory where MinGW's GCC libs are installed
(i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
"Linker / Input" from the tree view, and add the files @file{libavformat.a},
@file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
@file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
to the end of "Additional Dependencies".
775 776 777 778 779 780 781

@item Now, select "C/C++ / Code Generation" from the tree view. Select
"Debug" in the "Configuration" combo box. Make sure that "Runtime
Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
the "Configuration" combo box and make sure that "Runtime Library" is
set to "Multi-threaded DLL".

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
@item Click "OK" to close the "Project / Properties" dialog box.

@item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
and install it in MSVC++'s include directory
(i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).

@item MSVC++ also does not understand the @code{inline} keyword used by
FFmpeg, so you must add this line before @code{#include}ing libav*:
@example
#define inline _inline
@end example

@item Build your application, everything should work.

@end enumerate

@subsubsection Using shared libraries

This is how to create DLL and LIB files that are compatible with MSVC++:

@enumerate

@item Add a call to @file{vcvars32.bat} (which sets up the environment
variables for the Visual C++ tools) as the first line of @file{msys.bat}.
The standard location for @file{vcvars32.bat} is
@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
If this corresponds to your setup, add the following line as the first line
of @file{msys.bat}:

@example
call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
@end example

Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
and run @file{c:\msys\1.0\msys.bat} from there.

@item Within the MSYS shell, run @code{lib.exe}. If you get a help message
from @file{Microsoft (R) Library Manager}, this means your environment
variables are set up correctly, the @file{Microsoft (R) Library Manager}
is on the path and will be used by FFmpeg to create
MSVC++-compatible import libraries.

@item Build FFmpeg with

@example
./configure --enable-shared --enable-memalign-hack
make
make install
@end example

Your install path (@file{/usr/local/} by default) should now have the
necessary DLL and LIB files under the @file{bin} directory.
836 837 838

@end enumerate

839 840 841 842 843 844 845 846 847 848 849 850 851
To use those files with MSVC++, do the same as you would do with
the static libraries, as described above. But in Step 4,
you should only need to add the directory where the LIB files are installed
(i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
installed in the @file{bin} directory. And instead of adding @file{libxx.a}
files, you should add @file{avcodec.lib}, @file{avformat.lib}, and
@file{avutil.lib}. There should be no need for @file{libmingwex.a},
@file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
statically linked into the DLLs. The @file{bin} directory contains a bunch
of DLL files, but the ones that are actually used to run your application
are the ones with a major version number in their filenames
(i.e. @file{avcodec-51.dll}).

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
@subsection Cross compilation for Windows with Linux

You must use the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.

Then configure FFmpeg with the following options:
@example
./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
@end example
(you can change the cross-prefix according to the prefix chosen for the
MinGW tools).

Then you can easily test FFmpeg with Wine
(@url{http://www.winehq.com/}).

@subsection Compilation under Cygwin

869 870 871
The main issue with the 1.5.x Cygwin versions is that newlib, its C library,
does not contain llrint().  You need to upgrade to the unstable 1.7.x versions,
or leverage the implementation in MinGW (as explained below).
872 873 874 875

Just install your Cygwin with all the "Base" packages, plus the
following "Devel" ones:
@example
876
binutils, gcc-core, make, subversion, mingw-runtime, diffutils
877 878
@end example

Víctor Paesa's avatar
Víctor Paesa committed
879 880 881
The experimental gcc4 package is still buggy, hence please
use the official gcc 3.4.4 or a 4.2.x compiled from source by yourself.

882 883
Install the current binutils-20080624-2 as they work fine (the old
binutils-20060709-1 proved buggy on shared builds).
884

885 886 887 888 889 890 891
Then create a small library that just contains llrint():

@example
ar x /usr/lib/mingw/libmingwex.a llrint.o
ar cq /usr/local/lib/libllrint.a llrint.o
@end example

892 893 894
Then run

@example
895
./configure --enable-static --disable-shared  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
896 897 898 899 900
@end example

to make a static build or

@example
901
./configure --enable-shared --disable-static  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
902 903 904 905 906
@end example

to build shared libraries.

If you want to build FFmpeg with additional libraries, download Cygwin
907 908 909 910 911 912
"Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
@example
libogg-devel, libvorbis-devel
@end example

These library packages are only available from Cygwin Ports
913
(@url{http://sourceware.org/cygwinports/}) :
914 915 916 917 918 919 920 921 922

@example
yasm, libSDL-devel, libdirac-devel, libfaac-devel, libfaad-devel, libgsm-devel,
libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
libxvidcore-devel
@end example

The recommendation for libnut and x264 is to build them from source by
yourself, as they evolve too quickly for Cygwin Ports to be up to date.
923

924 925 926
Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.

927 928 929 930 931 932 933 934