Fix langs TS typing (#570)

README.md

@@ -46,11 +46,12 @@ Or more imperative
 ```javascript
 import { createWorker } from 'tesseract.js';
 
-const worker = await createWorker({
+const worker = 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');

docs/api.md

@@ -1,6 +1,7 @@
 # API
 
 - [createWorker()](#create-worker)
+  - [Worker.load](#worker-load)
   - [Worker.writeText](#worker-writeText)
   - [Worker.readText](#worker-readText)
   - [Worker.removeFile](#worker-removeFile)
@@ -52,7 +53,7 @@ createWorker is a factory function that creates a tesseract worker, a worker is
 
 ```javascript
 const { createWorker } = Tesseract;
-const worker = await createWorker({
+const worker = createWorker({
   langPath: '...',
   logger: m => console.log(m),
 });
@@ -62,6 +63,7 @@ const worker = await 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
@@ -80,6 +82,23 @@ 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
 
@@ -206,7 +225,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
 
-**Useful Paramters:**
+**Supported Paramters:**
 
 | name                        | type   | default value     | description                                                                                                                     |
 | --------------------------- | ------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
@@ -215,8 +234,11 @@ 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.**                                          |
-
-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`.) 
+| 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                                       |
 
 **Examples:**
 
@@ -240,9 +262,8 @@ 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` an object of customized options
+- `options` a 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:**
@@ -252,7 +273,8 @@ Figures out what words are in `image`, where the words are in `image`, etc.
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = await createWorker();
+  const worker = createWorker();
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize(image);
@@ -265,7 +287,8 @@ With rectangle
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = await createWorker();
+  const worker = createWorker();
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize(image, {
@@ -290,7 +313,8 @@ Worker.detect() does OSD (Orientation and Script Detection) to the image instead
 ```javascript
 const { createWorker } = Tesseract;
 (async () => {
-  const worker = await createWorker();
+  const worker = createWorker();
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data } = await worker.detect(image);
@@ -337,7 +361,7 @@ Scheduler.addWorker() adds a worker into the worker pool inside scheduler, it is
 ```javascript
 const { createWorker, createScheduler } = Tesseract;
 const scheduler = createScheduler();
-const worker = await createWorker();
+const worker = createWorker();
 scheduler.addWorker(worker);
 ```
 

docs/examples.md

@@ -7,9 +7,10 @@ You can also check [examples](../examples) folder.
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker();
+const worker = 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');
@@ -23,11 +24,12 @@ const worker = await createWorker();
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker({
+const worker = 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');
@@ -41,9 +43,10 @@ const worker = await createWorker({
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker();
+const worker = 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');
@@ -51,14 +54,15 @@ const worker = await createWorker();
   await worker.terminate();
 })();
 ```
-### with whitelist char
+### with whitelist char (^2.0.0-beta.1)
 
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker();
+const worker = createWorker();
 
 (async () => {
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   await worker.setParameters({
@@ -70,16 +74,17 @@ const worker = await createWorker();
 })();
 ```
 
-### with different pageseg mode
+### with different pageseg mode (^2.0.0-beta.1)
 
 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 = await createWorker();
+const worker = createWorker();
 
 (async () => {
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   await worker.setParameters({
@@ -91,7 +96,7 @@ const worker = await createWorker();
 })();
 ```
 
-### with pdf output
+### with pdf output (^2.0.0-beta.1)
 
 Please check **examples** folder for details.
 
@@ -105,10 +110,11 @@ Node: [download-pdf.js](../examples/node/download-pdf.js)
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker();
+const worker = 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 });
@@ -122,7 +128,7 @@ const rectangle = { left: 0, top: 0, width: 500, height: 250 };
 ```javascript
 const { createWorker } = require('tesseract.js');
 
-const worker = await createWorker();
+const worker = createWorker();
 const rectangles = [
   {
     left: 0,
@@ -139,6 +145,7 @@ const rectangles = [
 ];
 
 (async () => {
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const values = [];
@@ -157,8 +164,8 @@ const rectangles = [
 const { createWorker, createScheduler } = require('tesseract.js');
 
 const scheduler = createScheduler();
-const worker1 = await createWorker();
-const worker2 = await createWorker();
+const worker1 = createWorker();
+const worker2 = createWorker();
 const rectangles = [
   {
     left: 0,
@@ -175,6 +182,8 @@ const rectangles = [
 ];
 
 (async () => {
+  await worker1.load();
+  await worker2.load();
   await worker1.loadLanguage('eng');
   await worker2.loadLanguage('eng');
   await worker1.initialize('eng');
@@ -189,16 +198,18 @@ const rectangles = [
 })();
 ```
 
-### with multiple workers to speed up
+### with multiple workers to speed up (^2.0.0-beta.1)
 
 ```javascript
 const { createWorker, createScheduler } = require('tesseract.js');
 
 const scheduler = createScheduler();
-const worker1 = await createWorker();
-const worker2 = await createWorker();
+const worker1 = createWorker();
+const worker2 = createWorker();
 
 (async () => {
+  await worker1.load();
+  await worker2.load();
   await worker1.loadLanguage('eng');
   await worker2.loadLanguage('eng');
   await worker1.initialize('eng');

docs/faq.md

@@ -1,13 +1,6 @@
 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()`.
@@ -16,5 +9,34 @@ During the downloading of language model, Tesseract.js will first check if \*.tr
 
 ## How can I train my own \*.traineddata?
 
-See the documentation from the main [Tesseract project](https://tesseract-ocr.github.io/tessdoc/) for training instructions. 
-
+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);
+})();
+```

docs/image-format.md

@@ -1,17 +1,18 @@
 # Image Format
 
-Support Format: **bmp, jpg, png, pbm**
+The main Tesseract.js functions (ex. recognize, detect) take an `image` parameter.  The image formats and data types supported are listed below. 
 
-The main Tesseract.js functions (ex. recognize, detect) take an `image` parameter, which should be something that is like an image. What's considered "image-like" differs depending on whether it is being run from the browser or through NodeJS.
+Support Image Formats: **bmp, jpg, png, pbm, webp**
 
-On a browser, an image can be:
-- an `img` or `canvas` element
-- a `File` object (from a file `<input>`)
-- a `Blob` object
-- a path or URL to an accessible image
-- a base64 encoded image fits `data:image\/([a-zA-Z]*);base64,([^"]*)` regexp
+For browser and Node, supported data types are:
+ - string with base64 encoded image (fits `data:image\/([a-zA-Z]*);base64,([^"]*)` regexp)
+ - buffer
 
-In Node.js, an image can be
-- a path to a local image
-- a Buffer storing binary image 
-- a base64 encoded image fits `data:image\/([a-zA-Z]*);base64,([^"]*)` regexp
+For browser only, supported data types are:
+ - `File` or `Blob` object
+ - `img` or `canvas` element
+
+For Node only, supported data types are:
+ - string containing a path to local image
+
+Note: images must be a supported image format **and** a supported data type.  For example, a buffer containing a png image is supported.  A buffer containing raw pixel data is not supported. 

docs/local-installation.md

@@ -19,7 +19,7 @@ Tesseract.recognize(image, langs, {
 Or
 
 ```javascript
-const worker = await createWorker({
+const worker = createWorker({
   workerPath: 'https://unpkg.com/tesseract.js@v2.0.0/dist/worker.min.js',
   langPath: 'https://tessdata.projectnaptha.com/4.0.0',
   corePath: 'https://unpkg.com/tesseract.js-core@v2.0.0/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/tesseract.js-core@v2.0.0/tesseract-core.wasm.js'.
+A string specifying the location of the [tesseract.js-core library](https://github.com/naptha/tesseract.js-core), with default value 'https://unpkg.com/tesseract.js-core@v2.0.0/tesseract-core.wasm.js' (fallback to tesseract-core.asm.js when WebAssembly is not available).
 
 Another WASM option is 'https://unpkg.com/tesseract.js-core@v2.0.0/tesseract-core.js' which is a script that loads 'https://unpkg.com/tesseract.js-core@v2.0.0/tesseract-core.wasm'. But it fails to fetch at this moment.

examples/browser/basic-edge.html

@@ -6,9 +6,9 @@
   <body>
     <input type="file" id="uploader">
     <script>
-      const recognize = async function(evt){
+      const recognize = function(evt){
         const files = evt.target.files;
-        const worker = await Tesseract.createWorker({
+        const worker = Tesseract.createWorker({
           /*
            * As Edge don't support webassembly,
            * here we force to use asm.js version.
@@ -21,12 +21,14 @@
            */
           cacheMethod: 'none',
         });
-
-        await worker.loadLanguage('eng');
-        await worker.initialize('eng');
-        const ret = await worker.recognize(files[0]);
-        console.log(ret.data.text);
-
+        Promise.resolve()
+          .then(() => worker.load())
+          .then(() => worker.loadLanguage('eng'))
+          .then(() => worker.initialize('eng'))
+          .then(() => worker.recognize(files[0]))
+          .then((ret) => {
+            console.log(ret.data.text);
+          });
       }
       const elm = document.getElementById('uploader');
       elm.addEventListener('change', recognize);

examples/browser/basic.html

@@ -8,7 +8,6 @@
       const recognize = async ({ target: { files }  }) => {
         const { data: { text } } = await Tesseract.recognize(files[0], 'eng', {
           corePath: '../../node_modules/tesseract.js-core/tesseract-core.wasm.js',
-          workerPath: "/dist/worker.dev.js",
           logger: m => console.log(m),
         });
         console.log(text);

examples/browser/benchmark.html

@@ -7,8 +7,9 @@
 
     <script>
       const { createWorker } = Tesseract;
-      const worker = await createWorker();
+      const worker = createWorker();
       (async () => {
+        await worker.load();
         await worker.loadLanguage('eng');
         await worker.initialize('eng');
         

examples/browser/download-pdf.html

@@ -8,29 +8,27 @@
       <button id="download-pdf" disabled="true">Download PDF</button>
     </div>
     <textarea id="board" readonly rows="8" cols="80">Upload an image file</textarea>
-    <script type="module">
+    <script>
       const { createWorker } = Tesseract;
-      const worker = await createWorker({
+      const worker = createWorker({
         corePath: '/node_modules/tesseract.js-core/tesseract-core.wasm.js',
-        workerPath: "/dist/worker.dev.js",
         logger: m => console.log(m),
       });
       const uploader = document.getElementById('uploader');
       const dlBtn = document.getElementById('download-pdf');
-      let pdf;
       const recognize = async ({ target: { files }  }) => {
+        await worker.load();
         await worker.loadLanguage('eng');
         await worker.initialize('eng');
-        const res = await worker.recognize(files[0],{pdfTitle: "Example PDF"},{pdf: true});
-        pdf = res.data.pdf;
-        const text = res.data.text;
+        const { data: { text } } = await worker.recognize(files[0]);
         const board = document.getElementById('board');
         board.value = text;
         dlBtn.disabled = false;
       };
       const downloadPDF = async () => {
         const filename = 'tesseract-ocr-result.pdf';
-        const blob = new Blob([new Uint8Array(pdf)], { type: 'application/pdf' });
+        const { data } = await worker.getPDF('Tesseract OCR Result');
+        const blob = new Blob([new Uint8Array(data)], { type: 'application/pdf' });
         if (navigator.msSaveBlob) {
           // IE 10+
           navigator.msSaveBlob(blob, filename);

examples/browser/image-processing.html

@@ -1,59 +0,0 @@
-<html>
-
-<head>
-  <script src="/dist/tesseract.dev.js"></script>
-  <style>
-    .column {
-  float: left;
-  width: 20%;
-  padding: 5px;
-}
-
-  </style>
-</head>
-
-<body>
-  <input type="file" id="uploader">
-
-  <div class="row">
-    <div class="column">
-      <p>Input Image</p>
-      <img id="imgInput" style="max-width:500px;">
-    </div>
-    <div class="column">
-      <p>Rotated, Original Color</p>
-      <img id="imgOriginal" style="max-width:500px;">
-    </div>
-    <div class="column">
-      <p>Rotated, Grey</p>
-      <img id="imgGrey" style="max-width:500px;">
-    </div>
-    <div class="column">
-      <p>Rotated, Binary</p>
-      <img id="imgBinary" style="max-width:500px;">
-    </div>
-  </div>
-
-  <script>
-    const recognize = async ({ target: { files } }) => {
-      document.getElementById("imgInput").src = URL.createObjectURL(files[0]);
-      const worker = await Tesseract.createWorker({
-        // corePath: '/tesseract-core-simd.wasm.js',
-        workerPath: "/dist/worker.dev.js"
-      });
-      await worker.loadLanguage('eng');
-      await worker.initialize('eng');
-
-      await worker.initialize();
-      const ret = await worker.recognize(files[0], {rotateAuto: true}, {imageColor: true, imageGrey: true, imageBinary: true});
-      document.getElementById("imgOriginal").src = ret.data.imageColor;
-      document.getElementById("imgGrey").src = ret.data.imageGrey;
-      document.getElementById("imgBinary").src = ret.data.imageBinary;
-
-    }
-    const elm = document.getElementById('uploader');
-    elm.addEventListener('change', recognize);
-  </script>
-</body>
-
-</html>

examples/node/benchmark.js

@@ -2,8 +2,10 @@
 const path = require('path');
 const { createWorker } = require('../../');
 
+const worker = createWorker();
+
 (async () => {
-  const worker = await createWorker();
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const fileArr = ["../data/meditations.jpg", "../data/tyger.jpg", "../data/testocr.png"];

examples/node/download-pdf.js

@@ -9,12 +9,14 @@ const image = path.resolve(__dirname, (imagePath || '../../tests/assets/images/c
 console.log(`Recognizing ${image}`);
 
 (async () => {
-  const worker = await createWorker();
+  const worker = createWorker();
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
-  const { data: { text, pdf } } = await worker.recognize(image, {pdfTitle: "Example PDF"}, {pdf: true});
+  const { data: { text } } = await worker.recognize(image);
   console.log(text);
-  fs.writeFileSync('tesseract-ocr-result.pdf', Buffer.from(pdf));
+  const { data } = await worker.getPDF('Tesseract OCR Result');
+  fs.writeFileSync('tesseract-ocr-result.pdf', Buffer.from(data));
   console.log('Generate PDF: tesseract-ocr-result.pdf');
   await worker.terminate();
 })();

examples/node/recognize.js

@@ -6,11 +6,12 @@ const [,, imagePath] = process.argv;
 const image = path.resolve(__dirname, (imagePath || '../../tests/assets/images/cosmic.png'));
 
 console.log(`Recognizing ${image}`);
+const worker = createWorker({
+  logger: m => console.log(m),
+});
 
 (async () => {
-  const worker = await createWorker({
-    logger: m => console.log(m),
-  });  
+  await worker.load();
   await worker.loadLanguage('eng');
   await worker.initialize('eng');
   const { data: { text } } = await worker.recognize(image);

examples/node/scheduler.js

@@ -1,26 +0,0 @@
-const { createWorker, createScheduler } = require('../../');
-
-const scheduler = createScheduler();
-
-// Creates worker and adds to scheduler
-const workerGen = async () => {
-  const worker = createWorker({cachePath: "."});
-  await worker.load();
-  await worker.loadLanguage('eng');
-  await worker.initialize('eng');
-  scheduler.addWorker(worker);
-}
-
-const workerN = 4;
-(async () => {
-  const resArr = Array(workerN);
-  for (let i=0; i<workerN; i++) {
-    resArr[i] = workerGen();
-  }
-  await Promise.all(resArr);
-  /** Add 4 recognition jobs */
-  const results = await Promise.all(Array(10).fill(0).map(() => (
-    scheduler.addJob('recognize', 'https://tesseract.projectnaptha.com/img/eng_bw.png').then((x) => console.log(x.data.text))
-  )))
-  await scheduler.terminate(); // It also terminates all workers.
-})();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tesseract.js",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Pure Javascript Multilingual OCR",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -47,8 +47,8 @@
     "eslint-plugin-import": "^2.22.1",
     "expect.js": "^0.3.1",
     "express": "^4.17.1",
-    "mocha": "^10.0.0",
-    "mocha-headless-chrome": "^4.0.0",
+    "mocha": "^8.1.3",
+    "mocha-headless-chrome": "^2.0.3",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "rimraf": "^2.7.1",
@@ -70,7 +70,7 @@
     "opencollective-postinstall": "^2.0.2",
     "regenerator-runtime": "^0.13.3",
     "resolve-url": "^0.2.1",
-    "tesseract.js-core": "^3.0.1",
+    "tesseract.js-core": "^3.0.2",
     "wasm-feature-detect": "^1.2.11",
     "zlibjs": "^0.3.1"
   },

src/Tesseract.js

@@ -1,7 +1,8 @@
 const createWorker = require('./createWorker');
 
 const recognize = async (image, langs, options) => {
-  const worker = await createWorker(options);
+  const worker = createWorker(options);
+  await worker.load();
   await worker.loadLanguage(langs);
   await worker.initialize(langs);
   return worker.recognize(image)
@@ -11,7 +12,8 @@ const recognize = async (image, langs, options) => {
 };
 
 const detect = async (image, options) => {
-  const worker = await createWorker(options);
+  const worker = createWorker(options);
+  await worker.load();
   await worker.loadLanguage('osd');
   await worker.initialize('osd');
   return worker.detect(image)

src/constants/PSM.js

@@ -15,4 +15,5 @@ module.exports = {
   SINGLE_CHAR: '10',
   SPARSE_TEXT: '11',
   SPARSE_TEXT_OSD: '12',
+  RAW_LINE: '13',
 };

src/constants/imageType.js

@@ -1,5 +0,0 @@
-module.exports = {
-  COLOR: 0,
-  GREY: 1,
-  BINARY: 2,
-};

src/createWorker.js

@@ -15,7 +15,7 @@ const {
 
 let workerCounter = 0;
 
-module.exports = async (_options = {}) => {
+module.exports = (_options = {}) => {
   const id = getId('Worker', workerCounter);
   const {
     logger,
@@ -27,17 +27,7 @@ module.exports = async (_options = {}) => {
   });
   const resolves = {};
   const rejects = {};
-
-  let workerResReject;
-  let workerResResolve;
-  const workerRes = new Promise((resolve, reject) => {
-    workerResResolve = resolve;
-    workerResReject = reject;
-  });
-  const workerError = (event) => { workerResReject(event.message); };
-
   let worker = spawnWorker(options);
-  worker.onerror = workerError;
 
   workerCounter += 1;
 
@@ -63,11 +53,7 @@ module.exports = async (_options = {}) => {
     })
   );
 
-  const load = () => (
-    console.warn('`load` is depreciated and should be removed from code (workers now come pre-loaded)')
-  );
-
-  const loadInternal = (jobId) => (
+  const load = (jobId) => (
     startJob(createJob({
       id: jobId, action: 'load', payload: { options },
     }))
@@ -113,11 +99,11 @@ module.exports = async (_options = {}) => {
     }))
   );
 
-  const initialize = (langs = 'eng', oem = defaultOEM, config, jobId) => (
+  const initialize = (langs = 'eng', oem = defaultOEM, jobId) => (
     startJob(createJob({
       id: jobId,
       action: 'initialize',
-      payload: { langs, oem, config },
+      payload: { langs, oem },
     }))
   );
 
@@ -129,22 +115,21 @@ module.exports = async (_options = {}) => {
     }))
   );
 
-  const recognize = async (image, opts = {}, output = {blocks: true, text: true, hocr: true, tsv: true}, jobId) => (
+  const recognize = async (image, opts = {}, jobId) => (
     startJob(createJob({
       id: jobId,
       action: 'recognize',
-      payload: { image: await loadImage(image), options: opts, output },
+      payload: { image: await loadImage(image), options: opts },
     }))
   );
 
-  const getPDF = (title = 'Tesseract OCR Result', textonly = false, jobId) => {
-    console.log('`getPDF` function is depreciated. `recognize` option `savePDF` should be used instead.');
-    return startJob(createJob({
+  const getPDF = (title = 'Tesseract OCR Result', textonly = false, jobId) => (
+    startJob(createJob({
       id: jobId,
       action: 'getPDF',
       payload: { title, textonly },
-    }));
-  };
+    }))
+  );
 
   const detect = async (image, jobId) => (
     startJob(createJob({
@@ -182,7 +167,6 @@ module.exports = async (_options = {}) => {
       resolves[action]({ jobId, data: d });
     } else if (status === 'reject') {
       rejects[action](data);
-      if (action === 'load') workerResReject(data);
       if (errorHandler) {
         errorHandler(data);
       } else {
@@ -193,7 +177,7 @@ module.exports = async (_options = {}) => {
     }
   });
 
-  const resolveObj = {
+  return {
     id,
     worker,
     setResolve,
@@ -211,8 +195,4 @@ module.exports = async (_options = {}) => {
     detect,
     terminate,
   };
-
-  loadInternal().then(() => workerResResolve(resolveObj)).catch(() => {});
-
-  return workerRes;
 };

src/index.d.ts

@@ -1,6 +1,6 @@
 declare namespace Tesseract {
   function createScheduler(): Scheduler
-  function createWorker(options?: Partial<WorkerOptions>): Promise<Worker>
+  function createWorker(options?: Partial<WorkerOptions>): Worker
   function setLogging(logging: boolean): void
   function recognize(image: ImageLike, langs?: string, options?: Partial<WorkerOptions>): Promise<RecognizeResult>
   function detect(image: ImageLike, options?: Partial<WorkerOptions>): any
@@ -19,24 +19,20 @@ declare namespace Tesseract {
     readText(path: string, jobId?: string): Promise<ConfigResult>
     removeText(path: string, jobId?: string): Promise<ConfigResult>
     FS(method: string, args: any[], jobId?: string): Promise<ConfigResult>
-    loadLanguage(langs?: string, jobId?: string): Promise<ConfigResult>
-    initialize(langs?: string, oem?: OEM, config?: string | Partial<InitOptions>, jobId?: string): Promise<ConfigResult>
+    loadLanguage(langs?: string | Lang[], jobId?: string): Promise<ConfigResult>
+    initialize(langs?: string | Lang[], oem?: OEM, jobId?: string): Promise<ConfigResult>
     setParameters(params: Partial<WorkerParams>, jobId?: string): Promise<ConfigResult>
-    getImage(type: imageType): string
-    recognize(image: ImageLike, options?: Partial<RecognizeOptions>, output?: Partial<OutputFormats>, jobId?: string): Promise<RecognizeResult>
+    recognize(image: ImageLike, options?: Partial<RecognizeOptions>, jobId?: string): Promise<RecognizeResult>
     detect(image: ImageLike, jobId?: string): Promise<DetectResult>
     terminate(jobId?: string): Promise<ConfigResult>
     getPDF(title?: string, textonly?: boolean, jobId?: string):Promise<GetPDFResult>
   }
 
-  interface InitOptions {
-    load_system_dawg: string
-    load_freq_dawg: string
-    load_unambig_dawg: string
-    load_punc_dawg: string
-    load_number_dawg: string
-    load_bigram_dawg: string
+  interface Lang {
+    code: string;
+    data: unknown;
   }
+
   interface WorkerOptions {
     corePath: string
     langPath: string
@@ -61,26 +57,8 @@ declare namespace Tesseract {
     tessjs_create_unlv: string
     tessjs_create_osd: string
   }
-  interface OutputFormats {
-    text: boolean;
-    blocks: boolean;
-    hocr: boolean;
-    tsv: boolean;
-    box: boolean;
-    unlv: boolean;
-    osd: boolean;
-    pdf: boolean;
-    imageColor: boolean;
-    imageGrey: boolean;
-    imageBinary: boolean;
-    debug: boolean;
-  }
   interface RecognizeOptions {
     rectangle: Rectangle
-    pdfTitle: string
-    pdfTextOnly: boolean
-    rotateAuto: boolean
-    rotateRadians: number
   }
   interface ConfigResult {
     jobId: string
@@ -99,11 +77,11 @@ declare namespace Tesseract {
     data: DetectData
   }
   interface DetectData {
-    tesseract_script_id: number | null
-    script: string | null
-    script_confidence: number | null
-    orientation_degrees: number | null
-    orientation_confidence: number | null
+    tesseract_script_id: number
+    script: string
+    script_confidence: number
+    orientation_degrees: number
+    orientation_confidence: number
   }
   interface Rectangle {
     left: number
@@ -111,13 +89,13 @@ declare namespace Tesseract {
     width: number
     height: number
   }
-  const enum OEM {
+  enum OEM {
     TESSERACT_ONLY,
     LSTM_ONLY,
     TESSERACT_LSTM_COMBINED,
     DEFAULT,
   }
-  const enum PSM {
+  enum PSM {
     OSD_ONLY = '0',
     AUTO_OSD = '1',
     AUTO_ONLY = '2',
@@ -133,11 +111,6 @@ declare namespace Tesseract {
     SPARSE_TEXT_OSD = '12',
     RAW_LINE = '13'
   }
-  const enum imageType {
-    COLOR = 0,
-    GREY = 1,
-    BINARY = 2
-  }
   type ImageLike = string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement
     | CanvasRenderingContext2D | File | Blob | ImageData | Buffer;
   interface Block {
@@ -235,7 +208,7 @@ declare namespace Tesseract {
     page: Page;
   }
   interface Page {
-    blocks: Block[] | null;
+    blocks: Block[];
     confidence: number;
     lines: Line[];
     oem: string;
@@ -251,11 +224,6 @@ declare namespace Tesseract {
     box: string | null;
     unlv: string | null;
     sd: string | null;
-    imageColor: string | null;
-    imageGrey: string | null;
-    imageBinary: string | null;
-    rotateRadians: number | null;
-    pdf: number[] | null;
   }
 }
 

src/utils/circularize.js

@@ -22,33 +22,31 @@ module.exports = (page) => {
   const words = [];
   const symbols = [];
 
-  if (page.blocks) {
-    page.blocks.forEach((block) => {
-      block.paragraphs.forEach((paragraph) => {
-        paragraph.lines.forEach((line) => {
-          line.words.forEach((word) => {
-            word.symbols.forEach((sym) => {
-              symbols.push({
-                ...sym, page, block, paragraph, line, word,
-              });
-            });
-            words.push({
-              ...word, page, block, paragraph, line,
+  page.blocks.forEach((block) => {
+    block.paragraphs.forEach((paragraph) => {
+      paragraph.lines.forEach((line) => {
+        line.words.forEach((word) => {
+          word.symbols.forEach((sym) => {
+            symbols.push({
+              ...sym, page, block, paragraph, line, word,
             });
           });
-          lines.push({
-            ...line, page, block, paragraph,
+          words.push({
+            ...word, page, block, paragraph, line,
           });
         });
-        paragraphs.push({
-          ...paragraph, page, block,
+        lines.push({
+          ...line, page, block, paragraph,
         });
       });
-      blocks.push({
-        ...block, page,
+      paragraphs.push({
+        ...paragraph, page, block,
       });
     });
-  }
+    blocks.push({
+      ...block, page,
+    });
+  });
 
   return {
     ...page, blocks, paragraphs, lines, words, symbols,

src/worker-script/constants/defaultOutput.js

@@ -1,17 +0,0 @@
-/*
- * default output formats for tesseract.js
- */
-
-module.exports = {
-  text: true,
-  blocks: true,
-  hocr: true,
-  tsv: true,
-  box: false,
-  unlv: false,
-  osd: false,
-  pdf: false,
-  imageColor: false,
-  imageGrey: false,
-  imageBinary: false
-};

src/worker-script/index.js

@@ -14,10 +14,7 @@ const dump = require('./utils/dump');
 const isWebWorker = require('../utils/getEnvironment')('type') === 'webworker';
 const setImage = require('./utils/setImage');
 const defaultParams = require('./constants/defaultParams');
-const defaultOutput = require('./constants/defaultOutput');
 const { log, setLogging } = require('../utils/log');
-const imageType = require('../constants/imageType');
-const PSM = require('../constants/PSM');
 
 /*
  * Tesseract Module returned by TesseractCore.
@@ -57,7 +54,7 @@ const load = async ({ workerId, jobId, payload: { options: { corePath, logging }
   }
 };
 
-const FS = async ({ workerId, payload: { method, args } }, res) => {
+const FS = ({ workerId, payload: { method, args } }, res) => {
   log(`[${workerId}]: FS.${method} with args ${args}`);
   res.resolve(TessModule.FS[method](...args));
 };
@@ -82,7 +79,6 @@ res) => {
       ? () => Promise.resolve()
       : adapter.readCache;
     let data = null;
-    let newData = false;
 
     try {
       const _data = await readCache(`${cachePath || '.'}/${lang}.traineddata`);
@@ -94,7 +90,6 @@ res) => {
         throw Error('Not found in cache');
       }
     } catch (e) {
-      newData = true;
       log(`[${workerId}]: Load ${lang}.traineddata from ${langPath}`);
       if (typeof _lang === 'string') {
         let path = null;
@@ -136,13 +131,8 @@ res) => {
       TessModule.FS.writeFile(`${dataPath || '.'}/${lang}.traineddata`, data);
     }
 
-    if (newData && ['write', 'refresh', undefined].includes(cacheMethod)) {
-      try {
-        await adapter.writeCache(`${cachePath || '.'}/${lang}.traineddata`, data);
-      } catch (err) {
-        log(`[${workerId}]: Failed to write ${lang}.traineddata to cache due to error:`);
-        log(err.toString());
-      }
+    if (['write', 'refresh', undefined].includes(cacheMethod)) {
+      await adapter.writeCache(`${cachePath || '.'}/${lang}.traineddata`, data);
     }
 
     return Promise.resolve(data);
@@ -154,19 +144,11 @@ res) => {
     res.progress({ workerId, status: 'loaded language traineddata', progress: 1 });
     res.resolve(langs);
   } catch (err) {
-    if (isWebWorker && err instanceof DOMException) {
-      /*
-       * For some reason google chrome throw DOMException in loadLang,
-       * while other browser is OK, for now we ignore this exception
-       * and hopefully to find the root cause one day.
-       */
-    } else {
-      res.reject(err.toString());
-    }
+    res.reject(err.toString());
   }
 };
 
-const setParameters = async ({ payload: { params: _params } }, res) => {
+const setParameters = ({ payload: { params: _params } }, res) => {
   Object.keys(_params)
     .filter((k) => !k.startsWith('tessjs_'))
     .forEach((key) => {
@@ -179,9 +161,9 @@ const setParameters = async ({ payload: { params: _params } }, res) => {
   }
 };
 
-const initialize = async ({
+const initialize = ({
   workerId,
-  payload: { langs: _langs, oem, config},
+  payload: { langs: _langs, oem },
 }, res) => {
   const langs = (typeof _langs === 'string')
     ? _langs
@@ -194,24 +176,13 @@ const initialize = async ({
     if (api !== null) {
       api.End();
     }
-    let configFile = undefined;
-    let configStr = undefined;
-    // config argument may either be config file text, or object with key/value pairs
-    // In the latter case we convert to config file text here
-    if (typeof config === "object") {
-      configStr = JSON.stringify(config).replace(/,/g, "\n").replace(/:/g, " ").replace(/["'{}]/g, "");
-    } else {
-      configStr = config;
-    }
-    if (typeof configStr === "string") {
-      configFile = "/config";
-      TessModule.FS.writeFile(configFile, configStr);
-    }
-
     api = new TessModule.TessBaseAPI();
-    api.Init(null, langs, oem, configFile);
+    const status = api.Init(null, langs, oem);
+    if (status === -1) {
+      res.reject('initialization failed');
+    }
     params = defaultParams;
-    await setParameters({ payload: { params } });
+    setParameters({ payload: { params } });
     res.progress({
       workerId, status: 'initialized api', progress: 1,
     });
@@ -221,167 +192,46 @@ const initialize = async ({
   }
 };
 
-const getPDFInternal = (title, textonly) => {
-  const pdfRenderer = new TessModule.TessPDFRenderer('tesseract-ocr', '/', textonly);
-  pdfRenderer.BeginDocument(title);
-  pdfRenderer.AddImage(api);
-  pdfRenderer.EndDocument();
-  TessModule._free(pdfRenderer);
-
-  return TessModule.FS.readFile('/tesseract-ocr.pdf');
-};
-
-const getPDF = async ({ payload: { title, textonly } }, res) => {
-  res.resolve(getPDFInternal(title, textonly));
-};
-
-// Combines default output with user-specified options and
-// counts (1) total output formats requested and (2) outputs that require OCR
-const processOutput = (output) => {
-  const workingOutput = JSON.parse(JSON.stringify(defaultOutput));
-  // Output formats were set using `setParameters` in previous versions
-  // These settings are copied over for compatability
-  if (params.tessjs_create_box === "1") workingOutput.box = true;
-  if (params.tessjs_create_hocr === "1") workingOutput.hocr = true;
-  if (params.tessjs_create_osd === "1") workingOutput.osd = true;
-  if (params.tessjs_create_tsv === "1") workingOutput.tsv = true;
-  if (params.tessjs_create_unlv === "1") workingOutput.unlv = true;
-
-  const nonRecOutputs = ["imageColor", "imageGrey", "imageBinary"];
-  let recOutputCount = 0;
-  for (const prop in output) {
-    workingOutput[prop] = output[prop];
-  }
-  for (const prop in workingOutput) {
-    if (workingOutput[prop]) {
-      if (!nonRecOutputs.includes(prop)) {
-        recOutputCount++;
-      }
-    }
-  }
-  return {workingOutput, recOutputCount}
-}
-
-// List of options for Tesseract.js (rather than passed through to Tesseract),
-// not including those with prefix "tessjs_"
-const tessjsOptions = ["rectangle", "pdfTitle", "pdfTextOnly", "rotateAuto", "rotateRadians"];
-
-const recognize = async ({
-  payload: {
-    image, options, output
-  },
-}, res) => {
+const recognize = ({ payload: { image, options: { rectangle: rec } } }, res) => {
   try {
-    const optionsTess = {};
-    if (typeof options === "object" && Object.keys(options).length > 0) {
-      // The options provided by users contain a mix of options for Tesseract.js
-      // and parameters passed through to Tesseract. 
-      for (const param in options) {
-        if (!param.startsWith('tessjs_') && !tessjsOptions.includes(param)) {
-          optionsTess[param] = options[param];
-        }
-      }
-    }
-    if (output.debug) {
-      optionsTess["debug_file"] = "/debugInternal.txt";
-      TessModule.FS.writeFile("/debugInternal.txt", "");
-    }
-    // If any parameters are changed here they are changed back at the end
-    if (Object.keys(optionsTess).length > 0) {
-      api.SaveParameters();
-      for (const prop in optionsTess) {
-        api.SetVariable(prop, optionsTess[prop]);
-      }
-    }
-
-    const {workingOutput, recOutputCount} = processOutput(output);
-
-    // When the auto-rotate option is True, setImage is called with no angle,
-    // then the angle is calculated by Tesseract and then setImage is re-called.
-    // Otherwise, setImage is called once using the user-provided rotateRadiansFinal value.
-    let rotateRadiansFinal;
-    if (options.rotateAuto) {
-      // The angle is only detected if auto page segmentation is used
-      // Therefore, if this is not the mode specified by the user, it is enabled temporarily here
-      const psmInit = api.GetPageSegMode();
-      let psmEdit = false;
-      if (![PSM.AUTO, PSM.AUTO_ONLY, PSM.OSD].includes(psmInit)) {
-        psmEdit = true;
-        api.SetVariable('tessedit_pageseg_mode', String(PSM.AUTO));
-      }
-
-      setImage(TessModule, api, image);
-      api.FindLines();
-      const rotateRadiansCalc = api.GetAngle();
-
-      // Restore user-provided PSM setting
-      if (psmEdit) {
-        api.SetVariable('tessedit_pageseg_mode', String(psmInit));
-      }
-
-      // Small angles (<0.005 radians/~0.3 degrees) are ignored to save on runtime
-      if (Math.abs(rotateRadiansCalc) >= 0.005) {
-        rotateRadiansFinal = rotateRadiansCalc;
-        setImage(TessModule, api, image, rotateRadiansFinal);
-      } else {
-        // Image needs to be reset if run with different PSM setting earlier
-        if (psmEdit) {
-          setImage(TessModule, api, image);
-        }
-        rotateRadiansFinal = 0;
-      }
-    } else {
-      rotateRadiansFinal = options.rotateRadians || 0;
-      setImage(TessModule, api, image, rotateRadiansFinal);
-    }
-
-    const rec = options.rectangle;
+    const ptr = setImage(TessModule, api, image);
     if (typeof rec === 'object') {
       api.SetRectangle(rec.left, rec.top, rec.width, rec.height);
     }
-
-    if (recOutputCount > 0) {
-      api.Recognize(null);
-    } else {
-      log(`Skipping recognition: all output options requiring recognition are disabled.`);
-    }
-    const pdfTitle = options.pdfTitle;
-    const pdfTextOnly = options.pdfTextOnly;
-    const result = dump(TessModule, api, workingOutput, {pdfTitle, pdfTextOnly});
-    result.rotateRadians = rotateRadiansFinal;
-
-    if (output.debug) TessModule.FS.unlink("/debugInternal.txt");
-
-    if (Object.keys(optionsTess).length > 0) {
-      api.RestoreParameters();
-    }
-
-    res.resolve(result);
+    api.Recognize(null);
+    res.resolve(dump(TessModule, api, params));
+    TessModule._free(ptr);
   } catch (err) {
     res.reject(err.toString());
   }
 };
 
+const getPDF = ({ payload: { title, textonly } }, res) => {
+  const pdfRenderer = new TessModule.TessPDFRenderer('tesseract-ocr', '/', textonly);
+  pdfRenderer.BeginDocument(title);
+  pdfRenderer.AddImage(api);
+  pdfRenderer.EndDocument();
+  TessModule._free(pdfRenderer);
+
+  res.resolve(TessModule.FS.readFile('/tesseract-ocr.pdf'));
+};
 
-const detect = async ({ payload: { image } }, res) => {
+const detect = ({ payload: { image } }, res) => {
   try {
-    setImage(TessModule, api, image);
+    const ptr = setImage(TessModule, api, image);
     const results = new TessModule.OSResults();
 
     if (!api.DetectOS(results)) {
-
-      res.resolve({
-        tesseract_script_id: null,
-        script: null,
-        script_confidence: null,
-        orientation_degrees: null,
-        orientation_confidence: null,
-      });
+      api.End();
+      TessModule._free(ptr);
+      res.reject('Failed to detect OS');
     } else {
       const best = results.best_result;
       const oid = best.orientation_id;
       const sid = best.script_id;
 
+      TessModule._free(ptr);
+
       res.resolve({
         tesseract_script_id: sid,
         script: results.unicharset.get_script_from_script_id(sid),
@@ -395,7 +245,7 @@ const detect = async ({ payload: { image } }, res) => {
   }
 };
 
-const terminate = async (_, res) => {
+const terminate = (_, res) => {
   try {
     if (api !== null) {
       api.End();
@@ -432,18 +282,22 @@ exports.dispatchHandlers = (packet, send) => {
 
   latestJob = res;
 
-  ({
-    load,
-    FS,
-    loadLanguage,
-    initialize,
-    setParameters,
-    recognize,
-    getPDF,
-    detect,
-    terminate,
-  })[packet.action](packet, res)
-    .catch((err) => res.reject(err.toString()));
+  try {
+    ({
+      load,
+      FS,
+      loadLanguage,
+      initialize,
+      setParameters,
+      recognize,
+      getPDF,
+      detect,
+      terminate,
+    })[packet.action](packet, res);
+  } catch (err) {
+    /** Prepare exception to travel through postMessage */
+    res.reject(err.toString());
+  }
 };
 
 /**

src/worker-script/utils/arrayBufferToBase64.js

@@ -1,56 +0,0 @@
-// Copied from https://gist.github.com/jonleighton/958841
-// Copyright 2011 Jon Leighton, MIT LICENSE
-
-/* eslint no-bitwise: 0 */
-module.exports = (arrayBuffer) => {
-  let base64 = '';
-  const encodings = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
-
-  const bytes = new Uint8Array(arrayBuffer);
-  const { byteLength } = bytes;
-  const byteRemainder = byteLength % 3;
-  const mainLength = byteLength - byteRemainder;
-
-  let a; let b; let c; let
-    d;
-  let chunk;
-
-  // Main loop deals with bytes in chunks of 3
-  for (let i = 0; i < mainLength; i += 3) {
-    // Combine the three bytes into a single integer
-    chunk = (bytes[i] << 16) | (bytes[i + 1] << 8) | bytes[i + 2];
-
-    // Use bitmasks to extract 6-bit segments from the triplet
-    a = (chunk & 16515072) >> 18; // 16515072 = (2^6 - 1) << 18
-    b = (chunk & 258048) >> 12; // 258048   = (2^6 - 1) << 12
-    c = (chunk & 4032) >> 6; // 4032     = (2^6 - 1) << 6
-    d = chunk & 63; // 63       = 2^6 - 1
-
-    // Convert the raw binary segments to the appropriate ASCII encoding
-    base64 += encodings[a] + encodings[b] + encodings[c] + encodings[d];
-  }
-
-  // Deal with the remaining bytes and padding
-  if (byteRemainder === 1) {
-    chunk = bytes[mainLength];
-
-    a = (chunk & 252) >> 2; // 252 = (2^6 - 1) << 2
-
-    // Set the 4 least significant bits to zero
-    b = (chunk & 3) << 4; // 3   = 2^2 - 1
-
-    base64 += `${encodings[a] + encodings[b]}==`;
-  } else if (byteRemainder === 2) {
-    chunk = (bytes[mainLength] << 8) | bytes[mainLength + 1];
-
-    a = (chunk & 64512) >> 10; // 64512 = (2^6 - 1) << 10
-    b = (chunk & 1008) >> 4; // 1008  = (2^6 - 1) << 4
-
-    // Set the 2 least significant bits to zero
-    c = (chunk & 15) << 2; // 15    = 2^4 - 1
-
-    base64 += `${encodings[a] + encodings[b] + encodings[c]}=`;
-  }
-
-  return base64;
-};

src/worker-script/utils/dump.js

@@ -7,8 +7,6 @@
  * @author Guillermo Webster <gui@mit.edu>
  * @author Jerome Wu <jeromewus@gmail.com>
  */
-const arrayBufferToBase64 = require('./arrayBufferToBase64');
-const imageType = require('../../constants/imageType');
 
 /**
  * deindent
@@ -39,7 +37,13 @@ const deindent = (html) => {
  * @function dump recognition result to a JSON object
  * @access public
  */
-module.exports = (TessModule, api, output, options) => {
+module.exports = (TessModule, api, {
+  tessjs_create_hocr,
+  tessjs_create_tsv,
+  tessjs_create_box,
+  tessjs_create_unlv,
+  tessjs_create_osd,
+}) => {
   const ri = api.GetIterator();
   const {
     RIL_BLOCK,
@@ -61,164 +65,137 @@ module.exports = (TessModule, api, output, options) => {
       .map((e) => e.slice(prefix.length + 1))[0]
   );
 
-  const getImage = (type) => {
-    api.WriteImage(type, '/image.png');
-    const pngBuffer = TessModule.FS.readFile('/image.png');
-    const pngStr = `data:image/png;base64,${arrayBufferToBase64(pngBuffer.buffer)}`;
-    TessModule.FS.unlink('/image.png');
-    return pngStr;
-  };
-
-  const getPDFInternal = (title, textonly) => {
-    const pdfRenderer = new TessModule.TessPDFRenderer('tesseract-ocr', '/', textonly);
-    pdfRenderer.BeginDocument(title);
-    pdfRenderer.AddImage(api);
-    pdfRenderer.EndDocument();
-    TessModule._free(pdfRenderer);
-
-    return TessModule.FS.readFile('/tesseract-ocr.pdf');
-  };
-
-  if (output.blocks) {
-
-    ri.Begin();
-    do {
-      if (ri.IsAtBeginningOf(RIL_BLOCK)) {
-        const poly = ri.BlockPolygon();
-        let polygon = null;
-        // BlockPolygon() returns null when automatic page segmentation is off
-        if (TessModule.getPointer(poly) > 0) {
-          const n = poly.get_n();
-          const px = poly.get_x();
-          const py = poly.get_y();
-          polygon = [];
-          for (let i = 0; i < n; i += 1) {
-            polygon.push([px.getValue(i), py.getValue(i)]);
-          }
-          /*
-           * TODO: find out why _ptaDestroy doesn't work
-           */
-          // TessModule._ptaDestroy(TessModule.getPointer(poly));
+  ri.Begin();
+  do {
+    if (ri.IsAtBeginningOf(RIL_BLOCK)) {
+      const poly = ri.BlockPolygon();
+      let polygon = null;
+      // BlockPolygon() returns null when automatic page segmentation is off
+      if (TessModule.getPointer(poly) > 0) {
+        const n = poly.get_n();
+        const px = poly.get_x();
+        const py = poly.get_y();
+        polygon = [];
+        for (let i = 0; i < n; i += 1) {
+          polygon.push([px.getValue(i), py.getValue(i)]);
         }
-
-        block = {
-          paragraphs: [],
-          text: ri.GetUTF8Text(RIL_BLOCK),
-          confidence: ri.Confidence(RIL_BLOCK),
-          baseline: ri.getBaseline(RIL_BLOCK),
-          bbox: ri.getBoundingBox(RIL_BLOCK),
-          blocktype: enumToString(ri.BlockType(), 'PT'),
-          polygon,
-        };
-        blocks.push(block);
-      }
-      if (ri.IsAtBeginningOf(RIL_PARA)) {
-        para = {
-          lines: [],
-          text: ri.GetUTF8Text(RIL_PARA),
-          confidence: ri.Confidence(RIL_PARA),
-          baseline: ri.getBaseline(RIL_PARA),
-          bbox: ri.getBoundingBox(RIL_PARA),
-          is_ltr: !!ri.ParagraphIsLtr(),
-        };
-        block.paragraphs.push(para);
-      }
-      if (ri.IsAtBeginningOf(RIL_TEXTLINE)) {
-        textline = {
-          words: [],
-          text: ri.GetUTF8Text(RIL_TEXTLINE),
-          confidence: ri.Confidence(RIL_TEXTLINE),
-          baseline: ri.getBaseline(RIL_TEXTLINE),
-          bbox: ri.getBoundingBox(RIL_TEXTLINE),
-        };
-        para.lines.push(textline);
+        /*
+         * TODO: find out why _ptaDestroy doesn't work
+         */
+        // TessModule._ptaDestroy(TessModule.getPointer(poly));
       }
-      if (ri.IsAtBeginningOf(RIL_WORD)) {
-        const fontInfo = ri.getWordFontAttributes();
-        const wordDir = ri.WordDirection();
-        word = {
-          symbols: [],
-          choices: [],
 
-          text: ri.GetUTF8Text(RIL_WORD),
-          confidence: ri.Confidence(RIL_WORD),
-          baseline: ri.getBaseline(RIL_WORD),
-          bbox: ri.getBoundingBox(RIL_WORD),
+      block = {
+        paragraphs: [],
+        text: ri.GetUTF8Text(RIL_BLOCK),
+        confidence: ri.Confidence(RIL_BLOCK),
+        baseline: ri.getBaseline(RIL_BLOCK),
+        bbox: ri.getBoundingBox(RIL_BLOCK),
+        blocktype: enumToString(ri.BlockType(), 'PT'),
+        polygon,
+      };
+      blocks.push(block);
+    }
+    if (ri.IsAtBeginningOf(RIL_PARA)) {
+      para = {
+        lines: [],
+        text: ri.GetUTF8Text(RIL_PARA),
+        confidence: ri.Confidence(RIL_PARA),
+        baseline: ri.getBaseline(RIL_PARA),
+        bbox: ri.getBoundingBox(RIL_PARA),
+        is_ltr: !!ri.ParagraphIsLtr(),
+      };
+      block.paragraphs.push(para);
+    }
+    if (ri.IsAtBeginningOf(RIL_TEXTLINE)) {
+      textline = {
+        words: [],
+        text: ri.GetUTF8Text(RIL_TEXTLINE),
+        confidence: ri.Confidence(RIL_TEXTLINE),
+        baseline: ri.getBaseline(RIL_TEXTLINE),
+        bbox: ri.getBoundingBox(RIL_TEXTLINE),
+      };
+      para.lines.push(textline);
+    }
+    if (ri.IsAtBeginningOf(RIL_WORD)) {
+      const fontInfo = ri.getWordFontAttributes();
+      const wordDir = ri.WordDirection();
+      word = {
+        symbols: [],
+        choices: [],
 
-          is_numeric: !!ri.WordIsNumeric(),
-          in_dictionary: !!ri.WordIsFromDictionary(),
-          direction: enumToString(wordDir, 'DIR'),
-          language: ri.WordRecognitionLanguage(),
+        text: ri.GetUTF8Text(RIL_WORD),
+        confidence: ri.Confidence(RIL_WORD),
+        baseline: ri.getBaseline(RIL_WORD),
+        bbox: ri.getBoundingBox(RIL_WORD),
 
-          is_bold: fontInfo.is_bold,
-          is_italic: fontInfo.is_italic,
-          is_underlined: fontInfo.is_underlined,
-          is_monospace: fontInfo.is_monospace,
-          is_serif: fontInfo.is_serif,
-          is_smallcaps: fontInfo.is_smallcaps,
-          font_size: fontInfo.pointsize,
-          font_id: fontInfo.font_id,
-          font_name: fontInfo.font_name,
-        };
-        const wc = new TessModule.WordChoiceIterator(ri);
-        do {
-          word.choices.push({
-            text: wc.GetUTF8Text(),
-            confidence: wc.Confidence(),
-          });
-        } while (wc.Next());
-        TessModule.destroy(wc);
-        textline.words.push(word);
-      }
+        is_numeric: !!ri.WordIsNumeric(),
+        in_dictionary: !!ri.WordIsFromDictionary(),
+        direction: enumToString(wordDir, 'DIR'),
+        language: ri.WordRecognitionLanguage(),
 
-      // let image = null;
-      // var pix = ri.GetBinaryImage(TessModule.RIL_SYMBOL)
-      // var image = pix2array(pix);
-      // // for some reason it seems that things stop working if you destroy pics
-      // TessModule._pixDestroy(TessModule.getPointer(pix));
-      if (ri.IsAtBeginningOf(RIL_SYMBOL)) {
-        symbol = {
-          choices: [],
-          image: null,
-          text: ri.GetUTF8Text(RIL_SYMBOL),
-          confidence: ri.Confidence(RIL_SYMBOL),
-          baseline: ri.getBaseline(RIL_SYMBOL),
-          bbox: ri.getBoundingBox(RIL_SYMBOL),
-          is_superscript: !!ri.SymbolIsSuperscript(),
-          is_subscript: !!ri.SymbolIsSubscript(),
-          is_dropcap: !!ri.SymbolIsDropcap(),
-        };
-        word.symbols.push(symbol);
-        const ci = new TessModule.ChoiceIterator(ri);
-        do {
-          symbol.choices.push({
-            text: ci.GetUTF8Text(),
-            confidence: ci.Confidence(),
-          });
-        } while (ci.Next());
-        // TessModule.destroy(i);
-      }
-    } while (ri.Next(RIL_SYMBOL));
-    TessModule.destroy(ri);
+        is_bold: fontInfo.is_bold,
+        is_italic: fontInfo.is_italic,
+        is_underlined: fontInfo.is_underlined,
+        is_monospace: fontInfo.is_monospace,
+        is_serif: fontInfo.is_serif,
+        is_smallcaps: fontInfo.is_smallcaps,
+        font_size: fontInfo.pointsize,
+        font_id: fontInfo.font_id,
+        font_name: fontInfo.font_name,
+      };
+      const wc = new TessModule.WordChoiceIterator(ri);
+      do {
+        word.choices.push({
+          text: wc.GetUTF8Text(),
+          confidence: wc.Confidence(),
+        });
+      } while (wc.Next());
+      TessModule.destroy(wc);
+      textline.words.push(word);
+    }
 
-  }
+    // let image = null;
+    // var pix = ri.GetBinaryImage(TessModule.RIL_SYMBOL)
+    // var image = pix2array(pix);
+    // // for some reason it seems that things stop working if you destroy pics
+    // TessModule._pixDestroy(TessModule.getPointer(pix));
+    if (ri.IsAtBeginningOf(RIL_SYMBOL)) {
+      symbol = {
+        choices: [],
+        image: null,
+        text: ri.GetUTF8Text(RIL_SYMBOL),
+        confidence: ri.Confidence(RIL_SYMBOL),
+        baseline: ri.getBaseline(RIL_SYMBOL),
+        bbox: ri.getBoundingBox(RIL_SYMBOL),
+        is_superscript: !!ri.SymbolIsSuperscript(),
+        is_subscript: !!ri.SymbolIsSubscript(),
+        is_dropcap: !!ri.SymbolIsDropcap(),
+      };
+      word.symbols.push(symbol);
+      const ci = new TessModule.ChoiceIterator(ri);
+      do {
+        symbol.choices.push({
+          text: ci.GetUTF8Text(),
+          confidence: ci.Confidence(),
+        });
+      } while (ci.Next());
+      // TessModule.destroy(i);
+    }
+  } while (ri.Next(RIL_SYMBOL));
+  TessModule.destroy(ri);
 
   return {
-    text: output.text ? api.GetUTF8Text() : null,
-    hocr: output.hocr ? deindent(api.GetHOCRText()) : null,
-    tsv: output.tsv ? api.GetTSVText() : null,
-    box: output.box ? api.GetBoxText() : null,
-    unlv: output.unlv ? api.GetUNLVText() : null,
-    osd: output.osd ? api.GetOsdText() : null,
-    pdf: output.pdf ? getPDFInternal(options.pdfTitle ?? 'Tesseract OCR Result', options.pdfTextOnly ?? false) : null,
-    imageColor: output.imageColor ? getImage(imageType.COLOR) : null,
-    imageGrey: output.imageGrey ? getImage(imageType.GREY) : null,
-    imageBinary: output.imageBinary ? getImage(imageType.BINARY) : null,
+    text: api.GetUTF8Text(),
+    hocr: tessjs_create_hocr === '1' ? deindent(api.GetHOCRText()) : null,
+    tsv: tessjs_create_tsv === '1' ? api.GetTSVText() : null,
+    box: tessjs_create_box === '1' ? api.GetBoxText() : null,
+    unlv: tessjs_create_unlv === '1' ? api.GetUNLVText() : null,
+    osd: tessjs_create_osd === '1' ? api.GetOsdText() : null,
     confidence: api.MeanTextConf(),
-    blocks: output.blocks ? blocks : null,
+    blocks,
     psm: enumToString(api.GetPageSegMode(), 'PSM'),
     oem: enumToString(api.oem(), 'OEM'),
     version: api.Version(),
-    debug: output.debug ? TessModule.FS.readFile('/debugInternal.txt', { encoding: 'utf8', flags:"a+" }) : null
   };
 };

src/worker-script/utils/setImage.js

@@ -8,27 +8,56 @@ const fileType = require('file-type');
  * @function set image in tesseract for recognition
  * @access public
  */
-module.exports = (TessModule, api, image, angle = 0) => {
+module.exports = (TessModule, api, image) => {
+  const buf = Buffer.from(Array.from({ ...image, length: Object.keys(image).length }));
+  const type = fileType(buf);
+  let bytesPerPixel = 0;
+  let data = null;
+  let pix = null;
+  let w = 0;
+  let h = 0;
 
-  const type = fileType(image);
+  const exif = buf.slice(0, 500).toString().match(/\x01\x12\x00\x03\x00\x00\x00\x01\x00(.)/)?.[1]?.charCodeAt(0) || 1;
 
-  const exif = image.slice(0, 500).toString().match(/\x01\x12\x00\x03\x00\x00\x00\x01\x00(.)/)?.[1]?.charCodeAt(0) || 1;
-
-  // /*
-  //  * Leptonica supports some but not all bmp files
-  //  * @see https://github.com/DanBloomberg/leptonica/issues/607#issuecomment-1068802516
-  //  * We therefore use bmp-js to convert all bmp files into a format Leptonica is known to support
-  //  */
+  /*
+   * Leptonica supports uncompressed but not compressed bmp files
+   * @see https://github.com/DanBloomberg/leptonica/issues/607#issuecomment-1068802516
+   * We therefore use bmp-js to process all bmp files
+   */
   if (type && type.mime === 'image/bmp') {
-    // Not sure what this line actually does, but removing breaks the function
-    const buf = Buffer.from(Array.from({ ...image, length: Object.keys(image).length }));
     const bmpBuf = bmp.decode(buf);
-    TessModule.FS.writeFile("/input", bmp.encode(bmpBuf).data);
+    data = TessModule._malloc(bmpBuf.data.length * Uint8Array.BYTES_PER_ELEMENT);
+    TessModule.HEAPU8.set(bmpBuf.data, data);
+    w = bmpBuf.width;
+    h = bmpBuf.height;
+    bytesPerPixel = 4;
   } else {
-    TessModule.FS.writeFile("/input", image);
+    const ptr = TessModule._malloc(buf.length * Uint8Array.BYTES_PER_ELEMENT);
+    TessModule.HEAPU8.set(buf, ptr);
+    pix = TessModule._pixReadMem(ptr, buf.length);
+    if (TessModule.getValue(pix + (7 * 4), 'i32') === 0) {
+      /*
+       * Set a yres default value to prevent warning from tesseract
+       * See kMinCredibleResolution in tesseract/src/ccstruct/publictypes.h
+       */
+      TessModule.setValue(pix + (7 * 4), 300, 'i32');
+    }
+    [w, h] = Array(2).fill(0)
+      .map((v, idx) => (
+        TessModule.getValue(pix + (idx * 4), 'i32')
+      ));
   }
 
-  api.SetImageFile(exif, angle);
-  return;
-
+  /*
+   * As some image format (ex. bmp) is not supported natiely by tesseract,
+   * sometimes it will not return pix directly, but data and bytesPerPixel
+   * for another SetImage usage.
+   *
+   */
+  if (data === null) {
+    api.SetImage(pix, undefined, undefined, undefined, undefined, exif);
+  } else {
+    api.SetImage(data, w, h, bytesPerPixel, w * bytesPerPixel, exif);
+  }
+  return data === null ? pix : data;
 };

tests/FS.test.js

@@ -1,9 +1,9 @@
 const { createWorker } = Tesseract;
 const FS_WAIT = 500;
-let worker;
-before(async function cb() {
+const worker = createWorker(OPTIONS);
+before(function cb() {
   this.timeout(0);
-  worker = await createWorker(OPTIONS);
+  return worker.load();
 });
 
 describe('FS', async () => {

tests/detect.test.js

@@ -1,8 +1,8 @@
 const { createWorker } = Tesseract;
-let worker;
-before(async function cb() {
+const worker = createWorker(OPTIONS);
+before(function cb() {
   this.timeout(0);
-  worker = await createWorker(OPTIONS);
+  return worker.load();
 });
 
 describe('detect()', async () => {
@@ -17,15 +17,3 @@ describe('detect()', async () => {
     });
   }).timeout(TIMEOUT);
 });
-
-
-describe('detect()', async () => {
-  it('should detect OSD (simplified interface)', () => {
-    [
-      { name: 'cosmic.png', ans: { script: 'Latin' } },
-    ].forEach(async ({ name, ans: { script } }) => {
-      const { data: { script: s } } = await Tesseract.detect(`${IMAGE_PATH}/${name}`, undefined, OPTIONS);
-      expect(s).to.be(script);
-    });
-  }).timeout(TIMEOUT);
-});

tests/recognize.test.js

@@ -1,8 +1,8 @@
 const { createWorker, PSM } = Tesseract;
-let worker;
+const worker = createWorker(OPTIONS);
 before(async function cb() {
   this.timeout(0);
-  worker = await createWorker(OPTIONS);
+  await worker.load();
   await worker.loadLanguage('eng+chi_tra+osd');
 });
 
@@ -30,19 +30,6 @@ describe('recognize()', () => {
     ));
   });
 
-  describe('should recognize base64 image (simplified interface)', () => {
-    [
-      { format: 'png', image: SIMPLE_PNG_BASE64, ans: SIMPLE_TEXT },
-      { format: 'jpg', image: SIMPLE_JPG_BASE64, ans: SIMPLE_TEXT },
-    ].forEach(({ format, image, ans }) => (
-      it(`recongize ${format} in base64`, async () => {
-        const { data: { text } } = await Tesseract.recognize(image, undefined, OPTIONS);
-        expect(text).to.be(ans);
-      }).timeout(TIMEOUT)
-    ));
-  });
-
-
   describe('should recognize different langs', () => {
     [
       { name: 'chinese.png', lang: 'chi_tra', ans: CHINESE_TEXT },

tests/scheduler.test.js

@@ -7,7 +7,8 @@ before(async function cb() {
   const NUM_WORKERS = 5;
   console.log(`Initializing ${NUM_WORKERS} workers`);
   workers = await Promise.all(Array(NUM_WORKERS).fill(0).map(async () => {
-    const w = await createWorker(OPTIONS);
+    const w = createWorker(OPTIONS);
+    await w.load();
     await w.loadLanguage('eng');
     await w.initialize('eng');
     return w;