Merge pull request #131 from BlinkID/feature/v2.15.0

Feature/v2.15.0

CHANGELOG.md

@@ -1,3 +1,29 @@
+## 2.15.0
+
+- Updates and additions
+    - added support for reading back side of Malaysian MyKad - use `PPMyKadBackRecognizerSettings` 
+    - added support for reading Malaysian MyTentera documents - use `PPMyTenteraRecognizerSettings`
+    - added support for reading Malaysian MyTentera documents with MyKad recognizer - use `PPMyKadFrontRecognizerSettings` and enable reading of army number 
+    - added support for setting DPI for full document images returned by `PPMyKadFrontRecognizerSettings`, `PPMyKadBackRecognizerSettings`, `PPMyKadFrontRecognizerSettings` and `PPIKadRecognizerSettings`:
+    - use `fullDocumentImageDPI` on the corresponding recognizer settings
+    - added full support for iPhone X layout for all SDK's overlay views
+
+- Minor API changes
+    - renamed `PPMyKadRecognizerSettings` and `PPMyKadRecognizerResult` to `PPMyKadFrontRecognizerSettings` and `PPMyKadFrontRecognizerResult`
+
+- Improvements in ID scanning performance
+    - improved `PPAustraliaDLFrontRecognizer`:
+        - improved reading of names and addresses
+        - added support for reading first names with more words
+    - improved `PPSingaporeIDFrontRecognizer`:
+        - tuned ID card data extraction positions
+    - improved Malaysian `IKadRecognizer`:
+        - better reading of date of expiry and employer fields
+
+- Bugfixes
+    - fixed crash in `PPDocumentFaceRecognizer`
+    - added missing document classifier property `documentClassifier` to `PPTemplatingRecognizerSettings`         
+
 ## 2.14.0
 
 - Updates and additions

MicroBlink.framework/Headers/PPBlinkIDRecognizers.h

@@ -66,8 +66,16 @@
 #import "PPiKadRecognizerResult.h"
 
 // Malaysian IDs (MyKad)
-#import "PPMyKadRecognizerSettings.h"
-#import "PPMyKadRecognizerResult.h"
+#import "PPMyKadFrontRecognizerSettings.h"
+#import "PPMyKadFrontRecognizerResult.h"
+
+// Malaysian IDs Back (MyKad)
+#import "PPMyKadBackRecognizerSettings.h"
+#import "PPMyKadBackRecognizerResult.h"
+
+// Malaysian army IDs (MyTentera)
+#import "PPMyTenteraRecognizerSettings.h"
+#import "PPMyTenteraRecognizerResult.h"
 
 // MRTD
 #import "PPMrtdRecognizerSettings.h"

MicroBlink.framework/Headers/PPBlinkOcrRecognizerSettings.h

