Android पर ML किट से बारकोड स्कैन करना

आप बारकोड पहचानने और डिकोड करने के लिए ML किट का इस्तेमाल कर सकते हैं.

सुविधाअनबंडल किए गएबंडल किए गए
लागू करनामॉडल, Google Play Services के ज़रिए डाइनैमिक रूप से डाउनलोड होता है.मॉडल, बिल्ड टाइम के दौरान स्टैटिक तौर पर आपके ऐप्लिकेशन से लिंक होता है.
ऐप्लिकेशन का साइज़करीब 200 केबी का साइज़ बढ़ाएं.फ़ाइल का साइज़ करीब 2.4 एमबी बढ़ गया है.
शुरू करने का समयपहली बार इस्तेमाल करने से पहले, शायद मॉडल डाउनलोड होने का इंतज़ार करना पड़े.मॉडल तुरंत उपलब्ध है.

इसे आज़माएं

शुरू करने से पहले

  1. प्रोजेक्ट-लेवल की build.gradle फ़ाइल में, अपने buildscript और allprojects, दोनों सेक्शन में Google का Maven का स्टोरेज शामिल करना न भूलें.

  2. अपने मॉड्यूल की ऐप्लिकेशन-लेवल की ग्रेडल फ़ाइल में ML किट की Android लाइब्रेरी के लिए डिपेंडेंसी जोड़ें, जो आम तौर पर app/build.gradle होती है. अपनी ज़रूरतों के हिसाब से इनमें से कोई एक डिपेंडेंसी चुनें:

    अपने ऐप्लिकेशन के साथ मॉडल को बंडल करने के लिए:

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

    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.1.0'
    }
    
  3. अगर Google Play सेवाओं में मॉडल का इस्तेमाल किया जाता है, तो 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>
    

    Google Play सेवाओं के ModuleInstallClient API की मदद से, मॉडल की उपलब्धता की जानकारी साफ़ तौर पर देखी जा सकती है. साथ ही, उसे डाउनलोड करने का अनुरोध भी किया जा सकता है.

    अगर आपने इंस्टॉल के समय 'डाउनलोड' मॉडल चालू नहीं किया है या साफ़ तौर पर डाउनलोड करने का अनुरोध नहीं किया है, तो पहली बार स्कैनर चलाने पर वह मॉडल डाउनलोड हो जाता है. डाउनलोड पूरा होने से पहले किए गए अनुरोधों से कोई भी नतीजा नहीं मिलता.

