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