@shopify/react-native-skia 0.0.135

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2021-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# React Native Skia
+
+React Native Skia brings the [Skia Graphics Library](https://skia.org/) to React Native.
+Skia serves as the graphics engine for Google Chrome and Chrome OS, Android, Flutter, Mozilla Firefox, Firefox OS, and many other products.
+
+Checkout the full documentation [here](https://shopify.github.io/react-native-skia).
+
+```sh
+yarn add @shopify/react-native-skia
+```
+
+Or using npm:
+
+```sh
+npm install @shopify/react-native-skia
+```
+
+## iOS
+
+Run `pod install` on the `ios/` directory.
+
+## Android
+
+> **Version compatibility**: `react-native@>=0.66` is required.
+
+Currently, you will need Android NDK to be installed.
+If you have Android Studio installed, make sure `$ANDROID_NDK` is available.
+`ANDROID_NDK=/Users/username/Library/Android/sdk/ndk-bundle` for instance.
+
+If the NDK is not installed, you can install it via Android Studio by going to the menu _File > Project Structure_
+
+And then the _SDK Location_ section. It will show you the NDK path, or the option to download it if you don't have it installed.
+
+### Proguard
+
+If you're using Proguard, make sure to add the following rule:
+
+```
+-keep class com.shopify.reactnative.skia.** { *; }
+```
+
+## Playground
+
+We have an example project you can play with [here](https://github.com/Shopify/react-native-skia/tree/main/example).
+
+```sh
+yarn
+cd package && yarn && cd ..
+cd example && yarn && yarn start
+```
+
+To run the example project on iOS, you will need to run `pod install`, and on Android, you will also need Android NDK to be installed ([see here](#android)).

package/android/CMakeLists.txt

@@ -0,0 +1,151 @@
+cmake_minimum_required(VERSION 3.4.1)
+
+set (CMAKE_VERBOSE_MAKEFILE ON)
+set (CMAKE_CXX_STANDARD 17)
+set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DSK_GL -DSK_BUILD_FOR_ANDROID -DFOLLY_NO_CONFIG=1 -DFOLLY_HAVE_CLOCK_GETTIME=1 -DFOLLY_HAVE_MEMRCHR=1 -DFOLLY_USE_LIBCPP=1 -DFOLLY_MOBILE=1 -DON_ANDROID -DONANDROID")
+
+set (PACKAGE_NAME "reactskia")
+set (SKIA_LIB "skia")
+set (SKIA_SVG_LIB "svg")
+set (SKIA_SKSHAPER_LIB "skshaper")
+
+set(build_DIR ${CMAKE_SOURCE_DIR}/build)
+file(GLOB LIBRN_DIR "${PREBUILT_DIR}/${ANDROID_ABI}")
+file(GLOB libfbjni_link_DIRS "${build_DIR}/fbjni*.aar/jni/${ANDROID_ABI}")
+file(GLOB libfbjni_include_DIRS "${build_DIR}/fbjni-*-headers.jar/")
+
+link_directories(../libs/android/${ANDROID_ABI}/)
+
+if(${REACT_NATIVE_VERSION} LESS 66)
+        file(
+                TO_CMAKE_PATH 
+                "${NODE_MODULES_DIR}/react-native/ReactCommon/jsi/jsi/jsi.cpp"
+                INCLUDE_JSI_CPP
+        )
+endif()
+
+add_library(
+        ${PACKAGE_NAME}
+        SHARED
+        "${PROJECT_SOURCE_DIR}/cpp/jni/JniLoad.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/jni/JniSkiaManager.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/jni/JniSkiaDrawView.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/jni/JniPlatformContext.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/RNSkDrawViewImpl.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia-android/SkiaOpenGLRenderer.cpp"
+        
+        "${PROJECT_SOURCE_DIR}/cpp/jsi/JsiHostObject.cpp"
+
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia/RNSkManager.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia/RNSkDrawView.cpp"
+        "${PROJECT_SOURCE_DIR}/cpp/rnskia/RNSkDispatchQueue.cpp"
+
+
+        "${PROJECT_SOURCE_DIR}/cpp/api/third_party/CSSColorParser.cpp"
+        
+)
+
+
+target_include_directories(
+        ${PACKAGE_NAME}
+        PRIVATE
+
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/callinvoker"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/jsi"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/react/nativemodule/core"
+        "${NODE_MODULES_DIR}/react-native/ReactAndroid/src/main/java/com/facebook/react/turbomodule/core/jni"
+
+        cpp/skia/include/config/
+        cpp/skia/include/core/
+        cpp/skia/include/effects/
+        cpp/skia/include/utils/
+        cpp/skia/include/pathops/
+        cpp/skia/modules/
+        cpp/skia/include/
+        cpp/skia
+
+        cpp/api
+        cpp/jsi
+        cpp/jni/include
+        cpp/rnskia-android
+        cpp/rnskia
+        cpp/rnskia/values
+        cpp/utils  
+
+        ${libfbjni_include_DIRS}
+)
+
+# Import prebuilt SKIA libraries
+set (SKIA_LIBS_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../libs/android/${ANDROID_ABI}")
+add_library(skia STATIC IMPORTED)
+set_property(TARGET skia PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libskia.a")
+
+add_library(svg STATIC IMPORTED)
+set_property(TARGET svg PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libsvg.a")
+
+add_library(skshaper STATIC IMPORTED)
+set_property(TARGET skshaper PROPERTY IMPORTED_LOCATION "${SKIA_LIBS_PATH}/libskshaper.a")
+
+
+find_library(
+        LOG_LIB
+        log
+)
+
+find_library(
+         JSI_LIB
+         jsi
+         PATHS ${LIBRN_DIR}
+         NO_CMAKE_FIND_ROOT_PATH
+ )
+ if(${REACT_NATIVE_VERSION} LESS 66)
+         # JSI lib didn't exist on RN 0.65 and before. Simply omit it.
+         set (JSI_LIB "")
+ else()
+         # RN 0.66 distributes libjsi.so, can be used instead of compiling jsi.cpp manually.
+         find_library(
+                 JSI_LIB
+                 jsi
+                 PATHS ${LIBRN_DIR}
+                 NO_CMAKE_FIND_ROOT_PATH
+         )
+ endif()
+
+find_library(
+        REACT_LIB
+        react_nativemodule_core
+        PATHS ${LIBRN_DIR}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+
+find_library(
+        FBJNI_LIBRARY 
+        fbjni 
+        PATHS ${libfbjni_link_DIRS}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+
+find_library(
+        TURBOMODULES_LIB
+        turbomodulejsijni
+        PATHS ${LIBRN_DIR}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+
+# Link
+target_link_libraries(
+        ${PACKAGE_NAME}
+        ${LOG_LIB}
+        ${FBJNI_LIBRARY}
+        ${REACT_LIB}
+        ${JSI_LIB}
+        ${TURBOMODULES_LIB}
+        ${SKIA_SVG_LIB}
+        ${SKIA_SKSHAPER_LIB}
+        ${SKIA_LIB}
+        -ljnigraphics
+        -lGLESv2
+        -lEGL
+        -landroid
+    )

package/android/README.md

@@ -0,0 +1,14 @@
+README
+======
+
+If you want to publish the lib as a maven dependency, follow these steps before publishing a new version to npm:
+
+1. Be sure to have the Android [SDK](https://developer.android.com/studio/index.html) and [NDK](https://developer.android.com/ndk/guides/index.html) installed
+2. Be sure to have a `local.properties` file in this folder that points to the Android SDK and NDK
+```
+ndk.dir=/Users/{username}/Library/Android/sdk/ndk-bundle
+sdk.dir=/Users/{username}/Library/Android/sdk
+```
+3. Delete the `maven` folder
+4. Run `./gradlew installArchives`
+5. Verify that latest set of generated files is in the maven folder with the correct version number

package/android/build.gradle

@@ -0,0 +1,258 @@
+import java.nio.file.Paths
+
+// android/build.gradle
+
+// based on:
+//
+// * https://github.com/facebook/react-native/blob/0.60-stable/template/android/build.gradle
+//   previous location:
+//   - https://github.com/facebook/react-native/blob/0.58-stable/local-cli/templates/HelloWorld/android/build.gradle
+//
+// * https://github.com/facebook/react-native/blob/0.60-stable/template/android/app/build.gradle
+//   previous location:
+//   - https://github.com/facebook/react-native/blob/0.58-stable/local-cli/templates/HelloWorld/android/app/build.gradle
+
+// FBJNI build is based on:
+// 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.
+def DEFAULT_COMPILE_SDK_VERSION = 28
+def DEFAULT_BUILD_TOOLS_VERSION = '28.0.3'
+def DEFAULT_MIN_SDK_VERSION = 16
+def DEFAULT_TARGET_SDK_VERSION = 28
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+apply plugin: 'com.android.library'
+
+static def findNodeModules(baseDir) {
+  def basePath = baseDir.toPath().normalize()
+  // Node's module resolution algorithm searches up to the root directory,
+  // after which the base path will be null
+  while (basePath) {
+    def nodeModulesPath = Paths.get(basePath.toString(), "node_modules")
+    def reactNativePath = Paths.get(nodeModulesPath.toString(), "react-native")
+    if (nodeModulesPath.toFile().exists() && reactNativePath.toFile().exists()) {
+      return nodeModulesPath.toString()
+    }
+    basePath = basePath.getParent()
+  }
+  throw new GradleException("React-Native-Skia: Failed to find node_modules/ path!")
+}
+
+def nodeModules = findNodeModules(projectDir)
+logger.warn("react-native-skia: node_modules/ found at: ${nodeModules}")
+
+def sourceBuild = false
+def defaultDir = null
+def androidSourcesDir = null
+def androidSourcesName = 'React Native sources'
+
+def buildType = "debug"
+tasks.all({ task ->
+    if (task.name == "buildCMakeRelease") {
+        buildType = "release"
+    }
+})
+
+if (rootProject.ext.has('reactNativeAndroidRoot')) {
+  defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
+  androidSourcesDir = defaultDir.parentFile.toString()
+} else if (findProject(':ReactAndroid') != null) {
+    sourceBuild = true
+    defaultDir = project(':ReactAndroid').projectDir
+    androidSourcesDir = defaultDir.parentFile.toString()
+} else {
+  defaultDir = file("$nodeModules/react-native/android")
+  androidSourcesDir = defaultDir.parentFile.toString()
+}
+
+if (!defaultDir.exists()) {
+    throw new GradleException(
+      "${project.name}: React Native android directory (node_modules/react-native/android) does not exist! Resolved node_modules to: ${nodeModules}"
+    )
+}
+
+def prebuiltDir = sourceBuild
+    ? "$nodeModules/react-native/ReactAndroid/src/main/jni/prebuilt/lib"
+    : "$buildDir/react-native-0*/jni"
+
+
+def reactProperties = new Properties()
+file("$nodeModules/react-native/ReactAndroid/gradle.properties").withInputStream { reactProperties.load(it) }
+def REACT_NATIVE_VERSION = reactProperties.getProperty("VERSION_NAME").split("\\.")[1].toInteger()
+
+logger.warn("react-native-skia: React Native version: ${REACT_NATIVE_VERSION}")
+logger.warn("react-native-skia: Is Source build: ${sourceBuild}")
+logger.warn("react-native-skia: Prebuilt dir: ${prebuiltDir}")
+logger.warn("react-native-skia: Build type: ${buildType}")
+
+buildscript {
+    // The Android Gradle plugin is only required when opening the android folder stand-alone.
+    // This avoids unnecessary downloads and potential conflicts when the library is included as a
+    // module dependency in an application project.
+    // ref: https://docs.gradle.org/current/userguide/tutorial_using_tasks.html#sec:build_script_external_dependencies
+    if (project == rootProject) {
+        repositories {
+            google()
+        }
+        dependencies {
+            // This should reflect the Gradle plugin version used by
+            // the minimum React Native version supported.
+            classpath 'com.android.tools.build:gradle:3.4.1'
+        }
+    }
+}
+
+android {
+    compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+    buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
+    defaultConfig {
+        minSdkVersion safeExtGet('minSdkVersion', DEFAULT_MIN_SDK_VERSION)
+        targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
+        versionCode 1
+        versionName "1.0"
+
+        externalNativeBuild {
+            cmake {
+                cppFlags "-fexceptions", "-frtti", "-std=c++1y", "-DONANDROID"
+                abiFilters 'x86', 'x86_64', 'armeabi-v7a', 'arm64-v8a'
+                arguments '-DANDROID_STL=c++_shared',
+                          "-DREACT_NATIVE_VERSION=${REACT_NATIVE_VERSION}",
+                          "-DNODE_MODULES_DIR=${nodeModules}",
+                          "-DPREBUILT_DIR=${prebuiltDir}"
+            }
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+
+    externalNativeBuild {
+        cmake {
+            path file('CMakeLists.txt')
+            version '3.10.2'
+        }
+    }
+
+    packagingOptions {
+        excludes = [
+             "**/libc++_shared.so",
+             "**/libfbjni.so",
+             "**/libjsi.so",
+             "**/libreact_nativemodule_core.so",
+             "**/libturbomodulejsijni.so"
+        ]
+    }
+
+
+
+    // Create new configurations that can be referred to in dependencies.
+    // The Android Gradle Plugin 3.* does not allow hooking into existing
+    // configurations like `implementation`.
+    configurations {
+        extractHeaders
+        extractJNI
+    }
+}
+
+repositories {
+    // ref: https://www.baeldung.com/maven-local-repository
+    jcenter()
+    mavenLocal()
+    maven {
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        url "$rootDir/../node_modules/react-native/android"
+    }
+    maven {
+        // Android JSC is installed from npm
+        url "$rootDir/../node_modules/jsc-android/dist"
+    }
+    google()
+}
+
+dependencies {
+    //noinspection GradleDynamicVersion
+    implementation 'com.facebook.react:react-native:+'  // From node_modules
+
+    //noinspection GradleDynamicVersion
+    extractHeaders("com.facebook.fbjni:fbjni:0.2.2:headers")
+    //noinspection GradleDynamicVersion
+    extractJNI("com.facebook.fbjni:fbjni:0.2.2")
+
+    if(REACT_NATIVE_VERSION < 69) {
+        def rnAAR = fileTree("${nodeModules}/react-native/android").matching({ it.include "**/**/*.aar" }).singleFile
+        extractJNI(files(rnAAR))
+    } else {
+        // React Native >= 0.69
+        def rnAarMatcher = "**/react-native/**/*${buildType}.aar"
+        def rnAAR = fileTree("${nodeModules}/react-native/android").matching({ it.include rnAarMatcher }).singleFile
+        extractJNI(files(rnAAR))
+    }
+}
+
+afterEvaluate { project ->
+    task androidSourcesJar(type: Jar) {
+        classifier = 'sources'
+        from android.sourceSets.main.java.srcDirs
+        include '**/*.java'
+    }
+
+    android.libraryVariants.all { variant ->
+        def name = variant.name.capitalize()
+        def javaCompileTask = variant.javaCompileProvider.get()
+
+        task "jar${name}"(type: Jar, dependsOn: javaCompileTask) {
+            from javaCompileTask.destinationDir
+        }
+    }
+
+    artifacts {
+        archives androidSourcesJar
+    }
+}
+
+task extractAARHeaders {
+    doLast {
+        configurations.extractHeaders.files.each {
+            def file = it.absoluteFile
+            copy {
+                from zipTree(file)
+                into "$buildDir/$file.name"
+                include "**/*.h"
+            }
+        }
+    }
+}
+
+task extractJNIFiles {
+    doLast {
+        configurations.extractJNI.files.each {
+            def file = it.absoluteFile
+            copy {
+                from zipTree(file)
+                into "$buildDir/$file.name"
+                include "jni/**/*"
+            }
+        }
+    }
+}
+
+extractJNIFiles.mustRunAfter extractAARHeaders
+
+def nativeBuildDependsOn(dependsOnTask, variant) {
+  def buildTasks = tasks.findAll({ task ->
+      !task.name.contains("Clean") && (task.name.contains("externalNative") || task.name.contains("CMake")) })
+  if (variant != null) {
+    buildTasks = buildTasks.findAll({ task -> task.name.contains(variant) })
+  }
+  buildTasks.forEach { task -> task.dependsOn(dependsOnTask) }
+}
+
+afterEvaluate {
+  nativeBuildDependsOn(extractAARHeaders, null)
+  nativeBuildDependsOn(extractJNIFiles, null)  
+}

package/android/cpp/jni/JniLoad.cpp

@@ -0,0 +1,13 @@
+#include "JniPlatformContext.h"
+#include "JniSkiaDrawView.h"
+#include "JniSkiaManager.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::JniSkiaDrawView::registerNatives();
+        RNSkia::JniPlatformContext::registerNatives();
+    });
+}

package/android/cpp/jni/JniPlatformContext.cpp

@@ -0,0 +1,142 @@
+#include "JniPlatformContext.h"
+
+#include <exception>
+#include <thread>
+#include <utility>
+
+#include <RNSkMeasureTime.h>
+#include "SkData.h"
+#include "SkRefCnt.h"
+#include "SkTypes.h"
+#include "SkStream.h"
+
+namespace RNSkia
+{
+
+    using namespace facebook;
+
+    using TSelf = jni::local_ref<JniPlatformContext::jhybriddata>;
+
+    void JniPlatformContext::registerNatives()
+    {
+        registerHybrid({
+            makeNativeMethod("initHybrid", JniPlatformContext::initHybrid),
+            makeNativeMethod("notifyDrawLoop", JniPlatformContext::notifyDrawLoopExternal),
+            makeNativeMethod("notifyTaskReady", JniPlatformContext::notifyTaskReadyExternal),
+        });
+    }
+
+    TSelf JniPlatformContext::initHybrid(jni::alias_ref<jhybridobject> jThis, float pixelDensity)
+    {
+        return makeCxxInstance(jThis, pixelDensity);
+    }
+
+    void JniPlatformContext::startDrawLoop()
+    {
+        jni::ThreadScope ts;
+        // Start drawing loop
+        static auto method = javaPart_->getClass()->getMethod<void(void)>("beginDrawLoop");
+        method(javaPart_.get());
+    }
+
+    void JniPlatformContext::stopDrawLoop()
+    {
+        jni::ThreadScope ts;
+        // Stop drawing loop
+        static auto method = javaPart_->getClass()->getMethod<void(void)>("endDrawLoop");
+        method(javaPart_.get());
+    }
+
+    void JniPlatformContext::notifyDrawLoopExternal()
+    {
+        jni::ThreadScope ts;
+        _onNotifyDrawLoop();
+    }
+
+    void JniPlatformContext::notifyTaskReadyExternal()
+    {
+        _taskMutex->lock();
+        auto task = _taskCallbacks.front();
+        if (task != nullptr)
+        {
+            _taskCallbacks.pop();
+            _taskMutex->unlock();
+            task();
+        }
+        else
+        {
+            _taskMutex->unlock();
+        }
+    }
+
+    void JniPlatformContext::performStreamOperation(
+        const std::string &sourceUri,
+        const std::function<void(std::unique_ptr<SkStreamAsset>)> &op)
+    {
+        auto measure =
+            RNSkMeasureTime("JniPlatformContext::performStreamOperation");
+
+        static auto method = javaPart_->getClass()->getMethod<jbyteArray(jstring)>(
+            "getJniStreamFromSource");
+
+        auto loader = [=]() -> void
+        {
+            jni::ThreadScope ts;
+            jstring jstr =
+                (*jni::Environment::current()).NewStringUTF(sourceUri.c_str());
+
+            // Get the array with data from input stream from Java
+            auto array = method(javaPart_.get(), jstr);
+
+            if (array == nullptr)
+            {
+                printf("Calling getJniStreamFromSource failed\n");
+                return;
+            }
+
+            // Allocate buffer for java byte array
+            jsize num_bytes =
+                jni::Environment::current()->GetArrayLength(array.get());
+            char *buffer = (char *)malloc(num_bytes + 1);
+
+            if (!buffer)
+            {
+                printf("Buff Fail\n");
+                return;
+            }
+
+            jbyte *elements = jni::Environment::current()->GetByteArrayElements(
+                array.get(), nullptr);
+            if (!elements)
+            {
+                printf("Element Fail\n");
+                return;
+            }
+
+            // Copy data from java array to buffer
+            memcpy(buffer, elements, num_bytes);
+            buffer[num_bytes] = 0;
+
+            jni::Environment::current()->ReleaseByteArrayElements(
+                array.get(), elements, JNI_ABORT);
+
+            // Copy malloced data and give ownership to SkData
+            auto data = SkData::MakeFromMalloc(buffer, num_bytes);
+            auto skStream = SkMemoryStream::Make(data);
+
+            // Perform operation
+            op(std::move(skStream));
+        };
+
+        // Fire and forget the thread - will be resolved on completion
+        std::thread(loader).detach();
+    }
+
+    void JniPlatformContext::raiseError(const std::exception &err)
+    {
+        jni::ThreadScope ts;
+        static auto method = javaPart_->getClass()->getMethod<void(std::string)>("raise");
+        method(javaPart_.get(), std::string(err.what()));
+    }
+
+} // namespace RNSkia