AudioManagerDaemon/src/CommandSender.cpp

   1 /**
   2  * Copyright (C) 2011, BMW AG
   3  *
   4  * GeniviAudioMananger AudioManagerDaemon
   5  *
   6  * \file CommandSender.cpp
   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 #include "CommandSender.h"
  26 #include "command/CommandReceiveInterface.h"
  27 #include <dirent.h>
  28 #include "PluginTemplate.h"
  29 #include "DLTWrapper.h"
  30
  31 using namespace am;
  32
  33 #define REQUIRED_INTERFACE_VERSION 1
  34
  35 //!< macro to call all interfaces
  36 #define CALL_ALL_INTERFACES(...)                                                                                                                 \
  37                 std::vector<CommandSendInterface*>::iterator iter = mListInterfaces.begin();     \
  38                 std::vector<CommandSendInterface*>::iterator iterEnd = mListInterfaces.end();    \
  39                 for (; iter<iterEnd;++iter)                                                                                                              \
  40                 {                                                                                                                                                                \
  41                         (*iter)->__VA_ARGS__;                                                                                                            \
  42                 }
  43
  44 CommandSender::CommandSender(const std::vector<std::string>& listOfPluginDirectories) :
  45         mListInterfaces(), //
  46         mListLibraryHandles(),
  47         mListLibraryNames()
  48 {
  49     std::vector<std::string> sharedLibraryNameList;
  50     std::vector<std::string>::const_iterator dirIter = listOfPluginDirectories.begin();
  51     std::vector<std::string>::const_iterator dirIterEnd = listOfPluginDirectories.end();
  52
  53     // search communicator plugins in configured directories
  54     for (; dirIter < dirIterEnd; ++dirIter)
  55     {
  56         const char* directoryName = dirIter->c_str();
  57         logInfo("Searching for CommandPlugins in" , *dirIter);
  58         DIR *directory = opendir(directoryName);
  59
  60         if (!directory)
  61         {
  62             logError("Error opening directory ",*dirIter);
  63             continue;
  64         }
  65
  66         // iterate content of directory
  67         struct dirent *itemInDirectory = 0;
  68         while ((itemInDirectory = readdir(directory)))
  69         {
  70             unsigned char entryType = itemInDirectory->d_type;
  71             std::string entryName = itemInDirectory->d_name;
  72
  73             bool regularFile = (entryType == DT_REG || entryType == DT_LNK);
  74             bool sharedLibExtension = ("so" == entryName.substr(entryName.find_last_of(".") + 1));
  75
  76             if (regularFile && sharedLibExtension)
  77             {
  78                 std::string name(directoryName);
  79                 sharedLibraryNameList.push_back(name + "/" + entryName);
  80             }
  81         }
  82         closedir(directory);
  83     }
  84
  85     // iterate all communicator plugins and start them
  86     std::vector<std::string>::iterator iter = sharedLibraryNameList.begin();
  87     std::vector<std::string>::iterator iterEnd = sharedLibraryNameList.end();
  88
  89     for (; iter < iterEnd; ++iter)
  90     {
  91         logInfo("Loading CommandSender plugin", *iter);
  92         CommandSendInterface* (*createFunc)();
  93         void* tempLibHandle = NULL;
  94         createFunc = getCreateFunction<CommandSendInterface*()>(*iter, tempLibHandle);
  95
  96         if (!createFunc)
  97         {
  98             logInfo("Entry point of CommandPlugin not found", *iter);
  99             continue;
 100         }
 101
 102         CommandSendInterface* commander = createFunc();
 103
 104         if (!commander)
 105         {
 106             logInfo("CommandPlugin initialization failed. Entry Function not callable");
 107             continue;
 108         }
 109
 110         //check libversion
 111         if (commander->getInterfaceVersion() < REQUIRED_INTERFACE_VERSION)
 112         {
 113             logInfo("RoutingPlugin initialization failed. Version of Interface to old");
 114             continue;
 115         }
 116
 117         mListInterfaces.push_back(commander);
 118         mListLibraryHandles.push_back(tempLibHandle);
 119         mListLibraryNames.push_back(iter->c_str());
 120     }
 121 }
 122
 123 CommandSender::~CommandSender()
 124 {
 125     unloadLibraries();
 126 }
 127
 128 am_Error_e CommandSender::stopInterface()
 129 {
 130     am_Error_e returnError = E_OK;
 131
 132     std::vector<CommandSendInterface*>::iterator iter = mListInterfaces.begin();
 133     std::vector<CommandSendInterface*>::iterator iterEnd = mListInterfaces.end();
 134     for (; iter < iterEnd; ++iter)
 135     {
 136         am_Error_e error = (*iter)->stopInterface();
 137         if (error != E_OK)
 138         {
 139             returnError = error;
 140         }
 141     }
 142     return returnError;
 143 }
 144
 145 am_Error_e CommandSender::startupInterface(CommandReceiveInterface *commandreceiveinterface)
 146 {
 147     am_Error_e returnError = E_OK;
 148
 149     std::vector<CommandSendInterface*>::iterator iter = mListInterfaces.begin();
 150     std::vector<CommandSendInterface*>::iterator iterEnd = mListInterfaces.end();
 151     for (; iter < iterEnd; ++iter)
 152     {
 153         am_Error_e error = (*iter)->startupInterface(commandreceiveinterface);
 154         if (error != E_OK)
 155         {
 156             returnError = error;
 157         }
 158     }
 159     return returnError;
 160 }
 161
 162 void CommandSender::cbCommunicationReady()
 163 {
 164     CALL_ALL_INTERFACES(cbCommunicationReady())
 165 }
 166
 167 void CommandSender::cbCommunicationRundown()
 168 {
 169     CALL_ALL_INTERFACES(cbCommunicationRundown())
 170 }
 171
 172 void CommandSender::cbNumberOfMainConnectionsChanged()
 173 {
 174     CALL_ALL_INTERFACES(cbNumberOfMainConnectionsChanged())
 175 }
 176
 177 void CommandSender::cbNumberOfSinksChanged()
 178 {
 179     CALL_ALL_INTERFACES(cbNumberOfSinksChanged())
 180 }
 181
 182 void CommandSender::cbNumberOfSourcesChanged()
 183 {
 184     CALL_ALL_INTERFACES(cbNumberOfSourcesChanged())
 185 }
 186
 187 void CommandSender::cbNumberOfSinkClassesChanged()
 188 {
 189     CALL_ALL_INTERFACES(cbNumberOfSinkClassesChanged())
 190 }
 191
 192 void CommandSender::cbNumberOfSourceClassesChanged()
 193 {
 194     CALL_ALL_INTERFACES(cbNumberOfSourceClassesChanged())
 195 }
 196
 197 void CommandSender::cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState)
 198 {
 199     CALL_ALL_INTERFACES(cbMainConnectionStateChanged(connectionID,connectionState))
 200 }
 201
 202 void CommandSender::cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s SoundProperty)
 203 {
 204     CALL_ALL_INTERFACES(cbMainSinkSoundPropertyChanged(sinkID,SoundProperty))
 205 }
 206
 207 void CommandSender::cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s & SoundProperty)
 208 {
 209     CALL_ALL_INTERFACES(cbMainSourceSoundPropertyChanged(sourceID,SoundProperty))
 210 }
 211
 212 void CommandSender::cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s & availability)
 213 {
 214     CALL_ALL_INTERFACES(cbSinkAvailabilityChanged(sinkID,availability))
 215 }
 216
 217 void CommandSender::cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s & availability)
 218 {
 219     CALL_ALL_INTERFACES(cbSourceAvailabilityChanged(sourceID,availability))
 220 }
 221
 222 void CommandSender::cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume)
 223 {
 224     CALL_ALL_INTERFACES(cbVolumeChanged(sinkID,volume))
 225 }
 226
 227 void CommandSender::cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState)
 228 {
 229     CALL_ALL_INTERFACES(cbSinkMuteStateChanged(sinkID,muteState))
 230 }
 231
 232 void CommandSender::cbSystemPropertyChanged(const am_SystemProperty_s & SystemProperty)
 233 {
 234     CALL_ALL_INTERFACES(cbSystemPropertyChanged(SystemProperty))
 235 }
 236
 237 void CommandSender::cbTimingInformationChanged(const am_mainConnectionID_t mainConnection, const am_timeSync_t time)
 238 {
 239     CALL_ALL_INTERFACES(cbTimingInformationChanged(mainConnection,time))
 240 }
 241
 242 am_Error_e am::CommandSender::getListPlugins(std::vector<std::string> & interfaces) const
 243 {
 244    interfaces = mListLibraryNames;
 245    return E_OK;
 246 }
 247
 248 void CommandSender::unloadLibraries(void)
 249 {
 250     std::vector<void*>::iterator iterator = mListLibraryHandles.begin();
 251     for (; iterator < mListLibraryHandles.end(); ++iterator)
 252     {
 253         dlclose(*iterator);
 254     }
 255     mListLibraryHandles.clear();
 256 }
 257
 258 uint16_t CommandSender::getInterfaceVersion() const
 259 {
 260     return CommandSendVersion;
 261 }
 262