Release History and Changelog

Version 1.9.9 (4 Feb 2020):

• 🎉 New:

  • Adjustable Filters: Added new GPU-accelerated filters for base manipulation of images, e.g. contrast, brightness, saturation, vibrance, color temperature, tint etc. using Metal.framework with fallback options to OpenGL ES and CPU (see SBSDKAdjustableFilters headers includes for subclasses)
  • Barcode Scanning: New ML-based Barcode and QR-code scanner
  • Cheque recognition: New ML-based recognizer with support for american and EU cheque formats

• 🚀 Improvements:

  • Licensing: Changed license failure handling: invalid licenses will no longer crash the app containing ScanbotSDK, instead SDK API will return nil or empty values
  • Licensing: Query the currents license status using +[ScanbotSDK licenseStatus]
  • Barcode Scanning: Improved static images detection
  • MRZ Scanning: Added support for swiss driver license
  • Added aspect ratio range property to SBSDKMultipleObjectsDetector

• 🐞 Bug fixes:

  • Fixes and improvements for various image filters
  • Various fixes for barcode parsers of different formats
  • Fixed Machine Readable Zones recognition (black background)
  • Fixed a typo in SBSDKMachineReadableZoneRecognizerResult: recognitionSuccessful
  • DC recognizer: bug fixes and performance improvements

• ⚠️ Breaking Changes:

  • Fixed a typo in SBSDKMachineReadableZoneRecognizerResult: recognitionSuccessful
  • SBSDKBarcodeScanner: function parameters with types of barcodes to detect have been moved to a property
  • SBSDKBarcodeScanner: some function parameters have been renamed
  • SBSDKUIBarcodeScannerViewControllerDelegate: [SBSDKUIBarcodeScannerViewControllerDelegate qrBarcodeDetectionViewController:didDetect:] has been replaced by [SBSDKUIBarcodeScannerViewControllerDelegate qrBarcodeDetectionViewController:didDetectResults:]

• ❌ Deprecated API:

  • SBSDKChequeRecognizerResult: the properties routingNumber, accountNumber and chequeNumber have been encapsulated in a new class named SBSDKChequeRecognizerResultField that now holds the string value as well as a detection confidence value

Version 1.9.8 (15 Jan 2020):

• 🐞 Bug fixes:
  • Fixed crash caused by adding SBSDKScannerViewController as embedded controller via Interface Builder

Version 1.9.7 (25 Oct 2019):

• 🚀 Improvements:
  • MRZ Scanner: Added all checkdigits in MRZ result as additional fields - see SBSDKMachineReadableZoneRecognizerResult.checkDigits.
• 🐞 Bug fixes:
  • Fixed crashes in the beta Barcode Scanner with parsing AAMVA data of PDF417 barcodes on US driver licenses.
  • iOS 13 fix: Set the default modalPresentationStyle of SBSDKScannerViewController and all RTU UI ViewControllers to UIModalPresentationFullScreen.
• ⚠️ Breaking Changes:
  • Barcode types passed to ScnabotSDK API are no longer parameters of type NSArray<NSNumber *>* but of NSArray<SBSDKBarcodeType *>*. Affected APIs are located in SBSDKBarcodeScanner, SBSDKBarcodeScannerResult, SBSDKScannerViewController , SBSDKUIBarcodeScannerViewController, SBSDKUIMachineCodesCollection and SBSDKUIWorkflowStep and its subclasses.

Version 1.9.6 (24 Sep 2019):

• 🐞 Bug fixes:
  • Fixed a sporadic crash in the beta Barcode Scanner SBSDKBarcodeScanner.
  • Fixed a crash in the beta Barcode Scanner with parsing AAMVA data of PDF417 barcodes (support for shorter header than in specification).

Version 1.9.5 (21 Aug 2019):

• 🐞 Bug fixes:
  • Fixed UI configs of the RTU UI EHIC Scanner (SBSDKUIHealthInsuranceCardScannerUIConfiguration.topBarBackgroundColor).
  • Fixed mappings of new field types SBSDKDisabilityCertificateRecognizerCheckboxTypeAccident and SBSDKDisabilityCertificateRecognizerCheckboxTypeRequiresCare in SBSDKDisabilityCertificatesRecognizerResult.

Version 1.9.4 (12 Aug 2019):

