react-native-skia 3.0.0 → 3.0.2

package/cpp/rnskia/RNSkView.h

@@ -1,31 +1,29 @@
-
 #pragma once
 
+#include <atomic>
+#include <functional>
 #include <memory>
+#include <mutex>
 #include <string>
 #include <unordered_map>
+#include <utility>
 #include <vector>
 
+#include <jsi/jsi.h>
+
+#include "RNSkCanvasProvider.h"
+#include "RNSkGraphiteProducer.h"
+#include "RNSkGraphiteTarget.h"
 #include "RNSkPlatformContext.h"
 #include "jsi/ViewProperty.h"
-
-#include "api/JsiSkImage.h"
-#include "api/JsiSkPoint.h"
-#include "api/JsiSkRect.h"
+#include "utils/RNSkLog.h"
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdocumentation"
 
 #include "include/core/SkCanvas.h"
-#include "include/core/SkSurface.h"
-
-#if defined(SK_GRAPHITE)
-#include "RNDawnContext.h"
-#include "RNDawnUtils.h"
-#include "include/gpu/graphite/Recording.h"
-#include "include/gpu/graphite/TextureInfo.h"
-#include "include/gpu/graphite/dawn/DawnGraphiteTypes.h"
-#endif
+#include "include/core/SkImage.h"
+#include "include/core/SkRect.h"
 
 #pragma clang diagnostic pop
 
