Implement aura::WindowPortMus::CreateCompositorFrameSink()

ui/aura/mus/window_port_mus.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/aura/mus/window_port_mus.h"
 
 #include "base/memory/ptr_util.h"
+#include "cc/output/context_provider.h"
 #include "ui/aura/client/aura_constants.h"
 #include "ui/aura/client/transient_window_client.h"
+#include "ui/aura/env.h"
 #include "ui/aura/mus/client_surface_embedder.h"
+#include "ui/aura/mus/mus_context_factory.h"
 #include "ui/aura/mus/property_converter.h"
 #include "ui/aura/mus/window_tree_client.h"
 #include "ui/aura/mus/window_tree_client_delegate.h"
 #include "ui/aura/window.h"
 #include "ui/aura/window_delegate.h"
 #include "ui/aura/window_observer.h"
 #include "ui/base/class_property.h"
 #include "ui/display/display.h"
 #include "ui/display/screen.h"
 
 namespace aura {
 
 namespace {
 // Helper function to get the device_scale_factor() of the display::Display
 // nearest to |window|.
 float ScaleFactorForDisplay(Window* window) {
   return display::Screen::GetScreen()
       ->GetDisplayNearestWindow(window)
       .device_scale_factor();
 }
+
+// TODO(mfomitchev, samans): Remove these stub classes once the SurfaceReference
+// work is complete.
+class StubSurfaceReferenceFactory : public cc::SurfaceReferenceFactory {
+ public:
+  StubSurfaceReferenceFactory() = default;
+
+  // cc::SurfaceReferenceFactory:
+  base::Closure CreateReference(
+      cc::SurfaceReferenceOwner* owner,
+      const cc::SurfaceId& surface_id) const override {
+    return base::Closure();
+  }
+
+ protected:
+  ~StubSurfaceReferenceFactory() override = default;
+
+  DISALLOW_COPY_AND_ASSIGN(StubSurfaceReferenceFactory);
+};
 }  // namespace
 
 WindowPortMus::WindowMusChangeDataImpl::WindowMusChangeDataImpl() = default;
 
 WindowPortMus::WindowMusChangeDataImpl::~WindowMusChangeDataImpl() = default;
 
 // static
 WindowMus* WindowMus::Get(Window* window) {
   return WindowPortMus::Get(window);
 }
 
 WindowPortMus::WindowPortMus(WindowTreeClient* client,
                              WindowMusType window_mus_type)
-    : WindowMus(window_mus_type), window_tree_client_(client) {}
+    : WindowMus(window_mus_type),
+      window_tree_client_(client),
+      weak_factory_(this) {}
 
 WindowPortMus::~WindowPortMus() {
   client_surface_embedder_.reset();
 
   // DESTROY is only scheduled from DestroyFromServer(), meaning if DESTROY is
   // present then the server originated the change.
   const WindowTreeClient::Origin origin =
       RemoveChangeByTypeAndData(ServerChangeType::DESTROY, ServerChangeData())
           ? WindowTreeClient::Origin::SERVER
           : WindowTreeClient::Origin::CLIENT;
@@ skipping 59 matching lines @@
 }
 
 void WindowPortMus::RequestCompositorFrameSinkInternal(
     scoped_refptr<cc::ContextProvider> context_provider,
     gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager,
     const CompositorFrameSinkCallback& callback) {
   DCHECK(frame_sink_id_.is_valid());
   std::unique_ptr<ui::ClientCompositorFrameSinkBinding>
       compositor_frame_sink_binding;
   std::unique_ptr<ui::ClientCompositorFrameSink> compositor_frame_sink =
-      ui::ClientCompositorFrameSink::Create(
-          frame_sink_id_, std::move(context_provider),
-          gpu_memory_buffer_manager, &compositor_frame_sink_binding);
+      ui::ClientCompositorFrameSink::Create(std::move(context_provider),
+                                            gpu_memory_buffer_manager,
+                                            &compositor_frame_sink_binding);
   AttachCompositorFrameSink(std::move(compositor_frame_sink_binding));
   callback.Run(std::move(compositor_frame_sink));
 }
 
 void WindowPortMus::AttachCompositorFrameSink(
     std::unique_ptr<ui::ClientCompositorFrameSinkBinding>
         compositor_frame_sink_binding) {
   window_tree_client_->AttachCompositorFrameSink(
       server_id(), compositor_frame_sink_binding->TakeFrameSinkRequest(),
       mojo::MakeProxy(compositor_frame_sink_binding->TakeFrameSinkClient()));
@@ skipping 177 matching lines @@
   // corresponding CompositorFrame or a deadline hits.
   if (window_tree_client_->enable_surface_synchronization_ &&
       frame_sink_id_.is_valid()) {
     UpdatePrimarySurfaceInfo();
   }
 
   return local_surface_id_;
 }
 
 void WindowPortMus::SetPrimarySurfaceInfo(const cc::SurfaceInfo& surface_info) {
+  bool embeds_surface = window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
+                        window_mus_type() == WindowMusType::EMBED_IN_OWNER;
   primary_surface_info_ = surface_info;
-  UpdateClientSurfaceEmbedder();
+  if (embeds_surface) {
+    UpdateClientSurfaceEmbedder();
+  } else {
+    if (!ref_factory_)

[Fady Samuel, 2017/05/16 10:26:41]

what calls this?

[Peng, 2017/05/16 10:55:24]

window_->layer()->SetShowPrimarySurface(surface_info, ref_factory_);

It needs a SurfaceReferenceFactory.

+      ref_factory_ = new StubSurfaceReferenceFactory();
+    window_->layer()->SetBounds(gfx::Rect(window_->layer()->bounds().origin(),
+                                          surface_info.size_in_pixels()));
+    window_->layer()->SetShowPrimarySurface(surface_info, ref_factory_);
+  }
   if (window_->delegate())
     window_->delegate()->OnWindowSurfaceChanged(surface_info);
 }
 
 void WindowPortMus::SetFallbackSurfaceInfo(
     const cc::SurfaceInfo& surface_info) {
   fallback_surface_info_ = surface_info;
   UpdateClientSurfaceEmbedder();
 }
 
@@ skipping 179 matching lines @@
   // TODO(sky): investigate to see if we need to compare data. In particular do
   // we ever have a case where changing a property cascades into changing the
   // same property?
   if (!RemoveChangeByTypeAndData(ServerChangeType::PROPERTY, change_data))
     window_tree_client_->OnWindowMusPropertyChanged(this, key, old_value,
                                                     std::move(data));
 }
 
 std::unique_ptr<cc::CompositorFrameSink>
 WindowPortMus::CreateCompositorFrameSink() {
-  // TODO(penghuang): Implement it for Mus.
-  return nullptr;
+  // We only allow creating a compositor frame sink for a local window.
+  if (window_mus_type() != WindowMusType::LOCAL)
+    return nullptr;
+
+  DCHECK(!frame_sink_id_.is_valid());
+  window_tree_client_->GetFrameSinkId(server_id());

[Fady Samuel, 2017/05/16 10:28:03]

Why do we need this?

[Peng, 2017/05/16 10:55:23]

Right now, WS doesn't send frame sink id to client for a local window. So this
CL addes a new mojo IPC GetFrameSinkId() to will request the WS send the frame
sink id to client via OnFrameSinkIdAllocated() method. And then the
WindowPortMus::SetFrameSinkIdFromServer() will be called, and then we can set
aura::Window's ui::Layer's Primary surface with the frame sink id and local
surface id.

+
+  ui::ContextFactory* context_factory =
+      aura::Env::GetInstance()->context_factory();
+  std::unique_ptr<ui::ClientCompositorFrameSinkBinding> frame_sink_binding;
+  std::unique_ptr<ui::ClientCompositorFrameSink> frame_sink =
+      ui::ClientCompositorFrameSink::Create(
+          nullptr /* context_provider */,
+          context_factory->GetGpuMemoryBufferManager(), &frame_sink_binding);
+  frame_sink->SetSurfaceChangedCallback(

[Fady Samuel, 2017/05/16 10:28:03]

What is the purpose of this callback?

[Peng, 2017/05/16 10:55:23]

The ClientCompositorFrameSink will generate new local surface id, when the frame
size is changed. So we need this callback for being notified for the new size
and local surface id.

+      base::Bind(&WindowPortMus::OnSurfaceChanged, weak_factory_.GetWeakPtr()));
+  AttachCompositorFrameSink(std::move(frame_sink_binding));
+  return std::move(frame_sink);
 }
 
 cc::SurfaceId WindowPortMus::GetSurfaceId() const {
-  // TODO(penghuang): Implement it for Mus.
+  // This method is only used by exo unittests which are not running against
+  // mus, so don't implement it now.
   return cc::SurfaceId();
 }
 
 void WindowPortMus::UpdatePrimarySurfaceInfo() {
   bool embeds_surface = window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
                         window_mus_type() == WindowMusType::EMBED_IN_OWNER;
-  if (!embeds_surface || !window_tree_client_->enable_surface_synchronization_)
+  if (embeds_surface && !window_tree_client_->enable_surface_synchronization_)
     return;
 
   if (!frame_sink_id_.is_valid() || !local_surface_id_.is_valid())
     return;
 
   SetPrimarySurfaceInfo(
       cc::SurfaceInfo(cc::SurfaceId(frame_sink_id_, local_surface_id_),
                       ScaleFactorForDisplay(window_), last_surface_size_));
 }
 
 void WindowPortMus::UpdateClientSurfaceEmbedder() {
   bool embeds_surface = window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
                         window_mus_type() == WindowMusType::EMBED_IN_OWNER;
   if (!embeds_surface)
     return;
 
   if (!client_surface_embedder_) {
     client_surface_embedder_ = base::MakeUnique<ClientSurfaceEmbedder>(
         window_, window_tree_client_->normal_client_area_insets_);
   }
 
   client_surface_embedder_->SetPrimarySurfaceInfo(primary_surface_info_);
   client_surface_embedder_->SetFallbackSurfaceInfo(fallback_surface_info_);
 }
 
+void WindowPortMus::OnSurfaceChanged(const cc::LocalSurfaceId& local_surface_id,

[Fady Samuel, 2017/05/16 10:26:42]

I'm confused about when this happens then...

[Peng, 2017/05/16 10:55:23]

See line 103 at
https://codereview.chromium.org/2875753002/diff/100001/services/ui/public/cpp...

+                                     const gfx::Size& surface_size) {
+  DCHECK_EQ(window_mus_type(), WindowMusType::LOCAL);
+  local_surface_id_ = local_surface_id;
+  last_surface_size_ = surface_size;
+  UpdatePrimarySurfaceInfo();
+}
+
 }  // namespace aura