added "passthrough" option for clickable global animations
[rocksndiamonds.git] / src / libgame / system.h
1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // system.h
10 // ============================================================================
11
12 #ifndef SYSTEM_H
13 #define SYSTEM_H
14
15 #include "platform.h"
16 #include "types.h"
17
18
19 #if defined(PLATFORM_MACOSX)
20 #include "macosx.h"
21 #elif defined(PLATFORM_WIN32)
22 #include "windows.h"
23 #elif defined(PLATFORM_ANDROID)
24 #include "android.h"
25 #endif
26
27 #include "sdl.h"
28
29
30 /* the additional 'b' is needed for Win32 to open files in binary mode */
31 #define MODE_READ                       "rb"
32 #define MODE_WRITE                      "wb"
33 #define MODE_APPEND                     "ab"
34
35 #define DEFAULT_DEPTH                   0
36
37 #define BLIT_OPAQUE                     0
38 #define BLIT_MASKED                     1
39 #define BLIT_INVERSE                    2
40 #define BLIT_ON_BACKGROUND              3
41
42 /* values for fullscreen status */
43 #define FULLSCREEN_NOT_AVAILABLE        FALSE
44 #define FULLSCREEN_AVAILABLE            TRUE
45
46 /* values for window scaling */
47 #define WINDOW_SCALING_NOT_AVAILABLE    FALSE
48 #define WINDOW_SCALING_AVAILABLE        TRUE
49
50 #define MIN_WINDOW_SCALING_PERCENT      30
51 #define STD_WINDOW_SCALING_PERCENT      100
52 #define MAX_WINDOW_SCALING_PERCENT      400
53 #define STEP_WINDOW_SCALING_PERCENT     10
54
55 /* values for window scaling quality */
56 #define SCALING_QUALITY_NEAREST         "nearest"
57 #define SCALING_QUALITY_LINEAR          "linear"
58 #define SCALING_QUALITY_BEST            "best"
59
60 #define SCALING_QUALITY_DEFAULT         SCALING_QUALITY_LINEAR
61
62 /* values for screen rendering mode */
63 #define STR_SPECIAL_RENDERING_OFF       "stream_texture_only"
64 #define STR_SPECIAL_RENDERING_BITMAP    "bitmap_and_stream_texture"
65 #define STR_SPECIAL_RENDERING_TARGET    "target_texture_only"
66 #define STR_SPECIAL_RENDERING_DOUBLE    "stream_and_target_texture"
67
68 #if defined(TARGET_SDL2)
69 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_DOUBLE
70 #else
71 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_BITMAP
72 #endif
73
74 #define SPECIAL_RENDERING_OFF           0
75 #define SPECIAL_RENDERING_BITMAP        1
76 #define SPECIAL_RENDERING_TARGET        2
77 #define SPECIAL_RENDERING_DOUBLE        3
78
79 #if defined(TARGET_SDL2)
80 #define SPECIAL_RENDERING_DEFAULT       SPECIAL_RENDERING_DOUBLE
81 #else
82 #define SPECIAL_RENDERING_DEFAULT       SPECIAL_RENDERING_BITMAP
83 #endif
84
85 /* values for touch control */
86 #define TOUCH_CONTROL_OFF               "off"
87 #define TOUCH_CONTROL_VIRTUAL_BUTTONS   "virtual_buttons"
88 #define TOUCH_CONTROL_WIPE_GESTURES     "wipe_gestures"
89 #define TOUCH_CONTROL_FOLLOW_FINGER     "follow_finger"
90
91 #if defined(PLATFORM_ANDROID)
92 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_VIRTUAL_BUTTONS
93 #else
94 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_OFF
95 #endif
96
97 #define TOUCH_MOVE_DISTANCE_DEFAULT     2
98 #define TOUCH_DROP_DISTANCE_DEFAULT     5
99 #define TOUCH_TRANSPARENCY_DEFAULT      50
100
101 #define ALPHA_FROM_TRANSPARENCY(x)      ((100 - x) * SDL_ALPHA_OPAQUE / 100)
102 #define ALPHA_FADING_STEPSIZE(x)        ((x) / 25)
103
104 /* values for special settings for mobile devices */
105 #if defined(PLATFORM_ANDROID)
106 #define USE_TOUCH_INPUT_OVERLAY
107 #define USE_COMPLETE_DISPLAY
108 #define HAS_SCREEN_KEYBOARD
109 #define SCREEN_KEYBOARD_POS(h)          ((h) / 2)
110 #endif
111
112 /* default input keys */
113 #define DEFAULT_KEY_LEFT                KSYM_Left
114 #define DEFAULT_KEY_RIGHT               KSYM_Right
115 #define DEFAULT_KEY_UP                  KSYM_Up
116 #define DEFAULT_KEY_DOWN                KSYM_Down
117 #if defined(PLATFORM_MACOSX)
118 #define DEFAULT_KEY_SNAP                KSYM_Control_L
119 #define DEFAULT_KEY_DROP                KSYM_KP_Enter
120 #else
121 #define DEFAULT_KEY_SNAP                KSYM_Control_L
122 #define DEFAULT_KEY_DROP                KSYM_Control_R
123 #endif
124 #define DEFAULT_KEY_OKAY                KSYM_Return
125 #define DEFAULT_KEY_CANCEL              KSYM_Escape
126
127 /* default shortcut keys */
128 #define DEFAULT_KEY_SAVE_GAME           KSYM_F1
129 #define DEFAULT_KEY_LOAD_GAME           KSYM_F2
130 #define DEFAULT_KEY_TOGGLE_PAUSE        KSYM_space
131 #define DEFAULT_KEY_FOCUS_PLAYER_1      KSYM_F5
132 #define DEFAULT_KEY_FOCUS_PLAYER_2      KSYM_F6
133 #define DEFAULT_KEY_FOCUS_PLAYER_3      KSYM_F7
134 #define DEFAULT_KEY_FOCUS_PLAYER_4      KSYM_F8
135 #define DEFAULT_KEY_FOCUS_PLAYER_ALL    KSYM_F9
136 #define DEFAULT_KEY_TAPE_EJECT          KSYM_UNDEFINED
137 #define DEFAULT_KEY_TAPE_EXTRA          KSYM_UNDEFINED
138 #define DEFAULT_KEY_TAPE_STOP           KSYM_UNDEFINED
139 #define DEFAULT_KEY_TAPE_PAUSE          KSYM_UNDEFINED
140 #define DEFAULT_KEY_TAPE_RECORD         KSYM_UNDEFINED
141 #define DEFAULT_KEY_TAPE_PLAY           KSYM_UNDEFINED
142 #define DEFAULT_KEY_SOUND_SIMPLE        KSYM_UNDEFINED
143 #define DEFAULT_KEY_SOUND_LOOPS         KSYM_UNDEFINED
144 #define DEFAULT_KEY_SOUND_MUSIC         KSYM_UNDEFINED
145 #define DEFAULT_KEY_SNAP_LEFT           KSYM_UNDEFINED
146 #define DEFAULT_KEY_SNAP_RIGHT          KSYM_UNDEFINED
147 #define DEFAULT_KEY_SNAP_UP             KSYM_UNDEFINED
148 #define DEFAULT_KEY_SNAP_DOWN           KSYM_UNDEFINED
149
150 /* default debug setup keys and values */
151 #define DEFAULT_FRAME_DELAY_0           20              // 100 % speed
152 #define DEFAULT_FRAME_DELAY_1           500             // 4 % speed
153 #define DEFAULT_FRAME_DELAY_2           250             // 8 % speed
154 #define DEFAULT_FRAME_DELAY_3           125             // 16 % speed
155 #define DEFAULT_FRAME_DELAY_4           60              // 33 % speed
156 #define DEFAULT_FRAME_DELAY_5           40              // 50 % speed
157 #define DEFAULT_FRAME_DELAY_6           30              // 66 % speed
158 #define DEFAULT_FRAME_DELAY_7           10              // 200 % speed
159 #define DEFAULT_FRAME_DELAY_8           5               // 400 % speed
160 #define DEFAULT_FRAME_DELAY_9           0               // maximum speed
161
162 #define DEFAULT_KEY_FRAME_DELAY_0       KSYM_0
163 #define DEFAULT_KEY_FRAME_DELAY_1       KSYM_1
164 #define DEFAULT_KEY_FRAME_DELAY_2       KSYM_2
165 #define DEFAULT_KEY_FRAME_DELAY_3       KSYM_3
166 #define DEFAULT_KEY_FRAME_DELAY_4       KSYM_4
167 #define DEFAULT_KEY_FRAME_DELAY_5       KSYM_5
168 #define DEFAULT_KEY_FRAME_DELAY_6       KSYM_6
169 #define DEFAULT_KEY_FRAME_DELAY_7       KSYM_7
170 #define DEFAULT_KEY_FRAME_DELAY_8       KSYM_8
171 #define DEFAULT_KEY_FRAME_DELAY_9       KSYM_9
172
173 #define NUM_DEBUG_FRAME_DELAY_KEYS      10
174
175 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
176 #define DEFAULT_FRAME_DELAY_GAME_ONLY   TRUE
177
178 /* values for key_status */
179 #define KEY_NOT_PRESSED                 FALSE
180 #define KEY_RELEASED                    FALSE
181 #define KEY_PRESSED                     TRUE
182
183 /* values for button status */
184 #define MB_NOT_PRESSED                  FALSE
185 #define MB_NOT_RELEASED                 TRUE
186 #define MB_RELEASED                     FALSE
187 #define MB_PRESSED                      TRUE
188 #define MB_MENU_CHOICE                  FALSE
189 #define MB_MENU_MARK                    TRUE
190 #define MB_MENU_INITIALIZE              (-1)
191 #define MB_MENU_LEAVE                   (-2)
192 #define MB_LEFTBUTTON                   1
193 #define MB_MIDDLEBUTTON                 2
194 #define MB_RIGHTBUTTON                  3
195 #define MB_WHEEL_UP                     4
196 #define MB_WHEEL_DOWN                   5
197 #define MB_WHEEL_LEFT                   6
198 #define MB_WHEEL_RIGHT                  7
199 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) == MB_WHEEL_UP ||          \
200                                          (b) == MB_WHEEL_DOWN)
201 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) == MB_WHEEL_LEFT ||        \
202                                          (b) == MB_WHEEL_RIGHT)
203 #define IS_WHEEL_BUTTON(b)              (IS_WHEEL_BUTTON_VERTICAL(b) || \
204                                          IS_WHEEL_BUTTON_HORIZONTAL(b))
205 #define DEFAULT_WHEEL_STEPS             3
206
207 #define BUTTON_STEPSIZE(b)              ((b) == MB_LEFTBUTTON   ?  1 :  \
208                                          (b) == MB_MIDDLEBUTTON ?  5 :  \
209                                          (b) == MB_RIGHTBUTTON  ? 10 : 1)
210
211 /* values for move directions */
212 #define MV_BIT_LEFT                     0
213 #define MV_BIT_RIGHT                    1
214 #define MV_BIT_UP                       2
215 #define MV_BIT_DOWN                     3
216
217 #define NUM_DIRECTIONS                  4
218
219 /* diagonal movement directions are used in a different contect than buttons */
220 #define MV_BIT_UPLEFT                   4
221 #define MV_BIT_UPRIGHT                  5
222 #define MV_BIT_DOWNLEFT                 6
223 #define MV_BIT_DOWNRIGHT                7
224
225 #define NUM_DIRECTIONS_FULL             8
226
227 /* values for special "button" bitmasks */
228 #define BUTTON_1                        4
229 #define BUTTON_2                        5
230
231 #define NUM_PLAYER_ACTIONS              6
232
233 /* values for special "focus player" bitmasks */
234 #define BIT_SET_FOCUS                   6
235
236 /* values for drawing stages for global animations */
237 #define DRAW_GLOBAL_ANIM_STAGE_1        1
238 #define DRAW_GLOBAL_ANIM_STAGE_2        2
239
240 /* values for drawing target (various functions) */
241 #define DRAW_TO_BACKBUFFER              0
242 #define DRAW_TO_FIELDBUFFER             1
243 #define DRAW_TO_SCREEN                  2
244 #define DRAW_TO_FADE_SOURCE             3
245 #define DRAW_TO_FADE_TARGET             4
246
247 /* values for move directions and special "button" key bitmasks */
248 #define MV_NONE                 0
249 #define MV_LEFT                 (1 << MV_BIT_LEFT)
250 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
251 #define MV_UP                   (1 << MV_BIT_UP)
252 #define MV_DOWN                 (1 << MV_BIT_DOWN)
253
254 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
255 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
256 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
257 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
258
259 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
260 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
261 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
262 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
263 #define MV_NO_DIRECTION         (MV_NONE)
264
265 #define KEY_BUTTON_1            (1 << BUTTON_1)
266 #define KEY_BUTTON_2            (1 << BUTTON_2)
267 #define KEY_BUTTON_SNAP         KEY_BUTTON_1
268 #define KEY_BUTTON_DROP         KEY_BUTTON_2
269 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
270 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
271 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
272
273 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
274
275 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
276                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
277                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
278                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
279                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
280                                  MV_NONE)
281
282 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
283                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
284                                  (x) == MV_UP        ? MV_BIT_UP        : \
285                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
286                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
287                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
288                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
289                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
290                                  MV_BIT_DOWN)
291
292 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
293                                  (x) == MV_RIGHT     ? MV_LEFT      : \
294                                  (x) == MV_UP        ? MV_DOWN      : \
295                                  (x) == MV_DOWN      ? MV_UP        : \
296                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
297                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
298                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
299                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
300                                  MV_NONE)
301
302 /* values for animation mode (frame order and direction) */
303 /* (stored in level files -- never change existing values) */
304 #define ANIM_NONE               0
305 #define ANIM_LOOP               (1 << 0)
306 #define ANIM_LINEAR             (1 << 1)
307 #define ANIM_PINGPONG           (1 << 2)
308 #define ANIM_PINGPONG2          (1 << 3)
309 #define ANIM_RANDOM             (1 << 4)
310 #define ANIM_CE_VALUE           (1 << 5)
311 #define ANIM_CE_SCORE           (1 << 6)
312 #define ANIM_CE_DELAY           (1 << 7)
313 #define ANIM_REVERSE            (1 << 8)
314 #define ANIM_OPAQUE_PLAYER      (1 << 9)
315
316 /* values for special (non game element) animation modes */
317 /* (not stored in level files -- can be changed, if needed) */
318 #define ANIM_HORIZONTAL         (1 << 10)
319 #define ANIM_VERTICAL           (1 << 11)
320 #define ANIM_CENTERED           (1 << 12)
321 #define ANIM_STATIC_PANEL       (1 << 13)
322 #define ANIM_ALL                (1 << 14)
323 #define ANIM_ONCE               (1 << 15)
324
325 #define ANIM_DEFAULT            ANIM_LOOP
326
327 /* values for special drawing styles (currently only for crumbled graphics) */
328 #define STYLE_NONE              0
329 #define STYLE_ACCURATE_BORDERS  (1 << 0)
330 #define STYLE_INNER_CORNERS     (1 << 1)
331 #define STYLE_REVERSE           (1 << 2)
332
333 /* values for special event handling style (used for global animation) */
334 #define STYLE_PASSTHROUGH       (1 << 3)
335
336 #define STYLE_DEFAULT           STYLE_NONE
337
338 /* values for special global animation events */
339 #define ANIM_EVENT_NONE         0
340 #define ANIM_EVENT_SELF         (1 << 16)
341 #define ANIM_EVENT_ANY          (1 << 17)
342
343 #define ANIM_EVENT_ANIM_BIT     0
344 #define ANIM_EVENT_PART_BIT     8
345
346 #define ANIM_EVENT_ANIM_MASK    (0xff << ANIM_EVENT_ANIM_BIT)
347 #define ANIM_EVENT_PART_MASK    (0xff << ANIM_EVENT_PART_BIT)
348
349 #define ANIM_EVENT_DEFAULT      ANIM_EVENT_NONE
350
351 /* values for special global animation event actions */
352 #define ANIM_EVENT_ACTION_NONE  -1
353
354 /* values for fade mode */
355 #define FADE_TYPE_NONE          0
356 #define FADE_TYPE_FADE_IN       (1 << 0)
357 #define FADE_TYPE_FADE_OUT      (1 << 1)
358 #define FADE_TYPE_TRANSFORM     (1 << 2)
359 #define FADE_TYPE_CROSSFADE     (1 << 3)
360 #define FADE_TYPE_MELT          (1 << 4)
361 #define FADE_TYPE_CURTAIN       (1 << 5)
362 #define FADE_TYPE_SKIP          (1 << 6)
363
364 #define FADE_MODE_NONE          (FADE_TYPE_NONE)
365 #define FADE_MODE_FADE_IN       (FADE_TYPE_FADE_IN)
366 #define FADE_MODE_FADE_OUT      (FADE_TYPE_FADE_OUT)
367 #define FADE_MODE_FADE          (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
368 #define FADE_MODE_TRANSFORM     (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
369 #define FADE_MODE_CROSSFADE     (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
370 #define FADE_MODE_MELT          (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
371 #define FADE_MODE_CURTAIN       (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
372 #define FADE_MODE_SKIP_FADE_IN  (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
373 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
374
375 #define FADE_MODE_DEFAULT       FADE_MODE_FADE
376
377 /* values for toon positions */
378 #define POS_UNDEFINED           -1
379 #define POS_LEFT                0
380 #define POS_RIGHT               1
381 #define POS_TOP                 2
382 #define POS_UPPER               3
383 #define POS_MIDDLE              4
384 #define POS_LOWER               5
385 #define POS_BOTTOM              6
386 #define POS_ANY                 7
387 #define POS_LAST                8
388
389 /* values for text alignment */
390 #define ALIGN_LEFT              (1 << 0)
391 #define ALIGN_RIGHT             (1 << 1)
392 #define ALIGN_CENTER            (1 << 2)
393 #define ALIGN_DEFAULT           ALIGN_LEFT
394
395 #define VALIGN_TOP              (1 << 0)
396 #define VALIGN_BOTTOM           (1 << 1)
397 #define VALIGN_MIDDLE           (1 << 2)
398 #define VALIGN_DEFAULT          VALIGN_TOP
399
400 #define ALIGNED_XPOS(x,w,a)     ((a) == ALIGN_CENTER  ? (x) - (w) / 2 : \
401                                  (a) == ALIGN_RIGHT   ? (x) - (w) : (x))
402 #define ALIGNED_YPOS(y,h,v)     ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
403                                  (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
404 #define ALIGNED_TEXT_XPOS(p)    ALIGNED_XPOS((p)->x, (p)->width,  (p)->align)
405 #define ALIGNED_TEXT_YPOS(p)    ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
406
407 /* values for redraw_mask */
408 #define REDRAW_NONE             (0)
409 #define REDRAW_ALL              (1 << 0)
410 #define REDRAW_FIELD            (1 << 1)
411 #define REDRAW_DOOR_1           (1 << 2)
412 #define REDRAW_DOOR_2           (1 << 3)
413 #define REDRAW_DOOR_3           (1 << 4)
414 #define REDRAW_FPS              (1 << 5)
415
416 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
417                                  REDRAW_DOOR_2 | \
418                                  REDRAW_DOOR_3)
419
420 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
421                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
422 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
423                                  x <  gfx.real_sx + gfx.full_sxsize && \
424                                  y >= gfx.real_sy && \
425                                  y <  gfx.real_sy + gfx.full_sysize)
426 #define IN_GFX_DOOR_1(x, y)     (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
427                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
428 #define IN_GFX_DOOR_2(x, y)     (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
429                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
430 #define IN_GFX_DOOR_3(x, y)     (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
431                                  y >= gfx.ey && y < gfx.ey + gfx.eysize)
432
433 /* values for mouse cursor */
434 #define CURSOR_DEFAULT          0
435 #define CURSOR_NONE             1
436 #define CURSOR_PLAYFIELD        2
437
438 /* fundamental game speed values */
439 #define ONE_SECOND_DELAY        1000    /* delay value for one second */
440 #define MENU_FRAME_DELAY        20      /* frame delay in milliseconds */
441 #define GAME_FRAME_DELAY        20      /* frame delay in milliseconds */
442 #define FFWD_FRAME_DELAY        10      /* 200% speed for fast forward */
443 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
444 #define FRAMES_PER_SECOND_SP    35
445
446 /* maximum playfield size supported by libgame functions */
447 #define MAX_PLAYFIELD_WIDTH     128
448 #define MAX_PLAYFIELD_HEIGHT    128
449
450 /* maximum number of parallel players supported by libgame functions */
451 #define MAX_PLAYERS             4
452
453 /* maximum allowed length of player name */
454 #define MAX_PLAYER_NAME_LEN     10
455
456 /* maximum number of levels in a level set */
457 #define MAX_LEVELS              1000
458
459 /* maximum number of global animation and parts */
460 #define MAX_GLOBAL_ANIMS                32
461 #define MAX_GLOBAL_ANIM_PARTS           32
462
463 /* minimum/maximum/default x/y grid size for virtual buttons */
464 #define MIN_GRID_XSIZE                  3
465 #define MIN_GRID_YSIZE                  3
466 #define MAX_GRID_XSIZE                  32
467 #define MAX_GRID_YSIZE                  32
468 #define GRID_REAL_WIDTH                 MAX(1, MAX(video.screen_width,  \
469                                                    video.screen_height))
470 #define GRID_REAL_HEIGHT                MAX(1, MIN(video.screen_width,  \
471                                                    video.screen_height))
472 #define DEFAULT_GRID_XSIZE_0            18
473 #define DEFAULT_GRID_YSIZE_0            MIN(MAX(MIN_GRID_YSIZE,         \
474                                                 DEFAULT_GRID_XSIZE_0 *  \
475                                                 GRID_REAL_HEIGHT /      \
476                                                 GRID_REAL_WIDTH),       \
477                                             MAX_GRID_YSIZE)
478 #define DEFAULT_GRID_XSIZE_1            13
479 #define DEFAULT_GRID_YSIZE_1            MIN(MAX(MIN_GRID_YSIZE,         \
480                                                 DEFAULT_GRID_XSIZE_1 *  \
481                                                 GRID_REAL_WIDTH /       \
482                                                 GRID_REAL_HEIGHT),      \
483                                             MAX_GRID_YSIZE)
484
485 #define DEFAULT_GRID_XSIZE(n)           ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
486                                          DEFAULT_GRID_XSIZE_1)
487 #define DEFAULT_GRID_YSIZE(n)           ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
488                                          DEFAULT_GRID_YSIZE_1)
489
490 #define GRID_ACTIVE_NR()                (video.screen_width >   \
491                                          video.screen_height ? 0 : 1)
492
493 /* values for grid button characters for virtual buttons */
494 #define CHAR_GRID_BUTTON_NONE           ' '
495 #define CHAR_GRID_BUTTON_LEFT           '<'
496 #define CHAR_GRID_BUTTON_RIGHT          '>'
497 #define CHAR_GRID_BUTTON_UP             '^'
498 #define CHAR_GRID_BUTTON_DOWN           'v'
499 #define CHAR_GRID_BUTTON_SNAP           '1'
500 #define CHAR_GRID_BUTTON_DROP           '2'
501
502 #define GET_ACTION_FROM_GRID_BUTTON(c)  ((c) == CHAR_GRID_BUTTON_LEFT ?  \
503                                          JOY_LEFT :                      \
504                                          (c) == CHAR_GRID_BUTTON_RIGHT ? \
505                                          JOY_RIGHT :                     \
506                                          (c) == CHAR_GRID_BUTTON_UP ?    \
507                                          JOY_UP :                        \
508                                          (c) == CHAR_GRID_BUTTON_DOWN ?  \
509                                          JOY_DOWN :                      \
510                                          (c) == CHAR_GRID_BUTTON_SNAP ?  \
511                                          JOY_BUTTON_1 :                  \
512                                          (c) == CHAR_GRID_BUTTON_DROP ?  \
513                                          JOY_BUTTON_2 :                  \
514                                          JOY_NO_ACTION)
515
516 /* default name for empty highscore entry */
517 #define EMPTY_PLAYER_NAME       "no name"
518
519 /* default name for unknown player names */
520 #define ANONYMOUS_NAME          "anonymous"
521
522 /* default for other unknown names */
523 #define UNKNOWN_NAME            "unknown"
524
525 /* default name for new levels */
526 #define NAMELESS_LEVEL_NAME     "nameless level"
527
528 /* default text for non-existant artwork */
529 #define NOT_AVAILABLE           "(not available)"
530
531 /* default value for undefined filename */
532 #define UNDEFINED_FILENAME      "[NONE]"
533
534 /* default value for undefined levelset */
535 #define UNDEFINED_LEVELSET      "[NONE]"
536
537 /* default value for undefined parameter */
538 #define ARG_DEFAULT             "[DEFAULT]"
539
540 /* default values for undefined configuration file parameters */
541 #define ARG_UNDEFINED           "-1000000"
542 #define ARG_UNDEFINED_VALUE     (-1000000)
543
544 /* default value for off-screen positions */
545 #define POS_OFFSCREEN           (-1000000)
546
547 /* definitions for game sub-directories */
548 #ifndef RO_GAME_DIR
549 #define RO_GAME_DIR             "."
550 #endif
551
552 #ifndef RW_GAME_DIR
553 #define RW_GAME_DIR             "."
554 #endif
555
556 #define RO_BASE_PATH            RO_GAME_DIR
557 #define RW_BASE_PATH            RW_GAME_DIR
558
559 /* directory names */
560 #define GRAPHICS_DIRECTORY      "graphics"
561 #define SOUNDS_DIRECTORY        "sounds"
562 #define MUSIC_DIRECTORY         "music"
563 #define LEVELS_DIRECTORY        "levels"
564 #define TAPES_DIRECTORY         "tapes"
565 #define SCORES_DIRECTORY        "scores"
566 #define DOCS_DIRECTORY          "docs"
567 #define CACHE_DIRECTORY         "cache"
568 #define CONF_DIRECTORY          "conf"
569
570 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
571 #define SND_CLASSIC_SUBDIR      "snd_classic"
572 #define MUS_CLASSIC_SUBDIR      "mus_classic"
573
574 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
575 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
576 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
577
578 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
579 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
580 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
581
582 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
583
584 /* file names and filename extensions */
585 #define LEVELSETUP_DIRECTORY    "levelsetup"
586 #define SETUP_FILENAME          "setup.conf"
587 #define AUTOSETUP_FILENAME      "autosetup.conf"
588 #define LEVELSETUP_FILENAME     "levelsetup.conf"
589 #define EDITORSETUP_FILENAME    "editorsetup.conf"
590 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
591 #define HELPANIM_FILENAME       "helpanim.conf"
592 #define HELPTEXT_FILENAME       "helptext.conf"
593 #define LEVELINFO_FILENAME      "levelinfo.conf"
594 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
595 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
596 #define MUSICINFO_FILENAME      "musicinfo.conf"
597 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
598 #define LEVELTEMPLATE_FILENAME  "template.level"
599 #define LEVELFILE_EXTENSION     "level"
600 #define TAPEFILE_EXTENSION      "tape"
601 #define SCOREFILE_EXTENSION     "score"
602
603 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
604
605 #define LOG_OUT_BASENAME        "stdout.txt"
606 #define LOG_ERR_BASENAME        "stderr.txt"
607
608 #define LOG_OUT_ID              0
609 #define LOG_ERR_ID              1
610 #define NUM_LOGS                2
611
612 #define STRING_PARENT_DIRECTORY         ".."
613 #define STRING_TOP_DIRECTORY            "/"
614
615 #define CHAR_PATH_SEPARATOR_UNIX        '/'
616 #define CHAR_PATH_SEPARATOR_DOS         '\\'
617
618 #define STRING_PATH_SEPARATOR_UNIX      "/"
619 #define STRING_PATH_SEPARATOR_DOS       "\\"
620
621 #define STRING_NEWLINE_UNIX             "\n"
622 #define STRING_NEWLINE_DOS              "\r\n"
623
624 #if defined(PLATFORM_WIN32)
625 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
626 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
627 #define STRING_NEWLINE          STRING_NEWLINE_DOS
628 #else
629 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
630 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
631 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
632 #endif
633
634
635 /* areas in bitmap PIX_DOOR */
636 /* meaning in PIX_DB_DOOR: (3 PAGEs)
637    PAGEX1: 1. buffer for DOOR_1
638    PAGEX2: 2. buffer for DOOR_1
639    PAGEX3: buffer for animations
640 */
641
642 /* these values are hard-coded to be able to use them in initialization */
643 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
644 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
645
646 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
647 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
648 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
649 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
650 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
651 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
652 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
653 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
654 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
655 #define DOOR_GFX_PAGEY1         (0)
656 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
657
658
659 /* macros for version handling */
660 #define VERSION_PART_1(x)       ((x) / 1000000)
661 #define VERSION_PART_2(x)       (((x) % 1000000) / 10000)
662 #define VERSION_PART_3(x)       (((x) % 10000) / 100)
663 #define VERSION_PART_4(x)       ((x) % 100)
664
665 #define VERSION_SUPER(x)        VERSION_PART_1(x)
666 #define VERSION_MAJOR(x)        VERSION_PART_2(x)
667 #define VERSION_MINOR(x)        VERSION_PART_3(x)
668 #define VERSION_PATCH(x)        VERSION_PART_4(x)
669 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
670
671
672 /* macros for parent/child process identification */
673 #if defined(PLATFORM_UNIX)
674 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
675 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
676 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
677 #else
678 #define IS_PARENT_PROCESS()     TRUE
679 #define IS_CHILD_PROCESS()      FALSE
680 #define HAS_CHILD_PROCESS()     FALSE
681 #endif
682
683
684 /* values for artwork type */
685 #define ARTWORK_TYPE_GRAPHICS   0
686 #define ARTWORK_TYPE_SOUNDS     1
687 #define ARTWORK_TYPE_MUSIC      2
688
689 #define NUM_ARTWORK_TYPES       3
690
691
692 /* values for tree type (chosen to match artwork type) */
693 #define TREE_TYPE_UNDEFINED     -1
694 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
695 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
696 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
697 #define TREE_TYPE_LEVEL_DIR     3
698 #define TREE_TYPE_LEVEL_NR      4
699
700 #define NUM_TREE_TYPES          5
701
702 #define INFOTEXT_UNDEFINED      ""
703 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
704 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
705 #define INFOTEXT_MUSIC_DIR      "Custom Music"
706 #define INFOTEXT_LEVEL_DIR      "Level Sets"
707 #define INFOTEXT_LEVEL_NR       "Levels"
708
709 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_LEVEL_NR ?            \
710                                  INFOTEXT_LEVEL_NR :                    \
711                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
712                                  INFOTEXT_LEVEL_DIR :                   \
713                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
714                                  INFOTEXT_GRAPHICS_DIR :                \
715                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
716                                  INFOTEXT_SOUNDS_DIR :                  \
717                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
718                                  INFOTEXT_MUSIC_DIR :                   \
719                                  INFOTEXT_UNDEFINED)
720
721 /* values for artwork handling */
722 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
723                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
724                                  &(leveldir)->graphics_set :            \
725                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
726                                  &(leveldir)->sounds_set :              \
727                                  &(leveldir)->music_set)
728
729 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
730                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
731                                  (leveldir)->graphics_set :             \
732                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
733                                  (leveldir)->sounds_set :               \
734                                  (leveldir)->music_set)
735
736 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
737                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
738                                  &(leveldir)->graphics_path :           \
739                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
740                                  &(leveldir)->sounds_path :             \
741                                  &(leveldir)->music_path)
742
743 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
744                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
745                                  (leveldir)->graphics_path :            \
746                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
747                                  (leveldir)->sounds_path :              \
748                                  (leveldir)->music_path)
749
750 #define SETUP_ARTWORK_SET(setup, type)                                  \
751                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
752                                  (setup).graphics_set :                 \
753                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
754                                  (setup).sounds_set :                   \
755                                  (setup).music_set)
756
757 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
758                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
759                                  (setup).override_level_graphics :      \
760                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
761                                  (setup).override_level_sounds :        \
762                                  (setup).override_level_music)
763
764 #define GFX_OVERRIDE_ARTWORK(type)                                      \
765                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
766                                  gfx.override_level_graphics :          \
767                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
768                                  gfx.override_level_sounds :            \
769                                  gfx.override_level_music)
770
771 #define ARTWORK_FIRST_NODE(artwork, type)                               \
772                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
773                                  (artwork).gfx_first :                  \
774                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
775                                  (artwork).snd_first :                  \
776                                  (artwork).mus_first)
777
778 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
779                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
780                                  &(artwork).gfx_current_identifier :    \
781                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
782                                  &(artwork).snd_current_identifier :    \
783                                  &(artwork).mus_current_identifier)
784
785 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
786                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
787                                  (artwork).gfx_current_identifier :     \
788                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
789                                  (artwork).snd_current_identifier :     \
790                                  (artwork).mus_current_identifier)
791
792 #define ARTWORKINFO_FILENAME(type)                                      \
793                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
794                                  GRAPHICSINFO_FILENAME :                \
795                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
796                                  SOUNDSINFO_FILENAME :                  \
797                                  (type) == ARTWORK_TYPE_MUSIC ?         \
798                                  MUSICINFO_FILENAME : "")
799
800 #define ARTWORK_DIRECTORY(type)                                         \
801                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
802                                  GRAPHICS_DIRECTORY :                   \
803                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
804                                  SOUNDS_DIRECTORY :                     \
805                                  (type) == ARTWORK_TYPE_MUSIC ?         \
806                                  MUSIC_DIRECTORY : "")
807
808 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
809                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
810                                  options.graphics_directory :           \
811                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
812                                  options.sounds_directory :             \
813                                  (type) == ARTWORK_TYPE_MUSIC ?         \
814                                  options.music_directory : "")
815
816 #define UPDATE_BUSY_STATE()                     \
817 {                                               \
818   if (gfx.draw_busy_anim_function != NULL)      \
819     gfx.draw_busy_anim_function();              \
820 }
821
822
823 /* structure definitions */
824
825 struct ProgramInfo
826 {
827   char *command_basepath;       /* path to the program binary */
828   char *command_basename;       /* base filename of the program binary */
829
830   char *config_filename;        /* optional global program config filename */
831
832   char *maindata_path;          /* main game data (installation) directory */
833
834   char *userdata_subdir;        /* personal user game data directory */
835   char *userdata_path;          /* resulting full path to game data directory */
836
837   char *program_title;
838   char *window_title;
839   char *icon_title;
840
841   char *icon_filename;
842
843   char *cookie_prefix;
844
845   char *log_filename[NUM_LOGS];         /* log filenames for out/err messages */
846   FILE *log_file[NUM_LOGS];             /* log file handles for out/err files */
847   FILE *log_file_default[NUM_LOGS];     /* default log file handles (out/err) */
848
849   int version_super;
850   int version_major;
851   int version_minor;
852   int version_patch;
853   int version_ident;
854
855   char *version_string;
856
857   char *(*window_title_function)(void);
858   void (*exit_message_function)(char *, va_list);
859   void (*exit_function)(int);
860
861   boolean global_scores;
862   boolean many_scores_per_name;
863
864   boolean headless;
865 };
866
867 struct OptionInfo
868 {
869   char *server_host;
870   int server_port;
871
872   char *ro_base_directory;
873   char *rw_base_directory;
874   char *level_directory;
875   char *graphics_directory;
876   char *sounds_directory;
877   char *music_directory;
878   char *docs_directory;
879   char *conf_directory;
880
881   char *execute_command;
882
883   char *special_flags;
884
885   boolean mytapes;
886   boolean serveronly;
887   boolean network;
888   boolean verbose;
889   boolean debug;
890 };
891
892 struct VideoSystemInfo
893 {
894   int default_depth;
895   int width, height, depth;
896   int window_width, window_height;
897   int display_width, display_height;
898   int screen_width, screen_height;
899   int screen_xoffset, screen_yoffset;
900
901   boolean fullscreen_available;
902   boolean fullscreen_enabled;
903   boolean fullscreen_initial;
904
905   boolean window_scaling_available;
906   int window_scaling_percent;
907   char *window_scaling_quality;
908   int screen_rendering_mode;
909
910   unsigned int frame_delay;
911   unsigned int frame_delay_value;
912
913   boolean shifted_up;
914   int shifted_up_pos;
915   int shifted_up_pos_last;
916   unsigned int shifted_up_delay;
917   unsigned int shifted_up_delay_value;
918
919   boolean initialized;
920 };
921
922 struct AudioSystemInfo
923 {
924   boolean sound_available;
925   boolean loops_available;
926   boolean music_available;
927
928   boolean sound_enabled;
929   boolean sound_deactivated;    /* for temporarily disabling sound */
930
931   int mixer_pipe[2];
932   int mixer_pid;
933   char *device_name;
934   int device_fd;
935
936   int num_channels;
937   int music_channel;
938   int first_sound_channel;
939 };
940
941 struct FontBitmapInfo
942 {
943   Bitmap *bitmap;
944
945   int src_x, src_y;             /* start position of font characters */
946   int width, height;            /* width / height of font characters */
947
948   int offset_x;                 /* offset to next font character */
949   int offset_y;                 /* offset to next font character */
950
951   int draw_xoffset;             /* offset for drawing font characters */
952   int draw_yoffset;             /* offset for drawing font characters */
953
954   int num_chars;
955   int num_chars_per_line;
956 };
957
958 struct GfxInfo
959 {
960   int sx, sy;
961   int sxsize, sysize;
962   int real_sx, real_sy;
963   int full_sxsize, full_sysize;
964   int scrollbuffer_width, scrollbuffer_height;
965
966   int game_tile_size, standard_tile_size;
967
968   int dx, dy;
969   int dxsize, dysize;
970
971   int vx, vy;
972   int vxsize, vysize;
973
974   int ex, ey;
975   int exsize, eysize;
976
977   int win_xsize, win_ysize;
978
979   int draw_deactivation_mask;
980   int draw_background_mask;
981
982   Bitmap *field_save_buffer;
983
984   Bitmap *background_bitmap;
985   int background_bitmap_mask;
986
987   Bitmap *fade_bitmap_backup;
988   Bitmap *fade_bitmap_source;
989   Bitmap *fade_bitmap_target;
990   Bitmap *fade_bitmap_black;
991
992   int fade_border_source_status;
993   int fade_border_target_status;
994   Bitmap *masked_border_bitmap_ptr;
995
996   Bitmap *final_screen_bitmap;
997
998   boolean clipping_enabled;
999   int clip_x, clip_y;
1000   int clip_width, clip_height;
1001
1002   boolean override_level_graphics;
1003   boolean override_level_sounds;
1004   boolean override_level_music;
1005
1006   boolean draw_init_text;
1007
1008   int num_fonts;
1009   struct FontBitmapInfo *font_bitmap_info;
1010   int (*select_font_function)(int);
1011   int (*get_font_from_token_function)(char *);
1012
1013   int anim_random_frame;
1014
1015   void (*draw_busy_anim_function)(void);
1016   void (*draw_global_anim_function)(int, int);
1017   void (*draw_global_border_function)(int);
1018   void (*draw_tile_cursor_function)(int);
1019
1020   int cursor_mode;
1021 };
1022
1023 struct TileCursorInfo
1024 {
1025   boolean enabled;              /* tile cursor generally enabled or disabled */
1026   boolean active;               /* tile cursor activated (depending on game) */
1027   boolean moving;               /* tile cursor moving to target position */
1028
1029   int xpos, ypos;               /* tile cursor level playfield position */
1030   int x, y;                     /* tile cursor current screen position */
1031   int target_x, target_y;       /* tile cursor target screen position */
1032
1033   int sx, sy;                   /* tile cursor screen start position */
1034 };
1035
1036 struct OverlayInfo
1037 {
1038   boolean enabled;              /* overlay generally enabled or disabled */
1039   boolean active;               /* overlay activated (depending on game mode) */
1040
1041   boolean show_grid;
1042
1043   int grid_xsize;
1044   int grid_ysize;
1045
1046   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1047   char grid_button_highlight;
1048
1049   int grid_button_action;
1050 };
1051
1052 struct JoystickInfo
1053 {
1054   int status;
1055   int nr[MAX_PLAYERS];          /* joystick number for each player */
1056 };
1057
1058 struct SetupJoystickInfo
1059 {
1060   char *device_name;            /* device name of player's joystick */
1061
1062   int xleft, xmiddle, xright;
1063   int yupper, ymiddle, ylower;
1064   int snap, drop;
1065 };
1066
1067 struct SetupKeyboardInfo
1068 {
1069   Key left, right, up, down;
1070   Key snap, drop;
1071 };
1072
1073 struct SetupTouchInfo
1074 {
1075   char *control_type;
1076   int move_distance;
1077   int drop_distance;
1078
1079   int grid_xsize[2];
1080   int grid_ysize[2];
1081
1082   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1083
1084   int transparency;             /* in percent (0 == opaque, 100 == invisible) */
1085   boolean draw_outlined;
1086   boolean draw_pressed;
1087
1088   boolean grid_initialized;
1089 };
1090
1091 struct SetupInputInfo
1092 {
1093   boolean use_joystick;
1094   struct SetupJoystickInfo joy;
1095   struct SetupKeyboardInfo key;
1096 };
1097
1098 struct SetupEditorInfo
1099 {
1100   boolean el_boulderdash;
1101   boolean el_emerald_mine;
1102   boolean el_emerald_mine_club;
1103   boolean el_more;
1104   boolean el_sokoban;
1105   boolean el_supaplex;
1106   boolean el_diamond_caves;
1107   boolean el_dx_boulderdash;
1108
1109   boolean el_mirror_magic;
1110   boolean el_deflektor;
1111
1112   boolean el_chars;
1113   boolean el_steel_chars;
1114
1115   boolean el_classic;
1116   boolean el_custom;
1117   boolean el_user_defined;
1118   boolean el_dynamic;
1119
1120   boolean el_headlines;
1121
1122   boolean el_by_game;
1123   boolean el_by_type;
1124
1125   boolean show_element_token;
1126
1127   boolean use_template_for_new_levels;
1128 };
1129
1130 struct SetupAutoSetupInfo
1131 {
1132   int editor_zoom_tilesize;
1133 };
1134
1135 struct SetupEditorCascadeInfo
1136 {
1137   boolean el_bd;
1138   boolean el_em;
1139   boolean el_emc;
1140   boolean el_rnd;
1141   boolean el_sb;
1142   boolean el_sp;
1143   boolean el_dc;
1144   boolean el_dx;
1145   boolean el_mm;
1146   boolean el_df;
1147   boolean el_chars;
1148   boolean el_steel_chars;
1149   boolean el_ce;
1150   boolean el_ge;
1151   boolean el_ref;
1152   boolean el_user;
1153   boolean el_dynamic;
1154 };
1155
1156 struct SetupShortcutInfo
1157 {
1158   Key save_game;
1159   Key load_game;
1160   Key toggle_pause;
1161
1162   Key focus_player[MAX_PLAYERS];
1163   Key focus_player_all;
1164
1165   Key tape_eject;
1166   Key tape_extra;
1167   Key tape_stop;
1168   Key tape_pause;
1169   Key tape_record;
1170   Key tape_play;
1171
1172   Key sound_simple;
1173   Key sound_loops;
1174   Key sound_music;
1175
1176   Key snap_left;
1177   Key snap_right;
1178   Key snap_up;
1179   Key snap_down;
1180 };
1181
1182 struct SetupSystemInfo
1183 {
1184   char *sdl_videodriver;
1185   char *sdl_audiodriver;
1186   int audio_fragment_size;
1187 };
1188
1189 struct SetupInternalInfo
1190 {
1191   char *program_title;
1192   char *program_version;
1193   char *program_author;
1194   char *program_email;
1195   char *program_website;
1196   char *program_copyright;
1197   char *program_company;
1198
1199   char *program_icon_file;
1200
1201   char *default_graphics_set;
1202   char *default_sounds_set;
1203   char *default_music_set;
1204
1205   char *fallback_graphics_file;
1206   char *fallback_sounds_file;
1207   char *fallback_music_file;
1208
1209   char *default_level_series;
1210
1211   int default_window_width;
1212   int default_window_height;
1213
1214   boolean choose_from_top_leveldir;
1215   boolean show_scaling_in_title;
1216 };
1217
1218 struct SetupDebugInfo
1219 {
1220   int frame_delay[10];
1221   Key frame_delay_key[10];
1222   boolean frame_delay_use_mod_key;
1223   boolean frame_delay_game_only;
1224   boolean show_frames_per_second;
1225 };
1226
1227 struct SetupInfo
1228 {
1229   char *player_name;
1230
1231   boolean sound;
1232   boolean sound_loops;
1233   boolean sound_music;
1234   boolean sound_simple;
1235   boolean toons;
1236   boolean scroll_delay;
1237   boolean scroll_delay_value;
1238   char *engine_snapshot_mode;
1239   int engine_snapshot_memory;
1240   boolean fade_screens;
1241   boolean autorecord;
1242   boolean show_titlescreen;
1243   boolean quick_doors;
1244   boolean team_mode;
1245   boolean handicap;
1246   boolean skip_levels;
1247   boolean increment_levels;
1248   boolean time_limit;
1249   boolean fullscreen;
1250   int window_scaling_percent;
1251   char *window_scaling_quality;
1252   char *screen_rendering_mode;
1253   boolean ask_on_escape;
1254   boolean ask_on_escape_editor;
1255   boolean quick_switch;
1256   boolean input_on_focus;
1257   boolean prefer_aga_graphics;
1258   int game_frame_delay;
1259   boolean sp_show_border_elements;
1260   boolean small_game_graphics;
1261   boolean show_snapshot_buttons;
1262
1263   char *graphics_set;
1264   char *sounds_set;
1265   char *music_set;
1266   int override_level_graphics;          /* not boolean -- can also be "AUTO" */
1267   int override_level_sounds;            /* not boolean -- can also be "AUTO" */
1268   int override_level_music;             /* not boolean -- can also be "AUTO" */
1269
1270   int volume_simple;
1271   int volume_loops;
1272   int volume_music;
1273
1274   struct SetupAutoSetupInfo auto_setup;
1275   struct SetupEditorInfo editor;
1276   struct SetupEditorCascadeInfo editor_cascade;
1277   struct SetupShortcutInfo shortcut;
1278   struct SetupInputInfo input[MAX_PLAYERS];
1279   struct SetupTouchInfo touch;
1280   struct SetupSystemInfo system;
1281   struct SetupInternalInfo internal;
1282   struct SetupDebugInfo debug;
1283
1284   struct OptionInfo options;
1285 };
1286
1287 struct TreeInfo
1288 {
1289   struct TreeInfo **node_top;           /* topmost node in tree */
1290   struct TreeInfo *node_parent;         /* parent level directory info */
1291   struct TreeInfo *node_group;          /* level group sub-directory info */
1292   struct TreeInfo *next;                /* next level series structure node */
1293
1294   int cl_first;         /* internal control field for setup screen */
1295   int cl_cursor;        /* internal control field for setup screen */
1296
1297   int type;             /* type of tree content */
1298
1299   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1300
1301   char *subdir;         /* tree info sub-directory basename (may be ".") */
1302   char *fullpath;       /* complete path relative to tree base directory */
1303   char *basepath;       /* absolute base path of tree base directory */
1304   char *identifier;     /* identifier string for configuration files */
1305   char *name;           /* tree info name, as displayed in selection menues */
1306   char *name_sorting;   /* optional sorting name for correct name sorting */
1307   char *author;         /* level or artwork author name */
1308   char *year;           /* optional year of creation for levels or artwork */
1309
1310   char *program_title;     /* optional alternative text for program title */
1311   char *program_copyright; /* optional alternative text for program copyright */
1312   char *program_company;   /* optional alternative text for program company */
1313
1314   char *imported_from;  /* optional comment for imported levels or artwork */
1315   char *imported_by;    /* optional comment for imported levels or artwork */
1316   char *tested_by;      /* optional comment to name people who tested a set */
1317
1318   char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1319   char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1320   char *graphics_set;   /* optional custom graphics set (level tree only) */
1321   char *sounds_set;     /* optional custom sounds set (level tree only) */
1322   char *music_set;      /* optional custom music set (level tree only) */
1323   char *graphics_path;  /* path to optional custom graphics set (level only) */
1324   char *sounds_path;    /* path to optional custom sounds set (level only) */
1325   char *music_path;     /* path to optional custom music set (level only) */
1326
1327   char *level_filename; /* filename of level file (for packed level file) */
1328   char *level_filetype; /* type of levels in level directory or level file */
1329
1330   char *special_flags;  /* flags for special actions performed on level file */
1331
1332   int levels;           /* number of levels in level series */
1333   int first_level;      /* first level number (to allow start with 0 or 1) */
1334   int last_level;       /* last level number (automatically calculated) */
1335   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
1336
1337   boolean latest_engine;/* force level set to use the latest game engine */
1338
1339   boolean level_group;  /* directory contains more level series directories */
1340   boolean parent_link;  /* entry links back to parent directory */
1341   boolean in_user_dir;  /* user defined levels are stored in home directory */
1342   boolean user_defined; /* levels in user directory and marked as "private" */
1343   boolean readonly;     /* readonly levels can not be changed with editor */
1344   boolean handicap;     /* level set has no handicap when set to "false" */
1345   boolean skip_levels;  /* levels can be skipped when set to "true" */
1346
1347   int color;            /* color to use on selection screen for this level */
1348   char *class_desc;     /* description of level series class */
1349   int handicap_level;   /* number of the lowest unsolved level */
1350
1351   char *infotext;       /* optional text to describe the tree type (headline) */
1352 };
1353
1354 typedef struct TreeInfo TreeInfo;
1355 typedef struct TreeInfo LevelDirTree;
1356 typedef struct TreeInfo ArtworkDirTree;
1357 typedef struct TreeInfo GraphicsDirTree;
1358 typedef struct TreeInfo SoundsDirTree;
1359 typedef struct TreeInfo MusicDirTree;
1360
1361 struct ArtworkInfo
1362 {
1363   GraphicsDirTree *gfx_first;
1364   GraphicsDirTree *gfx_current;
1365   SoundsDirTree *snd_first;
1366   SoundsDirTree *snd_current;
1367   MusicDirTree *mus_first;
1368   MusicDirTree *mus_current;
1369
1370   char *gfx_current_identifier;
1371   char *snd_current_identifier;
1372   char *mus_current_identifier;
1373 };
1374
1375 struct ValueTextInfo
1376 {
1377   int value;
1378   char *text;
1379 };
1380
1381 struct ConfigInfo
1382 {
1383   char *token;
1384   char *value;
1385 };
1386
1387 struct ConfigTypeInfo
1388 {
1389   char *token;
1390   char *value;
1391   int type;
1392 };
1393
1394 struct TokenIntPtrInfo
1395 {
1396   char *token;
1397   int *value;
1398 };
1399
1400 struct FileInfo
1401 {
1402   char *token;
1403
1404   char *default_filename;
1405   char *filename;
1406
1407   char **default_parameter;                     /* array of file parameters */
1408   char **parameter;                             /* array of file parameters */
1409
1410   boolean redefined;
1411   boolean fallback_to_default;
1412   boolean default_is_cloned;
1413 };
1414
1415 struct SetupFileList
1416 {
1417   char *token;
1418   char *value;
1419
1420   struct SetupFileList *next;
1421 };
1422
1423 struct ListNodeInfo
1424 {
1425   char *source_filename;                        /* primary key for node list */
1426   int num_references;
1427 };
1428
1429 struct PropertyMapping
1430 {
1431   int base_index;
1432   int ext1_index;
1433   int ext2_index;
1434   int ext3_index;
1435
1436   int artwork_index;
1437 };
1438
1439 struct ArtworkListInfo
1440 {
1441   int type;                                     /* type of artwork */
1442
1443   int num_file_list_entries;
1444   int num_dynamic_file_list_entries;
1445   struct FileInfo *file_list;                   /* static artwork file array */
1446   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
1447
1448   int num_suffix_list_entries;
1449   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
1450
1451   int num_base_prefixes;
1452   int num_ext1_suffixes;
1453   int num_ext2_suffixes;
1454   int num_ext3_suffixes;
1455   char **base_prefixes;                         /* base token prefixes array */
1456   char **ext1_suffixes;                         /* property suffixes array 1 */
1457   char **ext2_suffixes;                         /* property suffixes array 2 */
1458   char **ext3_suffixes;                         /* property suffixes array 3 */
1459
1460   int num_ignore_tokens;
1461   char **ignore_tokens;                         /* file tokens to be ignored */
1462
1463   int num_property_mapping_entries;
1464   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
1465
1466   int sizeof_artwork_list_entry;
1467
1468   struct ListNodeInfo **artwork_list;           /* static artwork node array */
1469   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
1470   struct ListNode *content_list;                /* dynamic artwork node list */
1471
1472   void *(*load_artwork)(char *);                /* constructor function */
1473   void (*free_artwork)(void *);                 /* destructor function */
1474 };
1475
1476 struct XY
1477 {
1478   int x, y;
1479 };
1480
1481 struct XYTileSize
1482 {
1483   int x, y;
1484   int tile_size;
1485 };
1486
1487 struct Rect
1488 {
1489   int x, y;
1490   int width, height;
1491 };
1492
1493 struct RectWithBorder
1494 {
1495   int x, y;
1496   int width, height;
1497   int border_size;
1498 };
1499
1500 struct MenuPosInfo
1501 {
1502   int x, y;
1503   int width, height;
1504   int align, valign;
1505 };
1506
1507 struct DoorPartPosInfo
1508 {
1509   int x, y;
1510   int step_xoffset;
1511   int step_yoffset;
1512   int step_delay;
1513   int start_step;
1514   int start_step_opening;
1515   int start_step_closing;
1516   boolean draw_masked;
1517   int sort_priority;
1518 };
1519
1520 struct TextPosInfo
1521 {
1522   int x, y;
1523   int xoffset;                  /* special case for tape date and time */
1524   int xoffset2;                 /* special case for tape date */
1525   int width, height;
1526   int align, valign;
1527   int size;                     /* also used for suffix ".digits" */
1528   int font, font_alt;
1529   boolean draw_masked;
1530   boolean draw_player;          /* special case for network player buttons */
1531   int sort_priority;            /* also used for suffix ".draw_order" */
1532   int id;
1533
1534   int direction;                /* needed for panel time/health graphics */
1535   int class;                    /* needed for panel time/health graphics */
1536   int style;                    /* needed for panel time/health graphics */
1537 };
1538
1539 struct MouseActionInfo
1540 {
1541   int lx, ly;
1542   int button;
1543   int button_hint;
1544 };
1545
1546 struct LevelStats
1547 {
1548   int played;
1549   int solved;
1550 };
1551
1552
1553 /* ========================================================================= */
1554 /* exported variables                                                        */
1555 /* ========================================================================= */
1556
1557 extern struct ProgramInfo       program;
1558 extern struct OptionInfo        options;
1559 extern struct VideoSystemInfo   video;
1560 extern struct AudioSystemInfo   audio;
1561 extern struct GfxInfo           gfx;
1562 extern struct TileCursorInfo    tile_cursor;
1563 extern struct OverlayInfo       overlay;
1564 extern struct AnimInfo          anim;
1565 extern struct ArtworkInfo       artwork;
1566 extern struct JoystickInfo      joystick;
1567 extern struct SetupInfo         setup;
1568
1569 extern LevelDirTree            *leveldir_first_all;
1570 extern LevelDirTree            *leveldir_first;
1571 extern LevelDirTree            *leveldir_current;
1572 extern int                      level_nr;
1573
1574 extern struct LevelStats        level_stats[];
1575
1576 extern DrawWindow              *window;
1577 extern DrawBuffer              *backbuffer;
1578 extern DrawBuffer              *drawto;
1579
1580 extern int                      button_status;
1581 extern boolean                  motion_status;
1582 extern int                      wheel_steps;
1583 #if defined(TARGET_SDL2)
1584 extern boolean                  keyrepeat_status;
1585 #endif
1586
1587 extern int                      redraw_mask;
1588
1589 extern int                      FrameCounter;
1590
1591
1592 /* function definitions */
1593
1594 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1595                      char *, int);
1596
1597 void InitScoresInfo();
1598 void SetWindowTitle();
1599
1600 void InitWindowTitleFunction(char *(*window_title_function)(void));
1601 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1602 void InitExitFunction(void (*exit_function)(int));
1603 void InitPlatformDependentStuff(void);
1604 void ClosePlatformDependentStuff(void);
1605
1606 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1607 void InitGfxTileSizeInfo(int, int);
1608 void InitGfxDoor1Info(int, int, int, int);
1609 void InitGfxDoor2Info(int, int, int, int);
1610 void InitGfxDoor3Info(int, int, int, int);
1611 void InitGfxWindowInfo(int, int);
1612 void InitGfxScrollbufferInfo(int, int);
1613 void InitGfxClipRegion(boolean, int, int, int, int);
1614 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1615 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1616 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1617 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1618 void InitGfxCustomArtworkInfo();
1619 void InitGfxOtherSettings();
1620 void InitTileCursorInfo();
1621 void InitOverlayInfo();
1622 void SetTileCursorEnabled(boolean);
1623 void SetTileCursorActive(boolean);
1624 void SetTileCursorTargetXY(int, int);
1625 void SetTileCursorXY(int, int);
1626 void SetTileCursorSXSY(int, int);
1627 void SetOverlayEnabled(boolean);
1628 void SetOverlayActive(boolean);
1629 void SetOverlayShowGrid(boolean);
1630 boolean GetOverlayActive();
1631 void SetDrawDeactivationMask(int);
1632 int GetDrawDeactivationMask(void);
1633 void SetDrawBackgroundMask(int);
1634 void SetWindowBackgroundBitmap(Bitmap *);
1635 void SetMainBackgroundBitmap(Bitmap *);
1636 void SetDoorBackgroundBitmap(Bitmap *);
1637 void SetRedrawMaskFromArea(int, int, int, int);
1638
1639 void LimitScreenUpdates(boolean);
1640
1641 void InitVideoDefaults(void);
1642 void InitVideoDisplay(void);
1643 void CloseVideoDisplay(void);
1644 void InitVideoBuffer(int, int, int, boolean);
1645 Bitmap *CreateBitmapStruct(void);
1646 Bitmap *CreateBitmap(int, int, int);
1647 void ReCreateBitmap(Bitmap **, int, int);
1648 void FreeBitmap(Bitmap *);
1649 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1650 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1651 void FadeRectangle(int, int, int, int, int, int, int,
1652                    void (*draw_border_function)(void));
1653 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1654 void ClearRectangle(Bitmap *, int, int, int, int);
1655 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1656 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1657 boolean DrawingDeactivatedField(void);
1658 boolean DrawingDeactivated(int, int, int, int);
1659 boolean DrawingOnBackground(int, int);
1660 boolean DrawingAreaChanged();
1661 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1662 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1663 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1664 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1665 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1666 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1667 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1668 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1669 Pixel GetPixel(Bitmap *, int, int);
1670 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1671 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1672
1673 void KeyboardAutoRepeatOn(void);
1674 void KeyboardAutoRepeatOff(void);
1675 boolean SetVideoMode(boolean);
1676 void SetVideoFrameDelay(unsigned int);
1677 unsigned int GetVideoFrameDelay();
1678 boolean ChangeVideoModeIfNeeded(boolean);
1679
1680 Bitmap *LoadImage(char *);
1681 Bitmap *LoadCustomImage(char *);
1682 void ReloadCustomImage(Bitmap *, char *);
1683
1684 void ReCreateGameTileSizeBitmap(Bitmap **);
1685 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1686 void CreateBitmapTextures(Bitmap **);
1687 void FreeBitmapTextures(Bitmap **);
1688 void ScaleBitmap(Bitmap **, int);
1689
1690 void SetMouseCursor(int);
1691
1692 void OpenAudio(void);
1693 void CloseAudio(void);
1694 void SetAudioMode(boolean);
1695
1696 boolean PendingEvent(void);
1697 void WaitEvent(Event *event);
1698 void PeekEvent(Event *event);
1699 void CheckQuitEvent(void);
1700 Key GetEventKey(KeyEvent *, boolean);
1701 KeyMod HandleKeyModState(Key, int);
1702 KeyMod GetKeyModState();
1703 KeyMod GetKeyModStateFromEvents();
1704 void StartTextInput(int, int, int, int);
1705 void StopTextInput();
1706 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1707
1708 void InitJoysticks();
1709 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1710 boolean CheckJoystickOpened(int);
1711 void ClearJoystickState();
1712
1713 #endif /* SYSTEM_H */