Merge lp:~mterry/unity-system-compositor/default-wallpaper into lp:unity-system-compositor

[Michael Terry]

Use system wallpaper instead of custom built-in one.

Additionally, crop it instead of stretching it.

I used gdk-pixbuf for loading the image. Is there a better library to use? We were already using glib, so it didn't seem like a big stretch.

Question for reviewers: how badly do we want performance here? It's good to reduce the gap between the firmware screen and the spinner screen. Here's rough timings from program launch to first frame for the old background and new (on my laptop, which is presumably beefier than my phone):

Old background (statically linked into binary): ~0.080s
New background (statically linked into binary): ~0.125s
New background (dynamically loaded): ~0.250s

This MP is currently dynamically loaded, since it's "most correct". But it might be worth statically linking the image for the time savings? It means we'd have to no-change rebuild the package every time ubuntu-wallpapers updates the default image before USC picks it up.

I'm open to options.

Also related:
- https://code.launchpad.net/~mterry/ubuntu-system-settings/default-wallpaper/+merge/297632
- https://code.launchpad.net/~mterry/unity8/default-wallpaper/+merge/297636

I've made silo 23 that includes all three for easier testing.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:300
https://mir-jenkins.ubuntu.com/job/usc-ci/30/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-usc/41/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1364
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1355
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1355
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=amd64,release=xenial/45/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=armhf,release=vivid+overlay/45/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=i386,release=xenial/45/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/usc-ci/30/rebuild

review: Needs Fixing (continuous-integration)

[Michael Terry (mterry)]

/me looks into the startup timing changes involved in loading the image dynamically vs built in.

[Michael Terry (mterry)]

OK, added some brief timing notes in the description.

[Alexandros Frantzis (afrantzis)]

Code looks good.

On krillin the timings I get are:

static wallpaper.png 0.34s
dynamic wallpaper.png 0.28s !!!
static warty-final-ubuntu.png 0.62s
dynamic warty-final-ubuntu.png 0.82s

For the large background, the penalty for dynamically loading is 0.2s, whereas there seems to be a slight benefit for the small background.

Note that dynamically loading presents a net gain in installed size, which may be a concern on the phone. With static embedding unity-system-compositor-spinner size is ~28MB, whereas with dynamic loading usc-spinner is 0.3MB + 20MB for ubuntu-wallpaper(-vivid) packages. We could get even lower if there was a package that didn't pull in *all* the wallpapers for the distro.

Ideas for improved performance:
* Also provide a lower resolution (e.g. 1920x1080) version of the default background. If the display is not larger than that we could just go with the small version and improve performance a lot.
* We could experiment with using libpng directly to check if it reduces loading time.

My vote is to go with dynamic loading, since it's the lowest maintenance solution (no need for rebuilds etc), and the runtime cost is not prohibitive, especially if we implement idea (1) and provide a lower resolution image also.

review: Approve

[Alexandros Frantzis (afrantzis)]

Actually small concern/needs info:

On krillin I see a horizontal line just behind the logo, as if like the image somehow restarts at that point. Could this be a cropping artifact?

review: Needs Information

[Michael Terry (mterry)]

You mentioned the size of installing ubuntu-wallpapers. We need ubuntu-wallpapers for the other components of this change (ubuntu-system-settings and unity8) anyway. So dynamic or not, those packages will be installed.

And I agree it's annoying that ubuntu-wallpapers assumes you want all of vivid-wallpapers too.

I'll test on krillin and see about that horizontal line...

[Michael Terry (mterry)]

Ah that horizontal line is actually part of the wallpaper. See http://3.bp.blogspot.com/-4DI7qffDyRg/VRPh-1fkGMI/AAAAAAAAV94/IaeSY8Bc_zg/s1600/warty-final-ubuntu.png

[Alexandros Frantzis (afrantzis)]

review: Approve

[Mir CI Bot (mir-ci-bot)]

