├── .gitignore ├── .idea ├── codeStyles │ └── Project.xml ├── encodings.xml ├── gradle.xml ├── misc.xml ├── runConfigurations.xml └── vcs.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── net │ │ └── idscan │ │ └── example │ │ └── android │ │ └── mrzscannerexample │ │ └── ExampleInstrumentedTest.java │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── net │ │ │ └── idscan │ │ │ └── example │ │ │ └── android │ │ │ └── mrzscannerexample │ │ │ ├── CustomScanActivity.java │ │ │ └── MainActivity.java │ └── res │ │ ├── drawable-v24 │ │ └── ic_launcher_foreground.xml │ │ ├── drawable │ │ └── ic_launcher_background.xml │ │ ├── layout │ │ ├── activity_main.xml │ │ └── custom_viewfinder.xml │ │ ├── mipmap-anydpi-v26 │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ └── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── styles.xml │ └── test │ └── java │ └── net │ └── idscan │ └── example │ └── android │ └── mrzscannerexample │ └── ExampleUnitTest.java ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── images └── scan_view_structure.png └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/caches 5 | /.idea/libraries 6 | /.idea/modules.xml 7 | /.idea/workspace.xml 8 | /.idea/navEditor.xml 9 | /.idea/assetWizardSettings.xml 10 | .DS_Store 11 | /build 12 | /captures 13 | .externalNativeBuild 14 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 7 | 8 | 9 |
10 | 11 | 12 | 13 | xmlns:android 14 | 15 | ^$ 16 | 17 | 18 | 19 |
20 |
21 | 22 | 23 | 24 | xmlns:.* 25 | 26 | ^$ 27 | 28 | 29 | BY_NAME 30 | 31 |
32 |
33 | 34 | 35 | 36 | .*:id 37 | 38 | http://schemas.android.com/apk/res/android 39 | 40 | 41 | 42 |
43 |
44 | 45 | 46 | 47 | .*:name 48 | 49 | http://schemas.android.com/apk/res/android 50 | 51 | 52 | 53 |
54 |
55 | 56 | 57 | 58 | name 59 | 60 | ^$ 61 | 62 | 63 | 64 |
65 |
66 | 67 | 68 | 69 | style 70 | 71 | ^$ 72 | 73 | 74 | 75 |
76 |
77 | 78 | 79 | 80 | .* 81 | 82 | ^$ 83 | 84 | 85 | BY_NAME 86 | 87 |
88 |
89 | 90 | 91 | 92 | .* 93 | 94 | http://schemas.android.com/apk/res/android 95 | 96 | 97 | ANDROID_ATTRIBUTE_ORDER 98 | 99 |
100 |
101 | 102 | 103 | 104 | .* 105 | 106 | .* 107 | 108 | 109 | BY_NAME 110 | 111 |
112 | 113 | 114 | 115 | 116 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 17 | 18 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 14 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ScanMrz Library 2 | 3 | ## Setup 4 | 5 | 1. Add **idscan-public** maven repository to the project **build.gradle** file. 6 | ``` 7 | allprojects { 8 | repositories { 9 | ... 10 | maven { 11 | url 'https://www.myget.org/F/idscan-public/maven/' 12 | } 13 | ... 14 | } 15 | } 16 | ``` 17 | 18 | 2. Add the following to the module **build.gradle** file: 19 | ``` 20 | dependencies { 21 | ... 22 | implementation 'net.idscan.components.android:scanmrz:1.3.0' 23 | ... 24 | } 25 | ``` 26 | 27 | ## Using 28 | 29 | For scanning you need to call ```MrzScanActivity```: 30 | 31 | ``` 32 | Intent i = new Intent(MainActivity.this, MrzScanActivity.class); 33 | i.putExtra(MrzScanActivity.EXTRA_LICENSE_KEY, ** LICENSE KEY **); 34 | startActivityForResult(i, SCAN_ACTIVITY_CODE); 35 | ``` 36 | **Note** need to replace ```** LICENSE KEY **``` by your **License Key**. To obtain a license key, please email your application’s package name to support@idscan.net. 37 | 38 | To process the result you need to override ```onActivityResult()``` of your Activity. 39 | 40 | ``` 41 | @Override 42 | protected void onActivityResult(int requestCode, int resultCode, Intent data) { 43 | super.onActivityResult(requestCode, resultCode, data); 44 | if (requestCode == SCAN_ACTIVITY_CODE) { 45 | switch (resultCode) { 46 | case MrzScanActivity.RESULT_OK: 47 | if (data != null) { 48 | MrzScanActivity.MRZData result = 49 | data.getParcelableExtra(MrzScanActivity.DOCUMENT_DATA); 50 | // TODO: Handle the data. 51 | } 52 | break; 53 | 54 | case MrzScanActivity.ERROR_RECOGNITION: 55 | if (data != null) { 56 | String desc = 57 | data.getStringExtra(MrzScanActivity.ERROR_DESCRIPTION); 58 | // TODO: Handle the error. 59 | } 60 | break; 61 | 62 | case MrzScanActivity.ERROR_INVALID_CAMERA_NUMBER: 63 | case MrzScanActivity.ERROR_CAMERA_NOT_AVAILABLE: 64 | case MrzScanActivity.ERROR_INVALID_CAMERA_ACCESS: 65 | case MrzScanActivity.RESULT_CANCELED: 66 | // TODO: Handle the error. 67 | break; 68 | } 69 | } 70 | } 71 | ``` 72 | 73 | #### Error codes: 74 | 75 | * ```ERROR_RECOGNITION``` internal error. 76 | 77 | * ```ERROR_CAMERA_NOT_AVAILABLE``` device has no camera. 78 | 79 | * ```ERROR_INVALID_CAMERA_NUMBER``` invalid camera number is selected. 80 | 81 | * ```ERROR_INVALID_CAMERA_ACCESS``` application cannot access the camera. For example, camera can be captured by the other application or application has no permission to use the camera. 82 | 83 | * ```ERROR_INVALID_LICENSE_KEY``` **License Key** is invalid. 84 | 85 | ## Customization 86 | 87 | For customization **scanning activity** you need to extend MrzScanActivity and override some methods. 88 | 89 | #### Custom Viewfinder 90 | 91 | The **scanning activity** has the following structure: 92 | ![Structure of Scanning View](/images/scan_view_structure.png) 93 | 94 | By default, **Viewfinder** layer is a simple view with a frame. You can replace it with a custom view. For that you need to override ```getViewFinder(LayoutInflater inflater)``` method. Also, you can add any views to **Viewfinder** layer. 95 | ``` 96 | @Override 97 | protected View getViewFinder(LayoutInflater inflater) { 98 | View v = inflater.inflate(R.layout.custom_viewfinder, null); 99 | 100 | // TODO: setup view. 101 | 102 | return v; 103 | } 104 | ``` 105 | 106 | **Note** **Viewfinder** layer is drawn as an overlay above the **camera preview** layer, so it should has a transparent background color. 107 | 108 | #### Select camera 109 | 110 | You have two ways to select active camera in the **scanning activity**: 111 | 112 | 1. You can override ```selectCamera(int numberOfCameras)``` method and return the number of desired camera. 113 | ``` 114 | @Override 115 | protected int selectCamera(int numberOfCameras) { 116 | // TODO: Return number of camera in range [0, numberOfCameras). 117 | } 118 | ``` 119 | 2. You can call ```setCamera(int id)``` method to change the current active camera. 120 | 121 | 122 | #### Handle scanned data 123 | 124 | By default, when MRZ is recognized it returns via ```onActivityResult``` method. But you can change this behavior by overriding ```onData(PDF4MRZData17Result result)``` method. That is default implementation of this method: 125 | ``` 126 | protected void onData(@NonNull MRZData result) { 127 | finish(result); 128 | } 129 | ``` 130 | But you can process scanned data in a different way. For example, you can display MRZ on **Viewfiender** layer. Also you don't have to return the result immediately. Instead of, you can return scanned data at any time in future by calling ```void finish(MRZData result)``` method. 131 | 132 | #### Flashlight 133 | 134 | You have two ways to control flashlight: 135 | 136 | 1. You can call **scanning activity** with ```EXTRA_FLASH_STATE``` parameter with ```true``` value and if flashlight is available it will be turned on. 137 | ``` 138 | Intent i = new Intent(MainActivity.this, MrzScanActivity.class); 139 | i.putExtra(MrzScanActivity.EXTRA_LICENSE_KEY, LIC_KEY); 140 | i.putExtra(MrzScanActivity.EXTRA_FLASH_STATE, true); 141 | startActivityForResult(i, SCAN_ACTIVITY_CODE); 142 | ``` 143 | 2. You can change state of the flashlight by calling ```setFlashState(booelan state)```. 144 | ``` 145 | public class CustomScanActivity extends MrzScanActivity { 146 | ... 147 | void switchFlashlight() { 148 | setFlashState(!getFlashState()); 149 | } 150 | ... 151 | } 152 | ``` 153 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 28 5 | defaultConfig { 6 | applicationId "net.idscan.example.android.mrzscannerexample" 7 | minSdkVersion 19 8 | targetSdkVersion 28 9 | versionCode 1 10 | versionName "1.0" 11 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 12 | } 13 | buildTypes { 14 | release { 15 | minifyEnabled false 16 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 17 | } 18 | } 19 | } 20 | 21 | dependencies { 22 | implementation fileTree(dir: 'libs', include: ['*.jar']) 23 | implementation 'com.android.support:appcompat-v7:28.0.0' 24 | implementation 'com.android.support:design:28.0.0' 25 | implementation 'com.android.support.constraint:constraint-layout:1.1.3' 26 | implementation 'net.idscan.components.android:scanmrz:1.3.0' 27 | 28 | testImplementation 'junit:junit:4.12' 29 | androidTestImplementation 'com.android.support.test:runner:1.0.2' 30 | androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' 31 | } 32 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /app/src/androidTest/java/net/idscan/example/android/mrzscannerexample/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package net.idscan.example.android.mrzscannerexample; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumented test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) 18 | public class ExampleInstrumentedTest { 19 | @Test 20 | public void useAppContext() { 21 | // Context of the app under test. 22 | Context appContext = InstrumentationRegistry.getTargetContext(); 23 | 24 | assertEquals("net.idscan.example.android.mrzscannerexample", appContext.getPackageName()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /app/src/main/java/net/idscan/example/android/mrzscannerexample/CustomScanActivity.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2017 IDScan.net 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | * Support: support@idscan.net 17 | */ 18 | 19 | package net.idscan.example.android.mrzscannerexample; 20 | 21 | import android.content.Context; 22 | import android.content.SharedPreferences; 23 | import android.media.AudioManager; 24 | import android.media.ToneGenerator; 25 | import android.os.Bundle; 26 | import android.os.Handler; 27 | import android.support.annotation.NonNull; 28 | import android.view.LayoutInflater; 29 | import android.view.View; 30 | import android.view.ViewGroup; 31 | import android.widget.Button; 32 | import android.widget.FrameLayout; 33 | import android.widget.ImageView; 34 | import android.widget.TextView; 35 | 36 | import net.idscan.components.android.scanmrz.MrzScanActivity; 37 | 38 | public class CustomScanActivity extends MrzScanActivity { 39 | private static final String _PREFS_NAME = "CustomScanActivitySettings"; 40 | 41 | private int _number_of_cameras = 0; 42 | private int _current_camera = 0; 43 | private MRZData _result; 44 | 45 | private Button _btn_confirm; 46 | private TextView _tv_scanned_data; 47 | private ImageView _iv_info; 48 | 49 | private ToneGenerator _beep; 50 | 51 | private Handler _handler = new Handler(); 52 | 53 | @Override 54 | protected void onCreate(Bundle savedInstanceState) { 55 | super.onCreate(savedInstanceState); 56 | 57 | _beep = new ToneGenerator(AudioManager.STREAM_ALARM, 50); 58 | } 59 | 60 | @Override 61 | protected void onDestroy() { 62 | super.onDestroy(); 63 | _beep.release(); 64 | } 65 | 66 | @Override 67 | protected void onStop() { 68 | super.onStop(); 69 | _handler.removeCallbacks(_clearResult); 70 | } 71 | 72 | @Override 73 | protected int selectCamera(int numberOfCameras) { 74 | _number_of_cameras = numberOfCameras; 75 | 76 | SharedPreferences pref = getSharedPreferences(_PREFS_NAME, Context.MODE_PRIVATE); 77 | _current_camera = pref.getInt("camera", 0); 78 | 79 | if (_current_camera >= _number_of_cameras) { 80 | _current_camera = 0; 81 | pref.edit() 82 | .putInt("camera", _current_camera) 83 | .apply(); 84 | } 85 | 86 | return _current_camera; 87 | } 88 | 89 | @Override 90 | protected View getViewFinder(LayoutInflater inflater) { 91 | View v = inflater.inflate(R.layout.custom_viewfinder, null); 92 | 93 | View old_vf = super.getViewFinder(inflater); 94 | if (old_vf != null) { 95 | FrameLayout old_vf_layout = v.findViewById(R.id.old_vf); 96 | ViewGroup.LayoutParams p = new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT); 97 | old_vf_layout.addView(old_vf, p); 98 | } 99 | 100 | _tv_scanned_data = v.findViewById(R.id.tv_scanned_data); 101 | _iv_info = v.findViewById(R.id.iv_info); 102 | _btn_confirm = v.findViewById(R.id.btn_confirm); 103 | _btn_confirm.setOnClickListener(new View.OnClickListener() { 104 | @Override 105 | public void onClick(View view) { 106 | finish(_result); 107 | } 108 | }); 109 | _btn_confirm.setVisibility(View.VISIBLE); 110 | v.findViewById(R.id.btn_next_camera).setOnClickListener(new View.OnClickListener() { 111 | @Override 112 | public void onClick(View view) { 113 | 114 | // Select next camera. 115 | _current_camera++; 116 | if (_current_camera >= _number_of_cameras) 117 | _current_camera = 0; 118 | 119 | if (setCamera(_current_camera)) { 120 | // Save the last selected camera. 121 | getSharedPreferences(_PREFS_NAME, Context.MODE_PRIVATE).edit() 122 | .putInt("camera", _current_camera) 123 | .apply(); 124 | } 125 | } 126 | }); 127 | 128 | v.findViewById(R.id.btn_flash).setOnClickListener(new View.OnClickListener() { 129 | @Override 130 | public void onClick(View v) { 131 | setFlashState(!getFlashState()); 132 | } 133 | }); 134 | 135 | return v; 136 | } 137 | 138 | @Override 139 | protected void onData(@NonNull MRZData result) { 140 | if (!result.equals(_result)) { 141 | _result = result; 142 | MRZField line1 = result.fields.get(MRZFieldType.Line1); 143 | MRZField line2 = result.fields.get(MRZFieldType.Line2); 144 | MRZField line3 = result.fields.get(MRZFieldType.Line3); 145 | String sb = ""; 146 | if (line1 != null) { 147 | sb = sb + line1.value + "\n"; 148 | } 149 | if (line2 != null) { 150 | sb = sb + line2.value + "\n"; 151 | } 152 | if (line3 != null) { 153 | sb = sb + line3.value + "\n"; 154 | } 155 | _tv_scanned_data.setText(sb); 156 | _btn_confirm.setVisibility(View.VISIBLE); 157 | _beep.startTone(ToneGenerator.TONE_CDMA_ALERT_CALL_GUARD, 200); 158 | } 159 | 160 | _handler.removeCallbacks(_clearResult); 161 | _handler.postDelayed(_clearResult, 2500); 162 | } 163 | 164 | private Runnable _clearResult = new Runnable() { 165 | @Override 166 | public void run() { 167 | _result = null; 168 | _tv_scanned_data.setText(""); 169 | } 170 | }; 171 | } 172 | -------------------------------------------------------------------------------- /app/src/main/java/net/idscan/example/android/mrzscannerexample/MainActivity.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2017 IDScan.net 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | * Support: support@idscan.net 17 | */ 18 | 19 | package net.idscan.example.android.mrzscannerexample; 20 | 21 | import android.Manifest; 22 | import android.content.Intent; 23 | import android.content.pm.PackageManager; 24 | import android.os.Bundle; 25 | import android.support.annotation.NonNull; 26 | import android.support.v4.app.ActivityCompat; 27 | import android.support.v4.content.ContextCompat; 28 | import android.support.v7.app.AppCompatActivity; 29 | import android.text.method.ScrollingMovementMethod; 30 | import android.view.View; 31 | import android.widget.TextView; 32 | 33 | import net.idscan.components.android.scanmrz.MrzScanActivity; 34 | import net.idscan.components.android.scanmrz.Version; 35 | 36 | public class MainActivity extends AppCompatActivity { 37 | private final static int SCAN_ACTIVITY_CODE = 0x001; 38 | private final static int REQUEST_CAMERA_PERMISSIONS_DEFAULT = 0x100; 39 | private final static int REQUEST_CAMERA_PERMISSIONS_CUSTOM = 0x101; 40 | 41 | // Valid key. 42 | private final static String LIC_KEY = "HnbRlGg5dNGMR8R0q35waR9GBLERp0u0I2nqElr+roc5W3+72TagPH6udPA0zC/h3H73r4gNOfWh3JNzdOYQWl3a9aO1n1lUZssy2vQbaRsW85QcUEHIjDT/zj1ube0XNEmeTv91HVHKhtDaCtqUenxUrGfWz/ucKu7XbafRIuA="; 43 | 44 | @Override 45 | protected void onCreate(Bundle savedInstanceState) { 46 | super.onCreate(savedInstanceState); 47 | setContentView(R.layout.activity_main); 48 | ((TextView) findViewById(R.id.tv_result)).setMovementMethod(new ScrollingMovementMethod()); 49 | 50 | ((TextView) findViewById(R.id.tv_version)).setText("Version: " + Version.getVersion()); 51 | 52 | findViewById(R.id.btn_scan).setOnClickListener(new View.OnClickListener() { 53 | @Override 54 | public void onClick(View view) { 55 | showDefaultScanView(); 56 | } 57 | }); 58 | 59 | findViewById(R.id.btn_scan_custom).setOnClickListener(new View.OnClickListener() { 60 | @Override 61 | public void onClick(View view) { 62 | showCustomScanView(); 63 | } 64 | }); 65 | } 66 | 67 | @Override 68 | public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) { 69 | super.onRequestPermissionsResult(requestCode, permissions, grantResults); 70 | switch (requestCode) { 71 | case REQUEST_CAMERA_PERMISSIONS_DEFAULT: 72 | if (checkCameraPermissions()) { 73 | showDefaultScanView(); 74 | } 75 | break; 76 | 77 | case REQUEST_CAMERA_PERMISSIONS_CUSTOM: 78 | if (checkCameraPermissions()) { 79 | showCustomScanView(); 80 | } 81 | break; 82 | } 83 | } 84 | 85 | @Override 86 | protected void onActivityResult(int requestCode, int resultCode, Intent data) { 87 | super.onActivityResult(requestCode, resultCode, data); 88 | 89 | if (requestCode == SCAN_ACTIVITY_CODE) { 90 | TextView tv_result = findViewById(R.id.tv_result); 91 | 92 | switch (resultCode) { 93 | case MrzScanActivity.RESULT_OK: 94 | if (data != null) { 95 | MrzScanActivity.MRZData result = data.getParcelableExtra(MrzScanActivity.DOCUMENT_DATA); 96 | if (result != null) { 97 | StringBuilder text = new StringBuilder(); 98 | for (MrzScanActivity.MRZField f : result.fields.values()) { 99 | switch (f.type) { 100 | case DocumentType: 101 | text.append("DocumentType: ").append(f.value).append("\n"); 102 | break; 103 | case FullName: 104 | text.append("FullName: ").append(f.value).append("\n"); 105 | break; 106 | case LastName: 107 | text.append("LastName: ").append(f.value).append("\n"); 108 | break; 109 | case FirstName: 110 | text.append("FirstName: ").append(f.value).append("\n"); 111 | break; 112 | case Dob: 113 | text.append("Dob: ").append(f.value).append("\n"); 114 | break; 115 | case Exp: 116 | text.append("Exp: ").append(f.value).append("\n"); 117 | break; 118 | case DocumentNumber: 119 | text.append("DocumentNumber: ").append(f.value).append("\n"); 120 | break; 121 | case Gender: 122 | text.append("Gender: ").append(f.value).append("\n"); 123 | break; 124 | case IssuingState: 125 | text.append("IssuingState: ").append(f.value).append("\n"); 126 | break; 127 | case Nationality: 128 | text.append("Nationality: ").append(f.value).append("\n"); 129 | break; 130 | case Line1: 131 | text.append("Line1: ").append(f.value).append("\n"); 132 | break; 133 | case Line2: 134 | text.append("Line2: ").append(f.value).append("\n"); 135 | break; 136 | case Line3: 137 | text.append("Line3: ").append(f.value).append("\n"); 138 | break; 139 | } 140 | } 141 | 142 | tv_result.setText(text.toString()); 143 | } 144 | } 145 | break; 146 | 147 | case MrzScanActivity.ERROR_RECOGNITION: 148 | tv_result.setText(data.getStringExtra(MrzScanActivity.ERROR_DESCRIPTION)); 149 | break; 150 | 151 | case MrzScanActivity.ERROR_INVALID_CAMERA_NUMBER: 152 | tv_result.setText("Invalid camera number."); 153 | break; 154 | 155 | case MrzScanActivity.ERROR_CAMERA_NOT_AVAILABLE: 156 | tv_result.setText("Camera not available."); 157 | break; 158 | 159 | case MrzScanActivity.ERROR_INVALID_CAMERA_ACCESS: 160 | tv_result.setText("Invalid camera access."); 161 | break; 162 | 163 | case MrzScanActivity.RESULT_CANCELED: 164 | break; 165 | 166 | default: 167 | tv_result.setText("Undefined error."); 168 | break; 169 | } 170 | } 171 | } 172 | 173 | private void showDefaultScanView() { 174 | if (checkCameraPermissions()) { 175 | Intent i = new Intent(MainActivity.this, MrzScanActivity.class); 176 | i.putExtra(MrzScanActivity.EXTRA_LICENSE_KEY, LIC_KEY); 177 | startActivityForResult(i, SCAN_ACTIVITY_CODE); 178 | } else { 179 | requestCameraPermissions(REQUEST_CAMERA_PERMISSIONS_DEFAULT); 180 | } 181 | } 182 | 183 | private void showCustomScanView() { 184 | if (checkCameraPermissions()) { 185 | Intent i = new Intent(MainActivity.this, CustomScanActivity.class); 186 | i.putExtra(MrzScanActivity.EXTRA_LICENSE_KEY, LIC_KEY); 187 | startActivityForResult(i, SCAN_ACTIVITY_CODE); 188 | } else { 189 | requestCameraPermissions(REQUEST_CAMERA_PERMISSIONS_CUSTOM); 190 | } 191 | } 192 | 193 | private boolean checkCameraPermissions() { 194 | int status = ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA); 195 | return (status == PackageManager.PERMISSION_GRANTED); 196 | } 197 | 198 | private void requestCameraPermissions(int requestCode) { 199 | ActivityCompat.requestPermissions( 200 | this, 201 | new String[]{Manifest.permission.CAMERA}, 202 | requestCode); 203 | } 204 | } 205 | -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 12 | 13 | 19 | 22 | 25 | 26 | 27 | 28 | 34 | 35 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 18 | 19 | 23 | 24 | 29 | 30 | 35 | 36 |