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