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