react-native-image-stitcher 0.7.1 → 0.9.0

package/ios/Sources/RNImageStitcher/StitcherFrameHostObject.h

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// StitcherFrameHostObject.h — Obj-C facade for the v0.8.0
+// `StitcherFrame` JSI host object.  Header is intentionally
+// Obj-C-only (no `<jsi/jsi.h>` import) so this can land in the
+// public CocoaPods umbrella without breaking `use_frameworks!` hosts
+// (same rationale as `KeyframeGateBridge.h`).
+//
+// The C++ JSI host object class lives in the .mm; this facade
+// exposes only what cross-module callers need:
+//
+//   - Factory `+ fromARFrame:pose:` that the AR worklet runtime
+//     calls per ARFrame to construct a host object backed by the
+//     current AR session's frame.
+//   - Opaque accessor `- (void *)jsiHostObjectPtr` returning the
+//     `std::shared_ptr<facebook::jsi::HostObject> *` (boxed) that
+//     the worklet runtime hands to `jsi::Object::createFromHostObject`.
+//
+// Lifetime: the Obj-C wrapper holds the C++ shared_ptr; ARC frees
+// the wrapper when nothing references it.  Worklet runtime
+// invalidates the underlying ARFrame retain when the dispatch
+// returns; after invalidation, JSI access throws.
+
+#pragma once
+
+#import <Foundation/Foundation.h>
+#import <ARKit/ARKit.h>
+
+@class RNSARFramePose;
+
+NS_ASSUME_NONNULL_BEGIN
+
+NS_SWIFT_NAME(StitcherFrameHostObject)
+@interface StitcherFrameHostObject : NSObject
+
+/// Construct a host object backed by the supplied ARFrame + pose.
+/// Retains the ARFrame for the host object's lifetime — caller can
+/// safely release their reference.
+///
+/// Thread: safe to call from the ARSession delegate queue; the
+/// resulting host object's JSI access must happen on the worklet
+/// runtime's thread (separate queue).
++ (instancetype)fromARFrame:(ARFrame *)arFrame pose:(RNSARFramePose *)pose;
+
+/// Mark the host object's underlying ARFrame as no longer accessible.
+/// Subsequent JSI property reads return `undefined` or throw,
+/// depending on the property.  Idempotent.
+- (void)invalidate;
+
+/// Opaque pointer to a `std::shared_ptr<facebook::jsi::HostObject>`.
+/// The worklet runtime (Obj-C++ context with JSI available) casts
+/// this back via `*reinterpret_cast<std::shared_ptr<facebook::jsi::HostObject>*>(ptr)`
+/// to hand to `jsi::Object::createFromHostObject`.
+///
+/// Returns `NULL` if the host object has been invalidated.
+- (nullable void *)jsiHostObjectPtr;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Sources/RNImageStitcher/StitcherFrameHostObject.mm