FAILED: Autolanding.
More details in the following jenkins job:
https://mir-jenkins.ubuntu.com/job/usc-autolanding/15/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-usc/51/console
    None: https://mir-jenkins.ubuntu.com/job/generic-land-mp/594/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2069
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2060
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2060
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2060
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=amd64,release=xenial+overlay/55/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=amd64,release=yakkety/55/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=armhf,release=vivid+overlay/55/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=i386,release=xenial+overlay/55/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-usc/arch=i386,release=yakkety/55/console

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

review: Approve (continuous-integration)

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-06-09 08:36:48 +0000
+++ CMakeLists.txt	2016-06-17 16:55:53 +0000
@@ -39,6 +39,7 @@
 
 find_package(PkgConfig)
 pkg_check_modules(ANDROIDPROPS libandroid-properties)
+pkg_check_modules(GDKPIXBUF REQUIRED gdk-pixbuf-2.0)
 pkg_check_modules(GLIB REQUIRED glib-2.0)
 pkg_check_modules(MIRCLIENT REQUIRED mirclient)
 pkg_check_modules(MIRSERVER REQUIRED mirserver)

=== modified file 'debian/control'
--- debian/control	2016-06-09 08:32:32 +0000
+++ debian/control	2016-06-17 16:55:53 +0000
@@ -11,6 +11,7 @@
                libboost-dev,
                libboost-system-dev,
                libdbus-1-dev,
+               libgdk-pixbuf2.0-dev,
                libglib2.0-dev,
                libgles2-mesa-dev,
                libglm-dev,
@@ -31,6 +32,7 @@
 Architecture: any
 Depends: ${misc:Depends},
          ${shlibs:Depends},
+         ubuntu-wallpapers,
 Suggests: repowerd,
 Description: System compositor for Ubuntu
  System compositor used by the Mir display server in Ubuntu. If the Unity

