Merge pull request #53 from yushulx/dev

Dev

Author: yushulx

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.0.5
+* Added `errorCode` and `errorMsg` properties to `BarcodeResult`.
+* Removed support for the macOS plugin.
+
 ## 3.0.4
 * Updated SDKs for Android and iOS.
 

README.md

@@ -1,7 +1,7 @@
 # flutter_barcode_sdk
 ![pub.dev](https://img.shields.io/pub/v/flutter_barcode_sdk.svg)
 
-The **Flutter Barcode SDK** is a wrapper for the [Dynamsoft Barcode Reader SDK](https://www.dynamsoft.com/barcode-reader/overview/). It supports multiple platforms, including **Android**, **iOS**, **Web**, **Windows**, **Linux** and **macOS**, and can decode various barcode types such as linear barcodes, QR Code, DataMatrix, MaxiCode, PDF417, and more. This SDK encapsulates the low-level decoding functions of the Dynamsoft Barcode Reader, enabling both file and image buffer decoding. It empowers developers to effortlessly build 1D/2D barcode readers and scanners. The project is actively maintained by community contributors.
+The **Flutter Barcode SDK** is a wrapper for the [Dynamsoft Barcode Reader SDK](https://www.dynamsoft.com/barcode-reader/overview/). It supports multiple platforms, including **Android**, **iOS**, **Web**, **Windows**, and **Linux**, and can decode various barcode types such as linear barcodes, QR Code, DataMatrix, MaxiCode, PDF417, and more. This SDK encapsulates the low-level decoding functions of the Dynamsoft Barcode Reader, enabling both file and image buffer decoding. It empowers developers to effortlessly build 1D/2D barcode readers and scanners. The project is actively maintained by community contributors.
 
 > **Note:** For live camera scenarios, it is recommended to use the official [Dynamsoft Capture Vision Flutter Edition](https://pub.dev/packages/dynamsoft_capture_vision_flutter), as it offers better performance than combining the [Flutter camera plugin](https://pub.dev/packages/camera) with the Flutter Barcode SDK.
 
@@ -22,7 +22,6 @@ The **Flutter Barcode SDK** is a wrapper for the [Dynamsoft Barcode Reader SDK](
 - **iOS**
 - **Windows**
 - **Linux**
-- **macOS**
 - **Web**
 
 ## **Supported Barcode Symbologies**
@@ -89,36 +88,6 @@ minSdkVersion 21
 
 Install `CMake` and `platform-specific C++ compiler`.
 
-**macOS**
-
-Install `Xcode`.
-
-To make the demo app work on macOS:
-- Disable `com.apple.security.app-sandbox` and enable `com.apple.security.files.user-selected.read-write` in `example/macos/Runner/DebugProfile.entitlements`:
-    
-  ```xml
-  <?xml version="1.0" encoding="UTF-8"?>
-  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-  <plist version="1.0">
-  <dict>
-    <key>com.apple.security.app-sandbox</key>
-    <false/>
-    <key>com.apple.security.cs.allow-jit</key>
-    <true/>
-    <key>com.apple.security.network.server</key>
-    <true/>
-    <key>com.apple.security.files.user-selected.read-write</key>
-    <true/>
-  </dict>
-  </plist>
-  ```    
-
-- If `DCV` package is not found, run the command:
-
-  ```bash
-  pod repo add master https://github.com/CocoaPods/Specs
-  ```
-  The command manually adds the CocoaPods `master` spec repository to the local machine to resolve the issue.
 
 ### Web
 In `index.html`, include:
@@ -128,15 +97,15 @@ In `index.html`, include:
 ```
 
 ## **API Compatibility**
-| Methods      | Android |    iOS | Windows | Linux | macOS | Web|
-| ----------- | ----------- | ----------- | ----------- |----------- |----------- |----------- |
-| `Future<void> setLicense(String license) async`     | :heavy_check_mark:       | :heavy_check_mark:   | :heavy_check_mark:      | :heavy_check_mark:      |:heavy_check_mark:      | :heavy_check_mark:    |
-| `Future<List<BarcodeResult>> decodeFile(String filename) async`     | :heavy_check_mark:      | :heavy_check_mark:   | :heavy_check_mark:      |:heavy_check_mark:      | :heavy_check_mark:     |:heavy_check_mark:      |
-| `Future<List<BarcodeResult>> decodeImageBuffer(Uint8List bytes, int width, int height, int stride, int format) async`     | :heavy_check_mark:      | :heavy_check_mark:   | :heavy_check_mark:      |:heavy_check_mark:      | :heavy_check_mark:     |:heavy_check_mark:    |
-| `Future<int> setBarcodeFormats(int formats) async`     | :heavy_check_mark:       | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:       |:heavy_check_mark:      | :heavy_check_mark:     |
-| `Future<String> getParameters() async`     | :heavy_check_mark:         | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:        |:heavy_check_mark:       | :heavy_check_mark:     |
+| Methods      | Android |    iOS | Windows | Linux | Web|
+| ----------- | ----------- | ----------- | ----------- |----------- |----------- |
+| `Future<void> setLicense(String license) async`     | :heavy_check_mark:       | :heavy_check_mark:   | :heavy_check_mark:      | :heavy_check_mark:      |:heavy_check_mark:      | 
+| `Future<List<BarcodeResult>> decodeFile(String filename) async`     | :heavy_check_mark:      | :heavy_check_mark:   | :heavy_check_mark:      |:heavy_check_mark:      | :heavy_check_mark:     |
+| `Future<List<BarcodeResult>> decodeImageBuffer(Uint8List bytes, int width, int height, int stride, int format) async`     | :heavy_check_mark:      | :heavy_check_mark:   | :heavy_check_mark:      | :heavy_check_mark:     |:heavy_check_mark:    |
+| `Future<int> setBarcodeFormats(int formats) async`     | :heavy_check_mark:       | :heavy_check_mark:       | :heavy_check_mark:       |:heavy_check_mark:      | :heavy_check_mark:     |
+| `Future<String> getParameters() async`     | :heavy_check_mark:         | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:        |:heavy_check_mark:       | 
 | `Future<int> setParameters(String params)` async | :heavy_check_mark:         |:heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:        |:heavy_check_mark:      | :heavy_check_mark:     |
-| `Future<void> init()` async | :heavy_check_mark:         |:heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:        |:heavy_check_mark:      | :heavy_check_mark:     |
+| `Future<void> init()` async | :heavy_check_mark:         |:heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark:        |:heavy_check_mark:      | 
 
 ## **Usage**
 - Initialize Flutter barcode SDK and set the license key:
@@ -191,14 +160,14 @@ In `index.html`, include:
   ```
 
 
-## **Try Barcode Decoding Example**
+## Try Barcode Reader & Scanner Examples
 
 ### Android/iOS
 The example demonstrates how to use the Flutter Barcode SDK to read barcodes from an image file and decode the barcode image buffer from the camera stream on Android and iOS.
 
 ```
 cd example
-flutter run -d <device>
+flutter run 
 ```
 
 - **Barcode Scanner**
@@ -210,8 +179,8 @@ flutter run -d <device>
     ![flutter barcode reader](https://www.dynamsoft.com/codepool/img/2025/01/flutter-android-barcode-image-detection.jpg)
 
 
-### Windows, Linux and macOS
-Run the desktop barcode reader and scanner application on Windows, Linux or macOS:
+### Windows & Linux 
+Run the desktop barcode reader and scanner application on Windows or Linux:
 
 ```bash
 cd example
@@ -220,21 +189,10 @@ flutter run -d windows
 
 # Linux
 flutter run -d linux
-
-# macOS
-flutter run -d macos
 ```
 
-- **Barcode Reader**
-
-    ![flutter desktop barcode reader](https://www.dynamsoft.com/codepool/img/2025/01/flutter-barcode-reader-windows-linux-macos.png)
-
-- **Barcode Scanner**
-
-    ![flutter desktop barcode scanner](https://www.dynamsoft.com/codepool/img/2025/01/flutter-barcode-scanner-windows-linux-macos.png)
-
 
-### Web Browser
+### Web Barcode Scanner
 
 ```bash
 cd example

android/src/main/java/com/dynamsoft/flutter_barcode_sdk/BarcodeManager.java

@@ -5,6 +5,7 @@
 import android.graphics.BitmapFactory;
 import android.graphics.Point;
 
+import com.dynamsoft.core.basic_structures.EnumCapturedResultItemType;
 import com.dynamsoft.cvr.CapturedResult;
 import com.dynamsoft.core.basic_structures.CapturedResultItem;
 import com.dynamsoft.cvr.CaptureVisionRouter;
@@ -24,10 +25,29 @@ public class BarcodeManager {
     private static final String TAG = "DynamsoftBarcodeReader";
     private CaptureVisionRouter mRouter;
 
+    private void wrapError(List<Map<String, Object>> out, int errorCode, String errorMsg) {
+        Map<String, Object> data = new HashMap<>();
+        data.put("format", "");
+        data.put("text", "");
+        data.put("x1", 0);
+        data.put("y1", 0);
+        data.put("x2", 0);
+        data.put("y2", 0);
+        data.put("x3", 0);
+        data.put("y3", 0);
+        data.put("x4", 0);
+        data.put("y4", 0);
+        data.put("angle", 0);
+        data.put("barcodeBytes", new byte[0]);
+        data.put("errorCode", errorCode);
+        data.put("errorMsg", errorMsg);
+        out.add(data);
+    }
 
     private void wrapResults(CapturedResult result, List<Map<String, Object>> out) {
         CapturedResultItem[] items = result.getItems();
         for (CapturedResultItem item : items) {
+            if (item.getType() != EnumCapturedResultItemType.CRIT_BARCODE) continue;
             Map<String, Object> data = new HashMap<>();
             BarcodeResultItem barcodeItem = (BarcodeResultItem)item;
             data.put("format", barcodeItem.getFormatString());
@@ -43,6 +63,8 @@ private void wrapResults(CapturedResult result, List<Map<String, Object>> out) {
             data.put("y4", points[3].y);
             data.put("angle", barcodeItem.getAngle());
             data.put("barcodeBytes", barcodeItem.getBytes());
+            data.put("errorCode", 0);
+            data.put("errorMsg", "");
             out.add(data);
         }
     }
@@ -75,7 +97,16 @@ public List<Map<String, Object>> decodeFile(String filename) {
         List<Map<String, Object>> ret = new ArrayList<Map<String, Object>>();
         try {
             CapturedResult results = mRouter.capture(filename, "");
-            wrapResults(results, ret);
+            int errorCode = results.getErrorCode();
+            String errorMsg = results.getErrorMessage();
+
+            if (errorCode != 0) {
+                wrapError(ret, errorCode, errorMsg);
+            }
+            else {
+                wrapResults(results, ret);
+            }
+
         } catch (Exception e) {
             e.printStackTrace();
         }
@@ -88,7 +119,15 @@ public List<Map<String, Object>> decodeFileBytes(byte[] bytes) {
         Bitmap bitmap = BitmapFactory.decodeByteArray(bytes, 0, bytes != null ? bytes.length : 0);
         try {
             CapturedResult results = mRouter.capture(bitmap, "");
-            wrapResults(results, ret);
+            int errorCode = results.getErrorCode();
+            String errorMsg = results.getErrorMessage();
+
+            if (errorCode != 0) {
+                wrapError(ret, errorCode, errorMsg);
+            }
+            else {
+                wrapResults(results, ret);
+            }
         } catch (Exception e) {
             e.printStackTrace();
         }
@@ -105,7 +144,15 @@ public List<Map<String, Object>> decodeImageBuffer(byte[] bytes, int width, int
             imageData.stride = stride;
             imageData.format = format;
             CapturedResult results = mRouter.capture(imageData, "");
-            wrapResults(results, ret);
+            int errorCode = results.getErrorCode();
+            String errorMsg = results.getErrorMessage();
+
+            if (errorCode != 0) {
+                wrapError(ret, errorCode, errorMsg);
+            }
+            else {
+                wrapResults(results, ret);
+            }
         } catch (Exception e) {
             e.printStackTrace();
         }
@@ -115,8 +162,11 @@ public List<Map<String, Object>> decodeImageBuffer(byte[] bytes, int width, int
     public int setBarcodeFormats(int formats) {
         try {
             SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings("");
-            settings.barcodeSettings.barcodeFormatIds = formats;
-            mRouter.updateSettings("", settings);
+            if (settings.barcodeSettings != null) {
+                settings.barcodeSettings.barcodeFormatIds = formats;
+                mRouter.updateSettings("", settings);
+            }
+
             return 0;
         } catch (Exception e) {
             e.printStackTrace();

example/lib/mobile.dart

@@ -101,6 +101,8 @@ class MobileState extends State<Mobile> with WidgetsBindingObserver {
       int y2 = result.y2;
       int y3 = result.y3;
       int y4 = result.y4;
+      int errorCode = result.errorCode;
+      String errorMsg = result.errorMsg;
 
       BarcodeResult newResult = BarcodeResult(
           result.format,
@@ -114,7 +116,9 @@ class MobileState extends State<Mobile> with WidgetsBindingObserver {
           height - y4,
           x4,
           result.angle,
-          result.barcodeBytes);
+          result.barcodeBytes,
+          errorCode,
+          errorMsg);
 
       output.add(newResult);
     }

example/lib/overlay_painter.dart

@@ -20,6 +20,7 @@ class OverlayPainter extends CustomPainter {
       ..style = PaintingStyle.stroke;
 
     for (var result in results) {
+      print(result.toJson());
       double minX = result.x1.toDouble();
       double minY = result.y1.toDouble();
       if (result.x2 < minX) minX = result.x2.toDouble();