feat: bump android dependency & clean up scanner widgets

.github/workflows/flutter.yml

@@ -36,7 +36,7 @@ jobs:
       - uses: subosito/flutter-action@v2.12.0
         with:
           cache: true
-          flutter-version: '3.22'
+          flutter-version: '3.24'
           channel: 'stable'
       - name: Version
         run: flutter doctor -v

CHANGELOG.md

@@ -1,34 +1,50 @@
 ## NEXT
-- Fixed an issue which caused the scanWindow to always be present if provided, even when scanWindow is updated to null
-- Integrated basic barcode overlay and scanner overlay into the package.
-- Made updateScanWindow private, because logic within the MobileScanner widget is needed in order to pass a correct scanWindow.
-The scanWindow can be updated by directly changing the scanWindow in the MobileScanner widget.
+
+**BREAKING CHANGES:**
+
+* The `updateScanWindow` method is now private. Instead, update the scan window in the `MobileScanner` widget directly.
+* The deprecated `EncryptionType.none` constant has been removed. Use `EncryptionType.unknown` instead.
+
+Bugs fixed:
+* [Apple] Fixed an issue which caused the scanWindow to always be present, even when reset to no value.
+* [Apple] Fixed an issue that caused the barcode size to report the wrong height.
+
+Improvements:
+* Added a basic barcode overlay widget, for use with the camera preview.
+* Added a basic scan window overlay widget, for use with the camera preview.
+* Update the bundled MLKit model for Android to version `17.3.0`.
+* Added documentation in places where it was missing.
+* Added `color` and `style` properties to the `BarcodePainter` widget.
 
 ## 7.0.0-beta.3
-Fix build issues on macOS
+
+* Fixed a build issue on macOS.
 
 ## 7.0.0-beta.2
 
+Bugs fixed:
+* [Apple] Fixed an issue with the zoom slider being non-functional.
+* [Apple] Fixed an issue where the flash would briefly show when the camera is turned on.
+* [Apple] Fixed an issue that prevented the scan window from working.
+* [Apple] Fixed an issue that caused the barcode overlay to use the wrong dimensions.
+
 Improvements:
 * [iOS] Adds support for Swift Package Manager.
-* [Apple] Fixes zoom slider
-* Fixed torch at start not working
-* Fixed scanWindow not being correct
-* Fixed barcode overlay not being correct
 
 Known issues:
-* BoxFit.cover & BoxFit.fitHeight produces wrong width in barcodeOverlay
+* BoxFit.cover & BoxFit.fitHeight produce the wrong width in the barcode overlay.
 
 ## 7.0.0-beta.1
 
-This version replaces MLKit on iOS with Apple's Vision API and merges the iOS and MacOS sources.
-The requirement for the minimum iOS version has been relaxed back down to iOS 12.0.
+Improvements:
+* [iOS] Migrate to the Vision API.
+* [iOS] Updated the minimum iOS version back down to 12.0.
+* [Apple] Merged the iOS and MacOS sources.
 
-There are still some problems with this build.
-* Zoom slider not working
-* scanWindow not working
-* Flash shows briefly when starting scanner.
-* Other issues, not fully tested yet.
+Known issues:
+* [Apple] The zoom slider does not work correctly.
+* [Apple] The scan window does not work correctly.
+* [Apple] The camera flash briefly shows when the camera is started.
 
 ## 6.0.2
 

analysis_options.yaml

@@ -3,6 +3,8 @@ include: package:lint/analysis_options_package.yaml
 linter:
   rules:
     - combinators_ordering
+    - comment_references
     - require_trailing_commas
     - unnecessary_library_directive
-    - prefer_single_quotes
+    - prefer_single_quotes
+    - public_member_api_docs

android/build.gradle

@@ -70,7 +70,7 @@ dependencies {
         implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.1'
     } else {
         // Bundled model in app
-        implementation 'com.google.mlkit:barcode-scanning:17.2.0'
+        implementation 'com.google.mlkit:barcode-scanning:17.3.0'
     }
 
     // org.jetbrains.kotlin:kotlin-bom artifact purpose is to align kotlin stdlib and related code versions.

