X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=pctb%2Focr.c;h=fafdba8eec2ac74f54c4ffc05f096f62c0c5d479;hp=7eb871a68844acc1d802747e67346aed760b3729;hb=8360f12a6a457b73ebb18dbeedbb15e6ed91318b;hpb=d3eaa28d304c5b0639bc0f7e29b3285317d5c1e7

diff --git a/pctb/ocr.c b/pctb/ocr.c
index 7eb871a..fafdba8 100644
--- a/pctb/ocr.c
+++ b/pctb/ocr.c
@@ -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;
 
@@ -21,10 +46,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 3
+#define NCONTEXTS (sizeof(context_names)/sizeof(context_names[0]))
 
 struct OcrReader {
   int h;
@@ -37,14 +79,9 @@ static FILE *resolver;
 static pid_t resolver_pid;
 static int resolver_done;
 
-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)))
+DEBUG_DEFINE_DEBUGF(ocr)
+
+#define FGETSLINE (dbfile_getsline(lbuf,sizeof(lbuf),__FILE__,__LINE__))
 
 static void cleardb_node(DatabaseNode *n) {
   int i;
@@ -58,67 +95,66 @@ static void readdb(OcrReader *rd) {
   DatabaseNode *current, *additional;
   char chrs[MAXGLYPHCHRS+1];
   Pixcol cv;
-  int r,j,ctxi;
-  int h;
+  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);
+  sysassert(dbfname);
   
-  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);
+      int c= fgetc(dbfile); sysassert(!ferror(dbfile)); 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(dbfile); sysassert(!ferror(dbfile)); dbassert(c=='x');
+	dbassert( dbfile_scanf("%2x", &cr) == 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; }
+      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) {
@@ -126,16 +162,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;
@@ -145,11 +180,13 @@ 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));
+ x:
+  dbfile_close();
+  free(dbfname);
 }
 
 static void cu_pr_ctxmap(unsigned ctxmap) {
@@ -166,31 +203,38 @@ 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 (!o_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);
+    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",
-	     "--automatic","1",(char*)0);
-      eassert(!"execlp failed");
+      sysassert( dup2(donepipe[1],4) ==4 );
+      execlp(o_resolver, o_resolver,
+	     DEBUGP(callout) ? "--debug" : "--noop-arg",
+	     "--automatic-1",
+	     (char*)0);
+      sysassert(!"execlp ocr-resolver 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);
@@ -223,38 +267,26 @@ 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;
-    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");
-    }
+    waitpid_check_exitstatus(resolver_pid, "character resolver");
+    fclose(resolver);
+    close(resolver_done);
+    resolver= 0;
   } else {
-    eassert(r==1);
-    eassert(cb==0);
+    assert(r==1);
+    sysassert(cb==0);
   }
 
   readdb(rd);
@@ -264,8 +296,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;
@@ -274,26 +305,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 */
-};
 
-static void vdebugf(const char *fmt, va_list al) {
-#ifdef DEBUG_OCR
-  vfprintf(debug,fmt,al);
-#endif
-}
-static void debugf(const char *fmt, ...) {
-  va_list al;  va_start(al,fmt);  vdebugf(fmt,al);  va_end(al);
-}
+const char *ocr_celltype_name(OcrCellType ct) { return ct->name; }
 
 OcrResultGlyph *ocr(OcrReader *rd, OcrCellType ct, int w, Pixcol cols[]) {
   int nspaces;
@@ -320,7 +333,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;
       }
@@ -328,7 +341,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;
 
@@ -365,7 +378,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 {
@@ -387,10 +400,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= ct->space_spaces;
+	debugf("_");
+	ctxmap= ct->nextword;
+      }
+      debugf("\n");
     } else {
       int rx;
       debugf(" || UNKNOWN");
@@ -410,7 +430,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);