react-native-image-stitcher 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -200,36 +200,20 @@ export interface CameraProps {
200
200
  * Introduced for F8 (FrameProcessor port) — see
201
201
  * `docs/f8-frame-processor-plan.md`.
202
202
  *
203
- * As of v0.5 (F8.3) this prop is **deprecated for the standard
204
- * non-AR capture flow**: the SDK now installs its own frame
205
- * processor via `useFrameProcessorDriver` that pipes pixel
206
- * buffers into the incremental stitcher with synthesised pose.
207
- * Setting this prop in the default mode will be IGNORED with a
208
- * one-time console.warn — supplying your own worklet would race
209
- * with the SDK's pixel-buffer feed.
203
+ * The SDK installs its own frame processor via
204
+ * `useFrameProcessorDriver`. Setting this prop is ignored with
205
+ * a one-time `console.warn` supplying a host worklet would
206
+ * race with the SDK's pixel-buffer feed. Either remove the prop
207
+ * or fork the SDK if you genuinely need a custom worklet.
210
208
  *
211
- * Three coexistence rules:
212
- * * Default (modern non-AR): SDK owns the worklet, this prop
213
- * is ignored.
214
- * * `legacyDriver={true}`: SDK uses the old `useIncrementalJSDriver`
215
- * (takeSnapshot path). Honoured for diagnostics or as an
216
- * escape hatch.
217
- * * AR mode: vision-camera Camera isn't mounted, this prop is
218
- * irrelevant.
219
- */
220
- frameProcessor?: ReadonlyFrameProcessor | DrawableFrameProcessor;
221
- /**
222
- * Opt back into the legacy `useIncrementalJSDriver` for non-AR
223
- * captures (the v0.4 path: `takeSnapshot` → JPEG → cache file →
224
- * `IncrementalStitcher.processFrameAtPath`).
209
+ * AR mode is irrelevant: vision-camera's Camera isn't mounted.
225
210
  *
226
- * Default `false` (use the new `useFrameProcessorDriver`, which
227
- * runs the gate on the camera producer thread at native frame
228
- * rate via a vision-camera Frame Processor plugin). The legacy
229
- * path will be removed in v0.6 — set this only if you hit a
230
- * specific issue with the new driver and need to ship a fix.
211
+ * (v0.5 had a `legacyDriver` escape hatch that routed back to
212
+ * `useIncrementalJSDriver`. That hook + prop were removed in
213
+ * v0.6 per the deprecation timeline announced in the v0.5.0
214
+ * CHANGELOG.)
231
215
  */
232
- legacyDriver?: boolean;
216
+ frameProcessor?: ReadonlyFrameProcessor | DrawableFrameProcessor;
233
217
  }
234
218
  /**
235
219
  * The public `<Camera>` component.
@@ -97,7 +97,6 @@ const lowMemDevice_1 = require("./lowMemDevice");
97
97
  const useCapture_1 = require("./useCapture");
98
98
  const useDeviceOrientation_1 = require("./useDeviceOrientation");
99
99
  const incremental_1 = require("../stitching/incremental");
100
- const useIncrementalJSDriver_1 = require("../stitching/useIncrementalJSDriver");
101
100
  const useFrameProcessorDriver_1 = require("../stitching/useFrameProcessorDriver");
102
101
  const useIncrementalStitcher_1 = require("../stitching/useIncrementalStitcher");
103
102
  const useIMUTranslationGate_1 = require("../sensors/useIMUTranslationGate");
@@ -271,7 +270,7 @@ function extractPanoramaOverrides(props) {
271
270
  * The public `<Camera>` component.
272
271
  */
273
272
  function Camera(props) {
274
- const { defaultCaptureSource = 'ar', defaultLens = '1x', enablePhotoMode = true, enablePanoramaMode = true, showSettingsButton = false, style, outputDir, onCapture, onCaptureSourceChange, onLensChange, onFramesDropped, onError, frameProcessor: hostFrameProcessor, legacyDriver = false, engine = 'batch-keyframe', } = props;
273
+ const { defaultCaptureSource = 'ar', defaultLens = '1x', enablePhotoMode = true, enablePanoramaMode = true, showSettingsButton = false, style, outputDir, onCapture, onCaptureSourceChange, onLensChange, onFramesDropped, onError, frameProcessor: hostFrameProcessor, engine = 'batch-keyframe', } = props;
275
274
  const insets = (0, react_native_safe_area_context_1.useSafeAreaInsets)();
276
275
  // ── State ───────────────────────────────────────────────────────
277
276
  const [arPreference, setArPreference] = (0, react_1.useState)(defaultCaptureSource === 'ar');
@@ -417,58 +416,44 @@ function Camera(props) {
417
416
  mod?.markNextFrameAsLastKeyframe?.().catch(() => undefined);
418
417
  },
419
418
  });
