@xbone-3/cordova-plugin-mlkit-barcodescanner 4.0.0

package/src/android/src/MLKitBarcodeScanner.java

@@ -0,0 +1,221 @@
+package com.mobisys.cordova.plugins.mlkit.barcode.scanner;
+
+import android.app.Activity;
+import android.app.AlertDialog;
+import android.content.Context;
+import android.content.DialogInterface;
+import android.content.Intent;
+import android.content.pm.PackageManager;
+import android.content.res.AssetFileDescriptor;
+import android.hardware.camera2.CameraManager;
+import android.media.MediaPlayer;
+import android.os.Build;
+import android.os.Bundle;
+import android.os.VibrationEffect;
+import android.os.Vibrator;
+import android.util.Log;
+
+import com.google.android.gms.common.api.CommonStatusCodes;
+
+import org.apache.cordova.CallbackContext;
+import org.apache.cordova.CordovaInterface;
+import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.CordovaWebView;
+import org.apache.cordova.PluginResult;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.IOException;
+
+/**
+ * This class echoes a string called from JavaScript.
+ */
+public class MLKitBarcodeScanner extends CordovaPlugin {
+
+  private static final String TAG = "MLKitBarcodeScanner";
+  private static final int RC_BARCODE_CAPTURE = 9001;
+
+  // Active plugin instance, used by CaptureActivity to stream results back
+  // while the camera stays open in continuous mode.
+  private static MLKitBarcodeScanner _Instance;
+
+  private CallbackContext _CallbackContext;
+  private Boolean _BeepOnSuccess;
+  private Boolean _VibrateOnSuccess;
+  private MediaPlayer _MediaPlayer;
+  private Vibrator _Vibrator;
+
+  public void initialize(CordovaInterface cordova, CordovaWebView webView) {
+    super.initialize(cordova, webView);
+
+    _Instance = this;
+
+    Context context = cordova.getContext();
+
+    _Vibrator = (Vibrator) context.getSystemService(Context.VIBRATOR_SERVICE);
+    _MediaPlayer = new MediaPlayer();
+
+    try {
+      AssetFileDescriptor descriptor = context.getAssets().openFd("beep.ogg");
+      _MediaPlayer.setDataSource(descriptor.getFileDescriptor(), descriptor.getStartOffset(), descriptor.getLength());
+      descriptor.close();
+      _MediaPlayer.prepare();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+
+  @Override
+  public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+    Activity activity = cordova.getActivity();
+    Boolean hasCamera = activity.getPackageManager().hasSystemFeature(PackageManager.FEATURE_CAMERA_ANY);
+    CameraManager cameraManager = (CameraManager) activity.getSystemService(Context.CAMERA_SERVICE);
+
+    _CallbackContext = callbackContext;
+
+    int numberOfCameras = 0;
+
+    try {
+      numberOfCameras = cameraManager.getCameraIdList().length;
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
+
+    if (!hasCamera || numberOfCameras == 0) {
+      AlertDialog alertDialog = new AlertDialog.Builder(activity).create();
+      alertDialog.setMessage(activity.getString(activity.getResources()
+          .getIdentifier("no_cameras_found", "string", activity.getPackageName())));
+      alertDialog.setButton(
+          AlertDialog.BUTTON_POSITIVE, activity.getString(activity.getResources()
+              .getIdentifier("ok", "string", activity.getPackageName())),
+          new DialogInterface.OnClickListener() {
+            public void onClick(DialogInterface dialog, int which) {
+              dialog.dismiss();
+            }
+          });
+      alertDialog.show();
+      return false;
+    }
+
+    if (action.equals("startScan")) {
+      class OneShotTask implements Runnable {
+        private final Context context;
+        private final JSONArray args;
+
+        private OneShotTask(Context ctx, JSONArray as) {
+          context = ctx;
+          args = as;
+        }
+
+        public void run() {
+          try {
+            openNewActivity(context, args);
+          } catch (JSONException e) {
+            _CallbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, e.toString()));
+          }
+        }
+      }
+      Thread t = new Thread(new OneShotTask(cordova.getContext(), args));
+      t.start();
+      return true;
+    }
+    return false;
+  }
+
+  private void openNewActivity(Context context, JSONArray args) throws JSONException {
+    JSONObject config = args.getJSONObject(0);
+    Intent intent = new Intent(context, CaptureActivity.class);
+    intent.putExtra("BarcodeFormats", config.optInt("barcodeFormats", 1234));
+    intent.putExtra("DetectorSize", config.optDouble("detectorSize", 0.5));
+    intent.putExtra("RotateCamera", config.optBoolean("rotateCamera", false));
+    intent.putExtra("Continuous", config.optBoolean("continuous", false));
+    intent.putExtra("Multiple", config.optBoolean("multiple", false));
+    intent.putExtra("DrawDetectionBorder", config.optBoolean("drawDetectionBorder", false));
+    intent.putExtra("Confirmation", config.optBoolean("confirmation", false));
+
+    _BeepOnSuccess = config.optBoolean("beepOnSuccess", false);
+    _VibrateOnSuccess = config.optBoolean("vibrateOnSuccess", false);
+
+    // NOTE: do not call setActivityResultCallback(this) here.
+    // startActivityForResult() already registers this plugin as the result
+    // callback. Calling it twice makes the second registration treat the first
+    // as a still-pending activity and cancel it via a synthetic
+    // onActivityResult(activityResultRequestCode, RESULT_CANCELED, null). Once
+    // activityResultRequestCode has been set to RC_BARCODE_CAPTURE by an
+    // earlier scan, that synthetic cancel passes our guard and aborts every
+    // subsequent scan before the camera opens.
+    this.cordova.startActivityForResult(this, intent, RC_BARCODE_CAPTURE);
+  }
+
+  @Override
+  public void onActivityResult(int requestCode, int resultCode, Intent data) {
+    super.onActivityResult(requestCode, resultCode, data);
+
+    if (requestCode == RC_BARCODE_CAPTURE) {
+      // CommonStatusCodes.SUCCESS and Activity.RESULT_CANCELED are both 0, so a
+      // successful scan can only be distinguished from a cancellation (back
+      // press / permission denied) by the presence of result data.
+      if (resultCode == CommonStatusCodes.SUCCESS && data != null) {
+        String payload = data.getStringExtra(CaptureActivity.BarcodePayload);
+        try {
+          // The payload is an array of [text, format, type] triples (one per
+          // detected barcode).
+          JSONArray result = new JSONArray(payload);
+          _CallbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, result));
+          notifyScan();
+          Log.d(TAG, "Barcodes read: " + payload);
+        } catch (JSONException e) {
+          _CallbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, e.toString()));
+        }
+      } else {
+        // No result data means the user cancelled (back press / permission
+        // denied). Report it as a cancellation rather than crashing on a null
+        // intent. A null first element is mapped to USER_CANCELLED in JS.
+        String err = (data != null) ? data.getStringExtra("err") : null;
+        JSONArray result = new JSONArray();
+        result.put(err);
+        result.put("");
+        result.put("");
+        _CallbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, result));
+      }
+    }
+  }
+
+  /**
+   * Streams a batch of barcodes back to JS while keeping the callback (and the
+   * camera) alive. Called from CaptureActivity in continuous mode.
+   */
+  static void sendContinuousResult(JSONArray barcodes) {
+    MLKitBarcodeScanner self = _Instance;
+    if (self == null || self._CallbackContext == null) {
+      return;
+    }
+    PluginResult result = new PluginResult(PluginResult.Status.OK, barcodes);
+    result.setKeepCallback(true);
+    self._CallbackContext.sendPluginResult(result);
+    self.notifyScan();
+  }
+
+  /** Plays the success beep and/or vibrates, honouring the scan options. */
+  private void notifyScan() {
+    if (_BeepOnSuccess) {
+      _MediaPlayer.start();
+    }
+
+    if (_VibrateOnSuccess) {
+      int duration = 200;
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+        _Vibrator.vibrate(VibrationEffect.createOneShot(duration, VibrationEffect.DEFAULT_AMPLITUDE));
+      } else {
+        // deprecated in API 26 aka Oreo
+        _Vibrator.vibrate(duration);
+      }
+    }
+  }
+
+  @Override
+  public void onRestoreStateForActivityResult(Bundle state, CallbackContext callbackContext) {
+    _CallbackContext = callbackContext;
+  }
+}

