Merge pull request #12 from BlinkOCR/feature/v2.1.0

updated to version v2.1.0
blinkinput · Jun 29, 2016 · 1578f54 · 1578f54
2 parents 65a8a71 + 1147c90
commit 1578f54
Show file tree

Hide file tree

Showing 55 changed files with 1,290 additions and 1,247 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,14 @@
+## 2.1.0
+
+- iOS updates:
+
+	- Added option to mirror camera frames in 'PPCameraSettings'
+	- Added VIN parser
+
+- iOS bugfixes
+	- Fixed deadlock when 'processImage:' is called from main thread
+	- Fixed setting custom PPOcrEngineOptions
+
 ## 2.0.0
 
 - iOS updates:

diff --git a/MicroBlink.bundle/Info.plist b/MicroBlink.bundle/Info.plist
diff --git a/MicroBlink.bundle/torchoff.png b/MicroBlink.bundle/torchoff.png
diff --git a/MicroBlink.bundle/[email protected] b/MicroBlink.bundle/[email protected]
diff --git a/MicroBlink.bundle/torchoff_pressed.png b/MicroBlink.bundle/torchoff_pressed.png
diff --git a/MicroBlink.bundle/[email protected] b/MicroBlink.bundle/[email protected]
diff --git a/MicroBlink.bundle/torchon.png b/MicroBlink.bundle/torchon.png
diff --git a/MicroBlink.bundle/[email protected] b/MicroBlink.bundle/[email protected]
diff --git a/MicroBlink.bundle/torchon_pressed.png b/MicroBlink.bundle/torchon_pressed.png
diff --git a/MicroBlink.bundle/[email protected] b/MicroBlink.bundle/[email protected]
diff --git a/MicroBlink.framework/Headers/PPBaseOverlayViewController.h b/MicroBlink.framework/Headers/PPBaseOverlayViewController.h
@@ -13,17 +13,17 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- * Common base class for PhotoPay default overlay view controllers
+ * Common base class for default overlay view controllers
  */
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPBaseOverlayViewController : PPOverlayViewController
 
 /**
- * Registers a subview for overlay events.
+ * Registers a subview for PPOverlaySubview protocol events.
  */
 - (void)registerOverlaySubview:(UIView<PPOverlaySubview>*)subview;
 
 /**
- * Unregisters a subview for overlay events.
+ * Unregisters a subview for PPOverlaySubview protocol events.
  */
 - (void)unregisterOverlaySubview:(UIView<PPOverlaySubview>*)subview;
 

diff --git a/MicroBlink.framework/Headers/PPBlinkOcrRecognizerSettings.h b/MicroBlink.framework/Headers/PPBlinkOcrRecognizerSettings.h
@@ -43,7 +43,7 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPBlinkOcrRecognizerSettings : PPTemplati
 @property (nonatomic) PPDetectorSettings *detectorSettings;
 
 /**
- * Templating API documents will be processed twice: once regulary and second time flipped upside down.
+ * With this enabled, Templating API documents will be processed twice: once regulary and second time flipped upside down.
  *
  * Default: NO
  */

diff --git a/MicroBlink.framework/Headers/PPCameraCoordinator.h b/MicroBlink.framework/Headers/PPCameraCoordinator.h
@@ -76,16 +76,6 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 - (void)setScanningRegion:(CGRect)scanningRegion;
 
-/** 
- * Tell coordinator that scanning has started
- */
-- (void)start;
-
-/** 
- * Tell coordinator scanning has stopped
- */
-- (void)stop;
-
 /**
  * Pauses recognition of input images. Any image inputted will not be processed
  */

diff --git a/MicroBlink.framework/Headers/PPCameraSettings.h b/MicroBlink.framework/Headers/PPCameraSettings.h
@@ -112,6 +112,20 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, assign) CGPoint focusPoint;
 
