AudioManagerDaemon/include/DatabaseHandler.h

   1 /**
   2 * Copyright (C) 2011, BMW AG
   3 *
   4 * GeniviAudioMananger AudioManagerDaemon
   5 *
   6 * \file Databasehandler.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 DATABASEHANDLER_H_
  26 #define DATABASEHANDLER_H_
  27
  28 #include "audiomanagertypes.h"
  29 #include <sqlite3.h>
  30 #include <map>
  31
  32 namespace am {
  33
  34 class DatabaseObserver;
  35 class RoutingTree;
  36 class RoutingTreeItem;
  37
  38 #define DYNAMIC_ID_BOUNDARY 100 //!< the value below is reserved for staticIDs, the value above will be assigned to dynamically registered items
  39
  40 //todo: we do not have to create MainSoundProperty tables if visible = false.
  41 //todo: check the enum values before entering & changing in the database.
  42 //todo: change asserts for dynamic boundary checks into failure answers.#
  43 //todo: check autoincrement boundary and set to 16bit limits
  44 //todo: If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation. Check this statement for sinks & sources
  45 //todo: exchange last_insert_row id to be more safe
  46 //todo: create test to ensure uniqueness of names throughout the database
  47 //todo: enforce the uniqueness of names
  48 //todo: set isUsed flag for gateways!
  49
  50 /**
  51  * This class handles and abstracts the database
  52  */
  53 class DatabaseHandler {
  54 public:
  55         DatabaseHandler(std::string databasePath);
  56         virtual ~DatabaseHandler();
  57         am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID) ;
  58         am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID) ;
  59         am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID) ;
  60         am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) ;
  61         am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) ;
  62         am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID) ;
  63         am_Error_e enterConnectionDB(const am_Connection_s& connection, am_connectionID_t& connectionID);
  64         am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID) ;
  65         am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass) ;
  66         am_Error_e enterSystemProperties(const std::vector<am_SystemProperty_s>& listSystemProperties) ;
  67         am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const am_Route_s& route) ;
  68         am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) ;
  69         am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) ;
  70         am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) ;
  71         am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) ;
  72         am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) ;
  73         am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) ;
  74         am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) ;
  75         am_Error_e changeSourceSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sourceID_t sourceID) ;
  76         am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sinkID_t sinkID) ;
  77         am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) ;
  78         am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) ;
  79         am_Error_e changeDelayMainConnection(const am_timeSync_t & delay, const am_mainConnectionID_t & connectionID) ;
  80         am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) ;
  81         am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass) ;
  82         am_Error_e changeConnectionTimingInformation(const am_connectionID_t connectionID, const am_timeSync_t delay) ;
  83         am_Error_e changeConnectionFinal(const am_connectionID_t connectionID) ;
  84         am_Error_e changeSourceState(const am_sourceID_t sourceID, const am_SourceState_e sourceState);
  85         am_Error_e changeSinkVolume(const am_sinkID_t sinkID, const am_volume_t volume);
  86         am_Error_e changeSourceVolume(const am_sourceID_t sourceID, const am_volume_t volume);
  87         am_Error_e changeCrossFaderHotSink(const am_crossfaderID_t crossfaderID,const am_HotSink_e hotsink);
  88         am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) ;
  89         am_Error_e removeSinkDB(const am_sinkID_t sinkID) ;
  90         am_Error_e removeSourceDB(const am_sourceID_t sourceID) ;
  91         am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) ;
  92         am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) ;
  93         am_Error_e removeDomainDB(const am_domainID_t domainID) ;
  94         am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) ;
  95         am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) ;
  96         am_Error_e removeConnection(const am_connectionID_t connectionID) ;
  97         am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const ;
  98         am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const ;
  99         am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const ;
 100         am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const ;
 101         am_Error_e getSinkVolume(const am_sinkID_t sinkID, am_volume_t& volume) const;
 102         am_Error_e getSourceVolume(const am_sourceID_t sourceID, am_volume_t& volume) const;
 103         am_Error_e getSinkSoundPropertyValue(const am_sinkID_t sinkID, const am_SoundPropertyType_e propertyType, uint16_t& value) const ;
 104         am_Error_e getSourceSoundPropertyValue(const am_sourceID_t sourceID, const am_SoundPropertyType_e propertyType, uint16_t& value) const ;
 105         am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const ;
 106         am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const ;
 107         am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listGatewaysID) const ;
 108         am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const ;
 109         am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const ;
 110         am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const ;
 111         am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const ;
 112         am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const ;
 113         am_Error_e getListSources(std::vector<am_Source_s>& lisSources) const ;
 114         am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const ;
 115         am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const ;
 116         am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const ;
 117         am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const ;
 118         am_Error_e getListVisibleMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const ;
 119         am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const ;
 120         am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const ;
 121         am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const ;
 122         am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const ;
 123         am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const ;
 124         am_Error_e getListSinkConnectionFormats(const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const ;
 125         am_Error_e getListSourceConnectionFormats(const am_sourceID_t sourceID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const ;
 126         am_Error_e getListGatewayConnectionFormats(const am_gatewayID_t gatewayID, std::vector<bool> & listConnectionFormat) const;
 127         am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const ;
 128         am_Error_e getDomainOfSource(const am_sourceID_t sourceID, am_domainID_t& domainID) const;
 129         am_Error_e getDomainOfSink(const am_sinkID_t sinkID, am_domainID_t& domainID) const;
 130         am_Error_e getSoureState(const am_sourceID_t sourceID, am_SourceState_e& sourceState) const;
 131         am_Error_e getDomainState(const am_domainID_t domainID, am_DomainState_e state) const;
 132         am_Error_e getRoutingTree(bool onlyfree, RoutingTree* tree, std::vector<RoutingTreeItem*>* flatTree);
 133         am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID);
 134         am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID);
 135         am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID);
 136         /**
 137          * checks for a certain mainConnection
 138          * @param mainConnectionID to be checked for
 139          * @return true if it exists
 140          */
 141         bool existMainConnection(const am_mainConnectionID_t mainConnectionID) const;
 142
 143         /**
 144          * checks if a CrossFader exists
 145          * @param crossfaderID the ID of the crossfader to be checked
 146          * @return true if exists
 147          */
 148         bool existcrossFader(const am_crossfaderID_t crossfaderID) const;
 149
 150         /**
 151          * checks if a connection already exists.
 152          * Only takes sink, source and format information for search!
 153          * @param connection the connection to be checked
 154          * @return true if connections exists
 155          */
 156         bool existConnection(const am_Connection_s connection);
 157
 158         /**
 159          * checks if a connection with the given ID exists
 160          * @param connectionID
 161          * @return true if connection exits
 162          */
 163         bool existConnectionID(const am_connectionID_t connectionID);
 164         /**
 165          * checks for a certain Source
 166          * @param sourceID to be checked for
 167          * @return true if it exists
 168          */
 169         bool existSource(const am_sourceID_t sourceID) const;
 170
 171         /**
 172          * checks if a source name or ID exists
 173          * @param sourceID the sourceID
 174          * @param name the name
 175          * @return true if it exits
 176          */
 177         bool existSourceNameOrID(const am_sourceID_t sourceID, const std::string& name) const;
 178
 179         /**
 180          * checks if a name exits
 181          * @param name the name
 182          * @return true if it exits
 183          */
 184         bool existSourceName(const std::string& name) const;
 185         /**
 186          * checks for a certain Sink
 187          * @param sinkID to be checked for
 188          * @return true if it exists
 189          */
 190         bool existSink(const am_sinkID_t sinkID) const;
 191
 192         /**
 193          * checks if a sink with the ID or the name exists
 194          * @param sinkID the ID
 195          * @param name the name
 196          * @return true if it exists.
 197          */
 198         bool existSinkNameOrID(const am_sinkID_t sinkID, const std::string& name) const;
 199
 200         /**
 201          * checks if a sink with the name exists
 202          * @param name the name
 203          * @return true if it exists
 204          */
 205         bool existSinkName(const std::string& name) const;
 206
 207         /**
 208          * checks for a certain domain
 209          * @param domainID to be checked for
 210          * @return true if it exists
 211          */
 212         bool existDomain(const am_domainID_t domainID) const;
 213
 214         /**
 215          * checks for certain gateway
 216          * @param gatewayID to be checked for
 217          * @return true if it exists
 218          */
 219         bool existGateway(const am_gatewayID_t gatewayID) const;
 220
 221         /**
 222          * checks for certain SinkClass
 223          * @param sinkClassID
 224          * @return true if it exists
 225          */
 226         bool existSinkClass(const am_sinkClass_t sinkClassID) const;
 227
 228         /**
 229          * checks for certain sourceClass
 230          * @param sourceClassID
 231          * @return true if it exists
 232          */
 233         bool existSourceClass(const am_sourceClass_t sourceClassID) const;
 234
 235         /**
 236          * registers the Observer at the Database
 237          * @param iObserver pointer to the observer
 238          */
 239         void registerObserver(DatabaseObserver *iObserver);
 240
 241         /**
 242          * gives information about the visibility of a source
 243          * @param sourceID the sourceID
 244          * @return true if source is visible
 245          */
 246         bool sourceVisible(const am_sourceID_t sourceID) const;
 247
 248         /**
 249          * gives information about the visibility of a sink
 250          * @param sinkID the sinkID
 251          * @return true if source is visible
 252          */
 253         bool sinkVisible(const am_sinkID_t sinkID) const;
 254
 255 private:
 256         am_timeSync_t calculateMainConnectionDelay(const am_mainConnectionID_t mainConnectionID) const;
 257         bool sqQuery(const std::string& query);
 258         bool openDatabase(); //!< opens the database
 259         void createTables(); //!< creates all tables from the static table
 260         sqlite3 *mDatabase; //!< pointer to the database
 261         std::string mPath;  //!< path to the database
 262         DatabaseObserver *mDatabaseObserver; //!< pointer to the Observer
 263         bool mFirstStaticSink;
 264         bool mFirstStaticSource;
 265         bool mFirstStaticGateway;
 266         bool mFirstStaticSinkClass;
 267         bool mFirstStaticSourceClass;
 268         typedef std::map<am_gatewayID_t,std::vector<bool> > ListConnectionFormat; //!< type for list of connection formats
 269         ListConnectionFormat mListConnectionFormat; //!< list of connection formats
 270 };
 271
 272 }
 273
 274 #endif /* DATABASEHANDLER_H_ */