Merge pull request #54 from yushulx/dev

Dev

Author: yushulx

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+* Added a `rotation` parameter to `decodeImageBuffer()` method.
+
 ## 3.0.5
 * Added `errorCode` and `errorMsg` properties to `BarcodeResult`.
 * Removed support for the macOS plugin.

README.md

@@ -1,28 +1,27 @@
 # 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**, 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.
+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 a wide range of barcode types such as **linear barcodes**, **QR Code**, **DataMatrix**, **MaxiCode**, **PDF417**, and more. This SDK encapsulates the low-level decoding capabilities of the Dynamsoft Barcode Reader, enabling barcode decoding from both **files and image buffers**. With this package, developers can effortlessly build robust **1D/2D barcode reader** and **scanner** apps. The project is actively maintained with contributions from the community.
 
-> **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.
+> **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), which offers better performance than combining the [Flutter camera plugin](https://pub.dev/packages/camera) with the Flutter Barcode SDK.
 
 ## **Table of Contents**
 1. [Getting a License Key](#getting-a-license-key)
 2. [Supported Platforms](#supported-platforms)
 3. [Supported Barcode Symbologies](#supported-barcode-symbologies)
 4. [Build Configuration](#build-configuration)
-5. [API Compatibility](#api-compatibility)
-6. [Usage](#usage)
-7. [Examples](#try-barcode-decoding-example)
+5. [API Reference](#api-reference)
+6. [Examples](#try-barcode-decoding-example)
 
 ## **Getting a License Key**
 [![](https://img.shields.io/badge/Get-30--day%20FREE%20Trial-blue)](https://www.dynamsoft.com/customer/license/trialLicense/?product=dcv&package=cross-platform)
 
 ## **Supported Platforms**
-- **Android**
-- **iOS**
-- **Windows**
-- **Linux**
-- **Web**
+- ✅ **Android**
+- ✅ **iOS**
+- ✅ **Windows**
+- ✅ **Linux**
+- ✅ **Web**
 
 ## **Supported Barcode Symbologies**
 ### **Linear Barcodes (1D)**
@@ -71,16 +70,14 @@ minSdkVersion 21
 ```
 
 ### iOS
-- Add camera usage descriptions to `ios/Runner/Info.plist`:
+Add camera usage descriptions to `ios/Runner/Info.plist`:
 
-    ```xml
-    <key>NSCameraUsageDescription</key>
-    <string>Can I use the camera please?</string>
-    <key>NSMicrophoneUsageDescription</key>
-    <string>Can I use the mic please?</string>
-    ```
-
-- Minimum deployment target: iOS 13.0 or later
+```xml
+<key>NSCameraUsageDescription</key>
+<string>Can I use the camera please?</string>
+<key>NSMicrophoneUsageDescription</key>
+<string>Can I use the mic please?</string>
+```
 
 ### Desktop
 
@@ -96,68 +93,17 @@ In `index.html`, include:
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/dcv.bundle.min.js"></script>
 ```
 
-## **API Compatibility**
-| 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:      | 
-
-## **Usage**
-- Initialize Flutter barcode SDK and set the license key:
-    
-  ```dart
-  _barcodeReader = FlutterBarcodeSdk();
-  await _barcodeReader.setLicense('LICENSE-KEY');
-  await _barcodeReader.init();
-  ```
-
-- Read barcodes from an image file:
-
-  ```dart
-  List<BarcodeResult> results = await _barcodeReader.decodeFile(image-path);
-  ```
-
-- Read barcodes from an image buffer:
-
-
-  ```dart
-  import 'dart:ui' as ui;
-  Uint8List fileBytes = await file.readAsBytes();
-  ui.Image image = await decodeImageFromList(fileBytes);
-
-  ByteData byteData = await image.toByteData(
-      format: ui.ImageByteFormat.rawRgba);
-  List<BarcodeResult> results =
-      await _barcodeReader.decodeImageBuffer(
-          byteData.buffer.asUint8List(),
-          image.width,
-          image.height,
-          byteData.lengthInBytes ~/ image.height,
-          ImagePixelFormat.IPF_ARGB_8888.index);
-  ```
-
-- Set barcode formats:
-
-  ```dart
-  int ret = await _barcodeReader.setBarcodeFormats(BarcodeFormat.CODE_39 | BarcodeFormat.CODABAR | BarcodeFormat.QR_CODE | BarcodeFormat.DATAMATRIX);
-  ```
-
-- Get current barcode detection parameters:
-    
-  ```dart
-  String params = await _barcodeReader.getParameters();
-  ```
-
-- Set barcode detection parameters:
-    
-  ```dart
-  int ret = await _barcodeReader.setParameters(params);
-  ```
+## API Reference
+| Method                                                                                                                        | Description                                                                             | Parameters                                                                                                                                                                                    | Return Type                   |
+| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
+| `Future<int> setLicense(String license)`                                                                                      | Sets the Dynamsoft Barcode Reader license key.                                          | `license`: The license key string.                                                                                                                                                            | `Future<int>`                 |
+| `Future<int> init()`                                                                                                          | Initializes the barcode reader and applies default parameters for the current platform. | —                                                                                                                                                                                             | `Future<int>`                 |
+| `Future<List<BarcodeResult>> decodeFile(String filename)`                                                                     | Decodes barcodes from an image file.                                                    | `filename`: Path to the image file.                                                                                                                                                           | `Future<List<BarcodeResult>>` |
+| `Future<List<BarcodeResult>> decodeImageBuffer(Uint8List bytes, int width, int height, int stride, int format, int rotation)` | Decodes barcodes from a raw image buffer (for real-time or camera preview scanning).    | `bytes`: Image buffer (raw bytes)<br>`width`: Image width<br>`height`: Image height<br>`stride`: Bytes per row<br>`format`: Pixel format (see `ImagePixelFormat`)<br>`rotation`: 0/90/180/270 | `Future<List<BarcodeResult>>` |
+| `Future<int> setBarcodeFormats(int formats)`                                                                                  | Sets the barcode formats to be detected.                                                | `formats`: Bitwise combination of barcode formats (see `BarcodeFormat`).                                                                                                                      | `Future<int>`                 |
+| `Future<String> getParameters()`                                                                                              | Retrieves the current barcode detection settings as a JSON string.                      | —                                                                                                                                                                                             | `Future<String>`              |
+| `Future<int> setParameters(String params)`                                                                                    | Updates barcode detection parameters with a JSON string.                                | `params`: JSON string of detection parameters.                                                                                                                                                | `Future<int>`                 |
+
 
 
 ## Try Barcode Reader & Scanner Examples

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

@@ -134,7 +134,7 @@ public List<Map<String, Object>> decodeFileBytes(byte[] bytes) {
         return ret;
     }
 
-    public List<Map<String, Object>> decodeImageBuffer(byte[] bytes, int width, int height, int stride, int format) {
+    public List<Map<String, Object>> decodeImageBuffer(byte[] bytes, int width, int height, int stride, int format, int rotation) {
         List<Map<String, Object>> ret = new ArrayList<Map<String, Object>>();
         try {
             ImageData imageData = new ImageData();
@@ -143,6 +143,7 @@ public List<Map<String, Object>> decodeImageBuffer(byte[] bytes, int width, int
             imageData.height = height;
             imageData.stride = stride;
             imageData.format = format;
+            imageData.orientation = rotation;
             CapturedResult results = mRouter.capture(imageData, "");
             int errorCode = results.getErrorCode();
             String errorMsg = results.getErrorMessage();

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

@@ -79,11 +79,12 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
                 final int height = call.argument("height");
                 final int stride = call.argument("stride");
                 final int format = call.argument("format");
+                final int rotation = call.argument("rotation");
                 final Result r = result;
                 mExecutor.execute(new Runnable() {
                     @Override
                     public void run() {
-                        final List<Map<String, Object>> results = mBarcodeManager.decodeImageBuffer(bytes, width, height, stride, format);
+                        final List<Map<String, Object>> results = mBarcodeManager.decodeImageBuffer(bytes, width, height, stride, format, rotation);
                         mHandler.post(new Runnable() {
                             @Override
                             public void run() {

example/ios/Podfile.lock

@@ -4,8 +4,6 @@ PODS:
   - DynamsoftBarcodeReaderBundle (11.0.3000):
     - DynamsoftCaptureVisionBundle (= 3.0.3000)
   - DynamsoftCaptureVisionBundle (3.0.3000)
-  - file_selector_ios (0.0.1):
-    - Flutter
   - Flutter (1.0.0)
   - flutter_barcode_sdk (3.0.0):
     - DynamsoftBarcodeReaderBundle (= 11.0.3000)
@@ -18,7 +16,6 @@ PODS:
 
 DEPENDENCIES:
   - camera_avfoundation (from `.symlinks/plugins/camera_avfoundation/ios`)
-  - file_selector_ios (from `.symlinks/plugins/file_selector_ios/ios`)
   - Flutter (from `Flutter`)
   - flutter_barcode_sdk (from `.symlinks/plugins/flutter_barcode_sdk/ios`)
   - image_picker_ios (from `.symlinks/plugins/image_picker_ios/ios`)
@@ -32,8 +29,6 @@ SPEC REPOS:
 EXTERNAL SOURCES:
   camera_avfoundation:
     :path: ".symlinks/plugins/camera_avfoundation/ios"
-  file_selector_ios:
-    :path: ".symlinks/plugins/file_selector_ios/ios"
   Flutter:
     :path: Flutter
   flutter_barcode_sdk:
@@ -47,7 +42,6 @@ SPEC CHECKSUMS:
   camera_avfoundation: be3be85408cd4126f250386828e9b1dfa40ab436
   DynamsoftBarcodeReaderBundle: 578c27daeda029a5a5aeb0fdda63dddb3fc5fc29
   DynamsoftCaptureVisionBundle: 1935e3efc70db1b7c6cab19dfe420c3e43dbe1a0
-  file_selector_ios: f92e583d43608aebc2e4a18daac30b8902845502
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
   flutter_barcode_sdk: 82cec9bdb0d4e88b81c4ff1351a82dda6a9f9acb
   image_picker_ios: 7fe1ff8e34c1790d6fff70a32484959f563a928a

example/lib/desktop.dart

@@ -137,12 +137,12 @@ class _DesktopState extends State<Desktop> {
 
     isDecoding = true;
     _barcodeResultsList = await _barcodeReader.decodeImageBuffer(
-      rgb,
-      width,
-      height,
-      width * 3,
-      ImagePixelFormat.IPF_RGB_888.index,
-    );
+        rgb,
+        width,
+        height,
+        width * 3,
+        ImagePixelFormat.IPF_RGB_888.index,
+        ImageRotation.rotation0.value);
 
     // _barcodeResults = getBarcodeResults(_barcodeResultsList);
 

example/lib/mobile.dart

@@ -137,6 +137,14 @@ class MobileState extends State<Mobile> with WidgetsBindingObserver {
           defaultTargetPlatform == TargetPlatform.iOS);
       int format = ImagePixelFormat.IPF_NV21.index;
 
+      int rotation = 0;
+      if (MediaQuery.of(context).size.width <
+          MediaQuery.of(context).size.height) {
+        if (Platform.isAndroid) {
+          rotation = ImageRotation.rotation90.value;
+        }
+      }
+
       switch (availableImage.format.group) {
         case ImageFormatGroup.yuv420:
           format = ImagePixelFormat.IPF_NV21.index;
@@ -160,13 +168,14 @@ class MobileState extends State<Mobile> with WidgetsBindingObserver {
               availableImage.width,
               availableImage.height,
               availableImage.planes[0].bytesPerRow,
-              format)
+              format,
+              rotation)
           .then((results) {
         if (_isScanRunning) {
           _results = results;
-          if (Platform.isAndroid && results.isNotEmpty) {
-            _results = rotate90barcode(_results, _previewSize.height.toInt());
-          }
+          // if (Platform.isAndroid && results.isNotEmpty) {
+          //   _results = rotate90barcode(_results, _previewSize_previewSize.height.toInt());
+          // }
           setState(() {});
         }
 
@@ -237,8 +246,14 @@ class MobileState extends State<Mobile> with WidgetsBindingObserver {
                         'images/default.png',
                       )
                     : SizedBox(
-                        width: _previewSize.height,
-                        height: _previewSize.width,
+                        width: MediaQuery.of(context).size.width <
+                                MediaQuery.of(context).size.height
+                            ? _previewSize.height
+                            : _previewSize.width,
+                        height: MediaQuery.of(context).size.width <
+                                MediaQuery.of(context).size.height
+                            ? _previewSize.width
+                            : _previewSize.height,
                         child: CameraPreview(
                           _controller!,
                         )),

example/lib/web.dart

@@ -102,7 +102,8 @@ class _WebState extends State<Web> {
               image.width,
               image.height,
               byteData.lengthInBytes ~/ image.height,
-              ImagePixelFormat.IPF_ARGB_8888.index);
+              ImagePixelFormat.IPF_ARGB_8888.index,
+              ImageRotation.rotation0.value);
         }
 
         updateResults(_barcodeResultsList);

example/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -6,13 +6,11 @@ import FlutterMacOS
 import Foundation
 
 import file_selector_macos
-import flutter_barcode_sdk
 import flutter_lite_camera
 import path_provider_foundation
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
   FileSelectorPlugin.register(with: registry.registrar(forPlugin: "FileSelectorPlugin"))
-  FlutterBarcodeSdkPlugin.register(with: registry.registrar(forPlugin: "FlutterBarcodeSdkPlugin"))
   FlutterLiteCameraPlugin.register(with: registry.registrar(forPlugin: "FlutterLiteCameraPlugin"))
   PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
 }