fix: support formats for analyze image

CHANGELOG.md

@@ -1,3 +1,10 @@
+## NEXT
+
+* [MacOS] Added the corners and size information to barcode results.
+* [MacOS] Added support for `analyzeImage`.
+* [web] Added the size information to barcode results.
+* Added support for barcode formats to image analysis.
+
 ## 5.2.3
 
 Deprecations:

README.md

@@ -35,8 +35,8 @@ See the example app for detailed implementation information.
 
 | Features               | Android            | iOS                | macOS                | Web |
 |------------------------|--------------------|--------------------|----------------------|-----|
-| analyzeImage (Gallery) | :heavy_check_mark: | :heavy_check_mark: | :x:                  | :x: |
-| returnImage            | :heavy_check_mark: | :heavy_check_mark: | :x:                  | :x: |
+| analyzeImage (Gallery) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:   | :x: |
+| returnImage            | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:   | :x: |
 | scanWindow             | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:   | :x: |
 
 ## Platform Support
@@ -83,8 +83,8 @@ Ensure that you granted camera permission in XCode -> Signing & Capabilities:
 
 ## Web
 
-As of version 5.0.0 adding the library to the `index.html` is no longer required,
-as the library is automatically loaded on first use.
+As of version 5.0.0 adding the barcode scanning library script to the `index.html` is no longer required,
+as the script is automatically loaded on first use.
 
 ### Providing a mirror for the barcode scanning library
 

android/build.gradle

