react-native-image-stitcher 0.3.0 → 0.4.1

package/src/camera/lowMemDevice.ts

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * lowMemDevice — shared helpers around the iOS BatchStitcher
+ * `physicalMemoryBytes` constant.
+ *
+ * Two consumers (Camera.tsx's `useState` initialiser + the modal's
+ * device-mem debug line) had near-identical implementations of the
+ * same "read physical memory from NativeModules, classify as
+ * low-mem" logic.  The F10 Phase 2 review (N2) flagged this as a
+ * drift hazard — exactly the kind of subtle duplication that audit
+ * fix F1 chased on the native side.
+ *
+ * Layered for testability:
+ *
+ *   - `isBelowMemThreshold(bytes)` is pure (in: number, out:
+ *     boolean) — unit-testable.
+ *   - `getPhysicalMemoryBytes()` reads the RN bridge module — must
+ *     run on a real device.
+ *   - `isLowMemDevice()` composes the two for the common case.
+ *
+ * The 2 GB threshold corresponds to iPhone X / 8 Plus / iPhone 6s
+ * era devices; below that, multiband blend + graphcut seam-finder
+ * peak memory risks the jetsam threshold mid-stitch.  Static value
+ * (no runtime config); revisit if the SDK ever targets a wider
+ * device range.
+ */
+import { NativeModules } from 'react-native';
+
+
+/** 2 GB in bytes — the cutoff below which `<Camera>` falls back
+ *  to the feather+skip blender/seam combo for safer peak memory. */
+export const LOW_MEM_THRESHOLD_BYTES = 2 * 1024 * 1024 * 1024;
+
+
+/**
+ * Pure classifier.  Returns `true` when `bytes` is a positive
+ * number strictly below the threshold.  Zero / NaN / undefined-shaped
+ * inputs return `false` — the safe choice when the native bridge
+ * hasn't surfaced the value (assume the device has enough memory
+ * for the higher-quality combo; the operator can still flip
+ * blender / seamFinder in the modal).
+ */
+export function isBelowMemThreshold(bytes: number): boolean {
+  return Number.isFinite(bytes)
+    && bytes > 0
+    && bytes < LOW_MEM_THRESHOLD_BYTES;
+}
+
+
+/**
+ * Read the device's physical memory from the native bridge.
+ * Returns 0 when the bridge isn't loaded or the constant is missing
+ * — caller should treat 0 as "unknown".
+ */
+export function getPhysicalMemoryBytes(): number {
+  const m = (NativeModules as Record<string, unknown>).BatchStitcher;
+  const bytes =
+    m && typeof m === 'object'
+      ? (m as { physicalMemoryBytes?: number }).physicalMemoryBytes
+      : undefined;
+  return typeof bytes === 'number' ? bytes : 0;
+}
+
+
+/**
+ * Composed `getPhysicalMemoryBytes()` + `isBelowMemThreshold()`.
+ * Convenience for the common consumer pattern.
+ */
+export function isLowMemDevice(): boolean {
+  return isBelowMemThreshold(getPhysicalMemoryBytes());
+}

package/src/index.ts

@@ -109,11 +109,50 @@ export type { CaptureThumbnailItem } from './camera/CaptureThumbnailStrip';
 export { IncrementalPanGuide } from './camera/IncrementalPanGuide';
 export { PanoramaBandOverlay } from './camera/PanoramaBandOverlay';
 export { PanoramaGuidance } from './camera/PanoramaGuidance';
+// Settings modal — the modal is in `PanoramaSettingsModal.tsx`, but
+// the type tree + defaults + JS↔native bridge live in dedicated
+// files since v0.4 (F10).  The modal is now a thin presentational
+// component over the typed structure.
+export { PanoramaSettingsModal } from './camera/PanoramaSettingsModal';
+export type { PanoramaSettingsModalProps } from './camera/PanoramaSettingsModal';
+
+// Settings types — the v0.4 engine-discriminated structures.  Three
+// disjoint top-level types (one per stitching engine), each composed
+// of named sub-trees the corresponding native engine actually reads.
+// See `./camera/PanoramaSettings.ts` for the rationale and the
+// field-by-field native-consumer references.
 export {
-  PanoramaSettingsModal,
   DEFAULT_PANORAMA_SETTINGS,
-} from './camera/PanoramaSettingsModal';
-export type { PanoramaSettings } from './camera/PanoramaSettingsModal';
+  DEFAULT_FLOW_GATE_SETTINGS,
+  DEFAULT_SLITSCAN_SETTINGS,
+  DEFAULT_HYBRID_SETTINGS,
+} from './camera/PanoramaSettings';
+export type {
+  CaptureBaseSettings,
+  PanoramaSettings,
+  BatchStitcherSettings,
+  FrameSelectionSettings,
+  FlowGateSettings,
+  SlitscanSettings,
+  SlitscanPaintingSettings,
+  SlitscanRegistrationSettings,
+  SlitscanAdvancedSettings,
+  Ncc1dSettings,
+  Ncc2dSettings,
+  PlaneProjectionSettings,
+  HybridSettings,
+} from './camera/PanoramaSettings';
+
+// Settings → native config adapters.  Layer 2 hosts building their
+// own capture flow on top of `incremental.start()` should always
+// pass the result of the matching adapter as `config`; the bridge is
+// the single source of truth for the JS↔native wire format.
+export {
+  panoramaSettingsToNativeConfig,
+  slitscanSettingsToNativeConfig,
+  hybridSettingsToNativeConfig,
+} from './camera/PanoramaSettingsBridge';
+export type { NativeConfigDict } from './camera/PanoramaSettingsBridge';
 export { ViewportCropOverlay } from './camera/ViewportCropOverlay';
 
 // ── Capture hooks ─────────────────────────────────────────────────────