1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
25 #elif defined(PLATFORM_EMSCRIPTEN)
26 #include "emscripten.h"
32 // the additional 'b' is needed for Win32 to open files in binary mode
33 #define MODE_READ "rb"
34 #define MODE_WRITE "wb"
35 #define MODE_APPEND "ab"
37 #define DEFAULT_DEPTH 0
41 #define BLIT_INVERSE 2
42 #define BLIT_ON_BACKGROUND 3
44 // values for fullscreen status
45 #define FULLSCREEN_NOT_AVAILABLE FALSE
46 #define FULLSCREEN_AVAILABLE TRUE
48 // values for window scaling
49 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
50 #define WINDOW_SCALING_AVAILABLE TRUE
52 #define MIN_WINDOW_SCALING_PERCENT 30
53 #define STD_WINDOW_SCALING_PERCENT 100
54 #define MAX_WINDOW_SCALING_PERCENT 400
55 #define STEP_WINDOW_SCALING_PERCENT 10
57 // values for window scaling quality
58 #define SCALING_QUALITY_NEAREST "nearest"
59 #define SCALING_QUALITY_LINEAR "linear"
60 #define SCALING_QUALITY_BEST "best"
62 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
64 // values for screen rendering mode
65 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
66 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
67 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
68 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
70 #if defined(PLATFORM_EMSCRIPTEN)
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
73 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
76 #define SPECIAL_RENDERING_OFF 0
77 #define SPECIAL_RENDERING_BITMAP 1
78 #define SPECIAL_RENDERING_TARGET 2
79 #define SPECIAL_RENDERING_DOUBLE 3
81 // values for vertical screen retrace synchronization (vsync)
82 #define STR_VSYNC_MODE_OFF "off"
83 #define STR_VSYNC_MODE_NORMAL "normal"
84 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
86 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
88 #define VSYNC_MODE_OFF 0
89 #define VSYNC_MODE_NORMAL 1
90 #define VSYNC_MODE_ADAPTIVE -1
92 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
94 #define VSYNC_MODE_STR_TO_INT(s) \
95 (strEqual((s), STR_VSYNC_MODE_NORMAL) ? VSYNC_MODE_NORMAL : \
96 strEqual((s), STR_VSYNC_MODE_ADAPTIVE) ? VSYNC_MODE_ADAPTIVE : \
99 #define VSYNC_MODE_INT_TO_STR(i) \
100 ((i) == VSYNC_MODE_NORMAL ? STR_VSYNC_MODE_NORMAL : \
101 (i) == VSYNC_MODE_ADAPTIVE ? STR_VSYNC_MODE_ADAPTIVE : \
104 // values for network server settings
105 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
106 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
108 // values for API server settings
109 #define API_SERVER_HOSTNAME "api.artsoft.org"
110 #define API_SERVER_PORT 80
111 #define API_SERVER_METHOD "POST"
112 #define API_SERVER_URI_ADD "/api/scores/add"
114 // values for touch control
115 #define TOUCH_CONTROL_OFF "off"
116 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
117 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
118 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
120 #if defined(PLATFORM_ANDROID)
121 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
123 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
126 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
127 #define TOUCH_DROP_DISTANCE_DEFAULT 5
128 #define TOUCH_TRANSPARENCY_DEFAULT 50
130 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
131 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
133 // values for special settings for mobile devices
134 #if defined(PLATFORM_ANDROID)
135 #define HAS_TOUCH_DEVICE
136 #define USE_TOUCH_INPUT_OVERLAY
137 #define USE_COMPLETE_DISPLAY
138 #define HAS_SCREEN_KEYBOARD
139 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
142 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
143 #if !SDL_VERSION_ATLEAST(2,0,5)
144 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
145 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
146 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
149 // default input keys
150 #define DEFAULT_KEY_LEFT KSYM_Left
151 #define DEFAULT_KEY_RIGHT KSYM_Right
152 #define DEFAULT_KEY_UP KSYM_Up
153 #define DEFAULT_KEY_DOWN KSYM_Down
154 #if defined(PLATFORM_MACOSX)
155 #define DEFAULT_KEY_SNAP KSYM_Control_L
156 #define DEFAULT_KEY_DROP KSYM_KP_Enter
158 #define DEFAULT_KEY_SNAP KSYM_Control_L
159 #define DEFAULT_KEY_DROP KSYM_Control_R
161 #define DEFAULT_KEY_OKAY KSYM_Return
162 #define DEFAULT_KEY_CANCEL KSYM_Escape
164 // default shortcut keys
165 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
166 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
167 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
168 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
169 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
170 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
171 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
172 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
173 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
174 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
175 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
176 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
177 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
178 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
179 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
180 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
181 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
182 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
183 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
184 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
185 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
187 // default debug setup keys and values
188 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
189 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
190 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
191 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
192 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
193 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
194 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
195 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
196 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
197 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
199 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
200 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
201 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
202 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
203 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
204 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
205 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
206 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
207 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
208 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
210 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
212 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
213 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
215 // values for key_status
216 #define KEY_NOT_PRESSED FALSE
217 #define KEY_RELEASED FALSE
218 #define KEY_PRESSED TRUE
220 // values for button status
221 #define MB_NOT_PRESSED FALSE
222 #define MB_NOT_RELEASED TRUE
223 #define MB_RELEASED FALSE
224 #define MB_PRESSED TRUE
225 #define MB_MENU_CHOICE FALSE
226 #define MB_MENU_MARK TRUE
227 #define MB_MENU_INITIALIZE (-1)
228 #define MB_MENU_LEAVE (-2)
229 #define MB_LEFTBUTTON 1
230 #define MB_MIDDLEBUTTON 2
231 #define MB_RIGHTBUTTON 3
232 #define MB_WHEEL_UP 4
233 #define MB_WHEEL_DOWN 5
234 #define MB_WHEEL_LEFT 6
235 #define MB_WHEEL_RIGHT 7
236 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
237 (b) == MB_WHEEL_DOWN)
238 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
239 (b) == MB_WHEEL_RIGHT)
240 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
241 IS_WHEEL_BUTTON_HORIZONTAL(b))
242 #define DEFAULT_WHEEL_STEPS 3
244 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
245 (b) == MB_MIDDLEBUTTON ? 5 : \
246 (b) == MB_RIGHTBUTTON ? 10 : 1)
248 // values for move directions
249 #define MV_BIT_LEFT 0
250 #define MV_BIT_RIGHT 1
252 #define MV_BIT_DOWN 3
254 #define NUM_DIRECTIONS 4
256 // diagonal movement directions are used in a different contect than buttons
257 #define MV_BIT_UPLEFT 4
258 #define MV_BIT_UPRIGHT 5
259 #define MV_BIT_DOWNLEFT 6
260 #define MV_BIT_DOWNRIGHT 7
262 #define NUM_DIRECTIONS_FULL 8
264 // values for special "button" bitmasks
268 #define NUM_PLAYER_ACTIONS 6
270 // values for special "focus player" bitmasks
271 #define BIT_SET_FOCUS 6
273 // values for drawing stages for global animations
274 #define DRAW_GLOBAL_ANIM_STAGE_1 1
275 #define DRAW_GLOBAL_ANIM_STAGE_2 2
277 // values for drawing target (various functions)
278 #define DRAW_TO_BACKBUFFER 0
279 #define DRAW_TO_FIELDBUFFER 1
280 #define DRAW_TO_SCREEN 2
281 #define DRAW_TO_FADE_SOURCE 3
282 #define DRAW_TO_FADE_TARGET 4
284 // values for move directions and special "button" key bitmasks
286 #define MV_LEFT (1 << MV_BIT_LEFT)
287 #define MV_RIGHT (1 << MV_BIT_RIGHT)
288 #define MV_UP (1 << MV_BIT_UP)
289 #define MV_DOWN (1 << MV_BIT_DOWN)
291 #define MV_UPLEFT (MV_UP | MV_LEFT)
292 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
293 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
294 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
296 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
297 #define MV_VERTICAL (MV_UP | MV_DOWN)
298 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
299 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
300 #define MV_NO_DIRECTION (MV_NONE)
302 #define KEY_BUTTON_1 (1 << BUTTON_1)
303 #define KEY_BUTTON_2 (1 << BUTTON_2)
304 #define KEY_BUTTON_SNAP KEY_BUTTON_1
305 #define KEY_BUTTON_DROP KEY_BUTTON_2
306 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
307 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
308 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
310 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
312 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
313 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
314 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
315 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
316 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
319 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
320 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
321 (x) == MV_UP ? MV_BIT_UP : \
322 (x) == MV_DOWN ? MV_BIT_DOWN : \
323 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
324 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
325 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
326 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
329 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
330 (x) == MV_RIGHT ? MV_LEFT : \
331 (x) == MV_UP ? MV_DOWN : \
332 (x) == MV_DOWN ? MV_UP : \
333 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
334 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
335 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
336 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
339 // values for animation mode (frame order and direction)
340 // (stored in level files -- never change existing values)
342 #define ANIM_LOOP (1 << 0)
343 #define ANIM_LINEAR (1 << 1)
344 #define ANIM_PINGPONG (1 << 2)
345 #define ANIM_PINGPONG2 (1 << 3)
346 #define ANIM_RANDOM (1 << 4)
347 #define ANIM_CE_VALUE (1 << 5)
348 #define ANIM_CE_SCORE (1 << 6)
349 #define ANIM_CE_DELAY (1 << 7)
350 #define ANIM_REVERSE (1 << 8)
351 #define ANIM_OPAQUE_PLAYER (1 << 9)
353 // values for special (non game element) animation modes
354 // (not stored in level files -- can be changed, if needed)
355 #define ANIM_HORIZONTAL (1 << 10)
356 #define ANIM_VERTICAL (1 << 11)
357 #define ANIM_CENTERED (1 << 12)
358 #define ANIM_STATIC_PANEL (1 << 13)
359 #define ANIM_ALL (1 << 14)
360 #define ANIM_ONCE (1 << 15)
362 #define ANIM_DEFAULT ANIM_LOOP
364 // values for special drawing styles and event handling
367 // values used for crumbled graphics
368 #define STYLE_ACCURATE_BORDERS (1 << 0)
369 #define STYLE_INNER_CORNERS (1 << 1)
371 // values used for game panel graphics
372 #define STYLE_REVERSE (1 << 2)
373 #define STYLE_LEFTMOST_POSITION (1 << 3)
375 // values used for global animations
376 #define STYLE_BLOCK (1 << 4)
377 #define STYLE_PASSTHROUGH (1 << 5)
378 #define STYLE_MULTIPLE_ACTIONS (1 << 6)
380 #define STYLE_DEFAULT STYLE_NONE
382 // values for special global animation delay types
383 #define ANIM_DELAY_UNDEFINED -1
384 #define ANIM_DELAY_NONE 0
385 #define ANIM_DELAY_INIT 1
386 #define ANIM_DELAY_ANIM 2
387 #define ANIM_DELAY_POST 3
389 // values for special global animation delay actions
390 #define ANIM_DELAY_ACTION_NONE -1
392 // values for special global animation events
393 #define ANIM_EVENT_UNDEFINED -1
394 #define ANIM_EVENT_NONE 0
395 #define ANIM_EVENT_SELF (1 << 16)
396 #define ANIM_EVENT_ANY (1 << 17)
397 #define ANIM_EVENT_CLICK (1 << 18)
398 #define ANIM_EVENT_INIT (1 << 19)
399 #define ANIM_EVENT_START (1 << 20)
400 #define ANIM_EVENT_END (1 << 21)
401 #define ANIM_EVENT_POST (1 << 22)
402 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
404 // anim number: bits 0-7
405 // part number: bits 8-15
406 #define ANIM_EVENT_ANIM_BIT 0
407 #define ANIM_EVENT_PART_BIT 8
409 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
410 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
412 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
414 // values for special global animation event actions
415 #define ANIM_EVENT_ACTION_NONE -1
417 // values for fade mode
418 #define FADE_TYPE_NONE 0
419 #define FADE_TYPE_FADE_IN (1 << 0)
420 #define FADE_TYPE_FADE_OUT (1 << 1)
421 #define FADE_TYPE_TRANSFORM (1 << 2)
422 #define FADE_TYPE_CROSSFADE (1 << 3)
423 #define FADE_TYPE_MELT (1 << 4)
424 #define FADE_TYPE_CURTAIN (1 << 5)
425 #define FADE_TYPE_SKIP (1 << 6)
427 #define FADE_MODE_NONE (FADE_TYPE_NONE)
428 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
429 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
430 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
431 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
432 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
433 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
434 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
435 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
436 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
438 #define FADE_MODE_DEFAULT FADE_MODE_FADE
440 #define AUTO_DELAY_UNIT_MS 0
441 #define AUTO_DELAY_UNIT_FRAMES 1
443 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
445 // values for toon positions
446 #define POS_UNDEFINED -1
457 // values for text alignment
458 #define ALIGN_LEFT (1 << 0)
459 #define ALIGN_RIGHT (1 << 1)
460 #define ALIGN_CENTER (1 << 2)
461 #define ALIGN_DEFAULT ALIGN_LEFT
463 #define VALIGN_TOP (1 << 0)
464 #define VALIGN_BOTTOM (1 << 1)
465 #define VALIGN_MIDDLE (1 << 2)
466 #define VALIGN_DEFAULT VALIGN_TOP
468 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
469 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
470 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
471 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
472 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
473 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
474 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
475 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
477 // values for redraw_mask
478 #define REDRAW_NONE (0)
479 #define REDRAW_ALL (1 << 0)
480 #define REDRAW_FIELD (1 << 1)
481 #define REDRAW_DOOR_1 (1 << 2)
482 #define REDRAW_DOOR_2 (1 << 3)
483 #define REDRAW_DOOR_3 (1 << 4)
484 #define REDRAW_FPS (1 << 5)
486 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
490 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
491 y >= gfx.sy && y < gfx.sy + gfx.sysize)
492 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
493 x < gfx.real_sx + gfx.full_sxsize && \
494 y >= gfx.real_sy && \
495 y < gfx.real_sy + gfx.full_sysize)
496 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
497 y >= gfx.dy && y < gfx.dy + gfx.dysize)
498 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
499 y >= gfx.vy && y < gfx.vy + gfx.vysize)
500 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
501 y >= gfx.ey && y < gfx.ey + gfx.eysize)
503 // values for mouse cursor
504 #define CURSOR_UNDEFINED -1
505 #define CURSOR_DEFAULT 0
506 #define CURSOR_NONE 1
507 #define CURSOR_PLAYFIELD 2
509 // fundamental game speed values
510 #define ONE_SECOND_DELAY 1000 // delay value for one second
511 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
512 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
513 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
514 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
515 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
516 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
517 #define FRAMES_PER_SECOND_SP 35
519 // maximum playfield size supported by libgame functions
520 #define MAX_PLAYFIELD_WIDTH 128
521 #define MAX_PLAYFIELD_HEIGHT 128
523 // maximum number of parallel players supported by libgame functions
524 #define MAX_PLAYERS 4
526 // maximum number of player names
527 #define MAX_PLAYER_NAMES 12
529 // maximum allowed length of player name
530 #define MAX_PLAYER_NAME_LEN 10
532 // maximum number of levels in a level set
533 #define MAX_LEVELS 1000
535 // maximum number of global animation and parts
536 #define MAX_GLOBAL_ANIMS 32
537 #define MAX_GLOBAL_ANIM_PARTS 32
539 // minimum/maximum/default x/y grid size for virtual buttons
540 #define MIN_GRID_XSIZE 3
541 #define MIN_GRID_YSIZE 3
542 #define MAX_GRID_XSIZE 32
543 #define MAX_GRID_YSIZE 32
544 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
545 video.screen_height))
546 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
547 video.screen_height))
548 #define DEFAULT_GRID_XSIZE_0 18
549 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
550 DEFAULT_GRID_XSIZE_0 * \
554 #define DEFAULT_GRID_XSIZE_1 13
555 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
556 DEFAULT_GRID_XSIZE_1 * \
561 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
562 DEFAULT_GRID_XSIZE_1)
563 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
564 DEFAULT_GRID_YSIZE_1)
566 #define GRID_ACTIVE_NR() (video.screen_width > \
567 video.screen_height ? 0 : 1)
569 // values for grid button characters for virtual buttons
570 #define CHAR_GRID_BUTTON_NONE ' '
571 #define CHAR_GRID_BUTTON_LEFT '<'
572 #define CHAR_GRID_BUTTON_RIGHT '>'
573 #define CHAR_GRID_BUTTON_UP '^'
574 #define CHAR_GRID_BUTTON_DOWN 'v'
575 #define CHAR_GRID_BUTTON_SNAP '1'
576 #define CHAR_GRID_BUTTON_DROP '2'
578 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
580 (c) == CHAR_GRID_BUTTON_RIGHT ? \
582 (c) == CHAR_GRID_BUTTON_UP ? \
584 (c) == CHAR_GRID_BUTTON_DOWN ? \
586 (c) == CHAR_GRID_BUTTON_SNAP ? \
588 (c) == CHAR_GRID_BUTTON_DROP ? \
592 // maximum number of level sets in the level set history
593 #define MAX_LEVELDIR_HISTORY 12
595 // default name for empty highscore entry
596 #define EMPTY_PLAYER_NAME "no name"
598 // default name for unknown player names
599 #define ANONYMOUS_NAME "anonymous"
601 // default for other unknown names
602 #define UNKNOWN_NAME "unknown"
604 // default name for new levels
605 #define NAMELESS_LEVEL_NAME "nameless level"
607 // default text for non-existant artwork
608 #define NOT_AVAILABLE "(not available)"
610 // default value for undefined filename
611 #define UNDEFINED_FILENAME "[NONE]"
613 // default value for undefined levelset
614 #define UNDEFINED_LEVELSET "[NONE]"
616 // default value for undefined parameter
617 #define ARG_DEFAULT "[DEFAULT]"
619 // default values for undefined configuration file parameters
620 #define ARG_UNDEFINED "-1000000"
621 #define ARG_UNDEFINED_VALUE (-1000000)
623 // default value for off-screen positions
624 #define POS_OFFSCREEN (-1000000)
626 // definitions for game sub-directories
628 #define RO_GAME_DIR "."
632 #define RW_GAME_DIR "."
635 #define RO_BASE_PATH RO_GAME_DIR
636 #define RW_BASE_PATH RW_GAME_DIR
639 #define GRAPHICS_DIRECTORY "graphics"
640 #define SOUNDS_DIRECTORY "sounds"
641 #define MUSIC_DIRECTORY "music"
642 #define LEVELS_DIRECTORY "levels"
643 #define TAPES_DIRECTORY "tapes"
644 #define SCORES_DIRECTORY "scores"
645 #define DOCS_DIRECTORY "docs"
646 #define CACHE_DIRECTORY "cache"
647 #define CONF_DIRECTORY "conf"
648 #define NETWORK_DIRECTORY "network"
649 #define USERS_DIRECTORY "users"
651 #define GFX_CLASSIC_SUBDIR "gfx_classic"
652 #define SND_CLASSIC_SUBDIR "snd_classic"
653 #define MUS_CLASSIC_SUBDIR "mus_classic"
655 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
656 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
657 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
659 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
660 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
661 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
663 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
665 // file names and filename extensions
666 #define LEVELSETUP_DIRECTORY "levelsetup"
667 #define SETUP_FILENAME "setup.conf"
668 #define USERSETUP_FILENAME "usersetup.conf"
669 #define AUTOSETUP_FILENAME "autosetup.conf"
670 #define LEVELSETUP_FILENAME "levelsetup.conf"
671 #define EDITORSETUP_FILENAME "editorsetup.conf"
672 #define EDITORCASCADE_FILENAME "editorcascade.conf"
673 #define HELPANIM_FILENAME "helpanim.conf"
674 #define HELPTEXT_FILENAME "helptext.conf"
675 #define LEVELINFO_FILENAME "levelinfo.conf"
676 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
677 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
678 #define MUSICINFO_FILENAME "musicinfo.conf"
679 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
680 #define LEVELTEMPLATE_FILENAME "template.level"
681 #define LEVELFILE_EXTENSION "level"
682 #define TAPEFILE_EXTENSION "tape"
683 #define SCOREFILE_EXTENSION "score"
685 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
687 #define LOG_OUT_BASENAME "stdout.txt"
688 #define LOG_ERR_BASENAME "stderr.txt"
694 #define STRING_PARENT_DIRECTORY ".."
695 #define STRING_TOP_DIRECTORY "/"
697 #define CHAR_PATH_SEPARATOR_UNIX '/'
698 #define CHAR_PATH_SEPARATOR_DOS '\\'
700 #define STRING_PATH_SEPARATOR_UNIX "/"
701 #define STRING_PATH_SEPARATOR_DOS "\\"
703 #define STRING_NEWLINE_UNIX "\n"
704 #define STRING_NEWLINE_DOS "\r\n"
706 #if defined(PLATFORM_WIN32)
707 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
708 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
709 #define STRING_NEWLINE STRING_NEWLINE_DOS
711 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
712 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
713 #define STRING_NEWLINE STRING_NEWLINE_UNIX
717 // areas in bitmap PIX_DOOR
718 // meaning in PIX_DB_DOOR: (3 PAGEs)
719 // PAGEX1: 1. buffer for DOOR_1
720 // PAGEX2: 2. buffer for DOOR_1
721 // PAGEX3: buffer for animations
723 // these values are hard-coded to be able to use them in initialization
724 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
725 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
727 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
728 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
729 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
730 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
731 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
732 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
733 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
734 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
735 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
736 #define DOOR_GFX_PAGEY1 (0)
737 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
740 // macros for version handling
741 #define VERSION_PART_1(x) ((x) / 1000000)
742 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
743 #define VERSION_PART_3(x) (((x) % 10000) / 100)
744 #define VERSION_PART_4(x) ((x) % 100)
746 #define VERSION_SUPER(x) VERSION_PART_1(x)
747 #define VERSION_MAJOR(x) VERSION_PART_2(x)
748 #define VERSION_MINOR(x) VERSION_PART_3(x)
749 #define VERSION_PATCH(x) VERSION_PART_4(x)
750 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
753 // macros for parent/child process identification
754 #if defined(PLATFORM_UNIX)
755 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
756 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
757 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
759 #define IS_PARENT_PROCESS() TRUE
760 #define IS_CHILD_PROCESS() FALSE
761 #define HAS_CHILD_PROCESS() FALSE
765 // values for artwork type
766 #define ARTWORK_TYPE_GRAPHICS 0
767 #define ARTWORK_TYPE_SOUNDS 1
768 #define ARTWORK_TYPE_MUSIC 2
770 #define NUM_ARTWORK_TYPES 3
773 // values for tree type (chosen to match artwork type)
774 #define TREE_TYPE_UNDEFINED -1
775 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
776 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
777 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
778 #define TREE_TYPE_LEVEL_DIR 3
779 #define TREE_TYPE_LEVEL_NR 4
780 #define TREE_TYPE_PLAYER_NAME 5
782 #define NUM_BASE_TREE_TYPES 4
783 #define NUM_TREE_TYPES 6
785 #define TREE_TYPE_IS_DIR(type) ((type) == TREE_TYPE_GRAPHICS_DIR || \
786 (type) == TREE_TYPE_SOUNDS_DIR || \
787 (type) == TREE_TYPE_MUSIC_DIR || \
788 (type) == TREE_TYPE_LEVEL_DIR)
790 #define INFOTEXT_UNDEFINED ""
791 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
792 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
793 #define INFOTEXT_MUSIC_DIR "Custom Music"
794 #define INFOTEXT_LEVEL_DIR "Level Sets"
795 #define INFOTEXT_LEVEL_NR "Levels"
796 #define INFOTEXT_PLAYER_NAME "Players & Teams"
798 #define BACKLINK_TEXT_MAIN ".. (main menu)"
799 #define BACKLINK_TEXT_SETUP ".. (setup menu)"
800 #define BACKLINK_TEXT_PARENT ".. (parent directory)"
802 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_PLAYER_NAME ? \
803 INFOTEXT_PLAYER_NAME : \
804 (t) == TREE_TYPE_LEVEL_NR ? \
805 INFOTEXT_LEVEL_NR : \
806 (t) == TREE_TYPE_LEVEL_DIR ? \
807 INFOTEXT_LEVEL_DIR : \
808 (t) == TREE_TYPE_GRAPHICS_DIR ? \
809 INFOTEXT_GRAPHICS_DIR : \
810 (t) == TREE_TYPE_SOUNDS_DIR ? \
811 INFOTEXT_SOUNDS_DIR : \
812 (t) == TREE_TYPE_MUSIC_DIR ? \
813 INFOTEXT_MUSIC_DIR : \
816 #define TREE_BACKLINK_TEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
817 BACKLINK_TEXT_MAIN : \
820 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
821 getUserLevelDir(NULL) : \
822 (t) == TREE_TYPE_GRAPHICS_DIR ? \
823 getUserGraphicsDir() : \
824 (t) == TREE_TYPE_SOUNDS_DIR ? \
825 getUserSoundsDir() : \
826 (t) == TREE_TYPE_MUSIC_DIR ? \
827 getUserMusicDir() : \
830 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
832 (t) == TREE_TYPE_GRAPHICS_DIR ? \
833 &artwork.gfx_first : \
834 (t) == TREE_TYPE_SOUNDS_DIR ? \
835 &artwork.snd_first : \
836 (t) == TREE_TYPE_MUSIC_DIR ? \
837 &artwork.mus_first : \
840 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
842 (t) == TREE_TYPE_GRAPHICS_DIR ? \
843 artwork.gfx_first : \
844 (t) == TREE_TYPE_SOUNDS_DIR ? \
845 artwork.snd_first : \
846 (t) == TREE_TYPE_MUSIC_DIR ? \
847 artwork.mus_first : \
850 // values for artwork handling
851 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
852 ((type) == ARTWORK_TYPE_GRAPHICS ? \
853 &(leveldir)->graphics_set : \
854 (type) == ARTWORK_TYPE_SOUNDS ? \
855 &(leveldir)->sounds_set : \
856 &(leveldir)->music_set)
858 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
859 ((type) == ARTWORK_TYPE_GRAPHICS ? \
860 (leveldir)->graphics_set : \
861 (type) == ARTWORK_TYPE_SOUNDS ? \
862 (leveldir)->sounds_set : \
863 (leveldir)->music_set)
865 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
866 ((type) == ARTWORK_TYPE_GRAPHICS ? \
867 &(leveldir)->graphics_path : \
868 (type) == ARTWORK_TYPE_SOUNDS ? \
869 &(leveldir)->sounds_path : \
870 &(leveldir)->music_path)
872 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
873 ((type) == ARTWORK_TYPE_GRAPHICS ? \
874 (leveldir)->graphics_path : \
875 (type) == ARTWORK_TYPE_SOUNDS ? \
876 (leveldir)->sounds_path : \
877 (leveldir)->music_path)
879 #define SETUP_ARTWORK_SET(setup, type) \
880 ((type) == ARTWORK_TYPE_GRAPHICS ? \
881 (setup).graphics_set : \
882 (type) == ARTWORK_TYPE_SOUNDS ? \
883 (setup).sounds_set : \
886 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
887 ((type) == ARTWORK_TYPE_GRAPHICS ? \
888 (setup).override_level_graphics : \
889 (type) == ARTWORK_TYPE_SOUNDS ? \
890 (setup).override_level_sounds : \
891 (setup).override_level_music)
893 #define GFX_OVERRIDE_ARTWORK(type) \
894 ((type) == ARTWORK_TYPE_GRAPHICS ? \
895 gfx.override_level_graphics : \
896 (type) == ARTWORK_TYPE_SOUNDS ? \
897 gfx.override_level_sounds : \
898 gfx.override_level_music)
900 #define ARTWORK_FIRST_NODE(artwork, type) \
901 ((type) == ARTWORK_TYPE_GRAPHICS ? \
902 (artwork).gfx_first : \
903 (type) == ARTWORK_TYPE_SOUNDS ? \
904 (artwork).snd_first : \
907 #define ARTWORK_CURRENT_PTR(artwork, type) \
908 ((type) == ARTWORK_TYPE_GRAPHICS ? \
909 &(artwork).gfx_current : \
910 (type) == ARTWORK_TYPE_SOUNDS ? \
911 &(artwork).snd_current : \
912 &(artwork).mus_current)
914 #define ARTWORK_CURRENT(artwork, type) \
915 ((type) == ARTWORK_TYPE_GRAPHICS ? \
916 (artwork).gfx_current : \
917 (type) == ARTWORK_TYPE_SOUNDS ? \
918 (artwork).snd_current : \
919 (artwork).mus_current)
921 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
922 ((type) == ARTWORK_TYPE_GRAPHICS ? \
923 &(artwork).gfx_current_identifier : \
924 (type) == ARTWORK_TYPE_SOUNDS ? \
925 &(artwork).snd_current_identifier : \
926 &(artwork).mus_current_identifier)
928 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
929 ((type) == ARTWORK_TYPE_GRAPHICS ? \
930 (artwork).gfx_current_identifier : \
931 (type) == ARTWORK_TYPE_SOUNDS ? \
932 (artwork).snd_current_identifier : \
933 (artwork).mus_current_identifier)
935 #define ARTWORKINFO_FILENAME(type) \
936 ((type) == ARTWORK_TYPE_GRAPHICS ? \
937 GRAPHICSINFO_FILENAME : \
938 (type) == ARTWORK_TYPE_SOUNDS ? \
939 SOUNDSINFO_FILENAME : \
940 (type) == ARTWORK_TYPE_MUSIC ? \
941 MUSICINFO_FILENAME : "")
943 #define ARTWORK_DIRECTORY(type) \
944 ((type) == ARTWORK_TYPE_GRAPHICS ? \
945 GRAPHICS_DIRECTORY : \
946 (type) == ARTWORK_TYPE_SOUNDS ? \
948 (type) == ARTWORK_TYPE_MUSIC ? \
949 MUSIC_DIRECTORY : "")
951 #define OPTIONS_ARTWORK_DIRECTORY(type) \
952 ((type) == ARTWORK_TYPE_GRAPHICS ? \
953 options.graphics_directory : \
954 (type) == ARTWORK_TYPE_SOUNDS ? \
955 options.sounds_directory : \
956 (type) == ARTWORK_TYPE_MUSIC ? \
957 options.music_directory : "")
959 #define USER_ARTWORK_DIRECTORY(type) \
960 ((type) == ARTWORK_TYPE_GRAPHICS ? \
961 getUserGraphicsDir() : \
962 (type) == ARTWORK_TYPE_SOUNDS ? \
963 getUserSoundsDir() : \
964 (type) == ARTWORK_TYPE_MUSIC ? \
965 getUserMusicDir() : "")
967 #define ARTWORK_DEFAULT_SUBDIR(type) \
968 ((type) == ARTWORK_TYPE_GRAPHICS ? \
969 GFX_DEFAULT_SUBDIR : \
970 (type) == ARTWORK_TYPE_SOUNDS ? \
971 SND_DEFAULT_SUBDIR : \
974 #define UPDATE_BUSY_STATE() \
976 if (gfx.draw_busy_anim_function != NULL) \
977 gfx.draw_busy_anim_function(); \
981 // structure definitions
985 char *command_basepath; // path to the program binary
986 char *command_basename; // base filename of the program binary
988 char *config_filename; // optional global program config filename
990 char *maindata_path; // main game data (installation) directory
992 char *userdata_subdir; // personal user game data directory
993 char *userdata_path; // resulting full path to game data directory
1001 char *cookie_prefix;
1003 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
1004 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
1005 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
1013 char *version_string;
1015 char *(*window_title_function)(void);
1016 void (*exit_message_function)(char *, va_list);
1017 void (*exit_function)(int);
1019 boolean global_scores;
1020 boolean many_scores_per_name;
1034 SDL_Thread *server_thread;
1035 boolean is_server_thread;
1040 boolean uses_touch_device;
1048 char *ro_base_directory;
1049 char *rw_base_directory;
1050 char *level_directory;
1051 char *graphics_directory;
1052 char *sounds_directory;
1053 char *music_directory;
1054 char *docs_directory;
1055 char *conf_directory;
1057 char *execute_command;
1059 char *special_flags;
1069 struct VideoSystemInfo
1072 int width, height, depth;
1073 int window_width, window_height;
1074 int display_width, display_height;
1075 int screen_width, screen_height;
1076 int screen_xoffset, screen_yoffset;
1078 boolean fullscreen_available;
1079 boolean fullscreen_enabled;
1080 boolean fullscreen_initial;
1082 boolean window_scaling_available;
1083 int window_scaling_percent;
1084 char *window_scaling_quality;
1085 int screen_rendering_mode;
1088 unsigned int frame_counter;
1089 unsigned int frame_delay;
1090 unsigned int frame_delay_value;
1094 int shifted_up_pos_last;
1095 unsigned int shifted_up_delay;
1096 unsigned int shifted_up_delay_value;
1098 boolean initialized;
1101 struct AudioSystemInfo
1103 boolean sound_available;
1104 boolean loops_available;
1105 boolean music_available;
1107 boolean sound_enabled;
1108 boolean sound_deactivated; // for temporarily disabling sound
1117 int first_sound_channel;
1120 struct FontBitmapInfo
1124 int src_x, src_y; // start position of font characters
1125 int width, height; // width / height of font characters
1127 int offset_x; // offset to next font character
1128 int offset_y; // offset to next font character
1130 int draw_xoffset; // offset for drawing font characters
1131 int draw_yoffset; // offset for drawing font characters
1134 int num_chars_per_line;
1141 int real_sx, real_sy;
1142 int full_sxsize, full_sysize;
1143 int scrollbuffer_width, scrollbuffer_height;
1145 int game_tile_size, standard_tile_size;
1156 int win_xsize, win_ysize;
1158 int draw_deactivation_mask;
1159 int draw_background_mask;
1161 Bitmap *field_save_buffer;
1163 Bitmap *background_bitmap;
1164 int background_bitmap_mask;
1166 Bitmap *fade_bitmap_backup;
1167 Bitmap *fade_bitmap_source;
1168 Bitmap *fade_bitmap_target;
1169 Bitmap *fade_bitmap_black;
1171 int fade_border_source_status;
1172 int fade_border_target_status;
1173 Bitmap *masked_border_bitmap_ptr;
1175 Bitmap *final_screen_bitmap;
1177 boolean clipping_enabled;
1179 int clip_width, clip_height;
1181 boolean override_level_graphics;
1182 boolean override_level_sounds;
1183 boolean override_level_music;
1185 boolean draw_init_text;
1188 struct FontBitmapInfo *font_bitmap_info;
1189 int (*select_font_function)(int);
1190 int (*get_font_from_token_function)(char *);
1192 int anim_random_frame;
1194 void (*draw_busy_anim_function)(void);
1195 void (*draw_global_anim_function)(int, int);
1196 void (*draw_global_border_function)(int);
1197 void (*draw_tile_cursor_function)(int);
1200 int cursor_mode_override;
1201 int cursor_mode_final;
1202 int mouse_x, mouse_y;
1205 struct TileCursorInfo
1207 boolean enabled; // tile cursor generally enabled or disabled
1208 boolean active; // tile cursor activated (depending on game)
1209 boolean moving; // tile cursor moving to target position
1211 int xpos, ypos; // tile cursor level playfield position
1212 int x, y; // tile cursor current screen position
1213 int target_x, target_y; // tile cursor target screen position
1215 int sx, sy; // tile cursor screen start position
1217 boolean xsn_debug; // enable or disable XSN debugging
1222 boolean enabled; // overlay generally enabled or disabled
1223 boolean active; // overlay activated (depending on game mode)
1230 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1231 char grid_button_highlight;
1233 int grid_button_action;
1239 int nr[MAX_PLAYERS]; // joystick number for each player
1242 struct SetupJoystickInfo
1244 char *device_name; // device name of player's joystick
1246 int xleft, xmiddle, xright;
1247 int yupper, ymiddle, ylower;
1251 struct SetupKeyboardInfo
1253 Key left, right, up, down;
1257 struct SetupTouchInfo
1266 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1268 int transparency; // in percent (0 == opaque, 100 == invisible)
1269 boolean draw_outlined;
1270 boolean draw_pressed;
1272 boolean grid_initialized;
1275 struct SetupInputInfo
1277 boolean use_joystick;
1278 struct SetupJoystickInfo joy;
1279 struct SetupKeyboardInfo key;
1282 struct SetupEditorInfo
1284 boolean el_boulderdash;
1285 boolean el_emerald_mine;
1286 boolean el_emerald_mine_club;
1289 boolean el_supaplex;
1290 boolean el_diamond_caves;
1291 boolean el_dx_boulderdash;
1293 boolean el_mirror_magic;
1294 boolean el_deflektor;
1297 boolean el_steel_chars;
1301 boolean el_user_defined;
1304 boolean el_headlines;
1309 boolean show_element_token;
1311 boolean show_read_only_warning;
1313 boolean use_template_for_new_levels;
1316 struct SetupAutoSetupInfo
1318 int editor_zoom_tilesize;
1321 struct SetupLevelSetupInfo
1323 char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1326 struct SetupEditorCascadeInfo
1339 boolean el_steel_chars;
1347 struct SetupShortcutInfo
1353 Key focus_player[MAX_PLAYERS];
1354 Key focus_player_all;
1373 struct SetupSystemInfo
1375 char *sdl_renderdriver;
1376 char *sdl_videodriver;
1377 char *sdl_audiodriver;
1378 int audio_fragment_size;
1381 struct SetupInternalInfo
1383 char *program_title;
1384 char *program_version;
1385 char *program_author;
1386 char *program_email;
1387 char *program_website;
1388 char *program_copyright;
1389 char *program_company;
1391 char *program_icon_file;
1393 char *default_graphics_set;
1394 char *default_sounds_set;
1395 char *default_music_set;
1397 char *fallback_graphics_file;
1398 char *fallback_sounds_file;
1399 char *fallback_music_file;
1401 char *default_level_series;
1403 int default_window_width;
1404 int default_window_height;
1406 boolean choose_from_top_leveldir;
1407 boolean show_scaling_in_title;
1408 boolean create_user_levelset;
1411 boolean menu_engines;
1412 boolean menu_editor;
1413 boolean menu_graphics;
1415 boolean menu_artwork;
1418 boolean menu_shortcuts;
1420 boolean menu_save_and_exit;
1423 struct SetupDebugInfo
1425 int frame_delay[10];
1426 Key frame_delay_key[10];
1427 boolean frame_delay_use_mod_key;
1428 boolean frame_delay_game_only;
1429 boolean show_frames_per_second;
1438 boolean multiple_users;
1441 boolean sound_loops;
1442 boolean sound_music;
1443 boolean sound_simple;
1445 boolean scroll_delay;
1446 boolean forced_scroll_delay;
1447 int scroll_delay_value;
1448 char *engine_snapshot_mode;
1449 int engine_snapshot_memory;
1450 boolean fade_screens;
1452 boolean show_titlescreen;
1453 boolean quick_doors;
1456 boolean skip_levels;
1457 boolean increment_levels;
1458 boolean auto_play_next_level;
1459 boolean count_score_after_game;
1460 boolean show_scores_after_game;
1463 int window_scaling_percent;
1464 char *window_scaling_quality;
1465 char *screen_rendering_mode;
1467 boolean ask_on_escape;
1468 boolean ask_on_escape_editor;
1469 boolean ask_on_game_over;
1470 boolean ask_on_quit_game;
1471 boolean ask_on_quit_program;
1472 boolean quick_switch;
1473 boolean input_on_focus;
1474 boolean prefer_aga_graphics;
1475 boolean prefer_lowpass_sounds;
1476 boolean prefer_extra_panel_items;
1477 boolean game_speed_extended;
1478 int game_frame_delay;
1479 boolean sp_show_border_elements;
1480 boolean small_game_graphics;
1481 boolean show_snapshot_buttons;
1486 int override_level_graphics; // not boolean -- can also be "AUTO"
1487 int override_level_sounds; // not boolean -- can also be "AUTO"
1488 int override_level_music; // not boolean -- can also be "AUTO"
1494 boolean network_mode;
1495 int network_player_nr;
1496 char *network_server_hostname;
1498 struct SetupAutoSetupInfo auto_setup;
1499 struct SetupLevelSetupInfo level_setup;
1501 struct SetupEditorInfo editor;
1502 struct SetupEditorCascadeInfo editor_cascade;
1503 struct SetupShortcutInfo shortcut;
1504 struct SetupInputInfo input[MAX_PLAYERS];
1505 struct SetupTouchInfo touch;
1506 struct SetupSystemInfo system;
1507 struct SetupInternalInfo internal;
1508 struct SetupDebugInfo debug;
1510 struct OptionInfo options;
1520 struct TreeInfo **node_top; // topmost node in tree
1521 struct TreeInfo *node_parent; // parent level directory info
1522 struct TreeInfo *node_group; // level group sub-directory info
1523 struct TreeInfo *next; // next level series structure node
1525 int cl_first; // internal control field for setup screen
1526 int cl_cursor; // internal control field for setup screen
1528 int type; // type of tree content
1530 // fields for "type == TREE_TYPE_LEVEL_DIR"
1532 char *subdir; // tree info sub-directory basename (may be ".")
1533 char *fullpath; // complete path relative to tree base directory
1534 char *basepath; // absolute base path of tree base directory
1535 char *identifier; // identifier string for configuration files
1536 char *name; // tree info name, as displayed in selection menues
1537 char *name_sorting; // optional sorting name for correct name sorting
1538 char *author; // level or artwork author name
1539 char *year; // optional year of creation for levels or artwork
1541 char *program_title; // optional alternative text for program title
1542 char *program_copyright; // optional alternative text for program copyright
1543 char *program_company; // optional alternative text for program company
1545 char *imported_from; // optional comment for imported levels or artwork
1546 char *imported_by; // optional comment for imported levels or artwork
1547 char *tested_by; // optional comment to name people who tested a set
1549 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1550 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1551 char *graphics_set; // optional custom graphics set (level tree only)
1552 char *sounds_set_default; // default EMC custom sounds set
1553 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1554 char *sounds_set; // optional custom sounds set (level tree only)
1555 char *music_set; // optional custom music set (level tree only)
1556 char *graphics_path; // path to optional custom graphics set (level only)
1557 char *sounds_path; // path to optional custom sounds set (level only)
1558 char *music_path; // path to optional custom music set (level only)
1560 char *level_filename; // filename of level file (for packed level file)
1561 char *level_filetype; // type of levels in level directory or level file
1563 char *special_flags; // flags for special actions performed on level file
1565 int levels; // number of levels in level series
1566 int first_level; // first level number (to allow start with 0 or 1)
1567 int last_level; // last level number (automatically calculated)
1568 int sort_priority; // sort levels by 'sort_priority' and then by name
1570 boolean latest_engine;// force level set to use the latest game engine
1572 boolean level_group; // directory contains more level series directories
1573 boolean parent_link; // entry links back to parent directory
1574 boolean is_copy; // this entry is a copy of another entry in the tree
1575 boolean in_user_dir; // user defined levels are stored in home directory
1576 boolean user_defined; // levels in user directory and marked as "private"
1577 boolean readonly; // readonly levels can not be changed with editor
1578 boolean handicap; // level set has no handicap when set to "false"
1579 boolean skip_levels; // levels can be skipped when set to "true"
1581 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1583 int color; // color to use on selection screen for this level
1584 char *class_desc; // description of level series class
1585 int handicap_level; // number of the lowest unsolved level
1587 char *infotext; // optional text to describe the tree type (headline)
1590 typedef struct TreeInfo TreeInfo;
1591 typedef struct TreeInfo LevelDirTree;
1592 typedef struct TreeInfo ArtworkDirTree;
1593 typedef struct TreeInfo GraphicsDirTree;
1594 typedef struct TreeInfo SoundsDirTree;
1595 typedef struct TreeInfo MusicDirTree;
1599 GraphicsDirTree *gfx_first;
1600 GraphicsDirTree *gfx_current;
1601 SoundsDirTree *snd_first;
1602 SoundsDirTree *snd_current;
1603 MusicDirTree *mus_first;
1604 MusicDirTree *mus_current;
1606 char *gfx_current_identifier;
1607 char *snd_current_identifier;
1608 char *mus_current_identifier;
1611 struct ValueTextInfo
1617 struct StringValueTextInfo
1629 struct ConfigTypeInfo
1636 struct TokenIntPtrInfo
1646 char *default_filename;
1649 char **default_parameter; // array of file parameters
1650 char **parameter; // array of file parameters
1653 boolean fallback_to_default;
1654 boolean default_is_cloned;
1657 struct SetupFileList
1662 struct SetupFileList *next;
1667 char *source_filename; // primary key for node list
1671 struct PropertyMapping
1681 struct ArtworkListInfo
1683 int type; // type of artwork
1685 int num_file_list_entries;
1686 int num_dynamic_file_list_entries;
1687 struct FileInfo *file_list; // static artwork file array
1688 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1690 int num_suffix_list_entries;
1691 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1693 int num_base_prefixes;
1694 int num_ext1_suffixes;
1695 int num_ext2_suffixes;
1696 int num_ext3_suffixes;
1697 char **base_prefixes; // base token prefixes array
1698 char **ext1_suffixes; // property suffixes array 1
1699 char **ext2_suffixes; // property suffixes array 2
1700 char **ext3_suffixes; // property suffixes array 3
1702 int num_ignore_tokens;
1703 char **ignore_tokens; // file tokens to be ignored
1705 int num_property_mapping_entries;
1706 struct PropertyMapping *property_mapping; // mapping token -> artwork
1708 int sizeof_artwork_list_entry;
1710 struct ListNodeInfo **artwork_list; // static artwork node array
1711 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1712 struct ListNode *content_list; // dynamic artwork node list
1714 void *(*load_artwork)(char *); // constructor function
1715 void (*free_artwork)(void *); // destructor function
1735 struct RectWithBorder
1739 int min_width, min_height;
1740 int max_width, max_height;
1761 struct DoorPartPosInfo
1768 int start_step_opening;
1769 int start_step_closing;
1770 boolean draw_masked;
1777 int xoffset; // special case for tape date and time
1778 int xoffset2; // special case for tape date
1779 int yoffset; // special case for list of preview players
1782 int size; // also used for suffix ".digits"
1784 boolean draw_masked;
1785 boolean draw_player; // special case for network player buttons
1786 int sort_priority; // also used for suffix ".draw_order"
1789 int direction; // needed for panel time/health graphics
1790 int class; // needed for panel time/health graphics
1791 int style; // needed for panel time/health graphics
1793 int tile_size; // special case for list of network players
1794 int border_size; // special case for list of preview players
1795 int vertical; // special case for list of preview players
1797 boolean redefined; // redefined by custom artwork
1800 struct MouseActionInfo
1809 int music[MAX_LEVELS];
1822 // ============================================================================
1823 // exported variables
1824 // ============================================================================
1826 extern struct ProgramInfo program;
1827 extern struct NetworkInfo network;
1828 extern struct RuntimeInfo runtime;
1829 extern struct OptionInfo options;
1830 extern struct VideoSystemInfo video;
1831 extern struct AudioSystemInfo audio;
1832 extern struct GfxInfo gfx;
1833 extern struct TileCursorInfo tile_cursor;
1834 extern struct OverlayInfo overlay;
1835 extern struct AnimInfo anim;
1836 extern struct ArtworkInfo artwork;
1837 extern struct JoystickInfo joystick;
1838 extern struct SetupInfo setup;
1839 extern struct UserInfo user;
1841 extern LevelDirTree *leveldir_first_all;
1842 extern LevelDirTree *leveldir_first;
1843 extern LevelDirTree *leveldir_current;
1844 extern int level_nr;
1846 extern struct LevelSetInfo levelset;
1847 extern struct LevelStats level_stats[];
1849 extern DrawWindow *window;
1850 extern DrawBuffer *backbuffer;
1851 extern DrawBuffer *drawto;
1853 extern int button_status;
1854 extern boolean motion_status;
1855 extern int wheel_steps;
1856 extern boolean keyrepeat_status;
1857 extern boolean textinput_status;
1859 extern int redraw_mask;
1861 extern int FrameCounter;
1864 // function definitions
1866 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1868 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1869 void InitRuntimeInfo(void);
1871 void InitScoresInfo(void);
1872 void SetWindowTitle(void);
1874 void InitWindowTitleFunction(char *(*window_title_function)(void));
1875 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1876 void InitExitFunction(void (*exit_function)(int));
1877 void InitPlatformDependentStuff(void);
1878 void ClosePlatformDependentStuff(void);
1880 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1881 void InitGfxTileSizeInfo(int, int);
1882 void InitGfxDoor1Info(int, int, int, int);
1883 void InitGfxDoor2Info(int, int, int, int);
1884 void InitGfxDoor3Info(int, int, int, int);
1885 void InitGfxWindowInfo(int, int);
1886 void InitGfxScrollbufferInfo(int, int);
1887 void InitGfxClipRegion(boolean, int, int, int, int);
1888 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1889 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1890 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1891 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1892 void InitGfxCustomArtworkInfo(void);
1893 void InitGfxOtherSettings(void);
1894 void InitTileCursorInfo(void);
1895 void InitOverlayInfo(void);
1896 void SetOverlayGridSizeAndButtons(void);
1897 void SetTileCursorEnabled(boolean);
1898 void SetTileCursorActive(boolean);
1899 void SetTileCursorTargetXY(int, int);
1900 void SetTileCursorXY(int, int);
1901 void SetTileCursorSXSY(int, int);
1902 void SetOverlayEnabled(boolean);
1903 void SetOverlayActive(boolean);
1904 void SetOverlayShowGrid(boolean);
1905 boolean GetOverlayEnabled(void);
1906 boolean GetOverlayActive(void);
1907 void SetDrawDeactivationMask(int);
1908 int GetDrawDeactivationMask(void);
1909 void SetDrawBackgroundMask(int);
1910 void SetWindowBackgroundBitmap(Bitmap *);
1911 void SetMainBackgroundBitmap(Bitmap *);
1912 void SetDoorBackgroundBitmap(Bitmap *);
1913 void SetRedrawMaskFromArea(int, int, int, int);
1915 void LimitScreenUpdates(boolean);
1917 void InitVideoDefaults(void);
1918 void InitVideoDisplay(void);
1919 void CloseVideoDisplay(void);
1920 void InitVideoBuffer(int, int, int, boolean);
1921 Bitmap *CreateBitmapStruct(void);
1922 Bitmap *CreateBitmap(int, int, int);
1923 void ReCreateBitmap(Bitmap **, int, int);
1924 void FreeBitmap(Bitmap *);
1925 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1926 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1927 void FadeRectangle(int, int, int, int, int, int, int,
1928 void (*draw_border_function)(void));
1929 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1930 void ClearRectangle(Bitmap *, int, int, int, int);
1931 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1932 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1933 boolean DrawingDeactivatedField(void);
1934 boolean DrawingDeactivated(int, int, int, int);
1935 boolean DrawingOnBackground(int, int);
1936 boolean DrawingAreaChanged(void);
1937 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1938 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1939 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1940 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1941 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1942 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1943 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1944 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1945 Pixel GetPixel(Bitmap *, int, int);
1946 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1947 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1949 void KeyboardAutoRepeatOn(void);
1950 void KeyboardAutoRepeatOff(void);
1951 boolean SetVideoMode(boolean);
1952 void SetVideoFrameDelay(unsigned int);
1953 unsigned int GetVideoFrameDelay(void);
1954 boolean ChangeVideoModeIfNeeded(boolean);
1956 Bitmap *LoadImage(char *);
1957 Bitmap *LoadCustomImage(char *);
1958 void ReloadCustomImage(Bitmap *, char *);
1960 void ReCreateGameTileSizeBitmap(Bitmap **);
1961 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1962 void CreateBitmapTextures(Bitmap **);
1963 void FreeBitmapTextures(Bitmap **);
1964 void ScaleBitmap(Bitmap **, int);
1966 void SetMouseCursor(int);
1967 void UpdateRawMousePosition(int, int);
1968 void UpdateMousePosition(void);
1970 void OpenAudio(void);
1971 void CloseAudio(void);
1972 void SetAudioMode(boolean);
1974 void InitEventFilter(EventFilter);
1975 boolean PendingEvent(void);
1976 void WaitEvent(Event *event);
1977 void PeekEvent(Event *event);
1978 void PumpEvents(void);
1979 void CheckQuitEvent(void);
1980 Key GetEventKey(KeyEvent *, boolean);
1981 KeyMod HandleKeyModState(Key, int);
1982 KeyMod GetKeyModState(void);
1983 KeyMod GetKeyModStateFromEvents(void);
1984 void StartTextInput(int, int, int, int);
1985 void StopTextInput(void);
1986 void PushUserEvent(int, int, int);
1988 void InitJoysticks(void);
1989 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1990 boolean CheckJoystickOpened(int);
1991 void ClearJoystickState(void);
1993 void InitEmscriptenFilesystem(void);
1994 void SyncEmscriptenFilesystem(void);