tapirscan 1.2.0 → 1.2.2

package/dist/multiformat/scanner.d.ts

@@ -1,60 +0,0 @@
-import { ReleaseDetailScanner } from "../detail.js";
-import { IndependentScanner, type Image, type Quad } from "../completion-host.mjs";
-import type { Mode } from "../index.js";
-import { type Format } from "./formats.js";
-export interface Barcode {
-    bytes?: number[];
-    format: Format | "Unknown";
-    text: string;
-    polygon: Quad;
-    support: number;
-    localizationScore?: number;
-    gs1?: boolean;
-    readerInitialization?: boolean;
-    structuredAppend?: {
-        index: number;
-        count: number;
-        id?: string;
-        parity?: number;
-    };
-    eanAddOn?: string;
-    error?: number;
-    rank?: number;
-}
-export type EanAddOnSymbol = "Ignore" | "Read" | "Require";
-export interface Frame {
-    primary?: ReturnType<ReleaseDetailScanner["scanLocalized"]> | ReturnType<IndependentScanner["scanLocalized"]>;
-    eanAddOnSymbol: EanAddOnSymbol;
-    barcodes: Barcode[];
-    regions: Barcode[];
-    formats: Format[];
-    unfinished: boolean;
-    scanMs: number;
-    mediumMs: number;
-    additionalMs: number;
-    preparationMs: number;
-    localizationMs: number;
-    linearStrategy: "scanlines" | "medium-localized";
-}
-/** Frozen EAN13 Medium plus project-owned opt-in readers. No reference decoder. */
-export declare class MediumMultiformatScanner {
-    private medium?;
-    private mode;
-    private extra?;
-    private handle;
-    private rgba;
-    private crop;
-    private effort;
-    private qrEffort;
-    private disposed;
-    private constructor();
-    static create(mediumBytes: ArrayBuffer | undefined, extraBytes?: ArrayBuffer, mode?: Mode, recoveryBytes?: ArrayBuffer): Promise<MediumMultiformatScanner>;
-    scan(image: Image, inputFormats?: readonly string[], options?: {
-        linearStrategy?: "scanlines" | "medium-localized";
-        eanAddOnSymbol?: EanAddOnSymbol;
-        finishCandidates?: boolean;
-    }): Frame;
-    private scanExtra;
-    private scanPrepared;
-    dispose(): void;
-}

package/dist/multiformat/scanner.js

