2 * Copyright (C) 2012, BMW AG
4 * This file is part of GENIVI Project AudioManager.
6 * Contributions are licensed to the GENIVI Alliance under one or more
7 * Contribution License Agreements.
10 * This Source Code Form is subject to the terms of the
11 * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
12 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
15 * \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
17 * \file CAmDatabaseHandler.h
18 * For further information see http://www.genivi.org/.
25 #include "CAmDatabaseHandlerInterface.h"
26 #include <unordered_map>
33 //todo: check the enum values before entering & changing in the database.
34 //todo: change asserts for dynamic boundary checks into failure answers.#
35 //todo: check autoincrement boundary and set to 16bit limits
36 //todo: If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation. Check this statement for sinks & sources
37 //todo: exchange last_insert_row id to be more safe
38 //todo: create test to ensure uniqueness of names throughout the database
39 //todo: enforce the uniqueness of names
42 * This class handles and abstracts the database
44 class CAmMapHandler : public CAmDatabaseHandlerInterface
49 am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID);
50 am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID);
51 am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID);
52 am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID);
53 am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID);
54 am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID);
55 am_Error_e enterConnectionDB(const am_Connection_s& connection, am_connectionID_t& connectionID);
56 am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID);
57 am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass);
58 am_Error_e enterSystemProperties(const std::vector<am_SystemProperty_s>& listSystemProperties);
59 am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID);
60 am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState);
61 am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID);
62 am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID);
63 am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID);
64 am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID);
65 am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID);
66 am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID);
67 am_Error_e changeSourceSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sourceID_t sourceID);
68 am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sinkID_t sinkID);
69 am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID);
70 am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property);
71 am_Error_e changeDelayMainConnection(const am_timeSync_t & delay, const am_mainConnectionID_t & connectionID);
72 am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass);
73 am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass);
74 am_Error_e changeConnectionTimingInformation(const am_connectionID_t connectionID, const am_timeSync_t delay);
75 am_Error_e changeConnectionFinal(const am_connectionID_t connectionID);
76 am_Error_e changeSourceState(const am_sourceID_t sourceID, const am_SourceState_e sourceState);
77 am_Error_e changeSinkVolume(const am_sinkID_t sinkID, const am_volume_t volume);
78 am_Error_e changeSourceVolume(const am_sourceID_t sourceID, const am_volume_t volume);
79 am_Error_e changeCrossFaderHotSink(const am_crossfaderID_t crossfaderID, const am_HotSink_e hotsink);
80 am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID);
81 am_Error_e removeSinkDB(const am_sinkID_t sinkID);
82 am_Error_e removeSourceDB(const am_sourceID_t sourceID);
83 am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID);
84 am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID);
85 am_Error_e removeDomainDB(const am_domainID_t domainID);
86 am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID);
87 am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID);
88 am_Error_e removeConnection(const am_connectionID_t connectionID);
89 am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const;
90 am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const;
91 am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const;
92 am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const;
93 am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const;
94 am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const;
95 am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const;
96 am_Error_e getSinkVolume(const am_sinkID_t sinkID, am_volume_t& volume) const;
97 am_Error_e getSourceVolume(const am_sourceID_t sourceID, am_volume_t& volume) const;
98 am_Error_e getSinkSoundPropertyValue(const am_sinkID_t sinkID, const am_SoundPropertyType_e propertyType, int16_t& value) const;
99 am_Error_e getSourceSoundPropertyValue(const am_sourceID_t sourceID, const am_SoundPropertyType_e propertyType, int16_t& value) const;
100 am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const;
101 am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const;
102 am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listGatewaysID) const;
103 am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const;
104 am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const;
105 am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const;
106 am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const;
107 am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const;
108 am_Error_e getListSources(std::vector<am_Source_s>& lisSources) const;
109 am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const;
110 am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const;
111 am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const;
112 am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const;
113 am_Error_e getListVisibleMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const;
114 am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const;
115 am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const;
116 am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const;
117 am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const;
118 am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const;
119 am_Error_e getListSinkConnectionFormats(const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const;
120 am_Error_e getListSourceConnectionFormats(const am_sourceID_t sourceID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const;
121 am_Error_e getListGatewayConnectionFormats(const am_gatewayID_t gatewayID, std::vector<bool> & listConnectionFormat) const;
122 am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const;
123 am_Error_e getDomainOfSource(const am_sourceID_t sourceID, am_domainID_t& domainID) const;
124 am_Error_e getDomainOfSink(const am_sinkID_t sinkID, am_domainID_t& domainID) const;
125 am_Error_e getSoureState(const am_sourceID_t sourceID, am_SourceState_e& sourceState) const;
126 am_Error_e getDomainState(const am_domainID_t domainID, am_DomainState_e& state) const;
127 am_Error_e getRoutingTree(bool onlyfree, CAmRoutingTree& tree, std::vector<CAmRoutingTreeItem*>& flatTree);
128 am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID);
129 am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID);
130 am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID);
131 am_Error_e peekSinkClassID(const std::string& name, am_sinkClass_t& sinkClassID);
132 am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID);
133 am_Error_e changeSourceDB(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_ConnectionFormat_e>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties);
134 am_Error_e changeSinkDB(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_ConnectionFormat_e>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties);
135 am_Error_e getListMainSinkNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations);
136 am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations);
137 am_Error_e changeMainSinkNotificationConfigurationDB(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration);
138 am_Error_e changeMainSourceNotificationConfigurationDB(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration);
139 am_Error_e changeGatewayDB(const am_gatewayID_t gatewayID, const std::vector<am_ConnectionFormat_e>& listSourceConnectionFormats, const std::vector<am_ConnectionFormat_e>& listSinkConnectionFormats, const std::vector<bool>& convertionMatrix);
140 am_Error_e changeSinkNotificationConfigurationDB(const am_sinkID_t sinkID,const am_NotificationConfiguration_s notificationConfiguration);
141 am_Error_e changeSourceNotificationConfigurationDB(const am_sourceID_t sourceID,const am_NotificationConfiguration_s notificationConfiguration);
143 bool existMainConnection(const am_mainConnectionID_t mainConnectionID) const;
144 bool existcrossFader(const am_crossfaderID_t crossfaderID) const;
145 bool existConnection(const am_Connection_s & connection) const;
146 bool existConnectionID(const am_connectionID_t connectionID) const;
147 bool existSource(const am_sourceID_t sourceID) const;
148 bool existSourceNameOrID(const am_sourceID_t sourceID, const std::string& name) const;
149 bool existSourceName(const std::string& name) const;
150 bool existSink(const am_sinkID_t sinkID) const;
151 bool existSinkNameOrID(const am_sinkID_t sinkID, const std::string& name) const;
152 bool existSinkName(const std::string& name) const;
153 bool existDomain(const am_domainID_t domainID) const;
154 bool existGateway(const am_gatewayID_t gatewayID) const;
155 bool existSinkClass(const am_sinkClass_t sinkClassID) const;
156 bool existSourceClass(const am_sourceClass_t sourceClassID) const;
157 void registerObserver(CAmDatabaseObserver *iObserver);
158 bool sourceVisible(const am_sourceID_t sourceID) const;
159 bool sinkVisible(const am_sinkID_t sinkID) const;
163 void printSinkClasses();
164 void printSourceClasses();
168 * The following structures extend the base structures with the field 'reserved'.
171 struct am_Sink_Database_s : public am_Sink_s
174 am_Sink_Database_s():am_Sink_s(), reserved(false)
176 void getSinkType(am_SinkType_s & sinkType) const
178 sinkType.name = name;
179 sinkType.sinkID = sinkID;
180 sinkType.availability = available;
181 sinkType.muteState = muteState;
182 sinkType.volume = mainVolume;
183 sinkType.sinkClassID = sinkClassID;
185 am_Sink_Database_s & operator=(const am_Sink_Database_s & anObject)
187 if (this != &anObject)
189 am_Sink_s::operator=(anObject);
190 reserved = anObject.reserved;
194 am_Sink_Database_s & operator=(const am_Sink_s & anObject)
196 if (this != &anObject)
197 am_Sink_s::operator=(anObject);
202 printf("\n Sink(%s) id(%d)\n", name.c_str() ,sinkID);
203 printf("\t availability(%d) availabilityReason(%d) sinkClassID(%d) domainID(%d) visible(%d) volume(%d) mainVolume(%d) muteState(%d) reserved(%d)\n",
204 available.availability, available.availabilityReason, sinkClassID, domainID, visible, volume, mainVolume, muteState,reserved);
208 struct am_Source_Database_s : public am_Source_s
211 am_Source_Database_s():am_Source_s(), reserved(false)
213 void getSourceType(am_SourceType_s & sourceType) const
215 sourceType.name = name;
216 sourceType.sourceClassID = sourceClassID;
217 sourceType.availability = available;
218 sourceType.sourceID = sourceID;
220 am_Source_Database_s & operator=(const am_Source_Database_s & anObject)
222 if (this != &anObject)
224 am_Source_s::operator=(anObject);
225 reserved = anObject.reserved;
229 am_Source_Database_s & operator=(const am_Source_s & anObject)
231 if (this != &anObject)
233 am_Source_s::operator=(anObject);
239 printf("\n Source(%s) id(%d)\n", name.c_str() ,sourceID);
240 printf("\t availability(%d) availabilityReason(%d) sourceClassID(%d) domainID(%d) visible(%d) volume(%d) interruptState(%d) sourceState(%d) reserved(%d)\n",
241 available.availability, available.availabilityReason, sourceClassID, domainID, visible, volume, interruptState, sourceState,reserved);
245 struct am_Connection_Database_s : public am_Connection_s
248 am_Connection_Database_s():am_Connection_s(), reserved(true)
250 am_Connection_Database_s & operator=(const am_Connection_Database_s & anObject)
252 if (this != &anObject)
254 am_Connection_s::operator=(anObject);
255 reserved = anObject.reserved;
259 am_Connection_Database_s & operator=(const am_Connection_s & anObject)
261 if (this != &anObject)
262 am_Connection_s::operator=(anObject);
267 struct am_Domain_Database_s : public am_Domain_s
270 am_Domain_Database_s():am_Domain_s(), reserved(false)
272 am_Domain_Database_s & operator=(const am_Domain_Database_s & anObject)
274 if (this != &anObject)
276 am_Domain_s::operator=(anObject);
277 reserved = anObject.reserved;
281 am_Domain_Database_s & operator=(const am_Domain_s & anObject)
283 if (this != &anObject)
284 am_Domain_s::operator=(anObject);
289 struct am_MainConnection_Database_s : public am_MainConnection_s
291 am_MainConnection_Database_s():am_MainConnection_s()
293 void getMainConnectionType(am_MainConnectionType_s & connectionType) const
295 connectionType.mainConnectionID = mainConnectionID;
296 connectionType.sourceID = sourceID;
297 connectionType.sinkID = sinkID;
298 connectionType.connectionState = connectionState;
299 connectionType.delay = delay;
301 am_MainConnection_Database_s & operator=(const am_MainConnection_Database_s & anObject)
303 am_MainConnection_s::operator=(anObject);
306 am_MainConnection_Database_s & operator=(const am_MainConnection_s & anObject)
308 am_MainConnection_s::operator=(anObject);
313 typedef std::map<am_domainID_t, am_Domain_Database_s> CAmMapDomain;
314 typedef std::map<am_sourceClass_t, am_SourceClass_s> CAmMapSourceClass;
315 typedef std::map<am_sinkClass_t, am_SinkClass_s> CAmMapSinkClass;
316 typedef std::map<am_sinkID_t, am_Sink_Database_s> CAmMapSink;
317 typedef std::map<am_sourceID_t, am_Source_Database_s> CAmMapSource;
318 typedef std::map<am_gatewayID_t, am_Gateway_s> CAmMapGateway;
319 typedef std::map<am_crossfaderID_t, am_Crossfader_s> CAmMapCrossfader;
320 typedef std::map<am_connectionID_t, am_Connection_Database_s> CAmMapConnection;
321 typedef std::map<am_mainConnectionID_t, am_MainConnection_Database_s> CAmMapMainConnection;
322 typedef std::vector<am_SystemProperty_s> CAmVectorSystemProperties;
323 typedef struct CAmMappedData
325 int16_t mCurrentDomainID;
326 int16_t mCurrentSourceClassesID;
327 int16_t mCurrentSinkClassesID;
328 int16_t mCurrentSinkID;
329 int16_t mCurrentSourceID;
330 int16_t mCurrentGatewayID;
331 int16_t mCurrentCrossfaderID;
332 int16_t mCurrentConnectionID;
333 int16_t mCurrentMainConnectionID;
334 int16_t mDefaultIDLimit;
336 CAmVectorSystemProperties mSystemProperties;
337 CAmMapDomain mDomainMap;
338 CAmMapSourceClass mSourceClassesMap;
339 CAmMapSinkClass mSinkClassesMap;
341 CAmMapSource mSourceMap;
342 CAmMapGateway mGatewayMap;
343 CAmMapCrossfader mCrossfaderMap;
344 CAmMapConnection mConnectionMap;
345 CAmMapMainConnection mMainConnectionMap;
347 CAmMappedData(): //For Domain, MainConnections, Connections we don't have static IDs.
348 mCurrentDomainID(1), mCurrentSourceClassesID(DYNAMIC_ID_BOUNDARY), mCurrentSinkClassesID(DYNAMIC_ID_BOUNDARY),
349 mCurrentSinkID(DYNAMIC_ID_BOUNDARY), mCurrentSourceID(DYNAMIC_ID_BOUNDARY), mCurrentGatewayID(DYNAMIC_ID_BOUNDARY),
350 mCurrentCrossfaderID(DYNAMIC_ID_BOUNDARY), mCurrentConnectionID(1), mCurrentMainConnectionID(1),
351 mDefaultIDLimit(SHRT_MAX),
354 mDomainMap(),mSourceClassesMap(), mSinkClassesMap(), mSinkMap(), mSourceMap(),
355 mGatewayMap(), mCrossfaderMap(), mConnectionMap(), mMainConnectionMap()
358 bool increaseID(int16_t * resultID, int16_t * sourceID, int16_t const desiredStaticID = 0, int16_t const preferedStaticIDBoundary = DYNAMIC_ID_BOUNDARY)
360 if( desiredStaticID > 0 && desiredStaticID < preferedStaticIDBoundary )
362 *resultID = desiredStaticID;
365 else if( *sourceID < mDefaultIDLimit-1 ) //SHRT_MAX or the max limit is reserved and not used!!!
367 *resultID = (*sourceID)++;
379 CAmMappedData mMappedData;
381 am_timeSync_t calculateMainConnectionDelay(const am_mainConnectionID_t mainConnectionID) const; //!< calculates a new main connection delay
382 int16_t calculateDelayForRoute(const std::vector<am_connectionID_t>& listConnectionID);
383 bool insertSinkDB(const am_Sink_s & sinkData, am_sinkID_t & sinkID);
384 bool insertCrossfaderDB(const am_Crossfader_s & crossfaderData, am_crossfaderID_t & crossfaderID);
385 bool insertGatewayDB(const am_Gateway_s & gatewayData, am_gatewayID_t & gatewayID);
386 bool insertSourceDB(const am_Source_s & sourceData, am_sourceID_t & sourceID);
387 bool insertSinkClassDB(const am_SinkClass_s & sinkClass, am_sinkClass_t & sinkClassID);
388 bool insertSourceClassDB(am_sourceClass_t & sourceClassID, const am_SourceClass_s & sourceClass);
393 #endif /* MAPHANDLER_H_ */