AudioManagerDaemon/include/CAmDatabaseHandler.h

   1 /**
   2  * Copyright (C) 2012, BMW AG
   3  *
   4  * This file is part of GENIVI Project AudioManager.
   5  *
   6  * Contributions are licensed to the GENIVI Alliance under one or more
   7  * Contribution License Agreements.
   8  *
   9  * \copyright
  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/.
  13  *
  14  *
  15  * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
  16  *
  17  * \file CAmDatabaseHandler.h
  18  * For further information see http://www.genivi.org/.
  19  *
  20  */
  21
  22 #ifndef DATABASEHANDLER_H_
  23 #define DATABASEHANDLER_H_
  24
  25 #include "CAmDatabaseHandlerInterface.h"
  26 #include <map>
  27 #include <sqlite3.h>
  28
  29 namespace am
  30 {
  31
  32 class CAmDatabaseObserver;
  33 class CAmRoutingTree;
  34 class CAmRoutingTreeItem;
  35
  36 //todo: check the enum values before entering & changing in the database.
  37 //todo: change asserts for dynamic boundary checks into failure answers.#
  38 //todo: check autoincrement boundary and set to 16bit limits
  39 //todo: If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation. Check this statement for sinks & sources
  40 //todo: exchange last_insert_row id to be more safe
  41 //todo: create test to ensure uniqueness of names throughout the database
  42 //todo: enforce the uniqueness of names
  43
  44 /**
  45  * This class handles and abstracts the database
  46  */
  47 class CAmDatabaseHandler : public CAmDatabaseHandlerInterface
  48 {
  49 private:
  50     am_timeSync_t calculateMainConnectionDelay(const am_mainConnectionID_t mainConnectionID) const; //!< calculates a new main connection delay
  51     bool sqQuery(const std::string& query); //!< queries the database
  52     bool openDatabase(); //!< opens the database
  53     void createTables(); //!< creates all tables from the static table
  54     sqlite3 *mpDatabase; //!< pointer to the database
  55     std::string mPath; //!< path to the database
  56
  57 public:
  58         CAmDatabaseHandler();
  59     CAmDatabaseHandler(std::string databasePath);
  60     ~CAmDatabaseHandler();
  61     am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID);
  62     am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID);
  63     am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID);
  64     am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID);
  65     am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID);
  66     am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID);
  67     am_Error_e enterConnectionDB(const am_Connection_s& connection, am_connectionID_t& connectionID);
  68     am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID);
  69     am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass);
  70     am_Error_e enterSystemProperties(const std::vector<am_SystemProperty_s>& listSystemProperties);
  71     am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID);
  72     am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState);
  73     am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID);
  74     am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID);
  75     am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID);
  76     am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID);
  77     am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID);
  78     am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID);
  79     am_Error_e changeSourceSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sourceID_t sourceID);
  80     am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sinkID_t sinkID);
  81     am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID);
  82     am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property);
  83     am_Error_e changeDelayMainConnection(const am_timeSync_t & delay, const am_mainConnectionID_t & connectionID);
  84     am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass);
  85     am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass);
  86     am_Error_e changeConnectionTimingInformation(const am_connectionID_t connectionID, const am_timeSync_t delay);
  87     am_Error_e changeConnectionFinal(const am_connectionID_t connectionID);
  88     am_Error_e changeSourceState(const am_sourceID_t sourceID, const am_SourceState_e sourceState);
  89     am_Error_e changeSinkVolume(const am_sinkID_t sinkID, const am_volume_t volume);
  90     am_Error_e changeSourceVolume(const am_sourceID_t sourceID, const am_volume_t volume);
  91     am_Error_e changeCrossFaderHotSink(const am_crossfaderID_t crossfaderID, const am_HotSink_e hotsink);
  92     am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID);
  93     am_Error_e removeSinkDB(const am_sinkID_t sinkID);
  94     am_Error_e removeSourceDB(const am_sourceID_t sourceID);
  95     am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID);
  96     am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID);
  97     am_Error_e removeDomainDB(const am_domainID_t domainID);
  98     am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID);
  99     am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID);
 100     am_Error_e removeConnection(const am_connectionID_t connectionID);
 101     am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const;
 102     am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const;
 103     am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const;
 104     am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const;
 105     am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const;
 106     am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const;
 107     am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const;
 108     am_Error_e getSinkVolume(const am_sinkID_t sinkID, am_volume_t& volume) const;
 109     am_Error_e getSourceVolume(const am_sourceID_t sourceID, am_volume_t& volume) const;
 110     am_Error_e getSinkSoundPropertyValue(const am_sinkID_t sinkID, const am_SoundPropertyType_e propertyType, int16_t& value) const;
 111     am_Error_e getSourceSoundPropertyValue(const am_sourceID_t sourceID, const am_SoundPropertyType_e propertyType, int16_t& value) const;
 112     am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const;
 113     am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const;
 114     am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listGatewaysID) const;
 115     am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const;
 116     am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const;
 117     am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const;
 118     am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const;
 119     am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const;
 120     am_Error_e getListSources(std::vector<am_Source_s>& lisSources) const;
 121     am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const;
 122     am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const;
 123     am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const;
 124     am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const;
 125     am_Error_e getListVisibleMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const;
 126     am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const;
 127     am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const;
 128     am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const;
 129     am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const;
 130     am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const;
 131     am_Error_e getListSinkConnectionFormats(const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const;
 132     am_Error_e getListSourceConnectionFormats(const am_sourceID_t sourceID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const;
 133     am_Error_e getListGatewayConnectionFormats(const am_gatewayID_t gatewayID, std::vector<bool> & listConnectionFormat) const;
 134     am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const;
 135     am_Error_e getDomainOfSource(const am_sourceID_t sourceID, am_domainID_t& domainID) const;
 136     am_Error_e getDomainOfSink(const am_sinkID_t sinkID, am_domainID_t& domainID) const;
 137     am_Error_e getSoureState(const am_sourceID_t sourceID, am_SourceState_e& sourceState) const;
 138     am_Error_e getDomainState(const am_domainID_t domainID, am_DomainState_e& state) const;
 139     am_Error_e getRoutingTree(bool onlyfree, CAmRoutingTree& tree, std::vector<CAmRoutingTreeItem*>& flatTree);
 140     am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID);
 141     am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID);
 142     am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID);
 143     am_Error_e peekSinkClassID(const std::string& name, am_sinkClass_t& sinkClassID);
 144     am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID);
 145     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);
 146     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);
 147     am_Error_e getListMainSinkNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations);
 148     am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations);
 149     am_Error_e changeMainSinkNotificationConfigurationDB(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration);
 150     am_Error_e changeMainSourceNotificationConfigurationDB(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration);
 151     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);
 152     am_Error_e changeSinkNotificationConfigurationDB(const am_sinkID_t sinkID,const am_NotificationConfiguration_s notificationConfiguration);
 153     am_Error_e changeSourceNotificationConfigurationDB(const am_sourceID_t sourceID,const am_NotificationConfiguration_s notificationConfiguration);
 154
 155     bool existMainConnection(const am_mainConnectionID_t mainConnectionID) const;
 156     bool existcrossFader(const am_crossfaderID_t crossfaderID) const;
 157     bool existConnection(const am_Connection_s & connection) const;
 158     bool existConnectionID(const am_connectionID_t connectionID) const;
 159     bool existSource(const am_sourceID_t sourceID) const;
 160     bool existSourceNameOrID(const am_sourceID_t sourceID, const std::string& name) const;
 161     bool existSourceName(const std::string& name) const;
 162     bool existSink(const am_sinkID_t sinkID) const;
 163     bool existSinkNameOrID(const am_sinkID_t sinkID, const std::string& name) const;
 164     bool existSinkName(const std::string& name) const;
 165     bool existDomain(const am_domainID_t domainID) const;
 166     bool existGateway(const am_gatewayID_t gatewayID) const;
 167     bool existSinkClass(const am_sinkClass_t sinkClassID) const;
 168     bool existSourceClass(const am_sourceClass_t sourceClassID) const;
 169     void registerObserver(CAmDatabaseObserver *iObserver);
 170     bool sourceVisible(const am_sourceID_t sourceID) const;
 171     bool sinkVisible(const am_sinkID_t sinkID) const;
 172 };
 173
 174 }
 175
 176 #endif /* DATABASEHANDLER_H_ */