بارکدها را با ML Kit در اندروید اسکن کنید

شما می‌توانید از کیت ML برای شناسایی و رمزگشایی بارکدها استفاده کنید.

ویژگی بدون دسته بندی بسته‌بندی شده
پیاده‌سازی مدل به صورت پویا از طریق سرویس‌های گوگل پلی دانلود می‌شود. مدل در زمان ساخت به صورت ایستا به برنامه شما متصل است.
اندازه برنامه حدود ۲۰۰ کیلوبایت افزایش حجم. حدود ۲.۴ مگابایت افزایش حجم.
زمان اولیه سازی ممکن است لازم باشد قبل از اولین استفاده، منتظر دانلود مدل باشید. مدل فوراً موجود است.

امتحانش کن.

قبل از اینکه شروع کنی

  1. در فایل build.gradle سطح پروژه خود، مطمئن شوید که مخزن Maven گوگل را هم در بخش‌های buildscript و هم allprojects خود وارد کرده‌اید.

  2. وابستگی‌های کتابخانه‌های اندروید 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'
    }
    

    برای استفاده از مدل در سرویس‌های گوگل پلی:

    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. اگر تصمیم دارید از مدل در سرویس‌های گوگل پلی استفاده کنید ، می‌توانید برنامه خود را طوری پیکربندی کنید که پس از نصب برنامه از فروشگاه پلی استور، مدل را به طور خودکار روی دستگاه دانلود کند. برای انجام این کار، اعلان زیر را به فایل 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 سرویس‌های گوگل پلی درخواست دانلود دهید.

    اگر دانلود مدل در زمان نصب را فعال نکنید یا درخواست دانلود صریح را ندهید، مدل در اولین باری که اسکنر را اجرا می‌کنید دانلود می‌شود. درخواست‌هایی که قبل از اتمام دانلود انجام می‌دهید، هیچ نتیجه‌ای ندارند.

دستورالعمل‌های تصویر ورودی

  • برای اینکه کیت ML بارکدها را به طور دقیق بخواند، تصاویر ورودی باید حاوی بارکدهایی باشند که با داده‌های پیکسلی کافی نمایش داده شوند.

    الزامات خاص داده‌های پیکسلی به نوع بارکد و میزان داده‌های کدگذاری شده در آن بستگی دارد، زیرا بسیاری از بارکدها از ظرفیت بار متغیر پشتیبانی می‌کنند. به طور کلی، کوچکترین واحد معنادار بارکد باید حداقل 2 پیکسل عرض و برای کدهای دوبعدی، 2 پیکسل ارتفاع داشته باشد.

    برای مثال، بارکدهای EAN-13 از میله‌ها و فضاهایی با عرض ۱، ۲، ۳ یا ۴ واحد تشکیل شده‌اند، بنابراین یک تصویر بارکد EAN-13 در حالت ایده‌آل دارای میله‌ها و فضاهایی با عرض حداقل ۲، ۴، ۶ و ۸ پیکسل است. از آنجا که یک بارکد EAN-13 در مجموع ۹۵ واحد عرض دارد، بارکد باید حداقل ۱۹۰ پیکسل عرض داشته باشد.

    فرمت‌های متراکم‌تر، مانند PDF417، برای اینکه ML Kit بتواند آنها را به طور قابل اعتمادی بخواند، به ابعاد پیکسلی بیشتری نیاز دارند. برای مثال، یک کد PDF417 می‌تواند تا ۳۴ "کلمه" با عرض ۱۷ واحد در یک ردیف داشته باشد که در حالت ایده‌آل حداقل ۱۱۵۶ پیکسل عرض خواهد داشت.

  • فوکوس ضعیف تصویر می‌تواند بر دقت اسکن تأثیر بگذارد. اگر برنامه شما نتایج قابل قبولی ارائه نمی‌دهد، از کاربر بخواهید که تصویر را دوباره ثبت کند.

  • برای کاربردهای معمول، توصیه می‌شود تصویری با وضوح بالاتر، مانند ۱۲۸۰x۷۲۰ یا ۱۹۲۰x۱۰۸۰، ارائه دهید که باعث می‌شود بارکدها از فاصله بیشتری نسبت به دوربین قابل اسکن باشند.

    با این حال، در برنامه‌هایی که تأخیر بسیار مهم است، می‌توانید با گرفتن تصاویر با وضوح پایین‌تر، عملکرد را بهبود بخشید، اما لازم است که بارکد بخش عمده تصویر ورودی را تشکیل دهد. همچنین به نکاتی برای بهبود عملکرد در زمان واقعی مراجعه کنید.

۱. اسکنر بارکد را پیکربندی کنید

اگر می‌دانید کدام فرمت‌های بارکد را می‌خواهید بخوانید، می‌توانید با پیکربندی آشکارساز بارکد برای شناسایی فقط آن فرمت‌ها، سرعت آن را بهبود بخشید.

