Latest 0.3.1
Homepage https://github.com/charlymr/IRLDocumentScanner
License MIT
Platforms ios 8.0
Dependencies TOCropViewController
Authors

Demo

IRLDocumentScanner is an Objective-C ViewController that will Automatically scan a document for you you.
MINIMUM iOS REQUIREMENT: 8.0

Build StatusVersionCarthage compatiblePlatform

Screenshot

Application plist requirement (iOS 10+)

As of iOS 10, you must povide a reason for using thre camera in you plist:
Please add the follwing to your plist:
NSCameraUsageDescription : We need the camera to scan

Installation

The recommended approach for installing IRLDocumentScanner is via the CocoaPods package manager, as it provides flexible dependency management and dead simple installation. For best results, it is recommended that you install via CocoaPods >= 1.0 using Git >= 1.8.0 installed via Homebrew.

via CocoaPods

Install CocoaPods if not already available:

$ [sudo] gem install cocoapods
$ pod setup

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile

platform :ios, '8.0'

target "YOUR APP" do
pod 'IRLDocumentScanner'
use_frameworks!
end

via Carthage

Install Carthage if not already available

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

$ cd /path/to/MyProject
$ touch CartFile
$ edit CartFile

github "charlymr/IRLDocumentScanner" ~> 0.3.1

Save and run:

$ carthage update

Drop the Carthage/Build/iOS .framework in your project.

For more details on Cartage and how to use it, check the Carthage Github documentation

Manually

  • Download IRLDocumentScanner
  • Copy to your project those 2 files: IRLCamera.storyboard | IRLCameraMedia.xcassets
  • Copy to your project this folder: Source
  • Make sure your project link to ‘Foundation’, ‘UIKit’, ‘AVFoundation’, ‘CoreImage’, ‘GLKit’
  • Download TOCropViewController
  • Add it to TOCropViewController your project

Getting Started

IRLDocumentScanner is designed to be a standalone drop in dependency. You instanciate the controller, defining its delegate and present it.

Examples

Objective-C

#pragma mark - User Actions

- (IBAction)scan:(id)sender {
    IRLScannerViewController *scanner = [IRLScannerViewController standardCameraViewWithDelegate:self];
        scanner.showCountrols = YES;
        scanner.showAutoFocusWhiteRectangle = YES;
        [self presentViewController:scanner animated:YES completion:nil];
}

#pragma mark - IRLScannerViewControllerDelegate

-(void)pageSnapped:(UIImage *)page_image from:(UIViewController *)controller {
    [controller dismissViewControllerAnimated:YES completion:^{
        [self.scannedImage setImage:page_image];
    }];
}

-(void)didCancelIRLScannerViewController:(IRLScannerViewController *)cameraView {
    [cameraView dismissViewControllerAnimated:YES completion:nil];
}

Swift

   // MARK: User Actions

    @IBAction func scan(sender: AnyObject) {
        let scanner = IRLScannerViewController.standardCameraViewWithDelegate(self)
        scanner.showControls = true
        scanner.showAutoFocusWhiteRectangle = true
        presentViewController(scanner, animated: true, completion: nil)
    }

    // MARK: IRLScannerViewControllerDelegate

    func pageSnapped(page_image: UIImage!, from controller: IRLScannerViewController!) {
        controller.dismissViewControllerAnimated(true) { () -> Void in
            self.imageView.image = page_image
        }
    }

    func didCancel(_ cameraView: IRLScannerViewController) {
        cameraView.dismissViewControllerAnimated(true) {}
    }

Authors

Attribution

Open Source

  • Feel free to fork and modify this code. Pull requests are more thant welcome!

License

The MIT License (MIT)

Copyright (c) 2015 Denis Martin. Part of this code where taken from IPDFCameraViewController

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Latest podspec

{
    "name": "IRLDocumentScanner",
    "version": "0.3.1",
    "summary": "A Drop-in Document Scanner based View Controller.",
    "description": "A very simple to use class allowing you scan document with border detection.",
    "license": {
        "type": "MIT",
        "file": "LICENSE.txt"
    },
    "homepage": "https://github.com/charlymr/IRLDocumentScanner",
    "authors": {
        "Denis Martin": "[email protected]"
    },
    "source": {
        "git": "https://github.com/charlymr/IRLDocumentScanner.git",
        "branch": "master",
        "tag": "0.3.1"
    },
    "platforms": {
        "ios": "8.0"
    },
    "module_name": "IRLDocumentScanner",
    "default_subspecs": "Default",
    "dependencies": {
        "TOCropViewController": [
            "~> 2.3"
        ]
    },
    "subspecs": [
        {
            "name": "Default",
            "source_files": [
                "Source",
                "Source/**/*.{h,m}"
            ],
            "resources": [
                "*.storyboard",
                "*.xcassets"
            ],
            "ios": {
                "frameworks": [
                    "Foundation",
                    "UIKit",
                    "AVFoundation",
                    "CoreImage",
                    "GLKit"
                ]
            },
            "requires_arc": true,
            "public_header_files": [
                "Source/Public/**/*.h",
                "Source/IRLDocumentScanner.h"
            ],
            "private_header_files": "Source/Private/**/*.h"
        },
        {
            "name": "Private",
            "source_files": [
                "Source",
                "Source/**/*.{h,m}"
            ],
            "resources": [
                "*.storyboard",
                "*.xcassets"
            ],
            "ios": {
                "frameworks": [
                    "Foundation",
                    "UIKit",
                    "AVFoundation",
                    "CoreImage",
                    "GLKit"
                ]
            },
            "requires_arc": true,
            "public_header_files": [
                "Source/Public/**/*.h",
                "Source/IRLDocumentScanner.h",
                "Source/Private/**/*.h"
            ]
        }
    ]
}

Pin It on Pinterest

Share This