@@ -0,0 +1,214 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// StitcherFrameHostObject.mm — iOS-specific wrapper for the shared
+// `retailens::StitcherFrameJsiHostObject` (defined in
+// `cpp/stitcher_frame_jsi.{hpp,cpp}`).
+//
+// Owns:
+//   - The Obj-C facade callable from Swift / other Obj-C / .mm files.
+//   - The iOS-specific `PixelBufferReader` impl (wraps a
+//     `CVPixelBufferRef` from `ARFrame.capturedImage`; lock / memcpy
+//     / unlock pattern).
+//   - The Obj-C → C++ extraction logic that builds a
+//     `retailens::StitcherFrameData` from an `ARFrame` + the lib's
+//     `RNSARFramePose`.
+//
+// Does NOT own:
+//   - The JSI `get` / `getPropertyNames` dispatch.  That lives in
+//     `cpp/stitcher_frame_jsi.cpp` and is identical to the Android
+//     implementation (DRY across platforms).
+
+#import "StitcherFrameHostObject.h"
+
+#import <Foundation/Foundation.h>
+#import <CoreVideo/CVPixelBuffer.h>
+#import <CoreMedia/CoreMedia.h>
+#import <os/log.h>
+
+#include <jsi/jsi.h>
+
+#include <algorithm>
+#include <cstring>
+#include <memory>
+#include <string>
+#include <utility>
+
+#include "stitcher_frame_data.hpp"
+#include "stitcher_frame_jsi.hpp"
+
+using namespace facebook;
+
+// Forward-declare the Swift `RNSARFramePose` Obj-C surface we need.
+// This matches the pattern in `KeyframeGateFrameProcessor.mm`
+// (forward-declaring `IncrementalStitcher`) — avoids depending on
+// the autogenerated `RNImageStitcher-Swift.h`, which is created at
+// build time and not always available to .mm files in this pod.
+//
+// MUST stay in sync with `RNSARSession.swift::RNSARFramePose` —
+// adding a new field there means adding it here too.
+@class RNSARFramePose;
+@interface RNSARFramePose : NSObject
+@property (nonatomic, readonly) double tx;
+@property (nonatomic, readonly) double ty;
+@property (nonatomic, readonly) double tz;
+@property (nonatomic, readonly) double qx;
+@property (nonatomic, readonly) double qy;
+@property (nonatomic, readonly) double qz;
+@property (nonatomic, readonly) double qw;
+@property (nonatomic, readonly) NSInteger imageWidth;
+@property (nonatomic, readonly) NSInteger imageHeight;
+@property (nonatomic, readonly) double timestampMs;
+@end
+
+#pragma mark - iOS PixelBufferReader
+
+namespace {
+
+/// iOS-specific `retailens::PixelBufferReader` impl.  See the base
+/// class docstring for the general contract (thread-affinity,
+/// invalidation semantics, Y-plane-only constraint).  This subclass
+/// adds:
+///   - `CVPixelBuffer` lock/memcpy/unlock per copyTo
+///   - `CFBridgingRetain` of the parent `ARFrame` so ARKit's
+///     pool can't reclaim the underlying buffer mid-read
+class IOSPixelBufferReader : public retailens::PixelBufferReader {
+ public:
+  explicit IOSPixelBufferReader(ARFrame* arFrame) {
+    // Retain the ARFrame for our lifetime.  CFBridgingRetain hands
+    // ARC ownership to our void*.  Released in destructor.
+    _retainedFrame = (void*)CFBridgingRetain(arFrame);
+    CVPixelBufferRef pixelBuffer = arFrame.capturedImage;
+    if (pixelBuffer != NULL) {
+      _bytesPerRow = CVPixelBufferGetBytesPerRow(pixelBuffer);
+      _height = CVPixelBufferGetHeight(pixelBuffer);
+    }
+  }
+
+  ~IOSPixelBufferReader() override {
+    // Transfer ownership back to ARC, which then releases.
+    if (_retainedFrame != nullptr) {
+      ARFrame* frame = CFBridgingRelease(_retainedFrame);
+      (void)frame;
+      _retainedFrame = nullptr;
+    }
+  }
+
+  std::size_t byteSize() const override {
+    return _bytesPerRow * _height;
+  }
+
+  std::size_t copyTo(uint8_t* dst, std::size_t maxBytes) override {
+    if (_retainedFrame == nullptr) return 0;
+    ARFrame* frame = (__bridge ARFrame*)_retainedFrame;
+    CVPixelBufferRef pixelBuffer = frame.capturedImage;
+    if (pixelBuffer == NULL) return 0;
+
+    CVPixelBufferLockBaseAddress(pixelBuffer, kCVPixelBufferLock_ReadOnly);
+    const uint8_t* src = (const uint8_t*)CVPixelBufferGetBaseAddress(pixelBuffer);
+    std::size_t toCopy = std::min<std::size_t>(byteSize(), maxBytes);
+    if (src != nullptr && toCopy > 0) {
+      std::memcpy(dst, src, toCopy);
+    } else {
+      toCopy = 0;
+    }
+    CVPixelBufferUnlockBaseAddress(pixelBuffer, kCVPixelBufferLock_ReadOnly);
+    return toCopy;
+  }
+
+ private:
+  void* _retainedFrame = nullptr;   // CFBridgingRetain'd ARFrame
+  std::size_t _bytesPerRow = 0;
+  std::size_t _height = 0;
+};
+
+}  // anonymous namespace
+
+#pragma mark - Obj-C facade
+
+@implementation StitcherFrameHostObject {
+  std::shared_ptr<retailens::StitcherFrameJsiHostObject> _hostObject;
+}
+
++ (instancetype)fromARFrame:(ARFrame*)arFrame pose:(RNSARFramePose*)pose {
+  StitcherFrameHostObject* obj = [[self alloc] init];
+
+  retailens::StitcherFrameData data;
+  data.source = "ar";
+  data.width = static_cast<int32_t>(pose.imageWidth);
+  data.height = static_cast<int32_t>(pose.imageHeight);
+  // ARKit's `kCVPixelFormatType_420YpCbCr8BiPlanarFullRange` (NV12)
+  // is reported as "yuv".  Other formats (rare in ARKit; possible if
+  // ARWorldTrackingConfiguration.videoFormat is overridden to BGRA)
+  // → "unknown" + os_log warning so worklets that gate on
+  // `pixelFormat === 'yuv'` can be debugged without a screen recording.
+  OSType pf = CVPixelBufferGetPixelFormatType(arFrame.capturedImage);
+  if (pf == kCVPixelFormatType_420YpCbCr8BiPlanarFullRange ||
+      pf == kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange) {
+    data.pixelFormat = "yuv";
+  } else {
+    data.pixelFormat = "unknown";
+    os_log_error(OS_LOG_DEFAULT,
+        "[StitcherFrame] unexpected ARKit pixel format 0x%x; "
+        "worklet receives pixelFormat='unknown' and toArrayBuffer() "
+        "bytes are first-plane only (layout undefined for unknown "
+        "formats).  See StitcherFrame.ts docstring.", (unsigned int)pf);
+  }
+  // ARKit doesn't have a `Frame.orientation` per se; pose carries
+  // the imageWidth >= imageHeight discriminator the lib uses
+  // elsewhere (`isLandscape`).  v0.8.0 ships a coarse mapping;
+  // worklets that need exact UI orientation can read it from
+  // device-orientation sensors.
+  data.orientation =
+      (pose.imageWidth >= pose.imageHeight) ? "landscape-right" : "portrait";
+  // `ARFrame.timestamp` is CFAbsoluteTime (seconds since epoch).
+  // Convert to ns to match vc Frame.timestamp.
+  data.timestampNs = arFrame.timestamp * 1e9;
+
+  data.qx = pose.qx;
+  data.qy = pose.qy;
+  data.qz = pose.qz;
+  data.qw = pose.qw;
+  data.tx = pose.tx;
+  data.ty = pose.ty;
+  data.tz = pose.tz;
+  data.hasTranslation = true;   // AR mode always has translation
+
+  switch (arFrame.camera.trackingState) {
+    case ARTrackingStateNotAvailable:
+      data.arTrackingState = "notAvailable";
+      break;
+    case ARTrackingStateLimited:
+      data.arTrackingState = "limited";
+      break;
+    case ARTrackingStateNormal:
+      data.arTrackingState = "normal";
+      break;
+  }
+
+  data.pixelReader = std::make_shared<IOSPixelBufferReader>(arFrame);
+
+  // Use the static factory (private ctor enforces shared_ptr
+  // ownership — required for `shared_from_this()` inside the JSI
+  // `toArrayBuffer` lambda).
+  obj->_hostObject =
+      retailens::StitcherFrameJsiHostObject::create(std::move(data));
+  return obj;
+}
+
+- (void)invalidate {
+  if (_hostObject) {
+    _hostObject->invalidate();
+  }
+}
+
+- (void*)jsiHostObjectPtr {
+  if (!_hostObject) return NULL;
+  // Box a heap-allocated copy of the shared_ptr to the abstract
+  // `jsi::HostObject` base.  Caller (worklet runtime) does:
+  //   auto sp = static_cast<std::shared_ptr<jsi::HostObject>*>(ptr);
+  //   auto jsObj = jsi::Object::createFromHostObject(rt, *sp);
+  //   delete sp;
+  return new std::shared_ptr<jsi::HostObject>(_hostObject);
+}
+
+@end