• 🎉 New:
  • New recognizer for the European Health Insurance Cards (EHIC). Provides live detection and data extraction of all fields on the back of the card. Available as Classical SDK Component class SBSDKHealthInsuranceCardRecognizer as well as the Ready-To-Use UI Component class SBSDKUIHealthInsuranceCardScannerViewController. Also see our updated example apps on GitHub scanbot-sdk-example-ios for easy integration.
  • New QR- & Barcode Scanner SBSDKBarcodeScanner as beta feature which provides:
    • better detection and exatraction of 1D and 2D barcodes, especially Data Matrix and PDF 417 codes
    • improved and simplified API - see the class SBSDKBarcodeScanner of our Classical SDK Components (implementation as RTU UI Component will follow soon)
    • out-of-the-box parsers, like German Medical Plans (Medikationsplan) based on Data Matrix (SBSDKMedicalPlanDocumentFormat), ID Cards (SBSDKIDCardPDF417DocumentFormat) or US Driver Licenses (SBSDKAAMVADocumentFormat) both based on PDF 417.
  • Please note that the new SBSDKBarcodeScanner component is a BETA feature and is still under active development and improvement.
• 🐞 Bug fixes:
  • Fixed the delegate call imageEditingViewControllerDidChangePolygon: of SBSDKImageEditingViewController.

Version 1.9.3 (30 Jul 2019):

• 🎉 New:
  • New black & white image filter SBSDKImageFilterType.SBSDKImageFilterTypeLowLightBinarization2.
  • Disability Certificate Recognizer - Recognition of new fields: SBSDKDisabilityCertificatesRecognizerResult.patientFields, SBSDKDisabilityCertificatesRecognizerResult.intention, SBSDKDisabilityCertificatesRecognizerResult.insuredPersonType.
• 🚀 Improvements:
  • Validation of the key names in -[SBSDKKeyedImageStorage setImage:forKey:]. Please note that passing an invalid key will throw an NSInvalidArgumentException now. See the API docs of the setImage method for more details.
  • Improved recognition of SEPA payforms via SBSDKPayFormScanner. Added recognition from barcodes and some new fields. Please also note the API breaking changes below.
• ⚠️ Breaking Changes:
  • SBSDKPayFormScanner API - Removed the obsolete methods detectOnImage:scannedImage and recognizeFieldsOnImage:scannedImage. Replaced by a new all-in-one method -[SBSDKPayFormScanner recognizeFromImage:]. Removed obsolete classes SBSDKPayFormResult, SBSDKPayFormDetectionResult and SBSDKPayFormDetectedBox.
• 🐞 Bug fixes:
  • Fixed an issue with unknown device orientation UIDeviceOrientationUnknown in SBSDKScannerViewController.
  • Removed hardcoded language string in +[SBSDKOpticalTextRecognizer recognizeText:indexSet:languageString:pdfOutputURL:error:].

Version 1.9.2 (6 Jun 2019):

• 🎉 New:
  • Added a new config property in the RTU UI Document Scanner Component: SBSDKUIDocumentScannerBehaviorConfiguration.maxNumberOfPages

Version 1.9.1 (23 May 2019):

• 🚀 Improvements:
  • Added initializer -[SBSDKUIPage initWithPageFileID:polygon:filter:documentImageSizeLimit:]
• 🐞 Bug fixes:
  • Fixed OCR resource path

Version 1.9.0 (3 May 2019):

• 🎉 New:
  • Workflows - New RTU UI Scanning Components. See the Workflows section for more details.
  • New black & white image filter SBSDKImageFilterType.SBSDKImageFilterTypeLowLightBinarization - Binarization filter primarily intended to use on low-contrast documents with hard shadows.
  • Added new config properties in the RTU UI Document Scanner Component:
    • SBSDKUIDocumentScannerBehaviorConfiguration.documentImageSizeLimit - to limit the size of the document image.
    • SBSDKUIDocumentScannerBehaviorConfiguration.stopsCameraSessionWhenDisappeared - to avoid lags in some situations when the receiver returns to the scanning screen.
    • SBSDKUIDocumentScannerUIConfiguration.shutterButtonHidden - to hide the shutter button.
