@biso_gmbh/capacitor-plugin-ml-kit-barcode-scanner 1.0.8

package/CapacitorPluginMlKitBarcodeScanner.podspec

@@ -0,0 +1,20 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorPluginMlKitBarcodeScanner'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.static_framework = true
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '15.0'
+  s.dependency 'Capacitor'
+  s.dependency 'GoogleMLKit/BarcodeScanning', '~> 5.0.0'
+  s.swift_version = '5.1'
+  s.resources = [ 'ios/Plugin/**/*.xcassets']
+end

package/README.md

@@ -0,0 +1,231 @@
+# capacitor-plugin-mlkit-barcode-scanner
+A really configurable implementation of googles MLKit Vision barcode scanning API for Android/IOS for capacitor.
+
+This is a capacitor port of [bi-so-gmbh / cordova-plugin-mlkit-barcode-scanner](https://github.com/bi-so-gmbh/cordova-plugin-mlkit-barcode-scanner)
+
+## Supported Versions
+
+### iOS
+A version of 1.15.0 or higher is needed. This is because that is the oldest version I can build the app on an emulator to test if the build runs through.
+
+## Install
+
+```bash
+npm install https://github.com/bi-so-gmbh/capacitor-plugin-mlkit-barcode-scanner.git
+npx cap sync
+```
+
+### Permissions
+
+#### IOS
+On IOS the camera permission needs to be added to the Info.plist of the project using the plugin.
+```
+<key>NSCameraUsageDescription</key>
+<string>Scan Barcodes</string>
+```
+
+#### Android
+On Android the permission has to be added in the AndroidManifest.xml of the project using the plugin.
+```
+<uses-feature android:name="android.hardware.camera" android:required="false"/>
+<uses-permission android:name="android.permission.CAMERA"/>
+```
+
+## Barcode Support
+
+| 1d formats   | Android | iOS |
+|--------------|---------|-----|
+| Codabar      | ✓       | ✓   |
+| Code 39      | ✓       | ✓   |
+| Code 93      | ✓       | ✓   |
+| Code 128     | ✓       | ✓   |
+| EAN-8.       | ✓       | ✓   |
+| EAN-13       | ✓       | ✓   |
+| ITF          | ✓       | ✓   |
+| MSI          | ✗       | ✗   |
+| RSS Expanded | ✗       | ✗   |
+| RSS-14       | ✗       | ✗   |
+| UPC-A        | ✓       | ✓   |
+| UPC-E        | ✓       | ✓   |
+
+| 2d formats  | Android | iOS |
+|-------------|---------|-----|
+| Aztec       | ✓       | ✓   |
+| Codablock   | ✗       | ✗   |
+| Data Matrix | ✓       | ✓   |
+| MaxiCode    | ✗       | ✗   |
+| PDF417      | ✓       | ✓   |
+| QR Code     | ✓       | ✓   |
+
+#### MLKit does not detect the following barcodes:
+
+- 1D Barcodes with only one character
+- Barcodes in ITF format with fewer than six characters
+- Barcodes encoded with FNC2, FNC3 or FNC4
+- QR codes generated in the ECI mode
+
+### Plugin Options
+
+The default options are shown below.
+All values are optional.
+
+Note that the `detectorSize` value must be between `0` and `1`, because it determines how many percent of the screen should be covered by the detector.
+If the value is greater than 1 the detector will not be visible on the screen.
+
+```javascript
+const defaultOptions = {
+  barcodeFormats: {
+    Code128: true,
+    Code39: true,
+    Code93: true,
+    CodaBar: true,
+    DataMatrix: true,
+    EAN13: true,
+    EAN8: true,
+    ITF: true,
+    QRCode: true,
+    UPCA: true,
+    UPCE: true,
+    PDF417: true,
+    Aztec: true,
+  },
+  beepOnSuccess: false,
+  vibrateOnSuccess: false,
+  detectorSize: 0.6,
+  detectorAspectRatio: "1:1",
+  drawFocusRect: true,
+  focusRectColor: "#FFFFFF",
+  focusRectBorderRadius: 100,
+  focusRectBorderThickness: 5,
+  drawFocusLine: false,
+  focusLineColor: "#ff2d37",
+  focusLineThickness: 2,
+  drawFocusBackground: false,
+  focusBackgroundColor: "#66FFFFFF",
+  stableThreshold: 5,
+  debugOverlay: false,
+  ignoreRotatedBarcodes: false
+};
+```
+
+### Barcode Detection
+
+All barcodes that are on the image are detected by MLKit. Once the barcodes detected haven't changed for a configurable amount of images (`stableThreshold`) they enter a secondary logic that checks if the barcodes found are in the scan area. Barcodes are considered inside if the center line of the barcode fits into the scan area completely. If the option `ignoreRotatedBarcodes` is set to `true` then barcodes additionally have to have a center line that matches the device rotation. This is done to be able to sort out barcodes rotated by 90 degree.
+
+## API
+
+<docgen-index>
+
+* [`scan(...)`](#scan)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### scan(...)
+
+```typescript
+scan(settings: ISettings) => Promise<IResult>
+```
+
+Opens a camera preview for barcode scanning and automatically detects barcodes in the scan area.
+In case of unsuccessful scan the reason is thrown as an error.
+
+__Possible errors:__
+  * CANCELED
+  * NO_CAMERA
+  * NO_CAMERA_PERMISSION
+  * JSON_EXCEPTION
+  * PLATFORM_NOT_SUPPORTED
+
+| Param          | Type                                            | Description                      |
+| -------------- | ----------------------------------------------- | -------------------------------- |
+| **`settings`** | <code><a href="#isettings">ISettings</a></code> | settings to be used for the scan |
+
+**Returns:** <code>Promise&lt;<a href="#iresult">IResult</a>&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### IResult
+
+The result of the plugin is an object with a list of detected barcodes, sorted by
+distanceToCenter with the lowest value being first. DistanceToCenter is calculated by how
+far away the center of the barcode is from the center of the scan area.
+
+| Prop           | Type                                                                                      |
+| -------------- | ----------------------------------------------------------------------------------------- |
+| **`barcodes`** | <code>[{ value: string; format: string; type: string; distanceToCenter: number; }]</code> |
+
+
+#### ISettings
+
+All settings that can be passed to the plugin. The `detectorSize` value must be between
+`0` and `1`, because it determines how many percent of the screen should be covered by
+the detector.
+If the value is greater than 1 the detector will not be visible on the screen.
+
+| Prop                           | Type                                                        |
+| ------------------------------ | ----------------------------------------------------------- |
+| **`barcodeFormats`**           | <code><a href="#ibarcodeformats">IBarcodeFormats</a></code> |
+| **`beepOnSuccess`**            | <code>boolean</code>                                        |
+| **`vibrateOnSuccess`**         | <code>boolean</code>                                        |
+| **`detectorSize`**             | <code>number</code>                                         |
+| **`detectorAspectRatio`**      | <code>string</code>                                         |
+| **`drawFocusRect`**            | <code>boolean</code>                                        |
+| **`focusRectColor`**           | <code>string</code>                                         |
+| **`focusRectBorderRadius`**    | <code>number</code>                                         |
+| **`focusRectBorderThickness`** | <code>number</code>                                         |
+| **`drawFocusLine`**            | <code>boolean</code>                                        |
+| **`focusLineColor`**           | <code>string</code>                                         |
+| **`focusLineThickness`**       | <code>number</code>                                         |
+| **`drawFocusBackground`**      | <code>boolean</code>                                        |
+| **`focusBackgroundColor`**     | <code>string</code>                                         |
+| **`stableThreshold`**          | <code>number</code>                                         |
+| **`debugOverlay`**             | <code>boolean</code>                                        |
+
+
+#### IBarcodeFormats
+
+Options to make it possible to narrow down the barcode types scanned.
+
+| Prop             | Type                 |
+| ---------------- | -------------------- |
+| **`Aztec`**      | <code>boolean</code> |
+| **`CodaBar`**    | <code>boolean</code> |
+| **`Code39`**     | <code>boolean</code> |
+| **`Code93`**     | <code>boolean</code> |
+| **`Code128`**    | <code>boolean</code> |
+| **`DataMatrix`** | <code>boolean</code> |
+| **`EAN8`**       | <code>boolean</code> |
+| **`EAN13`**      | <code>boolean</code> |
+| **`ITF`**        | <code>boolean</code> |
+| **`PDF417`**     | <code>boolean</code> |
+| **`QRCode`**     | <code>boolean</code> |
+| **`UPCA`**       | <code>boolean</code> |
+| **`UPCE`**       | <code>boolean</code> |
+
+</docgen-api>
+
+## Known Issues
+
+### Sometimes the orientation of the barcode is detected wrongly
+
+This is an issue with the fact that MLKit doesn't actually expose the barcode orientation, so any orientation that is used by this plugin basically just checks for the longest side of the barcode bounds. With square barcodes this causes some display issues in the debug overlay, and detection issues with `ignoreRotatedBarcodes` set to `true`. If you expect square barcodes (or qr codes) don't use that setting.
+
+### Barcodes are only read partially
+
+Another MLKit "feature". Happens especially often on ITF barcodes because the barcode checksum check isn't implemented in MLKit. Should be somewhat mitigated by the detection using the center line of the barcode, but sometimes only parts of the barcode will be read anyway. Only way to deal with it is to play around with `stableThreshold` until you have enough time to get the whole barcode in the scan area.
+
+### Barcode detection doesn't detect all barcodes
+
+More MLKit issues. When having multiple barcodes on screen, not all of them are detected all the time. If you are wondering why some barcodes are missing, activate `debugOverlay` and you will see which barcodes MLKIt found.
+
+### [Android] Torch Button is behind the drawn background
+
+On android, I use a SurfaceView to draw the overlay, including the full background, on. The only way to get this to be transparent so the camera can be seen behind it is to use ```setZOrderOnTop(true)``` on it, which makes it impossible for the button to be shown over it. This becomes a problem when a (nearly) opaque background is selected because then the button can't be seen anymore. NOTE: The button still works, it is just rendered behind the background.

package/android/build.gradle

@@ -0,0 +1,65 @@
+ext {
+    androidxCameraVersion = project.hasProperty('androidxCameraVersion') ? rootProject.ext.androidxCameraVersion : '1.3.2'
+    mlkitBarcodeScanningVersion = project.hasProperty('mlkitBarcodeScanningVersion') ? rootProject.ext.mlkitBarcodeScanningVersion : '17.2.0'
+    mlKitBarcodeScanningPlayServiceVersion = project.hasProperty('mlKitBarcodeScanningPlayServiceVersion') ? rootProject.ext.mlKitBarcodeScanningPlayServiceVersion : '18.3.0'
+    androidxConstraintLayoutVersion = project.hasProperty('androidxConstraintLayoutVersion') ? rootProject.ext.androidxConstraintLayoutVersion : '2.1.4'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.1.4'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.biso.capacitor.plugins.mlkit.barcode.scanner"
+    defaultConfig {
+        compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 26
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 107
+        versionName "1.0.7"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+    buildFeatures {
+        viewBinding true
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "androidx.constraintlayout:constraintlayout:$androidxConstraintLayoutVersion"
+    implementation "androidx.camera:camera-camera2:$androidxCameraVersion"
+    implementation "androidx.camera:camera-core:$androidxCameraVersion"
+    implementation "androidx.camera:camera-lifecycle:$androidxCameraVersion"
+    implementation "androidx.camera:camera-view:$androidxCameraVersion"
+    implementation "com.google.mlkit:barcode-scanning:$mlkitBarcodeScanningVersion"
+    implementation "com.google.android.gms:play-services-mlkit-barcode-scanning:$mlKitBarcodeScanningPlayServiceVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,8 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+  <uses-permission android:name="android.permission.VIBRATE" />
+  <application android:hardwareAccelerated="true" android:supportsRtl="true">
+    <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
+    <meta-data android:name="com.google.android.gms.vision.DEPENDENCIES" android:value="barcode" />
+    <activity android:label="Read Barcode" android:name=".CaptureActivity" android:theme="@style/Theme.AppCompat.Light.NoActionBar" />
+  </application>
+</manifest>

package/android/src/main/java/com/biso/capacitor/plugins/mlkit/barcode/scanner/BarcodeAnalyzer.java

@@ -0,0 +1,119 @@
+package com.biso.capacitor.plugins.mlkit.barcode.scanner;
+
+import static com.biso.capacitor.plugins.mlkit.barcode.scanner.Utils.getTranslationMatrix;
+import static com.biso.capacitor.plugins.mlkit.barcode.scanner.Utils.mapRect;
+
+import android.annotation.SuppressLint;
+import android.content.Intent;
+import android.graphics.Matrix;
+import android.graphics.RectF;
+import android.media.Image;
+import android.util.Log;
+import androidx.annotation.NonNull;
+import androidx.camera.core.ImageAnalysis.Analyzer;
+import androidx.camera.core.ImageProxy;
+import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.Tasks;
+import com.google.mlkit.vision.barcode.BarcodeScanner;
+import com.google.mlkit.vision.barcode.BarcodeScannerOptions;
+import com.google.mlkit.vision.barcode.BarcodeScanning;
+import com.google.mlkit.vision.barcode.common.Barcode;
+import com.google.mlkit.vision.common.InputImage;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.stream.Collectors;
+
+public class BarcodeAnalyzer implements Analyzer {
+
+  public static final String BARCODES = "barcodes";
+  private static final String ANALYZER = "BarcodeAnalyzer";
+  private List<DetectedBarcode> lastBarcodes;
+  private int stableCounter = 0;
+  private final BarcodeScanner scanner;
+  private final CameraOverlay cameraOverlay;
+  private final BarcodesListener barcodesListener;
+  private final ScannerSettings settings;
+
+  public BarcodeAnalyzer(ScannerSettings settings, BarcodesListener barcodesListener,
+      CameraOverlay cameraOverlay) {
+    int useBarcodeFormats = settings.getBarcodeFormats();
+    if (useBarcodeFormats == 0 || useBarcodeFormats == 1234) {
+      useBarcodeFormats = (Barcode.FORMAT_CODE_39 | Barcode.FORMAT_DATA_MATRIX);
+    }
+    scanner = BarcodeScanning
+        .getClient(
+            new BarcodeScannerOptions.Builder().setBarcodeFormats(useBarcodeFormats).build());
+    this.settings = settings;
+    this.lastBarcodes = new ArrayList<>();
+    this.barcodesListener = barcodesListener;
+    this.cameraOverlay = cameraOverlay;
+  }
+
+  @Override
+  public void analyze(@NonNull ImageProxy imageProxy) {
+    @SuppressLint("UnsafeOptInUsageError")
+    Image image = imageProxy.getImage();
+    if (image == null) {
+      imageProxy.close();
+      return;
+    }
+    InputImage inputImage = InputImage.fromMediaImage(image, imageProxy.getImageInfo().getRotationDegrees());
+    Task<List<Barcode>> scannerTask = scanner.process(inputImage);
+    try {
+      List<Barcode> barcodes = Tasks.await(scannerTask);
+
+      RectF source;
+      if (inputImage.getRotationDegrees() == 90) {
+        source = new RectF(0, 0, inputImage.getHeight(), inputImage.getWidth());
+      } else {
+        source = new RectF(0, 0, inputImage.getWidth(), inputImage.getHeight());
+      }
+      Matrix matrix = getTranslationMatrix(source, cameraOverlay.getSurfaceArea());
+
+      List<DetectedBarcode> detectedBarcodes = barcodes.stream().map(
+              barcode -> new DetectedBarcode(barcode, mapRect(barcode.getBoundingBox(), matrix),
+                  cameraOverlay.getScanArea().centerX(), cameraOverlay.getScanArea().centerY()))
+          .collect(Collectors.toList());
+
+      if (settings.isDebugOverlay()) {
+        cameraOverlay.drawDebugOverlay(detectedBarcodes);
+      }
+
+      if (areBarcodesStable(detectedBarcodes) && stableCounter >= settings.getStableThreshold()) {
+        ArrayList<DetectedBarcode> barcodesInScanArea = (ArrayList<DetectedBarcode>) detectedBarcodes.stream()
+            .filter(barcode -> barcode.isInScanArea(cameraOverlay.getScanArea(), settings.isIgnoreRotatedBarcodes())).sorted()
+            .collect(Collectors.toList());
+
+        if (!barcodesInScanArea.isEmpty()) {
+          Intent data = new Intent();
+          data.putParcelableArrayListExtra(BARCODES, barcodesInScanArea);
+          barcodesListener.onBarcodesFound(data);
+        } else {
+          stableCounter = 0;
+          lastBarcodes = new ArrayList<>();
+        }
+      }
+    } catch (ExecutionException e) {
+      Log.e(ANALYZER, e.getMessage());
+    } catch (InterruptedException e) {
+      Log.e(ANALYZER, e.getMessage());
+      Thread.currentThread().interrupt();
+    }
+    imageProxy.close();
+  }
+
+  private boolean areBarcodesStable(List<DetectedBarcode> barcodes) {
+    if (!barcodes.isEmpty() && (barcodes.size() == lastBarcodes.size())
+        && (new HashSet<>(lastBarcodes).containsAll(barcodes))) {
+      stableCounter++;
+      Log.d(ANALYZER,
+          "barcodes stable for " + stableCounter + "/" + settings.getStableThreshold());
+      return true;
+    }
+    lastBarcodes = barcodes;
+    stableCounter = 0;
+    return false;
+  }
+}

package/android/src/main/java/com/biso/capacitor/plugins/mlkit/barcode/scanner/BarcodeFormat.java

@@ -0,0 +1,40 @@
+package com.biso.capacitor.plugins.mlkit.barcode.scanner;
+
+import com.google.mlkit.vision.barcode.common.Barcode;
+
+// suppress uppercase rule for enum naming (this matches js and swift code)
+@SuppressWarnings("java:S115")
+public enum BarcodeFormat {
+  Code128(Barcode.FORMAT_CODE_128),
+  Code39(Barcode.FORMAT_CODE_39),
+  Code93(Barcode.FORMAT_CODE_93),
+  CodaBar(Barcode.FORMAT_CODABAR),
+  DataMatrix(Barcode.FORMAT_DATA_MATRIX),
+  EAN13(Barcode.FORMAT_EAN_13),
+  EAN8(Barcode.FORMAT_EAN_8),
+  ITF(Barcode.FORMAT_ITF),
+  QRCode(Barcode.FORMAT_QR_CODE),
+  UPCA(Barcode.FORMAT_UPC_A),
+  UPCE(Barcode.FORMAT_UPC_E),
+  PDF417(Barcode.FORMAT_PDF417),
+  Aztec(Barcode.FORMAT_AZTEC);
+
+  private final int format;
+
+  BarcodeFormat(int formatFlag) {
+    this.format = formatFlag;
+  }
+
+  public int getAsInt() {
+    return format;
+  }
+
+  public static BarcodeFormat getFromInt(int intValue) {
+    for (BarcodeFormat value : BarcodeFormat.values()) {
+      if(value.format == intValue) {
+        return value;
+      }
+    }
+    return null;
+  }
+}

package/android/src/main/java/com/biso/capacitor/plugins/mlkit/barcode/scanner/BarcodeFormats.java

@@ -0,0 +1,38 @@
+package com.biso.capacitor.plugins.mlkit.barcode.scanner;
+
+import com.getcapacitor.JSObject;
+import java.util.Iterator;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+public class BarcodeFormats {
+
+  private final JSObject formats = new JSObject();
+
+  public BarcodeFormats(JSONObject barcodeFormats) {
+    if (barcodeFormats == null) {
+      barcodeFormats = new JSObject();
+    }
+    for (BarcodeFormat value : BarcodeFormat.values()) {
+      boolean format = barcodeFormats.optBoolean(String.valueOf(value), barcodeFormats.length() == 0);
+      formats.put(String.valueOf(value), format);
+    }
+  }
+
+  public int getFormatFlags() {
+    int flags = 0;
+    try {
+      Iterator<String> iterator = formats.keys();
+      while (iterator.hasNext()) {
+        String key = iterator.next();
+        BarcodeFormat format = BarcodeFormat.valueOf(key);
+        if (formats.has(key) && formats.getBoolean(key)) {
+          flags += format.getAsInt();
+        }
+      }
+    } catch (JSONException e) {
+      // should not happen, the json is only used in this class
+    }
+    return flags;
+  }
+}

package/android/src/main/java/com/biso/capacitor/plugins/mlkit/barcode/scanner/BarcodeType.java

@@ -0,0 +1,37 @@
+package com.biso.capacitor.plugins.mlkit.barcode.scanner;
+
+import com.google.mlkit.vision.barcode.common.Barcode;
+
+public enum BarcodeType {
+  UNKNOWN(Barcode.TYPE_UNKNOWN),
+  CONTACT_INFO(Barcode.TYPE_CONTACT_INFO),
+  EMAIL(Barcode.TYPE_EMAIL),
+  ISBN(Barcode.TYPE_ISBN),
+  PHONE(Barcode.TYPE_PHONE),
+  PRODUCT(Barcode.TYPE_PRODUCT),
+  SMS(Barcode.TYPE_SMS),
+  TEXT(Barcode.TYPE_TEXT),
+  URL(Barcode.TYPE_URL),
+  WIFI(Barcode.TYPE_WIFI),
+  GEO(Barcode.TYPE_GEO),
+  CALENDAR_EVENT(Barcode.TYPE_CALENDAR_EVENT),
+  DRIVER_LICENSE(Barcode.TYPE_DRIVER_LICENSE);
+  private final int type;
+
+  BarcodeType(int type) {
+    this.type = type;
+  }
+
+  public int getAsInt() {
+    return type;
+  }
+
+  public static BarcodeType getFromInt(int intValue) {
+    for (BarcodeType value : BarcodeType.values()) {
+      if(value.type == intValue) {
+        return value;
+      }
+    }
+    return null;
+  }
+}

package/android/src/main/java/com/biso/capacitor/plugins/mlkit/barcode/scanner/BarcodesListener.java

@@ -0,0 +1,8 @@
+package com.biso.capacitor.plugins.mlkit.barcode.scanner;
+
+import android.content.Intent;
+
+public interface BarcodesListener {
+
+  void onBarcodesFound(Intent barcodes);
+}