From c1e284360ec02b06ccb0a97a00fed05ef0bb2c60 Mon Sep 17 00:00:00 2001 From: Martin Koch Date: Fri, 17 Jan 2020 09:07:47 +0100 Subject: AM: add plural form of setSystemProperties for global configuration attributes to command and control interface - implement plural form of requests and acknowledgments in core - provide empty default implementations in interfaces to ensure backward compatibility with older plugins - accommodate extension in module tests Main purpose of this extension is to allow for one-shot (uninterrupted), consistent change of multiple, possibly interrelated configuration attributes. Signed-off-by: Martin Koch --- AudioManagerCore/include/CAmCommandReceiver.h | 1 + AudioManagerCore/include/CAmCommandSender.h | 1 + AudioManagerCore/include/CAmControlReceiver.h | 1 + AudioManagerCore/include/CAmControlSender.h | 1 + AudioManagerCore/include/CAmDatabaseHandlerMap.h | 2 ++ AudioManagerCore/include/IAmDatabaseHandler.h | 1 + AudioManagerCore/src/CAmCommandReceiver.cpp | 5 +++++ AudioManagerCore/src/CAmCommandSender.cpp | 8 +++++++ AudioManagerCore/src/CAmControlReceiver.cpp | 5 +++++ AudioManagerCore/src/CAmControlSender.cpp | 6 +++++ AudioManagerCore/src/CAmDatabaseHandlerMap.cpp | 26 ++++++++++++++++++++++ .../AmMapHandlerTest/CAmTestDatabaseObserver.cpp | 2 ++ .../test/AmMapHandlerTest/MockDatabaseObserver.h | 2 ++ AudioManagerCore/test/MockIAmCommandSend.h | 2 ++ AudioManagerCore/test/MockIAmControlSend.h | 2 ++ include/IAmCommand.h | 11 ++++++++- include/IAmControl.h | 11 +++++++++ 17 files changed, 86 insertions(+), 1 deletion(-) diff --git a/AudioManagerCore/include/CAmCommandReceiver.h b/AudioManagerCore/include/CAmCommandReceiver.h index 8c43987..17c3fd4 100644 --- a/AudioManagerCore/include/CAmCommandReceiver.h +++ b/AudioManagerCore/include/CAmCommandReceiver.h @@ -53,6 +53,7 @@ public: am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s &soundProperty, const am_sourceID_t sourceID); am_Error_e setMainSourceSoundProperties(const std::vector &listSoundProperties, const am_sourceID_t sourceID); am_Error_e setSystemProperty(const am_SystemProperty_s &property); + am_Error_e setSystemProperties(const std::vector &listSystemProperties); am_Error_e getVolume(const am_sinkID_t sinkID, am_mainVolume_t &mainVolume) const; am_Error_e getListMainConnections(std::vector &listConnections) const; am_Error_e getListMainSinks(std::vector &listMainSinks) const; diff --git a/AudioManagerCore/include/CAmCommandSender.h b/AudioManagerCore/include/CAmCommandSender.h index c438711..5e47837 100644 --- a/AudioManagerCore/include/CAmCommandSender.h +++ b/AudioManagerCore/include/CAmCommandSender.h @@ -68,6 +68,7 @@ public: void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume); void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState); void cbSystemPropertyChanged(const am_SystemProperty_s &systemProperty); + void cbSystemPropertiesChanged(const std::vector &listSystemProperties); void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time); void getInterfaceVersion(std::string &version) const; am_Error_e getListPlugins(std::vector &interfaces) const; diff --git a/AudioManagerCore/include/CAmControlReceiver.h b/AudioManagerCore/include/CAmControlReceiver.h index a710d23..0a0e1f3 100644 --- a/AudioManagerCore/include/CAmControlReceiver.h +++ b/AudioManagerCore/include/CAmControlReceiver.h @@ -81,6 +81,7 @@ public: am_Error_e changeMainSourceSoundPropertiesDB(const std::vector &listSoundProperties, const am_sourceID_t sourceID); am_Error_e changeSourceAvailabilityDB(const am_Availability_s &availability, const am_sourceID_t sourceID); am_Error_e changeSystemPropertyDB(const am_SystemProperty_s &property); + am_Error_e changeSystemPropertiesDB(const std::vector &listSystemProperties); am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID); am_Error_e removeSinkDB(const am_sinkID_t sinkID); am_Error_e removeSourceDB(const am_sourceID_t sourceID); diff --git a/AudioManagerCore/include/CAmControlSender.h b/AudioManagerCore/include/CAmControlSender.h index f6c2f0e..77e8e2c 100644 --- a/AudioManagerCore/include/CAmControlSender.h +++ b/AudioManagerCore/include/CAmControlSender.h @@ -54,6 +54,7 @@ public: am_Error_e hookUserSetMainSourceSoundProperty(const am_sourceID_t sourceID, const am_MainSoundProperty_s &soundProperty); am_Error_e hookUserSetMainSourceSoundProperties(const am_sourceID_t sourceID, const std::vector &listSoundProperties); am_Error_e hookUserSetSystemProperty(const am_SystemProperty_s &property); + am_Error_e hookUserSetSystemProperties(const std::vector &listSystemProperties); am_Error_e hookUserVolumeChange(const am_sinkID_t SinkID, const am_mainVolume_t newVolume); am_Error_e hookUserVolumeStep(const am_sinkID_t SinkID, const int16_t increment); am_Error_e hookUserSetSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState); diff --git a/AudioManagerCore/include/CAmDatabaseHandlerMap.h b/AudioManagerCore/include/CAmDatabaseHandlerMap.h index f3c39d8..46da560 100644 --- a/AudioManagerCore/include/CAmDatabaseHandlerMap.h +++ b/AudioManagerCore/include/CAmDatabaseHandlerMap.h @@ -105,6 +105,7 @@ public: std::function dboVolumeChanged; std::function dboSinkMuteStateChanged; std::functiondboSystemPropertyChanged; + std::function &)>dboSystemPropertiesChanged; std::functiondboTimingInformationChanged; std::function &, const bool)>dboSinkUpdated; std::function &, const bool)>dboSourceUpdated; @@ -146,6 +147,7 @@ public: am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s &soundProperty, const am_sinkID_t sinkID); am_Error_e changeSourceAvailabilityDB(const am_Availability_s &availability, const am_sourceID_t sourceID); am_Error_e changeSystemPropertyDB(const am_SystemProperty_s &property); + am_Error_e changeSystemPropertiesDB(const std::vector &listSystemProperties); am_Error_e changeDelayMainConnection(const am_timeSync_t &delay, const am_mainConnectionID_t &connectionID); am_Error_e changeSinkClassInfoDB(const am_SinkClass_s &sinkClass); am_Error_e changeSourceClassInfoDB(const am_SourceClass_s &sourceClass); diff --git a/AudioManagerCore/include/IAmDatabaseHandler.h b/AudioManagerCore/include/IAmDatabaseHandler.h index 2185cd4..8e4118e 100644 --- a/AudioManagerCore/include/IAmDatabaseHandler.h +++ b/AudioManagerCore/include/IAmDatabaseHandler.h @@ -86,6 +86,7 @@ public: virtual am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s &soundProperty, const am_sinkID_t sinkID) = 0; virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s &availability, const am_sourceID_t sourceID) = 0; virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s &property) = 0; + virtual am_Error_e changeSystemPropertiesDB(const std::vector &listSystemProperties) = 0; virtual am_Error_e changeDelayMainConnection(const am_timeSync_t &delay, const am_mainConnectionID_t &connectionID) = 0; virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s &sinkClass) = 0; virtual am_Error_e changeSourceClassInfoDB(const am_SourceClass_s &sourceClass) = 0; diff --git a/AudioManagerCore/src/CAmCommandReceiver.cpp b/AudioManagerCore/src/CAmCommandReceiver.cpp index 1937f32..028b6ef 100644 --- a/AudioManagerCore/src/CAmCommandReceiver.cpp +++ b/AudioManagerCore/src/CAmCommandReceiver.cpp @@ -135,6 +135,11 @@ am_Error_e CAmCommandReceiver::setSystemProperty(const am_SystemProperty_s &prop return (mControlSender->hookUserSetSystemProperty(property)); } +am_Error_e CAmCommandReceiver::setSystemProperties(const std::vector &listSystemProperties) +{ + return (mControlSender->hookUserSetSystemProperties(listSystemProperties)); +} + am_Error_e CAmCommandReceiver::getVolume(const am_sinkID_t sinkID, am_mainVolume_t &mainVolume) const { return (mDatabaseHandler->getSinkMainVolume(sinkID, mainVolume)); diff --git a/AudioManagerCore/src/CAmCommandSender.cpp b/AudioManagerCore/src/CAmCommandSender.cpp index 622e5fd..fd1be69 100644 --- a/AudioManagerCore/src/CAmCommandSender.cpp +++ b/AudioManagerCore/src/CAmCommandSender.cpp @@ -142,6 +142,9 @@ CAmCommandSender::CAmCommandSender(const std::vector &listOfPluginD dboSystemPropertyChanged = [&](const am_SystemProperty_s &SystemProperty) { mSerializer.asyncCall(this, &CAmCommandSender::cbSystemPropertyChanged, SystemProperty); }; + dboSystemPropertiesChanged = [&](const std::vector &SystemProperties) { + mSerializer.asyncCall(this, &CAmCommandSender::cbSystemPropertiesChanged, SystemProperties); + }; dboTimingInformationChanged = [&](const am_mainConnectionID_t mainConnection, const am_timeSync_t time) { mSerializer.asyncCall(this, &CAmCommandSender::cbTimingInformationChanged, mainConnection, time); }; @@ -356,6 +359,11 @@ void CAmCommandSender::cbSystemPropertyChanged(const am_SystemProperty_s &System CALL_ALL_INTERFACES(cbSystemPropertyChanged(SystemProperty)) } +void CAmCommandSender::cbSystemPropertiesChanged(const std::vector &listSystemProperties) +{ + CALL_ALL_INTERFACES(cbSystemPropertiesChanged(listSystemProperties)) +} + void CAmCommandSender::cbTimingInformationChanged(const am_mainConnectionID_t mainConnection, const am_timeSync_t time) { CALL_ALL_INTERFACES(cbTimingInformationChanged(mainConnection, time)) diff --git a/AudioManagerCore/src/CAmControlReceiver.cpp b/AudioManagerCore/src/CAmControlReceiver.cpp index 0fe9b03..c72d733 100644 --- a/AudioManagerCore/src/CAmControlReceiver.cpp +++ b/AudioManagerCore/src/CAmControlReceiver.cpp @@ -231,6 +231,11 @@ am_Error_e CAmControlReceiver::changeSystemPropertyDB(const am_SystemProperty_s return (mDatabaseHandler->changeSystemPropertyDB(property)); } +am_Error_e CAmControlReceiver::changeSystemPropertiesDB(const std::vector &listSystemProperties) +{ + return (mDatabaseHandler->changeSystemPropertiesDB(listSystemProperties)); +} + am_Error_e CAmControlReceiver::removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) { return (mDatabaseHandler->removeMainConnectionDB(mainConnectionID)); diff --git a/AudioManagerCore/src/CAmControlSender.cpp b/AudioManagerCore/src/CAmControlSender.cpp index e8f2285..a683a42 100644 --- a/AudioManagerCore/src/CAmControlSender.cpp +++ b/AudioManagerCore/src/CAmControlSender.cpp @@ -217,6 +217,12 @@ am_Error_e CAmControlSender::hookUserSetSystemProperty(const am_SystemProperty_s return (mController->hookUserSetSystemProperty(property)); } +am_Error_e CAmControlSender::hookUserSetSystemProperties(const std::vector &listSystemProperties) +{ + assert(mController); + return (mController->hookUserSetSystemProperties(listSystemProperties)); +} + am_Error_e CAmControlSender::hookUserVolumeChange(const am_sinkID_t sinkID, const am_mainVolume_t newVolume) { assert(mController); diff --git a/AudioManagerCore/src/CAmDatabaseHandlerMap.cpp b/AudioManagerCore/src/CAmDatabaseHandlerMap.cpp index eabcb18..928ce8f 100644 --- a/AudioManagerCore/src/CAmDatabaseHandlerMap.cpp +++ b/AudioManagerCore/src/CAmDatabaseHandlerMap.cpp @@ -1689,6 +1689,32 @@ am_Error_e CAmDatabaseHandlerMap::changeSystemPropertyDB(const am_SystemProperty } } +am_Error_e CAmDatabaseHandlerMap::changeSystemPropertiesDB(const std::vector &listSystemProperties) +{ + std::vector::iterator elementIterator; + + for (auto &itlistSystemProperties : listSystemProperties) + { + for (elementIterator = mMappedData.mSystemProperties.begin(); elementIterator != mMappedData.mSystemProperties.end(); + ++elementIterator) + { + if (elementIterator->type == itlistSystemProperties.type) + { + DB_COND_UPDATE_RIE(elementIterator->value, itlistSystemProperties.value); + } + else + logVerbose("DatabaseHandler::changeSystemPropertiesDB system property does not match the internal list"); + } + + } + + logVerbose("DatabaseHandler::changeSystemPropertiesDB changed system property"); + + NOTIFY_OBSERVERS1(dboSystemPropertiesChanged, listSystemProperties) + + return (E_OK); +} + am_Error_e CAmDatabaseHandlerMap::removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) { diff --git a/AudioManagerCore/test/AmMapHandlerTest/CAmTestDatabaseObserver.cpp b/AudioManagerCore/test/AmMapHandlerTest/CAmTestDatabaseObserver.cpp index 77b6ecb..f318852 100644 --- a/AudioManagerCore/test/AmMapHandlerTest/CAmTestDatabaseObserver.cpp +++ b/AudioManagerCore/test/AmMapHandlerTest/CAmTestDatabaseObserver.cpp @@ -80,6 +80,8 @@ CAmDatabaseObserver::CAmDatabaseObserver() { MockDatabaseObserver::getMockObserverObject()->sinkMuteStateChanged(sinkID, muteState); }; dboSystemPropertyChanged = [&](const am_SystemProperty_s& SystemProperty) { MockDatabaseObserver::getMockObserverObject()->systemPropertyChanged(SystemProperty); }; + dboSystemPropertiesChanged = [&](const std::vector& listSystemProperties) + { MockDatabaseObserver::getMockObserverObject()->systemPropertiesChanged(listSystemProperties); }; dboTimingInformationChanged = [&](const am_mainConnectionID_t mainConnection, const am_timeSync_t time) { MockDatabaseObserver::getMockObserverObject()->timingInformationChanged(mainConnection,time); }; dboSinkUpdated = [&](const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector& listMainSoundProperties, const bool visible) diff --git a/AudioManagerCore/test/AmMapHandlerTest/MockDatabaseObserver.h b/AudioManagerCore/test/AmMapHandlerTest/MockDatabaseObserver.h index 894db07..0c7399c 100644 --- a/AudioManagerCore/test/AmMapHandlerTest/MockDatabaseObserver.h +++ b/AudioManagerCore/test/AmMapHandlerTest/MockDatabaseObserver.h @@ -69,6 +69,7 @@ public: virtual void volumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) = 0; virtual void sinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) = 0; virtual void systemPropertyChanged(const am_SystemProperty_s& SystemProperty) = 0; + virtual void systemPropertiesChanged(const std::vector& listSystemProperties) = 0; virtual void timingInformationChanged(const am_mainConnectionID_t mainConnection, const am_timeSync_t time) = 0; virtual void sinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector& listMainSoundProperties, const bool visible) = 0; virtual void sourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector& listMainSoundProperties, const bool visible) = 0; @@ -105,6 +106,7 @@ class MockDatabaseObserver : public IAmDatabaseObserver{ MOCK_METHOD2(volumeChanged, void(const am_sinkID_t sinkID, const am_mainVolume_t volume)); MOCK_METHOD2(sinkMuteStateChanged, void(const am_sinkID_t sinkID, const am_MuteState_e muteState)); MOCK_METHOD1(systemPropertyChanged, void(const am_SystemProperty_s& SystemProperty)); + MOCK_METHOD1(systemPropertiesChanged, void(const std::vector& listSystemProperties)); MOCK_METHOD2(timingInformationChanged, void(const am_mainConnectionID_t mainConnection, const am_timeSync_t time)); MOCK_METHOD4(sinkUpdated, void(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector& listMainSoundProperties, const bool visible)); MOCK_METHOD4(sourceUpdated, void(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector& listMainSoundProperties, const bool visible)); diff --git a/AudioManagerCore/test/MockIAmCommandSend.h b/AudioManagerCore/test/MockIAmCommandSend.h index 2310c81..f7cb9bb 100644 --- a/AudioManagerCore/test/MockIAmCommandSend.h +++ b/AudioManagerCore/test/MockIAmCommandSend.h @@ -75,6 +75,8 @@ class MockIAmCommandSend : public IAmCommandSend { void(const am_sinkID_t sinkID, const am_MuteState_e muteState)); MOCK_METHOD1(cbSystemPropertyChanged, void(const am_SystemProperty_s& systemProperty)); + MOCK_METHOD1(cbSystemPropertiesChanged, + void(const std::vector& listSystemProperties)); MOCK_METHOD2(cbTimingInformationChanged, void(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time)); MOCK_METHOD3(cbSinkUpdated, diff --git a/AudioManagerCore/test/MockIAmControlSend.h b/AudioManagerCore/test/MockIAmControlSend.h index 1f0b7df..9115d00 100644 --- a/AudioManagerCore/test/MockIAmControlSend.h +++ b/AudioManagerCore/test/MockIAmControlSend.h @@ -53,6 +53,8 @@ class MockIAmControlSend : public IAmControlSend { am_Error_e(const am_sourceID_t sourceID, const std::vector &listSoundProperty)); MOCK_METHOD1(hookUserSetSystemProperty, am_Error_e(const am_SystemProperty_s& property)); + MOCK_METHOD1(hookUserSetSystemProperties, + am_Error_e(const std::vector& listSystemProperties)); MOCK_METHOD2(hookUserVolumeChange, am_Error_e(const am_sinkID_t SinkID, const am_mainVolume_t newVolume)); MOCK_METHOD2(hookUserVolumeStep, diff --git a/include/IAmCommand.h b/include/IAmCommand.h index 4f70389..72a4373 100644 --- a/include/IAmCommand.h +++ b/include/IAmCommand.h @@ -25,7 +25,6 @@ #include #include -#include "audiomanagertypes.h" namespace am { class CAmDbusWrapper; class CAmSocketHandler; @@ -133,6 +132,12 @@ public: * case of an error */ virtual am_Error_e setSystemProperty(const am_SystemProperty_s& property) =0; + /** + * is used to set a specific system properties. + * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in + * case of an error + */ + virtual am_Error_e setSystemProperties(const std::vector&/*listSystemProperties*/ ) { return E_OK; }; /** * returns the actual list of MainConnections * @return E_OK on success, E_DATABASE_ERROR on error @@ -365,6 +370,10 @@ public: * is fired if a systemProperty changed */ virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0; + /** + * is fired if a systemProperties changed + */ + virtual void cbSystemPropertiesChanged(const std::vector&/*listSystemProperties*/) { return; }; /** * This callback is fired if the timinginformation for a mainConnectionID changed */ diff --git a/include/IAmControl.h b/include/IAmControl.h index 872177f..2f2f083 100644 --- a/include/IAmControl.h +++ b/include/IAmControl.h @@ -331,6 +331,12 @@ public: * was not found */ virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) =0; + /** + * changes systemProperties + * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property + * was not found + */ + virtual am_Error_e changeSystemPropertiesDB(const std::vector&/*listSystemProperties*/){ return E_OK; }; /** * removes a mainconnection from the DB * @return E_OK on success, E_NON_EXISTENT if main connection was not found, @@ -757,6 +763,11 @@ public: * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error */ virtual am_Error_e hookUserSetSystemProperty(const am_SystemProperty_s& property) =0; + /** + * sets a user SystemProperties list + * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error + */ + virtual am_Error_e hookUserSetSystemProperties(const std::vector& /*listproperties*/){ return E_OK; } /** * sets a user volume * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error -- cgit v1.2.1