chiark / gitweb /
cope better when POST limit exceeded
[ypp-sc-tools.web-live.git] / pctb / ocr.c
index 712f90d..2c3a167 100644 (file)
@@ -1,19 +1,42 @@
 /*
-  */
+ * 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 DatabaseNode *then;
 } DatabaseLink;
 
-#define MAXGLYPHCHRS 7
-
 typedef struct DatabaseNode {
-  char s[MAXGLYPHCHRS+1]; /* null-terminated; "" means no match here */
+  char *str;
   int nlinks, alinks;
-  unsigned endsword:1;
+  unsigned match:1, defined:1, endsword:1;
   DatabaseLink *links;
 } DatabaseNode;
 
@@ -22,10 +45,27 @@ static const char *context_names[]= {
   "Upper",
   "Digit"
 };
+struct OcrCellTypeInfo {
+  /* bitmaps of indices into context_names: */
+  unsigned initial, nextword, midword;
+  int space_spaces;
+  const char *name;
+};
+const struct OcrCellTypeInfo ocr_celltype_number= {
+  4,4,4,
+  .space_spaces= 5,
+  .name= "number"
+};
+const struct OcrCellTypeInfo ocr_celltype_text= {
+  .initial=2, /* Uppercase */
+  .nextword=3, /* Either */
+  .midword=1, /* Lower only */
+  .space_spaces= 4,
+  .name= "text"
+};
 
-#define NCONTEXTS (sizeof(context_names)/sizeof(context_names[0]))
 
