README

   1 GENIVI AUDIOMANAGER
   2
   3 Copyright (C) 2011, BMW AG
   4
   5 Datum  14.12.2012
   6 author Christian Müller (christian.ei.mueller@bmw.de)
   7
   8 ***********************************************************************************************************
   9 LICENSE
  10 ***********************************************************************************************************
  11
  12 GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
  13 Copyright (C) 2011, BMW AG – Christian Müller  Christian.ei.mueller@bmw.de
  14
  15 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.
  16 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.
  17 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>.
  18 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.
  19 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.
  20 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.
  21 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.
  22
  23 Version 0.0.1
  24
  25 ***********************************************************************************************************
  26 CURRENT STATUS
  27 ***********************************************************************************************************
  28 The most important parts of the audiomanager are already there - nevertheless there are main features missing (pls look at the todos)
  29 It should be sufficient to start working on a POC around it.
  30
  31 ***********************************************************************************************************
  32 COMPILE PROGRAMS
  33 ***********************************************************************************************************
  34 - compile options with default values:
  35
  36         CMAKE_BUILD_TYPE
  37         CMAKE_INSTALL_PREFIX             /usr/local
  38         WITH_DBUS_WRAPPER                ON
  39         WITH_DOCUMENTATION               OFF
  40         WITH_MAIN                        ON
  41         WITH_PLUGIN_COMMAND              ON
  42         WITH_PLUGIN_CONTROL              ON
  43         WITH_PLUGIN_ROUTING              ON
  44         WITH_PPOLL                       ON
  45         WITH_SIMPLEDBUS_LOOP             OFF
  46         WITH_SOCKETHANDLER_LOOP          ON
  47         WITH_TESTS                       ON
  48
  49 In order to change these options, you can modify this values with ccmake, do the appropriate changes in CmakeList.txt or via
  50 the commandline for cmake or (when installed via ccmake)
  51
  52 You will need some packages in order to comile the GENIVI AudioManager Daemon, these are:
  53         -dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
  54         -sqlite3 [tested on version 3.6.22]
  55         -automotive-dlt [tested on version 2.2.0]
  56         -doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
  57
  58         to install them in a build environment like Ubuntu you can use:
  59                 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
  60
  61 For building the tests, you will need the following packages:
  62         -google mock [tested on version 1.6.0-1]
  63         -google test [tested on version 1.6.0]
  64         -python [tested on version 2.6]
  65
  66         to install them in a build environment like Ubuntu you can use:
  67                 sudo apt-get install libgtest-dev google-mock python2.6-dev
  68
  69 More details in the CMake Files CmakeList.txt in the projects.
  70
  71 The build was tested on a freshly setup LinuxMint 12 (don't like Unity) with the following steps:
  72         sudo apt-get update
  73         sudo apt-get upgrade
  74         sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake build-essential python2.6-dev
  75
  76         git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/DLT-daemon
  77
  78 In order to build the project (out of source build), please follow these instructions on the commandline:
  79
  80         mkdir /build
  81         cd build
  82         cmake ..
  83         make -j4
  84
  85 after the script finished, you should have:
  86
  87         a /bin folder which contains all executables and the libraries:
  88         a /build folder which has all build objects (erase that if you need a clean build)
  89         a /doc folder in case you turned the documentation on
  90
  91 The commandline options of the AudioManager:
  92
  93 Usage:  AudioManagerDaemon [options]
  94 options:
  95         -h: print this message
  96         -v: print version
  97         -d: daemonize AudioManager
  98         -p: path for sqlite database (default is in memory)
  99         -c: <Name> use controllerPlugin <Name> (full path with .so ending)
 100         -l: <Name> replace command plugin directory with <Name> (full path)
 101         -r: <Name> replace routing plugin directory with <Name> (full path)
 102         -L: <Name> add command plugin directory with <Name> (full path)
 103         -R: <Name> add routing plugin directory with <Name> (full path)
 104
 105
 106
 107
 108
 109                                  _..-------++._
 110                              _.-'/ |      _||  \"--._
 111                        __.--'`._/_\j_____/_||___\    `----.
 112                   _.--'_____    |          \     _____    /
 113                 _j    /,---.\   |        =o |   /,---.\   |_
 114                [__]==// .-. \\==`===========/==// .-. \\=[__]
 115                  `-._|\ `-' /|___\_________/___|\ `-' /|_.'
 116                        `---'                     `---'