react-native-image-stitcher 0.7.1 → 0.8.0

package/cpp/stitcher_worklet_dispatch.cpp

@@ -0,0 +1,103 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// stitcher_worklet_dispatch.cpp — implementation of the v0.8.0
+// Phase 4b.iii per-frame fan-out helper.  See header for contract.
+
+#include "stitcher_worklet_dispatch.hpp"
+
+#include "stitcher_frame_jsi.hpp"
+#include "stitcher_worklet_registry.hpp"
+
+#include <react-native-worklets-core/WKTJsiWorklet.h>
+#include <react-native-worklets-core/WKTJsiWorkletContext.h>
+
+#include <exception>
+#include <memory>
+#include <utility>
+#include <vector>
+
+#if defined(__ANDROID__)
+#include <android/log.h>
+#define DISPATCH_LOG_ERROR(...) \
+  __android_log_print(ANDROID_LOG_ERROR, "StitcherWorkletDispatch", __VA_ARGS__)
+#else
+// iOS path uses `os_log` from its caller (RNSARWorkletRuntime.mm);
+// this shared helper isn't invoked from iOS in v0.8.0.  Fall back
+// to fprintf for any non-Android build that picks this up.
+#include <cstdio>
+#define DISPATCH_LOG_ERROR(...) std::fprintf(stderr, __VA_ARGS__)
+#endif
+
+namespace retailens {
+
+void dispatchToHostWorklets(RNWorklet::JsiWorkletContext* context,
+                             StitcherFrameData data) {
+  // Fast-path early-exit when no host worklets are registered.
+  // The Android caller (`StitcherWorkletRuntime.dispatchToHostWorklets`)
+  // already runs in a hot per-frame loop; saving the host-object
+  // alloc + dispatch hop on every frame is meaningful — typical
+  // first-party-only deployments will hit this path.
+  auto invokers = StitcherWorkletRegistry::shared().snapshot();
+  if (invokers.empty()) {
+    return;
+  }
+
+  if (context == nullptr) {
+    DISPATCH_LOG_ERROR(
+        "dispatchToHostWorklets: context is null; "
+        "did Worklets.install() run on the JS side?");
+    return;
+  }
+
+  // Build the JSI host object on the worklet thread (inside the
+  // lambda) so JSI access happens on the target runtime.
+  // `StitcherFrameJsiHostObject::create` uses the `make_shared`-via-
+  // factory pattern (required by `shared_from_this()` inside the
+  // `toArrayBuffer` lambda); see its header.
+  //
+  // Capture `data` by-move so the StitcherFrameData (including the
+  // pixel reader's shared_ptr) lives until the lambda runs.
+  // Capture `invokers` by-move as well.
+  context->invokeOnWorkletThread(
+      [invokers = std::move(invokers), data = std::move(data)](
+          RNWorklet::JsiWorkletContext* /*ctx*/,
+          facebook::jsi::Runtime& rt) mutable {
+        auto hostObj = StitcherFrameJsiHostObject::create(std::move(data));
+        facebook::jsi::Object frameJsi =
+            facebook::jsi::Object::createFromHostObject(rt, hostObj);
+        facebook::jsi::Value frameVal(rt, frameJsi);
+
+        for (const auto& entry : invokers) {
+          if (!entry.invoker) continue;
+          try {
+            entry.invoker->call(rt, facebook::jsi::Value::undefined(),
+                                 &frameVal, 1);
+          } catch (const facebook::jsi::JSError& jsErr) {
+            // Per-worklet failure isolation: one host worklet
+            // throwing must NOT stop the lib's own path or other
+            // host worklets.  Log + continue.  Same three-level
+            // catch hierarchy iOS' `RNSARWorkletRuntime` uses.
+            DISPATCH_LOG_ERROR(
+                "host worklet '%s' threw JS error: %s",
+                entry.id.c_str(), jsErr.what());
+          } catch (const std::exception& e) {
+            DISPATCH_LOG_ERROR(
+                "host worklet '%s' threw native exception: %s",
+                entry.id.c_str(), e.what());
+          } catch (...) {
+            DISPATCH_LOG_ERROR(
+                "host worklet '%s' threw unknown exception",
+                entry.id.c_str());
+          }
+        }
+
+        // Invalidate after all worklets finish.  Releases the
+        // PixelBufferReader's shared_ptr, which (when its refcount
+        // drops to 0) drops the underlying buffer — for Android
+        // that's the std::vector of copied NV21 bytes; for iOS it
+        // would be the CFBridgingRetain'd ARFrame.
+        hostObj->invalidate();
+      });
+}
+
+}  // namespace retailens

