dynamsoft-capture-vision-react-native 1.1.15 → 2.4.2000-alpha.1

package/README.md

@@ -1,39 +1,34 @@
 # Dynamsoft Capture Vision React-Native Edition
 
-![version](https://img.shields.io/npm/v/dynamsoft-capture-vision-react-native.svg)
-![downloads](https://img.shields.io/npm/dm/dynamsoft-capture-vision-react-native.svg)
-![jsdelivr](https://img.shields.io/jsdelivr/npm/hm/dynamsoft-capture-vision-react-native.svg)
-![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/dynamsoft-capture-vision-react-native.svg)
+Dynamsoft Capture Vision (DCV) is an aggregating SDK of a series of specific functional products, which cover image capturing, content understanding, result parsing, and interactive workflow.
 
-<a href="https://www.dynamsoft.com/capture-vision/docs/introduction/">Dynamsoft Capture Vision (DCV) </a> is an aggregating SDK of a series of specific functional products including:
+1. With the implementation of the Image Source Adapter (ISA) interface, a seamless integration with DCV is possible, allowing easy access to various image sources.
+2. Dynamsoft Barcode Reader (DBR), Dynamsoft Document Normalizer (DDN), and Dynamsoft Label Recognizer (DLR) play crucial roles in reading barcodes, structures, and texts from images.
+3. Dynamsoft Code Parser (DCP) is utilized to extract meaningful fields from text/bytes results, ensuring optimal data parsing capabilities.
+4. To seamlessly access intermediate and final results within the DCV SDK, the Capture Result Receiver (CRR) and Intermediate Result Receiver (IRR) interfaces are provided. After users implement these interfaces and register with DCV, they can obtain the results efficiently and conveniently.
+5. To view and edit the output results, Dynamsoft Camera Enhancer (DCE) provide a suite of robust viewing and editing functions.
 
-- Dynamsoft Camera Enhancer (DCE) which provides camera enhancements and UI configuration APIs.
-- Dynamsoft Barcode Reader (DBR) which provides barcode decoding algorithm and APIs.
-- Dynamsoft Label Recognizer (DLR) which provides label content recognizing algorithm and APIs.
-- Dynamsoft Document Normalizer (DDN) which provides document scanning algorithms and APIs.
+DCV powers your software development through the following aspects:
 
->Note: DCV React-Native edition currently only includes DCE and DBR modules. DLR and DDN modules are still under development and will be included in the future.
+1. Simplicity with Packable Scenarios
+2. Scalability with Pluggable Components
+3. Flexibility With Customizable Workflows
+4. High Performance With Shared Computations
+5. Bidirectional Interactivity with Intermediate Results
 
-## Getting Started
+DCV enables you to develop highly customizable applications for barcode reading, label recognition, document board detection, and result parsing. These applications offer enterprise-grade performance and can be tailored to meet your specific business needs.
 
-In <a href="https://www.dynamsoft.com/capture-vision/docs/programming/react-native/user-guide/barcode-reader.html" target="_blank">this guide</a>, you will learn step by step how to integrate the barcode reading capabilities of Dynamsoft Capture Vision React-Native SDK into your App.
 ## Samples
 
 You can view all the DCV React Native samples via the following links:
 
-- <a href = "https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/main/BarcodeReaderSimpleSample" target = "_blank" >Barcode reader simple sample</a>
-
-## API References
-
-View the API reference of DCV React Native Edition to explore the full feature of DCV:
-
-- <a href = "https://www.dynamsoft.com/capture-vision/docs/programming/react-native/api-reference/?ver=latest" target = "_blank" >DCV API Reference - React Native Edition</a>
-  - <a href = "https://www.dynamsoft.com/capture-vision/docs/programming/react-native/api-reference/barcode-reader.html?ver=latest" target = "_blank" >DCVBarcodeReader Class</a>
-  - <a href = "https://www.dynamsoft.com/capture-vision/docs/programming/react-native/api-reference/camera-view.html?ver=latest" target = "_blank" >DCVCameraView Class</a>
+- [Barcode reader simple sample](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/v2.x-alpha/BarcodeReaderSimpleSample)
+- [Document Scanner](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/v2.x-alpha/DocumentNormalizerSimpleSample)
+- [MRZ Scanner](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/v2.x-alpha/MRZScanner)
 
 ## License
 
-- You can also request an extension for your trial license in the [customer portal](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=github)
+- You can also request an extension for your trial license in the [customer portal](https://www.dynamsoft.com/customer/license/trialLicense?product=dcv&utm_source=github)
 
 ## Contact
 

package/android/.gitignore

@@ -0,0 +1,4 @@
+build
+.cxx
+.idea
+.gradle

package/android/CMakeLists.txt

@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.18.1)
+project("react-native-dcv-android")
+
+file(GLOB SRC_FILES "../cpp/*.cpp" "src/main/cpp/**.cpp" "src/main/cpp/*/*.cpp")
+
+add_library(${CMAKE_PROJECT_NAME} SHARED
+    ${SRC_FILES})
+
+find_package(ReactAndroid REQUIRED CONFIG)
+
+target_link_libraries(${CMAKE_PROJECT_NAME}
+    ReactAndroid::jsi   # <-- RN: JSI
+    android
+    log)

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

@@ -1,53 +1,133 @@
+def DEFAULT_COMPILE_SDK_VERSION = 34
+def DEFAULT_MIN_SDK_VERSION = 21
+def DEFAULT_TARGET_SDK_VERSION = 34
 
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+apply plugin: 'com.android.library'
+apply plugin: "kotlin-android"
+def isNewArchitectureEnabled = rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+if (isNewArchitectureEnabled) {
+    apply plugin: "com.facebook.react"
+}
 buildscript {
+    def kotlinVersion = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["kotlinVersion"]
     repositories {
         google()
         mavenCentral()
     }
-
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.3'
+        classpath 'com.android.tools.build:gradle:8.5.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
     }
 }
 
-apply plugin: 'com.android.library'
+def resolveBuildType() {
+    Gradle gradle = getGradle()
+    String tskReqStr = gradle.getStartParameter().getTaskRequests()['args'].toString()
+
+    return tskReqStr.contains('Release') ? 'release' : 'debug'
+}
+
+def supportsNamespace() {
+    def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
+    def major = parsed[0].toInteger()
+    def minor = parsed[1].toInteger()
+
+    // Namespace support was added in 7.3.0
+    return (major == 7 && minor >= 3) || major >= 8
+}
 
 android {
-    compileSdkVersion 30
-    buildToolsVersion "30.0.3"
+    if (supportsNamespace()) {
+        namespace "com.dynamsoft.reactnativelib"
+    }
+    sourceSets {
+        main {
+            manifest.srcFile supportsNamespace()?
+                    "src/main/withoutNamespace/AndroidManifest.xml":
+                    "src/main/withNamespace/AndroidManifest.xml"
+            java.srcDirs += isNewArchitectureEnabled? ["src/newarch"] : ["src/oldarch"]
+        }
+    }
 
+    compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
     defaultConfig {
-        minSdkVersion 21
-        targetSdkVersion 27
+        minSdkVersion safeExtGet('minSdkVersion', DEFAULT_MIN_SDK_VERSION)
+        targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
         versionCode 1
         versionName "1.0"
+        externalNativeBuild {
+            cmake {
+//                cppFlags "-O2 -frtti -fexceptions -Wall -Wno-unused-variable -fstack-protector-all"
+                arguments "-DANDROID_STL=c++_shared"
+            }
+        }
+        buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled.toString())
     }
     lintOptions {
         abortOnError false
     }
+    externalNativeBuild {
+        cmake {
+            path file('CMakeLists.txt')
+            version '3.18.1'
+        }
+    }
+
+    buildFeatures {
+        prefab true
+    }
+    packagingOptions {
+//        doNotStrip resolveBuildType() == 'debug' ? "**/**/*.so" : ''
+        excludes = [
+                "META-INF",
+                "META-INF/**",
+                "**/libjsi.so",
+                "**/libc++_shared.so"
+        ]
+    }
 }
 
 repositories {
+    // ref: https://www.baeldung.com/maven-local-repository
     google()
     mavenCentral()
     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"
+    }
 }
 
 rootProject.allprojects {
     repositories {
-      maven {
-        url "https://download2.dynamsoft.com/maven/aar"
-      }
-   }
+        maven {
+            url "https://download2.dynamsoft.com/maven/aar"
+        }
+        maven {
+            url "http://192.168.8.101:8081/repository/maven-dynamsoft-public/"
+            allowInsecureProtocol true
+        }
+    }
 }
 
 dependencies {
-    implementation 'com.dynamsoft:dynamsoftcameraenhancer:2.3.11@aar'
-    implementation 'com.dynamsoft:dynamsoftbarcodereader:9.6.20@aar'
+    def kotlinVersion = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["kotlinVersion"]
 
-    implementation 'com.facebook.react:react-native:+'
-}
+    //noinspection GradleDynamicVersion
+    implementation 'com.facebook.react:react-native:+'  // From node_modules
+//    compileOnly "com.facebook.react:react-android:0.75.2"
 