इनपुट इमेज के दिशा-निर्देश

  • मशीन लर्निंग (ML) किट में मौजूद बारकोड को सही तरीके से पढ़ने के लिए, इनपुट इमेज में ऐसे बारकोड होने चाहिए जिन्हें पिक्सल डेटा की मदद से दिखाया गया हो.

    पिक्सल से जुड़ी ज़रूरी शर्तें, बारकोड के टाइप और उसमें एन्कोड किए गए डेटा, दोनों के आधार पर तय की जाती हैं. ऐसा इसलिए होता है, क्योंकि कई बारकोड में वैरिएबल साइज़ पेलोड होता है. आम तौर पर, बारकोड की सबसे छोटी और अहम जानकारी वाली यूनिट कम से कम 2 पिक्सल की होनी चाहिए. साथ ही, दो डाइमेंशन वाले कोड और दो पिक्सल लंबे होने चाहिए.

    उदाहरण के लिए, EAN-13 बारकोड में ऐसे बार और स्पेस होते हैं जो 1, 2, 3 या 4 यूनिट वाले होते हैं. इसलिए, EAN-13 बारकोड इमेज में कम से कम 2, 4, 6, और 8 पिक्सल की चौड़ाई वाले बार और स्पेस होते हैं. ईएएन-13 बारकोड की लंबाई 95 यूनिट होती है. इसलिए, बारकोड कम से कम 190 पिक्सल का होना चाहिए.

    डेंसर के फ़ॉर्मैट, जैसे कि PDF417 का इस्तेमाल करने से, पिक्सल पिक्सल को बेहतर तरीके से पढ़ने में मदद मिलती है. उदाहरण के लिए, PDF417 कोड में एक ही पंक्ति में ज़्यादा से ज़्यादा 34 17 यूनिट वाली चौड़ी "शब्द" हो सकती है जो आम तौर पर कम से कम 1156 पिक्सल चौड़ी होनी चाहिए.

  • इमेज का फ़ोकस ठीक न होने से, स्कैन करने की प्रोसेस पर असर पड़ सकता है. अगर आपके ऐप्लिकेशन को स्वीकार किए जाने वाले नतीजे नहीं मिल रहे हैं, तो उपयोगकर्ता से इमेज को फिर से देखने के लिए कहें.

  • आम तौर पर इस्तेमाल किए जाने वाले ऐप्लिकेशन के लिए, ज़्यादा रिज़ॉल्यूशन वाली इमेज देने का सुझाव दिया जाता है, जैसे कि 1280x720 या 1920x1080. ऐसी इमेज में बारकोड को कैमरे से दूर से स्कैन किया जा सकता है.

    हालांकि, जिन ऐप्लिकेशन में इंतज़ार का समय बहुत कम होता है उनमें इमेज को कम रिज़ॉल्यूशन में कैप्चर करके, परफ़ॉर्मेंस को बेहतर बनाया जा सकता है. हालांकि, इनपुट के ज़्यादातर हिस्से में बारकोड शामिल होना चाहिए. रीयल-टाइम परफ़ॉर्मेंस को बेहतर बनाने के लिए सलाह भी देखें.

1. बारकोड स्कैनर कॉन्फ़िगर करें

अगर आपको पता है कि आपको किन बारकोड फ़ॉर्मैट को पढ़ना है, तो आप बारकोड डिटेक्टर को सिर्फ़ उन फ़ॉर्मैट का पता लगाने के लिए कॉन्फ़िगर करके, उनकी गति बढ़ा सकते हैं.

उदाहरण के लिए, सिर्फ़ ऐज़टेक कोड और क्यूआर कोड का पता लगाने के लिए, BarcodeScannerOptions ऑब्जेक्ट बनाएं, जैसा कि इस उदाहरण में दिखाया गया है:

Kotlin

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

Java

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

इस फ़ॉर्मैट का इस्तेमाल किया जा सकता है:

  • कोड 128 (FORMAT_CODE_128)
  • कोड 39 (FORMAT_CODE_39)
  • कोड 93 (FORMAT_CODE_93)
  • कोडाबार (FORMAT_CODABAR)
  • EAN-13 (FORMAT_EAN_13)
  • ईएएन-8 (FORMAT_EAN_8)
  • आईटीएफ़ (FORMAT_ITF)
  • यूपीसी-ए (FORMAT_UPC_A)
  • यूपीसी-ई (FORMAT_UPC_E)
  • क्यूआर कोड (FORMAT_QR_CODE)
  • PDF417 (FORMAT_PDF417)
  • ऐज़टेक (FORMAT_AZTEC)
  • डेटा मैट्रिक्स (FORMAT_DATA_MATRIX)

2. इनपुट इमेज तैयार करें

किसी इमेज में बारकोड पहचानने के लिए, Bitmap, media.Image, ByteBuffer, बाइट कैटगरी या डिवाइस पर मौजूद किसी फ़ाइल से InputImage ऑब्जेक्ट बनाएं. इसके बाद, InputImage ऑब्जेक्ट को BarcodeScanner के process तरीके पर भेजें.

अलग-अलग सोर्स से ऑब्जेक्ट InputImage बनाया जा सकता है. हर ऑब्जेक्ट के बारे में यहां बताया गया है.

media.Image का इस्तेमाल किया जा रहा है

