Merge lp:~thomas-voss/media-hub/introduce-battery-observer-interface into lp:media-hub

[Thomas Voß]

Introduce an interface media::power::BatteryObserver to monitor the current battery level of the system.
The core reacts to low/very low battery levels by pausing all multimedia playback sessions and
resumes them whenever the user has been notified of the critical battery level.
Provide an implementation of media::power::BatteryObserver using com.canonical.indicator.power.Battery.
Adjust media::ServiceImplementation to use media::power::BatteryObserver.

Introduce an interface media::power::BatteryObserver to monitor the current battery level of the system.
The core reacts to low/very low battery levels by pausing all multimedia playback sessions and
resumes them whenever the user has been notified of the critical battery level.
Provide an implementation of media::power::BatteryObserver using com.canonical.indicator.power.Battery.
Adjust media::ServiceImplementation to use media::power::BatteryObserver.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:106
http://jenkins.qa.ubuntu.com/job/media-hub-ci/182/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/22/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/182/rebuild

review: Needs Fixing (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

107. By Thomas Voß on 2014-11-26

Remerge prereq branch.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:107
http://jenkins.qa.ubuntu.com/job/media-hub-ci/187/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/27/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/187/rebuild

review: Needs Fixing (continuous-integration)

[Jim Hodapp (jhodapp)]

This looks great, I really like this particular class abstraction.

review: Approve (code)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

108. By Thomas Voß on 2014-12-11

[ Jim Hodapp ]
* Resubmitting with prerequisite branch (LP: #1331041)
[ Justin McPherson ]
* Resubmitting with prerequisite branch (LP: #1331041)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:108
http://jenkins.qa.ubuntu.com/job/media-hub-ci/206/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/46/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/206/rebuild

review: Needs Fixing (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

109. By Thomas Voß on 2014-12-15

Merge prerequisite branch.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:109
http://jenkins.qa.ubuntu.com/job/media-hub-ci/211/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/51
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/51
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/51/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/51

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/211/rebuild

review: Approve (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

110. By Thomas Voß on 2015-01-26

[ Jim Hodapp ]
* Error reporting all the way up to the app level from the playbin
  pipeline.
[ Ubuntu daily release ]
* New rebuild forced
[ Jim Hodapp ]
* Don't auto-resume playback of videos after a phone call ends. (LP:
  #1411273)
[ Ubuntu daily release ]
* New rebuild forced
[ Ricardo Salveti de Araujo ]
* service_implementation: adding debug for call started/ended signals.
  Make sure account and connection are available when setting up
  account manager (patch from Gustavo Boiko). call_monitor: don't
  check caps when hooking up on/off signals, until bug 1409125 is
  fixed. Enable parallel building . (LP: #1409125)
[ Jim Hodapp ]
* Pause playback when recording begins. (LP: #1398047)
[ Ricardo Salveti de Araujo ]
* call_monitor.cpp: waiting for bridge to be up, and also protecting
  the on_change call (LP: #1408137)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:110
http://jenkins.qa.ubuntu.com/job/media-hub-ci/225/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/65/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/65/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/65/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/225/rebuild

review: Needs Fixing (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

111. By Thomas Voß on 2015-01-26

Merge prereq branch.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:111
http://jenkins.qa.ubuntu.com/job/media-hub-ci/234/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/74
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/74
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/74/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/74

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/234/rebuild

review: Approve (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

112. By Thomas Voß on 2015-01-29

Merge prereq branch.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:112
http://jenkins.qa.ubuntu.com/job/media-hub-ci/255/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/95/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/95
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/95/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/95

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/255/rebuild

review: Needs Fixing (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

113. By Thomas Voß on 2015-02-24

Merge prereq branch.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:113
http://jenkins.qa.ubuntu.com/job/media-hub-ci/277/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/117
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/117
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/117/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/117

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/277/rebuild

review: Approve (continuous-integration)

[lp:~thomas-voss/media-hub/introduce-battery-observer-interface]

114. By Thomas Voß on 2015-03-12

* debian/control:
  - Removing pre-depends that are not required
  - Bumping standards-version to 3.9.6
[ Ricardo Salveti de Araujo ]
* Migrating tests to use ogg instead of mp3/avi removed:
  tests/h264.avi tests/test.mp3 added: tests/test-audio-1.ogg
  tests/test-video.ogg tests/test.mp3 renamed: tests/test.ogg =>
  tests/test-audio.ogg

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:114
http://jenkins.qa.ubuntu.com/job/media-hub-ci/310/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/150
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/150
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/150/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/150

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/media-hub-ci/310/rebuild

review: Approve (continuous-integration)

=== modified file 'src/core/media/CMakeLists.txt'
--- src/core/media/CMakeLists.txt	2015-03-12 11:43:33 +0000
+++ src/core/media/CMakeLists.txt	2015-03-12 11:43:33 +0000
@@ -91,6 +91,7 @@
     cover_art_resolver.cpp
     engine.cpp
 
+    power/battery_observer.cpp
     power/state_controller.cpp
 
     recorder_observer.cpp

=== removed file 'src/core/media/indicator_power_service.h'
--- src/core/media/indicator_power_service.h	2014-09-05 18:59:48 +0000
+++ src/core/media/indicator_power_service.h	1970-01-01 00:00:00 +0000
@@ -1,74 +0,0 @@
-/*
- * Copyright (C) 2014 Canonical Ltd
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3 as
- * published by the Free Software Foundation.
- *
- * 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 for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- *      Author: Jim Hodapp <[e-mail]>
- */
-
-#include <core/dbus/dbus.h>
-#include <core/dbus/fixture.h>
-#include <core/dbus/object.h>
-#include <core/dbus/property.h>
-#include <core/dbus/service.h>
-#include <core/dbus/interfaces/properties.h>
-#include <core/dbus/types/stl/tuple.h>
-#include <core/dbus/types/stl/vector.h>
-
-#include <core/dbus/asio/executor.h>
-
-#include <string>
-
-namespace core
-{
-
-struct IndicatorPower
-{
-    static std::string& name()
-    {
-        static std::string s = "com.canonical.indicator.power.Battery";
-        return s;
-    }
-
-    struct PowerLevel
-    {
-        static std::string name()
-        {
-            static std::string s = "PowerLevel";
-            return s;
-        }
-
-        typedef IndicatorPower Interface;
-        // Possible values: "ok", "low", "very_low", "critical"
-        typedef std::string ValueType;
-        static const bool readable = true;
-        static const bool writable = false;
-    };
-
-    struct IsWarning
-    {
-        static std::string name()
-        {
-            static std::string s = "IsWarning";
-            return s;
-        }
-
-        typedef IndicatorPower Interface;
-        typedef bool ValueType;
-        static const bool readable = true;
-        static const bool writable = false;
-    };
-
-}; // IndicatorPower
-
-}

=== added file 'src/core/media/power/battery_observer.cpp'
--- src/core/media/power/battery_observer.cpp	1970-01-01 00:00:00 +0000
+++ src/core/media/power/battery_observer.cpp	2015-03-12 11:43:33 +0000
@@ -0,0 +1,127 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Thomas Voß <[e-mail]>
+ */
+
+#include <core/media/power/battery_observer.h>
+
+#include <core/dbus/macros.h>
+#include <core/dbus/object.h>
+#include <core/dbus/property.h>
+
+namespace media = core::ubuntu::media;
+
+namespace com { namespace canonical { namespace indicator { namespace power {
+struct Battery
+{
+    static std::string& name()
+    {
+        static std::string s = "com.canonical.indicator.power.Battery";
+        return s;
+    }
+
+    static const core::dbus::types::ObjectPath& path()
+    {
+        static core::dbus::types::ObjectPath p{"/com/canonical/indicator/power/Battery"};
+        return p;
+    }
+
+    // Possible values: "ok", "low", "very_low", "critical"
+    DBUS_CPP_READABLE_PROPERTY_DEF(PowerLevel, Battery, std::string)
+    DBUS_CPP_READABLE_PROPERTY_DEF(IsWarning, Battery, bool)
+}; // IndicatorPower
+}}}}
+
+namespace
+{
+namespace impl
+{
+struct BatteryObserver : public media::power::BatteryObserver
+{
+    static core::ubuntu::media::power::Level power_level_from_string(const std::string& s)
+    {
+        static const std::map<std::string, core::ubuntu::media::power::Level> lut =
+        {
+            {"ok", core::ubuntu::media::power::Level::ok},
+            {"low", core::ubuntu::media::power::Level::low},
+            {"very_low", core::ubuntu::media::power::Level::very_low},
+            {"critical", core::ubuntu::media::power::Level::critical}
+        };
+
+        if (lut.count(s) == 0)
+            return core::ubuntu::media::power::Level::unknown;
+
+        return lut.at(s);
+    }
+
+    BatteryObserver(const core::dbus::Object::Ptr& object)
+        : object{object},
+          properties
+          {
+              core::Property<core::ubuntu::media::power::Level>{core::ubuntu::media::power::Level::unknown},
+              object->get_property<com::canonical::indicator::power::Battery::PowerLevel>(),
+              object->get_property<com::canonical::indicator::power::Battery::IsWarning>(),
+          },
+          connections
+          {
+              properties.power_level->changed().connect([this](const std::string& value)
+              {
+                  properties.typed_power_level = BatteryObserver::power_level_from_string(value);
+              })
+          }
+    {
+    }
+
+    const core::Property<core::ubuntu::media::power::Level>& level() const override
+    {
+        return properties.typed_power_level;
+    }
+
+    const core::Property<bool>& is_warning_active() const override
+    {
+        return *properties.is_warning;
+    }
+
+    // The object representing the remote indicator instance.
+    core::dbus::Object::Ptr object;
+    // All properties go here.
+    struct
+    {
+        // We have to translate from the raw strings coming in via the bus to
+        // the strongly typed enumeration exposed via the interface.
+        core::Property<core::ubuntu::media::power::Level> typed_power_level;
+        std::shared_ptr<core::dbus::Property<com::canonical::indicator::power::Battery::PowerLevel>> power_level;
+
+        std::shared_ptr<core::dbus::Property<com::canonical::indicator::power::Battery::IsWarning>> is_warning;
+    } properties;
+    // Our event connections
+    struct
+    {
+        core::ScopedConnection power_level;
+    } connections;
+
+};
+}
+}
+
+media::power::BatteryObserver::Ptr media::power::make_platform_default_battery_observer(media::helper::ExternalServices& es)
+{
+    auto service = core::dbus::Service::use_service<com::canonical::indicator::power::Battery>(es.session);
+    auto object = service->object_for_path(com::canonical::indicator::power::Battery::path());
+
+    return std::make_shared<impl::BatteryObserver>(object);
+}
+

=== added file 'src/core/media/power/battery_observer.h'
--- src/core/media/power/battery_observer.h	1970-01-01 00:00:00 +0000
+++ src/core/media/power/battery_observer.h	2015-03-12 11:43:33 +0000
@@ -0,0 +1,69 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Thomas Voß <[e-mail]>
+ */
+#ifndef CORE_UBUNTU_MEDIA_POWER_STATE_OBSERVER_H_
+#define CORE_UBUNTU_MEDIA_POWER_STATE_OBSERVER_H_
+
+#include <core/media/external_services.h>
+
+#include <core/property.h>
+
+#include <memory>
+
+namespace core
+{
+namespace ubuntu
+{
+namespace media
+{
+namespace power
+{
+// Enumerates known power levels.
+enum class Level
+{
+    unknown,
+    ok,
+    low,
+    very_low,
+    critical
+};
+
+// Interface that enables observation of the system power state.
+struct BatteryObserver
+{
+    // To safe us some typing.
+    typedef std::shared_ptr<BatteryObserver> Ptr;
+
+    BatteryObserver() = default;
+    virtual ~BatteryObserver() = default;
+
+    // A getable/observable property reporting the current power-level
+    // of the system.
+    virtual const core::Property<Level>& level() const = 0;
+    // A getable/observable property indicating whether a power-level
+    // warning is currently presented to the user.
+    virtual const core::Property<bool>& is_warning_active() const = 0;
+};
+
+// Creates a BatteryObserver instance that connects to the platform default
+// services to observe battery levels.
+core::ubuntu::media::power::BatteryObserver::Ptr make_platform_default_battery_observer(core::ubuntu::media::helper::ExternalServices&);
+}
+}
+}
+}
+#endif // CORE_UBUNTU_MEDIA_POWER_STATE_OBSERVER_H_

=== modified file 'src/core/media/service_implementation.cpp'
--- src/core/media/service_implementation.cpp	2015-03-12 11:43:33 +0000
+++ src/core/media/service_implementation.cpp	2015-03-12 11:43:33 +0000
@@ -23,10 +23,11 @@
 #include "service_implementation.h"
 
 #include "client_death_observer.h"
-#include "indicator_power_service.h"
 #include "call-monitor/call_monitor.h"
 #include "player_configuration.h"
 #include "player_implementation.h"
+#include "power/battery_observer.h"
+#include "power/state_controller.h"
 #include "recorder_observer.h"
 
 #include <boost/asio.hpp>
@@ -51,6 +52,7 @@
     Private(const ServiceImplementation::Configuration& configuration)
         : configuration(configuration),
           resume_key(std::numeric_limits<std::uint32_t>::max()),
+          battery_observer(media::power::make_platform_default_battery_observer(configuration.external_services)),
           power_state_controller(media::power::make_platform_default_state_controller(configuration.external_services)),
           display_state_lock(power_state_controller->display_state_lock()),
           client_death_observer(media::platform_default_client_death_observer()),
@@ -122,14 +124,7 @@
                     return false;
                 });
         }));
-
-        // Connect the property change signal that will allow media-hub to take appropriate action
-        // when the battery level reaches critical
-        auto stub_service = dbus::Service::use_service(configuration.external_services.session, "com.canonical.indicator.power");
-        indicator_power_session = stub_service->object_for_path(dbus::types::ObjectPath("/com/canonical/indicator/power/Battery"));
-        power_level = indicator_power_session->get_property<core::IndicatorPower::PowerLevel>();
-        is_warning = indicator_power_session->get_property<core::IndicatorPower::IsWarning>();
-
+        
         recorder_observer->recording_state().changed().connect([this](media::RecordingState state)
         {
             media_recording_state_changed(state);
@@ -411,9 +406,7 @@
     // This holds the key of the multimedia role Player instance that was paused
     // when the battery level reached 10% or 5%
     media::Player::PlayerKey resume_key;    
-    std::shared_ptr<dbus::Object> indicator_power_session;
-    std::shared_ptr<core::dbus::Property<core::IndicatorPower::PowerLevel>> power_level;
-    std::shared_ptr<core::dbus::Property<core::IndicatorPower::IsWarning>> is_warning;
+    media::power::BatteryObserver::Ptr battery_observer;
     media::power::StateController::Ptr power_state_controller;
     media::power::StateController::Lock<media::power::DisplayState>::Ptr display_state_lock;
     media::ClientDeathObserver::Ptr client_death_observer;
@@ -440,19 +433,26 @@
 
 media::ServiceImplementation::ServiceImplementation(const Configuration& configuration) : d(new Private(configuration))
 {
-    d->power_level->changed().connect([this](const core::IndicatorPower::PowerLevel::ValueType &level)
+    d->battery_observer->level().changed().connect([this](const media::power::Level& level)
     {
         // When the battery level hits 10% or 5%, pause all multimedia sessions.
         // Playback will resume when the user clears the presented notification.
-        if (level == "low" || level == "very_low")
+        switch (level)
+        {
+        case media::power::Level::low:
+        case media::power::Level::very_low:
             pause_all_multimedia_sessions();
+            break;
+        default:
+            break;
+        }
     });
 
-    d->is_warning->changed().connect([this](const core::IndicatorPower::IsWarning::ValueType &notifying)
+    d->battery_observer->is_warning_active().changed().connect([this](bool active)
     {
         // If the low battery level notification is no longer being displayed,
         // resume what the user was previously playing
-        if (!notifying)
+        if (!active)
             resume_multimedia_session();
     });