cc: Plumbing for BeginFrameSource based on Surfaces

cc/surfaces/surface_factory_unittest.cc

 // Copyright 2014 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 "base/bind.h"
 #include "cc/output/compositor_frame.h"
 #include "cc/output/copy_output_request.h"
 #include "cc/output/copy_output_result.h"
 #include "cc/output/delegated_frame_data.h"
 #include "cc/resources/resource_provider.h"
 #include "cc/surfaces/surface.h"
 #include "cc/surfaces/surface_factory.h"
 #include "cc/surfaces/surface_factory_client.h"
 #include "cc/surfaces/surface_manager.h"
+#include "cc/test/scheduler_test_common.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/gfx/geometry/size.h"
 
 namespace cc {
 namespace {
 
 class TestSurfaceFactoryClient : public SurfaceFactoryClient {
  public:
-  TestSurfaceFactoryClient() {}
+  TestSurfaceFactoryClient() : begin_frame_source_(nullptr) {}
   ~TestSurfaceFactoryClient() override {}
 
   void ReturnResources(const ReturnedResourceArray& resources) override {
     returned_resources_.insert(
         returned_resources_.end(), resources.begin(), resources.end());
   }
 
+  void SetBeginFrameSource(SurfaceId surface_id,
+                           BeginFrameSource* begin_frame_source) override {
+    begin_frame_source_ = begin_frame_source;
+  }
+
   const ReturnedResourceArray& returned_resources() const {
     return returned_resources_;
   }
 
   void clear_returned_resources() { returned_resources_.clear(); }
 
+  BeginFrameSource* begin_frame_source() const { return begin_frame_source_; }
+
  private:
   ReturnedResourceArray returned_resources_;
+  BeginFrameSource* begin_frame_source_;
 
   DISALLOW_COPY_AND_ASSIGN(TestSurfaceFactoryClient);
 };
 
 class SurfaceFactoryTest : public testing::Test {
  public:
-  SurfaceFactoryTest() : factory_(&manager_, &client_), surface_id_(3) {
-    factory_.Create(surface_id_);
+  SurfaceFactoryTest()
+      : factory_(new SurfaceFactory(&manager_, &client_)), surface_id_(3) {
+    factory_->Create(surface_id_);
   }
 
   ~SurfaceFactoryTest() override {
     if (!surface_id_.is_null())
-      factory_.Destroy(surface_id_);
+      factory_->Destroy(surface_id_);
   }
 
   void SubmitCompositorFrameWithResources(ResourceId* resource_ids,
                                           size_t num_resource_ids) {
     scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
     for (size_t i = 0u; i < num_resource_ids; ++i) {
       TransferableResource resource;
       resource.id = resource_ids[i];
       resource.mailbox_holder.texture_target = GL_TEXTURE_2D;
       frame_data->resource_list.push_back(resource);
     }
     scoped_ptr<CompositorFrame> frame(new CompositorFrame);
     frame->delegated_frame_data = frame_data.Pass();
-    factory_.SubmitCompositorFrame(surface_id_, frame.Pass(),
-                                   SurfaceFactory::DrawCallback());
+    factory_->SubmitCompositorFrame(surface_id_, frame.Pass(),
+                                    SurfaceFactory::DrawCallback());
   }
 
   void UnrefResources(ResourceId* ids_to_unref,
                       int* counts_to_unref,
                       size_t num_ids_to_unref) {
     ReturnedResourceArray unref_array;
     for (size_t i = 0; i < num_ids_to_unref; ++i) {
       ReturnedResource resource;
       resource.id = ids_to_unref[i];
       resource.count = counts_to_unref[i];
       unref_array.push_back(resource);
     }
-    factory_.UnrefResources(unref_array);
+    factory_->UnrefResources(unref_array);
   }
 
   void CheckReturnedResourcesMatchExpected(ResourceId* expected_returned_ids,
                                            int* expected_returned_counts,
                                            size_t expected_resources) {
     const ReturnedResourceArray& actual_resources =
         client_.returned_resources();
     ASSERT_EQ(expected_resources, actual_resources.size());
     for (size_t i = 0; i < expected_resources; ++i) {
       ReturnedResource resource = actual_resources[i];
       EXPECT_EQ(expected_returned_ids[i], resource.id);
       EXPECT_EQ(expected_returned_counts[i], resource.count);
     }
     client_.clear_returned_resources();
   }
 
   void RefCurrentFrameResources() {
     Surface* surface = manager_.GetSurfaceForId(surface_id_);
-    factory_.RefResources(
+    factory_->RefResources(
         surface->GetEligibleFrame()->delegated_frame_data->resource_list);
   }
 
  protected:
   SurfaceManager manager_;
   TestSurfaceFactoryClient client_;
-  SurfaceFactory factory_;
+  scoped_ptr<SurfaceFactory> factory_;
   SurfaceId surface_id_;
 };
 
 // Tests submitting a frame with resources followed by one with no resources
 // with no resource provider action in between.
 TEST_F(SurfaceFactoryTest, ResourceLifetimeSimple) {
   ResourceId first_frame_ids[] = {1, 2, 3};
   SubmitCompositorFrameWithResources(first_frame_ids,
                                      arraysize(first_frame_ids));
 
@@ skipping 251 matching lines @@
     ResourceId expected_returned_ids[] = {12, 13};
     int expected_returned_counts[] = {2, 2};
     CheckReturnedResourcesMatchExpected(expected_returned_ids,
                                         expected_returned_counts,
                                         arraysize(expected_returned_counts));
   }
 }
 
 TEST_F(SurfaceFactoryTest, BlankNoIndexIncrement) {
   SurfaceId surface_id(6);
-  factory_.Create(surface_id);
+  factory_->Create(surface_id);
   Surface* surface = manager_.GetSurfaceForId(surface_id);
   ASSERT_NE(nullptr, surface);
   EXPECT_EQ(2, surface->frame_index());
   scoped_ptr<CompositorFrame> frame(new CompositorFrame);
   frame->delegated_frame_data.reset(new DelegatedFrameData);
 
-  factory_.SubmitCompositorFrame(surface_id, frame.Pass(),
-                                 SurfaceFactory::DrawCallback());
+  factory_->SubmitCompositorFrame(surface_id, frame.Pass(),
+                                  SurfaceFactory::DrawCallback());
   EXPECT_EQ(2, surface->frame_index());
-  factory_.Destroy(surface_id);
+  factory_->Destroy(surface_id);
 }
 
 void DrawCallback(uint32* execute_count,
                   SurfaceDrawStatus* result,
                   SurfaceDrawStatus drawn) {
   *execute_count += 1;
   *result = drawn;
 }
 
 // Tests doing a DestroyAll before shutting down the factory;
 TEST_F(SurfaceFactoryTest, DestroyAll) {
   SurfaceId id(7);
-  factory_.Create(id);
+  factory_->Create(id);
 
   scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
   TransferableResource resource;
   resource.id = 1;
   resource.mailbox_holder.texture_target = GL_TEXTURE_2D;
   frame_data->resource_list.push_back(resource);
   scoped_ptr<CompositorFrame> frame(new CompositorFrame);
   frame->delegated_frame_data = frame_data.Pass();
   uint32 execute_count = 0;
   SurfaceDrawStatus drawn = SurfaceDrawStatus::DRAW_SKIPPED;
 
-  factory_.SubmitCompositorFrame(
+  factory_->SubmitCompositorFrame(
       id, frame.Pass(), base::Bind(&DrawCallback, &execute_count, &drawn));
 
   surface_id_ = SurfaceId();
-  factory_.DestroyAll();
+  factory_->DestroyAll();
   EXPECT_EQ(1u, execute_count);
   EXPECT_EQ(SurfaceDrawStatus::DRAW_SKIPPED, drawn);
 }
 
 TEST_F(SurfaceFactoryTest, DestroySequence) {
   SurfaceId id2(5);
-  factory_.Create(id2);
+  factory_->Create(id2);
 
   manager_.RegisterSurfaceIdNamespace(0);
 
   // Check that waiting before the sequence is satisfied works.
   manager_.GetSurfaceForId(id2)
       ->AddDestructionDependency(SurfaceSequence(0, 4));
-  factory_.Destroy(id2);
+  factory_->Destroy(id2);
 
   scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
   scoped_ptr<CompositorFrame> frame(new CompositorFrame);
   frame->metadata.satisfies_sequences.push_back(6);
   frame->metadata.satisfies_sequences.push_back(4);
   frame->delegated_frame_data = frame_data.Pass();
   DCHECK(manager_.GetSurfaceForId(id2));
-  factory_.SubmitCompositorFrame(surface_id_, frame.Pass(),
-                                 SurfaceFactory::DrawCallback());
+  factory_->SubmitCompositorFrame(surface_id_, frame.Pass(),
+                                  SurfaceFactory::DrawCallback());
   DCHECK(!manager_.GetSurfaceForId(id2));
 
   // Check that waiting after the sequence is satisfied works.
-  factory_.Create(id2);
+  factory_->Create(id2);
   DCHECK(manager_.GetSurfaceForId(id2));
   manager_.GetSurfaceForId(id2)
       ->AddDestructionDependency(SurfaceSequence(0, 6));
-  factory_.Destroy(id2);
+  factory_->Destroy(id2);
   DCHECK(!manager_.GetSurfaceForId(id2));
 }
 
 // Tests that Surface ID namespace invalidation correctly allows
 // Sequences to be ignored.
 TEST_F(SurfaceFactoryTest, InvalidIdNamespace) {
   uint32_t id_namespace = 9u;
   SurfaceId id(5);
-  factory_.Create(id);
+  factory_->Create(id);
 
   manager_.RegisterSurfaceIdNamespace(id_namespace);
   manager_.GetSurfaceForId(id)
       ->AddDestructionDependency(SurfaceSequence(id_namespace, 4));
-  factory_.Destroy(id);
+  factory_->Destroy(id);
 
   // Verify the dependency has prevented the surface from getting destroyed.
   EXPECT_TRUE(manager_.GetSurfaceForId(id));
 
   manager_.InvalidateSurfaceIdNamespace(id_namespace);
 
   // Verify that the invalidated namespace caused the unsatisfied sequence
   // to be ignored.
   EXPECT_FALSE(manager_.GetSurfaceForId(id));
 }
 
 TEST_F(SurfaceFactoryTest, DestroyCycle) {
   SurfaceId id2(5);
-  factory_.Create(id2);
+  factory_->Create(id2);
 
   manager_.RegisterSurfaceIdNamespace(0);
 
   manager_.GetSurfaceForId(id2)
       ->AddDestructionDependency(SurfaceSequence(0, 4));
 
   // Give id2 a frame that references surface_id_.
   {
     scoped_ptr<RenderPass> render_pass(RenderPass::Create());
     render_pass->referenced_surfaces.push_back(surface_id_);
     scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
     frame_data->render_pass_list.push_back(render_pass.Pass());
     scoped_ptr<CompositorFrame> frame(new CompositorFrame);
     frame->delegated_frame_data = frame_data.Pass();
-    factory_.SubmitCompositorFrame(id2, frame.Pass(),
-                                   SurfaceFactory::DrawCallback());
+    factory_->SubmitCompositorFrame(id2, frame.Pass(),
+                                    SurfaceFactory::DrawCallback());
   }
-  factory_.Destroy(id2);
+  factory_->Destroy(id2);
 
   // Give surface_id_ a frame that references id2.
   {
     scoped_ptr<RenderPass> render_pass(RenderPass::Create());
     render_pass->referenced_surfaces.push_back(id2);
     scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
     frame_data->render_pass_list.push_back(render_pass.Pass());
     scoped_ptr<CompositorFrame> frame(new CompositorFrame);
     frame->delegated_frame_data = frame_data.Pass();
-    factory_.SubmitCompositorFrame(surface_id_, frame.Pass(),
-                                   SurfaceFactory::DrawCallback());
+    factory_->SubmitCompositorFrame(surface_id_, frame.Pass(),
+                                    SurfaceFactory::DrawCallback());
   }
-  factory_.Destroy(surface_id_);
+  factory_->Destroy(surface_id_);
   EXPECT_TRUE(manager_.GetSurfaceForId(id2));
   // surface_id_ should be retained by reference from id2.
   EXPECT_TRUE(manager_.GetSurfaceForId(surface_id_));
 
   // Satisfy last destruction dependency for id2.
   std::vector<uint32_t> to_satisfy;
   to_satisfy.push_back(4);
   manager_.DidSatisfySequences(0, &to_satisfy);
 
   // id2 and surface_id_ are in a reference cycle that has no surface
@@ skipping 10 matching lines @@
 }
 
 TEST_F(SurfaceFactoryTest, DuplicateCopyRequest) {
   {
     scoped_ptr<RenderPass> render_pass(RenderPass::Create());
     render_pass->referenced_surfaces.push_back(surface_id_);
     scoped_ptr<DelegatedFrameData> frame_data(new DelegatedFrameData);
     frame_data->render_pass_list.push_back(render_pass.Pass());
     scoped_ptr<CompositorFrame> frame(new CompositorFrame);
     frame->delegated_frame_data = frame_data.Pass();
-    factory_.SubmitCompositorFrame(surface_id_, frame.Pass(),
-                                   SurfaceFactory::DrawCallback());
+    factory_->SubmitCompositorFrame(surface_id_, frame.Pass(),
+                                    SurfaceFactory::DrawCallback());
   }
   void* source1 = &source1;
   void* source2 = &source2;
 
   bool called1 = false;
   scoped_ptr<CopyOutputRequest> request;
   request = CopyOutputRequest::CreateRequest(
       base::Bind(&CopyRequestTestCallback, &called1));
   request->set_source(source1);
 
-  factory_.RequestCopyOfSurface(surface_id_, request.Pass());
+  factory_->RequestCopyOfSurface(surface_id_, request.Pass());
   EXPECT_FALSE(called1);
 
   bool called2 = false;
   request = CopyOutputRequest::CreateRequest(
       base::Bind(&CopyRequestTestCallback, &called2));
   request->set_source(source2);
 
-  factory_.RequestCopyOfSurface(surface_id_, request.Pass());
+  factory_->RequestCopyOfSurface(surface_id_, request.Pass());
   // Callbacks have different sources so neither should be called.
   EXPECT_FALSE(called1);
   EXPECT_FALSE(called2);
 
   bool called3 = false;
   request = CopyOutputRequest::CreateRequest(
       base::Bind(&CopyRequestTestCallback, &called3));
   request->set_source(source1);
 
-  factory_.RequestCopyOfSurface(surface_id_, request.Pass());
+  factory_->RequestCopyOfSurface(surface_id_, request.Pass());
   // Two callbacks are from source1, so the first should be called.
   EXPECT_TRUE(called1);
   EXPECT_FALSE(called2);
   EXPECT_FALSE(called3);
 
-  factory_.Destroy(surface_id_);
+  factory_->Destroy(surface_id_);
   surface_id_ = SurfaceId();
   EXPECT_TRUE(called1);
   EXPECT_TRUE(called2);
   EXPECT_TRUE(called3);
 }
 
+// Verifies BFS is forwarded to the client.
+TEST_F(SurfaceFactoryTest, SetBeginFrameSource) {
+  FakeBeginFrameSource bfs1;
+  FakeBeginFrameSource bfs2;
+  EXPECT_EQ(nullptr, client_.begin_frame_source());
+  factory_->SetBeginFrameSource(surface_id_, &bfs1);
+  EXPECT_EQ(&bfs1, client_.begin_frame_source());
+  factory_->SetBeginFrameSource(surface_id_, &bfs2);
+  EXPECT_EQ(&bfs2, client_.begin_frame_source());
+  factory_->SetBeginFrameSource(surface_id_, nullptr);
+  EXPECT_EQ(nullptr, client_.begin_frame_source());
+}
+
+TEST_F(SurfaceFactoryTest, BeginFrameSourceRemovedOnFactoryDestruction) {
+  FakeBeginFrameSource bfs;
+  factory_->SetBeginFrameSource(surface_id_, &bfs);
+  EXPECT_EQ(&bfs, client_.begin_frame_source());
+
+  // Prevent the Surface from being destroyed when we destroy the factory.
+  manager_.RegisterSurfaceIdNamespace(0);
+  manager_.GetSurfaceForId(surface_id_)
+      ->AddDestructionDependency(SurfaceSequence(0, 4));
+
+  surface_id_ = SurfaceId();
+  factory_->DestroyAll();
+
+  EXPECT_EQ(&bfs, client_.begin_frame_source());
+  factory_.reset();
+  EXPECT_EQ(nullptr, client_.begin_frame_source());
+}
+
 }  // namespace
 }  // namespace cc