Сканируйте штрих-коды с помощью ML Kit на Android

Вы можете использовать ML Kit для распознавания и декодирования штрихкодов.

Этот API доступен с использованием либо неупакованной библиотеки, которую необходимо загрузить перед использованием, либо упакованной библиотеки, которая увеличивает размер вашего приложения. См. это руководство для получения дополнительной информации о различиях между двумя вариантами установки.

Особенность	Разделенный	В комплекте
Выполнение	Модель динамически загружается через Google Play Services.	Модель статически привязывается к вашему приложению во время сборки.
Размер приложения	Увеличение размера примерно на 200 КБ.	Увеличение размера примерно на 2,4 МБ.
Время инициализации	Возможно, придется подождать, пока модель загрузится перед первым использованием.	Модель доступна немедленно.

Примечание: Если у вашего приложения сложные сценарии использования или требуется настраиваемый пользовательский интерфейс, используйте этот API. Если нет, используйте сканер кода Google для более быстрого и не требующего разрешений API.

Попробуйте это

• Поэкспериментируйте с образцом приложения , чтобы увидеть пример использования этого API.
• Полную реализацию этого API можно увидеть в демонстрационном приложении Material Design .

Прежде чем начать

Для этого API требуется Android API уровня 21 или выше. Убедитесь, что файл сборки вашего приложения использует значение minSdkVersion 21 или выше.

1. В файле build.gradle на уровне проекта обязательно включите репозиторий Maven от Google в разделы buildscript и allprojects .

2. Добавьте зависимости для библиотек Android ML Kit в файл gradle уровня приложения вашего модуля, который обычно называется app/build.gradle . Выберите одну из следующих зависимостей в зависимости от ваших потребностей:

   Для объединения модели с вашим приложением:

   dependencies {
     // ...
     // Use this dependency to bundle the model with your app
     implementation 'com.google.mlkit:barcode-scanning:17.3.0'
   }
   

   Для использования модели в Google Play Services:

   dependencies {
     // ...
     // Use this dependency to use the dynamically downloaded model in Google Play Services
     implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.1'
   }
   

3. Если вы решили использовать модель в Google Play Services , вы можете настроить свое приложение на автоматическую загрузку модели на устройство после установки приложения из Play Store. Для этого добавьте следующее объявление в файл AndroidManifest.xml вашего приложения:

   <application ...>
         ...
         <meta-data
             android:name="com.google.mlkit.vision.DEPENDENCIES"
             android:value="barcode" >
         <!-- To use multiple models: android:value="barcode,model2,model3" -->
   </application>
   

   Вы также можете явно проверить доступность модели и запросить загрузку через API ModuleInstallClient сервисов Google Play.

   Если вы не включите загрузку модели во время установки или не запросите явную загрузку, модель будет загружена при первом запуске сканера. Запросы, которые вы сделаете до завершения загрузки, не дадут никаких результатов.

Руководство по вводу изображений

• Для того чтобы ML Kit мог точно считывать штрихкоды, входные изображения должны содержать штрихкоды, представленные достаточным количеством пиксельных данных.

  Конкретные требования к пиксельным данным зависят как от типа штрихкода, так и от объема закодированных в нем данных, поскольку многие штрихкоды поддерживают переменный размер полезной нагрузки. В общем, наименьшая значимая единица штрихкода должна быть не менее 2 пикселей в ширину, а для двумерных кодов — 2 пикселя в высоту.

  Например, штрихкоды EAN-13 состоят из полос и пробелов шириной 1, 2, 3 или 4 единицы, поэтому изображение штрихкода EAN-13 в идеале имеет полосы и пробелы шириной не менее 2, 4, 6 и 8 пикселей. Поскольку общая ширина штрихкода EAN-13 составляет 95 единиц, ширина штрихкода должна быть не менее 190 пикселей.

  Более плотные форматы, такие как PDF417, требуют большего размера пикселей для ML Kit, чтобы надежно их прочитать. Например, код PDF417 может иметь до 34 17-элементных "слов" в одной строке, что в идеале должно быть не менее 1156 пикселей в ширину.

• Плохая фокусировка изображения может повлиять на точность сканирования. Если ваше приложение не дает приемлемых результатов, попросите пользователя повторно захватить изображение.

