Merge lp:~kdub/mir/consumer-usage-bits into lp:mir

[Kevin DuBois]

android: support the NATIVE_WINDOW_CONSUMER_USAGE_BITS query. We recently encountered a device that made use of this query.

android: support the NATIVE_WINDOW_CONSUMER_USAGE_BITS query. We recently encountered a device that made use of this query.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:2902
http://jenkins.qa.ubuntu.com/job/mir-ci/4778/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/3800/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/mir-clang-ts-vivid-amd64-build/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/2710
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/3749/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/927
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/927/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3749
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3749/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/6481/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/23000

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/4778/rebuild

review: Needs Fixing (continuous-integration)

[Daniel van Vugt (vanvugt)]

Cool.

Just a note the code would be slightly easier to follow and potentially more efficient without using these:
  + unsigned int const hardware_bits;
  + unsigned int const software_bits;
Although the optimizer will make it the same, it's still easier to read if you don't have to look elsewhere to see what flags are set.

review: Approve

[Daniel van Vugt (vanvugt)]

Another side note: If you find yourself writing simple tests that essentially just replicate the implementation I believe it's better to not have those tests at all. They don't provide value because the implementer (or maintainer who might be changing things) is equally likely to break the test in the same way as the implementation. Because they believe the implementation is right and so just keep the test in sync with the implementation. So such tests provide no benefit.

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

=== modified file 'src/platforms/android/client/egl_native_surface_interpreter.cpp'
--- src/platforms/android/client/egl_native_surface_interpreter.cpp	2015-06-18 14:33:10 +0000
+++ src/platforms/android/client/egl_native_surface_interpreter.cpp	2015-09-02 12:23:57 +0000
@@ -21,6 +21,7 @@
 #include "mir/frontend/client_constants.h"
 #include "mir/client_buffer.h"
 #include <system/window.h>
+#include <hardware/gralloc.h>
 #include <stdexcept>
 
 namespace mcla=mir::client::android;
@@ -29,8 +30,11 @@
 mcla::EGLNativeSurfaceInterpreter::EGLNativeSurfaceInterpreter(EGLNativeSurface& surface)
  :  surface(surface),
     driver_pixel_format(-1),
-    sync_ops(std::make_shared<mga::RealSyncFileOps>())
-
+    sync_ops(std::make_shared<mga::RealSyncFileOps>()),
+    hardware_bits( GRALLOC_USAGE_HW_TEXTURE | GRALLOC_USAGE_HW_RENDER ),
+    software_bits(
+        GRALLOC_USAGE_SW_WRITE_OFTEN | GRALLOC_USAGE_SW_READ_OFTEN |
+        GRALLOC_USAGE_HW_COMPOSER | GRALLOC_USAGE_HW_TEXTURE )
 {
 }
 
@@ -76,6 +80,11 @@
             return 2;
         case NATIVE_WINDOW_CONCRETE_TYPE:
             return NATIVE_WINDOW_SURFACE;
+        case NATIVE_WINDOW_CONSUMER_USAGE_BITS:
+            if (surface.get_parameters().buffer_usage ==  mir_buffer_usage_hardware)
+                return hardware_bits;
+            else
+                return software_bits;
         default:
             throw std::runtime_error("driver requested unsupported query");
     }

=== modified file 'src/platforms/android/client/egl_native_surface_interpreter.h'
--- src/platforms/android/client/egl_native_surface_interpreter.h	2015-06-17 05:20:42 +0000
+++ src/platforms/android/client/egl_native_surface_interpreter.h	2015-09-02 12:23:57 +0000
@@ -52,6 +52,8 @@
     EGLNativeSurface& surface;
     int driver_pixel_format;
     std::shared_ptr<graphics::android::SyncFileOps> const sync_ops;
+    unsigned int const hardware_bits;
+    unsigned int const software_bits;
 };
 
 }

=== modified file 'src/platforms/android/server/server_render_window.cpp'
--- src/platforms/android/server/server_render_window.cpp	2015-07-21 04:30:03 +0000
+++ src/platforms/android/server/server_render_window.cpp	2015-09-02 12:23:57 +0000
@@ -84,6 +84,8 @@
             return 1;
         case NATIVE_WINDOW_CONCRETE_TYPE:
             return NATIVE_WINDOW_FRAMEBUFFER;