media.Image ऑब्जेक्ट से InputImage ऑब्जेक्ट बनाने के लिए, media.Image ऑब्जेक्ट और इमेज का घुमाव, InputImage.fromMediaImage() को पास करें. उदाहरण के लिए, जब आप किसी डिवाइस के कैमरे से इमेज कैप्चर कर रहे हों.

अगर आप CameraX लाइब्रेरी का इस्तेमाल करते हैं, तो OnImageCapturedListener और ImageAnalysis.Analyzer क्लास, आपके लिए रोटेशन वैल्यू का हिसाब लगाती हैं.

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

किसी ऐसी कैमरा लाइब्रेरी का इस्तेमाल न करने पर, जो इमेज को घुमाने की डिग्री देती है, आप डिवाइस के घुमाव डिग्री और डिवाइस में कैमरा सेंसर की दिशा से उसका हिसाब लगा सकते हैं:

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
}

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

इसके बाद, InputImage.fromMediaImage() ऑब्जेक्ट को media.Image ऑब्जेक्ट और रोटेशन डिग्री वैल्यू पास करें:

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)

Java

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

फ़ाइल यूआरआई का इस्तेमाल करना

किसी फ़ाइल यूआरआई से InputImage ऑब्जेक्ट बनाने के लिए, ऐप्लिकेशन संदर्भ और फ़ाइल यूआरआई को InputImage.fromFilePath() पर भेजें. यह तब मददगार होता है, जब आप ACTION_GET_CONTENT इंटेंट का इस्तेमाल करके, उपयोगकर्ता से उनकी गैलरी के ऐप्लिकेशन से कोई इमेज चुनने के लिए कहते हैं.

Kotlin

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

Java

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

ByteBuffer या ByteArray का इस्तेमाल करके

ByteBuffer या ByteArray से InputImage ऑब्जेक्ट बनाने के लिए, पहले इमेज इनपुट के लिए डिग्री का हिसाब लगाएं, जैसा कि पहले media.Image इनपुट में बताया गया है. इसके बाद, बफ़र या अरे के साथ InputImage ऑब्जेक्ट बनाएं. इसमें इमेज की लंबाई, चौड़ाई, कलर एन्कोडिंग का फ़ॉर्मैट, और घुमाव की डिग्री शामिल है.

Kotlin

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

Java

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

Bitmap का इस्तेमाल किया जा रहा है

Bitmap ऑब्जेक्ट से InputImage ऑब्जेक्ट बनाने के लिए, यह एलान करें:

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)

Java

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

इमेज को रोटेशन ऑब्जेक्ट के साथ Bitmap ऑब्जेक्ट के ज़रिए दिखाया जाता है.

3. BarcodeScanner का एक उदाहरण पाएं

Kotlin

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

Java

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

4. इमेज को प्रोसेस करें

इमेज को process तरीके से पास करें:

Kotlin

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

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

5. बारकोड से जानकारी पाएं

अगर बारकोड पहचानने की कार्रवाई पूरी हो जाती है, तो Barcode ऑब्जेक्ट की सूची, सक्सेस लिसनर पर भेज दी जाएगी. हर Barcode ऑब्जेक्ट उस बारकोड को दिखाता है जिसकी इमेज में पता लगाया गया था. हर बारकोड के लिए, आप इनपुट इमेज में इसके बाउंडिंग कोऑर्डिनेट के साथ-साथ बारकोड से एन्कोड किया गया रॉ डेटा पा सकते हैं. साथ ही, अगर बारकोड स्कैनर यह पता लगाने में सफल हुआ था कि बारकोड से कोड किया गया डेटा किस तरह का है, तो आपको पार्स किया गया डेटा वाला एक ऑब्जेक्ट मिल सकता है.

उदाहरण के लिए:

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

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

रीयल-टाइम में परफ़ॉर्मेंस को बेहतर बनाने के लिए सलाह