package/cpp/stitcher_worklet_dispatch.hpp

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// stitcher_worklet_dispatch.hpp — shared C++ helper that fans out a
+// `StitcherFrameData` to every host worklet registered in the
+// process-scope `retailens::StitcherWorkletRegistry`.
+//
+// v0.8.0 Phase 4b.iii — used by Android's per-frame fan-out path
+// (`StitcherWorkletRuntime.dispatchToHostWorklets` → JNI binding →
+// this function).  Designed to be platform-neutral so iOS' inline
+// dispatch in `RNSARWorkletRuntime.mm` could refactor onto this
+// helper in a later cleanup pass.
+//
+// ## Threading
+//
+// `dispatchToHostWorklets` is safe to call from ANY thread.  It
+// posts a lambda onto `context`'s worklet thread via
+// `JsiWorkletContext::invokeOnWorkletThread`.  The caller's thread
+// returns immediately (async); the lambda runs later on the
+// worklet thread.
+//
+// `data` is moved into the lambda — including the
+// `std::shared_ptr<PixelBufferReader>` which owns the pixel bytes.
+// The reader (and any underlying buffer it holds) lives until the
+// dispatch lambda completes + the resulting jsi::Object is GC'd by
+// the worklet runtime.
+
+#pragma once
+
+#include "stitcher_frame_data.hpp"
+
+#include <jsi/jsi.h>
+
+namespace RNWorklet {
+class JsiWorkletContext;
+}
+
+namespace retailens {
+
+/// Fan out a `StitcherFrameData` to every registered host worklet.
+///
+/// Behaviour:
+///
+///   1. Fast-path early-exit when `StitcherWorkletRegistry::shared()`
+///      is empty.  No host object is constructed; the caller's
+///      thread returns immediately.
+///   2. Otherwise, the function snapshots the registry, constructs
+///      a `StitcherFrameJsiHostObject` (deferred until inside the
+///      worklet-thread lambda so JSI access happens on the
+///      target runtime), and dispatches via
+///      `context->invokeOnWorkletThread(...)`.
+///   3. Each registered `RNWorklet::WorkletInvoker` is called with
+///      the host object as its single argument.  Per-worklet failure
+///      isolation: exceptions thrown by one invoker do NOT stop
+///      the next invoker (each call is try/catch'd).
+///   4. After all invokers return, the host object is invalidated;
+///      its underlying `PixelBufferReader` is released so the
+///      caller-provided buffer (NV21 bytes / CVPixelBuffer / etc.)
+///      can be reclaimed.
+///
+/// @param context  Worklet runtime to dispatch on.  On Android this
+///                 is typically `RNWorklet::JsiWorkletContext::
+///                 getDefaultInstance()` (worklets-core's default,
+///                 set up by `Worklets.install()`).  iOS uses its
+///                 own context (`RNSARWorkletRuntime::_ctx`).
+///                 MUST be non-null and initialized.
+/// @param data     Frame data + pixel reader.  Moved into the
+///                 worklet-thread lambda.
+void dispatchToHostWorklets(RNWorklet::JsiWorkletContext* context,
+                             StitcherFrameData data);
+
+}  // namespace retailens

