Merge lp:~kdub/mir/detect-demo-decorations into lp:mir

[Kevin DuBois]

demo shell: detect when decorations for the windows are on screen. When a decoration that can't be represented in the optimized abstraction needs to be painted, render using opengl. This makes the --disable-overlays false option on android not look so bad.

demo shell: detect when decorations for the windows are on screen. When a decoration that can't be represented in the optimized abstraction needs to be painted, render using opengl. This makes the --disable-overlays false option on android not look so bad. More work is still needed to detect when only the grey background is visible before the demo shell looks good when android is transitioning back and forth from gl to overlay. (and change the default to overlay on by default)

Note how the demo compositor code is not thinking about what sort of hardware optimization would go on, only if it could represent what it wants to paint as a RenderableList. On the mesa platform, an exactly fullscreen client would be bypassed. On android, a fullscreen client and larger would be optimized as an overlay.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1699
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/2194/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1001
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1007
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/996/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/716/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/717/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/3378/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/2194/rebuild

review: Needs Fixing (continuous-integration)

[Daniel van Vugt (vanvugt)]

The prereq branch is blocked and I think should not land. So this needs to not depend on it.

Also, more generally we should not treat decorations alone. Doing free-form GL rendering outside of surface rectangles encompasses much more than decorations. For example, resize highlights, FPS overlays and other temporary effect/animation rendering.

The alternate solution we're also working toward is for *everything* to be in the scene graph. When that happens, detection of what's on screen is a graph traversal exercise.

So,
  (1) Resubmit to not depend on the parent branch.
  (2) Don't treat decorations as the special case, but rather any free-form rendering needs to be detected (or just flagged as a bool somewhere).
  (3) Consider continuing on the road toward "everything's in the scene graph" so it can just be done as a graph traversal.

review: Needs Resubmitting

[Kevin DuBois (kdub)]

The depends-on-branch was close to landing, so I just wanted to pipeline this on Friday. Seeing as that branch was blocked, no point reviewing this until the base branch's block is resolved.

Unmerged revisions

1699. By Kevin DuBois on 2014-07-18

make a type richer

1698. By Kevin DuBois on 2014-07-18

remerge in fix base branch, because bzr cant tfigure out the history here apparently

1697. By Kevin DuBois on 2014-07-18

merge devel

1696. By Kevin DuBois on 2014-07-18

test to pass

1695. By Kevin DuBois on 2014-07-18

work through some problems to see the test fail

1694. By Kevin DuBois on 2014-07-18

make it possible to statically link the test binary to the demo shell code

1693. By Kevin DuBois on 2014-07-18

add test that checks the demo shell compositor

=== modified file 'examples/demo-shell/CMakeLists.txt'
--- examples/demo-shell/CMakeLists.txt	2014-07-18 20:30:29 +0000
+++ examples/demo-shell/CMakeLists.txt	2014-07-18 20:30:30 +0000
@@ -1,5 +1,4 @@
-add_executable(mir_demo_server_shell
-  demo_shell.cpp
+add_library(mirdemoshell STATIC
   demo_compositor.cpp
   demo_renderer.cpp
   fullscreen_placement_strategy.cpp
@@ -7,7 +6,12 @@
   ../server_configuration.cpp
 )
 
+add_executable(mir_demo_server_shell
+  demo_shell.cpp
+)
+
 target_link_libraries(mir_demo_server_shell
+  mirdemoshell
   mirserver
   mirdraw
 )

=== modified file 'examples/demo-shell/demo_compositor.cpp'
--- examples/demo-shell/demo_compositor.cpp	2014-07-18 20:30:29 +0000
+++ examples/demo-shell/demo_compositor.cpp	2014-07-18 20:30:30 +0000
@@ -35,24 +35,53 @@
 {
     return db.uses_alpha() ? mc::DestinationAlpha::generate_from_source : mc::DestinationAlpha::opaque;
 }
+
+bool decorations_need_painting(
+    mg::RenderableList const& list,
+    geom::Rectangle const& area,
+    int shadow_radius, geom::Height const& titlebar_height)
+{
+    for(auto const& renderable : list)
+    {
+        auto const& pos = renderable->screen_position(); 
+        geom::Rectangle titlebar_rect{
+            {pos.top_left.x.as_int(), pos.top_left.y.as_int() - titlebar_height.as_int()},
+            {pos.size.width, titlebar_height}};
+        geom::Rectangle right_shadow_rect{
+            pos.top_right(),
+            {geom::Width{shadow_radius}, geom::Height{pos.size.height.as_int() + shadow_radius}}};
+        geom::Rectangle bottom_shadow_rect{
+            pos.bottom_left(),
+            {pos.size.width, geom::Height{shadow_radius}}};
+
+        if (titlebar_rect.intersection_with(area) != geom::Rectangle{} ||
+            right_shadow_rect.intersection_with(area) != geom::Rectangle{} ||
+            bottom_shadow_rect.intersection_with(area) != geom::Rectangle{})
+        return true;
+    }
+    return false;
+}
+
 }
 
 me::DemoCompositor::DemoCompositor(
     mg::DisplayBuffer& display_buffer,
     std::shared_ptr<mc::Scene> const& scene,
     mg::GLProgramFactory const& factory,
-    std::shared_ptr<mc::CompositorReport> const& report) :
+    std::shared_ptr<mc::CompositorReport> const& report,
+    int shadow_radius,
+    geom::Height titlebar_height) :
     display_buffer(display_buffer),
     scene(scene),
     report(report),
