Difference between revisions of "UnixCompile"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Regarless of the method: Typo regarless -> regardless)
 
(55 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 
== Prepare your environment  ==
 
== Prepare your environment  ==
  
VLC requires a C compiler, development headers and a toolchain. gcc will do but you could also use LLVM or proprietary C99/C++ compilers such as Intel's.
+
VLC requires a C11 compiler, development headers and a toolchain.
  
If you build from the [[Git]] repositories, you will also need the GNU build system, a.k.a. the "autotools" (autoconf, automake, libtool and gettext) to setup the Makefiles. Make sure they are up-to-date and usable for your system.
+
'''gcc''' (version 4.9 or later) is recommended, but '''clang/LLVM''' are known to work as well.
 +
 
 +
If you build from the [[Git]] repositories, you will also need the GNU build system, also known as the "autotools" (autoconf, automake, libtool and gettext) to setup the Makefiles. Make sure they are up-to-date and usable for your system.
  
 
On Fedora:
 
On Fedora:
  
  % sudo yum install git libtool
+
  {{$}} sudo yum install git libtool pkgconfig
 +
 
 +
On Debian or Ubuntu:
 +
 
 +
{{$}} sudo apt-get install git g++ make libtool automake autopoint pkg-config flex bison lua5.2
 +
 
 +
On Arch
 +
{{$}} sudo pacman -S base-devel git pkg-config autoconf automake
  
 
== Get the source  ==
 
== Get the source  ==
 
Start by [[GetTheSource|getting the source]], using FTP for official releases, or using [[Git]] to track VLC development.  
 
Start by [[GetTheSource|getting the source]], using FTP for official releases, or using [[Git]] to track VLC development.  
  
If your are using an official release, download source code, extract the archive and go into the resulting VLC directory, e.g.:
+
If you are using the [[Git]] development version, start by bootstrapping the source tree:
  % wget ftp://ftp.videolan.org/pub/videolan/vlc/1.1.11/vlc-1.1.11.tar.bz2
+
  {{$}} git clone git://git.videolan.org/vlc.git
  % tar xvjf vlc-1.1.11.tar.bz2
+
{{$}} cd vlc
% cd vlc-1.1.11
+
  {{$}} ./bootstrap
 +
Bootstrapping will fail if 'autotools' is missing or out-of-date.
  
If you are using the [[Git]] development version, start by bootstrapping the source tree:
+
If you are using an official release, download source code, extract the archive and go into the resulting VLC directory, e.g.:
  % cd vlc
+
  {{$}} wget ftp://ftp.videolan.org/pub/videolan/vlc/{{VLC:latest version}}/vlc-{{VLC:latest version}}.tar.xz
  % ./bootstrap
+
  {{$}} tar xvJf vlc-{{VLC:latest version}}.tar.xz
Bootstrapping will fail if the autotools are missing or out-of-date.
+
{{$}} cd vlc-{{VLC:latest version}}
  
 
== Get the third-party libraries  ==
 
== Get the third-party libraries  ==
Now you could configure the VLC build. But first, you need to make sure that all the required dependencies are in place. Take a look at <tt>./configure --help</tt>. Take a good look at that enormous list of options.
+
Now you can almost [[configure]] the VLC build. But first, you need to make sure that all the required dependencies are in place.
  
It is very important that you do install and enable all the 3rd party libraries that you need. Yes, there is going to be a lot of them if you want a complete or even mostly functional VLC build. If you fail to install a required library, you will end up with a VLC application that well..... essentially does not do anything useful. See [[Contrib Status|here]] for a complete list.
+
You must install and enable all the necessary underlying libraries. If you fail to install a required library, either the configure script or (more likely) you will end up with a crippled VLC program. Furthermore keep in mind that whilst build a program (in this case, VLC), you need to install the '''development packages''' (development header files and import libraries), not just the run-time libraries. On Debian/Ubuntu, the correct package names end with -dev. On RPM distributions, they usually end in -devel.
 
There are some very important dependencies: gettext (NLS) for international support (required), libdvbpsi for MPEG-TS files and streams support, libmad for MP3 audio decoding, libmpeg2 for MPEG1 and MPEG2 video support, FFmpeg or libav (libavcodec, libavformat, libpostproc, libswscale and optionally libavio) for MPEG4 and most other audio and video codecs, and many file formats, liba52 for Dolby (AC3) sound, dvdread and dvdnav for DVD playback, live555 for RTSP stream playback, etc.
 
  
For audio output, you will need probably alsa-lib (on [[Linux]]) and/or libpulse (for [[PulseAudio]]).
+
'''Be careful!''' If the libraries are not provided by your distribution, you may be better off linking VLC with them statically. See the "Contrib" method.
For video output, you will normally need XCB/XVideo and/or OpenGL/GLX.
 
And Qt4 is required to get the GUI support.
 
 
'''Note''' that you need to install the development packages (development header files and import libraries) to compile VLC, not just the run-time. On Debian/Ubuntu, the correct package names end with -dev. On RPM distributions, they usually end in -devel.
 
 
 
'''Be careful!''' If the libraries are not provided by your distribution, you may be better off linking VLC with them statically. Otherwise, you may encounter version problems if another multimedia application updates the libraries later. This is especially true of FFmpeg or libav, and live555.
 
  
 
There are a several ways to get those libraries. You should use only one method at a time:  
 
There are a several ways to get those libraries. You should use only one method at a time:  
 
   
 
   
 
=== The preferred method ===
 
=== The preferred method ===
Use your distribution packaging or portage system, in order to get all the needed libs.
+
 
 +
Installing the dependencies from the package or portage system is generally much easier and faster. However this only works if your distribution actually ships the necessary libraries. Otherwise, you may need to use the contribs method (see below). It is also possible to combine both methods, picking only the missing bits and pieces from contribs.
 +
 
 +
==== Debian ====
 
For example on Debian or Ubuntu:  
 
For example on Debian or Ubuntu:  
  # apt-get build-dep vlc
+
  {{$}} sudo apt-get build-dep vlc
  
 +
==== OpenSuSE ====
 
openSUSE users might have a look at the source-install (si) command in the zypper manpage:
 
openSUSE users might have a look at the source-install (si) command in the zypper manpage:
  # zypper si -d vlc
+
  {{$}} sudo zypper si -d vlc
  
=== The method for badly-behaved distributions ===
+
'''Note:''' To get the libraries, you must first add the VLC repositories to your system repositories.  
If your distribution does not provide the needed libraries,
+
For example in openSUSE:
or you really want to link VLC statically, use the VLC contribs system. It is included in the VLC source.
+
{{$}} sudo zypper ar http://download.videolan.org/pub/vlc/SuSE/<openSUSEversion> VLC
 +
You should replace <openSUSEversion> with the version of your system (12.1, 11.4, 11.3, 11.2 or 11.1)
  
First, you need to install the GNU autotools (if you have not already done so), CMake, subversion, Git and a recent GNU/tar utility or equivalent. Then you can run:
+
=== The "Contrib" method ===
% cd contrib
+
If your distribution does not provide the needed libraries or if you really need to link VLC statically, use the VLC contribs system, included in the VLC source.
% mkdir native
 
% cd native
 
% ../bootstrap
 
% make
 
  
'''Note''' the commands above are for VLC 1.2 or later. Details differ slightly for older versions:
+
First, you need to install the GNU autotools (if you have not already done so), CMake, subversion, Git and a recent GNU/tar utility or equivalent.
  % cd extras/contrib
+
{{prompt|root}} apt-get install subversion yasm cvs cmake ragel
  % ./bootstrap
+
 
  % make
+
Then you can run:
 +
  {{$}} cd contrib
 +
  {{$}} mkdir native
 +
{{$}} cd native
 +
{{$}} ../bootstrap
 +
  {{$}} make
  
 
That should download and build a lot of those libraries for you.  Unfortunately, given the large number of libraries and the variety of the platforms people build VLC for, it is not unlikely that you will hit an error while contribs are compiling. Thus, this approach is only recommended for experienced Unix compilers.
 
That should download and build a lot of those libraries for you.  Unfortunately, given the large number of libraries and the variety of the platforms people build VLC for, it is not unlikely that you will hit an error while contribs are compiling. Thus, this approach is only recommended for experienced Unix compilers.
  
'''For 1.2 or later''': If you want to compile only a few select libraries instead of everything, you can run e.g.:
+
=== Regardless of the method ===
% cd contrib
+
In any case, some basic OS support libraries are not included and must really be installed through the packaging system in any case, notably [[ALSA]], [[PulseAudio]] and OpenGL.
% mkdir native
 
% cd native
 
% ../bootstrap
 
% make .orc .schroedinger .x264 .ffmpeg
 
  
Note the dot in front of each target name; otherwise the target names are the same as the directory names in ''contrib/src/''. Note however that some of the libraries may depend on others; for example ''schroedinger'' depends on ''orc''. When compiling single libraries like this, you will have to fulfill the dependencies manually by compiling the libraries in the right order.
+
== Configuration  ==
 +
<code>./configure</code> is used to check whether your system is able to compile VLC. Also you can choose the features in your build. As a reminder, this command will show the various options:
 +
{{$}} ./configure --help
  
When building manually (regardless of VLC version or whether you're building everything or just a few libraries), you can also use standard make flags such as -jN for multicore (where N is the number of processes to use). Examples:
+
For most users, <code>./configure</code> does not require any command-line options.
% # everything
 
% make -j2
 
% # chosen libraries only
 
% make -j2 .orc .schroedinger .x264 .ffmpeg
 
would use two processes for compiling.
 
  
=== The method for people with too much time to waste ===
+
By default, features to be compiled are chosen automatically depending on what libraries are detected as available. If the contribs have been compiled first, the resulting VLC will be reasonably functional.
Read the [[Contrib Status|list]], download them and build them by hand.
 
  
=== Regardless of the method ===
+
Note that libraries that are not in the default prefix, and not in vlc contribs, must be known to pkg-config in order for <code>./configure</code> to find them. Use ''PKG_CONFIG_PATH'' for this.
In any case, some basic OS support libraries are not included and must really be installed through the packaging system in any case, notably [[ALSA]], [[PulseAudio]] and [[OpenGL]].
 
  
== Configuration  ==
+
There are some features that are disabled (not compiled) by default. If you want them, they must be forced on by using configure flags. You can find a list of these features by searching for "disabled" in <code>./configure --help</code>.
You probably need to tweak the "configure" line.  
 
 
 
<tt>./configure</tt> is used to check whether your system is able to compile VLC. Also you can choose the features in your build. As a reminder, this command will show the various options:
 
% ./configure --help
 
 
=== Special libs  ===
 
Use <tt>--with-live555-path=path/to/livemedia/source/tree</tt> in connection with <tt>--enable-live555</tt>. For FFmpeg or libav, pkg-config is the only reliable way for VLC's configure to find the libraries. So you need to set PKG_CONFIG_PATH correctly if your FFmpeg/libav libraries are not installed at the default prefix (meaning /usr) or you want to use static linking.
 
  
=== Final configuration ===
+
=== Prefix ===
 
If you want to install VLC into another directory, run  
 
If you want to install VLC into another directory, run  
 
   
 
   
  % ./configure --prefix=/path/to/install/folder/
+
  {{$}} ./configure --prefix=/path/to/install/folder/
 
 
This is an example of a typical VLC configure line:
 
 
% ./configure --enable-x11 --enable-xvideo --enable-sdl --enable-avcodec --enable-avformat \
 
  --enable-swscale --enable-mad --enable-libdvbpsi --enable-a52 --enable-libmpeg2 --enable-dvdnav \
 
  --enable-faad --enable-vorbis --enable-ogg --enable-theora --enable-faac --enable-mkv --enable-freetype \
 
  --enable-fribidi --enable-speex --enable-flac --enable-live555 --with-live555-tree=/usr/lib/live \
 
  --enable-caca --enable-skins --enable-skins2 --enable-alsa --enable-qt4 --enable-ncurses
 
 
[[User:J-b#VLC_configure_line|Here]] is another.
 
 
 
=== Ubuntu ===
 
  
If you get continuous errors while ./configure then consider reinstalling the corresponding libraries. This will set the paths and other information correctly. Check the $PKG_CONFIG_PATH(environment variable) whether it is set to a path where the libraries like libavcodec.pc are available. Otherwise create the environment variable, export it and then update the ldconfig.
+
You can find example of configure in the [[Configure]] page of this wiki.
  
 
== Compilation ==
 
== Compilation ==
 
Compile VLC:  
 
Compile VLC:  
  % make
+
  {{$}} make
  
 
You do not need to install VLC to use it. You can also simply run it from the build directory:
 
You do not need to install VLC to use it. You can also simply run it from the build directory:
  # ./vlc
+
  {{prompt|root}} ./vlc
  
 
If you really want to install VLC to the system, run this as root:
 
If you really want to install VLC to the system, run this as root:
  # make install
+
  {{prompt|root}} make install
  
 
You can uninstall later with this, but you need to keep the build tree untouched until then:
 
You can uninstall later with this, but you need to keep the build tree untouched until then:
  # make uninstall
+
  {{prompt|root}} make uninstall
  
 
To remove files created during the compile (optional) type:
 
To remove files created during the compile (optional) type:
  % make clean
+
  {{$}} make clean
 
 
== Notes ==
 
 
 
=== Cygwin ===
 
 
 
Compiling on [[Win32CompileCygwin|Cygwin]] may be broken from time to time as Cygwin packages change.
 
We recommend [[Win32Compile|cross-compiling from Linux to Windows]] instead. '''Consider yourself warned.'''
 
 
 
=== Debian/Ubuntu ===
 
Debian users who want to compile VLC should install the packages below:
 
*[http://packages.debian.org/unstable/libdevel/libavcodec-dev libavcodec-dev]
 
*[http://packages.debian.org/unstable/libdevel/libpostproc-dev libpostproc-dev]
 
*[http://packages.debian.org/unstable/libdevel/libmpeg2-4-dev libmpeg2-4-dev]
 
 
 
If you just want to ''use'' VLC media player then simply install the package vlc (<tt>sudo apt-get install vlc</tt>) - the unstable version is fairly up-to-date most of the time, while the stable is, err, stable and very old&nbsp;;-)
 
  
 
== Troubleshooting / common problems ==
 
== Troubleshooting / common problems ==
Line 152: Line 117:
  
 
On Debian/Ubuntu:
 
On Debian/Ubuntu:
  % sudo apt-get install lua5.1
+
  {{$}} sudo apt-get install lua5.1
  
 
On Fedora:
 
On Fedora:
  % sudo yum install lua
+
  {{$}} sudo yum install lua
  
 
=== XCB ===
 
=== XCB ===
Line 162: Line 127:
  
 
To install these libraries run the following commands (Debian/Ubuntu):
 
To install these libraries run the following commands (Debian/Ubuntu):
  % sudo apt-get install libxcb-shm0-dev libxcb-xv0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-composite0-dev
+
  {{$}} sudo apt-get install libxcb-shm0-dev libxcb-xv0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-composite0-dev
  
 
Under Fedora:
 
Under Fedora:
  % sudo yum install libxcb-devel xcb-util-devel
+
  {{$}} sudo yum install libxcb-devel xcb-util-devel
  
 
For OpenGL (Debian/Ubuntu only), you will additionally need XLib with XCB:
 
For OpenGL (Debian/Ubuntu only), you will additionally need XLib with XCB:
  % sudo apt-get install libx11-xcb-dev
+
  {{$}} sudo apt-get install libx11-xcb-dev
  
 
If your distribution provides a version of XLib without XCB, then this later package will not be available. So you will not be able to use OpenGL. Use XVideo instead.
 
If your distribution provides a version of XLib without XCB, then this later package will not be available. So you will not be able to use OpenGL. Use XVideo instead.
 +
 +
=== Compile fails after git pull ===
 +
 +
It is likely that the sources in the repository have changed significantly since they were last pulled, and a build system cache has gone out of date. Try the troubleshooting methods described in the [[Hacker_Guide/How_To_Write_a_Module#Module_load_troubleshooting|hacker guide for modules]].
  
 
[[Category:Building]]
 
[[Category:Building]]
 +
[[Category:GNU/Linux]]

Latest revision as of 17:06, 19 March 2022

Prepare your environment

VLC requires a C11 compiler, development headers and a toolchain.

gcc (version 4.9 or later) is recommended, but clang/LLVM are known to work as well.

If you build from the Git repositories, you will also need the GNU build system, also known as the "autotools" (autoconf, automake, libtool and gettext) to setup the Makefiles. Make sure they are up-to-date and usable for your system.

On Fedora:

$ sudo yum install git libtool pkgconfig

On Debian or Ubuntu:

$ sudo apt-get install git g++ make libtool automake autopoint pkg-config flex bison lua5.2

On Arch

$ sudo pacman -S base-devel git pkg-config autoconf automake

Get the source

Start by getting the source, using FTP for official releases, or using Git to track VLC development.

If you are using the Git development version, start by bootstrapping the source tree:

$ git clone git://git.videolan.org/vlc.git
$ cd vlc
$ ./bootstrap

Bootstrapping will fail if 'autotools' is missing or out-of-date.

If you are using an official release, download source code, extract the archive and go into the resulting VLC directory, e.g.:

$ wget ftp://ftp.videolan.org/pub/videolan/vlc/3.0.12/vlc-3.0.12.tar.xz
$ tar xvJf vlc-3.0.12.tar.xz
$ cd vlc-3.0.12

Get the third-party libraries

Now you can almost configure the VLC build. But first, you need to make sure that all the required dependencies are in place.

You must install and enable all the necessary underlying libraries. If you fail to install a required library, either the configure script or (more likely) you will end up with a crippled VLC program. Furthermore keep in mind that whilst build a program (in this case, VLC), you need to install the development packages (development header files and import libraries), not just the run-time libraries. On Debian/Ubuntu, the correct package names end with -dev. On RPM distributions, they usually end in -devel.

Be careful! If the libraries are not provided by your distribution, you may be better off linking VLC with them statically. See the "Contrib" method.

There are a several ways to get those libraries. You should use only one method at a time:

The preferred method

Installing the dependencies from the package or portage system is generally much easier and faster. However this only works if your distribution actually ships the necessary libraries. Otherwise, you may need to use the contribs method (see below). It is also possible to combine both methods, picking only the missing bits and pieces from contribs.

Debian

For example on Debian or Ubuntu:

$ sudo apt-get build-dep vlc

OpenSuSE

openSUSE users might have a look at the source-install (si) command in the zypper manpage:

$ sudo zypper si -d vlc

Note: To get the libraries, you must first add the VLC repositories to your system repositories. For example in openSUSE:

$ sudo zypper ar http://download.videolan.org/pub/vlc/SuSE/<openSUSEversion> VLC

You should replace <openSUSEversion> with the version of your system (12.1, 11.4, 11.3, 11.2 or 11.1)

The "Contrib" method

If your distribution does not provide the needed libraries or if you really need to link VLC statically, use the VLC contribs system, included in the VLC source.

First, you need to install the GNU autotools (if you have not already done so), CMake, subversion, Git and a recent GNU/tar utility or equivalent.

# apt-get install subversion yasm cvs cmake ragel

Then you can run:

$ cd contrib
$ mkdir native
$ cd native
$ ../bootstrap
$ make

That should download and build a lot of those libraries for you. Unfortunately, given the large number of libraries and the variety of the platforms people build VLC for, it is not unlikely that you will hit an error while contribs are compiling. Thus, this approach is only recommended for experienced Unix compilers.

Regardless of the method

In any case, some basic OS support libraries are not included and must really be installed through the packaging system in any case, notably ALSA, PulseAudio and OpenGL.

Configuration

./configure is used to check whether your system is able to compile VLC. Also you can choose the features in your build. As a reminder, this command will show the various options:

$ ./configure --help

For most users, ./configure does not require any command-line options.

By default, features to be compiled are chosen automatically depending on what libraries are detected as available. If the contribs have been compiled first, the resulting VLC will be reasonably functional.

Note that libraries that are not in the default prefix, and not in vlc contribs, must be known to pkg-config in order for ./configure to find them. Use PKG_CONFIG_PATH for this.

There are some features that are disabled (not compiled) by default. If you want them, they must be forced on by using configure flags. You can find a list of these features by searching for "disabled" in ./configure --help.

Prefix

If you want to install VLC into another directory, run

$ ./configure --prefix=/path/to/install/folder/

You can find example of configure in the Configure page of this wiki.

Compilation

Compile VLC:

$ make

You do not need to install VLC to use it. You can also simply run it from the build directory:

# ./vlc

If you really want to install VLC to the system, run this as root:

# make install

You can uninstall later with this, but you need to keep the build tree untouched until then:

# make uninstall

To remove files created during the compile (optional) type:

$ make clean

Troubleshooting / common problems

Lua

You may need to install Lua if you get "LUA byte compiler missing." message. You namely need to install "luac", the Lua byte compiler.

On Debian/Ubuntu:

$ sudo apt-get install lua5.1

On Fedora:

$ sudo yum install lua

XCB

VLC 1.1 and later requires XCB libraries to deal with X11 displays. Do not disable XCB or you will not get any video support!

To install these libraries run the following commands (Debian/Ubuntu):

$ sudo apt-get install libxcb-shm0-dev libxcb-xv0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-composite0-dev

Under Fedora:

$ sudo yum install libxcb-devel xcb-util-devel

For OpenGL (Debian/Ubuntu only), you will additionally need XLib with XCB:

$ sudo apt-get install libx11-xcb-dev

If your distribution provides a version of XLib without XCB, then this later package will not be available. So you will not be able to use OpenGL. Use XVideo instead.

Compile fails after git pull

It is likely that the sources in the repository have changed significantly since they were last pulled, and a build system cache has gone out of date. Try the troubleshooting methods described in the hacker guide for modules.