-
Notifications
You must be signed in to change notification settings - Fork 17
Home
The AudioManager is a Deamon that manages all Audio Connections in a GENIVI headunit. It is a managing instance that uses so called RoutingAdaptors to control AudioDomains that then do the "real" connections.
Copyright © 2012, GENIVI Alliance, Inc. Copyright © 2012, BMW AG
This file is part of GENIVI Project AudioManager.
Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements or MPL 2.0.
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 Linke = Christian Linke [email protected] BMW 2011-2016
The main repository is https://github.com/GENIVI/AudioManager
The repository for example plugins can be found here: https://github.com/GENIVI/AudioManagerPlugins
A very detailed documentation is provided by doxygen, it can be viewed online here: https://genivi.github.io/AudioManager
For generation of the documentaton please compile the AudioManager with
cmake -DWITH_DOCUMENTATION=ON make
The README is compiled into README.html with asciidoc
To write to the mailing list, use this adress: https://lists.genivi.org/mailman/listinfo/genivi-audio-manager
The mailing list of the Audiomanager can be found here for registration: https://lists.genivi.org/mailman/listinfo/genivi-projects
The archives here: http://lists.genivi.org/pipermail/genivi-projects/
The licenses of this project are split into two parts:
1) the AudioManagerDaemon, licensed under MPL 2.0
2) the plugins 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 MPL2.0 or MIT License, depending on the location of the code.
Can be issued here: https://github.com/GENIVI/audiomanager/issues
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 every GENIVI release, there is a release of the AudioManager, each of the releases have their own bug fix branch that will get the most important fixes. Development is done on the master branch.
The versioning scheme was decided in the February face2face 2012. The first number describes the release branch. This is 1 for Discovery, 2 for Excalibur and 3 for Foton. For major features or release, the second number will be increased. 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). The next commit on the master branch gets then the new first number (3) and starts from zero.
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. 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. Whenever changes are done, the minor version of the interface needs to be incremented.
Since 7.0, the AudioManager follows a new versioning scheme. Please check the documentation for that.
These are the compile options with default values:
AudioManager Configuration: -- CMAKE_BUILD_TYPE = -- CMAKE_INSTALL_PREFIX = /usr/local -- BUILD_DOCUMENTATION = OFF -- WITH_TESTS = ON -- WITH_DLT = ON -- WITH_TESTS = ON -- WITH_TELNET = ON -- WITH_SYSTEMD_WATCHDOG = OFF -- WITH_CAPI_WRAPPER = ON -- WITH_DBUS_WRAPPER = OFF -- WITH_SHARED_UTILITIES = OFF -- WITH_SHARED_CORE = OFF -- DYNAMIC_ID_BOUNDARY = 100 -- LIB_INSTALL_SUFFIX = audiomanager -- TEST_EXECUTABLE_INSTALL_PATH = ~/tests -- DEFAULT_PLUGIN_COMMAND_DIR = /usr/local/lib/audiomanager/command -- DEFAULT_PLUGIN_ROUTING_DIR = /usr/local/lib/audiomanager/routing -- CONTROLLER_PLUGIN_DIR = /usr/local/lib/audiomanager/control -- AM_SHARE_FOLDER = /usr/local/share/audiomanager -- AM_MAP_CAPACITY = 10 -- AM_MAX_CONNECTIONS = 0x1000 -- AM_MAX_MAIN_CONNECTIONS = 0x1000 -- BUILD_TESTING = ON -- CommandInterface version: 4.0 -- ControlInterface version: 5.0 -- RoutingInterface version: 5.0
Standard CMake can be used to configure these options. Tools like ccmake can be used to visually change the values. For each option, some hints are given.
Basically, all build dependencies are optional- but you might need to use some if you want to have support for Dbus, for example…
You will need optionally fulfill some dependencies in order to compile the GENIVI AudioManager Daemon, these are:
-
dbus (only when WITH_DBUS_WRAPPER==ON) [tested on version 1.2.16]
-
automotive-dlt [greater 2.5.0] (only when WITH_DLT==ON)
-
doxygen [tested on version 1.6.3] (only when WITH_DOCUMENTATION==ON)
-
commonAPI [version > 3.1.5] (only with WITH_CAPI_WRAPPER), more information here http://projects.genivi.org/commonapi/
-
systemd [ version > 44 ] (only WITH_SYSTEMD_WATCHDOG)
In the AudioManagerUtilites you can find helper functions that can be reused by other projects as well. The library can be shipped as a static or a dynamic link library (WITH_SHARED_UTILITIES).
The AudioMangerCore is build as a static (or with WITH_SHARED_CORE) library. Sometimes it is useful for unit testing of a plugin to compile against the core.
The commonapi wrapper provides the mainloop intergration for commonapi into the Mainloop of the audiomanager (CAmSockethandler). In order to use it, just use:
CAPI->registerService(....) CAPI->buildProxy(...)
instead of the standard calls. The CAPIWrapper will serialize the commands and integrate it smoothly with the mainloop.
For building the tests, you will need the following packages:
-
python [tested on version 2.6, should work on higher versions as well]
GoogleMock and GoogleTest are as source code integrated in the source tree To install them in a build environment like Ubuntu you can use:
sudo apt-get install python2.6-dev
For compiling, you will need a compiler, linker etc. On most Linux systems you will get this via
sudo apt-get install build-essential
More details in the CMake Files CmakeList.txt in the projects.
To compile open a shell, browse to the AudioManager folder and
mkdir /build cd build cmake .. make
The AudioManager executable will be placed in the bin folder of your build folder, tests in a sub folder below.-
In order to install the AudioManager, you can do
sudo make install
this installs everything.
The commandline options of the AudioManager:
USAGE:
./AudioManager [-K <string>] [-m <int>] [-t <int>] [-i] [-r <string>]
[-R <string>] [-l <string>] [-L <string>] [-c <string>]
[--] [--version] [-h]
Where:
-K <string>, --controllerPluginArg <string>
a test argument for the controller
-m <int>, --maxConnections <int>
Maximal number of connections for telnet
-t <int>, --telnetport <int>
The port that is used for telnet
-i, --currentSettings
print current settings and exit
-r <string>, --RoutingPluginDir <string>
path for looking for routing plugins
-R <string>, --additionalRoutingPluginDirs <string>
additional path for looking for routing plugins, can be used after -r
option
-l <string>, --CommandPluginDir <string>
path for looking for command plugins
-L <string>, --additionalCommandPluginDirs <string>
additional path for looking for command plugins, can be used after -l
option
-c <string>, --controllerPlugin <string>
use controllerPlugin full path with .so ending
--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.
--version
Displays version information and exits.
-h, --help
Displays usage information and exits.
The team of the AudioManager wishes you a nice day!
To learn more about the commandline options, check the doxygen documentation.