aura: Allow delegated frames to be used by more than one impl layer.

cc/layers/delegated_frame_provider_unittest.cc

+// Copyright 2013 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/layers/delegated_frame_provider.h"
+#include "cc/layers/delegated_frame_resource_collection.h"
+#include "cc/layers/delegated_renderer_layer.h"
+#include "cc/output/delegated_frame_data.h"
+#include "cc/quads/texture_draw_quad.h"
+#include "cc/resources/returned_resource.h"
+#include "cc/resources/transferable_resource.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace cc {
+namespace {
+
+class DelegatedFrameProviderTest
+    : public testing::Test,
+      public DelegatedFrameResourceCollectionClient {
+ protected:
+  DelegatedFrameProviderTest() : resources_available_(false) {}
+
+  scoped_ptr<DelegatedFrameData> CreateFrameData(gfx::Rect root_output_rect,
+                                                 gfx::Rect root_damage_rect) {
+    scoped_ptr<DelegatedFrameData> frame(new DelegatedFrameData);
+
+    scoped_ptr<RenderPass> root_pass(RenderPass::Create());
+    root_pass->SetNew(RenderPass::Id(1, 1),
+                      root_output_rect,
+                      root_damage_rect,
+                      gfx::Transform());
+    frame->render_pass_list.push_back(root_pass.Pass());
+    return frame.Pass();
+  }
+
+  void AddTransferableResource(DelegatedFrameData* frame,
+                               ResourceProvider::ResourceId resource_id) {
+    TransferableResource resource;
+    resource.id = resource_id;
+    resource.target = GL_TEXTURE_2D;
+    frame->resource_list.push_back(resource);
+  }
+
+  void AddTextureQuad(DelegatedFrameData* frame,
+                      ResourceProvider::ResourceId resource_id) {
+    scoped_ptr<SharedQuadState> sqs = SharedQuadState::Create();
+    scoped_ptr<TextureDrawQuad> quad = TextureDrawQuad::Create();
+    float vertex_opacity[4] = {1.f, 1.f, 1.f, 1.f};
+    quad->SetNew(sqs.get(),
+                 gfx::Rect(0, 0, 10, 10),
+                 gfx::Rect(0, 0, 10, 10),
+                 resource_id,
+                 false,
+                 gfx::PointF(0.f, 0.f),
+                 gfx::PointF(1.f, 1.f),
+                 SK_ColorTRANSPARENT,
+                 vertex_opacity,
+                 false);
+    frame->render_pass_list[0]->shared_quad_state_list.push_back(sqs.Pass());
+    frame->render_pass_list[0]->quad_list.push_back(quad.PassAs<DrawQuad>());
+  }
+
+  virtual void SetUp() OVERRIDE {
+    resource_collection_ = new DelegatedFrameResourceCollection;
+    resource_collection_->SetClient(this);
+  }
+
+  virtual void TearDown() OVERRIDE { resource_collection_->SetClient(NULL); }
+
+  virtual void UnusedResourcesAreAvailable() OVERRIDE {
+    resources_available_ = true;
+    resource_collection_->TakeUnusedResourcesForChildCompositor(&resources_);
+  }
+
+  bool ReturnAndResetResourcesAvailable() {
+    bool r = resources_available_;
+    resources_available_ = false;
+    return r;
+  }
+
+  void SetFrameProvider(scoped_ptr<DelegatedFrameData> frame_data) {
+    frame_provider_ =
+        new DelegatedFrameProvider(resource_collection_, frame_data.Pass());
+  }
+
+  scoped_refptr<DelegatedFrameResourceCollection> resource_collection_;
+  scoped_refptr<DelegatedFrameProvider> frame_provider_;
+  bool resources_available_;
+  ReturnedResourceArray resources_;
+};
+
+TEST_F(DelegatedFrameProviderTest, SameResources) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(1, 1), gfx::Rect(1, 1));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+  SetFrameProvider(frame.Pass());
+
+  frame = CreateFrameData(gfx::Rect(1, 1), gfx::Rect(1, 1));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+  SetFrameProvider(frame.Pass());
+
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(0u, resources_.size());
+
+  frame_provider_ = NULL;
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(444u, resources_[0].id);
+}
+
+TEST_F(DelegatedFrameProviderTest, ReplaceResources) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(1, 1), gfx::Rect(1, 1));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+  SetFrameProvider(frame.Pass());
+
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  frame = CreateFrameData(gfx::Rect(1, 1), gfx::Rect(1, 1));
+  AddTextureQuad(frame.get(), 555);
+  AddTransferableResource(frame.get(), 555);
+  SetFrameProvider(frame.Pass());
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(444u, resources_[0].id);
+  resources_.clear();
+
+  frame_provider_ = NULL;
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(555u, resources_[0].id);
+}
+
+TEST_F(DelegatedFrameProviderTest, RefResources) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+
+  TransferableResourceArray reffed = frame->resource_list;
+  ReturnedResourceArray returned;
+  TransferableResource::ReturnResources(reffed, &returned);
+
+  SetFrameProvider(frame.Pass());
+
+  scoped_refptr<DelegatedRendererLayer> observer1 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+  scoped_refptr<DelegatedRendererLayer> observer2 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+
+  gfx::RectF damage;
+
+  // Both observers get a full frame of damage on the first request.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF(5.f, 5.f).ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF(5.f, 5.f).ToString(), damage.ToString());
+
+  // And both get no damage on the 2nd request. This adds a second ref to the
+  // resources.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  frame = CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 555);
+  AddTransferableResource(frame.get(), 555);
+  frame_provider_->SetFrameData(frame.Pass());
+
+  // The resources from the first frame are still reffed by the observers.
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // There are 4 refs taken.
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // The 4th unref will release them.
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(444u, resources_[0].id);
+}
+
+TEST_F(DelegatedFrameProviderTest, RefResourcesInFrameProvider) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+
+  TransferableResourceArray reffed = frame->resource_list;
+  ReturnedResourceArray returned;
+  TransferableResource::ReturnResources(reffed, &returned);
+
+  SetFrameProvider(frame.Pass());
+
+  scoped_refptr<DelegatedRendererLayer> observer1 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+  scoped_refptr<DelegatedRendererLayer> observer2 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+
+  gfx::RectF damage;
+
+  // Take a ref on each observer.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // Release both refs. But there's still a ref held in the frame
+  // provider itself.
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // Setting a new frame will release it.
+  frame = CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 555);
+  AddTransferableResource(frame.get(), 555);
+  frame_provider_->SetFrameData(frame.Pass());
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(444u, resources_[0].id);
+}
+
+TEST_F(DelegatedFrameProviderTest, RefResourcesInFrameProviderUntilDestroy) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+
+  TransferableResourceArray reffed = frame->resource_list;
+  ReturnedResourceArray returned;
+  TransferableResource::ReturnResources(reffed, &returned);
+
+  SetFrameProvider(frame.Pass());
+
+  scoped_refptr<DelegatedRendererLayer> observer1 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+  scoped_refptr<DelegatedRendererLayer> observer2 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+
+  gfx::RectF damage;
+
+  // Take a ref on each observer.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // Release both refs. But there's still a ref held in the frame
+  // provider itself.
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  frame_provider_->UnrefResourcesOnMainThread(returned);
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  // Releasing all references to the frame provider will release
+  // the frame.
+  observer1 = NULL;
+  observer2 = NULL;
+  EXPECT_FALSE(ReturnAndResetResourcesAvailable());
+
+  frame_provider_ = NULL;
+
+  EXPECT_TRUE(ReturnAndResetResourcesAvailable());
+  EXPECT_EQ(1u, resources_.size());
+  EXPECT_EQ(444u, resources_[0].id);
+}
+
+TEST_F(DelegatedFrameProviderTest, Damage) {
+  scoped_ptr<DelegatedFrameData> frame =
+      CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 444);
+  AddTransferableResource(frame.get(), 444);
+
+  TransferableResourceArray reffed = frame->resource_list;
+  ReturnedResourceArray returned;
+  TransferableResource::ReturnResources(reffed, &returned);
+
+  SetFrameProvider(frame.Pass());
+
+  scoped_refptr<DelegatedRendererLayer> observer1 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+  scoped_refptr<DelegatedRendererLayer> observer2 =
+      DelegatedRendererLayer::Create(NULL, frame_provider_.get());
+
+  gfx::RectF damage;
+
+  // Both observers get a full frame of damage on the first request.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF(5.f, 5.f).ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF(5.f, 5.f).ToString(), damage.ToString());
+
+  // And both get no damage on the 2nd request.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+
+  frame = CreateFrameData(gfx::Rect(5, 5), gfx::Rect(2, 2));
+  AddTextureQuad(frame.get(), 555);
+  AddTransferableResource(frame.get(), 555);
+  frame_provider_->SetFrameData(frame.Pass());
+
+  // Both observers get the damage for the new frame.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF(2.f, 2.f).ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF(2.f, 2.f).ToString(), damage.ToString());
+
+  // And both get no damage on the 2nd request.
+  frame_provider_->GetFrameDataAndRefResources(observer1, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+  frame_provider_->GetFrameDataAndRefResources(observer2, &damage);
+  EXPECT_EQ(gfx::RectF().ToString(), damage.ToString());
+}
+
+}  // namespace
+}  // namespace cc