libhocr-dev 0.10.17-1 / usr / include / libhocr / hocrpp.h

/***************************************************************************
 *            hocrpp.h
 *
 *  Fri Aug 12 20:13:33 2005
 *  Copyright  2005-2007, 2008  Yaacov Zamir
 *  <kzamir@walla.co.il>
 ****************************************************************************/

/*  
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/** @file hocrpp.h
    @brief libhocr main C++ language header.
    
    libhocr - LIBrary for Hebrew Optical Character Recognition 
*/

#ifndef HOCRPP_H
#define HOCRPP_H

#include <hocr.h>

/**
 @brief the libhocr namespace.

 namespace for Hebrew Optical Character Recognition 
 */
namespace hocr
{

  /**
   @brief Hocr class.
	
   class for Hebrew Optical Character Recognition 
   */
  class Hocr;

  /**
   @brief Hocr class.
	
   class for Hebrew Optical Character Recognition 
   */
  class Hocr
  {

  public:

    /**
     @brief Hocr constructor.
     */
    Hocr (ho_pixbuf * m_in = NULL)
    {
      /* set pixbuf */
      m_pix_orig = m_in;

      /* lock free pointers */
      m_bit_bw = NULL;
      page_layout = NULL;
      text_out = NULL;

      /* set defaults */
      scale = 0;
      no_auto_scale = 0;
      rotate = 0;
      no_auto_rotate = 0;
      adaptive = 0;
      threshold = 0;
      a_threshold = 0;

      dir_ltr = 0;
      font_spacing_code = 0;
      paragraph_setup = 0;
      slicing_threshold = 0;
      slicing_width = 0;
      line_leeway = 0;

      font_code = 0;
      html = 0;
      nikud = 1;
      do_linguistics = 0;
      
      /* init progress */
      progress = 0;
    }

    /**
     @brief Hocr destructor.
     */
     ~Hocr ()
    {
      if (m_pix_orig)
        ho_pixbuf_free (m_pix_orig);
      if (m_bit_bw)
        ho_bitmap_free (m_bit_bw);
      if (page_layout)
        ho_layout_free (page_layout);
      if (text_out)
        ho_string_free (text_out);
    }

    /**
     @brief set pixbuf
    
     @param m_in the pixbuf to use
     @return 0
     */
    int set_pixbuf (ho_pixbuf * m_in)
    {
      /* free existing data if present */
      if (m_pix_orig)
        ho_pixbuf_free (m_pix_orig);
      if (m_bit_bw)
        ho_bitmap_free (m_bit_bw);
      if (page_layout)
        ho_layout_free (page_layout);
      if (text_out)
        ho_string_free (text_out);

      /* create a new data based on the new image */
      m_pix_orig = m_in;
      m_bit_bw = NULL;
      page_layout = NULL;
      text_out = NULL;

      progress = 0;

      return 0;
    }

    /**
     @brief set b/w bitmap
    
     @param m_in the b/w bitmap to use
     @return 0
     */
    int set_bitmap (ho_bitmap * m_in)
    {
      /* free existing data if present */
      if (m_pix_orig)
        ho_pixbuf_free (m_pix_orig);
      if (m_bit_bw)
        ho_bitmap_free (m_bit_bw);
      if (page_layout)
        ho_layout_free (page_layout);
      if (text_out)
        ho_string_free (text_out);

      /* create a new data based on the new image */
      m_pix_orig = NULL;
      m_bit_bw = m_in;
      page_layout = NULL;
      text_out = NULL;

      progress = 0;

      return 0;
    }

    /**
     @brief get pixbuf
    
     @return the object pixbuf
     */
    ho_pixbuf *get_pixbuf ()
    {
      return m_pix_orig;
    }

    /**
     @brief get bitmap
    
     @return the object bitmap
     */
    ho_bitmap *get_bitmap ()
    {
      return m_bit_bw;
    }

    /**
     @brief save bitmap as pnm
    
     @param filename the the image file name
     @return the object bitmap
     */
    int save_bitmap_as_pnm (const char *filename)
    {
      return ho_bitmap_pnm_save (m_bit_bw, filename);
    }
 
