summaryrefslogtreecommitdiff
path: root/AudioManagerCore/include/CAmRoutingSender.h
blob: 39b5c235537b6c01c135b3f30aa991321745facc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/**
 * SPDX license identifier: MPL-2.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 BMW 2011,2012
 *
 * \file CAmRoutingSender.h
 * For further information see http://www.genivi.org/.
 *
 */

#ifndef ROUTINGSENDER_H_
#define ROUTINGSENDER_H_

#include "IAmRouting.h"
#include <map>
#include <memory>

#ifdef UNIT_TEST // this is needed to test RoutingSender
# include "../test/IAmRoutingBackdoor.h"
#endif

#include "CAmDatabaseHandlerMap.h"

namespace am
{

class CAmRoutingReceiver;

/**
 * Implements the RoutingSendInterface. Loads all plugins and dispatches calls to the plugins
 */
class CAmRoutingSender : public CAmDatabaseHandlerMap::AmDatabaseObserverCallbacks
{
public:
    CAmRoutingSender(const std::vector<std::string> &listOfPluginDirectories, IAmDatabaseHandler *databaseHandler);
    ~CAmRoutingSender();

    am_Error_e removeHandle(const am_Handle_s &handle);
    am_Error_e addDomainLookup(const am_Domain_s &domainData);
    am_Error_e addSourceLookup(const am_Source_s &sourceData);
    am_Error_e addSinkLookup(const am_Sink_s &sinkData);
    am_Error_e addCrossfaderLookup(const am_Crossfader_s &crossfaderData);
    am_Error_e removeDomainLookup(const am_domainID_t domainID);
    am_Error_e removeSourceLookup(const am_sourceID_t sourceID);
    am_Error_e removeSinkLookup(const am_sinkID_t sinkID);
    am_Error_e removeCrossfaderLookup(const am_crossfaderID_t crossfaderID);
    am_Error_e removeConnectionLookup(const am_connectionID_t connectionID);

    am_Error_e startupInterfaces(CAmRoutingReceiver *iRoutingReceiver);
    void setRoutingReady();
    void setRoutingRundown();
    am_Error_e asyncAbort(const am_Handle_s &handle);
    am_Error_e asyncConnect(am_Handle_s &handle, am_connectionID_t &connectionID, const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_CustomConnectionFormat_t connectionFormat);
    am_Error_e asyncDisconnect(am_Handle_s &handle, const am_connectionID_t connectionID);
    am_Error_e asyncSetSinkVolume(am_Handle_s &handle, const am_sinkID_t sinkID, const am_volume_t volume, const am_CustomRampType_t ramp, const am_time_t time);
    am_Error_e asyncSetSourceVolume(am_Handle_s &handle, const am_sourceID_t sourceID, const am_volume_t volume, const am_CustomRampType_t ramp, const am_time_t time);
    am_Error_e asyncSetSourceState(am_Handle_s &handle, const am_sourceID_t sourceID, const am_SourceState_e state);
    am_Error_e asyncSetSinkSoundProperty(am_Handle_s &handle, const am_sinkID_t sinkID, const am_SoundProperty_s &soundProperty);
    am_Error_e asyncSetSourceSoundProperties(am_Handle_s &handle, const std::vector<am_SoundProperty_s> &listSoundProperties, const am_sourceID_t sourceID);
    am_Error_e asyncSetSinkSoundProperties(am_Handle_s &handle, const std::vector<am_SoundProperty_s> &listSoundProperties, const am_sinkID_t sinkID);
    am_Error_e asyncSetSourceSoundProperty(am_Handle_s &handle, const am_sourceID_t sourceID, const am_SoundProperty_s &soundProperty);
    am_Error_e asyncCrossFade(am_Handle_s &handle, const am_crossfaderID_t crossfaderID, const am_HotSink_e hotSink, const am_CustomRampType_t rampType, const am_time_t time);
    am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState);
    am_Error_e getListHandles(std::vector<am_Handle_s> &listHandles) const;
    am_Error_e getListPlugins(std::vector<std::string> &interfaces) const;
    void getInterfaceVersion(std::string &version) const;
    am_Error_e asyncSetVolumes(am_Handle_s &handle, const std::vector<am_Volumes_s> &listVolumes);
    am_Error_e asyncSetSinkNotificationConfiguration(am_Handle_s &handle, const am_sinkID_t sinkID, const am_NotificationConfiguration_s &notificationConfiguration);
    am_Error_e asyncSetSourceNotificationConfiguration(am_Handle_s &handle, const am_sourceID_t sourceID, const am_NotificationConfiguration_s &notificationConfiguration);
    am_Error_e resyncConnectionState(const am_domainID_t domainID, std::vector<am_Connection_s> &listOfExistingConnections);

    struct InterfaceNamePairs //!< is used to pair interfaces with busnames
    {
        IAmRoutingSend *routingInterface; //!< pointer to the routingInterface
        std::string busName;              //!< the busname
    };

