cc: Clean up RecordingSource API

cc/layers/picture_layer.cc

 // Copyright 2012 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/picture_layer.h"
 
 #include "base/auto_reset.h"
 #include "base/trace_event/trace_event.h"
 #include "cc/layers/content_layer_client.h"
 #include "cc/layers/picture_layer_impl.h"
 #include "cc/playback/recording_source.h"
 #include "cc/proto/cc_conversions.h"
 #include "cc/proto/gfx_conversions.h"
 #include "cc/proto/layer.pb.h"
 #include "cc/trees/layer_tree_host.h"
 #include "cc/trees/layer_tree_impl.h"
 #include "third_party/skia/include/core/SkPictureRecorder.h"
 #include "ui/gfx/geometry/rect_conversions.h"
 
 namespace cc {
 
+PictureLayer::Inputs::Inputs() = default;
+
+PictureLayer::Inputs::~Inputs() = default;
+
 scoped_refptr<PictureLayer> PictureLayer::Create(ContentLayerClient* client) {
   return make_scoped_refptr(new PictureLayer(client));
 }
 
 PictureLayer::PictureLayer(ContentLayerClient* client)
     : instrumentation_object_tracker_(id()),
       update_source_frame_number_(-1),
       is_mask_(false) {
   inputs_.client = client;
 }
@@ skipping 18 matching lines @@
   PictureLayerImpl* layer_impl = static_cast<PictureLayerImpl*>(base_layer);
   // TODO(danakj): Make is_mask_ a constructor parameter for PictureLayer.
   DCHECK_EQ(layer_impl->is_mask(), is_mask_);
   DropRecordingSourceContentIfInvalid();
 
   layer_impl->SetNearestNeighbor(inputs_.nearest_neighbor);
 
   // Preserve lcd text settings from the current raster source.
   bool can_use_lcd_text = layer_impl->RasterSourceUsesLCDText();
   scoped_refptr<RasterSource> raster_source =
-      recording_source_->CreateRasterSource(can_use_lcd_text);
+      recording_source_->CreateRasterSource(
+          can_use_lcd_text, inputs_.recorded_viewport, inputs_.display_list,
+          inputs_.painter_reported_memory_usage);
   layer_impl->set_gpu_raster_max_texture_size(
       layer_tree_host()->device_viewport_size());
   layer_impl->UpdateRasterSource(raster_source, &last_updated_invalidation_,
                                  nullptr);
   DCHECK(last_updated_invalidation_.IsEmpty());
 }
 
 void PictureLayer::SetLayerTreeHost(LayerTreeHost* host) {
   Layer::SetLayerTreeHost(host);
   if (!host)
@@ skipping 31 matching lines @@
                "source_frame_number",
                layer_tree_host()->source_frame_number());
   devtools_instrumentation::ScopedLayerTreeTask update_layer(
       devtools_instrumentation::kUpdateLayer, id(), layer_tree_host()->id());
 
   // UpdateAndExpandInvalidation will give us an invalidation that covers
   // anything not explicitly recorded in this frame. We give this region
   // to the impl side so that it drops tiles that may not have a recording
   // for them.
   DCHECK(inputs_.client);
+
+  gfx::Rect old_recorded_viewport = inputs_.recorded_viewport;
+  inputs_.recorded_viewport = inputs_.client->PaintableRegion();
+  // TODO(vmpstr): Add a slow_down_recording_scale_factor_for_debug_ to be able
+  // to slow down recording.
+  inputs_.display_list = inputs_.client->PaintContentsToDisplayList(
+      ContentLayerClient::PAINTING_BEHAVIOR_NORMAL);
+  inputs_.painter_reported_memory_usage =
+      inputs_.client->GetApproximateUnsharedMemoryUsage();
+
   updated |= recording_source_->UpdateAndExpandInvalidation(
       inputs_.client, &last_updated_invalidation_, layer_size,
-      update_source_frame_number_, RecordingSource::RECORD_NORMALLY);
+      old_recorded_viewport, inputs_.recorded_viewport, inputs_.display_list);

