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