Merge branch 'master' into fix_android_permission_bug

Julian Steenbakker · GitHub
Commit 581fe5e243e80b1865cf2a0e91c95f38f16c0333 581fe5e2 2 parents 684634aa 5e9486e8
Showing 8 changed files with 44 additions and 47 deletions
.github/workflows/flutter.yml
.github/workflows/release-please.yml
CHANGELOG.md
README.md
android/build.gradle
example/lib/barcode_scanner_window.dart
lib/src/mobile_scanner.dart
macos/mobile_scanner.podspec
--- a/.github/workflows/flutter.yml
View file @581fe5e
+++ b/.github/workflows/flutter.yml
View file @581fe5e
@@ -11,8 +11,8 @@ jobs:
   analysis:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.1.0
-      - uses: actions/setup-java@v3.6.0
+      - uses: actions/checkout@v3.2.0
+      - uses: actions/setup-java@v3.8.0
         with:
           java-version: 11
           distribution: temurin
@@ -28,8 +28,8 @@ jobs:
   formatting:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.1.0
-      - uses: actions/setup-java@v3.6.0
+      - uses: actions/checkout@v3.2.0
+      - uses: actions/setup-java@v3.8.0
         with:
           java-version: 11
           distribution: temurin
--- a/.github/workflows/release-please.yml
View file @581fe5e
+++ b/.github/workflows/release-please.yml
View file @581fe5e
@@ -7,7 +7,7 @@
    release-please:
      runs-on: ubuntu-latest
      steps:
-       - uses: GoogleCloudPlatform/release-please-action@v3.6.1
+       - uses: GoogleCloudPlatform/release-please-action@v3.7.0
          with:
            token: ${{ secrets.GITHUB_TOKEN }}
            release-type: simple
--- a/CHANGELOG.md
View file @581fe5e
+++ b/CHANGELOG.md
View file @581fe5e
@@ -28,6 +28,8 @@ Improvements:
 * Removed `called stop while already stopped` messages.
 Features:
+* You can now provide a `scanWindow` to the `MobileScanner()` widget.
+* You can now draw an overlay over the scanned barcode. See the barcode scanner window in the example app for more information.
 * Added a new `placeholderBuilder` function to the `MobileScanner` widget to customize the preview placeholder.
 * Added `autoStart` parameter to MobileScannerController(). If set to false, controller won't start automatically.
 * Added `hasTorch` function on MobileScannerController(). After starting the controller, you can check if the device has a torch.
