Merge lp:~albaguirre/unity-system-compositor/add-power-off-delay-option into lp:unity-system-compositor

[Alberto Aguirre]

Add an optional delay when powering off screen.

Add an option (power-off-delay, defaulted to 0) to delay stopping the compositor and powering off the screen to allow the shell to present a shutdown animation; without delay, the shell and-or greeter will get blocked while trying to render such animation; this is due to the compositor stopping as USC receives the power state change before the shell.

This is mostly a workaround as ideally, the greeter and-or shell should coordinate when to shutdown the screen after they are given a chance to possibly show a shutdown animation.

fixes: lp: #1233564

Add an optional delay when powering off screen.

Add an option (power-off-delay, defaulted to 0) to delay stopping the compositor and powering off the screen to allow the shell to present a shutdown animation; without delay, the shell and-or greeter will get blocked while trying to render such animation; this is due to the compositor stopping as USC receives the power state change before the shell.

This is mostly a workaround as ideally, the greeter and-or shell should coordinate when to shutdown the screen after they are given a chance to possibly show a shutdown animation.

fixes: lp: #1233564

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:116
http://jenkins.qa.ubuntu.com/job/unity-system-compositor-ci/81/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-trusty-amd64-ci/33
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-trusty-armhf-ci/33

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-system-compositor-ci/81/rebuild

review: Approve (continuous-integration)

[Michael Terry (mterry)]

Seems fine, worked for me when passing --power-off-delay=500 to USC.

review: Approve

[Alberto Aguirre (albaguirre)]

Note that to actually see the delay in action you need powerd to avoid touching the backlight before notifying USC:

https://code.launchpad.net/~albaguirre/powerd/let-display-turn-off-backlight/+merge/208667

[Nick Dedekind (nick-dedekind)]

displayConfig::configure_output

no longer exists in mir/devel

=== modified file 'src/dbus_screen.cpp'
--- src/dbus_screen.cpp	2014-02-04 14:43:09 +0000
+++ src/dbus_screen.cpp	2014-02-26 06:33:04 +0000
@@ -28,15 +28,59 @@
 namespace mc = mir::compositor;
 namespace mg = mir::graphics;
 
+static void set_screen_power_mode(MirPowerMode mode, const std::shared_ptr<mir::DefaultServerConfiguration>& config)
+{
+    std::shared_ptr<mg::Display> display = config->the_display();
+    std::shared_ptr<mg::DisplayConfiguration> displayConfig = display->configuration();
+    std::shared_ptr<mc::Compositor> compositor = config->the_compositor();
+
+    displayConfig->for_each_output([&](const mg::DisplayConfigurationOutput displayConfigOutput) {
+        if (displayConfigOutput.power_mode != mode) {
+            displayConfig->configure_output(
+                        displayConfigOutput.id,         //unchanged
+                        displayConfigOutput.used,       //unchanged
+                        displayConfigOutput.top_left,   //unchanged
+                        displayConfigOutput.current_mode_index, //unchanged
+                        displayConfigOutput.current_format,
+                        mode,
+                        displayConfigOutput.orientation //unchanged
+                        );
+        }
+    });
+
+    if (mode != MirPowerMode::mir_power_mode_on)
+        compositor->stop();
+
+    display->configure(*displayConfig.get());
+
+    if (mode == MirPowerMode::mir_power_mode_on)
+        compositor->start();
+}
+
 // Note: this class should be created only after when the Mir DisplayServer has started
-DBusScreen::DBusScreen(std::shared_ptr<mir::DefaultServerConfiguration> config, QObject *parent)
-    : QObject(parent)
-    , config(config)
+DBusScreen::DBusScreen(std::shared_ptr<mir::DefaultServerConfiguration> config,
+                       int off_delay, QObject *parent)
+    : QObject(parent),
+      config(config),
+      power_off_timer(off_delay > 0 ? new QTimer(this) : nullptr),
+      power_off_mode(MirPowerMode::mir_power_mode_off),
+      power_off_delay(off_delay)
+
 {
     new DBusScreenAdaptor(this);
     QDBusConnection bus = QDBusConnection::systemBus();
     bus.registerObject("/com/canonical/Unity/Screen", this);
     bus.registerService("com.canonical.Unity.Screen");
+
+    if (power_off_timer != nullptr) {
+        power_off_timer->setSingleShot(true);
+        connect(power_off_timer, SIGNAL(timeout()), this, SLOT(power_off()));
+    }
+}
+
+DBusScreen::~DBusScreen()
+{
+    delete power_off_timer;
 }
 
 bool DBusScreen::setScreenPowerMode(const QString &mode)
