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_MSDOS)
27 #elif defined(PLATFORM_ANDROID)
31 #if defined(TARGET_SDL)
33 #elif defined(TARGET_X11)
38 /* the additional 'b' is needed for Win32 to open files in binary mode */
39 #define MODE_READ "rb"
40 #define MODE_WRITE "wb"
41 #define MODE_APPEND "ab"
43 #define DEFAULT_DEPTH 0
47 #define BLIT_INVERSE 2
48 #define BLIT_ON_BACKGROUND 3
50 #define FULLSCREEN_NOT_AVAILABLE FALSE
51 #define FULLSCREEN_AVAILABLE TRUE
53 /* default input keys */
54 #define DEFAULT_KEY_LEFT KSYM_Left
55 #define DEFAULT_KEY_RIGHT KSYM_Right
56 #define DEFAULT_KEY_UP KSYM_Up
57 #define DEFAULT_KEY_DOWN KSYM_Down
58 #if defined(PLATFORM_MACOSX)
59 #define DEFAULT_KEY_SNAP KSYM_Control_L
60 #define DEFAULT_KEY_DROP KSYM_KP_Enter
62 #define DEFAULT_KEY_SNAP KSYM_Control_L
63 #define DEFAULT_KEY_DROP KSYM_Control_R
65 #define DEFAULT_KEY_OKAY KSYM_Return
66 #define DEFAULT_KEY_CANCEL KSYM_Escape
68 /* default shortcut keys */
69 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
70 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
71 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
72 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
73 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
74 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
75 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
76 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
77 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
78 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
79 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
80 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
81 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
82 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
83 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
84 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
85 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
86 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
87 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
88 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
89 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
91 /* values for key_status */
92 #define KEY_NOT_PRESSED FALSE
93 #define KEY_RELEASED FALSE
94 #define KEY_PRESSED TRUE
96 /* values for button status */
97 #define MB_NOT_PRESSED FALSE
98 #define MB_NOT_RELEASED TRUE
99 #define MB_RELEASED FALSE
100 #define MB_PRESSED TRUE
101 #define MB_MENU_CHOICE FALSE
102 #define MB_MENU_MARK TRUE
103 #define MB_MENU_INITIALIZE (-1)
104 #define MB_MENU_LEAVE (-2)
105 #define MB_LEFTBUTTON 1
106 #define MB_MIDDLEBUTTON 2
107 #define MB_RIGHTBUTTON 3
108 #define MB_WHEEL_UP 4
109 #define MB_WHEEL_DOWN 5
110 #define MB_WHEEL_LEFT 6
111 #define MB_WHEEL_RIGHT 7
112 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
113 (b) <= MB_WHEEL_DOWN)
114 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
115 (b) <= MB_WHEEL_RIGHT)
116 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
117 (b) <= MB_WHEEL_DOWN)
118 #define DEFAULT_WHEEL_STEPS 3
120 /* values for move directions */
121 #define MV_BIT_LEFT 0
122 #define MV_BIT_RIGHT 1
124 #define MV_BIT_DOWN 3
126 #define NUM_DIRECTIONS 4
128 /* diagonal movement directions are used in a different contect than buttons */
129 #define MV_BIT_UPLEFT 4
130 #define MV_BIT_UPRIGHT 5
131 #define MV_BIT_DOWNLEFT 6
132 #define MV_BIT_DOWNRIGHT 7
134 #define NUM_DIRECTIONS_FULL 8
136 /* values for special "button" bitmasks */
140 #define NUM_PLAYER_ACTIONS 6
142 /* values for special "focus player" bitmasks */
143 #define BIT_SET_FOCUS 6
145 /* values for move directions and special "button" key bitmasks */
147 #define MV_LEFT (1 << MV_BIT_LEFT)
148 #define MV_RIGHT (1 << MV_BIT_RIGHT)
149 #define MV_UP (1 << MV_BIT_UP)
150 #define MV_DOWN (1 << MV_BIT_DOWN)
152 #define MV_UPLEFT (MV_UP | MV_LEFT)
153 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
154 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
155 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
157 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
158 #define MV_VERTICAL (MV_UP | MV_DOWN)
159 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
160 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
161 #define MV_NO_DIRECTION (MV_NONE)
163 #define KEY_BUTTON_1 (1 << BUTTON_1)
164 #define KEY_BUTTON_2 (1 << BUTTON_2)
165 #define KEY_BUTTON_SNAP KEY_BUTTON_1
166 #define KEY_BUTTON_DROP KEY_BUTTON_2
167 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
168 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
169 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
171 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
173 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
174 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
175 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
176 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
177 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
180 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
181 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
182 (x) == MV_UP ? MV_BIT_UP : \
183 (x) == MV_DOWN ? MV_BIT_DOWN : \
184 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
185 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
186 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
187 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
190 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
191 (x) == MV_RIGHT ? MV_LEFT : \
192 (x) == MV_UP ? MV_DOWN : \
193 (x) == MV_DOWN ? MV_UP : \
194 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
195 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
196 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
197 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
200 /* values for animation mode (frame order and direction) */
202 #define ANIM_LOOP (1 << 0)
203 #define ANIM_LINEAR (1 << 1)
204 #define ANIM_PINGPONG (1 << 2)
205 #define ANIM_PINGPONG2 (1 << 3)
206 #define ANIM_RANDOM (1 << 4)
207 #define ANIM_CE_VALUE (1 << 5)
208 #define ANIM_CE_SCORE (1 << 6)
209 #define ANIM_CE_DELAY (1 << 7)
210 #define ANIM_REVERSE (1 << 8)
211 #define ANIM_OPAQUE_PLAYER (1 << 9)
213 /* values for special (non game element) animation modes */
214 #define ANIM_HORIZONTAL (1 << 10)
215 #define ANIM_VERTICAL (1 << 11)
216 #define ANIM_CENTERED (1 << 12)
217 #define ANIM_STATIC_PANEL (1 << 13)
219 #define ANIM_DEFAULT ANIM_LOOP
221 /* values for special drawing styles (currently only for crumbled graphics) */
223 #define STYLE_ACCURATE_BORDERS (1 << 0)
224 #define STYLE_INNER_CORNERS (1 << 1)
226 #define STYLE_DEFAULT STYLE_NONE
228 /* values for fade mode */
229 #define FADE_TYPE_NONE 0
230 #define FADE_TYPE_FADE_IN (1 << 0)
231 #define FADE_TYPE_FADE_OUT (1 << 1)
232 #define FADE_TYPE_TRANSFORM (1 << 2)
233 #define FADE_TYPE_CROSSFADE (1 << 3)
234 #define FADE_TYPE_MELT (1 << 4)
235 #define FADE_TYPE_SKIP (1 << 5)
237 #define FADE_MODE_NONE (FADE_TYPE_NONE)
238 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
239 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
240 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
241 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
242 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
243 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
244 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
245 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
247 #define FADE_MODE_DEFAULT FADE_MODE_FADE
249 /* values for text alignment */
250 #define ALIGN_LEFT (1 << 0)
251 #define ALIGN_RIGHT (1 << 1)
252 #define ALIGN_CENTER (1 << 2)
253 #define ALIGN_DEFAULT ALIGN_LEFT
255 #define VALIGN_TOP (1 << 0)
256 #define VALIGN_BOTTOM (1 << 1)
257 #define VALIGN_MIDDLE (1 << 2)
258 #define VALIGN_DEFAULT VALIGN_TOP
260 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
261 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
262 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
263 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
264 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
265 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
267 /* values for redraw_mask */
268 #define REDRAW_NONE (0)
269 #define REDRAW_ALL (1 << 0)
270 #define REDRAW_FIELD (1 << 1)
271 #define REDRAW_TILES (1 << 2)
272 #define REDRAW_DOOR_1 (1 << 3)
273 #define REDRAW_VIDEO_1 (1 << 4)
274 #define REDRAW_VIDEO_2 (1 << 5)
275 #define REDRAW_VIDEO_3 (1 << 6)
276 #define REDRAW_MICROLEVEL (1 << 7)
277 #define REDRAW_MICROLABEL (1 << 8)
278 #define REDRAW_FROM_BACKBUFFER (1 << 9)
279 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
282 #define REDRAW_DOOR_3 (1 << 10)
283 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
286 #define REDRAW_MAIN (REDRAW_FIELD | \
289 #define REDRAW_FPS (1 << 11)
291 #if defined(TARGET_X11)
292 /* on old-style, classic and potentially slow graphics systems, redraw single
293 tiles instead of the whole playfield unless a certain threshold is reached;
294 when using the X11 target, this method should still be fast on all systems */
295 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
297 /* on modern graphics systems and when using the SDL target, this tile redraw
298 optimization can slow things down a lot due to many small blits compared to
299 one single playfield-sized blit (especially observed on Mac OS X with SDL) */
300 #define REDRAWTILES_THRESHOLD 0
303 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
304 y >= gfx.sy && y < gfx.sy + gfx.sysize)
305 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
306 y >= gfx.dy && y < gfx.dy + gfx.dysize)
307 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
308 y >= gfx.vy && y < gfx.vy + gfx.vysize)
310 /* values for mouse cursor */
311 #define CURSOR_DEFAULT 0
312 #define CURSOR_NONE 1
313 #define CURSOR_PLAYFIELD 2
315 /* fundamental game speed values */
316 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
317 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
318 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
319 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
320 #define FRAMES_PER_SECOND_SP 35
322 /* maximum playfield size supported by libgame functions */
323 #define MAX_PLAYFIELD_WIDTH 128
324 #define MAX_PLAYFIELD_HEIGHT 128
326 /* maximum number of parallel players supported by libgame functions */
327 #define MAX_PLAYERS 4
329 /* maximum allowed length of player name */
330 #define MAX_PLAYER_NAME_LEN 10
332 /* maximum number of levels in a level set */
333 #define MAX_LEVELS 1000
335 /* default name for empty highscore entry */
336 #define EMPTY_PLAYER_NAME "no name"
338 /* default name for unknown player names */
339 #define ANONYMOUS_NAME "anonymous"
341 /* default for other unknown names */
342 #define UNKNOWN_NAME "unknown"
344 /* default name for new levels */
345 #define NAMELESS_LEVEL_NAME "nameless level"
347 /* default text for non-existant artwork */
348 #define NOT_AVAILABLE "(not available)"
350 /* default value for undefined filename */
351 #define UNDEFINED_FILENAME "[NONE]"
353 /* default value for undefined parameter */
354 #define ARG_DEFAULT "[DEFAULT]"
356 /* default values for undefined configuration file parameters */
357 #define ARG_UNDEFINED "-1000000"
358 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
360 /* definitions for game sub-directories */
362 #define RO_GAME_DIR "."
366 #define RW_GAME_DIR "."
369 #define RO_BASE_PATH RO_GAME_DIR
370 #define RW_BASE_PATH RW_GAME_DIR
372 /* directory names */
373 #define GRAPHICS_DIRECTORY "graphics"
374 #define SOUNDS_DIRECTORY "sounds"
375 #define MUSIC_DIRECTORY "music"
376 #define LEVELS_DIRECTORY "levels"
377 #define TAPES_DIRECTORY "tapes"
378 #define SCORES_DIRECTORY "scores"
379 #define DOCS_DIRECTORY "docs"
380 #define CACHE_DIRECTORY "cache"
382 #if !defined(PLATFORM_MSDOS)
383 #define GFX_CLASSIC_SUBDIR "gfx_classic"
384 #define SND_CLASSIC_SUBDIR "snd_classic"
385 #define MUS_CLASSIC_SUBDIR "mus_classic"
387 #define GFX_CLASSIC_SUBDIR "gfx_orig"
388 #define SND_CLASSIC_SUBDIR "snd_orig"
389 #define MUS_CLASSIC_SUBDIR "mus_orig"
392 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
393 #define GFX_DEFAULT_SUBDIR "jue0"
394 #define SND_DEFAULT_SUBDIR "jue0"
395 #define MUS_DEFAULT_SUBDIR "jue0"
397 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
398 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
399 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
402 #if defined(CREATE_SPECIAL_EDITION)
403 #define GFX_FALLBACK_FILENAME "fallback.pcx"
404 #define SND_FALLBACK_FILENAME "fallback.wav"
405 #define MUS_FALLBACK_FILENAME "fallback.wav"
408 /* file names and filename extensions */
409 #if !defined(PLATFORM_MSDOS)
410 #define LEVELSETUP_DIRECTORY "levelsetup"
411 #define SETUP_FILENAME "setup.conf"
412 #define LEVELSETUP_FILENAME "levelsetup.conf"
413 #define EDITORSETUP_FILENAME "editorsetup.conf"
414 #define EDITORCASCADE_FILENAME "editorcascade.conf"
415 #define HELPANIM_FILENAME "helpanim.conf"
416 #define HELPTEXT_FILENAME "helptext.conf"
417 #define LEVELINFO_FILENAME "levelinfo.conf"
418 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
419 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
420 #define MUSICINFO_FILENAME "musicinfo.conf"
421 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
422 #define LEVELFILE_EXTENSION "level"
423 #define TAPEFILE_EXTENSION "tape"
424 #define SCOREFILE_EXTENSION "score"
426 #define LEVELSETUP_DIRECTORY "lvlsetup"
427 #define SETUP_FILENAME "setup.cnf"
428 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
429 #define EDITORSETUP_FILENAME "edsetup.cnf"
430 #define EDITORCASCADE_FILENAME "edcascad.conf"
431 #define HELPANIM_FILENAME "helpanim.cnf"
432 #define HELPTEXT_FILENAME "helptext.cnf"
433 #define LEVELINFO_FILENAME "lvlinfo.cnf"
434 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
435 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
436 #define MUSICINFO_FILENAME "musinfo.cnf"
437 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
438 #define LEVELFILE_EXTENSION "lvl"
439 #define TAPEFILE_EXTENSION "tap"
440 #define SCOREFILE_EXTENSION "sco"
443 #define ERROR_BASENAME "stderr.txt"
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) || defined(PLATFORM_MSDOS)
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 *x11_icon_filename;
674 char *x11_iconmask_filename;
675 char *sdl_icon_filename;
676 char *msdos_cursor_filename;
679 char *filename_prefix; /* prefix to cut off from DOS filenames */
681 char *error_filename; /* filename where to write error messages to */
682 FILE *error_file; /* (used instead of 'stderr' on some systems) */
688 void (*exit_message_function)(char *, va_list);
689 void (*exit_function)(int);
698 char *ro_base_directory;
699 char *rw_base_directory;
700 char *level_directory;
701 char *graphics_directory;
702 char *sounds_directory;
703 char *music_directory;
704 char *docs_directory;
706 char *execute_command;
714 boolean debug_x11_sync;
717 struct ScreenModeInfo
722 struct VideoSystemInfo
725 int width, height, depth;
727 boolean fullscreen_available;
728 boolean fullscreen_enabled;
729 struct ScreenModeInfo *fullscreen_modes;
730 char *fullscreen_mode_current;
733 struct AudioSystemInfo
735 boolean sound_available;
736 boolean loops_available;
737 boolean music_available;
739 boolean sound_enabled;
740 boolean sound_deactivated; /* for temporarily disabling sound */
749 int first_sound_channel;
752 struct FontBitmapInfo
756 int src_x, src_y; /* start position of animation frames */
757 int width, height; /* width/height of each animation frame */
759 int draw_xoffset; /* offset for drawing font characters */
760 int draw_yoffset; /* offset for drawing font characters */
763 int num_chars_per_line;
765 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
766 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
774 int real_sx, real_sy;
775 int full_sxsize, full_sysize;
776 int scrollbuffer_width, scrollbuffer_height;
784 int win_xsize, win_ysize;
786 int draw_deactivation_mask;
787 int draw_background_mask;
789 Bitmap *field_save_buffer;
791 Bitmap *background_bitmap;
792 int background_bitmap_mask;
794 boolean clipping_enabled;
796 int clip_width, clip_height;
798 boolean override_level_graphics;
799 boolean override_level_sounds;
800 boolean override_level_music;
802 boolean draw_init_text;
805 struct FontBitmapInfo *font_bitmap_info;
806 int (*select_font_function)(int);
807 int (*get_font_from_token_function)(char *);
809 int anim_random_frame;
811 void (*draw_busy_anim_function)(void);
817 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
820 struct SetupJoystickInfo
822 char *device_name; /* device name of player's joystick */
824 int xleft, xmiddle, xright;
825 int yupper, ymiddle, ylower;
829 struct SetupKeyboardInfo
831 Key left, right, up, down;
835 struct SetupInputInfo
837 boolean use_joystick;
838 struct SetupJoystickInfo joy;
839 struct SetupKeyboardInfo key;
842 struct SetupEditorInfo
844 boolean el_boulderdash;
845 boolean el_emerald_mine;
846 boolean el_emerald_mine_club;
850 boolean el_diamond_caves;
851 boolean el_dx_boulderdash;
853 boolean el_steel_chars;
855 boolean el_user_defined;
858 boolean el_headlines;
863 boolean show_element_token;
866 struct SetupEditorCascadeInfo
877 boolean el_steel_chars;
885 struct SetupShortcutInfo
891 Key focus_player[MAX_PLAYERS];
892 Key focus_player_all;
911 struct SetupSystemInfo
913 char *sdl_videodriver;
914 char *sdl_audiodriver;
915 int audio_fragment_size;
925 boolean sound_simple;
927 boolean scroll_delay;
928 boolean scroll_delay_value;
929 boolean soft_scrolling;
930 boolean fade_screens;
932 boolean show_titlescreen;
939 char *fullscreen_mode;
940 boolean ask_on_escape;
941 boolean ask_on_escape_editor;
942 boolean quick_switch;
943 boolean input_on_focus;
944 boolean prefer_aga_graphics;
945 int game_frame_delay;
946 boolean sp_show_border_elements;
947 boolean small_game_graphics;
952 int override_level_graphics; /* not boolean -- can also be "AUTO" */
953 int override_level_sounds; /* not boolean -- can also be "AUTO" */
954 int override_level_music; /* not boolean -- can also be "AUTO" */
960 struct SetupEditorInfo editor;
961 struct SetupEditorCascadeInfo editor_cascade;
962 struct SetupShortcutInfo shortcut;
963 struct SetupInputInfo input[MAX_PLAYERS];
964 struct SetupSystemInfo system;
965 struct OptionInfo options;
970 struct TreeInfo **node_top; /* topmost node in tree */
971 struct TreeInfo *node_parent; /* parent level directory info */
972 struct TreeInfo *node_group; /* level group sub-directory info */
973 struct TreeInfo *next; /* next level series structure node */
975 int cl_first; /* internal control field for setup screen */
976 int cl_cursor; /* internal control field for setup screen */
978 int type; /* type of tree content */
980 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
982 char *subdir; /* tree info sub-directory basename (may be ".") */
983 char *fullpath; /* complete path relative to tree base directory */
984 char *basepath; /* absolute base path of tree base directory */
985 char *identifier; /* identifier string for configuration files */
986 char *name; /* tree info name, as displayed in selection menues */
987 char *name_sorting; /* optional sorting name for correct name sorting */
988 char *author; /* level or artwork author name */
989 char *year; /* optional year of creation for levels or artwork */
990 char *imported_from; /* optional comment for imported levels or artwork */
991 char *imported_by; /* optional comment for imported levels or artwork */
992 char *tested_by; /* optional comment to name people who tested a set */
994 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
995 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
996 char *graphics_set; /* optional custom graphics set (level tree only) */
997 char *sounds_set; /* optional custom sounds set (level tree only) */
998 char *music_set; /* optional custom music set (level tree only) */
999 char *graphics_path; /* path to optional custom graphics set (level only) */
1000 char *sounds_path; /* path to optional custom sounds set (level only) */
1001 char *music_path; /* path to optional custom music set (level only) */
1003 char *level_filename; /* filename of level file (for packed level file) */
1004 char *level_filetype; /* type of levels in level directory or level file */
1006 char *special_flags; /* flags for special actions performed on level file */
1008 int levels; /* number of levels in level series */
1009 int first_level; /* first level number (to allow start with 0 or 1) */
1010 int last_level; /* last level number (automatically calculated) */
1011 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1013 boolean latest_engine;/* force level set to use the latest game engine */
1015 boolean level_group; /* directory contains more level series directories */
1016 boolean parent_link; /* entry links back to parent directory */
1017 boolean in_user_dir; /* user defined levels are stored in home directory */
1018 boolean user_defined; /* levels in user directory and marked as "private" */
1019 boolean readonly; /* readonly levels can not be changed with editor */
1020 boolean handicap; /* level set has no handicap when set to "false" */
1021 boolean skip_levels; /* levels can be skipped when set to "true" */
1023 int color; /* color to use on selection screen for this level */
1024 char *class_desc; /* description of level series class */
1025 int handicap_level; /* number of the lowest unsolved level */
1027 char *infotext; /* optional text to describe the tree type (headline) */
1030 typedef struct TreeInfo TreeInfo;
1031 typedef struct TreeInfo LevelDirTree;
1032 typedef struct TreeInfo ArtworkDirTree;
1033 typedef struct TreeInfo GraphicsDirTree;
1034 typedef struct TreeInfo SoundsDirTree;
1035 typedef struct TreeInfo MusicDirTree;
1039 GraphicsDirTree *gfx_first;
1040 GraphicsDirTree *gfx_current;
1041 SoundsDirTree *snd_first;
1042 SoundsDirTree *snd_current;
1043 MusicDirTree *mus_first;
1044 MusicDirTree *mus_current;
1046 char *gfx_current_identifier;
1047 char *snd_current_identifier;
1048 char *mus_current_identifier;
1051 struct ValueTextInfo
1063 struct ConfigTypeInfo
1070 struct TokenIntPtrInfo
1080 char *default_filename;
1083 char **default_parameter; /* array of file parameters */
1084 char **parameter; /* array of file parameters */
1087 boolean fallback_to_default;
1088 boolean default_is_cloned;
1091 struct SetupFileList
1096 struct SetupFileList *next;
1101 char *source_filename; /* primary key for node list */
1105 struct PropertyMapping
1115 struct ArtworkListInfo
1117 int type; /* type of artwork */
1119 int num_file_list_entries;
1120 int num_dynamic_file_list_entries;
1121 struct FileInfo *file_list; /* static artwork file array */
1122 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1124 int num_suffix_list_entries;
1125 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1127 int num_base_prefixes;
1128 int num_ext1_suffixes;
1129 int num_ext2_suffixes;
1130 int num_ext3_suffixes;
1131 char **base_prefixes; /* base token prefixes array */
1132 char **ext1_suffixes; /* property suffixes array 1 */
1133 char **ext2_suffixes; /* property suffixes array 2 */
1134 char **ext3_suffixes; /* property suffixes array 3 */
1136 int num_ignore_tokens;
1137 char **ignore_tokens; /* file tokens to be ignored */
1139 int num_property_mapping_entries;
1140 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1142 int sizeof_artwork_list_entry;
1144 struct ListNodeInfo **artwork_list; /* static artwork node array */
1145 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1146 struct ListNode *content_list; /* dynamic artwork node list */
1148 void *(*load_artwork)(char *); /* constructor function */
1149 void (*free_artwork)(void *); /* destructor function */
1163 struct RectWithBorder
1184 boolean draw_masked;
1196 /* ========================================================================= */
1197 /* exported variables */
1198 /* ========================================================================= */
1200 extern struct ProgramInfo program;
1201 extern struct OptionInfo options;
1202 extern struct VideoSystemInfo video;
1203 extern struct AudioSystemInfo audio;
1204 extern struct GfxInfo gfx;
1205 extern struct AnimInfo anim;
1206 extern struct ArtworkInfo artwork;
1207 extern struct JoystickInfo joystick;
1208 extern struct SetupInfo setup;
1210 extern LevelDirTree *leveldir_first_all;
1211 extern LevelDirTree *leveldir_first;
1212 extern LevelDirTree *leveldir_current;
1213 extern int level_nr;
1215 extern struct LevelStats level_stats[];
1217 extern Display *display;
1218 extern Visual *visual;
1220 extern Colormap cmap;
1222 extern DrawWindow *window;
1223 extern DrawBuffer *backbuffer;
1224 extern DrawBuffer *drawto;
1226 extern int button_status;
1227 extern boolean motion_status;
1228 #if defined(TARGET_SDL2)
1229 extern boolean keyrepeat_status;
1232 extern int redraw_mask;
1233 extern int redraw_tiles;
1235 extern int FrameCounter;
1238 /* function definitions */
1240 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1241 char *, char *, char *, char *, char *, int);
1243 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1244 void InitExitFunction(void (*exit_function)(int));
1245 void InitPlatformDependentStuff(void);
1246 void ClosePlatformDependentStuff(void);
1248 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1249 void InitGfxDoor1Info(int, int, int, int);
1250 void InitGfxDoor2Info(int, int, int, int);
1251 void InitGfxWindowInfo(int, int);
1252 void InitGfxScrollbufferInfo(int, int);
1253 void InitGfxClipRegion(boolean, int, int, int, int);
1254 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1255 void InitGfxCustomArtworkInfo();
1256 void SetDrawDeactivationMask(int);
1257 void SetDrawBackgroundMask(int);
1258 void SetWindowBackgroundBitmap(Bitmap *);
1259 void SetMainBackgroundBitmap(Bitmap *);
1260 void SetDoorBackgroundBitmap(Bitmap *);
1262 void InitVideoDisplay(void);
1263 void CloseVideoDisplay(void);
1264 void InitVideoBuffer(int, int, int, boolean);
1265 Bitmap *CreateBitmapStruct(void);
1266 Bitmap *CreateBitmap(int, int, int);
1267 void ReCreateBitmap(Bitmap **, int, int, int);
1268 void FreeBitmap(Bitmap *);
1269 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1270 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1271 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1272 void (*draw_border_function)(void));
1273 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1274 void ClearRectangle(Bitmap *, int, int, int, int);
1275 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1276 void SetClipMask(Bitmap *, GC, Pixmap);
1277 void SetClipOrigin(Bitmap *, GC, int, int);
1278 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1279 boolean DrawingOnBackground(int, int);
1280 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1281 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1282 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1283 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1284 Pixel GetPixel(Bitmap *, int, int);
1285 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1286 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1288 void FlushDisplay(void);
1289 void SyncDisplay(void);
1290 void KeyboardAutoRepeatOn(void);
1291 void KeyboardAutoRepeatOff(void);
1292 boolean PointerInWindow(DrawWindow *);
1293 boolean SetVideoMode(boolean);
1294 boolean ChangeVideoModeIfNeeded(boolean);
1296 Bitmap *LoadImage(char *);
1297 Bitmap *LoadCustomImage(char *);
1298 void ReloadCustomImage(Bitmap *, char *);
1300 Bitmap *ZoomBitmap(Bitmap *, int, int);
1301 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1302 void ScaleBitmap(Bitmap *, int);
1304 void SetMouseCursor(int);
1306 void OpenAudio(void);
1307 void CloseAudio(void);
1308 void SetAudioMode(boolean);
1310 void InitEventFilter(EventFilter);
1311 boolean PendingEvent(void);
1312 void NextEvent(Event *event);
1313 void PeekEvent(Event *event);
1314 Key GetEventKey(KeyEvent *, boolean);
1315 KeyMod HandleKeyModState(Key, int);
1316 KeyMod GetKeyModState();
1317 KeyMod GetKeyModStateFromEvents();
1318 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1320 void InitJoysticks();
1321 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1323 #endif /* SYSTEM_H */