doc: FLV muxing is supported.
[ffmpeg.git] / doc / general.texi
index 75c6f57..303159e 100644 (file)
@@ -2,21 +2,22 @@
 
 @settitle General Documentation
 @titlepage
-@sp 7
 @center @titlefont{General Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter external libraries
 
-FFmpeg can be hooked up with a number of external libraries to add support
+Libav can be hooked up with a number of external libraries to add support
 for more formats. None of them are used by default, their use has to be
 explicitly requested by passing the appropriate flags to @file{./configure}.
 
 @section OpenCORE AMR
 
-FFmpeg can make use of the OpenCORE libraries for AMR-NB
+Libav can make use of the OpenCORE libraries for AMR-NB
 decoding/encoding and AMR-WB decoding.
 
 Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for
@@ -26,7 +27,7 @@ installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or
 Note that OpenCORE is under the Apache License 2.0 (see
 @url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is
 incompatible with the LGPL version 2.1 and GPL version 2. You have to
-upgrade FFmpeg's license to LGPL version 3 (or if you have enabled
+upgrade Libav's license to LGPL version 3 (or if you have enabled
 GPL components, GPL version 3) to use it.
 
 
@@ -36,7 +37,7 @@ You can use the @code{-formats} and @code{-codecs} options to have an exhaustive
 
 @section File Formats
 
-FFmpeg supports the following file formats through the @code{libavformat}
+Libav supports the following file formats through the @code{libavformat}
 library:
 
 @multitable @columnfractions .4 .1 .1 .4
@@ -61,6 +62,8 @@ library:
     @tab Used in some games from Bethesda Softworks.
 @item Bink                      @tab   @tab X
     @tab Multimedia format used by many games.
+@item Bitmap Brothers JV        @tab   @tab X
+    @tab Used in Z and Z95 games.
 @item Brute Force & Ignorance   @tab   @tab X
     @tab Used in the game Flash Traffic: City of Angels.
 @item Interplay C93             @tab   @tab X
@@ -78,6 +81,8 @@ library:
     @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 DFA                       @tab   @tab X
+    @tab This format is used in Chronomaster game
 @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
@@ -91,7 +96,7 @@ library:
     @tab Only embedded audio is decoded.
 @item FLI/FLC/FLX animation     @tab   @tab X
     @tab .fli/.flc files
-@item Flash Video (FLV)         @tab   @tab X
+@item Flash Video (FLV)         @tab X @tab X
     @tab Macromedia Flash video files
 @item framecrc testing format   @tab X @tab
 @item FunCom ISS                @tab   @tab X
@@ -110,7 +115,7 @@ library:
     @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
+@item IVF (On2)                 @tab X @tab X
     @tab A format used by libvpx
 @item LMLM4                     @tab   @tab X
     @tab Used by Linux Media Labs MPEG-4 PCI boards
@@ -118,7 +123,7 @@ library:
     @tab VR native stream format, used by Leitch/Harris' video servers.
 @item Matroska                  @tab X @tab X
 @item Matroska audio            @tab X @tab
-@item FFmpeg metadata           @tab X @tab
+@item FFmpeg metadata           @tab X @tab X
     @tab Metadata in text format.
 @item MAXIS XA                  @tab   @tab X
     @tab Used in Sim City 3000; file extension .xa.
@@ -253,6 +258,8 @@ library:
     @tab Multimedia format used in Westwood Studios games.
 @item Westwood Studios VQA      @tab   @tab X
     @tab Multimedia format used in Westwood Studios games.
+@item xWMA                      @tab   @tab X
+    @tab Microsoft audio container used by XAudio 2.
 @item YUV4MPEG pipe             @tab X @tab X
 @item Psygnosis YOP             @tab   @tab X
 @end multitable
@@ -351,7 +358,7 @@ following image formats are supported:
 @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 Bitmap Brothers JV video  @tab   @tab X
 @item Brute Force & Ignorance   @tab   @tab X
     @tab Used in the game Flash Traffic: City of Angels.
 @item C93 video              @tab     @tab  X
@@ -368,6 +375,8 @@ following image formats are supported:
 @item Cirrus Logic AccuPak   @tab     @tab  X
     @tab fourcc: CLJR
 @item Creative YUV (CYUV)    @tab     @tab  X
+@item DFA                    @tab     @tab  X
+    @tab Codec used in Chronomaster game.
 @item Dirac                  @tab  E  @tab  E
     @tab supported through external libdirac/libschroedinger libraries
 @item Deluxe Paint Animation @tab     @tab  X
@@ -424,6 +433,7 @@ following image formats are supported:
     @tab Codec used in Worms games.
 @item Kega Game Video (KGV1) @tab      @tab  X
     @tab Kega emulator screen capture codec.
+@item Lagarith               @tab     @tab  X
 @item LCL (LossLess Codec Library) MSZH  @tab     @tab  X
 @item LCL (LossLess Codec Library) ZLIB  @tab  E  @tab  E
 @item LOCO                   @tab     @tab  X
@@ -435,6 +445,7 @@ following image formats are supported:
 @item Miro VideoXL           @tab     @tab  X
     @tab fourcc: VIXL
 @item MJPEG (Motion JPEG)    @tab  X  @tab  X
+@item Mobotix MxPEG video    @tab     @tab  X
 @item Motion Pixels video    @tab     @tab  X
 @item MPEG-1 video           @tab  X  @tab  X
 @item MPEG-1/2 video XvMC (X-Video Motion Compensation)  @tab     @tab  X
@@ -509,6 +520,8 @@ following image formats are supported:
     @tab not completely working
 @item Wing Commander III / Xan  @tab     @tab  X
     @tab Used in Wing Commander III .MVE files.
+@item Wing Commander IV / Xan  @tab     @tab  X
+    @tab Used in Wing Commander IV.
 @item Winnov WNV1            @tab     @tab  X
 @item WMV7                   @tab  X  @tab  X
 @item YAMAHA SMAF            @tab  X  @tab  X
@@ -529,7 +542,7 @@ following image formats are supported:
 @item Name @tab Encoding @tab Decoding @tab Comments
 @item 8SVX audio             @tab     @tab  X
 @item AAC                    @tab  E  @tab  X
-    @tab encoding supported through external library libfaac
+    @tab encoding supported through external library libfaac and libvo-aacenc
 @item AC-3                   @tab IX  @tab  X
 @item ADPCM 4X Movie         @tab     @tab  X
 @item ADPCM CDROM XA         @tab     @tab  X
@@ -577,7 +590,8 @@ following image formats are supported:
 @item ADPCM Yamaha           @tab  X  @tab  X
 @item AMR-NB                 @tab  E  @tab  X
     @tab encoding supported through external library libopencore-amrnb
-@item AMR-WB                 @tab     @tab  X
+@item AMR-WB                 @tab  E  @tab  X
+    @tab encoding supported through external library libvo-amrwbenc
 @item Apple lossless audio   @tab  X  @tab  X
     @tab QuickTime fourcc 'alac'
 @item Atrac 1                @tab     @tab  X
@@ -659,10 +673,6 @@ following image formats are supported:
 @item Sierra VMD audio       @tab     @tab  X
     @tab Used in Sierra VMD files.
 @item Smacker audio          @tab     @tab  X
-@item Sonic                  @tab  X  @tab  X
-    @tab experimental codec
-@item Sonic lossless         @tab  X  @tab  X
-    @tab experimental codec
 @item Speex                  @tab     @tab  E
     @tab supported through external library libspeex
 @item True Audio (TTA)       @tab     @tab  X
@@ -690,11 +700,11 @@ performance on systems without hardware floating point support).
 
 @multitable @columnfractions .4 .1 .1 .1 .1
 @item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