@@ -52,35 +52,6 @@ PP_CLASS_DEPRECATED_IOS(1_0, 5_10_0, "Use PPDetectorRecognizerSettings for templ
  */
 @property (nonatomic) BOOL allowFlippedRecognition;
 
-/**
- * Delegate for document classification.
- *
- * Default: nil
- */
-@property (nonatomic) id<PPDocumentClassifier> documentClassifier;
-
-/**
- * Sets array of PPDecodingInfo to be used when PPDocumentClassifer outputs a selected result.
- *
- *  @see PPDocumentClassifier
- *
- *  @param decodingInfos    Decoding infos to be used when PPDocumentClassifier outputs selected result
- *  @param classifierResult Output from PPDocumentClassifer
- */
-- (void)setDecodingInfoSet:(NSArray<PPDecodingInfo *> *)decodingInfos forClassifierResult:(NSString *)classifierResult;
-
-/**
- * Removes all decoding infos for a given classifier result.
- *
- * @param classifierResult Removes all decoding infos linked to specified classifier result
- */
-- (void)removeDecodingInfoSetForClassifierResult:(NSString *)classifierResult;
-
-/**
- * Removes all present decoding info
- */
-- (void)removeAllDecodingInfoSets;
-
 @end
 
 NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/PPMyKadBackRecognizerResult.h

@@ -0,0 +1,45 @@
+//
+//  PPMyKadBackRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 21/12/2017.
+//
+
+#import "PPDetectorRecognizerResult.h"
+
+/**
+ * Result of scanning MyKad Back (Malaysian ID document).
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPMyKadBackRecognizerResult : PPDetectorRecognizerResult
+
+/**
+ * NRIC number (National Registration Identity Card Number)
+ *
+ *  @see https://en.wikipedia.org/wiki/Malaysian_identity_card#Structure_of_the_National_Registration_Identity_Card_Number_.28NRIC.29
+ */
+@property (nonatomic, readonly, nullable) NSString *nricNumber;
+
+/**
+ * Extended NRIC number (National Registration Identity Card Number)
+ *
+ *  @see https://en.wikipedia.org/wiki/Malaysian_identity_card#Structure_of_the_National_Registration_Identity_Card_Number_.28NRIC.29
+ */
+@property (nonatomic, readonly, nullable) NSString *extendedNricNumber;
+
+/**
+ * Owner birth date string, as written on the document (YYMMDD format)
+ */
+@property (nonatomic, readonly, nullable) NSString *rawOwnerBirthDate;
+
+/**
+ * Owner birth date converted in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *ownerBirthDate;
+
+/**
+ * Owner sex (M for male, F for female)
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerSex;
+
+@end

MicroBlink.framework/Headers/PPMyKadBackRecognizerSettings.h

@@ -0,0 +1,68 @@
+//
+//  PPMyKadBackRecognizerSettings.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 21/12/2017.
+//
+
+#import "PPRecognizerSettings.h"
+
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Settings class for configuring Malaysian MyKad Back Recognizer.
+ *
+ * Malaysian MyKad Back recognizer is used for scanning front side of Malaysian MyKad Back.
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+
+@interface PPMyKadBackRecognizerSettings : PPRecognizerSettings
+
+/**
+ * Name of the image sent to didOutputMetadata method of scanDelegate object that contains signature.
+ * This image will be sent to scan delegate during recognition process if displaying of face image
+ * is enabled via displaySignatureImage property and receiving of dewarpedImage in MetadataSettings is enabled.
+ */
++ (NSString *)ID_SIGNATURE;
+
+/**
+ * Name of the image sent to didOutputMetadata method of scanDelegate object that contains full document.
+ * This image will be sent to scan delegate during recognition process if displaying of full document image
+ * is enabled via displayFullDocumentImage property and receiving of dewarpedImage in MetadataSettings is enabled.
+ */
++ (NSString *)FULL_DOCUMENT_IMAGE;
+
+/**
+ * Sets whether face image from ID card should be sent to didOutputMetadata method of scanDelegate object.
+ * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL displaySignatureImage;
+
+/**
+ * Sets whether full document image of ID card should be sent to didOutputMetadata method of scanDelegate object.
+ * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL displayFullDocumentImage;
+
+/**
+ * Defines if glare detection should be turned on/off for Malaysian MyKad Back.
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL detectGlare;
+
+/**
+ * Property got setting DPI for full document images
+ *
+ * Default: 250.0
+ */
+@property (nonatomic, assign) NSUInteger fullDocumentImageDPI;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/PPMyKadRecognizerResult.h → MicroBlink.framework/Headers/PPMyKadFrontRecognizerResult.h

@@ -12,7 +12,7 @@
  * Result of scanning MyKad (Malaysian ID document).
  */
 PP_CLASS_AVAILABLE_IOS(6.0)
-@interface PPMyKadRecognizerResult : PPRecognizerResult
+@interface PPMyKadFrontRecognizerResult : PPRecognizerResult
 
 /**
  * NRIC number (National Registration Identity Card Number)
@@ -71,4 +71,9 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, readonly, nullable) NSString *ownerSex;
 
+/**
+ * Owner army number on MyTentera documents
+ */
+@property (nonatomic, readonly, nullable) NSString *armyNumber;
+
 @end

MicroBlink.framework/Headers/PPMyKadRecognizerSettings.h → MicroBlink.framework/Headers/PPMyKadFrontRecognizerSettings.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @see https://en.wikipedia.org/wiki/Malaysian_identity_card
  */
 PP_CLASS_AVAILABLE_IOS(6.0)
-@interface PPMyKadRecognizerSettings : PPRecognizerSettings
+@interface PPMyKadFrontRecognizerSettings : PPRecognizerSettings
 
 /**
  * Name of the image sent to didOutputMetadata method of scanDelegate object that contains face.
@@ -35,6 +35,13 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 + (NSString *)FULL_DOCUMENT_IMAGE;
 
+/**
+ * Defines if army number should be extracted from MyTentera documents with MyKadRecognizer
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL extractArmyNumber;
+
 /**
  * Sets whether full document image of ID card should be sent to didOutputMetadata method of scanDelegate object.
  * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
@@ -51,6 +58,13 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, assign) BOOL showFaceImage;
 
+/**
+ * Property got setting DPI for full document images
+ *
+ * Default: 250.0
+ */
+@property (nonatomic, assign) NSUInteger fullDocumentImageDPI;
+
 @end
 
 NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/PPMyTenteraRecognizerResult.h

@@ -0,0 +1,79 @@
+//
+//  PPMyTenteraRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 21/12/2017.
+//
+
+#import "PPDetectorRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning front side of MyTentera
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+
+@interface PPMyTenteraRecognizerResult : PPDetectorRecognizerResult
+
+/**
+ * NRIC number (National Registration Identity Card Number)
+ *
+ *  @see https://en.wikipedia.org/wiki/Malaysian_identity_card#Structure_of_the_National_Registration_Identity_Card_Number_.28NRIC.29
+ */
+@property (nonatomic, readonly, nullable) NSString *nricNumber;
+
+/**
+ * Owner army number
+ */
+@property (nonatomic, readonly, nullable) NSString *armyNumber;
+
+/**
+ * Owner address
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerAddress;
+
+/**
+ * Owner address city. Determined from owner address.
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerAddressCity;
+
+/**
+ * Owner address state. Determined from owner address.
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerAddressState;
+
+/**
+ * Owner address Zip code. Determined from owner address.
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerAddressZipCode;
+
+/**
+ * Owner street. Determined from owner address.
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerAddressStreet;
+
+/**
+ * Owner birth date string, as written on the document (YYMMDD format)
+ */
+@property (nonatomic, readonly, nullable) NSString *rawOwnerBirthDate;
+
+/**
+ * Owner birth date converted in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *ownerBirthDate;
+
+/**
+ * Owner full name
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerFullName;
+
+/**
+ * Owner religion if written on MyKad
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerReligion;
+
+/**
+ * Owner sex (M for male, F for female)
+ */
+@property (nonatomic, readonly, nullable) NSString *ownerSex;
+
+@end