general.texi 40.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
\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}.

17
@section OpenCORE AMR
18

19 20
FFmpeg can make use of the OpenCORE libraries for AMR-NB
decoding/encoding and AMR-WB decoding.
21

22
Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for
23 24 25 26 27 28 29 30 31
installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or
@code{--enable-libopencore-amrwb} to configure to enable the libraries.

Note that OpenCORE is under the Apache License 2.0 (see
@url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is
incompatible with the LGPL version 2.1 and GPL version 2. You have to
upgrade FFmpeg's license to LGPL version 3 (or if you have enabled
GPL components, GPL version 3) to use it.

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 8088flex TMV              @tab   @tab X
47
@item Audio IFF (AIFF)          @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
48 49
@item American Laser Games MM   @tab   @tab X
    @tab Multimedia format used in games like Mad Dog McCree.
50
@item 3GPP AMR                  @tab X @tab X
51 52
@item ASF                       @tab X @tab X
@item AVI                       @tab X @tab X
53
@item AVISynth                  @tab   @tab X
54
@item AVS                       @tab   @tab X
55
    @tab Multimedia format used by the Creature Shock game.
56 57 58
@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
59
    @tab Used in some games from Bethesda Softworks.
60 61 62
@item Brute Force & Ignorance   @tab   @tab X
    @tab Used in the game Flash Traffic: City of Angels.
@item Interplay C93             @tab   @tab X
63
    @tab Used in the game Cyberia from Interplay.
64
@item Delphine Software International CIN @tab   @tab X
65
    @tab Multimedia format used by Delphine Software games.
Peter Ross's avatar
Peter Ross committed
66 67
@item Core Audio Format         @tab   @tab X
    @tab Apple Core Audio Format
68
@item CRC testing format        @tab X @tab
69
@item Creative Voice            @tab X @tab X
70
    @tab Created for the Sound Blaster Pro.
Diego Biurrun's avatar
Diego Biurrun committed
71 72
@item CRYO APC                  @tab   @tab X
    @tab Audio format used in some games by CRYO Interactive Entertainment.
73
@item D-Cinema audio            @tab X @tab X
74
@item DV video                  @tab X @tab X
75
@item DXA                       @tab   @tab X
76 77
    @tab This format is used in the non-Windows version of the Feeble Files
         game and different game cutscenes repacked for use with ScummVM.
78
@item Electronic Arts cdata  @tab    @tab X
79
@item Electronic Arts Multimedia  @tab    @tab X
80
    @tab Used in various EA games; files have extensions like WVE and UV2.
81 82
@item FFM (FFserver live feed)  @tab X @tab X
@item Flash (SWF)               @tab X @tab X
83 84 85
@item Flash 9 (AVM2)            @tab X @tab X
    @tab Only embedded audio is decoded.
@item FLI/FLC/FLX animation     @tab   @tab X
86
    @tab .fli/.flc files
87
@item Flash Video (FLV)         @tab   @tab X
88
    @tab Macromedia Flash video files
89
@item framecrc testing format   @tab X @tab
90 91
@item FunCom ISS                @tab   @tab X
    @tab Audio format used in various games from FunCom like The Longest Journey.
92
@item GIF Animation             @tab X @tab
93
@item GXF                       @tab X @tab X
94
    @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
Diego Biurrun's avatar
Diego Biurrun committed
95
         playout servers.
96
@item id Quake II CIN video     @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
97
@item id RoQ                    @tab X @tab X
98
    @tab Used in Quake III, Jedi Knight 2, other computer games.
99
@item IEC61937 encapsulation @tab X @tab
100
@item IFF                       @tab   @tab X
101
    @tab Interchange File Format
102
@item Interplay MVE             @tab   @tab X
103
    @tab Format used in various Interplay computer games.
104
@item LMLM4                     @tab   @tab X
105
    @tab Used by Linux Media Labs MPEG-4 PCI boards
Diego Biurrun's avatar
Diego Biurrun committed
106
@item Matroska                  @tab X @tab X
107
@item Matroska audio            @tab X @tab
108
@item MAXIS XA                  @tab   @tab X
109
    @tab Used in Sim City 3000; file extension .xa.
110
@item MD Studio                 @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
111
@item Monkey's Audio            @tab   @tab X
112
@item Motion Pixels MVI         @tab   @tab X
113 114
@item MOV/QuickTime/MP4         @tab X @tab X
    @tab 3GP, 3GP2, PSP, iPod variants supported
