chiark / gitweb /
New Word dictionary and new disambiguation algorithm
[ypp-sc-tools.db-test.git] / pctb / ocr.c
index 87bf808..f610445 100644 (file)
 /*
-  */
+ * Core OCR algorithm (first exact bitmap match)
+ */
+/*
+ *  This is part of ypp-sc-tools, a set of third-party tools for assisting
+ *  players of Yohoho Puzzle Pirates.
+ * 
+ *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ * 
+ *  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/>.
+ * 
+ *  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+ *  are used without permission.  This program is not endorsed or
+ *  sponsored by Three Rings.
+ */
 
 #include "ocr.h"
+#include "convert.h"
 
 typedef struct {
   Pixcol col;
-  struct OCRDatabaseNode *then;
-} OCRDatabaseLink;
-
-#define MAXGLYPHCHRS 3
+  struct DatabaseNode *then;
+} DatabaseLink;
 
-typedef struct OCRDatabaseNode {
-  char s[MAXGLYPHCHRS+1]; /* null-terminated; "" means no match here */
+typedef struct DatabaseNode {
+  char *str;
   int nlinks, alinks;
-  OCRDatabaseLink *links;
-} OCRDatabaseNode;
+  unsigned match:1, defined:1, endsword:1;
+  DatabaseLink *links;
+} DatabaseNode;
+
+typedef struct {
+  OcrReader *rd;
+  OcrCellType ct;
+  int w;
+  Pixcol *cols;
+  int x;
+  unsigned ctxmap;
+} FindCharArgs;
+typedef struct {
+  DatabaseNode *match;
+  int rx;
+} FindCharResults;
+
+enum { ct_Lower, ct_Upper, ct_Word, ct_Digit };
+static const char *context_names[]= {
+  "Lower",  /*  bit 0, value 001 */
+  "Upper",  /*  bit 1, value 002 */
+  "Word",   /*  bit 2, value 004 */
+  "Digit",  /*  bit 3, value 010 */
+};
+struct OcrCellTypeInfo {
+  /* bitmaps of indices into context_names: */
+  unsigned initial, nextword, midword;
+  int space_spaces;
+  const char *name;
+  int (*findchar_select)(const FindCharArgs *fca,
+                        const FindCharResults results[]);
+};
+
+#define NCONTEXTS (sizeof(context_names)/sizeof(context_names[0]))
+
+struct OcrReader {
+  int h;
+  DatabaseNode contexts[NCONTEXTS];
+  OcrResultGlyph *results;
+  int aresults, nresults;
+};
+
+DEBUG_DEFINE_DEBUGF(ocr)
 
-#define N_OCR_CONTEXTS 2
+#define FGETSLINE (dbfile_getsline(lbuf,sizeof(lbuf),__FILE__,__LINE__))
 
-static OCRDatabaseNode ocr_contexts[N_OCR_CONTEXTS];
-static FILE *db;
-static OcrResultGlyph *results;
-static int aresults, nresults;
+static void cleardb_node(DatabaseNode *n) {
+  int i;
+  free(n->str); n->str=0;
+  n->defined=n->match=n->endsword= 0;
+  for (i=0; i<n->nlinks; i++)
+    cleardb_node(n->links[i].then);
+}
+
+static void readdb1(OcrReader *rd, const char *which);
 
-static FILE *resolver;
-static pid_t resolver_pid;
+static void readdb(OcrReader *rd) {
+  int ctxi;
+  
+  for (ctxi=0; ctxi<NCONTEXTS; ctxi++)
+    cleardb_node(&rd->contexts[ctxi]);
+
+  readdb1(rd, "master");
+  readdb1(rd, "local");
+}
 
