Merge pull request #271 from BlinkID/release/v5.16.0

Release/v5.16.0

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
 Before opening an issue, check that you are using the latest version of the BlinkID SDK.
 
-Also, make sure your issue isn't on [the list of common problems.](https://github.com/BlinkID/blinkid-android#-frequently-asked-questions-and-known-problems)
+Also, make sure your issue isn't on [the list of common problems.](https://github.com/BlinkID/blinkid-android#-faq-and-known-issues)
 
 ---
 

BlinkIDSample/LibUtils/src/main/java/com/microblink/result/extract/blinkid/BlinkIdExtractor.java

@@ -12,6 +12,8 @@
 package com.microblink.result.extract.blinkid;
 
 import com.microblink.entities.recognizers.Recognizer;
+import com.microblink.entities.recognizers.blinkid.generic.DriverLicenseDetailedInfo;
+import com.microblink.entities.recognizers.blinkid.generic.VehicleClassInfo;
 import com.microblink.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult;
 import com.microblink.entities.recognizers.blinkid.imageresult.EncodedFullDocumentImageResult;
 import com.microblink.entities.recognizers.blinkid.imageresult.EncodedSignatureImageResult;
@@ -110,4 +112,16 @@ protected static boolean shouldShowEncodedImageEntry(byte[] encodedImage) {
         return encodedImage != null && encodedImage.length > 0;
     }
 
+    protected String extractVehicleClassesInfo(DriverLicenseDetailedInfo driverLicenseInfo) {
+        StringBuilder vehicleClassInfoResult = new StringBuilder();
+        for (VehicleClassInfo vehicleClassInfo : driverLicenseInfo.getVehicleClassesInfo()) {
+            vehicleClassInfoResult.append(vehicleClassInfo.getVehicleClass()).append(" ")
+                    .append(vehicleClassInfo.getLicenceType()).append(" ")
+                    .append(vehicleClassInfo.getEffectiveDate().getOriginalDateString()).append(" ")
+                    .append(vehicleClassInfo.getExpiryDate().getOriginalDateString())
+                    .append("\n");
+        }
+        return vehicleClassInfoResult.toString();
+    }
+
 }

BlinkIDSample/LibUtils/src/main/java/com/microblink/result/extract/blinkid/generic/BlinkIDCombinedRecognizerResultExtractor.java