115 116
@item MP2                       @tab X @tab X
@item MP3                       @tab X @tab X
117 118 119 120 121
@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
122
    @tab also known as DVB Transport Stream
123
@item MPEG-4                    @tab X @tab X
124
    @tab MPEG-4 is a variant of QuickTime.
125
@item MIME multipart JPEG       @tab X @tab
126
@item MSN TCP webcam            @tab   @tab X
127
    @tab Used by MSN Messenger webcam streams.
128 129 130
@item MTV                       @tab   @tab X
@item Musepack                  @tab   @tab X
@item Musepack SV8              @tab   @tab X
131 132
@item Material eXchange Format (MXF) @tab X @tab X
    @tab SMPTE 377M, used by D-Cinema, broadcast industry.
133 134
@item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
    @tab SMPTE 386M, D-10/IMX Mapping.
135 136
@item NC camera feed            @tab   @tab X
    @tab NC (AVIP NC4600) camera streams
137 138
@item NTT TwinVQ (VQF)          @tab   @tab X
    @tab Nippon Telegraph and Telephone Corporation TwinVQ.
139
@item Nullsoft Streaming Video  @tab   @tab X
140
@item NuppelVideo               @tab   @tab X
141
@item NUT                       @tab X @tab X
142
    @tab NUT Open Container Format
143
@item Ogg                       @tab X @tab X
144
@item TechnoTrend PVA           @tab   @tab X
145
    @tab Used by TechnoTrend DVB PCI boards.
Kenan Gillet's avatar
Kenan Gillet committed
146
@item QCP                       @tab   @tab X
147
@item raw ADTS (AAC)            @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
148
@item raw AC-3                  @tab X @tab X
149
@item raw Chinese AVS video     @tab   @tab X
150 151 152 153 154 155 156 157 158 159 160
@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
161
@item raw MJPEG                 @tab X @tab X
162 163 164 165 166 167
@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
168
@item raw video                 @tab X @tab X
169 170
@item raw id RoQ                @tab X @tab
@item raw Shorten               @tab   @tab X
Ramiro Polla's avatar
Ramiro Polla committed
171
@item raw TrueHD                @tab X @tab X
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
@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
193
@item RDT                       @tab   @tab X
194
@item REDCODE R3D               @tab   @tab X
Baptiste Coudurier's avatar
Baptiste Coudurier committed
195
    @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
Diego Biurrun's avatar
Diego Biurrun committed
196
@item RealMedia                 @tab X @tab X
197
@item Redirector                @tab   @tab X
198
@item Renderware TeXture Dictionary @tab   @tab X
199
@item RL2                       @tab   @tab X
200
    @tab Audio and video format used in some games by Entertainment Software Partners.
201
@item RPL/ARMovie               @tab   @tab X
202
@item RTMP                      @tab   @tab X
203 204 205
@item RTP                       @tab   @tab X
@item RTSP                      @tab   @tab X
@item SDP                       @tab   @tab X
206
@item Sega FILM/CPK             @tab   @tab X
207
    @tab Used in many Sega Saturn console games.
208
@item Sierra SOL                @tab   @tab X
209
    @tab .sol files used in Sierra Online games.
210
@item Sierra VMD                @tab   @tab X
211
    @tab Used in Sierra CD-ROM games.
212
@item Smacker                   @tab   @tab X
213
    @tab Multimedia format used by many games.
214 215 216
@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
Daniel Verkamp's avatar
Daniel Verkamp committed
217
@item Sony Wave64 (W64)         @tab   @tab X
218
@item SoX native format         @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
219
@item SUN AU format             @tab X @tab X
220
@item THP                       @tab   @tab X
221
    @tab Used on the Nintendo GameCube.
222 223
@item Tiertex Limited SEQ       @tab   @tab X
    @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
224 225
@item True Audio                @tab   @tab X
@item VC-1 test bitstream       @tab X @tab X
226
@item WAV                       @tab X @tab X
227
@item WavPack                   @tab   @tab X
228
@item Wing Commander III movie  @tab   @tab X
229
    @tab Multimedia format used in Origin's Wing Commander III computer game.
230 231 232 233
@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.
234
@item YUV4MPEG pipe             @tab X @tab X
235 236 237 238 239 240 241 242 243 244
@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
245
@item Name @tab Encoding @tab Decoding @tab Comments
246 247 248 249
@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.
250 251
@item BMP          @tab X @tab X
    @tab Microsoft BMP image
