Android'de ML Kit ile barkodları tarama

Barkodları tanımak ve kodlarını çözmek için ML Kit'i kullanabilirsiniz.

Bu API, kullanımdan önce indirilmesi gereken paketlenmemiş kitaplık veya uygulamanızın boyutunu artıran paketli bir kitaplık kullanılarak kullanılabilir. İki yükleme seçeneği arasındaki farklar hakkında daha fazla bilgi için bu kılavuza göz atın.

Özellik	Grup halinde olmayanlar	Gruplandırılanlar
Uygulama	Model, Google Play Hizmetleri üzerinden dinamik olarak indirilir.	Model, derleme sırasında uygulamanıza statik olarak bağlanır.
Uygulama boyutu	Yaklaşık 200 KB boyut artışı.	Yaklaşık 2,4 MB boyut artışı.
Başlatma süresi	İlk kullanımdan önce modelin indirilmesini beklemeniz gerekebilir.	Model hemen kullanılabilir.

Deneyin

• Bu API'nin örnek kullanımını görmek için örnek uygulamayla denemeler yapın.
• Bu API'nin uçtan uca uygulanmasını sağlamak için Materyal Tasarım vitrin uygulamasına bakın.

Başlamadan önce

Bu API, Android API düzeyi 19 veya üzeridir. Uygulamanızın derleme dosyasının 19 veya daha yüksek bir minSdkVersion değeri kullandığından emin olun.

1. Proje düzeyindeki build.gradle dosyanıza, Google'ın Maven deposunu hem buildscript hem de allprojects bölümlerine ekleyin.

2. ML Kit Android kitaplıklarının bağımlılarını, modülünüzün genellikle app/build.gradle olan Gradle dosyasına ekleyin. İhtiyaçlarınıza bağlı olarak aşağıdaki bağımlılıklardan birini seçin:

   Modeli uygulamanızla birlikte gruplandırmak için:

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

   Modeli Google Play Hizmetleri'nde kullanmak için:

   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.1.0'
   }
   

3. Modeli Google Play Hizmetleri'nde kullanmayı seçerseniz uygulamanızı Play Store'dan yüklendikten sonra modeli otomatik olarak cihaza indirecek şekilde yapılandırabilirsiniz. Bunu yapmak için aşağıdaki beyanı uygulamanızın AndroidManifest.xml dosyasına ekleyin:

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

   Ayrıca modelin kullanılabilirliğini açık bir şekilde kontrol edebilir ve Google Play Hizmetleri ModuleInstallClient API'si üzerinden indirme isteğinde bulunabilirsiniz.

   Yükleme sırasında model indirmeyi etkinleştirmez veya açık indirme isteğinde bulunmazsanız model, tarayıcıyı ilk kez çalıştırdığınızda indirilir. İndirme tamamlanmadan önce yaptığınız istekler sonuç vermez.

Giriş resmi yönergeleri

• ML Kit'in barkodları doğru bir şekilde okuyabilmesi için giriş resimleri yeterli piksel verisi ile temsil edilen barkodlar içermelidir.

  Birçok piksel kodu, değişken boyut yükünü desteklediği için belirli piksel verisi gereksinimleri hem barkodun türüne hem de bu kodla kodlanan veri miktarına bağlıdır. Genel olarak, barkodun en küçük birimi en az 2 piksel genişliğinde ve 2 boyutlu kodlarda 2 piksel yüksekliğinde olmalıdır.

  Örneğin, EAN-13 barkodları, 1, 2, 3 veya 4 birim genişliğindeki çubuklardan ve boşluklardan oluşur. Bu nedenle EAN-13 barkod resmi, en az 2, 4, 6 ve 8 piksel genişliğinde çubuklara ve alanlara sahip olur. EAN-13 barkodlarının toplam genişliği 95 birim olduğundan, barkod en az 190 piksel genişliğinde olmalıdır.

  PDF417 gibi yoğun biçimler, ML Kit'in güvenilir şekilde okuyabilmesi için daha büyük piksel boyutlarına ihtiyaç duyar. Örneğin, bir PDF417 kodunda, tek bir satırda ideal olarak en az 1156 piksel genişliğinde 34 adet 17 birim genişliğinde "kelime" bulunabilir.

• Düşük resim odağı, tarama doğruluğunu etkileyebilir. Uygulamanız kabul edilebilir sonuçlar almıyorsa kullanıcıdan resmi yeniden yakalamasını isteyin.

