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

[Thomas Voß]

Introduce an interface media::RecorderObserver that allows the core classes to monitor the overall state of the system.
Provide an implementation of media::RecorderObserver relying on Hybris to interface with the Android side.
Adjust the ServiceImplementation to connect to the platform-default media::RecorderObserver.

Introduce an interface media::RecorderObserver that allows the core classes to monitor the overall state of the system.
Provide an implementation of media::RecorderObserver relying on Hybris to interface with the Android side.
Adjust the ServiceImplementation to connect to the platform-default media::RecorderObserver.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

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

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

Remerge prereq branch.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[Jim Hodapp (jhodapp)]

Looks good, thanks!

review: Approve (code)

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

104. By Thomas Voß on 2014-12-09

[ 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:104
http://jenkins.qa.ubuntu.com/job/media-hub-ci/200/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/40/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/40
        deb: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/40/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/40

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

review: Needs Fixing (continuous-integration)

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

105. 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:105
http://jenkins.qa.ubuntu.com/job/media-hub-ci/228/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-amd64-ci/68/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-armhf-ci/68/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/media-hub-vivid-i386-ci/68/console

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

review: Needs Fixing (continuous-integration)

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

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

Merge prereq branch.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

The jenkins node for the i386 build failed, I've restarted a new ci run.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

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

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

Merge prereq branch.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Needs Fixing (continuous-integration)

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

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

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

review: Approve (continuous-integration)

=== modified file 'src/core/media/CMakeLists.txt'
--- src/core/media/CMakeLists.txt	2015-03-12 11:41:17 +0000
+++ src/core/media/CMakeLists.txt	2015-03-12 11:41:17 +0000
@@ -90,6 +90,8 @@
     hybris_client_death_observer.cpp
     cover_art_resolver.cpp
     engine.cpp
+    recorder_observer.cpp
+    hybris_recorder_observer.cpp
     gstreamer/engine.cpp
 
     player_skeleton.cpp

=== added file 'src/core/media/hybris_recorder_observer.cpp'
--- src/core/media/hybris_recorder_observer.cpp	1970-01-01 00:00:00 +0000
+++ src/core/media/hybris_recorder_observer.cpp	2015-03-12 11:41:17 +0000
@@ -0,0 +1,99 @@
+/*
+ * 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/hybris_recorder_observer.h>
+
+namespace media = core::ubuntu::media;
+
+#if defined(MEDIA_HUB_HAVE_HYBRIS_MEDIA_COMPAT_LAYER)
+#include <hybris/media/media_recorder_layer.h>
+
+struct media::HybrisRecorderObserver::Private
+{
+    struct Holder
+    {
+        std::weak_ptr<media::HybrisRecorderObserver::Private> wp;
+    };
+
+    // The fringe that we hand over to hybris.
+    static void on_media_recording_state_changed(bool started, void* context)
+    {
+        if (auto holder = static_cast<Holder*>(context))
+        {
+            if (auto sp = holder->wp.lock())
+            {
+                sp->recording_state = started ? media::RecordingState::started : media::RecordingState::stopped;
+            }
+        }
+    }
+
+    // TODO: We have no way of freeing the observer and thus leak
+    // an instance here.
+    MediaRecorderObserver* observer
+    {
+        android_media_recorder_observer_new()
+    };
+
+    core::Property<media::RecordingState> recording_state
+    {
+        media::RecordingState::stopped
+    };
+
+    Holder* holder
+    {
+        nullptr
+    };
+};
+
+media::HybrisRecorderObserver::HybrisRecorderObserver() : d{new Private{}}
+{
+    android_media_recorder_observer_set_cb(
+                d->observer,
+                &Private::on_media_recording_state_changed,
+                d->holder = new Private::Holder{d});
+}
+
+media::HybrisRecorderObserver::~HybrisRecorderObserver()
+{
+    // We first reset the context of the callback.
+    android_media_recorder_observer_set_cb(
+                d->observer,
+                &Private::on_media_recording_state_changed,
+                nullptr);
+
+    delete d->holder;
+}
+
+const core::Property<media::RecordingState>& media::HybrisRecorderObserver::recording_state() const
+{
+    return d->recording_state;
+}
+
+media::RecorderObserver::Ptr media::HybrisRecorderObserver::create()
+{
+    return media::RecorderObserver::Ptr{new media::HybrisRecorderObserver{}};
+}
+#else  // MEDIA_HUB_HAVE_HYBRIS_MEDIA_COMPAT_LAYER
+media::RecorderObserver::Ptr media::HybrisRecorderObserver::create()
+{
+    throw std::logic_error
+    {
+        "Hybris-based recorder observer implementation not supported on this platform."
+    };
+}
+#endif // MEDIA_HUB_HAVE_HYBRIS_MEDIA_COMPAT_LAYER

=== added file 'src/core/media/hybris_recorder_observer.h'
--- src/core/media/hybris_recorder_observer.h	1970-01-01 00:00:00 +0000
+++ src/core/media/hybris_recorder_observer.h	2015-03-12 11:41:17 +0000
@@ -0,0 +1,52 @@
+/*
+ * 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_HYBRIS_RECORDER_OBSERVER_H_
+#define CORE_UBUNTU_MEDIA_HYBRIS_RECORDER_OBSERVER_H_
+
+#include <core/media/recorder_observer.h>
+
+namespace core
+{
+namespace ubuntu
+{
+namespace media
+{
+class HybrisRecorderObserver : public RecorderObserver
+{
+public:
+    // Creates a new instance of the HybrisRecorderObserver or throws
+    // if hybris is not available.
+    static RecorderObserver::Ptr create();
+
+    ~HybrisRecorderObserver();
+
+    // Getable/observable property describing the recording state of the system.
+    const core::Property<RecordingState>& recording_state() const override;
+
+private:
+    struct Private;
+
+    HybrisRecorderObserver();
+    std::shared_ptr<Private> d;
+};
+}
+}
+}
+
+#endif // CORE_UBUNTU_MEDIA_HYBRIS_RECORDER_OBSERVER_H_

=== added file 'src/core/media/recorder_observer.cpp'
--- src/core/media/recorder_observer.cpp	1970-01-01 00:00:00 +0000
+++ src/core/media/recorder_observer.cpp	2015-03-12 11:41:17 +0000
@@ -0,0 +1,28 @@
+/*
+ * 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/recorder_observer.h>
+
+#include <core/media/hybris_recorder_observer.h>
+
+namespace media = core::ubuntu::media;
+
+media::RecorderObserver::Ptr media::make_platform_default_recorder_observer()
+{
+    return media::HybrisRecorderObserver::create();
+}

=== added file 'src/core/media/recorder_observer.h'
--- src/core/media/recorder_observer.h	1970-01-01 00:00:00 +0000
+++ src/core/media/recorder_observer.h	2015-03-12 11:41:17 +0000
@@ -0,0 +1,64 @@
+/*
+ * 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_RECORDER_OBSERVER_H_
+#define CORE_UBUNTU_MEDIA_RECORDER_OBSERVER_H_
+
+#include <core/property.h>
+
+#include <memory>
+
+namespace core
+{
+namespace ubuntu
+{
+namespace media
+{
+// All known states of the recorder
+enum class RecordingState
+{
+    // No active recording
+    stopped,
+    // We have an active recording session
+    started
+};
+
+// A RecorderObserver allows for monitoring the recording state
+// of the service.
+struct RecorderObserver
+{
+    // To save us some typing.
+    typedef std::shared_ptr<RecorderObserver> Ptr;
+
+    RecorderObserver() = default;
+    RecorderObserver(const RecorderObserver&) = delete;
+    virtual ~RecorderObserver() = default;
+    RecorderObserver& operator=(const RecorderObserver&) = delete;
+
+    // Getable/observable property describing the recording state of the system.
+    virtual const core::Property<RecordingState>& recording_state() const = 0;
+};
+
+// Creates an instance of interface RecorderObserver relying on
+// default services offered by the platform we are currently running on.
+RecorderObserver::Ptr make_platform_default_recorder_observer();
+}
+}
+}
+
+#endif // CORE_UBUNTU_MEDIA_RECORDER_OBSERVER_H_

=== modified file 'src/core/media/service_implementation.cpp'
--- src/core/media/service_implementation.cpp	2015-01-16 17:17:30 +0000
+++ src/core/media/service_implementation.cpp	2015-03-12 11:41:17 +0000
@@ -26,6 +26,7 @@
 #include "call-monitor/call_monitor.h"
 #include "player_configuration.h"
 #include "player_implementation.h"
+#include "recorder_observer.h"
 
 #include <boost/asio.hpp>
 
@@ -40,7 +41,6 @@
 
 #include "util/timeout.h"
 #include "unity_screen_service.h"
-#include <hybris/media/media_recorder_layer.h>
 
 namespace media = core::ubuntu::media;
 
@@ -141,8 +141,11 @@
         auto uscreen_stub_service = dbus::Service::use_service(bus, dbus::traits::Service<core::UScreen>::interface_name());
         uscreen_session = uscreen_stub_service->object_for_path(dbus::types::ObjectPath("/com/canonical/Unity/Screen"));
 
-        observer = android_media_recorder_observer_new();
-        android_media_recorder_observer_set_cb(observer, &Private::media_recording_started_callback, this);
+        recorder_observer = media::make_platform_default_recorder_observer();
+        recorder_observer->recording_state().changed().connect([this](media::RecordingState state)
+        {
+            media_recording_state_changed(state);
+        });
     }
 
     ~Private()
@@ -165,12 +168,12 @@
             pulse_worker.join();
     }
 
-    void media_recording_started(bool started)
+    void media_recording_state_changed(media::RecordingState state)
     {
         if (uscreen_session == nullptr)
             return;
 
-        if (started)
+        if (state == media::RecordingState::started)
         {
             if (disp_cookie > 0)
                 return;
@@ -183,7 +186,7 @@
                 throw std::runtime_error(result.error().print());
             disp_cookie = result.value();
         }
-        else
+        else if (state == media::RecordingState::stopped)
         {
             if (disp_cookie != -1)
             {
@@ -195,15 +198,6 @@
         }
     }
 
-    static void media_recording_started_callback(bool started, void *context)
-    {
-        if (context == nullptr)
-            return;
-
-        auto p = static_cast<Private*>(context);
-        p->media_recording_started(started);
-    }
-
     pa_threaded_mainloop *mainloop()
     {
         return pulse_mainloop;
@@ -459,8 +453,7 @@
     std::shared_ptr<core::dbus::Property<core::IndicatorPower::IsWarning>> is_warning;
     int disp_cookie;
     std::shared_ptr<dbus::Object> uscreen_session;
-    MediaRecorderObserver *observer;
-
+    media::RecorderObserver::Ptr recorder_observer;
     // Pulse-specific
     pa_mainloop_api *pulse_mainloop_api;
     pa_threaded_mainloop *pulse_mainloop;