kaelzhang / penteract-ocr Goto Github PK

View Code? Open in Web Editor NEW

113.0 3.0 12.0 1.03 MB

⭐️ The native node.js bindings to the Tesseract OCR project.

License: Other

JavaScript 17.45% Python 7.65% C++ 54.67% C 5.16% Shell 11.81% CMake 3.27%

n-api nodejs tesseract ocr penteract ocr-engine optical-character-recognition

penteract-ocr's Introduction

penteract

The native Node.js bindings to the Tesseract OCR project.

Using Node.js bindings, avoid spawning tesseract command line.
Asynchronous I/O: Image reading and processing in insulated event loop backed by libuv.
Support to read image data from JavaScript buffers.

Contributions are welcome.

Install

First of all, a g++ 4.9 compiler is required.

Before install penteract, the following dependencies should be installed

$ brew install pkg-config tesseract # mac os

Then npm install

$ npm install penteract

To Use with Electron

Due to the limitation of node native modules, if you want to use penteract with electron, add a .npmrc file to the root of your electron project, before npm install:

runtime = electron
; The version of the local electron,
; use `npm ls electron` to figure it out
target = 1.7.5
target_arch = x64
disturl = https://atom.io/download/atom-shell

Usage

Recognize an Image Buffer

import {
  recognize
} from 'penteract'

import fs from 'fs-extra'

const filepath = path.join(__dirname, 'test', 'fixtures', 'penteract.jpg')

fs.readFile(filepath).then(recognize).then(console.log) // 'penteract'

Recognize a Local Image File

import {
  fromFile
} from 'penteract'

fromFile(filepath, {lang: 'eng'}).then(console.log)     // 'penteract'

recognize(image [, options])

image Buffer the content buffer of the image file.
options PenteractOptions= optional

Returns Promise.<String> the recognized text if succeeded.

fromFile(filepath [, options])

filepath Path the file path of the image file.
options PenteractOptions=

Returns Promise.<String>

`PenteractOptions` `Object`

{
  // @type `(String|Array.<String>)=eng`,
  //
  // Specifies language(s) used for OCR.
  //   Run `tesseract --list-langs` in command line for all supported languages.
  //   Defaults to `'eng'`.
  //
  // To specify multiple languages, use an array.
  //   English and Simplified Chinese, for example:
  // ```
  // lang: ['eng', 'chi_sim']
  // ```
  lang: 'eng'
}

`Promise.reject(error)`

error Error The JavaScript Error instance
- code String Error code.
- message String Error message.
- other properties of Error.

code: `ERR_READ_IMAGE`

Rejects if it fails to read image data from file or buffer.

code: `ERR_INIT_TESSER`

Rejects if tesseract fails to initialize

Example of Using with Electron

// For details of `mainWindow: BrowserWindow`, see
// https://github.com/electron/electron/blob/master/docs/api/browser-window.md
mainWindow.capturePage({
  x: 10,
  y: 10,
  width: 100,
  height: 10

}, (data) => {
  recognize(data.toPNG()).then(console.log)
})

Compiling Troubles

For Mac OS users, if you are experiencing trouble when compiling, run the following command:

$ xcode-select --install

will resolve most problems.

Warnings:

xcode-select: error: tool 'xcodebuild' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance

resolver:

$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

License

MIT

penteract-ocr's People

Contributors

Stargazers

Watchers

Forkers

guerrerocarlos iqinning acadia1337 xtrctio daggieblanqx cnsuhao axelline tuananh egoist37 rohithzr sakhidamaulik mynodejs

penteract-ocr's Issues

Documentation example on How to set options request

Hello. I had perf issue using the teserract.js so i decided to give this penteract binding a try. However
I am quite confused on how to set options like: use my own dictionary words

I am also wondering if version 4 of tesseract with neural LSTM is supported .

THANKS

pkg-config install failed on windows and unbuntu

It works well on mac, pertty good, but I have no idea when install pkg-config dependencies on win10 and unbuntu18, if this issue dose not belong to penteract-ocr, please forgive me and close it, thanks.

I just want to know two questions:

Is penteract-ocr support windows and unbuntu
Is pkg-config could install success on windows and ubuntu as penteract-ocr wanted

The problem I am having is

I don't know how to install pkg-config success on windows, I have try https://stackoverflow.com/questions/1710922/how-to-install-pkg-config-in-windows, but faild.
I install pkg-config success by apt-get on Ubuntu, but it does't have lept, however, tesseract needs it.

so, could you give me some help or advise, thanks.

How to set dpi

I keep getting Warning. Invalid resolution 0 dpi. Using 70 instead., the dpi is 72 however and it is giving bad results. Is there a way to set dpi to 72 without changing the files?

Thanks for making this!

Module not found: Error: Can't resolve '../build/Release/penteract'

I am trying to use this in my electron project. Unfortunately when I run my project (via webpack), I am getting this:

    ERROR in ./node_modules/penteract/src/index.js
    Module not found: Error: Can't resolve '../build/Release/penteract' in '/Users/steph/Documents/workspace/myElectronProject/node_modules/penteract/src'
     @ ./node_modules/penteract/src/index.js 1:0-49 25:4-12

I checked the build/Release folder, and there is a penteract.node file present.
Any idea?

On a side note: I am using node-loader, not sure if this is related. Webpack config:

  module: {
    rules: [
      {
        test: /\.node$/,
        use: 'node-loader'
      },
   ...
  }

Unable to install on Mac OS

Hello - I have been unable to install the npm package on my Mac.

From bash:
npm i penteract

Complete error log: link

install on linux?

can this module install on ubuntu?

Container usage from node.js app

What are the setup and run instructions if I choose to run a node.js app get penteract (running in a docker container in BlueMix) as an engine to process uploaded files (on the server/linking a volume to a container)?

Can I run the container and access the image's filesystem via a bash shell for testing purposes?

Do I need a compiler? My test machine is with Windows.

Thank you

Dependency information is not enough

Hello, I just found this repo and so glad to test it.
But it is not working simple code:
require("penteract.js");

Looks like dependency problem. Please add this in your readme. :)

internal/modules/cjs/loader.js:730
return process.dlopen(module, path.toNamespacedPath(filename));
^

Error: dlopen(/Users/jeefo/projects/face_recognition/node_modules/penteract/build/Release/penteract.node, 1): Library not loaded: /usr/local/opt/webp/lib/libwebp.5.dylib
Referenced from: /usr/local/opt/libtiff/lib/libtiff.5.dylib
Reason: image not found
at Object.Module._extensions..node (internal/modules/cjs/loader.js:730:18)
at Module.load (internal/modules/cjs/loader.js:600:32)
at tryModuleLoad (internal/modules/cjs/loader.js:539:12)
at Function.Module._load (internal/modules/cjs/loader.js:531:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:22:18)
at Object. (/Users/jeefo/projects/face_recognition/node_modules/penteract/lib/index.js:12:18)
at Module._compile (internal/modules/cjs/loader.js:701:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:712:10)
at Module.load (internal/modules/cjs/loader.js:600:32)