yarrg/convert.h

   1 /*
   2  * general header file for yarrg
   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 #ifndef CONVERT_H
  29 #define CONVERT_H
  30
  31 #include "common.h"
  32 #include "ocr.h"
  33
  34 #include <pam.h>
  35 #include <time.h>
  36 #include <limits.h>
  37
  38 #include <sys/time.h>
  39
  40
  41 /*----- from rgbimage.c -----*/
  42
  43 #define MAXIMGIDENT 100
  44
  45 typedef uint32_t Rgb; /* red<<0 | green<<8 | blue<<16 */
  46
  47 typedef struct RgbImage {
  48   int w, h;
  49   Rgb data[]; /* data[ y*w + x ] */
  50 } RgbImage;
  51
  52 void identify_rgbimage(const RgbImage *base, Rect portion,
  53                        char result[MAXIMGIDENT], const char *what);
  54 RgbImage *alloc_rgb_image(int w, int h);
  55 void fwrite_ppmraw(FILE *f, const RgbImage *ri);
  56
  57 #define RI_PIXEL32(ri,x,y) ((ri)->data + ((y)*(ri)->w + (x)))
  58
  59 static inline Rgb ri_rgb(const RgbImage *ri, int x, int y) {
  60   return *RI_PIXEL32(ri,x,y);
  61 }
  62
  63 /*----- from structure.c -----*/
  64
  65 typedef struct PageStruct PageStruct;
  66
  67 void find_structure(const CanonImage *im,
  68                     PageStruct **pagestruct_r, /* caller must free() */
  69                     int *max_relevant_y_r,
  70                     Point *commod_focus_point_r,
  71                     Point *commod_page_point_r,
  72                     Point *commod_focuslast_point_r);
  73 void store_current_page(CanonImage *ci /*pointer saved*/,
  74                         PageStruct *pagestruct, /*freed*/
  75                         RgbImage *rgb /*freed*/);
  76 void adjust_colours(CanonImage *ci, const RgbImage *rgb);
  77
  78 void select_page(int page);
  79
  80 Rect find_sunshine_widget(void);
  81
  82 void canon_colour_prepare(void);
  83 void find_islandname(void);
  84 void check_correct_commodities(void);
  85 void read_screenshots(void);
  86 void read_one_screenshot(void);
  87 void analyse(FILE *tsv_output);
  88
  89 /*----- from convert.c -----*/
  90
  91 extern FILE *screenshot_file;
  92 void fetch_with_rsync(const char *stem);
  93 void fetch_with_rsync_gz(const char *stem);
  94
  95 void vwarning(const char *fmt, va_list) FMT(1,0);
  96 void warning(const char *fmt, ...)      FMT(1,2);
  97
  98 void vprogress(const char *fmt, va_list) FMT(1,0);
  99 void progress(const char *fmt, ...)      FMT(1,2);
 100
 101 void vprogress_log(const char *fmt, va_list) FMT(1,0);
 102 void progress_log(const char *fmt, ...)      FMT(1,2);
 103
 104 void vprogress_spinner(const char *fmt, va_list) FMT(1,0);
 105 void progress_spinner(const char *fmt, ...)      FMT(1,2);
 106
 107 enum flags {
 108   ff_singlepage=          000002,
 109   ff_testservers=         000004,
 110
 111   ff_charset_edit=        000010,
 112   ff_charset_allowedit=   000020,
 113   ff_charset_havelocal=   000040,
 114   ffm_charset=            000070,
 115
 116   ff_dict_fetch=          000100,
 117   ff_dict_submit=         000200,
 118   ff_dict_pirate=         000400,
 119   ffs_dict=               000700,
 120
 121   ff_needisland=          001000,
 122   ff_printisland=         002000,
 123   ff_upload=              004000,
 124
 125   ff_use_yarrg=           010000,
 126   ff_use_pctb=            020000,
 127   ffm_use=                070000,
 128
 129   ffs_printisland=        003000,
 130   ffs_upload=             005000,
 131 };
 132 extern enum flags o_flags;
 133
 134 enum mode {
 135   mf_findwindow=      00001,
 136   mf_screenshot=      00010,
 137   mf_readscreenshot=  00020,
 138   mf_analyse=         00100,
 139   mfm_special=        07000,
 140
 141   mode_findwindow=    00001,
 142   mode_screenshot=    00011,
 143   mode_analyse=       00120,
 144   mode_showcharset=   01000,
 145
 146   mode_all=           00111,
 147 };
 148 extern enum mode o_mode;
 149
 150 extern const char *o_ocean, *o_pirate;
 151 extern int o_quiet;
 152
 153 /*----- from pages.c -----*/
 154
 155 void screenshot_startup(void);
 156 void set_yppclient_window(unsigned long wul);
 157 void find_yppclient_window(void);
 158 void take_screenshots(void);
 159 void take_one_screenshot(void);
 160
 161 #define MAX_PAGES 1000
 162
 163 extern const CanonImage *page_images[MAX_PAGES];
 164 extern const RgbImage *page0_rgbimage;
 165 extern int npages;
 166
 167 extern const char *ocean, *pirate;
 168 extern char *archipelago, *island;
 169
 170
 171 #endif /*CONVERT_H*/