mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-03 16:09:39 +00:00
Code Issues 1 Projects Releases Wiki Activity

Cleanup page about building with cerbero

Browse source 
All platform specific where hard to follow as "information", make proper
paragapgraph about those requirements

And pass the file into ``pandoc -t markdown --reference-links
--atx-headers` making the whoel file much nicer to read.`
This commit is contained in:
Thibault Saunier 2016-05-26 22:31:36 -04:00
parent 7d5fe14134
commit a230b60399
1 changed files with 102 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

209
Building+from+source+using+Cerbero.markdown
View file

@ -1,53 +1,70 @@
# Building from source using Cerbero # Building from source using Cerbero
> ![Warning](images/icons/emoticons/warning.png) > ![Warning] This section is intended for advanced users.
> This section is intended for advanced users.</p></td> > </p>
> </td>
## Build requirements ## Build requirements
The GStreamer SDK build system provides bootstrapping facilities for all The GStreamer SDK build system provides bootstrapping facilities for all
platforms, but it still needs a minimum base to bootstrap: platforms, but it still needs a minimum base to bootstrap:
- python \>= 2.6 and python's `argparse` module, which is already - python &gt;= 2.6 and python's `argparse` module, which is already
included in python2.7. included in python2.7.
- git - git
> ![Information](images/icons/emoticons/information.png) ### Windows users
> **Windows users**
>
> Cerbero can be used on Windows using the Msys/MinGW shell (a Unix-like shell for Windows). There is a bit of setup that you need to do before Cerbero can take control.
>
> You need to install the following programs:
> - [Python 2.7](http://www.python.org/getit/releases/2.7/)
> - [Git](http://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git) (Select the install option &quot;Checkout as-is, Commit as-is&quot; and install it in a path without spaces, eg: c:\Git)
> - [Msys/MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/) (Install it with all the options enabled)
> - [CMake](http://www.cmake.org/cmake/resources/software.htm) (Select the option &quot;Add CMake in system path for the current user&quot;)
> - [Yasm](http://yasm.tortall.net/Download.html) (Download the win32 or win64 version for your platform, name it <code>yasm.exe</code>, and place it in your MinGW <code>bin</code> directory, typically, <code>C:\MinGW\bin</code>)
> - [WiX 3.5](http://wix.codeplex.com/releases/view/60102)
> - [Microsoft SDK 7.1](http://www.microsoft.com/en-us/download/details.aspx?id=8279) (Install the SDK samples and the Visual C++ Compilers, required to build the DirectShow base classes. Might need installing the .NET 4 Framework first if the SDK installer doesn't find it)
> - [Windows Driver Kit 7.1.0](http://msdn.microsoft.com/en-us/windows/hardware/hh852365)
>
> Your user ID can't have spaces (eg: John Smith). Paths with spaces are not correctly handled in the build system and msys uses the user ID for the home folder.
>
>Cerbero must be run in the MinGW shell, which is accessible from the main menu once MinGW is installed.
>
>The last step is making `python` and `git` available from the shell, for which you will need to create a `.profile` file. Issue this command from within the MinGW shell:
>
> `echo "export PATH=\"\$PATH:/c/Python27:/c/Git/bin\"" >> ~/.profile`
>
> Using the appropriate paths to where you installed `python` and `git`
>
> (Note that inside the shell, / is mapped to c:\Mingw\msys\1.0\ )
> ![Information](images/icons/emoticons/information.png) Cerbero can be used on Windows using the Msys/MinGW shell (a Unix-like
> **OS X users** shell for Windows). There is a bit of setup that you need to do before
> Cerbero can take control.
>To use cerbero on OS X you need to install the "Command Line Tools" from XCode. They are available from the "Preferences" dialog under "Downloads".
> ![Information](images/icons/emoticons/information.png) You need to install the following programs:
> **iOS developers**
> - [Python 2.7]
>If you want to build the GStreamer-SDK for iOS, you also need the iOS SDK. The minimum required iOS SDK version is 6.0 and is included in [XCode](https://developer.apple.com/devcenter/ios/index.action#downloads) since version 4. - [Git] (Select the install option "Checkout as-is, Commit as-is" and
install it in a path without spaces, eg: c:\Git)
- [Msys/MinGW] (Install it with all the options enabled)
- [CMake] (Select the option "Add CMake in system path for the
current user")
- [Yasm] (Download the win32 or win64 version for your platform, name
it `yasm.exe`, and place it in your MinGW `bin` directory,
typically, `C:\MinGW\bin`)
- [WiX 3.5]
- [Microsoft SDK 7.1] (Install the SDK samples and the Visual C++
Compilers, required to build the DirectShow base classes. Might need
installing the .NET 4 Framework first if the SDK installer doesn't
find it)
- [Windows Driver Kit 7.1.0]
Your user ID can't have spaces (eg: John Smith). Paths with spaces are
not correctly handled in the build system and msys uses the user ID for
the home folder.
Cerbero must be run in the MinGW shell, which is accessible from the
main menu once MinGW is installed.
The last step is making `python` and `git` available from the shell, for
which you will need to create a `.profile` file. Issue this command from
within the MinGW shell:
`echo "export PATH=\"\$PATH:/c/Python27:/c/Git/bin\"" >> ~/.profile`
Using the appropriate paths to where you installed `python` and `git`
(Note that inside the shell, / is mapped to c:\Mingw\msys\1.0 )
### OS X users
To use cerbero on OS X you need to install the "Command Line Tools" from
XCode. They are available from the "Preferences" dialog under
"Downloads".
### iOS developers
If you want to build the GStreamer-SDK for iOS, you also need the iOS
SDK. The minimum required iOS SDK version is 6.0 and is included in
[XCode] since version 4.
## Download the sources ## Download the sources
@ -58,18 +75,14 @@ architectures and distributions.
Get a copy of Cerbero by cloning the git repository: Get a copy of Cerbero by cloning the git repository:
``` git clone git://anongit.freedesktop.org/gstreamer/cerbero
git clone git://anongit.freedesktop.org/gstreamer/cerbero
```
Cerbero can be run uninstalled and for convenience you can create an Cerbero can be run uninstalled and for convenience you can create an
alias in your `.bashrc` file*. *If you prefer to skip this step, alias in your `.bashrc` file*. *If you prefer to skip this step,
remember that you need to replace the calls to `cerbero` with remember that you need to replace the calls to `cerbero` with
`./cerbero-uninstalled` in the next steps. `./cerbero-uninstalled` in the next steps.
``` echo "alias cerbero='~/git/cerbero/cerbero-uninstalled'" >> ~/.bashrc
echo "alias cerbero='~/git/cerbero/cerbero-uninstalled'" >> ~/.bashrc
```
## Setup environment ## Setup environment
@ -85,15 +98,12 @@ are running and will use default build options such as the default build
directory. The default options should work fine on the supported directory. The default options should work fine on the supported
distributions. distributions.
An example configuration file with detailed comments can be found An example configuration file with detailed comments can be found [here]
[here](http://www.freedesktop.org/software/gstreamer-sdk/cerbero.cbc.template)
To fire up the bootstrapping process, go to the directory where you To fire up the bootstrapping process, go to the directory where you
cloned/unpacked Cerbero and type: cloned/unpacked Cerbero and type:
``` cerbero bootstrap
cerbero bootstrap
```
Enter the superuser/root password when prompted. Enter the superuser/root password when prompted.
@ -104,45 +114,33 @@ the GStreamer SDK.
To generate the SDK, use the following command: To generate the SDK, use the following command:
``` cerbero package gstreamer-1.0
cerbero package gstreamer-1.0
```
This should build all required SDK components and create packages for This should build all required SDK components and create packages for
your distribution at the Cerbero source directory. your distribution at the Cerbero source directory.
A list of supported packages to build can be retrieved using: A list of supported packages to build can be retrieved using:
``` cerbero list-packages
cerbero list-packages
```
Packages are composed of 0 (in case of a meta package) or more Packages are composed of 0 (in case of a meta package) or more
components that can be built separately if desired. The components are components that can be built separately if desired. The components are
defined as individual recipes and can be listed with: defined as individual recipes and can be listed with:
``` cerbero list
cerbero list
```
To build an individual recipe and its dependencies, do the following: To build an individual recipe and its dependencies, do the following:
``` cerbero build <recipe_name>
cerbero build <recipe_name>
```
Or to build or force a rebuild of a recipe without building its Or to build or force a rebuild of a recipe without building its
dependencies use: dependencies use:
``` cerbero buildone <recipe_name>
cerbero buildone <recipe_name>
```
To wipe everything and start from scratch: To wipe everything and start from scratch:
``` cerbero wipe
cerbero wipe
```
Once built, the output of the recipes will be installed at the prefix Once built, the output of the recipes will be installed at the prefix
defined in the Cerbero configuration file `$HOME/.cerbero/cerbero.cbc` defined in the Cerbero configuration file `$HOME/.cerbero/cerbero.cbc`
@ -155,53 +153,43 @@ can be very slow on Windows, so if you only need to rebuild a single
project (eg: gst-plugins-good to patch qtdemux) there is a much faster project (eg: gst-plugins-good to patch qtdemux) there is a much faster
way of doing it. You will need to follow the steps detailed in this way of doing it. You will need to follow the steps detailed in this
page, but skipping the step "**Build the SDK**", and installing the page, but skipping the step "**Build the SDK**", and installing the
SDK's development files as explained in [Installing the SDK's development files as explained in [Installing the SDK].
SDK](Installing+the+SDK.markdown).
By default, Cerbero uses as prefix a folder in the user directory with By default, Cerbero uses as prefix a folder in the user directory with
the following schema ~/cerbero/dist/$platform\_$arch, but for the SDK we the following schema \~/cerbero/dist/$platform\_$arch, but for the SDK
must change this prefix to use its installation directory. This can be we must change this prefix to use its installation directory. This can
done with a custom configuration file named *custom.cbc*: be done with a custom configuration file named *custom.cbc*:
``` # For Windows x86
# For Windows x86 prefix='/c/gstreamer/1.0/x86/'
prefix='/c/gstreamer/1.0/x86/'
# For Windows x86_64 # For Windows x86_64
#prefix='/c/gstreamer/1.0/x86_64' #prefix='/c/gstreamer/1.0/x86_64'
# For Linux # For Linux
#prefix='/opt/gstreamer' #prefix='/opt/gstreamer'
# For OS X # For OS X
#prefix='/Library/Frameworks/GStreamer.framework/Versions/1.0' #prefix='/Library/Frameworks/GStreamer.framework/Versions/1.0'
```
The prefix path might not be writable by your current user. Make sure The prefix path might not be writable by your current user. Make sure
you fix it before, for instance with: you fix it before, for instance with:
``` $ sudo chown -R <username> /Library/Frameworks/GStreamer.framework/
$ sudo chown -R <username> /Library/Frameworks/GStreamer.framework/
```
Cerbero has a shell command that starts a new shell with all the Cerbero has a shell command that starts a new shell with all the
environment set up to target the SDK. You can start a new shell using environment set up to target the SDK. You can start a new shell using
the installation prefix defined in *custom.cbc *with the following the installation prefix defined in *custom.cbc *with the following
command: command:
``` $ cerbero -c custom.cbc shell
$ cerbero -c custom.cbc shell
```
Once you are in Cerbero's shell you can compile new Once you are in Cerbero's shell you can compile new projects targeting
projects targeting the SDK using the regular build the SDK using the regular build process:
process:
``` $ git clone -b sdk-0.10.31 git://anongit.freedesktop.org/gstreamer-sdk/gst-plugins-good; cd gst-plugins-good
$ git clone -b sdk-0.10.31 git://anongit.freedesktop.org/gstreamer-sdk/gst-plugins-good; cd gst-plugins-good $ sh autogen.sh --disable-gtk-doc --prefix=<prefix>
$ sh autogen.sh --disable-gtk-doc --prefix=<prefix> $ make -C gst/isomp4
$ make -C gst/isomp4
```
### Cross-compilation of the SDK ### Cross-compilation of the SDK
@ -217,9 +205,7 @@ You can cross-compile the SDK for Android from a Linux host using the
configuration file `config/cross-android.cbc`. Replace all the previous configuration file `config/cross-android.cbc`. Replace all the previous
commands with: commands with:
``` cerbero -c config/cross-android.cbc <command>
cerbero -c config/cross-android.cbc <command>
```
#### Windows #### Windows
@ -230,21 +216,28 @@ only be created from Windows.
Replace all the above commands for Windows 32bits with: Replace all the above commands for Windows 32bits with:
``` cerbero -c config/cross-win32.cbc <command>
cerbero -c config/cross-win32.cbc <command>
```
Or with using the following for Windows 64bits: Or with using the following for Windows 64bits:
``` cerbero -c config/cross-win64.cbc <command>
cerbero -c config/cross-win64.cbc <command>
```
#### iOS #### iOS
To cross compile for iOS from OS X, use the configuration file To cross compile for iOS from OS X, use the configuration file
`config/cross-ios-universal.cbc`. Replace all previous commands with: `config/cross-ios-universal.cbc`. Replace all previous commands with:
``` cerbero -c config/cross-ios-universal.cbc <command>
cerbero -c config/cross-ios-universal.cbc <command>
``` [Warning]: images/icons/emoticons/warning.png
[Python 2.7]: http://www.python.org/getit/releases/2.7/
[Git]: http://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git
[Msys/MinGW]: https://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/
[CMake]: http://www.cmake.org/cmake/resources/software.htm
[Yasm]: http://yasm.tortall.net/Download.html
[WiX 3.5]: http://wix.codeplex.com/releases/view/60102
[Microsoft SDK 7.1]: http://www.microsoft.com/en-us/download/details.aspx?id=8279
[Windows Driver Kit 7.1.0]: http://msdn.microsoft.com/en-us/windows/hardware/hh852365
[XCode]: https://developer.apple.com/devcenter/ios/index.action#downloads
[here]: http://www.freedesktop.org/software/gstreamer-sdk/cerbero.cbc.template
[Installing the SDK]: Installing+the+SDK.markdown