diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..3409833
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,178 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+build
+output
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
diff --git a/.prettierrc b/.prettierrc
new file mode 100644
index 0000000..fdf53d1
--- /dev/null
+++ b/.prettierrc
@@ -0,0 +1,7 @@
+{
+ "$schema": "https://json.schemastore.org/prettierrc",
+ "semi": false,
+ "singleQuote": true,
+ "trailingComma": "all",
+ "bracketSpacing": true
+}
\ No newline at end of file
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..d1b4edb
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+ "editor.formatOnSave": true,
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
+}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fa48188
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2024 Guten Ye
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1068904
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# @gutenye/ocr
+
+> an OCR Javascript library works on Node.js, Browser and React Native
+
+Based on [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)
+
+## Examples
+
+- [Node Example](./examples/node/README.md)
+- [Browser Example](./examples/browser/README.md)
+
+## Getting Started
+
+### Node
+
+```ts
+bun add @gutenye/ocr-node
+import Ocr from '@guenye/ocr-node'
+const ocr = await Ocr.create()
+const result = await ocr.detect('a.jpg')
+```
+
+### Browser
+
+```ts
+bun add @gutenye/ocr-browser
+import Ocr from '@gutenye/ocr-browser'
+const ocr = await Ocr.create({
+ models: {
+ detectionPath: '/assets/ch_PP-OCRv3_det_infer.onnx',
+ recognitionPath: '/assets/ch_PP-OCRv3_rec_infer.onnx',
+ dictionaryPath: '/assets/ppocr_keys_v1.txt'
+ }
+})
+const result = await ocr.detect(imageUrl)
+```
+
+### React Native
+
+Due to opencv does not work on React Native. You need to implement the [detectBoxes](./common/src/splitIntoLineImages.ts) method by yourself
+
+## Related Projects
+
+| Name | Platforms | Note |
+| -------------------------------------------------------------- | --------- | ------------------------------- |
+| [eSearch-OCR](https://github.com/xushengfeng/eSearch-OCR) | Electron | |
+| [paddleocr-onnx](https://github.com/backrunner/paddleocr-onnx) | Node | Recogination part is incomplete |
+| [ocrjs](https://github.com/SOVLOOKUP/ocrjs) | Node | Recogination part is incomplete |
diff --git a/ake b/ake
new file mode 100755
index 0000000..c8873cd
--- /dev/null
+++ b/ake
@@ -0,0 +1,18 @@
+#!/usr/bin/env nu
+
+def main [] {}
+
+def 'main build' [] {
+ bun run scripts/build.ts
+}
+
+def 'main node' [] {
+ cd examples/node
+ ./ake start
+}
+
+def 'main browser' [] {
+ cd examples/browser
+ ./ake build
+ ./ake start
+}
diff --git a/bun.lockb b/bun.lockb
new file mode 100755
index 0000000..ea3c2b4
Binary files /dev/null and b/bun.lockb differ
diff --git a/examples/assets/cn-01.jpg b/examples/assets/cn-01.jpg
new file mode 100644
index 0000000..ed91b8c
Binary files /dev/null and b/examples/assets/cn-01.jpg differ
diff --git a/examples/assets/cn-02.jpg b/examples/assets/cn-02.jpg
new file mode 100644
index 0000000..5c3329a
Binary files /dev/null and b/examples/assets/cn-02.jpg differ
diff --git a/examples/assets/cn-03.jpg b/examples/assets/cn-03.jpg
new file mode 100644
index 0000000..3cd2e79
Binary files /dev/null and b/examples/assets/cn-03.jpg differ
diff --git a/examples/assets/cn-04.jpg b/examples/assets/cn-04.jpg
new file mode 100644
index 0000000..0801017
Binary files /dev/null and b/examples/assets/cn-04.jpg differ
diff --git a/examples/assets/en-01.jpg b/examples/assets/en-01.jpg
new file mode 100644
index 0000000..2690324
Binary files /dev/null and b/examples/assets/en-01.jpg differ
diff --git a/examples/browser/.gitignore b/examples/browser/.gitignore
new file mode 100644
index 0000000..9b1ee42
--- /dev/null
+++ b/examples/browser/.gitignore
@@ -0,0 +1,175 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
diff --git a/examples/browser/README.md b/examples/browser/README.md
new file mode 100644
index 0000000..b75f4e4
--- /dev/null
+++ b/examples/browser/README.md
@@ -0,0 +1,10 @@
+# Example Browser
+
+## Getting Started
+
+```
+cd ../.. && bun install
+cd examples/web
+bun install
+./ake start
+```
diff --git a/examples/browser/ake b/examples/browser/ake
new file mode 100755
index 0000000..4f00b56
--- /dev/null
+++ b/examples/browser/ake
@@ -0,0 +1,18 @@
+#!/usr/bin/env nu
+
+$env.DEFAULT_IMAGE_PATH = '/assets/cn-01.jpg'
+
+def main [] {}
+
+def 'main build:watch' [] {
+ chokidar '../../src/**/*.ts' 'web.ts' 'build.ts' -c 'bun run build.ts' --initial
+}
+
+def 'main start' [] {
+ bun run build.ts
+ main start:prod --header "Cache-Control:no-cache"
+}
+
+def --wrapped 'main start:prod' [...args] {
+ miniserve build -p 3000 --index index.html --verbose ...$args
+}
diff --git a/examples/browser/browser.ts b/examples/browser/browser.ts
new file mode 100644
index 0000000..2a11846
--- /dev/null
+++ b/examples/browser/browser.ts
@@ -0,0 +1,61 @@
+import Ocr from '@gutenye/ocr-browser'
+
+async function main() {
+ const ocr = await Ocr.create({
+ models: {
+ detectionPath: '/assets/ch_PP-OCRv3_det_infer.onnx',
+ recognitionPath: '/assets/ch_PP-OCRv3_rec_infer.onnx',
+ dictionaryPath: '/assets/ppocr_keys_v1.txt',
+ },
+ })
+ document.querySelector('#title')!.textContent = 'OCR is ready'
+
+ createApp(async ({ imageUrl }) => {
+ const startTime = new Date().valueOf()
+ const result = await ocr.detect(imageUrl, { isDebug: true })
+ const duration = new Date().valueOf() - startTime
+
+ return {
+ text: result.map((v) => `${v.mean.toFixed(2)} ${v.text}`).join('\n'),
+ duration,
+ }
+ })
+}
+
+function createApp(
+ runOcr: (params: {
+ imageUrl: string
+ }) => Promise<{ text: string; duration: number }>,
+) {
+ const resultTextEl = document.querySelector('#result-text') as HTMLDivElement
+ const performanceEl = document.querySelector('#performance') as HTMLDivElement
+ const resultImageEl = document.querySelector(
+ '#result-image',
+ ) as HTMLImageElement
+ const inputImageEl = document.querySelector(
+ '#input-image',
+ ) as HTMLImageElement
+ inputImageEl.addEventListener('change', async (event) => {
+ const file = (event.target as HTMLInputElement).files?.[0]
+ if (!file) {
+ return
+ }
+ const imageUrl = URL.createObjectURL(file)
+ await handleChange(imageUrl)
+ })
+ const handleChange = async (imageUrl: string) => {
+ document.querySelectorAll('canvas').forEach((el) => el.remove())
+ resultTextEl.textContent = 'Working in progress...'
+ resultImageEl.setAttribute('src', imageUrl)
+ const { text, duration } = await runOcr({ imageUrl })
+ resultTextEl.textContent = text
+ performanceEl.textContent = `Performance: ${duration}ms (Close Chrome DevTools for better perlrmance)`
+ }
+
+ console.log(1, process.env.DEFAULT_IMAGE_PATH)
+ if (process.env.DEFAULT_IMAGE_PATH) {
+ handleChange(process.env.DEFAULT_IMAGE_PATH)
+ }
+}
+
+main()
diff --git a/examples/browser/build.ts b/examples/browser/build.ts
new file mode 100644
index 0000000..157515f
--- /dev/null
+++ b/examples/browser/build.ts
@@ -0,0 +1,24 @@
+import fs from 'node:fs/promises'
+import { $ } from 'bun'
+
+const result = await Bun.build({
+ entrypoints: ['./browser.ts'],
+ outdir: './build',
+ target: 'browser',
+ sourcemap: 'external',
+ define: {
+ 'process.env.DEFAULT_IMAGE_PATH': process.env.DEFAULT_IMAGE_PATH || '',
+ },
+})
+
+if (result.success) {
+ console.log('Build success')
+} else {
+ throw new AggregateError(result.logs, 'Build failed')
+}
+
+await fs.appendFile('./build/browser.js', '//# sourceMappingURL=browser.js.map')
+
+await $`cd build; ln -sf ../../assets .`
+await $`cd build; ln -sf ../{index.html,index.css} .`
+await $`cd build; ln -sf ../node_modules/onnxruntime-web/dist/*.wasm .`
diff --git a/examples/browser/bun.lockb b/examples/browser/bun.lockb
new file mode 100755
index 0000000..5e9ba65
Binary files /dev/null and b/examples/browser/bun.lockb differ
diff --git a/examples/browser/index.css b/examples/browser/index.css
new file mode 100644
index 0000000..443d10a
--- /dev/null
+++ b/examples/browser/index.css
@@ -0,0 +1,3 @@
+.result {
+ display: flex;
+}
diff --git a/examples/browser/index.html b/examples/browser/index.html
new file mode 100644
index 0000000..c14a5a3
--- /dev/null
+++ b/examples/browser/index.html
@@ -0,0 +1,23 @@
+
+
+
+
+
+ OCR Example
+
+
+
+ OCR is Loading
+
+
+
![]()
+
+