+    //noinspection GradleDependency
+
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3"
+
+    implementation "com.dynamsoft:dynamsoftcapturevisionbundle:2.4.2000"
+}

package/android/gradle.properties

@@ -0,0 +1,21 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+android.useAndroidX=true
+android.enableJetifier=true
+
+kotlinVersion=1.7.21
+minSdk=21
+targetSdk=34
+compileSdk=34
+ndkversion=21.4.7075529

package/android/settings.gradle

@@ -0,0 +1,6 @@
+rootProject.name = "react-native-dcv-android"
+
+if(file("$rootDir/../node_modules/@react-native-community/cli-platform-android/native_modules.gradle").exists()) {
+    apply from: file("$rootDir/../node_modules/@react-native-community/cli-platform-android/native_modules.gradle")
+    applyNativeModulesSettingsGradle(settings)
+}

package/android/src/main/cpp/MutableRawBuffer.cpp

@@ -0,0 +1,24 @@
+//
+// Created by Allen on 24/08/26.
+//
+
+
+#include "MutableRawBuffer.h"
+
+MutableRawBuffer::MutableRawBuffer(uint8_t* data, size_t size, bool freeOnDealloc)
+        : _data(data), _size(size), _freeOnDealloc(freeOnDealloc) {}
+
+MutableRawBuffer::~MutableRawBuffer() {
+    if (_freeOnDealloc && _data != nullptr) {
+        free(_data);
+        _data = nullptr;
+    }
+}
+
+size_t MutableRawBuffer::size() const {
+    return _size;
+}
+
+uint8_t* MutableRawBuffer::data() {
+    return _data;
+}