420
- // JS-driver for non-AR captures (iOS + Android). In AR mode the
421
- // engine consumes frames from the ARSession stream natively, so this
422
- // hook stays idle.
419
+ // Frame Processor driver for non-AR captures (iOS + Android).
420
+ // In AR mode the engine consumes frames from the ARSession stream
421
+ // natively, so this hook stays idle.
423
422
  //
424
423
  // IMPORTANT: start()/stop() are called imperatively from the hold
425
424
  // handlers below — NOT from a useEffect driven by statusPhase. The
426
425
  // hook returns a fresh object identity on every render, and during
427
426
  // a recording the engine emits IncrementalStateUpdate events that
428
- // cause re-renders multiple times per second. An effect with
429
- // `jsDriver` in its deps would teardown + restart the driver on
430
- // every event, resetting the gyro accumulator (yaw/pitch) to zero
431
- // each cycle and nulling the cameraRef during the brief gap. The
432
- // user-visible symptom was "only the first keyframe is accepted,
433
- // every subsequent snapshot sees pose=(0,0) and is rejected as a
434
- // duplicate of the first". Matching AuditCaptureScreen's proven
435
- // imperative pattern (start on hold-start, stop on hold-end) avoids
436
- // the re-render churn entirely.
437
- const jsDriver = (0, useIncrementalJSDriver_1.useIncrementalJSDriver)();
438
- // F8.3 — vision-camera Frame Processor variant. Always
439
- // instantiated so we don't have conditional hook calls; only one
440
- // of the two drivers actually .start()s per capture. Stop() on
441
- // an idle driver is a no-op.
427
+ // cause re-renders multiple times per second. An effect with the
428
+ // driver in its deps would teardown + restart on every event,
429
+ // resetting the gyro accumulator (yaw/pitch) to zero each cycle.
430
+ // User-visible symptom: "only the first keyframe is accepted, every
431
+ // subsequent ingest sees pose=(0,0) and is rejected as a duplicate".
432
+ // The imperative pattern (start on hold-start, stop on hold-end)
433
+ // avoids the re-render churn entirely.
442
434
  const fpDriver = (0, useFrameProcessorDriver_1.useFrameProcessorDriver)();
443
- // Safety: ensure both drivers are stopped if the component unmounts
444
- // mid-recording. Empty deps so this only fires on unmount.
435
+ // Safety: stop the driver if the component unmounts mid-recording.
445
436
  // eslint-disable-next-line react-hooks/exhaustive-deps
446
- (0, react_1.useEffect)(() => () => { jsDriver.stop(); fpDriver.stop(); }, []);
447
- // F8.3 — one-shot deprecation warning when the host supplies their
448
- // own `frameProcessor` while running in the default (Frame
449
- // Processor driver) mode. Two worklets racing on the same
450
- // producer thread would corrupt the engine's workQueue ordering;
451
- // the SDK's own worklet wins and the host's is ignored. Hosts
452
- // that *need* a custom worklet must opt into `legacyDriver={true}`
453
- // (which switches off the SDK's worklet entirely).
437
+ (0, react_1.useEffect)(() => () => { fpDriver.stop(); }, []);
438
+ // One-shot deprecation warning when the host supplies their own
439
+ // `frameProcessor` prop. Two worklets racing on the same
440
+ // producer thread would corrupt the engine's workQueue ordering,
441
+ // so the SDK's own worklet wins and the host's is silently
442
+ // ignored. (v0.5 had a `legacyDriver` opt-out for hosts that
443
+ // wanted to route around the SDK driver; that was removed in
444
+ // v0.6 along with `useIncrementalJSDriver`.)
454
445
  const hostFrameProcessorIgnoredWarnedRef = (0, react_1.useRef)(false);
