src/libgame/system.h

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