@@ -1,361 +0,0 @@
-import { mergeLinearDuplicates } from "./linear-duplicates.js";
-import { ReleaseDetailScanner, fitLimits } from "../detail.js";
-import { IndependentScanner } from "../completion-host.mjs";
-import { policy } from "../policy.js";
-import { rectify, rectificationPlan, project, distinctReads, polygonOverlap } from "./geometry.js";
-import { toGray } from "./pixels.js";
-import { maskFor, resolveFormats, linearFormats as supportedLinearFormats, } from "./formats.js";
-function scanGray(image) {
-    return image.channels === 1 && image.stride === image.width
-        ? image.data.subarray(0, image.width * image.height)
-        : toGray(image);
-}
-/** Frozen EAN13 Medium plus project-owned opt-in readers. No reference decoder. */
-export class MediumMultiformatScanner {
-    medium;
-    mode = "medium";
-    extra;
-    handle = 0;
-    rgba = false;
-    crop = false;
-    effort = 1;
-    qrEffort = 1;
-    disposed = false;
-    constructor() { }
-    static async create(mediumBytes, extraBytes, mode = "medium", recoveryBytes) {
-        const scanner = new MediumMultiformatScanner();
-        try {
-            scanner.mode = mode;
-            scanner.effort = { low: 0, medium: 1, high: 2, "very-high": 2 }[mode];
-            scanner.qrEffort = { low: 0, medium: 1, high: 2, "very-high": 3 }[mode];
-            if (mediumBytes)
-                scanner.medium =
-                    mode !== "low" && recoveryBytes
-                        ? await ReleaseDetailScanner.create(mediumBytes, recoveryBytes, mode)
-                        : await IndependentScanner.create(mediumBytes);
-            if (extraBytes) {
-                const instance = await WebAssembly.instantiate(extraBytes, {});
-                const e = instance.instance.exports;
-                for (const name of [
-                    "multi_new",
-                    "multi_free",
-                    "multi_prepare",
-                    "multi_input",
-                    "multi_scan",
-                    "multi_output",
-                    "multi_output_len",
-                ]) {
-                    if (typeof e[name] !== "function")
-                        throw Error(`Invalid multiformat WASM export: ${name}`);
-                }
-                if (!(e.memory instanceof WebAssembly.Memory))
-                    throw Error("Invalid multiformat WASM memory.");
-                scanner.rgba =
-                    typeof e.multi_capabilities === "function" &&
-                        (e.multi_capabilities() & 4) !== 0 &&
-                        [e.multi_prepare_rgba, e.multi_input_rgba, e.multi_scan_rgba].every((f) => typeof f === "function");
-                scanner.crop =
-                    typeof e.multi_capabilities === "function" &&
-                        (e.multi_capabilities() & 16) !== 0 &&
-                        [e.multi_capture_source, e.multi_crop_transform, e.multi_crop].every((f) => typeof f === "function");
-                scanner.extra = e;
-                scanner.handle = e.multi_new();
-                if (!scanner.handle)
-                    throw Error("Could not create additional reader session.");
-            }
-            return scanner;
-        }
-        catch (error) {
-            scanner.dispose();
-            throw error;
-        }
-    }
-    scan(image, inputFormats, options = {}) {
-        if (this.disposed)
-            throw Error("Scanner is disposed.");
-        const medium = this.medium;
-        const scanPolicy = { ...policy, finishCandidates: options.finishCandidates ?? false };
-        const formats = resolveFormats(inputFormats);
-        const eanAddOnSymbol = options.eanAddOnSymbol ?? "Ignore";
-        if (!["Ignore", "Read", "Require"].includes(eanAddOnSymbol))
-            throw Error("Unknown EAN add-on policy.");
-        const requestedStrategy = options.linearStrategy ?? "scanlines";
-        if (!["scanlines", "medium-localized"].includes(requestedStrategy))
-            throw Error("Unknown linear strategy.");
-        // Supplements extend beyond the frozen Medium crop, so they require the
-        // full-frame supplemental pass. Default EAN13 remains untouched.
-        const linearStrategy = eanAddOnSymbol === "Ignore" ? requestedStrategy : "scanlines";
-        const localized = linearStrategy === "medium-localized" &&
-            formats.some((f) => f !== "EAN13" && f !== "UPCA" && supportedLinearFormats.includes(f));
-        let proposals = [];
-        const start = performance.now();
-        const { width, height, channels, stride, data } = image;
-        if (!Number.isSafeInteger(width) ||
-            !Number.isSafeInteger(height) ||
-            width < 3 ||
-            height < 3 ||
-            width * height > 32 * 1024 * 1024 ||
-            ![1, 3, 4].includes(channels) ||
-            !Number.isSafeInteger(stride) ||
-            stride < width * channels ||
-            !(data instanceof Uint8Array) ||
-            data.length < (height - 1) * stride + width * channels)
-            throw Error("Invalid image dimensions or buffer.");
-        const barcodes = [], regions = [];
-        let primary;
-        let unfinished = false, mediumMs = 0, additionalMs = 0, preparationMs = 0, localizationMs = 0;
-        const extraFormats = formats.filter((f) => eanAddOnSymbol !== "Ignore" || (f !== "EAN13" && f !== "UPCA"));
-        const conservative = medium instanceof ReleaseDetailScanner &&
-            !localized &&
-            eanAddOnSymbol === "Ignore" &&
-            formats.some((f) => f === "EAN13" || f === "UPCA") &&
-            extraFormats.some((f) => supportedLinearFormats.includes(f));
-        let preparedGray;
-        let preLinear;
-        const coverage = [];
-        if (conservative) {
-            const prepareStart = performance.now();
-            preparedGray = scanGray(image);
-            preparationMs += performance.now() - prepareStart;
-            const extraStart = performance.now();
-            preLinear = this.scanExtra(preparedGray, width, height, extraFormats.filter((f) => supportedLinearFormats.includes(f)), this.effort, eanAddOnSymbol);
-            additionalMs += performance.now() - extraStart;
-            for (const read of preLinear.barcodes) {
-                const error = read.error ?? Infinity;
-                const checked = ["EAN8", "UPCE", "Code128"].includes(read.format) && read.support >= 3 && error <= 0.08;
-                const unchecked = ["Code39", "ITF"].includes(read.format) &&
-                    read.support >= 8 &&
-                    error <= 0.035 &&
-                    read.text.length >= 8;
-                if (checked || unchecked)
-                    coverage.push(read.polygon);
-            }
-        }
-        if (formats.includes("EAN13") || formats.includes("UPCA")) {
-            if (!medium)
-                throw Error("EAN13 engine has not been initialized.");
-            const begin = performance.now();
-            const found = medium instanceof ReleaseDetailScanner
-                ? medium.scanLocalized(image, scanPolicy, fitLimits[this.mode], true, coverage)
-                : medium.scanLocalized(image, scanPolicy, fitLimits[this.mode], true);
-            primary = found;
-            const localization = found.localization;
-            proposals = localization.proposals;
-            localizationMs = found.localizationMs;
-            for (const b of found.scan.barcodes) {
-                if (formats.includes("UPCA") && b.text.startsWith("0"))
-                    barcodes.push({
-                        format: "UPCA",
-                        text: b.text.slice(1),
-                        polygon: b.polygon,
-                        support: b.support,
-                    });
-                else if (formats.includes("EAN13"))
-                    barcodes.push({ format: "EAN13", text: b.text, polygon: b.polygon, support: b.support });
-            }
-            const decoded = new Set(found.scan.barcodes.flatMap((b) => b.candidate_indices));
-            localization.proposals.forEach((p, i) => {
-                if (!decoded.has(i))
-                    regions.push({ format: "Unknown", text: "", polygon: p.polygon, support: 0 });
-            });
-            if ("recovery" in found) {
-                const recovery = found.recovery;
-                for (const attempt of recovery.attempts) {
-                    const accepted = new Set(attempt.reads.flatMap((b) => b.candidate_indices));
-                    attempt.proposals.forEach((p, i) => {
-                        if (!accepted.has(i))
-                            regions.push({ format: "Unknown", text: "", polygon: p.polygon, support: 0 });
-                    });
-                }
-            }
-            unfinished =
-                found.scan.unfinished ||
-                    Boolean(localization.workLimited) ||
-                    (localization.omitted ?? 0) > 0;
-            mediumMs = performance.now() - begin;
-        }
-        if (localized && !formats.includes("EAN13") && !formats.includes("UPCA")) {
-            if (!medium)
-                throw Error("EAN13 localization engine has not been initialized.");
-            const begin = performance.now();
-            const found = medium.scanLocalized(image, scanPolicy, fitLimits[this.mode], true)
-                .localization;
-            proposals = found.proposals;
-            unfinished ||= Boolean(found.workLimited) || (found.omitted ?? 0) > 0;
-            localizationMs = performance.now() - begin;
-        }
-        // UPC-A has the same optical structure as zero-prefixed EAN13, so the
-        // frozen Medium reader handles it without a second optical search.
-        if (extraFormats.length) {
-            if (!this.extra || !this.handle)
-                throw Error("Additional readers have not been loaded.");
-            const begin = performance.now();
-            const rgba = this.rgba &&
-                !localized &&
-                formats.length === 1 &&
-                formats[0] === "QRCode" &&
-                channels === 4 &&
-                stride === width * 4;
-            const gray = preparedGray ?? (rgba ? data.subarray(0, width * height * 4) : scanGray(image));
-            preparationMs += performance.now() - begin;
-            const matrixFormats = extraFormats.filter((f) => !supportedLinearFormats.includes(f));
-            const linearFormats = extraFormats.filter((f) => supportedLinearFormats.includes(f));
-            const run = (pixels, w, h, enabled, effort) => {
-                const start = performance.now();
-                const result = this.scanExtra(pixels, w, h, enabled, effort, eanAddOnSymbol, rgba);
-                additionalMs += performance.now() - start;
-                unfinished ||= result.unfinished;
-                return result;
-            };
-            if (!localized || !proposals.length) {
-                for (const [enabled, effort] of [
-                    [linearFormats, this.effort],
-                    [matrixFormats, matrixFormats.includes("QRCode") ? this.qrEffort : 1],
-                ]) {
-                    if (!enabled.length)
-                        continue;
-                    const result = enabled === linearFormats && preLinear
-                        ? preLinear
-                        : run(gray, width, height, enabled, effort);
-                    unfinished ||= result.unfinished;
-                    barcodes.push(...result.barcodes);
-                    regions.push(...(result.regions ?? []));
-                }
-            }
-            else {
-                if (matrixFormats.length) {
-                    const result = run(gray, width, height, matrixFormats, matrixFormats.includes("QRCode") ? this.qrEffort : 1);
-                    barcodes.push(...result.barcodes);
-                    regions.push(...(result.regions ?? []));
-                }
-                if (this.crop) {
-                    this.extra.multi_prepare(this.handle, width, height);
-                    new Uint8Array(this.extra.memory.buffer, this.extra.multi_input(this.handle), width * height).set(gray);
-                    if (this.extra.multi_capture_source(this.handle) !== 0)
-                        throw Error("Could not retain source image.");
-                }
-                for (const proposal of proposals) {
-                    const start = performance.now();
-                    let crop;
-                    let pixels;
-                    try {
-                        if (this.crop) {
-                            crop = rectificationPlan(proposal.polygon);
-                            new Float64Array(this.extra.memory.buffer, this.extra.multi_crop_transform(this.handle), 8).set(crop.transform);
-                            if (this.extra.multi_crop(this.handle, crop.width, crop.height) !== 0)
-                                throw Error("Could not sample barcode crop.");
-                        }
-                        else {
-                            const sampled = rectify(gray, width, height, proposal.polygon);
-                            crop = sampled;
-                            pixels = sampled.data;
-                        }
-                    }
-                    catch {
-                        unfinished = true;
-                        regions.push({ format: "Unknown", text: "", polygon: proposal.polygon, support: 0 });
-                        continue;
-                    }
-                    preparationMs += performance.now() - start;
-                    const decodeStart = performance.now();
-                    const result = pixels
-                        ? run(pixels, crop.width, crop.height, linearFormats, 0)
-                        : this.scanPrepared(linearFormats, 0, eanAddOnSymbol);
-                    if (!pixels) {
-                        additionalMs += performance.now() - decodeStart;
-                        unfinished ||= result.unfinished;
-                    }
-                    const reads = result.barcodes;
-                    if (!reads.length)
-                        regions.push({ format: "Unknown", text: "", polygon: proposal.polygon, support: 0 });
-                    for (const read of [...reads, ...(result.regions ?? [])]) {
-                        const p = read.polygon;
-                        const mapped = (p) => project(crop.transform, p[0], p[1]);
-                        read.polygon = [mapped(p[0]), mapped(p[1]), mapped(p[2]), mapped(p[3])];
-                        if (read.text)
-                            barcodes.push(read);
-                        else
-                            regions.push(read);
-                    }
-                }
-            }
-        }
-        if (extraFormats.length) {
-            for (const read of barcodes.filter((b) => b.eanAddOn)) {
-                for (const base of barcodes) {
-                    if (base.format === read.format &&
-                        base.text === read.text &&
-                        !base.eanAddOn &&
-                        polygonOverlap(base.polygon, read.polygon).smaller >= 0.65)
-                        base.eanAddOn = read.eanAddOn;
-                }
-            }
-            if (eanAddOnSymbol === "Require") {
-                for (let i = barcodes.length - 1; i >= 0; i--) {
-                    const b = barcodes[i];
-                    if (["EAN13", "UPCA", "EAN8", "UPCE"].includes(b.format) && !b.eanAddOn) {
-                        regions.push({ ...b, text: "" });
-                        barcodes.splice(i, 1);
-                    }
-                }
-            }
-            const distinct = distinctReads(barcodes);
-            barcodes.splice(0, barcodes.length, ...distinct);
-            const remaining = regions.filter((region) => !barcodes.some((b) => polygonOverlap(region.polygon, b.polygon).a >= 0.65));
-            regions.splice(0, regions.length, ...distinctReads(remaining));
-        }
-        const mergedLinear = mergeLinearDuplicates(barcodes, image);
-        barcodes.splice(0, barcodes.length, ...mergedLinear);
-        barcodes.sort((a, b) => b.support - a.support);
-        barcodes.forEach((b, i) => {
-            b.rank = i + 1;
-        });
-        return {
-            primary,
-            barcodes,
-            eanAddOnSymbol,
-            regions: [...barcodes, ...regions],
-            formats,
-            unfinished,
-            scanMs: performance.now() - start,
-            mediumMs,
-            additionalMs,
-            preparationMs,
-            localizationMs,
-            linearStrategy,
-        };
-    }
-    scanExtra(gray, width, height, formats, effort, eanAddOnSymbol, rgba = false) {
-        const e = this.extra;
-        if (!e || !this.handle)
-            throw Error("Additional readers have not been loaded.");
-        if ((rgba ? e.multi_prepare_rgba : e.multi_prepare)(this.handle, width, height) !== 0)
-            throw Error("Additional reader rejected image size.");
-        new Uint8Array(e.memory.buffer, (rgba ? e.multi_input_rgba : e.multi_input)(this.handle), width * height * (rgba ? 4 : 1)).set(gray);
-        return this.scanPrepared(formats, effort, eanAddOnSymbol, rgba);
-    }
-    scanPrepared(formats, effort, eanAddOnSymbol, rgba = false) {
-        const e = this.extra;
-        if (!e || !this.handle)
-            throw Error("Additional readers have not been loaded.");
-        const mask = maskFor(formats) |
-            (eanAddOnSymbol === "Read" ? 32768 : eanAddOnSymbol === "Require" ? 65536 : 0);
-        if ((rgba ? e.multi_scan_rgba : e.multi_scan)(this.handle, mask, effort) !== 0)
-            throw Error("Additional scanner failed.");
-        const bytes = new Uint8Array(e.memory.buffer, e.multi_output(this.handle), e.multi_output_len(this.handle));
-        const found = JSON.parse(new TextDecoder().decode(bytes));
-        for (const b of [...found.barcodes, ...(found.regions ?? [])])
-            if (!formats.includes(b.format))
-                throw Error("Scanner returned a disabled format.");
-        return found;
-    }
-    dispose() {
-        if (this.disposed)
-            return;
-        this.medium?.dispose();
-        if (this.handle)
-            this.extra?.multi_free(this.handle);
-        this.handle = 0;
-        this.disposed = true;
-    }
-}