455
446
  if (hostFrameProcessor != null
456
- && !legacyDriver
457
447
  && !hostFrameProcessorIgnoredWarnedRef.current) {
458
448
  hostFrameProcessorIgnoredWarnedRef.current = true;
459
449
  // eslint-disable-next-line no-console
460
450
  console.warn('[react-native-image-stitcher] The `frameProcessor` prop on '
461
- + '<Camera> is ignored when the default driver is active '
462
- + '(legacyDriver=false). Either remove the prop or set '
463
- + 'legacyDriver={true} to opt into the legacy path.');
451
+ + '<Camera> is ignored the SDK installs its own worklet '
452
+ + 'via useFrameProcessorDriver. Remove the prop, or fork '
453
+ + 'the SDK if you genuinely need a custom worklet.');
464
454
  }
465
- // The Frame Processor worklet actually bound to vision-camera's
466
- // Camera. Resolution order:
467
- // 1. Legacy mode: honor the host's prop (or null).
468
- // 2. Modern mode: SDK driver's worklet, regardless of host's prop.
469
- const effectiveFrameProcessor = legacyDriver
470
- ? (hostFrameProcessor ?? null)
471
- : fpDriver.frameProcessor;
455
+ // The Frame Processor worklet bound to vision-camera's Camera.
456
+ const effectiveFrameProcessor = fpDriver.frameProcessor;
472
457
  // ── Subscribe to engine state for live keyframe thumbs ──────────
