1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
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"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 /* values for fullscreen status */
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 /* values for window scaling */
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
50 #define MIN_WINDOW_SCALING_PERCENT 50
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 300
53 #define STEP_WINDOW_SCALING_PERCENT 10
55 /* values for window scaling quality */
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
62 /* values for touch control */
63 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
64 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
66 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
68 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
69 #define TOUCH_DROP_DISTANCE_DEFAULT 5
72 /* default input keys */
73 #define DEFAULT_KEY_LEFT KSYM_Left
74 #define DEFAULT_KEY_RIGHT KSYM_Right
75 #define DEFAULT_KEY_UP KSYM_Up
76 #define DEFAULT_KEY_DOWN KSYM_Down
77 #if defined(PLATFORM_MACOSX)
78 #define DEFAULT_KEY_SNAP KSYM_Control_L
79 #define DEFAULT_KEY_DROP KSYM_KP_Enter
81 #define DEFAULT_KEY_SNAP KSYM_Control_L
82 #define DEFAULT_KEY_DROP KSYM_Control_R
84 #define DEFAULT_KEY_OKAY KSYM_Return
85 #define DEFAULT_KEY_CANCEL KSYM_Escape
87 /* default shortcut keys */
88 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
89 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
90 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
91 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
92 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
93 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
94 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
95 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
96 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
97 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
98 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
99 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
100 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
101 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
102 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
103 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
104 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
105 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
106 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
107 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
108 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
110 /* values for key_status */
111 #define KEY_NOT_PRESSED FALSE
112 #define KEY_RELEASED FALSE
113 #define KEY_PRESSED TRUE
115 /* values for button status */
116 #define MB_NOT_PRESSED FALSE
117 #define MB_NOT_RELEASED TRUE
118 #define MB_RELEASED FALSE
119 #define MB_PRESSED TRUE
120 #define MB_MENU_CHOICE FALSE
121 #define MB_MENU_MARK TRUE
122 #define MB_MENU_INITIALIZE (-1)
123 #define MB_MENU_LEAVE (-2)
124 #define MB_LEFTBUTTON 1
125 #define MB_MIDDLEBUTTON 2
126 #define MB_RIGHTBUTTON 3
127 #define MB_WHEEL_UP 4
128 #define MB_WHEEL_DOWN 5
129 #define MB_WHEEL_LEFT 6
130 #define MB_WHEEL_RIGHT 7
131 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
132 (b) <= MB_WHEEL_DOWN)
133 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
134 (b) <= MB_WHEEL_RIGHT)
135 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
136 (b) <= MB_WHEEL_DOWN)
137 #define DEFAULT_WHEEL_STEPS 3
139 /* values for move directions */
140 #define MV_BIT_LEFT 0
141 #define MV_BIT_RIGHT 1
143 #define MV_BIT_DOWN 3
145 #define NUM_DIRECTIONS 4
147 /* diagonal movement directions are used in a different contect than buttons */
148 #define MV_BIT_UPLEFT 4
149 #define MV_BIT_UPRIGHT 5
150 #define MV_BIT_DOWNLEFT 6
151 #define MV_BIT_DOWNRIGHT 7
153 #define NUM_DIRECTIONS_FULL 8
155 /* values for special "button" bitmasks */
159 #define NUM_PLAYER_ACTIONS 6
161 /* values for special "focus player" bitmasks */
162 #define BIT_SET_FOCUS 6
164 /* values for move directions and special "button" key bitmasks */
166 #define MV_LEFT (1 << MV_BIT_LEFT)
167 #define MV_RIGHT (1 << MV_BIT_RIGHT)
168 #define MV_UP (1 << MV_BIT_UP)
169 #define MV_DOWN (1 << MV_BIT_DOWN)
171 #define MV_UPLEFT (MV_UP | MV_LEFT)
172 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
173 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
174 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
176 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
177 #define MV_VERTICAL (MV_UP | MV_DOWN)
178 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
179 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
180 #define MV_NO_DIRECTION (MV_NONE)
182 #define KEY_BUTTON_1 (1 << BUTTON_1)
183 #define KEY_BUTTON_2 (1 << BUTTON_2)
184 #define KEY_BUTTON_SNAP KEY_BUTTON_1
185 #define KEY_BUTTON_DROP KEY_BUTTON_2
186 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
187 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
188 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
190 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
192 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
193 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
194 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
195 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
196 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
199 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
200 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
201 (x) == MV_UP ? MV_BIT_UP : \
202 (x) == MV_DOWN ? MV_BIT_DOWN : \
203 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
204 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
205 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
206 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
209 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
210 (x) == MV_RIGHT ? MV_LEFT : \
211 (x) == MV_UP ? MV_DOWN : \
212 (x) == MV_DOWN ? MV_UP : \
213 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
214 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
215 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
216 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
219 /* values for animation mode (frame order and direction) */
221 #define ANIM_LOOP (1 << 0)
222 #define ANIM_LINEAR (1 << 1)
223 #define ANIM_PINGPONG (1 << 2)
224 #define ANIM_PINGPONG2 (1 << 3)
225 #define ANIM_RANDOM (1 << 4)
226 #define ANIM_CE_VALUE (1 << 5)
227 #define ANIM_CE_SCORE (1 << 6)
228 #define ANIM_CE_DELAY (1 << 7)
229 #define ANIM_REVERSE (1 << 8)
230 #define ANIM_OPAQUE_PLAYER (1 << 9)
232 /* values for special (non game element) animation modes */
233 #define ANIM_HORIZONTAL (1 << 10)
234 #define ANIM_VERTICAL (1 << 11)
235 #define ANIM_CENTERED (1 << 12)
236 #define ANIM_STATIC_PANEL (1 << 13)
238 #define ANIM_DEFAULT ANIM_LOOP
240 /* values for special drawing styles (currently only for crumbled graphics) */
242 #define STYLE_ACCURATE_BORDERS (1 << 0)
243 #define STYLE_INNER_CORNERS (1 << 1)
245 #define STYLE_DEFAULT STYLE_NONE
247 /* values for fade mode */
248 #define FADE_TYPE_NONE 0
249 #define FADE_TYPE_FADE_IN (1 << 0)
250 #define FADE_TYPE_FADE_OUT (1 << 1)
251 #define FADE_TYPE_TRANSFORM (1 << 2)
252 #define FADE_TYPE_CROSSFADE (1 << 3)
253 #define FADE_TYPE_MELT (1 << 4)
254 #define FADE_TYPE_SKIP (1 << 5)
256 #define FADE_MODE_NONE (FADE_TYPE_NONE)
257 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
258 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
259 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
260 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
261 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
262 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
263 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
264 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
266 #define FADE_MODE_DEFAULT FADE_MODE_FADE
268 /* values for text alignment */
269 #define ALIGN_LEFT (1 << 0)
270 #define ALIGN_RIGHT (1 << 1)
271 #define ALIGN_CENTER (1 << 2)
272 #define ALIGN_DEFAULT ALIGN_LEFT
274 #define VALIGN_TOP (1 << 0)
275 #define VALIGN_BOTTOM (1 << 1)
276 #define VALIGN_MIDDLE (1 << 2)
277 #define VALIGN_DEFAULT VALIGN_TOP
279 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
280 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
281 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
282 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
283 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
284 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
286 /* values for redraw_mask */
287 #define REDRAW_NONE (0)
288 #define REDRAW_ALL (1 << 0)
289 #define REDRAW_FIELD (1 << 1)
290 #define REDRAW_TILES (1 << 2)
291 #define REDRAW_DOOR_1 (1 << 3)
292 #define REDRAW_VIDEO_1 (1 << 4)
293 #define REDRAW_VIDEO_2 (1 << 5)
294 #define REDRAW_VIDEO_3 (1 << 6)
295 #define REDRAW_MICROLEVEL (1 << 7)
296 #define REDRAW_MICROLABEL (1 << 8)
297 #define REDRAW_FROM_BACKBUFFER (1 << 9)
298 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
301 #define REDRAW_DOOR_3 (1 << 10)
302 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
305 #define REDRAW_MAIN (REDRAW_FIELD | \
308 #define REDRAW_FPS (1 << 11)
310 /* on modern graphics systems and when using the SDL target, the old tile redraw
311 optimization can slow things down a lot due to many small blits compared to
312 one single playfield-sized blit (especially observed on Mac OS X with SDL) */
313 #define REDRAWTILES_THRESHOLD 0
315 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
316 y >= gfx.sy && y < gfx.sy + gfx.sysize)
317 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
318 x < gfx.real_sx + gfx.full_sxsize && \
319 y >= gfx.real_sy && \
320 y < gfx.real_sy + gfx.full_sysize)
321 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
322 y >= gfx.dy && y < gfx.dy + gfx.dysize)
323 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
324 y >= gfx.vy && y < gfx.vy + gfx.vysize)
325 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
326 y >= gfx.ey && y < gfx.ey + gfx.eysize)
328 /* values for mouse cursor */
329 #define CURSOR_DEFAULT 0
330 #define CURSOR_NONE 1
331 #define CURSOR_PLAYFIELD 2
333 /* fundamental game speed values */
334 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
335 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
336 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
337 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
338 #define FRAMES_PER_SECOND_SP 35
340 /* maximum playfield size supported by libgame functions */
341 #define MAX_PLAYFIELD_WIDTH 128
342 #define MAX_PLAYFIELD_HEIGHT 128
344 /* maximum number of parallel players supported by libgame functions */
345 #define MAX_PLAYERS 4
347 /* maximum allowed length of player name */
348 #define MAX_PLAYER_NAME_LEN 10
350 /* maximum number of levels in a level set */
351 #define MAX_LEVELS 1000
353 /* default name for empty highscore entry */
354 #define EMPTY_PLAYER_NAME "no name"
356 /* default name for unknown player names */
357 #define ANONYMOUS_NAME "anonymous"
359 /* default for other unknown names */
360 #define UNKNOWN_NAME "unknown"
362 /* default name for new levels */
363 #define NAMELESS_LEVEL_NAME "nameless level"
365 /* default text for non-existant artwork */
366 #define NOT_AVAILABLE "(not available)"
368 /* default value for undefined filename */
369 #define UNDEFINED_FILENAME "[NONE]"
371 /* default value for undefined parameter */
372 #define ARG_DEFAULT "[DEFAULT]"
374 /* default values for undefined configuration file parameters */
375 #define ARG_UNDEFINED "-1000000"
376 #define ARG_UNDEFINED_VALUE (-1000000)
378 /* default value for off-screen positions */
379 #define POS_OFFSCREEN (-1000000)
381 /* definitions for game sub-directories */
383 #define RO_GAME_DIR "."
387 #define RW_GAME_DIR "."
390 #define RO_BASE_PATH RO_GAME_DIR
391 #define RW_BASE_PATH RW_GAME_DIR
393 /* directory names */
394 #define GRAPHICS_DIRECTORY "graphics"
395 #define SOUNDS_DIRECTORY "sounds"
396 #define MUSIC_DIRECTORY "music"
397 #define LEVELS_DIRECTORY "levels"
398 #define TAPES_DIRECTORY "tapes"
399 #define SCORES_DIRECTORY "scores"
400 #define DOCS_DIRECTORY "docs"
401 #define CACHE_DIRECTORY "cache"
403 #define GFX_CLASSIC_SUBDIR "gfx_classic"
404 #define SND_CLASSIC_SUBDIR "snd_classic"
405 #define MUS_CLASSIC_SUBDIR "mus_classic"
407 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
408 #define GFX_DEFAULT_SUBDIR "jue0"
409 #define SND_DEFAULT_SUBDIR "jue0"
410 #define MUS_DEFAULT_SUBDIR "jue0"
412 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
413 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
414 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
417 #if defined(CREATE_SPECIAL_EDITION)
418 #define GFX_FALLBACK_FILENAME "fallback.pcx"
419 #define SND_FALLBACK_FILENAME "fallback.wav"
420 #define MUS_FALLBACK_FILENAME "fallback.wav"
423 /* file names and filename extensions */
424 #define LEVELSETUP_DIRECTORY "levelsetup"
425 #define SETUP_FILENAME "setup.conf"
426 #define LEVELSETUP_FILENAME "levelsetup.conf"
427 #define EDITORSETUP_FILENAME "editorsetup.conf"
428 #define EDITORCASCADE_FILENAME "editorcascade.conf"
429 #define HELPANIM_FILENAME "helpanim.conf"
430 #define HELPTEXT_FILENAME "helptext.conf"
431 #define LEVELINFO_FILENAME "levelinfo.conf"
432 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
433 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
434 #define MUSICINFO_FILENAME "musicinfo.conf"
435 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
436 #define LEVELFILE_EXTENSION "level"
437 #define TAPEFILE_EXTENSION "tape"
438 #define SCOREFILE_EXTENSION "score"
440 #define ERROR_BASENAME "stderr.txt"
442 #define STRING_PARENT_DIRECTORY ".."
443 #define STRING_TOP_DIRECTORY "/"
445 #define CHAR_PATH_SEPARATOR_UNIX '/'
446 #define CHAR_PATH_SEPARATOR_DOS '\\'
448 #define STRING_PATH_SEPARATOR_UNIX "/"
449 #define STRING_PATH_SEPARATOR_DOS "\\"
451 #define STRING_NEWLINE_UNIX "\n"
452 #define STRING_NEWLINE_DOS "\r\n"
454 #if defined(PLATFORM_WIN32)
455 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
456 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
457 #define STRING_NEWLINE STRING_NEWLINE_DOS
459 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
460 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
461 #define STRING_NEWLINE STRING_NEWLINE_UNIX
465 /* areas in bitmap PIX_DOOR */
466 /* meaning in PIX_DB_DOOR: (3 PAGEs)
467 PAGEX1: 1. buffer for DOOR_1
468 PAGEX2: 2. buffer for DOOR_1
469 PAGEX3: buffer for animations
472 /* these values are hard-coded to be able to use them in initialization */
473 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
474 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
476 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
477 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
478 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
479 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
480 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
481 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
482 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
483 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
484 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
485 #define DOOR_GFX_PAGEY1 (0)
486 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
489 /* macros for version handling */
490 #define VERSION_MAJOR(x) ((x) / 1000000)
491 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
492 #define VERSION_PATCH(x) (((x) % 10000) / 100)
493 #define VERSION_BUILD(x) ((x) % 100)
494 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
497 /* macros for parent/child process identification */
498 #if defined(PLATFORM_UNIX)
499 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
500 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
501 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
503 #define IS_PARENT_PROCESS() TRUE
504 #define IS_CHILD_PROCESS() FALSE
505 #define HAS_CHILD_PROCESS() FALSE
509 /* values for artwork type */
510 #define ARTWORK_TYPE_GRAPHICS 0
511 #define ARTWORK_TYPE_SOUNDS 1
512 #define ARTWORK_TYPE_MUSIC 2
514 #define NUM_ARTWORK_TYPES 3
517 /* values for tree type (chosen to match artwork type) */
518 #define TREE_TYPE_UNDEFINED -1
519 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
520 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
521 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
522 #define TREE_TYPE_LEVEL_DIR 3
523 #define TREE_TYPE_LEVEL_NR 4
525 #define NUM_TREE_TYPES 5
527 #define INFOTEXT_UNDEFINED ""
528 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
529 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
530 #define INFOTEXT_MUSIC_DIR "Custom Music"
531 #define INFOTEXT_LEVEL_DIR "Level Sets"
532 #define INFOTEXT_LEVEL_NR "Levels"
534 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
535 INFOTEXT_LEVEL_NR : \
536 (t) == TREE_TYPE_LEVEL_DIR ? \
537 INFOTEXT_LEVEL_DIR : \
538 (t) == TREE_TYPE_GRAPHICS_DIR ? \
539 INFOTEXT_GRAPHICS_DIR : \
540 (t) == TREE_TYPE_SOUNDS_DIR ? \
541 INFOTEXT_SOUNDS_DIR : \
542 (t) == TREE_TYPE_MUSIC_DIR ? \
543 INFOTEXT_MUSIC_DIR : \
546 /* values for artwork handling */
547 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
548 ((type) == ARTWORK_TYPE_GRAPHICS ? \
549 &(leveldir)->graphics_set : \
550 (type) == ARTWORK_TYPE_SOUNDS ? \
551 &(leveldir)->sounds_set : \
552 &(leveldir)->music_set)
554 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
555 ((type) == ARTWORK_TYPE_GRAPHICS ? \
556 (leveldir)->graphics_set : \
557 (type) == ARTWORK_TYPE_SOUNDS ? \
558 (leveldir)->sounds_set : \
559 (leveldir)->music_set)
561 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
562 ((type) == ARTWORK_TYPE_GRAPHICS ? \
563 &(leveldir)->graphics_path : \
564 (type) == ARTWORK_TYPE_SOUNDS ? \
565 &(leveldir)->sounds_path : \
566 &(leveldir)->music_path)
568 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
569 ((type) == ARTWORK_TYPE_GRAPHICS ? \
570 (leveldir)->graphics_path : \
571 (type) == ARTWORK_TYPE_SOUNDS ? \
572 (leveldir)->sounds_path : \
573 (leveldir)->music_path)
575 #define SETUP_ARTWORK_SET(setup, type) \
576 ((type) == ARTWORK_TYPE_GRAPHICS ? \
577 (setup).graphics_set : \
578 (type) == ARTWORK_TYPE_SOUNDS ? \
579 (setup).sounds_set : \
582 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
583 ((type) == ARTWORK_TYPE_GRAPHICS ? \
584 (setup).override_level_graphics : \
585 (type) == ARTWORK_TYPE_SOUNDS ? \
586 (setup).override_level_sounds : \
587 (setup).override_level_music)
589 #define GFX_OVERRIDE_ARTWORK(type) \
590 ((type) == ARTWORK_TYPE_GRAPHICS ? \
591 gfx.override_level_graphics : \
592 (type) == ARTWORK_TYPE_SOUNDS ? \
593 gfx.override_level_sounds : \
594 gfx.override_level_music)
596 #define ARTWORK_FIRST_NODE(artwork, type) \
597 ((type) == ARTWORK_TYPE_GRAPHICS ? \
598 (artwork).gfx_first : \
599 (type) == ARTWORK_TYPE_SOUNDS ? \
600 (artwork).snd_first : \
603 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
604 ((type) == ARTWORK_TYPE_GRAPHICS ? \
605 &(artwork).gfx_current_identifier : \
606 (type) == ARTWORK_TYPE_SOUNDS ? \
607 &(artwork).snd_current_identifier : \
608 &(artwork).mus_current_identifier)
610 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
611 ((type) == ARTWORK_TYPE_GRAPHICS ? \
612 (artwork).gfx_current_identifier : \
613 (type) == ARTWORK_TYPE_SOUNDS ? \
614 (artwork).snd_current_identifier : \
615 (artwork).mus_current_identifier)
617 #define ARTWORKINFO_FILENAME(type) \
618 ((type) == ARTWORK_TYPE_GRAPHICS ? \
619 GRAPHICSINFO_FILENAME : \
620 (type) == ARTWORK_TYPE_SOUNDS ? \
621 SOUNDSINFO_FILENAME : \
622 (type) == ARTWORK_TYPE_MUSIC ? \
623 MUSICINFO_FILENAME : "")
625 #define ARTWORK_DIRECTORY(type) \
626 ((type) == ARTWORK_TYPE_GRAPHICS ? \
627 GRAPHICS_DIRECTORY : \
628 (type) == ARTWORK_TYPE_SOUNDS ? \
630 (type) == ARTWORK_TYPE_MUSIC ? \
631 MUSIC_DIRECTORY : "")
633 #define OPTIONS_ARTWORK_DIRECTORY(type) \
634 ((type) == ARTWORK_TYPE_GRAPHICS ? \
635 options.graphics_directory : \
636 (type) == ARTWORK_TYPE_SOUNDS ? \
637 options.sounds_directory : \
638 (type) == ARTWORK_TYPE_MUSIC ? \
639 options.music_directory : "")
641 #define UPDATE_BUSY_STATE() \
643 if (gfx.draw_busy_anim_function != NULL) \
644 gfx.draw_busy_anim_function(); \
648 /* type definitions */
649 #if defined(TARGET_SDL2)
650 typedef int (*EventFilter)(void *, Event *);
652 typedef int (*EventFilter)(const Event *);
656 /* structure definitions */
660 char *command_basepath; /* path to the program binary */
661 char *command_basename; /* base filename of the program binary */
663 char *maindata_path; /* main game data (installation) directory */
665 char *userdata_subdir; /* personal user game data directory */
666 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
667 char *userdata_path; /* resulting full path to game data directory */
673 char *sdl_icon_filename;
677 char *error_filename; /* filename where to write error messages to */
678 FILE *error_file; /* (used instead of 'stderr' on some systems) */
686 char *(*window_title_function)(void);
687 void (*exit_message_function)(char *, va_list);
688 void (*exit_function)(int);
697 char *ro_base_directory;
698 char *rw_base_directory;
699 char *level_directory;
700 char *graphics_directory;
701 char *sounds_directory;
702 char *music_directory;
703 char *docs_directory;
705 char *execute_command;
715 struct ScreenModeInfo
720 struct VideoSystemInfo
723 int width, height, depth;
724 int window_width, window_height;
726 boolean fullscreen_available;
727 boolean fullscreen_enabled;
728 boolean fullscreen_initial;
729 struct ScreenModeInfo *fullscreen_modes;
730 char *fullscreen_mode_current;
732 boolean window_scaling_available;
733 int window_scaling_percent;
734 char *window_scaling_quality;
739 struct AudioSystemInfo
741 boolean sound_available;
742 boolean loops_available;
743 boolean music_available;
745 boolean sound_enabled;
746 boolean sound_deactivated; /* for temporarily disabling sound */
755 int first_sound_channel;
758 struct FontBitmapInfo
762 int src_x, src_y; /* start position of animation frames */
763 int width, height; /* width/height of each animation frame */
765 int draw_xoffset; /* offset for drawing font characters */
766 int draw_yoffset; /* offset for drawing font characters */
769 int num_chars_per_line;
776 int real_sx, real_sy;
777 int full_sxsize, full_sysize;
778 int scrollbuffer_width, scrollbuffer_height;
780 int game_tile_size, standard_tile_size;
791 int win_xsize, win_ysize;
793 int draw_deactivation_mask;
794 int draw_background_mask;
796 boolean drawing_area_changed;
798 Bitmap *field_save_buffer;
800 Bitmap *background_bitmap;
801 int background_bitmap_mask;
803 boolean clipping_enabled;
805 int clip_width, clip_height;
807 boolean override_level_graphics;
808 boolean override_level_sounds;
809 boolean override_level_music;
811 boolean draw_init_text;
814 struct FontBitmapInfo *font_bitmap_info;
815 int (*select_font_function)(int);
816 int (*get_font_from_token_function)(char *);
818 int anim_random_frame;
820 void (*draw_busy_anim_function)(void);
828 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
831 struct SetupJoystickInfo
833 char *device_name; /* device name of player's joystick */
835 int xleft, xmiddle, xright;
836 int yupper, ymiddle, ylower;
840 struct SetupKeyboardInfo
842 Key left, right, up, down;
846 struct SetupTouchInfo
853 struct SetupInputInfo
855 boolean use_joystick;
856 struct SetupJoystickInfo joy;
857 struct SetupKeyboardInfo key;
860 struct SetupEditorInfo
862 boolean el_boulderdash;
863 boolean el_emerald_mine;
864 boolean el_emerald_mine_club;
868 boolean el_diamond_caves;
869 boolean el_dx_boulderdash;
871 boolean el_steel_chars;
873 boolean el_user_defined;
876 boolean el_headlines;
881 boolean show_element_token;
884 struct SetupEditorCascadeInfo
895 boolean el_steel_chars;
903 struct SetupShortcutInfo
909 Key focus_player[MAX_PLAYERS];
910 Key focus_player_all;
929 struct SetupSystemInfo
931 char *sdl_videodriver;
932 char *sdl_audiodriver;
933 int audio_fragment_size;
943 boolean sound_simple;
945 boolean scroll_delay;
946 boolean scroll_delay_value;
947 boolean soft_scrolling;
948 boolean fade_screens;
950 boolean show_titlescreen;
957 char *fullscreen_mode;
958 int window_scaling_percent;
959 char *window_scaling_quality;
960 boolean ask_on_escape;
961 boolean ask_on_escape_editor;
962 boolean quick_switch;
963 boolean input_on_focus;
964 boolean prefer_aga_graphics;
965 int game_frame_delay;
966 boolean sp_show_border_elements;
967 boolean small_game_graphics;
972 int override_level_graphics; /* not boolean -- can also be "AUTO" */
973 int override_level_sounds; /* not boolean -- can also be "AUTO" */
974 int override_level_music; /* not boolean -- can also be "AUTO" */
980 struct SetupEditorInfo editor;
981 struct SetupEditorCascadeInfo editor_cascade;
982 struct SetupShortcutInfo shortcut;
983 struct SetupInputInfo input[MAX_PLAYERS];
984 struct SetupTouchInfo touch;
985 struct SetupSystemInfo system;
986 struct OptionInfo options;
991 struct TreeInfo **node_top; /* topmost node in tree */
992 struct TreeInfo *node_parent; /* parent level directory info */
993 struct TreeInfo *node_group; /* level group sub-directory info */
994 struct TreeInfo *next; /* next level series structure node */
996 int cl_first; /* internal control field for setup screen */
997 int cl_cursor; /* internal control field for setup screen */
999 int type; /* type of tree content */
1001 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1003 char *subdir; /* tree info sub-directory basename (may be ".") */
1004 char *fullpath; /* complete path relative to tree base directory */
1005 char *basepath; /* absolute base path of tree base directory */
1006 char *identifier; /* identifier string for configuration files */
1007 char *name; /* tree info name, as displayed in selection menues */
1008 char *name_sorting; /* optional sorting name for correct name sorting */
1009 char *author; /* level or artwork author name */
1010 char *year; /* optional year of creation for levels or artwork */
1011 char *imported_from; /* optional comment for imported levels or artwork */
1012 char *imported_by; /* optional comment for imported levels or artwork */
1013 char *tested_by; /* optional comment to name people who tested a set */
1015 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1016 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1017 char *graphics_set; /* optional custom graphics set (level tree only) */
1018 char *sounds_set; /* optional custom sounds set (level tree only) */
1019 char *music_set; /* optional custom music set (level tree only) */
1020 char *graphics_path; /* path to optional custom graphics set (level only) */
1021 char *sounds_path; /* path to optional custom sounds set (level only) */
1022 char *music_path; /* path to optional custom music set (level only) */
1024 char *level_filename; /* filename of level file (for packed level file) */
1025 char *level_filetype; /* type of levels in level directory or level file */
1027 char *special_flags; /* flags for special actions performed on level file */
1029 int levels; /* number of levels in level series */
1030 int first_level; /* first level number (to allow start with 0 or 1) */
1031 int last_level; /* last level number (automatically calculated) */
1032 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1034 boolean latest_engine;/* force level set to use the latest game engine */
1036 boolean level_group; /* directory contains more level series directories */
1037 boolean parent_link; /* entry links back to parent directory */
1038 boolean in_user_dir; /* user defined levels are stored in home directory */
1039 boolean user_defined; /* levels in user directory and marked as "private" */
1040 boolean readonly; /* readonly levels can not be changed with editor */
1041 boolean handicap; /* level set has no handicap when set to "false" */
1042 boolean skip_levels; /* levels can be skipped when set to "true" */
1044 int color; /* color to use on selection screen for this level */
1045 char *class_desc; /* description of level series class */
1046 int handicap_level; /* number of the lowest unsolved level */
1048 char *infotext; /* optional text to describe the tree type (headline) */
1051 typedef struct TreeInfo TreeInfo;
1052 typedef struct TreeInfo LevelDirTree;
1053 typedef struct TreeInfo ArtworkDirTree;
1054 typedef struct TreeInfo GraphicsDirTree;
1055 typedef struct TreeInfo SoundsDirTree;
1056 typedef struct TreeInfo MusicDirTree;
1060 GraphicsDirTree *gfx_first;
1061 GraphicsDirTree *gfx_current;
1062 SoundsDirTree *snd_first;
1063 SoundsDirTree *snd_current;
1064 MusicDirTree *mus_first;
1065 MusicDirTree *mus_current;
1067 char *gfx_current_identifier;
1068 char *snd_current_identifier;
1069 char *mus_current_identifier;
1072 struct ValueTextInfo
1084 struct ConfigTypeInfo
1091 struct TokenIntPtrInfo
1101 char *default_filename;
1104 char **default_parameter; /* array of file parameters */
1105 char **parameter; /* array of file parameters */
1108 boolean fallback_to_default;
1109 boolean default_is_cloned;
1112 struct SetupFileList
1117 struct SetupFileList *next;
1122 char *source_filename; /* primary key for node list */
1126 struct PropertyMapping
1136 struct ArtworkListInfo
1138 int type; /* type of artwork */
1140 int num_file_list_entries;
1141 int num_dynamic_file_list_entries;
1142 struct FileInfo *file_list; /* static artwork file array */
1143 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1145 int num_suffix_list_entries;
1146 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1148 int num_base_prefixes;
1149 int num_ext1_suffixes;
1150 int num_ext2_suffixes;
1151 int num_ext3_suffixes;
1152 char **base_prefixes; /* base token prefixes array */
1153 char **ext1_suffixes; /* property suffixes array 1 */
1154 char **ext2_suffixes; /* property suffixes array 2 */
1155 char **ext3_suffixes; /* property suffixes array 3 */
1157 int num_ignore_tokens;
1158 char **ignore_tokens; /* file tokens to be ignored */
1160 int num_property_mapping_entries;
1161 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1163 int sizeof_artwork_list_entry;
1165 struct ListNodeInfo **artwork_list; /* static artwork node array */
1166 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1167 struct ListNode *content_list; /* dynamic artwork node list */
1169 void *(*load_artwork)(char *); /* constructor function */
1170 void (*free_artwork)(void *); /* destructor function */
1184 struct RectWithBorder
1198 struct DoorPartPosInfo
1205 int start_step_opening;
1206 int start_step_closing;
1207 boolean draw_masked;
1214 int xoffset; /* special case for tape date and time */
1215 int xoffset2; /* special case for tape date */
1218 int size; /* also used for suffix ".digits" */
1220 boolean draw_masked;
1221 boolean draw_player; /* special case for network player buttons */
1222 int sort_priority; /* also used for suffix ".draw_order" */
1233 /* ========================================================================= */
1234 /* exported variables */
1235 /* ========================================================================= */
1237 extern struct ProgramInfo program;
1238 extern struct OptionInfo options;
1239 extern struct VideoSystemInfo video;
1240 extern struct AudioSystemInfo audio;
1241 extern struct GfxInfo gfx;
1242 extern struct AnimInfo anim;
1243 extern struct ArtworkInfo artwork;
1244 extern struct JoystickInfo joystick;
1245 extern struct SetupInfo setup;
1247 extern LevelDirTree *leveldir_first_all;
1248 extern LevelDirTree *leveldir_first;
1249 extern LevelDirTree *leveldir_current;
1250 extern int level_nr;
1252 extern struct LevelStats level_stats[];
1254 extern DrawWindow *window;
1255 extern DrawBuffer *backbuffer;
1256 extern DrawBuffer *drawto;
1258 extern int button_status;
1259 extern boolean motion_status;
1260 #if defined(TARGET_SDL2)
1261 extern boolean keyrepeat_status;
1264 extern int redraw_mask;
1265 extern int redraw_tiles;
1267 extern int FrameCounter;
1270 /* function definitions */
1272 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1275 void SetWindowTitle();
1277 void InitWindowTitleFunction(char *(*window_title_function)(void));
1278 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1279 void InitExitFunction(void (*exit_function)(int));
1280 void InitPlatformDependentStuff(void);
1281 void ClosePlatformDependentStuff(void);
1283 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1284 void InitGfxTileSizeInfo(int, int);
1285 void InitGfxDoor1Info(int, int, int, int);
1286 void InitGfxDoor2Info(int, int, int, int);
1287 void InitGfxDoor3Info(int, int, int, int);
1288 void InitGfxWindowInfo(int, int);
1289 void InitGfxScrollbufferInfo(int, int);
1290 void InitGfxClipRegion(boolean, int, int, int, int);
1291 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1292 void InitGfxCustomArtworkInfo();
1293 void InitGfxOtherSettings();
1294 void SetDrawDeactivationMask(int);
1295 void SetDrawBackgroundMask(int);
1296 void SetWindowBackgroundBitmap(Bitmap *);
1297 void SetMainBackgroundBitmap(Bitmap *);
1298 void SetDoorBackgroundBitmap(Bitmap *);
1300 void LimitScreenUpdates(boolean);
1302 void InitVideoDisplay(void);
1303 void CloseVideoDisplay(void);
1304 void InitVideoBuffer(int, int, int, boolean);
1305 Bitmap *CreateBitmapStruct(void);
1306 Bitmap *CreateBitmap(int, int, int);
1307 void ReCreateBitmap(Bitmap **, int, int, int);
1308 void FreeBitmap(Bitmap *);
1309 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1310 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1311 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1312 void (*draw_border_function)(void));
1313 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1314 void ClearRectangle(Bitmap *, int, int, int, int);
1315 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1316 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1317 boolean DrawingOnBackground(int, int);
1318 boolean DrawingAreaChanged();
1319 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1320 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1321 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1322 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1323 Pixel GetPixel(Bitmap *, int, int);
1324 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1325 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1327 void KeyboardAutoRepeatOn(void);
1328 void KeyboardAutoRepeatOff(void);
1329 boolean PointerInWindow(DrawWindow *);
1330 boolean SetVideoMode(boolean);
1331 boolean ChangeVideoModeIfNeeded(boolean);
1333 Bitmap *LoadImage(char *);
1334 Bitmap *LoadCustomImage(char *);
1335 void ReloadCustomImage(Bitmap *, char *);
1337 Bitmap *ZoomBitmap(Bitmap *, int, int);
1338 void ReCreateGameTileSizeBitmap(Bitmap **);
1339 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1340 void ScaleBitmap(Bitmap **, int);
1342 void SetMouseCursor(int);
1344 void OpenAudio(void);
1345 void CloseAudio(void);
1346 void SetAudioMode(boolean);
1348 void InitEventFilter(EventFilter);
1349 boolean PendingEvent(void);
1350 void NextEvent(Event *event);
1351 void PeekEvent(Event *event);
1352 Key GetEventKey(KeyEvent *, boolean);
1353 KeyMod HandleKeyModState(Key, int);
1354 KeyMod GetKeyModState();
1355 KeyMod GetKeyModStateFromEvents();
1356 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1358 void InitJoysticks();
1359 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1361 #endif /* SYSTEM_H */