diff options
Diffstat (limited to 'AudioManagerDaemon/docx')
78 files changed, 0 insertions, 1762 deletions
diff --git a/AudioManagerDaemon/docx/01_mainpage.dox b/AudioManagerDaemon/docx/01_mainpage.dox deleted file mode 100644 index ad0848b..0000000 --- a/AudioManagerDaemon/docx/01_mainpage.dox +++ /dev/null @@ -1,30 +0,0 @@ -/** - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\mainpage - -\image html genivilogo.png - -\par More information -can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n - -\par About AudioManager -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. - -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/02_license.dox b/AudioManagerDaemon/docx/02_license.dox deleted file mode 100644 index d7fc220..0000000 --- a/AudioManagerDaemon/docx/02_license.dox +++ /dev/null @@ -1,38 +0,0 @@ -/* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page lic License -\section proj Open Source Projects in the source tree -The AudioManger comes with some open source software distributed in the source tree: -- Google Mock (in \googleMock), licensed under MIT license -- Tclap ( in \tclap-1.2.1), licensed under MIT license -\section split License Split -The licenses of this project are split into two parts:\n -1. the AudioManagerDaemon, licensed under MPL 2.0\n -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 -\section mpl Mozilla Public License, v. 2.0 -http://mozilla.org/MPL/2.0/ -\section mit MIT license -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, -including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR -THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/02_x_dependecies.dox b/AudioManagerDaemon/docx/02_x_dependecies.dox deleted file mode 100644 index ff5c346..0000000 --- a/AudioManagerDaemon/docx/02_x_dependecies.dox +++ /dev/null @@ -1,26 +0,0 @@ -/* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - - /*! -\page dep Dependencies -\section deps Dependency Graph -\image html dependencies.png -\section deptest Depedency Graph for Tests -\image html dependencies_test.png -\section depgen Generated Dependency Graph -\image html dependency_created.png -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/02_y_versioning.dox b/AudioManagerDaemon/docx/02_y_versioning.dox deleted file mode 100644 index 864a04e..0000000 --- a/AudioManagerDaemon/docx/02_y_versioning.dox +++ /dev/null @@ -1,31 +0,0 @@ -/* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - - /*! -\page ver Versioning -\section new_ver New versioning scheme -Due to the unclearness in the versioning scheme, the versioning scheme changed with release 7.0. -Beginning with the 7.0 version, the versioning changed to the semantic versioning described here: <a href="http://semver.org/">http://semver.org/</a>. -For every version that released for GENIVI (independent from the compliance), a stable branch will be created which will start with a minor number increase. On the masterbranch, no minor number increases are foreseen. -\image html versioning_new.png -\section ver_graph The versioning scheme until 7.0 -The versioning scheme was decided in the February face2face 2012. -\image html versioning.png -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. -*/ diff --git a/AudioManagerDaemon/docx/03_architecture_overview.dox b/AudioManagerDaemon/docx/03_architecture_overview.dox deleted file mode 100644 index c38bb60..0000000 --- a/AudioManagerDaemon/docx/03_architecture_overview.dox +++ /dev/null @@ -1,85 +0,0 @@ -/* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page architecturepage Architecture Overview - -The architecture concept bases on the partition of management (logic) and routing (action). Sinks and sources are clustered -into independent parts which are capable of exchanging audio with each other (AudioDomains). Between these AudioDomains, -Audio can be interchanged via Gateways. \n -Since the routing and the management shall be independent from the actual used system, it is realized as an OwnedComponent, -the AudioManager. Each AudioDomain has a Routing Adapter which implements some necessary logic and is the interface between -the AudioManager and the AudioDomains. - -\section domains Audio Domains - -\image html AudioDomains.gif -An Audio Domain consists of sinks and sources that can exchange audio with each other. To make the most out of the concept, -AudioDomains shall be chosen in such a way that they are implemented by already existing audio routing engines. - -The AudioManager assumes that there are no restrictions in interconnection of sinks and sources. One or more sources can be -connected to one sink and one or more sinks can be connected to one source. Since real hardware or software might end up in -having restrictions, the knowledge of this must exist in the AudioManager and handled by him accordingly. This shall be -accomplished via a plug-in mechanism. An AudioDomain is not tied to a hardware or software implementation. It can be software -or hardware or even a combination of both. \n - -Examples for possible audio domains:\n -PulseAudio, Alsa, Jack, DSP, FPGA, MOST, In-chip switching matrix\n - -The clustering and usage of the AudioDomains will vary from each product. Care must be taken while choosing the right AudioDomains -in regards to system load (due to resampling), latency and of course flexibility.\n -In special implementations of the AudioDomain, it is capable of operation a certain time without interaction to the AudioManager. -This is needed to fulfill the requirements for Early & Late Audio, more information can be found below. -am::am_Domain_s describe the attribiutes of a domain. - -\section routing_adaptor Routing Adapter - -Via this adapter, the interconnection from the AudioManager to the AudioDomains is accomplished. An AudioDomain shall have exactly -one RoutingAdapter. In the terms of GENIVI, a RoutingAdapter is an AbstractComponent, this means that we define an API and a certain -behavior in UML models but do not maintain components itself. Existing implementations from Proof of Concepts are shipped as example -Adapters "as is" but cannot be seen as maintained components.\n -The implementation of a routing adapter can and will vary from each project to another since the combination of sinks and sources, -the used hardware etc has influence on the adapters. Besides interchanging and abstracting information between the AudioManager and -the sinks and sources, the Adapters also need to implement some business logic in order to interact with the AudioManager. -This include for example the registering of components, managing the current state, error handling etc.\n -In the special case of an EarlyDomain, the routing adapter also has to manage start-up and rundown including persistence for his -domain while the AudioManager is not started or already stopped. During this periods of time, these special adapters have to be able -to fulfill basic tasks like changing volumes, for example (this implies that the Adapter is implemented on a different piece of -hardware, e.g. vehicle processor). - -\section gateway Gateway - -\image html Gateway.gif - -Gateways are used to let audio flow between two domains. They always have a direction and can only transport one stream at a time. -Several gateways connecting the same domains together can exist in parallel so that more than one source can be connected to more -than one sink from the same domains at the same time.\n -In principle, gateways have the ability to convert the connectionFormat of an audiostream, for example the sink could receive audio -in a digital form and output it as analog (sound card). In order to express the conversion capabilities of a gateway, a matrix of -all source/sink connectionFormats is given (details below). The sources and sinks of a gateway are registered like ordinary sources -and sinks where the domains have the responsibility to register "their" sinks and sources.\n -For every gateway, a controlDomain is defined, this is the domain that registered the gateway. At the time of registering, the ID of -the "other end" of the gateway might be unknown. To handle this situation, a domain can "peek" Domains, Sources and Sinks. When -something is peeked, it means that an ID is reserved for a unique name without registering it.\n -If a gateway is deregistered, the source or sink of the controlling domain is deregistered as well - not the one in the "other" domain. - -\section converter Converter - -Converters are very similar to gateways - the only difference is that they work inside a domain. The usage of gateways is analog to -gateways. - -*/ diff --git a/AudioManagerDaemon/docx/03_x_uml_model.dox b/AudioManagerDaemon/docx/03_x_uml_model.dox deleted file mode 100644 index 802d181..0000000 --- a/AudioManagerDaemon/docx/03_x_uml_model.dox +++ /dev/null @@ -1,49 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page uml UML Model auf the AudioManager -\section svn Audio Manager Branch -The SVN link to the AudioManager branch can be found here: https://svn.genivi.org/uml-model/genivi/branch/eg-mg-audiomanager -The last valid version that is compliant can be found on the trunk.\n -For more information about the EA model, please see here: https://collab.genivi.org/wiki/display/genivi/Audio+Management+UML+Model -After the EA Model is updated via "Get All latest", the relevant parts for Audio Management are:\n -- Requirements on System Level -\code -GENIVI Model -> Requirements View -> Media and Graphics -> Audio Management -\endcode -- Use Cases on System Level -\code -GENIVI Model -> Use Case View -> Audio Management -\endcode -- Requirements on Component Level -\code -GENIVI Model -> Logical View -> SW platform Requirements -> Multimedia -> AudioManagement -\endcode -- Use Cases on Component Level -\code -GENIVI Model -> Logical View -> Use Case Realizations -> AudioManagement -\endcode -- Component Diagram -\code -GENIVI Model -> Logical View -> SW Platform Components -> Audio Management -\endcode -- Implementation Class & Component diagrams: -\code -GENIVI Implementation -> Implementation View -> Audio Management -\endcode -*/ diff --git a/AudioManagerDaemon/docx/04_components.dox b/AudioManagerDaemon/docx/04_components.dox deleted file mode 100644 index 7c8f9b4..0000000 --- a/AudioManagerDaemon/docx/04_components.dox +++ /dev/null @@ -1,99 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - - /*! - \page audiomanagercomponentspage AudioManager Components - \image html AudioManagement.png - - The AudioManager is the central managing instance of the Audio architecture. It is designed as an OwnedComponent, this means that the - software is maintained within GENIVI as open source component. The AudioManager consists of 4 central components.\n - - - \section audiomanagercomponents AudioManagerDaemon - - This component is owned and maintained by Genivi. It is the central audio framework component. There can be only one daemon in a system (singleton).\n - The AudioManagerDaemon is subject to this documentation. - \subsection daemonover Daemon Overview - Here is an class overview of the AudioManagerDaemon: - \image html daemon_insight.png - - \section commander AudioManagerCommandPlugin - - This describes the interface towards the Commanding Instances of the AudioManagerDaemon. This is the HMI and interrupt sources that use this - interface to start their interrupt and stop it again. The interface shall be asynchronous. Via this interface all user interactions are handled. - This component is designed to be a dynamic linked library that will be loaded on the startup of the AudioManager. There can be more than one - CommandPlugin at a time. - Since the implementation of this component is project specific, only examples are included.\n - An example Dbus Implementation can be found in the folder PluginCommandInterfaceDbus. - - \subsection commandIface Interfaces - All commands that must be fulfilled by an AudioManagerCommandPlugin are described in am::IAmCommandSend.\n - All commands that are presented to AudioManagerCommandPlugin by the AudioManagerDaemon are described in am::IAmCommandReceive.\n - - \section controller AudioManagerController - The controller is the intelligent "heart" of the AudioManager and it is project specific. In principle, the controller gets commands from the command - interface or events from outside and reacts to them. For this purpose, some basic commands are in the "toolbox" of the Controller that he can use - to interact with the rest of the system.\n - Among this there are commands to read/write the database and to perform actions on the Audiodomains like connect or disconnect. There must be only one - Controller in the system at a time, like the AudioManagerCommandPlugins, the Controller is loaded at startup by the daemon\n - A simple example Implementation can be found in the folder PluginControlInterface. - - \subsection controlIface Interfaces - All commands that must be fulfilled by an AudioManagerController are described in am::IAmControlSend.\n - All commands that are presented to AudioManagerController by the AudioManagerDaemon are described in am::IAmControlReceive.\n - - \section router Routing AudioManagerRoutingPlugin - - The AudioManagerRoutingPlugins are used to abstract the actual Hard- and Software that does the routing. There can be more than one plugins at a - time, they are loaded at startup time like the commandplugins. \n - The AudioManager expects a bus-like structure behind each plug-in, so that a plug-in can implement a bus interface and proxy the messages to the - routing adapters - the AudioManager is capable of addressing more than one adapter one each plug-in. The AudioManagerController does not have to - know anything about the real system plugins - he sends his commands to sources and sinks. The daemon does the dispatching of these commands. - The interface is mainly asynchronous.\ - Sample plugins can be found in the directory, for example PluginRoutingInterfaceAsync.\n - - \subsection routingIface Interfaces - All commands that must be fulfilled by an AudioManagerRoutingPlugin are described in am::IAmRoutingSend.\n - All commands that are presented to AudioManagerRoutingPlugins by the AudioManagerDaemon are described in am::IAmRoutingReceive.\n - - \subsection subrouter Bus topology - The AudioManagerDaemon expects a bus behind each of the plugins. On one of these buses there can be several domains. In order to - reflect this, a domain has always a bus(plugin) and a node that it belongs to. So if a message needs to be transmitted to a domain, - it will always be sent to a node on a bus. - Here is a diagram showing the topology from the view of the AudioManagerDaemon: - \image html bus_topology.png - \subsection busname Busname - Since a plugin represents a bus for the AudioManagerDaemon, each plugin it has its unique name, the busname that is returned by - am::IAmRoutingSend::returnBusName. The AudioManagerDaemon used this information to link a plugin with a domain. All other elements like - sinks, sources etc are linked to domains. This is how the hierarchy looks like that is used: - \image html routing_hierarchy.png - - \subsection CAPIplugins CommonAPI plugins - As "sample code" with MIT license, PluginCommandInterfaceCAPI and PluginRoutingInterfaceCAPI are provided with the source code. The FRANCA - fidls have been generated out of the Enterprise architect model, so they might be used to draw project specific behavior in sequences. - The sources in src-gen have been generated out of the provided fidl files. - - \image html PluginCommandInterfaceCAPI.png - - \image html PluginRoutingInterfaceCAPI.png - - There is no fixed domain associated with this plugin. So you have to implement the interface org::genivi::am::RoutingControlStub and report - busname and path to the routingplugin on the interface org::genivi::am::RoutingControlObserverStub like this: - - \image html Register_Domain.png - -*/ diff --git a/AudioManagerDaemon/docx/04_d_commonAPI.dox b/AudioManagerDaemon/docx/04_d_commonAPI.dox deleted file mode 100644 index 7e837dd..0000000 --- a/AudioManagerDaemon/docx/04_d_commonAPI.dox +++ /dev/null @@ -1,30 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - - /*! - \page comminAPI AudioManager and CommonAPI -The audiomanager supports CommonAPI in very comfortable way. It will register CommonAPI in the audiomanager mainloop (am::CAmSocketHandler) and make -threadsafe calls to the stubs registered via the factory provided by the wrapper. - If enabled (by default) via cmake, the am::CAmCommonAPIWrapper is created. It is instantiated as singleton -and every Plugin can use it. -First, you have to create the interfaces out of the FIDL data like usual. -Then, you can access the singletons via am::CAmCommonAPIWrapper::factory and am::CAmCommonAPIWrapper::runtime. - -More information about CommonAPI can be found here: -http://projects.genivi.org/commonapi/ - -*/ diff --git a/AudioManagerDaemon/docx/04_x_elements.dox b/AudioManagerDaemon/docx/04_x_elements.dox deleted file mode 100644 index 7990d37..0000000 --- a/AudioManagerDaemon/docx/04_x_elements.dox +++ /dev/null @@ -1,63 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page elementspage Elements of the AudioManagement - - \section cDiag Overview Class Diagram - This class diagram shows a logical overview of the relevant elements in the AudioManager with their relations. - \image html ClassDiagramm.png - - The audiomanagement in principle consists of the following elements: - - \section source Sources - This is where audio comes from, for examples tuner, mediaplayer. But sources can also be part of a building block that processes audio, examples - are here crossfaders or gateways. Several Sinks can be connected to one source.\n - \subsection sourceattributes Attributes - - am::am_SourceType_s describes the attributes that are accessible from the AudioManagerCommandPlugins.\n - - am::am_Source_s describes the general attributes.\n - - \section sinks Sinks - This is where audio flows to, for examples amplifier, headphones. But sources can also be part of a building block that processes audio, - examples are here crossfaders or gateways. Several Sources can be connected to one sink.\n - \subsection sinkattributes Attributes - - am::am_SinkType_s describes the attribiutes that are accessible form the AudioManagerCommandPlugins.\n - - am::am_Sink_s describes the general attributes.\n - - \section gw Gateways - Gateways are described here: \ref gateway - A specialitry of a gateways is the convertionmatrix. It indicates which sinksoundformats can be transferred in which sourcesoundformats. A convertion - matrix looks like this: - \image html GatewayMatrix.png - \subsection gwattributes Attributes - - am::am_Gateway_s describe the attribiutes of a gateway\n - - \section crossfaders Crossfaders - Cross-faders are special elements that can perform cross-fading between two sources connected to the sinks of the crossfader. The audio of either source - or both (mixed, during the fade) is put out at the source of the fader. Cross-fading within a source (for example from one song to another) is out of - scope audio management and must be performed in the source.\n - A crossfader has two sinks and one source, where one sink is the "hot" one. It is in the duty of the AudioManagerController to connect the correct - sources to the sinks in order to perform a cross-fade. When fading is started, the hotSink changes from either HS_SINKA or HS_SINKB to HS_INTERMEDIATE, - when the fading is finished, it changes to HS_SINKA or HS_SINKB (the sink that was "cold" before).Fading itself is done in the RoutingAdapters, the - implementation has to ensure the smooth and synchronous change of volumes. With different rampTypes, different kinds of cross-fade ramps can be supported. - The actual status of the "hot" sink is reported by the routingAdapter. Care has to be taken that the correct "hot" end of the crossfader is given - at registration time.\n - \subsection cfattributes Attributes - - am::am_Crossfader_s describes the attribiutes of a Crossfader - - -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox b/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox deleted file mode 100644 index fd0f1e3..0000000 --- a/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox +++ /dev/null @@ -1,92 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page sourcesink The relation of sources & sinks with the AudioManager - -\section claDi Class diagramm of the relation between sources, sinks and the AudioManager -In general, the relationship is defined as well as the interfaces that are used to communicate the informations back and forth. But since the -exchange of these informations is abstracted by the RoutingPlugins, the architecture cannot define explicit mechanisms here.\n -A lot of attributes that are part of sources and sinks belong logical to them and might be implemented by the RoutingPlugin. The relation between -sources, sinks and the AudioManagerDaemon is shown in this \ref cDiag . - -\section boil The REAL interaction -A lot of information is related to sources and sinks as can be seen here: \ref cDiag . But not all informations are actually communicated to the -sources and sinks since the routing adaptor will take care of handling some of these informations.\n -Here are some informations that is believed to be actually communicated to the sources and sinks: - - \section conFormats Connection Formats - The am::am_CustomAvailabilityReason_t formats for a connection are chosen when the connection is build up. So if there are more than one possbilities - that can be used for a connection (am::am_Sink_s::listConnectionFormats and am::am_Source_s::listConnectionFormats) the correct one is chosen - upon a connect. If this is relevant to the sources and sinks, the routingAdaptor must communicate to the sources and sinks accordingly. - \image html SettingConnectionFormats.png - - - \section sstates Source States - This diagrams shows the sequence that is used to set the sources states am::am_SourceState_e. Since the source states are set by the - AudioManagerController, the exact behavior is product specific. - \image html SourceStates.png - - \section avail Availability - This diagram shows the sequence that is used to communicate the availability am::am_Availability_s. from the sources. Please note that the availability reasons - am::am_CustomAvailabilityReason_t are product specific. - \image html AvailabilityofSources.png - Here is the same for the sinks: - \image html AvailabilityofSinks.png - - \section vol Volumes - Volumes am::am_volume_t are set to the sinks, mainly, but depending on the used audio routing system it might be that they can be set on the source level as well. - If this is not the case, proper measures must be taken to do this. - Changes of a source: - \image html VolumeChangesofSources.png - Changes of a sink: - \image html VolumeChangesofSinks.png - - \section SoundProperties - The am::am_SoundProperty_s are set to the sources and sinks. More information about SoundProperties can be found here: \ref prop. - Changes of a sink: - \image html SoundPropertyChangeofSink.png - Changes of a source: - \image html SoundPropertyChangeofSource.png - - \section in Interrupt States - The am::am_InterruptState_e are reported by low level interrupts from the sources to the AudioManagement. More details here: \ref interrupts . - \image html InterruptStatusChange.png - - - - - - - - - - - - - - - - - - - - - - - -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/05_unique.dox b/AudioManagerDaemon/docx/05_unique.dox deleted file mode 100644 index 5bf021a..0000000 --- a/AudioManagerDaemon/docx/05_unique.dox +++ /dev/null @@ -1,36 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ -/*! - \page uniquepage About unique IDs : Static vs Dynamic IDs - - \section why Why having two different kinds of ids? - The complexity of up-to-date IVI-systems demand to support sources and sinks dynamically added and removed in order to support the variety of CE products, - but parts of the system are never going to change - to start a dynamic registration here is a waste of system capacity.\n - \section setup The setup - The AudioManagement is capable of handling static, dynamic or mixed setups. In case of a dynamic setup, all elements of the system like domains, sinks, - sources, gateways etc are registered at system start-up. In a static setup, the IDs of the elements are known and fixed - no further registration is needed. - The start-up for static elements works as follows:\n - when a domain known as static (this is knowledge of the AudioManagerController, recognized by the unique name of the domain) registers, the - AudioManagerController enters all elements of this domain in the database. Still, this domain can register additional elements during runtime. - In case of static setups, the RoutingAdapter needs to ensure that all static elements are ready to be used when the domain registers.\n - In order to ensure the uniqueness of IDs, there exist two separate ID areas (for each of sources, sinks, gateways and crossfaders):\n\n - \image html unique.svg - In case of dynamic added elements, the audiomanagerdaemon ensures the uniqueness of the ID's, in case of the static setup, the project has to ensure the - uniqueness by assigning the IDs wisely. The knowledge of the static IDs need to be in the AudioManagerController, the RoutingAdapters and in the HMI - (optional because IDs will be reported anyway).\n - Domains cannot be static because registering them is the trigger for the AudioManagerController to enter the static values into the database. -*/ diff --git a/AudioManagerDaemon/docx/06_classification.dox b/AudioManagerDaemon/docx/06_classification.dox deleted file mode 100644 index 0fb72cd..0000000 --- a/AudioManagerDaemon/docx/06_classification.dox +++ /dev/null @@ -1,32 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ -/*! - \page classficationpage Classification of Sinks and Sources - \section classification Classification - The AudioManagement offers classification for sources and sinks. It can be used to group sources and sinks together and link certain behaviors to these groups. - An example for such a use is to group all interrupt sources in a class together and let the AudioManagerController react different for this class.\n - Elements can only have one class at a time. The AudioManagerDaemon will take care of registration of sourceClasses, sinkClasses and will assign unique IDs, - but the parameters of the Classes itself are product specific and have to be interpreted by the AudioManagerController. This concept allows for very individual - implementations of system behaviors.\n - Since Classes are held in the database, Classes can be registered and deregistered during runtime, it is recommended that the AudioManagerController enters - all source & sink classes at start-up into the database.A ClassProperty exists out of an enumeration (am_CustomClassProperty_t, project specific) and a corresponding - value (integer) that is interpreted by the AudioManagerController according to am_CustomClassProperty_t.\n - There is no restriction to the number of properties a class can have and how many classes can exist in a system.\n - \section attributes Attributes - - am::am_SourceClass_s describes the attributes of a source class\n - - am::am_SinkClass_s describes the attributes of a sink class\n -*/ diff --git a/AudioManagerDaemon/docx/07_interrupts.dox b/AudioManagerDaemon/docx/07_interrupts.dox deleted file mode 100644 index 0e26b88..0000000 --- a/AudioManagerDaemon/docx/07_interrupts.dox +++ /dev/null @@ -1,36 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! - - \page interrupts Interrups & Low Level Interrupts - \section diff Differences - The only difference between a "normal" interrupt and a source for the audioManagement may lie in it's classification, so playing a "normal" interrupt is not - different to changing a source. An exception here are the so called "low level interrupts".\n - \section crit Criterias - These are special sources that fulfill the following criteria: - - direct connection to a sink that is "always on", so no extra actions and communications need to be done in order to play audio - - no dependencies to the current system state need to be checked before playing. This means that the source knows if it is allowed to play at the moment it - wants to play - - all information for the source that is needed to judge if it is allowed to play or not is either directly retrieved by the source or set static via a property. - - This becomes very handy for implementing such things like park distance control. When the source is informed that it needs to output signals - (due to an emerging wall for example) it outputs the beeps directly to the amplifier that then overlays the sound to the current active source.\n - Settings that influence the behavior of low level interrupts like for example volume offset for park distance control or sound on/off for it need to be done via - sourceProperties on the source level, so that the judgment and the adoptions that need to be taken can be taken by the source without system interaction. - In order to give the AudioManagerController the chance to react on a low level interrupt (by lowering the main volume for example), a feedback path is provided - and the AudioManagerController is informed about the current state of the low level interrupt (via hooklInterruptStatusChange).\n -*/ diff --git a/AudioManagerDaemon/docx/08_connections.dox b/AudioManagerDaemon/docx/08_connections.dox deleted file mode 100644 index fd8a194..0000000 --- a/AudioManagerDaemon/docx/08_connections.dox +++ /dev/null @@ -1,33 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! - \page connpage Connections & MainConnections - \section con Connections - A connection connects a source to a sink to let audio data flow. The direction of the flow is always source to sink. For each connection the connectionFormat - must be defined when the connection is demanded, if source or sink is not capable of supporting this format, the connection cannot be established. - ConnectionFormats are product specific, also are some standard formats defined within GENIVI that can be enhanced in the product area. Examples of formats: - analog, autodefined, stereo 48khz 16bit PCM, .... - - \section maincon Mainconnections - is visible to the HMI and consists out of one or more connections. A MainConnection shall always connect a Source and a Sink visible to the HMI. - In contradiction to connections, the MainConnection does not know about connectionFormat. MainConnections are demanded by the commandInterface. - This picture demonstrates the relation between MainConnections and connections: - \image html Levels.png - - \section att Attributes - - am::am_Connection_s describes the attributes of a conenction - - */
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/09_lipsync.dox b/AudioManagerDaemon/docx/09_lipsync.dox deleted file mode 100644 index 6229198..0000000 --- a/AudioManagerDaemon/docx/09_lipsync.dox +++ /dev/null @@ -1,37 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! - \page lip Lipsync - - \section t The Task of the Audiomanager - It is the job of the AudioManager to retrieve all latency timing information from each connection, to aggregate this information and provide a latency # - information on a per MainConnection Basis. It is not the task of the AudioManager to actually delay or speed up video or audio signals to achieve a lipsync. - The actual correction shall be done in the with the information provided by the AudioManager. - The time information is always reported by the routingadapters for each connection. Delays that are introduced in a sink or a gateway are counting for the - connection that connects to this sink or gateway. - \section ex Example - \image html delay.jpg - - This graph shows how the delay is calculated: - - Connection 1 has a delay 2ms + 60ms that is added due to the gateway - - Connection 2 has a delay 0ms + 10ms due to sink - So the routing adapters report 62ms and 10ms, the audiomanager will add this to 72ms and report this value for the main connection from sink to source. - The videoplayer getting this information can now delay his video against the audio for 72ms and be in perfect lipsync.\n - After the buildup of a connection the first timing information needs to be sent within 5 seconds, the timing information from the routing adapters need to - be sent via 4 seconds. If the latency for a connection is variable and changes over lifetime of the connection, the routing adapters shall resend the value - and the audiomanager will correct the over all latency. -*/ diff --git a/AudioManagerDaemon/docx/10_early_audio.dox b/AudioManagerDaemon/docx/10_early_audio.dox deleted file mode 100644 index bdd72f5..0000000 --- a/AudioManagerDaemon/docx/10_early_audio.dox +++ /dev/null @@ -1,31 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! -\page early Early Audio -\section req The Requirement -The requirement reviews showed that one very important aspect of managing audio within GENIVI is the early/late phase where the Linux part of the system is -not available. This feature is addressed via special domains: EarlyDomains. These domains are acting "unmanaged" - meaning without the interaction with the -AudioManager - providing a simpler set of features until the AudioManager is up and running. When the Linux system is then fully operable a handover is done -from the EarlyDomains towards the AudioManager. In order to be able to operate without the Linux up and running, the EarlyDomains must be implemented on a -second fast-boot or always-on controller, e.g. the so called vehicle processor.\n -\section earlys Early Startup -This picture shows the principle of the early startup: -\image html early.png -\section late Late Rundown -This picture shows the principle of the late rundown: -\image html late.png -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/11_views.dox b/AudioManagerDaemon/docx/11_views.dox deleted file mode 100644 index 2dda7c9..0000000 --- a/AudioManagerDaemon/docx/11_views.dox +++ /dev/null @@ -1,33 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! -\page views The two views of the AudioManager -In general, there are two views of the system:\n -\section command The CommandInterface View View -This is an abstracted view that the HMI and other controlling Instances have of the system. Every Information (with some little exceptions) here is maintained -by the AudioManagerController, so that he can "fake" situations for the HMI. -So why is that? Depending on the actual project it might be - for example - that not the volume at the sink must be changed, but instead of the source. -The HMI does not know about sourceVolumes (and does not need to!) so the HMI would change the sink volume and the AudioManagerController can translate it to a -sourceVolumeChange. The metrics of the volumes are different as well. -It is the duty of the AudioManagementController to keep the commandInterface information consistent with the "real" situation. -\section route RoutingInterface View -Here are the "real" system states. All changes that are done on this interface are maintained by the AudioMangerDaemon and here is the actual situation always -consistent with the reality. All actions on this interface are either triggered by the AudioManagerController or by the domains itself, like registration for -example. -\section over Overview -\image html views.png -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/12_volumes.dox b/AudioManagerDaemon/docx/12_volumes.dox deleted file mode 100644 index 60603bc..0000000 --- a/AudioManagerDaemon/docx/12_volumes.dox +++ /dev/null @@ -1,29 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page vol Volumes & MainVolumes -\section mainVol MainVolumes -This is the volume at the CommanInterface level. The exact definition is project specific and can be adopted for each project since the AudioManagerController -and the HMI are the only ones who need to interfere with this volume. The actual value is an integer. -- am::am_mainVolume_t defines the mainvolume - -\section volv Volumes -These are the actual volumes that are set for sources and sinks. The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). The minimum and maximum can be -limited by actual project. -- am::am_volume_t describes the volume -*/ diff --git a/AudioManagerDaemon/docx/13_properties.dox b/AudioManagerDaemon/docx/13_properties.dox deleted file mode 100644 index 2597fdf..0000000 --- a/AudioManagerDaemon/docx/13_properties.dox +++ /dev/null @@ -1,33 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ -/*! -\page prop Properties - \section soundprop SoundProperties & MainSoundProperties -SoundProperties are properties that are related to either a source or a sink. They are product specific and are used to set source or sink specific properties. -This could be for example: equalizer settings, relative volume offsets but also bool information "surround sound on/off". -A soundProperty is defined by its type (am_SoundProperty_e, a product specific enum) and a value (integer) that is interpreted according to the type. -There are not limits how many properties a sink or a source can have. SoundProperties in contradiction to MainSoundProperties are not visible to the -CommandInterface.\n -- am::am_SoundProperty_s describe the of the SoundProperties -- am::am_MainSoundProperty_s describe the attributes of MainSoundProperties - * -\section sys SystemProperties -are properties that apply to the whole system or parts of it but cannot be tight to a specific sink or source. They are product specific and could be used -for example to set general behavior like all interrupts on/off for example. The information is only exchanged between the commandInterface and the -AudioManagerController. The AudioManagerController has to interpret the value and react accordingly. -- am::am_SystemProperty_s describes the attributes of Systemproperties -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/13_x_notifications.dox b/AudioManagerDaemon/docx/13_x_notifications.dox deleted file mode 100644 index 135d4a5..0000000 --- a/AudioManagerDaemon/docx/13_x_notifications.dox +++ /dev/null @@ -1,64 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! -\page notifi Notifications -\section notifi_ex What are notifications? -The notification feature can be used to gather information from sources or sinks periodically or on certain thresholds.It can be used to implement a graphical spectrum for example or other information need to be passed back from sources or sinks. - -\section notifi_overview Overview -\image html Notifications.png - -\section notifi_command CommandInterface -all this methods have to do with MainNotifications (Information level between command and control) -- am::IAmCommandSend::cbSinkNotification -- am::IAmCommandSend::cbSourceNotification -- am::IAmCommandSend::cbMainSinkNotificationConfigurationChanged -- am::IAmCommandSend::cbMainSourceNotificationConfigurationChanged -- am::IAmCommandReceive::getListMainSourceNotificationConfigurations -- am::IAmCommandReceive::getListMainSinkNotificationConfigurations -- am::IAmCommandReceive::setMainSourceNotificationConfiguration -- am::IAmCommandReceive::setMainSinkNotificationConfiguration -\section notifi_control ControlInterface -all this methods have to do with MainNotifications (Information level between command and control) -- am::IAmControlSend::hookUserSetMainSinkNotificationConfiguration -- am::IAmControlSend::hookUserSetMainSourceNotificationConfiguration -- am::IAmControlReceive::changeMainSinkNotificationConfigurationDB -- am::IAmControlReceive::changeMainSourceNotificationConfigurationDB -- am::IAmControlReceive::sendMainSinkNotificationPayload -- am::IAmControlReceive::sendMainSourceNotificationPayload - -all this methods have to do with notifications (Information level between cotrol and routing) -- am::IAmControlSend::cbAckSetSinkNotificationConfiguration -- am::IAmControlSend::cbAckSetSourceNotificationConfiguration -- am::IAmControlSend::hookSinkNotificationDataChanged -- am::IAmControlSend::hookSourceNotificationDataChanged -- am::IAmControlReceive::setSinkNotificationConfiguration -- am::IAmControlReceive::setSourceNotificationConfiguration -\section notifi_routing RoutingInterface -all this methods have to do with notifications (Information level between cotrol and routing) -- am::IAmRoutingSend::asyncSetSinkNotificationConfiguration -- am::IAmRoutingSend::asyncSetSourceNotificationConfiguration -- am::IAmRoutingReceive::ackSinkNotificationConfiguration -- am::IAmRoutingReceive::ackSourceNotificationConfiguration -- am::IAmRoutingReceive::hookSinkNotificationDataChange -- am::IAmRoutingReceive::hookSourceNotificationDataChange - -\section notifi_levels Notification Levels -For notifications it's the same as for the soundproperties: there are two levels of information. One is between the Command Interface and the Control Interface -here it is in the duty of the controller to handle the notification data. The other one is between Control and Routing Interface. This could be used for example -to route the information from a source to the command interface. -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/14_misc.dox b/AudioManagerDaemon/docx/14_misc.dox deleted file mode 100644 index 8ae15c2..0000000 --- a/AudioManagerDaemon/docx/14_misc.dox +++ /dev/null @@ -1,39 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ -/*! -\page misc Miscellaneous - -\section misc_connfor Connection Formats -Every flow of audio is using a format to exchange data. The format that the source and the sink uses must match together in order to have an undisturbed -experience. It is common that sources and sinks are capable of supporting more than one audioformat.\n -So all sources and sinks register with a list of connectionFormats that they support and for each connection a format must be chosen that is then used -to transport the audio data. Gateways (and Soundconverters) have the information which connectionFormat can be transformed into another one. -am::am_CustomAvailabilityReason_t has all formats listed.\n -There is a special usecase that is worth showing as an example in this regard: the change of a connectionFormat when switching from one song to another. Here is an -example of how the project specific parts could handle this: -\image html ChangeofAudioformatduringplaytime.png - - -\section misc_pers Persistence -The persistence client library is defined as an abstract component with a c-like library interface. Since the AudioManagerController is the only one to know -what is to be made persistent, he is the one interfacing with that library. This is the reason why there is no specific interface for the persistence here. - -\section misc_speed Speed dependent volume -The adjustments for the speed are done product specific in the controller. The speed information itself is retrieved by the AudioManagerDaemon, sampled and -quantified and forwarded to the controller. The interface in not yet defined !\n -Turning speed controlled volume on/off and possible settings are achieved via SinkSoundProperty settings. -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/14_u_last_user_mode.dox b/AudioManagerDaemon/docx/14_u_last_user_mode.dox deleted file mode 100644 index 0c90f89..0000000 --- a/AudioManagerDaemon/docx/14_u_last_user_mode.dox +++ /dev/null @@ -1,37 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page luc Last User Mode -\section luc_concept Last User Mode concept -In general last user modes are project specific. So it is not mandatory to do it like described here - it is just a suggestion how it could be implemented -together with the LUC handler (Last User Concept). The LUC handler is a part of the NSC (Node State Controller) which is a GENIVI component. More information can be -found within GENIVI.\n -For implementing the suggested method here, the AudioManagerController has to take care of communicating with the LUC handler. The AudioManager is the -component that knows the last heard source that should be started earlier than others in order to reduce the timespan until the customer can hear it's last -source.\n -In order to fullfull this, the controller has to keep a map that links sources to unit files. The sequence that shall be an example of how it could be realized.\n - -\section luc_rundown The handling in the rundown context: -\image html LastUserModeHandlingExample.png - -\section luc_startup The next startup: -\image html StartupWithLastUserMode.png - - - - */ diff --git a/AudioManagerDaemon/docx/14_x_mainloop.dox b/AudioManagerDaemon/docx/14_x_mainloop.dox deleted file mode 100644 index 8f112bc..0000000 --- a/AudioManagerDaemon/docx/14_x_mainloop.dox +++ /dev/null @@ -1,49 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page mainl Mainloop concept -\section mconcept Mainloop -The AudioManager comes with a build in mainloop that can be utilized by the plug-ins to serve their needs of communication and thread-safe calling. -The mainloop, implemented in CAmSocketHandler works like this:\n -\image html Mainloop.png - -\section sec Using the Mainloop -Adding and removing callbacks and timers work via the am::CAmSocketHandler.\n -To add a callback, use am::CAmSocketHandler::addFDPoll, to remove one, use am::CAmSocketHandler::removeFDPoll.\n -To add a timer callback, use am::CAmSocketHandler::addTimer, use am::CAmSocketHandler::removeTimer and am::CAmSocketHandler::restartTimer and -am::CAmSocketHandler::stopTimer.\n -The mainloop is started via am::CAmSocketHandler::start_listenting and stopped via am::CAmSocketHandler::stop_listening. -Example code can be found in am::CAmDbusWrapper. - -\section util Utilizing The Mainloop as Threadsafe Call Method -The AudioManager itself is singlethreaded, so any calls from other threads inside the plugins directly to the interfaces is forbidden, the -behavior is undefined. The reason for this is that communication and routing plugins are often only communication interfaces that can are ideally used -with the am::CAmSocketHandler.\n -am::CAmSerializer creates an intermediate object on the heap holding all informations of the function to be called and a pointer to the object to be called. -After that, the class writes to a pipe witch triggers the mainloop to call the callback am::CAmSerializer::receiverCallback from the maincontext. The -callback uses the intermediate object to do the actual call. \n -\warning asynchronous calls can be used within the main thread, but synchronous not -> the call would block forever !\n -For each thread that needs to use synchronous calls independent an own instance of am::CAmSerializer needs to be used. -\subsection async Asynchronous calls -\image html Deferred_Call_async.png -\subsection sync Synchronous calls -\image html Deferred_Call_sync.png - - - - */ diff --git a/AudioManagerDaemon/docx/14_y_watchdog.dox b/AudioManagerDaemon/docx/14_y_watchdog.dox deleted file mode 100644 index a1facc5..0000000 --- a/AudioManagerDaemon/docx/14_y_watchdog.dox +++ /dev/null @@ -1,44 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page watchd The watchdog -\section watchdconcept The watchdog concept -The watchdog concept of the audiomanger is based on systemd. When systemd is configured via the unit file to use a watchdog and watchdog support is activated -in the audiomanager, the audiomanager will reset the watchdog via the mainloop in the given interval to prevent systemd from restarting the audiomanager.\n -If the audiomanager is stuck for whatever reason, systemd will not get this update and restart the audiomanager. - - -\section configwatch Watchdog configuration -By default, the watchdog is enabled in the audiomanager, you can disable the watchdog functionality by setting the cmake build option "WITH_SYSTEMD_WATCHDOG" to -OFF, either by modifying the cmake cache with ccache or by passing -DWITH_SYSTEMD_WATCHDOG=OFF to cmake.\n -The interval for checking the watchdog can be set in the unitfile of systemd by setting "WatchdogSec". The other settings need to be done as well: -\code -Restart=always -WatchdogSec=2 -NotifyAccess=main -\endcode -The intervall for pinging systemd is set to the half of "WatchdogSec". - -\section winteg Integration with systemd -The audiomanager will use the library proviced by "libsystemd-daemon" if it is available on the system. If this library is not available, the files sd-daemon.c and sd-daemon.h -that are provided with the audiomanager and released under MIT licence by Lennard Poettering will be used to connect to systemd. - -more information can be found here: am::CAmWatchdog and sd-daemon.h . - - - */ diff --git a/AudioManagerDaemon/docx/14_zz_Startup_Rundown.dox b/AudioManagerDaemon/docx/14_zz_Startup_Rundown.dox deleted file mode 100644 index 88f8dc6..0000000 --- a/AudioManagerDaemon/docx/14_zz_Startup_Rundown.dox +++ /dev/null @@ -1,30 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - -/*! -\page start Startup and Rundown -\section start_Start Startup -This flow describes the startup of the AudioManager: -\image html Startup.png -\section start_Rundown Rundown -This flow describes the rundown of the AudioManager: -\image html Rundown.png -\section start_Cancel Cancelled Rundown -This flow describes the cancel rundown of the AudioManager: -\image html CancelRundown.png - - */ diff --git a/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox b/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox deleted file mode 100644 index 74dd2e0..0000000 --- a/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox +++ /dev/null @@ -1,45 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! -\page cmdline CommandLineParsing -\section tclap TCLAP -Commandline parsing is accomplished via a template library that is added to the source tree of the Audiomanager: TCLAP. -The license of this libraty is MIT. -It manages commandline parsing in a handy way. More information can be found here: -http://tclap.sourceforge.net -\section cmdplugins CommandLine Parsing in the Plugins -The commandline Class that parses the commandline can be accessed via am::CAmCommandLineSingleton . This factory creates -a commandline object that can be accessed everywhere in the Audiomanager. -In the constructor of a plugin, the plugins can add commandline arguments they hold as member. -Here the member, in this case of type TCLAP::ValueArg<std::string> mCommandLineArg; - -\code -mCommandLineArg("K","controllerPluginArg","a test argument for the controller",false,"bla","string") -\endcode - -In the constructor, add the argument to the commandline like this -\code -CAmCommandLineSingleton::instance()->add(mCommandLineArg); -\endcode -And then in the startup controller routine (or later) you can get the value of the argument, like -\code -mCommandLineArg.getValue() -\endcode - -An example can be found in the plugins repository in the test controller. - -*/ diff --git a/AudioManagerDaemon/docx/15_dlt_support.dox b/AudioManagerDaemon/docx/15_dlt_support.dox deleted file mode 100644 index ca34896..0000000 --- a/AudioManagerDaemon/docx/15_dlt_support.dox +++ /dev/null @@ -1,23 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - /*! -\page dlt Dlt support -\section compile Compilerswitch -The AudioManager can be compiled with or without DLT support, in case that DLT is not compiled in (cmake option WITH_DLT), logging is switched off. -You can log to the commandline by starting the Audiomanager with the option -V.\n -If you want to log to the commandline and you have dlt compiled in, use the environment variable of the dlt to log to the command line. -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/15_x_eclipse.dox b/AudioManagerDaemon/docx/15_x_eclipse.dox deleted file mode 100644 index 95c8e9f..0000000 --- a/AudioManagerDaemon/docx/15_x_eclipse.dox +++ /dev/null @@ -1,91 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ - - -/*! -\page eclip Download Compile Debug -\section dw Get the source -For compiling the source, you need to use git and the following packages:\n -\code -sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake build-essential python2.6-dev -\endcode -Getting the source got works with following command -\code -git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/AudioManager -\endcode -\section build Compile -In order to build the project (out of source build), please follow these instructions on the commandline: -\code -mkdir /build -cd build -cmake .. -\endcode -if you want to influence the build options, you can use ccmake for example (apt-get install ccmake) -\code -ccmake .. -\endcode -You will get a menue that let's you select different options for the build. Compiling with a simple -\code -make -\endcode -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 -\code -sudo make install -\endcode -package generation is supported via CPack. To build packages, you have to -\code -make genivi_package -\endocde -this will create one package if your CMake version is < 2.8.5 (all binaries stripped): -\code -AudioManager-<git verison>-Linux.deb -\endcode -if your version is above, you will get 4 packages (all binaries stripped) : -\code -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] -\endcode -to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do: -\code -make package_source -\endcode -This will create the following package: -\code -AudioManager-<git verison>-Source.tar.gz -\endcode -All packages will be placed in a folder called packages -\section ec Using Eclipse -First you need to get eclipse, for example by downloading it from http://www.eclipse.org/ use the C++ CDT version. -Import the project with\n -File-> import project\n -Select "existing code as makefile project" and choose the root folder auf the AudioManager\n -In order to build with eclipse you need to tell eclipse where the makefile can be found:\n -In project properties enter as build command: -\code -"make -j4 -C build" as build command -\endcode -\section deb Debugging with eclipse -For debugging you need to modify debug configurations, choose the audiomanager as binary, the debugging should work. -*/ diff --git a/AudioManagerDaemon/docx/16_readme.dox b/AudioManagerDaemon/docx/16_readme.dox deleted file mode 100644 index 7798fee..0000000 --- a/AudioManagerDaemon/docx/16_readme.dox +++ /dev/null @@ -1,20 +0,0 @@ - /* - * 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. - * - * \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 Linke (christian.linke@bmw.de) - * - */ -/*! -\page comp Compiling & Co - <a href=README.html>README</a> -*/
\ No newline at end of file diff --git a/AudioManagerDaemon/docx/Doxyfile.in b/AudioManagerDaemon/docx/Doxyfile.in deleted file mode 100644 index 8cd141f..0000000 --- a/AudioManagerDaemon/docx/Doxyfile.in +++ /dev/null @@ -1,268 +0,0 @@ -# Doxyfile 1.6.3 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = AudioManager -PROJECT_NUMBER = @DAEMONVERSION@ -OUTPUT_DIRECTORY = @DOC_OUTPUT_PATH@ -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = -SHORT_NAMES = YES -JAVADOC_AUTOBRIEF = YES -QT_AUTOBRIEF = YES -MULTILINE_CPP_IS_BRIEF = YES -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 8 -ALIASES = -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -BUILTIN_STL_SUPPORT = YES -CPP_CLI_SUPPORT = YES -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -SUBGROUPING = YES -TYPEDEF_HIDES_STRUCT = NO -SYMBOL_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = YES -EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = NO -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = YES -SORT_GROUP_NAMES = YES -SORT_BY_SCOPE_NAME = NO -GENERATE_TODOLIST = NO -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES -SHOW_FILES = YES -SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = YES -WARNINGS = NO -WARN_IF_UNDOCUMENTED = NO -WARN_IF_DOC_ERROR = NO -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text " -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = @CMAKE_CURRENT_SOURCE_DIR@ -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.h *.cpp *.dox -RECURSIVE = YES -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = */test/* */build*/* */cmake/* */googleMock/* */tclap*/* -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = @CMAKE_SOURCE_DIR@/AudioManagerDaemon/docx/images -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = YES -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = YES -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = YES -HTML_ALIGN_MEMBERS = YES -HTML_DYNAMIC_SECTIONS = YES -GENERATE_DOCSET = YES -DOCSET_FEEDNAME = "AudioManager docs" -DOCSET_BUNDLE_ID = org.genivi.AudioManager.Doxygen -DOCSET_PUBLISHER_ID = org.genivi.AudioManager.Publisher -DOCSET_PUBLISHER_NAME = genivi -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.genivi.AudioManager -DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES -USE_INLINE_TREES = YES -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = YES -FORMULA_FONTSIZE = 10 -SEARCHENGINE = YES -SERVER_BASED_SEARCH = NO -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_OUTPUT = -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = -PDF_HYPERLINKS = YES -USE_PDFLATEX = NO -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = @CMAKE_SOURCE_DIR@/man -MAN_EXTENSION = .3 -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = NO -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = YES -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = YES -EXPAND_ONLY_PREDEF = YES -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = NO -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = YES -DOT_FONTNAME = FreeSans.ttf -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -TEMPLATE_RELATIONS = YES -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = YES -CALLER_GRAPH = YES -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = YES -GENERATE_LEGEND = YES -DOT_CLEANUP = YES diff --git a/AudioManagerDaemon/docx/images/AudioDomains.gif b/AudioManagerDaemon/docx/images/AudioDomains.gif Binary files differdeleted file mode 100644 index d3f1c8d..0000000 --- a/AudioManagerDaemon/docx/images/AudioDomains.gif +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/AudioManagement.png b/AudioManagerDaemon/docx/images/AudioManagement.png Binary files differdeleted file mode 100755 index f3b4cdd..0000000 --- a/AudioManagerDaemon/docx/images/AudioManagement.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/AvailabilityofSinks.png b/AudioManagerDaemon/docx/images/AvailabilityofSinks.png Binary files differdeleted file mode 100644 index c912cdf..0000000 --- a/AudioManagerDaemon/docx/images/AvailabilityofSinks.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/AvailabilityofSources.png b/AudioManagerDaemon/docx/images/AvailabilityofSources.png Binary files differdeleted file mode 100644 index 543a9f7..0000000 --- a/AudioManagerDaemon/docx/images/AvailabilityofSources.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/CancelRundown.png b/AudioManagerDaemon/docx/images/CancelRundown.png Binary files differdeleted file mode 100755 index 889ed56..0000000 --- a/AudioManagerDaemon/docx/images/CancelRundown.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/ChangeofAudioformatduringplaytime.png b/AudioManagerDaemon/docx/images/ChangeofAudioformatduringplaytime.png Binary files differdeleted file mode 100755 index 2fa30a1..0000000 --- a/AudioManagerDaemon/docx/images/ChangeofAudioformatduringplaytime.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/ClassDiagramm.png b/AudioManagerDaemon/docx/images/ClassDiagramm.png Binary files differdeleted file mode 100755 index 63f048b..0000000 --- a/AudioManagerDaemon/docx/images/ClassDiagramm.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Deferred_Call_async.png b/AudioManagerDaemon/docx/images/Deferred_Call_async.png Binary files differdeleted file mode 100644 index 30ad24e..0000000 --- a/AudioManagerDaemon/docx/images/Deferred_Call_async.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Deferred_Call_sync.png b/AudioManagerDaemon/docx/images/Deferred_Call_sync.png Binary files differdeleted file mode 100644 index 51c46dc..0000000 --- a/AudioManagerDaemon/docx/images/Deferred_Call_sync.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Gateway.gif b/AudioManagerDaemon/docx/images/Gateway.gif Binary files differdeleted file mode 100644 index 45badf9..0000000 --- a/AudioManagerDaemon/docx/images/Gateway.gif +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/GatewayMatrix.png b/AudioManagerDaemon/docx/images/GatewayMatrix.png Binary files differdeleted file mode 100644 index dcc0682..0000000 --- a/AudioManagerDaemon/docx/images/GatewayMatrix.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Interaction_with_sourcessinks.png b/AudioManagerDaemon/docx/images/Interaction_with_sourcessinks.png Binary files differdeleted file mode 100644 index 653da90..0000000 --- a/AudioManagerDaemon/docx/images/Interaction_with_sourcessinks.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Interacton_Overview.png b/AudioManagerDaemon/docx/images/Interacton_Overview.png Binary files differdeleted file mode 100644 index 023b1c0..0000000 --- a/AudioManagerDaemon/docx/images/Interacton_Overview.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/InterruptStatusChange.png b/AudioManagerDaemon/docx/images/InterruptStatusChange.png Binary files differdeleted file mode 100755 index b38cf21..0000000 --- a/AudioManagerDaemon/docx/images/InterruptStatusChange.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/LastUserModeHandlingExample.png b/AudioManagerDaemon/docx/images/LastUserModeHandlingExample.png Binary files differdeleted file mode 100755 index fd34b4a..0000000 --- a/AudioManagerDaemon/docx/images/LastUserModeHandlingExample.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Levels.png b/AudioManagerDaemon/docx/images/Levels.png Binary files differdeleted file mode 100644 index 9ba0886..0000000 --- a/AudioManagerDaemon/docx/images/Levels.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Lifecylerequest.png b/AudioManagerDaemon/docx/images/Lifecylerequest.png Binary files differdeleted file mode 100755 index f6a67fc..0000000 --- a/AudioManagerDaemon/docx/images/Lifecylerequest.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Mainloop.png b/AudioManagerDaemon/docx/images/Mainloop.png Binary files differdeleted file mode 100644 index 979c133..0000000 --- a/AudioManagerDaemon/docx/images/Mainloop.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/NodeStateManagementRelations.png b/AudioManagerDaemon/docx/images/NodeStateManagementRelations.png Binary files differdeleted file mode 100755 index 52c25c6..0000000 --- a/AudioManagerDaemon/docx/images/NodeStateManagementRelations.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Notifications.png b/AudioManagerDaemon/docx/images/Notifications.png Binary files differdeleted file mode 100755 index d938d61..0000000 --- a/AudioManagerDaemon/docx/images/Notifications.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png b/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png Binary files differdeleted file mode 100644 index 882be93..0000000 --- a/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png b/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png Binary files differdeleted file mode 100644 index 0ae79f5..0000000 --- a/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Register_Domain.png b/AudioManagerDaemon/docx/images/Register_Domain.png Binary files differdeleted file mode 100644 index 09a1251..0000000 --- a/AudioManagerDaemon/docx/images/Register_Domain.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Registrations.png b/AudioManagerDaemon/docx/images/Registrations.png Binary files differdeleted file mode 100755 index b3abae9..0000000 --- a/AudioManagerDaemon/docx/images/Registrations.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Rundown.png b/AudioManagerDaemon/docx/images/Rundown.png Binary files differdeleted file mode 100755 index daa8470..0000000 --- a/AudioManagerDaemon/docx/images/Rundown.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/SettingConnectionFormats.png b/AudioManagerDaemon/docx/images/SettingConnectionFormats.png Binary files differdeleted file mode 100755 index 7e52c66..0000000 --- a/AudioManagerDaemon/docx/images/SettingConnectionFormats.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/SoundPropertyChangeofSink.png b/AudioManagerDaemon/docx/images/SoundPropertyChangeofSink.png Binary files differdeleted file mode 100644 index 5381bdc..0000000 --- a/AudioManagerDaemon/docx/images/SoundPropertyChangeofSink.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/SoundPropertyChangeofSource.png b/AudioManagerDaemon/docx/images/SoundPropertyChangeofSource.png Binary files differdeleted file mode 100644 index 6dd8328..0000000 --- a/AudioManagerDaemon/docx/images/SoundPropertyChangeofSource.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/SourceStates.png b/AudioManagerDaemon/docx/images/SourceStates.png Binary files differdeleted file mode 100755 index bf4a6ec..0000000 --- a/AudioManagerDaemon/docx/images/SourceStates.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/Startup.png b/AudioManagerDaemon/docx/images/Startup.png Binary files differdeleted file mode 100755 index 6fa84a5..0000000 --- a/AudioManagerDaemon/docx/images/Startup.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/StartupWithLastUserMode.png b/AudioManagerDaemon/docx/images/StartupWithLastUserMode.png Binary files differdeleted file mode 100755 index a42ac2e..0000000 --- a/AudioManagerDaemon/docx/images/StartupWithLastUserMode.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/VolumeChangesofSinks.png b/AudioManagerDaemon/docx/images/VolumeChangesofSinks.png Binary files differdeleted file mode 100755 index 5870a80..0000000 --- a/AudioManagerDaemon/docx/images/VolumeChangesofSinks.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/VolumeChangesofSources.png b/AudioManagerDaemon/docx/images/VolumeChangesofSources.png Binary files differdeleted file mode 100644 index b8cf682..0000000 --- a/AudioManagerDaemon/docx/images/VolumeChangesofSources.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/bus_topology.png b/AudioManagerDaemon/docx/images/bus_topology.png Binary files differdeleted file mode 100644 index 44486ff..0000000 --- a/AudioManagerDaemon/docx/images/bus_topology.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/daemon_insight.png b/AudioManagerDaemon/docx/images/daemon_insight.png Binary files differdeleted file mode 100755 index 341e3ab..0000000 --- a/AudioManagerDaemon/docx/images/daemon_insight.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/delay.jpg b/AudioManagerDaemon/docx/images/delay.jpg Binary files differdeleted file mode 100644 index 6b645b7..0000000 --- a/AudioManagerDaemon/docx/images/delay.jpg +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/dependencies.png b/AudioManagerDaemon/docx/images/dependencies.png Binary files differdeleted file mode 100644 index 30d272f..0000000 --- a/AudioManagerDaemon/docx/images/dependencies.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/dependencies_test.png b/AudioManagerDaemon/docx/images/dependencies_test.png Binary files differdeleted file mode 100644 index 870bc26..0000000 --- a/AudioManagerDaemon/docx/images/dependencies_test.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/dependency_created.png b/AudioManagerDaemon/docx/images/dependency_created.png Binary files differdeleted file mode 100644 index 7eabbf8..0000000 --- a/AudioManagerDaemon/docx/images/dependency_created.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/early.png b/AudioManagerDaemon/docx/images/early.png Binary files differdeleted file mode 100644 index 016cad7..0000000 --- a/AudioManagerDaemon/docx/images/early.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/example_system.png b/AudioManagerDaemon/docx/images/example_system.png Binary files differdeleted file mode 100644 index 6019c22..0000000 --- a/AudioManagerDaemon/docx/images/example_system.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/genivilogo.png b/AudioManagerDaemon/docx/images/genivilogo.png Binary files differdeleted file mode 100644 index d016ec8..0000000 --- a/AudioManagerDaemon/docx/images/genivilogo.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/late.png b/AudioManagerDaemon/docx/images/late.png Binary files differdeleted file mode 100644 index 76753a8..0000000 --- a/AudioManagerDaemon/docx/images/late.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/routing_hierarchy.png b/AudioManagerDaemon/docx/images/routing_hierarchy.png Binary files differdeleted file mode 100644 index d9586e9..0000000 --- a/AudioManagerDaemon/docx/images/routing_hierarchy.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/unique.svg b/AudioManagerDaemon/docx/images/unique.svg deleted file mode 100644 index c957a1c..0000000 --- a/AudioManagerDaemon/docx/images/unique.svg +++ /dev/null @@ -1,209 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- Created with Inkscape (http://www.inkscape.org/) --> - -<svg - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:cc="http://creativecommons.org/ns#" - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns="http://www.w3.org/2000/svg" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="179.797" - height="250.05112" - id="svg2" - version="1.1" - inkscape:version="0.47 r22583" - sodipodi:docname="unique.svg"> - <defs - id="defs4"> - <inkscape:perspective - sodipodi:type="inkscape:persp3d" - inkscape:vp_x="0 : 526.18109 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_z="744.09448 : 526.18109 : 1" - inkscape:persp3d-origin="372.04724 : 350.78739 : 1" - id="perspective10" /> - <inkscape:perspective - id="perspective3600" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - <inkscape:perspective - id="perspective3632" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - <inkscape:perspective - id="perspective3632-2" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - <inkscape:perspective - id="perspective3671" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - <inkscape:perspective - id="perspective3698" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - <inkscape:perspective - id="perspective3727" - inkscape:persp3d-origin="0.5 : 0.33333333 : 1" - inkscape:vp_z="1 : 0.5 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_x="0 : 0.5 : 1" - sodipodi:type="inkscape:persp3d" /> - </defs> - <sodipodi:namedview - id="base" - pagecolor="#ffffff" - bordercolor="#666666" - borderopacity="1.0" - inkscape:pageopacity="0.0" - inkscape:pageshadow="2" - inkscape:zoom="1.979899" - inkscape:cx="90.384438" - inkscape:cy="51.977401" - inkscape:document-units="px" - inkscape:current-layer="layer1" - showgrid="false" - showguides="true" - inkscape:guide-bbox="true" - inkscape:window-width="1678" - inkscape:window-height="976" - inkscape:window-x="0" - inkscape:window-y="25" - inkscape:window-maximized="1"> - <sodipodi:guide - orientation="0,1" - position="236.37061,82.827427" - id="guide3618" /> - <sodipodi:guide - orientation="0,1" - position="215.66249,249.50256" - id="guide3620" /> - <sodipodi:guide - orientation="0,1" - position="-27.78428,-18.692903" - id="guide3622" /> - <sodipodi:guide - orientation="1,0" - position="0.49999,127.77922" - id="guide3688" /> - </sodipodi:namedview> - <metadata - id="metadata7"> - <rdf:RDF> - <cc:Work - rdf:about=""> - <dc:format>image/svg+xml</dc:format> - <dc:type - rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - <dc:title></dc:title> - </cc:Work> - </rdf:RDF> - </metadata> - <g - inkscape:label="Layer 1" - inkscape:groupmode="layer" - id="layer1" - transform="translate(-221.22849,-22.468225)"> - <rect - style="fill:#2d0cc0;fill-opacity:1;fill-rule:nonzero;stroke:#000600;stroke-width:0.766761;stroke-opacity:1" - id="rect2816" - width="120.23324" - height="82.149467" - x="279.14343" - y="189.69191" /> - <rect - style="fill:#00cc00;fill-opacity:1;fill-rule:nonzero;stroke:#000600;stroke-width:1.09071505;stroke-opacity:1" - id="rect2816-4" - width="119.90929" - height="166.67833" - x="279.30542" - y="23.013582" /> - <path - style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="m 400.52548,189.69191 -177.78684,0" - id="path3616" /> - <path - style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="m 399.51533,272.01934 -177.78684,0" - id="path3616-3" /> - <text - xml:space="preserve" - style="font-size:10px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:FreeSans;-inkscape-font-specification:FreeSans" - x="221.72849" - y="267.97873" - id="text3659" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3661" - x="221.72849" - y="267.97873">ID 1</tspan></text> - <text - xml:space="preserve" - style="font-size:10px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:FreeSans;-inkscape-font-specification:FreeSans" - x="221.72849" - y="200.80359" - id="text3659-7" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3661-9" - x="221.72849" - y="200.80359">ID 100</tspan></text> - <text - xml:space="preserve" - style="font-size:10px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:FreeSans;-inkscape-font-specification:FreeSans" - x="221.72849" - y="184.57471" - id="text3659-7-5" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3661-9-9" - x="221.72849" - y="184.57471">ID 101</tspan></text> - <text - xml:space="preserve" - style="font-size:10px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#f9f9f9;fill-opacity:1;stroke:none;font-family:FreeSans;-inkscape-font-specification:FreeSans" - x="280.82242" - y="235.65385" - id="text3715" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3717" - x="280.82242" - y="235.65385" - style="font-size:24px">Fixed Area </tspan></text> - <text - xml:space="preserve" - style="font-size:10px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#f9f9f9;fill-opacity:1;stroke:none;font-family:FreeSans;-inkscape-font-specification:FreeSans" - x="334.61154" - y="119.37202" - id="text3715-7" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3717-1" - x="334.61154" - y="119.37202" - style="font-size:24px;text-align:center;text-anchor:middle">Dynamic</tspan><tspan - sodipodi:role="line" - x="337.93967" - y="149.37201" - style="font-size:24px;text-align:center;text-anchor:middle" - id="tspan3744"> Area </tspan></text> - </g> -</svg> diff --git a/AudioManagerDaemon/docx/images/versioning.png b/AudioManagerDaemon/docx/images/versioning.png Binary files differdeleted file mode 100644 index 9b587ba..0000000 --- a/AudioManagerDaemon/docx/images/versioning.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/versioning_new.png b/AudioManagerDaemon/docx/images/versioning_new.png Binary files differdeleted file mode 100755 index f5de375..0000000 --- a/AudioManagerDaemon/docx/images/versioning_new.png +++ /dev/null diff --git a/AudioManagerDaemon/docx/images/views.png b/AudioManagerDaemon/docx/images/views.png Binary files differdeleted file mode 100644 index d036ef4..0000000 --- a/AudioManagerDaemon/docx/images/views.png +++ /dev/null |