@@ -46,6 +90,8 @@
 
     if (mode == "on") {
         newPowerMode = MirPowerMode::mir_power_mode_on;
+        if (power_off_timer != nullptr && power_off_timer->isActive())
+            power_off_timer->stop();
     } else if (mode == "standby") {
         newPowerMode = MirPowerMode::mir_power_mode_standby; // higher power "off" mode (fastest resume)
     } else if (mode == "suspend") {
@@ -57,31 +103,17 @@
         return false;
     }
 
-    std::shared_ptr<mg::Display> display = config->the_display();
-    std::shared_ptr<mg::DisplayConfiguration> displayConfig = display->configuration();
-    std::shared_ptr<mc::Compositor> compositor = config->the_compositor();
-
-    displayConfig->for_each_output([&](const mg::DisplayConfigurationOutput displayConfigOutput) {
-        if (displayConfigOutput.power_mode != newPowerMode) {
-            displayConfig->configure_output(
-                        displayConfigOutput.id,         //unchanged
-                        displayConfigOutput.used,       //unchanged
-                        displayConfigOutput.top_left,   //unchanged
-                        displayConfigOutput.current_mode_index, //unchanged
-                        displayConfigOutput.current_format,
-                        newPowerMode,
-                        displayConfigOutput.orientation //unchanged
-                        );
-        }
-    });
-
-    if (newPowerMode != MirPowerMode::mir_power_mode_on)
-        compositor->stop();
-
-    display->configure(*displayConfig.get());
-
-    if (newPowerMode == MirPowerMode::mir_power_mode_on)
-        compositor->start();
+    if ((newPowerMode != MirPowerMode::mir_power_mode_on) && (power_off_timer != nullptr)) {
+        power_off_mode = newPowerMode;
+        power_off_timer->start(power_off_delay);
+    } else {
+        set_screen_power_mode(newPowerMode, config);
+    }
 
     return true;
 }
+
+void DBusScreen::power_off()
+{
+    set_screen_power_mode(power_off_mode, config);
+}

=== modified file 'src/dbus_screen.h'
--- src/dbus_screen.h	2013-10-31 19:16:23 +0000
+++ src/dbus_screen.h	2014-02-26 06:33:04 +0000
@@ -17,8 +17,11 @@
 #ifndef DBUS_SCREEN_H_
 #define DBUS_SCREEN_H_
 
+#include <mir_toolkit/common.h>
+
 #include <memory>
 #include <QObject>
+#include <QtCore>
 
 namespace mir
 {
@@ -31,13 +34,21 @@
     Q_CLASSINFO("D-Bus Interface", "com.canonical.Unity.Screen")
 
 public:
-    explicit DBusScreen(std::shared_ptr<mir::DefaultServerConfiguration> config, QObject *parent = 0);
+    explicit DBusScreen(std::shared_ptr<mir::DefaultServerConfiguration> config,
+                        int off_delay, QObject *parent = 0);
+    virtual ~DBusScreen();
 
 public Q_SLOTS:
     bool setScreenPowerMode(const QString &mode);
 
+private Q_SLOTS:
+    void power_off();
+
 private:
     std::shared_ptr<mir::DefaultServerConfiguration> config;
+    QTimer *power_off_timer;
+    MirPowerMode power_off_mode;
+    int power_off_delay;
 };
 
 #endif /* DBUS_SCREEN_H_ */

=== modified file 'src/system_compositor.cpp'
--- src/system_compositor.cpp	2014-02-10 14:55:13 +0000
+++ src/system_compositor.cpp	2014-02-26 06:33:04 +0000
@@ -96,7 +96,8 @@
             ("to-dm-fd", po::value<int>(),  "File descriptor of write end of pipe to display manager [int]")
             ("blacklist", po::value<std::string>(), "Video blacklist regex to use")
             ("version", "Show version of Unity System Compositor")
-            ("public-socket", po::value<bool>(), "Make the socket file publicly writable");
+            ("public-socket", po::value<bool>(), "Make the socket file publicly writable")
+            ("power-off-delay", po::value<int>(), "Delay in milliseconds before powering off screen [int]");
     }
 
     int from_dm_fd()
@@ -114,6 +115,11 @@
         return the_options()->is_set ("version");
     }
 
+    int power_off_delay()
+    {
+        return the_options()->get("power-off-delay", 0);
+    }
+
     std::string blacklist()
     {
         auto x = the_options()->get ("blacklist", "");
@@ -331,6 +337,6 @@
 void SystemCompositor::qt_main(int argc, char **argv)
 {
     QCoreApplication app(argc, argv);
-    DBusScreen dbus_screen(config);
+    DBusScreen dbus_screen(config, config->power_off_delay());
     app.exec();
 }