• 🚀 Improvements:
  • OCR - Upgraded the OCR engine to Tesseract v4.00. Improved recognition speed and quality. Please also note the Breaking Changes below.
  • Improved performance of the images filter SBSDKImageFilterType.SBSDKImageFilterTypeDeepBinarization.
  • Better visualization and API for energy save management in the Classical UI Scanner Component SBSDKScannerViewController. See the new property SBSDKScannerViewController.energySavingActive. Please make sure to implement a suitable handling and localized text for that (e.g. in the delegate method -[SBSDKScannerViewControllerDelegate scannerController:localizedTextForDetectionStatus:]).
  • Better visualization for energy save management in the RTU UI Document Scanner Component SBSDKUIDocumentScannerViewController. Added a new text hint configuration SBSDKUIDocumentScannerTextConfiguration.textHintEnergySavingActive. Please make sure to provide a suitable localized text for that.
  • Added a dummy image for simulator image capturing. It can be used to run automated tests of all Document Scanner components on a simulator.
  • Added a new method in -[SBSDKDisabilityCertificatesRecognizer detectAndRecognizeFromImage:] as an alternative detection approach to the recognizeFromImage method.
• ⚠️ Breaking Changes:
  • OCR Language Files - If you use the OCR feature of the Scanbot SDK or some recognizer components which are based on OCR, please upgrade the OCR language files to Tesseract 4.00. See the OCR section for more details.
  • OCR API - OCR results per page. See SBSDKOCRResult.pages.
• 🐞 Bug fixes:
  • Fixed the status of the torch light toggle button in the RTU UI Document Scanner on reactivating the scanning screen.
  • Various minor bug fixes and improvements.

Version 1.8.6 (20 Feb 2019):

• 🚀 Improvements:
  • Changed the behaviour of image resource loading.
• 🚙 Under the hood:
  • Updated OpenSSL to v1.0.2q
  • Updated libtiff to v4.0.10
  • Updated libpng to v1.6.36 (part of other libs)
  • Updated libjpeg to v9b (part of other libs)

Version 1.8.5 (14 Feb 2019):

• 🎉 New:
  • Added business card detector and processor: SBSDKMultipleObjectsDetector and SBSDKBusinessCardsImageProcessor
  • Added text orientation recognizer: SBSDKTextOrientationRecognizer
• 🐞 Bug fixes:
  • Fixed potential synchronization issues with SBSDKIndexedImageStorage and SBSDKKeyedImageStorage

Version 1.8.4 (31 Jan 2019):

• Fixed crashes in SBSDKTIFFImageWriter when using write methods with file URLs

Version 1.8.3 (30 Jan 2019):

• Fixed handling of SBSDKUICroppingScreenConfiguration.uiConfiguration arguments in RTU Cropping UI (polygonColor, etc)
• Fixed animation of the Shutter Button in SmartMode in SBSDKScannerViewController
• Fixed handling of 24bit PNG images (e.g iOS 12 screenshots)
• Implemented a deep copy functionality in SBSDKIndexedImageStorage as specified by the protocol -[SBSDKImageStoring copy]
• Implemented new methods -[SBSDKIndexedImageStorage replaceImageAtIndex:withImage:] and -[SBSDKIndexedImageStorage replaceImageAtIndex:withImageAtURL:]
• Implemented new image filter types SBSDKImageFilterType.SBSDKImageFilterTypeOtsuBinarization, SBSDKImageFilterType.SBSDKImageFilterTypeDeepBinarization and SBSDKImageFilterType.SBSDKImageFilterTypeEdgeHighlight
• Added storage location initializers to SBSDKUIPageFileStorage
• Added support for meta-data and compression parameters in SBSDKTIFFImageWriter
• Added frame limiter for QR/barcode scanning: SBSDKScannerViewController.metadataFrameLimiter
• Improved recognition of pay cheque: SBSDKChequeRecognizer
• Improved document detection by required aspect ratios
  • ⚠️ Breaking change in the API: Changed the type of the property SBSDKScannerViewController.requiredAspectRatios
• Various minor bug fixes and improvements

Version 1.8.2 (20 Nov 2018):

• Fixed an issue with asset images of RTU UI components
• Small fixes in MRZ Recognizer (improved detection on still images of some ID cards)

Version 1.8.1 (13 Nov 2018):

• Added property SBSDKScannerViewController.requiredAspectRatios to restrict document detection to given aspect ratios
• Added a new viewfinder layer to SBSDKScannerViewController and the related property SBSDKScannerViewController.finderMode to visualize detection of document with required aspect ratios
• Added new functions to ScanbotSDK class to better handle license failures, like expiration and usage of features not included in your license:
  • +[ScanbotSDK setupDefaultLicenseFailureHandler]
  • +[ScanbotSDK setLicenseFailureHandler:]
• Added property SBSDKScannerViewController.frameLimiter which limits the detection rate on very fast devices to save a lot of CPU power and prevents unnecessary battery draining
• Added a new method +[SBSDKUIPDFRenderer renderDocument:withOCRLanguages:output:] which provides a convenient API to perform OCR and render a searchable PDF of a SBSDKUIDocument
• Minor accuracy improvements in the document detector

