src/cc/layers/delegated_renderer_layer_impl.cc

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "cc/layers/delegated_renderer_layer_impl.h"
   6
   7 #include <algorithm>
   8 #include <utility>
   9
  10 #include "base/bind.h"
  11 #include "base/containers/hash_tables.h"
  12 #include "cc/base/math_util.h"
  13 #include "cc/layers/append_quads_data.h"
  14 #include "cc/layers/render_pass_sink.h"
  15 #include "cc/output/delegated_frame_data.h"
  16 #include "cc/quads/render_pass_draw_quad.h"
  17 #include "cc/quads/solid_color_draw_quad.h"
  18 #include "cc/trees/layer_tree_impl.h"
  19 #include "cc/trees/occlusion.h"
  20 #include "ui/gfx/geometry/rect_conversions.h"
  21
  22 namespace cc {
  23
  24 DelegatedRendererLayerImpl::DelegatedRendererLayerImpl(LayerTreeImpl* tree_impl,
  25                                                        int id)
  26     : LayerImpl(tree_impl, id),
  27       have_render_passes_to_push_(false),
  28       inverse_device_scale_factor_(1.0f),
  29       child_id_(0),
  30       own_child_id_(false) {
  31 }
  32
  33 DelegatedRendererLayerImpl::~DelegatedRendererLayerImpl() {
  34   ClearRenderPasses();
  35   ClearChildId();
  36 }
  37
  38 bool DelegatedRendererLayerImpl::HasDelegatedContent() const { return true; }
  39
  40 bool DelegatedRendererLayerImpl::HasContributingDelegatedRenderPasses() const {
  41   // The root RenderPass for the layer is merged with its target
  42   // RenderPass in each frame. So we only have extra RenderPasses
  43   // to merge when we have a non-root RenderPass present.
  44   return render_passes_in_draw_order_.size() > 1;
  45 }
  46
  47 static ResourceProvider::ResourceId ResourceRemapHelper(
  48     bool* invalid_frame,
  49     const ResourceProvider::ResourceIdMap& child_to_parent_map,
  50     ResourceProvider::ResourceIdArray* resources_in_frame,
  51     ResourceProvider::ResourceId id) {
  52
  53   ResourceProvider::ResourceIdMap::const_iterator it =
  54       child_to_parent_map.find(id);
  55   if (it == child_to_parent_map.end()) {
  56     *invalid_frame = true;
  57     return 0;
  58   }
  59
  60   DCHECK_EQ(it->first, id);
  61   ResourceProvider::ResourceId remapped_id = it->second;
  62   resources_in_frame->push_back(id);
  63   return remapped_id;
  64 }
  65
  66 void DelegatedRendererLayerImpl::PushPropertiesTo(LayerImpl* layer) {
  67   LayerImpl::PushPropertiesTo(layer);
  68
  69   DelegatedRendererLayerImpl* delegated_layer =
  70       static_cast<DelegatedRendererLayerImpl*>(layer);
  71
  72   // If we have a new child_id to give to the active layer, it should
  73   // have already deleted its old child_id.
  74   DCHECK(delegated_layer->child_id_ == 0 ||
  75          delegated_layer->child_id_ == child_id_);
  76   delegated_layer->inverse_device_scale_factor_ = inverse_device_scale_factor_;
  77   delegated_layer->child_id_ = child_id_;
  78   delegated_layer->own_child_id_ = true;
  79   own_child_id_ = false;
  80
  81   if (have_render_passes_to_push_) {
  82     // This passes ownership of the render passes to the active tree.
  83     delegated_layer->SetRenderPasses(&render_passes_in_draw_order_);
  84     DCHECK(render_passes_in_draw_order_.empty());
  85     have_render_passes_to_push_ = false;
  86   }
  87
  88   // This is just a copy for testing, since resources are added to the
  89   // ResourceProvider in the pending tree.
  90   delegated_layer->resources_ = resources_;
  91 }
  92
  93 void DelegatedRendererLayerImpl::CreateChildIdIfNeeded(
  94     const ReturnCallback& return_callback) {
  95   if (child_id_)
  96     return;
  97
  98   ResourceProvider* resource_provider = layer_tree_impl()->resource_provider();
  99   child_id_ = resource_provider->CreateChild(return_callback);
 100   own_child_id_ = true;
 101 }
 102
 103 void DelegatedRendererLayerImpl::SetFrameData(
 104     const DelegatedFrameData* frame_data,
 105     const gfx::RectF& damage_in_frame) {
 106   DCHECK(child_id_) << "CreateChildIdIfNeeded must be called first.";
 107   DCHECK(frame_data);
 108   DCHECK(!frame_data->render_pass_list.empty());
 109   // A frame with an empty root render pass is invalid.
 110   DCHECK(!frame_data->render_pass_list.back()->output_rect.IsEmpty());
 111
 112   ResourceProvider* resource_provider = layer_tree_impl()->resource_provider();
 113     const ResourceProvider::ResourceIdMap& resource_map =
 114         resource_provider->GetChildToParentMap(child_id_);
 115
 116   resource_provider->ReceiveFromChild(child_id_, frame_data->resource_list);
 117
 118   RenderPassList render_pass_list;
 119   RenderPass::CopyAll(frame_data->render_pass_list, &render_pass_list);
 120
 121   bool invalid_frame = false;
 122   ResourceProvider::ResourceIdArray resources_in_frame;
 123   DrawQuad::ResourceIteratorCallback remap_resources_to_parent_callback =
 124       base::Bind(&ResourceRemapHelper,
 125                  &invalid_frame,
 126                  resource_map,
 127                  &resources_in_frame);
 128   for (const auto& pass : render_pass_list) {
 129     for (const auto& quad : pass->quad_list)
 130       quad->IterateResources(remap_resources_to_parent_callback);
 131   }
 132
 133   if (invalid_frame) {
 134     // Declare we are still using the last frame's resources.
 135     resource_provider->DeclareUsedResourcesFromChild(child_id_, resources_);
 136     return;
 137   }
 138
 139   // Declare we are using the new frame's resources.
 140   resources_.swap(resources_in_frame);
 141   resource_provider->DeclareUsedResourcesFromChild(child_id_, resources_);
 142
 143   inverse_device_scale_factor_ = 1.0f / frame_data->device_scale_factor;
 144   // Display size is already set so we can compute what the damage rect
 145   // will be in layer space. The damage may exceed the visible portion of
 146   // the frame, so intersect the damage to the layer's bounds.
 147   RenderPass* new_root_pass = render_pass_list.back();
 148   gfx::Size frame_size = new_root_pass->output_rect.size();
 149   gfx::RectF damage_in_layer = damage_in_frame;
 150   damage_in_layer.Scale(inverse_device_scale_factor_);
 151   SetUpdateRect(gfx::IntersectRects(
 152       gfx::UnionRects(update_rect(), gfx::ToEnclosingRect(damage_in_layer)),
 153       gfx::Rect(bounds())));
 154
 155   SetRenderPasses(&render_pass_list);
 156   have_render_passes_to_push_ = true;
 157 }
 158
 159 void DelegatedRendererLayerImpl::SetRenderPasses(
 160     RenderPassList* render_passes_in_draw_order) {
 161   ClearRenderPasses();
 162
 163   for (size_t i = 0; i < render_passes_in_draw_order->size(); ++i) {
 164     RenderPassList::iterator to_take =
 165         render_passes_in_draw_order->begin() + i;
 166     render_passes_index_by_id_.insert(
 167         std::pair<RenderPassId, int>((*to_take)->id, i));
 168     scoped_ptr<RenderPass> taken_render_pass =
 169         render_passes_in_draw_order->take(to_take);
 170     render_passes_in_draw_order_.push_back(taken_render_pass.Pass());
 171   }
 172
 173   // Give back an empty array instead of nulls.
 174   render_passes_in_draw_order->clear();
 175 }
 176
 177 void DelegatedRendererLayerImpl::ClearRenderPasses() {
 178   render_passes_index_by_id_.clear();
 179   render_passes_in_draw_order_.clear();
 180 }
 181
 182 scoped_ptr<LayerImpl> DelegatedRendererLayerImpl::CreateLayerImpl(
 183     LayerTreeImpl* tree_impl) {
 184   return DelegatedRendererLayerImpl::Create(tree_impl, id());
 185 }
 186
 187 void DelegatedRendererLayerImpl::ReleaseResources() {
 188   ClearRenderPasses();
 189   ClearChildId();
 190 }
 191
 192 static inline int IndexToId(int index) { return index + 1; }
 193 static inline int IdToIndex(int id) { return id - 1; }
 194
 195 RenderPassId DelegatedRendererLayerImpl::FirstContributingRenderPassId() const {
 196   return RenderPassId(id(), IndexToId(0));
 197 }
 198
 199 RenderPassId DelegatedRendererLayerImpl::NextContributingRenderPassId(
 200     RenderPassId previous) const {
 201   return RenderPassId(previous.layer_id, previous.index + 1);
 202 }
 203
 204 bool DelegatedRendererLayerImpl::ConvertDelegatedRenderPassId(
 205     RenderPassId delegated_render_pass_id,
 206     RenderPassId* output_render_pass_id) const {
 207   base::hash_map<RenderPassId, int>::const_iterator found =
 208       render_passes_index_by_id_.find(delegated_render_pass_id);
 209   if (found == render_passes_index_by_id_.end()) {
 210     // Be robust against a RenderPass id that isn't part of the frame.
 211     return false;
 212   }
 213   unsigned delegated_render_pass_index = found->second;
 214   *output_render_pass_id =
 215       RenderPassId(id(), IndexToId(delegated_render_pass_index));
 216   return true;
 217 }
 218
 219 void DelegatedRendererLayerImpl::AppendContributingRenderPasses(
 220     RenderPassSink* render_pass_sink) {
 221   DCHECK(HasContributingDelegatedRenderPasses());
 222
 223   const RenderPass* root_delegated_render_pass =
 224       render_passes_in_draw_order_.back();
 225   gfx::Size frame_size = root_delegated_render_pass->output_rect.size();
 226   gfx::Transform delegated_frame_to_root_transform = screen_space_transform();
 227   delegated_frame_to_root_transform.Scale(inverse_device_scale_factor_,
 228                                           inverse_device_scale_factor_);
 229
 230   for (size_t i = 0; i < render_passes_in_draw_order_.size() - 1; ++i) {
 231     RenderPassId output_render_pass_id(-1, -1);
 232     bool present =
 233         ConvertDelegatedRenderPassId(render_passes_in_draw_order_[i]->id,
 234                                      &output_render_pass_id);
 235
 236     // Don't clash with the RenderPass we generate if we own a RenderSurface.
 237     DCHECK(present) << render_passes_in_draw_order_[i]->id.layer_id << ", "
 238                     << render_passes_in_draw_order_[i]->id.index;
 239     DCHECK_GT(output_render_pass_id.index, 0);
 240
 241     scoped_ptr<RenderPass> copy_pass =
 242         render_passes_in_draw_order_[i]->Copy(output_render_pass_id);
 243     copy_pass->transform_to_root_target.ConcatTransform(
 244         delegated_frame_to_root_transform);
 245     render_pass_sink->AppendRenderPass(copy_pass.Pass());
 246   }
 247 }
 248
 249 bool DelegatedRendererLayerImpl::WillDraw(DrawMode draw_mode,
 250                                           ResourceProvider* resource_provider) {
 251   if (draw_mode == DRAW_MODE_RESOURCELESS_SOFTWARE)
 252     return false;
 253   return LayerImpl::WillDraw(draw_mode, resource_provider);
 254 }
 255
 256 void DelegatedRendererLayerImpl::AppendQuads(
 257     RenderPass* render_pass,
 258     const Occlusion& occlusion_in_content_space,
 259     AppendQuadsData* append_quads_data) {
 260   AppendRainbowDebugBorder(render_pass, append_quads_data);
 261
 262   // This list will be empty after a lost context until a new frame arrives.
 263   if (render_passes_in_draw_order_.empty())
 264     return;
 265
 266   RenderPassId target_render_pass_id = append_quads_data->render_pass_id;
 267
 268   const RenderPass* root_delegated_render_pass =
 269       render_passes_in_draw_order_.back();
 270
 271   DCHECK(root_delegated_render_pass->output_rect.origin().IsOrigin());
 272   gfx::Size frame_size = root_delegated_render_pass->output_rect.size();
 273
 274   // If the index of the RenderPassId is 0, then it is a RenderPass generated
 275   // for a layer in this compositor, not the delegating renderer. Then we want
 276   // to merge our root RenderPass with the target RenderPass. Otherwise, it is
 277   // some RenderPass which we added from the delegating renderer.
 278   bool should_merge_root_render_pass_with_target = !target_render_pass_id.index;
 279   if (should_merge_root_render_pass_with_target) {
 280     // Verify that the RenderPass we are appending to is created by our
 281     // render_target.
 282     DCHECK(target_render_pass_id.layer_id == render_target()->id());
 283
 284     AppendRenderPassQuads(render_pass,
 285                           occlusion_in_content_space,
 286                           append_quads_data,
 287                           root_delegated_render_pass,
 288                           frame_size);
 289   } else {
 290     // Verify that the RenderPass we are appending to was created by us.
 291     DCHECK(target_render_pass_id.layer_id == id());
 292
 293     int render_pass_index = IdToIndex(target_render_pass_id.index);
 294     const RenderPass* delegated_render_pass =
 295         render_passes_in_draw_order_[render_pass_index];
 296     AppendRenderPassQuads(render_pass,
 297                           occlusion_in_content_space,
 298                           append_quads_data,
 299                           delegated_render_pass,
 300                           frame_size);
 301   }
 302 }
 303
 304 void DelegatedRendererLayerImpl::AppendRainbowDebugBorder(
 305     RenderPass* render_pass,
 306     AppendQuadsData* append_quads_data) {
 307   if (!ShowDebugBorders())
 308     return;
 309
 310   SharedQuadState* shared_quad_state =
 311       render_pass->CreateAndAppendSharedQuadState();
 312   PopulateSharedQuadState(shared_quad_state);
 313
 314   SkColor color;
 315   float border_width;
 316   GetDebugBorderProperties(&color, &border_width);
 317
 318   SkColor colors[] = {
 319     0x80ff0000,  // Red.
 320     0x80ffa500,  // Orange.
 321     0x80ffff00,  // Yellow.
 322     0x80008000,  // Green.
 323     0x800000ff,  // Blue.
 324     0x80ee82ee,  // Violet.
 325   };
 326   const int kNumColors = arraysize(colors);
 327
 328   const int kStripeWidth = 300;
 329   const int kStripeHeight = 300;
 330
 331   for (size_t i = 0; ; ++i) {
 332     // For horizontal lines.
 333     int x =  kStripeWidth * i;
 334     int width = std::min(kStripeWidth, content_bounds().width() - x - 1);
 335
 336     // For vertical lines.
 337     int y = kStripeHeight * i;
 338     int height = std::min(kStripeHeight, content_bounds().height() - y - 1);
 339
 340     gfx::Rect top(x, 0, width, border_width);
 341     gfx::Rect bottom(x,
 342                      content_bounds().height() - border_width,
 343                      width,
 344                      border_width);
 345     gfx::Rect left(0, y, border_width, height);
 346     gfx::Rect right(content_bounds().width() - border_width,
 347                     y,
 348                     border_width,
 349                     height);
 350
 351     if (top.IsEmpty() && left.IsEmpty())
 352       break;
 353
 354     if (!top.IsEmpty()) {
 355       SolidColorDrawQuad* top_quad =
 356           render_pass->CreateAndAppendDrawQuad<SolidColorDrawQuad>();
 357       top_quad->SetNew(
 358           shared_quad_state, top, top, colors[i % kNumColors], false);
 359
 360       SolidColorDrawQuad* bottom_quad =
 361           render_pass->CreateAndAppendDrawQuad<SolidColorDrawQuad>();
 362       bottom_quad->SetNew(shared_quad_state,
 363                           bottom,
 364                           bottom,
 365                           colors[kNumColors - 1 - (i % kNumColors)],
 366                           false);
 367     }
 368     if (!left.IsEmpty()) {
 369       SolidColorDrawQuad* left_quad =
 370           render_pass->CreateAndAppendDrawQuad<SolidColorDrawQuad>();
 371       left_quad->SetNew(shared_quad_state,
 372                         left,
 373                         left,
 374                         colors[kNumColors - 1 - (i % kNumColors)],
 375                         false);
 376
 377       SolidColorDrawQuad* right_quad =
 378           render_pass->CreateAndAppendDrawQuad<SolidColorDrawQuad>();
 379       right_quad->SetNew(
 380           shared_quad_state, right, right, colors[i % kNumColors], false);
 381     }
 382   }
 383 }
 384
 385 void DelegatedRendererLayerImpl::AppendRenderPassQuads(
 386     RenderPass* render_pass,
 387     const Occlusion& occlusion_in_content_space,
 388     AppendQuadsData* append_quads_data,
 389     const RenderPass* delegated_render_pass,
 390     const gfx::Size& frame_size) const {
 391   const SharedQuadState* delegated_shared_quad_state = nullptr;
 392   SharedQuadState* output_shared_quad_state = nullptr;
 393
 394   for (const auto& delegated_quad : delegated_render_pass->quad_list) {
 395     bool is_root_delegated_render_pass =
 396         delegated_render_pass == render_passes_in_draw_order_.back();
 397
 398     if (delegated_quad->shared_quad_state != delegated_shared_quad_state) {
 399       delegated_shared_quad_state = delegated_quad->shared_quad_state;
 400       output_shared_quad_state = render_pass->CreateAndAppendSharedQuadState();
 401       output_shared_quad_state->CopyFrom(delegated_shared_quad_state);
 402
 403       if (is_root_delegated_render_pass) {
 404         gfx::Transform delegated_frame_to_target_transform = draw_transform();
 405         delegated_frame_to_target_transform.Scale(inverse_device_scale_factor_,
 406                                                   inverse_device_scale_factor_);
 407
 408         output_shared_quad_state->content_to_target_transform.ConcatTransform(
 409             delegated_frame_to_target_transform);
 410
 411         if (render_target() == this) {
 412           DCHECK(!is_clipped());
 413           DCHECK(render_surface());
 414           DCHECK_EQ(0, num_unclipped_descendants());
 415           output_shared_quad_state->clip_rect =
 416               MathUtil::MapEnclosingClippedRect(
 417                   delegated_frame_to_target_transform,
 418                   output_shared_quad_state->clip_rect);
 419         } else {
 420           gfx::Rect clip_rect = drawable_content_rect();
 421           if (output_shared_quad_state->is_clipped) {
 422             clip_rect.Intersect(MathUtil::MapEnclosingClippedRect(
 423                 delegated_frame_to_target_transform,
 424                 output_shared_quad_state->clip_rect));
 425           }
 426           output_shared_quad_state->clip_rect = clip_rect;
 427           output_shared_quad_state->is_clipped = true;
 428         }
 429
 430         output_shared_quad_state->opacity *= draw_opacity();
 431       }
 432     }
 433     DCHECK(output_shared_quad_state);
 434
 435     gfx::Transform quad_content_to_delegated_target_space =
 436         output_shared_quad_state->content_to_target_transform;
 437     if (!is_root_delegated_render_pass) {
 438       quad_content_to_delegated_target_space.ConcatTransform(
 439           delegated_render_pass->transform_to_root_target);
 440       quad_content_to_delegated_target_space.ConcatTransform(draw_transform());
 441     }
 442
 443     Occlusion occlusion_in_quad_space =
 444         occlusion_in_content_space.GetOcclusionWithGivenDrawTransform(
 445             quad_content_to_delegated_target_space);
 446
 447     gfx::Rect quad_visible_rect =
 448         occlusion_in_quad_space.GetUnoccludedContentRect(
 449             delegated_quad->visible_rect);
 450
 451     if (quad_visible_rect.IsEmpty())
 452       continue;
 453
 454     if (delegated_quad->material != DrawQuad::RENDER_PASS) {
 455       DrawQuad* output_quad = render_pass->CopyFromAndAppendDrawQuad(
 456           delegated_quad, output_shared_quad_state);
 457       output_quad->visible_rect = quad_visible_rect;
 458     } else {
 459       RenderPassId delegated_contributing_render_pass_id =
 460           RenderPassDrawQuad::MaterialCast(delegated_quad)->render_pass_id;
 461       RenderPassId output_contributing_render_pass_id(-1, -1);
 462
 463       bool present =
 464           ConvertDelegatedRenderPassId(delegated_contributing_render_pass_id,
 465                                        &output_contributing_render_pass_id);
 466
 467       // The frame may have a RenderPassDrawQuad that points to a RenderPass not
 468       // part of the frame. Just ignore these quads.
 469       if (present) {
 470         DCHECK(output_contributing_render_pass_id !=
 471                append_quads_data->render_pass_id);
 472
 473         RenderPassDrawQuad* output_quad =
 474             render_pass->CopyFromAndAppendRenderPassDrawQuad(
 475                 RenderPassDrawQuad::MaterialCast(delegated_quad),
 476                 output_shared_quad_state,
 477                 output_contributing_render_pass_id);
 478         output_quad->visible_rect = quad_visible_rect;
 479       }
 480     }
 481   }
 482 }
 483
 484 const char* DelegatedRendererLayerImpl::LayerTypeAsString() const {
 485   return "cc::DelegatedRendererLayerImpl";
 486 }
 487
 488 void DelegatedRendererLayerImpl::ClearChildId() {
 489   if (!child_id_)
 490     return;
 491
 492   if (own_child_id_) {
 493     ResourceProvider* provider = layer_tree_impl()->resource_provider();
 494     provider->DestroyChild(child_id_);
 495   }
 496
 497   resources_.clear();
 498   child_id_ = 0;
 499 }
 500
 501 }  // namespace cc