[vmpstr, 2016/07/25 20:29:14]

We're passing some more inputs in here, which is fine, but why do we also pass
the same inputs when we create the raster source? Can't the recording source
keep a copy after this function call? This would also make it possible to figure
out the old recorded viewport.

[Menglin, 2016/07/25 20:41:08]

So RecordingSource still has all its current members, but these three members
are just copied after UpdateAndExpandInvalidation? Of course we can do that.
Actually i think we can do the copy IN UpdateAndExpandInvalidation, right? that
will also simplify the change in the  test code. 

 
   if (updated) {
     SetNeedsPushProperties();
   } else {
     // If this invalidation did not affect the recording source, then it can be
     // cleared as an optimization.
     last_updated_invalidation_.Clear();
   }
 
   return updated;
 }
 
 void PictureLayer::SetIsMask(bool is_mask) {
   is_mask_ = is_mask;
 }
 
 sk_sp<SkPicture> PictureLayer::GetPicture() const {
   // We could either flatten the RecordingSource into a single
   // SkPicture, or paint a fresh one depending on what we intend to do with the
   // picture. For now we just paint a fresh one to get consistent results.
   if (!DrawsContent())
     return nullptr;
 
   gfx::Size layer_size = bounds();
   std::unique_ptr<RecordingSource> recording_source(new RecordingSource);
   Region recording_invalidation;
+
+  gfx::Rect old_recorded_viewport;
+  gfx::Rect new_recorded_viewport = inputs_.client->PaintableRegion();
+  // TODO(vmpstr): Add a slow_down_recording_scale_factor_for_debug_ to be able

[vmpstr, 2016/07/25 20:29:14]

This todo doesn't need to be here. 

[Menglin, 2016/07/25 21:58:52]

Done.

+  // to slow down recording.
+  scoped_refptr<DisplayItemList> display_list =
+      inputs_.client->PaintContentsToDisplayList(
+          ContentLayerClient::PAINTING_BEHAVIOR_NORMAL);
+  size_t painter_reported_memory_usage =
+      inputs_.client->GetApproximateUnsharedMemoryUsage();
+
   recording_source->UpdateAndExpandInvalidation(
       inputs_.client, &recording_invalidation, layer_size,
-      update_source_frame_number_, RecordingSource::RECORD_NORMALLY);
+      old_recorded_viewport, new_recorded_viewport, display_list);
 
   scoped_refptr<RasterSource> raster_source =
