]> git.sesse.net Git - ffmpeg/blobdiff - doc/general.texi
Tele-typewriter demuxer
[ffmpeg] / doc / general.texi
index 6326df90adb1c34e6f801c9519047782a1c7028b..e96f88d799f0372b8ef9f426b0ed622d8cfd25b2 100644 (file)
@@ -32,7 +32,7 @@ GPL components, GPL version 3) to use it.
 
 @chapter Supported File Formats and Codecs
 
-You can use the @code{-formats} option to have an exhaustive list.
+You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
 
 @section File Formats
 
@@ -44,6 +44,7 @@ library:
 @item 4xm                       @tab   @tab X
     @tab 4X Technologies format, used in some games.
 @item 8088flex TMV              @tab   @tab X
+@item Adobe Filmstrip           @tab X @tab X
 @item Audio IFF (AIFF)          @tab X @tab X
 @item American Laser Games MM   @tab   @tab X
     @tab Multimedia format used in games like Mad Dog McCree.
@@ -57,18 +58,25 @@ library:
     @tab Audio and video format used in some games by Beam Software.
 @item Bethesda Softworks VID    @tab   @tab X
     @tab Used in some games from Bethesda Softworks.
+@item Bink                      @tab   @tab X
+    @tab Multimedia format used by many games.
 @item Brute Force & Ignorance   @tab   @tab X
     @tab Used in the game Flash Traffic: City of Angels.
 @item Interplay C93             @tab   @tab X
     @tab Used in the game Cyberia from Interplay.
 @item Delphine Software International CIN @tab   @tab X
     @tab Multimedia format used by Delphine Software games.
+@item CD+G                      @tab   @tab X
+    @tab Video format used by CD+G karaoke disks
+@item Core Audio Format         @tab   @tab X
+    @tab Apple Core Audio Format
 @item CRC testing format        @tab X @tab
 @item Creative Voice            @tab X @tab X
     @tab Created for the Sound Blaster Pro.
 @item CRYO APC                  @tab   @tab X
     @tab Audio format used in some games by CRYO Interactive Entertainment.
 @item D-Cinema audio            @tab X @tab X
+@item Deluxe Paint Animation    @tab   @tab X
 @item DV video                  @tab X @tab X
 @item DXA                       @tab   @tab X
     @tab This format is used in the non-Windows version of the Feeble Files
@@ -94,16 +102,22 @@ library:
 @item id Quake II CIN video     @tab   @tab X
 @item id RoQ                    @tab X @tab X
     @tab Used in Quake III, Jedi Knight 2, other computer games.
+@item IEC61937 encapsulation @tab X @tab
 @item IFF                       @tab   @tab X
     @tab Interchange File Format
 @item Interplay MVE             @tab   @tab X
     @tab Format used in various Interplay computer games.
+@item IV8                       @tab   @tab X
+    @tab A format generated by IndigoVision 8000 video server.
+@item IVF (On2)                 @tab   @tab X
+    @tab A format used by libvpx
 @item LMLM4                     @tab   @tab X
     @tab Used by Linux Media Labs MPEG-4 PCI boards
 @item Matroska                  @tab X @tab X
 @item Matroska audio            @tab X @tab
 @item MAXIS XA                  @tab   @tab X
     @tab Used in Sim City 3000; file extension .xa.
+@item MD Studio                 @tab   @tab X
 @item Monkey's Audio            @tab   @tab X
 @item Motion Pixels MVI         @tab   @tab X
 @item MOV/QuickTime/MP4         @tab X @tab X
@@ -195,9 +209,10 @@ library:
 @item RL2                       @tab   @tab X
     @tab Audio and video format used in some games by Entertainment Software Partners.
 @item RPL/ARMovie               @tab   @tab X
-@item RTMP                      @tab   @tab X
+@item RTMP                      @tab X @tab X
+    @tab Output is performed by publishing stream to RTMP server
 @item RTP                       @tab   @tab X
-@item RTSP                      @tab   @tab X
+@item RTSP                      @tab X @tab X
 @item SDP                       @tab   @tab X
 @item Sega FILM/CPK             @tab   @tab X
     @tab Used in many Sega Saturn console games.
@@ -210,8 +225,10 @@ library:
 @item Sony OpenMG (OMA)         @tab   @tab X
     @tab Audio format used in Sony Sonic Stage and Sony Vegas.
 @item Sony PlayStation STR      @tab   @tab X
+@item Sony Wave64 (W64)         @tab   @tab X
 @item SoX native format         @tab X @tab X
 @item SUN AU format             @tab X @tab X
