react-native-yolo 0.0.1 → 0.0.3

package/README.md

@@ -1,18 +1,29 @@
 # react-native-yolo
 
-react-native-yolo is a react native package built with Nitro
+🚧 **Work in Progress**
+
+`react-native-yolo` is currently under active development and is **not yet ready for production use**. APIs, features, and installation steps may change between releases.
+
+The goal of this project is to provide YOLO-based object detection capabilities for React Native applications using Nitro Modules.
 
 [![Version](https://img.shields.io/npm/v/react-native-yolo.svg)](https://www.npmjs.com/package/react-native-yolo)
 [![Downloads](https://img.shields.io/npm/dm/react-native-yolo.svg)](https://www.npmjs.com/package/react-native-yolo)
 [![License](https://img.shields.io/npm/l/react-native-yolo.svg)](https://github.com/patrickkabwe/react-native-yolo/LICENSE)
 
+## Current Status
+
+* 🚧 Under active development
+* ⚠️ Breaking changes may occur between releases
+* ⚠️ Documentation is incomplete
+* ⚠️ Features are still being implemented and tested
+
 ## Requirements
 
-- React Native v0.76.0 or higher
-- Node 18.0.0 or higher
+* React Native v0.76.0 or higher
+* Node 18.0.0 or higher
 
-> [!IMPORTANT]  
-> To Support `Nitro Views` you need to install React Native version v0.78.0 or higher.
+> [!IMPORTANT]
+> To support `Nitro Views`, you need React Native v0.78.0 or higher.
 
 ## Installation
 
@@ -20,10 +31,21 @@ react-native-yolo is a react native package built with Nitro
 npm install react-native-yolo react-native-nitro-modules
 ```
 
+## Roadmap
+
+Planned features include:
+
+* YOLO model loading
+* Real-time object detection
+* Camera integration
+* Android support
+* iOS support
+* Performance optimizations
+
 ## Credits
 
 Bootstrapped with [create-nitro-module](https://github.com/patrickkabwe/create-nitro-module).
 
 ## Contributing
 
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+Contributions, bug reports, and feature requests are welcome. Since the project is still under development, feedback is especially appreciated.

package/android/build.gradle

@@ -137,6 +137,11 @@ dependencies {
 
   // Add a dependency on NitroModules
   implementation project(":react-native-nitro-modules")
+
+  // Add TensorFlow Lite dependencies
+  implementation "com.google.ai.edge.litert:litert:1.4.2"
+  implementation "com.google.ai.edge.litert:litert-support-api:1.4.2"
+  implementation "com.google.ai.edge.litert:litert-gpu:1.4.2"
 }
 
 if (isNewArchitectureEnabled()) {

package/android/src/main/java/com/yolo/HybridYolo.kt

@@ -1,12 +1,42 @@
 package com.yolo
 
+import android.net.Uri
+import android.util.Log
+import com.margelo.nitro.NitroModules
 import com.margelo.nitro.yolo.HybridYoloSpec
+import java.io.File
+import java.io.RandomAccessFile
+import java.net.URL
+import java.nio.MappedByteBuffer
+import java.nio.channels.FileChannel
+import org.tensorflow.lite.Interpreter
+import org.tensorflow.lite.support.common.FileUtil
+import yolo.com.loader.YoloModelLoader
+
+class HybridYolo : HybridYoloSpec() {
+    private var interpreter: Interpreter? = null
+    private val modelLoader = YoloModelLoader()
 
-class HybridYolo: HybridYoloSpec() {    
     override fun sum(num1: Double, num2: Double): Double {
         return num1 + num2
     }
-    override fun subtract(num1: Double, num2: Double): Double {
-        return num1 - num2
+
+    override fun loadModel(modelPath: String) {
+        val context =
+                NitroModules.applicationContext ?: throw IllegalStateException("Context is null")
+
+        Log.d("YOLO_TAG", "Trying to load: $modelPath")
+
+        try {
+            val modelBuffer = modelLoader.load(modelPath)
+
+            interpreter?.close()
+            interpreter = Interpreter(modelBuffer)
+
+            Log.d("YOLO_TAG", "✅ Model loaded successfully!")
+        } catch (e: Exception) {
+            Log.e("YOLO_TAG", "❌ Failed to load model: ${e.message}", e)
+        }
     }
+
 }

package/android/src/main/java/com/yolo/loader/YoloModelLoader.kt

@@ -0,0 +1,130 @@
+package yolo.com.loader
+
+import android.net.Uri
+import android.util.Log
+import com.yolo.utils.ContextProvider
+import java.io.File
+import java.io.RandomAccessFile
+import java.net.URL
+import java.nio.MappedByteBuffer
+import java.nio.channels.FileChannel
+import org.tensorflow.lite.support.common.FileUtil
+
+
+
+/**
+ * A utility class for loading YOLO models from various sources, including URLs, file URIs, absolute paths, and APK assets.
+ * This class provides methods to load a model into a MappedByteBuffer, which can be used with TensorFlow Lite's Interpreter for inference.
+ * It also includes methods to copy raw resources to the cache directory and map files for efficient reading
+ */
+class YoloModelLoader {
+    companion object {
+        private const val TAG = "YOLO_TAG_LOADER"
+    }
+
+    /**
+     * Loads a YOLO model from the specified path. The path can be a URL, a file URI, an absolute
+     * path, or an asset name.
+     * @param modelPath The path to the YOLO model.
+     * @return A MappedByteBuffer containing the model data.
+     * @throws IllegalArgumentException if the model cannot be loaded from the specified path.
+     */
+    fun load(modelPath: String): MappedByteBuffer {
+        val context = ContextProvider.context
+
+        return when {
+            modelPath.startsWith("http://") || modelPath.startsWith("https://") -> {
+                Log.d(TAG, "Loading model from URL")
+                val cachedFile = downloadToCache(modelPath)
+                mapFile(cachedFile)
+            }
+            modelPath.startsWith("file://") -> {
+                Log.d(TAG, "Loading model from file URI")
+                val file = File(Uri.parse(modelPath).path!!)
+                mapFile(file)
+            }
+            modelPath.startsWith("/") -> {
+                Log.d(TAG, "Loading model from absolute path")
+                mapFile(File(modelPath))
+            }
+            modelPath.startsWith("assets_") -> {
+                Log.d(TAG, "Loading model from RN raw resource")
+                val file = copyRawResourceToCache(modelPath)
+                mapFile(file)
+            }
+            else -> {
+                Log.d(TAG, "Loading model from APK assets")
+                FileUtil.loadMappedFile(context, modelPath)
+            }
+        }
+    }
+
+    /**
+     * Copies a raw resource to the cache directory and returns the corresponding File object.
+     * @param resourceName The name of the raw resource (without the file extension).
+     * @return The File object pointing to the copied resource in the cache directory.
+     * @throws IllegalArgumentException if the raw resource is not found.
+     */
+    private fun copyRawResourceToCache(resourceName: String): File {
+        val context = ContextProvider.context
+
+        val resId = context.resources.getIdentifier(resourceName, "raw", context.packageName)
+
+        if (resId == 0) {
+            throw IllegalArgumentException("Raw resource not found: $resourceName")
+        }
+
+        val file = File(context.cacheDir, "$resourceName.tflite")
+
+        context.resources.openRawResource(resId).use { input ->
+            file.outputStream().use { output -> input.copyTo(output) }
+        }
+
+        Log.d(TAG, "Copied raw resource to: ${file.absolutePath}")
+        Log.d(TAG, "Copied raw resource size: ${file.length()} bytes")
+
+        return file
+    }
+
+    /**
+     * Maps a file to a MappedByteBuffer for efficient reading.
+     * @param file The file to be mapped.
+     * @return A MappedByteBuffer containing the file data.
+     * @throws IllegalArgumentException if the file does not exist or is empty.
+     */
+    private fun mapFile(file: File): MappedByteBuffer {
+        if (!file.exists()) {
+            throw IllegalArgumentException("Model file does not exist: ${file.absolutePath}")
+        }
+
+        if (file.length() <= 0) {
+            throw IllegalArgumentException("Model file is empty: ${file.absolutePath}")
+        }
+
+        val randomAccessFile = RandomAccessFile(file, "r")
+        val fileChannel = randomAccessFile.channel
+
+        return fileChannel.map(FileChannel.MapMode.READ_ONLY, 0, fileChannel.size())
+    }
+
+    /**
+     * Downloads a file from a URL to the cache directory and returns the corresponding File object.
+     * @param urlString The URL of the file to download.
+     * @return The File object pointing to the downloaded file in the cache directory.
+     * @throws IllegalArgumentException if the file cannot be downloaded.
+     */
+    private fun downloadToCache(urlString: String): File {
+        val context = ContextProvider.context
+
+        val file = File(context.cacheDir, "yolo_model.tflite")
+
+        URL(urlString).openStream().use { input ->
+            file.outputStream().use { output -> input.copyTo(output) }
+        }
+
+        Log.d(TAG, "Downloaded model to: ${file.absolutePath}")
+        Log.d(TAG, "Downloaded model size: ${file.length()} bytes")
+
+        return file
+    }
+}

package/android/src/main/java/com/yolo/utils/ContextProvider.kt

@@ -0,0 +1,14 @@
+package com.yolo.utils
+
+import android.content.Context
+import com.margelo.nitro.NitroModules
+
+/**
+ * Provides a way to access the application context from anywhere in the app.
+ * This is useful for classes that do not have a direct reference to a Context object.
+ */
+object ContextProvider {
+    val context: Context
+        get() = NitroModules.applicationContext
+            ?: throw IllegalStateException("Context is null")
+}

package/ios/Bridge.h

@@ -2,7 +2,7 @@
 //  Bridge.h
 //  yolo
 //
-//  Created by Khaoula-Ghalimi on 17/06/2026
+//  Created by Khaoula-Ghalimi on 22/06/2026
 //
 
 #pragma once

package/ios/HybridYolo.swift

@@ -2,7 +2,7 @@
 //  HybridYolo.swift
 //  Pods
 //
-//  Created by Khaoula-Ghalimi on 17/06/2026.
+//  Created by Khaoula-Ghalimi on 22/06/2026.
 //
 
 import Foundation

package/lib/typescript/src/specs/yolo.nitro.d.ts

@@ -4,6 +4,6 @@ export interface Yolo extends HybridObject<{
     android: 'kotlin';
 }> {
     sum(num1: number, num2: number): number;
-    subtract(num1: number, num2: number): number;
+    loadModel(modelPath: string): void;
 }
 //# sourceMappingURL=yolo.nitro.d.ts.map

package/lib/typescript/src/specs/yolo.nitro.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"yolo.nitro.d.ts","sourceRoot":"","sources":["../../../../src/specs/yolo.nitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAE9D,MAAM,WAAW,IAAK,SAAQ,YAAY,CAAC;IAAE,GAAG,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IAC7E,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAC7C"}
+{"version":3,"file":"yolo.nitro.d.ts","sourceRoot":"","sources":["../../../../src/specs/yolo.nitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAE9D,MAAM,WAAW,IAAK,SAAQ,YAAY,CAAC;IAAE,GAAG,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IAC7E,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACvC,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC"}

package/nitrogen/generated/android/c++/JHybridYoloSpec.cpp

@@ -9,7 +9,7 @@
 
 
 
-
+#include <string>
 
 namespace margelo::nitro::yolo {
 
@@ -49,10 +49,9 @@ namespace margelo::nitro::yolo {
     auto __result = method(_javaPart, num1, num2);
     return __result;
   }
-  double JHybridYoloSpec::subtract(double num1, double num2) {
-    static const auto method = _javaPart->javaClassStatic()->getMethod<double(double /* num1 */, double /* num2 */)>("subtract");
-    auto __result = method(_javaPart, num1, num2);
-    return __result;
+  void JHybridYoloSpec::loadModel(const std::string& modelPath) {
+    static const auto method = _javaPart->javaClassStatic()->getMethod<void(jni::alias_ref<jni::JString> /* modelPath */)>("loadModel");
+    method(_javaPart, jni::make_jstring(modelPath));
   }
 
 } // namespace margelo::nitro::yolo

package/nitrogen/generated/android/c++/JHybridYoloSpec.hpp

@@ -55,7 +55,7 @@ namespace margelo::nitro::yolo {
   public:
     // Methods
     double sum(double num1, double num2) override;
-    double subtract(double num1, double num2) override;
+    void loadModel(const std::string& modelPath) override;
 
   private:
     jni::global_ref<JHybridYoloSpec::JavaPart> _javaPart;

package/nitrogen/generated/android/kotlin/com/margelo/nitro/yolo/HybridYoloSpec.kt

@@ -34,7 +34,7 @@ abstract class HybridYoloSpec: HybridObject() {
   
   @DoNotStrip
   @Keep
-  abstract fun subtract(num1: Double, num2: Double): Double
+  abstract fun loadModel(modelPath: String): Unit
 
   // Default implementation of `HybridObject.toString()`
   override fun toString(): String {

package/nitrogen/generated/ios/Yolo-Swift-Cxx-Bridge.hpp

@@ -47,5 +47,14 @@ namespace margelo::nitro::yolo::bridge::swift {
   inline Result_double_ create_Result_double_(const std::exception_ptr& error) noexcept {
     return Result<double>::withError(error);
   }
+  
+  // pragma MARK: Result<void>
+  using Result_void_ = Result<void>;
+  inline Result_void_ create_Result_void_() noexcept {
+    return Result<void>::withValue();
+  }
+  inline Result_void_ create_Result_void_(const std::exception_ptr& error) noexcept {
+    return Result<void>::withError(error);
+  }
 
 } // namespace margelo::nitro::yolo::bridge::swift

package/nitrogen/generated/ios/Yolo-Swift-Cxx-Umbrella.hpp

@@ -16,6 +16,7 @@ namespace margelo::nitro::yolo { class HybridYoloSpec; }
 #include <NitroModules/Result.hpp>
 #include <exception>
 #include <memory>
+#include <string>
 
 // C++ helpers for Swift
 #include "Yolo-Swift-Cxx-Bridge.hpp"

package/nitrogen/generated/ios/c++/HybridYoloSpecSwift.hpp

@@ -14,7 +14,7 @@ namespace Yolo { class HybridYoloSpec_cxx; }
 
 
 
-
+#include <string>
 
 #include "Yolo-Swift-Cxx-Umbrella.hpp"
 
@@ -74,13 +74,11 @@ namespace margelo::nitro::yolo {
       auto __value = std::move(__result.value());
       return __value;
     }
-    inline double subtract(double num1, double num2) override {
-      auto __result = _swiftPart.subtract(std::forward<decltype(num1)>(num1), std::forward<decltype(num2)>(num2));
+    inline void loadModel(const std::string& modelPath) override {
+      auto __result = _swiftPart.loadModel(modelPath);
       if (__result.hasError()) [[unlikely]] {
         std::rethrow_exception(__result.error());
       }
-      auto __value = std::move(__result.value());
-      return __value;
     }
 
   private:

package/nitrogen/generated/ios/swift/HybridYoloSpec.swift

@@ -14,7 +14,7 @@ public protocol HybridYoloSpec_protocol: HybridObject {
 
   // Methods
   func sum(num1: Double, num2: Double) throws -> Double
-  func subtract(num1: Double, num2: Double) throws -> Double
+  func loadModel(modelPath: String) throws -> Void
 }
 
 public extension HybridYoloSpec_protocol {

package/nitrogen/generated/ios/swift/HybridYoloSpec_cxx.swift

@@ -137,14 +137,13 @@ open class HybridYoloSpec_cxx {
   }
   
   @inline(__always)
-  public final func subtract(num1: Double, num2: Double) -> bridge.Result_double_ {
+  public final func loadModel(modelPath: std.string) -> bridge.Result_void_ {
     do {
-      let __result = try self.__implementation.subtract(num1: num1, num2: num2)
-      let __resultCpp = __result
-      return bridge.create_Result_double_(__resultCpp)
+      try self.__implementation.loadModel(modelPath: String(modelPath))
+      return bridge.create_Result_void_()
     } catch (let __error) {
       let __exceptionPtr = __error.toCpp()
-      return bridge.create_Result_double_(__exceptionPtr)
+      return bridge.create_Result_void_(__exceptionPtr)
     }
   }
 }

package/nitrogen/generated/shared/c++/HybridYoloSpec.cpp

@@ -15,7 +15,7 @@ namespace margelo::nitro::yolo {
     // load custom methods/properties
     registerHybrids(this, [](Prototype& prototype) {
       prototype.registerHybridMethod("sum", &HybridYoloSpec::sum);
-      prototype.registerHybridMethod("subtract", &HybridYoloSpec::subtract);
+      prototype.registerHybridMethod("loadModel", &HybridYoloSpec::loadModel);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridYoloSpec.hpp

@@ -15,7 +15,7 @@
 
 
 
-
+#include <string>
 
 namespace margelo::nitro::yolo {
 
@@ -49,7 +49,7 @@ namespace margelo::nitro::yolo {
     public:
       // Methods
       virtual double sum(double num1, double num2) = 0;
-      virtual double subtract(double num1, double num2) = 0;
+      virtual void loadModel(const std::string& modelPath) = 0;
 
     protected:
       // Hybrid Setup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-yolo",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "react-native-yolo is a react native package built with Nitro",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
@@ -119,4 +119,4 @@
       ]
     ]
   }
-}
+}

package/src/index.ts

@@ -1,5 +1,12 @@
 import { NitroModules } from 'react-native-nitro-modules'
 import type { Yolo as YoloSpec } from './specs/yolo.nitro'
+import { Image } from 'react-native'
 
-export const Yolo =
-  NitroModules.createHybridObject<YoloSpec>('Yolo')
+const NativeYolo = NitroModules.createHybridObject<YoloSpec>('Yolo')
+
+export const Yolo = Object.assign(NativeYolo, {
+  loadModelTest(modelAssetId: number){
+    const { uri } = Image.resolveAssetSource(modelAssetId);
+    return NativeYolo.loadModel(uri)
+  },
+})

package/src/specs/yolo.nitro.ts

@@ -1,6 +1,7 @@
 import type { HybridObject } from 'react-native-nitro-modules'
 
+
 export interface Yolo extends HybridObject<{ ios: 'swift', android: 'kotlin' }> {
   sum(num1: number, num2: number): number
-  subtract(num1: number, num2: number): number
+  loadModel(modelPath: string): void
 }