    /**
     @brief save bitmap as tiff (neads a tiff enabled libhocr)
     
     @param filename the the image file name
     @return the object bitmap
     */
    int save_bitmap_as_tiff (const char *filename)
    {
      return ho_bitmap_tiff_save (m_bit_bw, filename);
    }
      
    /**
     @brief get bitmap pixbuf
    
     @return a pixbuf of the object bitmap
     */
    ho_pixbuf *get_bitmap_pixbuf ()
    {
      ho_pixbuf *m_pix_tmp = NULL;
      ho_pixbuf *m_pix_out = NULL;

      if (!m_bit_bw)
        return NULL;

      m_pix_tmp = ho_pixbuf_new_from_bitmap (m_bit_bw);
      if (!m_pix_tmp)
        return NULL;
      
      m_pix_out = ho_pixbuf_to_rgb (m_pix_tmp);
      
      ho_pixbuf_free (m_pix_tmp);
      
      return m_pix_out;
    }

    /**
     @brief get layout pixbuf
    
     @return a pixbuf of the object layout
     */
    ho_pixbuf *get_layout_pixbuf ()
    {
      ho_pixbuf *m_pix_out = NULL;

      /* check if we have a layout and text */
      if (!page_layout || !m_bit_bw)
        return NULL;

      /* 
       * m_pix_out = ho_pixbuf_new_from_layout (layout, show_grid, text_bitmap,
       * block_frame_red, block_frame_green, block_frame_blue, block_frame_alfa,
       * block_frame_width, line_frame_red, line_frame_green, line_frame_blue,
       * line_frame_alfa, line_frame_width, word_frame_red, word_frame_green,
       * word_frame_blue, word_frame_alfa, word_frame_width, font_frame_red,
       * font_frame_green, font_frame_blue, font_frame_alfa, font_frame_width); */
      m_pix_out =
        ho_pixbuf_new_from_layout (page_layout, 0, m_bit_bw, 0, 0, 255, 150,
        5, 255, 0, 0, 255, 5, 255, 240, 0, 180, 255, 0, 250, 0, 235, 255);

      return m_pix_out;
    }

    /**
     @brief get text
     
     @return the recognized text
     */
    const char *get_text ()
    {
      /* do we have text ? */
      if (!text_out)
        return NULL;

      return text_out->string;
    }

    /**
     @brief get progress of ocr
     
     @return the progress 0..100
     */
    int get_progress ()
    {
      return progress;
    }

    /**
     @brief do image processing
    
     @return 0
     */
    int do_image_processing ()
    {
      if (!m_pix_orig)
        return 1;

      if (m_bit_bw)
      {
        ho_bitmap_free (m_bit_bw);
        m_bit_bw = NULL;
      }

      m_bit_bw = hocr_image_processing (m_pix_orig,
        scale,
        no_auto_scale,
        rotate, no_auto_rotate, adaptive, threshold, a_threshold, &progress);

      return 0;
    }

    /**
     @brief do bitmap closing
    
     @return 0
     */
    int do_bitmap_closing ()
    {
      ho_bitmap * m_bit_temp = NULL;
      
      if (!m_bit_bw)
        return 1;

      m_bit_temp = ho_bitmap_closing (m_bit_bw);
      if (!m_bit_temp)
        return 1;
      
      ho_bitmap_free (m_bit_bw);
      m_bit_bw = m_bit_temp;

      return 0;
    }
    
    /**
     @brief do bitmap opening
    
     @return 0
     */
    int do_bitmap_opening ()
    {
      ho_bitmap * m_bit_temp = NULL;
      
      if (!m_bit_bw)
        return 1;

      m_bit_temp = ho_bitmap_opening (m_bit_bw);
      if (!m_bit_temp)
        return 1;
      
      ho_bitmap_free (m_bit_bw);
      m_bit_bw = m_bit_temp;

      return 0;
    }
    
