react-native-skia 3.0.0 → 3.0.2

package/Package.swift

@@ -1,6 +1,6 @@
 // swift-tools-version: 6.0
 //
-// SwiftPM manifest for @shopify/react-native-skia. iOS, Ganesh.
+// SwiftPM manifest for react-native-skia. iOS, Graphite.
 // Additive: the CocoaPods podspec remains the supported default.
 //
 // React Native 0.87+ references a library that ships its own Package.swift
@@ -12,15 +12,17 @@ import Foundation
 import PackageDescription
 
 // Skia's xcframeworks are ~200MB and are not carried in this package. They come
-// from the react-native-skia-apple-ios npm package, which @shopify/react-native-skia
-// depends on, so a checkout that has installed its dependencies builds offline.
+// from the react-native-skia-graphite-apple-ios npm package, which
+// react-native-skia depends on, so a checkout that has installed its
+// dependencies builds offline. The package also ships the shared Dawn
+// (libwebgpu_dawn.xcframework) Graphite runs on.
 // Xcode passes the symlink as the package directory, hence resolvingSymlinks.
 let packageRoot = URL(fileURLWithPath: Context.packageDirectory)
   .resolvingSymlinksInPath().path
 
 let binariesPath = [
-  "../../react-native-skia-apple-ios", // consumer: sibling in node_modules
-  "../../node_modules/react-native-skia-apple-ios", // this monorepo
+  "../../react-native-skia-graphite-apple-ios", // consumer: sibling in node_modules
+  "../../node_modules/react-native-skia-graphite-apple-ios", // this monorepo
 ]
 .map { "\(packageRoot)/\($0)" }
 .first { FileManager.default.fileExists(atPath: "\($0)/Package.swift") }