=== modified file 'spinner/CMakeLists.txt'
--- spinner/CMakeLists.txt	2015-06-25 15:47:06 +0000
+++ spinner/CMakeLists.txt	2016-06-17 16:55:53 +0000
@@ -23,12 +23,6 @@
 endfunction()
 
 png2header(
-  ${CMAKE_CURRENT_SOURCE_DIR}/wallpaper.png
-  ${CMAKE_CURRENT_BINARY_DIR}/wallpaper.h
-  wallpaper
-)
-
-png2header(
   ${CMAKE_CURRENT_SOURCE_DIR}/logo.png
   ${CMAKE_CURRENT_BINARY_DIR}/logo.h
   logo
@@ -47,6 +41,7 @@
 )
 
 include_directories(
+  ${GDKPIXBUF_INCLUDE_DIRS}
   ${GLIB_INCLUDE_DIRS}
   ${ANDROIDPROPS_INCLUDE_DIRS}
   ${GLESv2_INCLUDE_DIRS}
@@ -66,7 +61,6 @@
   eglspinner.cpp
   miregl.h
   miregl.cpp
-  ${CMAKE_CURRENT_BINARY_DIR}/wallpaper.h
   ${CMAKE_CURRENT_BINARY_DIR}/logo.h
   ${CMAKE_CURRENT_BINARY_DIR}/white_dot.h
   ${CMAKE_CURRENT_BINARY_DIR}/orange_dot.h
@@ -74,6 +68,7 @@
 
 target_link_libraries(unity-system-compositor-spinner
   EGL
+  ${GDKPIXBUF_LDFLAGS}
   ${GLIB_LDFLAGS}
   ${ANDROIDPROPS_LDFLAGS}
   ${GLESv2_LIBRARIES}

=== modified file 'spinner/eglspinner.cpp'
--- spinner/eglspinner.cpp	2016-02-17 11:04:24 +0000
+++ spinner/eglspinner.cpp	2016-06-17 16:55:53 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2013-2015 Canonical Ltd.
+ * Copyright © 2013-2016 Canonical Ltd.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
@@ -12,16 +12,12 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authors: Daniel van Vugt <[e-mail]>
- *          Mirco Müller <[e-mail]>
- *          Alan Griffiths <[e-mail]>
- *          Kevin DuBois <[e-mail]>
  */
 
 #include "eglapp.h"
 #include "miregl.h"
 #include <assert.h>
+#include <gdk-pixbuf/gdk-pixbuf.h>
 #include <glib.h>
 #include <string.h>
 #include <GLES2/gl2.h>
@@ -40,11 +36,12 @@
 #include <glm/gtc/matrix_transform.hpp>
 #include <glm/gtc/type_ptr.hpp>
 
-#include "wallpaper.h"
 #include "logo.h"
 #include "white_dot.h"
 #include "orange_dot.h"
 
+#define WALLPAPER_FILE "/usr/share/backgrounds/warty-final-ubuntu.png"
+
 enum TextureIds {
     WALLPAPER = 0,
     LOGO,
@@ -158,6 +155,13 @@
 #define BLACK           0.0f,         0.0f,         0.0f
 //#define WHITE           1.0f,         1.0f,         1.0f
 
+static struct {
+    unsigned int width = 0;
+    unsigned int height = 0;
+    unsigned int bytes_per_pixel = 3; /* 3:RGB, 4:RGBA */
+    unsigned char *pixel_data = nullptr;
+} wallpaper;
+
 template <typename Image>
 void uploadTexture (GLuint id, Image& image)
 {
@@ -300,6 +304,19 @@
 
     SessionConfig session_config;
 
+    // Load wallpaper
+    GError *error = nullptr;
+    auto wallpaperPixbuf = gdk_pixbuf_new_from_file(WALLPAPER_FILE, &error);
+    if (wallpaperPixbuf) {
+        wallpaper.width = gdk_pixbuf_get_width(wallpaperPixbuf);
+        wallpaper.height = gdk_pixbuf_get_height(wallpaperPixbuf);
+        wallpaper.bytes_per_pixel = gdk_pixbuf_get_has_alpha(wallpaperPixbuf) ? 4 : 3;
+        wallpaper.pixel_data = (unsigned char*)gdk_pixbuf_read_pixels(wallpaperPixbuf);
+    } else {
+        printf("Could not load wallpaper: %s\n", error->message);
+    }
+    g_clear_error(&error);
+
     auto const surfaces = mir_eglapp_init(argc, argv);
 
     if (!surfaces.size())
@@ -430,6 +447,16 @@
                 mvpMatrix = glm::translate(mvpMatrix, glm::vec3(-1.0, -1.0, 0.0f));
                 mvpMatrix = glm::scale(mvpMatrix,
                                        glm::vec3(2.0f / render_width, 2.0f / render_height, 1.0f));
+
+                auto widthRatio = (1.0f * wallpaper.height * render_width) / (wallpaper.width * render_height);
+                auto heightRatio = 1.0f;
+                if (widthRatio > 1.0f) {
+                    heightRatio = 1.0f / widthRatio;
+                    widthRatio = 1.0f;
+                }
+                auto const wallpaperProjMatrix = glm::ortho(-widthRatio, widthRatio, heightRatio, -heightRatio, -1.0f, 1.0f);
+                auto wallpaperMatrix = wallpaperProjMatrix * mvpMatrix;
+
                 auto const projMatrix = glm::ortho(-1.0f, 1.0f, 1.0f, -1.0f, -1.0f, 1.0f);
                 mvpMatrix = projMatrix * mvpMatrix;
 
@@ -444,7 +471,7 @@
                 glBindTexture(GL_TEXTURE_2D, texture[WALLPAPER]);
                 glUniform1i(sampler[WALLPAPER], 0);
                 glUniform2f(offset[WALLPAPER], 0.0f, 0.0f);
-                glUniformMatrix4fv(projMat[WALLPAPER], 1, GL_FALSE, glm::value_ptr(mvpMatrix));
+                glUniformMatrix4fv(projMat[WALLPAPER], 1, GL_FALSE, glm::value_ptr(wallpaperMatrix));
                 glDrawArrays(GL_TRIANGLE_STRIP, 0, 4);
 
                 // draw logo

=== removed file 'spinner/wallpaper.png'
Binary files spinner/wallpaper.png	2015-08-27 15:25:37 +0000 and spinner/wallpaper.png	1970-01-01 00:00:00 +0000 differ