• Для типичных приложений рекомендуется предоставлять изображение с более высоким разрешением, например 1280x720 или 1920x1080, что позволяет сканировать штрихкоды с большего расстояния от камеры.

  Однако в приложениях, где задержка имеет решающее значение, можно повысить производительность, захватывая изображения с более низким разрешением, но требуя, чтобы штрихкод составлял большую часть входного изображения. Также см. Советы по повышению производительности в реальном времени .

1. Настройте сканер штрих-кода

Если вы знаете, какие форматы штрихкодов вы ожидаете считывать, вы можете повысить скорость детектора штрихкодов, настроив его на обнаружение только этих форматов.

Например, чтобы обнаружить только код Aztec и QR-коды, создайте объект BarcodeScannerOptions , как в следующем примере:

Котлин

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build()
BarcodeScanningActivity.kt

Ява

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build();
BarcodeScanningActivity.java

Поддерживаются следующие форматы:

• Код 128 ( FORMAT_CODE_128 )
• Код 39 ( FORMAT_CODE_39 )
• Код 93 ( FORMAT_CODE_93 )
• Кодабар ( FORMAT_CODABAR )
• EAN-13 ( FORMAT_EAN_13 )
• EAN-8 ( FORMAT_EAN_8 )
• МФТ ( FORMAT_ITF )
• UPC-A ( FORMAT_UPC_A )
• UPC-E ( FORMAT_UPC_E )
• QR-код ( FORMAT_QR_CODE )
• PDF417 ( FORMAT_PDF417 )
• Ацтекский ( FORMAT_AZTEC )
• Матрица данных ( FORMAT_DATA_MATRIX )

Примечание: Для распознавания кода Data Matrix он должен пересекать центральную точку входного изображения. Следовательно, на изображении может быть распознан только один код Data Matrix.

Начиная с bundled model 17.1.0 и unbundled model 18.2.0, вы также можете вызвать enableAllPotentialBarcodes() чтобы вернуть все потенциальные штрихкоды, даже если их невозможно декодировать. Это можно использовать для облегчения дальнейшего обнаружения, например, путем увеличения масштаба камеры, чтобы получить более четкое изображение любого штрихкода в возвращенной ограничивающей рамке.

Котлин

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build();

Further on, starting from bundled library 17.2.0 and unbundled library 18.3.0, a new feature called auto-zoom has been introduced to further enhance the barcode scanning experience. With this feature enabled, the app is notified when all barcodes within the view are too distant for decoding. As a result, the app can effortlessly adjust the camera's zoom ratio to the recommended setting provided by the library, ensuring optimal focus and readability. This feature will significantly enhance the accuracy and success rate of barcode scanning, making it easier for apps to capture information precisely.

To enable auto-zooming and customize the experience, you can utilize the setZoomSuggestionOptions() method along with your own ZoomCallback handler and desired maximum zoom ratio, as demonstrated in the code below.

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build();

zoomCallback is required to be provided to handle whenever the library suggests a zoom should be performed and this callback will always be called on the main thread.

The following code snippet shows an example of defining a simple callback.

Kotlin

fun setZoom(ZoomRatio: Float): Boolean {
    if (camera.isClosed()) return false
    camera.getCameraControl().setZoomRatio(zoomRatio)
    return true
}

Java

boolean setZoom(float zoomRatio) {
    if (camera.isClosed()) {
        return false;
    }
    camera.getCameraControl().setZoomRatio(zoomRatio);
    return true;
}

maxSupportedZoomRatio is related to the camera hardware, and different camera libraries have different ways to fetch it (see the javadoc of the setter method). In case this is not provided, an unbounded zoom ratio might be produced by the library which might not be supported. Refer to the setMaxSupportedZoomRatio() method introduction to see how to get the max supported zoom ratio with different Camera libraries.

When auto-zooming is enabled and no barcodes are successfully decoded within the view, BarcodeScanner triggers your zoomCallback with the requested zoomRatio. If the callback correctly adjusts the camera to this zoomRatio, it is highly probable that the most centered potential barcode will be decoded and returned.

A barcode may remain undecodable even after a successful zoom-in. In such cases, BarcodeScanner may either invoke the callback for another round of zoom-in until the maxSupportedZoomRatio is reached, or provide an empty list (or a list containing potential barcodes that were not decoded, if enableAllPotentialBarcodes() was called) to the OnSuccessListener (which will be defined in step 4. Process the image).

2. Prepare the input image

To recognize barcodes in an image, create an InputImage object from either a Bitmap, media.Image, ByteBuffer, byte array, or a file on the device. Then, pass the InputImage object to the BarcodeScanner's process method.

You can create an InputImage object from different sources, each is explained below.