अगर आप रीयल-टाइम ऐप्लिकेशन में बारकोड स्कैन करना चाहते हैं, तो सबसे अच्छे फ़्रेम रेट पाने के लिए, इन दिशा-निर्देशों का पालन करें:

  • इनपुट को कैमरे के खास रिज़ॉल्यूशन में कैप्चर न करें. कुछ डिवाइसों पर, नेटिव रिज़ॉल्यूशन पर इनपुट कैप्चर करने से बहुत बड़ी (10+ मेगापिक्सल) इमेज बनती हैं. इस वजह से, इंतज़ार का समय बहुत कम होता है और सटीक होने का कोई फ़ायदा नहीं होता. इसके बजाय, बारकोड के लिए ज़रूरी कैमरे से ही साइज़ का अनुरोध करें. आम तौर पर, इसकी दूरी दो मेगापिक्सल से ज़्यादा नहीं होती है.

    अगर स्कैनिंग की गति अहम है, तो इमेज कैप्चर करने के रिज़ॉल्यूशन को कम किया जा सकता है. हालांकि, ध्यान रखें कि ऊपर बताए गए बारकोड के साइज़ की शर्तें कम से कम हों.

    अगर वीडियो स्ट्रीम करने वाले क्रम में मौजूद बारकोड को पहचानने की कोशिश की जा रही है, तो हो सकता है कि पहचानकर्ता फ़्रेम-टू-फ़्रेम पर अलग-अलग नतीजे दिखाए. आपको अच्छे नतीजे देने के लिए, एक ही वैल्यू की लगातार सीरीज़ मिलने तक इंतज़ार करना चाहिए.

    Checksum अंक का इस्तेमाल ITF और CODE-39 के लिए नहीं किया जा सकता.

  • अगर Camera या camera2 एपीआई का इस्तेमाल किया जा रहा है, तो डिटेक्टर को कॉल थ्रॉटल करें. अगर डिटेक्टर चलने के दौरान नया वीडियो फ़्रेम उपलब्ध हो जाता है, तो फ़्रेम छोड़ दें. उदाहरण के लिए, क्विकस्टार्ट सैंपल ऐप्लिकेशन में VisionProcessorBase क्लास देखें.
  • अगर CameraX एपीआई का इस्तेमाल किया जाता है, तो पक्का करें कि बैकप्रेस स्ट्रेटजी इसकी डिफ़ॉल्ट वैल्यू ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST पर सेट हो. इस बात की गारंटी है कि विश्लेषण के लिए एक बार में सिर्फ़ एक इमेज डिलीवर की जाएगी. अगर विश्लेषक के व्यस्त होने पर ज़्यादा इमेज बनाई जाती हैं, तो उन्हें अपने-आप ही छोड़ दिया जाएगा और डिलीवरी के लिए उन्हें सूची में नहीं रखा जाएगा. विश्लेषण की जा रही इमेज को ImageProxy.करीब() बंद करके, अगली नई इमेज डिलीवर की जाएगी.
  • अगर आप इनपुट इमेज पर ग्राफ़िक ओवरले करने के लिए डिटेक्टर के आउटपुट का इस्तेमाल करते हैं, तो पहले ML किट से नतीजा पाएं. इसके बाद, इमेज और ओवरले को एक ही चरण में रेंडर करें. यह डिसप्ले के हर फ़्रेम के लिए सिर्फ़ एक बार डिसप्ले की सतह पर रेंडर होता है. उदाहरण के लिए, क्विकस्टार्ट सैंपल ऐप्लिकेशन में CameraSourcePreview और GraphicOverlay क्लास देखें.
  • Camera2 एपीआई का इस्तेमाल करने पर, इमेज को ImageFormat.YUV_420_888 फ़ॉर्मैट में कैप्चर करें. अगर आप पुराने Camera API का इस्तेमाल करते हैं, तो इमेज को ImageFormat.NV21 फ़ॉर्मैट में कैप्चर करें.