TestCompositorFrameSink should use CompositorFrameSinkSupport

cc/test/test_compositor_frame_sink.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 "cc/test/test_compositor_frame_sink.h"
 
 #include <stdint.h>
 #include <utility>
 
 #include "base/memory/ptr_util.h"
 #include "cc/output/begin_frame_args.h"
 #include "cc/output/compositor_frame_sink_client.h"
 #include "cc/output/copy_output_request.h"
 #include "cc/output/direct_renderer.h"
 #include "cc/output/output_surface.h"
 #include "cc/output/texture_mailbox_deleter.h"
+#include "cc/surfaces/compositor_frame_sink_support.h"
 
 namespace cc {
 
 static constexpr FrameSinkId kCompositorFrameSinkId(1, 1);
 
 TestCompositorFrameSink::TestCompositorFrameSink(
     scoped_refptr<ContextProvider> compositor_context_provider,
     scoped_refptr<ContextProvider> worker_context_provider,
     SharedBitmapManager* shared_bitmap_manager,
     gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager,
     const RendererSettings& renderer_settings,
     scoped_refptr<base::SingleThreadTaskRunner> task_runner,
     bool synchronous_composite,
     bool force_disable_reclaim_resources)
     : CompositorFrameSink(std::move(compositor_context_provider),
                           std::move(worker_context_provider),
                           gpu_memory_buffer_manager,
                           shared_bitmap_manager),
       synchronous_composite_(synchronous_composite),
       renderer_settings_(renderer_settings),
       task_runner_(std::move(task_runner)),
       frame_sink_id_(kCompositorFrameSinkId),
       surface_manager_(new SurfaceManager),
       local_surface_id_allocator_(new LocalSurfaceIdAllocator()),
-      surface_factory_(
-          new SurfaceFactory(frame_sink_id_, surface_manager_.get(), this)),
+      external_begin_frame_source_(this),
       weak_ptr_factory_(this) {
   // Since this CompositorFrameSink and the Display are tightly coupled and in
   // the same process/thread, the LayerTreeHostImpl can reclaim resources from
   // the Display. But we allow tests to disable this to mimic an out-of-process
   // Display.
   capabilities_.can_force_reclaim_resources = !force_disable_reclaim_resources;
   // Always use sync tokens so that code paths in resource provider that deal
   // with sync tokens are tested.
   capabilities_.delegated_sync_points_required = true;
 }
@@ skipping 38 matching lines @@
                   renderer_settings_, frame_sink_id_, begin_frame_source_.get(),
                   std::move(display_output_surface), std::move(scheduler),
                   base::MakeUnique<TextureMailboxDeleter>(task_runner_.get())));
 
   // We want the Display's OutputSurface to hear about lost context, and when
   // this shares a context with it we should not be listening for lost context
   // callbacks on the context here.
   if (display_context_shared_with_compositor && context_provider())
     context_provider()->SetLostContextCallback(base::Closure());
 
-  surface_manager_->RegisterFrameSinkId(frame_sink_id_);
-  surface_manager_->RegisterSurfaceFactoryClient(frame_sink_id_, this);
+  support_ = base::MakeUnique<CompositorFrameSinkSupport>(
+      this, surface_manager_.get(), frame_sink_id_, false /* is_root */,
+      true /* handles_frame_sink_id_invalidation */,
+      true /* needs_sync_points */);
+  client_->SetBeginFrameSource(&external_begin_frame_source_);
+
   display_->Initialize(this, surface_manager_.get());
   display_->renderer_for_testing()->SetEnlargePassTextureAmountForTesting(
       enlarge_pass_texture_amount_);
   display_->SetVisible(true);