Using a media.Image

To create an InputImage object from a media.Image object, such as when you capture an image from a device's camera, pass the media.Image object and the image's rotation to InputImage.fromMediaImage().

If you use the CameraX library, the OnImageCapturedListener and ImageAnalysis.Analyzer classes calculate the rotation value for you.

Kotlin

private class YourImageAnalyzer : ImageAnalysis.Analyzer {

    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
            // Pass image to an ML Kit Vision API
            // ...
        }
    }
}

Ява

private class YourAnalyzer implements ImageAnalysis.Analyzer {

    @Override
    public void analyze(ImageProxy imageProxy) {
        Image mediaImage = imageProxy.getImage();
        if (mediaImage != null) {
          InputImage image =
                InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees());
          // Pass image to an ML Kit Vision API
          // ...
        }
    }
}

Если вы не используете библиотеку камеры, которая выдает угол поворота изображения, вы можете рассчитать его на основе угла поворота устройства и ориентации датчика камеры на устройстве:

Котлин

private val ORIENTATIONS = SparseIntArray()

init {
    ORIENTATIONS.append(Surface.ROTATION_0, 0)
    ORIENTATIONS.append(Surface.ROTATION_90, 90)
    ORIENTATIONS.append(Surface.ROTATION_180, 180)
    ORIENTATIONS.append(Surface.ROTATION_270, 270)
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
@Throws(CameraAccessException::class)
private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    val deviceRotation = activity.windowManager.defaultDisplay.rotation
    var rotationCompensation = ORIENTATIONS.get(deviceRotation)

    // Get the device's sensor orientation.
    val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager
    val sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION)!!

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360
    }
    return rotationCompensation
}
MLKitVisionImage.kt

Ява

private static final SparseIntArray ORIENTATIONS = new SparseIntArray();
static {
    ORIENTATIONS.append(Surface.ROTATION_0, 0);
    ORIENTATIONS.append(Surface.ROTATION_90, 90);
    ORIENTATIONS.append(Surface.ROTATION_180, 180);
    ORIENTATIONS.append(Surface.ROTATION_270, 270);
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing)
        throws CameraAccessException {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation();
    int rotationCompensation = ORIENTATIONS.get(deviceRotation);

    // Get the device's sensor orientation.
    CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE);
    int sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION);

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360;
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360;
    }
    return rotationCompensation;
}

Затем передайте объект media.Image и значение угла поворота в InputImage.fromMediaImage() :

Котлин

val image = InputImage.fromMediaImage(mediaImage, rotation)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

Использование URI файла

Чтобы создать объект InputImage из URI файла, передайте контекст приложения и URI файла в InputImage.fromFilePath() . Это полезно, когда вы используете намерение ACTION_GET_CONTENT , чтобы предложить пользователю выбрать изображение из своего приложения галереи.

Котлин

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}
MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

Использование ByteBuffer или ByteArray

Чтобы создать объект InputImage из ByteBuffer или ByteArray , сначала вычислите степень поворота изображения, как описано ранее для ввода media.Image . Затем создайте объект InputImage с буфером или массивом, вместе с высотой изображения, шириной, форматом кодировки цвета и степенью поворота:

Котлин

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Ява

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java

Использование Bitmap

Чтобы создать объект InputImage из объекта Bitmap , сделайте следующее объявление:

Котлин

val image = InputImage.fromBitmap(bitmap, 0)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
MLKitVisionImage.java

Изображение представлено объектом Bitmap вместе с градусами поворота.

3. Получите экземпляр BarcodeScanner

Котлин

val scanner = BarcodeScanning.getClient()
// Or, to specify the formats to recognize:
// val scanner = BarcodeScanning.getClient(options)
BarcodeScanningActivity.kt

Ява

BarcodeScanner scanner = BarcodeScanning.getClient();
// Or, to specify the formats to recognize:
// BarcodeScanner scanner = BarcodeScanning.getClient(options);
BarcodeScanningActivity.java

4. Обработайте изображение.

Передайте изображение в метод process :

Котлин

