Merge commit 'b0ce601c160c87349d093d7e542b5c752754f598'
authorMichael Niedermayer <michaelni@gmx.at>
Tue, 25 Jun 2013 08:46:52 +0000 (10:46 +0200)
committerMichael Niedermayer <michaelni@gmx.at>
Tue, 25 Jun 2013 08:46:52 +0000 (10:46 +0200)
* commit 'b0ce601c160c87349d093d7e542b5c752754f598':
  doc/platform: Add info about ICL

Conflicts:
doc/platform.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
1  2 
doc/platform.texi

diff --combined doc/platform.texi
index 07030001a915540959b6349675759cea1560b774,2a7dd451dbddea82c47f4486f6d267afa97cb1fe..6d01e0e18456d71b8227ed8a6370682ed8339fcb
@@@ -1,8 -1,8 +1,8 @@@
  \input texinfo @c -*- texinfo -*-
  
 -@settitle Platform Specific information
 +@settitle Platform Specific Information
  @titlepage
 -@center @titlefont{Platform Specific information}
 +@center @titlefont{Platform Specific Information}
  @end titlepage
  
  @top
@@@ -11,7 -11,7 +11,7 @@@
  
  @chapter Unix-like
  
 -Some parts of Libav cannot be built with version 2.15 of the GNU
 +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:
