Merge lp:~vanvugt/mir/resize-client-buffers into lp:mir

[Daniel van Vugt]

Add resize support to *ClientBuffer classes. Now always get dimensions from
the latest buffer package.

There are some comments about some "size" parameters now being unused. They will be eliminated in later proposals.

[Alan Griffiths (alan-griffiths)]

I'd like to see the unused parameters gone, but OK as an intermediate step.

review: Approve

[Kevin DuBois (kdub)]

good improvement after the resize protocol changes

review: Approve

[Daniel van Vugt (vanvugt)]

The unused "size" parameters... I started removing and found the resulting diff from that cleanup work to be much bigger that this proposal. And it's only this one that contains the useful functionality change.

=== modified file 'src/client/android/android_client_buffer_factory.cpp'
--- src/client/android/android_client_buffer_factory.cpp	2013-06-21 21:36:56 +0000
+++ src/client/android/android_client_buffer_factory.cpp	2013-11-13 10:28:01 +0000
@@ -31,6 +31,12 @@
 
 std::shared_ptr<mcl::ClientBuffer> mcla::AndroidClientBufferFactory::create_buffer(std::shared_ptr<MirBufferPackage> const& package, geom::Size size, geom::PixelFormat pf)
 {
+    (void)size; // TODO: remove this unused parameter
     auto handle = registrar->register_buffer(package);
-    return std::make_shared<mcla::AndroidClientBuffer>(registrar, handle, size, pf, geom::Stride{package->stride});
+    return std::make_shared<mcla::AndroidClientBuffer>(
+        registrar,
+        handle,
+        geometry::Size{package->width, package->height},
+        pf,
+        geometry::Stride{package->stride});
 }

=== modified file 'src/client/gbm/gbm_client_buffer_factory.cpp'
--- src/client/gbm/gbm_client_buffer_factory.cpp	2013-04-24 05:22:20 +0000
+++ src/client/gbm/gbm_client_buffer_factory.cpp	2013-11-13 10:28:01 +0000
@@ -31,5 +31,10 @@
 
 std::shared_ptr<mcl::ClientBuffer> mclg::GBMClientBufferFactory::create_buffer(std::shared_ptr<MirBufferPackage> const& package, geometry::Size size, geometry::PixelFormat pf)
 {
-    return std::make_shared<mclg::GBMClientBuffer>(drm_fd_handler, package, size, pf);
+    (void)size; // TODO: remove this unused parameter
+    return std::make_shared<mclg::GBMClientBuffer>(
+        drm_fd_handler,
+        package,
+        geometry::Size{package->width, package->height},
+        pf);
 }

=== modified file 'tests/integration-tests/client/test_client_render.cpp'
--- tests/integration-tests/client/test_client_render.cpp	2013-11-11 19:08:47 +0000
+++ tests/integration-tests/client/test_client_render.cpp	2013-11-13 10:28:01 +0000
@@ -213,6 +213,10 @@
         //note about the stride. Mir protocol sends stride in bytes, android uses stride in pixels
         response->mutable_buffer()->set_stride(client_buffer->stride().as_uint32_t());
 
+        auto const& size = client_buffer->size();
+        response->mutable_buffer()->set_width(size.width.as_int());
+        response->mutable_buffer()->set_height(size.height.as_int());
+
         response->mutable_buffer()->set_fds_on_side_channel(1);
         native_handle_t const* native_handle = buf->handle();
         for(auto i=0; i<native_handle->numFds; i++)
@@ -242,6 +246,11 @@
         response->set_fds_on_side_channel(1);
         native_handle_t const* native_handle = buf->handle();
         response->set_stride(client_buffer->stride().as_uint32_t());
+
+        auto const& size = client_buffer->size();
+        response->set_width(size.width.as_int());
+        response->set_height(size.height.as_int());
+
         for(auto i=0; i<native_handle->numFds; i++)
             response->add_fd(native_handle->data[i]);
         for(auto i=0; i<native_handle->numInts; i++)

=== modified file 'tests/unit-tests/client/gbm/test_gbm_client_buffer.cpp'
--- tests/unit-tests/client/gbm/test_gbm_client_buffer.cpp	2013-05-02 20:57:20 +0000
+++ tests/unit-tests/client/gbm/test_gbm_client_buffer.cpp	2013-11-13 10:28:01 +0000
@@ -18,6 +18,7 @@
 
 #include "mir_toolkit/mir_client_library.h"
 #include "src/client/gbm/gbm_client_buffer.h"
+#include "src/client/gbm/gbm_client_buffer_factory.h"
 #include "mock_drm_fd_handler.h"
 
 #include <xf86drm.h>
@@ -42,6 +43,9 @@
 
         package = std::make_shared<MirBufferPackage>();
         package->stride = stride.as_uint32_t();
+        package->width = width.as_int();
+        package->height = height.as_int();
+
         package_copy = std::make_shared<MirBufferPackage>(*package.get());
     }
     geom::Width width;
@@ -212,3 +216,20 @@
 
     mclg::GBMClientBuffer buffer(drm_fd_handler, package, size, pf);
 }
+
+TEST_F(MirGBMBufferTest, factory_gets_size_from_package)
+{
+    using namespace testing;
+
+    mclg::GBMClientBufferFactory factory(drm_fd_handler);
+
+    geom::Size unused_size{0, 0};
+    auto buffer = factory.create_buffer(package, unused_size, pf);
+
+    auto const& buf_size = buffer->size();
+    EXPECT_EQ(package->width, buf_size.width.as_int());
+    EXPECT_EQ(package->height, buf_size.height.as_int());
+
+    EXPECT_NE(unused_size, buf_size);
+}
+

=== modified file 'tests/unit-tests/client/test_android_client_buffer_factory.cpp'
--- tests/unit-tests/client/test_android_client_buffer_factory.cpp	2013-04-24 05:22:20 +0000
+++ tests/unit-tests/client/test_android_client_buffer_factory.cpp	2013-11-13 10:28:01 +0000
@@ -39,9 +39,10 @@
         pf = geom::PixelFormat::abgr_8888;
 
         mock_registrar = std::make_shared<mtd::MockAndroidRegistrar>();
+
         package1 = std::make_shared<MirBufferPackage>();
-        package2 = std::make_shared<MirBufferPackage>();
-
+        package1->width = width.as_int();
+        package1->height = height.as_int();
     }
     geom::Width width;
     geom::Height height;
@@ -51,7 +52,6 @@
     std::shared_ptr<mtd::MockAndroidRegistrar> mock_registrar;
 
     std::shared_ptr<MirBufferPackage> package1;
-    std::shared_ptr<MirBufferPackage> package2;
 
 };
 
@@ -68,7 +68,7 @@
 
     auto buffer = buffer_factory.create_buffer(package1, size, pf);
 
-    EXPECT_EQ(buffer->size().height, height);
-    EXPECT_EQ(buffer->size().width, width);
+    EXPECT_EQ(package1->width, buffer->size().width.as_int());
+    EXPECT_EQ(package1->height, buffer->size().height.as_int());
     EXPECT_EQ(buffer->pixel_format(), pf);
 }

=== modified file 'tests/unit-tests/client/test_client_mir_surface.cpp'
--- tests/unit-tests/client/test_client_mir_surface.cpp	2013-10-24 14:22:27 +0000
+++ tests/unit-tests/client/test_client_mir_surface.cpp	2013-11-13 10:28:01 +0000
@@ -148,6 +148,8 @@
         }
 
         response->set_stride(server_package.stride);
+        response->set_width(server_package.width);
+        response->set_height(server_package.height);
     }
 
     void create_surface_response(mir::protobuf::Surface* response)