+@item Text files                @tab   @tab X
 @item THP                       @tab   @tab X
     @tab Used on the Nintendo GameCube.
 @item Tiertex Limited SEQ       @tab   @tab X
@@ -220,6 +237,7 @@ library:
 @item VC-1 test bitstream       @tab X @tab X
 @item WAV                       @tab X @tab X
 @item WavPack                   @tab   @tab X
+@item WebM                      @tab X @tab X
 @item Wing Commander III movie  @tab   @tab X
     @tab Multimedia format used in Origin's Wing Commander III computer game.
 @item Westwood Studios audio    @tab   @tab X
@@ -227,6 +245,7 @@ library:
 @item Westwood Studios VQA      @tab   @tab X
     @tab Multimedia format used in Westwood Studios games.
 @item YUV4MPEG pipe             @tab X @tab X
+@item Psygnosis YOP             @tab   @tab X
 @end multitable
 
 @code{X} means that encoding (resp. decoding) is supported.
@@ -263,6 +282,8 @@ following image formats are supported:
     @tab Portable GrayMap image
 @item PGMYUV       @tab X @tab X
     @tab PGM with U and V components in YUV 4:2:0
+@item PIC          @tab @tab X
+    @tab Pictor/PC Paint
 @item PNG          @tab X @tab X
     @tab 2/4 bpp not supported yet
 @item PPM          @tab X @tab X
@@ -296,6 +317,7 @@ following image formats are supported:
     @tab Used in games like Mad Dog McCree.
 @item AMV Video              @tab     @tab  X
     @tab Used in Chinese MP3 players.
+@item ANSI/ASCII art         @tab     @tab  X
 @item Apple MJPEG-B          @tab     @tab  X
 @item Apple QuickDraw        @tab     @tab  X
     @tab fourcc: qdrw
@@ -307,6 +329,8 @@ following image formats are supported:
     @tab fourcc: VCR1
 @item ATI VCR2               @tab     @tab  X
     @tab fourcc: VCR2
+@item Auravision Aura        @tab     @tab  X
+@item Auravision Aura 2      @tab     @tab  X
 @item Autodesk Animator Flic video  @tab     @tab  X
 @item Autodesk RLE           @tab     @tab  X
     @tab fourcc: AASC
@@ -315,12 +339,16 @@ following image formats are supported:
 @item Beam Software VB       @tab     @tab  X
 @item Bethesda VID video     @tab     @tab  X
     @tab Used in some games from Bethesda Softworks.
+@item Bink Video             @tab     @tab  X
+    @tab Support for version 'b' is missing.
 @item Brute Force & Ignorance   @tab   @tab X
     @tab Used in the game Flash Traffic: City of Angels.
 @item C93 video              @tab     @tab  X
     @tab Codec used in Cyberia game.
 @item CamStudio              @tab     @tab  X
     @tab fourcc: CSCD
+@item CD+G                   @tab     @tab  X
+    @tab Video codec for CD+G karaoke disks
 @item Chinese AVS video      @tab     @tab  X
     @tab AVS1-P2, JiZhun profile
 @item Delphine Software International CIN video  @tab     @tab  X
@@ -331,6 +359,7 @@ following image formats are supported:
 @item Creative YUV (CYUV)    @tab     @tab  X
 @item Dirac                  @tab  E  @tab  E
     @tab supported through external libdirac/libschroedinger libraries
+@item Deluxe Paint Animation @tab     @tab  X
 @item DNxHD                  @tab   X @tab  X
     @tab aka SMPTE VC3
 @item Duck TrueMotion 1.0   @tab     @tab  X
@@ -347,7 +376,7 @@ following image formats are supported:
 @item Electronic Arts TGQ video  @tab     @tab  X
 @item Electronic Arts TQI video  @tab     @tab  X
 @item Escape 124             @tab     @tab  X
-@item FFmpeg codec #1        @tab  X  @tab  X
+@item FFmpeg video codec #1  @tab  X  @tab  X
     @tab experimental lossless codec (fourcc: FFV1)
 @item Flash Screen Video v1  @tab  X  @tab  X
     @tab fourcc: FSV1
@@ -368,15 +397,22 @@ following image formats are supported:
     @tab Used in Quake II.
 @item id RoQ video           @tab  X  @tab  X
     @tab Used in Quake III, Jedi Knight 2, other computer games.
