Merge lp:~afrantzis/unity-system-compositor/fix-1463855-usc-spinner into lp:unity-system-compositor

[Alexandros Frantzis]

spinner: Fix failure to run on Android

This MP:

1. Passes surface dimensions in addition to the output_id when placing on a specific output. This is needed as a workaround for our Android backend, which unfortunately uses the value of mir_display_output_invalid_id (0) as a valid output id!

2. Sets swapinterval correctly per surface.

3. Uses eglQuerySurface to get the surface size (instead of mir_buffer_stream_get_current_buffer() which returns a platform dependent structure).

4. Uses a dummy pbuffer surface to emulate a surfaceless context on platforms that don't support it (e.g. Android).

spinner: Fix failure to run on Android

This MP:

1. Passes surface dimensions in addition to the output_id when placing on a specific output. This is needed as a workaround for our Android backend, which unfortunately uses the value of mir_display_output_invalid_id (0) as an output id ([1])!

2. Sets swapinterval correctly per surface.

3. Uses eglQuerySurface to get the surface size (instead of mir_buffer_stream_get_current_buffer() which returns a platform dependent structure).

4. Uses a dummy pbuffer surface to emulate a surfaceless context on platforms that don't support it (e.g. Android).

[1] https://bugs.launchpad.net/mir/+bug/1463873

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:220
http://jenkins.qa.ubuntu.com/job/unity-system-compositor-ci/228/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-amd64-ci/16
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/16
        deb: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/16/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-i386-ci/16

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

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

LGTM

review: Approve

[Chris Halse Rogers (raof)]

Looks sensible.

review: Approve

=== modified file 'spinner/eglapp.cpp'
--- spinner/eglapp.cpp	2015-05-28 15:25:28 +0000
+++ spinner/eglapp.cpp	2015-06-10 15:00:47 +0000
@@ -205,21 +205,30 @@
     auto const pixel_format = select_pixel_format(connection);
     surfaceparm.pixel_format = pixel_format;
 
-    auto const mir_egl_app = make_mir_eglapp(connection, pixel_format, swapinterval);
+    auto const mir_egl_app = make_mir_eglapp(connection, pixel_format);
 
     std::vector<std::shared_ptr<MirEglSurface>> result;
 
     // If a size has been specified just do that
     if (surfaceparm.width && surfaceparm.height)
     {
-        result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm));
+        result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm, swapinterval));
         return result;
     }
 
     // If an output has been specified just do that
     if (surfaceparm.output_id != mir_display_output_id_invalid)
     {
-        result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm));
+        for_each_active_output(connection, [&](MirDisplayOutput const* output)
+            {
+                if (output->output_id == surfaceparm.output_id)
+                {
+                    auto const& mode = output->modes[output->current_mode];
+                    surfaceparm.width = mode.horizontal_resolution;
+                    surfaceparm.height = mode.vertical_resolution;
+                }
+            });
+        result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm, swapinterval));
         return result;
     }
 
@@ -233,8 +242,10 @@
                    output->position_x, output->position_y,
                    mode.horizontal_resolution, mode.vertical_resolution);
 
+            surfaceparm.width = mode.horizontal_resolution;
+            surfaceparm.height = mode.vertical_resolution;
             surfaceparm.output_id = output->output_id;
-            result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm));
+            result.push_back(std::make_shared<MirEglSurface>(mir_egl_app, surfaceparm, swapinterval));
         });
 
     if (result.empty())

=== modified file 'spinner/miregl.cpp'
--- spinner/miregl.cpp	2015-05-28 15:29:51 +0000
+++ spinner/miregl.cpp	2015-06-10 15:00:47 +0000
@@ -16,12 +16,14 @@
 
 #include "miregl.h"
 
+#include <cstring>
+
 #include <GLES2/gl2.h>
 
 class MirEglApp
 {
 public:
-    MirEglApp(MirConnection* const connection, MirPixelFormat pixel_format, EGLint swapinterval);
+    MirEglApp(MirConnection* const connection, MirPixelFormat pixel_format);
 
     EGLSurface create_surface(MirSurface* surface);
 
@@ -33,6 +35,12 @@
 
     void destroy_surface(EGLSurface eglsurface) const;
 
+    void get_surface_size(EGLSurface eglsurface, int* width, int* height) const;
+
+    void set_swap_interval(EGLSurface eglsurface, int interval) const;
+
+    bool supports_surfaceless_context();
+
     ~MirEglApp();
 
     MirConnection* const connection;
@@ -41,12 +49,13 @@
     EGLContext eglctx;
     EGLConfig eglconfig;
     EGLint neglconfigs;
+    EGLSurface dummy_surface;
 };
 
 std::shared_ptr<MirEglApp> make_mir_eglapp(
-    MirConnection* const connection, MirPixelFormat const& pixel_format, EGLint swapinterval)
+    MirConnection* const connection, MirPixelFormat const& pixel_format)
 {
-    return std::make_shared<MirEglApp>(connection, pixel_format, swapinterval);
+    return std::make_shared<MirEglApp>(connection, pixel_format);
 }
 
 namespace
@@ -67,7 +76,7 @@
     mir_surface_spec_release(spec);
 
     if (!mir_surface_is_valid(surface))
-        throw std::runtime_error("Can't create a surface");
+        throw std::runtime_error(std::string("Can't create a surface ") + mir_surface_get_error_message(surface));
 
     if (surfaceparm.output_id != mir_display_output_id_invalid)
         mir_surface_set_state(surface, mir_surface_state_fullscreen);
