Tesseract Open Source OCR Engine (Mirror)

Stefan Weil ea462b2c03 Remove unused functions reverse16, reverse32 11 hours ago
.github 6a28cce96b Fix whitespace issues 11 months ago
abseil @ daf381e853 bb226c19ab Update abseil submodule to HEAD 1 month ago
cmake 674d6a90d8 Remove code for embedded build 4 weeks ago
doc 25acd28e1e add debugger view for params 1 week ago
googletest @ a18ac392d8 59b90bd466 Update googletest 3 months ago
java 9d84968d71 fix building of ScrollView.jar with modern java version; fixes #1289 9 months ago
m4 6b250b5812 Remove autoconf-archive dependency 1 year ago
snap 31de2cf60e Add newline at end of file 10 months ago
src ea462b2c03 Remove unused functions reverse16, reverse32 11 hours ago
tessdata 68ca3518be autotools: remove list of traineddata files 2 months ago
test @ e27d956691 e94392ef10 Update test submodule and fix pagesegmode_test 6 days ago
unittest 2ba90f02cb unittest: Initialize non-static class members in RecodeBeamTest (CID 1402765) 5 days ago
.clang-format e262d71a56 Modifiy formatting rules 3 months ago
.gitignore 6e55051706 extend ignore list 2 months ago
.gitmodules 3318c9aadd Add Abseil as a submodule (needed for some of the new unit tests) 9 months ago
.lgtm.yml 57d0ae06c0 Use Python3 for LGTM 7 months ago
.travis.yml cce26fa197 use Ubuntu Xenial for travis 3 days ago
AUTHORS af1af22fc0 Update AUTHORS 1 year ago
CMakeLists.txt fef64d795c fix #2101 2 days ago
CONTRIBUTING.md cc754ed1e0 Remove space at line endings 2 months ago
ChangeLog c8b9000ad9 info about 4.1.0 release to master 3 days ago
Dockerfile ad30f52eed Dockerfile: Delete the apt-get lists after installing 8 months ago
INSTALL dabf3c299f Fix file endings 1 year ago
INSTALL.GIT.md 21514457d4 Remove old and misguiding build steps on windows. 4 weeks ago
LICENSE 5913d7344f Added missing license headers 2 years ago
Makefile.am 270e466d75 Add build rule for fuzzer-api 3 months ago
README.md 2e2ea63cf2 Give info about expected leptonica dependencies (fix #2333) 3 days ago
VERSION bff6aaf302 Increase version number because of backward not compatible API code changes 2 months ago
appveyor.yml 757a885a59 Merge branch 'master' of github.com-egorpugin:tesseract-ocr/tesseract 2 days ago
autogen.sh 6a28cce96b Fix whitespace issues 11 months ago
configure.ac fef64d795c fix #2101 2 days ago
cppan.yml ab009fae94 Remove macro WINDLLNAME 3 months ago
docker-compose.yml 71ad8c9bff Dockerifying using travis build script 3 years ago
sw.cpp dbba30b82f [build][sw] Disable FMA dotproduct. 2 days ago
tesseract.pc.cmake c1c87d73ee Require tesseract/ for API header files (fixes potential name conflicts) 1 year ago
tesseract.pc.in ef26b312f9 improve tesseract.pc.in - fixes #241 3 years ago

README.md

Tesseract OCR

Build Status Build status
Coverity Scan Build Status Total Alerts
GitHub license Downloads

About

This package contains an OCR engine - libtesseract and a command line program - tesseract. Tesseract 4 adds a new neural net (LSTM) based OCR engine which is focused on line recognition, but also still supports the legacy Tesseract OCR engine of Tesseract 3 which works by recognizing character patterns. Compatibility with Tesseract 3 is enabled by using the Legacy OCR Engine mode (--oem 0). It also needs traineddata files which support the legacy engine, for example those from the tessdata repository.

The lead developer is Ray Smith. The maintainer is Zdenko Podobny. For a list of contributors see AUTHORS and GitHub's log of contributors.

Tesseract has unicode (UTF-8) support, and can recognize more than 100 languages "out of the box".

Tesseract supports various output formats: plain text, hOCR (HTML), PDF, invisible-text-only PDF, TSV. The master branch also has experimental support for ALTO (XML) output.

You should note that in many cases, in order to get better OCR results, you'll need to improve the quality of the image you are giving Tesseract.

This project does not include a GUI application. If you need one, please see the 3rdParty wiki page.

Tesseract can be trained to recognize other languages. See Tesseract Training for more information.

Brief history

Tesseract was originally developed at Hewlett-Packard Laboratories Bristol and at Hewlett-Packard Co, Greeley Colorado between 1985 and 1994, with some more changes made in 1996 to port to Windows, and some C++izing in 1998. In 2005 Tesseract was open sourced by HP. Since 2006 it is developed by Google.

The latest (LSTM based) stable version is 4.1.0, released on July 7, 2019. Latest source code is available from master branch on GitHub. Open issues can be found in issue tracker, and Planning wiki.

The latest 3.5 version is 3.05.02, released on June 19, 2018. Latest source code for 3.05 is available from 3.05 branch on GitHub. There is no development for this version, but it can be used for special cases (e.g. see Regression of features from 3.0x).

See Release Notes and Change Log for more details of the releases.

Installing Tesseract

You can either Install Tesseract via pre-built binary package or build it from source.

Supported Compilers are:

  • GCC 4.8 and above
  • Clang 3.4 and above
  • MSVC 2015, 2017, 2019

Other compilers might work, but are not officially supported.

Running Tesseract

Basic command line usage:

tesseract imagename outputbase [-l lang] [--oem ocrenginemode] [--psm pagesegmode] [configfiles...]

For more information about the various command line options use tesseract --help or man tesseract.

Examples can be found in the wiki.

For developers

Developers can use libtesseract C or C++ API to build their own application. If you need bindings to libtesseract for other programming languages, please see the wrapper section on AddOns wiki page.

Documentation of Tesseract generated from source code by doxygen can be found on tesseract-ocr.github.io.

Support

Before you submit an issue, please review the guidelines for this repository.

For support, first read the Wiki, particularly the FAQ to see if your problem is addressed there. If not, search the Tesseract user forum, the Tesseract developer forum and past issues, and if you still can't find what you need, ask for support in the mailing-lists.

Mailing-lists:

Please report an issue only for a bug, not for asking questions.

License

The code in this repository is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

NOTE: This software depends on other packages that may be licensed under different open source licenses.

Tesseract uses Leptonica library which essentially uses a BSD 2-clause license.

Dependencies

Tesseract uses Leptonica library for opening input images (e.g. not documents like pdf). It is suggested to use leptonica with build-in support for zlib, png and tiff (for w multipage tiff).

Latest Version of README

For the latest online version of the README.md see:

https://github.com/tesseract-ocr/tesseract/blob/master/README.md