-@item SSA/ASS      @tab X @tab X
+@item SSA/ASS      @tab X @tab X @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 SubRip (SRT) @tab X @tab X
+@item SubRip (SRT) @tab X @tab X @tab   @tab X
 @item XSUB         @tab   @tab   @tab X @tab X
 @end multitable
 
@@ -704,6 +714,7 @@ performance on systems without hardware floating point support).
 
 @multitable @columnfractions .4 .1
 @item Name         @tab Support
+@item Apple HTTP Live Streaming @tab X
 @item file         @tab X
 @item Gopher       @tab X
 @item HTTP         @tab X
@@ -744,18 +755,18 @@ Using a cross-compiler is preferred for various reasons.
 
 @subsection DJGPP
 
-FFmpeg cannot be compiled because of broken system headers, add
+Libav 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
+For information about compiling Libav 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
+Some parts of Libav 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:
@@ -770,12 +781,12 @@ to configure.
 
 @subsection BSD
 
-BSD make will not build FFmpeg, you need to install and use GNU Make
+BSD make will not build Libav, you need to install and use GNU Make
 (@file{gmake}).
 
-@subsubsection FreeBSD
+@subsubsection FreeBSD, DragonFly BSD
 
-FreeBSD will not compile out-of-the-box due to broken system headers.
+These systems 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
@@ -783,7 +794,7 @@ getting the system headers fixed.
 
 @subsection (Open)Solaris
 
-GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}),
+GNU Make is required to build Libav, 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
@@ -801,22 +812,18 @@ bash ./configure
 MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from
 @url{http://github.com/yuvi/gas-preprocessor} to build the optimized
 assembler functions. Just download the Perl script and put it somewhere
-in your PATH, FFmpeg's configure will pick it up automatically.
+in your PATH, Libav's configure will pick it up automatically.
 
 @section Windows
 
-To get help and instructions for building FFmpeg under Windows, check out
-the FFmpeg Windows Help Forum at
-@url{http://ffmpeg.arrozcru.org/}.
-
 @subsection Native Windows compilation
 
-FFmpeg can be built to run natively on Windows using the MinGW tools. Install
+Libav can be built to run natively on Windows using the MinGW tools. Install
 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
 You can find detailed installation
 instructions in the download section and the FAQ.
 
-FFmpeg does not build out-of-the-box with the packages the automated MinGW
+Libav does not build out-of-the-box with the packages the automated MinGW
 installer provides. It also requires coreutils to be installed and many other
 packages updated to the latest version. The minimum version for some packages
 are listed below:
@@ -828,7 +835,7 @@ are listed below:
 @item mingw-runtime 3.15
 @end itemize
 
-FFmpeg automatically passes @code{-fno-common} to the compiler to work around
+Libav automatically passes @code{-fno-common} to the compiler to work around
 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
 
 Within the MSYS shell, configure and make with:
@@ -859,14 +866,14 @@ Edit the @file{bin/sdl-config} script so that it points to the correct prefix
 where SDL was installed. Verify that @file{sdl-config} can be launched from
 the MSYS command line.
 
-@item By using @code{./configure --enable-shared} when configuring FFmpeg,
+@item By using @code{./configure --enable-shared} when configuring Libav,
 you can build libavutil, libavcodec and libavformat as DLLs.
 
 @end itemize
 
 @subsection Microsoft Visual C++ compatibility
 
-As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
+As stated in the FAQ, Libav will not compile under MSVC++. However, if you
 want to use the libav* libraries in your own applications, you can still
 compile those applications using MSVC++. But the libav* libraries you link
 to @emph{must} be built with MinGW. However, you will not be able to debug
@@ -874,13 +881,13 @@ inside the libav* libraries, since MSVC++ does not recognize the debug
 symbols generated by GCC.
 We strongly recommend you to move over from MSVC++ to MinGW tools.
 
-This description of how to use the FFmpeg libraries with MSVC++ is based on
+This description of how to use the Libav libraries with MSVC++ is based on
 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
 you might have to modify the procedures slightly.
 
 @subsubsection Using static libraries
 
-Assuming you have just built and installed FFmpeg in @file{/usr/local}.
+Assuming you have just built and installed Libav in @file{/usr/local}.
 
 @enumerate
 
@@ -891,13 +898,13 @@ Application Wizard, uncheck the "Precompiled headers" option.
 @item Write the source code for your application, or, for testing, just
 copy the code from an existing sample application into the source file
 that MSVC++ has already created for you. For example, you can copy
-@file{libavformat/output-example.c} from the FFmpeg distribution.
+@file{libavformat/output-example.c} from the Libav distribution.
 
 @item Open the "Project / Properties" dialog box. In the "Configuration"
 combo box, select "All Configurations" so that the changes you make will
 affect both debug and release builds. In the tree view on the left hand
 side, select "C/C++ / General", then edit the "Additional Include
-Directories" setting to contain the path where the FFmpeg includes were
+Directories" setting to contain the path where the Libav includes were
 installed (i.e. @file{c:\msys\1.0\local\include}).
 Do not add MinGW's include directory here, or the include files will
 conflict with MSVC's.
@@ -905,7 +912,7 @@ conflict with MSVC's.
 @item Still in the "Project / Properties" dialog box, select
 "Linker / General" from the tree view and edit the
 "Additional Library Directories" setting to contain the @file{lib}
-directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
+directory where Libav was installed (i.e. @file{c:\msys\1.0\local\lib}),
 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
 and the directory where MinGW's GCC libs are installed
 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
@@ -922,13 +929,13 @@ set to "Multi-threaded DLL".
 
 @item Click "OK" to close the "Project / Properties" dialog box.
 
-@item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
+@item MSVC++ lacks some C99 header files that are fundamental for Libav.
 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
 and install it in MSVC++'s include directory
 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
 
 @item MSVC++ also does not understand the @code{inline} keyword used by
-FFmpeg, so you must add this line before @code{#include}ing libav*:
+Libav, so you must add this line before @code{#include}ing libav*:
 @example
 #define inline _inline
 @end example
@@ -961,10 +968,10 @@ and run @file{c:\msys\1.0\msys.bat} from there.
 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
 from @file{Microsoft (R) Library Manager}, this means your environment
 variables are set up correctly, the @file{Microsoft (R) Library Manager}
-is on the path and will be used by FFmpeg to create
+is on the path and will be used by Libav to create
 MSVC++-compatible import libraries.
 
-@item Build FFmpeg with
+@item Build Libav with
 
 @example
 ./configure --enable-shared --enable-memalign-hack
@@ -983,7 +990,7 @@ you should only need to add the directory where the LIB files are installed
 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
 installed in the @file{bin} directory. And instead of adding the static
 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
-(@file{avcodec.lib}, @file{avformat.lib}, @file{avcore.lib}, and
+(@file{avcodec.lib}, @file{avformat.lib}, and
 @file{avutil.lib}). Note that you should not use the GCC import
 libraries (@file{libxxx.dll.a} files), as these will give you undefined
 reference errors. There should be no need for @file{libmingwex.a},
@@ -993,7 +1000,7 @@ of DLL files, but the ones that are actually used to run your application
 are the ones with a major version number in their filenames
 (i.e. @file{avcodec-51.dll}).
 
-FFmpeg headers do not declare global data for Windows DLLs through the usual
+Libav headers do not declare global data for Windows DLLs through the usual
 dllexport/dllimport interface. Such data will be exported properly while
 building, but to use them in your MSVC++ code you will have to edit the
 appropriate headers and mark the data as dllimport. For example, in
@@ -1002,19 +1009,25 @@ libavutil/pixdesc.h you should have:
 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
 @end example
 
+Note that using import libraries created by dlltool requires
+the linker optimization option to be set to
+"References: Keep Unreferenced Data (/OPT:NOREF)", otherwise
+the resulting binaries will fail during runtime. This isn't
+required when using import libraries generated by lib.exe.
+
 @subsection Cross compilation for Windows with Linux
 
 You must use the MinGW cross compilation tools available at
 @url{http://www.mingw.org/}.
 
-Then configure FFmpeg with the following options:
+Then configure Libav with the following options:
 @example
 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
 @end example
 (you can change the cross-prefix according to the prefix chosen for the
 MinGW tools).
 
-Then you can easily test FFmpeg with Wine
+Then you can easily test Libav with Wine
 (@url{http://www.winehq.com/}).
 
 @subsection Compilation under Cygwin
@@ -1025,7 +1038,7 @@ llrint() in its C library.
 Install your Cygwin with all the "Base" packages, plus the
 following "Devel" ones:
 @example
-binutils, gcc4-core, make, subversion, mingw-runtime, texi2html
+binutils, gcc4-core, make, git, mingw-runtime, texi2html
 @end example
 
 And the following "Utils" one:
@@ -1048,7 +1061,7 @@ shared libraries:
 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
 @end example
 
-If you want to build FFmpeg with additional libraries, download Cygwin
+If you want to build Libav with additional libraries, download Cygwin
 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
 @example
 libogg-devel, libvorbis-devel