darwin/mobile_scanner/Sources/mobile_scanner/MobileScannerPlugin.swift

@@ -177,11 +177,11 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
                         })
 
                         DispatchQueue.main.async {
+                            // If the image is nil, use zero as the size.
                             guard let image = cgImage else {
-                            // Image not known, default image size to 1
                                 self?.sink?([
                                     "name": "barcode",
-                                    "data": barcodes.map({ $0.toMap(width: 1, height: 1) }),
+                                    "data": barcodes.map({ $0.toMap(imageWidth: 0, imageHeight: 0) }),
                                 ])
                                 return
                             }
@@ -194,10 +194,9 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
                                 "height": Double(image.height),
                             ]
 
-
                             self?.sink?([
                                 "name": "barcode",
-                                "data": barcodes.map({ $0.toMap(width: image.width, height: image.height) }),
+                                "data": barcodes.map({ $0.toMap(imageWidth: image.width, imageHeight: image.height) }),
                                 "image": imageData,
                             ])
                         }
@@ -473,7 +472,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
             device.torchMode = .on
             device.unlockForConfiguration()
         } catch(_) {
-
+            // Do nothing.
         }
     }
 
@@ -526,7 +525,6 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
 
     /// Set the zoom factor of the camera
     func setScaleInternal(_ scale: CGFloat) throws {
-
         if (device == nil) {
             throw MobileScannerError.zoomWhenStopped
         }
@@ -545,10 +543,8 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
                 actualScale = min(maxZoomFactor, actualScale)
 
                 // Limit to 1.0 scale
-
                 device.videoZoomFactor = actualScale
 
-
                 device.unlockForConfiguration()
             #endif
         } catch {
@@ -620,7 +616,9 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
             try device.lockForConfiguration()
             device.torchMode = newTorchMode
             device.unlockForConfiguration()
-        } catch(_) {}
+        } catch(_) {
+            // Do nothing.
+        }
 
         result(nil)
     }
@@ -690,7 +688,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin, FlutterStreamHandler,
 
                 result([
                     "name": "barcode",
-                    "data": barcodes.map({ $0.toMap(width: 1, height: 1) }),
+                    "data": barcodes.map({ $0.toMap(imageWidth: Int(ciImage.extent.width), imageHeight: Int(ciImage.extent.height)) }),
                 ])
             })
 
@@ -803,15 +801,18 @@ extension VNBarcodeObservation {
         return sqrt(pow(p1.x - p2.x, 2) + pow(p1.y - p2.y, 2))
     }
 
