Switch to a new MLKit library which runs on-device

rushio-consulting · Dec 6, 2021 · 7badd21 · 7badd21
1 parent 502409a
commit 7badd21
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 145 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,10 @@ First, add `flutter_camera_ml_vision` as a dependency.
 dependencies:
   flutter:
     sdk: flutter
-  flutter_camera_ml_vision: ^2.2.4
+  flutter_camera_ml_vision: ^3.0.1
 ...
 ```
 
-## Configure Firebase
-You must also configure Firebase for each platform project: Android and iOS (see the `example` folder or https://firebase.google.com/codelabs/firebase-get-to-know-flutter#3 for step by step details).
-
-
 ### iOS
 
 Add two rows to the ios/Runner/Info.plist:
@@ -42,10 +38,10 @@ Or in text format add the key:
 If you're using one of the on-device APIs, include the corresponding ML Kit library model in your Podfile. Then run pod update in a terminal within the same directory as your Podfile.
 
 ```
-pod 'Firebase/MLVisionBarcodeModel'
-pod 'Firebase/MLVisionFaceModel'
-pod 'Firebase/MLVisionLabelModel'
-pod 'Firebase/MLVisionTextModel'
+pod 'GoogleMLKit/BarcodeScanning'
+pod 'GoogleMLKit/FaceDetection'
+pod 'GoogleMLKit/ImageLabeling'
+pod 'GoogleMLKit/TextRecognition'
 ```
 
 ### Android
@@ -65,7 +61,7 @@ android {
     dependencies {
         // ...
 
-        api 'com.google.firebase:firebase-ml-vision-image-label-model:19.0.0'
+        api 'com.google.mlkit:image-labeling:17.0.5'
     }
 }
 ```
@@ -78,7 +74,7 @@ Optional but recommended: If you use the on-device API, configure your app to au
 <application ...>
   ...
   <meta-data
-    android:name="com.google.firebase.ml.vision.DEPENDENCIES"
+    android:name="com.google.mlkit.vision.DEPENDENCIES"
     android:value="ocr" />
   <!-- To use multiple models: android:value="ocr,label,barcode,face" -->
 </application>
@@ -90,7 +86,7 @@ Optional but recommended: If you use the on-device API, configure your app to au
 
 ```dart
 CameraMlVision<List<Barcode>>(
-  detector: FirebaseVision.instance.barcodeDetector().detectInImage,
+  detector: GoogleMlKit.vision.barcodeScanner().processImage,
   onResult: (List<Barcode> barcodes) {
     if (!mounted || resultSent) {
       return;
@@ -101,15 +97,14 @@ CameraMlVision<List<Barcode>>(
 )
 ```
 
-`CameraMlVision` is a widget that shows the preview of the camera. It takes a detector as a parameter here we pass the `detectInImage` method of the `BarcodeDetector` object.
-The detector parameter can take all the different FirebaseVision Detector. Here is a list :
+`CameraMlVision` is a widget that shows the preview of the camera. It takes a detector as a parameter; here we pass the `processImage` method of the `BarcodeScanner` object.
+The detector parameter can take all the different MLKit Vision Detectors. Here is a list :
 
 ```
-FirebaseVision.instance.barcodeDetector().detectInImage
-FirebaseVision.instance.cloudLabelDetector().detectInImage
-FirebaseVision.instance.faceDetector().processImage
-FirebaseVision.instance.labelDetector().detectInImage
-FirebaseVision.instance.textRecognizer().processImage
+GoogleMlKit.vision.barcodeScanner().processImage
+GoogleMlKit.vision.imageLabeler().processImage
+GoogleMlKit.vision.faceDetector().processImage
+GoogleMlKit.vision.textDetector().processImage
 ```
 
 Then when something is detected the onResult callback is called with the data in the parameter of the function.

diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle
@@ -55,10 +55,8 @@ flutter {
 }
 
 dependencies {
-    api 'com.google.firebase:firebase-ml-vision-barcode-model:16.1.2'
+    implementation 'com.google.mlkit:barcode-scanning:17.0.0'
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'androidx.test:runner:1.1.1'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
 }
