1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
21 #if defined(PLATFORM_MACOSX)
23 #elif defined(PLATFORM_WIN32)
25 #elif defined(PLATFORM_ANDROID)
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 50
53 #define STD_WINDOW_SCALING_PERCENT 100
54 #define MAX_WINDOW_SCALING_PERCENT 300
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 touch control */
65 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
66 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
68 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
70 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
71 #define TOUCH_DROP_DISTANCE_DEFAULT 5
74 /* default input keys */
75 #define DEFAULT_KEY_LEFT KSYM_Left
76 #define DEFAULT_KEY_RIGHT KSYM_Right
77 #define DEFAULT_KEY_UP KSYM_Up
78 #define DEFAULT_KEY_DOWN KSYM_Down
79 #if defined(PLATFORM_MACOSX)
80 #define DEFAULT_KEY_SNAP KSYM_Control_L
81 #define DEFAULT_KEY_DROP KSYM_KP_Enter
83 #define DEFAULT_KEY_SNAP KSYM_Control_L
84 #define DEFAULT_KEY_DROP KSYM_Control_R
86 #define DEFAULT_KEY_OKAY KSYM_Return
87 #define DEFAULT_KEY_CANCEL KSYM_Escape
89 /* default shortcut keys */
90 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
91 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
92 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
93 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
94 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
95 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
96 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
97 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
98 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
99 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
100 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
101 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
102 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
103 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
104 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
105 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
106 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
107 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
108 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
109 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
110 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
112 /* values for key_status */
113 #define KEY_NOT_PRESSED FALSE
114 #define KEY_RELEASED FALSE
115 #define KEY_PRESSED TRUE
117 /* values for button status */
118 #define MB_NOT_PRESSED FALSE
119 #define MB_NOT_RELEASED TRUE
120 #define MB_RELEASED FALSE
121 #define MB_PRESSED TRUE
122 #define MB_MENU_CHOICE FALSE
123 #define MB_MENU_MARK TRUE
124 #define MB_MENU_INITIALIZE (-1)
125 #define MB_MENU_LEAVE (-2)
126 #define MB_LEFTBUTTON 1
127 #define MB_MIDDLEBUTTON 2
128 #define MB_RIGHTBUTTON 3
129 #define MB_WHEEL_UP 4
130 #define MB_WHEEL_DOWN 5
131 #define MB_WHEEL_LEFT 6
132 #define MB_WHEEL_RIGHT 7
133 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
134 (b) <= MB_WHEEL_DOWN)
135 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
136 (b) <= MB_WHEEL_RIGHT)
137 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
138 (b) <= MB_WHEEL_DOWN)
139 #define DEFAULT_WHEEL_STEPS 3
141 /* values for move directions */
142 #define MV_BIT_LEFT 0
143 #define MV_BIT_RIGHT 1
145 #define MV_BIT_DOWN 3
147 #define NUM_DIRECTIONS 4
149 /* diagonal movement directions are used in a different contect than buttons */
150 #define MV_BIT_UPLEFT 4
151 #define MV_BIT_UPRIGHT 5
152 #define MV_BIT_DOWNLEFT 6
153 #define MV_BIT_DOWNRIGHT 7
155 #define NUM_DIRECTIONS_FULL 8
157 /* values for special "button" bitmasks */
161 #define NUM_PLAYER_ACTIONS 6
163 /* values for special "focus player" bitmasks */
164 #define BIT_SET_FOCUS 6
166 /* values for move directions and special "button" key bitmasks */
168 #define MV_LEFT (1 << MV_BIT_LEFT)
169 #define MV_RIGHT (1 << MV_BIT_RIGHT)
170 #define MV_UP (1 << MV_BIT_UP)
171 #define MV_DOWN (1 << MV_BIT_DOWN)
173 #define MV_UPLEFT (MV_UP | MV_LEFT)
174 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
175 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
176 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
178 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
179 #define MV_VERTICAL (MV_UP | MV_DOWN)
180 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
181 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
182 #define MV_NO_DIRECTION (MV_NONE)
184 #define KEY_BUTTON_1 (1 << BUTTON_1)
185 #define KEY_BUTTON_2 (1 << BUTTON_2)
186 #define KEY_BUTTON_SNAP KEY_BUTTON_1
187 #define KEY_BUTTON_DROP KEY_BUTTON_2
188 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
189 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
190 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
192 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
194 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
195 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
196 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
197 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
198 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
201 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
202 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
203 (x) == MV_UP ? MV_BIT_UP : \
204 (x) == MV_DOWN ? MV_BIT_DOWN : \
205 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
206 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
207 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
208 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
211 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
212 (x) == MV_RIGHT ? MV_LEFT : \
213 (x) == MV_UP ? MV_DOWN : \
214 (x) == MV_DOWN ? MV_UP : \
215 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
216 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
217 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
218 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
221 /* values for animation mode (frame order and direction) */
223 #define ANIM_LOOP (1 << 0)
224 #define ANIM_LINEAR (1 << 1)
225 #define ANIM_PINGPONG (1 << 2)
226 #define ANIM_PINGPONG2 (1 << 3)
227 #define ANIM_RANDOM (1 << 4)
228 #define ANIM_CE_VALUE (1 << 5)
229 #define ANIM_CE_SCORE (1 << 6)
230 #define ANIM_CE_DELAY (1 << 7)
231 #define ANIM_REVERSE (1 << 8)
232 #define ANIM_OPAQUE_PLAYER (1 << 9)
234 /* values for special (non game element) animation modes */
235 #define ANIM_HORIZONTAL (1 << 10)
236 #define ANIM_VERTICAL (1 << 11)
237 #define ANIM_CENTERED (1 << 12)
238 #define ANIM_STATIC_PANEL (1 << 13)
240 #define ANIM_DEFAULT ANIM_LOOP
242 /* values for special drawing styles (currently only for crumbled graphics) */
244 #define STYLE_ACCURATE_BORDERS (1 << 0)
245 #define STYLE_INNER_CORNERS (1 << 1)
247 #define STYLE_DEFAULT STYLE_NONE
249 /* values for fade mode */
250 #define FADE_TYPE_NONE 0
251 #define FADE_TYPE_FADE_IN (1 << 0)
252 #define FADE_TYPE_FADE_OUT (1 << 1)
253 #define FADE_TYPE_TRANSFORM (1 << 2)
254 #define FADE_TYPE_CROSSFADE (1 << 3)
255 #define FADE_TYPE_MELT (1 << 4)
256 #define FADE_TYPE_SKIP (1 << 5)
258 #define FADE_MODE_NONE (FADE_TYPE_NONE)
259 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
260 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
261 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
262 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
263 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
264 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
265 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
266 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
268 #define FADE_MODE_DEFAULT FADE_MODE_FADE
270 /* values for text alignment */
271 #define ALIGN_LEFT (1 << 0)
272 #define ALIGN_RIGHT (1 << 1)
273 #define ALIGN_CENTER (1 << 2)
274 #define ALIGN_DEFAULT ALIGN_LEFT
276 #define VALIGN_TOP (1 << 0)
277 #define VALIGN_BOTTOM (1 << 1)
278 #define VALIGN_MIDDLE (1 << 2)
279 #define VALIGN_DEFAULT VALIGN_TOP
281 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
282 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
283 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
284 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
285 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
286 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
288 /* values for redraw_mask */
289 #define REDRAW_NONE (0)
290 #define REDRAW_ALL (1 << 0)
291 #define REDRAW_FIELD (1 << 1)
292 #define REDRAW_TILES (1 << 2)
293 #define REDRAW_DOOR_1 (1 << 3)
294 #define REDRAW_VIDEO_1 (1 << 4)
295 #define REDRAW_VIDEO_2 (1 << 5)
296 #define REDRAW_VIDEO_3 (1 << 6)
297 #define REDRAW_MICROLEVEL (1 << 7)
298 #define REDRAW_MICROLABEL (1 << 8)
299 #define REDRAW_FROM_BACKBUFFER (1 << 9)
300 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
303 #define REDRAW_DOOR_3 (1 << 10)
304 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
307 #define REDRAW_MAIN (REDRAW_FIELD | \
310 #define REDRAW_FPS (1 << 11)
312 /* on modern graphics systems and when using the SDL target, the old tile redraw
313 optimization can slow things down a lot due to many small blits compared to
314 one single playfield-sized blit (especially observed on Mac OS X with SDL) */
315 #define REDRAWTILES_THRESHOLD 0
317 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
318 y >= gfx.sy && y < gfx.sy + gfx.sysize)
319 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
320 x < gfx.real_sx + gfx.full_sxsize && \
321 y >= gfx.real_sy && \
322 y < gfx.real_sy + gfx.full_sysize)
323 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
324 y >= gfx.dy && y < gfx.dy + gfx.dysize)
325 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
326 y >= gfx.vy && y < gfx.vy + gfx.vysize)
327 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
328 y >= gfx.ey && y < gfx.ey + gfx.eysize)
330 /* values for mouse cursor */
331 #define CURSOR_DEFAULT 0
332 #define CURSOR_NONE 1
333 #define CURSOR_PLAYFIELD 2
335 /* fundamental game speed values */
336 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
337 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
338 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
339 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
340 #define FRAMES_PER_SECOND_SP 35
342 /* maximum playfield size supported by libgame functions */
343 #define MAX_PLAYFIELD_WIDTH 128
344 #define MAX_PLAYFIELD_HEIGHT 128
346 /* maximum number of parallel players supported by libgame functions */
347 #define MAX_PLAYERS 4
349 /* maximum allowed length of player name */
350 #define MAX_PLAYER_NAME_LEN 10
352 /* maximum number of levels in a level set */
353 #define MAX_LEVELS 1000
355 /* default name for empty highscore entry */
356 #define EMPTY_PLAYER_NAME "no name"
358 /* default name for unknown player names */
359 #define ANONYMOUS_NAME "anonymous"
361 /* default for other unknown names */
362 #define UNKNOWN_NAME "unknown"
364 /* default name for new levels */
365 #define NAMELESS_LEVEL_NAME "nameless level"
367 /* default text for non-existant artwork */
368 #define NOT_AVAILABLE "(not available)"
370 /* default value for undefined filename */
371 #define UNDEFINED_FILENAME "[NONE]"
373 /* default value for undefined parameter */
374 #define ARG_DEFAULT "[DEFAULT]"
376 /* default values for undefined configuration file parameters */
377 #define ARG_UNDEFINED "-1000000"
378 #define ARG_UNDEFINED_VALUE (-1000000)
380 /* default value for off-screen positions */
381 #define POS_OFFSCREEN (-1000000)
383 /* definitions for game sub-directories */
385 #define RO_GAME_DIR "."
389 #define RW_GAME_DIR "."
392 #define RO_BASE_PATH RO_GAME_DIR
393 #define RW_BASE_PATH RW_GAME_DIR
395 /* directory names */
396 #define GRAPHICS_DIRECTORY "graphics"
397 #define SOUNDS_DIRECTORY "sounds"
398 #define MUSIC_DIRECTORY "music"
399 #define LEVELS_DIRECTORY "levels"
400 #define TAPES_DIRECTORY "tapes"
401 #define SCORES_DIRECTORY "scores"
402 #define DOCS_DIRECTORY "docs"
403 #define CACHE_DIRECTORY "cache"
405 #define GFX_CLASSIC_SUBDIR "gfx_classic"
406 #define SND_CLASSIC_SUBDIR "snd_classic"
407 #define MUS_CLASSIC_SUBDIR "mus_classic"
409 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
410 #define GFX_DEFAULT_SUBDIR "jue0"
411 #define SND_DEFAULT_SUBDIR "jue0"
412 #define MUS_DEFAULT_SUBDIR "jue0"
414 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
415 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
416 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
419 #if defined(CREATE_SPECIAL_EDITION)
420 #define GFX_FALLBACK_FILENAME "fallback.pcx"
421 #define SND_FALLBACK_FILENAME "fallback.wav"
422 #define MUS_FALLBACK_FILENAME "fallback.wav"
425 /* file names and filename extensions */
426 #define LEVELSETUP_DIRECTORY "levelsetup"
427 #define SETUP_FILENAME "setup.conf"
428 #define LEVELSETUP_FILENAME "levelsetup.conf"
429 #define EDITORSETUP_FILENAME "editorsetup.conf"
430 #define EDITORCASCADE_FILENAME "editorcascade.conf"
431 #define HELPANIM_FILENAME "helpanim.conf"
432 #define HELPTEXT_FILENAME "helptext.conf"
433 #define LEVELINFO_FILENAME "levelinfo.conf"
434 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
435 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
436 #define MUSICINFO_FILENAME "musicinfo.conf"
437 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
438 #define LEVELFILE_EXTENSION "level"
439 #define TAPEFILE_EXTENSION "tape"
440 #define SCOREFILE_EXTENSION "score"
442 #define ERROR_BASENAME "stderr.txt"
444 #define CHAR_PATH_SEPARATOR_UNIX '/'
445 #define CHAR_PATH_SEPARATOR_DOS '\\'
447 #define STRING_PATH_SEPARATOR_UNIX "/"
448 #define STRING_PATH_SEPARATOR_DOS "\\"
450 #define STRING_NEWLINE_UNIX "\n"
451 #define STRING_NEWLINE_DOS "\r\n"
453 #if defined(PLATFORM_WIN32)
454 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
455 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
456 #define STRING_NEWLINE STRING_NEWLINE_DOS
458 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
459 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
460 #define STRING_NEWLINE STRING_NEWLINE_UNIX
464 /* areas in bitmap PIX_DOOR */
465 /* meaning in PIX_DB_DOOR: (3 PAGEs)
466 PAGEX1: 1. buffer for DOOR_1
467 PAGEX2: 2. buffer for DOOR_1
468 PAGEX3: buffer for animations
471 /* these values are hard-coded to be able to use them in initialization */
472 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
473 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
475 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
476 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
477 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
478 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
479 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
480 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
481 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
482 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
483 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
484 #define DOOR_GFX_PAGEY1 (0)
485 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
488 /* macros for version handling */
489 #define VERSION_MAJOR(x) ((x) / 1000000)
490 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
491 #define VERSION_PATCH(x) (((x) % 10000) / 100)
492 #define VERSION_BUILD(x) ((x) % 100)
493 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
496 /* macros for parent/child process identification */
497 #if defined(PLATFORM_UNIX)
498 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
499 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
500 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
502 #define IS_PARENT_PROCESS() TRUE
503 #define IS_CHILD_PROCESS() FALSE
504 #define HAS_CHILD_PROCESS() FALSE
508 /* values for artwork type */
509 #define ARTWORK_TYPE_GRAPHICS 0
510 #define ARTWORK_TYPE_SOUNDS 1
511 #define ARTWORK_TYPE_MUSIC 2
513 #define NUM_ARTWORK_TYPES 3
516 /* values for tree type (chosen to match artwork type) */
517 #define TREE_TYPE_UNDEFINED -1
518 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
519 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
520 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
521 #define TREE_TYPE_LEVEL_DIR 3
522 #define TREE_TYPE_LEVEL_NR 4
524 #define NUM_TREE_TYPES 5
526 #define INFOTEXT_UNDEFINED ""
527 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
528 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
529 #define INFOTEXT_MUSIC_DIR "Custom Music"
530 #define INFOTEXT_LEVEL_DIR "Level Sets"
531 #define INFOTEXT_LEVEL_NR "Levels"
533 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
534 INFOTEXT_LEVEL_NR : \
535 (t) == TREE_TYPE_LEVEL_DIR ? \
536 INFOTEXT_LEVEL_DIR : \
537 (t) == TREE_TYPE_GRAPHICS_DIR ? \
538 INFOTEXT_GRAPHICS_DIR : \
539 (t) == TREE_TYPE_SOUNDS_DIR ? \
540 INFOTEXT_SOUNDS_DIR : \
541 (t) == TREE_TYPE_MUSIC_DIR ? \
542 INFOTEXT_MUSIC_DIR : \
545 /* values for artwork handling */
546 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
547 ((type) == ARTWORK_TYPE_GRAPHICS ? \
548 &(leveldir)->graphics_set : \
549 (type) == ARTWORK_TYPE_SOUNDS ? \
550 &(leveldir)->sounds_set : \
551 &(leveldir)->music_set)
553 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
554 ((type) == ARTWORK_TYPE_GRAPHICS ? \
555 (leveldir)->graphics_set : \
556 (type) == ARTWORK_TYPE_SOUNDS ? \
557 (leveldir)->sounds_set : \
558 (leveldir)->music_set)
560 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
561 ((type) == ARTWORK_TYPE_GRAPHICS ? \
562 &(leveldir)->graphics_path : \
563 (type) == ARTWORK_TYPE_SOUNDS ? \
564 &(leveldir)->sounds_path : \
565 &(leveldir)->music_path)
567 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
568 ((type) == ARTWORK_TYPE_GRAPHICS ? \
569 (leveldir)->graphics_path : \
570 (type) == ARTWORK_TYPE_SOUNDS ? \
571 (leveldir)->sounds_path : \
572 (leveldir)->music_path)
574 #define SETUP_ARTWORK_SET(setup, type) \
575 ((type) == ARTWORK_TYPE_GRAPHICS ? \
576 (setup).graphics_set : \
577 (type) == ARTWORK_TYPE_SOUNDS ? \
578 (setup).sounds_set : \
581 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
582 ((type) == ARTWORK_TYPE_GRAPHICS ? \
583 (setup).override_level_graphics : \
584 (type) == ARTWORK_TYPE_SOUNDS ? \
585 (setup).override_level_sounds : \
586 (setup).override_level_music)
588 #define GFX_OVERRIDE_ARTWORK(type) \
589 ((type) == ARTWORK_TYPE_GRAPHICS ? \
590 gfx.override_level_graphics : \
591 (type) == ARTWORK_TYPE_SOUNDS ? \
592 gfx.override_level_sounds : \
593 gfx.override_level_music)
595 #define ARTWORK_FIRST_NODE(artwork, type) \
596 ((type) == ARTWORK_TYPE_GRAPHICS ? \
597 (artwork).gfx_first : \
598 (type) == ARTWORK_TYPE_SOUNDS ? \
599 (artwork).snd_first : \
602 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
603 ((type) == ARTWORK_TYPE_GRAPHICS ? \
604 &(artwork).gfx_current_identifier : \
605 (type) == ARTWORK_TYPE_SOUNDS ? \
606 &(artwork).snd_current_identifier : \
607 &(artwork).mus_current_identifier)
609 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
610 ((type) == ARTWORK_TYPE_GRAPHICS ? \
611 (artwork).gfx_current_identifier : \
612 (type) == ARTWORK_TYPE_SOUNDS ? \
613 (artwork).snd_current_identifier : \
614 (artwork).mus_current_identifier)
616 #define ARTWORKINFO_FILENAME(type) \
617 ((type) == ARTWORK_TYPE_GRAPHICS ? \
618 GRAPHICSINFO_FILENAME : \
619 (type) == ARTWORK_TYPE_SOUNDS ? \
620 SOUNDSINFO_FILENAME : \
621 (type) == ARTWORK_TYPE_MUSIC ? \
622 MUSICINFO_FILENAME : "")
624 #define ARTWORK_DIRECTORY(type) \
625 ((type) == ARTWORK_TYPE_GRAPHICS ? \
626 GRAPHICS_DIRECTORY : \
627 (type) == ARTWORK_TYPE_SOUNDS ? \
629 (type) == ARTWORK_TYPE_MUSIC ? \
630 MUSIC_DIRECTORY : "")
632 #define OPTIONS_ARTWORK_DIRECTORY(type) \
633 ((type) == ARTWORK_TYPE_GRAPHICS ? \
634 options.graphics_directory : \
635 (type) == ARTWORK_TYPE_SOUNDS ? \
636 options.sounds_directory : \
637 (type) == ARTWORK_TYPE_MUSIC ? \
638 options.music_directory : "")
640 #define UPDATE_BUSY_STATE() \
642 if (gfx.draw_busy_anim_function != NULL) \
643 gfx.draw_busy_anim_function(); \
647 /* type definitions */
648 #if defined(TARGET_SDL2)
649 typedef int (*EventFilter)(void *, Event *);
651 typedef int (*EventFilter)(const Event *);
655 /* structure definitions */
659 char *command_basepath; /* path to the program binary */
660 char *command_basename; /* base filename of the program binary */
662 char *maindata_path; /* main game data (installation) directory */
664 char *userdata_subdir; /* personal user game data directory */
665 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
666 char *userdata_path; /* resulting full path to game data directory */
672 char *sdl_icon_filename;
676 char *error_filename; /* filename where to write error messages to */
677 FILE *error_file; /* (used instead of 'stderr' on some systems) */
683 char *(*window_title_function)(void);
684 void (*exit_message_function)(char *, va_list);
685 void (*exit_function)(int);
694 char *ro_base_directory;
695 char *rw_base_directory;
696 char *level_directory;
697 char *graphics_directory;
698 char *sounds_directory;
699 char *music_directory;
700 char *docs_directory;
702 char *execute_command;
710 boolean debug_x11_sync;
713 struct ScreenModeInfo
718 struct VideoSystemInfo
721 int width, height, depth;
722 int window_width, window_height;
724 boolean fullscreen_available;
725 boolean fullscreen_enabled;
726 boolean fullscreen_initial;
727 struct ScreenModeInfo *fullscreen_modes;
728 char *fullscreen_mode_current;
730 boolean window_scaling_available;
731 int window_scaling_percent;
732 char *window_scaling_quality;
735 struct AudioSystemInfo
737 boolean sound_available;
738 boolean loops_available;
739 boolean music_available;
741 boolean sound_enabled;
742 boolean sound_deactivated; /* for temporarily disabling sound */
751 int first_sound_channel;
754 struct FontBitmapInfo
758 int src_x, src_y; /* start position of animation frames */
759 int width, height; /* width/height of each animation frame */
761 int draw_xoffset; /* offset for drawing font characters */
762 int draw_yoffset; /* offset for drawing font characters */
765 int num_chars_per_line;
772 int real_sx, real_sy;
773 int full_sxsize, full_sysize;
774 int scrollbuffer_width, scrollbuffer_height;
785 int win_xsize, win_ysize;
787 int draw_deactivation_mask;
788 int draw_background_mask;
790 Bitmap *field_save_buffer;
792 Bitmap *background_bitmap;
793 int background_bitmap_mask;
795 boolean clipping_enabled;
797 int clip_width, clip_height;
799 boolean override_level_graphics;
800 boolean override_level_sounds;
801 boolean override_level_music;
803 boolean draw_init_text;
806 struct FontBitmapInfo *font_bitmap_info;
807 int (*select_font_function)(int);
808 int (*get_font_from_token_function)(char *);
810 int anim_random_frame;
812 void (*draw_busy_anim_function)(void);
818 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
821 struct SetupJoystickInfo
823 char *device_name; /* device name of player's joystick */
825 int xleft, xmiddle, xright;
826 int yupper, ymiddle, ylower;
830 struct SetupKeyboardInfo
832 Key left, right, up, down;
836 struct SetupTouchInfo
843 struct SetupInputInfo
845 boolean use_joystick;
846 struct SetupJoystickInfo joy;
847 struct SetupKeyboardInfo key;
850 struct SetupEditorInfo
852 boolean el_boulderdash;
853 boolean el_emerald_mine;
854 boolean el_emerald_mine_club;
858 boolean el_diamond_caves;
859 boolean el_dx_boulderdash;
861 boolean el_steel_chars;
863 boolean el_user_defined;
866 boolean el_headlines;
871 boolean show_element_token;
874 struct SetupEditorCascadeInfo
885 boolean el_steel_chars;
893 struct SetupShortcutInfo
899 Key focus_player[MAX_PLAYERS];
900 Key focus_player_all;
919 struct SetupSystemInfo
921 char *sdl_videodriver;
922 char *sdl_audiodriver;
923 int audio_fragment_size;
933 boolean sound_simple;
935 boolean scroll_delay;
936 boolean scroll_delay_value;
937 boolean soft_scrolling;
938 boolean fade_screens;
940 boolean show_titlescreen;
947 char *fullscreen_mode;
948 int window_scaling_percent;
949 char *window_scaling_quality;
950 boolean ask_on_escape;
951 boolean ask_on_escape_editor;
952 boolean quick_switch;
953 boolean input_on_focus;
954 boolean prefer_aga_graphics;
955 int game_frame_delay;
956 boolean sp_show_border_elements;
957 boolean small_game_graphics;
962 int override_level_graphics; /* not boolean -- can also be "AUTO" */
963 int override_level_sounds; /* not boolean -- can also be "AUTO" */
964 int override_level_music; /* not boolean -- can also be "AUTO" */
970 struct SetupEditorInfo editor;
971 struct SetupEditorCascadeInfo editor_cascade;
972 struct SetupShortcutInfo shortcut;
973 struct SetupInputInfo input[MAX_PLAYERS];
974 struct SetupTouchInfo touch;
975 struct SetupSystemInfo system;
976 struct OptionInfo options;
981 struct TreeInfo **node_top; /* topmost node in tree */
982 struct TreeInfo *node_parent; /* parent level directory info */
983 struct TreeInfo *node_group; /* level group sub-directory info */
984 struct TreeInfo *next; /* next level series structure node */
986 int cl_first; /* internal control field for setup screen */
987 int cl_cursor; /* internal control field for setup screen */
989 int type; /* type of tree content */
991 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
993 char *subdir; /* tree info sub-directory basename (may be ".") */
994 char *fullpath; /* complete path relative to tree base directory */
995 char *basepath; /* absolute base path of tree base directory */
996 char *identifier; /* identifier string for configuration files */
997 char *name; /* tree info name, as displayed in selection menues */
998 char *name_sorting; /* optional sorting name for correct name sorting */
999 char *author; /* level or artwork author name */
1000 char *year; /* optional year of creation for levels or artwork */
1001 char *imported_from; /* optional comment for imported levels or artwork */
1002 char *imported_by; /* optional comment for imported levels or artwork */
1003 char *tested_by; /* optional comment to name people who tested a set */
1005 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1006 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1007 char *graphics_set; /* optional custom graphics set (level tree only) */
1008 char *sounds_set; /* optional custom sounds set (level tree only) */
1009 char *music_set; /* optional custom music set (level tree only) */
1010 char *graphics_path; /* path to optional custom graphics set (level only) */
1011 char *sounds_path; /* path to optional custom sounds set (level only) */
1012 char *music_path; /* path to optional custom music set (level only) */
1014 char *level_filename; /* filename of level file (for packed level file) */
1015 char *level_filetype; /* type of levels in level directory or level file */
1017 char *special_flags; /* flags for special actions performed on level file */
1019 int levels; /* number of levels in level series */
1020 int first_level; /* first level number (to allow start with 0 or 1) */
1021 int last_level; /* last level number (automatically calculated) */
1022 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1024 boolean latest_engine;/* force level set to use the latest game engine */
1026 boolean level_group; /* directory contains more level series directories */
1027 boolean parent_link; /* entry links back to parent directory */
1028 boolean in_user_dir; /* user defined levels are stored in home directory */
1029 boolean user_defined; /* levels in user directory and marked as "private" */
1030 boolean readonly; /* readonly levels can not be changed with editor */
1031 boolean handicap; /* level set has no handicap when set to "false" */
1032 boolean skip_levels; /* levels can be skipped when set to "true" */
1034 int color; /* color to use on selection screen for this level */
1035 char *class_desc; /* description of level series class */
1036 int handicap_level; /* number of the lowest unsolved level */
1038 char *infotext; /* optional text to describe the tree type (headline) */
1041 typedef struct TreeInfo TreeInfo;
1042 typedef struct TreeInfo LevelDirTree;
1043 typedef struct TreeInfo ArtworkDirTree;
1044 typedef struct TreeInfo GraphicsDirTree;
1045 typedef struct TreeInfo SoundsDirTree;
1046 typedef struct TreeInfo MusicDirTree;
1050 GraphicsDirTree *gfx_first;
1051 GraphicsDirTree *gfx_current;
1052 SoundsDirTree *snd_first;
1053 SoundsDirTree *snd_current;
1054 MusicDirTree *mus_first;
1055 MusicDirTree *mus_current;
1057 char *gfx_current_identifier;
1058 char *snd_current_identifier;
1059 char *mus_current_identifier;
1062 struct ValueTextInfo
1074 struct ConfigTypeInfo
1081 struct TokenIntPtrInfo
1091 char *default_filename;
1094 char **default_parameter; /* array of file parameters */
1095 char **parameter; /* array of file parameters */
1098 boolean fallback_to_default;
1099 boolean default_is_cloned;
1102 struct SetupFileList
1107 struct SetupFileList *next;
1112 char *source_filename; /* primary key for node list */
1116 struct PropertyMapping
1126 struct ArtworkListInfo
1128 int type; /* type of artwork */
1130 int num_file_list_entries;
1131 int num_dynamic_file_list_entries;
1132 struct FileInfo *file_list; /* static artwork file array */
1133 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1135 int num_suffix_list_entries;
1136 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1138 int num_base_prefixes;
1139 int num_ext1_suffixes;
1140 int num_ext2_suffixes;
1141 int num_ext3_suffixes;
1142 char **base_prefixes; /* base token prefixes array */
1143 char **ext1_suffixes; /* property suffixes array 1 */
1144 char **ext2_suffixes; /* property suffixes array 2 */
1145 char **ext3_suffixes; /* property suffixes array 3 */
1147 int num_ignore_tokens;
1148 char **ignore_tokens; /* file tokens to be ignored */
1150 int num_property_mapping_entries;
1151 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1153 int sizeof_artwork_list_entry;
1155 struct ListNodeInfo **artwork_list; /* static artwork node array */
1156 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1157 struct ListNode *content_list; /* dynamic artwork node list */
1159 void *(*load_artwork)(char *); /* constructor function */
1160 void (*free_artwork)(void *); /* destructor function */
1174 struct RectWithBorder
1188 struct DoorPartPosInfo
1195 int start_step_opening;
1196 int start_step_closing;
1197 boolean draw_masked;
1208 boolean draw_masked;
1209 boolean draw_player; /* special case for network player buttons */
1221 /* ========================================================================= */
1222 /* exported variables */
1223 /* ========================================================================= */
1225 extern struct ProgramInfo program;
1226 extern struct OptionInfo options;
1227 extern struct VideoSystemInfo video;
1228 extern struct AudioSystemInfo audio;
1229 extern struct GfxInfo gfx;
1230 extern struct AnimInfo anim;
1231 extern struct ArtworkInfo artwork;
1232 extern struct JoystickInfo joystick;
1233 extern struct SetupInfo setup;
1235 extern LevelDirTree *leveldir_first_all;
1236 extern LevelDirTree *leveldir_first;
1237 extern LevelDirTree *leveldir_current;
1238 extern int level_nr;
1240 extern struct LevelStats level_stats[];
1242 extern Display *display;
1243 extern Visual *visual;
1245 extern Colormap cmap;
1247 extern DrawWindow *window;
1248 extern DrawBuffer *backbuffer;
1249 extern DrawBuffer *drawto;
1251 extern int button_status;
1252 extern boolean motion_status;
1253 #if defined(TARGET_SDL2)
1254 extern boolean keyrepeat_status;
1257 extern int redraw_mask;
1258 extern int redraw_tiles;
1260 extern int FrameCounter;
1263 /* function definitions */
1265 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1268 void SetWindowTitle();
1270 void InitWindowTitleFunction(char *(*window_title_function)(void));
1271 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1272 void InitExitFunction(void (*exit_function)(int));
1273 void InitPlatformDependentStuff(void);
1274 void ClosePlatformDependentStuff(void);
1276 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1277 void InitGfxDoor1Info(int, int, int, int);
1278 void InitGfxDoor2Info(int, int, int, int);
1279 void InitGfxDoor3Info(int, int, int, int);
1280 void InitGfxWindowInfo(int, int);
1281 void InitGfxScrollbufferInfo(int, int);
1282 void InitGfxClipRegion(boolean, int, int, int, int);
1283 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1284 void InitGfxCustomArtworkInfo();
1285 void SetDrawDeactivationMask(int);
1286 void SetDrawBackgroundMask(int);
1287 void SetWindowBackgroundBitmap(Bitmap *);
1288 void SetMainBackgroundBitmap(Bitmap *);
1289 void SetDoorBackgroundBitmap(Bitmap *);
1291 void LimitScreenUpdates(boolean);
1293 void InitVideoDisplay(void);
1294 void CloseVideoDisplay(void);
1295 void InitVideoBuffer(int, int, int, boolean);
1296 Bitmap *CreateBitmapStruct(void);
1297 Bitmap *CreateBitmap(int, int, int);
1298 void ReCreateBitmap(Bitmap **, int, int, int);
1299 void FreeBitmap(Bitmap *);
1300 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1301 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1302 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1303 void (*draw_border_function)(void));
1304 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1305 void ClearRectangle(Bitmap *, int, int, int, int);
1306 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1307 void SetClipMask(Bitmap *, GC, Pixmap);
1308 void SetClipOrigin(Bitmap *, GC, int, int);
1309 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1310 boolean DrawingOnBackground(int, int);
1311 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1312 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1313 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1314 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1315 Pixel GetPixel(Bitmap *, int, int);
1316 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1317 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1319 void FlushDisplay(void);
1320 void SyncDisplay(void);
1321 void KeyboardAutoRepeatOn(void);
1322 void KeyboardAutoRepeatOff(void);
1323 boolean PointerInWindow(DrawWindow *);
1324 boolean SetVideoMode(boolean);
1325 boolean ChangeVideoModeIfNeeded(boolean);
1327 Bitmap *LoadImage(char *);
1328 Bitmap *LoadCustomImage(char *);
1329 void ReloadCustomImage(Bitmap *, char *);
1331 Bitmap *ZoomBitmap(Bitmap *, int, int);
1332 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1333 void ScaleBitmap(Bitmap *, int);
1335 void SetMouseCursor(int);
1337 void OpenAudio(void);
1338 void CloseAudio(void);
1339 void SetAudioMode(boolean);
1341 void InitEventFilter(EventFilter);
1342 boolean PendingEvent(void);
1343 void NextEvent(Event *event);
1344 void PeekEvent(Event *event);
1345 Key GetEventKey(KeyEvent *, boolean);
1346 KeyMod HandleKeyModState(Key, int);
1347 KeyMod GetKeyModState();
1348 KeyMod GetKeyModStateFromEvents();
1349 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1351 void InitJoysticks();
1352 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1354 #endif /* SYSTEM_H */