package/cpp/stitcher_worklet_registry.cpp

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// stitcher_worklet_registry.cpp — implementation of the v0.8.0
+// Phase 4b native worklet registry.  See header for the public
+// contract + threading rules.
+
+#include "stitcher_worklet_registry.hpp"
+
+// Cross-platform worklets-core header include.  On iOS the
+// CocoaPods setup publishes worklets-core headers via
+// `HEADER_SEARCH_PATHS` at the root of `Pods/Headers/Public/`,
+// so `<WKTJsiWorklet.h>` works.  On Android the prefab puts
+// headers under a `react-native-worklets-core/` subdirectory of
+// the include path (matches the prefab name).  The angled
+// namespace-prefixed include works on BOTH — `<x/y.h>` resolves
+// to `Pods/Headers/Public/x/y.h` on iOS (CocoaPods auto-creates
+// symlinked subdirs per pod) and to `build/headers/.../x/y.h` on
+// Android.  Pattern lifted from vc's
+// `node_modules/react-native-vision-camera/android/src/main/cpp/`.
+#include <react-native-worklets-core/WKTJsiWorklet.h>
+
+#include <algorithm>
+#include <sstream>
+
+namespace retailens {
+
+StitcherWorkletRegistry& StitcherWorkletRegistry::shared() {
+  static StitcherWorkletRegistry s_instance;
+  return s_instance;
+}
+
+std::string StitcherWorkletRegistry::install(
+    facebook::jsi::Runtime& mainRuntime,
+    const facebook::jsi::Value& workletValue) {
+  // Construct the invoker outside the lock — the WorkletInvoker
+  // constructor calls into worklets-core which acquires its own
+  // locks; nesting our lock around that would invite a deadlock if
+  // worklets-core ever called back into our code synchronously.
+  auto invoker = std::make_shared<RNWorklet::WorkletInvoker>(
+      mainRuntime, workletValue);
+
+  std::lock_guard<std::mutex> lock(_mutex);
+  std::ostringstream idStream;
+  idStream << "host-" << _nextId++;
+  std::string id = idStream.str();
+  _entries.push_back({id, std::move(invoker)});
+  return id;
+}
+
+void StitcherWorkletRegistry::uninstall(const std::string& id) {
+  std::lock_guard<std::mutex> lock(_mutex);
+  // erase-remove with a predicate (single-pass O(n) — n is tiny in
+  // practice, typically 0-3).
+  _entries.erase(
+      std::remove_if(_entries.begin(), _entries.end(),
+                     [&id](const StitcherWorkletEntry& e) {
+                       return e.id == id;
+                     }),
+      _entries.end());
+}
+
+std::vector<StitcherWorkletEntry> StitcherWorkletRegistry::snapshot() {
+  std::lock_guard<std::mutex> lock(_mutex);
+  // Copy the vector — entries hold shared_ptrs so this is O(n)
+  // refcount bumps, no deep copies.  Returning by value lets the
+  // caller iterate without holding the lock.
+  return _entries;
+}
+
+std::size_t StitcherWorkletRegistry::count() {
+  std::lock_guard<std::mutex> lock(_mutex);
+  return _entries.size();
+}
+
+void StitcherWorkletRegistry::_resetForTests() {
+  std::lock_guard<std::mutex> lock(_mutex);
+  _entries.clear();
+  _nextId = 0;
+}
+
+}  // namespace retailens

package/cpp/stitcher_worklet_registry.hpp

