Skip to content

Commit b62da99

Browse files
robert008robert008
committed
Initial release
0 parents  commit b62da99

462 files changed

Lines changed: 196979 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Miscellaneous
2+
*.class
3+
*.log
4+
*.pyc
5+
*.swp
6+
.DS_Store
7+
.atom/
8+
.build/
9+
.buildlog/
10+
.history
11+
.svn/
12+
.swiftpm/
13+
migrate_working_dir/
14+
15+
# IntelliJ related
16+
*.iml
17+
*.ipr
18+
*.iws
19+
.idea/
20+
21+
# The .vscode folder contains launch configuration and tasks you configure in
22+
# VS Code which you may wish to be included in version control, so this line
23+
# is commented out by default.
24+
#.vscode/
25+
26+
# Flutter/Dart/Pub related
27+
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
28+
/pubspec.lock
29+
**/doc/api/
30+
.dart_tool/
31+
.flutter-plugins
32+
.flutter-plugins-dependencies
33+
build/
34+
35+
# Project specific
36+
CLAUDE.md
37+
.claude/
38+
doc/
39+
scripts/
40+
41+
# Build artifacts
42+
src/build/
43+
*.a
44+
*.so
45+
*.dylib
46+
*.framework/
47+
48+
# OpenCV SDK is stored in ~/.opencv/ (shared across projects)

