您可以使用 ML Kit 辨識條碼並加以解碼。
事前準備
- 如果您尚未將 Firebase 新增至 Android 專案，請先完成這項操作。
- 將 ML Kit Android 程式庫的依附元件新增至模組 (應用程式層級) Gradle 檔案 (通常是
app/build.gradle)：apply plugin: 'com.android.application' apply plugin: 'com.google.gms.google-services' dependencies { // ... implementation 'com.google.firebase:firebase-ml-vision:24.0.3' implementation 'com.google.firebase:firebase-ml-vision-barcode-model:16.0.1' }
輸入圖片規範
-
為了讓 ML Kit 準確讀取條碼，輸入圖片必須包含以充足的像素資料表示的條碼。
具體的像素資料需求取決於條碼的類型和編碼的資料量 (因為大多數條碼支援可變長度酬載)。一般來說，條碼最小的有意義的單位寬度至少為 2 像素 (2D 代碼寬度至少為 2 像素)。
舉例來說，EAN-13 條碼是由寬度為 1、2、3 或 4 個單位的長條和空間組成，因此在 EAN-13 條碼圖片上，理想的長條和空間大小至少要有 2、4、6 和 8 像素。由於 EAN-13 條碼的總寬為 95 個單位，因此條碼的寬度至少要有 190 像素。
PDF417 等假載格式需要較大的像素尺寸，才能讓 ML Kit 穩定讀取。舉例來說，PDF417 程式碼的單一資料列最多可包含 34 個 17 個單位的「words」，理想寬度至少為 1156 像素。
-
圖片對焦品質不佳可能會降低掃描準確度。如果您仍未取得可接受的結果，請嘗試要求使用者重新拍攝圖片。
-
針對一般應用程式，建議您提供解析度較高的圖片 (例如 1280x720 或 1920x1080)，讓遠離相機遠處的條碼也能偵測條碼。
然而，在對延遲至關重要的應用程式中，您可以採用較低的解析度擷取圖片，藉此改善效能，但由於條碼必須構成輸入圖片大部分的內容。另請參閱「即時效能改善提示」。
1. 設定條碼偵測工具
如果您知道自己預期讀取的條碼格式，可以將條碼偵測工具設為僅偵測這些格式，藉此加快條碼偵測工具的速度。舉例來說，如果只要偵測 Aztec code 和 QR code，請建構 FirebaseVisionBarcodeDetectorOptions 物件，如以下範例所示：
Java
FirebaseVisionBarcodeDetectorOptions options =
new FirebaseVisionBarcodeDetectorOptions.Builder()
.setBarcodeFormats(
FirebaseVisionBarcode.FORMAT_QR_CODE,
FirebaseVisionBarcode.FORMAT_AZTEC)
.build();Kotlin+KTX
val options = FirebaseVisionBarcodeDetectorOptions.Builder()
.setBarcodeFormats(
FirebaseVisionBarcode.FORMAT_QR_CODE,
FirebaseVisionBarcode.FORMAT_AZTEC)
.build()支援下列格式：
- 代碼 128 (
FORMAT_CODE_128) - 代碼 39 (
FORMAT_CODE_39) - 代碼 93 (
FORMAT_CODE_93) - 科達巴 (
FORMAT_CODABAR) - EAN-13 (
FORMAT_EAN_13) - EAN-8 (
FORMAT_EAN_8) - ITF (
FORMAT_ITF) - 通用產品代碼 (
FORMAT_UPC_A) - UPC-E (
FORMAT_UPC_E) - QR code (
FORMAT_QR_CODE) - PDF417 (
FORMAT_PDF417) - 阿茲特克 (
FORMAT_AZTEC) - 資料矩陣 (
FORMAT_DATA_MATRIX)
2. 執行條碼偵測工具
如要辨識圖片中的條碼，請透過Bitmap、media.Image、ByteBuffer、位元組陣列或裝置上的檔案建立 FirebaseVisionImage 物件。然後將 FirebaseVisionImage 物件傳遞至 FirebaseVisionBarcodeDetector 的 detectInImage 方法。
使用圖片建立
FirebaseVisionImage物件。-
如要從
media.Image物件建立FirebaseVisionImage物件 (例如從裝置相機擷取圖片)，請將media.Image物件和圖片的旋轉角度傳遞至FirebaseVisionImage.fromMediaImage()。如果您使用 CameraX 程式庫，
OnImageCapturedListener和ImageAnalysis.Analyzer類別會為您計算旋轉值，因此只要在呼叫FirebaseVisionImage.fromMediaImage()之前，將旋轉角度轉換為 ML Kit 的ROTATION_常數即可：Java
private class YourAnalyzer implements ImageAnalysis.Analyzer { private int degreesToFirebaseRotation(int degrees) { switch (degrees) { case 0: return FirebaseVisionImageMetadata.ROTATION_0; case 90: return FirebaseVisionImageMetadata.ROTATION_90; case 180: return FirebaseVisionImageMetadata.ROTATION_180; case 270: return FirebaseVisionImageMetadata.ROTATION_270; default: throw new IllegalArgumentException( "Rotation must be 0, 90, 180, or 270."); } } @Override public void analyze(ImageProxy imageProxy, int degrees) { if (imageProxy == null || imageProxy.getImage() == null) { return; } Image mediaImage = imageProxy.getImage(); int rotation = degreesToFirebaseRotation(degrees); FirebaseVisionImage image = FirebaseVisionImage.fromMediaImage(mediaImage, rotation); // Pass image to an ML Kit Vision API // ... } }Kotlin+KTX
private class YourImageAnalyzer : ImageAnalysis.Analyzer { private fun degreesToFirebaseRotation(degrees: Int): Int = when(degrees) { 0 -> FirebaseVisionImageMetadata.ROTATION_0 90 -> FirebaseVisionImageMetadata.ROTATION_90 180 -> FirebaseVisionImageMetadata.ROTATION_180 270 -> FirebaseVisionImageMetadata.ROTATION_270 else -> throw Exception("Rotation must be 0, 90, 180, or 270.") } override fun analyze(imageProxy: ImageProxy?, degrees: Int) { val mediaImage = imageProxy?.image val imageRotation = degreesToFirebaseRotation(degrees) if (mediaImage != null) { val image = FirebaseVisionImage.fromMediaImage(mediaImage, imageRotation) // Pass image to an ML Kit Vision API // ... } } }如果您使用的相機程式庫不提供圖像旋轉功能，您可依據裝置旋轉情形和裝置相機感應器方向計算曝光：
Java
private static final SparseIntArray ORIENTATIONS = new SparseIntArray(); static { ORIENTATIONS.append(Surface.ROTATION_0, 90); ORIENTATIONS.append(Surface.ROTATION_90, 0); ORIENTATIONS.append(Surface.ROTATION_180, 270); ORIENTATIONS.append(Surface.ROTATION_270, 180); } /** * 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, Context context) 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); // On most devices, the sensor orientation is 90 degrees, but for some // devices it is 270 degrees. For devices with a sensor orientation of // 270, rotate the image an additional 180 ((270 + 270) % 360) degrees. CameraManager cameraManager = (CameraManager) context.getSystemService(CAMERA_SERVICE); int sensorOrientation = cameraManager .getCameraCharacteristics(cameraId) .get(CameraCharacteristics.SENSOR_ORIENTATION); rotationCompensation = (rotationCompensation + sensorOrientation + 270) % 360; // Return the corresponding FirebaseVisionImageMetadata rotation value. int result; switch (rotationCompensation) { case 0: result = FirebaseVisionImageMetadata.ROTATION_0; break; case 90: result = FirebaseVisionImageMetadata.ROTATION_90; break; case 180: result = FirebaseVisionImageMetadata.ROTATION_180; break; case 270: result = FirebaseVisionImageMetadata.ROTATION_270; break; default: result = FirebaseVisionImageMetadata.ROTATION_0; Log.e(TAG, "Bad rotation value: " + rotationCompensation); } return result; }Kotlin+KTX
private val ORIENTATIONS = SparseIntArray() init { ORIENTATIONS.append(Surface.ROTATION_0, 90) ORIENTATIONS.append(Surface.ROTATION_90, 0) ORIENTATIONS.append(Surface.ROTATION_180, 270) ORIENTATIONS.append(Surface.ROTATION_270, 180) } /** * 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, context: Context): 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) // On most devices, the sensor orientation is 90 degrees, but for some // devices it is 270 degrees. For devices with a sensor orientation of // 270, rotate the image an additional 180 ((270 + 270) % 360) degrees. val cameraManager = context.getSystemService(CAMERA_SERVICE) as CameraManager val sensorOrientation = cameraManager .getCameraCharacteristics(cameraId) .get(CameraCharacteristics.SENSOR_ORIENTATION)!! rotationCompensation = (rotationCompensation + sensorOrientation + 270) % 360 // Return the corresponding FirebaseVisionImageMetadata rotation value. val result: Int when (rotationCompensation) { 0 -> result = FirebaseVisionImageMetadata.ROTATION_0 90 -> result = FirebaseVisionImageMetadata.ROTATION_90 180 -> result = FirebaseVisionImageMetadata.ROTATION_180 270 -> result = FirebaseVisionImageMetadata.ROTATION_270 else -> { result = FirebaseVisionImageMetadata.ROTATION_0 Log.e(TAG, "Bad rotation value: $rotationCompensation") } } return result }然後將
media.Image物件和旋轉值傳遞至FirebaseVisionImage.fromMediaImage()：Java
FirebaseVisionImage image = FirebaseVisionImage.fromMediaImage(mediaImage, rotation);
Kotlin+KTX
val image = FirebaseVisionImage.fromMediaImage(mediaImage, rotation)
- 如要從檔案 URI 建立
FirebaseVisionImage物件，請將應用程式結構定義和檔案 URI 傳遞至FirebaseVisionImage.fromFilePath()。使用ACTION_GET_CONTENT意圖提示使用者從圖片庫應用程式中選取圖片時，這項功能就很實用。Java
FirebaseVisionImage image; try { image = FirebaseVisionImage.fromFilePath(context, uri); } catch (IOException e) { e.printStackTrace(); }Kotlin+KTX
val image: FirebaseVisionImage try { image = FirebaseVisionImage.fromFilePath(context, uri) } catch (e: IOException) { e.printStackTrace() } - 如要從
ByteBuffer或位元組陣列建立FirebaseVisionImage物件，請先按照上述的media.Image輸入方式計算圖片旋轉角度。接著，建立
FirebaseVisionImageMetadata物件，其中包含圖片的高度、寬度、顏色編碼格式和旋轉：Java
FirebaseVisionImageMetadata metadata = new FirebaseVisionImageMetadata.Builder() .setWidth(480) // 480x360 is typically sufficient for .setHeight(360) // image recognition .setFormat(FirebaseVisionImageMetadata.IMAGE_FORMAT_NV21) .setRotation(rotation) .build();Kotlin+KTX
val metadata = FirebaseVisionImageMetadata.Builder() .setWidth(480) // 480x360 is typically sufficient for .setHeight(360) // image recognition .setFormat(FirebaseVisionImageMetadata.IMAGE_FORMAT_NV21) .setRotation(rotation) .build()使用緩衝區或陣列和中繼資料物件建立
FirebaseVisionImage物件：Java
FirebaseVisionImage image = FirebaseVisionImage.fromByteBuffer(buffer, metadata); // Or: FirebaseVisionImage image = FirebaseVisionImage.fromByteArray(byteArray, metadata);
Kotlin+KTX
val image = FirebaseVisionImage.fromByteBuffer(buffer, metadata) // Or: val image = FirebaseVisionImage.fromByteArray(byteArray, metadata)
- 如要從
Bitmap物件建立FirebaseVisionImage物件，請按照下列步驟操作：Java
FirebaseVisionImage image = FirebaseVisionImage.fromBitmap(bitmap);
Kotlin+KTX
val image = FirebaseVisionImage.fromBitmap(bitmap)
Bitmap物件代表的圖片必須直立，無需額外旋轉。
-
取得
FirebaseVisionBarcodeDetector的執行個體：Java
FirebaseVisionBarcodeDetector detector = FirebaseVision.getInstance() .getVisionBarcodeDetector(); // Or, to specify the formats to recognize: // FirebaseVisionBarcodeDetector detector = FirebaseVision.getInstance() // .getVisionBarcodeDetector(options);Kotlin+KTX
val detector = FirebaseVision.getInstance() .visionBarcodeDetector // Or, to specify the formats to recognize: // val detector = FirebaseVision.getInstance() // .getVisionBarcodeDetector(options)最後，將圖片傳遞至
detectInImage方法：Java
Task<List<FirebaseVisionBarcode>> result = detector.detectInImage(image) .addOnSuccessListener(new OnSuccessListener<List<FirebaseVisionBarcode>>() { @Override public void onSuccess(List<FirebaseVisionBarcode> barcodes) { // Task completed successfully // ... } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Task failed with an exception // ... } });Kotlin+KTX
val result = detector.detectInImage(image) .addOnSuccessListener { barcodes -> // Task completed successfully // ... } .addOnFailureListener { // Task failed with an exception // ... }
3. 透過條碼取得資訊
如果條碼辨識作業成功，系統會將FirebaseVisionBarcode 物件清單傳遞至成功事件監聽器。每個 FirebaseVisionBarcode 物件都代表在圖片中偵測到的條碼。您可以在輸入圖片中取得各條碼的定界座標，以及透過條碼編碼的原始資料。此外，如果條碼偵測工具能夠判斷條碼編碼的資料類型，您就能取得包含剖析資料的物件。
例如：
Java
for (FirebaseVisionBarcode 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 FirebaseVisionBarcode.TYPE_WIFI:
String ssid = barcode.getWifi().getSsid();
String password = barcode.getWifi().getPassword();
int type = barcode.getWifi().getEncryptionType();
break;
case FirebaseVisionBarcode.TYPE_URL:
String title = barcode.getUrl().getTitle();
String url = barcode.getUrl().getUrl();
break;
}
}Kotlin+KTX
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) {
FirebaseVisionBarcode.TYPE_WIFI -> {
val ssid = barcode.wifi!!.ssid
val password = barcode.wifi!!.password
val type = barcode.wifi!!.encryptionType
}
FirebaseVisionBarcode.TYPE_URL -> {
val title = barcode.url!!.title
val url = barcode.url!!.url
}
}
}即時效能改善訣竅
如要在即時應用程式中掃描條碼，請遵循下列準則，以達到最佳影格速率：
-
請勿以相機原始解析度擷取輸入內容。在某些裝置上，以原生解析度擷取輸入內容會產生極大 (超過 1,000 萬像素) 的圖片，因此可大幅降低延遲，且無法提升準確率。而是只向偵測條碼所需的相機要求大小：通常不超過 200 萬像素。
如果掃描速度很重要，可以進一步降低圖片拍攝解析度。但請注意，上述的條碼大小下限規定。
- 限制對偵測工具的呼叫。如果在偵測工具執行時有新的影片影格，請捨棄影格。
- 如果您使用偵測工具的輸出內容，在輸入圖片上疊加圖像，請先從 ML Kit 取得結果，然後透過一個步驟算繪圖像和疊加層。這樣一來，每個輸入影格就只會算繪到顯示介面一次。
-
如果你使用 Camera2 API，請擷取
ImageFormat.YUV_420_888格式的圖片。如果您使用舊版 Camera API，請拍攝
ImageFormat.NV21格式的圖片。