Android Document Scanner

Additional

Language
Java
Version
1.6.1 (Dec 20, 2021)
Created
Mar 5, 2019
Updated
Dec 25, 2021
Owner
Muhammet Ali YUCE (mayuce)
Contributors
Muhammet Ali YUCE (mayuce)
bagolysz
shahawi
3
Activity
Badge
Generate
Download
Source code

Announcement

Android Document Scanner Library

If you liked the work you can think about Donate via Paypal.

This library helps you to scan any document like CamScanner.

Requirements

Add line below to your top level build.gradle

allprojects {
    repositories {
        /// ....
        mavenCentral()
    }
}

Add lines below to your app level build.gradle

    implementation 'io.github.mayuce:AndroidDocumentScanner:1.6.1'

And Sync the gradle

Usage

New version of this library provides you the gear instead of ready to go car. So you need to build your own implementation with it, before you upgrade your project make sure that you know it’s gonna be a braking change in your project.

  • Add DocumentScannerView to your layout

...
            <com.labters.documentscanner.DocumentScannerView
                    android:id="@+id/document_scanner"
                    android:layout_width="match_parent"
                    android:layout_height="match_parent" />
...
  • Set loading listener

        binding.documentScanner.setOnLoadListener { loading ->
            binding.progressBar.isVisible = loading
        }
  • Set selected Bitmap into the view

        binding.documentScanner.setImage(bitmap)
  • After selecting the edge points get cropped image

        binding.btnImageCrop.setOnClickListener {
            lifecycleScope.launch {
                binding.progressBar.isVisible = true
                val image = binding.documentScanner.getCroppedImage()
                binding.progressBar.isVisible = false
                binding.resultImage.isVisible = true
                binding.resultImage.setImageBitmap(image)
            }
        }

Additional Features

On above Android 9.0 there is magnifier to help user to see zoomed image to crop.

If you face with any issues you can take a look at com.labters.documentscannerandroid.ImageCropActivity to see how does it works.

TO-DO

  • Nothing so far, you may tell me?..

Thanks

MIT License

Copyright (c) 2020 Muhammet Ali YUCE

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.