package/src/android/src/utils/BitmapUtils.java

@@ -0,0 +1,286 @@
+/*
+ * Copyright 2020 Google LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mobisys.cordova.plugins.mlkit.barcode.scanner.utils;
+
+import android.annotation.TargetApi;
+import android.content.ContentResolver;
+import android.graphics.Bitmap;
+import android.graphics.BitmapFactory;
+import android.graphics.ImageFormat;
+import android.graphics.Matrix;
+import android.graphics.Rect;
+import android.graphics.YuvImage;
+import android.media.Image;
+import android.media.Image.Plane;
+import android.net.Uri;
+import android.os.Build.VERSION_CODES;
+import android.provider.MediaStore;
+import android.util.Log;
+
+import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
+import androidx.camera.core.ExperimentalGetImage;
+import androidx.camera.core.ImageProxy;
+import androidx.exifinterface.media.ExifInterface;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+
+/** Utils functions for bitmap conversions. */
+public class BitmapUtils {
+  private static final String TAG = "BitmapUtils";
+
+  /** Converts NV21 format byte buffer to bitmap. */
+  @Nullable
+  public static Bitmap getBitmap(ByteBuffer data, FrameMetadata metadata) {
+    data.rewind();
+    byte[] imageInBuffer = new byte[data.limit()];
+    data.get(imageInBuffer, 0, imageInBuffer.length);
+    try {
+      YuvImage image = new YuvImage(imageInBuffer, ImageFormat.NV21, metadata.getWidth(), metadata.getHeight(), null);
+      ByteArrayOutputStream stream = new ByteArrayOutputStream();
+      image.compressToJpeg(new Rect(0, 0, metadata.getWidth(), metadata.getHeight()), 80, stream);
+
+      Bitmap bmp = BitmapFactory.decodeByteArray(stream.toByteArray(), 0, stream.size());
+
+      stream.close();
+      return rotateBitmap(bmp, metadata.getRotation(), false, false);
+    } catch (Exception e) {
+      Log.e("VisionProcessorBase", "Error: " + e.getMessage());
+    }
+    return null;
+  }
+
+  /** Converts a YUV_420_888 image from CameraX API to a bitmap. */
+  @RequiresApi(VERSION_CODES.KITKAT)
+  @Nullable
+  @ExperimentalGetImage
+  public static Bitmap getBitmap(ImageProxy image) {
+    FrameMetadata frameMetadata = new FrameMetadata.Builder().setWidth(image.getWidth()).setHeight(image.getHeight())
+        .setRotation(image.getImageInfo().getRotationDegrees()).build();
+
+    ByteBuffer nv21Buffer = yuv420ThreePlanesToNV21(image.getImage().getPlanes(), image.getWidth(), image.getHeight());
+    return getBitmap(nv21Buffer, frameMetadata);
+  }
+
+  /** Rotates a bitmap if it is converted from a bytebuffer. */
+  private static Bitmap rotateBitmap(Bitmap bitmap, int rotationDegrees, boolean flipX, boolean flipY) {
+    Matrix matrix = new Matrix();
+
+    // Rotate the image back to straight.
+    matrix.postRotate(rotationDegrees);
+
+    // Mirror the image along the X or Y axis.
+    matrix.postScale(flipX ? -1.0f : 1.0f, flipY ? -1.0f : 1.0f);
+    Bitmap rotatedBitmap = Bitmap.createBitmap(bitmap, 0, 0, bitmap.getWidth(), bitmap.getHeight(), matrix, true);
+
+    // Recycle the old bitmap if it has changed.
+    if (rotatedBitmap != bitmap) {
+      bitmap.recycle();
+    }
+    return rotatedBitmap;
+  }
+
+  @Nullable
+  public static Bitmap getBitmapFromContentUri(ContentResolver contentResolver, Uri imageUri) throws IOException {
+    Bitmap decodedBitmap = MediaStore.Images.Media.getBitmap(contentResolver, imageUri);
+    if (decodedBitmap == null) {
+      return null;
+    }
+    int orientation = getExifOrientationTag(contentResolver, imageUri);
+
+    int rotationDegrees = 0;
+    boolean flipX = false;
+    boolean flipY = false;
+    // See e.g. https://magnushoff.com/articles/jpeg-orientation/ for a detailed
+    // explanation on each
+    // orientation.
+    switch (orientation) {
+    case ExifInterface.ORIENTATION_FLIP_HORIZONTAL:
+      flipX = true;
+      break;
+    case ExifInterface.ORIENTATION_ROTATE_90:
+      rotationDegrees = 90;
+      break;
+    case ExifInterface.ORIENTATION_TRANSPOSE:
+      rotationDegrees = 90;
+      flipX = true;
+      break;
+    case ExifInterface.ORIENTATION_ROTATE_180:
+      rotationDegrees = 180;
+      break;
+    case ExifInterface.ORIENTATION_FLIP_VERTICAL:
+      flipY = true;
+      break;
+    case ExifInterface.ORIENTATION_ROTATE_270:
+      rotationDegrees = -90;
+      break;
+    case ExifInterface.ORIENTATION_TRANSVERSE:
+      rotationDegrees = -90;
+      flipX = true;
+      break;
+    case ExifInterface.ORIENTATION_UNDEFINED:
+    case ExifInterface.ORIENTATION_NORMAL:
+    default:
+      // No transformations necessary in this case.
+    }
+
+    return rotateBitmap(decodedBitmap, rotationDegrees, flipX, flipY);
+  }
+
+  private static int getExifOrientationTag(ContentResolver resolver, Uri imageUri) {
+    // We only support parsing EXIF orientation tag from local file on the device.
+    // See also:
+    // https://android-developers.googleblog.com/2016/12/introducing-the-exifinterface-support-library.html
+    if (!ContentResolver.SCHEME_CONTENT.equals(imageUri.getScheme())
+        && !ContentResolver.SCHEME_FILE.equals(imageUri.getScheme())) {
+      return 0;
+    }
+
+    ExifInterface exif;
+    try (InputStream inputStream = resolver.openInputStream(imageUri)) {
+      if (inputStream == null) {
+        return 0;
+      }
+
+      exif = new ExifInterface(inputStream);
+    } catch (IOException e) {
+      Log.e(TAG, "failed to open file to read rotation meta data: " + imageUri, e);
+      return 0;
+    }
+
+    return exif.getAttributeInt(ExifInterface.TAG_ORIENTATION, ExifInterface.ORIENTATION_NORMAL);
+  }
+
+  /**
+   * Converts YUV_420_888 to NV21 bytebuffer.
+   *
+   * <p>
+   * The NV21 format consists of a single byte array containing the Y, U and V
+   * values. For an image of size S, the first S positions of the array contain
+   * all the Y values. The remaining positions contain interleaved V and U values.
+   * U and V are subsampled by a factor of 2 in both dimensions, so there are S/4
+   * U values and S/4 V values. In summary, the NV21 array will contain S Y values
+   * followed by S/4 VU values: YYYYYYYYYYYYYY(...)YVUVUVUVU(...)VU
+   *
+   * <p>
+   * YUV_420_888 is a generic format that can describe any YUV image where U and V
+   * are subsampled by a factor of 2 in both dimensions. {@link Image#getPlanes}
+   * returns an array with the Y, U and V planes. The Y plane is guaranteed not to
+   * be interleaved, so we can just copy its values into the first part of the
+   * NV21 array. The U and V planes may already have the representation in the
+   * NV21 format. This happens if the planes share the same buffer, the V buffer
+   * is one position before the U buffer and the planes have a pixelStride of 2.
+   * If this is case, we can just copy them to the NV21 array.
+   */
+  @RequiresApi(VERSION_CODES.KITKAT)
+  private static ByteBuffer yuv420ThreePlanesToNV21(Plane[] yuv420888planes, int width, int height) {
+    int imageSize = width * height;
+    byte[] out = new byte[imageSize + 2 * (imageSize / 4)];
+
+    if (areUVPlanesNV21(yuv420888planes, width, height)) {
+      // Copy the Y values.
+      yuv420888planes[0].getBuffer().get(out, 0, imageSize);
+
+      ByteBuffer uBuffer = yuv420888planes[1].getBuffer();
+      ByteBuffer vBuffer = yuv420888planes[2].getBuffer();
+      // Get the first V value from the V buffer, since the U buffer does not contain
+      // it.
+      vBuffer.get(out, imageSize, 1);
+      // Copy the first U value and the remaining VU values from the U buffer.
+      uBuffer.get(out, imageSize + 1, 2 * imageSize / 4 - 1);
+    } else {
+      // Fallback to copying the UV values one by one, which is slower but also works.
+      // Unpack Y.
+      unpackPlane(yuv420888planes[0], width, height, out, 0, 1);
+      // Unpack U.
+      unpackPlane(yuv420888planes[1], width, height, out, imageSize + 1, 2);
+      // Unpack V.
+      unpackPlane(yuv420888planes[2], width, height, out, imageSize, 2);
+    }
+
+    return ByteBuffer.wrap(out);
+  }
+
+  /**
+   * Checks if the UV plane buffers of a YUV_420_888 image are in the NV21 format.
+   */
+  @RequiresApi(VERSION_CODES.KITKAT)
+  private static boolean areUVPlanesNV21(Plane[] planes, int width, int height) {
+    int imageSize = width * height;
+
+    ByteBuffer uBuffer = planes[1].getBuffer();
+    ByteBuffer vBuffer = planes[2].getBuffer();
+
+    // Backup buffer properties.
+    int vBufferPosition = vBuffer.position();
+    int uBufferLimit = uBuffer.limit();
+
+    // Advance the V buffer by 1 byte, since the U buffer will not contain the first
+    // V value.
+    vBuffer.position(vBufferPosition + 1);
+    // Chop off the last byte of the U buffer, since the V buffer will not contain
+    // the last U value.
+    uBuffer.limit(uBufferLimit - 1);
+
+    // Check that the buffers are equal and have the expected number of elements.
+    boolean areNV21 = (vBuffer.remaining() == (2 * imageSize / 4 - 2)) && (vBuffer.compareTo(uBuffer) == 0);
+
+    // Restore buffers to their initial state.
+    vBuffer.position(vBufferPosition);
+    uBuffer.limit(uBufferLimit);
+
+    return areNV21;
+  }
+
+  /**
+   * Unpack an image plane into a byte array.
+   *
+   * The input plane data will be copied in 'out', starting at 'offset' and every
+   * pixel will be spaced by 'pixelStride'. Note that there is no row padding on
+   * the output.
+   */
+  @TargetApi(VERSION_CODES.KITKAT)
+  private static void unpackPlane(Plane plane, int width, int height, byte[] out, int offset, int pixelStride) {
+    ByteBuffer buffer = plane.getBuffer();
+    buffer.rewind();
+
+    // Compute the size of the current plane.
+    // We assume that it has the aspect ratio as the original image.
+    int numRow = (buffer.limit() + plane.getRowStride() - 1) / plane.getRowStride();
+    if (numRow == 0) {
+      return;
+    }
+    int scaleFactor = height / numRow;
+    int numCol = width / scaleFactor;
+
+    // Extract the data in the output buffer.
+    int outputPos = offset;
+    int rowStart = 0;
+    for (int row = 0; row < numRow; row++) {
+      int inputPos = rowStart;
+      for (int col = 0; col < numCol; col++) {
+        out[outputPos] = buffer.get(inputPos);
+        outputPos += pixelStride;
+        inputPos += plane.getPixelStride();
+      }
+      rowStart += plane.getRowStride();
+    }
+  }
+}

