How andrewdongminyoo/flutter_receipt_scanner works
This federated Flutter plugin acquires receipt images and returns normalized JPEGs, metadata, and on-device OCR; it does not parse receipt fields or upload results. The main workflow is an app calling scan, which routes through the platform contract to native camera or gallery capture, image processing, and OCR, then applies a Dart OCR-quality gate. Optional camera-page OCR merging and OCR capability queries are separate product features. iOS source excerpts show its orchestration and gallery processing; Android internals and several Dart modules were not sampled, so those relationships rely on README documentation.
Main entry points: GalleryPickerDelegate.swift Gallery Capture · receipt_scanner.dart Scan API · ReceiptScannerApiImpl.swift iOS Scan Orchestrator · flutter_receipt_scanner_platform.dart Platform Interface
Components 21
Dart API
- Scan API
flutter_receipt_scanner/lib/src/receipt_scanner.dart - OCR Floor Gate
flutter_receipt_scanner/lib/src/ocr_floor.dart - Page OCR Merger
flutter_receipt_scanner/lib/src/ocr_page_merger.dart
Platform Contract
- Scan Models
flutter_receipt_scanner_platform_interface/lib/src/models - Platform Interface
flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart - Pigeon Contract
flutter_receipt_scanner_platform_interface/lib/src/messages.g.dart
iOS Runtime
- iOS Scan Orchestrator
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift - Camera Capture
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift - Gallery Capture
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Quad Detection
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/QuadDetector.swift - Crop Editor
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/CropEditorViewController.swift - Image Processing
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ImageProcessor.swift - Vision OCR
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift - OCR Geometry
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrGeometry.swift - Origin Classification
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OriginClassifier.swift - iOS Registration
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift
Android Runtime
- Android Runtime
flutter_receipt_scanner_android/android/src/main/kotlin/com/example/flutter_receipt_scanner_android
Other components
- Consuming App
- iOS Scan Services
- Android Scan Services
- Scan Result
Connections 25
- Consuming App → Scan API: calls
README.md - Scan API → Platform Interface: routes through
README.md - Platform Interface → Pigeon Contract: uses contract
README.md - Platform Interface → Scan Models: exposes models
README.md - Pigeon Contract → iOS Scan Orchestrator: dispatches scan
- iOS Registration → iOS Scan Orchestrator: registers handler
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift - iOS Scan Orchestrator → Camera Capture: starts camera
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift - iOS Scan Orchestrator → Gallery Capture: starts gallery
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift - Camera Capture → Image Processing: processes pages
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift - Gallery Capture → Quad Detection: detects corners
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Gallery Capture → Crop Editor: presents editor
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Gallery Capture → Vision OCR: runs OCR
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Gallery Capture → Image Processing: encodes images
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Gallery Capture → Origin Classification: classifies origin
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift - Vision OCR → OCR Geometry: uses geometry
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift - Vision OCR → Image Processing: rotates pixels
flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift - iOS Scan Services → Camera Capture: provides capture
README.md - iOS Scan Services → Gallery Capture: provides picker
README.md - Android Scan Services → Android Runtime: provides capture
README.md - Platform Interface → Android Runtime: routes Android
README.md - iOS Scan Orchestrator → Scan Result: returns result
README.md - Android Runtime → Scan Result: returns result
README.md - Scan API → OCR Floor Gate: checks OCR floor
README.md - Scan API → Page OCR Merger: optionally merges
README.md - Scan API → Scan Result: returns result
README.md