summaryrefslogtreecommitdiff
path: root/README
blob: 954fc1ecc87339841bfc8c7f1770f6c68915551e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
GENIVI AUDIOMANAGER

Copyright (C) 2011, BMW AG

Datum  14.12.2012
author Christian Müller (christian.ei.mueller@bmw.de)

***********************************************************************************************************
LICENSE
***********************************************************************************************************

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

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.

Version 0.0.1

***********************************************************************************************************
CURRENT STATUS
***********************************************************************************************************
The most important parts of the audiomanager are already there - nevertheless there are main features missing (pls look at the todos)
It should be sufficient to start working on a POC around it.

***********************************************************************************************************
COMPILE PROGRAMS
***********************************************************************************************************
- compile options with default values:

 	CMAKE_BUILD_TYPE                                                                                                                  
 	CMAKE_INSTALL_PREFIX             /usr/local                                                                                       
 	WITH_DBUS_WRAPPER                ON                                                                                               
 	WITH_DOCUMENTATION               OFF                                                                                              
 	WITH_MAIN                        ON                                                                                               
	WITH_PLUGIN_COMMAND              ON                                                                                               
 	WITH_PLUGIN_CONTROL              ON                                                                                               
 	WITH_PLUGIN_ROUTING              ON                                                                                               
 	WITH_PPOLL                       ON                                                                                               
 	WITH_SIMPLEDBUS_LOOP             OFF                                                                                              
 	WITH_SOCKETHANDLER_LOOP          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 [tested on version 2.2.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/DLT-daemon

In order to build the project (out of source build), please follow these instructions on the commandline:

	mkdir /build
	cd build
	cmake ..
	make -j4

after the script finished, you should have:

	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

The commandline options of the AudioManager:

Usage:	AudioManagerDaemon [options]
options:	
	-h: print this message	
	-v: print version	
	-d: daemonize AudioManager 	
	-p: path for sqlite database (default is in memory)	
	-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)	





                                 _..-------++._
                             _.-'/ |      _||  \"--._
                       __.--'`._/_\j_____/_||___\    `----.
                  _.--'_____    |          \     _____    /
                _j    /,---.\   |        =o |   /,---.\   |_
               [__]==// .-. \\==`===========/==// .-. \\=[__]
                 `-._|\ `-' /|___\_________/___|\ `-' /|_.'     
                       `---'                     `---'