val result = scanner.process(image)
        .addOnSuccessListener { barcodes ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener {
            // Task failed with an exception
            // ...
        }
BarcodeScanningActivity.kt

Ява

Task<List<Barcode>> result = scanner.process(image)
        .addOnSuccessListener(new OnSuccessListener<List<Barcode>>() {
            @Override
            public void onSuccess(List<Barcode> barcodes) {
                // Task completed successfully
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Task failed with an exception
                // ...
            }
        });
BarcodeScanningActivity.java

Примечание: Если вы используете API CameraX , обязательно закройте ImageProxy после завершения его использования, например, добавив OnCompleteListener к Task возвращаемому методом process . См. класс VisionProcessorBase в примере приложения быстрого запуска для примера.

5. Получите информацию из штрих-кодов

Если операция распознавания штрихкода прошла успешно, список объектов Barcode передается прослушивателю успеха. Каждый объект Barcode представляет штрихкод, обнаруженный на изображении. Для каждого штрихкода можно получить его граничные координаты на входном изображении, а также необработанные данные, закодированные штрихкодом. Кроме того, если сканер штрихкода смог определить тип данных, закодированных штрихкодом, можно получить объект, содержащий проанализированные данные.

Например:

Котлин

for (barcode in barcodes) {
    val bounds = barcode.boundingBox
    val corners = barcode.cornerPoints

    val rawValue = barcode.rawValue

    val valueType = barcode.valueType
    // See API reference for complete list of supported types
    when (valueType) {
        Barcode.TYPE_WIFI -> {
            val ssid = barcode.wifi!!.ssid
            val password = barcode.wifi!!.password
            val type = barcode.wifi!!.encryptionType
        }
        Barcode.TYPE_URL -> {
            val title = barcode.url!!.title
            val url = barcode.url!!.url
        }
    }
}
BarcodeScanningActivity.kt

Ява

for (Barcode barcode: barcodes) {
    Rect bounds = barcode.getBoundingBox();
    Point[] corners = barcode.getCornerPoints();

    String rawValue = barcode.getRawValue();

    int valueType = barcode.getValueType();
    // See API reference for complete list of supported types
    switch (valueType) {
        case Barcode.TYPE_WIFI:
            String ssid = barcode.getWifi().getSsid();
            String password = barcode.getWifi().getPassword();
            int type = barcode.getWifi().getEncryptionType();
            break;
        case Barcode.TYPE_URL:
            String title = barcode.getUrl().getTitle();
            String url = barcode.getUrl().getUrl();
            break;
    }
}
BarcodeScanningActivity.java

Советы по улучшению производительности в реальном времени

Если вы хотите сканировать штрихкоды в режиме реального времени, следуйте этим рекомендациям, чтобы добиться наилучшей частоты кадров:

• Не захватывайте ввод с собственным разрешением камеры. На некоторых устройствах захват ввода с собственным разрешением создает чрезвычайно большие (10+ мегапикселей) изображения, что приводит к очень низкой задержке без какого-либо выигрыша в точности. Вместо этого запрашивайте у камеры только тот размер, который необходим для обнаружения штрихкода, который обычно не превышает 2 мегапикселей.

  Если важна скорость сканирования, можно еще больше снизить разрешение захвата изображения. Однако имейте в виду минимальные требования к размеру штрихкода, изложенные выше.

  Если вы пытаетесь распознать штрихкоды из последовательности кадров потокового видео, распознаватель может выдавать разные результаты от кадра к кадру. Вам следует подождать, пока вы не получите последовательную серию с одинаковым значением, чтобы быть уверенным, что вы возвращаете хороший результат.

  Контрольная сумма не поддерживается для ITF и CODE-39.

• Если вы используете API Camera или camera2 , заглушите вызовы детектора. Если новый видеокадр становится доступен во время работы детектора, удалите кадр. См. класс VisionProcessorBase в примере приложения быстрого запуска для примера.
• Если вы используете API CameraX , убедитесь, что стратегия обратного давления установлена ​​на значение по умолчанию ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST . Это гарантирует, что для анализа будет доставлено только одно изображение за раз. Если при занятости анализатора будет создано больше изображений, они будут автоматически удалены и не будут поставлены в очередь на доставку. После того, как анализируемое изображение будет закрыто вызовом ImageProxy.close(), будет доставлено следующее последнее изображение.
• Если вы используете вывод детектора для наложения графики на входное изображение, сначала получите результат из ML Kit, затем визуализируйте изображение и наложение за один шаг. Это визуализирует поверхность дисплея только один раз для каждого входного кадра. См. классы CameraSourcePreview и GraphicOverlay в примере приложения быстрого запуска для примера.
• Если вы используете API Camera2, захватывайте изображения в формате ImageFormat.YUV_420_888 . Если вы используете старый API Camera, захватывайте изображения в формате ImageFormat.NV21 .