برای مثال، برای شناسایی فقط کدهای Aztec و کدهای QR، یک شیء BarcodeScannerOptions مانند مثال زیر بسازید:

کاتلین

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

جاوا

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

فرمت‌های زیر پشتیبانی می‌شوند:

  • کد ۱۲۸ ( FORMAT_CODE_128 )
  • کد ۳۹ ( FORMAT_CODE_39 )
  • کد ۹۳ ( 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 )

با شروع از مدل بسته‌بندی‌شده‌ی ۱۷.۱.۰ و مدل بسته‌بندی‌نشده‌ی ۱۸.۲.۰، می‌توانید تابع 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
}

جاوا

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)

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

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
)
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)

جاوا

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

برای ایجاد یک شیء InputImage از یک شیء Bitmap ، تعریف زیر را انجام دهید:

کاتلین

val image = InputImage.fromBitmap(bitmap, 0)

Java

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

تصویر توسط یک شیء Bitmap به همراه درجه چرخش نمایش داده می‌شود.

۳. یک نمونه از BarcodeScanner دریافت کنید

کاتلین

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

جاوا

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

۴. تصویر را پردازش کنید

تصویر را به متد process ارسال کنید:

کاتلین

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

جاوا

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

۵. دریافت اطلاعات از بارکدها

اگر عملیات تشخیص بارکد با موفقیت انجام شود، فهرستی از اشیاء 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
        }
    }
}

جاوا

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

نکاتی برای بهبود عملکرد در زمان واقعی

اگر می‌خواهید بارکدها را در یک برنامه بلادرنگ اسکن کنید، برای دستیابی به بهترین نرخ فریم، این دستورالعمل‌ها را دنبال کنید:

  • ورودی را با وضوح اصلی دوربین ضبط نکنید. در برخی دستگاه‌ها، ضبط ورودی با وضوح اصلی، تصاویر بسیار بزرگی (۱۰+ مگاپیکسل) تولید می‌کند که منجر به تأخیر بسیار کم و بدون هیچ مزیتی برای دقت می‌شود. در عوض، فقط اندازه‌ای را از دوربین درخواست کنید که برای تشخیص بارکد مورد نیاز است، که معمولاً بیش از ۲ مگاپیکسل نیست.

    اگر سرعت اسکن مهم است، می‌توانید وضوح تصویر را بیشتر کاهش دهید. با این حال، حداقل اندازه بارکد ذکر شده در بالا را در نظر داشته باشید.

    اگر می‌خواهید بارکدها را از یک توالی فریم‌های ویدیویی در حال پخش تشخیص دهید، ممکن است تشخیص‌دهنده از فریمی به فریم دیگر نتایج متفاوتی تولید کند. باید صبر کنید تا یک سری متوالی از مقادیر یکسان را دریافت کنید تا مطمئن شوید که نتیجه خوبی را برمی‌گردانید.

    رقم Checksum برای ITF و CODE-39 پشتیبانی نمی‌شود.

  • اگر از API Camera یا camera2 استفاده می‌کنید، فراخوانی‌های throttle به آشکارساز انجام می‌شود. اگر در حین اجرای آشکارساز، یک فریم ویدیویی جدید در دسترس قرار گرفت، فریم را حذف کنید. برای مثال، به کلاس VisionProcessorBase در برنامه نمونه شروع سریع مراجعه کنید.
  • اگر از API CameraX استفاده می‌کنید، مطمئن شوید که استراتژی فشار معکوس (backpressure strategy) روی مقدار پیش‌فرض خود ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST تنظیم شده است. این تضمین می‌کند که فقط یک تصویر در هر زمان برای تجزیه و تحلیل تحویل داده می‌شود. اگر تصاویر بیشتری هنگام مشغول بودن تحلیلگر تولید شوند، به طور خودکار حذف می‌شوند و برای تحویل در صف قرار نمی‌گیرند. پس از بسته شدن تصویر در حال تجزیه و تحلیل با فراخوانی ImageProxy.close()، آخرین تصویر بعدی تحویل داده می‌شود.
  • اگر از خروجی آشکارساز برای همپوشانی گرافیک روی تصویر ورودی استفاده می‌کنید، ابتدا نتیجه را از کیت ML دریافت کنید، سپس تصویر و همپوشانی را در یک مرحله رندر کنید. این کار فقط یک بار برای هر فریم ورودی روی سطح نمایشگر رندر می‌شود. برای مثال به کلاس‌های CameraSourcePreview و GraphicOverlay در برنامه نمونه شروع سریع مراجعه کنید.
  • اگر از API دوربین ۲ استفاده می‌کنید، تصاویر را با فرمت ImageFormat.YUV_420_888 ضبط کنید. اگر از API دوربین قدیمی‌تر استفاده می‌کنید، تصاویر را با فرمت ImageFormat.NV21 ضبط کنید.