252 253
@item DPX          @tab   @tab X
    @tab Digital Picture Exchange
254 255 256 257
@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
258 259 260
@item JPEG-LS      @tab X @tab X
@item LJPEG        @tab X @tab
    @tab Lossless JPEG
261
@item PAM          @tab X @tab X
262
    @tab PAM is a PNM extension with alpha support.
263
@item PBM          @tab X @tab X
264
    @tab Portable BitMap image
265
@item PCX          @tab X @tab X
266
    @tab PC Paintbrush
267
@item PGM          @tab X @tab X
268
    @tab Portable GrayMap image
269
@item PGMYUV       @tab X @tab X
270 271 272
    @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
273
@item PPM          @tab X @tab X
274
    @tab Portable PixelMap image
275 276 277 278
@item PTX          @tab   @tab X
    @tab V.Flash PTX format
@item SGI          @tab X @tab X
    @tab SGI RGB image format
279 280
@item Sun Rasterfile  @tab   @tab X
    @tab Sun RAS image format
281 282
@item TIFF         @tab X @tab X
    @tab YUV, JPEG and some extension is not supported yet.
283 284
@item Truevision Targa  @tab X @tab X
    @tab Targa (.TGA) image format
285 286 287 288
@end multitable

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

289 290
@code{E} means that support is provided through an external library.

291 292 293
@section Video Codecs

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

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

477 478
@code{E} means that support is provided through an external library.

479 480
@section Audio Codecs

481
@multitable @columnfractions .4 .1 .1 .4
482
@item Name @tab Encoding @tab Decoding @tab Comments
483
@item 8SVX audio             @tab     @tab  X
484
@item AAC                    @tab  E  @tab  X
485
    @tab encoding supported through external library libfaac
Justin Ruggles's avatar
Justin Ruggles committed
486
@item AC-3                   @tab IX  @tab  X
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 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
@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
530
@item AMR-NB                 @tab  E  @tab  E
531 532 533
    @tab supported through external library libopencore-amrnb
@item AMR-WB                 @tab     @tab  E
    @tab decoding supported through external library libopencore-amrwb
534
@item Apple lossless audio   @tab  X  @tab  X
535
    @tab QuickTime fourcc 'alac'
536
@item Atrac 1                @tab     @tab  X
537 538
@item Atrac 3                @tab     @tab  X
@item Delphine Software International CIN audio  @tab     @tab  X
539
    @tab Codec used in Delphine Software International games.
540 541 542
@item COOK                   @tab     @tab  X
    @tab All versions except 5.1 are supported.
@item DCA (DTS Coherent Acoustics)  @tab     @tab  X
543 544 545 546 547 548 549 550
@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
551
    @tab Used in Origin's Wing Commander IV AVI files.
552 553
@item DSP Group TrueSpeech   @tab     @tab  X
@item DV audio               @tab     @tab  X
554
@item Enhanced AC-3          @tab     @tab  X
555 556
@item FLAC (Free Lossless Audio Codec)  @tab  X  @tab  IX
@item G.729                  @tab     @tab  X
557
@item GSM                    @tab  E  @tab  E
558
    @tab supported through external library libgsm
559
@item GSM Microsoft variant  @tab  E  @tab  E
560
    @tab supported through external library libgsm
561 562 563
@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
Ramiro Polla's avatar
Ramiro Polla committed
564 565
@item MLP (Meridian Lossless Packing)  @tab     @tab  X
    @tab Used in DVD-Audio discs.
566
@item Monkey's Audio         @tab     @tab  X
567
    @tab Only versions 3.97-3.99 are supported.
568 569 570 571 572 573
@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
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
@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
590
@item PCM signed 16/20/24-bit big-endian in MPEG-TS  @tab     @tab  X
591 592 593 594 595 596 597 598
@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
599
@item QCELP / PureVoice      @tab     @tab  X
600
@item QDesign Music Codec 2  @tab     @tab  X
601
    @tab There are still some distortions.
602
@item RealAudio 1.0 (14.4K)  @tab     @tab  X
603
    @tab Real 14400 bit/s codec
604
@item RealAudio 2.0 (28.8K)  @tab     @tab  X
605
    @tab Real 28800 bit/s codec
606
@item RealAudio 3.0 (dnet)   @tab IX  @tab  X
Justin Ruggles's avatar
Justin Ruggles committed
607
    @tab Real low bitrate AC-3 codec
