summaryrefslogtreecommitdiff
path: root/README
blob: 486f2a3fe842f6bbb23b28f7b32dc78f42d3c606 (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
GENIVI AUDIOMANAGER

Copyright (C) 2011, BMW AG

Datum  15.1.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                                                    
	 USE_BUILD_LIBS                   OFF                                                           
	 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_TELNET                      OFF                                                           
	 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

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

in order to install the AudioManager, you can do

	sudo make install

package generation is supported via CPack. To build packages, you have to 

	make genivi_package

this will create one package if your CMake version is < 2.8.5 (all binaries stripped):
	
	AudioManager-<git verison>-Linux.deb 

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]

to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do:

	make package_source	

This will create the following package:

	AudioManager-<git verison>-Source.tar.gz

All packages will be placed in a folder called packages

The commandline options of the AudioManager:

	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)	

Telnet-Server:
   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.



The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
cmake/AudioManager_Codestyle.xml

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