1 \input texinfo @c -*- texinfo -*-
3 @settitle General Documentation
5 @center @titlefont{General Documentation}
12 @chapter external libraries
14 Libav can be hooked up with a number of external libraries to add support
15 for more formats. None of them are used by default, their use has to be
16 explicitly requested by passing the appropriate flags to @file{./configure}.
20 Libav can make use of the OpenCORE libraries for AMR-NB
21 decoding/encoding and AMR-WB decoding.
23 Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for
24 installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or
25 @code{--enable-libopencore-amrwb} to configure to enable the libraries.
27 Note that OpenCORE is under the Apache License 2.0 (see
28 @url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is
29 incompatible with the LGPL version 2.1 and GPL version 2. You have to
30 upgrade Libav's license to LGPL version 3 (or if you have enabled
31 GPL components, GPL version 3) to use it.
34 @chapter Supported File Formats and Codecs
36 You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
40 Libav supports the following file formats through the @code{libavformat}
43 @multitable @columnfractions .4 .1 .1 .4
44 @item Name @tab Encoding @tab Decoding @tab Comments
46 @tab 4X Technologies format, used in some games.
47 @item 8088flex TMV @tab @tab X
48 @item Adobe Filmstrip @tab X @tab X
49 @item Audio IFF (AIFF) @tab X @tab X
50 @item American Laser Games MM @tab @tab X
51 @tab Multimedia format used in games like Mad Dog McCree.
52 @item 3GPP AMR @tab X @tab X
53 @item Apple HTTP Live Streaming @tab @tab X
54 @item ASF @tab X @tab X
55 @item AVI @tab X @tab X
56 @item AVISynth @tab @tab X
58 @tab Multimedia format used by the Creature Shock game.
59 @item Beam Software SIFF @tab @tab X
60 @tab Audio and video format used in some games by Beam Software.
61 @item Bethesda Softworks VID @tab @tab X
62 @tab Used in some games from Bethesda Softworks.
63 @item Bink @tab @tab X
64 @tab Multimedia format used by many games.
65 @item Bitmap Brothers JV @tab @tab X
66 @tab Used in Z and Z95 games.
67 @item Brute Force & Ignorance @tab @tab X
68 @tab Used in the game Flash Traffic: City of Angels.
69 @item BWF @tab X @tab X
70 @item Interplay C93 @tab @tab X
71 @tab Used in the game Cyberia from Interplay.
72 @item Delphine Software International CIN @tab @tab X
73 @tab Multimedia format used by Delphine Software games.
74 @item CD+G @tab @tab X
75 @tab Video format used by CD+G karaoke disks
76 @item Core Audio Format @tab @tab X
77 @tab Apple Core Audio Format
78 @item CRC testing format @tab X @tab
79 @item Creative Voice @tab X @tab X
80 @tab Created for the Sound Blaster Pro.
81 @item CRYO APC @tab @tab X
82 @tab Audio format used in some games by CRYO Interactive Entertainment.
83 @item D-Cinema audio @tab X @tab X
84 @item Deluxe Paint Animation @tab @tab X
86 @tab This format is used in Chronomaster game
87 @item DV video @tab X @tab X
89 @tab This format is used in the non-Windows version of the Feeble Files
90 game and different game cutscenes repacked for use with ScummVM.
91 @item Electronic Arts cdata @tab @tab X
92 @item Electronic Arts Multimedia @tab @tab X
93 @tab Used in various EA games; files have extensions like WVE and UV2.
94 @item FFM (AVserver live feed) @tab X @tab X
95 @item Flash (SWF) @tab X @tab X
96 @item Flash 9 (AVM2) @tab X @tab X
97 @tab Only embedded audio is decoded.
98 @item FLI/FLC/FLX animation @tab @tab X
100 @item Flash Video (FLV) @tab X @tab X
101 @tab Macromedia Flash video files
102 @item framecrc testing format @tab X @tab
103 @item FunCom ISS @tab @tab X
104 @tab Audio format used in various games from FunCom like The Longest Journey.
105 @item GIF Animation @tab X @tab
106 @item GXF @tab X @tab X
107 @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
109 @item id Quake II CIN video @tab @tab X
110 @item id RoQ @tab X @tab X
111 @tab Used in Quake III, Jedi Knight 2, other computer games.
112 @item IEC61937 encapsulation @tab X @tab X
113 @item IFF @tab @tab X
114 @tab Interchange File Format
115 @item Interplay MVE @tab @tab X
116 @tab Format used in various Interplay computer games.
117 @item IV8 @tab @tab X
118 @tab A format generated by IndigoVision 8000 video server.
119 @item IVF (On2) @tab X @tab X
120 @tab A format used by libvpx
121 @item LATM @tab X @tab X
122 @item LMLM4 @tab @tab X
123 @tab Used by Linux Media Labs MPEG-4 PCI boards
124 @item LXF @tab @tab X
125 @tab VR native stream format, used by Leitch/Harris' video servers.
126 @item Matroska @tab X @tab X
127 @item Matroska audio @tab X @tab
128 @item FFmpeg metadata @tab X @tab X
129 @tab Metadata in text format.
130 @item MAXIS XA @tab @tab X
131 @tab Used in Sim City 3000; file extension .xa.
132 @item MD Studio @tab @tab X
133 @item Mobotix .mxg @tab @tab X
134 @item Monkey's Audio @tab @tab X
135 @item Motion Pixels MVI @tab @tab X
136 @item MOV/QuickTime/MP4 @tab X @tab X
137 @tab 3GP, 3GP2, PSP, iPod variants supported
138 @item MP2 @tab X @tab X
139 @item MP3 @tab X @tab X
140 @item MPEG-1 System @tab X @tab X
141 @tab muxed audio and video, VCD format supported
142 @item MPEG-PS (program stream) @tab X @tab X
143 @tab also known as @code{VOB} file, SVCD and DVD format supported
144 @item MPEG-TS (transport stream) @tab X @tab X
145 @tab also known as DVB Transport Stream
146 @item MPEG-4 @tab X @tab X
147 @tab MPEG-4 is a variant of QuickTime.
148 @item MIME multipart JPEG @tab X @tab
149 @item MSN TCP webcam @tab @tab X
150 @tab Used by MSN Messenger webcam streams.
151 @item MTV @tab @tab X
152 @item Musepack @tab @tab X
153 @item Musepack SV8 @tab @tab X
154 @item Material eXchange Format (MXF) @tab X @tab X
155 @tab SMPTE 377M, used by D-Cinema, broadcast industry.
156 @item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
157 @tab SMPTE 386M, D-10/IMX Mapping.
158 @item NC camera feed @tab @tab X
159 @tab NC (AVIP NC4600) camera streams
160 @item NTT TwinVQ (VQF) @tab @tab X
161 @tab Nippon Telegraph and Telephone Corporation TwinVQ.
162 @item Nullsoft Streaming Video @tab @tab X
163 @item NuppelVideo @tab @tab X
164 @item NUT @tab X @tab X
165 @tab NUT Open Container Format
166 @item Ogg @tab X @tab X
167 @item TechnoTrend PVA @tab @tab X
168 @tab Used by TechnoTrend DVB PCI boards.
169 @item QCP @tab @tab X
170 @item raw ADTS (AAC) @tab X @tab X
171 @item raw AC-3 @tab X @tab X
172 @item raw Chinese AVS video @tab X @tab X
173 @item raw CRI ADX @tab X @tab X
174 @item raw Dirac @tab X @tab X
175 @item raw DNxHD @tab X @tab X
176 @item raw DTS @tab X @tab X
177 @item raw E-AC-3 @tab X @tab X
178 @item raw FLAC @tab X @tab X
179 @item raw GSM @tab @tab X
180 @item raw H.261 @tab X @tab X
181 @item raw H.263 @tab X @tab X
182 @item raw H.264 @tab X @tab X
183 @item raw Ingenient MJPEG @tab @tab X
184 @item raw MJPEG @tab X @tab X
185 @item raw MLP @tab @tab X
186 @item raw MPEG @tab @tab X
187 @item raw MPEG-1 @tab @tab X
188 @item raw MPEG-2 @tab @tab X
189 @item raw MPEG-4 @tab X @tab X
190 @item raw NULL @tab X @tab
191 @item raw video @tab X @tab X
192 @item raw id RoQ @tab X @tab
193 @item raw Shorten @tab @tab X
194 @item raw TrueHD @tab X @tab X
195 @item raw VC-1 @tab @tab X
196 @item raw PCM A-law @tab X @tab X
197 @item raw PCM mu-law @tab X @tab X
198 @item raw PCM signed 8 bit @tab X @tab X
199 @item raw PCM signed 16 bit big-endian @tab X @tab X
200 @item raw PCM signed 16 bit little-endian @tab X @tab X
201 @item raw PCM signed 24 bit big-endian @tab X @tab X
202 @item raw PCM signed 24 bit little-endian @tab X @tab X
203 @item raw PCM signed 32 bit big-endian @tab X @tab X
204 @item raw PCM signed 32 bit little-endian @tab X @tab X
205 @item raw PCM unsigned 8 bit @tab X @tab X
206 @item raw PCM unsigned 16 bit big-endian @tab X @tab X
207 @item raw PCM unsigned 16 bit little-endian @tab X @tab X
208 @item raw PCM unsigned 24 bit big-endian @tab X @tab X
209 @item raw PCM unsigned 24 bit little-endian @tab X @tab X
210 @item raw PCM unsigned 32 bit big-endian @tab X @tab X
211 @item raw PCM unsigned 32 bit little-endian @tab X @tab X
212 @item raw PCM floating-point 32 bit big-endian @tab X @tab X
213 @item raw PCM floating-point 32 bit little-endian @tab X @tab X
214 @item raw PCM floating-point 64 bit big-endian @tab X @tab X
215 @item raw PCM floating-point 64 bit little-endian @tab X @tab X
216 @item RDT @tab @tab X
217 @item REDCODE R3D @tab @tab X
218 @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
219 @item RealMedia @tab X @tab X
220 @item Redirector @tab @tab X
221 @item Renderware TeXture Dictionary @tab @tab X
222 @item RL2 @tab @tab X
223 @tab Audio and video format used in some games by Entertainment Software Partners.
224 @item RPL/ARMovie @tab @tab X
225 @item Lego Mindstorms RSO @tab X @tab X
226 @item RTMP @tab X @tab X
227 @tab Output is performed by publishing stream to RTMP server
228 @item RTP @tab X @tab X
229 @item RTSP @tab X @tab X
230 @item SAP @tab X @tab X
231 @item SDP @tab @tab X
232 @item Sega FILM/CPK @tab @tab X
233 @tab Used in many Sega Saturn console games.
234 @item Sierra SOL @tab @tab X
235 @tab .sol files used in Sierra Online games.
236 @item Sierra VMD @tab @tab X
237 @tab Used in Sierra CD-ROM games.
238 @item Smacker @tab @tab X
239 @tab Multimedia format used by many games.
240 @item Sony OpenMG (OMA) @tab @tab X
241 @tab Audio format used in Sony Sonic Stage and Sony Vegas.
242 @item Sony PlayStation STR @tab @tab X
243 @item Sony Wave64 (W64) @tab @tab X
244 @item SoX native format @tab X @tab X
245 @item SUN AU format @tab X @tab X
246 @item Text files @tab @tab X
247 @item THP @tab @tab X
248 @tab Used on the Nintendo GameCube.
249 @item Tiertex Limited SEQ @tab @tab X
250 @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
251 @item True Audio @tab @tab X
252 @item VC-1 test bitstream @tab X @tab X
253 @item WAV @tab X @tab X
254 @item WavPack @tab @tab X
255 @item WebM @tab X @tab X
256 @item Windows Televison (WTV) @tab @tab X
257 @item Wing Commander III movie @tab @tab X
258 @tab Multimedia format used in Origin's Wing Commander III computer game.
259 @item Westwood Studios audio @tab @tab X
260 @tab Multimedia format used in Westwood Studios games.
261 @item Westwood Studios VQA @tab @tab X
262 @tab Multimedia format used in Westwood Studios games.
263 @item XMV @tab @tab X
264 @tab Microsoft video container used in Xbox games.
265 @item xWMA @tab @tab X
266 @tab Microsoft audio container used by XAudio 2.
267 @item YUV4MPEG pipe @tab X @tab X
268 @item Psygnosis YOP @tab @tab X
271 @code{X} means that encoding (resp. decoding) is supported.
273 @section Image Formats
275 Libav can read and write images for each frame of a video sequence. The
276 following image formats are supported:
278 @multitable @columnfractions .4 .1 .1 .4
279 @item Name @tab Encoding @tab Decoding @tab Comments
280 @item .Y.U.V @tab X @tab X
281 @tab one raw file per component
282 @item animated GIF @tab X @tab X
283 @tab Only uncompressed GIFs are generated.
284 @item BMP @tab X @tab X
285 @tab Microsoft BMP image
286 @item DPX @tab X @tab X
287 @tab Digital Picture Exchange
288 @item JPEG @tab X @tab X
289 @tab Progressive JPEG is not supported.
290 @item JPEG 2000 @tab @tab E
291 @tab decoding supported through external library libopenjpeg
292 @item JPEG-LS @tab X @tab X
293 @item LJPEG @tab X @tab
295 @item PAM @tab X @tab X
296 @tab PAM is a PNM extension with alpha support.
297 @item PBM @tab X @tab X
298 @tab Portable BitMap image
299 @item PCX @tab X @tab X
301 @item PGM @tab X @tab X
302 @tab Portable GrayMap image
303 @item PGMYUV @tab X @tab X
304 @tab PGM with U and V components in YUV 4:2:0
305 @item PIC @tab @tab X
307 @item PNG @tab X @tab X
308 @tab 2/4 bpp not supported yet
309 @item PPM @tab X @tab X
310 @tab Portable PixelMap image
311 @item PTX @tab @tab X
312 @tab V.Flash PTX format
313 @item SGI @tab X @tab X
314 @tab SGI RGB image format
315 @item Sun Rasterfile @tab @tab X
316 @tab Sun RAS image format
317 @item TIFF @tab X @tab X
318 @tab YUV, JPEG and some extension is not supported yet.
319 @item Truevision Targa @tab X @tab X
320 @tab Targa (.TGA) image format
323 @code{X} means that encoding (resp. decoding) is supported.
325 @code{E} means that support is provided through an external library.
327 @section Video Codecs
329 @multitable @columnfractions .4 .1 .1 .4
330 @item Name @tab Encoding @tab Decoding @tab Comments
331 @item 4X Movie @tab @tab X
332 @tab Used in certain computer games.
333 @item 8088flex TMV @tab @tab X
334 @item 8SVX exponential @tab @tab X
335 @item 8SVX fibonacci @tab @tab X
336 @item A64 multicolor @tab X @tab
337 @tab Creates video suitable to be played on a commodore 64 (multicolor mode).
338 @item American Laser Games MM @tab @tab X
339 @tab Used in games like Mad Dog McCree.
340 @item AMV Video @tab @tab X
341 @tab Used in Chinese MP3 players.
342 @item ANSI/ASCII art @tab @tab X
343 @item Apple MJPEG-B @tab @tab X
344 @item Apple ProRes @tab @tab X
345 @item Apple QuickDraw @tab @tab X
347 @item Asus v1 @tab X @tab X
349 @item Asus v2 @tab X @tab X
351 @item ATI VCR1 @tab @tab X
353 @item ATI VCR2 @tab @tab X
355 @item Auravision Aura @tab @tab X
356 @item Auravision Aura 2 @tab @tab X
357 @item Autodesk Animator Flic video @tab @tab X
358 @item Autodesk RLE @tab @tab X
360 @item AVS (Audio Video Standard) video @tab @tab X
361 @tab Video encoding used by the Creature Shock game.
362 @item Beam Software VB @tab @tab X
363 @item Bethesda VID video @tab @tab X
364 @tab Used in some games from Bethesda Softworks.
365 @item Bink Video @tab @tab X
366 @item Bitmap Brothers JV video @tab @tab X
367 @item Brute Force & Ignorance @tab @tab X
368 @tab Used in the game Flash Traffic: City of Angels.
369 @item C93 video @tab @tab X
370 @tab Codec used in Cyberia game.
371 @item CamStudio @tab @tab X
373 @item CD+G @tab @tab X
374 @tab Video codec for CD+G karaoke disks
375 @item Chinese AVS video @tab E @tab X
376 @tab AVS1-P2, JiZhun profile, encoding through external library libxavs
377 @item Delphine Software International CIN video @tab @tab X
378 @tab Codec used in Delphine Software International games.
379 @item Cinepak @tab @tab X
380 @item Cirrus Logic AccuPak @tab @tab X
382 @item Creative YUV (CYUV) @tab @tab X
383 @item DFA @tab @tab X
384 @tab Codec used in Chronomaster game.
385 @item Dirac @tab E @tab E
386 @tab supported through external libdirac/libschroedinger libraries
387 @item Deluxe Paint Animation @tab @tab X
388 @item DNxHD @tab X @tab X
390 @item Duck TrueMotion 1.0 @tab @tab X
392 @item Duck TrueMotion 2.0 @tab @tab X
394 @item DV (Digital Video) @tab X @tab X
395 @item Feeble Files/ScummVM DXA @tab @tab X
396 @tab Codec originally used in Feeble Files game.
397 @item Electronic Arts CMV video @tab @tab X
398 @tab Used in NHL 95 game.
399 @item Electronic Arts Madcow video @tab @tab X
400 @item Electronic Arts TGV video @tab @tab X
401 @item Electronic Arts TGQ video @tab @tab X
402 @item Electronic Arts TQI video @tab @tab X
403 @item Escape 124 @tab @tab X
404 @item FFmpeg video codec #1 @tab X @tab X
405 @tab experimental lossless codec (fourcc: FFV1)
406 @item Flash Screen Video v1 @tab X @tab X
408 @item Flash Screen Video v2 @tab @tab X
409 @item Flash Video (FLV) @tab X @tab X
410 @tab Sorenson H.263 used in Flash
411 @item Fraps @tab @tab X
412 @item H.261 @tab X @tab X
413 @item H.263 / H.263-1996 @tab X @tab X
414 @item H.263+ / H.263-1998 / H.263 version 2 @tab X @tab X
415 @item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 @tab E @tab X
416 @tab encoding supported through external library libx264
417 @item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (VDPAU acceleration) @tab E @tab X
418 @item HuffYUV @tab X @tab X
419 @item HuffYUV FFmpeg variant @tab X @tab X
420 @item IBM Ultimotion @tab @tab X
422 @item id Cinematic video @tab @tab X
423 @tab Used in Quake II.
424 @item id RoQ video @tab X @tab X
425 @tab Used in Quake III, Jedi Knight 2, other computer games.
426 @item IFF ILBM @tab @tab X
427 @tab IFF interlaved bitmap
428 @item IFF ByteRun1 @tab @tab X
429 @tab IFF run length encoded bitmap
430 @item Intel H.263 @tab @tab X
431 @item Intel Indeo 2 @tab @tab X
432 @item Intel Indeo 3 @tab @tab X
433 @item Intel Indeo 5 @tab @tab X
434 @item Interplay C93 @tab @tab X
435 @tab Used in the game Cyberia from Interplay.
436 @item Interplay MVE video @tab @tab X
437 @tab Used in Interplay .MVE files.
438 @item Karl Morton's video codec @tab @tab X
439 @tab Codec used in Worms games.
440 @item Kega Game Video (KGV1) @tab @tab X
441 @tab Kega emulator screen capture codec.
442 @item Lagarith @tab @tab X
443 @item LCL (LossLess Codec Library) MSZH @tab @tab X
444 @item LCL (LossLess Codec Library) ZLIB @tab E @tab E
445 @item LOCO @tab @tab X
446 @item lossless MJPEG @tab X @tab X
447 @item Microsoft RLE @tab @tab X
448 @item Microsoft Video 1 @tab @tab X
449 @item Mimic @tab @tab X
450 @tab Used in MSN Messenger Webcam streams.
451 @item Miro VideoXL @tab @tab X
453 @item MJPEG (Motion JPEG) @tab X @tab X
454 @item Mobotix MxPEG video @tab @tab X
455 @item Motion Pixels video @tab @tab X
456 @item MPEG-1 video @tab X @tab X
457 @item MPEG-1/2 video XvMC (X-Video Motion Compensation) @tab @tab X
458 @item MPEG-1/2 video (VDPAU acceleration) @tab @tab X
459 @item MPEG-2 video @tab X @tab X
460 @item MPEG-4 part 2 @tab X @tab X
461 @ libxvidcore can be used alternatively for encoding.
462 @item MPEG-4 part 2 Microsoft variant version 1 @tab @tab X
463 @item MPEG-4 part 2 Microsoft variant version 2 @tab X @tab X
464 @item MPEG-4 part 2 Microsoft variant version 3 @tab X @tab X
465 @item Nintendo Gamecube THP video @tab @tab X
466 @item NuppelVideo/RTjpeg @tab @tab X
467 @tab Video encoding used in NuppelVideo files.
468 @item On2 VP3 @tab @tab X
469 @tab still experimental
470 @item On2 VP5 @tab @tab X
472 @item On2 VP6 @tab @tab X
473 @tab fourcc: VP60,VP61,VP62
474 @item VP8 @tab E @tab X
475 @tab fourcc: VP80, encoding supported through external library libvpx
476 @item planar RGB @tab @tab X
478 @item Q-team QPEG @tab @tab X
479 @tab fourccs: QPEG, Q1.0, Q1.1
480 @item QuickTime 8BPS video @tab @tab X
481 @item QuickTime Animation (RLE) video @tab X @tab X
483 @item QuickTime Graphics (SMC) @tab @tab X
485 @item QuickTime video (RPZA) @tab @tab X
487 @item R10K AJA Kona 10-bit RGB Codec @tab @tab X
488 @item R210 Quicktime Uncompressed RGB 10-bit @tab @tab X
489 @item Raw Video @tab X @tab X
490 @item RealVideo 1.0 @tab X @tab X
491 @item RealVideo 2.0 @tab X @tab X
492 @item RealVideo 3.0 @tab @tab X
493 @tab still far from ideal
494 @item RealVideo 4.0 @tab @tab X
495 @item Renderware TXD (TeXture Dictionary) @tab @tab X
496 @tab Texture dictionaries used by the Renderware Engine.
497 @item RL2 video @tab @tab X
498 @tab used in some games by Entertainment Software Partners
499 @item Sierra VMD video @tab @tab X
500 @tab Used in Sierra VMD files.
501 @item Smacker video @tab @tab X
502 @tab Video encoding used in Smacker.
503 @item SMPTE VC-1 @tab @tab X
504 @item Snow @tab X @tab X
505 @tab experimental wavelet codec (fourcc: SNOW)
506 @item Sony PlayStation MDEC (Motion DECoder) @tab @tab X
507 @item Sorenson Vector Quantizer 1 @tab X @tab X
509 @item Sorenson Vector Quantizer 3 @tab @tab X
511 @item Sunplus JPEG (SP5X) @tab @tab X
513 @item TechSmith Screen Capture Codec @tab @tab X
515 @item Theora @tab E @tab X
516 @tab encoding supported through external library libtheora
517 @item Tiertex Limited SEQ video @tab @tab X
518 @tab Codec used in DOS CD-ROM FlashBack game.
519 @item V210 Quicktime Uncompressed 4:2:2 10-bit @tab X @tab X
520 @item VMware Screen Codec / VMware Video @tab @tab X
521 @tab Codec used in videos captured by VMware.
522 @item Westwood Studios VQA (Vector Quantized Animation) video @tab @tab X
523 @item Windows Media Image @tab @tab X
524 @item Windows Media Video 7 @tab X @tab X
525 @item Windows Media Video 8 @tab X @tab X
526 @item Windows Media Video 9 @tab @tab X
527 @tab not completely working
528 @item Wing Commander III / Xan @tab @tab X
529 @tab Used in Wing Commander III .MVE files.
530 @item Wing Commander IV / Xan @tab @tab X
531 @tab Used in Wing Commander IV.
532 @item Winnov WNV1 @tab @tab X
533 @item WMV7 @tab X @tab X
534 @item YAMAHA SMAF @tab X @tab X
535 @item Psygnosis YOP Video @tab @tab X
536 @item ZLIB @tab X @tab X
537 @tab part of LCL, encoder experimental
538 @item Zip Motion Blocks Video @tab X @tab X
539 @tab Encoder works only in PAL8.
542 @code{X} means that encoding (resp. decoding) is supported.
544 @code{E} means that support is provided through an external library.
546 @section Audio Codecs
548 @multitable @columnfractions .4 .1 .1 .4
549 @item Name @tab Encoding @tab Decoding @tab Comments
550 @item 8SVX audio @tab @tab X
551 @item AAC @tab E @tab X
552 @tab encoding supported through external library libfaac and libvo-aacenc
553 @item AC-3 @tab IX @tab X
554 @item ADPCM 4X Movie @tab @tab X
555 @item ADPCM CDROM XA @tab @tab X
556 @item ADPCM Creative Technology @tab @tab X
557 @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
558 @item ADPCM Electronic Arts @tab @tab X
559 @tab Used in various EA titles.
560 @item ADPCM Electronic Arts Maxis CDROM XS @tab @tab X
561 @tab Used in Sim City 3000.
562 @item ADPCM Electronic Arts R1 @tab @tab X
563 @item ADPCM Electronic Arts R2 @tab @tab X
564 @item ADPCM Electronic Arts R3 @tab @tab X
565 @item ADPCM Electronic Arts XAS @tab @tab X
566 @item ADPCM G.722 @tab X @tab X
567 @item ADPCM G.726 @tab X @tab X
568 @item ADPCM IMA AMV @tab @tab X
569 @tab Used in AMV files
570 @item ADPCM IMA Electronic Arts EACS @tab @tab X
571 @item ADPCM IMA Electronic Arts SEAD @tab @tab X
572 @item ADPCM IMA Funcom @tab @tab X
573 @item ADPCM IMA QuickTime @tab X @tab X
574 @item ADPCM IMA Loki SDL MJPEG @tab @tab X
575 @item ADPCM IMA WAV @tab X @tab X
576 @item ADPCM IMA Westwood @tab @tab X
577 @item ADPCM ISS IMA @tab @tab X
578 @tab Used in FunCom games.
579 @item ADPCM IMA Duck DK3 @tab @tab X
580 @tab Used in some Sega Saturn console games.
581 @item ADPCM IMA Duck DK4 @tab @tab X
582 @tab Used in some Sega Saturn console games.
583 @item ADPCM Microsoft @tab X @tab X
584 @item ADPCM MS IMA @tab X @tab X
585 @item ADPCM Nintendo Gamecube THP @tab @tab X
586 @item ADPCM QT IMA @tab X @tab X
587 @item ADPCM SEGA CRI ADX @tab X @tab X
588 @tab Used in Sega Dreamcast games.
589 @item ADPCM Shockwave Flash @tab X @tab X
590 @item ADPCM SMJPEG IMA @tab @tab X
591 @tab Used in certain Loki game ports.
592 @item ADPCM Sound Blaster Pro 2-bit @tab @tab X
593 @item ADPCM Sound Blaster Pro 2.6-bit @tab @tab X
594 @item ADPCM Sound Blaster Pro 4-bit @tab @tab X
595 @item ADPCM Westwood Studios IMA @tab @tab X
596 @tab Used in Westwood Studios games like Command and Conquer.
597 @item ADPCM Yamaha @tab X @tab X
598 @item AMR-NB @tab E @tab X
599 @tab encoding supported through external library libopencore-amrnb
600 @item AMR-WB @tab E @tab X
601 @tab encoding supported through external library libvo-amrwbenc
602 @item Apple lossless audio @tab X @tab X
603 @tab QuickTime fourcc 'alac'
604 @item Atrac 1 @tab @tab X
605 @item Atrac 3 @tab @tab X
606 @item Bink Audio @tab @tab X
607 @tab Used in Bink and Smacker files in many games.
608 @item Delphine Software International CIN audio @tab @tab X
609 @tab Codec used in Delphine Software International games.
610 @item COOK @tab @tab X
611 @tab All versions except 5.1 are supported.
612 @item DCA (DTS Coherent Acoustics) @tab @tab X
613 @item DPCM id RoQ @tab X @tab X
614 @tab Used in Quake III, Jedi Knight 2, other computer games.
615 @item DPCM Interplay @tab @tab X
616 @tab Used in various Interplay computer games.
617 @item DPCM Sierra Online @tab @tab X
618 @tab Used in Sierra Online game audio files.
619 @item DPCM Sol @tab @tab X
620 @item DPCM Xan @tab @tab X
621 @tab Used in Origin's Wing Commander IV AVI files.
622 @item DSP Group TrueSpeech @tab @tab X
623 @item DV audio @tab @tab X
624 @item Enhanced AC-3 @tab X @tab X
625 @item FLAC (Free Lossless Audio Codec) @tab X @tab IX
626 @item GSM @tab E @tab X
627 @tab encoding supported through external library libgsm
628 @item GSM Microsoft variant @tab E @tab X
629 @tab encoding supported through external library libgsm
630 @item IMC (Intel Music Coder) @tab @tab X
631 @item MACE (Macintosh Audio Compression/Expansion) 3:1 @tab @tab X
632 @item MACE (Macintosh Audio Compression/Expansion) 6:1 @tab @tab X
633 @item MLP (Meridian Lossless Packing) @tab @tab X
634 @tab Used in DVD-Audio discs.
635 @item Monkey's Audio @tab @tab X
636 @tab Only versions 3.97-3.99 are supported.
637 @item MP1 (MPEG audio layer 1) @tab @tab IX
638 @item MP2 (MPEG audio layer 2) @tab IX @tab IX
639 @item MP3 (MPEG audio layer 3) @tab E @tab IX
640 @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
641 @item MPEG-4 Audio Lossless Coding (ALS) @tab @tab X
642 @item Musepack SV7 @tab @tab X
643 @item Musepack SV8 @tab @tab X
644 @item Nellymoser Asao @tab X @tab X
645 @item PCM A-law @tab X @tab X
646 @item PCM mu-law @tab X @tab X
647 @item PCM 16-bit little-endian planar @tab @tab X
648 @item PCM 32-bit floating point big-endian @tab X @tab X
649 @item PCM 32-bit floating point little-endian @tab X @tab X
650 @item PCM 64-bit floating point big-endian @tab X @tab X
651 @item PCM 64-bit floating point little-endian @tab X @tab X
652 @item PCM D-Cinema audio signed 24-bit @tab X @tab X
653 @item PCM signed 8-bit @tab X @tab X
654 @item PCM signed 16-bit big-endian @tab X @tab X
655 @item PCM signed 16-bit little-endian @tab X @tab X
656 @item PCM signed 24-bit big-endian @tab X @tab X
657 @item PCM signed 24-bit little-endian @tab X @tab X
658 @item PCM signed 32-bit big-endian @tab X @tab X
659 @item PCM signed 32-bit little-endian @tab X @tab X
660 @item PCM signed 16/20/24-bit big-endian in MPEG-TS @tab @tab X
661 @item PCM unsigned 8-bit @tab X @tab X
662 @item PCM unsigned 16-bit big-endian @tab X @tab X
663 @item PCM unsigned 16-bit little-endian @tab X @tab X
664 @item PCM unsigned 24-bit big-endian @tab X @tab X
665 @item PCM unsigned 24-bit little-endian @tab X @tab X
666 @item PCM unsigned 32-bit big-endian @tab X @tab X
667 @item PCM unsigned 32-bit little-endian @tab X @tab X
668 @item PCM Zork @tab X @tab X
669 @item QCELP / PureVoice @tab @tab X
670 @item QDesign Music Codec 2 @tab @tab X
671 @tab There are still some distortions.
672 @item RealAudio 1.0 (14.4K) @tab X @tab X
673 @tab Real 14400 bit/s codec
674 @item RealAudio 2.0 (28.8K) @tab @tab X
675 @tab Real 28800 bit/s codec
676 @item RealAudio 3.0 (dnet) @tab IX @tab X
677 @tab Real low bitrate AC-3 codec
678 @item RealAudio SIPR / ACELP.NET @tab @tab X
679 @item Shorten @tab @tab X
680 @item Sierra VMD audio @tab @tab X
681 @tab Used in Sierra VMD files.
682 @item Smacker audio @tab @tab X
683 @item SMPTE 302M AES3 audio @tab @tab X
684 @item Speex @tab @tab E
685 @tab supported through external library libspeex
686 @item True Audio (TTA) @tab @tab X
687 @item TrueHD @tab @tab X
688 @tab Used in HD-DVD and Blu-Ray discs.
689 @item TwinVQ (VQF flavor) @tab @tab X
690 @item Vorbis @tab E @tab X
691 @tab A native but very primitive encoder exists.
692 @item WavPack @tab @tab X
693 @item Westwood Audio (SND1) @tab @tab X
694 @item Windows Media Audio 1 @tab X @tab X
695 @item Windows Media Audio 2 @tab X @tab X
696 @item Windows Media Audio Pro @tab @tab X
697 @item Windows Media Audio Voice @tab @tab X
700 @code{X} means that encoding (resp. decoding) is supported.
702 @code{E} means that support is provided through an external library.
704 @code{I} means that an integer-only version is available, too (ensures high
705 performance on systems without hardware floating point support).
707 @section Subtitle Formats
709 @multitable @columnfractions .4 .1 .1 .1 .1
710 @item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
711 @item SSA/ASS @tab X @tab X @tab X @tab X
712 @item DVB @tab X @tab X @tab X @tab X
713 @item DVD @tab X @tab X @tab X @tab X
714 @item PGS @tab @tab @tab @tab X
715 @item SubRip (SRT) @tab X @tab X @tab @tab X
716 @item XSUB @tab @tab @tab X @tab X
719 @code{X} means that the feature is supported.
721 @section Network Protocols
723 @multitable @columnfractions .4 .1
724 @item Name @tab Support
725 @item Apple HTTP Live Streaming @tab X
736 @code{X} means that the protocol is supported.
739 @section Input/Output Devices
741 @multitable @columnfractions .4 .1 .1
742 @item Name @tab Input @tab Output
743 @item ALSA @tab X @tab X
744 @item BKTR @tab X @tab
745 @item DV1394 @tab X @tab
746 @item JACK @tab X @tab
747 @item LIBDC1394 @tab X @tab
748 @item OSS @tab X @tab X
749 @item Video4Linux @tab X @tab
750 @item Video4Linux2 @tab X @tab
751 @item VfW capture @tab X @tab
752 @item X11 grabbing @tab X @tab
755 @code{X} means that input/output is supported.
758 @chapter Platform Specific information
762 Using a cross-compiler is preferred for various reasons.
766 For information about compiling Libav on OS/2 see
767 @url{http://www.edm2.com/index.php/FFmpeg}.
771 Some parts of Libav cannot be built with version 2.15 of the GNU
772 assembler which is still provided by a few AMD64 distributions. To
773 make sure your compiler really uses the required version of gas
774 after a binutils upgrade, run:
777 $(gcc -print-prog-name=as) --version
780 If not, then you should install a different compiler that has no
781 hard-coded path to gas. In the worst case pass @code{--disable-asm}
786 BSD make will not build Libav, you need to install and use GNU Make
789 @subsection (Open)Solaris
791 GNU Make is required to build Libav, so you have to invoke (@file{gmake}),
792 standard Solaris Make will not work. When building with a non-c99 front-end
793 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
794 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
795 since the libc is not c99-compliant by default. The probes performed by
796 configure may raise an exception leading to the death of configure itself
797 due to a bug in the system shell. Simply invoke a different shell such as
798 bash directly to work around this:
804 @subsection Darwin (MacOS X, iPhone)
806 MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from
807 @url{http://github.com/yuvi/gas-preprocessor} to build the optimized
808 assembler functions. Just download the Perl script and put it somewhere
809 in your PATH, Libav's configure will pick it up automatically.
813 @subsection Native Windows compilation
815 Libav can be built to run natively on Windows using the MinGW tools. Install
816 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
817 You can find detailed installation
818 instructions in the download section and the FAQ.
820 Libav does not build out-of-the-box with the packages the automated MinGW
821 installer provides. It also requires coreutils to be installed and many other
822 packages updated to the latest version. The minimum version for some packages
827 @item msys-make 3.81-2 (note: not mingw32-make)
829 @item mingw-runtime 3.15
832 Libav automatically passes @code{-fno-common} to the compiler to work around
833 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
839 @item Building natively using MSYS can be sped up by disabling implicit rules
840 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
841 speed up is close to non-existent for normal one-off builds and is only
842 noticeable when running make for a second time (for example in
843 @code{make install}).
845 @item In order to compile AVplay, you must have the MinGW development library
846 of @uref{http://www.libsdl.org/, SDL}.
847 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
848 where SDL was installed. Verify that @file{sdl-config} can be launched from
849 the MSYS command line.
851 @item By using @code{./configure --enable-shared} when configuring Libav,
852 you can build libavutil, libavcodec and libavformat as DLLs.
856 @subsection Microsoft Visual C++ compatibility
858 As stated in the FAQ, Libav will not compile under MSVC++. However, if you
859 want to use the libav* libraries in your own applications, you can still
860 compile those applications using MSVC++. But the libav* libraries you link
861 to @emph{must} be built with MinGW. However, you will not be able to debug
862 inside the libav* libraries, since MSVC++ does not recognize the debug
863 symbols generated by GCC.
864 We strongly recommend you to move over from MSVC++ to MinGW tools.
866 This description of how to use the Libav libraries with MSVC++ is based on
867 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
868 you might have to modify the procedures slightly.
870 @subsubsection Using static libraries
872 Assuming you have just built and installed Libav in @file{/usr/local}.
876 @item Create a new console application ("File / New / Project") and then
877 select "Win32 Console Application". On the appropriate page of the
878 Application Wizard, uncheck the "Precompiled headers" option.
880 @item Write the source code for your application, or, for testing, just
881 copy the code from an existing sample application into the source file
882 that MSVC++ has already created for you. For example, you can copy
883 @file{libavformat/output-example.c} from the Libav distribution.
885 @item Open the "Project / Properties" dialog box. In the "Configuration"
886 combo box, select "All Configurations" so that the changes you make will
887 affect both debug and release builds. In the tree view on the left hand
888 side, select "C/C++ / General", then edit the "Additional Include
889 Directories" setting to contain the path where the Libav includes were
890 installed (i.e. @file{c:\msys\1.0\local\include}).
891 Do not add MinGW's include directory here, or the include files will
892 conflict with MSVC's.
894 @item Still in the "Project / Properties" dialog box, select
895 "Linker / General" from the tree view and edit the
896 "Additional Library Directories" setting to contain the @file{lib}
897 directory where Libav was installed (i.e. @file{c:\msys\1.0\local\lib}),
898 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
899 and the directory where MinGW's GCC libs are installed
900 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
901 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
902 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
903 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
904 to the end of "Additional Dependencies".
906 @item Now, select "C/C++ / Code Generation" from the tree view. Select
907 "Debug" in the "Configuration" combo box. Make sure that "Runtime
908 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
909 the "Configuration" combo box and make sure that "Runtime Library" is
910 set to "Multi-threaded DLL".
912 @item Click "OK" to close the "Project / Properties" dialog box.
914 @item MSVC++ lacks some C99 header files that are fundamental for Libav.
915 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
916 and install it in MSVC++'s include directory
917 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
919 @item MSVC++ also does not understand the @code{inline} keyword used by
920 Libav, so you must add this line before @code{#include}ing libav*:
922 #define inline _inline
925 @item Build your application, everything should work.
929 @subsubsection Using shared libraries
931 This is how to create DLL and LIB files that are compatible with MSVC++:
933 Within the MSYS shell, build Libav with
936 ./configure --enable-shared
941 Your install path (@file{/usr/local/} by default) should now have the
942 necessary DLL and LIB files under the @file{bin} directory.
944 Alternatively, build the libraries with a cross compiler, according to
945 the instructions below in @ref{Cross compilation for Windows with Linux}.
947 To use those files with MSVC++, do the same as you would do with
948 the static libraries, as described above. But in Step 4,
949 you should only need to add the directory where the LIB files are installed
950 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
951 installed in the @file{bin} directory. And instead of adding the static
952 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
953 (@file{avcodec.lib}, @file{avformat.lib}, and
954 @file{avutil.lib}). Note that you should not use the GCC import
955 libraries (@file{libxxx.dll.a} files), as these will give you undefined
956 reference errors. There should be no need for @file{libmingwex.a},
957 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
958 statically linked into the DLLs.
960 Libav headers do not declare global data for Windows DLLs through the usual
961 dllexport/dllimport interface. Such data will be exported properly while
962 building, but to use them in your MSVC++ code you will have to edit the
963 appropriate headers and mark the data as dllimport. For example, in
964 libavutil/pixdesc.h you should have:
966 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
969 Note that using import libraries created by dlltool requires
970 the linker optimization option to be set to
971 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
972 the resulting binaries will fail during runtime. This isn't
973 required when using import libraries generated by lib.exe.
974 This issue is reported upstream at
975 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
977 To create import libraries that work with the @code{/OPT:REF} option
978 (which is enabled by default in Release mode), follow these steps:
982 @item Open @file{Visual Studio 2005 Command Prompt}.
984 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
985 which sets up the environment variables for the Visual C++ tools
986 (the standard location for this file is
987 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
989 @item Enter the @file{bin} directory where the created LIB and DLL files
992 @item Generate new import libraries with @file{lib.exe}:
995 lib /machine:i386 /def:..\lib\avcodec-53.def /out:avcodec.lib
996 lib /machine:i386 /def:..\lib\avdevice-53.def /out:avdevice.lib
997 lib /machine:i386 /def:..\lib\avfilter-2.def /out:avfilter.lib
998 lib /machine:i386 /def:..\lib\avformat-53.def /out:avformat.lib
999 lib /machine:i386 /def:..\lib\avutil-51.def /out:avutil.lib
1000 lib /machine:i386 /def:..\lib\swscale-2.def /out:swscale.lib
1005 @anchor{Cross compilation for Windows with Linux}
1006 @subsection Cross compilation for Windows with Linux
1008 You must use the MinGW cross compilation tools available at
1009 @url{http://www.mingw.org/}.
1011 Then configure Libav with the following options:
1013 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
1015 (you can change the cross-prefix according to the prefix chosen for the
1018 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
1020 @subsection Compilation under Cygwin
1022 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
1023 llrint() in its C library.
1025 Install your Cygwin with all the "Base" packages, plus the
1026 following "Devel" ones:
1028 binutils, gcc4-core, make, git, mingw-runtime, texi2html
1031 And the following "Utils" one:
1042 to make a static build.
1044 The current @code{gcc4-core} package is buggy and needs this flag to build
1048 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
1051 If you want to build Libav with additional libraries, download Cygwin
1052 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
1054 libogg-devel, libvorbis-devel
1057 These library packages are only available from
1058 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
1061 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel,
1062 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
1066 The recommendation for libnut and x264 is to build them from source by
1067 yourself, as they evolve too quickly for Cygwin Ports to be up to date.
1069 Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
1070 of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
1072 @subsection Crosscompilation for Windows under Cygwin
1074 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
1076 Just install your Cygwin as explained before, plus these additional
1079 gcc-mingw-core, mingw-runtime, mingw-zlib
1082 and add some special flags to your configure invocation.
1084 For a static build run
1086 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1089 and for a build with shared libraries
1091 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin