Skip to content
Tesseract Open Source OCR Engine (main repository)
C++ C CMake Shell Java Python Other
Branch: master
Clone or download
egorpugin Merge pull request #2620 from stweil/simd
simd: Check whether the OS supports FMA, AVX, ...
Latest commit 0a3a351 Aug 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix whitespace issues Aug 1, 2018
abseil @ daf381e Update abseil submodule to HEAD May 17, 2019
cmake Remove code for embedded build Jun 17, 2019
doc add debugger view for params Jul 4, 2019
googletest @ a18ac39 Update googletest Mar 26, 2019
java fix building of ScrollView.jar with modern java version; fixes #1289 Oct 10, 2018
m4 Remove autoconf-archive dependency Jun 30, 2018
snap Add newline at end of file Sep 3, 2018
src simd: Check whether the OS supports FMA, AVX, ... Aug 16, 2019
tessdata autotools: remove list of traineddata files May 8, 2019
test @ e27d956 Update test submodule and fix pagesegmode_test Jul 9, 2019
unittest Remove more code for builds with disabled legacy engine Aug 13, 2019
.clang-format Modifiy formatting rules Apr 2, 2019
.gitignore extend ignore list Apr 22, 2019
.gitmodules Add Abseil as a submodule (needed for some of the new unit tests) Oct 11, 2018
.lgtm.yml Use Python3 for LGTM Nov 30, 2018
.travis.yml use Ubuntu Xenial for travis Jul 12, 2019
AUTHORS Update AUTHORS May 8, 2018
CMakeLists.txt Merge pull request #2614 from stweil/training Aug 12, 2019
CONTRIBUTING.md Remove space at line endings May 16, 2019
ChangeLog info about 4.1.0 release to master Jul 12, 2019
Dockerfile Dockerfile: Delete the apt-get lists after installing Nov 2, 2018
INSTALL Fix file endings Apr 25, 2018
INSTALL.GIT.md Remove old and misguiding build steps on windows. Jun 17, 2019
LICENSE Added missing license headers Nov 18, 2016
Makefile.am Add build rule for fuzzer-api Mar 26, 2019
README.md Give info about expected leptonica dependencies (fix #2333) Jul 12, 2019
VERSION Increase version number because of backward not compatible API code c… Apr 20, 2019
appveyor.yml [appveyor] Disable VS2019 image because it's too slow. Jul 19, 2019
autogen.sh Fix whitespace issues Aug 1, 2018
configure.ac fix #2101 Jul 13, 2019
cppan.yml Remove macro WINDLLNAME Mar 31, 2019
docker-compose.yml Dockerifying using travis build script Mar 18, 2016
sw.cpp [sw] Update build for commit e84cb24 Aug 12, 2019
tesseract.pc.cmake Require tesseract/ for API header files (fixes potential name conflicts) Jun 17, 2018
tesseract.pc.in improve tesseract.pc.in - fixes #241 Mar 4, 2016

README.md

Tesseract OCR

Build Status Build status
Coverity Scan Build Status Code Quality: Cpp 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

You can’t perform that action at this time.