general.texi 43.1 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

@chapter Supported File Formats and Codecs

Daniel Verkamp's avatar
Daniel Verkamp committed
35
You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
36 37 38 39 40 41 42

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

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

304 305
@code{E} means that support is provided through an external library.

306 307 308
@section Video Codecs

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

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

510 511
@code{E} means that support is provided through an external library.

512 513
@section Audio Codecs

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

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

671 672
@code{E} means that support is provided through an external library.

673 674 675
@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
676 677
@section Subtitle Formats

678
@multitable @columnfractions .4 .1 .1 .1 .1
679
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
680
@item SSA/ASS      @tab X @tab X
681 682
@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
683
@item PGS          @tab   @tab   @tab   @tab X
684
@item XSUB         @tab   @tab   @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
685 686 687 688
@end multitable

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

689 690
@section Network Protocols

691
@multitable @columnfractions .4 .1
692 693 694 695
@item Name         @tab Support
@item file         @tab X
@item Gopher       @tab X
@item HTTP         @tab X
696
@item MMS          @tab X
697 698 699 700 701 702 703 704 705
@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.


706 707 708 709 710 711 712
@section Input/Output Devices

@multitable @columnfractions .4 .1 .1
@item Name              @tab Input  @tab Output
@item ALSA              @tab X      @tab X
@item BKTR              @tab X      @tab
@item DV1394            @tab X      @tab
713
@item JACK              @tab X      @tab
714 715 716 717 718 719 720 721
@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

722
@code{X} means that input/output is supported.
723 724


725 726
@chapter Platform Specific information

727 728 729 730 731 732 733 734 735 736
@section DOS

Using a cross-compiler is preferred for various reasons.

@subsection DJGPP

FFmpeg cannot be compiled because of broken system headers, add
@code{--extra-cflags=-U__STRICT_ANSI__} to the configure options as a
workaround.

737 738 739 740 741 742 743
@section OS/2

For information about compiling FFmpeg on OS/2 see
@url{http://www.edm2.com/index.php/FFmpeg}.

@section Unix-like

744 745 746 747 748 749 750 751 752 753 754 755 756
Some parts of FFmpeg cannot be built with version 2.15 of the GNU
assembler which is still provided by a few AMD64 distributions. To
make sure your compiler really uses the required version of gas
after a binutils upgrade, run:

@example
$(gcc -print-prog-name=as) --version
@end example

If not, then you should install a different compiler that has no
hard-coded path to gas. In the worst case pass @code{--disable-asm}
to configure.

757
@subsection BSD
758 759 760 761

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

762
@subsubsection FreeBSD
763 764 765 766 767 768 769

FreeBSD will not compile out-of-the-box due to broken system headers.
Passing @code{--extra-cflags=-D__BSD_VISIBLE} to configure will work
around the problem. This may have unexpected sideeffects, so use it at
your own risk. If you care about FreeBSD, please make an attempt at
getting the system headers fixed.

770
@subsection (Open)Solaris
771 772

GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}),
773
standard Solaris Make will not work. When building with a non-c99 front-end
774
(gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
775 776 777 778 779 780 781 782 783
or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
since the libc is not c99-compliant by default. The probes performed by
configure may raise an exception leading to the death of configure itself
due to a bug in the system shell. Simply invoke a different shell such as
bash directly to work around this:

@example
bash ./configure
@end example
784

785 786 787 788 789 790
@subsection Darwin (MacOS X, iPhone)

MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from
@url{http://github.com/yuvi/gas-preprocessor} to build the optimized
assembler functions.

791 792
@section Windows

793
To get help and instructions for building FFmpeg under Windows, check out
794
the FFmpeg Windows Help Forum at
795
@url{http://ffmpeg.arrozcru.org/}.
796 797 798

@subsection Native Windows compilation

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

804 805 806 807 808 809 810 811
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)
812
@item w32api 3.13
813 814 815
@item mingw-runtime 3.15
@end itemize

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

819
Within the MSYS shell, configure and make with: