# chitraarasu/ocr-tamil architecture

> Architecture diagram of the GitHub repository chitraarasu/ocr-tamil, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chitraarasu/ocr-tamil
- Repository: https://github.com/chitraarasu/ocr-tamil

## Overview

OCR-Tamil is an Android app for recognizing Tamil text in images and PDFs using Tesseract 4. Users select or capture an image, or choose a PDF; the app processes it and presents recognized text and accuracy, with PDF results browsable page by page. Recent image scans can be reopened or deleted. A startup stage verifies and prepares OCR data; settings and contributor information are separate supporting features. The graph follows shown calls and SOURCE INDEX references; unsampled implementation details and some network wiring remain uncertain.

Main entry points: [`app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt) (OCR result screen), [`app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt) (Capture and file selection), [`app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt`](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt) (Recent scan queries), [`app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt`](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt) (Startup screen)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["App entry and selection"]
  node_launcher["Startup screen"]
  node_main["Capture and file selection<br/>[MainActivity.kt]"]
end

subgraph group_recognition["OCR and results"]
  node_result["OCR result screen<br/>[ResultActivity.kt]"]
  node_resultvm["PDF conversion<br/>[ResultViewModel.kt]"]
  node_pages["PDF page display"]
  node_pagefragment["Page text view"]
  node_scanner["Tesseract scanner<br/>[TessScanner.kt]"]
  node_fileutils["App file paths<br/>[FileUtils.kt]"]
end

subgraph group_history["Recent scan storage"]
  node_mainvm["History actions<br/>[MainViewModel.kt]"]
  node_recentui["Recent scan list"]
  node_scanmodel["Scan record<br/>[RecentScan.kt]"]
  node_dao["Recent scan queries<br/>[RecentScanDao.kt]"]
  node_database[("Room database<br/>[VizhiDatabase.kt]")]
end

subgraph group_support["Setup and community"]
  node_startup["OCR data setup"]
  node_settings["Settings"]
  node_contributors["Contributor listing"]
  node_contribvm["Contributor loading"]
end

node_user(("App user"))
node_tessdata(("Tesseract data host"))
node_github(("GitHub contributors API"))

node_user -->|"opens app"| node_launcher
node_launcher -->|"checks readiness"| node_startup
node_startup -.->|"fetches OCR data"| node_tessdata
node_launcher -->|"opens ready app"| node_main
node_user -->|"selects input"| node_main
node_main -->|"opens scan result"| node_result
node_main -->|"loads and deletes"| node_mainvm
node_main -->|"displays scans"| node_recentui
node_recentui -->|"dispatches item actions"| node_main
node_mainvm -->|"queries and deletes"| node_dao
node_dao -->|"reads and writes"| node_scanmodel
node_database -->|"provides access"| node_dao
node_result -->|"recognizes image text"| node_scanner
node_result -->|"gets OCR data path"| node_fileutils
node_result -->|"starts PDF conversion"| node_resultvm
node_resultvm -->|"uses OCR engine"| node_scanner
node_resultvm -->|"uses file paths"| node_fileutils
node_result -->|"shows PDF pages"| node_pages
node_pages -->|"creates page views"| node_pagefragment
node_pagefragment -.->|"uses OCR engine"| node_scanner
node_result -->|"inserts new scans"| node_dao
node_settings -->|"opens contributors"| node_contributors
node_contributors -->|"loads contributor data"| node_contribvm
node_contribvm -.->|"requests contributors"| node_github

