-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
+GENIVI_AudioManager
+===================
+:Author: Christian Linke <christian.linke@bmw.de>
+:doctitle: GENIVI_AudioManager
+
+Copyright
+---------
+Copyright (C) 2012, GENIVI Alliance, Inc.
+Copyright (C) 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 .
+
+(C) Copyright
+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 Mueller, christian.linke@bmw.de BMW 2011,2012
+
+For further information see http://projects.genivi.org/audio-manager/.
+
+== License
+The licenses of this project are split into two parts:
+1) the AudioManagerDaemon, licensed under MPL 2.0
+2) all other parts 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 GENIVI CLA or MPL2.0.
+
+== Version
+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 an own bugfix branch that will get the most important fixes.
+Development is done on the master branch.
+
+=== Versioning Scheme
+The versioning scheme was decided in the February face2face 2012.
+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.
+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 numner (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.
+
+== Documentation
+A very detailed documentation is provided by doxygen. In order to use this, please compile the AudioManager with
+----
+cmake -DWITH_DOCUMENTATION=ON
+make
+----
+
+== COMPILE PROGRAMS
+
+=== Compile Options
+These are the compile options with default values:
+
+ BUILD_SHARED_LIBS OFF
+ CMAKE_BUILD_TYPE
+ CMAKE_INSTALL_PREFIX /usr/local
+ COMMON_API_DBUS_LIBRARY /usr/local/lib/libCommonAPI-DBus.so
+ COMMON_API_LIBRARY /usr/local/lib/libCommonAPI.so
+ GLIB_DBUS_TYPES_TOLERANT ON
+ USE_BUILD_LIBS ON
+ WITH_COMMAND_INTERFACE_COMMON_ ON
+ WITH_DATABASE_STORAGE OFF
+ WITH_DLT ON
+ WITH_DOCUMENTATION ON
+ WITH_ENABLED_IPC CAPI
+ WITH_LOGSTATE ON
+ WITH_NSM ON
+ WITH_OXF_ANIMATION OFF
+ WITH_OXF_TRACE OFF
+ WITH_PLUGIN_COMMAND ON
+ WITH_PLUGIN_CONTROL ON
+ WITH_PLUGIN_ROUTING ON
+ WITH_ROUTING_INTERFACE_ASYNC OFF
+ WITH_ROUTING_INTERFACE_CAPI ON
+ WITH_SYSTEMD_WATCHDOG OFF
+ WITH_TELNET ON
+ WITH_TESTS ON
+ WITH_TEST_CONTROLLER OFF
+ gmock_build_tests OFF
+ gtest_build_samples OFF
+ gtest_build_tests OFF
+ gtest_disable_pthreads OFF
+ gtest_force_shared_crt OFF
+
+=== Passing options to cmake:
+
+.-DVERSION="XXX"
+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.
+
+.-DDBUS_SERVICE_PREFIX="XXX"
+sets the service prefix for Dbus, default "org.genivi.audiomanager\0"
+
+.-DDBUS_SERVICE_OBJECT_PATH="XXX"
+sets the object path for Dbus, default "/org/genivi/audiomanager\0"
+
+.-DDEFAULT_TELNETPORT="XXX"
+sets the default telnetport, default 6060. Can be overwriten by command line parameter
+
+.-DMAX_TELNETCONNECTIONS="XXX"
+sets the default maximum number of telnetconnections, default is 3
+
+.-DNSM_PATH="XXX"
+sets the path of the NSM DBUS interface
+
+.-DNSM_INTERFACE="XXX"
+sets the interface to the NSM DBUS interface
+
+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)
+
+=== Build dependencies
+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 fullfill some dependencies 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] (only when WITH_DATABASE_STORAGE==ON)
+* 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 > 2.1] (only with WITH_ENABLED_IPC CAPI), more information here http://projects.genivi.org/commonapi/
+
+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
+----
+
+=== The NodeStateManager
+
+The nodestatemanager headers are needed to compile the audiomanager. If the nodestatemanagerincludes are not found,
+the headers shipped with the audiomanager are used.
+The nodestatemanager can be retrieved from projects.genivi.org . You can install the headers on you system by
+
+----
+sudo make install-includeHEADERS
+----