@@ -0,0 +1,136 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// stitcher_worklet_registry.hpp — process-scope native registry of
+// host-supplied worklets (v0.8.0 Phase 4b).
+//
+// ## What this is
+//
+// The native-side counterpart to the JS-side `StitcherWorkletRegistry`
+// singleton (`src/stitching/StitcherWorkletRegistry.ts`).  When the
+// public `useFrameProcessor` hook is mounted from JS, it calls into a
+// JSI installable (`globalThis.__stitcherProxy.install(workletFn)`)
+// that wraps the worklet's JSI value into a
+// `RNWorklet::WorkletInvoker` and stores it here.  Unmount calls
+// `__stitcherProxy.uninstall(id)` which removes the entry.
+//
+// The AR worklet runtime's per-frame dispatch (`RNSARWorkletRuntime::
+// dispatchFrame:pose:` on iOS) reads from this registry to fan out
+// invocations across all registered host worklets.  The vc-mode
+// path (non-AR) does NOT touch this registry — vision-camera owns
+// the Frame Processor runtime in that mode and our public hook
+// passes the worklet through to vc unchanged.
+//
+// ## Threading
+//
+// `install` / `uninstall` are called from the main JS thread
+// (`useFrameProcessor`'s `useEffect` body).
+//
+// `snapshot` is called from the AR session callback thread (the
+// caller thread of `RNSARWorkletRuntime::dispatchFrame:pose:`).  The
+// snapshot returns shared_ptrs, so even if `uninstall` races on the
+// JS thread between the snapshot and the worklet runtime's
+// invocation, the WorkletInvoker stays alive until the caller drops
+// the shared_ptr.  WorkletInvoker itself does NOT need its caller
+// to live on a particular thread — the `call` method takes the
+// target `jsi::Runtime&` as an argument, so callers from any
+// thread can invoke it on any runtime they own.
+//
+// Mutation is serialised through `_mutex` (std::mutex).  Reads via
+// `snapshot` lock briefly to copy the entry vector; that's microseconds
+// at most (registry typically has 0-3 entries).  No worklet invocation
+// happens under the lock.
+//
+// ## Lifetime
+//
+// The registry is a `static`-local singleton, constructed on first
+// `shared()` call (function-static init = thread-safe per the C++11
+// memory model).  It outlives every JS / native runtime in the
+// process.  Entries are only added by `install` and only removed by
+// `uninstall` — no GC, no weak refs.  Hosts that bypass the
+// `useFrameProcessor` hook and call `install` directly without ever
+// calling `uninstall` leak entries (matches the JS-side singleton's
+// contract).
+//
+// ## Why a singleton (not per-runtime / per-AR-session)
+//
+// The AR worklet runtime (`RNSARWorkletRuntime` / `StitcherWorkletRuntime`)
+// is itself a process-scope singleton.  The hook lifecycle is
+// per-component-mount.  Registering against a per-AR-session registry
+// would mean re-registering each time AR mode starts — but the host
+// worklet's identity hasn't changed.  Process-scope = "registry
+// matches the host's mental model of `useFrameProcessor` semantics".
+
+#pragma once
+
+#include <jsi/jsi.h>
+
+#include <memory>
+#include <mutex>
+#include <string>
+#include <utility>
+#include <vector>
+
+// Forward-declare to avoid pulling the whole worklets-core header
+// into every translation unit that just needs to hold an invoker
+// pointer.  The .cpp includes the full header.
+namespace RNWorklet {
+class WorkletInvoker;
+}
+
+namespace retailens {
+
+/// One registered host worklet.  Public so callers iterating via
+/// `snapshot` can read both the ID and the invoker.
+struct StitcherWorkletEntry {
+  std::string id;
+  std::shared_ptr<RNWorklet::WorkletInvoker> invoker;
+};
+
+class StitcherWorkletRegistry {
+ public:
+  /// Process-scope singleton.  Thread-safe lazy init via C++11
+  /// function-static.
+  static StitcherWorkletRegistry& shared();
+
+  /// Install a host worklet.  Wraps the JSI value (the worklet's
+  /// `'worklet'`-decorated function from the main JS runtime) into
+  /// a `WorkletInvoker` and stores it.  Returns a stable string ID
+  /// the caller passes to `uninstall`.
+  ///
+  /// Thread: must be called from a thread that owns `mainRuntime`
+  /// (typically the main JS thread).  The wrapped `WorkletInvoker`
+  /// can then be invoked from any thread on any runtime via
+  /// `call(rt, ...)`.
+  std::string install(facebook::jsi::Runtime& mainRuntime,
+                       const facebook::jsi::Value& workletValue);
+
+  /// Remove a previously-installed entry by ID.  No-op for unknown
+  /// IDs (matches the JS-side `StitcherWorkletRegistry` semantics).
+  void uninstall(const std::string& id);
+
+  /// Snapshot the current entries.  The returned vector holds
+  /// shared_ptrs to `WorkletInvoker`; mutations against the
+  /// registry after `snapshot` returns do not affect the snapshot.
+  /// Callers iterate without holding the registry lock.
+  std::vector<StitcherWorkletEntry> snapshot();
+
+  /// Current entry count.  Used by `dispatchFrame:` for the
+  /// fast-path early-exit (no fan-out cost when no host worklets
+  /// are registered).
+  std::size_t count();
+
+  /// Test-only — clear all entries.  Used by C++ unit tests; not
+  /// exposed through the JSI surface.
+  void _resetForTests();
+
+ private:
+  StitcherWorkletRegistry() = default;
+  StitcherWorkletRegistry(const StitcherWorkletRegistry&) = delete;
+  StitcherWorkletRegistry& operator=(const StitcherWorkletRegistry&) = delete;
+
+  std::mutex _mutex;
+  std::vector<StitcherWorkletEntry> _entries;
+  int _nextId = 0;
+};
+
+}  // namespace retailens

package/dist/camera/Camera.d.ts

