AudioManagerDaemon/include/RoutingSender.h

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