@gueshbzh-perso/scanner 0.5.1 → 0.7.0

package/dist/wasm/scanner_wasm.d.ts

@@ -23,6 +23,18 @@ export type BarcodeFormat =
 export type PixelFormat = "rgba" | "rgb" | "luma";
 
 
+export interface FramePlan {
+    fallback?: number;
+}
+
+export interface FrameReport {
+    plan: FramePlan;
+    results: ScanResult[];
+    fallbackRan: boolean;
+    fallbackRead: boolean;
+    elapsedMs: number;
+}
+
 export interface Point {
     x: number;
     y: number;
@@ -66,6 +78,29 @@ export interface WasmScanConfig {
 }
 
 
+/**
+ * Stateless frame decoder for parallel decoding: one per Web Worker, all
+ * serving a single `WasmScanSession` (created with the same configuration)
+ * that plans the frames and commits the reports.
+ */
+export class WasmFrameDecoder {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Decode the frame previously written into `frameBuffer`, following `plan`.
+     */
+    decodeFrameBuffer(width: number, height: number, format: PixelFormat, plan: FramePlan): FrameReport;
+    /**
+     * Get a view of the internal frame buffer resized to `len` bytes, then
+     * call `decodeFrameBuffer`. **Do not keep the view** across calls.
+     */
+    frameBuffer(len: number): Uint8Array;
+    /**
+     * Create a decoder. Use the configuration of the session it serves.
+     */
+    constructor(config?: WasmScanConfig | null);
+}
+
 /**
  * Stateful session for camera streams: strategy rotation across frames,
  * deduplication, multi-frame confirmation and optional throttling.
@@ -77,6 +112,11 @@ export class WasmScanSession {
      * Allow `text` to be reported again immediately.
      */
     clearCooldown(text: string): void;
+    /**
+     * Record a frame decoded by a `WasmFrameDecoder`. Returns the **new**
+     * codes, or `null`, like `processFrameBuffer`.
+     */
+    commit(report: FrameReport): ScanResult[] | null;
     /**
      * Get a view of the internal frame buffer resized to `len` bytes.
      *
@@ -89,6 +129,12 @@ export class WasmScanSession {
      * Create a session for a camera stream.
      */
     constructor(config?: WasmScanConfig | null);
+    /**
+     * Decide what the next frame runs, when frames are decoded elsewhere
+     * (`WasmFrameDecoder` in Web Workers). Every plan must come back to
+     * `commit`, in any order. The adaptive throttle does not apply.
+     */
+    plan(): FramePlan;
     /**
      * Process the frame previously written into `frameBuffer`.
      */
@@ -165,9 +211,13 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
+    readonly __wbg_wasmframedecoder_free: (a: number, b: number) => void;
     readonly __wbg_wasmscanner_free: (a: number, b: number) => void;
     readonly __wbg_wasmscansession_free: (a: number, b: number) => void;
     readonly version: (a: number) => void;
+    readonly wasmframedecoder_decodeFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly wasmframedecoder_frameBuffer: (a: number, b: number) => number;
+    readonly wasmframedecoder_new: (a: number) => number;
     readonly wasmscanner_frameBuffer: (a: number, b: number) => number;
     readonly wasmscanner_new: (a: number) => number;
     readonly wasmscanner_scanFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
@@ -175,9 +225,11 @@ export interface InitOutput {
     readonly wasmscanner_scanRgb: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
     readonly wasmscanner_scanRgba: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
     readonly wasmscansession_clearCooldown: (a: number, b: number, c: number) => void;
+    readonly wasmscansession_commit: (a: number, b: number) => number;
     readonly wasmscansession_frameBuffer: (a: number, b: number) => number;
     readonly wasmscansession_lastDetections: (a: number) => number;
     readonly wasmscansession_new: (a: number) => number;
+    readonly wasmscansession_plan: (a: number) => number;
     readonly wasmscansession_processFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
     readonly wasmscansession_processFrameLuma: (a: number, b: number, c: number, d: number, e: number) => number;
     readonly wasmscansession_processFrameRgba: (a: number, b: number, c: number, d: number, e: number) => number;

package/dist/wasm/scanner_wasm.js

@@ -1,5 +1,69 @@
 /* @ts-self-types="./scanner_wasm.d.ts" */
 
+/**
+ * Stateless frame decoder for parallel decoding: one per Web Worker, all
+ * serving a single `WasmScanSession` (created with the same configuration)
+ * that plans the frames and commits the reports.
+ */
+export class WasmFrameDecoder {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        WasmFrameDecoderFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_wasmframedecoder_free(ptr, 0);
+    }
+    /**
+     * Decode the frame previously written into `frameBuffer`, following `plan`.
+     * @param {number} width
+     * @param {number} height
+     * @param {PixelFormat} format
+     * @param {FramePlan} plan
+     * @returns {FrameReport}
+     */
+    decodeFrameBuffer(width, height, format, plan) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(format, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.wasmframedecoder_decodeFrameBuffer(retptr, this.__wbg_ptr, width, height, ptr0, len0, addHeapObject(plan));
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+     * Get a view of the internal frame buffer resized to `len` bytes, then
+     * call `decodeFrameBuffer`. **Do not keep the view** across calls.
+     * @param {number} len
+     * @returns {Uint8Array}
+     */
+    frameBuffer(len) {
+        const ret = wasm.wasmframedecoder_frameBuffer(this.__wbg_ptr, len);
+        return takeObject(ret);
+    }
+    /**
+     * Create a decoder. Use the configuration of the session it serves.
+     * @param {WasmScanConfig | null} [config]
+     */
+    constructor(config) {
+        const ret = wasm.wasmframedecoder_new(isLikeNone(config) ? 0 : addHeapObject(config));
+        this.__wbg_ptr = ret;
+        WasmFrameDecoderFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+if (Symbol.dispose) WasmFrameDecoder.prototype[Symbol.dispose] = WasmFrameDecoder.prototype.free;
+
 /**
  * Stateful session for camera streams: strategy rotation across frames,
  * deduplication, multi-frame confirmation and optional throttling.
@@ -24,6 +88,16 @@ export class WasmScanSession {
         const len0 = WASM_VECTOR_LEN;
         wasm.wasmscansession_clearCooldown(this.__wbg_ptr, ptr0, len0);
     }
+    /**
+     * Record a frame decoded by a `WasmFrameDecoder`. Returns the **new**
+     * codes, or `null`, like `processFrameBuffer`.
+     * @param {FrameReport} report
+     * @returns {ScanResult[] | null}
+     */
+    commit(report) {
+        const ret = wasm.wasmscansession_commit(this.__wbg_ptr, addHeapObject(report));
+        return takeObject(ret);
+    }
     /**
      * Get a view of the internal frame buffer resized to `len` bytes.
      *
@@ -56,6 +130,16 @@ export class WasmScanSession {
         WasmScanSessionFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
+    /**
+     * Decide what the next frame runs, when frames are decoded elsewhere
+     * (`WasmFrameDecoder` in Web Workers). Every plan must come back to
+     * `commit`, in any order. The adaptive throttle does not apply.
+     * @returns {FramePlan}
+     */
+    plan() {
+        const ret = wasm.wasmscansession_plan(this.__wbg_ptr);
+        return takeObject(ret);
+    }
     /**
      * Process the frame previously written into `frameBuffer`.
      * @param {number} width
@@ -548,6 +632,9 @@ function __wbg_get_imports() {
     };
 }
 
+const WasmFrameDecoderFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_wasmframedecoder_free(ptr, 1));
 const WasmScanSessionFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_wasmscansession_free(ptr, 1));

package/dist/wasm/scanner_wasm_bg.wasm.d.ts

@@ -1,9 +1,13 @@
 /* tslint:disable */
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
+export const __wbg_wasmframedecoder_free: (a: number, b: number) => void;
 export const __wbg_wasmscanner_free: (a: number, b: number) => void;
 export const __wbg_wasmscansession_free: (a: number, b: number) => void;
 export const version: (a: number) => void;
+export const wasmframedecoder_decodeFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const wasmframedecoder_frameBuffer: (a: number, b: number) => number;
+export const wasmframedecoder_new: (a: number) => number;
 export const wasmscanner_frameBuffer: (a: number, b: number) => number;
 export const wasmscanner_new: (a: number) => number;
 export const wasmscanner_scanFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
@@ -11,9 +15,11 @@ export const wasmscanner_scanLuma: (a: number, b: number, c: number, d: number,
 export const wasmscanner_scanRgb: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const wasmscanner_scanRgba: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const wasmscansession_clearCooldown: (a: number, b: number, c: number) => void;
+export const wasmscansession_commit: (a: number, b: number) => number;
 export const wasmscansession_frameBuffer: (a: number, b: number) => number;
 export const wasmscansession_lastDetections: (a: number) => number;
 export const wasmscansession_new: (a: number) => number;
+export const wasmscansession_plan: (a: number) => number;
 export const wasmscansession_processFrameBuffer: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const wasmscansession_processFrameLuma: (a: number, b: number, c: number, d: number, e: number) => number;
 export const wasmscansession_processFrameRgba: (a: number, b: number, c: number, d: number, e: number) => number;

package/dist/worker.js

@@ -1,5 +1,7 @@
-// Web Worker entry point: decodes frames off the main thread.
-import { EngineCore } from './core.js';
+// Web Worker entry point: decodes frames off the main thread. Stateless: the
+// scan session (scheduling, confirmations, de-duplication) lives on the main
+// thread, so any number of these workers can serve one camera stream.
+import { DecoderCore, loadWasm } from './core.js';
 const scope = self;
 let core = null;
 function engine() {
@@ -12,33 +14,29 @@ scope.onmessage = async (ev) => {
     const buffer = 'buffer' in msg ? msg.buffer : undefined;
     try {
         switch (msg.type) {
-            case 'init':
-                core = await EngineCore.create(msg.wasmUrl);
-                scope.postMessage({ id: msg.id, ok: true, version: core.version });
+            case 'init': {
+                const version = await loadWasm(msg.module);
+                core = new DecoderCore();
+                scope.postMessage({ id: msg.id, ok: true, version });
                 break;
+            }
             case 'configure':
                 engine().configure(msg.options);
                 scope.postMessage({ id: msg.id, ok: true });
                 break;
-            case 'frame': {
-                const out = engine().process(new Uint8Array(msg.buffer), msg.width, msg.height, msg.format);
+            case 'decode': {
+                const pixels = new Uint8Array(msg.buffer);
+                const report = engine().decode(pixels, msg.width, msg.height, msg.format, msg.plan);
                 // Hand the pixel buffer back so the main thread can reuse it.
-                scope.postMessage({ id: msg.id, ok: true, ...out, buffer: msg.buffer }, [msg.buffer]);
+                scope.postMessage({ id: msg.id, ok: true, report, buffer: msg.buffer }, [msg.buffer]);
                 break;
             }
             case 'scan': {
-                const results = engine().scan(new Uint8Array(msg.buffer), msg.width, msg.height, msg.format, msg.options);
+                const pixels = new Uint8Array(msg.buffer);
+                const results = engine().scan(pixels, msg.width, msg.height, msg.format, msg.options);
                 scope.postMessage({ id: msg.id, ok: true, results, buffer: msg.buffer }, [msg.buffer]);
                 break;
             }
-            case 'reset':
-                engine().reset();
-                scope.postMessage({ id: msg.id, ok: true });
-                break;
-            case 'clearCooldown':
-                engine().clearCooldown(msg.text);
-                scope.postMessage({ id: msg.id, ok: true });
-                break;
         }
     }
     catch (err) {

package/dist/worker.js.map

@@ -1 +1 @@
-{"version":3,"file":"worker.js","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAQvC,MAAM,KAAK,GAAG,IAA8B,CAAC;AAC7C,IAAI,IAAI,GAAsB,IAAI,CAAC;AAEnC,SAAS,MAAM;IACb,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,CAAC,SAAS,GAAG,KAAK,EAAE,EAAE,EAAE,EAAE;IAC7B,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;IACpB,MAAM,MAAM,GAAG,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACxD,IAAI,CAAC;QACH,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,MAAM;gBACT,IAAI,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC5C,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBACnE,MAAM;YACR,KAAK,WAAW;gBACd,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAChC,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC5F,8DAA8D;gBAC9D,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtF,MAAM;YACR,CAAC;YACD,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,CAC3B,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAC1B,GAAG,CAAC,KAAK,EACT,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,OAAO,CACZ,CAAC;gBACF,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvF,MAAM;YACR,CAAC;YACD,KAAK,OAAO;gBACV,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;gBACjB,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,eAAe;gBAClB,MAAM,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACjC,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,MAAM;QACV,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/D,2EAA2E;QAC3E,uDAAuD;QACvD,MAAM,KAAK,GAAG,GAAG,YAAY,WAAW,CAAC,YAAY,CAAC;QACtD,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,IAAI,KAAK;YAAE,IAAI,GAAG,IAAI,CAAC;IACzB,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,6EAA6E;AAC7E,sEAAsE;AACtE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAQlD,MAAM,KAAK,GAAG,IAA8B,CAAC;AAC7C,IAAI,IAAI,GAAuB,IAAI,CAAC;AAEpC,SAAS,MAAM;IACb,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,CAAC,SAAS,GAAG,KAAK,EAAE,EAAE,EAAE,EAAE;IAC7B,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;IACpB,MAAM,MAAM,GAAG,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACxD,IAAI,CAAC;QACH,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC3C,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;gBACzB,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBACrD,MAAM;YACR,CAAC;YACD,KAAK,WAAW;gBACd,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAChC,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACpF,8DAA8D;gBAC9D,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtF,MAAM;YACR,CAAC;YACD,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;gBACtF,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvF,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/D,2EAA2E;QAC3E,uDAAuD;QACvD,MAAM,KAAK,GAAG,GAAG,YAAY,WAAW,CAAC,YAAY,CAAC;QACtD,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,IAAI,KAAK;YAAE,IAAI,GAAG,IAAI,CAAC;IACzB,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@gueshbzh-perso/scanner",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "Fast QR code & barcode scanning for the web: camera, WebGL frame pipeline, Web Worker and Rust/WebAssembly decoder.",
   "type": "module",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/romainrodrigues/scanner"
+    "url": "https://github.com/RomainRodrigues/scanner"
   },
   "keywords": [
     "barcode",
@@ -33,6 +33,8 @@
   },
   "files": [
     "dist",
+    "src",
+    "!src/wasm",
     "README.md"
   ],
   "sideEffects": false,
@@ -42,7 +44,8 @@
     "build": "npm run build:wasm && npm run build:ts",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test:e2e": "node scripts/e2e.mjs",
-    "serve": "node scripts/serve.mjs"
+    "serve": "node scripts/serve.mjs",
+    "test": "node --test test/unit/*.test.mjs"
   },
   "devDependencies": {
     "binaryen": "^132.0.0",

package/src/camera.ts

@@ -0,0 +1,107 @@
+// Camera access helpers (getUserMedia, device listing, torch, zoom, focus).
+import type { CameraOptions, CameraResolution } from './types.js';
+
+const RESOLUTIONS: Record<CameraResolution, [number, number]> = {
+  sd: [640, 480],
+  hd: [1280, 720],
+  fhd: [1920, 1080],
+};
+
+// Namespaced: the host page shares localStorage with the SDK.
+const STORAGE_KEY = '@gueshbzh-perso/scanner:cameraId';
+/** Key used up to 0.6: still read, so the remembered camera survives the upgrade. */
+const LEGACY_STORAGE_KEY = 'scanner.cameraId';
+
+export function rememberedCamera(): string | undefined {
+  try {
+    return localStorage.getItem(STORAGE_KEY) ?? localStorage.getItem(LEGACY_STORAGE_KEY) ?? undefined;
+  } catch {
+    return undefined;
+  }
+}
+
+export function rememberCamera(id: string | undefined): void {
+  try {
+    if (id) localStorage.setItem(STORAGE_KEY, id);
+  } catch {
+    /* storage unavailable: ignore */
+  }
+}
+
+export async function openCamera(options: CameraOptions = {}): Promise<MediaStream> {
+  if (!navigator.mediaDevices?.getUserMedia) {
+    throw new Error('Camera access is not available (a secure https:// context is required)');
+  }
+  const [width, height] = RESOLUTIONS[options.resolution ?? 'hd'];
+  const deviceId = options.deviceId ?? (options.rememberDevice !== false ? rememberedCamera() : undefined);
+
+  const video: MediaTrackConstraints = {
+    width: { ideal: width },
+    height: { ideal: height },
+    frameRate: { ideal: 30 },
+  };
+  if (deviceId) video.deviceId = { exact: deviceId };
+  else video.facingMode = { ideal: options.facingMode ?? 'environment' };
+
+  let stream: MediaStream;
+  try {
+    stream = await navigator.mediaDevices.getUserMedia({ video, audio: false });
+  } catch (err) {
+    // A remembered camera may have been unplugged: retry with the facing mode.
+    if (!deviceId || options.deviceId) throw err;
+    delete video.deviceId;
+    video.facingMode = { ideal: options.facingMode ?? 'environment' };
+    stream = await navigator.mediaDevices.getUserMedia({ video, audio: false });
+  }
+
+  const track = stream.getVideoTracks()[0];
+  if (track) await applyAdvanced(track, { focusMode: 'continuous' });
+  return stream;
+}
+
+/** Video input devices. Labels are only populated once camera permission was granted. */
+export async function listCameras(): Promise<MediaDeviceInfo[]> {
+  if (!navigator.mediaDevices?.enumerateDevices) return [];
+  const devices = await navigator.mediaDevices.enumerateDevices();
+  return devices.filter((d) => d.kind === 'videoinput');
+}
+
+interface ExtendedCapabilities extends MediaTrackCapabilities {
+  torch?: boolean;
+  zoom?: { min: number; max: number; step?: number };
+  focusMode?: string[];
+}
+
+export function capabilities(track: MediaStreamTrack | undefined): ExtendedCapabilities {
+  try {
+    return (track?.getCapabilities?.() ?? {}) as ExtendedCapabilities;
+  } catch {
+    return {};
+  }
+}
+
+export async function setTorch(track: MediaStreamTrack, on: boolean): Promise<void> {
+  if (!capabilities(track).torch) throw new Error('This camera has no controllable flashlight');
+  await track.applyConstraints({ advanced: [{ torch: on } as MediaTrackConstraintSet] });
+}
+
+export async function setZoom(track: MediaStreamTrack, zoom: number): Promise<void> {
+  const range = capabilities(track).zoom;
+  if (!range) throw new Error('This camera does not support zoom');
+  const value = Math.min(range.max, Math.max(range.min, zoom));
+  await track.applyConstraints({ advanced: [{ zoom: value } as MediaTrackConstraintSet] });
+}
+
+async function applyAdvanced(track: MediaStreamTrack, set: Record<string, unknown>): Promise<void> {
+  const caps = capabilities(track) as Record<string, unknown>;
+  const supported = Object.keys(set).filter((k) => {
+    const c = caps[k];
+    return Array.isArray(c) ? c.includes(set[k]) : c !== undefined;
+  });
+  if (supported.length === 0) return;
+  try {
+    await track.applyConstraints({ advanced: [Object.fromEntries(supported.map((k) => [k, set[k]]))] });
+  } catch {
+    /* best effort */
+  }
+}

package/src/core.ts

@@ -0,0 +1,189 @@
+// Engine core: owns the WebAssembly module and its objects.
+//
+// Two roles, so that frames can be decoded on several threads while a single
+// session keeps the state (strategy scheduling, multi-frame confirmation,
+// de-duplication):
+// - `SessionCore`: the session. Cheap calls (`plan`, `commit`), main thread.
+// - `DecoderCore`: the expensive decoding, one per Web Worker.
+// The inline engine (no Worker support) uses both on the main thread.
+import init, { WasmFrameDecoder, WasmScanner, WasmScanSession, version } from './wasm/scanner_wasm.js';
+import type { FramePlan, FrameReport, PixelFormat, ScanResult, WasmScanConfig } from './wasm/scanner_wasm.js';
+import type { Detection, EngineOptions } from './types.js';
+
+export type { FramePlan, FrameReport };
+
+/** Default location of the engine binary, next to this module. */
+export function defaultWasmUrl(): URL {
+  return new URL('./wasm/scanner_wasm_bg.wasm', import.meta.url);
+}
+
+/**
+ * Compile the engine once. The compiled module can be posted to any number
+ * of workers, which then only instantiate it (no second download or compile).
+ */
+export async function compileWasm(url: string | URL): Promise<WebAssembly.Module> {
+  const response = fetch(url);
+  try {
+    return await WebAssembly.compileStreaming(response);
+  } catch {
+    // Servers that do not send `application/wasm` reject streaming compilation.
+    return WebAssembly.compile(await (await response).arrayBuffer());
+  }
+}
+
+let initPromise: Promise<string> | null = null;
+
+/** Instantiate the engine in this realm (once). Returns the engine version. */
+export function loadWasm(source: string | URL | WebAssembly.Module): Promise<string> {
+  initPromise ??= init({ module_or_path: source }).then(() => version());
+  return initPromise;
+}
+
+/** Keep only the engine options (drops URLs and other non-cloneable values). */
+export function pickEngineOptions(o: EngineOptions): EngineOptions {
+  const { formats, preprocessing, tryInvert, maxResults, duplicateIntervalMs, linearConfirmations } = o;
+  return { formats, preprocessing, tryInvert, maxResults, duplicateIntervalMs, linearConfirmations };
+}
+
+export function toWasmConfig(o: EngineOptions, extra: Partial<WasmScanConfig> = {}): WasmScanConfig {
+  const cfg: WasmScanConfig = { ...extra };
+  if (o.formats) cfg.formats = o.formats;
+  if (o.preprocessing !== undefined) cfg.preprocessing = o.preprocessing;
+  if (o.tryInvert !== undefined) cfg.tryInvert = o.tryInvert;
+  if (o.maxResults !== undefined) cfg.maxResults = o.maxResults;
+  cfg.dedupCooldownMs = o.duplicateIntervalMs ?? 1500;
+  if (o.linearConfirmations !== undefined) cfg.linearConfirmations = o.linearConfirmations;
+  return cfg;
+}
+
+/**
+ * Configuration of camera sessions and their decoders: they must be equal,
+ * since a plan refers to the decoder's list of fallback strategies.
+ */
+function streamConfig(o: EngineOptions): WasmScanConfig {
+  // Back-pressure is handled by the SDK (frames are skipped, never queued),
+  // so the engine's own frame-skipping throttle would only drop useful frames.
+  return toWasmConfig(o, { adaptiveThrottle: false });
+}
+
+export function toDetection(r: ScanResult): Detection {
+  const d: Detection = { text: r.text, format: r.format, points: r.points, timestamp: r.timestampMs };
+  if (r.rawBytes) d.rawBytes = r.rawBytes;
+  return d;
+}
+
+export interface FrameOutcome {
+  /** New codes, or `null`. */
+  results: Detection[] | null;
+  /** Every code seen in this frame (including duplicates in cooldown). */
+  live: Detection[];
+  decodeMs: number;
+}
+
+/** The scan session of a camera stream (state only, cheap calls). */
+export class SessionCore {
+  private session: WasmScanSession | null = null;
+
+  configure(options: EngineOptions): void {
+    this.session?.free();
+    this.session = new WasmScanSession(streamConfig(options));
+  }
+
+  /** Strategy plan of the next frame, for a `DecoderCore` configured the same way. */
+  plan(): FramePlan {
+    return this.active().plan();
+  }
+
+  /** Record a decoded frame; returns the new codes and the live ones. */
+  commit(report: FrameReport): FrameOutcome {
+    const session = this.active();
+    const fresh = session.commit(report);
+    const results = fresh ? fresh.map(toDetection) : null;
+    return { results, live: results ?? session.lastDetections.map(toDetection), decodeMs: report.elapsedMs };
+  }
+
+  /** Decode on this thread (inline engine): plan, decode and commit at once. */
+  process(pixels: Uint8Array, width: number, height: number, format: PixelFormat): FrameOutcome {
+    const session = this.active();
+    // Write straight into WASM memory: avoids one more copy of the frame.
+    session.frameBuffer(pixels.length).set(pixels);
+    const t0 = performance.now();
+    const fresh = session.processFrameBuffer(width, height, format);
+    const decodeMs = performance.now() - t0;
+    const results = fresh ? fresh.map(toDetection) : null;
+    return { results, live: results ?? session.lastDetections.map(toDetection), decodeMs };
+  }
+
+  reset(): void {
+    this.session?.reset();
+  }
+
+  clearCooldown(text: string): void {
+    this.session?.clearCooldown(text);
+  }
+
+  destroy(): void {
+    this.session?.free();
+    this.session = null;
+  }
+
+  private active(): WasmScanSession {
+    if (!this.session) throw new Error('Engine not configured');
+    return this.session;
+  }
+}
+
+/** Frame decoding (stateless) and still-image scanning: the expensive part. */
+export class DecoderCore {
+  private decoder: WasmFrameDecoder | null = null;
+  private scanners = new Map<string, WasmScanner>();
+
+  configure(options: EngineOptions): void {
+    this.decoder?.free();
+    this.decoder = new WasmFrameDecoder(streamConfig(options));
+  }
+
+  decode(
+    pixels: Uint8Array,
+    width: number,
+    height: number,
+    format: PixelFormat,
+    plan: FramePlan,
+  ): FrameReport {
+    const decoder = this.decoder;
+    if (!decoder) throw new Error('Engine not configured');
+    decoder.frameBuffer(pixels.length).set(pixels);
+    return decoder.decodeFrameBuffer(width, height, format, plan);
+  }
+
+  /** One-shot scan of a still image, running every strategy. */
+  scan(
+    pixels: Uint8Array,
+    width: number,
+    height: number,
+    format: PixelFormat,
+    options: EngineOptions,
+  ): Detection[] {
+    const config = toWasmConfig(options);
+    const key = JSON.stringify(config);
+    let scanner = this.scanners.get(key);
+    if (!scanner) {
+      if (this.scanners.size >= 4) {
+        const [oldKey, old] = this.scanners.entries().next().value as [string, WasmScanner];
+        old.free();
+        this.scanners.delete(oldKey);
+      }
+      scanner = new WasmScanner(config);
+      this.scanners.set(key, scanner);
+    }
+    scanner.frameBuffer(pixels.length).set(pixels);
+    return scanner.scanFrameBuffer(width, height, format).map(toDetection);
+  }
+
+  destroy(): void {
+    this.decoder?.free();
+    this.decoder = null;
+    for (const s of this.scanners.values()) s.free();
+    this.scanners.clear();
+  }
+}