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 //                  http://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 #endif
  26
  27 #include "sdl.h"
  28
  29
  30 /* the additional 'b' is needed for Win32 to open files in binary mode */
  31 #define MODE_READ                       "rb"
  32 #define MODE_WRITE                      "wb"
  33 #define MODE_APPEND                     "ab"
  34
  35 #define DEFAULT_DEPTH                   0
  36
  37 #define BLIT_OPAQUE                     0
  38 #define BLIT_MASKED                     1
  39 #define BLIT_INVERSE                    2
  40 #define BLIT_ON_BACKGROUND              3
  41
  42 /* values for fullscreen status */
  43 #define FULLSCREEN_NOT_AVAILABLE        FALSE
  44 #define FULLSCREEN_AVAILABLE            TRUE
  45
  46 /* values for window scaling */
  47 #define WINDOW_SCALING_NOT_AVAILABLE    FALSE
  48 #define WINDOW_SCALING_AVAILABLE        TRUE
  49
  50 #define MIN_WINDOW_SCALING_PERCENT      50
  51 #define STD_WINDOW_SCALING_PERCENT      100
  52 #define MAX_WINDOW_SCALING_PERCENT      300
  53 #define STEP_WINDOW_SCALING_PERCENT     10
  54
  55 /* values for window scaling quality */
  56 #define SCALING_QUALITY_NEAREST         "nearest"
  57 #define SCALING_QUALITY_LINEAR          "linear"
  58 #define SCALING_QUALITY_BEST            "best"
  59
  60 #define SCALING_QUALITY_DEFAULT         SCALING_QUALITY_LINEAR
  61
  62 /* values for touch control */
  63 #define TOUCH_CONTROL_VIRTUAL_BUTTONS   "virtual_buttons"
  64 #define TOUCH_CONTROL_WIPE_GESTURES     "wipe_gestures"
  65
  66 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_VIRTUAL_BUTTONS
  67
  68 #define TOUCH_MOVE_DISTANCE_DEFAULT     2
  69 #define TOUCH_DROP_DISTANCE_DEFAULT     5
  70
  71
  72 /* default input keys */
  73 #define DEFAULT_KEY_LEFT                KSYM_Left
  74 #define DEFAULT_KEY_RIGHT               KSYM_Right
  75 #define DEFAULT_KEY_UP                  KSYM_Up
  76 #define DEFAULT_KEY_DOWN                KSYM_Down
  77 #if defined(PLATFORM_MACOSX)
  78 #define DEFAULT_KEY_SNAP                KSYM_Control_L
  79 #define DEFAULT_KEY_DROP                KSYM_KP_Enter
  80 #else
  81 #define DEFAULT_KEY_SNAP                KSYM_Control_L
  82 #define DEFAULT_KEY_DROP                KSYM_Control_R
  83 #endif
  84 #define DEFAULT_KEY_OKAY                KSYM_Return
  85 #define DEFAULT_KEY_CANCEL              KSYM_Escape
  86
  87 /* default shortcut keys */
  88 #define DEFAULT_KEY_SAVE_GAME           KSYM_F1
  89 #define DEFAULT_KEY_LOAD_GAME           KSYM_F2
  90 #define DEFAULT_KEY_TOGGLE_PAUSE        KSYM_space
  91 #define DEFAULT_KEY_FOCUS_PLAYER_1      KSYM_F5
  92 #define DEFAULT_KEY_FOCUS_PLAYER_2      KSYM_F6
  93 #define DEFAULT_KEY_FOCUS_PLAYER_3      KSYM_F7
  94 #define DEFAULT_KEY_FOCUS_PLAYER_4      KSYM_F8
  95 #define DEFAULT_KEY_FOCUS_PLAYER_ALL    KSYM_F9
  96 #define DEFAULT_KEY_TAPE_EJECT          KSYM_UNDEFINED
  97 #define DEFAULT_KEY_TAPE_EXTRA          KSYM_UNDEFINED
  98 #define DEFAULT_KEY_TAPE_STOP           KSYM_UNDEFINED
  99 #define DEFAULT_KEY_TAPE_PAUSE          KSYM_UNDEFINED
 100 #define DEFAULT_KEY_TAPE_RECORD         KSYM_UNDEFINED
 101 #define DEFAULT_KEY_TAPE_PLAY           KSYM_UNDEFINED
 102 #define DEFAULT_KEY_SOUND_SIMPLE        KSYM_UNDEFINED
 103 #define DEFAULT_KEY_SOUND_LOOPS         KSYM_UNDEFINED
 104 #define DEFAULT_KEY_SOUND_MUSIC         KSYM_UNDEFINED
 105 #define DEFAULT_KEY_SNAP_LEFT           KSYM_UNDEFINED
 106 #define DEFAULT_KEY_SNAP_RIGHT          KSYM_UNDEFINED
 107 #define DEFAULT_KEY_SNAP_UP             KSYM_UNDEFINED
 108 #define DEFAULT_KEY_SNAP_DOWN           KSYM_UNDEFINED
 109
 110 /* values for key_status */
 111 #define KEY_NOT_PRESSED                 FALSE
 112 #define KEY_RELEASED                    FALSE
 113 #define KEY_PRESSED                     TRUE
 114
 115 /* values for button status */
 116 #define MB_NOT_PRESSED                  FALSE
 117 #define MB_NOT_RELEASED                 TRUE
 118 #define MB_RELEASED                     FALSE
 119 #define MB_PRESSED                      TRUE
 120 #define MB_MENU_CHOICE                  FALSE
 121 #define MB_MENU_MARK                    TRUE
 122 #define MB_MENU_INITIALIZE              (-1)
 123 #define MB_MENU_LEAVE                   (-2)
 124 #define MB_LEFTBUTTON                   1
 125 #define MB_MIDDLEBUTTON                 2
 126 #define MB_RIGHTBUTTON                  3
 127 #define MB_WHEEL_UP                     4
 128 #define MB_WHEEL_DOWN                   5
 129 #define MB_WHEEL_LEFT                   6
 130 #define MB_WHEEL_RIGHT                  7
 131 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) >= MB_WHEEL_UP &&          \
 132                                          (b) <= MB_WHEEL_DOWN)
 133 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) >= MB_WHEEL_LEFT &&        \
 134                                          (b) <= MB_WHEEL_RIGHT)
 135 #define IS_WHEEL_BUTTON(b)              ((b) >= MB_WHEEL_UP &&          \
 136                                          (b) <= MB_WHEEL_DOWN)
 137 #define DEFAULT_WHEEL_STEPS             3
 138
 139 #define BUTTON_STEPSIZE(b)              ((b) == MB_LEFTBUTTON   ?  1 :  \
 140                                          (b) == MB_MIDDLEBUTTON ?  5 :  \
 141                                          (b) == MB_RIGHTBUTTON  ? 10 : 1)
 142
 143 /* values for move directions */
 144 #define MV_BIT_LEFT                     0
 145 #define MV_BIT_RIGHT                    1
 146 #define MV_BIT_UP                       2
 147 #define MV_BIT_DOWN                     3
 148
 149 #define NUM_DIRECTIONS                  4
 150
 151 /* diagonal movement directions are used in a different contect than buttons */
 152 #define MV_BIT_UPLEFT                   4
 153 #define MV_BIT_UPRIGHT                  5
 154 #define MV_BIT_DOWNLEFT                 6
 155 #define MV_BIT_DOWNRIGHT                7
 156
 157 #define NUM_DIRECTIONS_FULL             8
 158
 159 /* values for special "button" bitmasks */
 160 #define BUTTON_1                        4
 161 #define BUTTON_2                        5
 162
 163 #define NUM_PLAYER_ACTIONS              6
 164
 165 /* values for special "focus player" bitmasks */
 166 #define BIT_SET_FOCUS                   6
 167
 168 /* values for drawing stages for global animations */
 169 #define DRAW_GLOBAL_ANIM_STAGE_1        1
 170 #define DRAW_GLOBAL_ANIM_STAGE_2        2
 171
 172 /* values for drawing target for global border */
 173 #define DRAW_BORDER_TO_BACKBUFFER       0
 174 #define DRAW_BORDER_TO_SCREEN           1
 175
 176 /* values for move directions and special "button" key bitmasks */
 177 #define MV_NONE                 0
 178 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 179 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 180 #define MV_UP                   (1 << MV_BIT_UP)
 181 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 182
 183 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
 184 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
 185 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
 186 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
 187
 188 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
 189 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
 190 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 191 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
 192 #define MV_NO_DIRECTION         (MV_NONE)
 193
 194 #define KEY_BUTTON_1            (1 << BUTTON_1)
 195 #define KEY_BUTTON_2            (1 << BUTTON_2)
 196 #define KEY_BUTTON_SNAP         KEY_BUTTON_1
 197 #define KEY_BUTTON_DROP         KEY_BUTTON_2
 198 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 199 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 200 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 201
 202 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
 203
 204 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
 205                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
 206                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
 207                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
 208                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
 209                                  MV_NONE)
 210
 211 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
 212                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
 213                                  (x) == MV_UP        ? MV_BIT_UP        : \
 214                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
 215                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
 216                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
 217                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
 218                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
 219                                  MV_BIT_DOWN)
 220
 221 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
 222                                  (x) == MV_RIGHT     ? MV_LEFT      : \
 223                                  (x) == MV_UP        ? MV_DOWN      : \
 224                                  (x) == MV_DOWN      ? MV_UP        : \
 225                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
 226                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
 227                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
 228                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
 229                                  MV_NONE)
 230
 231 /* values for animation mode (frame order and direction) */
 232 /* (stored in level files -- never change existing values) */
 233 #define ANIM_NONE               0
 234 #define ANIM_LOOP               (1 << 0)
 235 #define ANIM_LINEAR             (1 << 1)
 236 #define ANIM_PINGPONG           (1 << 2)
 237 #define ANIM_PINGPONG2          (1 << 3)
 238 #define ANIM_RANDOM             (1 << 4)
 239 #define ANIM_CE_VALUE           (1 << 5)
 240 #define ANIM_CE_SCORE           (1 << 6)
 241 #define ANIM_CE_DELAY           (1 << 7)
 242 #define ANIM_REVERSE            (1 << 8)
 243 #define ANIM_OPAQUE_PLAYER      (1 << 9)
 244
 245 /* values for special (non game element) animation modes */
 246 /* (not stored in level files -- can be changed, if needed) */
 247 #define ANIM_HORIZONTAL         (1 << 10)
 248 #define ANIM_VERTICAL           (1 << 11)
 249 #define ANIM_CENTERED           (1 << 12)
 250 #define ANIM_STATIC_PANEL       (1 << 13)
 251 #define ANIM_ALL                (1 << 14)
 252 #define ANIM_ONCE               (1 << 15)
 253
 254 #define ANIM_DEFAULT            ANIM_LOOP
 255
 256 /* values for special drawing styles (currently only for crumbled graphics) */
 257 #define STYLE_NONE              0
 258 #define STYLE_ACCURATE_BORDERS  (1 << 0)
 259 #define STYLE_INNER_CORNERS     (1 << 1)
 260
 261 #define STYLE_DEFAULT           STYLE_NONE
 262
 263 /* values for fade mode */
 264 #define FADE_TYPE_NONE          0
 265 #define FADE_TYPE_FADE_IN       (1 << 0)
 266 #define FADE_TYPE_FADE_OUT      (1 << 1)
 267 #define FADE_TYPE_TRANSFORM     (1 << 2)
 268 #define FADE_TYPE_CROSSFADE     (1 << 3)
 269 #define FADE_TYPE_MELT          (1 << 4)
 270 #define FADE_TYPE_CURTAIN       (1 << 5)
 271 #define FADE_TYPE_SKIP          (1 << 6)
 272
 273 #define FADE_MODE_NONE          (FADE_TYPE_NONE)
 274 #define FADE_MODE_FADE_IN       (FADE_TYPE_FADE_IN)
 275 #define FADE_MODE_FADE_OUT      (FADE_TYPE_FADE_OUT)
 276 #define FADE_MODE_FADE          (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
 277 #define FADE_MODE_TRANSFORM     (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
 278 #define FADE_MODE_CROSSFADE     (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
 279 #define FADE_MODE_MELT          (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
 280 #define FADE_MODE_CURTAIN       (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
 281 #define FADE_MODE_SKIP_FADE_IN  (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
 282 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
 283
 284 #define FADE_MODE_DEFAULT       FADE_MODE_FADE
 285
 286 /* values for toon positions */
 287 #define POS_UNDEFINED           -1
 288 #define POS_LEFT                0
 289 #define POS_RIGHT               1
 290 #define POS_TOP                 2
 291 #define POS_UPPER               3
 292 #define POS_MIDDLE              4
 293 #define POS_LOWER               5
 294 #define POS_BOTTOM              6
 295 #define POS_ANY                 7
 296
 297 /* values for text alignment */
 298 #define ALIGN_LEFT              (1 << 0)
 299 #define ALIGN_RIGHT             (1 << 1)
 300 #define ALIGN_CENTER            (1 << 2)
 301 #define ALIGN_DEFAULT           ALIGN_LEFT
 302
 303 #define VALIGN_TOP              (1 << 0)
 304 #define VALIGN_BOTTOM           (1 << 1)
 305 #define VALIGN_MIDDLE           (1 << 2)
 306 #define VALIGN_DEFAULT          VALIGN_TOP
 307
 308 #define ALIGNED_XPOS(x,w,a)     ((a) == ALIGN_CENTER  ? (x) - (w) / 2 : \
 309                                  (a) == ALIGN_RIGHT   ? (x) - (w) : (x))
 310 #define ALIGNED_YPOS(y,h,v)     ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
 311                                  (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
 312 #define ALIGNED_TEXT_XPOS(p)    ALIGNED_XPOS((p)->x, (p)->width,  (p)->align)
 313 #define ALIGNED_TEXT_YPOS(p)    ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
 314
 315 /* values for redraw_mask */
 316 #define REDRAW_NONE             (0)
 317 #define REDRAW_ALL              (1 << 0)
 318 #define REDRAW_FIELD            (1 << 1)
 319 #define REDRAW_DOOR_1           (1 << 2)
 320 #define REDRAW_DOOR_2           (1 << 3)
 321 #define REDRAW_DOOR_3           (1 << 4)
 322 #define REDRAW_FPS              (1 << 5)
 323
 324 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 325                                  REDRAW_DOOR_2 | \
 326                                  REDRAW_DOOR_3)
 327
 328 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
 329                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
 330 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
 331                                  x <  gfx.real_sx + gfx.full_sxsize && \
 332                                  y >= gfx.real_sy && \
 333                                  y <  gfx.real_sy + gfx.full_sysize)
 334 #define IN_GFX_DOOR_1(x, y)     (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
 335                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
 336 #define IN_GFX_DOOR_2(x, y)     (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
 337                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
 338 #define IN_GFX_DOOR_3(x, y)     (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
 339                                  y >= gfx.ey && y < gfx.ey + gfx.eysize)
 340
 341 /* values for mouse cursor */
 342 #define CURSOR_DEFAULT          0
 343 #define CURSOR_NONE             1
 344 #define CURSOR_PLAYFIELD        2
 345
 346 /* fundamental game speed values */
 347 #define ONE_SECOND_DELAY        1000    /* delay value for one second */
 348 #define GAME_FRAME_DELAY        20      /* frame delay in milliseconds */
 349 #define FFWD_FRAME_DELAY        10      /* 200% speed for fast forward */
 350 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
 351 #define FRAMES_PER_SECOND_SP    35
 352
 353 /* maximum playfield size supported by libgame functions */
 354 #define MAX_PLAYFIELD_WIDTH     128
 355 #define MAX_PLAYFIELD_HEIGHT    128
 356
 357 /* maximum number of parallel players supported by libgame functions */
 358 #define MAX_PLAYERS             4
 359
 360 /* maximum allowed length of player name */
 361 #define MAX_PLAYER_NAME_LEN     10
 362
 363 /* maximum number of levels in a level set */
 364 #define MAX_LEVELS              1000
 365
 366 /* default name for empty highscore entry */
 367 #define EMPTY_PLAYER_NAME       "no name"
 368
 369 /* default name for unknown player names */
 370 #define ANONYMOUS_NAME          "anonymous"
 371
 372 /* default for other unknown names */
 373 #define UNKNOWN_NAME            "unknown"
 374
 375 /* default name for new levels */
 376 #define NAMELESS_LEVEL_NAME     "nameless level"
 377
 378 /* default text for non-existant artwork */
 379 #define NOT_AVAILABLE           "(not available)"
 380
 381 /* default value for undefined filename */
 382 #define UNDEFINED_FILENAME      "[NONE]"
 383
 384 /* default value for undefined levelset */
 385 #define UNDEFINED_LEVELSET      "[NONE]"
 386
 387 /* default value for undefined parameter */
 388 #define ARG_DEFAULT             "[DEFAULT]"
 389
 390 /* default values for undefined configuration file parameters */
 391 #define ARG_UNDEFINED           "-1000000"
 392 #define ARG_UNDEFINED_VALUE     (-1000000)
 393
 394 /* default value for off-screen positions */
 395 #define POS_OFFSCREEN           (-1000000)
 396
 397 /* definitions for game sub-directories */
 398 #ifndef RO_GAME_DIR
 399 #define RO_GAME_DIR             "."
 400 #endif
 401
 402 #ifndef RW_GAME_DIR
 403 #define RW_GAME_DIR             "."
 404 #endif
 405
 406 #define RO_BASE_PATH            RO_GAME_DIR
 407 #define RW_BASE_PATH            RW_GAME_DIR
 408
 409 /* directory names */
 410 #define GRAPHICS_DIRECTORY      "graphics"
 411 #define SOUNDS_DIRECTORY        "sounds"
 412 #define MUSIC_DIRECTORY         "music"
 413 #define LEVELS_DIRECTORY        "levels"
 414 #define TAPES_DIRECTORY         "tapes"
 415 #define SCORES_DIRECTORY        "scores"
 416 #define DOCS_DIRECTORY          "docs"
 417 #define CACHE_DIRECTORY         "cache"
 418
 419 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 420 #define SND_CLASSIC_SUBDIR      "snd_classic"
 421 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 422
 423 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
 424 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
 425 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
 426
 427 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
 428 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
 429 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
 430
 431 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
 432
 433 /* file names and filename extensions */
 434 #define LEVELSETUP_DIRECTORY    "levelsetup"
 435 #define SETUP_FILENAME          "setup.conf"
 436 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 437 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 438 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 439 #define HELPANIM_FILENAME       "helpanim.conf"
 440 #define HELPTEXT_FILENAME       "helptext.conf"
 441 #define LEVELINFO_FILENAME      "levelinfo.conf"
 442 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 443 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 444 #define MUSICINFO_FILENAME      "musicinfo.conf"
 445 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
 446 #define LEVELFILE_EXTENSION     "level"
 447 #define TAPEFILE_EXTENSION      "tape"
 448 #define SCOREFILE_EXTENSION     "score"
 449
 450 #define LOG_OUT_BASENAME        "stdout.txt"
 451 #define LOG_ERR_BASENAME        "stderr.txt"
 452
 453 #define LOG_OUT_ID              0
 454 #define LOG_ERR_ID              1
 455 #define NUM_LOGS                2
 456
 457 #define STRING_PARENT_DIRECTORY         ".."
 458 #define STRING_TOP_DIRECTORY            "/"
 459
 460 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 461 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 462
 463 #define STRING_PATH_SEPARATOR_UNIX      "/"
 464 #define STRING_PATH_SEPARATOR_DOS       "\\"
 465
 466 #define STRING_NEWLINE_UNIX             "\n"
 467 #define STRING_NEWLINE_DOS              "\r\n"
 468
 469 #if defined(PLATFORM_WIN32)
 470 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 471 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 472 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 473 #else
 474 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 475 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 476 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 477 #endif
 478
 479
 480 /* areas in bitmap PIX_DOOR */
 481 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 482    PAGEX1: 1. buffer for DOOR_1
 483    PAGEX2: 2. buffer for DOOR_1
 484    PAGEX3: buffer for animations
 485 */
 486
 487 /* these values are hard-coded to be able to use them in initialization */
 488 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
 489 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
 490
 491 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 492 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 493 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 494 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 495 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 496 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 497 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 498 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 499 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 500 #define DOOR_GFX_PAGEY1         (0)
 501 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 502
 503
 504 /* macros for version handling */
 505 #define VERSION_MAJOR(x)        ((x) / 1000000)
 506 #define VERSION_MINOR(x)        (((x) % 1000000) / 10000)
 507 #define VERSION_PATCH(x)        (((x) % 10000) / 100)
 508 #define VERSION_BUILD(x)        ((x) % 100)
 509 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 510
 511
 512 /* macros for parent/child process identification */
 513 #if defined(PLATFORM_UNIX)
 514 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 515 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 516 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 517 #else
 518 #define IS_PARENT_PROCESS()     TRUE
 519 #define IS_CHILD_PROCESS()      FALSE
 520 #define HAS_CHILD_PROCESS()     FALSE
 521 #endif
 522
 523
 524 /* values for artwork type */
 525 #define ARTWORK_TYPE_GRAPHICS   0
 526 #define ARTWORK_TYPE_SOUNDS     1
 527 #define ARTWORK_TYPE_MUSIC      2
 528
 529 #define NUM_ARTWORK_TYPES       3
 530
 531
 532 /* values for tree type (chosen to match artwork type) */
 533 #define TREE_TYPE_UNDEFINED     -1
 534 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 535 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 536 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 537 #define TREE_TYPE_LEVEL_DIR     3
 538 #define TREE_TYPE_LEVEL_NR      4
 539
 540 #define NUM_TREE_TYPES          5
 541
 542 #define INFOTEXT_UNDEFINED      ""
 543 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 544 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 545 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 546 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 547 #define INFOTEXT_LEVEL_NR       "Levels"
 548
 549 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_LEVEL_NR ?            \
 550                                  INFOTEXT_LEVEL_NR :                    \
 551                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
 552                                  INFOTEXT_LEVEL_DIR :                   \
 553                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 554                                  INFOTEXT_GRAPHICS_DIR :                \
 555                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 556                                  INFOTEXT_SOUNDS_DIR :                  \
 557                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 558                                  INFOTEXT_MUSIC_DIR :                   \
 559                                  INFOTEXT_UNDEFINED)
 560
 561 /* values for artwork handling */
 562 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 563                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 564                                  &(leveldir)->graphics_set :            \
 565                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 566                                  &(leveldir)->sounds_set :              \
 567                                  &(leveldir)->music_set)
 568
 569 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 570                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 571                                  (leveldir)->graphics_set :             \
 572                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 573                                  (leveldir)->sounds_set :               \
 574                                  (leveldir)->music_set)
 575
 576 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 577                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 578                                  &(leveldir)->graphics_path :           \
 579                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 580                                  &(leveldir)->sounds_path :             \
 581                                  &(leveldir)->music_path)
 582
 583 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 584                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 585                                  (leveldir)->graphics_path :            \
 586                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 587                                  (leveldir)->sounds_path :              \
 588                                  (leveldir)->music_path)
 589
 590 #define SETUP_ARTWORK_SET(setup, type)                                  \
 591                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 592                                  (setup).graphics_set :                 \
 593                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 594                                  (setup).sounds_set :                   \
 595                                  (setup).music_set)
 596
 597 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 598                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 599                                  (setup).override_level_graphics :      \
 600                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 601                                  (setup).override_level_sounds :        \
 602                                  (setup).override_level_music)
 603
 604 #define GFX_OVERRIDE_ARTWORK(type)                                      \
 605                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 606                                  gfx.override_level_graphics :          \
 607                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 608                                  gfx.override_level_sounds :            \
 609                                  gfx.override_level_music)
 610
 611 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 612                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 613                                  (artwork).gfx_first :                  \
 614                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 615                                  (artwork).snd_first :                  \
 616                                  (artwork).mus_first)
 617
 618 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 619                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 620                                  &(artwork).gfx_current_identifier :    \
 621                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 622                                  &(artwork).snd_current_identifier :    \
 623                                  &(artwork).mus_current_identifier)
 624
 625 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 626                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 627                                  (artwork).gfx_current_identifier :     \
 628                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 629                                  (artwork).snd_current_identifier :     \
 630                                  (artwork).mus_current_identifier)
 631
 632 #define ARTWORKINFO_FILENAME(type)                                      \
 633                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 634                                  GRAPHICSINFO_FILENAME :                \
 635                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 636                                  SOUNDSINFO_FILENAME :                  \
 637                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 638                                  MUSICINFO_FILENAME : "")
 639
 640 #define ARTWORK_DIRECTORY(type)                                         \
 641                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 642                                  GRAPHICS_DIRECTORY :                   \
 643                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 644                                  SOUNDS_DIRECTORY :                     \
 645                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 646                                  MUSIC_DIRECTORY : "")
 647
 648 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 649                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 650                                  options.graphics_directory :           \
 651                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 652                                  options.sounds_directory :             \
 653                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 654                                  options.music_directory : "")
 655
 656 #define UPDATE_BUSY_STATE()                     \
 657 {                                               \
 658   if (gfx.draw_busy_anim_function != NULL)      \
 659     gfx.draw_busy_anim_function();              \
 660 }
 661
 662
 663 /* type definitions */
 664 #if defined(TARGET_SDL2)
 665 typedef int (*EventFilter)(void *, Event *);
 666 #else
 667 typedef int (*EventFilter)(const Event *);
 668 #endif
 669
 670
 671 /* structure definitions */
 672
 673 struct ProgramInfo
 674 {
 675   char *command_basepath;       /* path to the program binary */
 676   char *command_basename;       /* base filename of the program binary */
 677
 678   char *config_filename;        /* optional global program config filename */
 679
 680   char *maindata_path;          /* main game data (installation) directory */
 681
 682   char *userdata_subdir;        /* personal user game data directory */
 683   char *userdata_path;          /* resulting full path to game data directory */
 684
 685   char *program_title;
 686   char *window_title;
 687   char *icon_title;
 688
 689   char *icon_filename;
 690
 691   char *cookie_prefix;
 692
 693   char *log_filename[NUM_LOGS];         /* log filenames for out/err messages */
 694   FILE *log_file[NUM_LOGS];             /* log file handles for out/err files */
 695   FILE *log_file_default[NUM_LOGS];     /* default log file handles (out/err) */
 696
 697   int version_major;
 698   int version_minor;
 699   int version_patch;
 700   int version_build;
 701   int version_ident;
 702
 703   char *(*window_title_function)(void);
 704   void (*exit_message_function)(char *, va_list);
 705   void (*exit_function)(int);
 706 };
 707
 708 struct OptionInfo
 709 {
 710   char *display_name;
 711   char *server_host;
 712   int server_port;
 713
 714   char *ro_base_directory;
 715   char *rw_base_directory;
 716   char *level_directory;
 717   char *graphics_directory;
 718   char *sounds_directory;
 719   char *music_directory;
 720   char *docs_directory;
 721
 722   char *execute_command;
 723
 724   char *special_flags;
 725
 726   boolean serveronly;
 727   boolean network;
 728   boolean verbose;
 729   boolean debug;
 730 };
 731
 732 struct ScreenModeInfo
 733 {
 734   int width, height;
 735 };
 736
 737 struct VideoSystemInfo
 738 {
 739   int default_depth;
 740   int width, height, depth;
 741   int window_width, window_height;
 742
 743   boolean fullscreen_available;
 744   boolean fullscreen_enabled;
 745   boolean fullscreen_initial;
 746   struct ScreenModeInfo *fullscreen_modes;
 747   char *fullscreen_mode_current;
 748
 749   boolean window_scaling_available;
 750   int window_scaling_percent;
 751   char *window_scaling_quality;
 752
 753   boolean initialized;
 754 };
 755
 756 struct AudioSystemInfo
 757 {
 758   boolean sound_available;
 759   boolean loops_available;
 760   boolean music_available;
 761
 762   boolean sound_enabled;
 763   boolean sound_deactivated;    /* for temporarily disabling sound */
 764
 765   int mixer_pipe[2];
 766   int mixer_pid;
 767   char *device_name;
 768   int device_fd;
 769
 770   int num_channels;
 771   int music_channel;
 772   int first_sound_channel;
 773 };
 774
 775 struct FontBitmapInfo
 776 {
 777   Bitmap *bitmap;
 778
 779   int src_x, src_y;             /* start position of animation frames */
 780   int width, height;            /* width/height of each animation frame */
 781
 782   int draw_xoffset;             /* offset for drawing font characters */
 783   int draw_yoffset;             /* offset for drawing font characters */
 784
 785   int num_chars;
 786   int num_chars_per_line;
 787 };
 788
 789 struct GfxInfo
 790 {
 791   int sx, sy;
 792   int sxsize, sysize;
 793   int real_sx, real_sy;
 794   int full_sxsize, full_sysize;
 795   int scrollbuffer_width, scrollbuffer_height;
 796
 797   int game_tile_size, standard_tile_size;
 798
 799   int dx, dy;
 800   int dxsize, dysize;
 801
 802   int vx, vy;
 803   int vxsize, vysize;
 804
 805   int ex, ey;
 806   int exsize, eysize;
 807
 808   int win_xsize, win_ysize;
 809
 810   int draw_deactivation_mask;
 811   int draw_background_mask;
 812
 813   Bitmap *field_save_buffer;
 814
 815   Bitmap *background_bitmap;
 816   int background_bitmap_mask;
 817
 818   Bitmap *fade_bitmap_source;
 819   Bitmap *fade_bitmap_target;
 820   Bitmap *fade_bitmap_black;
 821
 822 #if USE_FINAL_SCREEN_BITMAP
 823   Bitmap *final_screen_bitmap;
 824 #endif
 825
 826   boolean clipping_enabled;
 827   int clip_x, clip_y;
 828   int clip_width, clip_height;
 829
 830   boolean override_level_graphics;
 831   boolean override_level_sounds;
 832   boolean override_level_music;
 833
 834   boolean draw_init_text;
 835
 836   int num_fonts;
 837   struct FontBitmapInfo *font_bitmap_info;
 838   int (*select_font_function)(int);
 839   int (*get_font_from_token_function)(char *);
 840
 841   int anim_random_frame;
 842
 843   void (*draw_busy_anim_function)(void);
 844   void (*draw_global_anim_function)(int);
 845   void (*draw_global_border_function)(int);
 846
 847   int cursor_mode;
 848 };
 849
 850 struct JoystickInfo
 851 {
 852   int status;
 853   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 854 };
 855
 856 struct SetupJoystickInfo
 857 {
 858   char *device_name;            /* device name of player's joystick */
 859
 860   int xleft, xmiddle, xright;
 861   int yupper, ymiddle, ylower;
 862   int snap, drop;
 863 };
 864
 865 struct SetupKeyboardInfo
 866 {
 867   Key left, right, up, down;
 868   Key snap, drop;
 869 };
 870
 871 struct SetupTouchInfo
 872 {
 873   char *control_type;
 874   int move_distance;
 875   int drop_distance;
 876 };
 877
 878 struct SetupInputInfo
 879 {
 880   boolean use_joystick;
 881   struct SetupJoystickInfo joy;
 882   struct SetupKeyboardInfo key;
 883 };
 884
 885 struct SetupEditorInfo
 886 {
 887   boolean el_boulderdash;
 888   boolean el_emerald_mine;
 889   boolean el_emerald_mine_club;
 890   boolean el_more;
 891   boolean el_sokoban;
 892   boolean el_supaplex;
 893   boolean el_diamond_caves;
 894   boolean el_dx_boulderdash;
 895   boolean el_chars;
 896   boolean el_steel_chars;
 897   boolean el_custom;
 898   boolean el_user_defined;
 899   boolean el_dynamic;
 900
 901   boolean el_headlines;
 902
 903   boolean el_by_game;
 904   boolean el_by_type;
 905
 906   boolean show_element_token;
 907 };
 908
 909 struct SetupEditorCascadeInfo
 910 {
 911   boolean el_bd;
 912   boolean el_em;
 913   boolean el_emc;
 914   boolean el_rnd;
 915   boolean el_sb;
 916   boolean el_sp;
 917   boolean el_dc;
 918   boolean el_dx;
 919   boolean el_chars;
 920   boolean el_steel_chars;
 921   boolean el_ce;
 922   boolean el_ge;
 923   boolean el_ref;
 924   boolean el_user;
 925   boolean el_dynamic;
 926 };
 927
 928 struct SetupShortcutInfo
 929 {
 930   Key save_game;
 931   Key load_game;
 932   Key toggle_pause;
 933
 934   Key focus_player[MAX_PLAYERS];
 935   Key focus_player_all;
 936
 937   Key tape_eject;
 938   Key tape_extra;
 939   Key tape_stop;
 940   Key tape_pause;
 941   Key tape_record;
 942   Key tape_play;
 943
 944   Key sound_simple;
 945   Key sound_loops;
 946   Key sound_music;
 947
 948   Key snap_left;
 949   Key snap_right;
 950   Key snap_up;
 951   Key snap_down;
 952 };
 953
 954 struct SetupSystemInfo
 955 {
 956   char *sdl_videodriver;
 957   char *sdl_audiodriver;
 958   int audio_fragment_size;
 959 };
 960
 961 struct SetupInternalInfo
 962 {
 963   char *program_title;
 964   char *program_author;
 965   char *program_email;
 966   char *program_website;
 967   char *program_copyright;
 968   char *program_company;
 969
 970   char *program_icon_file;
 971
 972   char *default_graphics_set;
 973   char *default_sounds_set;
 974   char *default_music_set;
 975
 976   char *fallback_graphics_file;
 977   char *fallback_sounds_file;
 978   char *fallback_music_file;
 979
 980   char *default_level_series;
 981
 982   int default_window_width;
 983   int default_window_height;
 984
 985   boolean choose_from_top_leveldir;
 986 };
 987
 988 struct SetupInfo
 989 {
 990   char *player_name;
 991
 992   boolean sound;
 993   boolean sound_loops;
 994   boolean sound_music;
 995   boolean sound_simple;
 996   boolean toons;
 997   boolean scroll_delay;
 998   boolean scroll_delay_value;
 999   char *engine_snapshot_mode;
1000   boolean fade_screens;
1001   boolean autorecord;
1002   boolean show_titlescreen;
1003   boolean quick_doors;
1004   boolean team_mode;
1005   boolean handicap;
1006   boolean skip_levels;
1007   boolean time_limit;
1008   boolean fullscreen;
1009   char *fullscreen_mode;
1010   int window_scaling_percent;
1011   char *window_scaling_quality;
1012   boolean ask_on_escape;
1013   boolean ask_on_escape_editor;
1014   boolean quick_switch;
1015   boolean input_on_focus;
1016   boolean prefer_aga_graphics;
1017   int game_frame_delay;
1018   boolean sp_show_border_elements;
1019   boolean small_game_graphics;
1020   boolean show_snapshot_buttons;
1021
1022   char *graphics_set;
1023   char *sounds_set;
1024   char *music_set;
1025   int override_level_graphics;          /* not boolean -- can also be "AUTO" */
1026   int override_level_sounds;            /* not boolean -- can also be "AUTO" */
1027   int override_level_music;             /* not boolean -- can also be "AUTO" */
1028
1029   int volume_simple;
1030   int volume_loops;
1031   int volume_music;
1032
1033   struct SetupEditorInfo editor;
1034   struct SetupEditorCascadeInfo editor_cascade;
1035   struct SetupShortcutInfo shortcut;
1036   struct SetupInputInfo input[MAX_PLAYERS];
1037   struct SetupTouchInfo touch;
1038   struct SetupSystemInfo system;
1039   struct SetupInternalInfo internal;
1040   struct OptionInfo options;
1041 };
1042
1043 struct TreeInfo
1044 {
1045   struct TreeInfo **node_top;           /* topmost node in tree */
1046   struct TreeInfo *node_parent;         /* parent level directory info */
1047   struct TreeInfo *node_group;          /* level group sub-directory info */
1048   struct TreeInfo *next;                /* next level series structure node */
1049
1050   int cl_first;         /* internal control field for setup screen */
1051   int cl_cursor;        /* internal control field for setup screen */
1052
1053   int type;             /* type of tree content */
1054
1055   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1056
1057   char *subdir;         /* tree info sub-directory basename (may be ".") */
1058   char *fullpath;       /* complete path relative to tree base directory */
1059   char *basepath;       /* absolute base path of tree base directory */
1060   char *identifier;     /* identifier string for configuration files */
1061   char *name;           /* tree info name, as displayed in selection menues */
1062   char *name_sorting;   /* optional sorting name for correct name sorting */
1063   char *author;         /* level or artwork author name */
1064   char *year;           /* optional year of creation for levels or artwork */
1065   char *imported_from;  /* optional comment for imported levels or artwork */
1066   char *imported_by;    /* optional comment for imported levels or artwork */
1067   char *tested_by;      /* optional comment to name people who tested a set */
1068
1069   char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1070   char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1071   char *graphics_set;   /* optional custom graphics set (level tree only) */
1072   char *sounds_set;     /* optional custom sounds set (level tree only) */
1073   char *music_set;      /* optional custom music set (level tree only) */
1074   char *graphics_path;  /* path to optional custom graphics set (level only) */
1075   char *sounds_path;    /* path to optional custom sounds set (level only) */
1076   char *music_path;     /* path to optional custom music set (level only) */
1077
1078   char *level_filename; /* filename of level file (for packed level file) */
1079   char *level_filetype; /* type of levels in level directory or level file */
1080
1081   char *special_flags;  /* flags for special actions performed on level file */
1082
1083   int levels;           /* number of levels in level series */
1084   int first_level;      /* first level number (to allow start with 0 or 1) */
1085   int last_level;       /* last level number (automatically calculated) */
1086   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
1087
1088   boolean latest_engine;/* force level set to use the latest game engine */
1089
1090   boolean level_group;  /* directory contains more level series directories */
1091   boolean parent_link;  /* entry links back to parent directory */
1092   boolean in_user_dir;  /* user defined levels are stored in home directory */
1093   boolean user_defined; /* levels in user directory and marked as "private" */
1094   boolean readonly;     /* readonly levels can not be changed with editor */
1095   boolean handicap;     /* level set has no handicap when set to "false" */
1096   boolean skip_levels;  /* levels can be skipped when set to "true" */
1097
1098   int color;            /* color to use on selection screen for this level */
1099   char *class_desc;     /* description of level series class */
1100   int handicap_level;   /* number of the lowest unsolved level */
1101
1102   char *infotext;       /* optional text to describe the tree type (headline) */
1103 };
1104
1105 typedef struct TreeInfo TreeInfo;
1106 typedef struct TreeInfo LevelDirTree;
1107 typedef struct TreeInfo ArtworkDirTree;
1108 typedef struct TreeInfo GraphicsDirTree;
1109 typedef struct TreeInfo SoundsDirTree;
1110 typedef struct TreeInfo MusicDirTree;
1111
1112 struct ArtworkInfo
1113 {
1114   GraphicsDirTree *gfx_first;
1115   GraphicsDirTree *gfx_current;
1116   SoundsDirTree *snd_first;
1117   SoundsDirTree *snd_current;
1118   MusicDirTree *mus_first;
1119   MusicDirTree *mus_current;
1120
1121   char *gfx_current_identifier;
1122   char *snd_current_identifier;
1123   char *mus_current_identifier;
1124 };
1125
1126 struct ValueTextInfo
1127 {
1128   int value;
1129   char *text;
1130 };
1131
1132 struct ConfigInfo
1133 {
1134   char *token;
1135   char *value;
1136 };
1137
1138 struct ConfigTypeInfo
1139 {
1140   char *token;
1141   char *value;
1142   int type;
1143 };
1144
1145 struct TokenIntPtrInfo
1146 {
1147   char *token;
1148   int *value;
1149 };
1150
1151 struct FileInfo
1152 {
1153   char *token;
1154
1155   char *default_filename;
1156   char *filename;
1157
1158   char **default_parameter;                     /* array of file parameters */
1159   char **parameter;                             /* array of file parameters */
1160
1161   boolean redefined;
1162   boolean fallback_to_default;
1163   boolean default_is_cloned;
1164 };
1165
1166 struct SetupFileList
1167 {
1168   char *token;
1169   char *value;
1170
1171   struct SetupFileList *next;
1172 };
1173
1174 struct ListNodeInfo
1175 {
1176   char *source_filename;                        /* primary key for node list */
1177   int num_references;
1178 };
1179
1180 struct PropertyMapping
1181 {
1182   int base_index;
1183   int ext1_index;
1184   int ext2_index;
1185   int ext3_index;
1186
1187   int artwork_index;
1188 };
1189
1190 struct ArtworkListInfo
1191 {
1192   int type;                                     /* type of artwork */
1193
1194   int num_file_list_entries;
1195   int num_dynamic_file_list_entries;
1196   struct FileInfo *file_list;                   /* static artwork file array */
1197   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
1198
1199   int num_suffix_list_entries;
1200   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
1201
1202   int num_base_prefixes;
1203   int num_ext1_suffixes;
1204   int num_ext2_suffixes;
1205   int num_ext3_suffixes;
1206   char **base_prefixes;                         /* base token prefixes array */
1207   char **ext1_suffixes;                         /* property suffixes array 1 */
1208   char **ext2_suffixes;                         /* property suffixes array 2 */
1209   char **ext3_suffixes;                         /* property suffixes array 3 */
1210
1211   int num_ignore_tokens;
1212   char **ignore_tokens;                         /* file tokens to be ignored */
1213
1214   int num_property_mapping_entries;
1215   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
1216
1217   int sizeof_artwork_list_entry;
1218
1219   struct ListNodeInfo **artwork_list;           /* static artwork node array */
1220   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
1221   struct ListNode *content_list;                /* dynamic artwork node list */
1222
1223   void *(*load_artwork)(char *);                /* constructor function */
1224   void (*free_artwork)(void *);                 /* destructor function */
1225 };
1226
1227 struct XY
1228 {
1229   int x, y;
1230 };
1231
1232 struct Rect
1233 {
1234   int x, y;
1235   int width, height;
1236 };
1237
1238 struct RectWithBorder
1239 {
1240   int x, y;
1241   int width, height;
1242   int border_size;
1243 };
1244
1245 struct MenuPosInfo
1246 {
1247   int x, y;
1248   int width, height;
1249   int align, valign;
1250 };
1251
1252 struct DoorPartPosInfo
1253 {
1254   int x, y;
1255   int step_xoffset;
1256   int step_yoffset;
1257   int step_delay;
1258   int start_step;
1259   int start_step_opening;
1260   int start_step_closing;
1261   boolean draw_masked;
1262   int sort_priority;
1263 };
1264
1265 struct TextPosInfo
1266 {
1267   int x, y;
1268   int xoffset;                  /* special case for tape date and time */
1269   int xoffset2;                 /* special case for tape date */
1270   int width, height;
1271   int align, valign;
1272   int size;                     /* also used for suffix ".digits" */
1273   int font, font_alt;
1274   boolean draw_masked;
1275   boolean draw_player;          /* special case for network player buttons */
1276   int sort_priority;            /* also used for suffix ".draw_order" */
1277   int id;
1278 };
1279
1280 struct LevelStats
1281 {
1282   int played;
1283   int solved;
1284 };
1285
1286
1287 /* ========================================================================= */
1288 /* exported variables                                                        */
1289 /* ========================================================================= */
1290
1291 extern struct ProgramInfo       program;
1292 extern struct OptionInfo        options;
1293 extern struct VideoSystemInfo   video;
1294 extern struct AudioSystemInfo   audio;
1295 extern struct GfxInfo           gfx;
1296 extern struct AnimInfo          anim;
1297 extern struct ArtworkInfo       artwork;
1298 extern struct JoystickInfo      joystick;
1299 extern struct SetupInfo         setup;
1300
1301 extern LevelDirTree            *leveldir_first_all;
1302 extern LevelDirTree            *leveldir_first;
1303 extern LevelDirTree            *leveldir_current;
1304 extern int                      level_nr;
1305
1306 extern struct LevelStats        level_stats[];
1307
1308 extern DrawWindow              *window;
1309 extern DrawBuffer              *backbuffer;
1310 extern DrawBuffer              *drawto;
1311
1312 extern int                      button_status;
1313 extern boolean                  motion_status;
1314 #if defined(TARGET_SDL2)
1315 extern boolean                  keyrepeat_status;
1316 #endif
1317
1318 extern int                      redraw_mask;
1319
1320 extern int                      FrameCounter;
1321
1322
1323 /* function definitions */
1324
1325 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1326                      int);
1327
1328 void SetWindowTitle();
1329
1330 void InitWindowTitleFunction(char *(*window_title_function)(void));
1331 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1332 void InitExitFunction(void (*exit_function)(int));
1333 void InitPlatformDependentStuff(void);
1334 void ClosePlatformDependentStuff(void);
1335
1336 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1337 void InitGfxTileSizeInfo(int, int);
1338 void InitGfxDoor1Info(int, int, int, int);
1339 void InitGfxDoor2Info(int, int, int, int);
1340 void InitGfxDoor3Info(int, int, int, int);
1341 void InitGfxWindowInfo(int, int);
1342 void InitGfxScrollbufferInfo(int, int);
1343 void InitGfxClipRegion(boolean, int, int, int, int);
1344 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1345 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int));
1346 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1347 void InitGfxCustomArtworkInfo();
1348 void InitGfxOtherSettings();
1349 void SetDrawDeactivationMask(int);
1350 void SetDrawBackgroundMask(int);
1351 void SetWindowBackgroundBitmap(Bitmap *);
1352 void SetMainBackgroundBitmap(Bitmap *);
1353 void SetDoorBackgroundBitmap(Bitmap *);
1354 void SetRedrawMaskFromArea(int, int, int, int);
1355
1356 void LimitScreenUpdates(boolean);
1357
1358 void InitVideoDisplay(void);
1359 void CloseVideoDisplay(void);
1360 void InitVideoBuffer(int, int, int, boolean);
1361 Bitmap *CreateBitmapStruct(void);
1362 Bitmap *CreateBitmap(int, int, int);
1363 void ReCreateBitmap(Bitmap **, int, int, int);
1364 void FreeBitmap(Bitmap *);
1365 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1366 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1367 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1368                    void (*draw_border_function)(void));
1369 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1370 void ClearRectangle(Bitmap *, int, int, int, int);
1371 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1372 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1373 boolean DrawingOnBackground(int, int);
1374 boolean DrawingAreaChanged();
1375 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1376 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1377 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1378 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1379 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1380 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1381 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1382 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1383 Pixel GetPixel(Bitmap *, int, int);
1384 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1385 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1386
1387 void KeyboardAutoRepeatOn(void);
1388 void KeyboardAutoRepeatOff(void);
1389 boolean SetVideoMode(boolean);
1390 boolean ChangeVideoModeIfNeeded(boolean);
1391
1392 Bitmap *LoadImage(char *);
1393 Bitmap *LoadCustomImage(char *);
1394 void ReloadCustomImage(Bitmap *, char *);
1395
1396 Bitmap *ZoomBitmap(Bitmap *, int, int);
1397 void ReCreateGameTileSizeBitmap(Bitmap **);
1398 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1399 void CreateBitmapTextures(Bitmap **);
1400 void FreeBitmapTextures(Bitmap **);
1401 void ScaleBitmap(Bitmap **, int);
1402
1403 void SetMouseCursor(int);
1404
1405 void OpenAudio(void);
1406 void CloseAudio(void);
1407 void SetAudioMode(boolean);
1408
1409 void InitEventFilter(EventFilter);
1410 boolean PendingEvent(void);
1411 void NextEvent(Event *event);
1412 void PeekEvent(Event *event);
1413 Key GetEventKey(KeyEvent *, boolean);
1414 KeyMod HandleKeyModState(Key, int);
1415 KeyMod GetKeyModState();
1416 KeyMod GetKeyModStateFromEvents();
1417 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1418
1419 void InitJoysticks();
1420 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1421
1422 #endif /* SYSTEM_H */