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