chiark / gitweb /
copyright messages
[ypp-sc-tools.main.git] / pctb / ocr.c
index f5826df..fd4cba9 100644 (file)
@@ -1,5 +1,29 @@
 /*
-  */
+ * 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"
 
@@ -8,11 +32,12 @@ typedef struct {
   struct DatabaseNode *then;
 } DatabaseLink;
 
-#define MAXGLYPHCHRS 3
+#define MAXGLYPHCHRS 7
 
 typedef struct DatabaseNode {
   char s[MAXGLYPHCHRS+1]; /* null-terminated; "" means no match here */
   int nlinks, alinks;
+  unsigned endsword:1;
   DatabaseLink *links;
 } DatabaseNode;
 
@@ -39,11 +64,19 @@ static int resolver_done;
 
 DEBUG_DEFINE_DEBUGF(ocr)
 
+#define dbassert(x)                                                    \
+  ((x) ? (void)0 :                                                     \
+     fatal("Error in character set database.\n"                                \
+          " Requirement not met: %s:%d: %s", __FILE__,__LINE__, #x))
+
 static void fgetsline(FILE *f, char *lbuf, size_t lbufsz) {
+  errno=0;
   char *s= fgets(lbuf,lbufsz,f);
-  eassert(s);
+  sysassert(!ferror(f));
+  dbassert(!feof(f));
+  assert(s);
   int l= strlen(lbuf);
-  eassert(l>0);  eassert(lbuf[--l]='\n');
+  dbassert(l>0);  dbassert(lbuf[--l]='\n');
   lbuf[l]= 0;
 }
 #define FGETSLINE(f,buf) (fgetsline(f,buf,sizeof(buf)))
@@ -61,7 +94,7 @@ static void readdb(OcrReader *rd) {
   char chrs[MAXGLYPHCHRS+1];
   Pixcol cv;
   int r,j,ctxi;
-  int h;
+  int h, endsword;
   char lbuf[100];
   FILE *db;
 
@@ -70,21 +103,21 @@ static void readdb(OcrReader *rd) {
 
   char *dbfname=0;
   asprintf(&dbfname,"%s/charset-%d.txt",get_vardir(),rd->h);
-  eassert(dbfname);
+  sysassert(dbfname);
   
   db= fopen(dbfname,"r");
   free(dbfname);
   if (!db) {
-    eassert(errno==ENOENT);
+    sysassert(errno==ENOENT);
     return;
   }
 
   FGETSLINE(db,lbuf);
-  eassert(!strcmp(lbuf,"# ypp-sc-tools pctb font v1"));
+  dbassert(!strcmp(lbuf,"# ypp-sc-tools pctb font v1"));
 
   r= fscanf(db, "%d", &h);
-  eassert(r==1);
-  eassert(h==rd->h);
+  dbassert(r==1);
+  dbassert(h==rd->h);
 
   for (;;) {
     FGETSLINE(db,lbuf);
@@ -100,27 +133,32 @@ static void readdb(OcrReader *rd) {
 
   found_ctx:
     for (nchrs=0;;) {
-      int c= fgetc(db);  eassert(c!=EOF);
-      if (c=='\n') { eassert(nchrs); break; }
-      eassert(nchrs<MAXGLYPHCHRS);
+      int c= fgetc(db); sysassert(!ferror(db)); dbassert(c!=EOF);
+      if (c=='\n') { dbassert(nchrs); break; }
+      dbassert(nchrs<MAXGLYPHCHRS);
       if (c=='\\') {
        unsigned cr;
-       c= fgetc(db);  eassert(c=='x');
-       r= fscanf(db, "%2x", &cr);  eassert(r==1);
+       c= fgetc(db); sysassert(!ferror(db)); dbassert(c=='x');
+       r= fscanf(db, "%2x", &cr); sysassert(!ferror(db)); dbassert(r==1);
        assert(cr>0 && cr<=255);
        c= cr;
       }
       chrs[nchrs++]= c;
     }
+    endsword= 0;
+    if (nchrs>1 && 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; }
+      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) {
@@ -128,16 +166,15 @@ static void readdb(OcrReader *rd) {
          goto found_link;
        }
 
-      additional= malloc(sizeof(*additional)); eassert(additional);
+      additional= mmalloc(sizeof(*additional));
       additional->s[0]= 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;
@@ -147,11 +184,12 @@ static void readdb(OcrReader *rd) {
     found_link:;
     }
 
-    eassert(!current->s[0]);
+    dbassert(!current->s[0]);
     strcpy(current->s, chrs);
+    current->endsword= endsword;
   }
-  eassert(!ferror(db));
-  eassert(!fclose(db));
+  sysassert(!ferror(db));
+  sysassert(!fclose(db));
 }
 
 static void cu_pr_ctxmap(unsigned ctxmap) {
@@ -168,33 +206,33 @@ 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 jobpipe[2],donepipe[2], c,i, x,y;
   const OcrResultGlyph *s;
   const char *p;
   char cb;
   Pixcol pv;
   
   if (!resolver) {
-    r= pipe(jobpipe);  eassert(!r);
-    r= pipe(donepipe);  eassert(!r);
+    sysassert(! pipe(jobpipe) );
+    sysassert(! pipe(donepipe) );
     resolver_pid= fork();
-    eassert(resolver_pid!=-1);
+    sysassert(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);
+      sysassert( dup2(jobpipe[0],0) ==0 );
+      sysassert(! close(jobpipe[1]) );
+      sysassert(! close(donepipe[0]) );
       /* 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",
+      sysassert( dup2(donepipe[1],4) ==4 );
+      execlp("./yppsc-ocr-resolver", "yppsc-ocr-resolver",
             DEBUGP(callout) ? "--debug" : "--noop-arg",
             "--automatic-1",
             (char*)0);
-      eassert(!"execlp failed");
+      sysassert(!"execlp failed");
     }
-    r= close(jobpipe[0]); eassert(!r);
-    r= close(donepipe[1]); eassert(!r);
-    resolver= fdopen(jobpipe[1],"w"); eassert(resolver);
+    sysassert(! close(jobpipe[0]) );
+    sysassert(! close(donepipe[1]) );
+    resolver= fdopen(jobpipe[1],"w"); sysassert(resolver);
     resolver_done= donepipe[0];
   }
   fprintf(resolver,"%d %d ",unk_l,unk_r);
@@ -227,38 +265,43 @@ static void callout_unknown(OcrReader *rd, int w, Pixcol cols[],
     fputs("\",\n",resolver);
   }
   fputs("};\n",resolver);
-  eassert(!ferror(resolver));
-  eassert(!fflush(resolver));
+  sysassert(!ferror(resolver));
+  sysassert(!fflush(resolver));
 
-  eassert(resolver);
+  sysassert(resolver);
 
+  int r;
   for (;;) {
     r= read(resolver_done,&cb,1);
-    if (r==-1) { eassert(errno==EINTR); continue; }
+    if (r==-1) { sysassert(errno==EINTR); continue; }
     break;
   }
 
   if (r==0) {
     pid_t pid;
+    int st;
     for (;;) {
-      pid= waitpid(resolver_pid, &r, 0);
-      if (pid==-1) { eassert(errno==EINTR); continue; }
+      pid= waitpid(resolver_pid, &st, 0);
+      if (pid==-1) { sysassert(errno==EINTR); continue; }
       break;
     }
-    eassert(pid==resolver_pid);
-    if (WIFEXITED(r)) {
-      eassert(!WEXITSTATUS(r));
+    sysassert(pid==resolver_pid);
+    if (WIFEXITED(st)) {
+      if (WEXITSTATUS(st))
+       fatal("character resolver failed with nonzero exit status %d",
+             WEXITSTATUS(st));
       fclose(resolver);
       close(resolver_done);
       resolver= 0;
-    } else if (WIFSIGNALED(r)) {
-      eassert(!"resolver child died due to signal");
+    } else if (WIFSIGNALED(st)) {
+      fatal("character resolver died due to signal %s%s",
+           strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
     } else {
-      eassert(!"weird wait status");
+      fatal("character resolver gave strange wait status %d",st);
     }
   } else {
-    eassert(r==1);
-    eassert(cb==0);
+    assert(r==1);
+    sysassert(cb==0);
   }
 
   readdb(rd);
@@ -268,8 +311,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;
@@ -280,16 +322,21 @@ static void add_result(OcrReader *rd, const char *s, int l, int r,
 
 struct OcrCellTypeInfo {
   unsigned initial, nextword, midword;
+  const char *name;
 };
 const struct OcrCellTypeInfo ocr_celltype_number= {
-  4,4,4
+  4,4,4,
+  .name= "number"
 };
 const struct OcrCellTypeInfo ocr_celltype_text= {
-  .initial=2 /* Uppercase */,
-  .nextword=3 /* Either */,
-  .midword=1 /* Lower only */
+  .initial=2, /* Uppercase */
+  .nextword=3, /* Either */
+  .midword=1, /* Lower only */
+  .name= "text"
 };
 
+const char *ocr_celltype_name(OcrCellType ct) { return ct->name; }
+
 OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
   int nspaces;
   unsigned ctxmap;
@@ -360,7 +407,7 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
       found:
        current= current->links[i].then;
        if (current->s[0]) {
-         debugf(" \"%s\"",current->s);
+         debugf(" \"%s\"%s",current->s,current->endsword?"_":"");
          bestmatch= current;
          bestmatch_rx= x;
        } else {
@@ -382,10 +429,17 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
     }
 
     if (uniquematch) {
-      debugf(" || YES\n");
+      debugf(" || YES");
       add_result(rd, uniquematch->s, lx, uniquematch_rx, ctxmap);
       x= uniquematch_rx+1;
-      ctxmap= ct->midword;
+      if (uniquematch->s[0]) ctxmap= ct->midword;
+      else debugf(" (empty)");
+      if (uniquematch->endsword) {
+       nspaces= SPACE_SPACES;
+       debugf("_");
+       ctxmap= ct->nextword;
+      }
+      debugf("\n");
     } else {
       int rx;
       debugf(" || UNKNOWN");
@@ -405,7 +459,7 @@ OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
 OcrReader *ocr_init(int h) {
   OcrReader *rd;
 
-  rd= malloc(sizeof(*rd));  eassert(rd);
+  rd= mmalloc(sizeof(*rd));
   memset(rd,0,sizeof(*rd));
   rd->h= h;
   readdb(rd);