package/src/android/src/utils/FrameMetadata.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2020 Google LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mobisys.cordova.plugins.mlkit.barcode.scanner.utils;
+
+/** Describing a frame info. */
+public class FrameMetadata {
+
+  private final int width;
+  private final int height;
+  private final int rotation;
+
+  public int getWidth() {
+    return width;
+  }
+
+  public int getHeight() {
+    return height;
+  }
+
+  public int getRotation() {
+    return rotation;
+  }
+
+  private FrameMetadata(int width, int height, int rotation) {
+    this.width = width;
+    this.height = height;
+    this.rotation = rotation;
+  }
+
+  public static class Builder {
+
+    private int width;
+    private int height;
+    private int rotation;
+
+    public Builder setWidth(int width) {
+      this.width = width;
+      return this;
+    }
+
+    public Builder setHeight(int height) {
+      this.height = height;
+      return this;
+    }
+
+    public Builder setRotation(int rotation) {
+      this.rotation = rotation;
+      return this;
+    }
+
+    public FrameMetadata build() {
+      return new FrameMetadata(width, height, rotation);
+    }
+  }
+}

package/src/ios/CDViOSScanner.h

@@ -0,0 +1,21 @@
+#import <AVFoundation/AVFoundation.h>
+#import <Foundation/Foundation.h>
+#import <Cordova/CDV.h>
+#import <UIKit/UIKit.h>
+#import "CameraViewController.h"
+
+@class UIViewController;
+
+@interface CDViOSScanner : CDVPlugin {
+    NSString *_callback;
+    Boolean _scannerOpen;
+    AVAudioPlayer* _player;
+    Boolean _beepOnSuccess;
+    Boolean _vibrateOnSuccess;
+}
+
+@property (nonatomic, retain) CameraViewController* cameraViewController;
+
+- (void) startScan:(CDVInvokedUrlCommand *)command;
+
+@end