    /**
     @brief do bitmap erosion
    
     @return 0
     */
    int do_bitmap_erosion ()
    {
      ho_bitmap * m_bit_temp = NULL;
      
      if (!m_bit_bw)
        return 1;

      m_bit_temp = ho_bitmap_erosion (m_bit_bw);
      if (!m_bit_temp)
        return 1;
      
      ho_bitmap_free (m_bit_bw);
      m_bit_bw = m_bit_temp;

      return 0;
    }
    
    /**
     @brief do bitmap dilation
    
     @return 0
     */
    int do_bitmap_dilation ()
    {
      ho_bitmap * m_bit_temp = NULL;
      
      if (!m_bit_bw)
        return 1;

      m_bit_temp = ho_bitmap_dilation (m_bit_bw);
      if (!m_bit_temp)
        return 1;
      
      ho_bitmap_free (m_bit_bw);
      m_bit_bw = m_bit_temp;

      return 0;
    }
      
    /**
     @brief do layout analysis
    
     @return 0
     */
    int do_layout_analysis ()
    {
      if (!m_bit_bw)
        return 1;

      if (page_layout)
      {
        ho_layout_free (page_layout);
        page_layout = NULL;
      }

      page_layout = hocr_layout_analysis (m_bit_bw,
        font_spacing_code, paragraph_setup,
        slicing_threshold, slicing_width, line_leeway, dir_ltr, &progress);

      return 0;
    }

    /**
     @brief do font recognition
    
     @return 0
     */
    int do_font_recognition ()
    {
      if (!page_layout)
        return 1;

      if (text_out)
      {
        ho_string_free (text_out);
        text_out = NULL;
      }

      text_out = ho_string_new ();

      hocr_font_recognition (page_layout, text_out, html, font_code, nikud,
        do_linguistics, &progress);

      return 0;
    }

    /**
     @brief do ocr
    
     @return 0
     */
    int do_ocr ()
    {
      /* do all ocr stages */
      do_image_processing ();
      do_layout_analysis ();
      do_font_recognition ();

      return 0;
    }

    /**
     @brief get html param
    
     @return FALSE-no html in output, TRUE-output html text 
     */
    int get_html ()
    {
      return html;
    }

    /**
     @brief set html param
    
     @param html_in new value of html param
     @return FALSE-no html in output, TRUE-output html text 
     */
    int set_html (const unsigned char html_in)
    {
      html = html_in;

      return html;
    }

    /**
     @brief get font param
    
     @return font code of objct
     */
    int get_font ()
    {
      return font_code;
    }

    /**
     @brief set font param
    
     @param font_in new value of font param
     @return font code of objct
     */
    int set_font (const int font_in)
    {
      font_code = font_in;

      return font_code;
    }

    /**
     @brief get nikud param
    
     @return nikud of objct
     */
    unsigned char get_nikud ()
    {
      return nikud;
    }

    /**
     @brief set nikud param
    
     @param nikud_in new value of nikud param
     @return nikud of objct
     */
    unsigned char set_nikud (const unsigned char nikud_in)
    {
      nikud = nikud_in;

      return nikud;
    }
      
    /**
     @brief set dir_ltr param
    
     @param dir_ltr_in new value of dir_ltr param
     @return dir_ltr of objct
     */
    unsigned char set_dir_ltr (const unsigned char dir_ltr_in)
    {
      dir_ltr = dir_ltr_in;

      return dir_ltr;
    }

    /**
     @brief set scale param
    
     @param scale_in new value of scale param
     @return scale of objct
     */
    unsigned char set_scale (const unsigned char scale_in)
    {
      scale = scale_in;
      no_auto_scale = 1;
      
      return scale;
    }
      
    /**
     @brief set auto_scale param
    
     @return no_auto_scale of objct
     */
    unsigned char set_auto_scale ()
    {
      no_auto_scale = 0;
      
      return no_auto_scale;
    }
    
    /**
     @brief set adaptive param
    
     @param adaptive_in new value of adaptive param
     @return adaptive of objct
     */
    unsigned char set_adaptive (const unsigned char adaptive_in)
    {
      adaptive = adaptive_in;
      
      return adaptive;
    }
    
    /**
     @brief set threshold param
    
     @param threshold_in new value of threshold param
     @return threshold of objct
     */
    unsigned char set_threshold (const unsigned char threshold_in)
    {
      threshold = threshold_in;
      
      return threshold;
    }
    
