google_mlkit_object_detection 0.7.0

A Flutter plugin to use Google's ML Kit Object Detection and Tracking to detect and track objects in an image or live camera feed.

Google's ML Kit Object Detection and Tracking for Flutter

A Flutter plugin to use Google's ML Kit Object Detection and Tracking to detect and track objects in an image or live camera feed.

PLEASE READ THIS before continuing or posting a new issue:

• Google's ML Kit was build only for mobile platforms: iOS and Android apps.

• This plugin is not sponsor or maintained by Google. The authors are developers excited about machine learning that wanted to expose Google's native APIs to Flutter.

• Google's ML Kit APIs are ony developed natively for iOS and Android. This plugin uses Flutter Platform Channels as explained here.

  Messages are passed between the client (the app/plugin) and host (platform) using platform channels as illustrated in this diagram:

  

  Messages and responses are passed asynchronously, to ensure the user interface remains responsive. To read more about platform channels go here.

  Because this plugin uses platform channels, no Machine Learning processing is done in Flutter/Dart, all the calls are passed to the native platform using MethodChannel in Android and FlutterMethodChannel in iOS, and executed using the Google's native APIs. Think of this plugin as a bridge between your app and Google's native ML Kit APIs. This plugin only passes the call to the native API and the processing is done by Google's API. It is important that you understand this concept when it comes to debugging errors for your ML model and/or app.

• Since the plugin uses platform channels, you may encounter issues with the native API. Before submitting a new issue, identify the source of the issue. You can run both iOS and/or Android native example apps by Google and make sure that the issue is not reproducible with their native examples. If you can reproduce the issue in their apps then report the issue to Google. The authors do not have access to the source code of their native APIs, so you need to report the issue to them. If you find that their example apps are okay and still you have an issue using this plugin, then look at our closed and open issues. If you cannot find anything that can help you then report the issue and provide enough details. Be patient, someone from the community will eventually help you.

Getting Started

Before you get started read about the requirements and known issues of this plugin here.

Firebase dependency for remote models

Object Detection and Tracking can be used with both Base Models and Custom Models. Base models are bundled with the app, and custom Models can either be bundled with the app or downloaded from Firebase.

If you wish to use remote models hosted in Firebase, you must first enable the feature in iOS. Please see the additional setup instructions here.

To add Firebase to your project follow these steps:

• Android
• iOS

Usage

Object Detection and Tracking

Create an instance of InputImage

Create an instance of InputImage as explained here.

final InputImage inputImage;

Create an instance of ObjectDetector

// Use DetectionMode.stream when processing camera feed.
// Use DetectionMode.single when processing a single image.
final mode = DetectionMode.stream or DetectionMode.single;

// Options to configure the detector while using with base model.
final options = ObjectDetectorOptions(...);

// Options to configure the detector while using a local custom model.
final options = LocalObjectDetectorOptions(...);

// Options to configure the detector while using a Firebase model.
final options = FirebaseObjectDetectorOptions(...);

final objectDetector = ObjectDetector(options: options);

Process image

final List<DetectedObject> objects = await objectDetector.processImage(inputImage);

for(DetectedObject detectedObject in objects){
  final rect = detectedObject.boundingBox;
  final trackingId = detectedObject.trackingId;

  for(Label label in detectedObject.labels){
    print('${label.text} ${label.confidence}');
  }
}

Release resources with close()

objectDetector.close();

Load local custom model

To use a local custom model add the tflite model to your pubspec.yaml:

assets:
- assets/ml/

Add this method:

import 'dart:io';
import 'package:flutter/services.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';

Future<String> _getModel(String assetPath) async {
  if (io.Platform.isAndroid) {
    return 'flutter_assets/$assetPath';
  }
  final path = '${(await getApplicationSupportDirectory()).path}/$assetPath';
  await io.Directory(dirname(path)).create(recursive: true);
  final file = io.File(path);
  if (!await file.exists()) {
    final byteData = await rootBundle.load(assetPath);
    await file.writeAsBytes(byteData.buffer
        .asUint8List(byteData.offsetInBytes, byteData.lengthInBytes));
  }
  return file.path;
}

Create an instance of [ImageLabeler]:

final modelPath = await _getModel('assets/ml/object_labeler.tflite');
final options = LocalObjectDetectorOptions(
  modelPath: modelPath,
  classifyObjects: true,
  multipleObjects: true,
  mode: DetectionMode.stream,
);
final objectDetector = ObjectDetector(options: options);

Managing remote models

Create an instance of model manager

final modelManager = FirebaseObjectDetectorModelManager();

Check if model is downloaded

final bool response = await modelManager.isModelDownloaded(model);

Download model

final bool response = await modelManager.downloadModel(model);

Delete model

final bool response = await modelManager.deleteModel(model);

Example app

Find the example app here.

Contributing

Contributions are welcome. In case of any problems look at existing issues, if you cannot find anything related to your problem then open an issue. Create an issue before opening a pull request for non trivial fixes. In case of trivial fixes open a pull request directly.