473
458
  (0, react_1.useEffect)(() => {
474
459
  const sub = (0, incremental_1.subscribeIncrementalState)((state) => {
@@ -524,17 +509,17 @@ function Camera(props) {
524
509
  const accepted = incrementalState?.acceptedCount ?? 0;
525
510
  if (accepted > lastAcceptedCountRef.current) {
526
511
  lastAcceptedCountRef.current = accepted;
527
- // F8.3 review-of-review (M3 revert): originally gated this to
528
- // `legacyDriver` because the Frame Processor driver doesn't
529
- // consult `imuGate` for its own pose synthesis. That ignored a
530
- // load-bearing side effect: `imuGate.resetAnchor()` bounds the
531
- // IIR-integrator drift window per-accept, and
532
- // `imuGate.getTotalAbsMetres()` is read at finalize time
533
- // (Camera.tsx:1097) as `imuTranslationMetres` into the native
512
+ // F8.3 review-of-review (M3 revert): an earlier draft gated
513
+ // this on the pre-v0.6 `legacyDriver` prop because the Frame
514
+ // Processor driver doesn't consult `imuGate` for its own pose
515
+ // synthesis. That ignored a load-bearing side effect:
516
+ // `imuGate.resetAnchor()` bounds the IIR-integrator drift
517
+ // window per-accept, and `imuGate.getTotalAbsMetres()` is read
518
+ // at finalize time as `imuTranslationMetres` into the native
534
519
  // stitchMode auto-resolver (PANORAMA vs SCANS). Without the
535
520
  // per-accept reset, long FP-driver captures let IIR drift
536
- // compound → inflated metres → biased toward SCANS. Keep the
537
- // reset firing for ALL non-AR modes.
521
+ // compound → inflated metres → biased toward SCANS. Now fires
522
+ // for ALL non-AR captures (the only non-AR driver post-v0.6).
538
523
  if (isNonAR) {
539
524
  imuGate.resetAnchor();
540
525
  }
@@ -651,13 +636,11 @@ function Camera(props) {
651
636
  snapshotEveryNAccepts: 1,
652
637
  frameRotationDegrees: orientationRotation,
653
638
  captureOrientation: deviceOrientation,
654
- // F8.3 — non-AR captures pick between the new Frame Processor
655
- // driver (default) and the legacy JS-snapshot driver (opt-in
656
- // via `legacyDriver={true}`). AR captures always use the
657
- // ARSession-driven path.
658
- frameSourceMode: isNonAR
659
- ? (legacyDriver ? 'jsDriver' : 'frameProcessor')
660
- : 'arSession',
639
+ // Non-AR captures use the Frame Processor driver
640
+ // (vision-camera producer-thread worklet cv_flow_gate
641
+ // plugin → IncrementalStitcher.consumeFrame). AR captures
642
+ // use the ARSession-driven path.
643
+ frameSourceMode: isNonAR ? 'frameProcessor' : 'arSession',
661
644
  composeWidth: 1920,
662
645
  composeHeight: 1080,
663
646
  canvasWidth: 5000,
@@ -673,22 +656,13 @@ function Camera(props) {
673
656
  // matching comment on the per-accept reset useEffect above).
674
657
  // Keep firing it on every capture start, not just legacy mode.
675
658
  imuGate.resetAnchor();
676
- // Start the non-AR frame source. AR mode feeds natively from
677
- // ARSession so both drivers stay idle in that path.
678
- // * Default: Frame Processor driver worklet runs on the
679
- // producer thread, plugin calls `consumeFrameFromPlugin`
680
- // directly. No camera ref needed (vision-camera owns it).
681
- // * Legacy: JS driver — `takeSnapshot` + `processFrameAtPath`
682
- // via the cameraRef.
683
- // Imperative-pattern rationale: see the useIncrementalJSDriver
684
- // comment above re. why this isn't a useEffect.
659
+ // Start the Frame Processor driver for non-AR captures. AR
660
+ // mode feeds natively from ARSession so the driver stays idle.
661
+ // Imperative pattern (vs useEffect) because the driver's start
662
+ // resets pose accumulators that should only fire at the
663
+ // hold-start moment, not on every re-render.
685
664
  if (isNonAR) {
686
- if (legacyDriver) {
687
- jsDriver.start(visionCameraRef);
688
- }
689
- else {
690
- fpDriver.start();
691
- }
665
+ fpDriver.start();
692
666
  }
693
667
  }
694
668
  catch (err) {
@@ -703,9 +677,7 @@ function Camera(props) {
703
677
  settings,
704
678
  effectiveCaptureSource,
705
679
  imuGate,
706
- jsDriver,
707
680
  fpDriver,
708
- legacyDriver,
709
681
  engine,
710
682
  onError,
711
683
  ]);
@@ -715,10 +687,7 @@ function Camera(props) {
715
687
  setStatusPhase('stitching');
716
688
  // Stop pumping new frames before finalizing so the engine isn't
717
689
  // racing the final cv::Stitcher pass against late-arriving
718
- // keyframes. Both stop() calls are no-ops when the
719
- // corresponding driver wasn't started (AR mode, or the inactive
720
- // driver in non-AR mode).
721
- jsDriver.stop();
690
+ // keyframes. No-op in AR mode (the driver was never started).
722
691
  fpDriver.stop();
723
692
  try {
724
693
  // Compose the panorama output path: host-controlled if
@@ -788,7 +757,6 @@ function Camera(props) {
788
757
  onFramesDropped,
789
758
  onError,
790
759
  recordingStartedAt,
791
- jsDriver,
792
760
  fpDriver,
793
761
  // F10 Phase 2 review N1 — these four were missing pre-fix. The
794
762
  // callback reads `settings.debug` (to gate the stitchToast),
package/dist/index.d.ts CHANGED
@@ -64,8 +64,6 @@ export { useDeviceOrientation } from './camera/useDeviceOrientation';
64
64
  export { IncrementalOutcome, incrementalStitcherIsAvailable, subscribeIncrementalState, getIncrementalNativeModule, cleanupOldKeyframes, } from './stitching/incremental';
65
65
  export type { IncrementalState } from './stitching/incremental';
66
66
  export { useIncrementalStitcher } from './stitching/useIncrementalStitcher';
67
- export { useIncrementalJSDriver } from './stitching/useIncrementalJSDriver';
68
- export type { UseIncrementalJSDriverOptions, IncrementalJSDriverHandle, } from './stitching/useIncrementalJSDriver';
69
67
  export { useFrameProcessorDriver } from './stitching/useFrameProcessorDriver';
70
68
  export type { UseFrameProcessorDriverOptions, FrameProcessorDriverHandle, } from './stitching/useFrameProcessorDriver';
71
69
  export { stitchVideo } from './stitching/stitchVideo';
package/dist/index.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * adds RetaiLens-specific features on top.
23
23
  */
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.stitchVideo = exports.useFrameProcessorDriver = exports.useIncrementalJSDriver = 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;
25
+ exports.stitchVideo = exports.useFrameProcessorDriver = 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;
26
26
  // ─────────────────────────────────────────────────────────────────────
27
27
  // Layer 1 — the high-level <Camera> component
28
28
  // ─────────────────────────────────────────────────────────────────────
@@ -139,11 +139,9 @@ Object.defineProperty(exports, "getIncrementalNativeModule", { enumerable: true,
139
139
  Object.defineProperty(exports, "cleanupOldKeyframes", { enumerable: true, get: function () { return incremental_1.cleanupOldKeyframes; } });
140
140
  var useIncrementalStitcher_1 = require("./stitching/useIncrementalStitcher");
141
141
  Object.defineProperty(exports, "useIncrementalStitcher", { enumerable: true, get: function () { return useIncrementalStitcher_1.useIncrementalStitcher; } });
142
- var useIncrementalJSDriver_1 = require("./stitching/useIncrementalJSDriver");
143
- Object.defineProperty(exports, "useIncrementalJSDriver", { enumerable: true, get: function () { return useIncrementalJSDriver_1.useIncrementalJSDriver; } });
144
- // F8.3 vision-camera Frame Processor variant of the non-AR
145
- // driver. Preferred over `useIncrementalJSDriver` in v0.5+; the
146
- // JS driver stays exported as a deprecated fallback until v0.6.
142
+ // vision-camera Frame Processor driver for non-AR captures. As
143
+ // of v0.6 the only non-AR driver exported (the legacy
144
+ // `useIncrementalJSDriver` was removed; was deprecated in v0.5).
147
145
  var useFrameProcessorDriver_1 = require("./stitching/useFrameProcessorDriver");
148
146
  Object.defineProperty(exports, "useFrameProcessorDriver", { enumerable: true, get: function () { return useFrameProcessorDriver_1.useFrameProcessorDriver; } });
149
147
  // ── Batch stitching ───────────────────────────────────────────────────
@@ -191,23 +191,22 @@ export interface IncrementalStartOptions {
191
191
  * bridge.start() requires `RNSARSession.start()` to
192
192
  * have already been called.
193
193
  *
194
- * - 'jsDriver' — engine skips AR-session registration; JS
195
- * feeds frames via `processFrameAtPath`. Use in iOS non-AR
196
- * captures (vision-camera + gyro). No AR session required.
197
- * LEGACY; deprecated in v0.5, removed in v0.6.
198
- *
199
194
  * - 'frameProcessor' (F8.3 iOS / F8.4 Android, v0.5+) — engine
200
195
  * flips on `frameProcessorIngestEnabled` so the vision-camera
201
196
  * Frame Processor plugin (`cv_flow_gate_process_frame`) can
202
197
  * feed pixel data directly into the engine's gate path. iOS
203
198
  * passes the `CVPixelBuffer` straight to `consumeFrame`;
204
- * Android extracts the Y plane to a ByteArray and encodes
205
- * accepted frames to JPEG inline (the platform-specific
206
- * engine-input divergence is tracked as F8.6). Use in non-AR
207
- * captures driven by `useFrameProcessorDriver`. Pairs with
208
- * `Camera`'s default driver mode.
199
+ * Android extracts the Y plane to a ByteArray and (since
200
+ * F8.6, v0.5.1) routes live-engine ingest through
201
+ * `addFramePixelData` without a JPEG round-trip. Use in
202
+ * non-AR captures driven by `useFrameProcessorDriver`. Pairs
203
+ * with `Camera`'s default driver mode.
204
+ *
205
+ * `'jsDriver'` was removed in v0.6 (deprecated in v0.5). Hosts
206
+ * that used it should switch to `useFrameProcessorDriver` (or
207
+ * just let `<Camera>` use its default).
209
208
  */
210
- frameSourceMode?: 'arSession' | 'jsDriver' | 'frameProcessor';
209
+ frameSourceMode?: 'arSession' | 'frameProcessor';
211
210
  /** Compose-resolution width in pixels (default 720 for portrait, 960 for landscape). */
212
211
  composeWidth?: number;
213
212
  /** Compose-resolution height in pixels (default 960 for portrait, 720 for landscape). */
@@ -1,13 +1,14 @@
1
1
  /**
2
2
  * useFrameProcessorDriver — vision-camera Frame Processor + gyro
3
- * driver for the incremental panorama engine. Replaces
4
- * `useIncrementalJSDriver` in non-AR captures.
3
+ * driver for the incremental panorama engine. Sole non-AR driver
4
+ * from v0.6 onward (replaced the deprecated `useIncrementalJSDriver`
5
+ * hook, which was removed in v0.6).
5
6
  *
6
- * Why this exists (vs the JS-driver predecessor)
7
+ * Why this exists (vs the pre-v0.6 JS-driver predecessor)
7
8
  *
8
- * The JS driver takes a JPEG snapshot every ~250 ms and feeds the
9
- * path to `IncrementalStitcher.processFrameAtPath`. That path
10
- * has three costs:
9
+ * The old JS driver took a JPEG snapshot every ~250 ms and fed the
10
+ * path to `IncrementalStitcher.processFrameAtPath` (both removed in
11
+ * v0.6). That path had three costs:
11
12
  *
12
13
  * 1. JPEG encode (`takeSnapshot` ≈ 30–80 ms on iPhone 16 Pro)
13
14
  * 2. Disk write of the JPEG
@@ -2,14 +2,15 @@
2
2
  // SPDX-License-Identifier: Apache-2.0
3
3
  /**
4
4
  * useFrameProcessorDriver — vision-camera Frame Processor + gyro
5
- * driver for the incremental panorama engine. Replaces
6
- * `useIncrementalJSDriver` in non-AR captures.
5
+ * driver for the incremental panorama engine. Sole non-AR driver
6
+ * from v0.6 onward (replaced the deprecated `useIncrementalJSDriver`
7
+ * hook, which was removed in v0.6).
7
8
  *
8
- * Why this exists (vs the JS-driver predecessor)
9
+ * Why this exists (vs the pre-v0.6 JS-driver predecessor)
9
10
  *
10
- * The JS driver takes a JPEG snapshot every ~250 ms and feeds the
11
- * path to `IncrementalStitcher.processFrameAtPath`. That path
12
- * has three costs:
11
+ * The old JS driver took a JPEG snapshot every ~250 ms and fed the
12
+ * path to `IncrementalStitcher.processFrameAtPath` (both removed in
13
+ * v0.6). That path had three costs:
13
14
  *
14
15
  * 1. JPEG encode (`takeSnapshot` ≈ 30–80 ms on iPhone 16 Pro)
15
16
  * 2. Disk write of the JPEG
@@ -220,9 +221,9 @@ function useFrameProcessorDriver(options = {}) {
220
221
  // y = horizontal pan (yaw, about world-Y)
221
222
  // x = vertical tilt (pitch, about world-X)
222
223
  // z = wrist-twist roll (about world-Z, normal to the screen)
223
- // Signs match the legacy `useIncrementalJSDriver` for x/y; z
224
- // follows the same right-hand-rule convention. If field
225
- // captures show inverted roll, flip the sign on `z * dt` below.
224
+ // Right-hand-rule convention throughout same signs the pre-v0.6
225
+ // `useIncrementalJSDriver` produced. If field captures show
226
+ // inverted roll, flip the sign on `z * dt` below.
226
227
  (0, react_native_sensors_1.setUpdateIntervalForType)(react_native_sensors_1.SensorTypes.gyroscope, gyroIntervalMs);
227
228
  gyroSubRef.current = react_native_sensors_1.gyroscope.subscribe({
228
229
  next: ({ x, y, z }) => {
@@ -296,8 +297,8 @@ function useFrameProcessorDriver(options = {}) {
296
297
  imageWidth: w, imageHeight: h,
297
298
  timestampMs: 0,
298
299
  // 2 == RNSARTrackingState.tracking — we always claim "good
299
- // tracking" because there's no ARKit signal to differentiate
300
- // (matches legacy useIncrementalJSDriver semantics).
300
+ // tracking" because there's no ARKit signal to differentiate.
301
+ // (Same contract as the pre-v0.6 useIncrementalJSDriver.)
301
302
  trackingStateRaw: 2,
302
303
  });
303
304
  // Deps array intentionally minimal: only `plugin` actually