2 * Parsing of the structure of the YPP client's displayed image
5 * This is part of ypp-sc-tools, a set of third-party tools for assisting
6 * players of Yohoho Puzzle Pirates.
8 * Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
24 * are used without permission. This program is not endorsed or
25 * sponsored by Three Rings.
28 #include "structure.h"
30 static const CanonImage *cim;
32 static inline char get(int x, int y) { return cim->d[y * cim->w + x]; }
33 static inline char get_p(Point p) { return get(p.x,p.y); }
35 DEBUG_DEFINE_DEBUGF(struct)
37 #define START_MAIN {200,200}
39 #define INTERESTING_COLUMNS 7
40 #define TEXT_COLUMNS 2
43 static Rect mainr = { START_MAIN,START_MAIN };
44 static int commbasey, comminty;
45 static int colrightx[INTERESTING_COLUMNS];
46 static int text_h=-1, columns=-1;
49 char *archipelago, *island;
51 #define OTHERCOORD_x y
52 #define OTHERCOORD_y x
54 const CanonColourInfo canoncolourinfos[]= {
55 { 0x475A5E, '*' }, /* edge */
56 { 0x2C5F7A, '*' }, /* edge just under box heading shadow */
57 { 0xC5C7AE, '*' }, /* blank area of partial commodities list */
58 { 0x6B828C, '*' }, /* background of ship status meter area */
59 { 0x934405, '*' }, /* border of ship meter area */
60 { 0x7D9094, '+' }, /* interbox */
62 { 0xBDC5BF, ' ' }, /* background - pale Sugar cane, etc. */
63 { 0xADB5AF, ' ' }, /* background - dark */
64 { 0xC7E1C3, ' ' }, /* background - pale Swill, etc. */
65 { 0xB5CFB1, ' ' }, /* background - dark */
66 { 0xD6CEB0, ' ' }, /* background - pale Madder, etc. */
67 { 0xC8C0A2, ' ' }, /* background - dark */
68 { 0xE0E1D3, ' ' }, /* background - pale Lorandite, etc. */
69 { 0xD0D1C3, ' ' }, /* background - dark */
70 { 0xE5E6C1, ' ' }, /* background - pale Cloth */
71 { 0xD7D8B3, ' ' }, /* background - dark */
72 { 0xEDDED9, ' ' }, /* background - pale Dye */
73 { 0xDACBC6, ' ' }, /* background - dark */
74 { 0xD3DEDF, ' ' }, /* background - pale Paint */
75 { 0xC5D0D1, ' ' }, /* background - dark */
76 { 0xDCD1CF, ' ' }, /* background - pale Enamel */
77 { 0xCEC3C1, ' ' }, /* background - dark */
78 { 0xF3F6F5, ' ' }, /* background - pale fruit */
79 { 0xE2E7E5, ' ' }, /* background - dark */
81 { 0x000000, 'o' }, /* foreground */
82 { 0xD4B356, ' ' }, /* background (cursor) */
83 { 0xFFFFFF, 'o' }, /* foreground (cursor) */
85 { 0x5B93BF, '_' }, /* selector dropdown background */
86 { 0xD7C94F, 'X' }, /* selector dropdown foreground */
91 static void mustfail1(const char *file, int line, const char *what) {
94 "Unable to figure out contents of YPP client display.\n"
95 " Check that your client is logged in has the correct display.\n"
96 " If that isn't the problem, please report this as a fault.\n\n"
98 " %s:%d: requirement failed:\n"
102 static void mustfail2(void) NORET;
103 static void mustfail2(void) {
104 fprintf(stderr, "\n\nGiving up.\n");
108 #define MUST(x, ifnot) do{ \
110 mustfail1(__FILE__,__LINE__,#x); \
116 #define MP(v) fprintf(stderr," %s=%d,%d",#v,(v).x,(v).y)
117 #define MI(v) fprintf(stderr," %s=%d", #v,(v))
118 #define MC(v) fprintf(stderr," %s='%c'", #v,(v))
119 #define MS(v) fprintf(stderr," %s=\"%s\"", #v,(v))
120 #define MSB(v) fprintf(stderr," %s", (v))
121 #define MR(v) fprintf(stderr," %s=%d,%d..%d,%d",\
122 #v,(v).tl.x,(v).tl.y,(v).br.x,(v).br.y)
125 #define REQUIRE_RECTANGLE(tlx,tly,brx,bry,ok) \
126 require_rectangle(tlx, tly, brx, bry, ok, __LINE__);
128 static void require_rectangle(int tlx, int tly, int brx, int bry,
129 const char *ok, int lineno) {
131 for (p.x=tlx; p.x<=brx; p.x++)
132 for (p.y=tly; p.y<=bry; p.y++) {
134 MUST( strchr(ok,c), ({
135 Rect rm={{tlx,tly},{brx,bry}};
136 MI(lineno),MR(rm);MP(p);MS(ok);
140 static void require_rectangle_r(Rect rr, const char *ok, int lineno) {
141 require_rectangle(rr.tl.x,rr.tl.y, rr.br.x,rr.br.y, ok, lineno);
144 static void debug_rect(const char *what, int whati, Rect rr) {
145 if (!DEBUGP(rect)) return;
147 fprintf(debug, "%s %d: %d,%d..%d,%d:\n", what, whati,
148 rr.tl.x,rr.tl.y, rr.br.x,rr.br.y);
149 w= rr.br.x - rr.tl.x + 1;
150 for (y=rr.tl.y; y<=rr.br.y; y++) {
151 fprintf(debug, "%4d%*s|", y, rr.tl.x,"");
152 fwrite(cim->d + y*cim->w + rr.tl.x, 1, w, debug);
159 static int commod_selector_matches(Rect search, const char *const *all,
160 int allh, int allw) {
161 int alloffy, alloffx;
162 for (alloffy=0; alloffy < search.br.y; alloffy++) {
163 if (alloffy+allh-1 < search.tl.y) continue;
164 for (alloffx=search.tl.x; alloffx+allw-1 <= search.br.x; alloffx++) {
167 for (x=0; x<allw; x++)
168 for (y=0; y<allh; y++) {
170 if (want==' ') continue;
171 if (get(alloffx+x, alloffy+y) == want)
176 debugf("CHECKCOMMOD alloff=%d,%d good=%d bad=%d\n",
177 alloffx,alloffy, good,bad);
185 #define WALK_UNTIL(point,coord,increm,last,edge) \
187 if ((point).coord == (last)+(increm)) break; \
188 if (get_p((point)) == (edge)) { (point).coord -= (increm); break; } \
189 (point).coord += (increm); \
192 #define WALK_UNTIL_MUST(point,coord,increm,last,edge) \
194 WALK_UNTIL(point,coord,increm,last,edge); \
195 MUST( (point).coord != (last)+(increm), \
196 MP(point); MI(increm); MI(last); MC(edge); \
200 #define ADJUST_BOX(search,insidechrs,want, lim,LIMIT_MUST, TLBR,XY,increm) \
202 LIMIT_MUST( (search).tl.XY != (search).br.XY && \
203 (search).tl.XY != (lim), \
204 MR((search));MSB(#TLBR);MSB(#XY) ); \
206 Point p=(search).tl; \
207 for (p.XY=(search).TLBR.XY; \
208 p.OTHERCOORD_##XY <= (search).br.OTHERCOORD_##XY; \
209 p.OTHERCOORD_##XY++) \
210 got += !!strchr(insidechrs, get_p(p)); \
213 (search).TLBR.XY += increm; \
216 void find_structure(const CanonImage *im, int *max_relevant_y_r) {
219 Rect whole = { {0,0}, {cim->w-1,cim->h-1} };
223 for (y=0, xscaleunit=1; y<4; y++, xscaleunit*=10) {
225 for (x=0; x<=cim->w; x++) {
226 if (x % xscaleunit) fputc(' ',debug);
227 else fprintf(debug,"%d",(x / xscaleunit)%10);
233 WALK_UNTIL_MUST(mainr.tl, x,-1, whole.tl.x, '*');
234 WALK_UNTIL_MUST(mainr.tl, y,-1, whole.tl.y, '*');
235 WALK_UNTIL_MUST(mainr.br, x,+1, whole.br.x, '*');
236 WALK_UNTIL_MUST(mainr.br, y,+1, whole.br.y, '*');
238 REQUIRE_RECTANGLE(mainr.tl.x-1, mainr.tl.y, mainr.tl.x-1, mainr.br.y, "*");
239 REQUIRE_RECTANGLE(mainr.br.x+1, mainr.tl.y, mainr.br.x+1, mainr.br.y, "*");
240 REQUIRE_RECTANGLE(mainr.tl.x, mainr.tl.y-1, mainr.br.x, mainr.tl.y-1, "*");
241 REQUIRE_RECTANGLE(mainr.tl.x, mainr.br.y+1, mainr.br.x, mainr.br.y+1, "*");
243 #define CHECK_STRIP_BORDER(tlbr,xy,increm) \
248 csb_p.xy= mainr.tlbr.xy; \
249 if (get_p(csb_p)=='+') { \
251 csb_r.tl.xy= csb_p.xy; \
252 csb_r.br.xy= csb_p.xy; \
253 require_rectangle_r(csb_r, "+", __LINE__); \
254 mainr.tlbr.xy += increm; \
258 debug_rect("mainr",0, mainr);
260 CHECK_STRIP_BORDER(tl,x,+1);
261 CHECK_STRIP_BORDER(tl,y,+1);
262 CHECK_STRIP_BORDER(br,x,-1);
263 CHECK_STRIP_BORDER(br,y,-1);
265 debug_rect("mainr",1, mainr);
267 Point up = START_MAIN;
268 WALK_UNTIL_MUST(up, y,-1, mainr.tl.y, '+');
270 Point down = START_MAIN;
272 WALK_UNTIL_MUST(down, y,+1, mainr.br.y, '+');
275 comminty= down.y - up.y + 2;
277 Point across= { mainr.tl.x, commbasey };
280 MUST( get_p(across) != '+', MI(colno);MP(across);MR(mainr);MI(commbasey) );
281 WALK_UNTIL(across, x,+1, mainr.br.x, '+');
282 MUST( colno < MAX_COLUMNS, MP(across);MR(mainr);MI(commbasey); );
284 if (colrx > mainr.br.x) colrx= mainr.br.x;
285 if (colno < INTERESTING_COLUMNS)
286 colrightx[colno]= colrx;
290 if (across.x >= mainr.br.x-1)
294 REQUIRE_RECTANGLE(across.x,mainr.tl.y, across.x,mainr.br.y, "+");
297 MUST( colno >= MIN_COLUMNS, MI(colno);MR(mainr);MP(across); );
299 #define SET_ONCE(var,val) do{ \
301 if ((var)==-1) (var)= v; \
302 else MUST( (var) == v, MSB(#var);MI((var));MI(v);MR(mainr); ); \
305 SET_ONCE(columns, colno);
306 SET_ONCE(text_h, comminty - 1);
307 if (max_relevant_y_r)
308 SET_ONCE(*max_relevant_y_r, mainr.br.y + 10);
311 void check_correct_commodities(void) {
312 Rect search= { { 50,39 }, { 130,59 } };
314 ADJUST_BOX(search,"_",10, cim->h, MUST, tl,y,+1);
315 ADJUST_BOX(search,"_",10, 0, MUST, br,y,-1);
317 debug_rect("commodselr",1, search);
319 static const char *all_small[]= {
320 " ___________________________________ ",
321 " ________X____X__X____________________ ",
322 " ________ X___ X_ X_____XXXXXXXXXXX_____ ",
323 "_________X_X__ X_ X______XXXXXXXXX_______",
324 "________ X X__ X_ X_______XXXXXXX________",
325 "________X_ _X_ X_ X________XXXXX_________",
326 "_______ X__ X_ X_ X_________XXX__________",
327 "_______XXXXXXX X_ X__________X___________",
328 " _____ X X X_ X______________________",
329 " ____X_____ _XX_ X______________________",
330 " __ _______ __ ______________________ ",
332 static const char *all_big[]= {
333 "???_______________________________________???",
334 "??_________________________________________??",
335 "?_________X______X___X______________________?",
336 "_________?X_____?X__?X______XXXXXXXXXXX______",
337 "_________X_X____?X__?X_______XXXXXXXXX_______",
338 "________?X?X____?X__?X________XXXXXXX________",
339 "________X_?_X___?X__?X_________XXXXX_________",
340 "_______?X__?X___?X__?X__________XXX__________",
341 "_______?XXXXX___?X__?X___________X___________",
342 "_______X????_X__?X__?X_______________________",
343 "?_____?X____?X__?X__?X_______________________",
344 "??____X_____?_X_?X__?X_______________________",
345 "???__?_______?__?___?_______________________?",
348 #define COMMOD_SELECTOR_MATCHES(all) \
349 commod_selector_matches(search, all, \
350 sizeof((all))/sizeof((all)[0]), \
353 if (!(COMMOD_SELECTOR_MATCHES(all_small) ||
354 COMMOD_SELECTOR_MATCHES(all_big)))
355 fatal("Commodities selector not set to `All'.");
358 CanonImage *alloc_canon_image(int w, int h) {
359 CanonImage *im= mmalloc(sizeof(CanonImage) + w*h);
362 memset(im->d,'?',w*h);
366 static void file_read_image_ppm(FILE *f) {
368 unsigned char rgb_buf[3];
372 pnm_readpaminit(f, &inpam, sizeof(inpam));
373 if (!(inpam.maxval == 255 &&
374 inpam.bytes_per_sample == 1 &&
375 inpam.format == RPPM_FORMAT))
376 fatal("PNM screenshot(s) file must be 8bpp 1 byte per sample RGB");
379 page0_rgbimage= ri= alloc_rgb_image(inpam.width, inpam.height);
381 CANONICALISE_IMAGE(im, inpam.width, inpam.height, {
382 int r= fread(&rgb_buf,1,3,f);
383 sysassert(!ferror(f));
384 if (r!=3) fatal("PNM screenshot(s) file ends unexpectedly");
387 ((unsigned long)rgb_buf[0]<<16) |
388 ((unsigned long)rgb_buf[1]<<8) |
392 CANONIMG_ALSO_STORERGB(ri);
395 sysassert(!ferror(screenshot_file));
397 if (!(npages < MAX_PAGES))
398 fatal("Too many images in screenshots file; max is %d.\n", MAX_PAGES);
400 page_images[npages++]= im;
403 void read_one_screenshot(void) {
404 progress("reading screenshot...");
405 file_read_image_ppm(screenshot_file);
406 progress_log("read screenshot.");
409 void read_screenshots(void) {
412 sysassert(! fstat(fileno(screenshot_file), &stab) );
415 if (S_ISREG(stab.st_mode)) {
416 long pos= ftell(screenshot_file);
417 if (pos == stab.st_size) break;
419 int c= fgetc(screenshot_file);
421 ungetc(c, screenshot_file);
423 progress("reading screenshot %d...",npages);
424 file_read_image_ppm(screenshot_file);
426 sysassert(!ferror(screenshot_file));
427 progress_log("read %d screenshots.",npages);
430 static void find_commodity(int offset, Rect *rr) {
431 /* rr->tl.x==-1 if offset out of range */
432 rr->tl.y= commbasey - offset*comminty;
433 rr->br.y= rr->tl.y + comminty-2;
434 if (rr->tl.y < mainr.tl.y || rr->br.y > mainr.br.y) { rr->tl.x=-1; return; }
436 rr->tl.x= mainr.tl.x;
437 rr->br.x= mainr.br.x;
439 if (rr->tl.y > mainr.tl.y)
440 REQUIRE_RECTANGLE(rr->tl.x,rr->tl.y-1, rr->br.x,rr->tl.y-1, "+");
441 if (rr->br.y < mainr.tl.y)
442 REQUIRE_RECTANGLE(rr->tl.x,rr->br.y+1, rr->br.x,rr->br.y+1, "+");
445 static void find_table_entry(Rect commod, int colno, Rect *cellr) {
446 cellr->tl.y= commod.tl.y;
447 cellr->br.y= commod.br.y;
448 cellr->tl.x= !colno ? commod.tl.x : colrightx[colno-1]+2;
449 cellr->br.x= colrightx[colno];
450 debug_rect("cell", colno, *cellr);
451 require_rectangle_r(*cellr, " o", __LINE__);
454 static void ocr_rectangle(Rect r, const OcrCellType ct, FILE *tsv_output) {
455 OcrResultGlyph *results, *res;
457 int w= r.br.x - r.tl.x + 1;
460 for (x=0; x<w; x++) {
462 for (y=0, cx=0, rv=1; y<text_h; y++, rv<<=1) {
463 Point here= { x+r.tl.x, y+r.tl.y };
464 int pixel= get_p(here);
467 case 'o': cx |= rv; break;
470 MC(pixel);MP(here);MSB(ocr_celltype_name(ct));MR(r); );
477 results= ocr(rd,ct,w,cols);
478 for (res=results; res->s; res++)
479 fputs(res->s,tsv_output);
482 void analyse(FILE *tsv_output) {
484 int page, tryrect, colno;
486 for (page=0; page<npages; page++) {
487 find_structure(page_images[page], 0);
490 check_correct_commodities();
493 rd= ocr_init(text_h);
495 progress("Scanning page %d...",page);
497 for (tryrect= +cim->h; tryrect >= -cim->h; tryrect--) {
498 find_commodity(tryrect, &thisr);
501 debug_rect("commod",tryrect, thisr);
504 for (colno=0; colno<columns; colno++) {
505 find_table_entry(thisr,colno,&entryr);
506 fputs(tab, tsv_output);
507 ocr_rectangle(entryr,
510 : &ocr_celltype_number,
514 fputs("\n", tsv_output);
515 sysassert(!ferror(tsv_output));
516 sysassert(!fflush(tsv_output));
519 progress("Commodity table scan complete.");
522 //static Rect islandnamer;
524 void find_islandname(void) {
526 char sunshine[MAXIMGIDENT], archisland[MAXIMGIDENT];
528 RgbImage *ri= alloc_rgb_image(page0_rgbimage->w, page0_rgbimage->h);
529 const unsigned char *srcp;
530 unsigned char *destp, *endp;
531 for (srcp=page0_rgbimage->data, destp=ri->data,
532 endp= ri->data + 3 * ri->w * ri->h;
535 unsigned char c= *srcp & 0xf0;
541 sunshiner.tl.x= cim->w - 1034 + 885;
542 sunshiner.br.x= cim->w - 1034 + 1020;
546 ADJUST_BOX(sunshiner,"o*",30, 100,MUST, tl,y,-1);
547 ADJUST_BOX(sunshiner,"o*",30, 100,MUST, br,y,+1);
548 debug_rect("sunshiner",0, sunshiner);
550 MUST(sunshiner.br.y - sunshiner.tl.y > 20, MR(sunshiner));
553 ADJUST_BOX(sunshiner,"o",20, (cim->w - 1034 + 700), MUST, tl,x,-1);
554 ADJUST_BOX(sunshiner,"o",20, cim->w, MUST, br,x,+1);
555 debug_rect("sunshiner",1, sunshiner);
557 identify_rgbimage(ri, sunshiner, sunshine, "sunshine widget");
559 if (!memcmp(sunshine,"Vessel ",5)) {
562 islandnamer.tl.x= cim->w - 1034 + 885;
563 islandnamer.br.x= cim->w - 1034 + 1020;
564 islandnamer.tl.y= 128;
565 islandnamer.br.y= 156;
567 ADJUST_BOX(islandnamer,"o",5, 0, MUST, tl,y,+1);
568 ADJUST_BOX(islandnamer,"o",5, cim->h, MUST, br,y,-1);
570 ADJUST_BOX(islandnamer,"o",1, 0, MUST, tl,x,+1);
571 ADJUST_BOX(islandnamer,"o",1, cim->w, MUST, br,x,-1);
573 debug_rect("islandnamer",0, islandnamer);
574 // int larger_islandnamebry= islandnamer.tl.y + 25;
575 // MUST(islandnamer.br.y < larger_islandnamebry,
576 // MR(islandnamer);MI(larger_islandnamebry));
577 // islandnamer.br.y = larger_islandnamebry;
578 debug_rect("islandnamer",1, islandnamer);
581 for (x=islandnamer.tl.x; x<=islandnamer.br.x; x++)
582 for (y=islandnamer.tl.y; y<=islandnamer.br.y; y++) {
583 if (RI_PIXEL(ri,x,y)[0] < 0x40) {
584 for (i=0; i<3; i++) {
585 RI_PIXEL(ri,x,y)[i]= 0;
590 identify_rgbimage(ri, islandnamer, archisland, "island");
592 assert(!"not vessel");
595 char *delim= strstr(archisland," - ");
597 archipelago= masprintf("%.*s", delim-archisland, archisland);
598 island= masprintf("%s", delim+3);