+@item IFF ILBM               @tab     @tab  X
+    @tab IFF interlaved bitmap
+@item IFF ByteRun1           @tab     @tab  X
+    @tab IFF run length encoded bitmap
 @item Intel H.263            @tab     @tab  X
 @item Intel Indeo 2          @tab     @tab  X
 @item Intel Indeo 3          @tab     @tab  X
+@item Intel Indeo 5          @tab     @tab  X
 @item Interplay C93          @tab     @tab  X
     @tab Used in the game Cyberia from Interplay.
 @item Interplay MVE video    @tab     @tab  X
     @tab Used in Interplay .MVE files.
 @item Karl Morton's video codec  @tab     @tab  X
     @tab Codec used in Worms games.
+@item Kega Game Video (KGV1) @tab      @tab  X
+    @tab Kega emulator screen capture codec.
 @item LCL (LossLess Codec Library) MSZH  @tab     @tab  X
 @item LCL (LossLess Codec Library) ZLIB  @tab  E  @tab  E
 @item LOCO                   @tab     @tab  X
@@ -407,6 +443,8 @@ following image formats are supported:
     @tab fourcc: VP50
 @item On2 VP6                @tab     @tab  X
     @tab fourcc: VP60,VP61,VP62
+@item VP8                    @tab  E  @tab  X
+    @tab fourcc: VP80, encoding supported through external library libvpx
 @item planar RGB             @tab     @tab  X
     @tab fourcc: 8BPS
 @item Q-team QPEG            @tab     @tab  X
@@ -418,6 +456,7 @@ following image formats are supported:
     @tab fourcc: 'smc '
 @item QuickTime video (RPZA) @tab     @tab  X
     @tab fourcc: rpza
+@item R210 Quicktime Uncompressed RGB 10-bit     @tab     @tab  X
 @item Raw Video              @tab  X  @tab  X
 @item RealVideo 1.0          @tab  X  @tab  X
 @item RealVideo 2.0          @tab  X  @tab  X
@@ -461,6 +500,7 @@ following image formats are supported:
 @item Winnov WNV1            @tab     @tab  X
 @item WMV7                   @tab  X  @tab  X
 @item YAMAHA SMAF            @tab  X  @tab  X
+@item Psygnosis YOP Video    @tab     @tab  X
 @item ZLIB                   @tab  X  @tab  X
     @tab part of LCL, encoder experimental
 @item Zip Motion Blocks Video  @tab   X @tab  X
@@ -522,13 +562,16 @@ following image formats are supported:
 @item ADPCM Westwood Studios IMA @tab     @tab  X
     @tab Used in Westwood Studios games like Command and Conquer.
 @item ADPCM Yamaha           @tab  X  @tab  X
-@item AMR-NB                 @tab  E  @tab  E
-    @tab supported through external library libopencore-amrnb
+@item AMR-NB                 @tab  E  @tab  X
+    @tab encoding supported through external library libopencore-amrnb
 @item AMR-WB                 @tab     @tab  E
     @tab decoding supported through external library libopencore-amrwb
 @item Apple lossless audio   @tab  X  @tab  X
     @tab QuickTime fourcc 'alac'
+@item Atrac 1                @tab     @tab  X
 @item Atrac 3                @tab     @tab  X
+@item Bink Audio             @tab     @tab  X
+    @tab Used in Bink and Smacker files in many games.
 @item Delphine Software International CIN audio  @tab     @tab  X
     @tab Codec used in Delphine Software International games.
 @item COOK                   @tab     @tab  X
@@ -548,10 +591,10 @@ following image formats are supported:
 @item Enhanced AC-3          @tab     @tab  X
 @item FLAC (Free Lossless Audio Codec)  @tab  X  @tab  IX
 @item G.729                  @tab     @tab  X
-@item GSM                    @tab  E  @tab  E
-    @tab supported through external library libgsm
-@item GSM Microsoft variant  @tab  E  @tab  E
-    @tab supported through external library libgsm
+@item GSM                    @tab  E  @tab  X
+    @tab encoding supported through external library libgsm
+@item GSM Microsoft variant  @tab  E  @tab  X
+    @tab encoding supported through external library libgsm
 @item IMC (Intel Music Coder)  @tab     @tab  X
 @item MACE (Macintosh Audio Compression/Expansion) 3:1  @tab     @tab  X
 @item MACE (Macintosh Audio Compression/Expansion) 6:1  @tab     @tab  X
@@ -563,6 +606,7 @@ following image formats are supported:
 @item MP2 (MPEG audio layer 2)  @tab IX  @tab IX
 @item MP3 (MPEG audio layer 3)  @tab  E  @tab IX
     @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