-
-apply plugin: 'com.google.gms.google-services'
diff --git a/example/android/app/src/main/AndroidManifest.xml b/example/android/app/src/main/AndroidManifest.xml
@@ -31,7 +31,7 @@
             </intent-filter>
         </activity>
         <meta-data
-            android:name="com.google.firebase.ml.vision.DEPENDENCIES"
+            android:name="com.google.mlkit.vision.DEPENDENCIES"
             android:value="barcode" />
     </application>
 </manifest>
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -1,6 +1,7 @@
+import 'dart:developer';
 import 'dart:ui';
 
-import 'package:firebase_ml_vision/firebase_ml_vision.dart';
+import 'package:google_ml_kit/google_ml_kit.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_camera_ml_vision/flutter_camera_ml_vision.dart';
 
@@ -55,7 +56,7 @@ class _MyHomePageState extends State<MyHomePage> {
               }
 
               setState(() {
-                data.add(barcode.displayValue);
+                data.add(barcode.value.displayValue);
               });
             },
             child: Text('Scan product'),
@@ -78,7 +79,7 @@ class ScanPage extends StatefulWidget {
 
 class _ScanPageState extends State<ScanPage> {
   bool resultSent = false;
-  BarcodeDetector detector = FirebaseVision.instance.barcodeDetector();
+  BarcodeScanner scanner = GoogleMlKit.vision.barcodeScanner();
 
   @override
   Widget build(BuildContext context) {
@@ -97,7 +98,7 @@ class _ScanPageState extends State<ScanPage> {
                 ),
               );
             },
-            detector: detector.detectInImage,
+            detector: scanner.processImage,
             onResult: (List<Barcode> barcodes) {
               if (!mounted ||
                   resultSent ||
@@ -109,7 +110,7 @@ class _ScanPageState extends State<ScanPage> {
               Navigator.of(context).pop<Barcode>(barcodes.first);
             },
             onDispose: () {
-              detector.close();
+              scanner.close();
             },
           ),
         ),

diff --git a/example/lib/main_face.dart b/example/lib/main_face.dart
@@ -1,5 +1,5 @@
 import 'package:camera/camera.dart';
-import 'package:firebase_ml_vision/firebase_ml_vision.dart';
+import 'package:google_ml_kit/google_ml_kit.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_camera_ml_vision/flutter_camera_ml_vision.dart';
 
@@ -32,7 +32,7 @@ class _MyHomePageState extends State<MyHomePage> {
   final _scanKey = GlobalKey<CameraMlVisionState>();
   CameraLensDirection cameraLensDirection = CameraLensDirection.front;
   FaceDetector detector =
-      FirebaseVision.instance.faceDetector(FaceDetectorOptions(
+      GoogleMlKit.vision.faceDetector(FaceDetectorOptions(
     enableTracking: true,
     mode: FaceDetectorMode.accurate,
   ));

diff --git a/example/lib/main_live.dart b/example/lib/main_live.dart
@@ -1,4 +1,4 @@
-import 'package:firebase_ml_vision/firebase_ml_vision.dart';
+import 'package:google_ml_kit/google_ml_kit.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_camera_ml_vision/flutter_camera_ml_vision.dart';
 
@@ -29,7 +29,7 @@ class MyHomePage extends StatefulWidget {
 class _MyHomePageState extends State<MyHomePage> {
   List<String> data = [];
   final _scanKey = GlobalKey<CameraMlVisionState>();
-  BarcodeDetector detector = FirebaseVision.instance.barcodeDetector();
+  BarcodeScanner scanner = GoogleMlKit.vision.barcodeScanner();
 
   @override
   Widget build(BuildContext context) {
@@ -42,21 +42,21 @@ class _MyHomePageState extends State<MyHomePage> {
         children: [
           CameraMlVision<List<Barcode>>(
             key: _scanKey,
-            detector: detector.detectInImage,
+            detector: scanner.processImage,
             resolution: ResolutionPreset.high,
             onResult: (barcodes) {
               if (barcodes == null ||
                   barcodes.isEmpty ||
-                  data.contains(barcodes.first.displayValue) ||
+                  data.contains(barcodes.first.value.displayValue) ||
                   !mounted) {
                 return;
               }
               setState(() {
-                data.add(barcodes.first.displayValue);
+                data.add(barcodes.first.value.displayValue);
               });
             },
             onDispose: () {
-              detector.close();
+              scanner.close();
             },
           ),
           Container(

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -7,7 +7,7 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.5.0"
+    version: "2.8.1"
   boolean_selector:
     dependency: transitive
     description:
@@ -42,7 +42,7 @@ packages:
       name: charcode
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.1"
   clock:
     dependency: transitive
     description:
@@ -106,34 +106,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "6.1.0"
-  firebase_core:
-    dependency: transitive
-    description:
-      name: firebase_core
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.1.0"
-  firebase_core_platform_interface:
-    dependency: transitive
-    description:
-      name: firebase_core_platform_interface
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "4.0.0"
-  firebase_core_web:
-    dependency: transitive
-    description:
-      name: firebase_core_web
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.0.2"
-  firebase_ml_vision:
-    dependency: transitive
-    description:
-      name: firebase_ml_vision
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.12.0+1"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -145,24 +117,19 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "3.0.0+1"
+    version: "3.0.1"
   flutter_test:
     dependency: "direct dev"
     description: flutter
     source: sdk
     version: "0.0.0"
-  flutter_web_plugins:
-    dependency: transitive
-    description: flutter
-    source: sdk
-    version: "0.0.0"
-  js:
+  google_ml_kit:
     dependency: transitive
     description:
-      name: js
+      name: google_ml_kit
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.6.3"
+    version: "0.7.3"
   matcher:
     dependency: transitive
     description:
@@ -176,7 +143,7 @@ packages:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0"
+    version: "1.7.0"
   path:
     dependency: transitive
     description:
@@ -265,7 +232,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   stack_trace:
     dependency: transitive
     description:
@@ -307,7 +274,7 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.19"
+    version: "0.4.2"
   typed_data:
     dependency: transitive
     description:

diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -30,6 +30,7 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
 
+publish_to: none
 
 # For information on the generic Dart part of this file, see the
 # following page: https://www.dartlang.org/tools/pub/pubspec

diff --git a/lib/flutter_camera_ml_vision.dart b/lib/flutter_camera_ml_vision.dart
@@ -8,7 +8,7 @@ import 'dart:ui';
 import 'package:camera/camera.dart';
 import 'package:collection/collection.dart';
 import 'package:device_info/device_info.dart';
-import 'package:firebase_ml_vision/firebase_ml_vision.dart';
+import 'package:google_ml_kit/google_ml_kit.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
@@ -18,7 +18,7 @@ export 'package:camera/camera.dart';
 
 part 'utils.dart';
 
-typedef HandleDetection<T> = Future<T> Function(FirebaseVisionImage image);
+typedef HandleDetection<T> = Future<T> Function(InputImage image);
 typedef ErrorWidgetBuilder = Widget Function(
     BuildContext context, CameraError error);
 
@@ -66,7 +66,7 @@ class CameraMlVisionState<T> extends State<CameraMlVision<T>>
   XFile? _lastImage;
   final _visibilityKey = UniqueKey();
   CameraController? _cameraController;
-  ImageRotation? _rotation;
+  InputImageRotation? _rotation;
   _CameraState _cameraMlVisionState = _CameraState.loading;
   CameraError _cameraError = CameraError.unknown;
   bool _alreadyCheckingImage = false;
@@ -149,7 +149,7 @@ class CameraMlVisionState<T> extends State<CameraMlVision<T>>
 
   CameraValue? get cameraValue => _cameraController?.value;
 
-  ImageRotation? get imageRotation => _rotation;
+  InputImageRotation? get imageRotation => _rotation;
 
   Future<void> Function() get prepareForVideoRecording =>
       _cameraController!.prepareForVideoRecording;