--- a/README.md
View file @581fe5e
+++ b/README.md
View file @581fe5e
@@ -3,40 +3,42 @@
 [![pub package](https://img.shields.io/pub/v/mobile_scanner.svg)](https://pub.dev/packages/mobile_scanner)
 [![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
 [![mobile_scanner](https://github.com/juliansteenbakker/mobile_scanner/actions/workflows/flutter.yml/badge.svg)](https://github.com/juliansteenbakker/mobile_scanner/actions/workflows/flutter.yml)
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/juliansteenbakker?label=sponsor%20me)](https://github.com/sponsors/juliansteenbakker)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/juliansteenbakker?label=like%20my%20work?%20sponsor%20me!)](https://github.com/sponsors/juliansteenbakker)
-A universal barcode and QR code scanner for Flutter based on MLKit. Uses CameraX on Android, AVFoundation on iOS and Apple Vision & AVFoundation on macOS. 
+An universal barcode and QR code scanner for Flutter based on MLKit. Uses CameraX on Android, AVFoundation on iOS and Apple Vision & AVFoundation on macOS. 
-## Platform Support
+## Features Supported
-| Android | iOS | MacOS | Web | Linux | Windows |
-| :-----: | :-: | :---: | :-: | :---: | :-----: |
-|   ✔️    | ✔️   |  ✔️  | ✔️  |     |      |
+See the example app for detailed implementation information.
-### Android
-SDK 21 and newer. Reason: CameraX requires at least SDK 21.
-Also, make sure you upgrade kotlin to the latest version in your project.
+| Features               | Android            | iOS                | macOS | Web |
+|------------------------|--------------------|--------------------|-------|-----|
+| analyzeImage (Gallery) | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| returnImage            | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| scanWindow             | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| barcodeOverlay         | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+
+## Platform Support
-This packages uses the **bundled version** of MLKit Barcode-scanning for Android. This version is more accurate and immediately available to devices. However, this version will increas the size of the app with approximately 3 to 10 MB. The alternative for this is to use the **unbundled version** of MLKit Barcode-scanning for Android. This version is older than the bundled version however this only increases the size by around 600KB. 
+| Android | iOS | macOS | Web | Linux | Windows |
+|---------|-----|-------|-----|-------|---------|
+| ✔       | ✔   | ✔     | ✔   | :x:   | :x:     |
+## Platform specific setup
+### Android
+This packages uses the **bundled version** of MLKit Barcode-scanning for Android. This version is more accurate and immediately available to devices. However, this version will increase the size of the app with approximately 3 to 10 MB. The alternative for this is to use the **unbundled version** of MLKit Barcode-scanning for Android. This version is older than the bundled version however this only increases the size by around 600KB.
 To use this version you must alter the mobile_scanner gradle file to replace `com.google.mlkit:barcode-scanning:17.0.2` with `com.google.android.gms:play-services-mlkit-barcode-scanning:18.0.0`. Keep in mind that if you alter the gradle files directly in your project it can be overriden when you update your pubspec.yaml. I am still searching for a way to properly replace the module in gradle but have yet to find one.
 [You can read more about the difference between the two versions here.](https://developers.google.com/ml-kit/vision/barcode-scanning/android)
 ### iOS
-iOS 11 and newer. Reason: MLKit for iOS requires at least iOS 10 and a [64bit device](https://developers.google.com/ml-kit/migration/ios).
-
 **Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:**
-
 NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.
 **If you want to use the local gallery feature from [image_picker](https://pub.dev/packages/image_picker)**
-  
 NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
 ### macOS
-macOS 10.13 or newer. Reason: Apple Vision library.
-  
 Ensure that you granted camera permission in XCode -> Signing & Capabilities:
 <img width="696" alt="Screenshot of XCode where Camera is checked" src="https://user-images.githubusercontent.com/24459435/193464115-d76f81d0-6355-4cb2-8bee-538e413a3ad0.png">
@@ -48,12 +50,6 @@ Add this to `web/index.html`:
 <script type="text/javascript" src="https://unpkg.com/@zxing/library@0.19.1"></script>
 ```
-## Features Supported
-
-| Features               | Android            | iOS                | macOS | Web |
-|------------------------|--------------------|--------------------|-------|-----|
-| analyzeImage (Gallery) | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
-
 ## Usage
 Import `package:mobile_scanner/mobile_scanner.dart`, and use the widget with or without the controller.
--- a/android/build.gradle
View file @581fe5e
+++ b/android/build.gradle
View file @581fe5e
@@ -49,10 +49,10 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     // Use this dependency to bundle the model with your app
-    implementation 'com.google.mlkit:barcode-scanning:17.0.2'
+    implementation 'com.google.mlkit:barcode-scanning:17.0.3'
     // Use this dependency to use the dynamically downloaded model in Google Play Services
 //    implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.1.0'
-    implementation 'androidx.camera:camera-camera2:1.1.0'
-    implementation 'androidx.camera:camera-lifecycle:1.1.0'
+    implementation 'androidx.camera:camera-camera2:1.2.0'
+    implementation 'androidx.camera:camera-lifecycle:1.2.0'
 }
--- a/example/lib/barcode_scanner_window.dart
View file @581fe5e
+++ b/example/lib/barcode_scanner_window.dart
View file @581fe5e
@@ -54,11 +54,10 @@ class _BarcodeScannerWithScanWindowState
                   arguments != null)
                 CustomPaint(
                   painter: BarcodeOverlay(
-                    barcode!,
-                    arguments!,
-                    BoxFit.contain,
-                    MediaQuery.of(context).devicePixelRatio,
-                    capture!,
+                    barcode: barcode!,
+                    arguments: arguments!,
+                    boxFit: BoxFit.contain,
+                    capture: capture!,
                   ),
                 ),
               CustomPaint(
@@ -131,19 +130,17 @@ class ScannerOverlay extends CustomPainter {
 }
 class BarcodeOverlay extends CustomPainter {
-  BarcodeOverlay(
-    this.barcode,
-    this.arguments,
-    this.boxFit,
-    this.devicePixelRatio,
-    this.capture,
-  );
+  BarcodeOverlay({
+    required this.barcode,
+    required this.arguments,
+    required this.boxFit,
+    required this.capture,
+  });
   final BarcodeCapture capture;
   final Barcode barcode;
   final MobileScannerArguments arguments;
   final BoxFit boxFit;
-  final double devicePixelRatio;
   @override
   void paint(Canvas canvas, Size size) {
--- a/lib/src/mobile_scanner.dart
View file @581fe5e
+++ b/lib/src/mobile_scanner.dart
View file @581fe5e
@@ -218,6 +218,8 @@ class _MobileScannerState extends State<MobileScanner>
     );
   }
+  Rect? scanWindow;
+
   @override
   Widget build(BuildContext context) {
     return LayoutBuilder(
@@ -229,14 +231,14 @@ class _MobileScannerState extends State<MobileScanner>
                 return __buildPlaceholderOrError(context, child);
             }
-            if (widget.scanWindow != null) {
-              final window = calculateScanWindowRelativeToTextureInPercentage(
+            if (widget.scanWindow != null && scanWindow == null) {
+              scanWindow = calculateScanWindowRelativeToTextureInPercentage(
                 widget.fit,
                 widget.scanWindow!,
                 value.size,
                 Size(constraints.maxWidth, constraints.maxHeight),
               );
-              _controller.updateScanWindow(window);
+              _controller.updateScanWindow(scanWindow!);
             }
             return ClipRect(
--- a/macos/mobile_scanner.podspec
View file @581fe5e
+++ b/macos/mobile_scanner.podspec
View file @581fe5e
@@ -4,7 +4,7 @@
 #
 Pod::Spec.new do |s|
   s.name             = 'mobile_scanner'
-  s.version          = '0.0.1'
+  s.version          = '3.0.0'
   s.summary          = 'An universal scanner for Flutter based on MLKit.'
   s.description      = <<-DESC
 An universal scanner for Flutter based on MLKit.