capacitor-card-scanner 0.3.1 → 0.3.2

package/README.md

@@ -340,6 +340,7 @@ requestPermissions() => Promise<PermissionStatus>
 | **`requireCard`**     | <code>boolean</code> | Only read text when a card-shaped object is visible. When false, the whole frame is read if no card is found.                                                                                                                                        | <code>true</code>               |
 | **`debug`**           | <code>boolean</code> | Every object found is always outlined: red when accepted as a card, grey when rejected. With `debug`, each outline is also labelled with its area (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to tune the filters above. | <code>false</code>              |
 | **`showRejected`**    | <code>boolean</code> | Outline (in grey) the objects that were not accepted as a card. The accepted card is always outlined in red.                                                                                                                                         | <code>true</code>               |
+| **`repeatAfterMs`**   | <code>number</code>  | How long (ms) the card must be out of view before the same card can be reported again. While a card stays in view it is reported only once.                                                                                                          | <code>1500</code>               |
 
 
 #### PluginListenerHandle

package/android/src/main/java/pt/tcgclassifier/cardscanner/CardDetector.java

@@ -64,6 +64,8 @@ public class CardDetector implements ImageAnalysis.Analyzer {
         public boolean debug = false;
         /** Outline (in grey) the objects that were not accepted as a card. */
         public boolean showRejected = true;
+        /** How long the card must be out of view before the same card can be reported again. */
+        public long repeatAfterMs = 1500;
     }
 
     /** An object found by ML Kit, with the values the card filters were checked against. */
@@ -108,8 +110,8 @@ public class CardDetector implements ImageAnalysis.Analyzer {
     );
     private static final Pattern HP_SUFFIX = Pattern.compile("\\s*HP\\s*\\d+\\s*$", Pattern.CASE_INSENSITIVE);
     private static final Pattern LETTER = Pattern.compile("\\p{L}");
-    /** After this long without reading a card, the same card can be reported again. */
-    private static final long RESET_AFTER_MS = 1500;
+    /** Names at least this similar are treated as the same card. */
+    private static final float SAME_NAME_SIMILARITY = 0.8f;
     /** Extra margin around the detected card before running OCR. */
     private static final float CROP_MARGIN = 0.04f;
 
@@ -126,7 +128,10 @@ public class CardDetector implements ImageAnalysis.Analyzer {
     private long lastSeenAt;
     private String candidateKey;
     private int candidateCount;
-    private String lastEmittedKey;
+    // Last reported card. A reading is the same card if either its name or its
+    // number matches, because OCR does not read the number on every frame.
+    private String lastEmittedName;
+    private String lastEmittedNumber;
 
     public CardDetector(Options options, Listener listener) {
         this.options = options;
@@ -169,6 +174,9 @@ public class CardDetector implements ImageAnalysis.Analyzer {
             List<Candidate> candidates = new ArrayList<>();
             Rect card = pickCard(objects, frameW, frameH, candidates);
             RectF cardBox = card == null ? null : normalize(card, frameW, frameH);
+            // The card counts as "in view" while its outline is visible, even if
+            // its text is not readable on this frame.
+            if (card != null) lastSeenAt = now;
             BoxListener bl = boxListener;
             if (bl != null) bl.onDetections(cardBox, candidates, frameW, frameH);
 
@@ -287,8 +295,9 @@ public class CardDetector implements ImageAnalysis.Analyzer {
             candidateKey = key;
             candidateCount = 1;
         }
-        if (candidateCount < options.stableFrames || key.equals(lastEmittedKey)) return;
-        lastEmittedKey = key;
+        if (candidateCount < options.stableFrames || isLastEmitted(name, number)) return;
+        lastEmittedName = name;
+        lastEmittedNumber = number;
 
         JSObject result = new JSObject();
         result.put("name", name);
@@ -309,7 +318,33 @@ public class CardDetector implements ImageAnalysis.Analyzer {
     private void noCardRead(long now) {
         candidateKey = null;
         candidateCount = 0;
-        if (now - lastSeenAt > RESET_AFTER_MS) lastEmittedKey = null;
+        if (now - lastSeenAt > options.repeatAfterMs) {
+            lastEmittedName = null;
+            lastEmittedNumber = null;
+        }
+    }
+
+    private boolean isLastEmitted(String name, String number) {
+        if (number != null && number.equals(lastEmittedNumber)) return true;
+        return name != null && lastEmittedName != null && similarity(name, lastEmittedName) >= SAME_NAME_SIMILARITY;
+    }
+
+    /** 0-1 similarity (LCS based), so an OCR slip like "Evolutlon" still matches "Evolution". */
+    private static float similarity(String a, String b) {
+        a = a.toLowerCase(Locale.ROOT);
+        b = b.toLowerCase(Locale.ROOT);
+        if (a.equals(b)) return 1f;
+        int[] prev = new int[b.length() + 1];
+        int[] cur = new int[b.length() + 1];
+        for (int i = 1; i <= a.length(); i++) {
+            for (int j = 1; j <= b.length(); j++) {
+                cur[j] = a.charAt(i - 1) == b.charAt(j - 1) ? prev[j - 1] + 1 : Math.max(prev[j], cur[j - 1]);
+            }
+            int[] tmp = prev;
+            prev = cur;
+            cur = tmp;
+        }
+        return 2f * prev[b.length()] / (a.length() + b.length());
     }
 
     private static JSObject box(float x, float y, float width, float height) {

package/android/src/main/java/pt/tcgclassifier/cardscanner/CardScannerPlugin.java

@@ -102,6 +102,7 @@ public class CardScannerPlugin extends Plugin {
         options.requireCard = call.getBoolean("requireCard", options.requireCard);
         options.debug = call.getBoolean("debug", options.debug);
         options.showRejected = call.getBoolean("showRejected", options.showRejected);
+        options.repeatAfterMs = call.getInt("repeatAfterMs", (int) options.repeatAfterMs);
 
         CardDetector detector = new CardDetector(options, result -> notifyListeners("cardDetected", result));
         getActivity().runOnUiThread(() -> {

package/dist/docs.json

@@ -420,6 +420,18 @@
           "docs": "Outline (in grey) the objects that were not accepted as a card.\nThe accepted card is always outlined in red.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "repeatAfterMs",
+          "tags": [
+            {
+              "text": "1500",
+              "name": "default"
+            }
+          ],
+          "docs": "How long (ms) the card must be out of view before the same card can be\nreported again. While a card stays in view it is reported only once.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -90,6 +90,12 @@ export interface DetectionOptions {
      * @default true
      */
     showRejected?: boolean;
+    /**
+     * How long (ms) the card must be out of view before the same card can be
+     * reported again. While a card stays in view it is reported only once.
+     * @default 1500
+     */
+    repeatAfterMs?: number;
 }
 /** Normalized rectangle (0-1). */
 export interface Box {

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type CameraPosition = 'rear' | 'front';\n\nexport interface StartOptions {\n  /**\n   * Which camera to use.\n   * @default 'rear'\n   */\n  position?: CameraPosition;\n}\n\nexport interface CaptureOptions {\n  /**\n   * JPEG quality (0-100).\n   * @default 85\n   */\n  quality?: number;\n}\n\nexport interface CaptureResult {\n  /** Base64 encoded JPEG (without the `data:` prefix). */\n  base64: string;\n  width: number;\n  height: number;\n}\n\nexport interface TorchOptions {\n  enabled: boolean;\n}\n\nexport interface ZoomOptions {\n  /** Zoom ratio, clamped between the camera's min and max. */\n  ratio: number;\n}\n\nexport interface PermissionStatus {\n  camera: PermissionState;\n}\n\nexport interface DetectionOptions {\n  /**\n   * Minimum time between two OCR runs, in milliseconds.\n   * The red rectangle is updated on every frame regardless.\n   * @default 300\n   */\n  intervalMs?: number;\n  /**\n   * How many consecutive OCR runs must read the same card before\n   * `cardDetected` fires.\n   * @default 2\n   */\n  stableFrames?: number;\n  /**\n   * Include a JPEG of the detected card in the event.\n   * @default false\n   */\n  includeImage?: boolean;\n  /**\n   * Expected width / height of an upright card. Only upright cards are\n   * detected; a card lying sideways falls outside the tolerance.\n   * @default 0.716 (63 x 88 mm)\n   */\n  cardAspectRatio?: number;\n  /**\n   * Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\n   * Increase it if tilted cards are not detected.\n   * @default 0.15\n   */\n  aspectTolerance?: number;\n  /**\n   * Smallest card size, as a fraction of the camera frame (0-1).\n   * @default 0.08\n   */\n  minCardArea?: number;\n  /**\n   * Largest card size, as a fraction of the camera frame (0-1).\n   * @default 0.9\n   */\n  maxCardArea?: number;\n  /**\n   * Only read text when a card-shaped object is visible. When false, the whole\n   * frame is read if no card is found.\n   * @default true\n   */\n  requireCard?: boolean;\n  /**\n   * Every object found is always outlined: red when accepted as a card, grey\n   * when rejected. With `debug`, each outline is also labelled with its area\n   * (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\n   * tune the filters above.\n   * @default false\n   */\n  debug?: boolean;\n  /**\n   * Outline (in grey) the objects that were not accepted as a card.\n   * The accepted card is always outlined in red.\n   * @default true\n   */\n  showRejected?: boolean;\n}\n\n/** Normalized rectangle (0-1). */\nexport interface Box {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}\n\nexport interface TextLine {\n  text: string;\n  /** Position inside the card image. */\n  box: Box;\n}\n\nexport interface CardDetectedEvent {\n  /** Best guess for the card name (topmost line of text on the card). */\n  name?: string;\n  /** Collector number, e.g. `025/165`. */\n  collectorNumber?: string;\n  /** All text read on the card. */\n  text: string;\n  lines: TextLine[];\n  /** Where the card is in the camera frame. Missing if no card outline was found. */\n  cardBox?: Box;\n  /** Base64 JPEG of the card, when `includeImage` is true. */\n  image?: string;\n}\n\nexport interface CardScannerPlugin {\n  /**\n   * Opens the camera **behind** the WebView. The WebView background is made\n   * transparent, so the HTML page must also use transparent backgrounds\n   * where the camera should be visible.\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /** Stops the camera and removes the preview. */\n  stop(): Promise<void>;\n\n  /** Takes a photo from the running camera. */\n  capture(options?: CaptureOptions): Promise<CaptureResult>;\n\n  /** Turns the flashlight on/off. */\n  setTorch(options: TorchOptions): Promise<void>;\n\n  /** Sets the zoom ratio. */\n  setZoom(options: ZoomOptions): Promise<void>;\n\n  /** Switches between the rear and front camera. */\n  flip(): Promise<void>;\n\n  /**\n   * Starts looking for cards: draws a red rectangle around the card and reads\n   * its text, emitting `cardDetected`. Requires `start()` first. Android only.\n   */\n  startDetection(options?: DetectionOptions): Promise<void>;\n\n  /** Stops card detection and hides the rectangle. */\n  stopDetection(): Promise<void>;\n\n  /** Fired once per card, when its text has been read consistently. */\n  addListener(eventName: 'cardDetected', listener: (event: CardDetectedEvent) => void): Promise<PluginListenerHandle>;\n\n  removeAllListeners(): Promise<void>;\n\n  checkPermissions(): Promise<PermissionStatus>;\n\n  requestPermissions(): Promise<PermissionStatus>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type CameraPosition = 'rear' | 'front';\n\nexport interface StartOptions {\n  /**\n   * Which camera to use.\n   * @default 'rear'\n   */\n  position?: CameraPosition;\n}\n\nexport interface CaptureOptions {\n  /**\n   * JPEG quality (0-100).\n   * @default 85\n   */\n  quality?: number;\n}\n\nexport interface CaptureResult {\n  /** Base64 encoded JPEG (without the `data:` prefix). */\n  base64: string;\n  width: number;\n  height: number;\n}\n\nexport interface TorchOptions {\n  enabled: boolean;\n}\n\nexport interface ZoomOptions {\n  /** Zoom ratio, clamped between the camera's min and max. */\n  ratio: number;\n}\n\nexport interface PermissionStatus {\n  camera: PermissionState;\n}\n\nexport interface DetectionOptions {\n  /**\n   * Minimum time between two OCR runs, in milliseconds.\n   * The red rectangle is updated on every frame regardless.\n   * @default 300\n   */\n  intervalMs?: number;\n  /**\n   * How many consecutive OCR runs must read the same card before\n   * `cardDetected` fires.\n   * @default 2\n   */\n  stableFrames?: number;\n  /**\n   * Include a JPEG of the detected card in the event.\n   * @default false\n   */\n  includeImage?: boolean;\n  /**\n   * Expected width / height of an upright card. Only upright cards are\n   * detected; a card lying sideways falls outside the tolerance.\n   * @default 0.716 (63 x 88 mm)\n   */\n  cardAspectRatio?: number;\n  /**\n   * Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\n   * Increase it if tilted cards are not detected.\n   * @default 0.15\n   */\n  aspectTolerance?: number;\n  /**\n   * Smallest card size, as a fraction of the camera frame (0-1).\n   * @default 0.08\n   */\n  minCardArea?: number;\n  /**\n   * Largest card size, as a fraction of the camera frame (0-1).\n   * @default 0.9\n   */\n  maxCardArea?: number;\n  /**\n   * Only read text when a card-shaped object is visible. When false, the whole\n   * frame is read if no card is found.\n   * @default true\n   */\n  requireCard?: boolean;\n  /**\n   * Every object found is always outlined: red when accepted as a card, grey\n   * when rejected. With `debug`, each outline is also labelled with its area\n   * (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\n   * tune the filters above.\n   * @default false\n   */\n  debug?: boolean;\n  /**\n   * Outline (in grey) the objects that were not accepted as a card.\n   * The accepted card is always outlined in red.\n   * @default true\n   */\n  showRejected?: boolean;\n  /**\n   * How long (ms) the card must be out of view before the same card can be\n   * reported again. While a card stays in view it is reported only once.\n   * @default 1500\n   */\n  repeatAfterMs?: number;\n}\n\n/** Normalized rectangle (0-1). */\nexport interface Box {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}\n\nexport interface TextLine {\n  text: string;\n  /** Position inside the card image. */\n  box: Box;\n}\n\nexport interface CardDetectedEvent {\n  /** Best guess for the card name (topmost line of text on the card). */\n  name?: string;\n  /** Collector number, e.g. `025/165`. */\n  collectorNumber?: string;\n  /** All text read on the card. */\n  text: string;\n  lines: TextLine[];\n  /** Where the card is in the camera frame. Missing if no card outline was found. */\n  cardBox?: Box;\n  /** Base64 JPEG of the card, when `includeImage` is true. */\n  image?: string;\n}\n\nexport interface CardScannerPlugin {\n  /**\n   * Opens the camera **behind** the WebView. The WebView background is made\n   * transparent, so the HTML page must also use transparent backgrounds\n   * where the camera should be visible.\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /** Stops the camera and removes the preview. */\n  stop(): Promise<void>;\n\n  /** Takes a photo from the running camera. */\n  capture(options?: CaptureOptions): Promise<CaptureResult>;\n\n  /** Turns the flashlight on/off. */\n  setTorch(options: TorchOptions): Promise<void>;\n\n  /** Sets the zoom ratio. */\n  setZoom(options: ZoomOptions): Promise<void>;\n\n  /** Switches between the rear and front camera. */\n  flip(): Promise<void>;\n\n  /**\n   * Starts looking for cards: draws a red rectangle around the card and reads\n   * its text, emitting `cardDetected`. Requires `start()` first. Android only.\n   */\n  startDetection(options?: DetectionOptions): Promise<void>;\n\n  /** Stops card detection and hides the rectangle. */\n  stopDetection(): Promise<void>;\n\n  /** Fired once per card, when its text has been read consistently. */\n  addListener(eventName: 'cardDetected', listener: (event: CardDetectedEvent) => void): Promise<PluginListenerHandle>;\n\n  removeAllListeners(): Promise<void>;\n\n  checkPermissions(): Promise<PermissionStatus>;\n\n  requestPermissions(): Promise<PermissionStatus>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-card-scanner",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Recognize a pokemon card with camera open in background",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",