Merge lp:~phablet-team/media-hub/introduce-call-monitor-interface into lp:media-hub

[Ricardo Salveti]

Move src/core/media/call-monitor to src/core/media/telephony.
Introduce a proper interface media::telephony::CallMonitor.
Slightly adjust existing implementation based on Qt.
Adjust media::ServiceImplementation to account for changes in media::telephony::CallMonitor.

Move src/core/media/call-monitor to src/core/media/telephony.
Introduce a proper interface media::telephony::CallMonitor.
Slightly adjust existing implementation based on Qt.
Adjust media::ServiceImplementation to account for changes in media::telephony::CallMonitor.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[Jim Hodapp (jhodapp)]

Looks good.

review: Approve (code)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[lp:~phablet-team/media-hub/introduce-call-monitor-interface]

118. By Ricardo Salveti on 2015-03-04

Merge prereq

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[lp:~phablet-team/media-hub/introduce-call-monitor-interface]

119. 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:119
http://jenkins.qa.ubuntu.com/job/media-hub-ci/306/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/146
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/146
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/146/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/146

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

review: Approve (continuous-integration)

=== modified file 'src/core/media/CMakeLists.txt'
--- src/core/media/CMakeLists.txt	2015-03-12 11:44:42 +0000
+++ src/core/media/CMakeLists.txt	2015-03-12 11:44:43 +0000
@@ -11,7 +11,7 @@
 
 message(STATUS ${MEDIA_HUB_HEADERS})
 
-add_subdirectory(call-monitor)
+add_subdirectory(telephony)
 
 add_library(
   media-hub-common SHARED

=== modified file 'src/core/media/service_implementation.cpp'
--- src/core/media/service_implementation.cpp	2015-03-12 11:44:42 +0000
+++ src/core/media/service_implementation.cpp	2015-03-12 11:44:43 +0000
@@ -24,12 +24,12 @@
 
 #include "audio/output_observer.h"
 #include "client_death_observer.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 "telephony/call_monitor.h"
 
 #include <boost/asio.hpp>
 
@@ -60,7 +60,7 @@
           recorder_observer(media::make_platform_default_recorder_observer()),
           audio_output_observer(media::audio::make_platform_default_output_observer()),
           audio_output_state(media::audio::OutputState::Speaker),
-          call_monitor(new CallMonitor)
+          call_monitor(media::telephony::make_platform_default_call_monitor())
     {
     }
 
@@ -76,7 +76,7 @@
     media::audio::OutputObserver::Ptr audio_output_observer;
     media::audio::OutputState audio_output_state;
 
-    std::unique_ptr<CallMonitor> call_monitor;
+    media::telephony::CallMonitor::Ptr call_monitor;
     std::list<media::Player::PlayerKey> paused_sessions;
 };
 
@@ -123,15 +123,15 @@
         d->audio_output_state = state;
     });
 