-#define SPACE_SPACES 4
+#define NCONTEXTS (sizeof(context_names)/sizeof(context_names[0]))
 
 struct OcrReader {
   int h;
@@ -34,99 +74,83 @@ struct OcrReader {
   int aresults, nresults;
 };
 
-static FILE *resolver;
-static pid_t resolver_pid;
-static int resolver_done;
-
 DEBUG_DEFINE_DEBUGF(ocr)
 
-static void fgetsline(FILE *f, char *lbuf, size_t lbufsz) {
-  char *s= fgets(lbuf,lbufsz,f);
-  eassert(s);
-  int l= strlen(lbuf);
-  eassert(l>0);  eassert(lbuf[--l]='\n');
-  lbuf[l]= 0;
-}
-#define FGETSLINE(f,buf) (fgetsline(f,buf,sizeof(buf)))
+#define FGETSLINE (dbfile_getsline(lbuf,sizeof(lbuf),__FILE__,__LINE__))
 
 static void cleardb_node(DatabaseNode *n) {
   int i;
-  n->s[0]= 0;
+  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 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 readdb1(OcrReader *rd, const char *which) {
   int nchrs;
   DatabaseNode *current, *additional;
-  char chrs[MAXGLYPHCHRS+1];
+  char chrs[100];
   Pixcol cv;
-  int r,j,ctxi;
+  int j,ctxi;
   int h, endsword;
   char lbuf[100];
-  FILE *db;
 
-  for (ctxi=0; ctxi<NCONTEXTS; ctxi++)
-    cleardb_node(&rd->contexts[ctxi]);
-
-  char *dbfname=0;
-  asprintf(&dbfname,"%s/charset-%d.txt",get_vardir(),rd->h);
-  eassert(dbfname);
+  char *dbfname= masprintf("%s/#%s-char%d#.txt",
+                          get_vardir(), which, rd->h);
   
-  db= fopen(dbfname,"r");
-  free(dbfname);
-  if (!db) {
-    eassert(errno==ENOENT);
-    return;
-  }
+  if (!dbfile_open(dbfname))
+    goto x;
 
-  FGETSLINE(db,lbuf);
-  eassert(!strcmp(lbuf,"# ypp-sc-tools pctb font v1"));
+  FGETSLINE;
+  dbassert(!strcmp(lbuf,"# ypp-sc-tools pctb font v1"));
 
-  r= fscanf(db, "%d", &h);
-  eassert(r==1);
-  eassert(h==rd->h);
+  dbassert( dbfile_scanf("%d", &h) == 1);
+  dbassert(h==rd->h);
 
   for (;;) {
-    FGETSLINE(db,lbuf);
-    if (!lbuf || lbuf[0]=='#') continue;
+    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(db,lbuf); if (!lbuf[0]) break; }
+    for (;;) { FGETSLINE; if (!lbuf[0]) break; }
     continue;
 
   found_ctx:
     for (nchrs=0;;) {
-      int c= fgetc(db);  eassert(c!=EOF);
-      if (c=='\n') { eassert(nchrs); break; }
-      eassert(nchrs<MAXGLYPHCHRS);
-      if (c=='\\') {
-       unsigned cr;
-       c= fgetc(db);  eassert(c=='x');
-       r= fscanf(db, "%2x", &cr);  eassert(r==1);
-       assert(cr>0 && cr<=255);
-       c= cr;
-      }
+      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>1 && chrs[nchrs-1]==' ') {
+    if (nchrs>0 && chrs[nchrs-1]==' ') {
       endsword= 1;
       nchrs--;
     }
-    chrs[nchrs]= 0;
 
     current= &rd->contexts[ctxi];
     for (;;) {
-      FGETSLINE(db,lbuf);
-      if (!lbuf[0]) { eassert(current != &rd->contexts[ctxi]); break; }
+      FGETSLINE;
+      if (!lbuf[0]) { dbassert(current != &rd->contexts[ctxi]); break; }
       char *ep;
-      cv= strtoul(lbuf,&ep,16);  eassert(!*ep);
-      eassert(!(cv & ~((1UL << rd->h)-1)));
+      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) {
@@ -134,16 +158,18 @@ static void readdb(OcrReader *rd) {
          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;
@@ -153,15 +179,27 @@ static void readdb(OcrReader *rd) {
     found_link:;
     }
 
-    eassert(!current->s[0]);
-    strcpy(current->s, chrs);
-    current->endsword= endsword;
+    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(!fclose(db));
+ x:
+  dbfile_close();
+  free(dbfname);
 }
 
-static void cu_pr_ctxmap(unsigned ctxmap) {
+static void cu_pr_ctxmap(FILE *resolver, unsigned ctxmap) {
   fprintf(resolver,"{");
   const char *spc="";
   int ctxi;
@@ -175,41 +213,25 @@ static void cu_pr_ctxmap(unsigned ctxmap) {
 
 static void callout_unknown(OcrReader *rd, int w, Pixcol cols[],
                            int unk_l, int unk_r, unsigned unk_ctxmap) {
-  int jobpipe[2],donepipe[2], c, r,i, x,y;
+  int c,i, x,y;
   const OcrResultGlyph *s;
   const char *p;
-  char cb;
   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(jobpipe);  eassert(!r);
-    r= pipe(donepipe);  eassert(!r);
-    resolver_pid= fork();
-    eassert(resolver_pid!=-1);
-    if (!resolver_pid) {
-      r= dup2(jobpipe[0],0); eassert(r==0);
-      r= close(jobpipe[1]); eassert(!r);
-      r= close(donepipe[0]); eassert(!r);
-      /* we know donepipe[1] is >= 4 and we have dealt with all the others
-       * so we aren't in any danger of overwriting some other fd 4: */
-      r= dup2(donepipe[1],4); eassert(r==4);
-      execlp("./show-thing.tcl", "./show-thing.tcl",
-            DEBUGP(callout) ? "--debug" : "--noop-arg",
-            "--automatic-1",
-            (char*)0);
-      eassert(!"execlp failed");
-    }
-    r= close(jobpipe[0]); eassert(!r);
-    r= close(donepipe[1]); eassert(!r);
-    resolver= fdopen(jobpipe[1],"w"); eassert(resolver);
-    resolver_done= donepipe[0];
-  }
-  fprintf(resolver,"%d %d ",unk_l,unk_r);
-  cu_pr_ctxmap(unk_ctxmap);
+  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(s->ctxmap);
+    cu_pr_ctxmap(resolver,s->ctxmap);
     fprintf(resolver," ");
     for (p=s->s; (c= *p); p++) {
       if (c=='\\') fprintf(resolver,"\\%c",c);
@@ -234,40 +256,8 @@ static void callout_unknown(OcrReader *rd, int w, Pixcol cols[],
     fputs("\",\n",resolver);
   }
   fputs("};\n",resolver);
-  eassert(!ferror(resolver));
-  eassert(!fflush(resolver));
-
-  eassert(resolver);
-
-  for (;;) {
-    r= read(resolver_done,&cb,1);
-    if (r==-1) { eassert(errno==EINTR); continue; }
-    break;
-  }
-
-  if (r==0) {
-    pid_t pid;
-    for (;;) {
-      pid= waitpid(resolver_pid, &r, 0);
-      if (pid==-1) { eassert(errno==EINTR); continue; }
-      break;
-    }
-    eassert(pid==resolver_pid);
-    if (WIFEXITED(r)) {
-      eassert(!WEXITSTATUS(r));
-      fclose(resolver);
-      close(resolver_done);
-      resolver= 0;
-    } else if (WIFSIGNALED(r)) {
-      eassert(!"resolver child died due to signal");
-    } else {
-      eassert(!"weird wait status");
-    }
-  } else {
-    eassert(r==1);
-    eassert(cb==0);
-  }
 
+  resolve_finish();
   readdb(rd);
 }
 
@@ -275,8 +265,7 @@ 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= realloc(rd->results,sizeof(*rd->results)*rd->aresults);
-    eassert(rd->results);
+    rd->results= mrealloc(rd->results, sizeof(*rd->results)*rd->aresults);
   }
   rd->results[rd->nresults].s= s;
   rd->results[rd->nresults].l= l;
@@ -285,17 +274,8 @@ static void add_result(OcrReader *rd, const char *s, int l, int r,
   rd->nresults++;
 }
 
-struct OcrCellTypeInfo {
-  unsigned initial, nextword, midword;
-};
-const struct OcrCellTypeInfo ocr_celltype_number= {
-  4,4,4
-};
-const struct OcrCellTypeInfo ocr_celltype_text= {
-  .initial=2 /* Uppercase */,
-  .nextword=3 /* Either */,
-  .midword=1 /* Lower only */
-};
+
+const char *ocr_celltype_name(OcrCellType ct) { return ct->name; }
 
 OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
   int nspaces;
@@ -322,7 +302,7 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
     if (!cols[x]) {
       nspaces++;
       x++;
-      if (nspaces==SPACE_SPACES) {
+      if (nspaces == ct->space_spaces) {
        debugf("OCR  x=%x nspaces=%d space\n",x,nspaces);
        ctxmap= ct->nextword;
       }
@@ -330,7 +310,7 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
     }
 
     /* something here, so we need to add the spaces */
-    if (nspaces>=SPACE_SPACES)
+    if (nspaces >= ct->space_spaces)
       add_result(rd," ",x-nspaces,x+1,0);
     nspaces=0;
 
@@ -366,8 +346,8 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
 
       found:
        current= current->links[i].then;
-       if (current->s[0]) {
-         debugf(" \"%s\"%s",current->s,current->endsword?"_":"");
+       if (current->match) {
+         debugf(" \"%s\"%s",current->str,current->endsword?"_":"");
          bestmatch= current;
          bestmatch_rx= x;
        } else {
@@ -378,7 +358,7 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
       }
       
       if (bestmatch) {
-       if (uniquematch && strcmp(bestmatch->s, uniquematch->s)) {
+       if (uniquematch && strcmp(bestmatch->str, uniquematch->str)) {
          debugf( " ambiguous");
          uniquematch= 0;
          break;
@@ -390,12 +370,12 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
 
     if (uniquematch) {
       debugf(" || YES");
-      add_result(rd, uniquematch->s, lx, uniquematch_rx, ctxmap);
+      add_result(rd, uniquematch->str, lx, uniquematch_rx, ctxmap);
       x= uniquematch_rx+1;
-      if (uniquematch->s[0]) ctxmap= ct->midword;
+      if (uniquematch->match) ctxmap= ct->midword;
       else debugf(" (empty)");
       if (uniquematch->endsword) {
-       nspaces= SPACE_SPACES;
+       nspaces= ct->space_spaces;
        debugf("_");
        ctxmap= ct->nextword;
       }
@@ -419,7 +399,14 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
 OcrReader *ocr_init(int h) {
   OcrReader *rd;
 
-  rd= malloc(sizeof(*rd));  eassert(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);