package/ios/Sources/RNImageStitcher/StitcherJsiInstaller.h

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// StitcherJsiInstaller.h — RN module that installs the
+// `globalThis.__stitcherProxy` JSI host object on the main JS
+// runtime.  Called once at lib boot from the TS layer
+// (`src/index.ts` or the `useFrameProcessor` hook) via a
+// synchronous JS bridge call.
+//
+// The proxy exposes two host functions:
+//
+//   __stitcherProxy.install(workletFn)  →  string ID
+//   __stitcherProxy.uninstall(id)       →  undefined
+//
+// `install` wraps the worklet function into a
+// `RNWorklet::WorkletInvoker` and stores it in the C++
+// `retailens::StitcherWorkletRegistry` singleton (in
+// `cpp/stitcher_worklet_registry.{hpp,cpp}`).  The AR worklet
+// runtime's per-frame dispatch reads from that registry to fan
+// out invocations.
+//
+// Why a RN module (not a vanilla NSObject installable):
+//   - Hosts can't reliably reach into the JSI runtime from JS
+//     without a native sync method to broker the install.
+//   - `RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD` is the documented
+//     pattern for "JS calls a native method synchronously to
+//     install JSI bindings on the main runtime".  vision-camera
+//     uses the same pattern (`VisionCameraInstaller.mm`).
+//   - In RN's bridgeless mode the legacy `RCTCxxBridge.runtime`
+//     accessor still works (vc has a comment to migrate but it
+//     hasn't been needed yet — same applies to us).
+
+#pragma once
+
+#import <Foundation/Foundation.h>
+#import <React/RCTBridgeModule.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface StitcherJsiInstaller : NSObject <RCTBridgeModule>
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Sources/RNImageStitcher/StitcherJsiInstaller.mm