-    public func toMap(width: Int, height: Int) -> [String: Any?] {
-        let topLeftX = topLeft.x * CGFloat(width)
-        let topRightX = topRight.x * CGFloat(width)
-        let bottomRightX = bottomRight.x * CGFloat(width)
-        let bottomLeftX = bottomLeft.x * CGFloat(width)
-        let topLeftY = (1 - topLeft.y) * CGFloat(height)
-        let topRightY = (1 - topRight.y) * CGFloat(height)
-        let bottomRightY = (1 - bottomRight.y) * CGFloat(height)
-        let bottomLeftY = (1 - bottomLeft.y) * CGFloat(height)
+    /// Map this `VNBarcodeObservation` to a dictionary.
+    ///
+    /// The `imageWidth` and `imageHeight` indicate the width and height of the input image that contains this observation.
+    public func toMap(imageWidth: Int, imageHeight: Int) -> [String: Any?] {
+        let topLeftX = topLeft.x * CGFloat(imageWidth)
+        let topRightX = topRight.x * CGFloat(imageWidth)
+        let bottomRightX = bottomRight.x * CGFloat(imageWidth)
+        let bottomLeftX = bottomLeft.x * CGFloat(imageWidth)
+        let topLeftY = (1 - topLeft.y) * CGFloat(imageHeight)
+        let topRightY = (1 - topRight.y) * CGFloat(imageHeight)
+        let bottomRightY = (1 - bottomRight.y) * CGFloat(imageHeight)
+        let bottomLeftY = (1 - bottomLeft.y) * CGFloat(imageHeight)
         let data = [
             "corners":  [
                 ["x": bottomLeftX, "y": bottomLeftY],
@@ -823,8 +824,8 @@ extension VNBarcodeObservation {
             "rawValue": payloadStringValue ?? "",
             "displayValue": payloadStringValue ?? "",
             "size": [
-                "width": distanceBetween(topLeft, topRight) * CGFloat(width),
-                "height": distanceBetween(topLeft, bottomLeft) * CGFloat(width),
+                "width": distanceBetween(topLeft, topRight) * CGFloat(imageWidth),
+                "height": distanceBetween(topLeft, bottomLeft) * CGFloat(imageHeight),
             ],
         ] as [String : Any]
         return data

example/lib/barcode_scanner_controller.dart

@@ -21,8 +21,6 @@ class _BarcodeScannerWithControllerState
     torchEnabled: true,
   );
 
-  StreamSubscription<Object?>? _subscription;
-
   @override
   void initState() {
     super.initState();
@@ -44,8 +42,6 @@ class _BarcodeScannerWithControllerState
       case AppLifecycleState.resumed:
         unawaited(controller.start());
       case AppLifecycleState.inactive:
-        unawaited(_subscription?.cancel());
-        _subscription = null;
         unawaited(controller.stop());
     }
   }
@@ -96,8 +92,6 @@ class _BarcodeScannerWithControllerState
   @override
   Future<void> dispose() async {
     WidgetsBinding.instance.removeObserver(this);
-    unawaited(_subscription?.cancel());
-    _subscription = null;
     super.dispose();
     await controller.dispose();
   }

example/lib/barcode_scanner_window.dart

@@ -44,7 +44,7 @@ class _BarcodeScannerWithScanWindowState
             },
           ),
           BarcodeOverlay(controller: controller, boxFit: boxFit),