+@item MPEG-4 Audio Lossless Coding (ALS)  @tab     @tab  X
 @item Musepack SV7           @tab     @tab  X
 @item Musepack SV8           @tab     @tab  X
 @item Nellymoser Asao        @tab  X  @tab  X
@@ -581,6 +625,7 @@ following image formats are supported:
 @item PCM signed 24-bit little-endian  @tab  X  @tab  X
 @item PCM signed 32-bit big-endian  @tab  X  @tab  X
 @item PCM signed 32-bit little-endian  @tab  X  @tab  X
+@item PCM signed 16/20/24-bit big-endian in MPEG-TS  @tab     @tab  X
 @item PCM unsigned 8-bit     @tab  X  @tab  X
 @item PCM unsigned 16-bit big-endian  @tab  X  @tab  X
 @item PCM unsigned 16-bit little-endian  @tab  X  @tab  X
@@ -592,12 +637,13 @@ following image formats are supported:
 @item QCELP / PureVoice      @tab     @tab  X
 @item QDesign Music Codec 2  @tab     @tab  X
     @tab There are still some distortions.
-@item RealAudio 1.0 (14.4K)  @tab     @tab  X
+@item RealAudio 1.0 (14.4K)  @tab  X  @tab  X
     @tab Real 14400 bit/s codec
 @item RealAudio 2.0 (28.8K)  @tab     @tab  X
     @tab Real 28800 bit/s codec
 @item RealAudio 3.0 (dnet)   @tab IX  @tab  X
     @tab Real low bitrate AC-3 codec
+@item RealAudio SIPR / ACELP.NET @tab     @tab  X
 @item Shorten                @tab     @tab  X
 @item Sierra VMD audio       @tab     @tab  X
     @tab Used in Sierra VMD files.
@@ -611,12 +657,15 @@ following image formats are supported:
 @item True Audio (TTA)       @tab     @tab  X
 @item TrueHD                 @tab     @tab  X
     @tab Used in HD-DVD and Blu-Ray discs.
+@item TwinVQ (VQF flavor)    @tab     @tab  X
 @item Vorbis                 @tab  E  @tab  X
-    @ A native but very primitive encoder exists.
+    @tab A native but very primitive encoder exists.
 @item WavPack                @tab     @tab  X
 @item Westwood Audio (SND1)  @tab     @tab  X
 @item Windows Media Audio 1  @tab  X  @tab  X
 @item Windows Media Audio 2  @tab  X  @tab  X
+@item Windows Media Audio Pro @tab    @tab  X
+@item Windows Media Audio Voice @tab  @tab  X
 @end multitable
 
 @code{X} means that encoding (resp. decoding) is supported.
@@ -633,6 +682,7 @@ performance on systems without hardware floating point support).
 @item SSA/ASS      @tab X @tab X
 @item DVB          @tab X @tab X @tab X @tab X
 @item DVD          @tab X @tab X @tab X @tab X
+@item PGS          @tab   @tab   @tab   @tab X
 @item XSUB         @tab   @tab   @tab X @tab X
 @end multitable
 
@@ -645,6 +695,7 @@ performance on systems without hardware floating point support).
 @item file         @tab X
 @item Gopher       @tab X
 @item HTTP         @tab X
+@item MMS          @tab X
 @item pipe         @tab X
 @item RTP          @tab X
 @item TCP          @tab X
@@ -659,7 +710,6 @@ performance on systems without hardware floating point support).
 @multitable @columnfractions .4 .1 .1
 @item Name              @tab Input  @tab Output
 @item ALSA              @tab X      @tab X
-@item BEOS audio        @tab X      @tab X
 @item BKTR              @tab X      @tab
 @item DV1394            @tab X      @tab
 @item JACK              @tab X      @tab
@@ -676,11 +726,70 @@ performance on systems without hardware floating point support).
 
 @chapter Platform Specific information
 
