Difference between revisions of "Win32CompileMSYS"

From VideoLAN Wiki
Jump to navigation Jump to search
 
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Introduction  =
 
= Introduction  =
−
== About ==
+
[http://sourceforge.net/projects/msys2/ MSys2] is a helper environment for MinGW, the compiler chain for Windows based on GCC.
−
MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC.
 
  
−
It can build VLC natively on Windows. Note that you should probably [[Win32Compile|cross compile]] VLC from Linux, because it is faster, and feels easier.
+
It can build VLC natively on Microsoft Windows. However, VideoLAN developers '''strongly recommend''' [[Win32Compile|cross-compiling VLC from Linux]], which is faster and easier. If you decide to stick to the MSYS method, you are on your own. Should you encounter any problem and ask for help, expect to be told to cross-compile.
  
−
VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (4 hours is a minimum for the whole process) and don't despair if it doesn't work first time.
+
Either way, VLC is a complex program with many dependencies, most of which are obtained/built through the command line interface. Therefore, experience with the POSIX command line (i.e. the ''Unix shell'') is '''required'''.  
 +
Time, patience and persistence are indispensable. The entire process outlined below should take at the very least 4 hours. Experience show that mistakes are common, especially with beginners, so you might need to make multiple attempts.
  
−
This howto '''ONLY''' works  for VLC '''2.1.x'''!
+
= Install Windows tools =
−
 
 
−
Advanced users only: If you want to make your own MSYS environment, please use [[Win32CompileMSYSNew]]. If you don't understand this message, it is best to ignore this.
 
−
 
 
−
= Windows tools =
 
 
== Text editor  ==
 
== Text editor  ==
−
To edit unix-style text documents you need a suitable editor. Notepad is not enough.
+
To edit unix-style text documents you need a suitable editor: Notepad is not enough.
  
 
* Use [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.
 
* Use [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.
Line 24: Line 20:
 
A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.
 
A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.
  
−
= Prepare GNU on Windows =
+
= Install MSys2 and GCC =
−
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.  
+
Install MSys2 from http://msys2.github.io/
 +
 
 +
We recommend to use the 32bits version.
  
−
In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.  
+
Let the default, and run the command line.
  
−
== MinGW  ==
+
== Tools ==
−
=== TDM/MinGW Setup ===
+
Install the autotools suite:
 +
  pacman -S git subversion cvs automake autoconf libtool m4 make gettext pkg-config mingw-w64-i686-lua findutils mingw-w64-i686-headers yasm patch
  
−
Use the installer found at <strike>http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.7.1-2.exe/download</strike>http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.1006.0/tdm64-gcc-4.6.1.exe/download
+
=== gcc ===
 +
Download gcc from:
 +
[http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/4.9.2/threads-win32/sjlj/i686-4.9.2-release-win32-sjlj-rt_v3-rev0.7z/download mingw-w64].
  
−
Go through the wizard:
+
Unzip it to C:\MSys2\
−
* Disable "Check for updated files on the TDM-GCC server"
 
−
* Select "Create"
 
−
* Install to C:\MinGW
 
−
* Keep default settings
 
  
−
== MSys  ==
+
=== Restart ===
−
Use the MSys package found at http://people.videolan.org/~jb/msys/msys.7z
+
'''Exit MSys2, run ''autorebase.bat'' and re-run MSys2 from ''mingw32_shell.bat'''''
  
−
Un-7zip it to '''C:\MinGW\msys\'''.
+
== Check GCC ==
 +
Run
 +
gcc -v
  
−
The build is made exclusively from the command line, so execute '''C:\MinGW\msys\msys.bat''', then type the commands as mentioned.
+
And check that it says
 +
Thread model: win32
 +
gcc version 4.9.2 (i686-win32-sjlj-rev0, Built by MinGW-W64 project)
  
 
= Get VLC sources  =
 
= Get VLC sources  =
  
 
== Git ==
 
== Git ==
 +
<big>'''YOU MUST''' keep the native line-endings of the repo.</big>
 +
git config core.autocrlf=false
 +
 
Clone the git repo
 
Clone the git repo
−
cd ~
 
 
  git clone git://git.videolan.org/vlc.git
 
  git clone git://git.videolan.org/vlc.git
  
−
= Get configuration tools =
+
'''Nota Bene:''' ensure your Windows user name does not contain spaces so that the cloning folder of VLC will not not have spaces in it.
−
cd vlc/extras/tools
 
−
./bootstrap
 
−
make
 
−
 
 
−
export PATH=$PATH:$HOME/vlc/extras/tools/build/bin/
 
−
 
 
−
It should build ''autoconf, automake, libtool, pkg-config, cmake, yasm'' and ''ragel''.
 
−
 
 
−
'''Note:''' Ragel compilation can fail with gcc 4.7, ignore it.<br />
 
−
'''Note:''' check that all is well with autoconf --version
 
  
 
= Get precompiled 3rd party libraries =
 
= Get precompiled 3rd party libraries =
Line 71: Line 64:
 
  ../bootstrap --build=i686-w64-mingw32
 
  ../bootstrap --build=i686-w64-mingw32
 
  make prebuilt
 
  make prebuilt
−
cd ..
 
−
ln -sf i686-w64-mingw32 mingw32
 
  
−
export PATH=$PATH:$HOME/vlc/contrib/mingw32/bin/
 
−
export PKG_CONFIG_PATH=$HOME/vlc/contrib/mingw32/lib/pkgconfig
 
−
rm $HOME/vlc/contrib/mingw32/bin/moc $HOME/vlc/contrib/mingw32/bin/uic $HOME/vlc/contrib/mingw32/bin/rcc $HOME/vlc/contrib/mingw32/bin/luac
 
 
'''Note:''' check that all is well with moc -v
 
'''Note:''' check that all is well with moc -v
  
Line 88: Line 76:
 
  mkdir win32
 
  mkdir win32
 
  cd win32
 
  cd win32
−
  sh ../extras/package/win32/configure.sh --host=i586-pc-mingw32msvc --disable-nls
+
  sh ../extras/package/win32/configure.sh --host=i686-w64-mingw32 --disable-nls
  
 
'''Note:''' If you want any custom options, like "--disable-lua" or anything of that nature, you can append them.
 
'''Note:''' If you want any custom options, like "--disable-lua" or anything of that nature, you can append them.
Line 98: Line 86:
  
 
= Create packages  =
 
= Create packages  =
−
 
+
== Run VLC ==
 
Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:  
 
Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:  
  
 
  make package-win-common
 
  make package-win-common
  
−
(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).  
+
This will create a subdirectory named vlc-x.x.x with all the binaries with debugging symbols. You can run ./vlc.exe from there.
  
 +
== Create proper packages ==
 
  make package-win32-zip
 
  make package-win32-zip
  
Line 112: Line 101:
  
 
(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).
 
(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 =
 
= Troubleshooting =
Line 129: Line 114:
 
It was updated in July 2012 by gnosygnu. Note that there are several new notes in [[Win32CompileMSYSTroubleShooting]]. These reflect problems that were encountered on gnosygnu's setup (Windows XP SP3). Refer to this [http://forum.videolan.org/viewtopic.php?f=32&t=102843&sid=f58967215a83981dda030ff6efa3d493 forum thread] for more information.
 
It was updated in July 2012 by gnosygnu. Note that there are several new notes in [[Win32CompileMSYSTroubleShooting]]. These reflect problems that were encountered on gnosygnu's setup (Windows XP SP3). Refer to this [http://forum.videolan.org/viewtopic.php?f=32&t=102843&sid=f58967215a83981dda030ff6efa3d493 forum thread] for more information.
  
−
This howto was re-re-created by [[User:J-b|Jean-Baptiste Kempf]] in September 2012.
+
This howto was re-re-created by [[User:J-b|Jean-Baptiste Kempf]] in September 2012 and updated until 2015, with MSys2
  
 
= See also =
 
= See also =
Line 135: Line 120:
  
 
[[Category:Building]]
 
[[Category:Building]]
 +
[[Category:Windows]]

Latest revision as of 20:23, 15 February 2019

Introduction

MSys2 is a helper environment for MinGW, the compiler chain for Windows based on GCC.

It can build VLC natively on Microsoft Windows. However, VideoLAN developers strongly recommend cross-compiling VLC from Linux, which is faster and easier. If you decide to stick to the MSYS method, you are on your own. Should you encounter any problem and ask for help, expect to be told to cross-compile.

Either way, VLC is a complex program with many dependencies, most of which are obtained/built through the command line interface. Therefore, experience with the POSIX command line (i.e. the Unix shell) is required. Time, patience and persistence are indispensable. The entire process outlined below should take at the very least 4 hours. Experience show that mistakes are common, especially with beginners, so you might need to make multiple attempts.

Install Windows tools

Text editor

To edit unix-style text documents you need a suitable editor: Notepad is not enough.

  • Use notepad2. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

Unzip Utility (7-zip)

Files to downloaded will have to be uncompressed. Some of them use Unix originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will then need a versatile unzipping utility.

A recent version of 7-zip is therefore strongly advised.

Install MSys2 and GCC

Install MSys2 from http://msys2.github.io/

We recommend to use the 32bits version.

Let the default, and run the command line.

Tools

Install the autotools suite: 

 pacman -S git subversion cvs automake autoconf libtool m4 make gettext pkg-config mingw-w64-i686-lua findutils  mingw-w64-i686-headers yasm patch

gcc

Download gcc from: mingw-w64.

Unzip it to C:\MSys2\

Restart

Exit MSys2, run autorebase.bat and re-run MSys2 from mingw32_shell.bat

Check GCC

Run 

gcc -v

And check that it says 

Thread model: win32
gcc version 4.9.2 (i686-win32-sjlj-rev0, Built by MinGW-W64 project)

Get VLC sources

Git

YOU MUST keep the native line-endings of the repo. 

git config core.autocrlf=false

Clone the git repo 

git clone git://git.videolan.org/vlc.git

Nota Bene: ensure your Windows user name does not contain spaces so that the cloning folder of VLC will not not have spaces in it.

Get precompiled 3rd party libraries

cd vlc/contrib
mkdir win32 && cd win32
../bootstrap --build=i686-w64-mingw32
make prebuilt

Note: check that all is well with moc -v

Build VLC

Bootstrap

In VLC root folder, do: 

./bootstrap

Configure

mkdir win32
cd win32
sh ../extras/package/win32/configure.sh --host=i686-w64-mingw32 --disable-nls

Note: If you want any custom options, like "--disable-lua" or anything of that nature, you can append them.

Make (compile)

make -j4

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.

Create packages

Run VLC

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

make package-win-common

This will create a subdirectory named vlc-x.x.x with all the binaries with debugging symbols. You can run ./vlc.exe from there.

Create proper packages

make package-win32-zip

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

make package-win32-exe

(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).

Troubleshooting

See Win32CompileMSYSTroubleShooting.

Acknowledgements

This howto was re-created by 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

It was updated in July 2012 by gnosygnu. Note that there are several new notes in Win32CompileMSYSTroubleShooting. These reflect problems that were encountered on gnosygnu's setup (Windows XP SP3). Refer to this forum thread for more information.

This howto was re-re-created by Jean-Baptiste Kempf in September 2012 and updated until 2015, with MSys2

See also

Retrieved from "https://wiki.videolan.org/index.php?title=Win32CompileMSYS&oldid=58151"