‎.metadata‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# This file tracks properties of this Flutter project.
2+
# Used by Flutter tool to assess capabilities and perform upgrades etc.
3+
#
4+
# This file should be version controlled and should not be manually edited.
5+
6+
version:
7+
revision: "c23637390482d4cf9598c3ce3f2be31aa7332daf"
8+
channel: "stable"
9+
10+
project_type: plugin_ffi
11+
12+
# Tracks metadata for the flutter migrate command
13+
migration:
14+
platforms:
15+
- platform: root
16+
create_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
17+
base_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
18+
- platform: android
19+
create_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
20+
base_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
21+
- platform: ios
22+
create_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
23+
base_revision: c23637390482d4cf9598c3ce3f2be31aa7332daf
24+
25+
# User provided section
26+
27+
# List of Local paths (relative to this file) that should be
28+
# ignored by the migrate tool.
29+
#
30+
# Files that are not part of the templates will be ignored by default.
31+
unmanaged_files:
32+
- 'lib/main.dart'
33+
- 'ios/Runner.xcodeproj/project.pbxproj'

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## 0.0.1
2+
3+
- Document corner detection using OpenCV (Canny + findContours)
4+
- Quality assessment: blur, brightness, stability scoring
5+
- Perspective correction with guide frame
6+
- Image enhancement modes: whitenBg, contrastStretch, adaptiveBinarize, sauvola
7+
- Auto-capture trigger when quality thresholds are met
8+
- Example app with A/B test and batch test pages

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Flutter Document Capture
2+
3+
A Flutter FFI plugin for real-time document capture preprocessing. Uses OpenCV for image processing on mobile devices (Edge AI) to optimize input quality for downstream OCR and layout detection.
4+
5+
## Features
6+
7+
- **Document Detection** - OpenCV-based corner detection using Canny + findContours
8+
- **Quality Assessment** - Blur, brightness, and stability scoring
9+
- **Perspective Correction** - Transform skewed documents to rectangular
10+
- **Image Enhancement** - Multiple enhancement modes for OCR optimization
11+
- **Auto-capture Trigger** - Automatic capture when quality thresholds are met
12+
13+
## Screenshot
14+
15+
![Screenshot](screenshot.png)
16+
17+
## Demo
18+
19+
### A/B Test
20+
Real-time comparison between instant capture and processed results.
21+
22+
<!-- TODO: Add demo video -->
23+
24+
### Batch Test
25+
Compare recognition accuracy with preprocessing ON vs OFF.
26+
27+
<!-- TODO: Add demo video -->
28+
29+
## Results
30+
31+
Preprocessing significantly improves OCR recognition accuracy and stability.
32+
33+
| Mode | Avg Score | Success Rate |
34+
|------|-----------|--------------|
35+
| OFF | --% | --% |
36+
| ON | --% | --% |
37+
38+
## Why Use This Package?
39+
40+
| Benefit | Description |
41+
|---------|-------------|
42+
| **Higher Accuracy** | Preprocessing improves OCR recognition rate |
43+
| **Better Stability** | Multi-frame buffering selects the best result |
44+
| **Faster Valid Results** | Reduces time to obtain valid recognition |
45+
46+
> **Note:** Single-frame processing time is not faster (due to preprocessing + multi-frame buffer), but overall time to get valid results is reduced.
47+
48+
## Installation
49+
50+
Add to your `pubspec.yaml`:
51+
52+
```yaml
53+
dependencies:
54+
flutter_document_capture:
55+
git:
56+
url: https://github.com/robert008/flutter_document_capture.git
57+
```
58+
59+
## Usage
60+
61+
### Basic Setup
62+
63+
```dart
64+
import 'package:flutter_document_capture/flutter_document_capture.dart';
65+
66+
// Initialize engine
67+
final engine = DocumentCaptureEngine();
68+
69+
// Analyze frame quality
70+
final analysis = engine.analyzeFrame(
71+
imageBytes,
72+
width,
73+
height,
74+
format: 2, // RGB
75+
);
76+
77+
// Check if ready for capture
78+
if (analysis.captureReady) {
79+
// Capture and enhance
80+
final result = engine.enhanceImageWithGuideFrame(
81+
imageBytes,
82+
width,
83+
height,
84+
guideLeft,
85+
guideTop,
86+
guideRight,
87+
guideBottom,
88+
enhanceMode: EnhanceMode.contrastStretch,
89+
);
90+
}
91+
92+
// Cleanup
93+
engine.dispose();
94+
```
95+
96+
### Enhancement Modes
97+
98+
```dart
99+
enum EnhanceMode {
100+
none, // No enhancement
101+
whitenBg, // Background whitening
102+
contrastStretch, // Contrast stretching (recommended)
103+
adaptiveBinarize, // Adaptive binarization
104+
sauvola, // Sauvola binarization
105+
}
106+
```
107+
108+
### Frame Analysis Result
109+
110+
```dart
111+
class FrameAnalysisResult {
112+
bool documentFound; // Document corners detected
113+
bool tableFound; // Table region detected
114+
bool textRegionFound; // Text regions detected
115+
double blurScore; // 0.0 - 1.0 (higher = sharper)
116+
double brightnessScore; // 0.0 - 1.0
117+
double stabilityScore; // 0.0 - 1.0
118+
double cornerConfidence; // 0.0 - 1.0
119+
bool captureReady; // All thresholds met
120+
List<double> corners; // 8 values: [x0,y0,x1,y1,x2,y2,x3,y3]
121+
}
122+
```
123+
124+
## Requirements
125+
126+
- Flutter 3.0+
127+
- iOS 12.0+ / Android API 21+
128+
- OpenCV (bundled)
129+
130+
## Related Projects
131+
132+
- [flutter_ocr_kit](https://github.com/robert008/flutter_ocr_kit) - OCR + Layout Detection
133+
134+
## License
135+
136+
MIT License - see [LICENSE](LICENSE) for details.

‎analysis_options.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include: package:flutter_lints/flutter.yaml
2+
3+
# Additional information about this file can be found at
4+
# https://dart.dev/guides/language/analysis-options

‎android/.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea/workspace.xml
5+
/.idea/libraries
6+
.DS_Store
7+
/build
8+
/captures
9+
.cxx

‎android/build.gradle‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
// The Android Gradle Plugin builds the native code with the Android NDK.
2+
3+
group = "com.example.flutter_document_capture"
4+
version = "1.0"
5+
6+
buildscript {
7+
repositories {
8+
google()
9+
mavenCentral()
10+
}
11+
12+
dependencies {
13+
classpath("com.android.tools.build:gradle:8.7.0")
14+
}
15+
}
16+
17+
rootProject.allprojects {
18+
repositories {
19+
google()
20+
mavenCentral()
21+
}
22+
}
23+
24+
apply plugin: "com.android.library"
25+
26+
// Pre-built native libraries configuration (same pattern as flutter_ocr_kit)
27+
def jniLibsDir = file("src/main/jniLibs")
28+
def arm64Dir = file("src/main/jniLibs/arm64-v8a")
29+
def releaseVersion = "v1.0.0"
30+
// TODO: Update this URL when GitHub release is created
31+
def downloadUrl = "https://github.com/anthropics/flutter_document_capture/releases/download/${releaseVersion}/jniLibs.zip"
32+
33+
task downloadNativeLibraries {
34+
doLast {
35+
// Check if native libraries already exist
36+
if (arm64Dir.exists() && file("${arm64Dir}/libflutter_document_capture.so").exists()) {
37+
println "Android native libraries already exist"
38+
return
39+
}
40+
41+
println "Downloading Android native libraries..."
42+
println "URL: ${downloadUrl}"
43+
44+
def zipFile = file("${buildDir}/jniLibs.zip")
45+
zipFile.parentFile.mkdirs()
46+
47+
ant.get(src: downloadUrl, dest: zipFile, skipexisting: 'false')
48+
49+
jniLibsDir.mkdirs()
50+
ant.unzip(src: zipFile, dest: jniLibsDir)
51+
52+
zipFile.delete()
53+
54+
println "Android native libraries downloaded successfully"
55+
}
56+
}
57+
58+
// Skip download task for now since we're building locally
59+
// preBuild.dependsOn downloadNativeLibraries
60+
61+
android {
62+
namespace = "com.example.flutter_document_capture"
63+
64+
compileSdk = 35
65+
66+
// Use default NDK version for ABI compatibility with pre-built OpenCV
67+
// ndkVersion = "27.0.12077973"
68+
69+
compileOptions {
70+
sourceCompatibility = JavaVersion.VERSION_11
71+
targetCompatibility = JavaVersion.VERSION_11
72+
}
73+
74+
defaultConfig {
75+
minSdk = 21
76+
77+
ndk {
78+
abiFilters 'arm64-v8a', 'armeabi-v7a'
79+
}
80+
81+
externalNativeBuild {
82+
cmake {
83+
cppFlags "-std=c++17 -frtti -fexceptions"
84+
arguments "-DANDROID_STL=c++_shared"
85+
}
86+
}
87+
}
88+
89+
externalNativeBuild {
90+
cmake {
91+
path = "../src/CMakeLists.txt"
92+
version "3.22.1"
93+
}
94+
}
95+
96+
sourceSets {
97+
main {
98+
jniLibs.srcDirs = ['src/main/jniLibs']
99+
}
100+
}
101+
}

‎android/settings.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
rootProject.name = 'flutter_document_capture'

‎android/src/main/AndroidManifest.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
2+
package="com.example.flutter_document_capture">
3+
</manifest>

0 commit comments

Comments
 (0)