VideoLAN Wiki - User contributions [en]

Win32CompileMSYSNew

2011-06-13T11:51:40Z

Paulc0001: Fix typo

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the '''fastest''' and '''recommended '''way to build VLC natively on Windows. Note that you could also [[Win32Compile|cross compile]] VLC from Linux, if desired (it is faster).

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

You can look at [http://sourceforge.net/projects/notepad2/ notepad2]. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

Or you can look at [http://notepad-plus-plus.org/ notepad++].

== Unzip Utility (7-zip) ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''the old version of mingw GCC (3.4.5) worked with VLC, because it uses SlJl exception unwinding. Any "vanilla" version 4.0+ by default uses dwarf2 exception unwinding, so isn't compatible with the contribs. So recommend installing TDM, below.''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.5.2.exe/download

Go through the wizard:

*uncheck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings

*afterwards check that C:\MinGW\bin is added to windows PATH (http://www.computerhope.com/issues/ch000549.htm)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

Note* Download the latest version inside this folders (Last tested to be OK is glib 2.28, non-dev version)):

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip
*http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime_0.18.1.1-2_win32.zip

=== Add pkg config path variable ===

Add the following line to the *top* of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run C:\MSys\1.0\msys.bat
*type the following commands:

cd /home/<username>/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe /bin
cp *.dll /bin
cd ..

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

Contribs are basically some precompiled 3rd party library (Here's a [[Contrib_Status|list]] of what they all are).

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page (just download the VLC repository--you don't need the x264 one) then skip the next section "Last Change"''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.x only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common (1.1.x only) ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by extracting who.exe, whoami.exe and hostname.exe from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/coreutils/coreutils-5.97-2/coreutils-5.97-2-msys-1.0.11-ext.tar.lzma/download and saving them to C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto search button:
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

If you want any custom options, like "--disable-lua" or anything of that nature, you'll need to edit that file directly instead of passing them in as parameters (at least currently that is required).

== Make (compile) ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

If this step fails, try the following
* Go back to "Precompiled contribs" section, and obtain the latest compiled contrib (under "Note for the brave")
* In the configure script section (configure-msys.sh), open that file and add --disable-upnp

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

Note that with the 1.2 branch these names have changed slightly. Run '
grep ':' Makefile | grep package-win32
to see what they are now.

= Troubleshooting =

See [[Win32CompileMSYSTroubleShooting]].

= See also =
*[[Win32CompileMSYSOld]] - deprecated documentation

Win32CompileMSYSNew

2010-07-06T10:37:12Z

Paulc0001: Troubleshooting: Fixing a few more build failures

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the '''fastest''' and '''recommended '''way to build VLC natively on Windows.

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

For those wishing to have a Notepad look-and-feel I recommend [http://sourceforge.net/projects/notepad2/ notepad2], which may tempt you to ditch Notepad altogether. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

== Unzip Utility ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

== Browser ==

Please install [http://www.getfirefox.com Mozilla Firefox] or another modern browser (NOT Internet Explorer)

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''Note for the brave : The steps advised below use a modified version of MinGW. If you feel like staying with the vanilla MinGW intead, use the main installer 5.1.6 found at http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/MinGW%205.1.6/MinGW-5.1.6.exe/download , then go through the wizard:''
:''* select "Downloading and Install"''
:''* select candidate release''
:''* select g++ and MinGW Make (in addition to the base system)''
:''Then, update Mingw GCC to 4.4.0 by downloading http://sourceforge.net/projects/mingw/files/GCC%20Version%204/gcc-full-4.4.0-mingw32-bin-2.tar.lzma/download and extracting it to C:\Mingw (replacing files when asked). Finally, you'll gave to fix the file C:\MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la by opening it and changing the line defining library_names so that it reads <code><nowiki>library_names=''</nowiki></code>''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.908.0/tdm-mingw-1.908.0-4.4.1-2.exe/download

Go through the wizard:

*unckeck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings (i.e. under the gcc node, "TDM Unstable: 4.4.1-tdm-2" should be selected)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip

=== Add pkg config path variable ===

Add the following line to the top of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run C:\MSys\1.0\msys.bat
*type the following commands:

cd ~/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe /bin
cp *.dll /bin
cd ..

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page then skip the next section.''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.0rc3 only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common 1.1.0rc3 only ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by extracting who.exe, whoami.exe and hostname.exe from http://sourceforge.net/projects/mingw/files/MSYS/coreutils/coreutils-5.97-2/coreutils-5.97-2-msys-1.0.11-ext.tar.lzma/download and saving them to C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto line 4740
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

== Compile ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

= Troubleshooting =

*It doesn't link, and complains about missing gcc symbols: You missed this line in the instructions:

Use text editor to change MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la file (line should be library_names='') due to bug in latest MinGW.''

*Compilation stops early, after configure was complaining about mismatched quotes:

Check the VLC_COMPILE_HOST variable in your config.h - if it's ''Option f is not valid'' then ''hostname -f'' fails (on Windows, there is no such option as -f). In configure.ac change
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])</pre>
to
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])</pre>
*If compile complains about a config.h and pthread.h not found problem, just delete config.h
*If building self-contained packages fails with ''make: zip: Command not found'' then download the following file and extract it to C:\Msys\1.0 :
*http://www.mirrorservice.org/sites/download.sourceforge.net/pub/sourceforge/m/project/mi/mingw/MSYS/zip/zip-3.0-1/zip-3.0-1-msys-1.0.14-bin.tar.lzma
*If building self-contained packages fails with ''make: 7z: Command not found'' then copy 7z.exe from C:\Program Files\7-Zip in to C:\Msys\1.0\bin
*If building self-contained packages fails with ''Error: cannot locate makensis tool'' then use:
<pre>PATH=/c/Program\ Files/NSIS/:$PATH make package-win32</pre>

Win32CompileMSYSNew

2010-07-05T14:40:25Z

Paulc0001: Correct full path name for file to edit

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the '''fastest''' and '''recommended '''way to build VLC natively on Windows.

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

For those wishing to have a Notepad look-and-feel I recommend [http://sourceforge.net/projects/notepad2/ notepad2], which may tempt you to ditch Notepad altogether. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

== Unzip Utility ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

== Browser ==

Please install [http://www.getfirefox.com Mozilla Firefox] or another modern browser (NOT Internet Explorer)

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''Note for the brave : The steps advised below use a modified version of MinGW. If you feel like staying with the vanilla MinGW intead, use the main installer 5.1.6 found at http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/MinGW%205.1.6/MinGW-5.1.6.exe/download , then go through the wizard:''
:''* select "Downloading and Install"''
:''* select candidate release''
:''* select g++ and MinGW Make (in addition to the base system)''
:''Then, update Mingw GCC to 4.4.0 by downloading http://sourceforge.net/projects/mingw/files/GCC%20Version%204/gcc-full-4.4.0-mingw32-bin-2.tar.lzma/download and extracting it to C:\Mingw (replacing files when asked). Finally, you'll gave to fix the file C:\MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la by opening it and changing the line defining library_names so that it reads <code><nowiki>library_names=''</nowiki></code>''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.908.0/tdm-mingw-1.908.0-4.4.1-2.exe/download

Go through the wizard:

*unckeck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings (i.e. under the gcc node, "TDM Unstable: 4.4.1-tdm-2" should be selected)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip

=== Add pkg config path variable ===

Add the following line to the top of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run C:\MSys\1.0\msys.bat
*type the following commands:

cd ~/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe /bin
cp *.dll /bin
cd ..

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page then skip the next section.''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.0rc3 only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common 1.1.0rc3 only ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by extracting who.exe, whoami.exe and hostname.exe from http://sourceforge.net/projects/mingw/files/MSYS/coreutils/coreutils-5.97-2/coreutils-5.97-2-msys-1.0.11-ext.tar.lzma/download and saving them to C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto line 4740
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

== Compile ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

= Troubleshooting =

*It doesn't link, and complains about missing gcc symbols: You missed this line in the instructions:

Use text editor to change MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la file (line should be library_names='') due to bug in latest MinGW.''

*Compilation stops early, after configure was complaining about mismatched quotes:

Check the VLC_COMPILE_HOST variable in your config.h - if it's ''Option f is not valid'' then ''hostname -f'' fails (on Windows, there is no such option as -f). In configure.ac change
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])</pre>
to
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])</pre>
*If compile complains about a config.h and pthread.h not found problem, just delete config.h