@@ -31,7 +33,7 @@ guard let binariesPath else {
   // unresolvable dependency path.
   fatalError(
     """
-    react-native-skia-apple-ios was not found next to @shopify/react-native-skia. \
+    react-native-skia-graphite-apple-ios was not found next to react-native-skia. \
     It ships the prebuilt Skia binaries this package links against. Reinstall \
     dependencies without --omit=optional, on macOS.
     """)
@@ -57,15 +59,13 @@ let package = Package(
         .product(name: "ReactNativeHeaders", package: "ReactNative"),
         .product(name: "ReactNativeDependenciesHeaders", package: "ReactNative"),
         .product(name: "ReactAppHeaders", package: "React-GeneratedCode"),
-        .product(name: "react-native-skia-apple-ios", package: "react-native-skia-apple-ios"),
+        .product(
+          name: "react-native-skia-graphite-apple-ios",
+          package: "react-native-skia-graphite-apple-ios"),
       ],
       // apple/ and cpp/ have no common ancestor below the package root, and
       // .headerSearchPath cannot escape the target path.
       path: ".",
-      exclude: [
-        "cpp/rnskia/RNDawnWindowContext.cpp", // Graphite only
-        "cpp/rnskia/RNDawnInterop.cpp", // Graphite only
-      ],
       // Explicit, so SwiftPM never walks node_modules, lib, android, or the
       // headers-only cpp/skia — which carries x86 AVX skcms sources that
       // cannot build for arm64.
@@ -83,6 +83,7 @@ let package = Package(
         // Replaces the podspec's recursive cpp/** glob, which expands to 90.
         .headerSearchPath("cpp"), // "api/…", "jsi/…", "utils/…"
         .headerSearchPath("cpp/skia"), // "include/core/…", "modules/…", "src/…"
+        .headerSearchPath("cpp/dawn/include"), // "webgpu/…", "dawn/…"
         .headerSearchPath("cpp/rnskia"), // apple/ uses bare "RNSkView.h"
         .headerSearchPath("cpp/utils"), // apple/ uses bare "RNSkLog.h"
 
@@ -93,8 +94,8 @@ let package = Package(
         .define("RCT_NEW_ARCH_ENABLED", to: "1"),
         .define("RCT_REMOVE_LEGACY_ARCH", to: "1"),
 
-        .define("SK_METAL", to: "1"),
-        .define("SK_GANESH", to: "1"),
+        // Skia's public headers only declare the Graphite API with SK_GRAPHITE.
+        .define("SK_GRAPHITE", to: "1"),
         .define("SK_IMAGE_READ_PIXELS_DISABLE_LEGACY_API", to: "1"),
         .define("SK_DISABLE_LEGACY_SHAPER_FACTORY", to: "1"),
 

package/android/CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.4.1)
 set (CMAKE_CXX_STANDARD 20)
 
 # SKIA_LIBS_PATH is passed from Gradle (pointing at the prebuilt Skia binaries,
-# read straight from the react-native-skia-android npm package, or libs/android for Graphite)
+# read straight from the react-native-skia-graphite-android npm package, or libs/android for local builds)
 # Append the ABI to get the full path
 set (SKIA_LIBS_PATH "${SKIA_LIBS_PATH}/${ANDROID_ABI}")
 
@@ -29,9 +29,10 @@ endif()
 add_library(skia STATIC IMPORTED)
 set_property(TARGET skia PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libskia.a")
 
-# SK_GRAPHITE is passed from Gradle
 message("-- SKIA_LIBS_PATH: ${SKIA_LIBS_PATH}")
-message("-- SK_GRAPHITE: ${SK_GRAPHITE}")
+
+# Skia's public headers only declare the Graphite API with SK_GRAPHITE set.
+add_definitions(-DSK_GRAPHITE)
 
 string(APPEND CMAKE_CXX_FLAGS " -DSK_BUILD_FOR_ANDROID -DSK_DISABLE_LEGACY_SHAPER_FACTORY -DSK_IMAGE_READ_PIXELS_DISABLE_LEGACY_API -DFOLLY_NO_CONFIG=1 -DFOLLY_HAVE_CLOCK_GETTIME=1 -DFOLLY_HAVE_MEMRCHR=1 -DFOLLY_USE_LIBCPP=1 -DFOLLY_MOBILE=1 -DON_ANDROID -DONANDROID")
 
@@ -51,21 +52,6 @@ message("-- ABI     : " ${ANDROID_ABI})
 
 link_directories(${SKIA_LIBS_PATH}/)
 
-if(SK_GRAPHITE)
-    add_definitions(-DSK_GRAPHITE)
-    set(BACKEND_SOURCES
-    #TODO: is this source needed to be added?
-        "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNDawnWindowContext.cpp"
-        "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNDawnInterop.cpp"
-    )
-else()
-    add_definitions(-DSK_GL -DSK_GANESH)
-    set(BACKEND_SOURCES
-        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/OpenGLWindowContext.cpp"
-        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/GrAHardwareBufferUtils.cpp"
-    )
-endif()
-
 add_library(
         ${PACKAGE_NAME}
         SHARED
@@ -73,8 +59,7 @@ add_library(
         "${PROJECT_SOURCE_DIR}/cpp/jni/JniSkiaManager.cpp"
 
         "${PROJECT_SOURCE_DIR}/cpp/jni/JniPlatformContext.cpp"
-        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/gl/Error.cpp"
-        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/RNSkOpenGLCanvasProvider.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/RNSkAndroidCanvasProvider.cpp"
         "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/AHardwareBufferUtils.cpp"
         "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/RNSkAndroidVideo.cpp"
 
@@ -84,15 +69,15 @@ add_library(
         "${PROJECT_SOURCE_DIR}/../cpp/jsi/ViewProperty.cpp"
 
         "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNSkManager.cpp"
-        "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNSkPictureView.cpp"
         "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNSkGraphiteProducer.cpp"
+        "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNDawnWindowContext.cpp"
+        "${PROJECT_SOURCE_DIR}/../cpp/rnskia/RNDawnInterop.cpp"
 
         "${PROJECT_SOURCE_DIR}/../cpp/api/third_party/CSSColorParser.cpp"
         "${PROJECT_SOURCE_DIR}/../cpp/api/third_party/base64.cpp"
         "${PROJECT_SOURCE_DIR}/../cpp/api/third_party/SkottieUtils.cpp"
 
         "${PROJECT_SOURCE_DIR}/../cpp/api/JsiSkDispatcher.cpp"
-        ${BACKEND_SOURCES}
 )
 
 
@@ -155,12 +140,10 @@ set_property(TARGET pathops PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libpat
 add_library(jsonreader STATIC IMPORTED)
 set_property(TARGET jsonreader PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libjsonreader.a")
 
-if(SK_GRAPHITE)
-    # Dawn is a shared library, the same artifact react-native-webgpu links, so
-    # an app that installs both packages loads exactly one Dawn copy.
-    add_library(webgpu_dawn SHARED IMPORTED)
-    set_property(TARGET webgpu_dawn PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libwebgpu_dawn.so")
-endif()
+# Dawn is a shared library, the same artifact react-native-webgpu links, so
+# an app that installs both packages loads exactly one Dawn copy.
+add_library(webgpu_dawn SHARED IMPORTED)
+set_property(TARGET webgpu_dawn PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libwebgpu_dawn.so")
 
 find_library(
         LOG_LIB
@@ -182,7 +165,7 @@ else()
 endif()
 
 # Link
-set(COMMON_LIBS
+target_link_libraries(${PACKAGE_NAME}
     ${LOG_LIB}
     ReactAndroid::reactnative
     fbjni::fbjni
@@ -196,23 +179,11 @@ set(COMMON_LIBS
     ${SKIA_SKSG_LIB}
     ${SKIA_JSONREADER_LIB}
     ${SKIA_LIB}
+    webgpu_dawn
     -ljnigraphics
-    -lGLESv2
-    -lEGL
     -landroid
 )
 
-if(SK_GRAPHITE)
-    target_link_libraries(${PACKAGE_NAME}
-        ${COMMON_LIBS}
-        webgpu_dawn
-    )
-else()
-    target_link_libraries(${PACKAGE_NAME}
-        ${COMMON_LIBS}
-    )
-endif()
-
 # Enable Android 16kb native library alignment
 if(CMAKE_ANDROID_NDK_VERSION VERSION_LESS "27")
     target_link_options(${PACKAGE_NAME} PRIVATE "-Wl,-z,max-page-size=16384")

package/android/build.gradle

@@ -6,10 +6,12 @@ import java.nio.file.Paths
 // https://github.com/facebookincubator/fbjni/blob/main/docs/android_setup.md
 
 // These defaults should reflect the SDK versions used by
-// the minimum React Native version supported (0.78).
+// the minimum React Native version supported (0.78), except minSdk:
+// the Graphite binaries are built for API level 26 (ndk_api in
+// scripts/skia-configuration.ts).
 def DEFAULT_COMPILE_SDK_VERSION = 35
 def DEFAULT_BUILD_TOOLS_VERSION = '35.0.0'
-def DEFAULT_MIN_SDK_VERSION = 24
+def DEFAULT_MIN_SDK_VERSION = 26
 def DEFAULT_TARGET_SDK_VERSION = 34
 
 def safeExtGet(prop, fallback) {
@@ -58,54 +60,61 @@ static def resolveNodePackage(packageName, baseDir) {
   return proc.text.trim()
 }
 
-// Graphite is detected via a marker file (created by install-skia-graphite for
-// in-repo development, or shipped in the npm tarball for next-channel releases).
-// The prebuilt binaries live in the react-native-skia-android npm package for the
-// default (Ganesh) build and in react-native-skia-graphite-android for Graphite.
-// In-repo Graphite development downloads them directly into libs/android instead,
-// which takes precedence over the npm package when present.
-def useGraphite = file("${projectDir}/../libs/.graphite").exists()
-def localGraphiteLibs = file("${projectDir}/../libs/android")
-def skiaLibsPath = useGraphite
-    ? (localGraphiteLibs.exists()
-        ? "${projectDir}/../libs/android"
-        : "${resolveNodePackage('react-native-skia-graphite-android', projectDir)}/libs")
-    : "${resolveNodePackage('react-native-skia-android', projectDir)}/libs"
-
-// Both packages must link the exact same Dawn artifact: compare this
-// Graphite build's Dawn release tag (libs/.dawn-version) with the tag
-// react-native-webgpu declares in its package.json `dawn` field.
-if (useGraphite) {
-    def dawnMarker = file("${projectDir}/../libs/.dawn-version")
-    def webgpuDir = null
-    try {
-        webgpuDir = resolveNodePackage('react-native-webgpu', projectDir)
-    } catch (Exception ignored) {
-        // react-native-webgpu not installed: nothing to check
+// The Graphite binaries, including the shared Dawn (libwebgpu_dawn.so), live in
+// the react-native-skia-graphite-android npm package. Binaries built locally
+// with `yarn build-skia` land in libs/android and take precedence when present.
+def localSkiaLibs = file("${projectDir}/../libs/android")
+def skiaLibsPath = localSkiaLibs.exists()
+    ? "${projectDir}/../libs/android"
+    : "${resolveNodePackage('react-native-skia-graphite-android', projectDir)}/libs"
+
+// Fail early rather than with a ninja "missing and no known rule" error.
+def missingDawn = ["armeabi-v7a", "arm64-v8a", "x86", "x86_64"].findAll {
+    !file("${skiaLibsPath}/${it}/libwebgpu_dawn.so").exists()
+}
+if (!missingDawn.isEmpty()) {
+    throw new GradleException(
+        "react-native-skia: libwebgpu_dawn.so not found in ${skiaLibsPath} " +
+        "for ${missingDawn.join(', ')}. The installed react-native-skia-graphite-android " +
+        "package does not ship the shared Dawn library this Graphite build links against. " +
+        "Upgrade it and rebuild.")
+}
+
+// Both packages must link the exact same Dawn artifact: compare the Dawn
+// release tag the Skia binaries were packaged with (libs/.dawn-version in the
+// react-native-skia-graphite-android package, or next to a local build) with
+// the tag react-native-webgpu declares in its package.json `dawn` field.
+def dawnMarker = file("${skiaLibsPath}/.dawn-version")
+if (!dawnMarker.exists()) {
+    dawnMarker = file("${projectDir}/../libs/.dawn-version")
+}
+def webgpuDir = null
+try {
+    webgpuDir = resolveNodePackage('react-native-webgpu', projectDir)
+} catch (Exception ignored) {
+    // react-native-webgpu not installed: nothing to check
+}
+if (dawnMarker.exists() && webgpuDir != null) {
+    def skiaDawn = dawnMarker.text.trim()
+    def webgpuJson = new groovy.json.JsonSlurper().parse(file("${webgpuDir}/package.json"))
+    if (webgpuJson.dawn == null) {
+        throw new GradleException(
+            "react-native-skia: the installed react-native-webgpu " +
+            "(${webgpuJson.version}) does not declare a `dawn` field in its " +
+            "package.json, so it predates shared-Dawn support and cannot be " +
+            "paired with this Graphite build (which links ${skiaDawn}). " +
+            "Upgrade react-native-webgpu.")
     }
-    if (dawnMarker.exists() && webgpuDir != null) {
-        def skiaDawn = dawnMarker.text.trim()
-        def webgpuJson = new groovy.json.JsonSlurper().parse(file("${webgpuDir}/package.json"))
-        if (webgpuJson.dawn == null) {
-            throw new GradleException(
-                "react-native-skia: the installed react-native-webgpu " +
-                "(${webgpuJson.version}) does not declare a `dawn` field in its " +
-                "package.json, so it predates shared-Dawn support and cannot be " +
-                "paired with this Graphite build (which links ${skiaDawn}). " +
-                "Upgrade react-native-webgpu.")
-        }
-        def webgpuDawn = "dawn-" + webgpuJson.dawn.toString().replace('/', '-')
-        if (skiaDawn != webgpuDawn) {
-            throw new GradleException(
-                "react-native-skia: Dawn version mismatch. This Graphite build links " +
-                "${skiaDawn} but react-native-webgpu links ${webgpuDawn}. " +
-                "Align the two packages so the app contains exactly one Dawn.")
-        }
-        logger.warn("react-native-skia: Dawn versions match (${skiaDawn})")
+    def webgpuDawn = "dawn-" + webgpuJson.dawn.toString().replace('/', '-')
+    if (skiaDawn != webgpuDawn) {
+        throw new GradleException(
+            "react-native-skia: Dawn version mismatch. This Graphite build links " +
+            "${skiaDawn} but react-native-webgpu links ${webgpuDawn}. " +
+            "Align the two packages so the app contains exactly one Dawn.")
     }
+    logger.warn("react-native-skia: Dawn versions match (${skiaDawn})")
 }
 
-logger.warn("react-native-skia: SK_GRAPHITE: ${useGraphite}")
 logger.warn("react-native-skia: Skia libs: ${skiaLibsPath}")
 logger.warn("react-native-skia: node_modules/ found at: ${nodeModules}")
 
@@ -167,7 +176,6 @@ android {
                           "-DREACT_NATIVE_DIR=${defaultDir}",
                           "-DNODE_MODULES_DIR=${nodeModules}",
                           "-DSKIA_LIBS_PATH=${skiaLibsPath}",
-                          "-DSK_GRAPHITE=${useGraphite ? 'ON' : 'OFF'}",
                           "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
 
             }

package/android/cpp/jni/JniLoad.cpp

@@ -1,15 +1,13 @@
 #include "JniPlatformContext.h"
 #include "JniSkiaManager.h"
-#include "JniSkiaGraphiteView.h"
-#include "JniSkiaPictureView.h"
+#include "JniSkiaView.h"
 #include <fbjni/fbjni.h>
 #include <jni.h>
 
 JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *) {
   return facebook::jni::initialize(vm, [] {
     RNSkia::JniSkiaManager::registerNatives();
-    RNSkia::JniSkiaPictureView::registerNatives();
-    RNSkia::JniSkiaGraphiteView::registerNatives();
+    RNSkia::JniSkiaView::registerNatives();
     RNSkia::JniPlatformContext::registerNatives();
   });
 }

package/android/cpp/jni/include/JniSkiaView.h

@@ -0,0 +1,123 @@
+#pragma once
+
+#include <memory>
+
+#include <fbjni/fbjni.h>
+#include <jni.h>
+
+#include "JniSkiaManager.h"
+#include "RNSkAndroidCanvasProvider.h"
+#include "RNSkView.h"
+
+namespace RNSkia {
+namespace jni = facebook::jni;
+
+/**
+ * The JNI side of SkiaView: owns the native view and the ANativeWindow
+ * provider it presents into, and relays the surface callbacks of the backing
+ * SurfaceView or TextureView.
+ */
+class JniSkiaView : public jni::HybridClass<JniSkiaView> {
+public:
+  static auto constexpr kJavaDescriptor = "Lcom/reactnative/skia/SkiaView;";
+
+  static jni::local_ref<jhybriddata>
+  initHybrid(jni::alias_ref<jhybridobject> jThis,
+             jni::alias_ref<JniSkiaManager::javaobject> skiaManager) {
+    return makeCxxInstance(jThis, skiaManager);
+  }
+
+  static void registerNatives() {
+    registerHybrid(
+        {makeNativeMethod("initHybrid", JniSkiaView::initHybrid),
+         makeNativeMethod("surfaceAvailable", JniSkiaView::surfaceAvailable),
+         makeNativeMethod("surfaceDestroyed", JniSkiaView::surfaceDestroyed),
+         makeNativeMethod("surfaceSizeChanged",
+                          JniSkiaView::surfaceSizeChanged),
+         makeNativeMethod("setLayoutSize", JniSkiaView::setLayoutSize),
+         makeNativeMethod("registerView", JniSkiaView::registerView),
+         makeNativeMethod("unregisterView", JniSkiaView::unregisterView),
+         makeNativeMethod("presentFrame", JniSkiaView::presentFrame)});
+  }
+
+  // The manager is owned by the RNSkiaModule and is destroyed when the module
+  // is invalidated (reload). Fabric drops views on the UI thread while the
+  // module is invalidated on a background thread, so a view can outlive its
+  // manager: holding a weak reference makes a late unregister a no-op and a
+  // concurrent one keep the manager alive for the duration of the call.
+  std::shared_ptr<RNSkManager> getSkiaManager() { return _manager.lock(); }
+
+protected:
+  void surfaceAvailable(jobject surface, int width, int height, bool isSurface,
+                        bool highBitDepth) {
+    _provider->surfaceAvailable(surface, width, height, isSurface,
+                                highBitDepth);
+    _view->redraw();
+  }
+
+  void surfaceSizeChanged(jobject surface, int width, int height,
+                          bool isSurface, bool highBitDepth) {
+    _provider->surfaceSizeChanged(surface, width, height, isSurface,
+                                  highBitDepth);
+    // Paint the new size right away rather than on the next scheduled redraw.
+    _view->redraw();
+  }
+
+  void surfaceDestroyed() { _provider->surfaceDestroyed(); }
+
+  void setLayoutSize(int width, int height) {
+    _provider->setLayoutSize(width, height);
+  }
+
+  void registerView(int nativeId) {
+    auto manager = getSkiaManager();
+    if (manager == nullptr) {
+      return;
+    }
+    manager->registerSkiaView(nativeId, _view);
+  }
+
+  void unregisterView() {
+    if (auto manager = getSkiaManager()) {
+      manager->setSkiaView(_view->getNativeId(), nullptr);
+      manager->unregisterSkiaView(_view->getNativeId());
+    }
+    // React drops the Java view here, but the native view behind it (and the
+    // content it owns) is only destroyed when the Java object is finalized.
+    // Release the content now so it does not wait for the garbage collector.
+    _view->releaseContent();
+  }
+
+  // Choreographer tick: presents the queued recordings, returns whether more
+  // are already waiting.
+  bool presentFrame() { return _view->presentFrame(); }
+
+private:
+  friend HybridBase;
+
+  explicit JniSkiaView(jni::alias_ref<jhybridobject> jThis,
+                       jni::alias_ref<JniSkiaManager::javaobject> skiaManager)
+      : _manager(skiaManager->cthis()->getSkiaManager()) {
+    auto context = skiaManager->cthis()->getPlatformContext();
+    _provider = std::make_shared<RNSkAndroidCanvasProvider>(context);
+    _view = std::make_shared<RNSkView>(context, _provider);
+    // A submitted recording arms the Java view's frame callback. Weak: the
+    // Java view owns this object through its hybrid data.
+    jni::weak_ref<jhybridobject> weakJava = jni::make_weak(jThis);
+    _view->setFrameScheduler([weakJava]() {
+      auto javaPart = weakJava.lockLocal();
+      if (!javaPart) {
+        return;
+      }
+      static const auto method =
+          javaPart->getClass()->getMethod<void()>("scheduleFrame");
+      method(javaPart);
+    });
+  }
+
+  std::weak_ptr<RNSkManager> _manager;
+  std::shared_ptr<RNSkAndroidCanvasProvider> _provider;
+  std::shared_ptr<RNSkView> _view;
+};
+
+} // namespace RNSkia