feat: Implement Frame.close() (#229)

* Implement `Frame.close()`

* close frame in dtor

* Update JImageProxyHostObject.cpp

* fix close

* Check if closed

* remove a few logs

* r

* fix `isValid` and `isReady`

* Add JImage

* Release JNI frame ref on destroy

* fix pod setup

* Fix isValid call

* Fix `close` not returning a function

* throw error if closed twice

* iOS: Schedule `console.error` call on JS thread

* Android: Log Frame Processor Error to JS

* fix syntax

* Check if valid `toString()`

* Update Frame.ts

* Remove `isReady`

* Fix JImage accessors

* remove `JImage` C++ sources

* Throw error if accessing props on closed Frame

* Delete `JImage.h`

ios/Frame Processor/FrameHostObject.h

@@ -22,8 +22,11 @@ public:
 public:
   jsi::Value get(jsi::Runtime&, const jsi::PropNameID& name) override;
   std::vector<jsi::PropNameID> getPropertyNames(jsi::Runtime& rt) override;
-  void destroyBuffer();
-  
+  void close();
+
 public:
   Frame* frame;
+  
+private:
+  void assertIsFrameStrong(jsi::Runtime& runtime, const std::string& accessedPropName);
 };

ios/Frame Processor/FrameHostObject.mm

@@ -14,11 +14,11 @@ std::vector<jsi::PropNameID> FrameHostObject::getPropertyNames(jsi::Runtime& rt)
   std::vector<jsi::PropNameID> result;
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("toString")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("isValid")));
-  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("isReady")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("width")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("height")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("bytesPerRow")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("planesCount")));
+  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("close")));
   return result;
 }
 
@@ -26,7 +26,10 @@ jsi::Value FrameHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pr
   auto name = propName.utf8(runtime);
 
   if (name == "toString") {
-    auto toString = [this] (jsi::Runtime& runtime, const jsi::Value& thisValue, const jsi::Value* arguments, size_t count) -> jsi::Value {
+    auto toString = [this] (jsi::Runtime& runtime, const jsi::Value&, const jsi::Value*, size_t) -> jsi::Value {
+      if (this->frame == nil) {
+        return jsi::String::createFromUtf8(runtime, "[closed frame]");
+      }
       auto imageBuffer = CMSampleBufferGetImageBuffer(frame.buffer);
       auto width = CVPixelBufferGetWidth(imageBuffer);
       auto height = CVPixelBufferGetHeight(imageBuffer);
@@ -36,31 +39,41 @@ jsi::Value FrameHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pr
     };
     return jsi::Function::createFromHostFunction(runtime, jsi::PropNameID::forUtf8(runtime, "toString"), 0, toString);
   }
+  if (name == "close") {
+    auto close = [this] (jsi::Runtime& runtime, const jsi::Value&, const jsi::Value*, size_t) -> jsi::Value {
+      if (this->frame == nil) {
+        throw jsi::JSError(runtime, "Trying to close an already closed frame! Did you call frame.close() twice?");
+      }
+      this->close();
+      return jsi::Value::undefined();
+    };
+    return jsi::Function::createFromHostFunction(runtime, jsi::PropNameID::forUtf8(runtime, "close"), 0, close);
+  }
 
   if (name == "isValid") {
     auto isValid = frame != nil && CMSampleBufferIsValid(frame.buffer);
     return jsi::Value(isValid);
   }
-  if (name == "isReady") {
-    auto isReady = frame != nil && CMSampleBufferDataIsReady(frame.buffer);
-    return jsi::Value(isReady);
-  }
   if (name == "width") {
+    this->assertIsFrameStrong(runtime, name);
     auto imageBuffer = CMSampleBufferGetImageBuffer(frame.buffer);
     auto width = CVPixelBufferGetWidth(imageBuffer);
     return jsi::Value((double) width);
   }
   if (name == "height") {
+    this->assertIsFrameStrong(runtime, name);
     auto imageBuffer = CMSampleBufferGetImageBuffer(frame.buffer);
     auto height = CVPixelBufferGetHeight(imageBuffer);
     return jsi::Value((double) height);
   }
   if (name == "bytesPerRow") {
+    this->assertIsFrameStrong(runtime, name);
     auto imageBuffer = CMSampleBufferGetImageBuffer(frame.buffer);
     auto bytesPerRow = CVPixelBufferGetPlaneCount(imageBuffer);
     return jsi::Value((double) bytesPerRow);
   }
   if (name == "planesCount") {
+    this->assertIsFrameStrong(runtime, name);
     auto imageBuffer = CMSampleBufferGetImageBuffer(frame.buffer);
     auto planesCount = CVPixelBufferGetPlaneCount(imageBuffer);
     return jsi::Value((double) planesCount);
@@ -69,11 +82,21 @@ jsi::Value FrameHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pr
   return jsi::Value::undefined();
 }
 
-FrameHostObject::~FrameHostObject() {
-  destroyBuffer();
+void FrameHostObject::assertIsFrameStrong(jsi::Runtime &runtime, const std::string &accessedPropName) {
+  if (frame == nil) {
+    auto message = "Cannot get `" + accessedPropName + "`, frame is already closed!";
+    throw jsi::JSError(runtime, message.c_str());
+  }
 }
 
-void FrameHostObject::destroyBuffer() {
-  // ARC will hopefully delete it lol
-  this->frame = nil;
+FrameHostObject::~FrameHostObject() {
+  close();
+}
+
+void FrameHostObject::close() {
+  if (frame != nil) {
+    CMSampleBufferInvalidate(frame.buffer);
+    // ARC will hopefully delete it lol
+    this->frame = nil;
+  }
 }

ios/Frame Processor/FrameProcessorUtils.mm

@@ -28,7 +28,6 @@ FrameProcessorCallback convertJSIFunctionToFrameProcessorCallback(jsi::Runtime &
       cb.call(runtime, jsi::Object::createFromHostObject(runtime, frameHostObject));
     } catch (jsi::JSError& jsError) {
       auto message = jsError.getMessage();
-
       RCTBridge* bridge = [RCTBridge currentBridge];
       if (bridge != nil) {
         bridge.jsCallInvoker->invokeAsync([bridge, message]() {
@@ -44,6 +43,6 @@ FrameProcessorCallback convertJSIFunctionToFrameProcessorCallback(jsi::Runtime &
     //  1. we are sure we don't need it anymore, the frame processor worklet has finished executing.
     //  2. we don't know when the JS runtime garbage collects this object, it might be holding it for a few more frames
     //     which then blocks the camera queue from pushing new frames (memory limit)
-    frameHostObject->destroyBuffer();
+    frameHostObject->close();
   };
 }