    class handleDataBase
    {
    public:
        handleDataBase(IAmRoutingSend *interface, IAmDatabaseHandler *databaseHandler)
            : mInterface(interface)
            , mpDatabaseHandler(databaseHandler) {}
        virtual ~handleDataBase() {}
        virtual am_Error_e writeDataToDatabase() = 0;   //!< function to write the handle data to the database

        IAmRoutingSend *returnInterface() {return mInterface;}
    private:
        IAmRoutingSend     *mInterface;
    protected:
        IAmDatabaseHandler *mpDatabaseHandler;
    };

    class handleVolumeBase : public handleDataBase
    {
    public:
        handleVolumeBase(IAmRoutingSend *interface, IAmDatabaseHandler *databaseHandler, am_volume_t volume)
            : handleDataBase(interface, databaseHandler)
            , mVolume(volume) {}
        virtual ~handleVolumeBase(){}
        am_volume_t returnVolume() { return mVolume; }
    private:
        am_volume_t mVolume;
    };

    class handleSinkSoundProperty : public handleDataBase
    {
    public:
        handleSinkSoundProperty(IAmRoutingSend *interface, const am_sinkID_t sinkID, const am_SoundProperty_s &soundProperty, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSinkID(sinkID)
            , mSoundProperty(soundProperty) {}
        ~handleSinkSoundProperty() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sinkID_t        mSinkID;
        am_SoundProperty_s mSoundProperty;
    };

    class handleSinkSoundProperties : public handleDataBase
    {
    public:
        handleSinkSoundProperties(IAmRoutingSend *interface, const am_sinkID_t sinkID, const std::vector<am_SoundProperty_s> &listSoundProperties, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSinkID(sinkID)
            , mlistSoundProperties(listSoundProperties) {}
        ~handleSinkSoundProperties() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sinkID_t                     mSinkID;
        std::vector<am_SoundProperty_s> mlistSoundProperties;
    };

    class handleSourceSoundProperty : public handleDataBase
    {
    public:
        handleSourceSoundProperty(IAmRoutingSend *interface, const am_sourceID_t sourceID, const am_SoundProperty_s &soundProperty, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSourceID(sourceID)
            , mSoundProperty(soundProperty) {}
        ~handleSourceSoundProperty() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sourceID_t      mSourceID;
        am_SoundProperty_s mSoundProperty;
    };

    class handleSourceSoundProperties : public handleDataBase
    {
    public:
        handleSourceSoundProperties(IAmRoutingSend *interface, const am_sourceID_t sourceID, const std::vector<am_SoundProperty_s> &listSoundProperties, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSourceID(sourceID)
            , mlistSoundProperties(listSoundProperties) {}
        ~handleSourceSoundProperties(){}
        am_Error_e writeDataToDatabase();

    private:
        am_sourceID_t                   mSourceID;
        std::vector<am_SoundProperty_s> mlistSoundProperties;
    };

    class handleSourceState : public handleDataBase
    {
    public:
        handleSourceState(IAmRoutingSend *interface, const am_sourceID_t sourceID, const am_SourceState_e &state, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSourceID(sourceID)
            , mSourceState(state) {}
        ~handleSourceState() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sourceID_t    mSourceID;
        am_SourceState_e mSourceState;
    };

    class handleSourceVolume : public handleVolumeBase
    {
    public:
        handleSourceVolume(IAmRoutingSend *interface, const am_sourceID_t sourceID, IAmDatabaseHandler *databaseHandler, const am_volume_t &volume)
            : handleVolumeBase(interface, databaseHandler, volume)
            , mSourceID(sourceID) {}
        ~handleSourceVolume() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sourceID_t mSourceID;
    };

    class handleSinkVolume : public handleVolumeBase
    {
    public:
        handleSinkVolume(IAmRoutingSend *interface, const am_sinkID_t sinkID, IAmDatabaseHandler *databaseHandler, const am_volume_t &volume)
            : handleVolumeBase(interface, databaseHandler, volume)
            , mSinkID(sinkID) {}
        ~handleSinkVolume() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sinkID_t mSinkID;
    };

    class handleCrossFader : public handleDataBase
    {
    public:
        handleCrossFader(IAmRoutingSend *interface, const am_crossfaderID_t crossfaderID, const am_HotSink_e &hotSink, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mCrossfaderID(crossfaderID)
            , mHotSink(hotSink) {}
        ~handleCrossFader() {}
        am_Error_e writeDataToDatabase();

    private:
        am_crossfaderID_t mCrossfaderID;
        am_HotSink_e      mHotSink;
    };

    class handleConnect : public handleDataBase
    {
    public:
        handleConnect(IAmRoutingSend *interface, const am_connectionID_t connectionID, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mConnectionID(connectionID)
            , mConnectionPending(true) {}
        ~handleConnect();
        am_Error_e writeDataToDatabase();

    private:
        am_connectionID_t mConnectionID;
        bool              mConnectionPending;
    };