package/android/src/main/cpp/MutableRawBuffer.h

@@ -0,0 +1,24 @@
+//
+// Created by Allen on 24/08/26.
+//
+
+#ifndef REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_MUTABLERAWBUFFER_H_
+#define REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_MUTABLERAWBUFFER_H_
+
+
+#include <jsi/jsi.h>
+using namespace facebook::jsi;
+
+class MutableRawBuffer : public MutableBuffer {
+  public:
+    MutableRawBuffer(uint8_t* data, size_t size, bool freeOnDealloc);
+    ~MutableRawBuffer() override;
+
+    uint8_t* data() override;
+    [[nodiscard]] size_t size() const override;
+    uint8_t* _data;
+    size_t _size;
+    bool _freeOnDealloc;
+};
+
+#endif //REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_MUTABLERAWBUFFER_H_

package/android/src/main/cpp/android_log.h

@@ -0,0 +1,14 @@
+//
+// Created by Allen on 24/05/15.
+//
+
+#ifndef DYNAMSOFT_CORE_REACT_NATIVE_ANDROID_SRC_MAIN_CPP_ANDROID_LOG_H_
+#define DYNAMSOFT_CORE_REACT_NATIVE_ANDROID_SRC_MAIN_CPP_ANDROID_LOG_H_
+
+#include "android/log.h"
+#define LOG_TAG "Dynamsoft RN JNI"
+#define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__)
+#define LOGI(...) __android_log_print(ANDROID_LOG_INFO, LOG_TAG, __VA_ARGS__)
+#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)
+
+#endif //DYNAMSOFT_CORE_REACT_NATIVE_ANDROID_SRC_MAIN_CPP_ANDROID_LOG_H_

package/android/src/main/cpp/core/ImageDataHostObject.cpp