+        case NATIVE_WINDOW_CONSUMER_USAGE_BITS:
+            return GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_COMPOSER | GRALLOC_USAGE_HW_FB;
         default:
             {
             std::stringstream sstream;

=== modified file 'tests/unit-tests/client/android/test_egl_native_surface_interpreter.cpp'
--- tests/unit-tests/client/android/test_egl_native_surface_interpreter.cpp	2015-06-25 03:00:08 +0000
+++ tests/unit-tests/client/android/test_egl_native_surface_interpreter.cpp	2015-09-02 12:23:57 +0000
@@ -25,6 +25,7 @@
 #include "mir/test/doubles/stub_android_native_buffer.h"
 #include "mir/test/fake_shared.h"
 #include <system/window.h>
+#include <hardware/gralloc.h>
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>
 
@@ -267,3 +268,25 @@
     mcla::EGLNativeSurfaceInterpreter interpreter(mock_surface);
     interpreter.dispatch_driver_request_buffer_count(new_size); 
 }
+
+TEST_F(AndroidInterpreter, returns_proper_usage_bits_based_on_surface)
+{
+    using namespace testing;
+    MirSurfaceParameters const software = { "", 1, 2, mir_pixel_format_abgr_8888, mir_buffer_usage_software, 0 };
+    MirSurfaceParameters const hardware = { "", 1, 2, mir_pixel_format_abgr_8888, mir_buffer_usage_hardware, 0 };
+
+    testing::NiceMock<MockMirSurface> mock_surface{surf_params};
+    mcla::EGLNativeSurfaceInterpreter interpreter(mock_surface);
+
+    EXPECT_CALL(mock_surface, get_parameters())
+        .Times(2)
+        .WillOnce(Return(software))
+        .WillOnce(Return(hardware));
+
+    auto const hardware_bits = GRALLOC_USAGE_HW_TEXTURE | GRALLOC_USAGE_HW_RENDER;
+    auto const software_bits =
+        GRALLOC_USAGE_SW_WRITE_OFTEN | GRALLOC_USAGE_SW_READ_OFTEN |
+        GRALLOC_USAGE_HW_COMPOSER | GRALLOC_USAGE_HW_TEXTURE;
+    EXPECT_THAT(interpreter.driver_requests_info(NATIVE_WINDOW_CONSUMER_USAGE_BITS), Eq(software_bits));
+    EXPECT_THAT(interpreter.driver_requests_info(NATIVE_WINDOW_CONSUMER_USAGE_BITS), Eq(hardware_bits));
+}

=== modified file 'tests/unit-tests/graphics/android/test_server_interpreter.cpp'
--- tests/unit-tests/graphics/android/test_server_interpreter.cpp	2015-06-25 03:00:08 +0000
+++ tests/unit-tests/graphics/android/test_server_interpreter.cpp	2015-09-02 12:23:57 +0000
@@ -26,6 +26,7 @@
 #include "mir/test/fake_shared.h"
 #include "mir/test/doubles/mock_android_native_buffer.h"
 #include "mir_toolkit/common.h"
+#include <hardware/gralloc.h>
 #include <gtest/gtest.h>
 #include <gmock/gmock.h>
 #include <stdexcept>
@@ -96,6 +97,13 @@
     EXPECT_EQ(HAL_PIXEL_FORMAT_RGBA_8888, render_window.driver_requests_info(NATIVE_WINDOW_FORMAT));
 }
 
+TEST_F(ServerRenderWindow, returns_usage_bits_for_fb)
+{
+    using namespace testing;
+    auto bits = GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_COMPOSER | GRALLOC_USAGE_HW_FB;
+    EXPECT_THAT(render_window.driver_requests_info(NATIVE_WINDOW_CONSUMER_USAGE_BITS), Eq(bits));
+}
+
 TEST_F(ServerRenderWindow, returns_different_format_if_format_changes)
 {
     render_window.dispatch_driver_request_format(HAL_PIXEL_FORMAT_RGBX_8888);