fixed:[osx] more make changes and it's "make xcode-depends" for building xcode depend...
[xbmc:xbmc-antiquated.git] / XBMC / README.osx
1 TOC
2 1. Introduction
3 2. Getting the source code
4 3. Install required libs
5   3.1. Install Xcode
6   3.2. Install MacPorts 1.7
7 4. How to compile and run
8         4.1 Using XCode
9         4.2 Using Command line
10 5. Packaging
11
12 -----------------------------------------------------------------------------
13 1. Introduction
14 -----------------------------------------------------------------------------
15
16 This is a platform port of XBMC for the Apple OSX operating system. Both 10.5
17 and 10.4 Intel development platforms are supported. The current build system
18 is Xcode 2.5 or Xcode 3.1.2 There are two ways to build XBMC for Mac.
19 1) command-line or
20 2) Xcode.
21
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.
24
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.
27
28 NOTE TO NEW OS X USERS: All lines that are prefixed with the '$' character are
29 commands that need to be typed into a Terminal window. Note that the '$'
30 character itself should NOT be typed as part of the command.
31
32
33 -----------------------------------------------------------------------------
34 2. Getting the source code
35 -----------------------------------------------------------------------------
36
37  $ cd $HOME
38  $ svn checkout https://xbmc.svn.sourceforge.net/svnroot/xbmc/branches/linuxport/XBMC
39
40 -----------------------------------------------------------------------------
41 3.0 Install XCODE
42 -----------------------------------------------------------------------------
43 Install latest Xcode. You can download it from Apple's site after registration at
44 (http://developer.apple.com/tools/download). You also need to install the 10.4
45 sdk. If using Xcode 3.x, you MUST use Xcode 3.1.2 so update your existing version
46 if you are running a previous Xcode 3.x version. Xcode 3.x only runs on 10.5.
47
48
49 -----------------------------------------------------------------------------
50 3.1 Install MacPorts 1.7
51 -----------------------------------------------------------------------------
52
53 These build instructions depend on MacPorts 1.7. If you have another version
54 of MacPorts installed, it's best to remove it and install the 1.7 version.
55 To remove a previous install of MacPorts, enter the following from a terminal
56 windows:
57
58  $ sudo rm -rf \
59     /opt/local \
60     /etc/manpaths.d/macports \
61     /etc/paths.d/macports \
62     /Applications/DarwinPorts \
63     /Applications/MacPorts \
64     /Library/LaunchDaemons/org.macports.* \
65     /Library/Receipts/DarwinPorts*.pkg \
66     /Library/Receipts/MacPorts*.pkg \
67     /Library/StartupItems/DarwinPortsStartup \
68     /Library/Tcl/darwinports1.0 \
69     /Library/Tcl/macports1.0
70
71 Install MacPorts 1.7 (http://www.macports.org/). If you are going to run
72 under the same OSX version as you build under, just install the required port
73 packages without the extra flags. No modifications of MacPorts is required.
74 That means skip 1), 2), 3) and 4) below and don't add "+universal" or 
75 "macosx_deployment_target=10.4" when installing the ports. 
76
77 If you want to build a cross-compiled version that can run under
78 10.5/10.4/AppleTV, then change MacPorts's behavior to always build universal
79 against 10.4sdk using the following instructions.
80
81  1)
82    $ sudo nano /opt/local/etc/macports/macports.conf
83    a) change "universal_target  10.5" to "universal_target      10.4"
84
85    b) change "universal_sysroot /Developer/SDKs/MacOSX10.5.sdk" to
86      "universal_sysroot /Developer/SDKs/MacOSX10.4u.sdk"
87
88    c) change "universal_archs         ppc i386"
89      to reflect the arch you are building by removing the unused arch.
90
91  2) These are needed to build openssl (used by samba3 and mysql5) against 10.4sdk
92    $ sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/lib/dylib1.o /Developer/SDKs/MacOSX10.4u.sdk/usr/lib/dylib1.10.5.o
93    $ sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/lib/crt1.o /Developer/SDKs/MacOSX10.4u.sdk/usr/lib/crt1.10.5.o
94
95  3) samba3 does not have a +universal variant so we force it to build
96 libsmbclient in a compatible manner
97
98    $ sudo nano /opt/local/var/macports/sources/rsync.macports.org/release/ports/net/samba3/Portfile
99
100    add the following before "configure.cflags-append "-fno-common";
101
102    configure.ldflags-append "-mmacosx-version-min=10.4 -isysroot /Developer/SDKs/MacOSX10.4u.sdk -Wl,-syslibroot,/Developer/SDKs/MacOSX10.4u.sdk"
103
104    change "--enable-cups" to "--disable-cups".
105
106  4) mysql5 thinks we are cross-compiling and appends the cross-compile name to bin/my** apps.
107
108    $ sudo nano /opt/local/var/macports/sources/rsync.macports.org/release/ports/databases/mysql5/Portfile
109
110    scroll down to the post-destroot section and comment out the following
111    three lines like below;
112
113     # Symlink mysql binaries into bin directory, with ${major_version} appended to the name
114     #foreach f [glob -tails -directory ${destroot}${bindir} my*] {
115     #    ln -sf ${bindir}/${f} ${destroot}${prefix}/bin/${f}${major_version}
116     #}
117
118
119 Then install the following port packages (order is very important):
120
121  $ sudo port install pcre +universal
122  $ sudo port install expat +universal
123  $ sudo port install libiconv +universal
124  $ sudo port install gettext +universal
125  $ sudo port install libtool yasm cmake gmake pkgconfig
126
127  $ sudo port install lzo +universal
128  $ sudo port install bzip2 +universal
129  $ sudo port install fontconfig +universal
130  $ sudo port install boost +universal
131
132  $ sudo port install jpeg +universal
133  $ sudo port install tiff +universal
134  $ sudo port install libpng +universal
135  $ sudo port install libogg +universal
136  $ sudo port install libvorbis +universal
137  $ sudo port install libmad macosx_deployment_target=10.4
138  $ sudo port install fribidi +universal
139
140  $ sudo port install glew +universal
141  $ sudo port install libcdio +universal
142  $ sudo port install openssl +universal
143  $ sudo port install samba3 macosx_deployment_target=10.4
144  $ sudo port install mysql5 +universal
145  $ sudo port install sqlite3 +universal
146  $ sudo port install libsamplerate +universal
147
148  $ sudo port install libsdl +no_x11 +universal
149  $ sudo port install smpeg +universal
150  $ sudo port install libsdl_mixer +universal
151  $ sudo port install libsdl_image +universal
152
153 If you understand the following two lines, you can run it to automate
154 the installation of the ports in the above order:
155
156   sudo bash
157   cat README.osx | perl -ne 'print `port install $1` if /^ \$ sudo port install (.*)$/;'
158
159 Finally, fix the mysql package default install location with this symlink:
160
161  $ sudo ln -s /opt/local/include/mysql5/mysql/ /opt/local/include/mysql
162
163 -----------------------------------------------------------------------------
164 4. How to compile
165 -----------------------------------------------------------------------------
166 Both Xcode and Terminal compilation require that build environment be setup
167 first. This is a simple step and involves the following:
168
169  $ cd $HOME/XBMC
170  $ autoconf
171  $ ./configure
172  $ make clean
173  $ make xcode_depends
174
175 The configure operation will setup the build environment for codecs and
176 internal libraries that are used by XBMC. This step is required for both Xcode
177 and command-line building. The "make clean" ensures that there areno stale
178 binaries from svn that might cause problems The last step will pre-build
179 the majority of the codecs and libs:
180
181
182 The configure operation will default to building "debug". To build "release"
183 codecs and libraries for Xcode, do the configure step with "--disable-debug"
184 but remember that Xcode will need to be also built "Release":
185
186  $ ./configure --disable-debug
187
188 -----------------------------------------------------------------------------
189 4.1 Using Xcode
190 -----------------------------------------------------------------------------
191 Start XCode and open the XBMC project (XBMC.xcodeproj) located in $HOME/XBMC.
192 For development, XBMC is run from the $HOME/XBMC directory and needs to have
193 the XBMC_HOME environment variable set to know where that directory is located.
194 To set XBMC_HOME environment variable:
195
196 Menu -> Project -> Edit Active Executable "XBMC", click "Arguments" tab and
197 add "XBMC_HOME" as an enviroment variable. Set the value to the path to the
198 XBMC root folder. For example, "/Users/bigdog/Documents/XBMC"
199
200 There are two build targets "XBMC" and "XBMC.app" with debug and release
201 settings. The "XBMC" target is used for rapid build and debug cycles while
202 the "XBMC.app" target is used to build a self contained OSX application.
203
204 Set the build target to "XBMC" or "XBMC.app", then build. The build process
205 will take a long time when builting the first time. You can see the progress
206 in "Build Results". There are a large number of static and dynamic libaries
207 that will need to be built. Once these are built, subsequent builds will be
208 faster.
209
210 After the build, you can ether run XBMC for Mac from Xcode or run it from
211 the command-line. If you run it from the command-line, make sure your set
212 the XBMC_HOME environment variable (export XBMC_HOME=$HOME/XBMC). Then, to
213 run the debug version:
214
215 $ ./build/Debug/XBMC
216
217 Or the release version:
218
219 $ ./build/Release/XBMC
220
221 You can also build via Xcode from the command-line using the following:
222
223 $ xcodebuild -configuration Release -target "XBMC.app" -project XBMC.xcodeproj
224
225 You can specify "Release" instead of "Debug" as a configuration.
226
227 -----------------------------------------------------------------------------
228 4.2 Using Terminal (command-line) (this is a work in progress and might fail)
229 -----------------------------------------------------------------------------
230 There are two methods, a) make/Xcode and b) make (which might fail as it's under
231 construction).
232
233  a)
234  $ cd $HOME/XBMC
235  $ export XBMC_HOME=`pwd`
236  $ make xcode_depends
237  $ xcodebuild -sdk macosx10.4 -project XBMC.xcodeproj -target XBMC.app -configuration Release build
238
239  b)
240  $ cd $HOME/XBMC
241  $ export XBMC_HOME=`pwd`
242  $ make xbmc
243  $ ./xbmc.bin
244
245 -----------------------------------------------------------------------------
246 5. Packaging
247 -----------------------------------------------------------------------------
248 This section describes how to package XBMC in a disk image for
249 distribution.
250
251   1. Create 2 directories "extras/user" and "extras/system" in the root of
252   the source tree.
253
254     1.1. "extras/user" - anything found in this directory will be
255     copied to the user's XBMC directory (~/Library/Application
256     Support/XBMC) on first run. Examples:
257
258         extras/user/scripts/XBMC Lyrics
259         extras/user/plugins/music/iTunes
260
261     1.2. "extras/system" - anything found in this directory will be
262     copied to the XBMC application bundle at build time
263     (XBMC.app/Contents/Resources/XBMC/). Examples:
264
265         extras/system/skin/MediaStream
266         extras/system/skin/My Skin
267
268
269   2. After performing step 1, build XBMC.app from XCode so that the
270   application bundle is correctly updated.
271
272   3. Go to tools/PackageMaker and run dmgmaker.pl as follows:
273
274       $ cd tools/PackageMaker
275       $ ./dmgmaker.pl ../../build/Release/XBMC.app
276
277   4. If dmgmaker.pl completed successfully, a disk image will be
278   present in the "dist" subdirectory:
279
280       $ ls dist
281       XBMC.dmg
282
283 Remember to unmount/eject XBMC.dmg before attempting to recreate it,
284 otherwise dmgmaker.pl will fail.