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