@@ -0,0 +1,95 @@
+//
+// Created by Allen on 24/08/26.
+//
+
+#include "ImageDataHostObject.h"
+#include "../MutableRawBuffer.h"
+#include "../android_log.h"
+
+#define JSI_FUNC [=](Runtime & runtime, const Value& thisValue, const Value* arguments, size_t count) -> Value
+#define GET_VALUE(X) if(name==#X){return this->X;}
+#define SET_INT_VALUE(X) if(name==#X){this->X = (int) value.asNumber();}
+
+ImageDataHostObject::ImageDataHostObject(int width, int height, int stride, int format, int orientation, uint8_t *buffer, int bufferSize)
+        : width(width), height(height), stride(stride), format(format), orientation(orientation), buffer(buffer), bufferSize(bufferSize) {
+}
+
+ImageDataHostObject ImageDataHostObject::getHOFromObject(Runtime &runtime, Object jsObj) {
+    if (jsObj.isHostObject(runtime)) {
+        return *((ImageDataHostObject *) (jsObj.asHostObject(runtime).get()));
+    }
+    ImageDataHostObject imageHO;
+    int width = jsObj.hasProperty(runtime, "width") ? (int) jsObj.getProperty(runtime, "width").asNumber() : 0;
+    int height = jsObj.hasProperty(runtime, "height") ? (int) jsObj.getProperty(runtime, "height").asNumber() : 0;
+    int stride = jsObj.hasProperty(runtime, "stride") ? (int) jsObj.getProperty(runtime, "stride").asNumber() : 0;
+    int format = jsObj.hasProperty(runtime, "format") ? (int) jsObj.getProperty(runtime, "format").asNumber() : 0;
+    int orientation = jsObj.hasProperty(runtime, "orientation") ? (int) jsObj.getProperty(runtime, "orientation").asNumber() : 0;
+    uint8_t *buffer = nullptr;
+    int bufferSize = 0;
+    if (jsObj.hasProperty(runtime, "buffer")) {
+        ArrayBuffer array_buffer = jsObj.getProperty(runtime, "buffer").asObject(runtime).getArrayBuffer(runtime);
+        buffer = array_buffer.data(runtime);
+        bufferSize = (int) array_buffer.length(runtime);
+    }
+    return ImageDataHostObject(width, height, stride, format, orientation, buffer, bufferSize);
+}
+
+Value ImageDataHostObject::get(Runtime &runtime, const PropNameID &propName) {
+    auto name = propName.utf8(runtime);
+    GET_VALUE(width)
+    GET_VALUE(height)
+    GET_VALUE(stride)
+    GET_VALUE(format)
+    GET_VALUE(orientation)
+    GET_VALUE(bufferSize)
+    //todo
+    if (name == "buffer") {
+        auto mutableBuffer = std::make_shared<MutableRawBuffer>(buffer, bufferSize, false);
+        return ArrayBuffer(runtime, mutableBuffer);
+    }
+
+    if (name == "release") {
+        auto release = JSI_FUNC {
+            if(buffer != nullptr) {
+                delete[] buffer;
+                buffer = nullptr;
+                bufferSize = 0;
+            }
+            return {};
+        };
+        return Function::createFromHostFunction(runtime, PropNameID::forUtf8(runtime, "release"), 0, release);
+    }
+    return {};
+}
+
+void ImageDataHostObject::set(Runtime &runtime, const PropNameID &propName, const Value &value) {
+    auto name = propName.utf8(runtime);
+    SET_INT_VALUE(width)
+    SET_INT_VALUE(height)
+    SET_INT_VALUE(stride)
+    SET_INT_VALUE(format)
+    SET_INT_VALUE(orientation)
+    //todo
+    if (name == "buffer") {
+        auto arrayBuffer = value.asObject(runtime).getArrayBuffer(runtime);
+        this->buffer = arrayBuffer.data(runtime);
+        this->bufferSize = (int) arrayBuffer.length(runtime);
+    }
+}
+
+std::vector<PropNameID> ImageDataHostObject::getPropertyNames(Runtime &rt) {
+    std::vector<PropNameID> result;
+    result.push_back(PropNameID::forUtf8(rt, std::string("width")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("height")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("stride")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("format")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("orientation")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("buffer")));
+    result.push_back(PropNameID::forUtf8(rt, std::string("release")));
+    return result;
+}
+
+void ImageDataHostObject::logString(const char *preStr) const {
+    LOGI("%s wid:%d, hgt:%d, stride:%d, format:%d, orientation:%d, bufferSize:%d, buffer:%p, this:%p",
+         preStr, width, height, stride, format, orientation, bufferSize, buffer, this);
+}

package/android/src/main/cpp/core/ImageDataHostObject.h

@@ -0,0 +1,34 @@
+//
+// Created by Allen on 24/08/26.
+//
+
+#ifndef REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_CORE_IMAGEDATAHOSTOBJECT_H_
+#define REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_CORE_IMAGEDATAHOSTOBJECT_H_
+
+#include "jsi/jsi.h"
+
+using namespace facebook::jsi;
+
+class ImageDataHostObject : public HostObject {
+  public:
+    int width = 0;
+    int height = 0;
+    int stride = 0;
+    int format = 0;
+    int orientation = 0;
+
+    uint8_t *buffer = nullptr;
+    int bufferSize = 0;
+
+    explicit ImageDataHostObject() = default;
+    explicit ImageDataHostObject(int width, int height, int stride, int format, int orientation, uint8_t *buffer, int bufferSize);
+
+    Value get(Runtime &, const PropNameID &name) override;
+    void set(Runtime &, const PropNameID &name, const Value &value) override;
+    std::vector<PropNameID> getPropertyNames(Runtime &rt) override;
+
+    static ImageDataHostObject getHOFromObject(Runtime &runtime, Object jsObj);
+    void logString(const char *preStr = "ImageDataHostObject") const;
+};
+
+#endif //REACT_NATIVE_DCV_ANDROID_SRC_MAIN_CPP_CORE_IMAGEDATAHOSTOBJECT_H_