@@ -0,0 +1,103 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// StitcherJsiInstaller.mm — implementation.  Installs
+// `globalThis.__stitcherProxy` on the main JS runtime.
+//
+// ## Why a host object rather than two globalThis functions
+//
+// We could install `__stitcherProxy_install` + `__stitcherProxy_uninstall`
+// directly on `globalThis`.  Wrapping them in a host object is
+// slightly more code but:
+//   - Namespaces the proxy under a single global property
+//     (easier to feature-detect; one `if (globalThis.__stitcherProxy)`
+//     instead of two).
+//   - Matches vc's pattern (`global.VisionCameraProxy`), so future
+//     readers recognise the shape.
+//   - Keeps room to grow (e.g., add `__stitcherProxy.snapshot()` for
+//     diagnostics) without polluting globalThis further.
+
+#import "StitcherJsiInstaller.h"
+
+#import <Foundation/Foundation.h>
+#import <React/RCTBridge.h>
+#import <React/RCTBridge+Private.h>
+#import <React/RCTUtils.h>
+#import <os/log.h>
+
+#include <jsi/jsi.h>
+
+#include "stitcher_proxy_jsi.hpp"
+
+using namespace facebook;
+
+// The host object class + install logic moved to shared C++ in
+// `cpp/stitcher_proxy_jsi.{hpp,cpp}` (v0.8.0 Phase 4b.ii).  The
+// Android JNI installer reuses the same `install` / `uninstall` /
+// `count` host functions verbatim — the JSI dispatch is identical
+// across platforms (matches the StitcherFrame host object's design).
+
+#pragma mark - RN module
+
+@implementation StitcherJsiInstaller
+
+// RN injects `_bridge` at module init (legacy bridge → RCTBridge*;
+// bridgeless / new arch → RCTBridgeProxy*, which forwards `runtime`
+// access via NSProxy `forwardInvocation:`).  Using the injected
+// `_bridge` instead of `[RCTBridge currentBridge]` is the
+// bridgeless-compatible idiom — `currentBridge` is nil under new
+// arch.  Pattern lifted from `react-native-worklets-core/ios/Worklets.mm`.
+@synthesize bridge = _bridge;
+
+RCT_EXPORT_MODULE()
+
++ (BOOL)requiresMainQueueSetup {
+  return YES;
+}
+
+- (void)setBridge:(RCTBridge*)bridge {
+  _bridge = bridge;
+}
+
+// Synchronous install method.  JS calls this once at lib bootstrap
+// to install the global proxy on the main JS runtime.  Returns
+// `@YES` on success or `@NO` if the JSI runtime wasn't reachable
+// (remote debug mode pre-Hermes; bridge not yet ready; etc.).
+//
+// `RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD` is the documented
+// pattern for "run native code synchronously on the JS thread to
+// install JSI bindings."  Same pattern worklets-core + vision-camera
+// use for their installs.
+//
+// **Bridgeless mode:** `_bridge` is an `RCTBridgeProxy` (NSProxy
+// subclass) that forwards `-runtime` / `-jsCallInvoker` invocations
+// to the underlying RCTHost-backed runtime.  The `(RCTCxxBridge*)`
+// cast is a no-op at runtime (NSProxy ignores static type) but
+// keeps the Obj-C compiler happy about property access.
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(install) {
+  if (_bridge == nil) {
+    os_log_error(OS_LOG_DEFAULT,
+        "[StitcherJsiInstaller] _bridge is nil; the module was "
+        "instantiated without bridge injection.  Cannot install "
+        "__stitcherProxy.");
+    return @NO;
+  }
+
+  RCTCxxBridge* cxxBridge = (RCTCxxBridge*)_bridge;
+  if (cxxBridge.runtime == nullptr) {
+    os_log_error(OS_LOG_DEFAULT,
+        "[StitcherJsiInstaller] _bridge.runtime is nullptr; the JS "
+        "runtime hasn't been initialized yet OR remote debugger is "
+        "attached.  Cannot install __stitcherProxy.");
+    return @NO;
+  }
+
+  jsi::Runtime& runtime = *(jsi::Runtime*)cxxBridge.runtime;
+  retailens::installStitcherProxy(runtime);
+
+  os_log_info(OS_LOG_DEFAULT,
+      "[StitcherJsiInstaller] installed globalThis.__stitcherProxy "
+      "on main JS runtime.");
+  return @YES;
+}
+
+@end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-image-stitcher",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "Pose-aware panorama capture + stitching for React Native. One <Camera> component, both tap-to-photo and hold-to-pan modes, both AR-backed and IMU-fallback capture paths.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/camera/Camera.tsx

