/*
- */
+ * 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 3
-
typedef struct DatabaseNode {
- char s[MAXGLYPHCHRS+1]; /* null-terminated; "" means no match here */
+ char *str;
int nlinks, alinks;
+ 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",
- "Upper",
-/* "Digit"*/
+ "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]))
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 h;
+ int j,ctxi;
+ int h, endsword;
char lbuf[100];
- FILE *db;
- 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"); eassert(db);
- free(dbfname);
+ 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);
-
- for (ctxi=0; ctxi<NCONTEXTS; ctxi++)
- cleardb_node(&rd->contexts[ctxi]);
+ 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;
}
- chrs[nchrs]= 0;
+ endsword= 0;
+ if (nchrs>0 && chrs[nchrs-1]==' ') {
+ endsword= 1;
+ nchrs--;
+ }
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) {
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;
found_link:;
}
- eassert(!current->s[0]);
- strcpy(current->s, chrs);
- }
- eassert(!ferror(db));
- eassert(!fclose(db));
-}
-
-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;
- const OcrResultGlyph *s;
- const char *p;
- char cb;
- Pixcol pv;
-
- 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",
- "--automatic","1",(char*)0);
- eassert(!"execlp failed");
+ 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;
+ }
}
- 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);
+ x:
+ dbfile_close();
+ free(dbfname);
+}
+
+static void cu_pr_ctxmap(FILE *resolver, unsigned ctxmap) {
+ fprintf(resolver,"{");
const char *spc="";
int ctxi;
for (ctxi=0; ctxi<NCONTEXTS; ctxi++) {
- if (!(unk_ctxmap & (1u << ctxi))) continue;
+ 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");
+
+ 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 ",s->l,s->r,context_names[s->ctx]);
+ 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);
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);
}
-static void add_result(OcrReader *rd, const char *s, int l, int r, int ctx) {
+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;
rd->results[rd->nresults].r= r;
- rd->results[rd->nresults].ctx= ctx;
+ rd->results[rd->nresults].ctxmap= ctxmap;
rd->nresults++;
}
-OcrResultGlyph *ocr(OcrReader *rd, int w, Pixcol cols[]) {
- int nspaces=-w;
- unsigned ctxmap=2; /* uppercase */
- int ctxi, i, x;
- rd->nresults=0;
+static DatabaseNode *findchar_1ctx(const FindCharArgs *fca,
+ DatabaseNode *start, int *matchx_r) {
+ DatabaseNode *current= start;
+ DatabaseNode *bestmatch= 0;
+ int i;
+ int x= fca->x;
- fprintf(debug,"OCR h=%d w=%d",rd->h,w);
- for (x=0; x<w; x++) fprintf(debug," %"PSPIXCOL(PRIx),cols[x]);
- fprintf(debug,"\n");
- debug_flush();
+ for (;;) {
+ 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 {
+ debugf(" ...");
+ }
+
+ x++;
+ }
+ return bestmatch;
+}
+
+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]);
+ }
+ if (match<0)
+ return 0;
+
+ *match_rx= results[ctxi].rx;
+ return results[ctxi].match;
+}
+
+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;
+}
+
+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
+};
+
+
+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();
if (!cols[x]) {
nspaces++;
x++;
- if (nspaces==3) {
- fprintf(debug,"OCR x=%x nspaces=%d space\n",x,nspaces);
- add_result(rd," ",x-nspaces,x+1,0);
- ctxmap=3; /* either */
+ if (nspaces == ct->space_spaces) {
+ debugf("OCR x=%x nspaces=%d space\n",x,nspaces);
+ fca.ctxmap= ct->nextword;
}
continue;
}
+
+ /* something here, so we need to add the spaces */
+ if (nspaces >= ct->space_spaces)
+ add_result(rd," ",x-nspaces,x+1,0);
nspaces=0;
- /* find character */
- int lx=x;
+ fca.x= x;
- DatabaseNode *uniquematch= 0;
- int uniquematch_rx=-1, uniquematch_ctxi=-1;
+ int match_rx=-1;
+ DatabaseNode *match= findchar(&fca, &match_rx);
- fprintf(debug,"OCR lx=%d ctxmap=%x ",lx,ctxmap);
-
- for (ctxi=0; ctxi<NCONTEXTS; ctxi++) {
- DatabaseNode *current= &rd->contexts[ctxi];;
- DatabaseNode *bestmatch= 0;
- int bestmatch_rx=-1;
-
- x= lx;
- if (!(ctxmap & (1u << ctxi))) continue;
- fprintf(debug," || %s",context_names[ctxi]);
-
- for (;;) {
- debug_flush();
- fprintf(debug," | x=%d",x);
- if (x>w) break;
- Pixcol cv= cols[x];
- fprintf(debug," cv=%"PSPIXCOL(PRIx),cv);
- for (i=0; i<current->nlinks; i++)
- if (current->links[i].col == cv)
- goto found;
- /* not found */
- fprintf(debug," ?");
- break;
-
- found:
- current= current->links[i].then;
- if (current->s[0]) {
- fprintf(debug," \"%s\"",current->s);
- bestmatch= current;
- bestmatch_rx= x;
- } else {
- fprintf(debug," ...");
- }
-
- x++;
+ 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;
}
-
- if (bestmatch) {
- if (uniquematch) {
- fprintf(debug, " ambiguous");
- uniquematch= 0;
- break;
- }
- uniquematch= bestmatch;
- uniquematch_rx= bestmatch_rx;
- uniquematch_ctxi= ctxi;
- }
- }
-
- if (uniquematch) {
- fprintf(debug," || YES\n");
- add_result(rd, uniquematch->s, lx, uniquematch_rx, uniquematch_ctxi);
- x= uniquematch_rx+1;
- ctxmap= 1; /* Lower only */
+ debugf("\n");
} else {
int rx;
- fprintf(debug," || UNKNOWN");
- for (rx=lx; rx<w && cols[rx]; rx++);
- fprintf(debug," x=%d ctxmap=%x %d..%d\n",x, ctxmap, 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(rd, w,cols, lx,rx-1, ctxmap);
+ callout_unknown(rd, w,cols, x,rx-1, fca.ctxmap);
goto restart;
}
+
}
add_result(rd, 0,-1,-1,0);
- fprintf(debug,"OCR finished %d glyphs\n",rd->nresults);
+ debugf("OCR finished %d glyphs\n",rd->nresults);
debug_flush();
return rd->results;
}
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);
~yarrgweb / ypp-sc-tools.db-test.git / blobdiff