    /**
     @brief set a_threshold param
    
     @param a_threshold_in new value of a_threshold param
     @return a_threshold of objct
     */
    unsigned char set_a_threshold (const unsigned char a_threshold_in)
    {
      a_threshold = a_threshold_in;
      
      return a_threshold;
    }
    
    /**
     @brief get font_spacing_code param
    
     @return font_spacing_code of objct
     */
    int get_font_spacing_code ()
    {
      return font_spacing_code;
    }
      
    /**
     @brief set font_spacing_code param
    
     @param font_spacing_code_in new value of font_spacing_code param
     @return font_spacing_code of objct
     */
    int set_font_spacing_code (const int font_spacing_code_in)
    {
      font_spacing_code = font_spacing_code_in;
      
      return font_spacing_code;
    }
    
    /**
     @brief get slicing_width param
    
     @return slicing_width of objct
     */
    int get_slicing_width ()
    {
      return slicing_width;
    }
      
    /**
     @brief set slicing_width param
    
     @param slicing_width_in new value of slicing_width param
     @return slicing_width of objct
     */
    int set_slicing_width (const int slicing_width_in)
    {
      slicing_width = slicing_width_in;
      
      return slicing_width;
    }
      
    /**
     @brief get slicing_threshold param
    
     @return slicing_threshold of objct
     */
    int get_slicing_threshold ()
    {
      return slicing_threshold;
    }
      
    /**
     @brief set slicing_threshold param
    
     @param slicing_threshold_in new value of slicing_threshold param
     @return slicing_threshold of objct
     */
    int set_slicing_threshold (const int slicing_threshold_in)
    {
      slicing_threshold = slicing_threshold_in;
      
      return slicing_threshold;
    }
      
    /**
     @brief set line_leeway param
    
     @param line_leeway_in new value of line_leeway param
     @return line_leeway of objct
     */
    int set_line_leeway (const int line_leeway_in)
    {
      line_leeway = line_leeway_in;
      
      return line_leeway;
    }
    
    /**
     @brief set no_auto_rotate
    
     @param no_auto_rotate_in new value of font_spacing_code param
     @return no_auto_rotate of objct
     */
    unsigned char set_no_auto_rotate (const unsigned char no_auto_rotate_in)
    {
      no_auto_rotate = no_auto_rotate_in;
      
      return no_auto_rotate;
    }
    
    /**
     @brief set do_linguistics
    
     @param do_linguistics_in new value of do_linguistics param
     @return do_linguistics of objct
     */
    unsigned char set_do_linguistics (const unsigned char do_linguistics_in)
    {
      do_linguistics = do_linguistics_in;
      
      return do_linguistics;
    }
      
    /**
     @brief get paragraph setup param
    
     @return paragraph setup
     */
    int get_paragraph_setup ()
    {
      return paragraph_setup;
    }

    /**
     @brief set paragraph setup param
    
     @param paragraph_setup_in new value of font param
     @return paragraph setup of objct
     */
    int set_paragraph_setup (const int paragraph_setup_in)
    {
      paragraph_setup = paragraph_setup_in;

      return paragraph_setup;
    }

    /**
     @brief get build string
    
     @return build string
     */
    const char *get_build_string ()
    {
      return hocr_get_build_string ();
    }

    int progress;               // this is public

  private:

    ho_pixbuf * m_pix_orig;
    ho_bitmap *m_bit_bw;
    ho_layout *page_layout;
    ho_string *text_out;

    unsigned char scale;
    unsigned char no_auto_scale;
    double rotate;
    unsigned char no_auto_rotate;
    unsigned char adaptive;
    unsigned char threshold;
    unsigned char a_threshold;

    unsigned char dir_ltr;
    int font_spacing_code;
    int paragraph_setup;
    int slicing_threshold;
    int slicing_width;
    int line_leeway;

    unsigned char nikud;
    unsigned char do_linguistics;
    int font_code;
    unsigned char html;
  };                            // class
}                               // name space

#endif /* HOCRPP_H */