@@ -67,7 +67,7 @@ dependencies {
     def useUnbundled = project.findProperty('dev.steenbakker.mobile_scanner.useUnbundled') ?: false
     if (useUnbundled.toBoolean()) {
         // Dynamically downloaded model via Google Play Services
-        implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.0'
+        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'
@@ -77,8 +77,8 @@ dependencies {
     // See: https://youtrack.jetbrains.com/issue/KT-55297/kotlin-stdlib-should-declare-constraints-on-kotlin-stdlib-jdk8-and-kotlin-stdlib-jdk7
     implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.22"))
 
-    implementation 'androidx.camera:camera-lifecycle:1.3.3'
-    implementation 'androidx.camera:camera-camera2:1.3.3'
+    implementation 'androidx.camera:camera-lifecycle:1.3.4'
+    implementation 'androidx.camera:camera-camera2:1.3.4'
 
     testImplementation 'org.jetbrains.kotlin:kotlin-test'
     testImplementation 'org.mockito:mockito-core:5.12.0'    

android/src/main/kotlin/dev/steenbakker/mobile_scanner/MobileScannerHandler.kt

@@ -151,28 +151,16 @@ class MobileScannerHandler(
             null
         }
 
-        var barcodeScannerOptions: BarcodeScannerOptions? = null
-        if (formats != null) {
-            val formatsList: MutableList<Int> = mutableListOf()
-            for (formatValue in formats) {
-                formatsList.add(BarcodeFormats.fromRawValue(formatValue).intValue)
-            }
-            barcodeScannerOptions = if (formatsList.size == 1) {
-                BarcodeScannerOptions.Builder().setBarcodeFormats(formatsList.first())
-                    .build()
-            } else {
-                BarcodeScannerOptions.Builder().setBarcodeFormats(
-                    formatsList.first(),
-                    *formatsList.subList(1, formatsList.size).toIntArray()
-                ).build()
-            }
-        }
+        val barcodeScannerOptions: BarcodeScannerOptions? = buildBarcodeScannerOptions(formats)
 
         val position =
             if (facing == 0) CameraSelector.DEFAULT_FRONT_CAMERA else CameraSelector.DEFAULT_BACK_CAMERA
 
-        val detectionSpeed: DetectionSpeed = if (speed == 0) DetectionSpeed.NO_DUPLICATES
-        else if (speed ==1) DetectionSpeed.NORMAL else DetectionSpeed.UNRESTRICTED
+        val detectionSpeed: DetectionSpeed = when (speed) {
+            0 -> DetectionSpeed.NO_DUPLICATES
+            1 -> DetectionSpeed.NORMAL
+            else -> DetectionSpeed.UNRESTRICTED
+        }
 
         mobileScanner!!.start(
             barcodeScannerOptions,
@@ -243,13 +231,13 @@ class MobileScannerHandler(
 
     private fun analyzeImage(call: MethodCall, result: MethodChannel.Result) {
         analyzerResult = result
-        val uri = Uri.fromFile(File(call.arguments.toString()))
 
-        // TODO: parse options from the method call
-        // See https://github.com/juliansteenbakker/mobile_scanner/issues/1069
+        val formats: List<Int>? = call.argument<List<Int>>("formats")
+        val filePath: String = call.argument<String>("filePath")!!
+
         mobileScanner!!.analyzeImage(
-            uri,
-            null,
+            Uri.fromFile(File(filePath)),
+            buildBarcodeScannerOptions(formats),
             analyzeImageSuccessCallback,
             analyzeImageErrorCallback)
     }
@@ -284,4 +272,26 @@ class MobileScannerHandler(
 
         result.success(null)
     }
+
+    private fun buildBarcodeScannerOptions(formats: List<Int>?): BarcodeScannerOptions? {
+        if (formats == null) {
+            return null
+        }
+
+        val formatsList: MutableList<Int> = mutableListOf()
+
+        for (formatValue in formats) {
+            formatsList.add(BarcodeFormats.fromRawValue(formatValue).intValue)
+        }
+
+        if (formatsList.size == 1) {
+            return BarcodeScannerOptions.Builder().setBarcodeFormats(formatsList.first())
+                .build()
+        }
+
+        return BarcodeScannerOptions.Builder().setBarcodeFormats(
+            formatsList.first(),
+            *formatsList.subList(1, formatsList.size).toIntArray()
+        ).build()
+    }
 }

example/lib/barcode_scanner_analyze_image.dart

@@ -0,0 +1,76 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:image_picker/image_picker.dart';
+import 'package:mobile_scanner/mobile_scanner.dart';
+
+class BarcodeScannerAnalyzeImage extends StatefulWidget {
+  const BarcodeScannerAnalyzeImage({super.key});
+
+  @override
+  State<BarcodeScannerAnalyzeImage> createState() =>
+      _BarcodeScannerAnalyzeImageState();
+}
+
+class _BarcodeScannerAnalyzeImageState
+    extends State<BarcodeScannerAnalyzeImage> {
+  final MobileScannerController _controller = MobileScannerController();
+
+  BarcodeCapture? _barcodeCapture;
+
+  Future<void> _analyzeImageFromFile() async {
+    try {
+      final XFile? file =
+          await ImagePicker().pickImage(source: ImageSource.gallery);
+
+      if (!mounted || file == null) {
+        return;
+      }
+
+      final BarcodeCapture? barcodeCapture =
+          await _controller.analyzeImage(file.path);
+
+      if (mounted) {
+        setState(() {
+          _barcodeCapture = barcodeCapture;
+        });
+      }
+    } catch (_) {}
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    Widget label = const Text('Pick a file to detect barcode');
+
+    if (_barcodeCapture != null) {
+      label = Text(
+        _barcodeCapture?.barcodes.firstOrNull?.displayValue ??
+            'No barcode detected',
+      );
+    }
+
+    return Scaffold(
+      appBar: AppBar(title: const Text('Analyze image from file')),
+      body: Column(
+        children: [
+          Expanded(
+            child: Center(
+              child: ElevatedButton(
+                onPressed: kIsWeb ? null : _analyzeImageFromFile,
+                child: kIsWeb
+                    ? const Text('Analyze image is not supported on web')
+                    : const Text('Choose file'),
+              ),
+            ),
+          ),
+          Expanded(child: Center(child: label)),
+        ],
+      ),
+    );
+  }
+
+  @override
+  void dispose() {
+    _controller.dispose();
+    super.dispose();
+  }
+}

example/lib/barcode_scanner_window.dart

@@ -39,16 +39,16 @@ class _BarcodeScannerWithScanWindowState
             final scannedBarcode = barcodeCapture.barcodes.first;
 
             // No barcode corners, or size, or no camera preview size.
-            if (scannedBarcode.corners.isEmpty ||
-                value.size.isEmpty ||
-                barcodeCapture.size.isEmpty) {
+            if (value.size.isEmpty ||
+                scannedBarcode.size.isEmpty ||
+                scannedBarcode.corners.isEmpty) {
               return const SizedBox();
             }
 
             return CustomPaint(
               painter: BarcodeOverlay(
                 barcodeCorners: scannedBarcode.corners,
-                barcodeSize: barcodeCapture.size,
+                barcodeSize: scannedBarcode.size,
                 boxFit: BoxFit.contain,
                 cameraPreviewSize: value.size,
               ),

example/lib/main.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:mobile_scanner_example/barcode_scanner_analyze_image.dart';
 import 'package:mobile_scanner_example/barcode_scanner_controller.dart';
 import 'package:mobile_scanner_example/barcode_scanner_listview.dart';
 import 'package:mobile_scanner_example/barcode_scanner_pageview.dart';
@@ -20,95 +21,75 @@ void main() {
 class MyHome extends StatelessWidget {
   const MyHome({super.key});
 
+  Widget _buildItem(BuildContext context, String label, Widget page) {
+    return Padding(
+      padding: const EdgeInsets.all(8.0),
+      child: Center(
+        child: ElevatedButton(
+          onPressed: () {
+            Navigator.of(context).push(
+              MaterialPageRoute(
+                builder: (context) => page,
+              ),
+            );
+          },
+          child: Text(label),
+        ),
+      ),
+    );
+  }
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
       appBar: AppBar(title: const Text('Mobile Scanner Example')),
       body: Center(
-        child: Column(
-          mainAxisAlignment: MainAxisAlignment.spaceAround,
+        child: ListView(
           children: [
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerSimple(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner Simple'),
+            _buildItem(
+              context,
+              'MobileScanner Simple',
+              const BarcodeScannerSimple(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerListView(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner with ListView'),
+            _buildItem(
+              context,
+              'MobileScanner with ListView',
+              const BarcodeScannerListView(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerWithController(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner with Controller'),
+            _buildItem(
+              context,
+              'MobileScanner with Controller',
+              const BarcodeScannerWithController(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerWithScanWindow(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner with ScanWindow'),
+            _buildItem(
+              context,
+              'MobileScanner with ScanWindow',
+              const BarcodeScannerWithScanWindow(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerReturningImage(),
-                  ),
-                );
-              },
-              child: const Text(
-                'MobileScanner with Controller (returning image)',
-              ),
+            _buildItem(
+              context,
+              'MobileScanner with Controller (return image)',
+              const BarcodeScannerReturningImage(),
+            ),
+            _buildItem(
+              context,
+              'MobileScanner with zoom slider',
+              const BarcodeScannerWithZoom(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerWithZoom(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner with zoom slider'),
+            _buildItem(
+              context,
+              'MobileScanner with PageView',
+              const BarcodeScannerPageView(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => const BarcodeScannerPageView(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner pageView'),
+            _buildItem(
+              context,
+              'MobileScanner with Overlay',
+              const BarcodeScannerWithOverlay(),
             ),
-            ElevatedButton(
-              onPressed: () {
-                Navigator.of(context).push(
-                  MaterialPageRoute(
-                    builder: (context) => BarcodeScannerWithOverlay(),
-                  ),
-                );
-              },
-              child: const Text('MobileScanner with Overlay'),
+            _buildItem(
+              context,
+              'Analyze image from file',
+              const BarcodeScannerAnalyzeImage(),
             ),
           ],
         ),

example/lib/mobile_scanner_overlay.dart

@@ -5,6 +5,8 @@ import 'package:mobile_scanner_example/scanner_button_widgets.dart';
 import 'package:mobile_scanner_example/scanner_error_widget.dart';
 
 class BarcodeScannerWithOverlay extends StatefulWidget {
+  const BarcodeScannerWithOverlay({super.key});
+
   @override
   _BarcodeScannerWithOverlayState createState() =>
       _BarcodeScannerWithOverlayState();