Version 1.8.0 (27 Sep 2018):

• Implemented the “Reset/Detect” functionality in RTU Cropping UI
• Added support for allowedInterfaceOrientations in all RTU UI ViewControllers (can be set via corresponding configurations)
• Fixed issues with orientationLockMode in RTU Document Scanner UI
• Added ability to specify preferred aspect ratios for detector in SBSDKScannerViewController (see SBSDKScannerViewController.preferredAspectRatios)
• Under the hood: Upgraded to OpenCV version 3.4.3
• Minor bug fixes and improvements

Version 1.7.8 (7 Sep 2018):

• Added a new method +[ScanbotSDK setResourceBundle:] to overwrite the location of Scanbot SDK default data bundle (e.g. if you need to embed the data bundles in another bundle)
• Added a new property SBSDKScannerViewController.defaultShutterButton
• Bugfix in MRZ Recognizer (dateOfBirth field was not extracted on some French ID cards)
• Fixed issues with Xcode inspector showing nil for every field in SBSDKMachineReadableZoneRecognizerResult
• Fixed an issue with bundle data location for Cheque Recognizer
• Improvements and potential fixes in SDK license manager

Version 1.7.7 (28 Aug 2018):

• Fixed bitcode generation

Version 1.7.6 (28 Aug 2018):

• DC Scanner:
  • Improved recognition of low-constrast scans
  • ⚠️ Breaking change: The DC Scanner now uses eng.traineddata instead of deu.traineddata!
• Removed the obsolete Credit Card Recognizer from SDK (components and bundles)
• Minor internal refactorings and improvements

Version 1.7.4:

• fixes memory leaks

Version 1.7.3:

• fix a bug where SBSDKIndexedImageStorage removes image files not properly

Version 1.7.2:

• extended and improved API to apply image filter on pages coming from Ready-To-Use UI
• new thread-safe container class SBSDKUIDocument for scanned pages
• added the fields checkDigitsCount and validCheckDigitsCount in SBSDKMachineReadableZoneRecognizerResult
• minor bug fixes and improvements

Version 1.7.1:

• fixed rotation bug in SBSDKImageEditingViewController

Version 1.7.0:

• added Ready-To-Use UI components SBSDKUIDocumentScannerViewController, SBSDKUICroppingViewController, SBSDKUIMRZScannerViewController, SBSDKUIBarcodeScannerViewController - a set of easy to integrate and customize high-level UI components for the most common tasks in Scanbot SDK
• added SBSDKCameraExposureSettings class to extract the current exposure metering parameters from the camera
• deprecated SBSDKImageStorage
• added SBSDKIndexedImageStorage and SBSDKKeyedImageStorage as replacements
• minor bug fixes
• dropped support for iOS 8

Version 1.6.2:

• minor bugfixes
• added two new SBSDKPDFRendererPageSize modes

Version 1.6.1:

• added support for CocoaPods
• new documentation
• new filters and cleaned up filter enum
• moved OCR lanugage data into a separate bundle
• added image orientation lock property to SBSDKScannerViewController

Version 1.6.0:

• minor bugfixes and improvements
• built with Xcode 9.3 toolchain

Version 1.5.9:

• fixed a line rendering problem in SBSDKImageEditingViewController

Version 1.5.8:

• added SBSDKTIFFImageWriter

Version 1.5.7:

• updated OCR engine
• added SBSDKMachineReadableZoneRecognizer

Version 1.5.6:

• added capture simulation to SBSDKScannerViewController

Version 1.5.5:

• added Disability Certificate Recognizer

Version 1.5.4:

• fixed a bug with duplicated URLs in SBSDKImageStorage

Version 1.5.3:

• fixed a crash when importing images from the photo library

Version 1.5.2:

• fixed a bug with 16 bit per component images and Display P3 colorspace

Version 1.5.1:

• added two new functions to SBSDKScannerViewController to help with energy saving

Version 1.5.0:

• fixed a bug with unrecognized barcodes
• added a new SBSDKScannerViewControllerDelegate function that delivers the captured original image and image metadata

Version 1.4.8:

• added support for machine readable codes (QR codes, barcodes) scanning in SBSDKScannerViewController
• added support and protocol for parsing machine readable codes
• added basic QR and barcode parsers
• added support for registering custom machine readable code parsers
• moved demo app from SDK into a separate github repository, now it is located here: https://github.com/doo/scanbot-sdk-example-ios

