2 * Interaction with the YPP client via X11
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.
29 * Only this file #includes the X11 headers, as they're quite
30 * pollutant of the namespace.
33 #include "structure.h"
36 #include <X11/extensions/XTest.h>
37 #include <X11/keysym.h>
38 #include <X11/Xutil.h>
40 #include <X11/extensions/XShm.h>
44 CanonImage *page_images[MAX_PAGES];
47 const char *ocean, *pirate;
49 static XWindowAttributes attr;
52 static struct timeval tv_startup;
53 static unsigned wwidth, wheight;
54 static int max_relevant_y= -1;
55 static Point commod_focus_point, commod_page_point, commod_focuslast_point;
58 static XShmSegmentInfo shminfo;
60 DEBUG_DEFINE_DEBUGF(pages)
62 #define xassert(what) \
64 fatal("X11 operation unexpectedly failed." \
65 " %s:%d: %s\n", __FILE__,__LINE__,#what))
67 static KeyCode keycode(KeySym sym) {
68 return XKeysymToKeycode(disp,sym);
71 void screenshot_startup(void) {
72 progress("starting...");
73 disp= XOpenDisplay(0);
74 if (!disp) fatal("Unable to open X11 display.");
75 sysassert(! gettimeofday(&tv_startup,0) );
78 /*---------- pager ----------*/
80 typedef RgbImage Snapshot;
82 static double last_input;
83 static const double min_update_allowance= 0.25;
85 static double timestamp(void) {
88 sysassert(! gettimeofday(&tv,0) );
89 double t= (tv.tv_sec - tv_startup.tv_sec) +
90 (tv.tv_usec - tv_startup.tv_usec) * 1e-6;
91 debugf("PAGING %f\n",t);
94 static void delay(double need_sleep) {
95 debugf("PAGING delay %f\n",need_sleep);
96 sysassert(! usleep(need_sleep * 1e6) );
99 static void sync_after_input(void) {
100 xassert( XSync(disp, False) );
101 last_input= timestamp();
104 static void translate_coords_toroot(int wx, int wy, int *rx, int *ry) {
106 xassert( XTranslateCoordinates(disp, id,attr.root, wx,wy, rx,ry, &dummy) );
108 static void translate_coords_toroot_p(Point w, int *rx, int *ry) {
109 translate_coords_toroot(w.x, w.y, rx, ry);
112 static void check_client_window_all_on_screen(void) {
114 unsigned rwidth, rheight;
119 xassert( XGetGeometry(disp,attr.root, &dummy, &rxpos,&rypos,
123 translate_coords_toroot(0,0, &onroot.tl.x,&onroot.tl.y);
124 translate_coords_toroot(wwidth-1,wheight-1, &onroot.br.x,&onroot.br.y);
125 if (!(onroot.tl.x >= 0 &&
127 onroot.br.x < rwidth &&
128 onroot.br.y < rheight))
129 fatal("YPP client window is not entirely on the screen.");
132 static void check_not_disturbed(void) {
137 r= XCheckMaskEvent(disp, ~0, &ev);
138 if (r==False) return;
141 case VisibilityNotify:
142 if (ev.xvisibility.state != VisibilityUnobscured)
143 fatal("YPP client window has become obscured.");
145 case ConfigureNotify:
146 check_client_window_all_on_screen();
149 fatal("Focus left YPP client window.");
152 warning("focus entered YPP client window ?!");
155 fatal("Received unexpected X11 event (type code %d)!", ev.type);
160 static void send_key(KeySym sym) {
161 check_not_disturbed();
162 XTestFakeKeyEvent(disp, keycode(sym),1, 10);
163 XTestFakeKeyEvent(disp, keycode(sym),0, 10);
165 static void mouse_1_updown_here(void) {
166 check_not_disturbed();
167 XTestFakeButtonEvent(disp,1,1, 10);
168 XTestFakeButtonEvent(disp,1,0, 10);
170 static void mouse_1_updown(int x, int y) {
171 check_not_disturbed();
172 int screen= XScreenNumberOfScreen(attr.screen);
174 translate_coords_toroot(x,y, &xpos,&ypos);
175 XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
176 mouse_1_updown_here();
178 static void pgdown_by_mouse(void) {
179 check_not_disturbed();
180 debugf("PAGING Mouse\n");
181 mouse_1_updown_here();
187 static void send_pgup_many(void) {
189 for (i=0; i<25; i++) {
193 debugf("PAGING PageUp x %d\n",i);
196 static void send_pgdown_torestore(void) {
197 debugf("PAGING PageDown x %d\n", -pgupdown);
198 while (pgupdown < 0) {
205 static void free_snapshot(Snapshot **io) {
210 #define SAMPLEMASK 0xfful
216 static void compute_shift_mask(ShMask *sm, unsigned long ximage_mask) {
221 if (ximage_mask <= (SAMPLEMASK>>1)) {
222 sm->lshift++; ximage_mask <<= 1;
223 } else if (ximage_mask > SAMPLEMASK) {
224 sm->rshift++; ximage_mask >>= 1;
228 assert(!(sm->lshift && sm->rshift));
230 assert(sm->lshift < LONG_BIT);
231 assert(sm->rshift < LONG_BIT);
232 debugf("SHIFTMASK %p={.lshift=%d, .rshift=%d} image_mask=%lx\n",
233 sm, sm->lshift, sm->rshift, ximage_mask);
236 static void rtimestamp(double *t, const char *wh) {
237 double n= timestamp();
238 debugf("PAGING INTERVAL %f %s\n", n-*t, wh);
242 static void snapshot(Snapshot **output) {
243 XImage *im_use, *im_free=0;
245 ShMask shiftmasks[3];
247 debugf("PAGING snapshot\n");
249 double begin= timestamp();
251 rtimestamp(&begin, "XShmGetImage before");
252 xassert( XShmGetImage(disp,id,shmim, 0,0, AllPlanes) );
253 rtimestamp(&begin, "XShmGetImage");
255 size_t dsz= shmim->bytes_per_line * shmim->height;
256 im_use= im_free= mmalloc(sizeof(*im_use) + dsz);
258 im_free->data= (void*)(im_free+1);
259 memcpy(im_free->data, shmim->data, dsz);
260 rtimestamp(&begin, "mmalloc/memcpy");
262 rtimestamp(&begin, "XGetImage before");
263 xassert( im_use= im_free=
264 XGetImage(disp,id, 0,0, wwidth,wheight, AllPlanes, ZPixmap) );
265 rtimestamp(&begin, "XGetImage");
268 #define COMPUTE_SHIFT_MASK(ix, rgb) \
269 compute_shift_mask(&shiftmasks[ix], im_use->rgb##_mask)
270 COMPUTE_SHIFT_MASK(0, red);
271 COMPUTE_SHIFT_MASK(1, green);
272 COMPUTE_SHIFT_MASK(2, blue);
275 *output= alloc_rgb_image(wwidth, wheight);
277 rtimestamp(&begin, "compute_shift_masks+alloc_rgb_image");
280 unsigned char *op= (*output)->data;
281 for (y=0; y<wheight; y++) {
282 if (im_use->xoffset == 0 &&
283 im_use->format == ZPixmap &&
284 im_use->byte_order == LSBFirst &&
285 im_use->depth == 24 &&
286 im_use->bits_per_pixel == 32 &&
287 im_use->red_mask == 0x0000ffU &&
288 im_use->green_mask == 0x00ff00U &&
289 im_use->blue_mask == 0xff0000U) {
290 const char *p= im_use->data + y * im_use->bytes_per_line;
291 // debugf("optimised copy y=%d",y);
292 for (x=0; x<wwidth; x++) {
299 for (x=0; x<wwidth; x++) {
300 long xrgb= XGetPixel(im_use,x,y);
301 for (i=0; i<3; i++) {
302 unsigned long sample=
303 ((xrgb << shiftmasks[i].lshift) >> shiftmasks[i].rshift)
311 rtimestamp(&begin,"w*h*XGetPixel");
313 XDestroyImage(im_free);
315 rtimestamp(&begin,"XDestroyImage");
316 check_not_disturbed();
318 debugf("PAGING snapshot done.\n");
321 static int identical(const Snapshot *a, const Snapshot *b) {
322 if (!(a->w == b->w &&
326 int compare_to= a->h;
327 if (max_relevant_y>=0 && compare_to > max_relevant_y)
328 compare_to= max_relevant_y;
330 return !memcmp(a->data, b->data, a->w * 3 * compare_to);
333 static void wait_for_stability(Snapshot **output,
334 const Snapshot *previously,
335 void (*with_keypress)(void),
336 const char *fmt, ...)
339 static void wait_for_stability(Snapshot **output,
340 const Snapshot *previously,
341 void (*with_keypress)(void),
342 const char *fmt, ...) {
348 /* waits longer if we're going to return an image identical to previously
349 * if previously==0, all images are considered identical to it */
352 sysassert( vasprintf(&doing,fmt,al) >=0 );
354 debugf("PAGING wait_for_stability"
355 " last_input=%f previously=%p `%s'\n",
356 last_input, previously, doing);
358 double min_interval= 0.025; /*us*/
360 progress_spinner("%s",doing);
362 double since_last_input= timestamp() - last_input;
363 double this_interval= min_interval - since_last_input;
365 if (this_interval >= 0)
366 delay(this_interval);
371 debugf("PAGING wait_for_stability first...\n");
372 last=*output; *output=0;
373 } else if (!identical(*output,last)) {
374 debugf("PAGING wait_for_stability changed...\n");
375 free_snapshot(&last); last=*output; *output=0;
377 if (!with_keypress) {
385 identical(*output,previously) ? 5
387 debugf("PAGING wait_for_stability nidentical=%d threshold=%d\n",
388 nidentical, threshold);
389 if (nidentical >= threshold)
400 free_snapshot(&last);
402 debugf("PAGING wait_for_stability done.\n");
406 static void raise_and_get_details(void) {
407 int evbase,errbase,majver,minver;
411 progress("raising and checking YPP client window...");
413 debugf("PAGING raise_and_get_details\n");
415 int xtest= XTestQueryExtension(disp, &evbase,&errbase,&majver,&minver);
416 if (!xtest) fatal("X server does not support the XTEST extension.");
418 xassert( XRaiseWindow(disp, id) );
419 /* in case VisibilityNotify triggers right away before we have had a
420 * change to raise; to avoid falsely detecting lowering in that case */
422 xassert( XSelectInput(disp, id,
427 xassert( XRaiseWindow(disp, id) );
428 /* in case the window was lowered between our Raise and our SelectInput;
429 * to avoid failing to detect that lowering */
431 xassert( XGetWindowAttributes(disp, id, &attr) );
432 xassert( XGetGeometry(disp,id, &attr.root,
433 &wxpos,&wypos, &wwidth,&wheight,
436 if (!(wwidth >= 320 && wheight >= 320))
437 fatal("YPP client window is implausibly small?");
440 fatal("Display is not 24bpp.");
442 check_client_window_all_on_screen();
446 int shm= XShmQueryVersion(disp, &major,&minor,&shmpixmaps);
447 debugf("PAGING shm=%d %d.%d pixmaps=%d\n",shm,major,minor,shmpixmaps);
449 xassert( shmim= XShmCreateImage(disp, attr.visual, attr.depth, ZPixmap,
450 0,&shminfo, wwidth,wheight) );
452 sigset_t oldset, all;
454 sysassert(! sigprocmask(SIG_BLOCK,&all,&oldset) );
458 sysassert(! pipe(pfd) );
459 sysassert( (cleaner= fork()) != -1 );
461 sysassert(! close(pfd[1]) );
463 int r= read(pfd[0], &shminfo.shmid, sizeof(shminfo.shmid));
465 if (r==sizeof(shminfo.shmid)) break;
466 assert(r==-1 && errno==EINTR);
470 int r= read(pfd[0],&bc,1);
472 assert(r==-1 && errno==EINTR);
474 sysassert(! shmctl(shminfo.shmid,IPC_RMID,0) );
477 sysassert(! close(pfd[0]) );
479 sysassert(! sigprocmask(SIG_SETMASK,&oldset,0) );
481 assert(shmim->height == wheight);
482 sysassert( (shminfo.shmid=
483 shmget(IPC_PRIVATE, shmim->bytes_per_line * wheight,
484 IPC_CREAT|0600)) >= 0 );
486 sysassert( write(pfd[1],&shminfo.shmid,sizeof(shminfo.shmid)) ==
487 sizeof(shminfo.shmid) );
488 sysassert( shminfo.shmaddr= shmat(shminfo.shmid,0,0) );
489 shmim->data= shminfo.shmaddr;
490 shminfo.readOnly= False;
491 xassert( XShmAttach(disp,&shminfo) );
493 close(pfd[1]); /* causes IPC_RMID */
497 static void set_focus_commodity(void) {
498 int screen= XScreenNumberOfScreen(attr.screen);
500 progress("taking control of YPP client window...");
502 debugf("PAGING set_focus\n");
504 mouse_1_updown(commod_focus_point.x, commod_focus_point.y);
508 xassert( XSelectInput(disp, id,
510 VisibilityChangeMask|
515 translate_coords_toroot_p(commod_page_point, &xpos,&ypos);
516 XTestFakeMotionEvent(disp, screen, xpos,ypos, 0);
520 debugf("PAGING raise_and_set_focus done.\n");
523 static CanonImage *convert_page(const Snapshot *sn) {
526 fwrite_ppmraw(screenshot_file, sn);
528 const unsigned char *pixel= sn->data;
529 CANONICALISE_IMAGE(im, sn->w, sn->h, {
535 sysassert(!ferror(screenshot_file));
536 sysassert(!fflush(screenshot_file));
541 static void prepare_ypp_client(void) {
545 /* find the window and check it's on the right kind of screen */
546 raise_and_get_details();
547 wait_for_stability(¤t,0,0, "checking current YPP client screen...");
549 test= convert_page(current);
550 find_structure(test, &max_relevant_y,
553 &commod_focuslast_point);
554 check_correct_commodities();
555 Rect sunshine= find_sunshine_widget();
557 progress("poking client...");
558 mouse_1_updown((sunshine.tl.x + sunshine.br.x) / 2,
559 (sunshine.tl.y*9 + sunshine.br.y) / 10);
563 wait_for_stability(¤t,0,0, "checking basic YPP client screen...");
564 mouse_1_updown(250, wheight-10);
565 mouse_1_updown_here();
566 mouse_1_updown_here();
568 check_not_disturbed();
575 wait_for_stability(&status,current,0, "awaiting status information...");
576 free_snapshot(¤t);
577 free_snapshot(&status);
580 void take_screenshots(void) {
581 Snapshot *current=0, *last=0;
583 prepare_ypp_client();
585 /* page to the top - keep pressing page up until the image stops changing */
586 set_focus_commodity();
587 wait_for_stability(¤t,0, send_pgup_many,
588 "paging up to top of commodity list...");
590 /* now to actually page down */
592 debugf("paging page %d\n",npages);
594 if (!(npages < MAX_PAGES))
595 fatal("Paging down seems to generate too many pages - max is %d.",
598 page_images[npages]= convert_page(current);
599 free_snapshot(&last); last=current; current=0;
601 debugf("PAGING page %d converted\n",npages);
603 wait_for_stability(¤t,last, 0,
604 "collecting screenshot of page %d...",
607 if (npages && /* first pagedown doesn't do much */
608 identical(current,last)) {
609 free_snapshot(¤t);
616 progress("finishing with the YPP client...");
617 mouse_1_updown(commod_focuslast_point.x, commod_focuslast_point.y);
619 send_pgdown_torestore();
622 debugf("PAGING all done.\n");
623 progress_log("collected %d screenshots.",npages);
626 void take_one_screenshot(void) {
629 prepare_ypp_client();
630 wait_for_stability(¤t,0,0, "taking screenshot...");
631 page_images[0]= convert_page(current);
633 progress_log("collected single screenshot.");
636 void set_yppclient_window(unsigned long wul) {
640 DEBUG_DEFINE_SOME_DEBUGF(findypp,debugfind)
646 static void findypp_recurse(int depth, int targetdepth, Window w) {
647 unsigned int nchildren;
650 Window gotroot, gotparent;
652 static const char prefix[]= "Puzzle Pirates - ";
653 static const char onthe[]= " on the ";
654 static const char suffix[]= " ocean";
655 #define S(x) ((int)sizeof((x))-1)
657 debugfind("FINDYPP %d/%d screen %d %*s %lx",
658 depth,targetdepth,screen,
659 depth,"",(unsigned long)w);
661 if (depth!=targetdepth) {
662 xassert( XQueryTree(disp,w,
664 &children,&nchildren) );
665 debugfind(" nchildren=%d\n",nchildren);
667 for (i=0; i<nchildren; i++) {
668 Window child= children[i];
669 findypp_recurse(depth+1, targetdepth, child);
678 unsigned long len, gotbytesafter;
680 unsigned char *gottitle=0;
681 xassert( !XGetWindowProperty(disp,w, wm_name,0,512, False,
682 AnyPropertyType,&gottype, &gotfmt, &len,
683 &gotbytesafter, &gottitle) );
684 title= (char*)gottitle;
686 if (DEBUGP(findypp)) {
687 debugfind(" gf=%d len=%lu gba=%lu \"", gotfmt,len,gotbytesafter);
689 for (p=title; p < title+len; p++) {
691 if (c>=' ' && c<=126) fputc(c,debug);
692 else fprintf(debug,"\\x%02x",c & 0xff);
697 #define REQUIRE(pred) \
698 if (!(pred)) { debugfind(" failed test %s\n", #pred); return; } \
701 REQUIRE( gottype!=None );
703 REQUIRE( gotfmt==8 );
705 REQUIRE( len >= S(prefix) + 1 + S(onthe) + 1 + S(suffix) );
707 char *spc1= strchr( title + S(prefix), ' '); REQUIRE(spc1);
708 char *spc2= strrchr((title + len) - S(suffix), ' '); REQUIRE(spc2);
710 REQUIRE( (title + len) - spc1 >= S(onthe) + S(suffix) );
711 REQUIRE( spc2 - title >= S(prefix) + S(onthe) );
713 REQUIRE( !memcmp(title, prefix, S(prefix)) );
714 REQUIRE( !memcmp(title + len - S(suffix), suffix, S(suffix)) );
715 REQUIRE( !memcmp(spc1, onthe, S(onthe)) );
717 #define ASSIGN(what, start, end) \
718 what= masprintf("%.*s", (int)((end)-(start)), start); \
719 if (o_##what) REQUIRE( !strcasecmp(o_##what, what) ); \
722 ASSIGN(ocean, spc1 + S(onthe), (title + len) - S(suffix));
723 ASSIGN(pirate, title + S(prefix), spc1);
725 debugfind(" YES!\n");
728 progress_log("found YPP client (0x%lx):"
730 (unsigned long)id, ocean, pirate);
733 void find_yppclient_window(void) {
740 progress("looking for YPP client window...");
742 xassert( (wm_name= XInternAtom(disp,"WM_NAME",True)) != None);
744 for (targetdepth=1; targetdepth<4; targetdepth++) {
745 for (screen=0; screen<ScreenCount(disp); screen++) {
746 debugfind("FINDYPP screen %d\n", screen);
747 findypp_recurse(0,targetdepth, RootWindow(disp,screen));
753 fatal("Found several possible YPP clients. Close one,\n"
754 " disambiguate with --pirate or --ocean,"
755 " or specify --window-id.\n");
757 fatal("Did not find %sYPP client."
758 " Use --window-id and/or report this as a fault.\n",
759 o_ocean || o_pirate ? "matching ": "");