@@@ -26,12 -26,12 +26,12 @@@ to configure
  
  @section BSD
  
 -BSD make will not build Libav, you need to install and use GNU Make
 +BSD make will not build FFmpeg, you need to install and use GNU Make
  (@command{gmake}).
  
  @section (Open)Solaris
  
 -GNU Make is required to build Libav, so you have to invoke (@command{gmake}),
 +GNU Make is required to build FFmpeg, so you have to invoke (@command{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
@@@ -45,21 -45,20 +45,21 @@@ bash ./configur
  @end example
  
  @anchor{Darwin}
 -@section Darwin (OS X, iPhone)
 +@section Darwin (Mac OS X, iPhone)
  
  The toolchain provided with Xcode is sufficient to build the basic
  unacelerated code.
  
 -OS X on PowerPC or ARM (iPhone) requires a preprocessor from
 +Mac OS 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, Libav's configure will pick it up automatically.
 +in your PATH, FFmpeg's configure will pick it up automatically.
  
 -OS X on AMD64 and x86 requires @command{yasm} to build most of the
 -optimized assembler functions @url{http://mxcl.github.com/homebrew/, Homebrew},
 -@url{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix}
 -or @url{http://www.macports.org, MacPorts} can easily provide it.
 +Mac OS X on amd64 and x86 requires @command{yasm} to build most of the
 +optimized assembler functions. @uref{http://www.finkproject.org/, Fink},
 +@uref{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix},
 +@uref{http://mxcl.github.com/homebrew/, Homebrew}
 +or @uref{http://www.macports.org, MacPorts} can easily provide it.
  
  
  @chapter DOS
@@@ -70,18 -69,15 +70,18 @@@ Using a cross-compiler is preferred fo
  
  @chapter OS/2
  
 -For information about compiling Libav on OS/2 see
 +For information about compiling FFmpeg on OS/2 see
  @url{http://www.edm2.com/index.php/FFmpeg}.
  
  
  @chapter Windows
  
 +To get help and instructions for building FFmpeg under Windows, check out
 +the FFmpeg Windows Help Forum at @url{http://ffmpeg.zeranoe.com/forum/}.
 +
  @section Native Windows compilation using MinGW or MinGW-w64
  
 -Libav can be built to run natively on Windows using the MinGW or MinGW-w64
 +FFmpeg can be built to run natively on Windows using the MinGW or MinGW-w64
  toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
  @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
  You can find detailed installation instructions in the download section and
@@@ -97,24 -93,23 +97,24 @@@ speed up is close to non-existent for n
  noticeable when running make for a second time (for example during
  @code{make install}).
  
 -@item In order to compile AVplay, you must have the MinGW development library
 +@item In order to compile FFplay, you must have the MinGW development library
  of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
  
 -@item By using @code{./configure --enable-shared} when configuring Libav,
 -you can build all libraries as DLLs.
 +@item By using @code{./configure --enable-shared} when configuring FFmpeg,
 +you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
 +libavformat) as DLLs.
  
  @end itemize
  
- @section Microsoft Visual C++
+ @section Microsoft Visual C++ or Intel C++ Compiler for Windows
  
- FFmpeg can be built with MSVC using a C99-to-C89 conversion utility and
- wrapper.
 -Libav can be built with MSVC or ICL using a C99-to-C89 conversion utility and
++FFmpeg can be built with MSVC or ICL using a C99-to-C89 conversion utility and
+ wrapper. For ICL, only the wrapper is used, since ICL supports C99.
  
  You will need the following prerequisites:
  
  @itemize
 -@item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
 +@item @uref{http://download.videolan.org/pub/contrib/c99-to-c89/, C99-to-C89 Converter & Wrapper}
  @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
  @item @uref{http://www.mingw.org/, MSYS}
  @item @uref{http://yasm.tortall.net/, YASM}
  you want to run @uref{fate.html, FATE}.
  @end itemize
  
- To set up a proper MSVC environment in MSYS, you simply need to run
@code{msys.bat} from the Visual Studio command prompt.
+ To set up a proper environment in MSYS, you need to run @code{msys.bat} from
the Visual Studio or Intel Compiler command prompt.
  
  Place @code{makedef}, @code{c99wrap.exe}, @code{c99conv.exe}, and @code{yasm.exe}
  somewhere in your @code{PATH}.
  
  Next, make sure @code{inttypes.h} and any other headers and libs you want to use
- are located in a spot that MSVC can see. Do so by modifying the @code{LIB} and
- @code{INCLUDE} environment variables to include the @strong{Windows} paths to
+ are located in a spot that the compiler can see. Do so by modifying the @code{LIB}
and @code{INCLUDE} environment variables to include the @strong{Windows} paths to
  these directories. Alternatively, you can try and use the
  @code{--extra-cflags}/@code{--extra-ldflags} configure options.
  
  Finally, run:
  
  @example
+ For MSVC:
  ./configure --toolchain=msvc
+ For ICL:
+ ./configure --toolchain=icl
  make
  make install
  @end example
  
  If you wish to compile shared libraries, add @code{--enable-shared} to your
- configure options. Note that due to the way MSVC handles DLL imports and
+ configure options. Note that due to the way MSVC and ICL handle DLL imports and
  exports, you cannot compile static and shared libraries at the same time, and
  enabling shared libraries will automatically disable the static ones.
  
@@@ -165,20 -165,25 +170,25 @@@ follow step 3, or compilation will fail
  @enumerate
  @item Grab the @uref{http://zlib.net/, zlib sources}.
  @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
 -this is how Libav is built as well.
 +this is how FFmpeg is built as well.
  @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
 -erroneously included when building Libav.
 +erroneously included when building FFmpeg.
  @item Run @code{nmake -f win32/Makefile.msc}.
  @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
  can see.
  @end enumerate
  
- @item FFmpeg has been tested with Visual Studio 2010 and 2012, Pro and Express.
 -@item Libav has been tested with the following on i686 and x86_64:
++@item FFmpeg has been tested with the following on i686 and x86_64:
+ @itemize
+ @item Visual Studio 2010 Pro and Express
+ @item Visual Studio 2012 Pro and Express
+ @item Intel Composer XE 2013
+ @end itemize
  Anything else is not officially supported.
  
  @end itemize
  
 -@subsection Linking to Libav with Microsoft Visual C++
 +@subsection Linking to FFmpeg with Microsoft Visual C++
  
  If you plan to link with MSVC-built static libraries, you will need
  to make sure you have @code{Runtime Library} set to
@@@ -230,14 -235,14 +240,14 @@@ Replace @code{foo-version} and @code{fo
  You must use the MinGW cross compilation tools available at
  @url{http://www.mingw.org/}.
  
 -Then configure Libav with the following options:
 +Then configure FFmpeg 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 Libav with @uref{http://www.winehq.com/, Wine}.
 +Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
  
  @section Compilation under Cygwin
  
@@@ -255,7 -260,7 +265,7 @@@ In order to run FATE you will also nee
  bc, diffutils
  @end example
  
 -If you want to build Libav with additional libraries, download Cygwin
 +If you want to build FFmpeg with additional libraries, download Cygwin
  "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
  @example
  libogg-devel, libvorbis-devel
@@@ -265,7 -270,7 +275,7 @@@ These library packages are only availab
  @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
  
  @example
 -yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
 +yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
  libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
  @end example
  
@@@ -297,7 -302,7 +307,7 @@@ and for a build with shared librarie
  @chapter Plan 9
  
  The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
 -does not implement all the C99 features needed by Libav so the gcc
 +does not implement all the C99 features needed by FFmpeg so the gcc
  port must be used.  Furthermore, a few items missing from the C
  library and shell environment need to be fixed.
  
@@@ -313,7 -318,7 +323,7 @@@ utility by setting @code{pkgpath} t
  
  @item Missing/broken @code{head} and @code{printf} commands
  
 -Replacements adequate for building Libav can be found in the
 +Replacements adequate for building FFmpeg can be found in the
  @code{compat/plan9} directory.  Place these somewhere they will be
  found by the shell.  These are not full implementations of the
  commands and are @emph{not} suitable for general use.
@@@ -351,7 -356,7 +361,7 @@@ build system of this library
  @item FPU exceptions enabled by default
  
  Unlike most other systems, Plan 9 enables FPU exceptions by default.
 -These must be disabled before calling any Libav functions.  While the
 +These must be disabled before calling any FFmpeg functions.  While the
  included tools will do this automatically, other users of the
  libraries must do it themselves.