-          ScannerOverlay(
+          ScanWindowOverlay(
             scanWindow: scanWindow,
             controller: controller,
           ),

example/lib/mobile_scanner_overlay.dart

@@ -57,12 +57,14 @@ class _BarcodeScannerWithOverlayState extends State<BarcodeScannerWithOverlay> {
             builder: (context, value, child) {
               if (!value.isInitialized ||
                   !value.isRunning ||
-                  value.error != null) {
+                  value.error != null ||
+                  scanWindow.isEmpty) {
                 return const SizedBox();
               }
 
-              return CustomPaint(
-                painter: ScannerOverlay(scanWindow: scanWindow),
+              return ScanWindowOverlay(
+                controller: controller,
+                scanWindow: scanWindow,
               );
             },
           ),
@@ -90,67 +92,3 @@ class _BarcodeScannerWithOverlayState extends State<BarcodeScannerWithOverlay> {
     await controller.dispose();
   }
 }
-
-class ScannerOverlay extends CustomPainter {
-  const ScannerOverlay({
-    required this.scanWindow,
-    this.borderRadius = 12.0,
-  });
-
-  final Rect scanWindow;
-  final double borderRadius;
-
-  @override
-  void paint(Canvas canvas, Size size) {
-    // TODO: use `Offset.zero & size` instead of Rect.largest
-    // we need to pass the size to the custom paint widget
-    final backgroundPath = Path()..addRect(Rect.largest);
-
-    final cutoutPath = Path()
-      ..addRRect(
-        RRect.fromRectAndCorners(
-          scanWindow,
-          topLeft: Radius.circular(borderRadius),
-          topRight: Radius.circular(borderRadius),
-          bottomLeft: Radius.circular(borderRadius),
-          bottomRight: Radius.circular(borderRadius),
-        ),
-      );
-
-    final backgroundPaint = Paint()
-      ..color = Colors.black.withOpacity(0.5)
-      ..style = PaintingStyle.fill
-      ..blendMode = BlendMode.dstOut;
-
-    final backgroundWithCutout = Path.combine(
-      PathOperation.difference,
-      backgroundPath,
-      cutoutPath,
-    );
-
-    final borderPaint = Paint()
-      ..color = Colors.white
-      ..style = PaintingStyle.stroke
-      ..strokeWidth = 4.0;
-
-    final borderRect = RRect.fromRectAndCorners(
-      scanWindow,
-      topLeft: Radius.circular(borderRadius),
-      topRight: Radius.circular(borderRadius),
-      bottomLeft: Radius.circular(borderRadius),
-      bottomRight: Radius.circular(borderRadius),
-    );
-
-    // First, draw the background,
-    // with a cutout area that is a bit larger than the scan window.
-    // Finally, draw the scan window itself.
-    canvas.drawPath(backgroundWithCutout, backgroundPaint);
-    canvas.drawRRect(borderRect, borderPaint);
-  }
-
-  @override
-  bool shouldRepaint(ScannerOverlay oldDelegate) {
-    return scanWindow != oldDelegate.scanWindow ||
-        borderRadius != oldDelegate.borderRadius;
-  }
-}

lib/mobile_scanner.dart

@@ -29,5 +29,5 @@ export 'src/objects/url_bookmark.dart';
 export 'src/objects/wifi.dart';
 export 'src/overlay/barcode_overlay.dart';
 export 'src/overlay/barcode_painter.dart';
-export 'src/overlay/scanner_overlay.dart';
-export 'src/overlay/scanner_painter.dart';
+export 'src/overlay/scan_window_overlay.dart';
+export 'src/overlay/scan_window_painter.dart';

lib/src/enums/encryption_type.dart

@@ -14,11 +14,6 @@ enum EncryptionType {
 
   const EncryptionType(this.rawValue);
 
-  @Deprecated(
-    'EncryptionType.none is deprecated. Use EncryptionType.unknown instead.',
-  )
-  static const EncryptionType none = EncryptionType.unknown;
-
   factory EncryptionType.fromRawValue(int value) {
     switch (value) {
       case 0:

lib/src/method_channel/mobile_scanner_method_channel.dart

@@ -38,6 +38,7 @@ class MethodChannelMobileScanner extends MobileScannerPlatform {
 
   Stream<Map<Object?, Object?>>? _eventsStream;
 
+  /// Get the event stream of barcode events that come from the [eventChannel].
   Stream<Map<Object?, Object?>> get eventsStream {
     _eventsStream ??=
         eventChannel.receiveBroadcastStream().cast<Map<Object?, Object?>>();

lib/src/mobile_scanner_controller.dart

@@ -1,3 +1,6 @@
+/// @docImport 'package:mobile_scanner/src/mobile_scanner.dart';
+library;
+
 import 'dart:async';
 
 import 'package:flutter/widgets.dart';

lib/src/mobile_scanner_exception.dart

@@ -1,7 +1,12 @@
+/// @docImport 'package:flutter/services.dart';
+/// @docImport 'package:mobile_scanner/src/mobile_scanner_controller.dart';
+library;
+
 import 'package:mobile_scanner/src/enums/mobile_scanner_error_code.dart';
 
 /// This class represents an exception thrown by the [MobileScannerController].
 class MobileScannerException implements Exception {
+  /// Construct a new [MobileScannerException] instance.
   const MobileScannerException({
     required this.errorCode,
     this.errorDetails,
@@ -24,6 +29,7 @@ class MobileScannerException implements Exception {
 
 /// The raw error details for a [MobileScannerException].
 class MobileScannerErrorDetails {
+  /// Construct a new [MobileScannerErrorDetails] instance.
   const MobileScannerErrorDetails({
     this.code,
     this.details,

lib/src/mobile_scanner_view_attributes.dart

@@ -4,6 +4,7 @@ import 'package:mobile_scanner/src/enums/torch_state.dart';
 
 /// This class defines the attributes for the mobile scanner view.
 class MobileScannerViewAttributes {
+  /// Construct a new [MobileScannerViewAttributes] instance.
   const MobileScannerViewAttributes({
     required this.currentTorchMode,
     this.numberOfCameras,