tesseract_ffi 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b299b8e91905a54a81999730de02ae2dbf5ed58cf2bbf826854c178fd5f33296
+  data.tar.gz: 8906f6a6dd21011c076c8d785f6ac99e2297112831f829a924a32f3763b09713
+SHA512:
+  metadata.gz: 9d11f40349117f99080ba4d3eb7f75c4c3d44941c6a3e4aaeec71f22b0ac8e6bc0a361e89c6c657a3fd864853300112883c42162ee5af89f20b841a3cb91f544
+  data.tar.gz: cb2e721f373141bd6f42ef97ebd39257a6735c1b34e241739cdc4cfcdf5f0d7c6747ad95df3b6aa13b12e8a49115081dda447c708c5a6b64718d9dc57c739d2c

data/.gitignore

@@ -0,0 +1,2 @@
+forms.sublime*
+coverage

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dverrier@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'ffi'
+
+group :dev, :test do
+  gem 'awesome_print'
+  gem 'rdoc'
+  gem 'hocr_reader'
+  
+end
+
+group :test do
+  gem 'minitest'
+  gem 'mocha'
+  gem 'nokogiri'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    docile (1.3.2)
+    ffi (1.13.1)
+    hocr_reader (0.1.0)
+      nokogiri (~> 1.10.10)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    mocha (1.11.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rake (13.0.1)
+    rdoc (6.2.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  ffi
+  hocr_reader
+  minitest
+  mocha
+  nokogiri
+  rake
+  rdoc
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Verrier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+# Tesseract_FFI
+
+Welcome to Tesseract_FFI! 
+This is a ruby wrapper to the Tesseract library. _Before installing this gem, make sure that Tesseract runs. For example, run the command_
+
+```bash
+$ tesseract --version
+```
+
+and under Linux, etc you should see something like
+```bash
+tesseract 4.1.1-rc2-25-g9707
+ leptonica-1.78.0
+  libgif 5.1.4 : libjpeg 8d (libjpeg-turbo 1.4.2) : libpng 1.2.54 : libtiff 4.0.6 : zlib 1.2.8 : libwebp 0.4.4 : libopenjp2 2.3.0
+ Found AVX2
+ Found AVX
+ Found FMA
+ Found SSE
+ Found libarchive 3.1.2
+```
+Don't know about Windows, apart from the Windows Subsystem for Linux works really well!
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tesseract_ffi'
+```
+
+And then execute:
+```bash
+    $ bundle install
+```
+Or install it yourself as:
+```bash
+    $ gem install tesseract_ffi
+```
+
+## Usage
+The fastest way to get going is to use the high-level functions that will probably suit most people , most of the time.
+
+#### To convert an image to a string
+```ruby
+require 'tesseract_ffi'
+
+TesseractFFI.to_text('my_image.png')
+```
+#### To convert an image to a searchable PDF file
+```ruby
+require 'tesseract_ffi'
+TesseractFFI.to_pdf('my_image.png', 'output_file')
+```
+
+## Languages
+When the default 'recognition  of English' is not suitable, you can change it. The abreviations used for some common European languages are
+
+* deu - German
+* eng - English
+* fra - French
+* ita - Italian
+* nld - Dutch
+* por - Portuguese
+* spa - Spanish
+
+but Tesseract itself supports many, many languages including but not limited to chi_sim (Chinese simplified), chi_tra (Chinese traditional), chr (Cherokee), cym (Welsh), frk (Frankish), frm (French, Middle, ca.1400-1600). Just ensure that you have the corresponding Tesseract language recognition libraries installed. The best way to confirm this is directly from the command line. For example, to ensure that French recognition files are available to tesseract, type this command to recognise a test image in French
+```bash
+tesseract imagename.png  mytext -l fra
+```
+To call from within a ruby file, the following snippet should work for an image in German:
+```ruby
+require 'tesseract_ffi'
+
+TesseractFFI.to_text('my_image.png', 'deu')
+```
+or by creating Ruby objects:
+
+```ruby
+require 'tesseract_ffi'
+tess = TesseractFFI::Tesseract.new(
+      language:'fra', 
+      file_name: 'test/images/bonjour.png')
+tess.recognize
+text = tess.utf8_text
+```
+
+## To Generate HOCR 
+Wikipedia says HOCR 'is an open standard of data representation for formatted text 
+obtained from optical character recognition (OCR)'.  Tesseract can produce it and generate the bounding boxes of the words, the lines, the paragraphs on a page.
+
+```ruby
+require 'tesseract_ffi'
+tess = TesseractFFI::Tesseract.new( 
+      file_name: 'test/images/4words.png', 
+      source_resolution:96)
+tess.recognize
+text = tess.hocr_text
+```
+
+```xml
+<div class='ocr_page' id='page_18' title='image ""; bbox 0 0 341 17; ppageno 17'>
+   <div class='ocr_carea' id='block_18_1' title="bbox 0 0 341 17">
+    <p class='ocr_par' id='par_18_1' lang='eng' title="bbox 0 0 341 17">
+     <span class='ocr_line' id='line_18_1' title="bbox 0 0 341 17; baseline -0.012 -1; x_size 16; x_descenders 4; x_ascenders 4">
+      <span class='ocrx_word' id='word_18_1' title='bbox 0 4 49 17; x_wconf 92'>Name</span>
+      <span class='ocrx_word' id='word_18_2' title='bbox 54 4 94 17; x_wconf 90'>Arial</span>
+      <span class='ocrx_word' id='word_18_3' title='bbox 237 0 296 15; x_wconf 90'>Century</span>
+      <span class='ocrx_word' id='word_18_4' title='bbox 302 0 341 12; x_wconf 90'>Peter</span>
+     </span>
+    </p>
+   </div>
+  </div>
+```
+
+## Recognise Part of an Image
+```ruby
+require 'tesseract_ffi'
+tess = TesseractFFI::Tesseract.new( 
+      file_name: 'test/images/4words.png')
+
+# tess.recognize_rectangle(x,y,w,h)
+tess.recognize_rectangle(300, 0, 41, 15)
+text = tess.utf8_text
+# => "Peter"
+
+```
+
+## General Structure 
+
+Create a TesseractFFI::Tesseract object specifying the image file, the language(s) and, optionally the source resolution (dpi of the image) and the OCR Engine Mode, OEM. The default is to use the latest mode, which uses a neural network for the recognition. For some purposes, such as typeface/font recognition, it can be desirable to use the legacy mode even though the recognition is not usually as good.
+
+```ruby
+require 'tesseract_ffi'
+tess = TesseractFFI::Tesseract.new( 
+      file_name: 'test/images/4words.png', 
+      source_resolution:96)
+
+```
+Then call Tesseract.setup with the desired methods in a block.
+
+```ruby
+
+tess.setup do
+  tess.set_rectangle(300, 0, 40, 20)
+  tess.ocr
+  puts tess.utf8_text
+  # => Peter
+  tess.set_rectangle(0, 0, 340, 17)
+  tess.ocr
+  puts tess.utf8_text
+  # => Name Arial Century Peter
+end
+
+```
+
+
+## Low Level Calls
+
+If you look under the hood, there are intermediate ruby methods that do most things, and some very low level functions that make calls to the C-API of Tesseract using the wonderful FFI library. The low level functions give alarming error messages and often stack dump if called in the wrong order, so they are not for the feint of heart. But if your screen allows to scroll back 1000 lines, you can usually see where the call to Tesseract went wrong. This gem aims to hide the complexity of the direct calls to the C library. The examples directory includes a couple of files that show the way to proceed at the different levels of complexity and the tests show more usage.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dverrier/tesseract_ffi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dverrier/tesseract_ffi/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tesseract_FFI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tessy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+Rake::TestTask.new(:test_system) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/system/*_test.rb'
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_units) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/unit/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tesseract_ffi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/bonjour.rb

@@ -0,0 +1,7 @@
+
+# execute from the top-level directory to get the 
+# path to the image correct
+require 'tesseract_ffi'
+puts TesseractFFI.to_text('test/images/bonjour.png','fra')
+# => Bonjour les enfants
+

data/examples/low_level_pdf.rb

@@ -0,0 +1,31 @@
+# execute from the top-level directory to get the 
+# path to the image correct
+
+require 'tesseract_ffi'
+#
+# This example shows how to use the low-level functions directly
+# to convert an image to a searchable pdf file
+#
+ 
+input_filename = 'test/images/4words.png'
+output_stem = 'myfirst'
+image = TesseractFFI.tess_pix_read(input_filename)
+
+
+lang = 'eng'
+handle = TesseractFFI.tess_create
+
+if TesseractFFI.tess_init(handle, 0, lang, 0) > 0 
+  puts "Error initializing tesseract"
+end
+
+TesseractFFI.tess_set_image(handle, image)
+
+datapath = TesseractFFI.tess_get_datapath(handle)
+pdf_renderer = TesseractFFI.tess_pdf_renderer_create(output_stem, datapath, false)
+TesseractFFI.tess_process_pages(handle, input_filename, nil, 5000, pdf_renderer)
+puts "PDF file " + output_stem + ".pdf written"
+
+TesseractFFI.tess_end(handle)
+TesseractFFI.tess_delete(handle)
+

data/examples/low_level_recognition.rb

@@ -0,0 +1,39 @@
+# execute from the top-level directory to get the 
+# path to the image correct
+
+require 'tesseract_ffi'
+
+#
+# This example calls the recogniser and
+# prints the results in raw text form and
+# xml form
+
+puts "Found Tesserect #{TesseractFFI.version}"
+filename = 'test/images/4words.png'
+image = TesseractFFI.tess_pix_read(filename)
+
+lang = 'eng'
+handle = TesseractFFI.tess_create
+
+if TesseractFFI.tess_init(handle, 0, lang, 0) > 0 
+  puts "Error initializing tesseract"
+end
+
+TesseractFFI.tess_set_image(handle, image)
+
+
+TesseractFFI.tess_set_source_resolution(handle, 90)
+
+if TesseractFFI.tess_recognize(handle, 0) > 0
+  puts "Error in Tesseract recognition"
+end
+
+# print the text directly
+puts TesseractFFI.tess_get_utf8(handle,0)
+
+# print the HOCR format
+puts  TesseractFFI.tess_get_hocr(handle,0)
+
+TesseractFFI.tess_end(handle)
+TesseractFFI.tess_delete(handle)
+

data/examples/two_rectangles.rb

@@ -0,0 +1,15 @@
+require 'tesseract_ffi'
+tess = TesseractFFI::Tesseract.new( 
+      file_name: 'test/images/4words.png', 
+      source_resolution:96)
+
+tess.setup do
+  # x,y,w,h
+  tess.set_rectangle(300, 0, 40, 20)
+  tess.ocr
+  puts tess.utf8_text
+  tess.set_rectangle(0,0,340,17)
+  tess.ocr
+  puts tess.utf8_text
+  # and so on
+end

data/lib/tesseract_ffi.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require 'tesseract_ffi/version'
+require 'tesseract_ffi/conf_vars' # mix-in to tesseract
+require 'tesseract_ffi/oem' # mix-in to tesseract
+require 'tesseract_ffi/tesseract'
+require 'tesseract_ffi/tess_exception'
+require 'tesseract_ffi/quick'
+
+# module TesseractFFI
+module TesseractFFI
+  extend FFI::Library
+
+  # OCR Engine Modes OEM
+  LEGACY = 0
+  LTSM = 1
+  LEGACY_LTSM = 2
+  DEFAULT = 3
+
+  # class FFIIntPtr
+  class FFIIntPtr < FFI::Struct
+    layout :value, :int
+  end
+
+  # class FFIDoublePtr
+  class FFIDoublePtr < FFI::Struct
+    layout :value, :double
+  end
+
+  ffi_lib '/usr/lib/x86_64-linux-gnu/libtesseract.so'
+
+  attach_function :version, 'TessVersion', [], :string
+  attach_function :tess_create, 'TessBaseAPICreate', [], :pointer
+  attach_function :tess_delete, 'TessBaseAPIDelete', [:pointer], :int
+
+  attach_function :tess_init3,
+                  'TessBaseAPIInit3', %i[pointer int string], :int
+  attach_function :tess_init,
+                  'TessBaseAPIInit2', %i[pointer int string int], :int
+
+  attach_function :tess_end,
+                  'TessBaseAPIEnd', [:pointer], :int
+
+  attach_function :tess_set_image,
+                  'TessBaseAPISetImage2', %i[pointer buffer_in], :int
+  attach_function :tess_recognize,
+                  'TessBaseAPIRecognize', %i[pointer int], :int
+  attach_function :tess_pix_read,
+                  'pixRead', [:string], :pointer
+
+  attach_function :tess_get_utf8,
+                  'TessBaseAPIGetUTF8Text', %i[pointer int], :string
+  attach_function :tess_get_hocr,
+                  'TessBaseAPIGetHOCRText', %i[pointer int], :string
+
+  attach_function :tess_set_rectangle,
+                  'TessBaseAPISetRectangle', %i[pointer int int int int], :void
+  attach_function :tess_set_source_resolution,
+                  'TessBaseAPISetSourceResolution', %i[pointer int], :void
+  attach_function :tess_set_output_name, 'TessBaseAPISetOutputName', [:pointer], :void
+
+  attach_function :tess_print_to_file, 'TessBaseAPIPrintVariablesToFile', %i[pointer buffer_in], :bool
+
+  attach_function :tess_get_int_variable, 'TessBaseAPIGetIntVariable', [:pointer, :pointer, FFIIntPtr], :bool
+  attach_function :tess_get_double_variable, 'TessBaseAPIGetDoubleVariable', [:pointer, :pointer, FFIDoublePtr], :bool
+  attach_function :tess_set_variable, 'TessBaseAPISetVariable', %i[pointer pointer pointer], :bool
+  # GetVariableAsString not supported by C API
+  # attach_function :tess_get_variable_as_string, 'TessBaseAPIGetVariableAsString', [:pointer, :string, :pointer], :bool
+
+  attach_function :tess_get_init_languages_as_string, 'TessBaseAPIGetInitLanguagesAsString', [:pointer], :string
+  attach_function :tess_get_oem, 'TessBaseAPIOem', [:pointer], :int
+  attach_function :tess_get_datapath, 'TessBaseAPIGetDatapath', [:pointer], :pointer
+  attach_function :tess_pdf_renderer_create, 'TessPDFRendererCreate', %i[pointer pointer bool], :pointer
+  attach_function :tess_process_pages, 'TessBaseAPIProcessPages', %i[pointer pointer pointer int pointer], :bool
+end

data/lib/tesseract_ffi/conf_vars.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module TesseractFFI
+  # module ConfVars
+  module ConfVars
+    def get_double_variable(var_name)
+      d_ptr = TesseractFFI::FFIDoublePtr.new
+
+      unless tess_get_double_variable(@handle, var_name, d_ptr)
+        raise TessException.new(error_msg: 'Unable to get config variable ' + var_name)
+      end
+
+      d_ptr[:value]
+    end
+
+    def get_integer_variable(var_name)
+      i_ptr = TesseractFFI::FFIIntPtr.new
+
+      unless tess_get_int_variable(@handle, var_name, i_ptr)
+        raise TessException.new(error_msg: 'Unable to get config variable ' + var_name)
+      end
+
+      i_ptr[:value]
+    end
+
+    def set_variable(var_name, value)
+      mem_ptr = FFI::MemoryPointer.from_string(value.to_s)
+      unless tess_set_variable(@handle, var_name, mem_ptr)
+        raise TessException.new(error_msg: 'Unable to set config variable ' + var_name)
+      end
+
+      true
+    end
+
+    def print_variables_to_file(file_name)
+      result = tess_print_to_file(@handle, file_name)
+      raise TessException.new(error_msg: 'Unable to print variables to ' + file_name) unless result
+
+      result
+    end
+  end
+end

data/lib/tesseract_ffi/oem.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TesseractFFI
+  # module OEM
+  module OEM
+    def oem
+      ocr_engine_mode = nil
+      setup do
+        ocr_engine_mode = TesseractFFI.tess_get_oem(@handle)
+      end
+      ocr_engine_mode
+    end
+  end
+end

data/lib/tesseract_ffi/quick.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# module TesseractFFI Quick API
+module TesseractFFI
+  def self.to_text(file_name, language = 'eng')
+    t = Tesseract.new(file_name: file_name, language: language)
+    t.recognize
+    t.utf8_text
+  end
+
+  def self.to_pdf(in_file_name, out_file_root)
+    t = Tesseract.new(file_name: in_file_name)
+    t.convert_to_pdf(out_file_root)
+    t.utf8_text
+  end
+end

data/lib/tesseract_ffi/tess_exception.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TesseractFFI
+  # class TessException
+  class TessException < Gem::Exception
+    attr :error
+    def initialize(error_msg)
+      @error = error_msg
+    end
+  end
+end

data/lib/tesseract_ffi/tesseract.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module TesseractFFI
+  # class Tesseract
+  class Tesseract
+    include TesseractFFI
+    include ConfVars
+    include OEM
+
+    attr_accessor :language, :file_name, :source_resolution
+    attr_reader :utf8_text, :hocr_text, :errors
+
+    def initialize(file_name: nil, language: 'eng', source_resolution: 72, oem: DEFAULT)
+      @language = language
+      raise TessException.new(error_msg: 'file_name must be provided') unless file_name
+
+      raise TessException.new(error_msg: "File #{file_name} not found") unless File.exist? file_name
+
+      @file_name = file_name
+      @source_resolution = source_resolution
+      @oem = oem
+      @errors = []
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def setup
+      @handle = tess_create
+      raise TessException.new(error_msg: 'Library Error') unless @handle
+
+      result = tess_init(@handle, 0, @language, @oem)
+      raise TessException.new(error_msg: 'Init Error') if result != 0
+
+      @image = tess_pix_read(@file_name)
+      image_status = tess_set_image(@handle, @image)
+      raise TessException.new(error_msg: "Unable to set image #{@file_name}") if image_status != 0
+
+      yield # run the block for recognition etc
+    rescue TessException => e
+      @errors << "Tesseract Error #{e.error[:error_msg]}"
+      raise
+    ensure
+      tess_end(@handle)
+      tess_delete(@handle)
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def ocr
+      tess_set_source_resolution(@handle, @source_resolution)
+      raise TessException.new(error_msg: 'Recognition Error') if tess_recognize(@handle, 0) != 0
+
+      @utf8_text = ''
+      text = tess_get_utf8(@handle, 0)
+      @utf8_text = text.encode('UTF-8') if text
+      @hocr_text = tess_get_hocr(@handle, 0)
+    end
+
+    def recognize
+      setup do
+        ocr
+      end
+    end
+
+    def convert_to_pdf(output_stem)
+      setup do
+        datapath = TesseractFFI.tess_get_datapath(@handle)
+        pdf_renderer = TesseractFFI.tess_pdf_renderer_create(output_stem, datapath, false)
+        TesseractFFI.tess_process_pages(@handle, @file_name, nil, 5000, pdf_renderer)
+      end
+    end
+
+    def set_rectangle(x_coord, y_coord, width, height)
+      tess_set_rectangle(@handle, x_coord, y_coord, width, height)
+    end
+
+    def recognize_rectangle(x_coord, y_coord, width, height)
+      setup do
+        set_rectangle(x_coord, y_coord, width, height)
+        ocr
+      end
+    end
+
+    def recognize_rectangles(rectangle_list)
+      texts = []
+      setup do
+        rectangle_list.each do |r|
+          set_rectangle(r[0], r[1], r[2], r[3])
+          ocr
+          texts << @utf8_text.strip
+        end
+      end
+      texts
+    end
+  end
+end

data/lib/tesseract_ffi/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# module with version
+module TesseractFFI
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: tesseract_ffi
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- David Verrier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+description: This wrapper around the C-API allows use of the legacy modes of the recognition
+  engine.
+email:
+- dverrier@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/bonjour.rb
+- examples/low_level_pdf.rb
+- examples/low_level_recognition.rb
+- examples/two_rectangles.rb
+- lib/tesseract_ffi.rb
+- lib/tesseract_ffi/conf_vars.rb
+- lib/tesseract_ffi/oem.rb
+- lib/tesseract_ffi/quick.rb
+- lib/tesseract_ffi/tess_exception.rb
+- lib/tesseract_ffi/tesseract.rb
+- lib/tesseract_ffi/version.rb
+- tmp/keep.txt
+homepage: https://github.com/dverrier/tesseract_ffi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dverrier/tesseract_ffi
+  source_code_uri: https://github.com/dverrier/tesseract_ffi
+  changelog_uri: https://github.com/dverrier/tesseract_ffi
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This is a Ruby-wrapper around the Tesseract C-API.
+test_files: []