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