//
//  MBMrtdDetectorRecognizer.h
//  MicroblinkDev
//
//  Created by Jura Skrlec on 28/03/2018.
//

#import <Foundation/Foundation.h>
#import "MBMicroblinkDefines.h"
#import "MBTemplatingRecognizer.h"
#import "MBMrtdRecognizerResult.h"
#import "MBMicroblinkInitialization.h"
#import "MBMrtdSpecification.h"
#import "MBGlareDetection.h"

#import "MBFullDocumentImage.h"
#import "MBEncodeFullDocumentImage.h"
#import "MBFullDocumentImageDpi.h"
#import "MBFullDocumentImageExtensionFactors.h"
#import "MBMrzImage.h"
#import "MBMrzImageDpi.h"
#import "MBEncodeMrzImage.h"


@protocol MBMrzFilter;

@class MBDetector;

NS_ASSUME_NONNULL_BEGIN

/**
 * Recognizer that can recognizer Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD)
 */
MB_CLASS_AVAILABLE_IOS(8.0) MB_CLASS_DEPRECATED("MBMrtdRecognizer is deprecated. Use MBBlinkIdRecognizer with mrz_id, mrz_visa, mrz_passport rights.") MB_FINAL
@interface MBMrtdRecognizer : MBTemplatingRecognizer<NSCopying, MBFullDocumentImage, MBEncodeFullDocumentImage, MBFullDocumentImageDpi, MBFullDocumentImageExtensionFactors, MBGlareDetection>

MB_INIT

/**
 * Detector recognizer results
 */
@property (nonatomic, strong, readonly) MBMrtdRecognizerResult *result;

/**
 * Whether returning of unparsed results is allowed
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL allowUnparsedResults;

/**
 * Whether returning of unverified results is allowed
 * Unverified result is result that is parsed, but check digits are incorrect.
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL allowUnverifiedResults;

/**
 * Whether special characters are allowed
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL allowSpecialCharacters;

/**
 * Sets the mrtd specifications. Mrtd specifications describe the images that should be returned by
 * the detector. Setting nil or empty array will enable all possible specifications.
 *
 *  @param mrtdSpecifications mrtd specifications
 */
- (void)setMrtdSpecifications:(nullable NSArray<__kindof MBMrtdSpecification *> *)mrtdSpecifications;

/**
 * Get the mrtd specifications.
 */
@property (nonatomic, nullable, strong, readonly) NSArray<__kindof MBMrtdSpecification *> *mrtdSpecifications;

/**
* Filter for MRTDs (Machine Readable Travel Documents) that is used to determine which documents
* will be processed. If document is filtered out by this filter, its data cannot be returned as recognition result.
*/
@property (nonatomic, nullable, weak) id<MBMrzFilter> mrzFilterDelegate;

@end

@protocol MBMrzFilter <NSObject>
@required
/**
 * Determines whether document should be processed or it is filtered out.
 * @return YES if the document with the given MRZ should be processed, NO if the document
 * should be filtered out.
 */
- (BOOL)mrzFilter;
@end

NS_ASSUME_NONNULL_END