Implement our own theme, yay!
[platform/upstream/gstreamer.git] / sdk-installing-on-mac-osx.md
1 #  Installing on Mac OS X
2
3 ## Supported platforms
4
5  *  10.6 (Snow Leopard)
6  *  10.7 (Lion)
7  *  10.8 (Mountain Lion)
8  *  10.9 (Mavericks)
9  *  10.10 (Yosemite)
10  *  10.11 (El Capitan)
11
12 ## Prerequisites
13
14 **FIXME: Those all need updating**
15
16 To develop applications using the GStreamer SDK for OS X you will need
17 OS X Snow Leopard (10.6) or later and
18 [XCode 3.2.6](https://developer.apple.com/devcenter/mac/index.action) or
19 later.
20
21 The recommended system is [Mac OS X
22 El Capitan](http://www.apple.com/macosx/) with
23 [XCode 4](https://developer.apple.com/xcode/)
24
25 ## Download and install the SDK
26
27 There are 3 sets of files in the SDK:
28
29   - The runtime files are needed to run GStreamer applications. You
30     probably want to distribute these files with your application (or
31     the installer below).
32   - The development files are **additional** files you need to create
33     GStreamer applications.
34   - Mac OS X packages that you can use
35     with [PackageMaker](https://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/PackageMakerUserGuide/Introduction/Introduction.html)
36     to deploy GStreamer with your application
37
38 Get **both the runtime and the development installers** from [here](https://gstreamer.freedesktop.org/data/pkg/osx/).
39
40
41 > ![Warning](images/icons/emoticons/warning.png)
42 > On Mac OS X 10.6 (Snow Leopard) you have to install Python 2.7 manually. It is included in later versions of OS X already. You can get it from [here](http://www.python.org/getit).
43
44 The downloads are 
45 [Installer Packages
46 (.pkg)](http://en.wikipedia.org/wiki/Installer_%28Mac_OS_X%29). 
47
48 Double click the package file and follow the instructions presented by
49 the install wizard. In case the system complains about the package not
50 being signed, you can control-click it and open to start the
51 installation. When you do this, it will warn you, but there is an option
52 to install anyway. Otherwise you can go to System Preferences → Security
53 and Privacy → General and select the option to allow installation of
54 packages from "anywhere".
55
56
57 These are some paths of the GStreamer framework that you might find
58 useful:
59
60   - /Library/Frameworks/GStreamer.framework/: Framework's root path
61   - /Library/Frameworks/GStreamer.framework/Versions: path with all the
62     versions of the framework
63   - /Library/Frameworks/GStreamer.framework/Versions/Current: link to
64     the current version of the framework
65   - /Library/Frameworks/GStreamer.framework/Headers: path with the
66     development headers
67   - /Library/Frameworks/GStreamer.framework/Commands: link to the
68     commands provided by the framework, such as gst-inspect-1.0 or
69     gst-launch-1.0
70
71 For more information on OS X Frameworks anatomy, you can consult the
72 following [link](https://developer.apple.com/library/mac/#documentation/MacOSX/Conceptual/BPFrameworks/Concepts/FrameworkAnatomy.html)
73
74 ## Configure your development environment
75
76 ### Building the tutorials
77
78 The tutorial's code, along with project files and a solution file for
79 them all are included in the SDK. The source code and the XCode project
80 files are located
81 in `/Library/Frameworks/GStreamer.framework/Current/share/gst-sdk/tutorials.`
82
83 To start building the tutorials, create a new folder in your Documents
84 directory and copy the
85 folder `/Library/Frameworks/GStreamer.framework/Current/share/gst-sdk/tutorials`.
86
87 You can fire up XCode and load the project file.
88
89 Press the **Run** button to build and run the first tutorial. You can
90 switch the tutorial to build selecting one of the available schemes.
91
92 ### Creating new projects
93
94 The GStreamer binaries provides a
95 [framework](https://developer.apple.com/library/mac/#documentation/MacOSX/Conceptual/BPFrameworks/Tasks/IncludingFrameworks.html)
96 that you can drag and drop to XCode to start using it, or using the
97 linker option ***-framework GStreamer****.*
98
99 There is a small exception to the regular use of frameworks, and you
100 will need to manually include the headers search
101 path  `/Library/Frameworks/GStreamer.framework/Headers`
102
103   - XCode: Add the headers path to **Search Paths → Header Search
104     Paths**
105   - GCC: Using the compiler
106     option **-I/Library/Frameworks/GStreamer.framework/Headers**