general.texi 41 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.
112
@item LMLM4                     @tab   @tab X
113
    @tab Used by Linux Media Labs MPEG-4 PCI boards
Diego Biurrun's avatar
Diego Biurrun committed
114
@item Matroska                  @tab X @tab X
115
@item Matroska audio            @tab X @tab
116
@item MAXIS XA                  @tab   @tab X
117
    @tab Used in Sim City 3000; file extension .xa.
118
@item MD Studio                 @tab   @tab X
Diego Biurrun's avatar
Diego Biurrun committed
119
@item Monkey's Audio            @tab   @tab X
120
@item Motion Pixels MVI         @tab   @tab X
121 122
@item MOV/QuickTime/MP4         @tab X @tab X
    @tab 3GP, 3GP2, PSP, iPod variants supported
123 124
@item MP2                       @tab X @tab X
@item MP3                       @tab X @tab X
125 126 127 128 129
@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
130
    @tab also known as DVB Transport Stream
131
@item MPEG-4                    @tab X @tab X
132
    @tab MPEG-4 is a variant of QuickTime.
133
@item MIME multipart JPEG       @tab X @tab
134
@item MSN TCP webcam            @tab   @tab X
135
    @tab Used by MSN Messenger webcam streams.
136 137 138
@item MTV                       @tab   @tab X
@item Musepack                  @tab   @tab X
@item Musepack SV8              @tab   @tab X
139 140
@item Material eXchange Format (MXF) @tab X @tab X
    @tab SMPTE 377M, used by D-Cinema, broadcast industry.
141 142
@item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
    @tab SMPTE 386M, D-10/IMX Mapping.
143 144
@item NC camera feed            @tab   @tab X
    @tab NC (AVIP NC4600) camera streams
145 146
@item NTT TwinVQ (VQF)          @tab   @tab X
    @tab Nippon Telegraph and Telephone Corporation TwinVQ.
147
@item Nullsoft Streaming Video  @tab   @tab X
148
@item NuppelVideo               @tab   @tab X
149
@item NUT                       @tab X @tab X
150
    @tab NUT Open Container Format
151
@item Ogg                       @tab X @tab X
152
@item TechnoTrend PVA           @tab   @tab X
153
    @tab Used by TechnoTrend DVB PCI boards.
Kenan Gillet's avatar
Kenan Gillet committed
154
@item QCP                       @tab   @tab X
155
@item raw ADTS (AAC)            @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
156
@item raw AC-3                  @tab X @tab X
157
@item raw Chinese AVS video     @tab   @tab X
158 159 160 161 162 163 164 165 166 167 168
@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
169
@item raw MJPEG                 @tab X @tab X
170 171 172 173 174 175
@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
176
@item raw video                 @tab X @tab X
177 178
@item raw id RoQ                @tab X @tab
@item raw Shorten               @tab   @tab X
Ramiro Polla's avatar
Ramiro Polla committed
179
@item raw TrueHD                @tab X @tab X
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
@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
201
@item RDT                       @tab   @tab X
202
@item REDCODE R3D               @tab   @tab X
Baptiste Coudurier's avatar
Baptiste Coudurier committed
203
    @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
Diego Biurrun's avatar
Diego Biurrun committed
204
@item RealMedia                 @tab X @tab X
205
@item Redirector                @tab   @tab X
206
@item Renderware TeXture Dictionary @tab   @tab X
207
@item RL2                       @tab   @tab X
208
    @tab Audio and video format used in some games by Entertainment Software Partners.
209
@item RPL/ARMovie               @tab   @tab X
210 211
@item RTMP                      @tab X @tab X
    @tab Output is performed by publishing stream to RTMP server
212 213 214
@item RTP                       @tab   @tab X
@item RTSP                      @tab   @tab X
@item SDP                       @tab   @tab X
215
@item Sega FILM/CPK             @tab   @tab X
216
    @tab Used in many Sega Saturn console games.
217
@item Sierra SOL                @tab   @tab X
218
    @tab .sol files used in Sierra Online games.
219
@item Sierra VMD                @tab   @tab X
220
    @tab Used in Sierra CD-ROM games.
221
@item Smacker                   @tab   @tab X
222
    @tab Multimedia format used by many games.
223 224 225
@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
226
@item Sony Wave64 (W64)         @tab   @tab X
227
@item SoX native format         @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
228
@item SUN AU format             @tab X @tab X
229
@item THP                       @tab   @tab X
230
    @tab Used on the Nintendo GameCube.
231 232
@item Tiertex Limited SEQ       @tab   @tab X
    @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
