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 CAmDatabaseHandlerInterface.h
18 * For further information see http://www.genivi.org/.
22 #ifndef DATABASEHANDLERINTERFACE_H_
23 #define DATABASEHANDLERINTERFACE_H_
25 #include "audiomanagertypes.h"
33 class CAmDatabaseObserver;
35 class CAmRoutingTreeItem;
37 #define DYNAMIC_ID_BOUNDARY 100 //!< the value below is reserved for staticIDs, the value above will be assigned to dynamically registered items
38 //todo: check the enum values before entering & changing in the database.
39 //todo: change asserts for dynamic boundary checks into failure answers.#
40 //todo: check autoincrement boundary and set to 16bit limits
41 //todo: If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation. Check this statement for sinks & sources
42 //todo: exchange last_insert_row id to be more safe
43 //todo: create test to ensure uniqueness of names throughout the database
44 //todo: enforce the uniqueness of names
46 typedef std::map<am_gatewayID_t, std::vector<bool> > ListConnectionFormat; //!< type for list of connection formats
49 * This class handles and abstracts the database
52 class CAmDatabaseHandlerInterface
55 virtual am_timeSync_t calculateMainConnectionDelay(const am_mainConnectionID_t mainConnectionID) const = 0; //!< calculates a new main connection delay
56 CAmDatabaseObserver *mpDatabaseObserver; //!< pointer to the Observer
57 bool mFirstStaticSink; //!< bool for dynamic range handling
58 bool mFirstStaticSource; //!< bool for dynamic range handling
59 bool mFirstStaticGateway; //!< bool for dynamic range handling
60 bool mFirstStaticSinkClass; //!< bool for dynamic range handling
61 bool mFirstStaticSourceClass; //!< bool for dynamic range handling
62 bool mFirstStaticCrossfader; //!< bool for dynamic range handling
63 ListConnectionFormat mListConnectionFormat; //!< list of connection formats
66 CAmDatabaseHandlerInterface(): mpDatabaseObserver(NULL), //
67 mFirstStaticSink(true), //
68 mFirstStaticSource(true), //
69 mFirstStaticGateway(true), //
70 mFirstStaticSinkClass(true), //
71 mFirstStaticSourceClass(true), //
72 mFirstStaticCrossfader(true), //
73 mListConnectionFormat()
75 virtual ~CAmDatabaseHandlerInterface() {};
77 virtual am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID) = 0;
78 virtual am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID) = 0;
79 virtual am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID) = 0;
80 virtual am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) = 0;
81 virtual am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) = 0;
82 virtual am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID) = 0;
83 virtual am_Error_e enterConnectionDB(const am_Connection_s& connection, am_connectionID_t& connectionID) = 0;
84 virtual am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID) = 0;
85 virtual am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass) = 0;
86 virtual am_Error_e enterSystemProperties(const std::vector<am_SystemProperty_s>& listSystemProperties) = 0;
87 virtual am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID) = 0;
88 virtual am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) = 0;
89 virtual am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) = 0;
90 virtual am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) = 0;
91 virtual am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) = 0;
92 virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) = 0;
93 virtual am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) = 0;
94 virtual am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) = 0;
95 virtual am_Error_e changeSourceSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sourceID_t sourceID) = 0;
96 virtual am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sinkID_t sinkID) = 0;
97 virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) = 0;
98 virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) = 0;
99 virtual am_Error_e changeDelayMainConnection(const am_timeSync_t & delay, const am_mainConnectionID_t & connectionID) = 0;
100 virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) = 0;
101 virtual am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass) = 0;
102 virtual am_Error_e changeConnectionTimingInformation(const am_connectionID_t connectionID, const am_timeSync_t delay) = 0;
103 virtual am_Error_e changeConnectionFinal(const am_connectionID_t connectionID) = 0;
104 virtual am_Error_e changeSourceState(const am_sourceID_t sourceID, const am_SourceState_e sourceState) = 0;
105 virtual am_Error_e changeSinkVolume(const am_sinkID_t sinkID, const am_volume_t volume) = 0;
106 virtual am_Error_e changeSourceVolume(const am_sourceID_t sourceID, const am_volume_t volume) = 0;
107 virtual am_Error_e changeCrossFaderHotSink(const am_crossfaderID_t crossfaderID, const am_HotSink_e hotsink) = 0;
108 virtual am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) = 0;
109 virtual am_Error_e removeSinkDB(const am_sinkID_t sinkID) = 0;
110 virtual am_Error_e removeSourceDB(const am_sourceID_t sourceID) = 0;
111 virtual am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) = 0;
112 virtual am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) = 0;
113 virtual am_Error_e removeDomainDB(const am_domainID_t domainID) = 0;
114 virtual am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) = 0;
115 virtual am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) = 0;
116 virtual am_Error_e removeConnection(const am_connectionID_t connectionID) = 0;
117 virtual am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const = 0;
118 virtual am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const = 0;
119 virtual am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const = 0;
120 virtual am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const = 0;
121 virtual am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const = 0;
122 virtual am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const = 0;
123 virtual am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const = 0;
124 virtual am_Error_e getSinkVolume(const am_sinkID_t sinkID, am_volume_t& volume) const = 0;
125 virtual am_Error_e getSourceVolume(const am_sourceID_t sourceID, am_volume_t& volume) const = 0;
126 virtual am_Error_e getSinkSoundPropertyValue(const am_sinkID_t sinkID, const am_SoundPropertyType_e propertyType, int16_t& value) const = 0;
127 virtual am_Error_e getSourceSoundPropertyValue(const am_sourceID_t sourceID, const am_SoundPropertyType_e propertyType, int16_t& value) const = 0;
128 virtual am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const = 0;
129 virtual am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const = 0;
130 virtual am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listGatewaysID) const = 0;
131 virtual am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const = 0;
132 virtual am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const = 0;
133 virtual am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const = 0;
134 virtual am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const = 0;
135 virtual am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const = 0;
136 virtual am_Error_e getListSources(std::vector<am_Source_s>& lisSources) const = 0;
137 virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const = 0;
138 virtual am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const = 0;
139 virtual am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const = 0;
140 virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const = 0;
141 virtual am_Error_e getListVisibleMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const = 0;
142 virtual am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const = 0;
143 virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const = 0;
144 virtual am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const = 0;
145 virtual am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const = 0;
146 virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const = 0;
147 virtual am_Error_e getListSinkConnectionFormats(const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const = 0;
148 virtual am_Error_e getListSourceConnectionFormats(const am_sourceID_t sourceID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const = 0;
149 virtual am_Error_e getListGatewayConnectionFormats(const am_gatewayID_t gatewayID, std::vector<bool> & listConnectionFormat) const = 0;
150 virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const = 0;
151 virtual am_Error_e getDomainOfSource(const am_sourceID_t sourceID, am_domainID_t& domainID) const = 0;
152 virtual am_Error_e getDomainOfSink(const am_sinkID_t sinkID, am_domainID_t& domainID) const = 0;
153 virtual am_Error_e getSoureState(const am_sourceID_t sourceID, am_SourceState_e& sourceState) const = 0;
154 virtual am_Error_e getDomainState(const am_domainID_t domainID, am_DomainState_e& state) const = 0;
155 virtual am_Error_e getRoutingTree(bool onlyfree, CAmRoutingTree& tree, std::vector<CAmRoutingTreeItem*>& flatTree) = 0;
156 virtual am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID) = 0;
157 virtual am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID) = 0;
158 virtual am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID) = 0;
159 virtual am_Error_e peekSinkClassID(const std::string& name, am_sinkClass_t& sinkClassID) = 0;
160 virtual am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID) = 0;
161 virtual 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) = 0;
162 virtual 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) = 0;
163 virtual am_Error_e getListMainSinkNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) = 0;
164 virtual am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) = 0;
165 virtual am_Error_e changeMainSinkNotificationConfigurationDB(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) = 0;
166 virtual am_Error_e changeMainSourceNotificationConfigurationDB(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) = 0;
167 virtual 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) = 0;
168 virtual am_Error_e changeSinkNotificationConfigurationDB(const am_sinkID_t sinkID,const am_NotificationConfiguration_s notificationConfiguration) = 0;
169 virtual am_Error_e changeSourceNotificationConfigurationDB(const am_sourceID_t sourceID,const am_NotificationConfiguration_s notificationConfiguration) = 0;
171 virtual bool existMainConnection(const am_mainConnectionID_t mainConnectionID) const = 0;
172 virtual bool existcrossFader(const am_crossfaderID_t crossfaderID) const = 0;
173 virtual bool existConnection(const am_Connection_s & connection) const = 0;
174 virtual bool existConnectionID(const am_connectionID_t connectionID) const = 0;
175 virtual bool existSource(const am_sourceID_t sourceID) const = 0;
176 virtual bool existSourceNameOrID(const am_sourceID_t sourceID, const std::string& name) const = 0;
177 virtual bool existSourceName(const std::string& name) const = 0;
178 virtual bool existSink(const am_sinkID_t sinkID) const = 0;
179 virtual bool existSinkNameOrID(const am_sinkID_t sinkID, const std::string& name) const = 0;
180 virtual bool existSinkName(const std::string& name) const = 0;
181 virtual bool existDomain(const am_domainID_t domainID) const = 0;
182 virtual bool existGateway(const am_gatewayID_t gatewayID) const = 0;
183 virtual bool existSinkClass(const am_sinkClass_t sinkClassID) const = 0;
184 virtual bool existSourceClass(const am_sourceClass_t sourceClassID) const = 0;
185 virtual void registerObserver(CAmDatabaseObserver *iObserver) = 0;
186 virtual bool sourceVisible(const am_sourceID_t sourceID) const = 0;
187 virtual bool sinkVisible(const am_sinkID_t sinkID) const = 0;
192 #endif /* DATABASEHANDLERINTERFACE_H_ */