+/**
+ * Tells whether camera input images should be mirrored horizontally before processing
+ *
+ * Default: NO
+ */
+@property (nonatomic) BOOL cameraMirroredHorizontally;
+
+/**
+ * Tells whether camera input images should be mirrored vertically before processing
+ *
+ * Default: NO
+ */
+@property (nonatomic) BOOL cameraMirroredVertically;
+
 /**
  * Designated initializer. Initializes the object with default settings (see above for defaults)
  *

diff --git a/MicroBlink.framework/Headers/PPCoordinator.h b/MicroBlink.framework/Headers/PPCoordinator.h
@@ -72,8 +72,10 @@ PP_CLASS_AVAILABLE_IOS(6.0)
 #pragma mark - Direct processing of images
 
 /**
- * Processes a PPImage object using current settings.
- * Results are passed to a given delegate object.
+ * Processes a PPImage object synchronously using current settings.
+ * Since this method is synchronous, calling it from a main thread will switch the call to alternate thread internally and output a warning.
+ *
+ * Results are passed a delegate object given upon a creation of PPCoordinator.
  *
  *  @param image            image for processing
  */

diff --git a/MicroBlink.framework/Headers/PPDetectorSettings.h b/MicroBlink.framework/Headers/PPDetectorSettings.h
@@ -14,7 +14,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * MicroBlink scanning libraries run detector objects to find objects on image.
- * Each detector is configured with PPDetectorSettings object.
  * This class is common superclass for each of the Detector settings.
  */
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDetectorSettings : NSObject <NSCopying>

diff --git a/MicroBlink.framework/Headers/PPMultiDetectorSettings.h b/MicroBlink.framework/Headers/PPMultiDetectorSettings.h
@@ -9,10 +9,16 @@
 #import "PPDetectorSettings.h"
 
 /**
- * Settings for detector which combines multiple detectors inside
+ * Settings for detector which combines multiple detectors inside.
+ *
+ * As only one PPDetectorSettings can be used at a time, PPMultiDetectorSettings wraps multiple settings so they can be used simultaneously.
+ * In other words, it is necessary to use PPMultiDetectorSettings when more than 1 detectors are needed.
  */
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPMultiDetectorSettings : PPDetectorSettings
 
+/**
+ * Creates detector with array of concrete detectors.
+ */
 - (instancetype)initWithSettingsArray:(NSArray<__kindof PPDetectorSettings *> *)settingsArray;
 
 /**

diff --git a/MicroBlink.framework/Headers/PPOcrEngineOptions.h b/MicroBlink.framework/Headers/PPOcrEngineOptions.h
@@ -63,14 +63,15 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPOcrCharKey : NSObject
 @end
 
 /**
- * Options used for OCR process
+ * Options used for OCR process. These options enable you to customize how some OCR parsers work.
+ * For example, you can set character whitelists, character height, supported fonts etc.
  */
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPOcrEngineOptions : NSObject <NSCopying>
 
-///**
-// * Internal implementation
-// */
-//@property (nonatomic, readonly, assign) OcrEngineOptionsImpl* options;
+/**
+ * Creates PPOcrEngineOptions with default settings.
+ */
+- (instancetype)init;
 
 /**
  * Minimal height of the line of text given in pixels. All chars smaller than this value will be ignored.
@@ -137,7 +138,7 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPOcrEngineOptions : NSObject <NSCopying>
  *
  * Default: all chars with all fonts.
  */
-@property (nonatomic, strong) NSSet* charWhitelist;
+@property (nonatomic, strong) NSSet<PPOcrCharKey*> *charWhitelist;
 
 
 @end

diff --git a/MicroBlink.framework/Headers/PPQuadDetectorResult.h b/MicroBlink.framework/Headers/PPQuadDetectorResult.h
@@ -14,7 +14,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Result of the detection of a Quad detector.
- * Quad results are results of detecting various rectangular objects.
+ * Quad results are results of detecting various rectangular objects (such as ID cards, passports etc.).
  */
 PP_CLASS_AVAILABLE_IOS(6.0)
 @interface PPQuadDetectorResult : PPDetectorResult

diff --git a/MicroBlink.framework/Headers/PPQuadDetectorSettings.h b/MicroBlink.framework/Headers/PPQuadDetectorSettings.h
@@ -14,6 +14,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Settings for Quad detector, used for rectangular objects.
+ * This class is an abstract class.
  */
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPQuadDetectorSettings : PPDetectorSettings
 