-  bound_ = true;
   return true;
 }
 
 void TestCompositorFrameSink::DetachFromClient() {
-  // Some tests make BindToClient fail on purpose. ^__^
-  if (bound_) {
-    surface_factory_->EvictSurface();
-    surface_manager_->UnregisterSurfaceFactoryClient(frame_sink_id_);
-    surface_manager_->InvalidateFrameSinkId(frame_sink_id_);
-    display_ = nullptr;
-    bound_ = false;
-  }
-  surface_factory_ = nullptr;
+  client_->SetBeginFrameSource(nullptr);
+  support_ = nullptr;
+  display_ = nullptr;
   local_surface_id_allocator_ = nullptr;
   surface_manager_ = nullptr;
   test_client_ = nullptr;
   CompositorFrameSink::DetachFromClient();
 }
 
 void TestCompositorFrameSink::SubmitCompositorFrame(CompositorFrame frame) {
   test_client_->DisplayReceivedCompositorFrame(frame);
 
   if (!delegated_local_surface_id_.is_valid()) {
     delegated_local_surface_id_ = local_surface_id_allocator_->GenerateId();
   }
   display_->SetLocalSurfaceId(delegated_local_surface_id_,
                               frame.metadata.device_scale_factor);
 
   gfx::Size frame_size = frame.render_pass_list.back()->output_rect.size();
   display_->Resize(frame_size);
 
-  bool synchronous = !display_->has_scheduler();
-
-  SurfaceFactory::DrawCallback draw_callback;
-  if (!synchronous) {
-    // For async draws, we use a callback tell when it is done, but for sync
-    // draws we don't need one. Unretained is safe here because the callback
-    // will be run when |surface_factory_| is destroyed which is owned by this
-    // class.
-    draw_callback = base::Bind(&TestCompositorFrameSink::DidDrawCallback,
-                               base::Unretained(this));
-  }
-
-  surface_factory_->SubmitCompositorFrame(delegated_local_surface_id_,
-                                          std::move(frame), draw_callback);
+  support_->SubmitCompositorFrame(delegated_local_surface_id_,
+                                  std::move(frame));
 
   for (std::unique_ptr<CopyOutputRequest>& copy_request : copy_requests_) {
-    surface_factory_->RequestCopyOfSurface(std::move(copy_request));
+    support_->RequestCopyOfSurface(std::move(copy_request));
   }
   copy_requests_.clear();
 
-  if (synchronous) {
+  if (!display_->has_scheduler()) {
     display_->DrawAndSwap();
     // Post this to get a new stack frame so that we exit this function before
     // calling the client to tell it that it is done.
-    task_runner_->PostTask(FROM_HERE,
-                           base::Bind(&TestCompositorFrameSink::DidDrawCallback,
-                                      weak_ptr_factory_.GetWeakPtr()));
+    task_runner_->PostTask(
+        FROM_HERE,
+        base::Bind(&TestCompositorFrameSink::SendCompositorFrameAckToClient,
+                   weak_ptr_factory_.GetWeakPtr()));
   }
 }
 
-void TestCompositorFrameSink::DidDrawCallback() {
-  // This is to unthrottle the next frame, not actually a notice that drawing is
-  // done.
-  client_->DidReceiveCompositorFrameAck();
-}
-
 void TestCompositorFrameSink::ForceReclaimResources() {
   if (capabilities_.can_force_reclaim_resources &&
       delegated_local_surface_id_.is_valid()) {
-    surface_factory_->ClearSurface();
+    support_->ForceReclaimResources();
   }
 }
 
-void TestCompositorFrameSink::ReturnResources(
+void TestCompositorFrameSink::DidReceiveCompositorFrameAck() {
+  // In synchronous mode, we manually send acks and this method should not be
+  // used.
+  if (!display_->has_scheduler())

[danakj, 2017/03/02 21:58:54]

The other way to do this, since you have have branch on has_scheduler() here now
anyways, would be to optionally PostTask here to SendCompositorFrameAckToClient
instead of doing it after DrawAndSwap. It seems neither here nor there, so up to
you.

[Saman Sami, 2017/03/02 22:09:49]

Right. I think both approaches are equally good. I'm keeping things the way they
are.

+    return;
+  client_->DidReceiveCompositorFrameAck();
+}
+
+void TestCompositorFrameSink::OnBeginFrame(const BeginFrameArgs& args) {
+  external_begin_frame_source_.OnBeginFrame(args);
+}
+
+void TestCompositorFrameSink::ReclaimResources(
     const ReturnedResourceArray& resources) {
   client_->ReclaimResources(resources);
 }
 
-void TestCompositorFrameSink::SetBeginFrameSource(
-    BeginFrameSource* begin_frame_source) {
-  client_->SetBeginFrameSource(begin_frame_source);
-}
+void TestCompositorFrameSink::WillDrawSurface(
+    const LocalSurfaceId& local_surface_id,
+    const gfx::Rect& damage_rect) {}
 
 void TestCompositorFrameSink::DisplayOutputSurfaceLost() {
   client_->DidLoseCompositorFrameSink();
 }
 
 void TestCompositorFrameSink::DisplayWillDrawAndSwap(
     bool will_draw_and_swap,
     const RenderPassList& render_passes) {
   test_client_->DisplayWillDrawAndSwap(will_draw_and_swap, render_passes);
 }
 
 void TestCompositorFrameSink::DisplayDidDrawAndSwap() {
   test_client_->DisplayDidDrawAndSwap();
 }
 
+void TestCompositorFrameSink::OnNeedsBeginFrames(bool needs_begin_frames) {
+  support_->SetNeedsBeginFrame(needs_begin_frames);
+}
+
+void TestCompositorFrameSink::OnDidFinishFrame(const BeginFrameAck& ack) {}
+
+void TestCompositorFrameSink::SendCompositorFrameAckToClient() {
+  client_->DidReceiveCompositorFrameAck();
+}
+
 }  // namespace cc