click node_launcher "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt"
click node_startup "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherViewModel.kt"
click node_main "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt"
click node_mainvm "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainViewModel.kt"
click node_recentui "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/RecentScanAdapter.kt"
click node_result "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt"
click node_resultvm "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultViewModel.kt"
click node_pages "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageAdapter.kt"
click node_pagefragment "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageFragment.kt"
click node_scanner "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/utils/TessScanner.kt"
click node_fileutils "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/utils/FileUtils.kt"
click node_scanmodel "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/entity/RecentScan.kt"
click node_dao "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt"
click node_database "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/VizhiDatabase.kt"
click node_settings "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/SettingsActivity.kt"
click node_contributors "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsActivity.kt"
click node_contribvm "https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsViewModel.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_launcher,node_main,node_user toneBlue
class node_result,node_resultvm,node_pages,node_pagefragment,node_scanner,node_fileutils toneAmber
class node_mainvm,node_recentui,node_scanmodel,node_dao,node_database,node_github toneMint
class node_startup,node_settings,node_contributors,node_contribvm toneRose
class node_tessdata toneIndigo
```

## Components

### App entry and selection

- [Startup screen](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt`
- [Capture and file selection](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`

### OCR and results

- [OCR result screen](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`
- [PDF conversion](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultViewModel.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultViewModel.kt`
- [PDF page display](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageAdapter.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageAdapter.kt`
- [Page text view](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageFragment.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageFragment.kt`
- [Tesseract scanner](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/utils/TessScanner.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/utils/TessScanner.kt`
- [App file paths](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/utils/FileUtils.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/utils/FileUtils.kt`

### Recent scan storage

- [History actions](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainViewModel.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainViewModel.kt`
- [Recent scan list](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/RecentScanAdapter.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/RecentScanAdapter.kt`
- [Scan record](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/entity/RecentScan.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/db/entity/RecentScan.kt`
- [Recent scan queries](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt`
- [Room database](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/db/VizhiDatabase.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/db/VizhiDatabase.kt`

### Setup and community

- [OCR data setup](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherViewModel.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherViewModel.kt`
- [Settings](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/SettingsActivity.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/SettingsActivity.kt`
- [Contributor listing](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsActivity.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsActivity.kt`
- [Contributor loading](https://github.com/chitraarasu/ocr-tamil/blob/main/app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsViewModel.kt): `app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsViewModel.kt`

### Other components

- **App user**
- **Tesseract data host**
- **GitHub contributors API**

## Connections

- App user → Startup screen: opens app (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt`)
- Startup screen → OCR data setup: checks readiness (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt`)
- OCR data setup → Tesseract data host: fetches OCR data
- Startup screen → Capture and file selection: opens ready app (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/splash/LauncherActivity.kt`)
- App user → Capture and file selection: selects input (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`)
- Capture and file selection → OCR result screen: opens scan result (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`)
- Capture and file selection → History actions: loads and deletes (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`)
- Capture and file selection → Recent scan list: displays scans (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainActivity.kt`)
- Recent scan list → Capture and file selection: dispatches item actions (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/RecentScanAdapter.kt`)
- History actions → Recent scan queries: queries and deletes (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/main/MainViewModel.kt`)
- Recent scan queries → Scan record: reads and writes (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/db/dao/RecentScanDao.kt`)
- Room database → Recent scan queries: provides access (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/db/VizhiDatabase.kt`)
- OCR result screen → Tesseract scanner: recognizes image text (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`)
- OCR result screen → App file paths: gets OCR data path (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`)
- OCR result screen → PDF conversion: starts PDF conversion (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`)
- PDF conversion → Tesseract scanner: uses OCR engine (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultViewModel.kt`)
- PDF conversion → App file paths: uses file paths (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultViewModel.kt`)
- OCR result screen → PDF page display: shows PDF pages (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`)
- PDF page display → Page text view: creates page views (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageAdapter.kt`)
- Page text view → Tesseract scanner: uses OCR engine (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultPageFragment.kt`)
- OCR result screen → Recent scan queries: inserts new scans (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/result/ResultActivity.kt`)
- Settings → Contributor listing: opens contributors (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/SettingsActivity.kt`)
- Contributor listing → Contributor loading: loads contributor data (evidence: `app/src/main/java/com/jskaleel/vizhi_tamil/ui/contrib/ContributorsActivity.kt`)
- Contributor loading → GitHub contributors API: requests contributors
