Difference between revisions of "MacOSCompile"

From VideoLAN Wiki
Jump to navigation Jump to search
(→‎Compile VLC on Mac OS X: VLC project use Git now)
 
(229 intermediate revisions by 26 users not shown)
Line 1: Line 1:
== Compile VLC on Mac OS X ==
+
{{Lowercase}}
 +
This is an '''howto''' to compile {{VLC}} on '''macOS''' ''(formerly known as Mac OS X)'', focused on '''VLC 3.0''' and later.
  
Compiling {{VLC}} on Mac OS X is different from normal linux compiling and OS X compiling. We do not use Xcode, but a simple <code>./configure</code> and then <code>make</code> isn't enough either. The instructions below are always for the currently unstable, non-released code.
+
= Pre-requisites  =
  
If you compile from [[Git]] then please remember that this code can often be in an unstable state. If you wish to develop or test please join the vlc-devel mailinglist.
+
=== Apple Software ===
  
Don't put any of the non-released test binaries or git-compiles on software sites or on user-forums. We have had bad experiences with this before and we do not appreciate it.
+
Those are the minimum build system requirements to compile VLC 4.0 (current development version). They are also highly recommended to compile VLC 3.0:
 +
* At least '''macOS 10.13.4''', or any later version
 +
* At least '''Xcode 9.3''' from [https://developer.apple.com/xcode/ developer.apple.com/xcode]. (Note: Installing the developer tools package is not needed, and building with that package is not supported)
 +
* Use at least '''macOS SDK 10.13''' (this is included and the default in Xcode 9.3)
 +
* Install python3 (macOS pkg installer from python.org)
 +
* Java 8 JDK (needed to compile Java menu support for blurays)
  
''Be sure to read the paragraph on Mac OS X Leopard before starting the compilation.''
+
==== Compiler test  ====
  
== Steps ==
+
Ensure the compiler is found correctly by running
  
Please follow these steps for compiling:
+
xcrun clang
  
=== Set the development environment ===
+
in the Terminal, if this outputs anything else than <code>clang: error: no input files</code>, see the troubleshooting part of this document.
  
Install the Mac OS X Developer Tools from the Developer Tools CD, or get them online.
+
==== Developer directory test ====
  
You need at least Mac OS X 10.4.x and Xcode 2.4.x for compilation. Mac OS X 10.5 and Xcode 3.x are also supported.
+
The Xcode developer directory must be used, not the command line tools developer directory, as only Xcode includes all necessary tools.
  
Compiling with earlier releases of Mac OS X and/or Xcode will not work.
+
Run the following command in Terminal:
  
Additionally, you may need to install Subversion aka SVN and Git on your Mac.
+
xcode-select --print-path
  
=== Get the source ===
+
It needs to print out the path to your Xcode installation, like this
Download the {{VLC}} [[GetTheSource|source code]] (using [[Git]]) as described on the [[GetTheSource| "Get the source"]] page or get a recent source tarball. Note that the 3rd party libraries will probably break a few months after the release's publication.
 
  
=== Build external libs ===
+
/Applications/Xcode.app/Contents/Developer
  
We now need to build the [[Contrib_Status| 3rd party libs]]. For that, you will need to:
+
If it prints out a path to the command line tools package, select the correct path using the xcode-select tool. See [https://wiki.videolan.org/OSXCompile/#Xcode_.27No_developer_directory.27_error here] for the correct command.
* cd to the source directory with your Terminal application.
 
* If you have fink, then you will need to disable it. {{VLC}} has it's own form of Fink (in the extras/contrib subdir) and it can conflict with Fink. We use this system to generate a reliable, consistent and known amount of packages that {{VLC}} requires.  
 
  
''To disable Fink comment the line: #source /sw/bin/init.csh in your .cshrc file or . /sw/bin/init.csh in your .bashrc file in your home-directory.''
+
= [[GetTheSource|Get the source code]]  =
  
* cd to the extras/contrib subdir of VLC and execute <code>./bootstrap</code>
+
git clone git://git.videolan.org/vlc.git
* Now execute <code>make</code>.
 
  
This will download prebuilt binary contrib you can happily use to build VLC wth -- only if you're using git master branch.
+
= Build VLC with a single command  =
 +
This is the most simple way to build VLC, including all its necessary dependencies. This way is highly recommended to use, as it sets up everything automatically.
  
If you're trying to build some release from 0.9 series, you need to execute:
+
Setup a build folder:
 +
cd vlc && mkdir build && cd build
  
<code>make src</code>
+
And run the build:
 +
../extras/package/macosx/build.sh -c
  
This will download and compile all the required external libraries and programs. You will only have to do this once. (You can do it again if required libraries are added or updated by the team.)
+
The command line switch -c rebuilds all dependencies (contribs) from source. If you want to use a prebuild contrib package, omit the -c option.
  
''Note that the 10.4u SDK is required for the default compilation of this contributed code. If you encounter problems, make sure that your default GCC version is set to 4 and your Xcode installation's version is 2.4.x or 3.x. If bootstrap exits with an error message on Mac OS X Leopard, check the paragraph on this version below.''
+
Wait and you have finished.
  
=== Prepare the VLC build ===
+
You can see more options for this script (change arch or sdk):
Now we return to VLC itself. Go back to the top level VLC source directory. If you use Subversion (which you really should), then run <code>./bootstrap</code>.  
+
../extras/package/macosx/build.sh -h
  
This will create configure and Makefiles for {{VLC}} (snapshots and releases already include this).
+
In case this fails, please try the step-by-step build guide below using a
 +
clean checkout.
  
=== Configure the VLC build ===
+
== Making changes and compile again ==
  
The next step is to configure, in the top level VLC source directory.
+
Using build.sh is the recommended way to do a fresh VLC build. Now, if you did some changes to the VLC source code, you can try to compile the change by calling build.sh again. But sometimes this is a bit cubersome, as it might take longer, and sometimes its preferred to execute some build commands directly.
  
In current trunk revisions, you can simply run <code>./configure --enable-debug --with-macosx-sdk=/Developer/SDKs/MacOSX10.4u.sdk</code> to get VLC in its default configuration. If do not want to use VLC's default configuration for Mac, be sure to add <code>--disable-macosx-defaults</code> to your custom set.
+
For that reason, a script called env.build.sh is included in VLC (starting with VLC 4.0 in vlc.git), which helps you setting the correct environment of your Terminal. The correct environment is needed, to make sure the right internal tools are used for the build process.
  
When compiling earlier revisions or the 0.8.6 branch, you need to give a wide variety of configure flags to achieve a useful build. We used to use this set:
+
Before you compile again with make, just source this script into the current Terminal (pay attention to the dot at the front of the command):
<code> ./configure --enable-debug --disable-x11 --disable-xvideo --disable-glx --enable-sdl --enable-mad --enable-libdvbpsi --enable-a52 --disable-dvdplay --enable-dvdnav --enable-dvdread --enable-ffmpeg --enable-faad --enable-flac --enable-vorbis --enable-speex --enable-theora --enable-ogg --enable-shout --enable-cddb --disable-cddax --enable-vcdx --disable-skins --disable-skins2 --disable-wxwidgets --enable-freetype --enable-fribidi --enable-caca --enable-live555 --enable-dca --enable-goom --enable-modplug --enable-gnutls --enable-daap --enable-ncurses --enable-libtwolame --enable-x264 --enable-png --enable-realrtsp --enable-lua --disable-libtool</code>
+
. ../extras/package/macosx/env.build.sh
  
You can add <code>--with-mozilla-sdk-path=./extras/contrib/src/gecko-sdk --enable-mozilla</code> to the configure-line to enable the compilation of VLC's Safari/Firefox plugin.
+
You can also create a symlink to that script in a more convenient location, for instance into the main vlc checkout directory:
 +
# change directory to root git checkout
 +
ln -s $PWD/extras/package/macosx/env.build.sh
 +
cd build # go back to your build directory
 +
. ../env.build.sh
  
=== Build VLC ===
+
Afterwards, in the same terminal, you can recompile by using the usual commands like make:
After configure is finished, we can finally build {{VLC}}. A simple <code>make</code> will do the trick. If you want to use the resulting application package on a different Mac or a different account on the same Mac, run <code>make VLC-release.app</code> afterwards. Use the resulting ''VLC-release.app'' for these purposes.
+
make
 +
./bin/vlc-osx-static -vv # To test compiled changes
  
=== Special apostille on Mac OS X Leopard ===
+
= Build steps =
Starting with Leopard, Xcode may be installed to a custom location on the administrator's choice. While this is non-problematic for ordinary Xcode projects, VLC needs a little help. You have to place extra symbolic links in /Developer pointing to your custom location for these folders:
+
Now, if you prefer, you can read the following detailed information on how the build internally works. This section describes all steps which are internally done in build.sh already. Likely, they are only relevant to you if you do not want to use build.sh and env.build.sh.
  
<code>usr, Headers, Private, SDKs, Tools, Makefiles</code>
+
== Additional development tools  ==
  
You can easily create these links by executing the following command for each folder (whereas theFolder is one of these six):
+
You need a number of tools, notably all the autotools, to build VLC correctly.
 +
VLC has a way to build the specific versions of these tools required from source, here is how:
 +
 +
cd extras/tools
 +
./bootstrap && make
 +
cd ../..
  
<code>ln -s /full/path/to/Developer/theFolder /Developer/theFolder</code>
+
'''Important''': Add the extras/tools build results to your PATH, before doing anything else:
 +
export PATH=$PWD/extras/tools/build/bin:$PATH
  
 +
== Prepare [[Contrib Status|3rd party libraries]]  ==
  
== History ==
+
To compile VLC, you need lots of other libraries, called 3rd party. VLC has the so-called “contribs” system to help building these libraries
Written by Jean-Alexis Montignies, [[User:Fkuehne|Felix Paul Kühne]] and Derk-Jan Hartman, for the VideoLAN Team.
+
from source. Alternatively you can use a pre-built package of these libraries provided by VideoLAN.
Adapted to the Wiki by [[User:j-b|Jean-Baptiste Kempf]].
+
 
 +
<!--
 +
FIXME: Add guide how to use pre-built nightly contribs:
 +
 
 +
=== Using pre-built nightly contribs ===
 +
Together with the nightly builds, the build bot does each night a new build of all of the 3rd party libraries required for VLC.
 +
(Not all contribs are included in this pre-built package, as not all contribs are enabled on all OSes and required.)
 +
-->
 +
 
 +
First, set the correct '''SDK''' version for the 3rd party libraries, usually your current OS X Version:
 +
 
 +
export OSX_VERSION=10.11
 +
 
 +
Then, prepare the 3rd party library folder:
 +
 
 +
mkdir -p contrib/contrib-osx &amp;&amp; cd contrib/contrib-osx
 +
../bootstrap --build=x86_64-apple-darwin15
 +
 
 +
=== Prebuilt libraries (recommended) ===
 +
 
 +
If you want to download a prebuilt package of all the needed libraries.
 +
 
 +
make prebuilt
 +
 
 +
Now you can just skip to the [[OSXCompile#Update_PATH|Update PATH]] section.
 +
 
 +
=== Build your own libraries (not for the faint-hearted) ===
 +
You need to install the [http://www.oracle.com/technetwork/pt/java/javase/downloads/index.html Java JDK], to support java code for libbluray.
 +
 
 +
If you want to build contribs from source, you first need to make gettext, which is needed for some other contrib libraries to build:  
 +
 
 +
make -j4 .gettext
 +
 
 +
Now you need to update your path for the gettext tools to be usable later on, see the [[#Update_PATH|Update PATH]] section above.
 +
 
 +
Then fetch contrib sources:
 +
 
 +
make fetch
 +
 
 +
and build them with:
 +
 
 +
make
 +
 
 +
If you had no errors, the 3rd party libraries (contrib) are built correctly and you can proceed to the next step.
 +
 
 +
=== Update PATH  ===
 +
 
 +
First we go back to the source directory:
 +
 
 +
cd ../..
 +
 
 +
And now we still need to add the contribs to our path, so they can be found:
 +
 
 +
export PATH=$PWD/contrib/x86_64-apple-darwin15/bin:$PATH
 +
 
 +
== Bootstrap VLC  ==
 +
 
 +
This will create the configure script:
 +
 
 +
./bootstrap
 +
 
 +
Check that there are no obvious errors at this stage, like missing gettext or an error at exit.
 +
 
 +
== Configure the VLC build  ==
 +
 
 +
Create a build folder:
 +
 
 +
mkdir -p build &amp;&amp; cd build
 +
 
 +
To list the different options of configure:
 +
 
 +
../extras/package/macosx/configure.sh --help
 +
 
 +
To build a binary with the previously installed x86_64-apple-darwin15 contrib:
 +
 
 +
../extras/package/macosx/configure.sh --enable-debug --host=x86_64-apple-darwin15
 +
 
 +
By default it will not use the installed SDK, like Xcode does, but use System Root. This means that if you built contribs on your own, the configure script might behave unexpectedly, for example enabling functions which are not present in a given operating system version. To work around this and build against the latest installed SDK, you can use:
 +
 
 +
--with-macosx-sdk=`xcrun --show-sdk-path`
 +
 
 +
If you want to use a different SDK, you can list all installed SDKs with <code>xcodebuild -showsdks</code> and to get the path for it, you can use the following command <code>xcodebuild -version <SDK Flag from before> Path</code>.<br />
 +
For example: <code>xcodebuild -version -sdk macosx10.11 Path</code>
 +
 
 +
== Build VLC  ==
 +
 
 +
Just do:
 +
make -j4
 +
 
 +
and wait...
 +
 
 +
== Run VLC  ==
 +
After <code>make</code>, you can just run VLC like so:
 +
 
 +
./bin/vlc-osx-static
 +
 
 +
If you want a VLC app bundle, just do
 +
 +
make VLC.app
 +
 
 +
And use it like a normal .app bundle.
 +
 
 +
== Package VLC Application for Mac  ==
 +
 
 +
If you want a disk-image:
 +
 
 +
make package-macosx
 +
 
 +
Note: If you want a more fancy disk image, you need the [https://bitbucket.org/al45tair/dmgbuild dmgbuild] tool, which can be installed using <code>pip install dmgbuild</code> if you have
 +
python installed using [https://brew.sh Homebrew].
 +
 
 +
== Sign VLC Application for Mac  ==
 +
 
 +
If you want to sign your application with a certificate, for example for Gatekeeper, you need to run:
 +
 
 +
extras/package/macosx/codesign.sh -i "certificate name"
 +
 
 +
= Troubleshooting  =
 +
 
 +
== 3rd party packagers and PATH  ==
 +
 
 +
'''Pay careful attention to remove any reference to 3rd party package managers from your environment.''' This is important to avoid conflicts between your package manager (homebrew, fink, macports...) and the contrib package manager we use to build our contrib.
 +
 
 +
It shouldn't be necessary, but it can happen.
 +
 
 +
'''git must still be accessible though!'''
 +
 
 +
unset PKG_CONFIG_PATH
 +
unset PKG_CONFIG_LIBDIR
 +
export PATH=$PWD/build/bin:/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin
 +
 
 +
== Xcode 'No developer directory' error ==
 +
When running <code>xcrun clang</code>, if you see
 +
 
 +
Error: No developer directory...
 +
 
 +
then use xcode-select to select the developer directory within the Xcode package, to point to your xcode developer directory.
 +
 
 +
something like:
 +
 
 +
sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer 
 +
 
 +
== Xcode tooling tries to use SDK in CommandLineTools directory ==
 +
Occasionally it has been reported that Xcode tooling tries to compile with an SDK located under the .../Developer/CommandLineTools directory, even if Xcode.app is properly installed and a suitable SDK is available inside the app.
 +
 
 +
This problem might become visible with a similar error like this:
 +
error: SDK "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk" cannot be located.
 +
 
 +
The root cause of this issue is now known yet and likely lies inside the apple provided tooling. One known workaround is to delete or move away the CommandLineTools directory.  
  
 
[[Category:Building]]
 
[[Category:Building]]
[[Category:Coding]]
+
[[Category:macOS]]

Latest revision as of 19:20, 17 June 2020

This is an howto to compile VLC media player on macOS (formerly known as Mac OS X), focused on VLC 3.0 and later.

Pre-requisites

Apple Software

Those are the minimum build system requirements to compile VLC 4.0 (current development version). They are also highly recommended to compile VLC 3.0:

  • At least macOS 10.13.4, or any later version
  • At least Xcode 9.3 from developer.apple.com/xcode. (Note: Installing the developer tools package is not needed, and building with that package is not supported)
  • Use at least macOS SDK 10.13 (this is included and the default in Xcode 9.3)
  • Install python3 (macOS pkg installer from python.org)
  • Java 8 JDK (needed to compile Java menu support for blurays)

Compiler test

Ensure the compiler is found correctly by running

xcrun clang

in the Terminal, if this outputs anything else than clang: error: no input files, see the troubleshooting part of this document.

Developer directory test

The Xcode developer directory must be used, not the command line tools developer directory, as only Xcode includes all necessary tools.

Run the following command in Terminal:

xcode-select --print-path

It needs to print out the path to your Xcode installation, like this

/Applications/Xcode.app/Contents/Developer

If it prints out a path to the command line tools package, select the correct path using the xcode-select tool. See here for the correct command.

Get the source code

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

Build VLC with a single command

This is the most simple way to build VLC, including all its necessary dependencies. This way is highly recommended to use, as it sets up everything automatically.

Setup a build folder:

cd vlc && mkdir build && cd build

And run the build:

../extras/package/macosx/build.sh -c

The command line switch -c rebuilds all dependencies (contribs) from source. If you want to use a prebuild contrib package, omit the -c option.

Wait and you have finished.

You can see more options for this script (change arch or sdk):

../extras/package/macosx/build.sh -h

In case this fails, please try the step-by-step build guide below using a clean checkout.

Making changes and compile again

Using build.sh is the recommended way to do a fresh VLC build. Now, if you did some changes to the VLC source code, you can try to compile the change by calling build.sh again. But sometimes this is a bit cubersome, as it might take longer, and sometimes its preferred to execute some build commands directly.

For that reason, a script called env.build.sh is included in VLC (starting with VLC 4.0 in vlc.git), which helps you setting the correct environment of your Terminal. The correct environment is needed, to make sure the right internal tools are used for the build process.

Before you compile again with make, just source this script into the current Terminal (pay attention to the dot at the front of the command):

. ../extras/package/macosx/env.build.sh

You can also create a symlink to that script in a more convenient location, for instance into the main vlc checkout directory:

# change directory to root git checkout
ln -s $PWD/extras/package/macosx/env.build.sh
cd build # go back to your build directory
. ../env.build.sh

Afterwards, in the same terminal, you can recompile by using the usual commands like make:

make
./bin/vlc-osx-static -vv # To test compiled changes

Build steps

Now, if you prefer, you can read the following detailed information on how the build internally works. This section describes all steps which are internally done in build.sh already. Likely, they are only relevant to you if you do not want to use build.sh and env.build.sh.

Additional development tools

You need a number of tools, notably all the autotools, to build VLC correctly. VLC has a way to build the specific versions of these tools required from source, here is how:

cd extras/tools
./bootstrap && make
cd ../..

Important: Add the extras/tools build results to your PATH, before doing anything else:

export PATH=$PWD/extras/tools/build/bin:$PATH

Prepare 3rd party libraries

To compile VLC, you need lots of other libraries, called 3rd party. VLC has the so-called “contribs” system to help building these libraries from source. Alternatively you can use a pre-built package of these libraries provided by VideoLAN.


First, set the correct SDK version for the 3rd party libraries, usually your current OS X Version:

export OSX_VERSION=10.11

Then, prepare the 3rd party library folder:

mkdir -p contrib/contrib-osx && cd contrib/contrib-osx
../bootstrap --build=x86_64-apple-darwin15

Prebuilt libraries (recommended)

If you want to download a prebuilt package of all the needed libraries.

make prebuilt

Now you can just skip to the Update PATH section.

Build your own libraries (not for the faint-hearted)

You need to install the Java JDK, to support java code for libbluray.

If you want to build contribs from source, you first need to make gettext, which is needed for some other contrib libraries to build:

make -j4 .gettext

Now you need to update your path for the gettext tools to be usable later on, see the Update PATH section above.

Then fetch contrib sources:

make fetch

and build them with:

make

If you had no errors, the 3rd party libraries (contrib) are built correctly and you can proceed to the next step.

Update PATH

First we go back to the source directory:

cd ../..

And now we still need to add the contribs to our path, so they can be found:

export PATH=$PWD/contrib/x86_64-apple-darwin15/bin:$PATH

Bootstrap VLC

This will create the configure script:

./bootstrap

Check that there are no obvious errors at this stage, like missing gettext or an error at exit.

Configure the VLC build

Create a build folder:

mkdir -p build && cd build

To list the different options of configure:

../extras/package/macosx/configure.sh --help

To build a binary with the previously installed x86_64-apple-darwin15 contrib:

../extras/package/macosx/configure.sh --enable-debug --host=x86_64-apple-darwin15

By default it will not use the installed SDK, like Xcode does, but use System Root. This means that if you built contribs on your own, the configure script might behave unexpectedly, for example enabling functions which are not present in a given operating system version. To work around this and build against the latest installed SDK, you can use:

--with-macosx-sdk=`xcrun --show-sdk-path`

If you want to use a different SDK, you can list all installed SDKs with xcodebuild -showsdks and to get the path for it, you can use the following command xcodebuild -version <SDK Flag from before> Path.
For example: xcodebuild -version -sdk macosx10.11 Path

Build VLC

Just do:

make -j4

and wait...

Run VLC

After make, you can just run VLC like so:

./bin/vlc-osx-static

If you want a VLC app bundle, just do

make VLC.app

And use it like a normal .app bundle.

Package VLC Application for Mac

If you want a disk-image:

make package-macosx

Note: If you want a more fancy disk image, you need the dmgbuild tool, which can be installed using pip install dmgbuild if you have python installed using Homebrew.

Sign VLC Application for Mac

If you want to sign your application with a certificate, for example for Gatekeeper, you need to run:

extras/package/macosx/codesign.sh -i "certificate name"

Troubleshooting

3rd party packagers and PATH

Pay careful attention to remove any reference to 3rd party package managers from your environment. This is important to avoid conflicts between your package manager (homebrew, fink, macports...) and the contrib package manager we use to build our contrib.

It shouldn't be necessary, but it can happen.

git must still be accessible though!

unset PKG_CONFIG_PATH
unset PKG_CONFIG_LIBDIR
export PATH=$PWD/build/bin:/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin

Xcode 'No developer directory' error

When running xcrun clang, if you see

Error: No developer directory...

then use xcode-select to select the developer directory within the Xcode package, to point to your xcode developer directory.

something like:

sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer  

Xcode tooling tries to use SDK in CommandLineTools directory

Occasionally it has been reported that Xcode tooling tries to compile with an SDK located under the .../Developer/CommandLineTools directory, even if Xcode.app is properly installed and a suitable SDK is available inside the app.

This problem might become visible with a similar error like this:

error: SDK "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk" cannot be located.

The root cause of this issue is now known yet and likely lies inside the apple provided tooling. One known workaround is to delete or move away the CommandLineTools directory.