-GENIVI AUDIOMANAGER
-
-Copyright (C) 2011, BMW AG
-
-Datum 20.05.2011
-author Christian Müller (christian.ei.mueller@bmw.de)
-
***********************************************************************************************************
-LICENSE
+GENIVI AudioManager
***********************************************************************************************************
-GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
-Copyright (C) 2011, BMW AG – Christian Müller Christian.ei.mueller@bmw.de
+Copyright (C) 2012, GENIVI Alliance, Inc.
+Copyright (C) 2012, BMW AG
-This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
-You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
-Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
-Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
-As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
-Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
+This file is part of GENIVI Project AudioManager.
+
+Contributions are licensed to the GENIVI Alliance under one or more
+Contribution License Agreements.
+
+copyright
+This Source Code Form is subject to the terms of the
+Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
+this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
-Version 0.2
+For further information see http://www.genivi.org/.
***********************************************************************************************************
-COMPILE PROGRAMS
-*********************************************************************************************************
-
-You will need some packages in order to comile the GENIVI AudioManager Proof of Concept, these are:
--QT4
--automotive-dlt
--jack
--jackeq
--jack control
--dbus
--sqlite
--glib >=2.0
--gstreamer-base-0.10
--gstreamer-plugins-base-0.10
--gstreamer-plugins
--gstreamer0.10-pulseaudio
--gstreamer0.10-plugins-good
--phonon
--phonon-backend-gstreamer
--doxygen
-
-More details in the CMake Files CmakeList.txt in the projects
-
-on the top level of the folder you just received, there is a shall script "cmaker.sh" which can be invoked with a lot of different parameters. Invoking it with:
-
-sh cmaker.sh all all
-
-will create all neccessary folders and compile all plugins and applications except the PulseAudio Plugin.
-
-after the script finished, you should have:
-
-a /bin folder which contains:
- AudioGui
- AudioManager
- Bild1.png
- PlayerGui
-
-a /build folder which has all build objects (erase that if you need a clean build)
-
-a /doc folder which contains subfolders with the doxygen documentation:
- AudioGui
- AudioManager
- DBusPlugin
- JackPlugin
- PlayerGUI
- PluginTest
+License
+***********************************************************************************************************
+The licenses of this project are split into two parts:
+1) the AudioManagerDaemon, licensed under MPL 2.0
+2) all other parts that serve as example code that can be taken to build up an own project with it -
+ these parts are licensed with the MIT license
+
+Contribution is done under GENIVI CLA.
***********************************************************************************************************
-COMPILE PULSEAUDIO
+Version
***********************************************************************************************************
+The current version can be taken out of the git. The version 1.0.0 is the first GENIVI compliant code,
+in the compliance statement of discovery (2.0)
-For the pulseaudio plugin, you will need to do the following steps:
+***********************************************************************************************************
+COMPILE PROGRAMS
+***********************************************************************************************************
+- compile options with default values:
+
+ CMAKE_BUILD_TYPE
+ CMAKE_INSTALL_PREFIX /usr/local
+ GLIB_DBUS_TYPES_TOLERANT ON
+ USE_BUILD_LIBS ON
+ WITH_DBUS_WRAPPER ON
+ WITH_DLT ON
+ WITH_DOCUMENTATION OFF
+ WITH_MAIN ON
+ WITH_PLUGIN_COMMAND ON
+ WITH_PLUGIN_CONTROL ON
+ WITH_PLUGIN_ROUTING ON
+ WITH_PPOLL ON
+ WITH_TELNET ON
+ WITH_TESTS ON
+
+
+In order to change these options, you can modify this values with ccmake, do the appropriate changes in
+CmakeList.txt or via the commandline for cmake or (when installed via ccmake)
+
+You will need some packages in order to comile the GENIVI AudioManager Daemon, these are:
+ -dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
+ -sqlite3 [tested on version 3.6.22]
+ -automotive-dlt [greater 2.5.0]
+ -doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
+
+ to install them in a build environment like Ubuntu you can use:
+ sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
+
+For building the tests, you will need the following packages:
+ -google mock [tested on version 1.6.0-1]
+ -google test [tested on version 1.6.0]
+ -python [tested on version 2.6]
+
+ to install them in a build environment like Ubuntu you can use:
+ sudo apt-get install libgtest-dev google-mock python2.6-dev
+
+More details in the CMake Files CmakeList.txt in the projects.
+
+The build was tested on a freshly setup LinuxMint 12 (don't like Unity) with the following steps:
+ sudo apt-get update
+ sudo apt-get upgrade
+ sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake
+ build-essential python2.6-dev
+
+ git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/AudioManager
+
+In order to build the project (out of source build), please follow these instructions on the commandline:
+
+ mkdir /build
+ cd build
+ cmake ..
+ make -j4
-- if you have pulseaudio installed (e.g. you have vanilla ubuntu), remove it with the package manager
+after the script finished, you should have:
- apt-get purge pulseaudio
+ a bin/ folder which contains all executables and the libraries:
+ a build/ folder which has all build objects (erase that if you need a clean build)
+ a doc/ folder in case you turned the documentation on
-- remove all packages of modules as well (there can be only one server of course)
-- download the source code from pulseaudio
+in order to install the AudioManager, you can do
- wget http://freedesktop.org/software/pulseaudio/releases/pulseaudio-0.9.22.tar.gz
+ sudo make install
-- patch was developed and tested with verisopn 0.9.22 but newer versions could do as well and unpack it
+package generation is supported via CPack. To build packages, you have to
- tar xvf pulseaudio-0.9.22.tar.gz
+ make genivi_package
-- cd into the unpacked pulseaudio directory:
+this will create one package if your CMake version is < 2.8.5 (all binaries stripped):
+
+ AudioManager-<git verison>-Linux.deb
- cd pulseaudio-0.9.22
+if your version is above, you will get 4 packages (all binaries stripped) :
+
+ AudioManager-<git verison>-Linux-bin.deb [AudioManager binary]
+ AudioManager-<git verison>-Linux-dev.deb [header files needed to compile plugins]
+ AudioManager-<git verison>-Linux-sampleplugins.deb [sample plugins]
+ AudioManager-<git verison>-Linux-tests.deb [tests including tests for sample plugins,
+ installed in the ~/AudioMAnagerTests]
-- copy the patchfile into the pulseaudio directory
+to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do:
- cp ../genivipulseaudio.patch .
+ make package_source
--apply the patchfile genivipulseaudio.patch with
+This will create the following package:
- patch -p1 -i genivipulseaudio.patch
+ AudioManager-<git verison>-Source.tar.gz
-- what follows is the normal compiling process of pulseaudio, first bootstrap:
+All packages will be placed in a folder called packages
- ./bootstrap.sh
+The commandline options of the AudioManager:
-- then configure
-
- ./configure.sh
-
-- check the output, the summary file should look similar to this:
-
- Have X11: no
- Enable OSS Output: yes
- Enable OSS Wrapper: yes
- Enable Alsa: yes
- Enable Solaris: no
- Enable GLib 2.0: yes
- Enable Gtk+ 2.0: yes
- Enable GConf: no
- Enable Avahi: yes
- Enable Jack: yes
- Enable Async DNS: no
- Enable LIRC: no
- Enable HAL: no
- Enable udev: yes
- Enable HAL->udev compat: yes
- Enable BlueZ: no
- Enable TCP Wrappers: no
- Enable libsamplerate: yes
- Enable IPv6: yes
- Enable OpenSSL (for Airtunes): no
- Enable tdb: no
- Enable gdbm: no
- Enable simple database: yes
- Enable Genivi support yes
- System User: pulse
- System Group: pulse
- Access Group: pulse-access
- Enable per-user EsounD socket: yes
- Force preopen: no
- Preopened modules: all
-
- at least we should have alsa, Jack, udev, libsamplerate, Genivi, Glib 2.0 .... if not install missing packages and start again
-
-- ok, lets go with
-
- make -j4 all
-
-To adjust to your system, you can modify the file "Genivi.conf" witch can be found in pulseaudio-0.9.22/src. Here you can define the sources and sinks
-that are presented to the audiomanager by the routingadaptor in the pulseaudio genivi module.
+ Usage: AudioManagerDaemon [options]
+ options:
+ -h: print this message
+ -i: info about current settings
+ -v: print version
+ -d: daemonize AudioManager
+ -p<path> path for sqlite database (default is in memory)
+ -t<port> port for telnetconnection
+ -m<max> number of max telnetconnections
+ -c<Name> use controllerPlugin <Name> (full path with .so ending)
+ -l<Name> replace command plugin directory with <Name> (full path)
+ -r<Name> replace routing plugin directory with <Name> (full path)
+ -L<Name> add command plugin directory with <Name> (full path)
+ -R<Name> add routing plugin directory with <Name> (full path)
***********************************************************************************************************
-START
+Telnet Server
***********************************************************************************************************
+The audiomanager has a build- in telnetserver that serves for debuggin purposes.
+If you compile your AudioManager with TelnetServer support (cmake -DWITH_TELNET=ON), you will be able to
+set with commandline argument -t the port number and with -m the maximum supported connections.
+The default telnet port is 6060.
+
+ For example, launch a telnet session on port 6060:
+ telnet localhost 6060
+
+ #>Welcome to GENIVI AudioManager ver-0.0.1-37-ga004215
+ #>
+
+ press 'help' to get a list of all supported commands on this level:
+
+ #>help
+ ####################################################
+ ####### The following commands are supported: ######
+ ####################################################
+ #
+ #exit - quit telnet session
+ #get - Go into 'get'-submenu
+ #help - show all possible commands
+ #info - Go into 'info'-submenu
+ #list - Go into 'list'-submenu
+ #set - Go into 'set'-submenu
+ #
+ #\>
+
+ Now type one of these commands, for example 'get', followed with another 'help' to get a list of supported commands:
+
+ #\>get
+ #
+ #\Get>help
+ ####################################################
+ ####### The following commands are supported: ######
+ ####################################################
+ #
+ #.. - one step back in menu tree (back to root folder)
+ #exit - close telnet session
+ #help - show all possible commands
+ #recv - show receiverversion
+ #routing - show current routing
+ #sendv - show senderversion
+ #
+ #\Get>
+
+ You can also execute several commands in a line:
+
+ #\Get>recv sendv .. help exit
+ # Receiver versions:
+ # Ctrl: 1 | Cmd: 1 | Routing: 1
+ # Sender versions:
+ # Ctrl: 1 | Cmd: 1 | Routing: 1
+ ####################################################
+ ######## The following commands are supported: ######
+ ####################################################
+ #
+ #exit - quit telnet session
+ #get - Go into 'get'-submenu
+ #help - show all possible commands
+ #info - Go into 'info'-submenu
+ #list - Go into 'list'-submenu
+ #set - Go into 'set'-submenu
+ #
+ #Your wish is my command ... bye!
+ #Connection closed by foreign host.
-First we need to start Jack. This can be done via very easy via
-
- qjackctl
-
-if you cannot install it via packagemanager, you can dowload it here: http://qjackctl.sourceforge.net/
-
-Since we deinstalled pulse, jack will grab the hardwarecontrols if it is started, that is contra productive, so we make sure that the server runs virtual. Within
-qjackctl, you can select the settings tab and take as driver "dummy", or you start jackd with the following command:
-
- /usr/bin/jackd -T -P62 -t1000 -m -ddummy -r44100 -p256
-or write this command in your home into the .jackdrc file
-
-If you want to have the same as the demo in Dublin, start now the jack equalizer (if you don't have: http://jackeq.sourceforge.net/ or packagemanager)
-
- /usr/bin/jackeq
-
-Now it's time to start pulseaudio, since we need to start it with a special configuration, get into the pulseaudio directory and run
-
- src/pulseaudio -n -F src/default.pa -p $(pwd)/src/.libs/ -vvvv
-
-The next step is to start the DLT server
-
- dlt-daemon
-
-And a dlt client if you want to see something.
-Then get into the /bin directory of the workspace where the binaries where created and run in the following order:
-
- ./AudioManager
-
-This starts the audiomanager, you should already get some output on the DLT
-
- ./AudioGui
-
-starts the Test GUI, you can now connect and disconnect already, changing volumes works via double click on the sinks
+***********************************************************************************************************
+Code Formatting
+***********************************************************************************************************
+The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
+cmake/AudioManager_Codestyle.xml
- ./PLayerGui player youraudiofile.mp3
+***********************************************************************************************************
+Working on the code & contribution
+***********************************************************************************************************
+First get the code from the git:
+ git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/AudioManager
-starts the player application, please choose cool music.
-To test Traffic announcements, you need to create a folder on the workspace, same level as bin, called "music" and put an mp3 in there. please rename it to "ta.mp3", this file
-is taken to play the traffic announcement.
+Get an overview of all branches:
+ git branch
- ./PlayerGui ta
+Switch to the branch you want to work on (see versioning schmeme, the master is the feature branch)
+and verify that it has switched (* changed)
+ git checkout <your branch>
+ git branch
-Same for navigation, the file needs to have the name "music/navi.mp3"
+Best practice is to create a local branch based on the current branch:
+ git branch working_branch
- ./PLayerGui navigation
+Start working, best practice is to commit smaller, compilable peaced during the work that makes it easier to
+handle later on.
+If you want to commit you changes, send them to the audiomanager-dev list, you can create a patch like this:
+ git format-patch working_branch <your branch>
-***********************************************************************************************************
-Tips
-***********************************************************************************************************
-If you want to use the codebase with eclipse, define the main level of the git as workspace and import the projects as c++ makefile projects.
-Git is setup in a way that the settings are ignored when committing.
-To use make out of eclipse them, replace the default make command "make" with something like
-"make -j4 -C ../build/AudioManagerDeamon VERBOSE=1" (exchanging the name of the Project in respect to the plugin whatever.
+This creates a set of patches that are published via the mailing list (this is already the submission under CLA).
+The patches will be discussed and then merged & uploaded on the git. For more information about git checkout the
+Genivi wiki and the stuff on the web.
-***********************************************************************************************************
_..-------++._
_.-'/ | _|| \"--._
[__]==// .-. \\==`===========/==// .-. \\=[__]
`-._|\ `-' /|___\_________/___|\ `-' /|_.'
`---' `---'
-
-
-
projects / profile / ivi / genivi / genivi-audio-manager.git / blobdiff