-    shadow_radius(80),
-    titlebar_height(30),
+    shadow_radius(shadow_radius),
+    titlebar_height(titlebar_height),
     renderer(
         factory,
         display_buffer.view_area(),
         destination_alpha(display_buffer),
         static_cast<float>(shadow_radius),
-        static_cast<float>(titlebar_height)) 
+        titlebar_height.as_float()) 
 {
 }
 
@@ -60,7 +89,8 @@
 {
     mg::RenderableList renderable_list;
     auto elements = scene->scene_elements_for(this);
-    auto occluded = me::filter_occlusions_from(elements, display_buffer.view_area(), shadow_radius, titlebar_height);
+    auto occluded = me::filter_occlusions_from(
+        elements, display_buffer.view_area(), shadow_radius, titlebar_height.as_int());
     for(auto const& it : elements)
     {
         renderable_list.push_back(it->renderable());
@@ -77,7 +107,9 @@
     report->began_frame(this);
 
     auto renderable_list = generate_renderables();
-    if (display_buffer.post_renderables_if_optimizable(renderable_list))
+    if (!decorations_need_painting(
+            renderable_list, display_buffer.view_area(), shadow_radius, titlebar_height) && 
+        (display_buffer.post_renderables_if_optimizable(renderable_list)))
     {
         renderer.suspend();
         report->finished_frame(true, this);

=== modified file 'examples/demo-shell/demo_compositor.h'
--- examples/demo-shell/demo_compositor.h	2014-07-18 20:30:29 +0000
+++ examples/demo-shell/demo_compositor.h	2014-07-18 20:30:30 +0000
@@ -19,6 +19,7 @@
 #ifndef MIR_EXAMPLES_DEMO_COMPOSITOR_H_
 #define MIR_EXAMPLES_DEMO_COMPOSITOR_H_
 
+#include "mir/geometry/dimensions.h"
 #include "mir/compositor/display_buffer_compositor.h"
 #include "mir/compositor/scene.h"
 #include "mir/graphics/renderable.h"
@@ -45,7 +46,9 @@
         graphics::DisplayBuffer& display_buffer,
         std::shared_ptr<compositor::Scene> const& scene,
         graphics::GLProgramFactory const& factory,
-        std::shared_ptr<compositor::CompositorReport> const& report);
+        std::shared_ptr<compositor::CompositorReport> const& report,
+        int shadow_radius,
+        geometry::Height titlebar_height);
 
     void composite() override;
 
@@ -55,7 +58,7 @@
     std::shared_ptr<compositor::Scene> const scene;
     std::shared_ptr<compositor::CompositorReport> const report;
     int const shadow_radius;
-    int const titlebar_height;
+    geometry::Height const titlebar_height;
     DemoRenderer renderer;
 };
 

