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