• Tipik uygulamalar için 1280x720 veya 1920x1080 gibi daha yüksek çözünürlüklü bir resim sağlamanız önerilir. Böylece, barkodlar kameradan daha uzak bir yerden taranabilir.

  Bununla birlikte, gecikmenin kritik olduğu uygulamalarda, görüntüleri daha düşük çözünürlükte yakalayarak ancak giriş resminin büyük bir kısmının barkodda gösterilmesini gerektirerek performansı artırabilirsiniz. Gerçek zamanlı performansı artırmak için ipuçları başlıklı makaleyi de inceleyin.

1. Barkod tarayıcıyı yapılandırma

Okumak istediğiniz barkod biçimlerini biliyorsanız barkod dedektörünün hızını, yalnızca bu biçimleri algılayacak şekilde yapılandırarak artırabilirsiniz.

Örneğin, yalnızca Aztek ve QR kodlarını tespit etmek için aşağıdaki örnekte olduğu gibi bir BarcodeScannerOptions nesnesi oluşturun:

Kotlin

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

Java

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

Aşağıdaki biçimler desteklenir:

• Kod 128 (FORMAT_CODE_128)
• Kod 39 (FORMAT_CODE_39)
• Kod 93 (FORMAT_CODE_93)
• Codabar (FORMAT_CODABAR)
• EAN-13 (FORMAT_EAN_13)
• EAN-8 (FORMAT_EAN_8)
• BTF (FORMAT_ITF)
• UPC-A (FORMAT_UPC_A)
• UPC-E (FORMAT_UPC_E)
• QR Kodu (FORMAT_QR_CODE)
• PDF417 (FORMAT_PDF417)
• Aztek (FORMAT_AZTEC)
• Veri Matrisi (FORMAT_DATA_MATRIX)

Not: Bir Data Matris kodunun tanınması için kodun, giriş resminin odak noktasıyla kesişmesi gerekir. Sonuç olarak, bir resimde yalnızca bir Veri Matrisi kodu tanınabilir.

2. Giriş resmini hazırlayın

Bir resimdeki barkodları tanımak için Bitmap, media.Image, ByteBuffer, bayt dizisi veya cihazdaki bir dosyadan InputImage nesnesi oluşturun. Ardından, InputImage nesnesini BarcodeScanner öğesinin process yöntemine geçirin.

Farklı kaynaklardan InputImage nesnesi oluşturabilirsiniz. Her nesne aşağıda açıklanmıştır.

media.Image kullanılıyor

Bir cihazın kamerasından resim yakaladığınızda (ör. bir cihazın kamerasından yakaladığınızda) bir media.Image nesnesinden InputImage nesnesi oluşturmak için media.Image nesnesini ve resmin InputImage.fromMediaImage() yönünü döndürmesini iletin.

CameraX kitaplığını kullanırsanız OnImageCapturedListener ve ImageAnalysis.Analyzer sınıfları sizin için rotasyon değerini hesaplar.

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
            // ...
        }
    }
}

Java

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
          // ...
        }
    }
}

Görüntünün döndürülme derecesini veren bir kamera kitaplığı kullanmıyorsanız bunu, cihazın döndürme derecesinden ve cihazdaki kamera sensörünün yönüne göre hesaplayabilirsiniz:

Kotlin

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

Java

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;
}

Ardından media.Image nesnesini ve döndürme derecesi değerini InputImage.fromMediaImage() değerine iletin:

Kotlin

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

Java

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

Dosya URI'si kullanma

Dosya URI'sinden InputImage nesnesi oluşturmak için uygulama bağlamını ve dosya URI'sini InputImage.fromFilePath() öğesine iletin. Bu, kullanıcıdan galeri uygulamasından bir resim seçmesini istemek için bir ACTION_GET_CONTENT niyeti kullandığınızda kullanışlıdır.

Kotlin

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 veya ByteArray kullanma

ByteBuffer veya ByteArray öğesinden bir InputImage nesnesi oluşturmak için önce resim döndürme derecesini media.Image girişinde açıklandığı gibi hesaplayın. Ardından, arabellek veya diziyle birlikte InputImage nesnesini resmin yüksekliği, genişliği, renk kodlama biçimi ve döndürme derecesiyle oluşturun:

