3 2. Getting the source code
4 3. Install required libs
6 3.2. Install XBMC build depends
7 4. How to compile and run
12 -----------------------------------------------------------------------------
14 -----------------------------------------------------------------------------
16 This is a platform port of XBMC for the Apple OSX operating system. 10.6, 10.7
17 and 10.8 Intel development platforms are supported. Xcode 3.2.6 and 4.3 and newer
18 are the recommended versions.
19 There are 3 ways to build XBMC for Mac, from command-line with make, from command-line
20 using xcodebuild or from Xcode.
22 Generally, Xcode is the easiest as it presents the build system in a GUI environment.
23 The command-line build is still under development.
25 XBMC for Mac is composed of a main binary with numerous dynamic libraries and
26 codecs that support a multitude of music and video formats.
28 On Snow Leopard (OSX 10.6.x) we recommend using Xcode 3.2.6.
29 On Lion (OSX 10.7.x) we recommend using Xcode 4.3.x.
30 On Mountain Lion (OSX 10.8.1) we recommend using Xcode 4.4.
32 NOTE TO NEW OS X USERS: All lines that are prefixed with the '$' character are
33 commands that need to be typed into a Terminal window. Note that the '$'
34 character itself should NOT be typed as part of the command.
36 ATTENTION: When using Mountain Lion (OSX 10.8.x) you need to download and install
37 XQuartz from https://xquartz.macosforge.org/landing/ since its not part of OSX
40 -----------------------------------------------------------------------------
41 2. Getting the source code
42 -----------------------------------------------------------------------------
45 $ git clone git://github.com/xbmc/xbmc.git xbmc
47 -----------------------------------------------------------------------------
49 -----------------------------------------------------------------------------
50 See point 3.0a below for an updated list of supported/tested Xcode/osx constellations!!!
52 Install latest Xcode (4.3.2 or 3.2.6 as of the writing). You can download it from
54 1. Apple's site after registration at http://developer.apple.com/tools/download (Xcode 3.2.6)
55 2. In the MacOSX AppStore (Xcode 4.3.x).
57 If you are using XCode 4.3.x or later you also need to install the "Command Line Tools". To do so
58 after installing Xcode you have to go to "Xcode->Preferences->Downloads" and install the
59 package "Command Line Tools".
61 Xcode 3.2.6 only runs on 10.6.x (Snow Leopard).
62 Xcode 4.3.x only runs on 10.7.x (Lion).
63 Xcode 4.4 only runs on 10.8.x (Mountain Lion).
65 -----------------------------------------------------------------------------
66 3.0a Supported Xcode and OSX constellations
67 -----------------------------------------------------------------------------
68 As far as we know the compilation for mac osx should work with the following
69 constellations of Xcode and osx versions (to be updated once we know more):
71 1. XCode 3.2.6 against OSX SDK 10.6 on 10.6.x (Snow Leopard)
72 2. XCode 4.3.x against OSX SDK 10.6 and 10.7 on 10.7.x (Lion)
73 3. XCode 4.6 against OSX SDK 10.6, 10.7 and 10.8 on 10.7.x (Lion) and 10.8.x (ML)
75 -----------------------------------------------------------------------------
76 3.1 Install XBMC build depends
77 -----------------------------------------------------------------------------
78 The following commands will build using the latest OSX SDK found on your
81 3.1.1 Compiling as 32 Bit binary
85 $ ./configure --host=i386-apple-darwin
88 3.1.2 Compiling as 64 Bit binary
92 $ ./configure --host=x86_64-apple-darwin
95 NOTE: You can speedup compilation on multicore systems by doing
96 "make -j<number of cores>" instead of "make". For a dualcore this would read:
99 ADVANCED developers only! If you want to specify an OSX SDK version (if
100 multiple versions are installed) - then append it to the configure line
101 above (example below would use OSX SDK 10.7 and build for 64bit):
103 $ ./configure --host=x86_64-apple-darwin --with-sdk=10.7
105 Ensure that you also adapt the xcode project to use this SDK version.
107 -----------------------------------------------------------------------------
109 -----------------------------------------------------------------------------
110 Both Xcode and Terminal compilation require that build environment be setup
111 first. This is a simple step and involves the following:
113 4.a Compilation by using command-line building via xcodebuild or
114 by compiling via Xcode GUI
117 $ make -C tools/depends/target/xbmc
121 4.b Compilation by using command-line building via make (experimental)
124 $ make -C tools/depends/target/xbmc
127 The configure operation will setup the build environment for codecs and
128 internal libraries that are used by XBMC. This step is required for both Xcode
129 and command-line building. The "make clean" ensures that there are no stale
130 binaries from git that might cause problems.
132 -----------------------------------------------------------------------------
134 -----------------------------------------------------------------------------
135 Start XCode and open the XBMC project (XBMC.xcodeproj) located in $HOME/XBMC.
136 For development, XBMC is run from the $HOME/XBMC directory and needs to have
137 the XBMC_HOME environment variable set to know where that directory is located.
138 To set XBMC_HOME environment variable:
141 Menu -> Project -> Edit Active Executable "XBMC", click "Arguments" tab and
142 add "XBMC_HOME" as an enviroment variable. Set the value to the path to the
143 XBMC root folder. For example, "/Users/bigdog/Documents/XBMC"
145 Xcode 4.3.x and later
146 Menu -> Product -> Edit Sheme -> "Run XBMC"/"Debug" -> Add XBMC_HOME into
147 the List of "Environment Variables".Set the value to the path to thev XBMC
148 root folder. For example, "/Users/bigdog/Documents/XBMC"
150 There are two build targets "XBMC" and "XBMC.app" (each in 32Bit and 64Bit flavour)
151 with debug and release settings. The "XBMC" target is used for rapid build and
152 debug cycles while the "XBMC.app" target is used to build a self contained
155 Set the build target to "XBMC" or "XBMC.app" and be sure to select the same
156 architecture as selected in step 3.1 (either i386 for 32Bit or x86_64 for 64Bit),
159 If you have selected a specific OSX SDK Version in step 3.1 then you might need
160 to adapt the active target to use the same OSX SDK version. Else build will fail
161 (you will see alot of errors with at least non-found boost/shared_ptr.hpp).
163 The build process will take a long time when building the first time.
164 You can see the progress in "Build Results". There are a large number of static
165 and dynamic libaries that will need to be built. Once these are built,
166 subsequent builds will be faster.
168 After the build, you can ether run XBMC for Mac from Xcode or run it from
169 the command-line. If you run it from the command-line, make sure your set
170 the XBMC_HOME environment variable (export XBMC_HOME=$HOME/XBMC). Then, to
171 run the debug version:
175 Or the release version:
177 $ ./build/Release/XBMC
179 You can also build via Xcode from the command-line using the following:
181 $ xcodebuild -configuration Release ONLY_ACTIVE_ARCH=YES ARCHS=i386 VALID_ARCHS=i386 \
182 -target "XBMC.app" -project XBMC.xcodeproj
184 You can specify "Release" instead of "Debug" as a configuration. Be sure to set *_ARCHS
185 variables to the same architecture as selected in step 3.1 (either i386 for 32Bit or x86_64
188 -----------------------------------------------------------------------------
189 4.2 Using Terminal (command-line) (this is a work in progress and might fail)
190 -----------------------------------------------------------------------------
191 There are two methods, a) make/Xcode and b) make (which might fail as it's under
194 If you want to build a cross-compiled version that can run under 10.6/10.7,
195 you could try xcodebuild from the command-line (normally unneeded - for advanced
200 $ export XBMC_HOME=`pwd`
202 $ xcodebuild -sdk macosx10.7 -project XBMC.xcodeproj -target XBMC.app ONLY_ACTIVE_ARCH=YES \
203 ARCHS=x86_64 VALID_ARCHS=x86_64 -configuration Release build
207 $ export XBMC_HOME=`pwd`
211 -----------------------------------------------------------------------------
213 -----------------------------------------------------------------------------
214 This section describes how to package XBMC in a disk image for
217 1. build XBMC.app from XCode so that the application bundle is correctly updated.
219 2. $ cd tools/darwin/packaging/xbmc-osx
221 3. $ ./mkdmg-xbmc-osx.sh release
223 4. Use release or debug - you have to be sure that you build the corresponding
226 6. Find the corresponding dmg in the packaging dir.