Version 1.4.7:

• new SBSDKImageEditingViewController as a flexible and more powerful replacement of SBSDKCropViewController
• SBSDKCropViewController has been deprecated and will not longer receive software engineering love

Version 1.4.6:

• Fixed a bug where capturing an image would block the main thread unnecessarily long

Version 1.4.5:

• Improved performance when capturing images using SBSDKScannerViewController by around 50%

Version 1.4.4:

• New functions in SBSDKScannerViewControllerDelegate for scanning documents, customizing UI and QR code scanning
• Fixed a bug in SBSDKCropViewController where sometimes the polygon handles were not touchable

Version 1.4.3:

• Fixed a bug in SBSDKCropViewController where sometimes the polygon handles were not visible

Version 1.4.2:

• Minor bugfixes
• New autocaptureSensitivity property in SBSDKScannerViewController

Version 1.4.1:

• Minor bugfixes in documentation
• Additional synchronous API for SBSDKOpticalTextRecognizer and SBSDKPDFRenderer

Version 1.4.0:

• Added SBSDKCropViewController, a Scanbot-like UI for manual cropping of images, including magnetic snapping of edges to found contours

Version 1.3.0:

• Removed static libraries
• Changed distribution model to single embeddable framework containing all architectures and bitcode

Version 1.2.1:

• Fixed crash in sample app by adding NSCameraUsageDescription and NSPhotoLibraryUsageDescription.

Version 1.2.0:

• Improved all detectors accuracy
• Added SBSDKImageMetadata and SBSDKImageMetadataProcessor to extract EXIF data etc. from image
• Added SBSDKLensCameraProperties which can be passed to polygon based warping functions to improve the aspect ratio of the cropped image and let it be very close to the original documents aspect ratio
• SBSDKLensCameraProperties can be extracted from SBSDKImageMetadata
• Added 3 new filters: SBSDKImageFilterTypePhoto, SBSDKImageFilterTypePhotoBW1, SBSDKImageFilterTypePhotoBW2
• The photo filter is useful to correct strong color tints, the 2 other new filters create different color-to-gray mappings
• Added SBSDKMultipleDocumentsDetector (Beta) to detect multiple photos or documents on an image
• Minor fixes and optimizations

Version 1.1.4:

• Added cheque recognizer SBSDKChequeRecognizer

Version 1.1.2:

• Improved credit card recognizer SBSDKCreditCardRecognizer

Version 1.1.1:

• Beta: Added brand new credit card recognizer: SBSDKCreditCardRecognizer
• Refactored Demo app: now contains Document Detection, Payform Detection and Credit Card detection
• Fixed some bugs in SBSDKScannerViewController, e.g. automatic crop after manual snap
• Added imageMode flag to SBSDKScannerViewController, can be set to grayscale mode to capture all images in grayscale mode for better memory footprint
• Added API to SBSDImageProcessor to pass UIImage objects directly instead of NSURLs

Version 1.0.15:

• Added new delegate method -(NSString *)scannerController:(SBSDKScannerViewController *)controller localizedTextForDetectionStatus:(SBSDKDocumentDetectionStatus)status to help you localizing the detection status strings

Version 1.0.14:

• New color filter now working correctly
• Fixed a bug in the binarization filter

Version 1.0.13:

• Improved accuracy of automatic document detection
• Introduced new colored document image filter

Version 1.0.12:

• Rebuilt with Xcode 7 final
• Updated some documentation

Version 1.0.11:

SBSDKScannerViewController

• Fixed an orientation issue on iPad

Version 1.0.10:

SBSDKScannerViewController

• Significantly improved peak memory usage when capturing images (~ 50%)
• Added new delegate method - (BOOL)scannerController:shouldRotateInterfaceForDeviceOrientation:transform:(CGAffineTransform)transform

Version 1.0.9:

SBSDKScannerViewController

• Added new delegate method (void)scannerControllerDidChangeDeviceOrientation:to:transform:

Version 1.0.8:

SBSDKScannerViewController

• Added new method -(BOOL)captureStillImage to allow manual capturing using the delegate interface

Version 1.0.7:

SBSDKScannerViewController

• Fixed wrong orientation of original image when capturing a document image

Version 1.0.6:

SBSDKScannerViewController

• Fixed a bug that prevented displaying the detection statuses for poor light and noise
• Added properties acceptedSizeScore and acceptedAngleScore, allowing you to alter the acceptance parameters for automatic shutter release (e.g. more perspective distortion or smaller document size)