@@ -76,11 +85,14 @@
 }
 }
 
-MirEglSurface::MirEglSurface(std::shared_ptr<MirEglApp> const& mir_egl_app, MirSurfaceParameters const& surfaceparm) :
+MirEglSurface::MirEglSurface(std::shared_ptr<MirEglApp> const& mir_egl_app, MirSurfaceParameters const& surfaceparm, int swapinterval) :
     mir_egl_app{mir_egl_app},
     surface{create_surface(mir_egl_app->connection, surfaceparm)},
-    eglsurface{mir_egl_app->create_surface(surface)}
+    eglsurface{mir_egl_app->create_surface(surface)},
+    width_{0},
+    height_{0}
 {
+    mir_egl_app->set_swap_interval(eglsurface, swapinterval);
 }
 
 MirEglSurface::~MirEglSurface()
@@ -91,8 +103,7 @@
 
 void MirEglSurface::egl_make_current()
 {
-    auto const buffer_stream = mir_surface_get_buffer_stream(surface);
-    mir_buffer_stream_get_current_buffer(buffer_stream, &buffer_package);
+    mir_egl_app->get_surface_size(eglsurface, &width_, &height_);
     mir_egl_app->make_current(eglsurface);
 }
 
@@ -103,16 +114,17 @@
 
 unsigned int MirEglSurface::width() const
 {
-    return buffer_package->width;
+    return width_;
 }
 
 unsigned int MirEglSurface::height() const
 {
-    return buffer_package->height;
+    return height_;
 }
 
-MirEglApp::MirEglApp(MirConnection* const connection, MirPixelFormat pixel_format, EGLint swapinterval) :
-    connection{connection}
+MirEglApp::MirEglApp(MirConnection* const connection, MirPixelFormat pixel_format) :
+    connection{connection},
+    dummy_surface{EGL_NO_SURFACE}
 {
     unsigned int bpp = 8*MIR_BYTES_PER_PIXEL(pixel_format);
 
@@ -153,10 +165,21 @@
     if (eglctx == EGL_NO_CONTEXT)
         throw std::runtime_error("eglCreateContext failed");
 
-    if (!eglMakeCurrent(egldisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, eglctx))
-        throw std::runtime_error("Can't eglMakeCurrent");
+    if (!supports_surfaceless_context())
+    {
+        static EGLint const dummy_pbuffer_attribs[] =
+        {
+             EGL_WIDTH, 1,
+             EGL_HEIGHT, 1,
+             EGL_NONE
+        };
+     
+        dummy_surface = eglCreatePbufferSurface(egldisplay, eglconfig, dummy_pbuffer_attribs);
+        if (dummy_surface == EGL_NO_SURFACE)
+            throw std::runtime_error("eglCreatePbufferSurface failed");
+    }
 
-    eglSwapInterval(egldisplay, swapinterval);
+    make_current(dummy_surface);
 }
 
 EGLSurface MirEglApp::create_surface(MirSurface* surface)
@@ -188,10 +211,36 @@
     eglDestroySurface(egldisplay, eglsurface);
 }
 
+void MirEglApp::get_surface_size(EGLSurface eglsurface, int* width, int* height) const
+{
+    eglQuerySurface(egldisplay, eglsurface, EGL_WIDTH, width);
+    eglQuerySurface(egldisplay, eglsurface, EGL_HEIGHT, height);
+}
+
+void MirEglApp::set_swap_interval(EGLSurface eglsurface, int interval) const
+{
+    auto const previous_surface = eglGetCurrentSurface(EGL_DRAW);
+
+    make_current(eglsurface);
+    eglSwapInterval(egldisplay, interval);
+
+    if (previous_surface != EGL_NO_SURFACE)
+        make_current(previous_surface);
+}
+
+bool MirEglApp::supports_surfaceless_context()
+{
+    auto const extensions = eglQueryString(egldisplay, EGL_EXTENSIONS);
+    if (!extensions)
+        return false;
+    return std::strstr(extensions, "EGL_KHR_surfaceless_context") != nullptr;
+}
 
 MirEglApp::~MirEglApp()
 {
     eglMakeCurrent(egldisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
+    if (dummy_surface != EGL_NO_SURFACE)
+        destroy_surface(dummy_surface);
     eglDestroyContext(egldisplay, eglctx);
     eglTerminate(egldisplay);
     mir_connection_release(connection);

=== modified file 'spinner/miregl.h'
--- spinner/miregl.h	2015-05-28 15:25:28 +0000
+++ spinner/miregl.h	2015-06-10 15:00:47 +0000
@@ -30,13 +30,15 @@
 
 std::shared_ptr<MirEglApp> make_mir_eglapp(
     MirConnection* const connection,
-    MirPixelFormat const& pixel_format,
-    EGLint swapinterval);
+    MirPixelFormat const& pixel_format);
 
 class MirEglSurface
 {
 public:
-    MirEglSurface(std::shared_ptr<MirEglApp> const& mir_egl_app, MirSurfaceParameters const& surfaceparm);
+    MirEglSurface(
+        std::shared_ptr<MirEglApp> const& mir_egl_app,
+        MirSurfaceParameters const& surfaceparm,
+        int swapinterval);
 
     ~MirEglSurface();
 
@@ -57,8 +59,9 @@
 
     std::shared_ptr<MirEglApp> const mir_egl_app;
     MirSurface* const surface;
-    MirBufferPackage* buffer_package;
     EGLSurface const eglsurface;
+    int width_;
+    int height_;
 };
 
 #endif //UNITYSYSTEMCOMPOSITOR_MIREGL_H