-      recording_source->CreateRasterSource(false);
+      recording_source->CreateRasterSource(false, new_recorded_viewport,
+                                           display_list,
+                                           painter_reported_memory_usage);
 
   return raster_source->GetFlattenedPicture();
 }
 
 bool PictureLayer::IsSuitableForGpuRasterization() const {
-  return recording_source_->IsSuitableForGpuRasterization();
+  // The display list needs to be created (see: UpdateAndExpandInvalidation)
+  // before checking for suitability. There are cases where an update will not
+  // create a display list (e.g., if the size is empty). We return true in these
+  // cases because the gpu suitability bit sticks false.
+  return !inputs_.display_list ||
+         inputs_.display_list->IsSuitableForGpuRasterization();
 }
 
 void PictureLayer::ClearClient() {
   inputs_.client = nullptr;
   UpdateDrawsContent(HasDrawableContent());
 }
 
 void PictureLayer::SetNearestNeighbor(bool nearest_neighbor) {
   if (inputs_.nearest_neighbor == nearest_neighbor)
     return;
@@ skipping 11 matching lines @@
 }
 
 void PictureLayer::LayerSpecificPropertiesToProto(
     proto::LayerProperties* proto) {
   Layer::LayerSpecificPropertiesToProto(proto);
   DropRecordingSourceContentIfInvalid();
 
   proto::PictureLayerProperties* picture = proto->mutable_picture();
   recording_source_->ToProtobuf(picture->mutable_recording_source());
 
-  // Add all SkPicture items to the picture cache.
-  const DisplayItemList* display_list = recording_source_->GetDisplayItemList();
-  if (display_list) {
-    for (auto it = display_list->begin(); it != display_list->end(); ++it) {
+  RectToProto(inputs_.recorded_viewport, picture->mutable_recorded_viewport());
+  if (inputs_.display_list) {
+    inputs_.display_list->ToProtobuf(picture->mutable_display_list());
+    for (auto it = inputs_.display_list->begin();
+         it != inputs_.display_list->end(); ++it) {
       sk_sp<const SkPicture> picture = it->GetPicture();
       // Only DrawingDisplayItems have SkPictures.
       if (!picture)
         continue;
 
       layer_tree_host()->engine_picture_cache()->MarkUsed(picture.get());
     }
   }
 
   RegionToProto(last_updated_invalidation_, picture->mutable_invalidation());
   picture->set_is_mask(is_mask_);
   picture->set_nearest_neighbor(inputs_.nearest_neighbor);
 
   picture->set_update_source_frame_number(update_source_frame_number_);
 
   last_updated_invalidation_.Clear();
 }
 
 void PictureLayer::FromLayerSpecificPropertiesProto(
     const proto::LayerProperties& proto) {
   Layer::FromLayerSpecificPropertiesProto(proto);
   const proto::PictureLayerProperties& picture = proto.picture();
   // If this is a new layer, ensure it has a recording source. During layer
   // hierarchy deserialization, ::SetLayerTreeHost(...) is not called, but
   // instead the member is set directly, so it needs to be set here explicitly.
   if (!recording_source_)
     recording_source_.reset(new RecordingSource);
 
   std::vector<uint32_t> used_engine_picture_ids;
+
+  inputs_.recorded_viewport = ProtoToRect(picture.recorded_viewport());
+
+  ClientPictureCache* client_picture_cache =
+      layer_tree_host()->client_picture_cache();
+  DCHECK(client_picture_cache);
+  // This might not exist if the |input_.display_list| of the serialized
+  // RecordingSource was null, which can happen if |Clear()| is
+  // called.
+  if (picture.has_display_list()) {
+    inputs_.display_list = DisplayItemList::CreateFromProto(
+        picture.display_list(), client_picture_cache, &used_engine_picture_ids);
+  } else {
+    inputs_.display_list = nullptr;
+  }
+
   recording_source_->FromProtobuf(picture.recording_source(),
-                                  layer_tree_host()->client_picture_cache(),
-                                  &used_engine_picture_ids);
+                                  inputs_.display_list);
 
   // Inform picture cache about which SkPictures are now in use.
   for (uint32_t engine_picture_id : used_engine_picture_ids)
     layer_tree_host()->client_picture_cache()->MarkUsed(engine_picture_id);
 
   Region new_invalidation = RegionFromProto(picture.invalidation());
   last_updated_invalidation_.Swap(&new_invalidation);
   is_mask_ = picture.is_mask();
   inputs_.nearest_neighbor = picture.nearest_neighbor();
 
@@ skipping 18 matching lines @@
          layer_bounds == recording_source_bounds)
       << " bounds " << layer_bounds.ToString() << " recording source "
       << recording_source_bounds.ToString();
 
   if (update_source_frame_number_ != source_frame_number &&
       recording_source_bounds != layer_bounds) {
     // Update may not get called for the layer (if it's not in the viewport
     // for example), even though it has resized making the recording source no
     // longer valid. In this case just destroy the recording source.
     recording_source_->SetEmptyBounds();
+    inputs_.recorded_viewport = gfx::Rect();
+    inputs_.display_list = nullptr;
+    inputs_.painter_reported_memory_usage = 0;
   }
 }
 
 }  // namespace cc