=== modified file 'examples/demo-shell/demo_shell.cpp'
--- examples/demo-shell/demo_shell.cpp	2014-07-18 20:30:29 +0000
+++ examples/demo-shell/demo_shell.cpp	2014-07-18 20:30:30 +0000
@@ -66,7 +66,7 @@
         mg::DisplayBuffer& display_buffer) override
     {
         return std::unique_ptr<mc::DisplayBufferCompositor>(
-            new me::DemoCompositor{display_buffer, scene, *gl_program_factory, report});
+            new me::DemoCompositor{display_buffer, scene, *gl_program_factory, report, 80, geometry::Height{30}});
     }
 
 private:

=== modified file 'include/test/mir_test_doubles/mock_display_buffer.h'
--- include/test/mir_test_doubles/mock_display_buffer.h	2014-06-05 20:35:46 +0000
+++ include/test/mir_test_doubles/mock_display_buffer.h	2014-07-18 20:30:30 +0000
@@ -38,6 +38,8 @@
         using namespace testing;
         ON_CALL(*this, view_area())
             .WillByDefault(Return(geometry::Rectangle{{0,0},{0,0}}));
+        ON_CALL(*this, orientation())
+            .WillByDefault(Return(mir_orientation_normal));
     }
     MOCK_CONST_METHOD0(view_area, geometry::Rectangle());
     MOCK_METHOD0(make_current, void());

=== modified file 'include/test/mir_test_doubles/mock_gl.h'
--- include/test/mir_test_doubles/mock_gl.h	2014-06-18 12:50:31 +0000
+++ include/test/mir_test_doubles/mock_gl.h	2014-07-18 20:30:30 +0000
@@ -105,6 +105,7 @@
                  void(GLuint, GLint, GLenum, GLboolean, GLsizei,
                       const GLvoid *));
     MOCK_METHOD4(glViewport, void(GLint, GLint, GLsizei, GLsizei));
+    MOCK_METHOD1(glGenerateMipmap, void(GLenum));
 };
 
 }

=== modified file 'tests/mir_test_doubles/mock_gl.cpp'
--- tests/mir_test_doubles/mock_gl.cpp	2014-06-18 12:50:31 +0000
+++ tests/mir_test_doubles/mock_gl.cpp	2014-07-18 20:30:30 +0000
@@ -415,3 +415,9 @@
     CHECK_GLOBAL_VOID_MOCK();
     global_mock_gl->glFinish();
 }
+
+void glGenerateMipmap(GLenum target)
+{
+    CHECK_GLOBAL_VOID_MOCK();
+    global_mock_gl->glGenerateMipmap(target);
+}

=== modified file 'tests/unit-tests/CMakeLists.txt'
--- tests/unit-tests/CMakeLists.txt	2014-07-11 21:53:44 +0000
+++ tests/unit-tests/CMakeLists.txt	2014-07-18 20:30:30 +0000
@@ -34,6 +34,7 @@
 add_subdirectory(android_input/)
 add_subdirectory(scene/)
 add_subdirectory(draw/)
+add_subdirectory(examples/)
 
 link_directories(${LIBRARY_OUTPUT_PATH})
 
@@ -50,6 +51,7 @@
   mirdraw
   mirtestdraw
   mirlogging
+  mirdemoshell
 
   mir-test
   mir-test-doubles

=== added directory 'tests/unit-tests/examples'
=== added file 'tests/unit-tests/examples/CMakeLists.txt'
--- tests/unit-tests/examples/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/examples/CMakeLists.txt	2014-07-18 20:30:30 +0000
@@ -0,0 +1,5 @@
+list(APPEND UNIT_TEST_SOURCES
+  ${CMAKE_CURRENT_SOURCE_DIR}/test_demo_compositor.cpp
+)
+
+set(UNIT_TEST_SOURCES ${UNIT_TEST_SOURCES} PARENT_SCOPE)

