2 * Copyright (C) 2011, BMW AG
4 * GeniviAudioMananger AudioManagerDaemon
6 * \file RoutingSender.h
8 * \date 20-Oct-2011 3:42:04 PM
9 * \author Christian Mueller (christian.ei.mueller@bmw.de)
12 * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
13 * Copyright (C) 2011, BMW AG Christian Mueller Christian.ei.mueller@bmw.de
15 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
17 * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
18 * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
19 * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
20 * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
21 * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
25 #ifndef ROUTINGSENDER_H_
26 #define ROUTINGSENDER_H_
28 #include "routing/RoutingSendInterface.h"
31 #ifdef UNIT_TEST //this is needed to test RoutingSender
32 #include "../test/RoutingInterfaceBackdoor.h"
38 * Implements the RoutingSendInterface. Loads all plugins and dispatches calls to the plugins
42 RoutingSender(const std::vector<std::string>& listOfPluginDirectories);
43 virtual ~RoutingSender();
46 * removes a handle from the list
47 * @param handle to be removed
48 * @return E_OK in case of success
50 am_Error_e removeHandle(const am_Handle_s& handle);
54 * this adds the domain to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
55 * This must be done whenever a domain is registered.
57 am_Error_e addDomainLookup(const am_Domain_s& domainData);
60 * this adds the Source to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
61 * This must be done whenever a Source is registered.
63 am_Error_e addSourceLookup(const am_Source_s& sourceData);
66 * this adds the Sink to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
67 * This must be done whenever a Sink is registered.
69 am_Error_e addSinkLookup(const am_Sink_s& sinkData);
72 * this adds the Crossfader to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
73 * This must be done whenever a Crossfader is registered.
75 am_Error_e addCrossfaderLookup(const am_Crossfader_s& crossfaderData);
78 * this removes the Domain to the lookup table of the Router. This must be done everytime a domain is deregistered.
80 am_Error_e removeDomainLookup(const am_domainID_t domainID);
83 * this removes the Source to the lookup table of the Router. This must be done everytime a source is deregistered.
85 am_Error_e removeSourceLookup(const am_sourceID_t sourceID);
88 * this removes the Sink to the lookup table of the Router. This must be done everytime a sink is deregistered.
90 am_Error_e removeSinkLookup(const am_sinkID_t sinkID);
93 * this removes the Crossfader to the lookup table of the Router. This must be done everytime a crossfader is deregistered.
95 am_Error_e removeCrossfaderLookup(const am_crossfaderID_t crossfaderID);
96 void startupRoutingInterface(RoutingReceiveInterface* routingreceiveinterface) ;
97 void routingInterfacesReady() ;
98 void routingInterfacesRundown() ;
99 am_Error_e asyncAbort(const am_Handle_s& handle) ;
100 am_Error_e asyncConnect(am_Handle_s& handle, const am_connectionID_t connectionID, const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_ConnectionFormat_e connectionFormat) ;
101 am_Error_e asyncDisconnect(am_Handle_s& handle, const am_connectionID_t connectionID) ;
102 am_Error_e asyncSetSinkVolume(am_Handle_s& handle, const am_sinkID_t sinkID, const am_volume_t volume, const am_RampType_e ramp, const am_time_t time) ;
103 am_Error_e asyncSetSourceVolume(am_Handle_s& handle, const am_sourceID_t sourceID, const am_volume_t volume, const am_RampType_e ramp, const am_time_t time) ;
104 am_Error_e asyncSetSourceState(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SourceState_e state) ;
105 am_Error_e asyncSetSinkSoundProperty(am_Handle_s& handle, const am_sinkID_t sinkID, const am_SoundProperty_s& soundProperty) ;
106 am_Error_e asyncSetSourceSoundProperties(am_Handle_s& handle, const std::vector<am_SoundProperty_s>& listSoundProperties, const am_sourceID_t sourceID) ;
107 am_Error_e asyncSetSinkSoundProperties(am_Handle_s& handle, const std::vector<am_SoundProperty_s>& listSoundProperties, const am_sinkID_t sinkID) ;
108 am_Error_e asyncSetSourceSoundProperty(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SoundProperty_s& soundProperty) ;
109 am_Error_e asyncCrossFade(am_Handle_s& handle, const am_crossfaderID_t crossfaderID, const am_HotSink_e hotSink, const am_RampType_e rampType, const am_time_t time) ;
110 am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState) ;
111 am_Error_e getListHandles(std::vector<am_Handle_s> & listHandles) const ;
112 am_Error_e getListPlugins(std::vector<std::string>& interfaces) const;
113 uint16_t getInterfaceVersion() const;
115 //!< is used to pair interfaces with busnames
116 struct InterfaceNamePairs
118 RoutingSendInterface* routingInterface;
122 //!< is used to store data related to handles
123 class am_handleData_c
129 am_sourceID_t sourceID;
130 am_crossfaderID_t crossfaderID;
131 am_connectionID_t connectionID;
135 am_SoundProperty_s soundPropery;
136 am_SourceState_e sourceState;
138 am_HotSink_e hotSink;
139 std::vector<am_SoundProperty_s>* soundProperties;
145 #ifdef UNIT_TEST //this is needed to test RoutingSender
146 friend class RoutingInterfaceBackdoor;
150 * returns the data that belong to handles
151 * @param handle the handle
152 * @return a class holding the handle data
154 am_handleData_c returnHandleData(const am_Handle_s handle) const;
158 //!< is needed to sort the handles in the map
161 bool operator()(const am_Handle_s& a, const am_Handle_s& b) const
163 return (a.handle < b.handle);
168 * creates a handle and adds it to the list of handles
169 * @param handleData the data that should be saves together with the handle
170 * @param type the type of handle to be created
173 am_Handle_s createHandle(const am_handleData_c& handleData, const am_Handle_e type);
174 void unloadLibraries(void); //!< unloads all loaded plugins
176 typedef std::map<am_domainID_t, RoutingSendInterface*> DomainInterfaceMap; //!< maps domains to interfaces
177 typedef std::map<am_sinkID_t, RoutingSendInterface*> SinkInterfaceMap; //!< maps sinks to interfaces
178 typedef std::map<am_sourceID_t, RoutingSendInterface*> SourceInterfaceMap; //!< maps sources to interfaces
179 typedef std::map<am_crossfaderID_t, RoutingSendInterface*> CrossfaderInterfaceMap; //!< maps crossfaders to interfaces
180 typedef std::map<am_connectionID_t, RoutingSendInterface*> ConnectionInterfaceMap; //!< maps connections to interfaces
181 typedef std::map<uint16_t, RoutingSendInterface*> HandleInterfaceMap; //!< maps handles to interfaces
182 typedef std::map<am_Handle_s,am_handleData_c,comparator> HandlesMap; //!< maps handleData to handles
184 int16_t mHandleCount; //!< is used to create handles
185 HandlesMap mlistActiveHandles; //!< list of all currently "running" handles.
186 std::vector<void*> mListLibraryHandles; //!< list of all loaded pluginInterfaces
187 std::vector<InterfaceNamePairs> mListInterfaces; //!< list of busname/interface relation
188 ConnectionInterfaceMap mMapConnectionInterface; //!< map of connection to interfaces
189 CrossfaderInterfaceMap mMapCrossfaderInterface; //!< map of crossfaders to interface
190 DomainInterfaceMap mMapDomainInterface; //!< map of domains to interfaces
191 SinkInterfaceMap mMapSinkInterface; //!< map of sinks to interfaces
192 SourceInterfaceMap mMapSourceInterface; //!< map of sources to interfaces
193 HandleInterfaceMap mMapHandleInterface; //!< map of handles to interfaces
198 #endif /* ROUTINGSENDER_H_ */