diff --git a/MicroBlink.framework/Headers/PPRawOcrParserFactory.h b/MicroBlink.framework/Headers/PPRawOcrParserFactory.h
@@ -16,11 +16,11 @@
 PP_CLASS_AVAILABLE_IOS(6.0) @interface PPRawOcrParserFactory : PPOcrParserFactory
 
 /**
- * Ocr Engine options used in Raw ocr parsing
+ * Sets desired options for a parser. Options enable various customizations of a parsers such as: allowed characters, character heigh, etc.
  *
  * Default: [[PPOcrEngineOptions alloc] init]
  */
-@property (nonatomic, strong) PPOcrEngineOptions *options;
+-(void)setOptions:(PPOcrEngineOptions *) options;
 
 /**
  * Use algorithm for combining consecutive OCR results between video frames

diff --git a/MicroBlink.framework/Headers/PPRegexOcrParserFactory.h b/MicroBlink.framework/Headers/PPRegexOcrParserFactory.h
@@ -32,11 +32,11 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPRegexOcrParserFactory : PPOcrParserFact
 @property (nonatomic) NSString *regex;
 
 /**
- * Ocr Engine options used in Raw ocr parsing
+ * Sets desired options for a parser. Options enable various customizations of a parsers such as: allowed characters, character heigh, etc.
  *
  * Default: [[PPOcrEngineOptions alloc] init]
  */
-@property (nonatomic) PPOcrEngineOptions *options;
+-(void)setOptions:(PPOcrEngineOptions *) options;
 
 /**
  * Use algorithm for combining consecutive OCR results between video frames

diff --git a/MicroBlink.framework/Headers/PPScanSettings.h b/MicroBlink.framework/Headers/PPScanSettings.h
@@ -89,20 +89,6 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPScanSettings : NSObject <NSCopying>
  */
 @property (nonatomic, assign) PPFrameQualityEstimationMode frameQualityEstimationMode;
 
-/**
- * Tells whether camera input images should be mirrored horizontally before processing
- *
- * Default: NO
- */
-@property (nonatomic) BOOL cameraMirroredHorizontally;
-
-/**
- * Tells whether camera input images should be mirrored vertically before processing
- *
- * Default: NO
- */
-@property (nonatomic) BOOL cameraMirroredVertically;
-
 /**
  * Designated initializer. Initializes the object with default settings (see above for defaults)
  *

diff --git a/MicroBlink.framework/Headers/PPViewControllerFactory.h b/MicroBlink.framework/Headers/PPViewControllerFactory.h
@@ -17,8 +17,11 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-PP_CLASS_AVAILABLE_IOS(6.0)
-@interface PPViewControllerFactory : NSObject
+/**
+ * Factory class containing static methods for creating camera view controllers.
+ * Camera view controllers created this way will be managed internally by the SDK, and input frames will be processed.
+ */
+PP_CLASS_AVAILABLE_IOS(6.0) @interface PPViewControllerFactory : NSObject
 
 /**------------------------------------------*/
 /** @name Creating Scanning view controllers */

diff --git a/MicroBlink.framework/Info.plist b/MicroBlink.framework/Info.plist
diff --git a/MicroBlink.framework/MicroBlink b/MicroBlink.framework/MicroBlink
diff --git a/MicroBlink.framework/_CodeSignature/CodeDirectory b/MicroBlink.framework/_CodeSignature/CodeDirectory
diff --git a/MicroBlink.framework/_CodeSignature/CodeRequirements b/MicroBlink.framework/_CodeSignature/CodeRequirements
diff --git a/MicroBlink.framework/_CodeSignature/CodeRequirements-1 b/MicroBlink.framework/_CodeSignature/CodeRequirements-1
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,6 +14,7 @@ NS_ASSUME_NONNULL_BEGIN @@
     /**
      * Settings for Quad detector, used for rectangular objects.
+     * This class is an abstract class.
      */
     PP_CLASS_AVAILABLE_IOS(6.0) @interface PPQuadDetectorSettings : PPDetectorSettings
@@ Expand Down @@