233 234
@item True Audio                @tab   @tab X
@item VC-1 test bitstream       @tab X @tab X
235
@item WAV                       @tab X @tab X
236
@item WavPack                   @tab   @tab X
237
@item Wing Commander III movie  @tab   @tab X
238
    @tab Multimedia format used in Origin's Wing Commander III computer game.
239 240 241 242
@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.
243
@item YUV4MPEG pipe             @tab X @tab X
244 245 246 247 248 249 250 251 252 253
@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
254
@item Name @tab Encoding @tab Decoding @tab Comments
255 256 257 258
@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.
259 260
@item BMP          @tab X @tab X
    @tab Microsoft BMP image
261 262
@item DPX          @tab   @tab X
    @tab Digital Picture Exchange
263 264 265 266
@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
267 268 269
@item JPEG-LS      @tab X @tab X
@item LJPEG        @tab X @tab
    @tab Lossless JPEG
270
@item PAM          @tab X @tab X
271
    @tab PAM is a PNM extension with alpha support.
272
@item PBM          @tab X @tab X
273
    @tab Portable BitMap image
274
@item PCX          @tab X @tab X
275
    @tab PC Paintbrush
276
@item PGM          @tab X @tab X
277
    @tab Portable GrayMap image
278
@item PGMYUV       @tab X @tab X
279 280 281
    @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
282
@item PPM          @tab X @tab X
283
    @tab Portable PixelMap image
284 285 286 287
@item PTX          @tab   @tab X
    @tab V.Flash PTX format
@item SGI          @tab X @tab X
    @tab SGI RGB image format
288 289
@item Sun Rasterfile  @tab   @tab X
    @tab Sun RAS image format
290 291
@item TIFF         @tab X @tab X
    @tab YUV, JPEG and some extension is not supported yet.
292 293
@item Truevision Targa  @tab X @tab X
    @tab Targa (.TGA) image format
294 295 296 297
@end multitable

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

298 299
@code{E} means that support is provided through an external library.

300 301 302
@section Video Codecs

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

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

492 493
@code{E} means that support is provided through an external library.

494 495
@section Audio Codecs

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

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

650 651
@code{E} means that support is provided through an external library.

652 653 654
@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
655 656
@section Subtitle Formats

657
@multitable @columnfractions .4 .1 .1 .1 .1
658
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
659
@item SSA/ASS      @tab X @tab X
660 661
@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
662
@item PGS          @tab   @tab   @tab   @tab X
663
@item XSUB         @tab   @tab   @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
664 665 666 667
@end multitable

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

668 669
@section Network Protocols

670
@multitable @columnfractions .4 .1
671 672 673 674 675 676 677 678 679 680 681 682 683
@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.


684 685 686 687 688 689 690 691
@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
692
@item JACK              @tab X      @tab
693 694 695 696 697 698 699 700
@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

701
@code{X} means that input/output is supported.
702 703


704 705 706 707 708 709 710 711 712
@chapter Platform Specific information

@section BSD

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

@section Windows

713
To get help and instructions for building FFmpeg under Windows, check out
714
the FFmpeg Windows Help Forum at
715
@url{http://ffmpeg.arrozcru.org/}.
716 717 718

@subsection Native Windows compilation

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

724 725 726 727 728 729 730 731
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)
732
@item w32api 3.13
733 734 735
@item mingw-runtime 3.15
@end itemize

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

739
Within the MSYS shell, configure and make with:
740

741
@example
742
./configure --enable-memalign-hack
743 744 745
make
make install
@end example
746

747 748 749
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}.
750

751
Notes:
752

753
@itemize
754

755 756 757 758 759 760
@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}).

761 762 763 764 765
@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.
766 767

@item By using @code{./configure --enable-shared} when configuring FFmpeg,
768
you can build libavutil, libavcodec and libavformat as DLLs.
769 770 771

@end itemize

772
@subsection Microsoft Visual C++ compatibility
773

774 775 776 777 778 779 780
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.
781

782 783 784
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.
785

786
@subsubsection Using static libraries
787

788
Assuming you have just built and installed FFmpeg in @file{/usr/local}.
789 790 791 792 793 794 795 796 797

@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
798
that MSVC++ has already created for you. For example, you can copy
799
@file{libavformat/output-example.c} from the FFmpeg distribution.
800 801 802 803 804

@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
805 806
Directories" setting to contain the path where the FFmpeg includes were
installed (i.e. @file{c:\msys\1.0\local\include}).
807 808
Do not add MinGW's include directory here, or the include files will
conflict with MSVC's.
809 810 811 812 813 814 815 816 817 818 819 820

@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".
821 822 823 824 825 826 827

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

828 829 830 831 832 833 834 835