Update to Tesseract.js Version 4 (#691)

See #662 for explanation of Tesseract.js Version 4 changes. List below is auto-generated from commits. * Added image preprocessing functions (rotate + save images) * Updated createWorker to be async * Reworked createWorker to be async and throw errors per #654 * Reworked createWorker to be async and throw errors per #654 * Edited detect to return null when detection fails rather than throwing error per #526 * Updated types per #606 and #580 (#663) (#664) * Removed unused files * Added savePDF option to recognize per #488; cleaned up code for linter * Updated download-pdf example for node to use new savePDF option * Added OutputFormats option/interface for setting output * Allowed for Tesseract parameters to be set through recognition options per #665 * Updated docs * Edited loadLanguage to no longer overwrite cache with data from cache per #666 * Added interface for setting 'init only' options per #613 * Wrapped caching in try block per #609 * Fixed unit tests * Updated setImage to resolve memory leak per #678 * Added debug output option per #681 * Fixed bug with saving images per #588 * Updated examples * Updated readme and Tesseract.js-core version
naptha · Nov 25, 2022 · 5ccb3d9 · 5ccb3d9
1 parent 80aef15
commit 5ccb3d9
Show file tree

Hide file tree

Showing 33 changed files with 2,068 additions and 2,076 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -12,6 +12,9 @@
     "no-console": 0,
     "global-require": 0,
     "camelcase": 0,
-    "no-control-regex": 0
+    "no-control-regex": 0,
+    // Airbnb disallows ForOfStatement based on the bizarre belief that loops are not readable
+    // https://github.com/airbnb/javascript/issues/1271
+    "no-restricted-syntax": ["error", "ForInStatement", "LabeledStatement", "WithStatement"]
   }
 }
diff --git a/README.md b/README.md
@@ -46,12 +46,11 @@ Or more imperative
 ```javascript
 import { createWorker } from 'tesseract.js';
 
-const worker = createWorker({
+const worker = await createWorker({
   logger: m => console.log(m)
 });
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
@@ -62,6 +61,16 @@ const worker = createWorker({
 
 [Check out the docs](#documentation) for a full explanation of the API.
 
+## Major changes in v4
+Version 4 includes many new features and bug fixes--see [this issue](https://github.com/naptha/tesseract.js/issues/662) for a full list.  Several highlights are below. 
+
+- Added rotation preprocessing options (including auto-rotate) for significantly better accuracy
+- Processed images (rotated, grayscale, binary) can now be retrieved
+- Improved support for parallel processing (schedulers)
+- Breaking changes:
+  - `createWorker` is now async
+  - `getPDF` function replaced by `pdf` recognize option
+
 ## Major changes in v3
 - Significantly faster performance
    - Runtime reduction of 84% for Browser and 96% for Node.js when recognizing the [example images](./examples/data)

diff --git a/docs/api.md b/docs/api.md
@@ -1,7 +1,6 @@
 # API
 
 - [createWorker()](#create-worker)
-  - [Worker.load](#worker-load)
   - [Worker.writeText](#worker-writeText)
   - [Worker.readText](#worker-readText)
   - [Worker.removeFile](#worker-removeFile)
@@ -53,7 +52,7 @@ createWorker is a factory function that creates a tesseract worker, a worker is
 
 ```javascript
 const { createWorker } = Tesseract;
-const worker = createWorker({
+const worker = await createWorker({
   langPath: '...',
   logger: m => console.log(m),
 });
@@ -63,7 +62,6 @@ const worker = createWorker({
 
 A Worker helps you to do the OCR related tasks, it takes few steps to setup Worker before it is fully functional. The full flow is:
 
-- load
 - FS functions // optional
 - loadLanguauge
 - initialize
@@ -82,23 +80,6 @@ Each function is async, so using async/await or Promise is required. When it is
 
 jobId is generated by Tesseract.js, but you can put your own when calling any of the function above.
 
-<a name="worker-load"></a>
-### Worker.load(jobId): Promise
-
-Worker.load() loads tesseract.js-core scripts (download from remote if not presented), it makes Web Worker/Child Process ready for next action.
-
-**Arguments:**
-
-- `jobId` Please see details above
-
-**Examples:**
-
-```javascript
-(async () => {
-  await worker.load();
-})();
-```
-
 <a name="worker-writeText"></a>
 ### Worker.writeText(path, text, jobId): Promise
 
@@ -225,7 +206,7 @@ Worker.setParameters() set parameters for Tesseract API (using SetVariable()), i
 - `params` an object with key and value of the parameters
 - `jobId` Please see details above
 
-**Supported Paramters:**
+**Useful Paramters:**
 
 | name                        | type   | default value     | description                                                                                                                     |
 | --------------------------- | ------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
@@ -234,11 +215,8 @@ Worker.setParameters() set parameters for Tesseract API (using SetVariable()), i
 | tessedit\_char\_whitelist   | string | ''                | setting white list characters makes the result only contains these characters, useful the content in image is limited           |
 | preserve\_interword\_spaces | string | '0'               | '0' or '1', keeps the space between words                                                                                       |
 | user\_defined\_dpi          | string | ''                | Define custom dpi, use to fix **Warning: Invalid resolution 0 dpi. Using 70 instead.**                                          |
-| tessjs\_create\_hocr        | string | '1'               | only 2 values, '0' or '1', when the value is '1', tesseract.js includes hocr in the result                                      |
-| tessjs\_create\_tsv         | string | '1'               | only 2 values, '0' or '1', when the value is '1', tesseract.js includes tsv in the result                                       |
-| tessjs\_create\_box         | string | '0'               | only 2 values, '0' or '1', when the value is '1', tesseract.js includes box in the result                                       |
-| tessjs\_create\_unlv        | string | '0'               | only 2 values, '0' or '1', when the value is '1', tesseract.js includes unlv in the result                                      |
-| tessjs\_create\_osd         | string | '0'               | only 2 values, '0' or '1', when the value is '1', tesseract.js includes osd in the result                                       |
+
+This list is incomplete.  As Tesseract.js passes parameters to the Tesseract engine, all parameters supported by the underlying version of Tesseract should also be supported by Tesseract.js.  (Note that parameters marked as “init only” in Tesseract documentation cannot be set by `setParameters` or `recognize`.) 
 
 **Examples:**
 
@@ -262,8 +240,9 @@ Figures out what words are in `image`, where the words are in `image`, etc.
 **Arguments:**
 
 - `image` see [Image Format](./image-format.md) for more details.
-- `options` a object of customized options
+- `options` an object of customized options
   - `rectangle` an object to specify the regions you want to recognized in the image, should contain top, left, width and height, see example below.
+- `output` an object specifying which output formats to return (by default `text`, `blocks`, `hocr`, and `tsv` are returned)
 - `jobId` Please see details above
 
 **Output:**
@@ -273,8 +252,7 @@ Figures out what words are in `image`, where the words are in `image`, etc.
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = createWorker();
-  await worker.load();
+  const worker = await createWorker();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize(image);
@@ -287,8 +265,7 @@ With rectangle
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = createWorker();
-  await worker.load();
+  const worker = await createWorker();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize(image, {
@@ -313,8 +290,7 @@ Worker.detect() does OSD (Orientation and Script Detection) to the image instead
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = createWorker();
-  await worker.load();
+  const worker = await createWorker();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data } = await worker.detect(image);
@@ -361,7 +337,7 @@ Scheduler.addWorker() adds a worker into the worker pool inside scheduler, it is
 ```javascript
 const { createWorker, createScheduler } = Tesseract;
 const scheduler = createScheduler();
-const worker = createWorker();
+const worker = await createWorker();
 scheduler.addWorker(worker);
 ```
 

diff --git a/docs/examples.md b/docs/examples.md
@@ -7,10 +7,9 @@ You can also check [examples](../examples) folder.
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
@@ -24,12 +23,11 @@ const worker = createWorker();
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker({
+const worker = await createWorker({
   logger: m => console.log(m), // Add logger here
 });
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
@@ -43,26 +41,24 @@ const worker = createWorker({
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng+chi_tra');
   await worker.initialize('eng+chi_tra');
   const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
   console.log(text);
   await worker.terminate();
 })();
 ```
-### with whitelist char (^2.0.0-beta.1)
+### with whitelist char
 
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   await worker.setParameters({
@@ -74,17 +70,16 @@ const worker = createWorker();
 })();
 ```
 
-### with different pageseg mode (^2.0.0-beta.1)
+### with different pageseg mode
 
 Check here for more details of pageseg mode: https://github.com/tesseract-ocr/tesseract/blob/4.0.0/src/ccstruct/publictypes.h#L163
 
 ```javascript
 const { createWorker, PSM } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   await worker.setParameters({
@@ -96,7 +91,7 @@ const worker = createWorker();
 })();
 ```
 
-### with pdf output (^2.0.0-beta.1)
+### with pdf output
 
 Please check **examples** folder for details.
 
@@ -110,11 +105,10 @@ Node: [download-pdf.js](../examples/node/download-pdf.js)
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 const rectangle = { left: 0, top: 0, width: 500, height: 250 };
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png', { rectangle });
@@ -128,7 +122,7 @@ const rectangle = { left: 0, top: 0, width: 500, height: 250 };
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = createWorker();
+const worker = await createWorker();
 const rectangles = [
   {
     left: 0,
@@ -145,7 +139,6 @@ const rectangles = [
 ];
 
 (async () => {
-  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const values = [];
@@ -164,8 +157,8 @@ const rectangles = [
 const { createWorker, createScheduler } = require('tesseract.js');
 
 const scheduler = createScheduler();
-const worker1 = createWorker();
-const worker2 = createWorker();
+const worker1 = await createWorker();
+const worker2 = await createWorker();
 const rectangles = [
   {
     left: 0,
@@ -182,8 +175,6 @@ const rectangles = [
 ];
 
 (async () => {
-  await worker1.load();
-  await worker2.load();
   await worker1.loadLanguage('eng');
   await worker2.loadLanguage('eng');
   await worker1.initialize('eng');
@@ -198,18 +189,16 @@ const rectangles = [
 })();
 ```
 
-### with multiple workers to speed up (^2.0.0-beta.1)
+### with multiple workers to speed up
 
 ```javascript
 const { createWorker, createScheduler } = require('tesseract.js');
 
 const scheduler = createScheduler();
-const worker1 = createWorker();
-const worker2 = createWorker();
+const worker1 = await createWorker();
+const worker2 = await createWorker();
 
 (async () => {
-  await worker1.load();
-  await worker2.load();
   await worker1.loadLanguage('eng');
   await worker2.loadLanguage('eng');
   await worker1.initialize('eng');

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,6 +1,13 @@
 FAQ
 ===
 
+# Project
+## What is the scope of this project? 
+Tesseract.js is the JavaScript/Webassembly port of the Tesseract OCR engine.  We do not edit the underlying Tesseract recognition engine in any way.  Therefore, if you encounter bugs caused by the Tesseract engine you may open an issue here for the purposes of raising awareness to other users, but fixing is outside the scope of this repository. 
+
+If you encounter a Tesseract bug you would like to see fixed you should confirm the behavior is the same in the [main (CLI) version](https://github.com/tesseract-ocr/tesseract) of Tesseract and then open a Git Issue in that repository.    
+
+# Trained Data
 ## How does tesseract.js download and keep \*.traineddata?
 
 The language model is downloaded by `worker.loadLanguage()` and you need to pass the langs to `worker.initialize()`.
@@ -9,34 +16,5 @@ During the downloading of language model, Tesseract.js will first check if \*.tr
 
 ## How can I train my own \*.traineddata?
 
-For tesseract.js v2, check [TrainingTesseract 4.00](https://tesseract-ocr.github.io/tessdoc/TrainingTesseract-4.00)
-
-For tesseract.js v1, check [Training Tesseract 3.03–3.05](https://tesseract-ocr.github.io/tessdoc/Training-Tesseract-3.03%E2%80%933.05)
-
-## How can I get HOCR, TSV, Box, UNLV, OSD?
-
-Starting from 2.0.0-beta.1, you can get all these information in the final result.
-
-```javascript
-import { createWorker } from 'tesseract.js';
-const worker = createWorker({
-  logger: m => console.log(m)
-});
-
-(async () => {
-  await worker.load();
-  await worker.loadLanguage('eng');
-  await worker.initialize('eng');
-  await worker.setParameters({
-    tessedit_create_box: '1',
-    tessedit_create_unlv: '1',
-    tessedit_create_osd: '1',
-  });
-  const { data: { text, hocr, tsv, box, unlv } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
-  console.log(text);
-  console.log(hocr);
-  console.log(tsv);
-  console.log(box);
-  console.log(unlv);
-})();
-```
+See the documentation from the main [Tesseract project](https://tesseract-ocr.github.io/tessdoc/) for training instructions. 
+
diff --git a/docs/local-installation.md b/docs/local-installation.md
@@ -19,7 +19,7 @@ Tesseract.recognize(image, langs, {
 Or
 
 ```javascript
-const worker = createWorker({
+const worker = await createWorker({
   workerPath: 'https://unpkg.com/[email protected]/dist/worker.min.js',
   langPath: 'https://tessdata.projectnaptha.com/4.0.0',
   corePath: 'https://unpkg.com/[email protected]/tesseract-core.wasm.js',
@@ -33,6 +33,6 @@ A string specifying the location of the [worker.js](./dist/worker.min.js) file.
 A string specifying the location of the tesseract language files, with default value 'https://tessdata.projectnaptha.com/4.0.0'. Language file URLs are calculated according to the formula `langPath + langCode + '.traineddata.gz'`.
 
 ### corePath
-A string specifying the location of the [tesseract.js-core library](https://github.com/naptha/tesseract.js-core), with default value 'https://unpkg.com/[email protected]/tesseract-core.wasm.js' (fallback to tesseract-core.asm.js when WebAssembly is not available).
+A string specifying the location of the [tesseract.js-core library](https://github.com/naptha/tesseract.js-core), with default value 'https://unpkg.com/[email protected]/tesseract-core.wasm.js'.
 
 Another WASM option is 'https://unpkg.com/[email protected]/tesseract-core.js' which is a script that loads 'https://unpkg.com/[email protected]/tesseract-core.wasm'. But it fails to fetch at this moment.