Kotlin

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

Java

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 kullanılıyor

Bir Bitmap nesnesinden InputImage nesnesi oluşturmak için aşağıdaki beyanı oluşturun:

Kotlin

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

Java

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

Resim, döndürme dereceleriyle birlikte bir Bitmap nesnesiyle gösterilir.

3. BarcodeScanner örneği alın

Kotlin

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

Java

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

4. Resmi işleyin

Görüntüyü process yöntemine geçirin:

Kotlin

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

Java

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

Not: CameraX API'sini kullanıyorsanız işlemi tamamladıktan sonra ImageProxy yöntemini kapattığınızdan emin olun (ör. process yönteminden döndürülen Task işlevine OnCompleteListener ekleyerek). Örnek görmek için hızlı başlangıç örneği uygulamasındaki VisionProcessorBase bölümüne bakın.

5. Barkodlardan bilgi alın

Barkod tanıma işlemi başarılı olursa başarılı dinleyiciye Barcode nesnelerinin listesi aktarılır. Her Barcode nesnesi, resimde tespit edilen bir barkodu temsil eder. Her barkod için sınırlayıcı koordinatlarını, giriş resminde ve barkodla kodlanan ham verilerde alabilirsiniz. Ayrıca, barkod okuyucu barkodla kodlanan veri türünü belirleyebildiyse ayrıştırılan verileri içeren bir nesne alabilirsiniz.

Örnek:

Kotlin

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

Java

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

Gerçek zamanlı performansı artırmak için ipuçları

Barkodları gerçek zamanlı bir uygulamada taramak istiyorsanız en iyi kare hızlarını elde etmek için aşağıdaki yönergeleri izleyin:

• Kameranın yerel çözünürlüğünde girişi yakalamayın. Bazı cihazlarda, yerel çözünürlükte giriş alma işlemi çok büyük (10+ megapiksel) görüntüler üretir. Bu da doğrulukta herhangi bir azalmaya yol açmadan çok düşük gecikmeyle sonuçlanır. Bunun yerine, kameradan yalnızca barkod algılama için gereken boyutu isteyin. Genellikle 2 megapikselden büyük olmamalıdır.

  Tarama hızı önemliyse görüntü yakalama çözünürlüğünü daha da düşürebilirsiniz. Ancak, yukarıda belirtilen minimum barkod boyutu gereksinimlerini göz önünde bulundurun.

  Bir dizi video çerçevesinin barkodlarını tanımaya çalışıyorsanız, tanıyıcı kareden çerçeveye farklı sonuçlar üretebilir. İyi bir sonuç elde ettiğinizden emin olmak için aynı değerden art arda bir dizi oluşana kadar beklemeniz gerekir.

  Sağlama basamağı ITF ve CODE-39 için desteklenmiyor.

• Camera veya camera2 API'yi kullanıyorsanız algılayıcıya yapılan çağrıları azaltır. Algılayıcı çalışırken yeni bir video çerçevesi kullanılabilir hale gelirse çerçeveyi bırakın. Örnek için hızlı başlangıç örneği uygulamasındaki VisionProcessorBase sınıfını inceleyin.
• CameraX API'yi kullanıyorsanız geri baskı stratejisinin ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST varsayılan değerine ayarlandığından emin olun. Bu, tek seferde yalnızca bir resmin analiz için teslim edileceğini garanti eder. Analiz aracı meşgul olduğunda daha fazla resim üretilirse otomatik olarak çıkarılır ve sıraya alınmaz. Analiz edilen görüntü ImageProxy.close() çağrısıyla kapatıldıktan sonra, en son görüntü gönderilir.
• Algılayıcının çıkışını giriş resmine yer paylaşımlı olarak eklemek için kullanıyorsanız önce ML Kit'ten sonucu alın, ardından resmi ve yer paylaşımını tek bir adımda oluşturun. Bu işlem, her bir giriş çerçevesi için görüntü yüzeyine yalnızca bir kez oluşturulur. Örnek için hızlı başlangıç örneği uygulamasındaki CameraSourcePreview ve GraphicOverlay sınıflarını inceleyin.
• Camera2 API'sini kullanıyorsanız resimleri ImageFormat.YUV_420_888 biçiminde çekin. Eski Camera API'yi kullanıyorsanız görüntüleri ImageFormat.NV21 biçiminde çekin.