@@ -192,21 +192,71 @@ export interface CameraProps {
     onFramesDropped?: (info: FramesDroppedInfo) => void;
     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

package/dist/camera/Camera.js

@@ -435,25 +435,40 @@ function Camera(props) {
     // Safety: stop the driver if the component unmounts mid-recording.
     // eslint-disable-next-line react-hooks/exhaustive-deps
     (0, react_1.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 = (0, react_1.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 = (0, react_1.useRef)(false);
     if (hostFrameProcessor != null
-        && !hostFrameProcessorIgnoredWarnedRef.current) {
-        hostFrameProcessorIgnoredWarnedRef.current = true;
+        && !hostFrameProcessorAcceptedWarnedRef.current) {
+        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 ──────────
     (0, react_1.useEffect)(() => {
         const sub = (0, incremental_1.subscribeIncrementalState)((state) => {

package/dist/index.d.ts

@@ -65,6 +65,8 @@ export { IncrementalOutcome, incrementalStitcherIsAvailable, subscribeIncrementa
 export type { IncrementalState, AcceptedKeyframe } from './stitching/incremental';
 export { useIncrementalStitcher } from './stitching/useIncrementalStitcher';
 export { useKeyframeStream } from './stitching/useKeyframeStream';
+export type { StitcherFrame, StitcherFrameProcessor, ARAnchor, } from './stitching/StitcherFrame';
+export { useFrameProcessor } from './stitching/useFrameProcessor';
 export { useFrameProcessorDriver } from './stitching/useFrameProcessorDriver';
 export type { UseFrameProcessorDriverOptions, FrameProcessorDriverHandle, } from './stitching/useFrameProcessorDriver';
 export { stitchVideo } from './stitching/stitchVideo';

package/dist/index.js

@@ -22,7 +22,7 @@
  * adds RetaiLens-specific features on top.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stitchVideo = exports.useFrameProcessorDriver = exports.useKeyframeStream = exports.useIncrementalStitcher = exports.cleanupOldKeyframes = exports.getIncrementalNativeModule = exports.subscribeIncrementalState = exports.incrementalStitcherIsAvailable = exports.IncrementalOutcome = exports.useDeviceOrientation = exports.useVideoCapture = exports.useCapture = exports.ViewportCropOverlay = exports.hybridSettingsToNativeConfig = exports.slitscanSettingsToNativeConfig = exports.panoramaSettingsToNativeConfig = exports.DEFAULT_HYBRID_SETTINGS = exports.DEFAULT_SLITSCAN_SETTINGS = exports.DEFAULT_FLOW_GATE_SETTINGS = exports.DEFAULT_PANORAMA_SETTINGS = exports.PanoramaSettingsModal = exports.PanoramaGuidance = exports.PanoramaBandOverlay = exports.IncrementalPanGuide = exports.CaptureThumbnailStrip = exports.useStitchStatsToast = exports.CaptureStitchStatsToast = exports.CaptureOrientationPill = exports.CaptureKeyframePill = exports.CaptureMemoryPill = exports.CaptureDebugOverlay = exports.CaptureStatusOverlay = exports.CapturePreview = exports.CaptureControlsBar = exports.CaptureHeader = exports.CameraView = exports.ARCameraView = exports.useIMUTranslationGate = exports.ARTrackingState = exports.useARSession = exports.CameraError = exports.Camera = void 0;
+exports.stitchVideo = exports.useFrameProcessorDriver = exports.useFrameProcessor = exports.useKeyframeStream = exports.useIncrementalStitcher = exports.cleanupOldKeyframes = exports.getIncrementalNativeModule = exports.subscribeIncrementalState = exports.incrementalStitcherIsAvailable = exports.IncrementalOutcome = exports.useDeviceOrientation = exports.useVideoCapture = exports.useCapture = exports.ViewportCropOverlay = exports.hybridSettingsToNativeConfig = exports.slitscanSettingsToNativeConfig = exports.panoramaSettingsToNativeConfig = exports.DEFAULT_HYBRID_SETTINGS = exports.DEFAULT_SLITSCAN_SETTINGS = exports.DEFAULT_FLOW_GATE_SETTINGS = exports.DEFAULT_PANORAMA_SETTINGS = exports.PanoramaSettingsModal = exports.PanoramaGuidance = exports.PanoramaBandOverlay = exports.IncrementalPanGuide = exports.CaptureThumbnailStrip = exports.useStitchStatsToast = exports.CaptureStitchStatsToast = exports.CaptureOrientationPill = exports.CaptureKeyframePill = exports.CaptureMemoryPill = exports.CaptureDebugOverlay = exports.CaptureStatusOverlay = exports.CapturePreview = exports.CaptureControlsBar = exports.CaptureHeader = exports.CameraView = exports.ARCameraView = exports.useIMUTranslationGate = exports.ARTrackingState = exports.useARSession = exports.CameraError = exports.Camera = void 0;
 // ─────────────────────────────────────────────────────────────────────
 // Layer 1 — the high-level <Camera> component
 // ─────────────────────────────────────────────────────────────────────
@@ -145,6 +145,16 @@ Object.defineProperty(exports, "useIncrementalStitcher", { enumerable: true, get
 // keyframe, packet detection, server-side analysis, etc.).
 var useKeyframeStream_1 = require("./stitching/useKeyframeStream");
 Object.defineProperty(exports, "useKeyframeStream", { enumerable: true, get: function () { return useKeyframeStream_1.useKeyframeStream; } });
+// 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.
+var useFrameProcessor_1 = require("./stitching/useFrameProcessor");
+Object.defineProperty(exports, "useFrameProcessor", { enumerable: true, get: function () { return useFrameProcessor_1.useFrameProcessor; } });
 // 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).