1b9fdbd359f17c8c4d3f325f187ed5f6fbcdf7b9
[ffmpeg.git] / 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 Adobe Filmstrip           @tab X @tab X
48 @item Audio IFF (AIFF)          @tab X @tab X
49 @item American Laser Games MM   @tab   @tab X
50     @tab Multimedia format used in games like Mad Dog McCree.
51 @item 3GPP AMR                  @tab X @tab X
52 @item ASF                       @tab X @tab X
53 @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 @item Beam Software SIFF        @tab   @tab X
58     @tab Audio and video format used in some games by Beam Software.
59 @item Bethesda Softworks VID    @tab   @tab X
60     @tab Used in some games from Bethesda Softworks.
61 @item Bink                      @tab   @tab X
62     @tab Multimedia format used by many games.
63 @item Brute Force & Ignorance   @tab   @tab X
64     @tab Used in the game Flash Traffic: City of Angels.
65 @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.
69 @item CD+G                      @tab   @tab X
70     @tab Video format used by CD+G karaoke disks
71 @item Core Audio Format         @tab   @tab X
72     @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.
76 @item CRYO APC                  @tab   @tab X
77     @tab Audio format used in some games by CRYO Interactive Entertainment.
78 @item D-Cinema audio            @tab X @tab X
79 @item Deluxe Paint Animation    @tab   @tab X
80 @item DV video                  @tab X @tab X
81 @item DXA                       @tab   @tab X
82     @tab This format is used in the non-Windows version of the Feeble Files
83          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 @item FFM (FFserver live feed)  @tab X @tab X
88 @item Flash (SWF)               @tab X @tab X
89 @item Flash 9 (AVM2)            @tab X @tab X
90     @tab Only embedded audio is decoded.
91 @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 @item FunCom ISS                @tab   @tab X
97     @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
101          playout servers.
102 @item id Quake II CIN video     @tab   @tab X
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 @item IV8                       @tab   @tab X
111     @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
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
119 @item Monkey's Audio            @tab   @tab X
120 @item Motion Pixels MVI         @tab   @tab X
121 @item MOV/QuickTime/MP4         @tab X @tab X
122     @tab 3GP, 3GP2, PSP, iPod variants supported
123 @item MP2                       @tab X @tab X
124 @item MP3                       @tab X @tab X
125 @item MPEG-1 System             @tab X @tab X
126     @tab muxed audio and video, VCD format supported
127 @item MPEG-PS (program stream)  @tab X @tab X
128     @tab also known as @code{VOB} file, SVCD and DVD format supported
129 @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 @item MTV                       @tab   @tab X
137 @item Musepack                  @tab   @tab X
138 @item Musepack SV8              @tab   @tab X
139 @item Material eXchange Format (MXF) @tab X @tab X
140     @tab SMPTE 377M, used by D-Cinema, broadcast industry.
141 @item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
142     @tab SMPTE 386M, D-10/IMX Mapping.
143 @item NC camera feed            @tab   @tab X
144     @tab NC (AVIP NC4600) camera streams
145 @item NTT TwinVQ (VQF)          @tab   @tab X
146     @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.
154 @item QCP                       @tab   @tab X
155 @item raw ADTS (AAC)            @tab X @tab X
156 @item raw AC-3                  @tab X @tab X
157 @item raw Chinese AVS video     @tab   @tab X
158 @item raw CRI ADX               @tab X @tab X
159 @item raw Dirac                 @tab X @tab X
160 @item raw DNxHD                 @tab X @tab X
161 @item raw DTS                   @tab X @tab X
162 @item raw E-AC-3                @tab X @tab X
163 @item raw FLAC                  @tab X @tab X
164 @item raw GSM                   @tab   @tab X
165 @item raw H.261                 @tab X @tab X
166 @item raw H.263                 @tab X @tab X
167 @item raw H.264                 @tab X @tab X
168 @item raw Ingenient MJPEG       @tab   @tab X
169 @item raw MJPEG                 @tab X @tab X
170 @item raw MLP                   @tab   @tab X
171 @item raw MPEG                  @tab   @tab X
172 @item raw MPEG-1                @tab   @tab X
173 @item raw MPEG-2                @tab   @tab X
174 @item raw MPEG-4                @tab X @tab X
175 @item raw NULL                  @tab X @tab
176 @item raw video                 @tab X @tab X
177 @item raw id RoQ                @tab X @tab
178 @item raw Shorten               @tab   @tab X
179 @item raw TrueHD                @tab X @tab X
180 @item raw VC-1                  @tab   @tab X
181 @item raw PCM A-law             @tab X @tab X
182 @item raw PCM mu-law            @tab X @tab X
183 @item raw PCM signed 8 bit      @tab X @tab X
184 @item raw PCM signed 16 bit big-endian  @tab X @tab X
185 @item raw PCM signed 16 bit little-endian  @tab X @tab X
186 @item raw PCM signed 24 bit big-endian  @tab X @tab X
187 @item raw PCM signed 24 bit little-endian  @tab X @tab X
188 @item raw PCM signed 32 bit big-endian  @tab X @tab X
189 @item raw PCM signed 32 bit little-endian  @tab X @tab X
190 @item raw PCM unsigned 8 bit    @tab X @tab X
191 @item raw PCM unsigned 16 bit big-endian  @tab X @tab X
192 @item raw PCM unsigned 16 bit little-endian  @tab X @tab X
193 @item raw PCM unsigned 24 bit big-endian  @tab X @tab X
194 @item raw PCM unsigned 24 bit little-endian  @tab X @tab X
195 @item raw PCM unsigned 32 bit big-endian  @tab X @tab X
196 @item raw PCM unsigned 32 bit little-endian  @tab X @tab X
197 @item raw PCM floating-point 32 bit big-endian  @tab X @tab X
198 @item raw PCM floating-point 32 bit little-endian  @tab X @tab X
199 @item raw PCM floating-point 64 bit big-endian  @tab X @tab X
200 @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
203     @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
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 @item RTMP                      @tab X @tab X
211     @tab Output is performed by publishing stream to RTMP server
212 @item RTP                       @tab   @tab X
213 @item RTSP                      @tab   @tab X
214 @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 @item Sony OpenMG (OMA)         @tab   @tab X
224     @tab Audio format used in Sony Sonic Stage and Sony Vegas.
225 @item Sony PlayStation STR      @tab   @tab X
226 @item Sony Wave64 (W64)         @tab   @tab X
227 @item SoX native format         @tab X @tab X
228 @item SUN AU format             @tab X @tab X
229 @item THP                       @tab   @tab X
230     @tab Used on the Nintendo GameCube.
231 @item Tiertex Limited SEQ       @tab   @tab X
232     @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
233 @item True Audio                @tab   @tab X
234 @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 @item Westwood Studios audio    @tab   @tab X
240     @tab Multimedia format used in Westwood Studios games.
241 @item Westwood Studios VQA      @tab   @tab X
242     @tab Multimedia format used in Westwood Studios games.
243 @item YUV4MPEG pipe             @tab X @tab X
244 @end multitable
245
246 @code{X} means that encoding (resp. decoding) is supported.
247
248 @section Image Formats
249
250 FFmpeg can read and write images for each frame of a video sequence. The
251 following image formats are supported:
252
253 @multitable @columnfractions .4 .1 .1 .4
254 @item Name @tab Encoding @tab Decoding @tab Comments
255 @item .Y.U.V       @tab X @tab X
256     @tab one raw file per component
257 @item animated GIF @tab X @tab X
258     @tab Only uncompressed GIFs are generated.
259 @item BMP          @tab X @tab X
260     @tab Microsoft BMP image
261 @item DPX          @tab   @tab X
262     @tab Digital Picture Exchange
263 @item JPEG         @tab X @tab X
264     @tab Progressive JPEG is not supported.
265 @item JPEG 2000    @tab   @tab E
266     @tab decoding supported through external library libopenjpeg
267 @item JPEG-LS      @tab X @tab X
268 @item LJPEG        @tab X @tab
269     @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     @tab PGM with U and V components in YUV 4:2:0
280 @item PNG          @tab X @tab X
281     @tab 2/4 bpp not supported yet
282 @item PPM          @tab X @tab X
283     @tab Portable PixelMap image
284 @item PTX          @tab   @tab X
285     @tab V.Flash PTX format
286 @item SGI          @tab X @tab X
287     @tab SGI RGB image format
288 @item Sun Rasterfile  @tab   @tab X
289     @tab Sun RAS image format
290 @item TIFF         @tab X @tab X
291     @tab YUV, JPEG and some extension is not supported yet.
292 @item Truevision Targa  @tab X @tab X
293     @tab Targa (.TGA) image format
294 @end multitable
295
296 @code{X} means that encoding (resp. decoding) is supported.
297
298 @code{E} means that support is provided through an external library.
299
300 @section Video Codecs
301
302 @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 @item 8SVX exponential       @tab     @tab  X
308 @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 @item Apple MJPEG-B          @tab     @tab  X
314 @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
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 @item Brute Force & Ignorance   @tab   @tab X
335     @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
340 @item CD+G                   @tab     @tab  X
341     @tab Video codec for CD+G karaoke disks
342 @item Chinese AVS video      @tab     @tab  X
343     @tab AVS1-P2, JiZhun profile
344 @item Delphine Software International CIN video  @tab     @tab  X
345     @tab Codec used in Delphine Software International games.
346 @item Cinepak                @tab     @tab  X
347 @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
352 @item Deluxe Paint Animation @tab     @tab  X
353 @item DNxHD                  @tab   X @tab  X
354     @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 @item DV (Digital Video)     @tab  X  @tab  X
360 @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.
364 @item Electronic Arts Madcow video  @tab     @tab  X
365 @item Electronic Arts TGV video  @tab     @tab  X
366 @item Electronic Arts TGQ video  @tab     @tab  X
367 @item Electronic Arts TQI video  @tab     @tab  X
368 @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 @item H.263 / H.263-1996     @tab  X  @tab  X
378 @item H.263+ / H.263-1998 / H.263 version 2  @tab  X  @tab  X
379 @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 @item Intel H.263            @tab     @tab  X
391 @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 @item LCL (LossLess Codec Library) MSZH  @tab     @tab  X
400 @item LCL (LossLess Codec Library) ZLIB  @tab  E  @tab  E
401 @item LOCO                   @tab     @tab  X
402 @item lossless MJPEG         @tab  X  @tab  X
403 @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 @item Motion Pixels video    @tab     @tab  X
411 @item MPEG-1 video           @tab  X  @tab  X
412 @item MPEG-1/2 video XvMC (X-Video Motion Compensation)  @tab     @tab  X
413 @item MPEG-1/2 video (VDPAU acceleration)  @tab     @tab  X
414 @item MPEG-2 video           @tab  X  @tab  X
415 @item MPEG-4 part 2          @tab  X  @tab  X
416     @ libxvidcore can be used alternatively for encoding.
417 @item MPEG-4 part 2 Microsoft variant version 1  @tab  X  @tab  X
418 @item MPEG-4 part 2 Microsoft variant version 2  @tab  X  @tab  X
419 @item MPEG-4 part 2 Microsoft variant version 3  @tab  X  @tab  X
420 @item Nintendo Gamecube THP video  @tab     @tab  X
421 @item NuppelVideo/RTjpeg     @tab     @tab  X
422     @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 @item QuickTime Animation (RLE) video  @tab  X  @tab  X
435     @tab fourcc: 'rle '
436 @item QuickTime Graphics (SMC)  @tab     @tab  X
437     @tab fourcc: 'smc '
438 @item QuickTime video (RPZA) @tab     @tab  X
439     @tab fourcc: rpza
440 @item R210 Quicktime Uncompressed RGB 10-bit     @tab     @tab  X
441 @item Raw Video              @tab  X  @tab  X
442 @item RealVideo 1.0          @tab  X  @tab  X
443 @item RealVideo 2.0          @tab  X  @tab  X
444 @item RealVideo 3.0          @tab     @tab  X
445     @tab still far from ideal
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 @item RL2 video              @tab     @tab  X
450     @tab used in some games by Entertainment Software Partners
451 @item Sierra VMD video       @tab     @tab  X
452     @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 @item Windows Media Video 9  @tab     @tab  X
478     @tab not completely working
479 @item Wing Commander III / Xan  @tab     @tab  X
480     @tab Used in Wing Commander III .MVE files.
481 @item Winnov WNV1            @tab     @tab  X
482 @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 @end multitable
489
490 @code{X} means that encoding (resp. decoding) is supported.
491
492 @code{E} means that support is provided through an external library.
493
494 @section Audio Codecs
495
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
501 @item AC-3                   @tab IX  @tab  X
502 @item ADPCM 4X Movie         @tab     @tab  X
503 @item ADPCM CDROM XA         @tab     @tab  X
504 @item ADPCM Creative Technology @tab     @tab  X
505     @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
506 @item ADPCM Electronic Arts  @tab     @tab  X
507     @tab Used in various EA titles.
508 @item ADPCM Electronic Arts Maxis CDROM XS  @tab     @tab  X
509     @tab Used in Sim City 3000.
510 @item ADPCM Electronic Arts R1  @tab     @tab  X
511 @item ADPCM Electronic Arts R2  @tab     @tab  X
512 @item ADPCM Electronic Arts R3  @tab     @tab  X
513 @item ADPCM Electronic Arts XAS @tab     @tab  X
514 @item ADPCM G.726            @tab  X  @tab  X
515 @item ADPCM IMA AMV          @tab     @tab  X
516     @tab Used in AMV files
517 @item ADPCM IMA Electronic Arts EACS  @tab     @tab  X
518 @item ADPCM IMA Electronic Arts SEAD  @tab     @tab  X
519 @item ADPCM IMA Funcom       @tab     @tab  X
520 @item ADPCM IMA QuickTime    @tab  X  @tab  X
521 @item ADPCM IMA Loki SDL MJPEG  @tab     @tab  X
522 @item ADPCM IMA WAV          @tab  X  @tab  X
523 @item ADPCM IMA Westwood     @tab     @tab  X
524 @item ADPCM ISS IMA          @tab     @tab  X
525     @tab Used in FunCom games.
526 @item ADPCM IMA Duck DK3     @tab     @tab  X
527     @tab Used in some Sega Saturn console games.
528 @item ADPCM IMA Duck DK4     @tab     @tab  X
529     @tab Used in some Sega Saturn console games.
530 @item ADPCM Microsoft        @tab  X  @tab  X
531 @item ADPCM MS IMA           @tab  X  @tab  X
532 @item ADPCM Nintendo Gamecube THP  @tab     @tab  X
533 @item ADPCM QT IMA           @tab  X  @tab  X
534 @item ADPCM SEGA CRI ADX     @tab  X  @tab  X
535     @tab Used in Sega Dreamcast games.
536 @item ADPCM Shockwave Flash  @tab  X  @tab  X
537 @item ADPCM SMJPEG IMA       @tab     @tab  X
538     @tab Used in certain Loki game ports.
539 @item ADPCM Sound Blaster Pro 2-bit  @tab     @tab  X
540 @item ADPCM Sound Blaster Pro 2.6-bit  @tab     @tab  X
541 @item ADPCM Sound Blaster Pro 4-bit  @tab     @tab  X
542 @item ADPCM Westwood Studios IMA @tab     @tab  X
543     @tab Used in Westwood Studios games like Command and Conquer.
544 @item ADPCM Yamaha           @tab  X  @tab  X
545 @item AMR-NB                 @tab  E  @tab  E
546     @tab supported through external library libopencore-amrnb
547 @item AMR-WB                 @tab     @tab  E
548     @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 @item Atrac 3                @tab     @tab  X
553 @item Bink Audio             @tab     @tab  X
554     @tab Used in Bink and Smacker files in many games.
555 @item Delphine Software International CIN audio  @tab     @tab  X
556     @tab Codec used in Delphine Software International games.
557 @item COOK                   @tab     @tab  X
558     @tab All versions except 5.1 are supported.
559 @item DCA (DTS Coherent Acoustics)  @tab     @tab  X
560 @item DPCM id RoQ            @tab  X  @tab  X
561     @tab Used in Quake III, Jedi Knight 2, other computer games.
562 @item DPCM Interplay         @tab     @tab  X
563     @tab Used in various Interplay computer games.
564 @item DPCM Sierra Online     @tab     @tab  X
565     @tab Used in Sierra Online game audio files.
566 @item DPCM Sol               @tab     @tab  X
567 @item DPCM Xan               @tab     @tab  X
568     @tab Used in Origin's Wing Commander IV AVI files.
569 @item DSP Group TrueSpeech   @tab     @tab  X
570 @item DV audio               @tab     @tab  X
571 @item Enhanced AC-3          @tab     @tab  X
572 @item FLAC (Free Lossless Audio Codec)  @tab  X  @tab  IX
573 @item G.729                  @tab     @tab  X
574 @item GSM                    @tab  E  @tab  E
575     @tab supported through external library libgsm
576 @item GSM Microsoft variant  @tab  E  @tab  E
577     @tab supported through external library libgsm
578 @item IMC (Intel Music Coder)  @tab     @tab  X
579 @item MACE (Macintosh Audio Compression/Expansion) 3:1  @tab     @tab  X
580 @item MACE (Macintosh Audio Compression/Expansion) 6:1  @tab     @tab  X
581 @item MLP (Meridian Lossless Packing)  @tab     @tab  X
582     @tab Used in DVD-Audio discs.
583 @item Monkey's Audio         @tab     @tab  X
584     @tab Only versions 3.97-3.99 are supported.
585 @item MP1 (MPEG audio layer 1)  @tab     @tab IX
586 @item MP2 (MPEG audio layer 2)  @tab IX  @tab IX
587 @item MP3 (MPEG audio layer 3)  @tab  E  @tab IX
588     @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
589 @item MPEG-4 Audio Lossless Coding (ALS)  @tab     @tab  X
590 @item Musepack SV7           @tab     @tab  X
591 @item Musepack SV8           @tab     @tab  X
592 @item Nellymoser Asao        @tab  X  @tab  X
593 @item PCM A-law              @tab  X  @tab  X
594 @item PCM mu-law             @tab  X  @tab  X
595 @item PCM 16-bit little-endian planar  @tab     @tab  X
596 @item PCM 32-bit floating point big-endian  @tab  X  @tab  X
597 @item PCM 32-bit floating point little-endian  @tab  X  @tab  X
598 @item PCM 64-bit floating point big-endian  @tab  X  @tab  X
599 @item PCM 64-bit floating point little-endian  @tab  X  @tab  X
600 @item PCM D-Cinema audio signed 24-bit   @tab  X  @tab  X
601 @item PCM signed 8-bit       @tab  X  @tab  X
602 @item PCM signed 16-bit big-endian  @tab  X  @tab  X
603 @item PCM signed 16-bit little-endian  @tab  X  @tab  X
604 @item PCM signed 24-bit big-endian  @tab  X  @tab  X
605 @item PCM signed 24-bit little-endian  @tab  X  @tab  X
606 @item PCM signed 32-bit big-endian  @tab  X  @tab  X
607 @item PCM signed 32-bit little-endian  @tab  X  @tab  X
608 @item PCM signed 16/20/24-bit big-endian in MPEG-TS  @tab     @tab  X
609 @item PCM unsigned 8-bit     @tab  X  @tab  X
610 @item PCM unsigned 16-bit big-endian  @tab  X  @tab  X
611 @item PCM unsigned 16-bit little-endian  @tab  X  @tab  X
612 @item PCM unsigned 24-bit big-endian  @tab  X  @tab  X
613 @item PCM unsigned 24-bit little-endian  @tab  X  @tab  X
614 @item PCM unsigned 32-bit big-endian  @tab  X  @tab  X
615 @item PCM unsigned 32-bit little-endian  @tab  X  @tab  X
616 @item PCM Zork               @tab  X  @tab  X
617 @item QCELP / PureVoice      @tab     @tab  X
618 @item QDesign Music Codec 2  @tab     @tab  X
619     @tab There are still some distortions.
620 @item RealAudio 1.0 (14.4K)  @tab     @tab  X
621     @tab Real 14400 bit/s codec
622 @item RealAudio 2.0 (28.8K)  @tab     @tab  X
623     @tab Real 28800 bit/s codec
624 @item RealAudio 3.0 (dnet)   @tab IX  @tab  X
625     @tab Real low bitrate AC-3 codec
626 @item RealAudio SIPR / ACELP.NET @tab     @tab  X
627 @item Shorten                @tab     @tab  X
628 @item Sierra VMD audio       @tab     @tab  X
629     @tab Used in Sierra VMD files.
630 @item Smacker audio          @tab     @tab  X
631 @item Sonic                  @tab  X  @tab  X
632     @tab experimental codec
633 @item Sonic lossless         @tab  X  @tab  X
634     @tab experimental codec
635 @item Speex                  @tab     @tab  E
636     @tab supported through external library libspeex
637 @item True Audio (TTA)       @tab     @tab  X
638 @item TrueHD                 @tab     @tab  X
639     @tab Used in HD-DVD and Blu-Ray discs.
640 @item TwinVQ (VQF flavor)    @tab     @tab  X
641 @item Vorbis                 @tab  E  @tab  X
642     @ A native but very primitive encoder exists.
643 @item WavPack                @tab     @tab  X
644 @item Westwood Audio (SND1)  @tab     @tab  X
645 @item Windows Media Audio 1  @tab  X  @tab  X
646 @item Windows Media Audio 2  @tab  X  @tab  X
647 @item Windows Media Audio Pro @tab    @tab  X
648 @end multitable
649
650 @code{X} means that encoding (resp. decoding) is supported.
651
652 @code{E} means that support is provided through an external library.
653
654 @code{I} means that an integer-only version is available, too (ensures high
655 performance on systems without hardware floating point support).
656
657 @section Subtitle Formats
658
659 @multitable @columnfractions .4 .1 .1 .1 .1
660 @item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
661 @item SSA/ASS      @tab X @tab X
662 @item DVB          @tab X @tab X @tab X @tab X
663 @item DVD          @tab X @tab X @tab X @tab X
664 @item PGS          @tab   @tab   @tab   @tab X
665 @item XSUB         @tab   @tab   @tab X @tab X
666 @end multitable
667
668 @code{X} means that the feature is supported.
669
670 @section Network Protocols
671
672 @multitable @columnfractions .4 .1
673 @item Name         @tab Support
674 @item file         @tab X
675 @item Gopher       @tab X
676 @item HTTP         @tab X
677 @item pipe         @tab X
678 @item RTP          @tab X
679 @item TCP          @tab X
680 @item UDP          @tab X
681 @end multitable
682
683 @code{X} means that the protocol is supported.
684
685
686 @section Input/Output Devices
687
688 @multitable @columnfractions .4 .1 .1
689 @item Name              @tab Input  @tab Output
690 @item ALSA              @tab X      @tab X
691 @item BEOS audio        @tab X      @tab X
692 @item BKTR              @tab X      @tab
693 @item DV1394            @tab X      @tab
694 @item JACK              @tab X      @tab
695 @item LIBDC1394         @tab X      @tab
696 @item OSS               @tab X      @tab X
697 @item Video4Linux       @tab X      @tab
698 @item Video4Linux2      @tab X      @tab
699 @item VfW capture       @tab X      @tab
700 @item X11 grabbing      @tab X      @tab
701 @end multitable
702
703 @code{X} means that input/output is supported.
704
705
706 @chapter Platform Specific information
707
708 @section BSD
709
710 BSD make will not build FFmpeg, you need to install and use GNU Make
711 (@file{gmake}).
712
713 @section Windows
714
715 To get help and instructions for building FFmpeg under Windows, check out
716 the FFmpeg Windows Help Forum at
717 @url{http://ffmpeg.arrozcru.org/}.
718
719 @subsection Native Windows compilation
720
721 FFmpeg can be built to run natively on Windows using the MinGW tools. Install
722 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
723 You can find detailed installation
724 instructions in the download section and the FAQ.
725
726 FFmpeg does not build out-of-the-box with the packages the automated MinGW
727 installer provides. It also requires coreutils to be installed and many other
728 packages updated to the latest version. The minimum version for some packages
729 are listed below:
730
731 @itemize
732 @item bash 3.1
733 @item msys-make 3.81-2 (note: not mingw32-make)
734 @item w32api 3.13
735 @item mingw-runtime 3.15
736 @end itemize
737
738 FFmpeg automatically passes @code{-fno-common} to the compiler to work around
739 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
740
741 Within the MSYS shell, configure and make with:
742
743 @example
744 ./configure --enable-memalign-hack
745 make
746 make install
747 @end example
748
749 This will install @file{ffmpeg.exe} along with many other development files
750 to @file{/usr/local}. You may specify another install path using the
751 @code{--prefix} option in @file{configure}.
752
753 Notes:
754
755 @itemize
756
757 @item Building natively using MSYS can be sped up by disabling implicit rules
758 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
759 speed up is close to non-existent for normal one-off builds and is only
760 noticeable when running make for a second time (for example in
761 @code{make install}).
762
763 @item In order to compile FFplay, you must have the MinGW development library
764 of SDL. Get it from @url{http://www.libsdl.org}.
765 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
766 where SDL was installed. Verify that @file{sdl-config} can be launched from
767 the MSYS command line.
768
769 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
770 you can build libavutil, libavcodec and libavformat as DLLs.
771
772 @end itemize
773
774 @subsection Microsoft Visual C++ compatibility
775
776 As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
777 want to use the libav* libraries in your own applications, you can still
778 compile those applications using MSVC++. But the libav* libraries you link
779 to @emph{must} be built with MinGW. However, you will not be able to debug
780 inside the libav* libraries, since MSVC++ does not recognize the debug
781 symbols generated by GCC.
782 We strongly recommend you to move over from MSVC++ to MinGW tools.
783
784 This description of how to use the FFmpeg libraries with MSVC++ is based on
785 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
786 you might have to modify the procedures slightly.
787
788 @subsubsection Using static libraries
789
790 Assuming you have just built and installed FFmpeg in @file{/usr/local}.
791
792 @enumerate
793
794 @item Create a new console application ("File / New / Project") and then
795 select "Win32 Console Application". On the appropriate page of the
796 Application Wizard, uncheck the "Precompiled headers" option.
797
798 @item Write the source code for your application, or, for testing, just
799 copy the code from an existing sample application into the source file
800 that MSVC++ has already created for you. For example, you can copy
801 @file{libavformat/output-example.c} from the FFmpeg distribution.
802
803 @item Open the "Project / Properties" dialog box. In the "Configuration"
804 combo box, select "All Configurations" so that the changes you make will
805 affect both debug and release builds. In the tree view on the left hand
806 side, select "C/C++ / General", then edit the "Additional Include
807 Directories" setting to contain the path where the FFmpeg includes were
808 installed (i.e. @file{c:\msys\1.0\local\include}).
809 Do not add MinGW's include directory here, or the include files will
810 conflict with MSVC's.
811
812 @item Still in the "Project / Properties" dialog box, select
813 "Linker / General" from the tree view and edit the
814 "Additional Library Directories" setting to contain the @file{lib}
815 directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
816 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
817 and the directory where MinGW's GCC libs are installed
818 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
819 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
820 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
821 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
822 to the end of "Additional Dependencies".
823
824 @item Now, select "C/C++ / Code Generation" from the tree view. Select
825 "Debug" in the "Configuration" combo box. Make sure that "Runtime
826 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
827 the "Configuration" combo box and make sure that "Runtime Library" is
828 set to "Multi-threaded DLL".
829
830 @item Click "OK" to close the "Project / Properties" dialog box.
831
832 @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
833 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
834 and install it in MSVC++'s include directory
835 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
836
837 @item MSVC++ also does not understand the @code{inline} keyword used by
838 FFmpeg, so you must add this line before @code{#include}ing libav*:
839 @example
840 #define inline _inline
841 @end example
842
843 @item Build your application, everything should work.
844
845 @end enumerate
846
847 @subsubsection Using shared libraries
848
849 This is how to create DLL and LIB files that are compatible with MSVC++:
850
851 @enumerate
852
853 @item Add a call to @file{vcvars32.bat} (which sets up the environment
854 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
855 The standard location for @file{vcvars32.bat} is
856 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
857 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
858 If this corresponds to your setup, add the following line as the first line
859 of @file{msys.bat}:
860
861 @example
862 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
863 @end example
864
865 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
866 and run @file{c:\msys\1.0\msys.bat} from there.
867
868 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
869 from @file{Microsoft (R) Library Manager}, this means your environment
870 variables are set up correctly, the @file{Microsoft (R) Library Manager}
871 is on the path and will be used by FFmpeg to create
872 MSVC++-compatible import libraries.
873
874 @item Build FFmpeg with
875
876 @example
877 ./configure --enable-shared --enable-memalign-hack
878 make
879 make install
880 @end example
881
882 Your install path (@file{/usr/local/} by default) should now have the
883 necessary DLL and LIB files under the @file{bin} directory.
884
885 @end enumerate
886
887 To use those files with MSVC++, do the same as you would do with
888 the static libraries, as described above. But in Step 4,
889 you should only need to add the directory where the LIB files are installed
890 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
891 installed in the @file{bin} directory. And instead of adding @file{libxx.a}
892 files, you should add @file{avcodec.lib}, @file{avformat.lib}, and
893 @file{avutil.lib}. There should be no need for @file{libmingwex.a},
894 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
895 statically linked into the DLLs. The @file{bin} directory contains a bunch
896 of DLL files, but the ones that are actually used to run your application
897 are the ones with a major version number in their filenames
898 (i.e. @file{avcodec-51.dll}).
899
900 @subsection Cross compilation for Windows with Linux
901
902 You must use the MinGW cross compilation tools available at
903 @url{http://www.mingw.org/}.
904
905 Then configure FFmpeg with the following options:
906 @example
907 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
908 @end example
909 (you can change the cross-prefix according to the prefix chosen for the
910 MinGW tools).
911
912 Then you can easily test FFmpeg with Wine
913 (@url{http://www.winehq.com/}).
914
915 @subsection Compilation under Cygwin
916
917 The main issue with the 1.5.x Cygwin versions is that newlib, its C library,
918 does not contain llrint().  You need to upgrade to the unstable 1.7.x versions,
919 or leverage the implementation in MinGW (as explained below).
920
921 Just install your Cygwin with all the "Base" packages, plus the
922 following "Devel" ones:
923 @example
924 binutils, gcc-core, make, subversion, mingw-runtime
925 @end example
926
927 And the following "Utils" one:
928 @example
929 diffutils
930 @end example
931
932 The experimental gcc4 package is still buggy, hence please
933 use the official gcc 3.4.4 or a 4.2.x compiled from source by yourself.
934
935 Install the current binutils-20080624-2 as they work fine (the old
936 binutils-20060709-1 proved buggy on shared builds).
937
938 Then create a small library that just contains llrint():
939
940 @example
941 ar x /usr/lib/mingw/libmingwex.a llrint.o
942 ar cq /usr/local/lib/libllrint.a llrint.o
943 @end example
944
945 Then run
946
947 @example
948 ./configure --enable-static --disable-shared  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
949 @end example
950
951 to make a static build or
952
953 @example
954 ./configure --enable-shared --disable-static  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
955 @end example
956
957 to build shared libraries.
958
959 If you want to build FFmpeg with additional libraries, download Cygwin
960 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
961 @example
962 libogg-devel, libvorbis-devel
963 @end example
964
965 These library packages are only available from Cygwin Ports
966 (@url{http://sourceware.org/cygwinports/}) :
967
968 @example
969 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libfaad-devel, libgsm-devel,
970 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
971 libxvidcore-devel
972 @end example
973
974 The recommendation for libnut and x264 is to build them from source by
975 yourself, as they evolve too quickly for Cygwin Ports to be up to date.
976
977 Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
978 of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
979
980 @subsection Crosscompilation for Windows under Cygwin
981
982 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
983
984 Just install your Cygwin as explained before, plus these additional
985 "Devel" packages:
986 @example
987 gcc-mingw-core, mingw-runtime, mingw-zlib
988 @end example
989
990 and add some special flags to your configure invocation.
991
992 For a static build run
993 @example
994 ./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
995 @end example
996
997 and for a build with shared libraries
998 @example
999 ./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1000 @end example
1001
1002 @section BeOS
1003
1004 BeOS support is broken in mysterious ways.
1005
1006 @section OS/2
1007
1008 For information about compiling FFmpeg on OS/2 see
1009 @url{http://www.edm2.com/index.php/FFmpeg}.
1010
1011 @bye