package/dist/multiformat-host.d.ts

@@ -1,121 +0,0 @@
-/** Independent EAN-13 supplied-region scanner. Experimental; no localizer or
- * reference decoder is imported. All result confidence remains uncalibrated. */
-export type Point = readonly [number, number];
-export type Quad = readonly [Point, Point, Point, Point];
-export interface Image {
-    data: Uint8Array;
-    width: number;
-    height: number;
-    channels: 1 | 3 | 4;
-    stride: number;
-}
-export interface Policy {
-    transitionCleanup?: boolean;
-    sourceIdentity?: boolean;
-    interiorNormalization?: boolean;
-    guardBias?: boolean;
-    /** Experimental: accept one full-quiet scanline; increases false-read risk. Default false. */
-    allowSingleRow?: boolean;
-    maxRetryPathsPerCandidate?: number;
-    maxRetryPathsPerFrame?: number;
-    maxAssociationChecks?: number;
-    maxAssociationPixels?: number;
-    maxResults?: number;
-}
-export interface Detection {
-    text: string;
-    polygon: Quad;
-    support: number;
-    axis: number;
-}
-export interface Barcode extends Detection {
-    candidate_indices: number[];
-}
-export interface Observation {
-    text: string;
-    axis: number;
-    fraction: number;
-    left: number;
-    right: number;
-    cost: number;
-    gap: number;
-}
-export interface Candidate {
-    candidate_index: number;
-    coverage: readonly (readonly [number | null, number | null])[];
-    error: boolean;
-    error_detail: 'invalid_geometry' | 'sampling_error' | null;
-    unfinished: boolean;
-    ms: number;
-    work: Record<string, number>;
-    detections: Detection[];
-    observations: Observation[];
-}
-export interface ScanFrame {
-    unfinished: boolean;
-    candidates: Candidate[];
-    barcodes: Barcode[];
-    reconciliation: {
-        comparisons: number;
-        merged: number;
-        ambiguous: number;
-        conflicting: number;
-        pending_observations: number;
-        truncated: boolean;
-        source_pairs: number;
-        source_matches: number;
-        source_pixels: number;
-        source_capped: number;
-        pending_coverage_checks: number;
-        pending_quarantined: number;
-    };
-}
-export interface ScanResult extends ScanFrame {
-    /** This WASM build has no internal clock. Candidate ms values are unavailable zeros. */
-    candidateTimingsAvailable: false;
-    /** Actual host wall time, including validation, preparation/copies, decode and JSON parsing. */
-    elapsedMs: number;
-}
-/** Explicit indices reject sparse arrays; nonfinite numeric geometry reaches Rust. */
-export declare function isQuadShape(value: unknown): value is Quad;
-export declare class ScannerError extends Error {
-    readonly code: string;
-    constructor(code: string, message: string);
-}
-/** Validate before asynchronous work; returned bytes are owned by the caller. */
-export declare function snapshotImage(image: Image): Image;
-export declare function snapshotPolicy(policy: Policy): Policy;
-/** Uncalibrated support ordering; ties preserve spatial output order. */
-export declare function rankBarcodes(barcodes: readonly Barcode[]): Barcode[];
-export declare class IndependentScanner {
-    #private;
-    private constructor();
-    static create(bytes: BufferSource): Promise<IndependentScanner>;
-    /** Localization-only entry point for opt-in independent linear decoders. */
-    localizeOnly(image: Image, fitLimit?: number): {
-        proposals: {
-            polygon: Quad;
-            score?: number;
-        }[];
-        workLimited?: boolean;
-        omitted?: number;
-    };
-    /** All supplied regions receive the cheap pass; successful reads do not end scanning. */
-    scan(image: Image, quads: readonly Quad[], policy?: Policy): ScanResult;
-    /** Synchronous transaction: upload once, localize, decode the same owned pixels. */
-    scanLocalized(image: Image, policy?: Policy, fitLimit?: number, fullFrame?: boolean): {
-        localization: any;
-        searchWindows: {
-            kind: string;
-            polygon: number[][];
-            candidateIndex: any;
-        }[];
-        scan: ScanResult;
-        localizationMs: number;
-        decodingMs: number;
-        scanMs: number;
-    };
-    /** Separate convenience; it never changes find-all work or suppresses frame evidence. */
-    best(result: ScanFrame): Barcode | undefined;
-    dispose(): void;
-}