Win32CompileMSYSNew

2009-12-17T16:54:10Z

Paulc0001: Another package required for successful qt4 interface compilation

== Introduction ==

MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009.

== Install MinGW ==

Use the main installer 5.1.4 found at
http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/MinGW%205.1.4/MinGW-5.1.4.exe/download

Go through the wizard, selecting "Downloading and Install" and using the candidate release. Select gcc, g++ and MinGW make. It should download automatically:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

== Notes from December 2009 ==

Currently the MinGW installer adds mingwrt-3.17 which is not compatible with the precompiled contribs mentioned below. You should manually download and install 3.15 found at
http://sourceforge.net/projects/mingw/files/MinGW%20Runtime/mingwrt-3.15.2/mingwrt-3.15.2-mingw32-dev.tar.gz/download

The precompiled contribs also require gcc 4.2.1 found at
http://sourceforge.net/projects/mingw/files/GCC%20Version%204/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-core-4.2.1-sjlj-2.tar.gz/download
http://sourceforge.net/projects/mingw/files/GCC%20Version%204/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-g%2B%2B-4.2.1-sjlj-2.tar.gz/download

After downloading and unpacking those two files you can switch MinGW to use the new version with
mv /mingw/bin/c++.exe /mingw/bin/c++.345.exe
mv /mingw/bin/g++.exe /mingw/bin/g++.345.exe
mv /mingw/bin/g++-sjlj.exe /mingw/bin/g++.exe
mv /mingw/bin/g++-sjlj.exe /mingw/bin/c++.exe