=== added file 'tests/unit-tests/examples/test_demo_compositor.cpp'
--- tests/unit-tests/examples/test_demo_compositor.cpp	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/examples/test_demo_compositor.cpp	2014-07-18 20:30:30 +0000
@@ -0,0 +1,108 @@
+/*
+ * Copyright © 2014 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
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kevin DuBois <[e-mail]>
+ */
+
+#include "examples/demo-shell/demo_compositor.h"
+#include "src/server/report/null_report_factory.h"
+#include "mir_test_doubles/mock_display_buffer.h"
+#include "mir_test_doubles/stub_gl_program_factory.h"
+#include "mir_test_doubles/mock_scene.h"
+#include "mir_test_doubles/stub_scene_element.h"
+#include "mir_test_doubles/stub_renderable.h"
+#include "mir_test_doubles/mock_gl.h"
+#include "mir_test/fake_shared.h"
+#include <gtest/gtest.h>
+
+namespace me = mir::examples;
+namespace mc = mir::compositor;
+namespace mt = mir::test;
+namespace mr = mir::report;
+namespace mtd = mir::test::doubles;
+namespace mg = mir::graphics;
+namespace geom = mir::geometry;
+
+struct DemoCompositor : public testing::Test
+{
+    DemoCompositor() :
+        display_area{{10, 10}, {100,100}},
+        titlebar_height{5},
+        shadow_radius{3},
+        stub_report{mr::null_compositor_report()},
+        fullscreen{std::make_shared<mtd::StubSceneElement>(
+            std::make_shared<mtd::StubRenderable>(display_area))},
+        onscreen_titlebar{std::make_shared<mtd::StubSceneElement>(
+            std::make_shared<mtd::StubRenderable>(geom::Rectangle{{90,90},{10,10}}))},
+        onscreen_shadows{std::make_shared<mtd::StubSceneElement>(
+            std::make_shared<mtd::StubRenderable>(geom::Rectangle{{10,10},{10,10}}))},
+        onscreen_shadows_and_titlebar{std::make_shared<mtd::StubSceneElement>(
+            std::make_shared<mtd::StubRenderable>(geom::Rectangle{{10,14},{10,82}}))}
+    {
+        using namespace testing;
+        ON_CALL(mock_display_buffer, view_area())
+            .WillByDefault(Return(display_area));
+    }
+
+    geom::Rectangle const display_area;
+    geom::Height const titlebar_height;
+    unsigned int const shadow_radius;
+    std::shared_ptr<mc::CompositorReport> const stub_report;
+    std::shared_ptr<mc::SceneElement> const fullscreen;
+    std::shared_ptr<mc::SceneElement> const onscreen_titlebar;
+    std::shared_ptr<mc::SceneElement> const onscreen_shadows;
+    std::shared_ptr<mc::SceneElement> const onscreen_shadows_and_titlebar;
+
+    testing::NiceMock<mtd::MockDisplayBuffer> mock_display_buffer;
+    mtd::MockScene mock_scene;
+    mtd::StubGLProgramFactory stub_program_factory;
+    testing::NiceMock<mtd::MockGL> mock_gl;
+};
+
+TEST_F(DemoCompositor, does_not_use_optimized_path_if_titlebar_needs_to_be_drawn)
+{
+    using namespace testing;
+    EXPECT_CALL(mock_scene, scene_elements_for(_))
+        .WillOnce(Return(mc::SceneElementSequence{onscreen_titlebar}))
+        .WillOnce(Return(mc::SceneElementSequence{onscreen_shadows}))
+        .WillOnce(Return(mc::SceneElementSequence{onscreen_shadows_and_titlebar}));
+    EXPECT_CALL(mock_display_buffer, post_renderables_if_optimizable(_))
+        .Times(0);
+    EXPECT_CALL(mock_display_buffer, post_update())
+        .Times(3);
+
+    me::DemoCompositor demo_compositor(
+        mock_display_buffer, mt::fake_shared(mock_scene), stub_program_factory,
+        stub_report, shadow_radius, titlebar_height);
+    demo_compositor.composite();
+    demo_compositor.composite();
+    demo_compositor.composite();
+}
+
+TEST_F(DemoCompositor, uses_optimized_path_if_no_decorations_present)
+{
+    using namespace testing;
+    EXPECT_CALL(mock_scene, scene_elements_for(_))
+        .WillOnce(Return(mc::SceneElementSequence{fullscreen}))
+        .WillOnce(Return(mc::SceneElementSequence{onscreen_shadows_and_titlebar, fullscreen}));
+    EXPECT_CALL(mock_display_buffer, post_renderables_if_optimizable(_))
+        .Times(2);
+
+    me::DemoCompositor demo_compositor(
+        mock_display_buffer, mt::fake_shared(mock_scene), stub_program_factory,
+        stub_report, shadow_radius, titlebar_height);
+    demo_compositor.composite();
+    demo_compositor.composite();
+}