README

   1 GENIVI_AudioManager
   2 ===================
   3 :Author: Christian Linke <christian.linke@bmw.de>
   4 :doctitle: GENIVI_AudioManager
   5
   6 Copyright
   7 ---------
   8 Copyright (C) 2012, GENIVI Alliance, Inc.
   9 Copyright (C) 2012, BMW AG
  10
  11 This file is part of GENIVI Project AudioManager.
  12
  13 Contributions are licensed to the GENIVI Alliance under one or more
  14 Contribution License Agreements or MPL 2.0 .
  15
  16 (C) Copyright
  17 This Source Code Form is subject to the terms of the
  18 Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
  19 this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  20
  21 author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
  22
  23 For further information see http://projects.genivi.org/audio-manager/.
  24
  25 == License
  26 The licenses of this project are split into two parts:
  27 1) the AudioManagerDaemon, licensed under MPL 2.0
  28 2) all other parts that serve as example code that can be taken to build up an own project with it -
  29     these parts are licensed with the MIT license
  30
  31 Contribution is done under GENIVI CLA or MPL2.0.
  32
  33 == Version
  34 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).
  35 For every GENIVI release, there is a release of the AudioManager, each of the releases have an own bugfix branch that will get the most important fixes.
  36 Development is done on the master branch.
  37
  38 === Versioning Scheme
  39 The versioning scheme was decided in the February face2face 2012.
  40 The firs number describes the release branch. This is 1 for discovery, 2 for excalibur and 3 for photon. For major features or release, the second number will be increased.
  41 Each new GENIVI version (releases are every half year, around april and october) will get the current HEAD (for example 2.0.34 for excalibur) and release with the increase of the second number (2.1).
  42 The next commit on the master branch gets then the new first numner (3) and starts from zero.
  43
  44 For the daemon the third number (for example 1.0.X) describes the patch version. The versions are automatically created by git during the build process.
  45 The versioning scheme is used for the AudioManager daemon itself and for each of it's interfaces. The versioning of the Interfaces in EA is defined via the tag "version" and the name of the interfaceversion versionName, for example "CommandReceiveVersion". This information is generated into the interface header files and is used then by cmake to set the interface versions.
  46 Whenever changes are done, the minor version of the interface needs to be incremented.
  47
  48 == Documentation
  49 A very detailed documentation is provided by doxygen. In order to use this, please compile the AudioManager with
  50 ----
  51 cmake -DWITH_DOCUMENTATION=ON
  52 make
  53 ----
  54
  55 == COMPILE PROGRAMS
  56
  57 === Compile Options
  58 These are the compile options with default values:
  59
  60  BUILD_SHARED_LIBS                OFF
  61  CMAKE_BUILD_TYPE
  62  CMAKE_INSTALL_PREFIX             /usr/local
  63  GLIB_DBUS_TYPES_TOLERANT         ON
  64  USE_BUILD_LIBS                   ON
  65  WITH_DBUS_WRAPPER                ON
  66  WITH_DLT                         ON
  67  WITH_DOCUMENTATION               OFF
  68  WITH_MAIN                        ON
  69  WITH_PLUGIN_COMMAND              ON
  70  WITH_PLUGIN_CONTROL              ON
  71  WITH_PLUGIN_ROUTING              ON
  72  WITH_SYSTEMD_WATCHDOG            OFF
  73  WITH_TELNET                      ON
  74  WITH_TESTS                       ON
  75  gmock_build_tests                OFF
  76  gtest_build_samples              OFF
  77  gtest_build_tests                OFF
  78  gtest_disable_pthreads           OFF
  79  gtest_force_shared_crt           OFF
  80
  81 === Passing options to cmake:
  82
  83 .-DVERSION="XXX"
  84 When building the AudioManager without taking it from the git (and thus having a .git folder), you can set the version via passing _-DVERSION="XXX"_ to cmake.
  85
  86 .-DDBUS_SERVICE_PREFIX="XXX"
  87 sets the service prefix for Dbus, default "org.genivi.audiomanager\0"
  88
  89 .-DDBUS_SERVICE_OBJECT_PATH="XXX"
  90 sets the object path for Dbus, default "/org/genivi/audiomanager\0"
  91
  92 .-DDEFAULT_TELNETPORT="XXX"
  93 sets the default telnetport, default 6060. Can be overwriten by command line parameter
  94
  95 .-DMAX_TELNETCONNECTIONS="XXX"
  96 sets the default maximum number of telnetconnections, default is 3
  97
  98 In order to change these options, you can modify this values with ccmake, do the appropriate changes in
  99 CmakeList.txt or via the commandline for cmake or (when installed via ccmake)
 100
 101 === Build dependencies
 102 You will need to fullfill some dependencies in order to comile the GENIVI AudioManager Daemon, these are:
 103
 104 * dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
 105 * sqlite3 [tested on version 3.6.22]
 106 * automotive-dlt [greater 2.5.0]
 107 * doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
 108
 109 To install them in a build environment like Ubuntu you can use:
 110 ----
 111 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
 112 ----
 113
 114 For building the tests, you will need the following packages:
 115
 116 * python [tested on version 2.6, should work on higher versions as well]
 117
 118 GoogleMock and GoogleTest are as source code integrated in the sourcetree
 119 To install them in a build environment like Ubuntu you can use:
 120 ----
 121 sudo apt-get install python2.6-dev
 122 ----
 123
 124 For compiling, you will need a compiler, linker etc. On most linux systems you will get this via
 125 ----
 126 sudo apt-get install build-essential
 127 ----
 128
 129 More details in the CMake Files CmakeList.txt in the projects.
 130
 131 === Compiling
 132 To compile open a shell, browse to the AudioManager folder and
 133 ----
 134 mkdir /build
 135 cd build
 136 cmake ..
 137 make
 138 ----
 139
 140 After the script finished, you should have:
 141
 142 * a bin/ folder which contains all executables and the libraries:
 143 * a build/ folder which has all build objects (erase that if you need a clean build)
 144 * a doc/ folder in case you turned the documentation on
 145
 146 In order to install the AudioManager, you can do
 147 ----
 148 sudo make install
 149 ----
 150
 151 Package generation is supported via CPack. To build packages, you have to
 152 ----
 153 make genivi_package
 154 ----
 155
 156 This will create one package if your CMake version is < 2.8.5 (all binaries stripped):
 157 ----
 158 AudioManager-<git verison>-Linux.deb
 159 ----
 160
 161 If your version is above 2.8.5, you will get 4 packages (all binaries stripped) :
 162
 163 * AudioManager-<git verison>-Linux-bin.deb              [AudioManager binary]
 164 * AudioManager-<git verison>-Linux-dev.deb              [header files needed to compile plugins]
 165 * AudioManager-<git verison>-Linux-sampleplugins.deb    [sample plugins]
 166 * AudioManager-<git verison>-Linux-tests.deb            [tests including tests for sample plugins, installed in the ~/AudioMAnagerTests]
 167
 168 In order to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do:
 169 ----
 170 make package_source
 171 ----
 172
 173 This will create the following package:
 174 'AudioManager-<git verison>-Source.tar.gz'
 175
 176 All packages will be placed in a folder called packages
 177
 178 === Adding own plugins
 179 Since the AudioManager needs to be completed with on plugins before it can be used, it provides a mechanism to keep the own sources away from the GENIVI code but compile them together.
 180
 181 TIP: Using this feature is simple: +
 182 Just add a folder with the name _ProjectSpecific_ (be sure to name it excactly like this!) on the main level of the AudioManager folder. CMake will look for CMakeLists.txt in this folder and add all files that it finds in /include to the include path. You can use this to add subfolders with your own plugins and includes, and overwrite productspecific.h for example.
 183
 184 .Here is a sample CMakeLists.txt that can be placed in ProjectSpecific folder:
 185 ----
 186 cmake_minimum_required(VERSION 2.6)
 187
 188 ### set your own buildflags:
 189 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -Wall -Wextra -std=c++98 -D_GNU_SOURCE -pedantic -Wno-variadic-macros")
 190
 191 ##overwrite priojecttypes.h:
 192 CONFIGURE_FILE( ${CMAKE_SOURCE_DIR}/ProjectSpecific/overwrite/projecttypes.h ${CMAKE_SOURCE_DIR}/include/projecttypes.h COPYONLY)
 193
 194 if(WITH_PLUGIN_ROUTING)
 195         add_subdirectory (../PluginRoutingInterfaceMyRoutingPlugin ${CMAKE_CURRENT_BINARY_DIR}/PluginRoutingInterfaceMyRoutingPlugin )
 196 endif(WITH_PLUGIN_ROUTING)
 197
 198 if(WITH_PLUGIN_CONTROL)
 199         add_subdirectory ( ../PluginControlInterfaceMyControlPlugin ${CMAKE_CURRENT_BINARY_DIR}/PluginControlInterfaceMyControlPlugin)
 200 endif(WITH_PLUGIN_CONTROL)
 201
 202 ----
 203
 204 === CommandLine options
 205 The commandline options of the AudioManager:
 206
 207 ----
 208 AudioManagerDaemon Version: 3.0.11
 209 Usage:  AudioManagerDaemon [options]
 210 options:
 211         -h: print this message
 212         -i: info about current settings
 213         -v: print version
 214         -d: daemonize AudioManager
 215         -T: DbusType to be used by CAmDbusWrapper (0=DBUS_SESSION[default], 1=DBUS_SYSTEM)
 216         -p<path> path for sqlite database (default is in memory)
 217         -t<port> port for telnetconnection
 218         -m<max> number of max telnetconnections
 219         -c<Name> use controllerPlugin <Name> (full path with .so ending)
 220         -l<Name> replace command plugin directory with <Name> (full path)
 221         -r<Name> replace routing plugin directory with <Name> (full path)
 222         -L<Name> add command plugin directory with <Name> (full path)
 223         -R<Name> add routing plugin directory with <Name> (full path)
 224 ----
 225
 226
 227 == Telnet Server
 228 The audiomanager has a build- in telnetserver that serves for debuggin purposes.
 229 If you compile your AudioManager with TelnetServer support (cmake -DWITH_TELNET=ON), you will be able to
 230 set with commandline argument -t the port number and with -m the maximum supported connections.
 231 The default telnet port is 6060.
 232
 233 .For example, launch a telnet session on port 6060:
 234       telnet localhost 6060
 235
 236       #>Welcome to GENIVI AudioManager ver-0.0.1-37-ga004215
 237       #>
 238
 239 .press 'help' to get a list of all supported commands on this level:
 240
 241       #>help
 242       ####################################################
 243       ####### The following commands are supported: ######
 244       ####################################################
 245       #
 246       #exit  - quit telnet session
 247       #get   - Go into 'get'-submenu
 248       #help  - show all possible commands
 249       #info  - Go into 'info'-submenu
 250       #list  - Go into 'list'-submenu
 251       #set   - Go into 'set'-submenu
 252       #
 253       #\>
 254
 255 .Now type one of these commands, for example 'get', followed with another 'help' to get a list of supported commands:
 256
 257       #\>get
 258       #
 259       #\Get>help
 260       ####################################################
 261       ####### The following commands are supported: ######
 262       ####################################################
 263       #
 264       #.. - one step back in menu tree (back to root folder)
 265       #exit  - close telnet session
 266       #help  - show all possible commands
 267       #recv  - show receiverversion
 268       #routing  - show current routing
 269       #sendv - show senderversion
 270       #
 271       #\Get>
 272
 273 .You can also execute several commands in a line:
 274
 275       #\Get>recv sendv .. help exit
 276       #   Receiver versions:
 277       #   Ctrl: 1 | Cmd: 1 | Routing: 1
 278       #   Sender versions:
 279       #   Ctrl: 1 | Cmd: 1 | Routing: 1
 280       ####################################################
 281       ######## The following commands are supported: ######
 282       ####################################################
 283       #
 284       #exit  - quit telnet session
 285       #get   - Go into 'get'-submenu
 286       #help  - show all possible commands
 287       #info  - Go into 'info'-submenu
 288       #list  - Go into 'list'-submenu
 289       #set   - Go into 'set'-submenu
 290       #
 291       #Your wish is my command ... bye!
 292       #Connection closed by foreign host.
 293
 294
 295
 296 == Code Formatting
 297 The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
 298 ----
 299 cmake/AudioManager_Codestyle.xml
 300 ----
 301
 302 == Working on the code & contribution
 303
 304 .First get the code from the git:
 305         git clone
 306
 307 .Get an overview of all branches:
 308         git branch
 309
 310 .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)
 311         git checkout <your branch>
 312         git branch
 313
 314 .Best practice is to create a local branch based on the current branch:
 315         git branch working_branch
 316
 317 Start working, best practice is to commit smaller, compilable peaced during the work that makes it easier to
 318 handle later on.
 319
 320 .If you want to commit you changes, send them to the audiomanager-dev list, you can create a patch like this:
 321         git format-patch working_branch <your branch>
 322
 323 This creates a set of patches that are published via the mailing list.The patches will be discussed and then merged & uploaded on the git by the maintainer.
 324
 325 Patches can be accepted either under GENIVI Cla or MPL 2.0 (see section License). Please be sure that the signed-off-by is set correctly. For more, check out http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html
 326
 327
 328
 329 ----
 330                                             _             _ _       __  __
 331                                            / \  _   _  __| (_) ___ |  \/  | __ _ _ __   __ _  __ _  ___ _ __
 332                                           / _ \| | | |/ _` | |/ _ \| |\/| |/ _` | '_ \ / _` |/ _` |/ _ \ '__|
 333                                          / ___ \ |_| | (_| | | (_) | |  | | (_| | | | | (_| | (_| |  __/ |
 334                                         /_/   \_\__,_|\__,_|_|\___/|_|  |_|\__,_|_| |_|\__,_|\__, |\___|_|
 335                                                                                              |___/
 336
 337
 338
 339
 340                                                                         QQ
 341                                                                         QQ[
 342                                                                   qaap
 343                                                                   )4W? ayQap
 344                                                                        4QQQ[
 345                                                               .awQap   ==
 346                                                                $WWQF   aaaa,
 347                                                                  `    QWQWQQ
 348                                                             _aaap=    J?QQP'|
 349                                                            qQQWQQ6    -      qyQQQgp
 350                                                            )4QQQQ^ .yQQQQ,   QQQQQQQ
 351                                                          aa         4QQQW'   )?QQQP'  gmQQma
 352                                                        ]QQQQp         .               WQQQQW
 353                                                         ????    aQQQ6p    _aQQQQa      "??"+
 354                                                        qaaa,   ]QQQQQQ    jQQQQQQf   -aaaap
 355                                                       jQQWWQ    )????'    )4QQQQP'   mQWQWQf
 356                                                       ]WQQQQ    jaaa                 QQQQQQf
 357                                                       )WQQQQ   yQQWWQp    ayQQQap    QQQQQQf
 358                                                       )QQQQQ   QQQQQQf   ]QQQQQQQ,   QQQQQQf
 359                                                       ]QQQQD   QQQQQQf   ]QQQQQQQ[   QQQQQQf
 360                                                         ??':   QQQQQQf   ]QQQQQQQ[   4QQQQQf
 361                                                                QQQQQQf   ]QQQQQQQ[   =????'I
 362                                                                QQQQQQf   ]QQQQQQQ[
 363                                                               .4QQQQQ'   ]QQQQQQQ[
 364                                                                 ]??"-    ]QQQQQQQ(
 365                                                                          ]4QQQQQ?
 366                                                                            :
 367
 368                             qaayQQQQQQQQQwaa   ]mmmmmmmmmmmmmm  ]mmmmmmg,     ]mmm[  ]mmmm  4mmmg         ymmm' ]mmmm pwLq
 369                            jQQQQD???????QWWQf  ]QQQP??????????  ]QQQWQQQQp    ]QQQf  ]QQQQ   4QQQ6.     _yQQQ'  ]QQQQ \!'a'
 370                            ]QQQf        )???'  ]QQQ6aaaaaaaaap  ]QQQf)4QQQ6,  ]QQQf  ]QQQQ   |4QQQ6    jmQQQ'v  ]QQQQ
 371                            ]QQQ[   ]QQQQWWQQf  ]QQQQQQQWQWQWQf  ]QQQf  ?QQQQa ]QQQf  ]QQQQ    i4QQQ6  qQQQQ'    ]QQQQ
 372                            ]QQQ6,   .   qQQQf  ]QQQf            ]QQQf   ]4QQQ6jQQQf  ]QQQQ      4QQQ6gQWQQ'     ]QQQQ
 373                             4QQQQQQQQQQQQQQW'  ]QQQQQQWQWQWQWQ  ]QQQf    i?QQQQQQQf  ]QQQQ       ]QQQQQQQ'      ]QQQQ
 374                             ++"??????????`     ]""!"""""""""""S ]""!'      ]"""!""'  -""!"        """!""'       ]""!"
 375
 376
 377 ----