608
@item Shorten                @tab     @tab  X
609 610
@item Sierra VMD audio       @tab     @tab  X
    @tab Used in Sierra VMD files.
611
@item Smacker audio          @tab     @tab  X
Justin Ruggles's avatar
Justin Ruggles committed
612 613 614 615
@item Sonic                  @tab  X  @tab  X
    @tab experimental codec
@item Sonic lossless         @tab  X  @tab  X
    @tab experimental codec
616
@item Speex                  @tab     @tab  E
617
    @tab supported through external library libspeex
618
@item True Audio (TTA)       @tab     @tab  X
Ramiro Polla's avatar
Ramiro Polla committed
619 620
@item TrueHD                 @tab     @tab  X
    @tab Used in HD-DVD and Blu-Ray discs.
Vitor Sessak's avatar
Vitor Sessak committed
621
@item TwinVQ (VQF flavor)    @tab     @tab  X
622 623
@item Vorbis                 @tab  E  @tab  X
    @ A native but very primitive encoder exists.
624
@item WavPack                @tab     @tab  X
625 626 627
@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
628
@item Windows Media Audio Pro @tab    @tab  X
629 630 631 632
@end multitable

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

633 634
@code{E} means that support is provided through an external library.

635 636 637
@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
638 639
@section Subtitle Formats

640
@multitable @columnfractions .4 .1 .1 .1 .1
641
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
642
@item SSA/ASS      @tab X @tab X
643 644
@item DVB          @tab X @tab X @tab X @tab X
@item DVD          @tab X @tab X @tab X @tab X
Stephen Backway's avatar
Stephen Backway committed
645
@item PGS          @tab   @tab   @tab   @tab X
646
@item XSUB         @tab   @tab   @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
647 648 649 650
@end multitable

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

651 652
@section Network Protocols

653
@multitable @columnfractions .4 .1
654 655 656 657 658 659 660 661 662 663 664 665 666
@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.


667 668 669 670 671 672 673 674
@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
675
@item JACK              @tab X      @tab
676 677 678 679 680 681 682 683
@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

684
@code{X} means that input/output is supported.
685 686


687 688 689 690 691 692 693 694 695
@chapter Platform Specific information

@section BSD

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

@section Windows

696
To get help and instructions for building FFmpeg under Windows, check out
697
the FFmpeg Windows Help Forum at
698
@url{http://ffmpeg.arrozcru.org/}.
699 700 701

@subsection Native Windows compilation

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

707 708 709 710 711 712 713 714
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)
715
@item w32api 3.13
716 717 718
@item mingw-runtime 3.15
@end itemize

719
FFmpeg automatically passes @code{-fno-common} to the compiler to work around
720 721
a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).

722
Within the MSYS shell, configure and make with:
723

724
@example
725
./configure --enable-memalign-hack
726 727 728
make
make install
@end example
729

730 731 732
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}.
733

734
Notes:
735

736
@itemize
737

738 739 740 741 742 743
@item Building natively using MSYS can be sped up by disabling implicit rules
in the Makefile by calling @code{make -r} instead of plain @code{make}. This
speed up is close to non-existent for normal one-off builds and is only
noticeable when running make for a second time (for example in
@code{make install}).

744 745 746 747 748
@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.
749 750

@item By using @code{./configure --enable-shared} when configuring FFmpeg,
751
you can build libavutil, libavcodec and libavformat as DLLs.
752 753 754

@end itemize

755
@subsection Microsoft Visual C++ compatibility
756

757 758 759 760 761 762 763
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.
764

765 766 767
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.
768

769
@subsubsection Using static libraries
770

771
Assuming you have just built and installed FFmpeg in @file{/usr/local}.
772 773 774 775 776 777 778 779 780

@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
781
that MSVC++ has already created for you. For example, you can copy
782
@file{libavformat/output-example.c} from the FFmpeg distribution.
783 784 785 786 787

@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
788 789
Directories" setting to contain the path where the FFmpeg includes were
installed (i.e. @file{c:\msys\1.0\local\include}).
790 791
Do not add MinGW's include directory here, or the include files will
conflict with MSVC's.
792 793 794 795 796 797 798 799 800 801 802 803

@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".
804 805 806 807 808 809 810

@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".

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 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
@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.
865 866 867

@end enumerate

868 869 870 871 872 873 874 875 876 877 878 879 880
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}).

881 882 883