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