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