-static void ocr_readdb(void) {
-  int ctx,nchrs;
-  OCRDatabaseNode *current, *additional;
-  char chrs[MAXGLYPHCHRS+1];
+static void readdb1(OcrReader *rd, const char *which) {
+  int nchrs;
+  DatabaseNode *current, *additional;
+  char chrs[100];
   Pixcol cv;
-  int r,i,j;
+  int j,ctxi;
+  int h, endsword;
+  char lbuf[100];
 
-  assert(!db);
-  db= fopen("database","r");  eassert(db);
+  char *dbfname= masprintf("%s/#%s-char%d#.txt",
+                          get_vardir(), which, rd->h);
+  
+  if (!dbfile_open(dbfname))
+    goto x;
+
+  FGETSLINE;
+  dbassert(!strcmp(lbuf,"# ypp-sc-tools pctb font v1"));
+
+  dbassert( dbfile_scanf("%d", &h) == 1);
+  dbassert(h==rd->h);
 
   for (;;) {
-    r= fscanf(db, "%d %d", &ctx, &nchrs);
-    if (r==EOF) break;
-    eassert(r==2);
-    eassert(ctx>=0 && ctx<N_OCR_CONTEXTS);
-    eassert(nchrs>0 && nchrs<=MAXGLYPHCHRS);
-
-    for (i=0; i<nchrs; i++) {
-      int c;
-      r= fscanf(db, "%x", &c);  eassert(r==1);
-      eassert(c>0 && c<=255);
-      chrs[i]= c;
+    FGETSLINE;
+    if (!lbuf[0] || lbuf[0]=='#') continue;
+    if (!strcmp(lbuf,".")) break;
+
+    for (ctxi=0; ctxi<NCONTEXTS; ctxi++)
+      if (!strcmp(lbuf,context_names[ctxi]))
+       goto found_ctx;
+    /* not found, just skip */
+    for (;;) { FGETSLINE; if (!lbuf[0]) break; }
+    continue;
+
+  found_ctx:
+    for (nchrs=0;;) {
+      int c= fgetc(dbfile); sysassert(!ferror(dbfile)); dbassert(c!=EOF);
+      if (c=='\n') break; /* forces no match */
+      dbassert(nchrs<sizeof(chrs));
+      chrs[nchrs++]= c;
+    }
+    endsword= 0;
+    if (nchrs>0 && chrs[nchrs-1]==' ') {
+      endsword= 1;
+      nchrs--;
     }
-    chrs[nchrs]= 0;
 
-    int twidth;
-    r= fscanf(db, "%d", &twidth);  eassert(r==1);
-    current= &ocr_contexts[ctx];
-    for (i=0; i<twidth; i++) {
-      r= fscanf(db, "%"PSPIXCOL(SCNx), &cv);  eassert(r==1);
+    current= &rd->contexts[ctxi];
+    for (;;) {
+      FGETSLINE;
+      if (!lbuf[0]) { dbassert(current != &rd->contexts[ctxi]); break; }
+      char *ep;
+      cv= strtoul(lbuf,&ep,16);  dbassert(!*ep);
+      dbassert(!(cv & ~((1UL << rd->h)-1)));
+      
       for (j=0; j<current->nlinks; j++)
        if (current->links[j].col == cv) {
          current= current->links[j].then;
          goto found_link;
        }
 
-      additional= malloc(sizeof(*additional)); eassert(additional);
-      additional->s[0]= 0;
+      additional= mmalloc(sizeof(*additional));
+      additional->str= 0;
+      additional->defined= 0;
+      additional->match= 0;
+      additional->endsword= 0;
       additional->nlinks= additional->alinks= 0;
       additional->links= 0;
       if (current->nlinks==current->alinks) {
        current->alinks++;
        current->alinks<<=1;
-       current->links= realloc(current->links,
-            sizeof(*current->links) * current->alinks);
-       eassert(current->links);
+       current->links= mrealloc(current->links,
+                                sizeof(*current->links) * current->alinks);
       }
       current->links[current->nlinks].col= cv;
       current->links[current->nlinks].then= additional;
@@ -81,36 +183,60 @@ static void ocr_readdb(void) {
     found_link:;
     }
 
-    eassert(!current->s[0]);
-    strcpy(current->s, chrs);
+    if (!current->defined) {
+      free(current->str);
+      current->str= 0;
+      current->defined= 1;
+      current->match= 0;
+
+      if (nchrs) {
+       current->str= mmalloc(nchrs+1);
+       memcpy(current->str, chrs, nchrs);
+       current->str[nchrs]= 0;
+       current->match= 1;
+       current->endsword= endsword;
+      }
+    }
   }
-  eassert(!ferror(db));
-  eassert(feof(db));
-}      
+ x:
+  dbfile_close();
+  free(dbfname);
+}
 
-static void callout_unknown(int w, int h, Pixcol cols[], int unk_l, int unk_r,
-                           const OcrResultGlyph *sofar, int nsofar) {
-  int pfd[2], c, r,i, x,y;
+static void cu_pr_ctxmap(FILE *resolver, unsigned ctxmap) {
+  fprintf(resolver,"{");
+  const char *spc="";
+  int ctxi;
+  for (ctxi=0; ctxi<NCONTEXTS; ctxi++) {
+    if (!(ctxmap & (1u << ctxi))) continue;
+    fprintf(resolver,"%s%s",spc,context_names[ctxi]);
+    spc=" ";
+  }
+  fprintf(resolver,"}");
+}
+
+static void callout_unknown(OcrReader *rd, int w, Pixcol cols[],
+                           int unk_l, int unk_r, unsigned unk_ctxmap) {
+  int c,i, x,y;
   const OcrResultGlyph *s;
   const char *p;
   Pixcol pv;
+
+  FILE *resolver= resolve_start();
+  if (!resolver)
+    fatal("OCR failed - unrecognised characters or ligatures.\n"
+         "Character set database needs to be updated or augmented.\n"
+         "See README.charset.\n");
   
-  if (!resolver) {
-    r= pipe(pfd);  eassert(!r);
-    resolver_pid= fork();
-    eassert(resolver_pid!=-1);
-    if (!resolver_pid) {
-      r= dup2(pfd[0],0); eassert(!r);
-      r= close(pfd[1]); eassert(!r);
-      execlp("./show-thing.tcl", "./show-thing.tcl",(char*)0);
-      eassert(!"execlp failed");
-    }
-    r= close(pfd[0]); eassert(!r);
-    resolver= fdopen(pfd[1],"w"); eassert(resolver);
-  }
-  fprintf(resolver,"%d %d",unk_l,unk_r);
-  for (i=0, s=sofar; i<nsofar; i++, s++) {
-    fprintf(resolver," %d %d %d ",s->l,s->r,s->ctx);
+  fprintf(resolver,
+         "char\n"
+         "%d %d ",unk_l,unk_r);
+  cu_pr_ctxmap(resolver,unk_ctxmap);
+  for (i=0, s=rd->results; i<rd->nresults; i++, s++) {
+    if (!strcmp(s->s," ")) continue;
+    fprintf(resolver," %d %d ",s->l,s->r);
+    cu_pr_ctxmap(resolver,s->ctxmap);
+    fprintf(resolver," ");
     for (p=s->s; (c= *p); p++) {
       if (c=='\\') fprintf(resolver,"\\%c",c);
       else if (c>=33 && c<=126) fputc(c,resolver);
@@ -126,72 +252,150 @@ static void callout_unknown(int w, int h, Pixcol cols[], int unk_l, int unk_r,
          "\"%d %d 2 1\",\n"
          "\"  c black\",\n"
          "\"o c white\",\n",
-         w,h);
-  for (y=0, pv=1; y<h; y++, pv<<=1) {
+         w,rd->h);
+  for (y=0, pv=1; y<rd->h; y++, pv<<=1) {
     fputc('"',resolver);
     for (x=0; x<w; x++)
       fputc(cols[x] & pv ? 'o' : ' ', resolver);
     fputs("\",\n",resolver);
   }
   fputs("};\n",resolver);
-  eassert(!ferror(resolver));
-  eassert(!fflush(resolver));
+
+  resolve_finish();
+  readdb(rd);
+}
+
+static void add_result(OcrReader *rd, const char *s, int l, int r,
+                      unsigned ctxmap) {
+  if (rd->nresults >= rd->aresults) {
+    rd->aresults++; rd->aresults<<=1;
+    rd->results= mrealloc(rd->results, sizeof(*rd->results)*rd->aresults);
+  }
+  rd->results[rd->nresults].s= s;
+  rd->results[rd->nresults].l= l;
+  rd->results[rd->nresults].r= r;
+  rd->results[rd->nresults].ctxmap= ctxmap;
+  rd->nresults++;
+}
+
+
+static DatabaseNode *findchar_1ctx(const FindCharArgs *fca,
+                                  DatabaseNode *start, int *matchx_r) {
+  DatabaseNode *current= start;
+  DatabaseNode *bestmatch= 0;
+  int i;
+  int x= fca->x;
 
   for (;;) {
-    eassert(resolver);
-    pid_t pid= waitpid(resolver_pid, &r, WUNTRACED);
-    if (pid==-1) { eassert(errno==EINTR); continue; }
-    eassert(pid==resolver_pid);
-    if (WIFEXITED(r)) {
-      eassert(!WEXITSTATUS(r));
-      fclose(resolver);
-      resolver= 0;
-    } else if (WIFSTOPPED(r)) {
-      r= kill(resolver_pid,SIGCONT);
-      eassert(!r);
-    } else if (WIFSIGNALED(r)) {
-      eassert(!"resolver child died due to signal");
+    debug_flush();
+    debugf(" | x=%d",x);
+    if (x > fca->w) break;
+    Pixcol cv= fca->cols[x];
+    debugf(" cv=%"PSPIXCOL(PRIx),cv);
+    for (i=0; i<current->nlinks; i++)
+      if (current->links[i].col == cv)
+       goto found;
+    /* not found */
+    debugf(" ?");
+    break;
+
+  found:
+    current= current->links[i].then;
+    if (current->match) {
+      debugf(" \"%s\"%s",current->str,current->endsword?"_":"");
+      bestmatch= current;
+      *matchx_r= x;
     } else {
-      eassert(!"weird wait status");
+      debugf(" ...");
     }
-    struct stat stab, fstab;
-    r= stat("database",&stab);  eassert(!r);
-    r= fstat(fileno(db),&fstab);  eassert(!r);
-    if (stab.st_ino != fstab.st_ino ||
-       stab.st_dev != fstab.st_dev)
-      break;
+
+    x++;
   }
-  fclose(db);
-  db= 0;
-  ocr_readdb();
-}
+  return bestmatch;
+}  
 
-static void add_result(const char *s, int l, int r, int ctx) {
-  if (nresults >= aresults) {
-    aresults++; aresults<<=1;
-    results= realloc(results,sizeof(*results)*aresults);
-    eassert(results);
+static DatabaseNode *findchar(const FindCharArgs *fca, int *match_rx) {
+  FindCharResults results[NCONTEXTS];
+  int ctxi, match=-1, nmatches=0;
+
+  debugf("OCR  lx=%d ct_state=%x  ", fca->x, fca->ctxmap);
+  for (ctxi=0; ctxi<NCONTEXTS; ctxi++) {
+    results[ctxi].match= 0;
+    if (!(fca->ctxmap & (1u << ctxi))) continue;
+    debugf(" || %s",context_names[ctxi]);
+
+    results[ctxi].match= findchar_1ctx(fca, &fca->rd->contexts[ctxi],
+                                      &results[ctxi].rx);
+    if (!results[ctxi].match) continue;
+
+    match= ctxi;
+    nmatches++;
+  }
+  if (nmatches==1) {
+    debugf(" unique");
+  } else {
+    debugf(" ambiguous");
+    match= !fca->ct->findchar_select ? -1 :
+      fca->ct->findchar_select(fca,results);
+    debugf(" resolved %s", match<0 ? "<none>" : context_names[match]);
   }
-  results[nresults].s= s;
-  results[nresults].l= l;
-  results[nresults].r= r;
-  results[nresults].ctx= ctx;
-  nresults++;
+  if (match<0)
+    return 0;
+  
+  *match_rx= results[ctxi].rx;
+  return results[ctxi].match;
 }
 
-OcrResultGlyph *ocr(int w, int h, Pixcol cols[]) {
-  int nspaces=0;
-  int ctx=1,i, x;
+static int findchar_select_text(const FindCharArgs *fca,
+                               const FindCharResults results[]) {
+  if (fca->ctxmap != 017) return -1;
+
+  dbassert(! results[ct_Digit].match );
+  if (results[ct_Word].match) return ct_Word;
+  if (results[ct_Lower].rx > results[ct_Upper].rx) return ct_Lower;
+  if (results[ct_Upper].rx > results[ct_Lower].rx) return ct_Upper;
+  return -1;
+}
 
-  nresults=0;
-  assert(db);
+const struct OcrCellTypeInfo ocr_celltype_number= {
+  010,010,010,
+  .space_spaces= 5,
+  .name= "number",
+  .findchar_select= 0
+};
+const struct OcrCellTypeInfo ocr_celltype_text= {
+  .initial=  012, /* Digit|Upper */
+  .nextword= 017, /* Digit|Upper|Lower|Word */
+  .midword=  014, /* Digit|Lower */
+  .space_spaces= 4,
+  .name= "text",
+  .findchar_select= findchar_select_text
+};
 
-  fprintf(debug,"OCR h=%d w=%d",w,h);
-  for (x=0; x<w; x++) fprintf(debug," %"PSPIXCOL(PRIx),cols[x]);
-  fprintf(debug,"\n");
-  debug_flush();
+
+const char *ocr_celltype_name(OcrCellType ct) { return ct->name; }
+
+OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
+  int nspaces;
+  int x;
+
+  FindCharArgs fca;
+  fca.rd= rd;
+  fca.ct= ct;
+  fca.w= w;
+  fca.cols= cols;
+  fca.x= -1;
 
  restart:
+
+  nspaces=- w;
+  fca.ctxmap= ct->initial;
+  rd->nresults=0;
+  debugf("OCR h=%d w=%d",rd->h,w);
+  for (x=0; x<w; x++) debugf(" %"PSPIXCOL(PRIx),cols[x]);
+  debugf("\n");
+  debug_flush();
+
   x=0;
   for (;;) {
     debug_flush();
@@ -202,62 +406,65 @@ OcrResultGlyph *ocr(int w, int h, Pixcol cols[]) {
     if (!cols[x]) {
       nspaces++;
       x++;
-      if (nspaces>3) ctx=1;
+      if (nspaces == ct->space_spaces) {
+       debugf("OCR  x=%x nspaces=%d space\n",x,nspaces);
+       fca.ctxmap= ct->nextword;
+      }
       continue;
     }
 
-    /* find character */
-    OCRDatabaseNode *current=0, *bestmatch=0;
-    int lx=x;
-    int bestmatch_rx=-1;
-    current= &ocr_contexts[ctx];
-    fprintf(debug,"OCR  lx=%d ctx=%d  ",lx,ctx);
+    /* something here, so we need to add the spaces */
+    if (nspaces >= ct->space_spaces)
+      add_result(rd," ",x-nspaces,x+1,0);
+    nspaces=0;
 
-    for (;;) {
-      debug_flush();
-      fprintf(debug,"| x=%d",x);
-      if (x>w) break;
-      Pixcol cv= cols[x];
-      fprintf(debug," cv=%"PSPIXCOL(PRIx),x);
-      for (i=0; i<current->nlinks; i++)
-       if (current->links[i].col == cv)
-         goto found;
-      /* not found */
-      fprintf(debug," ?");
-      break;
+    fca.x= x;
 
-    found:
-      current= current->links[i].then;
-      if (current->s[0]) {
-       fprintf(debug," \"%s\"",current->s);
-       bestmatch=current; bestmatch_rx=x;
-      } else {
-       fprintf(debug," ...");
+    int match_rx=-1;
+    DatabaseNode *match= findchar(&fca, &match_rx);
+    
+    if (match) {
+      debugf(" || YES");
+      add_result(rd, match->str, x, match_rx, fca.ctxmap);
+      x= match_rx+1;
+      if (match->match) fca.ctxmap= ct->midword;
+      else debugf(" (empty)");
+      if (match->endsword) {
+       nspaces= ct->space_spaces;
+       debugf("_");
+       fca.ctxmap= ct->nextword;
       }
-      x++;
-    }
-
-    if (bestmatch) {
-      fprintf(debug," YES\n");
-      add_result(bestmatch->s, lx, bestmatch_rx, ctx);
-      x= bestmatch_rx+1;
-      ctx= 0;
+      debugf("\n");
     } else {
       int rx;
-      fprintf(debug," UNKNOWN");
-      for (rx=lx+1; rx<w && cols[rx]; rx++);
-      fprintf(debug," x=%d ctx=%d %d..%d\n",x, ctx, lx,rx);
+      debugf(" || UNKNOWN");
+      for (rx=x; rx<w && cols[rx]; rx++);
+      debugf(" x=%d ctxmap=%x %d..%d\n",x, fca.ctxmap, x,rx);
       debug_flush();
-      callout_unknown(w,h,cols, lx,rx, results,nresults);
+      callout_unknown(rd, w,cols, x,rx-1, fca.ctxmap);
       goto restart;
     }
+
   }
-  add_result(0,-1,-1,0);
-  fprintf(debug,"OCR  finished %d glyphs\n",nresults);
+  add_result(rd, 0,-1,-1,0);
+  debugf("OCR  finished %d glyphs\n",rd->nresults);
   debug_flush();
-  return results;
+  return rd->results;
 }
 
-void ocr_init(void) {
-  ocr_readdb();
+OcrReader *ocr_init(int h) {
+  OcrReader *rd;
+
+  if (o_flags & ff_dict_fetch) {
+    char *fetchfile= masprintf("char%d",h);
+    progress("Updating %s...",fetchfile);
+    fetch_with_rsync(fetchfile);
+    free(fetchfile);
+  }
+
+  rd= mmalloc(sizeof(*rd));
+  memset(rd,0,sizeof(*rd));
+  rd->h= h;
+  readdb(rd);
+  return rd;
 }