Parse android layer annotations in debugger, play back layers

Bug: skia:9626
Change-Id: I3ae8fa83520690f9af534e9ab0b70834d7890fb0
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/256100
Commit-Queue: Nathaniel Nifong <nifong@google.com>
Reviewed-by: Kevin Lubick <kjlubick@google.com>

Author: Nathaniel Nifong

BUILD.gn

@@ -1034,6 +1034,7 @@ if (target_cpu == "wasm") {
       "tools/SkSharingProc.cpp",
       "tools/UrlDataManager.cpp",
       "tools/debugger/DebugCanvas.cpp",
+      "tools/debugger/DebugLayerManager.cpp",
       "tools/debugger/DrawCommand.cpp",
       "tools/debugger/JsonWriteBuffer.cpp",
     ]
@@ -1455,6 +1456,7 @@ if (skia_enable_tools) {
       "tools/ToolUtils.cpp",
       "tools/UrlDataManager.cpp",
       "tools/debugger/DebugCanvas.cpp",
+      "tools/debugger/DebugLayerManager.cpp",
       "tools/debugger/DrawCommand.cpp",
       "tools/debugger/JsonWriteBuffer.cpp",
       "tools/fonts/RandomScalerContext.cpp",
@@ -1998,6 +2000,7 @@ if (skia_enable_tools) {
       "fuzz/oss_fuzz/FuzzTextBlobDeserialize.cpp",
       "tools/UrlDataManager.cpp",
       "tools/debugger/DebugCanvas.cpp",
+      "tools/debugger/DebugLayerManager.cpp",
       "tools/debugger/DrawCommand.cpp",
       "tools/debugger/JsonWriteBuffer.cpp",
     ]
@@ -2416,6 +2419,7 @@ if (skia_enable_tools) {
       sources = [
         "tools/UrlDataManager.cpp",
         "tools/debugger/DebugCanvas.cpp",
+        "tools/debugger/DebugLayerManager.cpp",
         "tools/debugger/DrawCommand.cpp",
         "tools/debugger/JsonWriteBuffer.cpp",
         "tools/mdbviz/MainWindow.cpp",

experimental/wasm-skp-debugger/debugger_bindings.cpp

@@ -13,7 +13,12 @@
 #include "tools/SkSharingProc.h"
 #include "tools/UrlDataManager.h"
 #include "tools/debugger/DebugCanvas.h"
+#include "tools/debugger/DebugLayerManager.h"
 
+#include <memory>
+#include <string>
+#include <string_view>
+#include <vector>
 #include <emscripten.h>
 #include <emscripten/bind.h>
 
@@ -98,10 +103,20 @@ class SkpDebugPlayer {
         SkDebugf("Constrained command index (%d) within this frame's length (%d)\n", index, cmdlen);
         index = cmdlen-1;
       }
+      auto* canvas = surface->getCanvas();
+      canvas->clear(SK_ColorTRANSPARENT);
       frames[fp]->drawTo(surface->getCanvas(), index);
       surface->getCanvas()->flush();
     }
 
+    // Draws to the end of the current frame.
+    void draw(SkSurface* surface) {
+      auto* canvas = surface->getCanvas();
+      canvas->clear(SK_ColorTRANSPARENT);
+      frames[fp]->draw(surface->getCanvas());
+      surface->getCanvas()->flush();
+    }
+
     const SkIRect& getBounds() { return fBounds; }
 
     // The following three operations apply to every frame because they are overdraw features.
@@ -201,6 +216,11 @@ class SkpDebugPlayer {
       return toSimpleImageInfo(fImages[index]->imageInfo(), fImages[index].get());
     }
 
+    // return a list of layer draw events that happened at the beginning of this frame.
+    std::vector<DebugLayerManager::DrawEventSummary> getLayerDrawEvents() {
+      return fLayerManager->summarizeEvents(fp);
+    }
+
   private:
 
       // Loads a single frame (traditional) skp file from the provided data stream and returns
@@ -215,54 +235,57 @@ class SkpDebugPlayer {
         SkDebugf("Parsed SKP file.\n");
         // Make debug canvas using bounds from SkPicture
         fBounds = picture->cullRect().roundOut();
-        std::unique_ptr<DebugCanvas> debugDanvas = std::make_unique<DebugCanvas>(fBounds);
-        SkDebugf("DebugCanvas created.\n");
+        std::unique_ptr<DebugCanvas> debugCanvas = std::make_unique<DebugCanvas>(fBounds);
 
         // Only draw picture to the debug canvas once.
-        debugDanvas->drawPicture(picture);
-        SkDebugf("Added picture with %d commands.\n", debugDanvas->getSize());
-        return debugDanvas;
+        debugCanvas->drawPicture(picture);
+        return debugCanvas;
       }
 
       void loadMultiFrame(SkMemoryStream* stream) {
+        // Attempt to deserialize with an image sharing serial proc.
+        auto deserialContext = std::make_unique<SkSharingDeserialContext>();
+        SkDeserialProcs procs;
+        procs.fImageProc = SkSharingDeserialContext::deserializeImage;
+        procs.fImageCtx = deserialContext.get();
+
+        int page_count = SkMultiPictureDocumentReadPageCount(stream);
+        if (!page_count) {
+          SkDebugf("Not a MultiPictureDocument");
+          return;
+        }
+        SkDebugf("Expecting %d frames\n", page_count);
 
-          // Attempt to deserialize with an image sharing serial proc.
-          auto deserialContext = std::make_unique<SkSharingDeserialContext>();
-          SkDeserialProcs procs;
-          procs.fImageProc = SkSharingDeserialContext::deserializeImage;
-          procs.fImageCtx = deserialContext.get();
+        std::vector<SkDocumentPage> pages(page_count);
+        if (!SkMultiPictureDocumentRead(stream, pages.data(), page_count, &procs)) {
+          SkDebugf("Reading frames from MultiPictureDocument failed");
+          return;
+        }
 
-          int page_count = SkMultiPictureDocumentReadPageCount(stream);
-          if (!page_count) {
-            SkDebugf("Not a MultiPictureDocument");
-            return;
-          }
-          SkDebugf("Expecting %d frames\n", page_count);
+        fLayerManager = std::make_unique<DebugLayerManager>();
 
-          std::vector<SkDocumentPage> pages(page_count);
-          if (!SkMultiPictureDocumentRead(stream, pages.data(), page_count, &procs)) {
-            SkDebugf("Reading frames from MultiPictureDocument failed");
-            return;
-          }
+        int i = 0;
+        for (const auto& page : pages) {
+          i++;
+          // Make debug canvas using bounds from SkPicture
+          fBounds = page.fPicture->cullRect().roundOut();
+          std::unique_ptr<DebugCanvas> debugCanvas = std::make_unique<DebugCanvas>(fBounds);
+          debugCanvas->setLayerManagerAndFrame(fLayerManager.get(), i);
 
-          for (const auto& page : pages) {
-            // Make debug canvas using bounds from SkPicture
-            fBounds = page.fPicture->cullRect().roundOut();
-            std::unique_ptr<DebugCanvas> debugDanvas = std::make_unique<DebugCanvas>(fBounds);
-            // Only draw picture to the debug canvas once.
-            debugDanvas->drawPicture(page.fPicture);
-            SkDebugf("Added picture with %d commands.\n", debugDanvas->getSize());
-
-            if (debugDanvas->getSize() <=0 ){
-              SkDebugf("Skipped corrupted frame, had %d commands \n", debugDanvas->getSize());
-              continue;
-            }
-            debugDanvas->setOverdrawViz(false);
-            debugDanvas->setDrawGpuOpBounds(false);
-            debugDanvas->setClipVizColor(SK_ColorTRANSPARENT);
-            frames.push_back(std::move(debugDanvas));
+          // Only draw picture to the debug canvas once.
+          debugCanvas->drawPicture(page.fPicture);
+
+          if (debugCanvas->getSize() <=0 ){
+            SkDebugf("Skipped corrupted frame, had %d commands \n", debugCanvas->getSize());
+            continue;
           }
-          fImages = deserialContext->fImages;
+          // If you don't set these, they're undefined.
+          debugCanvas->setOverdrawViz(false);
+          debugCanvas->setDrawGpuOpBounds(false);
+          debugCanvas->setClipVizColor(SK_ColorTRANSPARENT);
+          frames.push_back(std::move(debugCanvas));
+        }
+        fImages = deserialContext->fImages;
       }
 
       // A vector of DebugCanvas, each one initialized to a frame of the animation.
@@ -285,6 +308,10 @@ class SkpDebugPlayer {
       // find anything. TODO(nifong): Unify these two numbering schemes in CollatingCanvas.
       UrlDataManager udm;
 
+      // A structure holding the picture information needed to draw any layers used in an mskp file
+      // individual frames hold a pointer to it, store draw events, and request images from it.
+      // it is stateful and is set to the current frame at all times.
+      std::unique_ptr<DebugLayerManager> fLayerManager;
 };
 
 #if SK_SUPPORT_GPU
@@ -356,6 +383,7 @@ EMSCRIPTEN_BINDINGS(my_module) {
     .constructor<>()
     .function("loadSkp",              &SkpDebugPlayer::loadSkp, allow_raw_pointers())
     .function("drawTo",               &SkpDebugPlayer::drawTo, allow_raw_pointers())
+    .function("draw",                 &SkpDebugPlayer::draw, allow_raw_pointers())
     .function("getBounds",            &SkpDebugPlayer::getBounds)
     .function("setOverdrawVis",       &SkpDebugPlayer::setOverdrawVis)
     .function("setClipVizColor",      &SkpDebugPlayer::setClipVizColor)
@@ -369,14 +397,24 @@ EMSCRIPTEN_BINDINGS(my_module) {
     .function("getFrameCount",        &SkpDebugPlayer::getFrameCount)
     .function("getImageResource",     &SkpDebugPlayer::getImageResource)
     .function("getImageCount",        &SkpDebugPlayer::getImageCount)
-    .function("getImageInfo",         &SkpDebugPlayer::getImageInfo);
+    .function("getImageInfo",         &SkpDebugPlayer::getImageInfo)
+    .function("getLayerDrawEvents",   &SkpDebugPlayer::getLayerDrawEvents);
 
   // Structs used as arguments or returns to the functions above
   value_object<SkIRect>("SkIRect")
       .field("fLeft",   &SkIRect::fLeft)
       .field("fTop",    &SkIRect::fTop)
       .field("fRight",  &SkIRect::fRight)
       .field("fBottom", &SkIRect::fBottom);
+  // emscripten provided the following convenience function for binding vector<T>
+  // https://emscripten.org/docs/api_reference/bind.h.html#_CPPv415register_vectorPKc
+  register_vector<DebugLayerManager::DrawEventSummary>("VectorDrawEventSummary");
+  value_object<DebugLayerManager::DrawEventSummary>("DebugLayerManager::DrawEventSummary")
+    .field("nodeId",       &DebugLayerManager::DrawEventSummary::nodeId)
+    .field("fullRedraw",   &DebugLayerManager::DrawEventSummary::fullRedraw)
+    .field("commandCount", &DebugLayerManager::DrawEventSummary::commandCount)
+    .field("layerWidth",   &DebugLayerManager::DrawEventSummary::layerWidth)
+    .field("layerHeight",  &DebugLayerManager::DrawEventSummary::layerHeight);
 
   // Symbols needed by cpu.js to perform surface creation and flushing.
   enum_<SkColorType>("ColorType")

gn/tests.gni

@@ -50,6 +50,7 @@ tests_sources = [
   "$_tests/ColorTest.cpp",
   "$_tests/CopySurfaceTest.cpp",
   "$_tests/CubicMapTest.cpp",
+  "$_tests/DebugLayerManagerTest.cpp",
   "$_tests/DashPathEffectTest.cpp",
   "$_tests/DataRefTest.cpp",
   "$_tests/DefaultPathRendererTest.cpp",

tests/DebugLayerManagerTest.cpp

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2019 Google Inc.
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "include/core/SkPaint.h"
+#include "include/core/SkPicture.h"
+#include "include/core/SkPictureRecorder.h"
+#include "include/core/SkRect.h"
+#include "tests/Test.h"
+#include "tools/debugger/DebugLayerManager.h"
+
+// Adds one full update, one partial update, and requests one image a few frames later.
+static void test_basic(skiatest::Reporter* reporter) {
+  // prepare supporting objects
+  int layerWidth = 100;
+  int layerHeight = 100;
+
+  // make a picture that fully updates the layer
+  SkPictureRecorder rec;
+  SkCanvas* canvas = rec.beginRecording(layerWidth, layerHeight);
+  canvas->clear(0x00000000);
+  SkPaint paint;
+  paint.setColor(SK_ColorBLUE);
+  canvas->drawOval(SkRect::MakeLTRB(1,1,99,99), paint);
+  canvas->flush();
+  auto picture1 = rec.finishRecordingAsPicture();
+  SkIRect dirtyRectFull = SkIRect::MakeLTRB(0, 0, layerWidth, layerHeight);
+
+  // make a second picture that acts as a partial update.
+  SkPictureRecorder rec2;
+  canvas = rec2.beginRecording(layerWidth, layerHeight);
+  paint.setColor(SK_ColorGREEN);
+  canvas->drawOval(SkRect::MakeLTRB(40,40,60,60), paint);
+  canvas->flush();
+  auto picture2 = rec2.finishRecordingAsPicture();
+  SkIRect dirtyRectPartial = SkIRect::MakeLTRB(40,40,60,60);
+
+  int node = 2;
+
+  // create and exercise DebugLayerManager
+  DebugLayerManager dlm;
+  dlm.storeSkPicture(node, 0, picture1, dirtyRectFull);
+  dlm.storeSkPicture(node, 10, picture2, dirtyRectPartial);
+  auto frames = dlm.listFramesForNode(node);
+
+  // Confirm the layer manager stored these at the right places.
+  REPORTER_ASSERT(reporter, frames.size() == 2);
+  REPORTER_ASSERT(reporter, frames[0] == 0);
+  REPORTER_ASSERT(reporter, frames[1] == 10);
+
+  SkPixmap pixmap;
+  // request an image of the layer between the two updates.
+  for (int i=0; i<10; i++) {
+    auto image = dlm.getLayerAsImage(node, i);
+    REPORTER_ASSERT(reporter, image->width() == layerWidth);
+    REPORTER_ASSERT(reporter, image->height() == layerHeight);
+    // confirm center is blue, proving only first pic was drawn.
+    image->peekPixels(&pixmap);
+    SkColor paintColor = pixmap.getColor(50, 50);
+    REPORTER_ASSERT(reporter, paintColor == SK_ColorBLUE);
+  }
+
+  // For any images after the second draw, confirm the center is green, but the area just outside
+  // that smaller circle is still blue, proving dlm drew both pictures.
+  for (int i=10; i<12; i++) {
+    auto image = dlm.getLayerAsImage(node, i);
+    REPORTER_ASSERT(reporter, image->width() == layerWidth);
+    REPORTER_ASSERT(reporter, image->height() == layerHeight);
+    image->peekPixels(&pixmap);
+    auto innerColor = pixmap.getColor(50, 50);
+    REPORTER_ASSERT(reporter, innerColor == SK_ColorGREEN);
+    auto outerColor = pixmap.getColor(10, 50);
+    REPORTER_ASSERT(reporter, outerColor == SK_ColorBLUE);
+  }
+
+
+}
+
+DEF_TEST(DebugLayerManagerTest, reporter) {
+  test_basic(reporter);
+}