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