@@ -294,21 +294,71 @@ export interface CameraProps {
   onError?: (err: CameraError) => void;
 
   /**
-   * Optional vision-camera frame processor.  Only attached to the
-   * non-AR preview (AR mode uses ARCameraView, which doesn't expose
-   * a worklet seam).  Build the worklet on the host side with
-   * `useFrameProcessor` from `react-native-vision-camera`.
+   * Optional host-supplied vision-camera frame processor.
    *
-   * Introduced for F8 (FrameProcessor port) — see
-   * `docs/f8-frame-processor-plan.md`.
+   * ## When to set this prop
    *
-   * The SDK installs its own frame processor via
-   * `useFrameProcessorDriver`.  Setting this prop is ignored with
-   * a one-time `console.warn` — supplying a host worklet would
-   * race with the SDK's pixel-buffer feed.  Either remove the prop
-   * or fork the SDK if you genuinely need a custom worklet.
+   * v0.8.0+ canonical answer: use the lib's own `useFrameProcessor`
+   * hook, NOT `react-native-vision-camera`'s.  The lib's hook:
    *
-   * AR mode is irrelevant: vision-camera's Camera isn't mounted.
+   *   - **AR mode**: auto-registers the worklet in the native
+   *     `__stitcherProxy` registry; the AR session's per-frame
+   *     dispatch fans out to it alongside the lib's first-party
+   *     stitching.  No prop wiring needed — just mount the hook
+   *     anywhere in the tree.
+   *   - **Non-AR mode**: returns a vc processor object that this
+   *     prop accepts.  Wiring it through enables the host's
+   *     worklet to fire on vc's Frame Processor runtime.
+   *
+   * ```tsx
+   * import { Camera, useFrameProcessor, type StitcherFrame }
+   *   from 'react-native-image-stitcher';
+   *
+   * function MyScreen() {
+   *   const fp = useFrameProcessor((frame: StitcherFrame) => {
+   *     'worklet';
+   *     // ...
+   *   }, []);
+   *   return <Camera frameProcessor={fp} ... />;
+   * }
+   * ```
+   *
+   * ## Non-AR mode tradeoff (HONEST)
+   *
+   * vision-camera's `<Camera>` accepts ONLY ONE frame processor.
+   * The lib's internal `useFrameProcessorDriver` produces the
+   * processor that drives first-party panorama stitching in non-AR
+   * mode.  If you supply your own via this prop, **the lib's
+   * first-party stitching is replaced** — panorama capture in
+   * non-AR mode will not produce stitched output until you remove
+   * the prop or fork the SDK to compose both worklets manually.
+   *
+   * For the common case (host wants worklet + lib wants stitching
+   * concurrently), prefer AR mode: the AR-mode path natively fans
+   * out to both the lib's first-party stitching AND every
+   * registered host worklet on every frame, with per-worklet
+   * failure isolation.
+   *
+   * Composition for non-AR mode (lib stitching + host worklet on
+   * the same vc processor) is tracked as a v0.9+ follow-up;
+   * needs the lib's first-party logic exposed as a vc Frame
+   * Processor plugin the host's worklet can call.
+   *
+   * ## AR mode behaviour
+   *
+   * In AR mode (`defaultCaptureSource="ar"` or runtime-toggled),
+   * vc's `<Camera>` isn't mounted; this prop has no effect.
+   * Host worklets registered via the lib's `useFrameProcessor`
+   * fire automatically through the AR-session dispatch path
+   * (iOS Phase 4b.i / Android Phase 4b.iii).
+   *
+   * ## Backwards compatibility
+   *
+   * The pre-v0.8.0 behaviour (warn + ignore) is preserved when the
+   * supplied processor is recognisably from
+   * `react-native-vision-camera`'s `useFrameProcessor` directly
+   * (no `__stitcherFrame` marker).  Hosts should migrate to the
+   * lib's `useFrameProcessor` to benefit from AR-mode dispatch.
    *
    * (v0.5 had a `legacyDriver` escape hatch that routed back to
    * `useIncrementalJSDriver`.  That hook + prop were removed in
@@ -791,29 +841,44 @@ export function Camera(props: CameraProps): React.JSX.Element {
   // eslint-disable-next-line react-hooks/exhaustive-deps
   useEffect(() => () => { fpDriver.stop(); }, []);
 
-  // One-shot deprecation warning when the host supplies their own
-  // `frameProcessor` prop.  Two worklets racing on the same
-  // producer thread would corrupt the engine's workQueue ordering,
-  // so the SDK's own worklet wins and the host's is silently
-  // ignored.  (v0.5 had a `legacyDriver` opt-out for hosts that
-  // wanted to route around the SDK driver; that was removed in
-  // v0.6 along with `useIncrementalJSDriver`.)
-  const hostFrameProcessorIgnoredWarnedRef = useRef(false);
+  // v0.8.0 Phase 5 — frameProcessor prop semantics:
+  //
+  //   - Host supplied? → use host's processor; lib's first-party
+  //     stitching is DISABLED in non-AR mode (vc accepts only one
+  //     processor).  One-shot console.info documents the tradeoff
+  //     so the host isn't surprised by "panorama capture stopped
+  //     producing output" in non-AR mode.  AR-mode capture is
+  //     unaffected — the AR-session dispatch path fans out to BOTH
+  //     first-party and host worklets independently.
+  //
+  //   - No host processor? → use `fpDriver.frameProcessor` which is
+  //     the lib's internal worklet driving first-party stitching
+  //     via `useFrameProcessorDriver`.  Default behaviour for the
+  //     common "I just want panorama capture" case.
+  //
+  // The pre-v0.8.0 behaviour (host's prop silently ignored with
+  // a warning) is gone — Phase 5 plumbs the prop through.  The
+  // tradeoff is honestly documented in the CameraProps docstring.
+  const hostFrameProcessorAcceptedWarnedRef = useRef(false);
   if (
     hostFrameProcessor != null
-    && !hostFrameProcessorIgnoredWarnedRef.current
+    && !hostFrameProcessorAcceptedWarnedRef.current
   ) {
-    hostFrameProcessorIgnoredWarnedRef.current = true;
+    hostFrameProcessorAcceptedWarnedRef.current = true;
     // eslint-disable-next-line no-console
-    console.warn(
-      '[react-native-image-stitcher] The `frameProcessor` prop on '
-      + '<Camera> is ignored — the SDK installs its own worklet '
-      + 'via useFrameProcessorDriver.  Remove the prop, or fork '
-      + 'the SDK if you genuinely need a custom worklet.',
+    console.info(
+      '[react-native-image-stitcher] Host frameProcessor supplied — '
+      + 'non-AR mode will run YOUR worklet instead of the lib\'s '
+      + 'first-party stitching plugin (vc accepts only one frame '
+      + 'processor).  Non-AR panorama capture will not produce '
+      + 'stitched output until this prop is removed.  AR-mode '
+      + 'capture is unaffected (AR-session dispatch fans out to '
+      + 'both first-party and host worklets independently).',
     );
   }
   // The Frame Processor worklet bound to vision-camera's Camera.
-  const effectiveFrameProcessor = fpDriver.frameProcessor;
+  // Host's wins if supplied; lib's internal driver otherwise.
+  const effectiveFrameProcessor = hostFrameProcessor ?? fpDriver.frameProcessor;
 
   // ── Subscribe to engine state for live keyframe thumbs ──────────
   useEffect(() => {

package/src/index.ts

@@ -182,6 +182,41 @@ export { useIncrementalStitcher } from './stitching/useIncrementalStitcher';
 // caveat).  Foundation for plugin-pattern host features (OCR per
 // keyframe, packet detection, server-side analysis, etc.).
 export { useKeyframeStream } from './stitching/useKeyframeStream';
+// v0.8.0 — unified frame contract for the worklet processor.  Same
+// JS-visible shape regardless of capture mode (AR vs non-AR).
+export type {
+  StitcherFrame,
+  StitcherFrameProcessor,
+  ARAnchor,
+} from './stitching/StitcherFrame';
+// v0.8.0 Phase 4a — public host-worklet hook.  Hosts that want a
+// per-frame callback (OCR overlay, packet detection, ML inference)
+// use this to attach a `'worklet'`-prefixed function that fires
+// on the camera producer thread.  Non-AR mode is fully wired
+// today via vision-camera passthrough; AR-mode dispatch is
+// API-stable but registration-only until Phase 4b lands the
+// cross-runtime handoff (the AR runtime iterating the registry).
+// See the hook's docstring + StitcherFrame.ts for the contract.
+export { useFrameProcessor } from './stitching/useFrameProcessor';
+// v0.9.0 Layer 2 — `useThrottledFrameProcessor`.  Throttle gate over
+// `useFrameProcessor` for sub-frame-rate worklet-native processing
+// (native OCR via Vision.framework / ML Kit, TFLite ML detection,
+// LiDAR depth).  The worklet runtime has direct access to
+// `frame.toArrayBuffer()` / `frame.arDepth`; bridge small payloads
+// (bboxes, depth-derived metrics) to JS via `runOnJS`.  For JS-thread
+// JPEG consumers (file-path OCR libs, cloud upload, thumbnail UI),
+// prefer `useFrameStream` (Layer 3, ships in the same release).
+export { useThrottledFrameProcessor } from './stitching/useThrottledFrameProcessor';
+export type { ThrottledFrameProcessorOptions } from './types';
+// v0.9.0 Layer 3 — `useFrameStream`.  JS-thread sampled-frame
+// stream over Layer 1 (`save_frame_as_jpeg` vc plugin) + Layer 2
+// (`useThrottledFrameProcessor`).  Use for JS-thread consumers:
+// file-path OCR libs (RN modules), cloud upload, thumbnail UI.
+// For worklet-native processing (Vision/ML Kit as vc plugins,
+// TFLite ML, LiDAR depth), prefer `useThrottledFrameProcessor`
+// (Layer 2) — lower latency, no JPEG roundtrip.
+export { useFrameStream } from './stitching/useFrameStream';
+export type { FrameStreamOptions, SampledFrame } from './types';
 // vision-camera Frame Processor driver for non-AR captures.  As
 // of v0.6 the only non-AR driver exported (the legacy
 // `useIncrementalJSDriver` was removed; was deprecated in v0.5).