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 "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/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"
@@ skipping 246 matching lines @@
 void WindowPortMus::SetFrameSinkIdFromServer(
     const cc::FrameSinkId& frame_sink_id) {
   DCHECK(window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
          window_mus_type() == WindowMusType::EMBED_IN_OWNER);
   frame_sink_id_ = frame_sink_id;
   UpdatePrimarySurfaceInfo();
 }
 
 const cc::LocalSurfaceId& WindowPortMus::GetOrAllocateLocalSurfaceId(
     const gfx::Size& surface_size) {
+  if (window_mus_type() == WindowMusType::LOCAL &&
+      !frame_sink_for_local_window_.get()) {
+    local_surface_id_ = cc::LocalSurfaceId();
+    return local_surface_id_;

[Fady Samuel, 2017/06/07 17:36:27]

Do we need this change?

[Peng, 2017/06/07 19:30:29]

We don't want to generate local surface id, if a local window doesn't have
associated CFS. So WindowTreeClient::ScheduleInFlightBoundsChange() will not
send a unused local surface id to WS and not set
synchronizing_with_child_on_next_frame_ to true.

+  }
+
   if (last_surface_size_ == surface_size && local_surface_id_.is_valid())
     return local_surface_id_;
 
   local_surface_id_ = local_surface_id_allocator_.GenerateId();
   last_surface_size_ = surface_size;
 
   // If the FrameSinkId is available, then immediately embed the SurfaceId.
   // The newly generated frame by the embedder will block in the display
   // compositor until the child submits a corresponding CompositorFrame or a
   // deadline hits.
   if (frame_sink_id_.is_valid())
     UpdatePrimarySurfaceInfo();
 
+  if (frame_sink_for_local_window_)
+    frame_sink_for_local_window_->SetLocalSurfaceId(local_surface_id_);

[Fady Samuel, 2017/06/07 17:36:27]

Just call this compositor_frame_sink_. No point in mentioning this is for local
windows. Let's always keep a weak ptr for consistency?

[Peng, 2017/06/07 19:30:29]

Done.

+
   return local_surface_id_;
 }
 
-void WindowPortMus::SetPrimarySurfaceInfo(const cc::SurfaceInfo& surface_info) {
-  primary_surface_info_ = surface_info;
-  UpdateClientSurfaceEmbedder();
-  if (window_->delegate())
-    window_->delegate()->OnWindowSurfaceChanged(surface_info);
-}
+void WindowPortMus::SetSurfaceInfoFromServer(
+    const cc::SurfaceInfo& surface_info) {
+  if (!frame_sink_id_.is_valid()) {
+    // This only happens for a "local" window, because the
+    // |SetFrameSinkIdFromServer| will not be called for a "local" window.
+    DCHECK_EQ(window_mus_type(), WindowMusType::LOCAL);
+    // |primary_surface_info_| shold not be valid, since we didn't know the
+    // |frame_sink_id_|.
+    DCHECK(!primary_surface_info_.is_valid());
+    frame_sink_id_ = surface_info.id().frame_sink_id();
+    UpdatePrimarySurfaceInfo();

[Fady Samuel, 2017/06/07 17:36:27]

Do we need this change?

[Peng, 2017/06/07 19:30:29]

Yes. Because we don't know frame sink id for a local window. We only can get the
frame sink id here. And we like to call UpdatePrimarySurfaceInfo
here, becasue the CFS may already generate a frame.

+  }
 
-void WindowPortMus::SetFallbackSurfaceInfo(
-    const cc::SurfaceInfo& surface_info) {
+  // The frame sink id should never be changed.
+  DCHECK_EQ(surface_info.id().frame_sink_id(), frame_sink_id_);
+
+  // If the window is informed of a surface from server then that surface ID is
+  // guaranteed to be available in the display compositor so we set it as the
+  // fallback. For embedded window, the primary SurfaceInfo is created by the
+  // embedder, and the LocalSurfaceId is allocated by the embedder.
   fallback_surface_info_ = surface_info;
   UpdateClientSurfaceEmbedder();
 }
 
 void WindowPortMus::DestroyFromServer() {
   std::unique_ptr<ScopedServerChange> remove_from_parent_change;
   if (window_->parent()) {
     ServerChangeData data;
     data.child_id = server_id();
     WindowPortMus* parent = Get(window_->parent());
@@ skipping 173 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;
+  DCHECK_EQ(window_mus_type(), WindowMusType::LOCAL);

[Fady Samuel, 2017/06/07 17:36:26]

Can we just have a single code path? Let's not special case local windows.

[Peng, 2017/06/07 19:30:29]

We need make sure this function is used on a embedded window in embeddor.

+  DCHECK(!frame_sink_for_local_window_);
+  auto frame_sink = RequestCompositorFrameSink(
+      nullptr,
+      aura::Env::GetInstance()->context_factory()->GetGpuMemoryBufferManager());
+  auto* viz_frame_sink =
+      static_cast<viz::ClientCompositorFrameSink*>(frame_sink.get());
+  frame_sink_for_local_window_ = viz_frame_sink->GetWeakPtr();
+  return 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.

[Fady Samuel, 2017/06/07 17:36:27]

Just say this is only used by WindowPortLocal in unit tests.

[Peng, 2017/06/07 19:30:29]

Done.

   return cc::SurfaceId();
 }
 
 void WindowPortMus::UpdatePrimarySurfaceInfo() {
-  bool embeds_surface =
-      window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
-      window_mus_type() == WindowMusType::EMBED_IN_OWNER ||
-      window_mus_type() == WindowMusType::DISPLAY_MANUALLY_CREATED;
-  if (!embeds_surface)
+  if (window_mus_type() != WindowMusType::TOP_LEVEL_IN_WM &&
+      window_mus_type() != WindowMusType::EMBED_IN_OWNER &&
+      window_mus_type() != WindowMusType::DISPLAY_MANUALLY_CREATED &&
+      window_mus_type() != WindowMusType::LOCAL)
     return;
 
   if (!frame_sink_id_.is_valid() || !local_surface_id_.is_valid())
     return;
 
-  SetPrimarySurfaceInfo(
+  primary_surface_info_ =
       cc::SurfaceInfo(cc::SurfaceId(frame_sink_id_, local_surface_id_),
-                      ScaleFactorForDisplay(window_), last_surface_size_));
+                      ScaleFactorForDisplay(window_), last_surface_size_);
+  UpdateClientSurfaceEmbedder();
+  if (window_->delegate())
+    window_->delegate()->OnWindowSurfaceChanged(primary_surface_info_);
 }
 
 void WindowPortMus::UpdateClientSurfaceEmbedder() {
-  bool embeds_surface =
-      window_mus_type() == WindowMusType::TOP_LEVEL_IN_WM ||
-      window_mus_type() == WindowMusType::EMBED_IN_OWNER ||
-      window_mus_type() == WindowMusType::DISPLAY_MANUALLY_CREATED;
-  if (!embeds_surface)
+  if (window_mus_type() != WindowMusType::TOP_LEVEL_IN_WM &&
+      window_mus_type() != WindowMusType::EMBED_IN_OWNER &&
+      window_mus_type() != WindowMusType::DISPLAY_MANUALLY_CREATED &&
+      window_mus_type() != WindowMusType::LOCAL)
     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_);
 }
 
 }  // namespace aura