@@ -33,211 +31,108 @@ namespace RNSkia {
 
 namespace jsi = facebook::jsi;
 
-#if defined(SK_GRAPHITE)
 /**
- * Describes the texture a Graphite recording is replayed onto: the pixel size
- * and the format of a window (or offscreen) surface. A deferred canvas is
- * recorded against this description, so it can be created before the surface
- * itself exists.
+ * The native side of a Skia view. Frames come from one of two producers: JS
+ * records them itself through the view's target
+ * (SkiaViewApi.makeGraphiteContext), or <Canvas> hands over a recorder (or a
+ * picture) that the render thread pool records for the view. Either way the
+ * recordings are queued on the target; the view presents them onto its canvas
+ * provider on the main thread, aligned with the platform's display link.
+ *
+ * Threading: the registry side (RNSkJsiViewApi) runs on the JS thread, except
+ * applyUpdates() which a Reanimated mapper calls on the UI runtime; snapshots
+ * replay on the calling thread. Presenting runs on the main thread.
  */
-struct RNSkGraphiteTargetInfo {
-  int width = 0;
-  int height = 0;
-  SkColorType colorType = kUnknown_SkColorType;
-  skgpu::graphite::TextureInfo textureInfo;
-};
-#endif
-
-class RNSkCanvasProvider {
-public:
-  explicit RNSkCanvasProvider(std::function<void()> requestRedraw)
-      : _requestRedraw(requestRedraw) {}
-
-  virtual ~RNSkCanvasProvider() = default;
-
-#if defined(SK_GRAPHITE)
-  /**
-   Describes the current target texture. Safe to call from any thread;
-   returns false while there is no surface to describe.
-   */
-  virtual bool getGraphiteTargetInfo(RNSkGraphiteTargetInfo *info) {
-    return false;
-  }
-
-  /**
-   Replays the recordings, in order, onto the target texture and presents
-   it. Called on the thread that owns the surface.
-   */
-  virtual bool presentRecordings(
-      const std::vector<skgpu::graphite::Recording *> &recordings) {
-    return false;
-  }
-#endif
-
-  /**
-   Returns the scaled width of the view
-   */
-  virtual int getWidth() = 0;
-
-  /**
-   Returns the scaled height of the view
-   */
-  virtual int getHeight() = 0;
-
-  /**
-   Render to a canvas
-   */
-  virtual bool renderToCanvas(const std::function<void(SkCanvas *)> &) = 0;
-
-protected:
-  std::function<void()> _requestRedraw;
-};
-
-class RNSkRenderer {
-public:
-  explicit RNSkRenderer(std::function<void()> requestRedraw)
-      : _requestRedraw(std::move(requestRedraw)), _showDebugOverlays(false) {}
-
-  virtual void
-  renderImmediate(std::shared_ptr<RNSkCanvasProvider> canvasProvider) = 0;
-
-  void setShowDebugOverlays(bool showDebugOverlays) {
-    _showDebugOverlays = showDebugOverlays;
-  }
-  bool getShowDebugOverlays() const { return _showDebugOverlays; }
-
-protected:
-  std::function<void()> _requestRedraw;
-  bool _showDebugOverlays;
-};
-
-class RNSkOffscreenCanvasProvider : public RNSkCanvasProvider {
+class RNSkView : public std::enable_shared_from_this<RNSkView> {
 public:
-  RNSkOffscreenCanvasProvider(
-      const std::shared_ptr<RNSkPlatformContext> &context,
-      std::function<void()> requestRedraw, float width, float height)
-      : RNSkCanvasProvider(std::move(requestRedraw)), _width(width),
-        _height(height), _context(context) {
-    _surface = context->makeOffscreenSurface(_width, _height);
-    _pd = context->getPixelDensity();
+  RNSkView(std::shared_ptr<RNSkPlatformContext> context,
+           std::shared_ptr<RNSkCanvasProvider> canvasProvider)
+      : _platformContext(std::move(context)),
+        _canvasProvider(std::move(canvasProvider)),
+        _producer(std::make_shared<RNSkGraphiteProducer>()) {
+    // A new surface or a new size: present again. The platform view owns
+    // the provider together with this view, and the destructor clears the
+    // callback, so a raw capture is safe.
+    _canvasProvider->setRequestRedraw([this]() { requestRedraw(); });
   }
 
-  virtual ~RNSkOffscreenCanvasProvider() = default;
-
-  /**
-   Returns a snapshot of the current surface/canvas
-   */
-  sk_sp<SkImage> makeSnapshot(SkRect *bounds) {
-    if (_surface == nullptr) {
-      return nullptr;
+  ~RNSkView() {
+    _canvasProvider->setRequestRedraw(nullptr);
+    std::shared_ptr<RNSkGraphiteTarget> target;
+    {
+      std::lock_guard<std::mutex> lock(_mutex);
+      target = std::move(_target);
     }
-    sk_sp<SkImage> image;
-    if (bounds != nullptr) {
-      SkIRect b =
-          SkIRect::MakeXYWH(bounds->x() * _pd, bounds->y() * _pd,
-                            bounds->width() * _pd, bounds->height() * _pd);
-      image = _surface->makeImageSnapshot(b);
-    } else {
-      image = _surface->makeImageSnapshot();
+    if (target) {
+      target->detach(_canvasProvider);
     }
-#if defined(SK_GRAPHITE)
-    // Only Graphite-backed surfaces have a recorder to snap/submit; a raster
-    // surface's snapshot is already a valid CPU image.
-    if (auto *recorder = _surface->recorder()) {
-      DawnContext::getInstance().submitRecording(recorder->snap().get());
-    }
-    return DawnContext::getInstance().MakeRasterImage(image);
-#else
-    auto grContext = _context->getDirectContext();
-    return image->makeRasterImage(grContext);
-#endif
   }
 
-  /**
-   Returns the scaled width of the view
-   */
-  int getWidth() override { return _width; };
-
-  /**
-   Returns the scaled height of the view
-   */
-  int getHeight() override { return _height; };
+  // Registry side ------------------------------------------------------------
 
   /**
-   Render to a canvas
+   Binds the view to its id. The target recording for this id (created by
+   whichever side came first, see RNSkGraphiteTargetRegistry) is attached to
+   the view's surface, and frames recorded before the view existed are
+   presented now.
    */
-  bool renderToCanvas(const std::function<void(SkCanvas *)> &cb) override {
-    if (_surface == nullptr) {
-      return false;
+  void setNativeId(size_t nativeId) {
+    _nativeId = nativeId;
+    std::shared_ptr<RNSkGraphiteTarget> previous;
+    {
+      std::lock_guard<std::mutex> lock(_mutex);
+      if (_target && _targetId == nativeId) {
+        return;
+      }
+      previous = std::move(_target);
+      _targetId = nativeId;
+      _target = RNSkGraphiteTargetRegistry::getInstance().getOrCreate(
+          nativeId, _platformContext);
     }
-    cb(_surface->getCanvas());
-    return true;
-  };
-
-#if defined(SK_GRAPHITE)
-  bool getGraphiteTargetInfo(RNSkGraphiteTargetInfo *info) override {
-    if (_surface == nullptr || _surface->recorder() == nullptr) {
-      return false;
+    if (previous) {
+      previous->detach(_canvasProvider);
     }
-    // Graphite gives its render targets the sampled+renderable usage, a
-    // superset of what a deferred canvas asks for.
-    auto colorType = _surface->imageInfo().colorType();
-    info->width = _width;
-    info->height = _height;
-    info->colorType = colorType;
-    info->textureInfo = skgpu::graphite::TextureInfos::MakeDawn(
-        skgpu::graphite::DawnTextureInfo(
-            skgpu::graphite::SampleCount::k1, skgpu::Mipmapped::kNo,
-            DawnUtils::textureFormatForColorType(colorType),
-            DawnUtils::DefaultTargetUsage, wgpu::TextureAspect::All));
-    return true;
-  }
-
-  bool presentRecordings(
-      const std::vector<skgpu::graphite::Recording *> &recordings) override {
-    if (_surface == nullptr || _surface->recorder() == nullptr) {
-      return false;
+    std::weak_ptr<RNSkView> weakThis = weak_from_this();
+    auto context = _platformContext;
+    auto scheduleOnMainThread = [weakThis, context]() {
+      context->runOnMainThread([weakThis]() {
+        if (auto view = weakThis.lock()) {
+          view->scheduleFrame();
+        }
+      });
+    };
+    auto target = getTarget();
+    target->attach(_canvasProvider, scheduleOnMainThread);
+    _producer->setTarget(target);
+    if (target->hasQueued()) {
+      scheduleOnMainThread();
     }
-    return DawnContext::getInstance().insertRecordings(recordings,
-                                                       _surface.get());
   }
-#endif
-
-private:
-  int _width;
-  int _height;
-  float _pd = 1.0f;
-  sk_sp<SkSurface> _surface;
-  std::shared_ptr<RNSkPlatformContext> _context;
-};
-
-class RNSkView : public std::enable_shared_from_this<RNSkView> {
-public:
-  /**
-   * Constructor
-   */
-  RNSkView(std::shared_ptr<RNSkPlatformContext> context,
-           std::shared_ptr<RNSkCanvasProvider> canvasProvider,
-           std::shared_ptr<RNSkRenderer> renderer)
-      : _platformContext(context), _canvasProvider(canvasProvider),
-        _renderer(renderer) {}
 
-  /**
-   Destructor
-   */
-  virtual ~RNSkView() {}
+  size_t getNativeId() { return _nativeId; }
 
-  virtual void setJsiProperties(
-      std::unordered_map<std::string, RNJsi::ViewProperty> &props) = 0;
+  /** Declarative content: the recorder of <Canvas>, or a picture. */
+  void setJsiProperties(
+      std::unordered_map<std::string, RNJsi::ViewProperty> &props) {
+    for (auto &prop : props) {
+      if (prop.first == "recorder") {
+        _producer->setRecorder(
+            prop.second.isRecorder() ? prop.second.getRecorder() : nullptr);
+      } else if (prop.first == "picture") {
+        _producer->setPicture(prop.second.isPicture() ? prop.second.getPicture()
+                                                      : nullptr);
+      }
+    }
+  }
 
   /**
    Reads the shared values on the calling runtime into the recording the
    view owns and schedules a frame. Returns false when there is nothing to
    update: no recording, or one other than recorderId (a stale mapper).
    */
-  virtual bool applyUpdates(jsi::Runtime &runtime, double recorderId,
-                            const jsi::Array &values) {
-    return false;
+  bool applyUpdates(jsi::Runtime &runtime, double recorderId,
+                    const jsi::Array &values) {
+    return _producer->applyUpdates(runtime, recorderId, values);
   }
 
   /**
@@ -246,91 +141,291 @@ public:
    until it is finalized, so the resources go away here rather than with the
    garbage collector.
    */
-  virtual void releaseContent() {}
+  void releaseContent() { _producer->clear(); }
 
+  /** Schedules redraw() on the main thread, once. */
   void requestRedraw() {
-    if (!_redrawRequested) {
-      _redrawRequested = true;
-      // Capture a weak pointer to this
-      auto weakThis = std::weak_ptr<RNSkView>(shared_from_this());
-
-      _platformContext->runOnMainThread([weakThis]() {
-        // Try to lock the weak pointer
-        if (auto strongThis = weakThis.lock()) {
-          // Only proceed if the object still exists
-          if (strongThis->_renderer && strongThis->_redrawRequested) {
-            strongThis->_renderer->renderImmediate(strongThis->_canvasProvider);
-            strongThis->_redrawRequested = false;
-          }
-        }
-      });
+    if (_redrawRequested.exchange(true)) {
+      return;
     }
+    std::weak_ptr<RNSkView> weakThis = weak_from_this();
+    _platformContext->runOnMainThread([weakThis]() {
+      if (auto view = weakThis.lock()) {
+        if (view->_redrawRequested) {
+          view->redraw();
+        }
+      }
+    });
   }
 
+  /**
+   Main thread. Presents everything submitted since the last frame; with
+   nothing queued, presents the last frame again (a redraw after a resize or
+   on a new surface). Without a surface the queue is left alone: the surface
+   presents it when it appears.
+   */
   void redraw() {
-    _renderer->renderImmediate(_canvasProvider);
     _redrawRequested = false;
+    RNSkGraphiteTargetInfo targetInfo;
+    if (!_canvasProvider->getTargetInfo(&targetInfo)) {
+      return;
+    }
+    // Declarative content is recorded again for the surface as it is now.
+    const bool frameComing = _producer->requestFrame();
+    auto target = getTarget();
+    std::shared_ptr<RNSkGraphiteRecording> lastPresented;
+    {
+      std::lock_guard<std::mutex> lock(_mutex);
+      lastPresented = _lastPresented;
+    }
+    std::vector<std::shared_ptr<RNSkGraphiteRecording>> recordings;
+    if (target) {
+      recordings = target->takeQueued();
+    }
+    if (recordings.empty()) {
+      // With a frame on its way, the layer keeps showing the last one until
+      // it lands: presenting it again would only cost a second present.
+      // Otherwise the last frame is presented again, also onto a surface of
+      // another size (the view was resized and nothing records for it): the
+      // frame then shows at its own size rather than nothing at all.
+      if (frameComing || lastPresented == nullptr) {
+        return;
+      }
+      if (present(_canvasProvider, targetInfo, {lastPresented},
+                  /* remember= */ true)) {
+        _producer->onFramePresented();
+      }
+      return;
+    }
+    if (present(_canvasProvider, targetInfo, recordings,
+                /* remember= */ true)) {
+      _producer->onFramePresented();
+    } else if (target) {
+      target->requeue(recordings);
+    }
   }
 
   /**
-   Sets the native id of the view
+   Renders the view into an offscreen surface: declarative content is
+   replayed on the calling thread with the latest values, so the snapshot
+   does not wait for a frame; otherwise the current frame is replayed.
    */
-  virtual void setNativeId(size_t nativeId) { _nativeId = nativeId; }
+  sk_sp<SkImage> makeImageSnapshot(SkRect *bounds) {
+    auto provider = std::make_shared<RNSkOffscreenCanvasProvider>(
+        _platformContext, getScaledWidth(), getScaledHeight());
+    if (_producer->hasContent()) {
+      if (auto *canvas = provider->getCanvas()) {
+        _producer->renderInto(canvas, _platformContext->getPixelDensity());
+      }
+    } else {
+      renderLastFrame(provider);
+    }
+    return provider->makeSnapshot(bounds);
+  }
 
-  /**
-   Returns the native id
-   */
-  size_t getNativeId() { return _nativeId; }
+  /** Width of the surface, in pixels. */
+  int getScaledWidth() { return _canvasProvider->getWidth(); }
+
+  /** Height of the surface, in pixels. */
+  int getScaledHeight() { return _canvasProvider->getHeight(); }
+
+  // Platform view side -------------------------------------------------------
 
   /**
-   * Set to true to show the debug overlays on render
+   Installed by the platform view: arms its display link. Main thread. Without
+   one, frames are presented as soon as the main thread gets to them.
    */
-  void setShowDebugOverlays(bool show) {
-    _renderer->setShowDebugOverlays(show);
-    requestRedraw();
+  void setFrameScheduler(std::function<void()> scheduler) {
+    _frameScheduler = std::move(scheduler);
+  }
+
+  /** Main thread: a recording is waiting. */
+  void scheduleFrame() {
+    if (_frameScheduler) {
+      _frameScheduler();
+    } else {
+      redraw();
+    }
   }
 
   /**
-   Renders the view into an SkImage instead of the screen.
+   Display link tick: presents the queued recordings. Returns whether more
+   are waiting, so that the caller keeps its display link armed: also when the
+   present failed (the app is in the background), so that the recordings are
+   tried again on the next frame rather than left waiting for a redraw.
+   Without a surface the queue is left alone: the surface presents it when
+   it appears.
    */
-  virtual sk_sp<SkImage> makeImageSnapshot(SkRect *bounds) {
+  bool presentFrame() {
+    auto target = getTarget();
+    if (target == nullptr) {
+      return false;
+    }
+    RNSkGraphiteTargetInfo targetInfo;
+    if (!_canvasProvider->getTargetInfo(&targetInfo)) {
+      return false;
+    }
+    auto recordings = target->takeQueued();
+    if (recordings.empty()) {
+      return false;
+    }
+    if (!present(_canvasProvider, targetInfo, recordings,
+                 /* remember= */ true)) {
+      target->requeue(recordings);
+      return true;
+    }
+    _producer->onFramePresented();
+    return target->hasQueued();
+  }
 
-    auto provider = std::make_shared<RNSkOffscreenCanvasProvider>(
-        getPlatformContext(), std::bind(&RNSkView::requestRedraw, this),
-        _canvasProvider->getWidth(), _canvasProvider->getHeight());
+  bool hasQueuedRecordings() {
+    auto target = getTarget();
+    return target && target->hasQueued();
+  }
 
-    _renderer->renderImmediate(provider);
-    return provider->makeSnapshot(bounds);
+  std::shared_ptr<RNSkCanvasProvider> getCanvasProvider() {
+    return _canvasProvider;
   }
 
-  std::shared_ptr<RNSkRenderer> getRenderer() { return _renderer; }
+  std::shared_ptr<RNSkPlatformContext> getPlatformContext() {
+    return _platformContext;
+  }
+
+private:
+  std::shared_ptr<RNSkGraphiteTarget> getTarget() {
+    std::lock_guard<std::mutex> lock(_mutex);
+    return _target;
+  }
 
   /**
-   Returns the scaled width of the view
+   Replays the frame on screen, or the one about to be, onto another
+   provider (a snapshot surface). Any thread.
    */
-  int getScaledWidth() { return _canvasProvider->getWidth(); }
+  bool renderLastFrame(const std::shared_ptr<RNSkCanvasProvider> &provider) {
+    std::shared_ptr<RNSkGraphiteTarget> target;
+    std::shared_ptr<RNSkGraphiteRecording> recording;
+    {
+      std::lock_guard<std::mutex> lock(_mutex);
+      target = _target;
+      recording = _lastPresented;
+    }
+    if (target) {
+      if (auto latest = target->peekLatest()) {
+        recording = latest;
+      }
+    }
+    if (recording == nullptr) {
+      return false;
+    }
+    RNSkGraphiteTargetInfo targetInfo;
+    if (!provider->getTargetInfo(&targetInfo)) {
+      return false;
+    }
+    return present(provider, targetInfo, {recording}, /* remember= */ false);
+  }
 
   /**
-   Returns the scaled height of the view
+   Replays the recordings onto the provider's target, in order, and remembers
+   the last one for the next redraw when asked to (not for a snapshot).
+   Returns false when the provider could not present (no surface, app in the
+   background), in which case the caller keeps the recordings.
    */
-  int getScaledHeight() { return _canvasProvider->getHeight(); }
-
-protected:
-  std::shared_ptr<RNSkPlatformContext> getPlatformContext() {
-    return _platformContext;
+  bool
+  present(const std::shared_ptr<RNSkCanvasProvider> &provider,
+          const RNSkGraphiteTargetInfo &targetInfo,
+          const std::vector<std::shared_ptr<RNSkGraphiteRecording>> &recordings,
+          bool remember) {
+    // Recordings of the target's size are replayed straight onto it, as one
+    // batch; one of another size goes through a texture of its own size.
+    std::vector<skgpu::graphite::Recording *> batch;
+    std::shared_ptr<RNSkGraphiteRecording> last;
+    bool success = true;
+    auto flush = [&]() {
+      if (!batch.empty()) {
+        success = provider->presentRecordings(batch) && success;
+        batch.clear();
+      }
+    };
+    for (const auto &recording : recordings) {
+      // A recording made for another format (recorded before the surface
+      // existed, with a bit depth the surface did not get) cannot be
+      // replayed onto this one.
+      if (!recording->hasFormatOf(targetInfo)) {
+        RNSkLogger::logToConsole("SkiaView: skipping a recording made for a "
+                                 "different surface format");
+        continue;
+      }
+      if (recording->hasSizeOf(targetInfo)) {
+        batch.push_back(recording->get());
+        last = recording;
+        continue;
+      }
+      flush();
+      if (presentResized(provider, recording)) {
+        last = recording;
+      } else {
+        success = false;
+      }
+    }
+    flush();
+    if (last == nullptr) {
+      // Nothing presentable: the recordings are consumed, not kept.
+      return true;
+    }
+    if (success && remember) {
+      std::lock_guard<std::mutex> lock(_mutex);
+      _lastPresented = last;
+    }
+    return success;
   }
-  std::shared_ptr<RNSkCanvasProvider> getCanvasProvider() {
-    return _canvasProvider;
+
+  /**
+   Presents a recording made for another size than the target's: the size
+   JS measured before the surface existed can be a pixel off (the platform
+   rounds the layout to pixels on its own terms), and the view may have been
+   resized since. The recording is replayed into a texture of its own size
+   and that texture is drawn onto the target, so the frame shows rather than
+   being dropped; the copy only happens while the sizes differ.
+   */
+  bool presentResized(const std::shared_ptr<RNSkCanvasProvider> &provider,
+                      const std::shared_ptr<RNSkGraphiteRecording> &recording) {
+    const auto &size = recording->getTarget();
+    auto intermediate = std::make_shared<RNSkOffscreenCanvasProvider>(
+        _platformContext, size.width, size.height);
+    RNSkGraphiteTargetInfo info;
+    if (!intermediate->getTargetInfo(&info) ||
+        !recording->isCompatibleWith(info)) {
+      // No texture of that size and format: the frame is consumed.
+      RNSkLogger::logToConsole("SkiaView: skipping a %dx%d recording, the "
+                               "surface is %dx%d",
+                               size.width, size.height, provider->getWidth(),
+                               provider->getHeight());
+      return true;
+    }
+    if (!intermediate->presentRecordings({recording->get()})) {
+      return false;
+    }
+    auto image = intermediate->makeImage();
+    if (image == nullptr) {
+      return false;
+    }
+    return provider->presentImage(image);
   }
 
-private:
   std::shared_ptr<RNSkPlatformContext> _platformContext;
   std::shared_ptr<RNSkCanvasProvider> _canvasProvider;
-  std::shared_ptr<RNSkRenderer> _renderer;
-
-  size_t _nativeId;
-
+  std::shared_ptr<RNSkGraphiteProducer> _producer;
+  size_t _nativeId = 0;
+  std::function<void()> _frameScheduler;
   std::atomic<bool> _redrawRequested = {false};
+
+  // The target is bound on the JS thread and read on the main thread and by
+  // snapshots; the last presented frame is written by the main thread and
+  // read by snapshots.
+  std::mutex _mutex;
+  std::shared_ptr<RNSkGraphiteTarget> _target;
+  size_t _targetId = 0;
+  std::shared_ptr<RNSkGraphiteRecording> _lastPresented;
 };
 
 } // namespace RNSkia

package/jestSetup.js

@@ -21,7 +21,5 @@ jest.mock("react-native-skia", () => {
       useFonts: () => null,
     };
   });
-  return require("react-native-skia/lib/module/mock").Mock(
-    global.CanvasKit
-  );
+  return require("react-native-skia/lib/module/mock").Mock(global.CanvasKit);
 });