pctb/structure.c

   1 /*
   2  * Parsing of the structure of the YPP client's displayed image
   3  */
   4 /*
   5  *  This is part of ypp-sc-tools, a set of third-party tools for assisting
   6  *  players of Yohoho Puzzle Pirates.
   7  *
   8  *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  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.
  26  */
  27
  28 #include "structure.h"
  29
  30 static CanonImage *cim;
  31
  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); }
  34
  35 DEBUG_DEFINE_DEBUGF(struct)
  36
  37 #define START_MAIN {200,100}
  38 #define MIN_COLUMNS         6
  39 #define INTERESTING_COLUMNS 7
  40 #define TEXT_COLUMNS        2
  41 #define MAX_COLUMNS         7
  42
  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;
  47 static OcrReader *rd;
  48
  49 #define OTHERCOORD_x y
  50 #define OTHERCOORD_y x
  51
  52 const CanonColourInfo canoncolourinfos[]= {
  53   { 0x475A5E, '*' }, /* edge */
  54   { 0x2C5F7A, '*' }, /* edge just under box heading shadow */
  55   { 0xC5C7AE, '*' }, /* blank area of partial commodities list */
  56   { 0x6B828C, '*' }, /* background of ship status meter area */
  57   { 0x934405, '*' }, /* border of ship meter area */
  58   { 0x7D9094, '+' }, /* interbox */
  59
  60   { 0xBDC5BF, ' ' }, /* background - pale  Sugar cane, etc. */
  61   { 0xADB5AF, ' ' }, /* background - dark                   */
  62   { 0xC7E1C3, ' ' }, /* background - pale  Swill, etc.      */
  63   { 0xB5CFB1, ' ' }, /* background - dark                   */
  64   { 0xD6CEB0, ' ' }, /* background - pale  Madder, etc.     */
  65   { 0xC8C0A2, ' ' }, /* background - dark                   */
  66   { 0xE0E1D3, ' ' }, /* background - pale  Lorandite, etc.  */
  67   { 0xD0D1C3, ' ' }, /* background - dark                   */
  68   { 0xE5E6C1, ' ' }, /* background - pale  Cloth            */
  69   { 0xD7D8B3, ' ' }, /* background - dark                   */
  70   { 0xEDDED9, ' ' }, /* background - pale  Dye              */
  71   { 0xDACBC6, ' ' }, /* background - dark                   */
  72   { 0xD3DEDF, ' ' }, /* background - pale  Paint            */
  73   { 0xC5D0D1, ' ' }, /* background - dark                   */
  74   { 0xDCD1CF, ' ' }, /* background - pale  Enamel           */
  75   { 0xCEC3C1, ' ' }, /* background - dark                   */
  76   { 0xF3F6F5, ' ' }, /* background - pale  fruit            */
  77   { 0xE2E7E5, ' ' }, /* background - dark                   */
  78
  79   { 0x000000, 'o' }, /* foreground */
  80   { 0xD4B356, ' ' }, /* background (cursor) */
  81   { 0xFFFFFF, 'o' }, /* foreground (cursor) */
  82
  83   { 0x5B93BF, '_' }, /* selector dropdown background */
  84   { 0xD7C94F, 'X' }, /* selector dropdown foreground */
  85   { 0,0 }
  86 };
  87
  88
  89 static void mustfail1(const char *file, int line, const char *what) {
  90   fprintf(stderr,
  91           "\n\n"
  92           "Unable to figure out contents of YPP client display.\n"
  93           " Check that your client is logged in has the correct display.\n"
  94           " If that isn't the problem, please report this as a fault.\n\n"
  95           "Technical details:"
  96           " %s:%d: requirement failed: %s\n",
  97           file, line, what);
  98 }
  99 static void mustfail2(void) NORET;
 100 static void mustfail2(void) {
 101   fprintf(stderr, "\n\nGiving up.\n");
 102   exit(8);
 103 }
 104
 105 #define MUST(x, ifnot) do{                      \
 106     if (!(x)) {                                 \
 107       mustfail1(__FILE__,__LINE__,#x);          \
 108       ifnot;                                    \
 109       mustfail2();                              \
 110     }                                           \
 111   }while(0)
 112
 113 #define MP(v) fprintf(stderr," %s=%d,%d",#v,(v).x,(v).y)
 114 #define MI(v) fprintf(stderr," %s=%d",   #v,(v))
 115 #define MC(v) fprintf(stderr," %s='%c'", #v,(v))
 116 #define MS(v) fprintf(stderr," %s=\"%s\"", #v,(v))
 117 #define MSB(v) fprintf(stderr," %s", (v))
 118 #define MR(v) fprintf(stderr," %s=%d,%d..%d,%d",\
 119                       #v,(v).tl.x,(v).tl.y,(v).br.x,(v).br.y)
 120
 121
 122 #define REQUIRE_RECTANGLE(tlx,tly,brx,bry,ok) \
 123  require_rectangle(tlx, tly, brx, bry, ok, __LINE__);
 124
 125 static void require_rectangle(int tlx, int tly, int brx, int bry,
 126                               const char *ok, int lineno) {
 127   Point p;
 128   for (p.x=tlx; p.x<=brx; p.x++)
 129     for (p.y=tly; p.y<=bry; p.y++) {
 130       int c= get_p(p);
 131       MUST( strchr(ok,c), ({
 132              Rect rm={{tlx,tly},{brx,bry}};
 133              MI(lineno),MR(rm);MP(p);MS(ok);
 134       }));
 135     }
 136 }
 137 static void require_rectangle_r(Rect rr, const char *ok, int lineno) {
 138   require_rectangle(rr.tl.x,rr.tl.y, rr.br.x,rr.br.y, ok, lineno);
 139 }
 140
 141 static void debug_rect(const char *what, int whati, Rect rr) {
 142   if (!DEBUGP(rect)) return;
 143   int y,w;
 144   fprintf(debug, "%s %d: %d,%d..%d,%d:\n", what, whati,
 145           rr.tl.x,rr.tl.y, rr.br.x,rr.br.y);
 146   w= rr.br.x - rr.tl.x + 1;
 147   for (y=rr.tl.y; y<=rr.br.y; y++) {
 148     fprintf(debug, "%4d%*s|", y, rr.tl.x,"");
 149     fwrite(cim->d + y*cim->w + rr.tl.x, 1, w, debug);
 150     fputc('|',debug);
 151     fputc('\n',debug);
 152   }
 153   debug_flush();
 154 }
 155
 156 #define WALK_UNTIL(point,coord,increm,last,edge)                        \
 157   for (;;) {                                                            \
 158     if ((point).coord == (last)+(increm)) break;                        \
 159     if (get_p((point)) == (edge)) { (point).coord -= (increm); break; } \
 160     (point).coord += (increm);                                          \
 161   }
 162
 163 #define WALK_UNTIL_MUST(point,coord,increm,last,edge)   \
 164   do {                                                  \
 165     WALK_UNTIL(point,coord,increm,last,edge);           \
 166     MUST( (point).coord != (last)+(increm),             \
 167           MP(point); MI(increm); MI(last); MC(edge);    \
 168           );                                            \
 169   }while(0)
 170
 171 #define ADJUST_BOX(search,insidechrs,want, lim,LIMIT_MUST, TLBR,XY,increm) \
 172   for (;;) {                                                               \
 173     LIMIT_MUST( (search).tl.XY != (search).br.XY &&                        \
 174                 (search).tl.XY != (lim),                                   \
 175                 MR((search));MSB(#TLBR);MSB(#XY) );                        \
 176     int got;                                                               \
 177     Point p;                                                               \
 178     for (p=(search).tl, got=0;                                             \
 179          p.OTHERCOORD_##XY <= (search).br.OTHERCOORD_##XY;                 \
 180          p.OTHERCOORD_##XY++)                                              \
 181       got += !!strchr(insidechrs, get_p(p));                               \
 182     if (got >= (want))                                                     \
 183       break;                                                               \
 184     (search).TLBR.XY += increm;                                            \
 185   }
 186
 187 void find_structure_commod(CanonImage *im, int *max_relevant_y_r) {
 188   cim= im;
 189
 190   Rect whole = { {0,0}, {cim->w-1,cim->h-1} };
 191
 192   if (DEBUGP(rect)) {
 193     int xscaleunit, y,x;
 194     for (y=0, xscaleunit=1; y<4; y++, xscaleunit*=10) {
 195       fprintf(debug,"     ");
 196       for (x=0; x<=cim->w; x++) {
 197         if (x % xscaleunit) fputc(' ',debug);
 198         else fprintf(debug,"%d",(x / xscaleunit)%10);
 199       }
 200       fputc('\n',debug);
 201     }
 202   }
 203
 204   WALK_UNTIL_MUST(mainr.tl, x,-1, whole.tl.x, '*');
 205   WALK_UNTIL_MUST(mainr.tl, y,-1, whole.tl.y, '*');
 206   WALK_UNTIL_MUST(mainr.br, x,+1, whole.br.x, '*');
 207   WALK_UNTIL_MUST(mainr.br, y,+1, whole.br.y, '*');
 208
 209   REQUIRE_RECTANGLE(mainr.tl.x-1, mainr.tl.y, mainr.tl.x-1, mainr.br.y, "*");
 210   REQUIRE_RECTANGLE(mainr.br.x+1, mainr.tl.y, mainr.br.x+1, mainr.br.y, "*");
 211   REQUIRE_RECTANGLE(mainr.tl.x, mainr.tl.y-1, mainr.br.x, mainr.tl.y-1, "*");
 212   REQUIRE_RECTANGLE(mainr.tl.x, mainr.br.y+1, mainr.br.x, mainr.br.y+1, "*");
 213
 214 #define CHECK_STRIP_BORDER(tlbr,xy,increm)              \
 215   do {                                                  \
 216     Point csb_p;                                        \
 217     Rect csb_r;                                         \
 218     csb_p= mainr.tl;                                    \
 219     csb_p.xy= mainr.tlbr.xy;                            \
 220     if (get_p(csb_p)=='+') {                            \
 221       csb_r= mainr;                                     \
 222       csb_r.tl.xy= csb_p.xy;                            \
 223       csb_r.br.xy= csb_p.xy;                            \
 224       require_rectangle_r(csb_r, "+", __LINE__);        \
 225       mainr.tlbr.xy += increm;                          \
 226     }                                                   \
 227   } while(0)
 228
 229   debug_rect("mainr",0, mainr);
 230
 231   CHECK_STRIP_BORDER(tl,x,+1);
 232   CHECK_STRIP_BORDER(tl,y,+1);
 233   CHECK_STRIP_BORDER(br,x,-1);
 234   CHECK_STRIP_BORDER(br,y,-1);
 235
 236   debug_rect("mainr",1, mainr);
 237
 238   Point up = START_MAIN;
 239   WALK_UNTIL_MUST(up, y,-1, mainr.tl.y, '+');
 240
 241   Point down = START_MAIN;
 242   down.y++;
 243   WALK_UNTIL_MUST(down, y,+1, mainr.br.y, '+');
 244
 245   commbasey= up.y;
 246   comminty= down.y - up.y + 2;
 247
 248   Point across= { mainr.tl.x, commbasey };
 249   int colno=0;
 250   for (;;) {
 251     MUST( get_p(across) != '+', MI(colno);MP(across);MR(mainr);MI(commbasey) );
 252     WALK_UNTIL(across, x,+1, mainr.br.x, '+');
 253     MUST( colno < MAX_COLUMNS, MP(across);MR(mainr);MI(commbasey); );
 254     int colrx= across.x;
 255     if (colrx > mainr.br.x) colrx= mainr.br.x;
 256     if (colno < INTERESTING_COLUMNS)
 257       colrightx[colno]= colrx;
 258
 259     colno++;
 260
 261     if (across.x >= mainr.br.x-1)
 262       break;
 263
 264     across.x++;
 265     REQUIRE_RECTANGLE(across.x,mainr.tl.y, across.x,mainr.br.y, "+");
 266     across.x++;
 267   }
 268   MUST( colno >= MIN_COLUMNS, MI(colno);MR(mainr);MP(across); );
 269
 270 #define SET_ONCE(var,val) do{                                           \
 271     int v= (val);                                                       \
 272     if ((var)==-1) (var)= v;                                            \
 273     else MUST( (var) == v, MSB(#var);MI((var));MI(v);MR(mainr); );      \
 274   }while(0)
 275
 276   SET_ONCE(columns, colno);
 277   SET_ONCE(text_h, comminty - 1);
 278   if (max_relevant_y_r)
 279     SET_ONCE(*max_relevant_y_r, mainr.br.y + 10);
 280 }
 281
 282 void check_correct_commodities(void) {
 283   Rect search= { { 50,39 }, { 130,59 } };
 284
 285   ADJUST_BOX(search,"_",10, cim->h, MUST, tl,y,+1);
 286   ADJUST_BOX(search,"_",10, 0,      MUST, br,y,-1);
 287
 288   debug_rect("commodselr",1, search);
 289
 290   static const char *all[]= {
 291     "   ___________________________________   ",
 292     "  ________X____X__X____________________  ",
 293     " ________ X___ X_ X_____XXXXXXXXXXX_____ ",
 294     "_________X_X__ X_ X______XXXXXXXXX_______",
 295     "________ X X__ X_ X_______XXXXXXX________",
 296     "________X_ _X_ X_ X________XXXXX_________",
 297     "_______ X__ X_ X_ X_________XXX__________",
 298     "_______XXXXXXX X_ X__________X___________",
 299     " _____ X     X X_ X______________________",
 300     "  ____X_____ _XX_ X______________________",
 301     "   __ _______  __ ______________________ ",
 302   };
 303
 304   static int allh= sizeof(all)/sizeof(all[0]);
 305   const int allw= strlen(all[0]);
 306
 307   int alloffy, alloffx;
 308   for (alloffy=0; alloffy < search.br.y; alloffy++) {
 309     if (alloffy+allh-1 < search.tl.y) continue;
 310     for (alloffx=search.tl.x; alloffx+allw-1 <= search.br.x; alloffx++) {
 311       int good=0, bad=0;
 312       int x,y;
 313       for (x=0; x<allw; x++)
 314         for (y=0; y<allh; y++) {
 315           int want= all[y][x];
 316           if (want==' ') continue;
 317           if (get(alloffx+x, alloffy+y) == want)
 318             good++;
 319           else
 320             bad++;
 321         }
 322       debugf("CHECKCOMMOD alloff=%d,%d good=%d bad=%d\n",
 323              alloffx,alloffy, good,bad);
 324       if (good > 20*bad)
 325         goto all_found;
 326     }
 327   }
 328   fatal("Commodities selector not set to `All'.");
 329
 330  all_found:;
 331 }
 332
 333 CanonImage *alloc_canon_image(int w, int h) {
 334   CanonImage *im= mmalloc(sizeof(CanonImage) + w*h);
 335   im->w= w;
 336   im->h= h;
 337   memset(im->d,'?',w*h);
 338   return im;
 339 }
 340
 341 static void file_read_image_ppm(FILE *f) {
 342   struct pam inpam;
 343   unsigned char rgb_buf[3];
 344   CanonImage *im;
 345
 346   pnm_readpaminit(f, &inpam, sizeof(inpam));
 347   if (!(inpam.maxval == 255 &&
 348         inpam.bytes_per_sample == 1 &&
 349         inpam.format == RPPM_FORMAT))
 350     fatal("PNM screenshot(s) file must be 8bpp 1 byte per sample RGB");
 351
 352   CANONICALISE_IMAGE(im, inpam.width, inpam.height, {
 353     int r= fread(&rgb_buf,1,3,f);
 354     sysassert(!ferror(f));
 355     if (r!=3) fatal("PNM screenshot(s) file ends unexpectedly");
 356
 357     rgb=
 358         ((unsigned long)rgb_buf[0]<<16) |
 359         ((unsigned long)rgb_buf[1]<<8) |
 360                        (rgb_buf[2]);
 361   });
 362
 363   sysassert(!ferror(screenshot_file));
 364
 365   if (!(npages < MAX_PAGES))
 366     fatal("Too many images in screenshots file; max is %d.\n", MAX_PAGES);
 367
 368   page_images[npages++]= im;
 369 }
 370
 371 void read_one_screenshot(void) {
 372   progress("reading screenshot...");
 373   file_read_image_ppm(screenshot_file);
 374   progress_log("read screenshot.");
 375 }
 376
 377 void read_screenshots(void) {
 378   struct stat stab;
 379
 380   sysassert(! fstat(fileno(screenshot_file), &stab) );
 381
 382   for (;;) {
 383     if (S_ISREG(stab.st_mode)) {
 384       long pos= ftell(screenshot_file);
 385       if (pos == stab.st_size) break;
 386     } else {
 387       int c= fgetc(screenshot_file);
 388       if (c==EOF) break;
 389       ungetc(c, screenshot_file);
 390     }
 391     progress("reading screenshot %d...",npages);
 392     file_read_image_ppm(screenshot_file);
 393   }
 394   sysassert(!ferror(screenshot_file));
 395   progress_log("read %d screenshots.",npages);
 396 }
 397
 398 static void find_commodity(int offset, Rect *rr) {
 399   /* rr->tl.x==-1 if offset out of range */
 400   rr->tl.y= commbasey - offset*comminty;
 401   rr->br.y= rr->tl.y + comminty-2;
 402   if (rr->tl.y < mainr.tl.y || rr->br.y > mainr.br.y) { rr->tl.x=-1; return; }
 403
 404   rr->tl.x= mainr.tl.x;
 405   rr->br.x= mainr.br.x;
 406
 407   if (rr->tl.y > mainr.tl.y)
 408     REQUIRE_RECTANGLE(rr->tl.x,rr->tl.y-1, rr->br.x,rr->tl.y-1, "+");
 409   if (rr->br.y < mainr.tl.y)
 410     REQUIRE_RECTANGLE(rr->tl.x,rr->br.y+1, rr->br.x,rr->br.y+1, "+");
 411 }
 412
 413 static void find_table_entry(Rect commod, int colno, Rect *cellr) {
 414   cellr->tl.y= commod.tl.y;
 415   cellr->br.y= commod.br.y;
 416   cellr->tl.x= !colno ? commod.tl.x : colrightx[colno-1]+2;
 417   cellr->br.x=                        colrightx[colno];
 418   debug_rect("cell", colno, *cellr);
 419   require_rectangle_r(*cellr, " o", __LINE__);
 420 }
 421
 422 static void ocr_rectangle(Rect r, const OcrCellType ct, FILE *tsv_output) {
 423   OcrResultGlyph *results, *res;
 424
 425   int w= r.br.x - r.tl.x + 1;
 426   Pixcol cols[w+1];
 427   int x,y;
 428   for (x=0; x<w; x++) {
 429     Pixcol cx, rv;
 430     for (y=0, cx=0, rv=1; y<text_h; y++, rv<<=1) {
 431       Point here= { x+r.tl.x, y+r.tl.y };
 432       int pixel= get_p(here);
 433       switch (pixel) {
 434       case ' ':           break;
 435       case 'o': cx |= rv; break;
 436       default:
 437         MUST(!"wrong pixel",
 438              MC(pixel);MP(here);MSB(ocr_celltype_name(ct));MR(r); );
 439       }
 440     }
 441     cols[x]= cx;
 442   }
 443   cols[w]= 0;
 444
 445   results= ocr(rd,ct,w,cols);
 446   for (res=results; res->s; res++)
 447     fputs(res->s,tsv_output);
 448 }
 449
 450 void analyse(FILE *tsv_output) {
 451   Rect thisr, entryr;
 452   int page, tryrect, colno;
 453
 454   for (page=0; page<npages; page++) {
 455     find_structure_commod(page_images[page], 0);
 456
 457     if (!page)
 458       check_correct_commodities();
 459
 460     if (!rd)
 461       rd= ocr_init(text_h);
 462
 463     for (tryrect= +cim->h; tryrect >= -cim->h; tryrect--) {
 464       find_commodity(tryrect, &thisr);
 465       if (thisr.tl.x < 0)
 466         continue;
 467       debug_rect("commod",tryrect, thisr);
 468
 469       const char *tab= "";
 470       for (colno=0; colno<columns; colno++) {
 471         find_table_entry(thisr,colno,&entryr);
 472         fputs(tab, tsv_output);
 473         ocr_rectangle(entryr,
 474                       colno<TEXT_COLUMNS
 475                       ? &ocr_celltype_text
 476                       : &ocr_celltype_number,
 477                       tsv_output);
 478         tab= "\t";
 479       }
 480       fputs("\n", tsv_output);
 481       sysassert(!ferror(tsv_output));
 482       sysassert(!fflush(tsv_output));
 483     }
 484   }
 485 }
 486
 487 #if 0
 488
 489 static Rect islandnamer;
 490
 491 void find_structure_islandname(CanonImage *im, RawImage *ri) {
 492   Rect sunshiner;
 493
 494   sunshiner.tl.x= cim->w - 1034 +  885;
 495   sunshiner.br.x= cim->w - 1034 + 1020;
 496   sunshiner.tl.y= 227;
 497   sunshiner.br.y= 227;
 498
 499   ADJUST_BOX(sunshiner,"o*",30, 100,MUST, tl,y,-1);
 500   ADJUST_BOX(sunshiner,"o*",30, 100,MUST, tl,y,-1);
 501   debug_rect("sunshiner",0, sunshiner);
 502
 503   MUST(sunshiner.br.y - sunshiner.tl.y > 20);
 504   sunshiner.tl.y++;
 505   sunshiner.br.y--;
 506
 507   ADJUST_BOX(sunshiner,"o",20, (cim->w - 1034 + 700), MUST, tl,x,-1);
 508   ADJUST_BOX(sunshiner,"o",20,  cim->w,               MUST, tl,x,+1);
 509   debug_rect("sunshiner",1, sunshiner);
 510
 511   lookup_rect();
 512
 513
 514   islandnamer.tl.x= cim->w - 1034 +  885;
 515   islandnamer.br.x= cim->w - 1034 + 1020;
 516   islandnamer.tl.y=                 128;
 517   islandnamer.br.y=                 156;
 518
 519 #define IR_VSHRINK_MUST(CONDMUST,PRWHY) \
 520   do{ if (!(CONDMUST)) goto not_in_radar; }while(0)
 521
 522   ADJUST_BOX(islandnamer,"o",5, IR_VSHRINK_MUST, tl,y,+1);
 523   ADJUST_BOX(islandnamer,"o",5, IR_VSHRINK_MUST, br,y,-1);
 524
 525   debug_rect("islandnamer",0, islandnamer);
 526   static int larger_islandnamebry= islandname.tl.y + 25;
 527   if (islandnamer.br.y < larger_islandnamebry)
 528     goto not_in_radar;
 529   islandnamer.br.y = larger_islandnamebry;
 530   debug_rect("islandnamer",1, islandnamer);
 531
 532   debug_ppmrect("islandnamer",2, islandnamer,ri);
 533
 534  not_in_radar:
 535
 536
 537
 538   abort();
 539 }
 540
 541 #endif