-    d->call_monitor->on_change([this](CallMonitor::State state) {
+    d->call_monitor->on_call_state_changed().connect([this](media::telephony::CallMonitor::State state)
+    {
         switch (state) {
-        case CallMonitor::OffHook:
+        case media::telephony::CallMonitor::State::OffHook:
             std::cout << "Got call started signal, pausing all multimedia sessions" << std::endl;
             pause_all_multimedia_sessions();
             break;
-        case CallMonitor::OnHook:
+        case media::telephony::CallMonitor::State::OnHook:
             std::cout << "Got call ended signal, resuming paused multimedia sessions" << std::endl;
-            // Don't auto-resume any paused video playback sessions
             resume_paused_multimedia_sessions(false);
             break;
         }

=== renamed directory 'src/core/media/call-monitor' => 'src/core/media/telephony'
=== modified file 'src/core/media/telephony/call_monitor.cpp'
--- src/core/media/call-monitor/call_monitor.cpp	2015-01-12 21:35:36 +0000
+++ src/core/media/telephony/call_monitor.cpp	2015-03-12 11:44:43 +0000
@@ -29,8 +29,12 @@
 #include <list>
 #include <mutex>
 
+namespace media = core::ubuntu::media;
 
-namespace {
+namespace
+{
+namespace impl
+{
 class TelepathyCallMonitor : public QObject
 {
     Q_OBJECT
@@ -73,7 +77,7 @@
         }
     }
 
-    void on_change(const std::function<void(CallMonitor::State)>& func) {
+    void on_change(const std::function<void(media::telephony::CallMonitor::State)>& func) {
         std::lock_guard<std::mutex> l(cb_lock);
         cb = func;
     }
@@ -131,19 +135,19 @@
     {
         std::lock_guard<std::mutex> l(cb_lock);
         if (cb)
-            cb(CallMonitor::OffHook);
+            cb(media::telephony::CallMonitor::State::OffHook);
     }
 
     void onHook()
     {
         std::lock_guard<std::mutex> l(cb_lock);
         if (cb)
-            cb(CallMonitor::OnHook);
+            cb(media::telephony::CallMonitor::State::OnHook);
     }
 
 private:
     std::mutex cb_lock;
-    std::function<void (CallMonitor::State)>   cb;
+    std::function<void (media::telephony::CallMonitor::State)>   cb;
     Tp::AccountManagerPtr mAccountManager;
     std::list<TelepathyCallMonitor*> mCallMonitors;
 
@@ -159,63 +163,78 @@
         mCallMonitors.push_back(tcm);
     }
 };
-}
 
-class CallMonitorPrivate
+struct CallMonitor : public media::telephony::CallMonitor
 {
-public:
-    CallMonitorPrivate() {
-        mBridge = nullptr;
-        try {
-            std::thread([this]() {
-                qt::core::world::build_and_run(0, nullptr, [this]() {
-                    qt::core::world::enter_with_task([this]() {
+    CallMonitor() : mBridge{nullptr}
+    {
+        try
+        {
+            qt_world = std::move(std::thread([this]()
+            {
+                qt::core::world::build_and_run(0, nullptr, [this]()
+                {
+                    qt::core::world::enter_with_task([this]()
+                    {
                         std::cout << "CallMonitor: Creating TelepathyBridge" << std::endl;
                         mBridge = new TelepathyBridge();
                         cv.notify_all();
                     });
                 });
-            }).detach();
+          }));
         } catch(const std::system_error& error) {
             std::cerr << "exception(std::system_error) in CallMonitor thread start" << error.what() << std::endl;
         } catch(...) {
             std::cerr << "exception(...) in CallMonitor thread start" << std::endl;
         }
+
         // Wait until telepathy bridge is set, so we can hook up the change signals
         std::unique_lock<std::mutex> lck(mtx);
         cv.wait_for(lck, std::chrono::seconds(3));
+
+        if (mBridge)
+        {
+            mBridge->on_change([this](CallMonitor::State state)
+            {
+                call_state_changed(state);
+            });
+        }
     }
 
-    ~CallMonitorPrivate() {
+    ~CallMonitor()
+    {
+        // We first clean up the bridge instance.
+        qt::core::world::enter_with_task([this]()
+        {
+            delete mBridge;
+        }).get();
+
+        // We then request destruction of the qt world.
         qt::core::world::destroy();
+
+        // Before we finally join the worker.
+        if (qt_world.joinable())
+            qt_world.join();
+    }
+
+    const core::Signal<media::telephony::CallMonitor::State>& on_call_state_changed() const
+    {
+        return call_state_changed;
     }
 
     TelepathyBridge *mBridge;
+    core::Signal<media::telephony::CallMonitor::State> call_state_changed;
 
-private:
+    std::thread qt_world;
     std::mutex mtx;
     std::condition_variable cv;
 };
-
-
-CallMonitor::CallMonitor():
-    d(new CallMonitorPrivate)
-{
-}
-
-CallMonitor::~CallMonitor()
-{
-    delete d->mBridge;
-    delete d;
-}
-
-void CallMonitor::on_change(const std::function<void(CallMonitor::State)>& func)
-{
-    if (d->mBridge != nullptr) {
-        std::cout << "CallMonitor: Setting up callback for TelepathyBridge on_change" << std::endl;
-        d->mBridge->on_change(func);
-    } else
-        std::cerr << "TelepathyBridge: Failed to hook on_change signal, bridge not yet set" << std::endl;
+}
+}
+
+media::telephony::CallMonitor::Ptr media::telephony::make_platform_default_call_monitor()
+{
+    return std::make_shared<impl::CallMonitor>();
 }
 
 #include "call_monitor.moc"

=== modified file 'src/core/media/telephony/call_monitor.h'
--- src/core/media/call-monitor/call_monitor.h	2014-10-31 07:49:33 +0000
+++ src/core/media/telephony/call_monitor.h	2015-03-12 11:44:43 +0000
@@ -17,25 +17,50 @@
  */
 
 
-#ifndef CALLMONITOR_H
-#define CALLMONITOR_H
+#ifndef CORE_UBUNTU_MEDIA_TELEPHONY_CALL_MONITOR_H_
+#define CORE_UBUNTU_MEDIA_TELEPHONY_CALL_MONITOR_H_
+
+#include <core/signal.h>
 
 #include <functional>
-
-class CallMonitorPrivate;
-
-class CallMonitor
-{
-public:
-    enum State { OffHook, OnHook };
-
-    CallMonitor();
-    ~CallMonitor();
-
-    void on_change(const std::function<void(CallMonitor::State)>& func);
-
-private:
-    CallMonitorPrivate *d;
+#include <memory>
+
+namespace core
+{
+namespace ubuntu
+{
+namespace media
+{
+namespace telephony
+{
+// CallMonitor models the ability to observe and react
+// to changes of the overall call state of the system.
+struct CallMonitor
+{
+    // Save us some typing.
+    typedef std::shared_ptr<CallMonitor> Ptr;
+
+    // All known call states
+    enum class State
+    {
+        // No current call.
+        OffHook,
+        // Call in progress.
+        OnHook
+    };
+
+    CallMonitor() = default;
+    virtual ~CallMonitor() = default;
+
+    // Emitted whenever the current call state of the system changes.
+    virtual const core::Signal<State>& on_call_state_changed() const = 0;
 };
 
-#endif // CALLMONITOR_H
+// Returns a platform default implementation of CallMonitor.
+CallMonitor::Ptr make_platform_default_call_monitor();
+}
+}
+}
+}
+
+#endif // CORE_UBUNTU_MEDIA_TELEPHONY_CALL_MONITOR_H_