    class handleDisconnect : public handleDataBase
    {
    public:
        handleDisconnect(IAmRoutingSend *interface, const am_connectionID_t connectionID, IAmDatabaseHandler *databaseHandler, CAmRoutingSender *routingSender)
            : handleDataBase(interface, databaseHandler)
            , mConnectionID(connectionID)
            , mRoutingSender(routingSender){}
        ~handleDisconnect();
        am_Error_e writeDataToDatabase();

    private:
        am_connectionID_t mConnectionID;
        CAmRoutingSender *mRoutingSender;
    };

    class handleSetVolumes : public handleDataBase
    {
    public:
        handleSetVolumes(IAmRoutingSend *interface, const std::vector<am_Volumes_s> listVolumes, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mlistVolumes(listVolumes) {}
        ~handleSetVolumes() {}
        am_Error_e writeDataToDatabase();

    private:
        std::vector<am_Volumes_s> mlistVolumes;
    };

    class handleSetSinkNotificationConfiguration : public handleDataBase
    {
    public:
        handleSetSinkNotificationConfiguration(IAmRoutingSend *interface, const am_sinkID_t sinkID, const am_NotificationConfiguration_s notificationConfiguration, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSinkID(sinkID)
            , mNotificationConfiguration(notificationConfiguration){}
        ~handleSetSinkNotificationConfiguration() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sinkID_t                    mSinkID;
        am_NotificationConfiguration_s mNotificationConfiguration;
    };

    class handleSetSourceNotificationConfiguration : public handleDataBase
    {
    public:
        handleSetSourceNotificationConfiguration(IAmRoutingSend *interface, const am_sourceID_t sourceID, const am_NotificationConfiguration_s notificationConfiguration, IAmDatabaseHandler *databaseHandler)
            : handleDataBase(interface, databaseHandler)
            , mSourceID(sourceID)
            , mNotificationConfiguration(notificationConfiguration) {}
        ~handleSetSourceNotificationConfiguration() {}
        am_Error_e writeDataToDatabase();

    private:
        am_sourceID_t                  mSourceID;
        am_NotificationConfiguration_s mNotificationConfiguration;
    };

    am_Error_e writeToDatabaseAndRemove(const am_Handle_s handle); //!< write data to Database and remove handle
    void checkVolume(const am_Handle_s handle, const am_volume_t volume);
    bool handleExists(const am_Handle_s handle); //!< returns true if the handle exists

#ifdef UNIT_TEST // this is needed to test RoutingSender
    friend class IAmRoutingBackdoor;
#endif

private:
    struct comparator //!< is needed to sort the handles in the map
    {
        bool operator()(const am_Handle_s &a, const am_Handle_s &b) const
        {
            return (a.handle < b.handle || (a.handle == b.handle && a.handleType < b.handleType));
        }

    };

    void loadPlugins(const std::vector<std::string> &listOfPluginDirectories);
    am_Handle_s createHandle(std::shared_ptr<handleDataBase> handleData, const am_Handle_e type); //!< creates a handle
    void unloadLibraries(void);                                                                   //!< unloads all loaded plugins

    typedef std::map<am_domainID_t, IAmRoutingSend *>                          DomainInterfaceMap;     //!< maps domains to interfaces
    typedef std::map<am_sinkID_t, IAmRoutingSend *>                            SinkInterfaceMap;       //!< maps sinks to interfaces
    typedef std::map<am_sourceID_t, IAmRoutingSend *>                          SourceInterfaceMap;     //!< maps sources to interfaces
    typedef std::map<am_crossfaderID_t, IAmRoutingSend *>                      CrossfaderInterfaceMap; //!< maps crossfaders to interfaces
    typedef std::map<am_connectionID_t, IAmRoutingSend *>                      ConnectionInterfaceMap; //!< maps connections to interfaces
    typedef std::map<am_Handle_s, std::shared_ptr<handleDataBase>, comparator> HandlesMap;             //!< maps handleData to handles

    int16_t                         mHandleCount;            //!< is used to create handles
    HandlesMap                      mlistActiveHandles;      //!< list of all currently "running" handles.
    std::vector<void *>             mListLibraryHandles;     //!< list of all loaded pluginInterfaces
    std::vector<InterfaceNamePairs> mListInterfaces;         //!< list of busname/interface relation
    CrossfaderInterfaceMap          mMapCrossfaderInterface; //!< map of crossfaders to interface
    ConnectionInterfaceMap          mMapConnectionInterface; //!< map of connection to interfaces
    DomainInterfaceMap              mMapDomainInterface;     //!< map of domains to interfaces
    SinkInterfaceMap                mMapSinkInterface;       //!< map of sinks to interfaces
    SourceInterfaceMap              mMapSourceInterface;     //!< map of sources to interfaces
    CAmRoutingReceiver             *mpRoutingReceiver;       //!< pointer to routing receiver
    IAmDatabaseHandler             *mpDatabaseHandler;       //!< pointer to the databaseHandler
};

}

#endif /* ROUTINGSENDER_H_ */