It also needs
http://sourceforge.net/projects/mingw/files/GCC%20Version%204/Current%20Release_%20gcc-4.4.0/gcc-core-4.4.0-mingw32-dll.tar.gz/download
to be installed otherwise there are warnings about a libgcc_s_dw2-1.dll missing when it comes to compiling the qt4 interface.

== Install MSYS ==

* Install 7-zip and Mozilla Firefox
* Install MSys 1.0.11-rc1 with the exe: http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe
Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

=== AutoTools ===

Update your autoconf, automake and libtool by downloading and installing them, keeping in mind that you need to extract the content of the usr folder in C:\Msys
* http://sourceforge.net/projects/mingw/files/MSYS%20autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
* http://sourceforge.net/projects/mingw/files/MSYS%20automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
* http://sourceforge.net/projects/mingw/files/MSYS%20libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download

You can also compile them according to:
* http://wiki.enlightenment.org/index.php/EFL_Windows_XP
* http://www.mingw.org/wiki/msys

== Install other tools ==

http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz, extract it to mingw/bin.

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=== Install Git and checkout VLC ===

See [[Git_Windows]].

You can also retrieve the source code from [http://www.videolan.org/vlc/download-sources.html VideoLAN Project: VLC media player source code]

=== PKG-CONFIG ===

pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...

Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it to C:\Msys.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it to C:\Msys.

== Contribs ==

Take the precompiled contribs from:
http://people.videolan.org/~jb/Contribs/

Copy them in your ~
tar xvjf contrib-20090813-win32-bin-gcc-4.2.1-sjlj-runtime-3.15.2-only.tar.bz2 -C /
rm -v /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

== Bootstrap VLC ==

cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap
It should warn about gettext... Just ignore.

== Configure ==

sh extras/package/win32/configure-msys.sh
* If you downloaded a VLC source code tarball, retrieve ''configure-msys.sh'' and ''configure-common.sh'' from [[http://git.videolan.org/?p=vlc.git;a=summary vlc.git]] / extras / package / win32 /

== Compile ==

PATH=/usr/win32/bin:$PATH make
If you have Cygwin and others tools installed, try using a shorter PATH inside MSYS shell i.e.
$ echo $PATH
.:/usr/local/bin:/mingw/bin:/bin

==Creating self-contained packages==

Once the compilation is done, build self-contained VLC packages with the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

* If you have permissions problems running make package-*, chmod 777 -R the vlc folder.
* If you have permissions problems running vlc.exe after packaging, rename or delete vlc.exe.manifest

== Random bootstrap, configure, and make errors ==

There have been reports of random msys errors during bootstrap, configure, and make. They usually don't repeat themselves between runs. Rule out that your mingw-msys installation is at fault by building in windows safe mode. Even if this works, it may then be more practical to try a cross-compilation build.

Win32CompileMSYSNew

2009-12-17T15:53:12Z

Paulc0001: Notes about tool versions as at December 2009

== Introduction ==

MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009.

== Install MinGW ==

Use the main installer 5.1.4 found at
http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/MinGW%205.1.4/MinGW-5.1.4.exe/download

Go through the wizard, selecting "Downloading and Install" and using the candidate release. Select gcc, g++ and MinGW make. It should download automatically:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

== Notes from December 2009 ==

Currently the MinGW installer adds mingwrt-3.17 which is not compatible with the precompiled contribs mentioned below. You should manually download and install 3.15 found at
http://sourceforge.net/projects/mingw/files/MinGW%20Runtime/mingwrt-3.15.2/mingwrt-3.15.2-mingw32-dev.tar.gz/download

The precompiled contribs also require gcc 4.2.1 found at
http://sourceforge.net/projects/mingw/files/GCC%20Version%204/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-core-4.2.1-sjlj-2.tar.gz/download
http://sourceforge.net/projects/mingw/files/GCC%20Version%204/Previous%20Testing_%20gcc-4.2.1-sjlj%20-2/gcc-g%2B%2B-4.2.1-sjlj-2.tar.gz/download

After downloading and unpacking those two files you can switch MinGW to use the new version with
mv /mingw/bin/c++.exe /mingw/bin/c++.345.exe
mv /mingw/bin/g++.exe /mingw/bin/g++.345.exe
mv /mingw/bin/g++-sjlj.exe /mingw/bin/g++.exe
mv /mingw/bin/g++-sjlj.exe /mingw/bin/c++.exe

== Install MSYS ==

* Install 7-zip and Mozilla Firefox
* Install MSys 1.0.11-rc1 with the exe: http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe
Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

=== AutoTools ===

Update your autoconf, automake and libtool by downloading and installing them, keeping in mind that you need to extract the content of the usr folder in C:\Msys
* http://sourceforge.net/projects/mingw/files/MSYS%20autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
* http://sourceforge.net/projects/mingw/files/MSYS%20automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
* http://sourceforge.net/projects/mingw/files/MSYS%20libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download

You can also compile them according to:
* http://wiki.enlightenment.org/index.php/EFL_Windows_XP
* http://www.mingw.org/wiki/msys

== Install other tools ==

http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz, extract it to mingw/bin.

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=== Install Git and checkout VLC ===

See [[Git_Windows]].

You can also retrieve the source code from [http://www.videolan.org/vlc/download-sources.html VideoLAN Project: VLC media player source code]

=== PKG-CONFIG ===

pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...

Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it to C:\Msys.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it to C:\Msys.

== Contribs ==

Take the precompiled contribs from:
http://people.videolan.org/~jb/Contribs/

Copy them in your ~
tar xvjf contrib-20090813-win32-bin-gcc-4.2.1-sjlj-runtime-3.15.2-only.tar.bz2 -C /
rm -v /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

== Bootstrap VLC ==

cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap
It should warn about gettext... Just ignore.

== Configure ==

sh extras/package/win32/configure-msys.sh
* If you downloaded a VLC source code tarball, retrieve ''configure-msys.sh'' and ''configure-common.sh'' from [[http://git.videolan.org/?p=vlc.git;a=summary vlc.git]] / extras / package / win32 /

== Compile ==

PATH=/usr/win32/bin:$PATH make
If you have Cygwin and others tools installed, try using a shorter PATH inside MSYS shell i.e.
$ echo $PATH
.:/usr/local/bin:/mingw/bin:/bin

==Creating self-contained packages==

Once the compilation is done, build self-contained VLC packages with the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

* If you have permissions problems running make package-*, chmod 777 -R the vlc folder.
* If you have permissions problems running vlc.exe after packaging, rename or delete vlc.exe.manifest

== Random bootstrap, configure, and make errors ==

There have been reports of random msys errors during bootstrap, configure, and make. They usually don't repeat themselves between runs. Rule out that your mingw-msys installation is at fault by building in windows safe mode. Even if this works, it may then be more practical to try a cross-compilation build.