@@ -58,6 +58,7 @@ private void extractMixedResults(BlinkIdCombinedRecognizer.Result result) {
 
         add(R.string.PPAddress, result.getAddress());
         add(R.string.PPAdditionalAddressInformation, result.getAdditionalAddressInformation());
+        add(R.string.PPAdditionalOptionalAddressInformation, result.getAdditionalOptionalAddressInformation());
         add(R.string.PPDateOfBirth, result.getDateOfBirth());
         int age = result.getAge();
         if (age != -1) {
@@ -90,6 +91,7 @@ private void extractMixedResults(BlinkIdCombinedRecognizer.Result result) {
             add(R.string.PPEndorsements, driverLicenseInfo.getEndorsements());
             add(R.string.PPVehicleClass, driverLicenseInfo.getVehicleClass());
             add(R.string.PPConditions, driverLicenseInfo.getConditions());
+            add(R.string.PPVehicleClassesInfo, extractVehicleClassesInfo(driverLicenseInfo));
         }
 
         ClassInfo classInfo = result.getClassInfo();
@@ -121,6 +123,10 @@ private void extractMixedResults(BlinkIdCombinedRecognizer.Result result) {
         add(R.string.MBRecognitionMode, result.getRecognitionMode().name());
 
         add(R.string.PPDocumentBothSidesMatch, result.getDocumentDataMatch().name());
+
+        add(R.string.MBFrontCameraFrame, result.getFrontCameraFrame());
+        add(R.string.MBBackCameraFrame, result.getBackCameraFrame());
+        add(R.string.MBBarcodeCameraFrame, result.getBarcodeCameraFrame());
     }
 
     private void extractVisualResults(VizResult result) {
@@ -135,6 +141,7 @@ private void extractVisualResults(VizResult result) {
 
         addIfNotEmpty(R.string.PPAddress, result.getAddress());
         addIfNotEmpty(R.string.PPAdditionalAddressInformation, result.getAdditionalAddressInformation());
+        addIfNotEmpty(R.string.PPAdditionalOptionalAddressInformation, result.getAdditionalOptionalAddressInformation());
         addIfNotEmpty(R.string.PPDateOfBirth, result.getDateOfBirth());
 
         addIfNotEmpty(R.string.PPIssueDate, result.getDateOfIssue());
@@ -164,6 +171,7 @@ private void extractVisualResults(VizResult result) {
             addIfNotEmpty(R.string.PPEndorsements, driverLicenseInfo.getEndorsements());
             addIfNotEmpty(R.string.PPVehicleClass, driverLicenseInfo.getVehicleClass());
             addIfNotEmpty(R.string.PPConditions, driverLicenseInfo.getConditions());
+            addIfNotEmpty(R.string.PPVehicleClassesInfo, extractVehicleClassesInfo(driverLicenseInfo));
         }
     }
 
@@ -212,11 +220,12 @@ private void extractBarcodeResults(BarcodeResult result) {
             addIfNotEmpty(R.string.PPEndorsements, driverLicenseInfo.getEndorsements());
             addIfNotEmpty(R.string.PPVehicleClass, driverLicenseInfo.getVehicleClass());
             addIfNotEmpty(R.string.PPConditions, driverLicenseInfo.getConditions());
+            addIfNotEmpty(R.string.PPVehicleClassesInfo, extractVehicleClassesInfo(driverLicenseInfo));
         }
 
         BarcodeElements extendedElements = result.getExtendedElements();
         if (!extendedElements.isEmpty()) {
-            for (BarcodeElementKey key: BarcodeElementKey.values()) {
+            for (BarcodeElementKey key : BarcodeElementKey.values()) {
                 String barcodeElement = extendedElements.getValue(key);
                 if (!barcodeElement.isEmpty()) {
                     add(R.string.PPExtendedBarcodeData, key.name() + ": " + barcodeElement);

BlinkIDSample/LibUtils/src/main/java/com/microblink/result/extract/blinkid/generic/BlinkIDRecognizerResultExtractor.java

@@ -58,6 +58,7 @@ private void extractMixedResults(BlinkIdRecognizer.Result result) {
 
         add(R.string.PPAddress, result.getAddress());
         add(R.string.PPAdditionalAddressInformation, result.getAdditionalAddressInformation());
+        add(R.string.PPAdditionalOptionalAddressInformation, result.getAdditionalOptionalAddressInformation());
         add(R.string.PPDateOfBirth, result.getDateOfBirth());
         int age = result.getAge();
         if (age != -1) {
@@ -90,6 +91,7 @@ private void extractMixedResults(BlinkIdRecognizer.Result result) {
             add(R.string.PPEndorsements, driverLicenseInfo.getEndorsements());
             add(R.string.PPVehicleClass, driverLicenseInfo.getVehicleClass());
             add(R.string.PPConditions, driverLicenseInfo.getConditions());
+            addIfNotEmpty(R.string.PPVehicleClassesInfo, extractVehicleClassesInfo(driverLicenseInfo));
         }
 
         ClassInfo classInfo = result.getClassInfo();
@@ -110,6 +112,9 @@ private void extractMixedResults(BlinkIdRecognizer.Result result) {
 
         add(R.string.MBProcessingStatus, result.getProcessingStatus().name());
         add(R.string.MBRecognitionMode, result.getRecognitionMode().name());
+
+        add(R.string.MBCameraFrame, result.getCameraFrame());
+        add(R.string.MBBarcodeCameraFrame, result.getBarcodeCameraFrame());
     }
 
     private void extractVisualResults(VizResult result) {
@@ -124,6 +129,7 @@ private void extractVisualResults(VizResult result) {
 
         addIfNotEmpty(R.string.PPAddress, result.getAddress());
         addIfNotEmpty(R.string.PPAdditionalAddressInformation, result.getAdditionalAddressInformation());
+        addIfNotEmpty(R.string.PPAdditionalOptionalAddressInformation, result.getAdditionalOptionalAddressInformation());
         addIfNotEmpty(R.string.PPDateOfBirth, result.getDateOfBirth());
 
         addIfNotEmpty(R.string.PPIssueDate, result.getDateOfIssue());
@@ -201,6 +207,7 @@ private void extractBarcodeResults(BarcodeResult result) {
             addIfNotEmpty(R.string.PPEndorsements, driverLicenseInfo.getEndorsements());
             addIfNotEmpty(R.string.PPVehicleClass, driverLicenseInfo.getVehicleClass());
             addIfNotEmpty(R.string.PPConditions, driverLicenseInfo.getConditions());
+            add(R.string.PPVehicleClassesInfo, extractVehicleClassesInfo(driverLicenseInfo));
         }
 
         BarcodeElements extendedElements = result.getExtendedElements();

BlinkIDSample/LibUtils/src/main/res/drawable/ic_launcher_foreground.xml

@@ -3,28 +3,13 @@
     android:height="108dp"
     android:viewportWidth="108"
     android:viewportHeight="108">
-  <path
-      android:pathData="M35.633,33.897L33.827,35.701L38.49,40.357L40.296,38.553L35.633,33.897Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M39.594,52.755H33V55.306H39.594V52.755Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M72.279,33.836L67.617,38.492L69.423,40.296L74.085,35.64L72.279,33.836Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M55.218,33H52.664V39.585H55.218V33Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M75,52.696H68.406V55.247H75V52.696Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M69.439,67.643L67.633,69.447L72.296,74.103L74.102,72.299L69.439,67.643Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M38.506,67.705L33.843,72.361L35.65,74.165L40.312,69.509L38.506,67.705Z"
-      android:fillColor="#48B2E8"/>
-  <path
-      android:pathData="M55.277,68.415H52.723V75H55.277V68.415Z"
-      android:fillColor="#48B2E8"/>
+  <group android:scaleX="0.09104651"
+      android:scaleY="0.09104651"
+      android:translateX="22.68"
+      android:translateY="22.68">
+    <path
+        android:pathData="M604.548,125.826L683.117,321.911C686.444,330.199 688.102,339.062 687.995,347.993C687.895,356.923 686.031,365.746 682.51,373.955L599.367,568.212C595.858,576.413 590.768,583.842 584.387,590.075C578.007,596.308 570.461,601.223 562.181,604.54L366.03,683.123C357.748,686.445 348.894,688.096 339.972,687.996C331.05,687.889 322.235,686.032 314.033,682.517L119.773,599.359C103.214,592.268 90.147,578.893 83.443,562.174L4.876,366.025C1.557,357.746 -0.099,348.894 0.005,339.975C0.108,331.056 1.969,322.244 5.48,314.044L88.624,119.771C95.716,103.213 109.092,90.147 125.811,83.443L321.961,4.876C330.244,1.556 339.1,-0.099 348.022,0.005C356.944,0.108 365.758,1.969 373.96,5.48L568.219,88.624C576.422,92.134 583.853,97.225 590.087,103.609C596.321,109.993 601.234,117.542 604.548,125.826ZM491.539,478.572C506.652,470.796 523.138,462.315 541.221,452.409C571.017,436.168 592.693,408.087 598.192,382.406C604.231,356.472 594.028,332.952 573.56,320.048C526.827,290.114 507.633,252.812 478.6,196.39C470.827,181.284 462.349,164.808 452.449,146.736C436.287,116.924 408.207,95.216 382.526,89.765C356.591,83.711 333.071,93.929 320.167,114.397C290.238,161.119 252.947,180.305 196.544,209.322C181.429,217.099 164.94,225.582 146.852,235.49C117.04,251.747 95.347,279.827 89.88,305.508C83.841,331.427 94.044,354.963 114.512,367.85C161.245,397.785 180.439,435.086 209.472,491.509C217.244,506.615 225.722,523.091 235.622,541.162C251.784,570.975 279.865,592.683 305.546,598.134C331.481,604.188 355.001,593.986 367.905,573.517C397.835,526.78 435.131,507.593 491.539,478.572Z"
+        android:fillColor="#142641"
+        android:fillType="evenOdd"/>
+  </group>
 </vector>

BlinkIDSample/LibUtils/src/main/res/layout/activity_menu_list.xml

@@ -9,7 +9,7 @@
         android:id="@+id/txtTitle"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
-        android:background="#48B2E8"
+        android:background="@color/mb_blue_cobalt"
         android:gravity="center"
         android:padding="8dp"
         android:textColor="#FFFFFF"

BlinkIDSample/LibUtils/src/main/res/mipmap-anydpi-v26/ic_launcher.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
-    <background android:drawable="@color/mb_white"/>
+    <background android:drawable="@color/mb_brand_white"/>
     <foreground android:drawable="@drawable/ic_launcher_foreground"/>
 </adaptive-icon>

BlinkIDSample/LibUtils/src/main/res/values/colors.xml

@@ -2,7 +2,7 @@
 <resources>
     <color name="background">#333333</color>
     <color name="backgroundDark">#222222</color>
-    <color name="microblink_blue">#48B2E8</color>
+    <color name="microblink_blue">#0062F2</color>
     <color name="textColor">#FFF</color>
     <color name="preview_overlay_color">#22000000</color>
 </resources>

BlinkIDSample/LibUtils/src/main/res/values/resultActivityStrings.xml

@@ -8,6 +8,9 @@
     <!-- RecognitionResult strings -->
     <string name="PPAmount">Amount</string>
     <string name="PPParsedAmount">Parsed Amount</string>
+    <string name="PPAmountEur">Amount EUR</string>
+    <string name="PPAmountHrk">Amount HRK</string>
+    <string name="PPConversionToEurPerformed">Conversion to EUR performed</string>
     <string name="PPCurrency">Currency</string>
     <string name="PPCurrencyCode">Currency code</string>
     <string name="PPAccount">Account</string>
@@ -132,6 +135,7 @@
     <string name="PPPostalCode">Postal Code</string>
     <string name="PPJurisdiction">Jurisdiction</string>
     <string name="PPAdditionalAddressInformation">Additional Address Information</string>
+    <string name="PPAdditionalOptionalAddressInformation">Additional Optional Address Information</string>
     <string name="PPResidence">Residence</string>
     <string name="PPAddressChangeDate">Date of address change</string>
     <string name="PPFacultyAddress">Faculty Address</string>
@@ -213,6 +217,7 @@
     <string name="PPLicenceCategories">Licence Categories</string>
     <string name="PPVehicleCategories">Vehicle Categories</string>
     <string name="PPVehicleClass">Vehicle Class</string>
+    <string name="PPVehicleClassesInfo">Vehicle Classes info</string>
     <string name="PPLicencingAuthority">Licencing Authority</string>
     <string name="PPAlternativeSchemeParameters">Alternative scheme parameters</string>
     <string name="PPAdditionalInformation">Additional information</string>
@@ -297,6 +302,10 @@
     <string name="MBSignatureImage">Signature image</string>
     <string name="MBEncodedSignatureImage">Encoded signature image</string>
     <string name="MBHighResImage">High resolution image</string>
+    <string name="MBCameraFrame">Raw camera frame</string>
+    <string name="MBFrontCameraFrame">Front raw camera frame</string>
+    <string name="MBBackCameraFrame">Back raw camera frame</string>
+    <string name="MBBarcodeCameraFrame">Barcode raw camera frame</string>
 
     <string name="MBDocumentImageColorStatus">Image color status</string>
     <string name="MBDocumentFrontImageColorStatus">Front image color status</string>

BlinkIDSample/LibUtils/src/main/res/values/styles.xml

@@ -20,7 +20,7 @@
     <style name="TextResultLabel">
         <item name="android:textSize">12sp</item>
         <item name="android:textAllCaps">true</item>
-        <item name="android:textColor">@color/mb_blue</item>
+        <item name="android:textColor">@color/mb_blue_cobalt</item>
     </style>
 
 </resources>

BlinkIDSample/build.gradle

@@ -21,7 +21,7 @@ allprojects {
 // versions of libraries that all modules require
 
 project.ext {
-    blinkIdVersion = '5.15.2'
+    blinkIdVersion = '5.16.0'
     compileSdkVersion = 31
     targetSdkVersion = 31
     appCompatVersion = '1.4.0'

README.md

@@ -113,7 +113,7 @@ Add _BlinkID_ as a dependency and make sure `transitive` is set to true
 
 ```
 dependencies {
-    implementation('com.microblink:blinkid:5.15.2@aar') {
+    implementation('com.microblink:blinkid:5.16.0@aar') {
         transitive = true
     }
 }
@@ -125,7 +125,7 @@ Android studio 3.0 should automatically import javadoc from maven dependency. If
 
 1. In Android Studio project sidebar, ensure [project view is enabled](https://developer.android.com/sdk/installing/studio-androidview.html)
 2. Expand `External Libraries` entry (usually this is the last entry in project view)
-3. Locate `blinkid-5.15.2` entry, right click on it and select `Library Properties...`
+3. Locate `blinkid-5.16.0` entry, right click on it and select `Library Properties...`
 4. A `Library Properties` pop-up window will appear
 5. Click the second `+` button in bottom left corner of the window (the one that contains `+` with little globe)
 6. Window for defining documentation URL will appear

Release notes.md

@@ -1,5 +1,78 @@
 # Release notes
 
+## 5.16.0.
+
+### We've added new documents to our list of supported documents:
+
+#### Europe
+- Austria - ID Card (front only)
+- Germany - ID Card
+
+#### Latin America and the Caribbean
+- Brazil - ID Card (beta)
+- Colombia - ID Card (front only)
+- Ecuador - ID Card
+
+#### Mexico
+- Baja California Sur - Driving Licence (beta)
+- Ciudad De Mexico - Driving Licence (front only)
+- Colima - Driving Licence (front only, beta)
+- Michoacan - Driving Licence (beta)
+- Nayarit - Driving Licence (beta)
+- Quintana Roo Solidaridad - Driving Licence (front only)
+- Tlaxcala - Driving Licence
+- Veracruz - Driving Licence (beta)
+
+#### Oceania
+- Australia - Northern Territory (beta)
+
+#### Asia
+- Japan - My Number Card (front only)
+- Singapore - Resident ID
+
+#### Northern America
+- USA - Missouri - ID Card
+- USA - Nevada - Driving Licence
+- USA - New York City - ID Card
+- USA - Oklahoma - ID Card
+
+#### Back side support added:
+- Mexico - Chiapas - Driving License 
+
+#### No longer BETA:
+- Mexico - Baja California - Driving Licence
+- Mexico - Chihuahua - Driving Licence
+- Mexico - Coahuila - Driving Licence
+- Mexico - Guanajuato - Driving Licence
+- Mexico - Mexico - Driving Licence
+
+
+### Changes to BlinkID(Combined) Recognizer
+
+- Added the setting `saveCameraFrames` for saving camera frames with the default value being `false`. Note that the memory consumption is a bit bigger if this setting is set to `true`.
+	- New result members are available for: 
+		- BlinkIDRecognizer:`cameraFrame` and `barcodeCameraFrame`.
+		- BlinkIDCombinedRecognizer:`frontCameraFrame`, `backCameraFrame`, and `barcodeCameraFrame`.
+- We've added new result members when scanning Australian Driving Licences: `vehicleClass`, `licenceType`, `effectiveDate` and `expiryDate`.
+	- Result members are displayed under the `VehicleClassInfo` field; we can also extract data from multiple rows when this vehicle class info data is present on the document (e.g. multiple expiry dates for different vehicle classes).
+- We've added new enum values:
+	- Region: `QUINTANA_ROO`, `QUINTANA_ROO_SOLIDARIDAD`, `TLAXCALA` which are available when scanning Mexican Driving Licences.
+	- Type: `MY_NUMBER_CARD` which is available when scanning Japanese My Number Card documents.
+- We've added new result member `additionalOptionalAddressInformation` which gives additional address information about the document owner.
+	- This result member can be present when scanning the Pakistani ID Card for the field `Country of Stay`.
+- We've removed 2 recognizers: `GermanyDLBack Recognizer` and `SingaporeChangiEmployeeId Recognizer`.
+
+
+#### Changes to IDBarcodeRecognizer
+- For barcodes in countries: Argentina, Colombia, Nigeria, Panama, and South Africa, we now also extract data from the field `Sex` when it's populated with the character "X".
+
+
+### Improvements
+- We've added support for Brazil ID Card when the cardholder's face image is rotated for 90 degrees on the document.
+	- We will return face image and document image + data from VIZ part present on the back side.
+- `SuccessFrameGrabber` setting is now called `saveCameraFrames` and it can return the full frame from the front side now when using BlinkIdCombinedRecognizer, whereas before it returned the full frame only for the back side.
+
+
 ## 5.15.2
 
 ### Visual identity update

builtFromCommit.txt

@@ -1 +1 @@
-Built from commit 55736fa3c2a24f68233223e6e891c4d26520ecca
+Built from commit 06e0580ce124605d0c68af8f18fa193cd731732c