-@section BSD
+@section DOS
+
+Using a cross-compiler is preferred for various reasons.
+
+@subsection DJGPP
+
+FFmpeg cannot be compiled because of broken system headers, add
+@code{--extra-cflags=-U__STRICT_ANSI__} to the configure options as a
+workaround.
+
+@section OS/2
+
+For information about compiling FFmpeg on OS/2 see
+@url{http://www.edm2.com/index.php/FFmpeg}.
+
+@section Unix-like
+
+Some parts of FFmpeg cannot be built with version 2.15 of the GNU
+assembler which is still provided by a few AMD64 distributions. To
+make sure your compiler really uses the required version of gas
+after a binutils upgrade, run:
+
+@example
+$(gcc -print-prog-name=as) --version
+@end example
+
+If not, then you should install a different compiler that has no
+hard-coded path to gas. In the worst case pass @code{--disable-asm}
+to configure.
+
+@subsection BSD
 
 BSD make will not build FFmpeg, you need to install and use GNU Make
 (@file{gmake}).
 
+@subsubsection FreeBSD
+
+FreeBSD will not compile out-of-the-box due to broken system headers.
+Passing @code{--extra-cflags=-D__BSD_VISIBLE} to configure will work
+around the problem. This may have unexpected sideeffects, so use it at
+your own risk. If you care about FreeBSD, please make an attempt at
+getting the system headers fixed.
+
+@subsection (Open)Solaris
+
+GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}),
+standard Solaris Make will not work. When building with a non-c99 front-end
+(gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
+or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
+since the libc is not c99-compliant by default. The probes performed by
+configure may raise an exception leading to the death of configure itself
+due to a bug in the system shell. Simply invoke a different shell such as
+bash directly to work around this:
+
+@example
+bash ./configure
+@end example
+
+@subsection Darwin (MacOS X, iPhone)
+
+MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from
+@url{http://github.com/yuvi/gas-preprocessor} to build the optimized
+assembler functions.
+
 @section Windows
 
 To get help and instructions for building FFmpeg under Windows, check out
@@ -712,7 +821,7 @@ a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
 Within the MSYS shell, configure and make with:
 
 @example
-./configure --enable-memalign-hack --extra-cflags=-fno-common
+./configure --enable-memalign-hack
 make
 make install
 @end example
@@ -725,6 +834,12 @@ Notes:
 
 @itemize
 
+@item Building natively using MSYS can be sped up by disabling implicit rules
+in the Makefile by calling @code{make -r} instead of plain @code{make}. This
+speed up is close to non-existent for normal one-off builds and is only
+noticeable when running make for a second time (for example in
+@code{make install}).
+
 @item In order to compile FFplay, you must have the MinGW development library
 of SDL. Get it from @url{http://www.libsdl.org}.
 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
@@ -879,14 +994,13 @@ Then you can easily test FFmpeg with Wine
 
 @subsection Compilation under Cygwin
 
-The main issue with the 1.5.x Cygwin versions is that newlib, its C library,
-does not contain llrint().  You need to upgrade to the unstable 1.7.x versions,
-or leverage the implementation in MinGW (as explained below).
+Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
+llrint() in its C library.
 
-Just install your Cygwin with all the "Base" packages, plus the
+Install your Cygwin with all the "Base" packages, plus the
 following "Devel" ones:
 @example
-binutils, gcc-core, make, subversion, mingw-runtime
+binutils, gcc4-core, make, subversion, mingw-runtime, texi2html
 @end example
 
 And the following "Utils" one:
@@ -894,33 +1008,21 @@ And the following "Utils" one:
 diffutils
 @end example
 
-The experimental gcc4 package is still buggy, hence please
-use the official gcc 3.4.4 or a 4.2.x compiled from source by yourself.
-
-Install the current binutils-20080624-2 as they work fine (the old
-binutils-20060709-1 proved buggy on shared builds).
-
-Then create a small library that just contains llrint():
-
-@example
-ar x /usr/lib/mingw/libmingwex.a llrint.o
-ar cq /usr/local/lib/libllrint.a llrint.o
-@end example
-
 Then run
 
 @example
-./configure --enable-static --disable-shared  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
+./configure --enable-static --disable-shared
 @end example
 
-to make a static build or
+to make a static build.
+
+The current @code{gcc4-core} package is buggy and needs this flag to build
+shared libraries:
 
 @example
-./configure --enable-shared --disable-static  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
+./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
 @end example
 
-to build shared libraries.
-
 If you want to build FFmpeg with additional libraries, download Cygwin
 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
 @example
@@ -931,7 +1033,7 @@ These library packages are only available from Cygwin Ports
 (@url{http://sourceware.org/cygwinports/}) :
 
 @example
-yasm, libSDL-devel, libdirac-devel, libfaac-devel, libfaad-devel, libgsm-devel,
+yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel,
 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
 libxvidcore-devel
 @end example
@@ -964,13 +1066,4 @@ and for a build with shared libraries
 ./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
 @end example
 
-@section BeOS
-
-BeOS support is broken in mysterious ways.
-
-@section OS/2
-
-For information about compiling FFmpeg on OS/2 see
-@url{http://www.edm2.com/index.php/FFmpeg}.
-
 @bye