[Impeller] Reland DlAiksCanvas (flutter#45232)

Relands flutter#45131

Fixes flutter/flutter#132416

Differences from last time:

- Some minor merge conflict fixes
- Use the RTree to get the bounds instead of recalculating the bounds
- Make the iOS platform view controller implementation use the impeller-aware slices instead of the display list ones. This has been fixed for Android and the desktop embedding, but I missed iOS. The unit tests weren't actually running before I branched for my PR, @zanderso fixed them up separately and this resulted in catching the failures on post submit last time.

ci/licenses_golden/excluded_files

@@ -32,6 +32,7 @@
 ../../../flutter/display_list/benchmarking/dl_complexity_unittests.cc
 ../../../flutter/display_list/display_list_unittests.cc
 ../../../flutter/display_list/dl_color_unittests.cc
+../../../flutter/display_list/dl_op_spy_unittests.cc
 ../../../flutter/display_list/dl_paint_unittests.cc
 ../../../flutter/display_list/dl_vertices_unittests.cc
 ../../../flutter/display_list/effects/dl_color_filter_unittests.cc
@@ -53,6 +54,7 @@
 ../../../flutter/flow/flow_run_all_unittests.cc
 ../../../flutter/flow/frame_timings_recorder_unittests.cc
 ../../../flutter/flow/gl_context_switch_unittests.cc
+../../../flutter/flow/layers/aiks_layer_unittests.cc
 ../../../flutter/flow/layers/backdrop_filter_layer_unittests.cc
 ../../../flutter/flow/layers/checkerboard_layertree_unittests.cc
 ../../../flutter/flow/layers/clip_path_layer_unittests.cc
@@ -222,7 +224,6 @@
 ../../../flutter/runtime/type_conversions_unittests.cc
 ../../../flutter/shell/common/animator_unittests.cc
 ../../../flutter/shell/common/context_options_unittests.cc
-../../../flutter/shell/common/dl_op_spy_unittests.cc
 ../../../flutter/shell/common/engine_unittests.cc
 ../../../flutter/shell/common/fixtures
 ../../../flutter/shell/common/input_events_unittests.cc

ci/licenses_golden/licenses_flutter

@@ -735,6 +735,8 @@ ORIGIN: ../../../flutter/display_list/dl_op_recorder.cc + ../../../flutter/LICEN
 ORIGIN: ../../../flutter/display_list/dl_op_recorder.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/display_list/dl_op_records.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/display_list/dl_op_records.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/display_list/dl_op_spy.cc + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/display_list/dl_op_spy.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/display_list/dl_paint.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/display_list/dl_paint.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/display_list/dl_sampling_options.h + ../../../flutter/LICENSE
@@ -789,6 +791,8 @@ ORIGIN: ../../../flutter/flow/frame_timings.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/frame_timings.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/layer_snapshot_store.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/layer_snapshot_store.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/flow/layers/aiks_layer.cc + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/flow/layers/aiks_layer.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/layers/backdrop_filter_layer.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/layers/backdrop_filter_layer.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/flow/layers/cacheable_layer.cc + ../../../flutter/LICENSE
@@ -1167,6 +1171,8 @@ ORIGIN: ../../../flutter/impeller/core/texture_descriptor.cc + ../../../flutter/
 ORIGIN: ../../../flutter/impeller/core/texture_descriptor.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/impeller/core/vertex_buffer.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/impeller/core/vertex_buffer.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/impeller/display_list/dl_aiks_canvas.cc + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/impeller/display_list/dl_aiks_canvas.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/impeller/display_list/dl_dispatcher.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/impeller/display_list/dl_dispatcher.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/impeller/display_list/dl_image_impeller.cc + ../../../flutter/LICENSE
@@ -2247,8 +2253,6 @@ ORIGIN: ../../../flutter/shell/common/display.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/display.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/display_manager.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/display_manager.h + ../../../flutter/LICENSE
-ORIGIN: ../../../flutter/shell/common/dl_op_spy.cc + ../../../flutter/LICENSE
-ORIGIN: ../../../flutter/shell/common/dl_op_spy.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/engine.cc + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/engine.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/common/pipeline.cc + ../../../flutter/LICENSE
@@ -3485,6 +3489,8 @@ FILE: ../../../flutter/display_list/dl_op_recorder.cc
 FILE: ../../../flutter/display_list/dl_op_recorder.h
 FILE: ../../../flutter/display_list/dl_op_records.cc
 FILE: ../../../flutter/display_list/dl_op_records.h
+FILE: ../../../flutter/display_list/dl_op_spy.cc
+FILE: ../../../flutter/display_list/dl_op_spy.h
 FILE: ../../../flutter/display_list/dl_paint.cc
 FILE: ../../../flutter/display_list/dl_paint.h
 FILE: ../../../flutter/display_list/dl_sampling_options.h
@@ -3539,6 +3545,8 @@ FILE: ../../../flutter/flow/frame_timings.cc
 FILE: ../../../flutter/flow/frame_timings.h
 FILE: ../../../flutter/flow/layer_snapshot_store.cc
 FILE: ../../../flutter/flow/layer_snapshot_store.h
+FILE: ../../../flutter/flow/layers/aiks_layer.cc
+FILE: ../../../flutter/flow/layers/aiks_layer.h
 FILE: ../../../flutter/flow/layers/backdrop_filter_layer.cc
 FILE: ../../../flutter/flow/layers/backdrop_filter_layer.h
 FILE: ../../../flutter/flow/layers/cacheable_layer.cc
@@ -3917,6 +3925,8 @@ FILE: ../../../flutter/impeller/core/texture_descriptor.cc
 FILE: ../../../flutter/impeller/core/texture_descriptor.h
 FILE: ../../../flutter/impeller/core/vertex_buffer.cc
 FILE: ../../../flutter/impeller/core/vertex_buffer.h
+FILE: ../../../flutter/impeller/display_list/dl_aiks_canvas.cc
+FILE: ../../../flutter/impeller/display_list/dl_aiks_canvas.h
 FILE: ../../../flutter/impeller/display_list/dl_dispatcher.cc
 FILE: ../../../flutter/impeller/display_list/dl_dispatcher.h
 FILE: ../../../flutter/impeller/display_list/dl_image_impeller.cc
@@ -5002,8 +5012,6 @@ FILE: ../../../flutter/shell/common/display.cc
 FILE: ../../../flutter/shell/common/display.h
 FILE: ../../../flutter/shell/common/display_manager.cc
 FILE: ../../../flutter/shell/common/display_manager.h
-FILE: ../../../flutter/shell/common/dl_op_spy.cc
-FILE: ../../../flutter/shell/common/dl_op_spy.h
 FILE: ../../../flutter/shell/common/engine.cc
 FILE: ../../../flutter/shell/common/engine.h
 FILE: ../../../flutter/shell/common/pipeline.cc

display_list/BUILD.gn

@@ -43,6 +43,8 @@ source_set("display_list") {
     "dl_op_recorder.h",
     "dl_op_records.cc",
     "dl_op_records.h",
+    "dl_op_spy.cc",
+    "dl_op_spy.h",
     "dl_paint.cc",
     "dl_paint.h",
     "dl_sampling_options.h",
@@ -111,6 +113,7 @@ if (enable_unittests) {
       "benchmarking/dl_complexity_unittests.cc",
       "display_list_unittests.cc",
       "dl_color_unittests.cc",
+      "dl_op_spy_unittests.cc",
       "dl_paint_unittests.cc",
       "dl_vertices_unittests.cc",
       "effects/dl_color_filter_unittests.cc",

display_list/display_list.cc

@@ -33,7 +33,7 @@ DisplayList::DisplayList(DlStorage&& storage,
                          bool can_apply_group_opacity,
                          bool is_ui_thread_safe,
                          bool modifies_transparent_black,
-                         sk_sp<const DlRTree> rtree)
+                         std::shared_ptr<const DlRTree> rtree)
     : storage_(std::move(storage)),
       op_count_(op_count),
       nested_byte_count_(nested_byte_count),

display_list/display_list.h

@@ -234,7 +234,7 @@ class DisplayList : public SkRefCnt {
   const SkRect& bounds() const { return bounds_; }
 
   bool has_rtree() const { return rtree_ != nullptr; }
-  sk_sp<const DlRTree> rtree() const { return rtree_; }
+  std::shared_ptr<const DlRTree> rtree() const { return rtree_; }
 
   bool Equals(const DisplayList* other) const;
   bool Equals(const DisplayList& other) const { return Equals(&other); }
@@ -300,7 +300,7 @@ class DisplayList : public SkRefCnt {
               bool can_apply_group_opacity,
               bool is_ui_thread_safe,
               bool modifies_transparent_black,
-              sk_sp<const DlRTree> rtree);
+              std::shared_ptr<const DlRTree> rtree);
 
   static uint32_t next_unique_id();
 
@@ -317,7 +317,7 @@ class DisplayList : public SkRefCnt {
   const bool is_ui_thread_safe_;
   const bool modifies_transparent_black_;
 
-  const sk_sp<const DlRTree> rtree_;
+  const std::shared_ptr<const DlRTree> rtree_;
 
   void Dispatch(DlOpReceiver& ctx,
                 uint8_t* ptr,

display_list/display_list_unittests.cc

@@ -1932,7 +1932,7 @@ TEST_F(DisplayListTest, FlatDrawPointsProducesBounds) {
   }
 }
 
-static void test_rtree(const sk_sp<const DlRTree>& rtree,
+static void test_rtree(const std::shared_ptr<const DlRTree>& rtree,
                        const SkRect& query,
                        std::vector<SkRect> expected_rects,
                        const std::vector<int>& expected_indices) {

display_list/dl_canvas.h

@@ -18,6 +18,10 @@
 #include "third_party/skia/include/core/SkRect.h"
 #include "third_party/skia/include/core/SkTextBlob.h"
 
+namespace impeller {
+struct Picture;
+}  // namespace impeller
+
 namespace flutter {
 
 //------------------------------------------------------------------------------
@@ -61,7 +65,12 @@ class DlCanvas {
                          const DlImageFilter* backdrop = nullptr) = 0;
   virtual void Restore() = 0;
   virtual int GetSaveCount() const = 0;
-  virtual void RestoreToCount(int restore_count) = 0;
+  virtual void RestoreToCount(int restore_count) {
+    FML_DCHECK(restore_count <= GetSaveCount());
+    while (restore_count < GetSaveCount() && GetSaveCount() > 1) {
+      Restore();
+    }
+  }
 
   virtual void Translate(SkScalar tx, SkScalar ty) = 0;
   virtual void Scale(SkScalar sx, SkScalar sy) = 0;
@@ -201,6 +210,9 @@ class DlCanvas {
                          const DlPaint* paint = nullptr) = 0;
   virtual void DrawDisplayList(const sk_sp<DisplayList> display_list,
                                SkScalar opacity = SK_Scalar1) = 0;
+  virtual void DrawImpellerPicture(
+      const std::shared_ptr<const impeller::Picture>& picture,
+      SkScalar opacity = SK_Scalar1) = 0;
   virtual void DrawTextBlob(const sk_sp<SkTextBlob>& blob,
                             SkScalar x,
                             SkScalar y,

display_list/dl_canvas_to_receiver.cc

@@ -811,6 +811,12 @@ void DlCanvasToReceiver::DrawDisplayList(const sk_sp<DisplayList> display_list,
           : OpResult::kPreservesTransparency,
       display_list->can_apply_group_opacity());
 }
+void DlCanvasToReceiver::DrawImpellerPicture(
+    const std::shared_ptr<const impeller::Picture>& picture,
+    SkScalar opacity) {
+  FML_LOG(ERROR) << "Cannot draw Impeller Picture in to a a display list.";
+  FML_DCHECK(false);
+}
 void DlCanvasToReceiver::DrawTextBlob(const sk_sp<SkTextBlob>& blob,
                                       SkScalar x,
                                       SkScalar y,

display_list/dl_canvas_to_receiver.h

@@ -10,6 +10,10 @@
 #include "flutter/display_list/dl_op_receiver.h"
 #include "flutter/fml/macros.h"
 
+namespace impeller {
+struct Picture;
+}
+
 namespace flutter {
 
 class DlCanvasReceiver : public DlOpReceiver {
@@ -337,6 +341,10 @@ class DlCanvasToReceiver : public virtual DlCanvas,  //
   void DrawDisplayList(const sk_sp<DisplayList> display_list,
                        SkScalar opacity = SK_Scalar1) override;
   // |DlCanvas|
+  void DrawImpellerPicture(
+      const std::shared_ptr<const impeller::Picture>& picture,
+      SkScalar opacity = SK_Scalar1) override;
+  // |DlCanvas|
   void DrawTextBlob(const sk_sp<SkTextBlob>& blob,
                     SkScalar x,
                     SkScalar y,

shell/common/dl_op_spy.cc → display_list/dl_op_spy.cc

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "flutter/shell/common/dl_op_spy.h"
+#include "flutter/display_list/dl_op_spy.h"
 
 namespace flutter {
 

shell/common/dl_op_spy.h → display_list/dl_op_spy.h

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef FLUTTER_DISPLAY_LIST_DL_OP_SPY_H_
-#define FLUTTER_DISPLAY_LIST_DL_OP_SPY_H_
+#pragma once
 
 #include "flutter/display_list/dl_op_receiver.h"
 #include "flutter/display_list/utils/dl_receiver_utils.h"
@@ -105,5 +104,3 @@ class DlOpSpy final : public virtual DlOpReceiver,
 };
 
 }  // namespace flutter
-
-#endif  // FLUTTER_DISPLAY_LIST_DL_OP_SPY_H_

shell/common/dl_op_spy_unittests.cc → display_list/dl_op_spy_unittests.cc

@@ -4,7 +4,7 @@
 
 #include "flutter/display_list/display_list.h"
 #include "flutter/display_list/display_list_builder.h"
-#include "flutter/shell/common/dl_op_spy.h"
+#include "flutter/display_list/dl_op_spy.h"
 #include "flutter/testing/testing.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "third_party/skia/include/core/SkRSXform.h"

display_list/geometry/dl_rtree.h

@@ -25,7 +25,7 @@ namespace flutter {
 /// - Query for a set of non-overlapping rectangles that are joined
 ///   from the original rectangles that intersect a query rect
 ///   @see |searchAndConsolidateRects|
-class DlRTree : public SkRefCnt {
+class DlRTree {
  private:
   static constexpr int kMaxChildren = 11;
 

display_list/skia/dl_sk_canvas.cc

@@ -294,6 +294,13 @@ void DlSkCanvasAdapter::DrawAtlas(const sk_sp<DlImage>& atlas,
                        ToSk(sampling), cullRect, sk_paint());
 }
 
+void DlSkCanvasAdapter::DrawImpellerPicture(
+    const std::shared_ptr<const impeller::Picture>& picture,
+    SkScalar opacity) {
+  FML_LOG(ERROR) << "Cannot draw Impeller Picture in to a Skia canvas.";
+  FML_DCHECK(false);
+}
+
 void DlSkCanvasAdapter::DrawDisplayList(const sk_sp<DisplayList> display_list,
                                         SkScalar opacity) {
   const int restore_count = delegate_->getSaveCount();

display_list/skia/dl_sk_canvas.h

@@ -138,6 +138,9 @@ class DlSkCanvasAdapter final : public virtual DlCanvas {
                  DlImageSampling sampling,
                  const SkRect* cullRect,
                  const DlPaint* paint = nullptr) override;
+  void DrawImpellerPicture(
+      const std::shared_ptr<const impeller::Picture>& picture,
+      SkScalar opacity = SK_Scalar1) override;
   void DrawDisplayList(const sk_sp<DisplayList> display_list,
                        SkScalar opacity = SK_Scalar1) override;
   void DrawTextBlob(const sk_sp<SkTextBlob>& blob,

display_list/utils/dl_bounds_accumulator.cc

@@ -125,10 +125,11 @@ SkRect RTreeBoundsAccumulator::bounds() const {
   return accumulator.bounds();
 }
 
-sk_sp<DlRTree> RTreeBoundsAccumulator::rtree() const {
+std::shared_ptr<DlRTree> RTreeBoundsAccumulator::rtree() const {
   FML_DCHECK(saved_offsets_.empty());
-  return sk_make_sp<DlRTree>(rects_.data(), rects_.size(), rect_indices_.data(),
-                             [](int id) { return id >= 0; });
+  return std::make_shared<DlRTree>(rects_.data(), rects_.size(),
+                                   rect_indices_.data(),
+                                   [](int id) { return id >= 0; });
 }
 
 }  // namespace flutter

display_list/utils/dl_bounds_accumulator.h

@@ -87,7 +87,7 @@ class BoundsAccumulator {
 
   virtual SkRect bounds() const = 0;
 
-  virtual sk_sp<DlRTree> rtree() const = 0;
+  virtual std::shared_ptr<DlRTree> rtree() const = 0;
 };
 
 class RectBoundsAccumulator final : public virtual BoundsAccumulator {
@@ -111,7 +111,7 @@ class RectBoundsAccumulator final : public virtual BoundsAccumulator {
 
   Type type() const override { return Type::kRect; }
 
-  sk_sp<DlRTree> rtree() const override { return nullptr; }
+  std::shared_ptr<DlRTree> rtree() const override { return nullptr; }
 
  private:
   class AccumulationRect {
@@ -150,7 +150,7 @@ class RTreeBoundsAccumulator final : public virtual BoundsAccumulator {
 
   SkRect bounds() const override;
 
-  sk_sp<DlRTree> rtree() const override;
+  std::shared_ptr<DlRTree> rtree() const override;
 
   Type type() const override { return Type::kRTree; }
 

flow/BUILD.gn

@@ -20,6 +20,8 @@ source_set("flow") {
     "frame_timings.h",
     "layer_snapshot_store.cc",
     "layer_snapshot_store.h",
+    "layers/aiks_layer.cc",
+    "layers/aiks_layer.h",
     "layers/backdrop_filter_layer.cc",
     "layers/backdrop_filter_layer.h",
     "layers/cacheable_layer.cc",
@@ -192,6 +194,11 @@ if (enable_unittests) {
       "//third_party/skia",
     ]
 
+    if (impeller_supports_rendering) {
+      sources += [ "layers/aiks_layer_unittests.cc" ]
+      deps += [ "//flutter/impeller" ]
+    }
+
     if (!defined(defines)) {
       defines = []
     }