src/tape.c

   1 // ============================================================================
   2 // Rocks'n'Diamonds - McDuffin Strikes Back!
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  https://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // tape.c
  10 // ============================================================================
  11
  12 #include "libgame/libgame.h"
  13
  14 #include "tape.h"
  15 #include "init.h"
  16 #include "game.h"
  17 #include "tools.h"
  18 #include "files.h"
  19 #include "network.h"
  20 #include "anim.h"
  21 #include "api.h"
  22
  23
  24 #define DEBUG_TAPE_WHEN_PLAYING                 FALSE
  25
  26 // tape button identifiers
  27 #define TAPE_CTRL_ID_EJECT                      0
  28 #define TAPE_CTRL_ID_EXTRA                      1
  29 #define TAPE_CTRL_ID_STOP                       2
  30 #define TAPE_CTRL_ID_PAUSE                      3
  31 #define TAPE_CTRL_ID_RECORD                     4
  32 #define TAPE_CTRL_ID_PLAY                       5
  33 #define TAPE_CTRL_ID_INSERT_SOLUTION            6
  34 #define TAPE_CTRL_ID_PLAY_SOLUTION              7
  35
  36 #define NUM_TAPE_BUTTONS                        8
  37
  38 // values for tape handling
  39 #define TAPE_PAUSE_SECONDS_BEFORE_DEATH         5
  40 #define TAPE_MIN_SECONDS_FOR_UNDO_BUFFER        20
  41
  42 // forward declaration for internal use
  43 static void HandleTapeButtons(struct GadgetInfo *);
  44 static void TapeStopWarpForward(void);
  45 static float GetTapeLengthSecondsFloat(void);
  46 static void CopyTapeToUndoBuffer(void);
  47
  48 static struct GadgetInfo *tape_gadget[NUM_TAPE_BUTTONS];
  49 static struct TapeInfo tape_undo_buffer;
  50
  51
  52 // ============================================================================
  53 // video tape definitions
  54 // ============================================================================
  55
  56 #define VIDEO_INFO_OFF                  (VIDEO_STATE_DATE_OFF   |       \
  57                                          VIDEO_STATE_TIME_OFF   |       \
  58                                          VIDEO_STATE_FRAME_OFF)
  59 #define VIDEO_STATE_OFF                 (VIDEO_STATE_PLAY_OFF   |       \
  60                                          VIDEO_STATE_REC_OFF    |       \
  61                                          VIDEO_STATE_PAUSE_OFF  |       \
  62                                          VIDEO_STATE_FFWD_OFF   |       \
  63                                          VIDEO_STATE_WARP_OFF   |       \
  64                                          VIDEO_STATE_WARP2_OFF  |       \
  65                                          VIDEO_STATE_PBEND_OFF  |       \
  66                                          VIDEO_STATE_1STEP_OFF)
  67 #define VIDEO_PRESS_OFF                 (VIDEO_PRESS_PLAY_OFF   |       \
  68                                          VIDEO_PRESS_REC_OFF    |       \
  69                                          VIDEO_PRESS_PAUSE_OFF  |       \
  70                                          VIDEO_PRESS_STOP_OFF   |       \
  71                                          VIDEO_PRESS_EJECT_OFF)
  72 #define VIDEO_ALL_OFF                   (VIDEO_INFO_OFF         |       \
  73                                          VIDEO_STATE_OFF        |       \
  74                                          VIDEO_PRESS_OFF)
  75
  76 #define VIDEO_INFO_ON                   (VIDEO_STATE_DATE_ON    |       \
  77                                          VIDEO_STATE_TIME_ON    |       \
  78                                          VIDEO_STATE_FRAME_ON)
  79 #define VIDEO_STATE_ON                  (VIDEO_STATE_PLAY_ON    |       \
  80                                          VIDEO_STATE_REC_ON     |       \
  81                                          VIDEO_STATE_PAUSE_ON   |       \
  82                                          VIDEO_STATE_FFWD_ON    |       \
  83                                          VIDEO_STATE_WARP_ON    |       \
  84                                          VIDEO_STATE_WARP2_ON   |       \
  85                                          VIDEO_STATE_PBEND_ON   |       \
  86                                          VIDEO_STATE_1STEP_ON)
  87 #define VIDEO_PRESS_ON                  (VIDEO_PRESS_PLAY_ON    |       \
  88                                          VIDEO_PRESS_REC_ON     |       \
  89                                          VIDEO_PRESS_PAUSE_ON   |       \
  90                                          VIDEO_PRESS_STOP_ON    |       \
  91                                          VIDEO_PRESS_EJECT_ON)
  92 #define VIDEO_ALL_ON                    (VIDEO_INFO_ON          |       \
  93                                          VIDEO_STATE_ON         |       \
  94                                          VIDEO_PRESS_ON)
  95
  96 #define VIDEO_INFO                      (VIDEO_INFO_ON | VIDEO_INFO_OFF)
  97 #define VIDEO_STATE                     (VIDEO_STATE_ON | VIDEO_STATE_OFF)
  98 #define VIDEO_PRESS                     (VIDEO_PRESS_ON | VIDEO_PRESS_OFF)
  99 #define VIDEO_ALL                       (VIDEO_ALL_ON | VIDEO_ALL_OFF)
 100
 101 #define NUM_TAPE_FUNCTIONS              11
 102 #define NUM_TAPE_FUNCTION_PARTS         2
 103 #define NUM_TAPE_FUNCTION_STATES        2
 104
 105
 106 // ============================================================================
 107 // video display functions
 108 // ============================================================================
 109
 110 static void DrawVideoDisplay_Graphics(unsigned int state, unsigned int value)
 111 {
 112   int i, j, k;
 113
 114   static struct
 115   {
 116     int graphic;
 117     struct XY *pos;
 118   }
 119   video_pos[NUM_TAPE_FUNCTIONS][NUM_TAPE_FUNCTION_PARTS] =
 120   {
 121     {
 122       { IMG_GFX_TAPE_LABEL_PLAY,                &tape.label.play        },
 123       { IMG_GFX_TAPE_SYMBOL_PLAY,               &tape.symbol.play       },
 124     },
 125     {
 126       { IMG_GFX_TAPE_LABEL_RECORD,              &tape.label.record      },
 127       { IMG_GFX_TAPE_SYMBOL_RECORD,             &tape.symbol.record     },
 128     },
 129     {
 130       { IMG_GFX_TAPE_LABEL_PAUSE,               &tape.label.pause       },
 131       { IMG_GFX_TAPE_SYMBOL_PAUSE,              &tape.symbol.pause      },
 132     },
 133     {
 134       { IMG_GFX_TAPE_LABEL_DATE,                &tape.label.date        },
 135       { -1,                                     NULL                    },
 136     },
 137     {
 138       { IMG_GFX_TAPE_LABEL_TIME,                &tape.label.time        },
 139       { -1,                                     NULL                    },
 140     },
 141     {
 142       // (no label for displaying optional frame)
 143       { -1,                                     NULL                    },
 144       { -1,                                     NULL                    },
 145     },
 146     {
 147       { IMG_GFX_TAPE_LABEL_FAST_FORWARD,        &tape.label.fast_forward  },
 148       { IMG_GFX_TAPE_SYMBOL_FAST_FORWARD,       &tape.symbol.fast_forward },
 149     },
 150     {
 151       { IMG_GFX_TAPE_LABEL_WARP_FORWARD,        &tape.label.warp_forward  },
 152       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD,       &tape.symbol.warp_forward },
 153     },
 154     {
 155       { IMG_GFX_TAPE_LABEL_WARP_FORWARD_BLIND,  &tape.label.warp_forward_blind},
 156       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD_BLIND, &tape.symbol.warp_forward_blind},
 157     },
 158     {
 159       { IMG_GFX_TAPE_LABEL_PAUSE_BEFORE_END,    &tape.label.pause_before_end  },
 160       { IMG_GFX_TAPE_SYMBOL_PAUSE_BEFORE_END,   &tape.symbol.pause_before_end },
 161     },
 162     {
 163       { IMG_GFX_TAPE_LABEL_SINGLE_STEP,         &tape.label.single_step  },
 164       { IMG_GFX_TAPE_SYMBOL_SINGLE_STEP,        &tape.symbol.single_step },
 165     },
 166   };
 167
 168   for (k = 0; k < NUM_TAPE_FUNCTION_STATES; k++)        // on or off states
 169   {
 170     for (i = 0; i < NUM_TAPE_FUNCTIONS; i++)            // record, play, ...
 171     {
 172       for (j = 0; j < NUM_TAPE_FUNCTION_PARTS; j++)     // label or symbol
 173       {
 174         int graphic = video_pos[i][j].graphic;
 175         struct XY *pos = video_pos[i][j].pos;
 176
 177         if (graphic == -1 ||
 178             pos->x == -1 ||
 179             pos->y == -1)
 180           continue;
 181
 182         if (state & (1 << (i * 2 + k)))
 183         {
 184           struct GraphicInfo *gfx_bg = &graphic_info[IMG_BACKGROUND_TAPE];
 185           struct GraphicInfo *gfx = &graphic_info[graphic];
 186           Bitmap *gd_bitmap;
 187           int gd_x, gd_y;
 188           int skip_value =
 189             (j == 0 ? VIDEO_DISPLAY_SYMBOL_ONLY : VIDEO_DISPLAY_LABEL_ONLY);
 190
 191           if (value == skip_value)
 192             continue;
 193
 194           if (k == 1)           // on
 195           {
 196             gd_bitmap = gfx->bitmap;
 197             gd_x = gfx->src_x;
 198             gd_y = gfx->src_y;
 199           }
 200           else                  // off
 201           {
 202             gd_bitmap = gfx_bg->bitmap;
 203             gd_x = gfx_bg->src_x + pos->x;
 204             gd_y = gfx_bg->src_y + pos->y;
 205           }
 206
 207           // some tape graphics may be undefined -- only draw if defined
 208           if (gd_bitmap != NULL)
 209             BlitBitmap(gd_bitmap, drawto, gd_x, gd_y, gfx->width, gfx->height,
 210                        VX + pos->x, VY + pos->y);
 211
 212           redraw_mask |= REDRAW_DOOR_2;
 213         }
 214       }
 215     }
 216   }
 217 }
 218
 219
 220 #define DATETIME_NONE                   (0)
 221
 222 #define DATETIME_DATE_YYYY              (1 << 0)
 223 #define DATETIME_DATE_YY                (1 << 1)
 224 #define DATETIME_DATE_MON               (1 << 2)
 225 #define DATETIME_DATE_MM                (1 << 3)
 226 #define DATETIME_DATE_DD                (1 << 4)
 227
 228 #define DATETIME_TIME_HH                (1 << 5)
 229 #define DATETIME_TIME_MIN               (1 << 6)
 230 #define DATETIME_TIME_MM                (1 << 7)
 231 #define DATETIME_TIME_SS                (1 << 8)
 232
 233 #define DATETIME_FRAME                  (1 << 9)
 234
 235 #define DATETIME_XOFFSET_1              (1 << 10)
 236 #define DATETIME_XOFFSET_2              (1 << 11)
 237
 238 #define DATETIME_DATE                   (DATETIME_DATE_YYYY     |       \
 239                                          DATETIME_DATE_YY       |       \
 240                                          DATETIME_DATE_MON      |       \
 241                                          DATETIME_DATE_MM       |       \
 242                                          DATETIME_DATE_DD)
 243
 244 #define DATETIME_TIME                   (DATETIME_TIME_HH       |       \
 245                                          DATETIME_TIME_MIN      |       \
 246                                          DATETIME_TIME_MM       |       \
 247                                          DATETIME_TIME_SS)
 248
 249 #define MAX_DATETIME_STRING_SIZE        32
 250
 251 static void DrawVideoDisplay_DateTime(unsigned int state, unsigned int value)
 252 {
 253   int i;
 254
 255   static char *month_shortnames[] =
 256   {
 257     "JAN",
 258     "FEB",
 259     "MAR",
 260     "APR",
 261     "MAY",
 262     "JUN",
 263     "JUL",
 264     "AUG",
 265     "SEP",
 266     "OCT",
 267     "NOV",
 268     "DEC"
 269   };
 270
 271   static struct
 272   {
 273     struct TextPosInfo *pos;
 274     int type;
 275   }
 276   datetime_info[] =
 277   {
 278     { &tape.text.date,          DATETIME_DATE_DD                        },
 279     { &tape.text.date,          DATETIME_DATE_MON | DATETIME_XOFFSET_1  },
 280     { &tape.text.date,          DATETIME_DATE_YY  | DATETIME_XOFFSET_2  },
 281     { &tape.text.date_yyyy,     DATETIME_DATE_YYYY                      },
 282     { &tape.text.date_yy,       DATETIME_DATE_YY                        },
 283     { &tape.text.date_mon,      DATETIME_DATE_MON                       },
 284     { &tape.text.date_mm,       DATETIME_DATE_MM                        },
 285     { &tape.text.date_dd,       DATETIME_DATE_DD                        },
 286
 287     { &tape.text.time,          DATETIME_TIME_MIN                       },
 288     { &tape.text.time,          DATETIME_TIME_SS  | DATETIME_XOFFSET_1  },
 289     { &tape.text.time_hh,       DATETIME_TIME_HH                        },
 290     { &tape.text.time_mm,       DATETIME_TIME_MM                        },
 291     { &tape.text.time_ss,       DATETIME_TIME_SS                        },
 292
 293     { &tape.text.frame,         DATETIME_FRAME                          },
 294
 295     { NULL,                     DATETIME_NONE                           },
 296   };
 297
 298   for (i = 0; datetime_info[i].pos != NULL; i++)
 299   {
 300     struct TextPosInfo *pos = datetime_info[i].pos;
 301     int type = datetime_info[i].type;
 302     int xpos, ypos;
 303
 304     if (pos->x == -1 &&
 305         pos->y == -1)
 306       continue;
 307
 308     xpos = VX + pos->x + (type & DATETIME_XOFFSET_1 ? pos->xoffset  :
 309                           type & DATETIME_XOFFSET_2 ? pos->xoffset2 : 0);
 310     ypos = VY + pos->y;
 311
 312     if ((type & DATETIME_DATE) && (state & VIDEO_STATE_DATE_ON))
 313     {
 314       char s[MAX_DATETIME_STRING_SIZE];
 315       int year2 = value / 10000;
 316       int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
 317       int month_index_raw = (value / 100) % 100;
 318       int month_index = month_index_raw % 12;   // prevent invalid index
 319       int month = month_index + 1;
 320       int day = value % 100;
 321
 322       strcpy(s, (type & DATETIME_DATE_YYYY ? int2str(year4, 4) :
 323                  type & DATETIME_DATE_YY   ? int2str(year2, 2) :
 324                  type & DATETIME_DATE_MON  ? month_shortnames[month_index] :
 325                  type & DATETIME_DATE_MM   ? int2str(month, 2) :
 326                  type & DATETIME_DATE_DD   ? int2str(day, 2) : ""));
 327
 328       DrawText(xpos, ypos, s, pos->font);
 329     }
 330     else if ((type & DATETIME_TIME) && (state & VIDEO_STATE_TIME_ON))
 331     {
 332       char s[MAX_DATETIME_STRING_SIZE];
 333       int hh = (value / 3600) % 100;
 334       int min = value / 60;
 335       int mm = (value / 60) % 60;
 336       int ss = value % 60;
 337
 338       strcpy(s, (type & DATETIME_TIME_HH  ? int2str(hh, 2) :
 339                  type & DATETIME_TIME_MIN ? int2str(min, 2) :
 340                  type & DATETIME_TIME_MM  ? int2str(mm, 2) :
 341                  type & DATETIME_TIME_SS  ? int2str(ss, 2) : ""));
 342
 343       DrawText(xpos, ypos, s, pos->font);
 344     }
 345     else if ((type & DATETIME_FRAME) && (state & VIDEO_STATE_FRAME_ON))
 346     {
 347       DrawText(xpos, ypos, int2str(value, pos->size), pos->font);
 348     }
 349   }
 350 }
 351
 352 void DrawVideoDisplay(unsigned int state, unsigned int value)
 353 {
 354   DrawVideoDisplay_Graphics(state, value);
 355   DrawVideoDisplay_DateTime(state, value);
 356 }
 357
 358 static void DrawVideoDisplayLabel(unsigned int state)
 359 {
 360   DrawVideoDisplay(state, VIDEO_DISPLAY_LABEL_ONLY);
 361 }
 362
 363 static void DrawVideoDisplaySymbol(unsigned int state)
 364 {
 365   DrawVideoDisplay(state, VIDEO_DISPLAY_SYMBOL_ONLY);
 366 }
 367
 368 static void DrawVideoDisplayCurrentState(void)
 369 {
 370   int state = 0;
 371
 372   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
 373
 374   if (tape.pausing)
 375     state |= VIDEO_STATE_PAUSE_ON;
 376
 377   if (tape.recording)
 378   {
 379     state |= VIDEO_STATE_REC_ON;
 380
 381     if (tape.single_step)
 382       state |= VIDEO_STATE_1STEP_ON;
 383   }
 384   else if (tape.playing)
 385   {
 386     state |= VIDEO_STATE_PLAY_ON;
 387
 388     if (!tape.pausing)
 389     {
 390       if (tape.deactivate_display)
 391         state |= VIDEO_STATE_WARP2_ON;
 392       else if (tape.warp_forward)
 393         state |= VIDEO_STATE_WARP_ON;
 394       else if (tape.fast_forward)
 395         state |= VIDEO_STATE_FFWD_ON;
 396
 397       if (tape.pause_before_end)
 398         state |= VIDEO_STATE_PBEND_ON;
 399     }
 400   }
 401
 402   // draw labels and symbols separately to prevent labels overlapping symbols
 403   DrawVideoDisplayLabel(state);
 404   DrawVideoDisplaySymbol(state);
 405 }
 406
 407 void DrawCompleteVideoDisplay(void)
 408 {
 409   struct GraphicInfo *g_tape = &graphic_info[IMG_BACKGROUND_TAPE];
 410
 411   // draw tape background
 412   BlitBitmap(g_tape->bitmap, drawto, g_tape->src_x, g_tape->src_y,
 413              gfx.vxsize, gfx.vysize, gfx.vx, gfx.vy);
 414
 415   // draw tape buttons (forced)
 416   RedrawOrRemapTapeButtons();
 417
 418   DrawVideoDisplay(VIDEO_ALL_OFF, 0);
 419
 420   if (tape.recording)
 421   {
 422     DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
 423     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 424     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
 425     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
 426
 427     if (tape.pausing)
 428       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
 429   }
 430   else if (tape.playing)
 431   {
 432     DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
 433     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 434     DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
 435     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
 436
 437     if (tape.pausing)
 438       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
 439   }
 440   else if (tape.date && tape.length)
 441   {
 442     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 443     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
 444     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
 445   }
 446
 447   BlitBitmap(drawto, bitmap_db_door_2, gfx.vx, gfx.vy, gfx.vxsize, gfx.vysize,
 448              0, 0);
 449 }
 450
 451 void TapeDeactivateDisplayOn(void)
 452 {
 453   SetDrawDeactivationMask(REDRAW_FIELD);
 454   audio.sound_deactivated = TRUE;
 455 }
 456
 457 void TapeDeactivateDisplayOff(boolean redraw_display)
 458 {
 459   SetDrawDeactivationMask(REDRAW_NONE);
 460   audio.sound_deactivated = FALSE;
 461
 462   if (redraw_display)
 463   {
 464     RedrawPlayfield();
 465
 466     UpdateGameDoorValues();
 467     DrawGameDoorValues();
 468   }
 469 }
 470
 471
 472 // ============================================================================
 473 // tape logging functions
 474 // ============================================================================
 475
 476 struct AutoPlayInfo
 477 {
 478   LevelDirTree *leveldir;
 479   boolean all_levelsets;
 480   int last_level_nr;
 481   int level_nr;
 482   int num_levels_played;
 483   int num_levels_solved;
 484   int num_tapes_patched;
 485   int num_tape_missing;
 486   boolean level_failed[MAX_TAPES_PER_SET];
 487   char *tape_filename;
 488 };
 489
 490 static char tape_patch_info[MAX_OUTPUT_LINESIZE];
 491
 492 static void PrintTapeReplayHeader(struct AutoPlayInfo *autoplay)
 493 {
 494   PrintLine("=", 79);
 495
 496   if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
 497     Print("Automatically fixing level tapes\n");
 498   else if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
 499     Print("Automatically uploading level tapes\n");
 500   else
 501     Print("Automatically playing level tapes\n");
 502
 503   PrintLine("-", 79);
 504   Print("Level series identifier: '%s'\n", autoplay->leveldir->identifier);
 505   Print("Level series name:       '%s'\n", autoplay->leveldir->name);
 506   Print("Level series author:     '%s'\n", autoplay->leveldir->author);
 507   Print("Number of levels:        %d\n",   autoplay->leveldir->levels);
 508   PrintLine("=", 79);
 509   Print("\n");
 510
 511   DrawInitTextItem(autoplay->leveldir->name);
 512 }
 513
 514 static void PrintTapeReplayProgress(boolean replay_finished)
 515 {
 516   static unsigned int counter_last = -1;
 517   unsigned int counter = Counter();
 518   unsigned int counter_seconds  = counter / 1000;
 519
 520   if (!replay_finished)
 521   {
 522     unsigned int counter_delay = 50;
 523
 524     if (counter > counter_last + counter_delay)
 525     {
 526       PrintNoLog("\r");
 527       PrintNoLog("Tape %03d %s[%02d:%02d]: [%02d:%02d] - playing tape ... ",
 528                  level_nr,  tape_patch_info,
 529                  tape.length_seconds / 60, tape.length_seconds % 60,
 530                  TapeTime / 60, TapeTime % 60);
 531
 532       counter_last = counter;
 533     }
 534   }
 535   else
 536   {
 537     float tape_length_seconds = GetTapeLengthSecondsFloat();
 538
 539     PrintNoLog("\r");
 540     Print("Tape %03d %s[%02d:%02d]: (%02d:%02d.%03d / %.2f %%) - %s.\n",
 541           level_nr, tape_patch_info,
 542           tape.length_seconds / 60, tape.length_seconds % 60,
 543           counter_seconds / 60, counter_seconds % 60, counter % 1000,
 544           (float)counter / tape_length_seconds / 10,
 545           tape.auto_play_level_fixed ? "solved and fixed" :
 546           tape.auto_play_level_solved ? "solved" :
 547           tape.auto_play_level_not_fixable ? "NOT SOLVED, NOT FIXED" :
 548           "NOT SOLVED");
 549
 550     counter_last = -1;
 551   }
 552 }
 553
 554 static void PrintTapeReplaySummary(struct AutoPlayInfo *autoplay)
 555 {
 556   char *autoplay_status =
 557     (autoplay->num_levels_played == autoplay->num_levels_solved &&
 558      autoplay->num_levels_played > 0 ? " OK " : "WARN");
 559   int autoplay_percent =
 560     (autoplay->num_levels_played ?
 561      autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0);
 562   int i;
 563
 564   Print("\n");
 565   PrintLine("=", 79);
 566   Print("Number of levels played: %d\n", autoplay->num_levels_played);
 567   Print("Number of levels solved: %d (%d%%)\n", autoplay->num_levels_solved,
 568         (autoplay->num_levels_played ?
 569          autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0));
 570   if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
 571     Print("Number of tapes fixed: %d\n", autoplay->num_tapes_patched);
 572   PrintLine("-", 79);
 573   Print("Summary (for automatic parsing by scripts):\n");
 574
 575   if (autoplay->tape_filename)
 576   {
 577     Print("TAPEFILE [%s] '%s', %d, %d, %d",
 578           autoplay_status,
 579           autoplay->leveldir->identifier,
 580           autoplay->last_level_nr,
 581           game.score_final,
 582           game.score_time_final);
 583   }
 584   else
 585   {
 586     Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
 587           autoplay_status,
 588           autoplay->leveldir->identifier,
 589           autoplay->num_levels_solved,
 590           autoplay->num_levels_played,
 591           autoplay_percent);
 592
 593     if (autoplay->num_levels_played != autoplay->num_levels_solved)
 594     {
 595       Print(", FAILED:");
 596       for (i = 0; i < MAX_TAPES_PER_SET; i++)
 597         if (autoplay->level_failed[i])
 598           Print(" %03d", i);
 599     }
 600   }
 601
 602   Print("\n");
 603   PrintLine("=", 79);
 604 }
 605
 606 static FILE *tape_log_file;
 607
 608 static void OpenTapeLogfile(void)
 609 {
 610   if (!(tape_log_file = fopen(options.tape_log_filename, MODE_WRITE)))
 611     Warn("cannot write tape logfile '%s'", options.tape_log_filename);
 612 }
 613
 614 static void WriteTapeLogfile(byte action[MAX_TAPE_ACTIONS])
 615 {
 616   int i;
 617
 618   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
 619     putFile8Bit(tape_log_file, action[i]);
 620 }
 621
 622 static void CloseTapeLogfile(void)
 623 {
 624   fclose(tape_log_file);
 625 }
 626
 627
 628 // ============================================================================
 629 // tape control functions
 630 // ============================================================================
 631
 632 void TapeSetDateFromEpochSeconds(time_t epoch_seconds)
 633 {
 634   struct tm *lt = localtime(&epoch_seconds);
 635
 636   tape.date = 10000 * (lt->tm_year % 100) + 100 * lt->tm_mon + lt->tm_mday;
 637 }
 638
 639 void TapeSetDateFromNow(void)
 640 {
 641   TapeSetDateFromEpochSeconds(time(NULL));
 642 }
 643
 644 void TapeErase(void)
 645 {
 646   int i;
 647
 648   CopyTapeToUndoBuffer();
 649
 650   tape.counter = 0;
 651   tape.length = 0;
 652   tape.length_frames = 0;
 653   tape.length_seconds = 0;
 654
 655   tape.score_tape_basename[0] = '\0';
 656
 657   if (leveldir_current)
 658   {
 659     strncpy(tape.level_identifier, leveldir_current->identifier,
 660             MAX_FILENAME_LEN);
 661     tape.level_identifier[MAX_FILENAME_LEN] = '\0';
 662   }
 663
 664   tape.level_nr = level_nr;
 665   tape.pos[tape.counter].delay = 0;
 666   tape.changed = TRUE;
 667   tape.solved = FALSE;
 668
 669   tape.random_seed = InitRND(level.random_seed);
 670
 671   tape.file_version = FILE_VERSION_ACTUAL;
 672   tape.game_version = GAME_VERSION_ACTUAL;
 673   tape.engine_version = level.game_version;
 674
 675   tape.property_bits = TAPE_PROPERTY_NONE;
 676
 677   TapeSetDateFromNow();
 678
 679   for (i = 0; i < MAX_PLAYERS; i++)
 680     tape.player_participates[i] = FALSE;
 681
 682   tape.centered_player_nr_next = -1;
 683   tape.set_centered_player = FALSE;
 684
 685   // set flags for game actions to default values (may be overwritten later)
 686   tape.use_key_actions = TRUE;
 687   tape.use_mouse_actions = FALSE;
 688 }
 689
 690 static void TapeRewind(void)
 691 {
 692   tape.counter = 0;
 693   tape.delay_played = 0;
 694   tape.pause_before_end = FALSE;
 695   tape.recording = FALSE;
 696   tape.playing = FALSE;
 697   tape.fast_forward = FALSE;
 698   tape.warp_forward = FALSE;
 699   tape.deactivate_display = FALSE;
 700   tape.auto_play = (global.autoplay_leveldir != NULL);
 701   tape.auto_play_level_solved = FALSE;
 702   tape.auto_play_level_fixed = FALSE;
 703   tape.auto_play_level_not_fixable = FALSE;
 704   tape.quick_resume = FALSE;
 705   tape.single_step = FALSE;
 706
 707   tape.centered_player_nr_next = -1;
 708   tape.set_centered_player = FALSE;
 709
 710   InitRND(tape.random_seed);
 711 }
 712
 713 static void TapeSetRandomSeed(int random_seed)
 714 {
 715   tape.random_seed = InitRND(random_seed);
 716 }
 717
 718 void TapeStartRecording(int random_seed)
 719 {
 720   if (!TAPE_IS_STOPPED(tape))
 721     TapeStop();
 722
 723   TapeErase();
 724   TapeRewind();
 725   TapeSetRandomSeed(random_seed);
 726
 727   tape.recording = TRUE;
 728
 729   DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
 730   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 731   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
 732   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
 733
 734   MapTapeWarpButton();
 735
 736   SetDrawDeactivationMask(REDRAW_NONE);
 737   audio.sound_deactivated = FALSE;
 738
 739   // required here to update video display if tape door is closed
 740   if (GetDoorState() & DOOR_CLOSE_2)
 741     OpenDoor(GetDoorState() | DOOR_NO_DELAY | DOOR_FORCE_REDRAW);
 742 }
 743
 744 static void TapeStartGameRecording(void)
 745 {
 746   StartGameActions(network.enabled, TRUE, level.random_seed);
 747 }
 748
 749 static void TapeAppendRecording(void)
 750 {
 751   if (!tape.playing || !tape.pausing)
 752     return;
 753
 754   // stop playing
 755   tape.playing = FALSE;
 756   tape.fast_forward = FALSE;
 757   tape.warp_forward = FALSE;
 758   tape.pause_before_end = FALSE;
 759   tape.deactivate_display = FALSE;
 760
 761   // start recording
 762   tape.recording = TRUE;
 763   tape.changed = TRUE;
 764   tape.solved = FALSE;
 765
 766   // set current delay (for last played move)
 767   tape.pos[tape.counter].delay = tape.delay_played;
 768
 769   tape.property_bits |= TAPE_PROPERTY_REPLAYED;
 770
 771   // set current date
 772   TapeSetDateFromNow();
 773
 774   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 775   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF | VIDEO_STATE_REC_ON, 0);
 776
 777   UpdateAndDisplayGameControlValues();
 778 }
 779
 780 void TapeHaltRecording(void)
 781 {
 782   tape.counter++;
 783
 784   // initialize delay for next tape entry (to be able to continue recording)
 785   if (tape.counter < MAX_TAPE_LEN)
 786     tape.pos[tape.counter].delay = 0;
 787
 788   tape.length = tape.counter;
 789   tape.length_frames = GetTapeLengthFrames();
 790   tape.length_seconds = GetTapeLengthSeconds();
 791 }
 792
 793 void TapeStopRecording(void)
 794 {
 795   if (tape.recording)
 796     TapeHaltRecording();
 797
 798   tape.recording = FALSE;
 799   tape.pausing = FALSE;
 800
 801   DrawVideoDisplay(VIDEO_STATE_REC_OFF, 0);
 802   MapTapeEjectButton();
 803 }
 804
 805 boolean TapeAddAction(byte action[MAX_TAPE_ACTIONS])
 806 {
 807   int i;
 808
 809   if (tape.pos[tape.counter].delay > 0)         // already stored action
 810   {
 811     boolean changed_events = FALSE;
 812
 813     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
 814       if (tape.pos[tape.counter].action[i] != action[i])
 815         changed_events = TRUE;
 816
 817     if (changed_events || tape.pos[tape.counter].delay >= 255)
 818     {
 819       if (tape.counter >= MAX_TAPE_LEN - 1)
 820         return FALSE;
 821
 822       tape.counter++;
 823       tape.pos[tape.counter].delay = 0;
 824     }
 825     else
 826       tape.pos[tape.counter].delay++;
 827   }
 828
 829   if (tape.pos[tape.counter].delay == 0)        // store new action
 830   {
 831     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
 832       tape.pos[tape.counter].action[i] = action[i];
 833
 834     tape.pos[tape.counter].delay++;
 835   }
 836
 837   return TRUE;
 838 }
 839
 840 void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
 841 {
 842   byte action[MAX_TAPE_ACTIONS];
 843   int i;
 844
 845   if (!tape.recording)          // (record action even when tape is paused)
 846     return;
 847
 848   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
 849     action[i] = action_raw[i];
 850
 851   if (tape.use_key_actions && tape.set_centered_player)
 852   {
 853     for (i = 0; i < MAX_PLAYERS; i++)
 854       if (tape.centered_player_nr_next == i ||
 855           tape.centered_player_nr_next == -1)
 856         action[i] |= KEY_SET_FOCUS;
 857
 858     tape.set_centered_player = FALSE;
 859   }
 860
 861   if (GameFrameDelay != GAME_FRAME_DELAY)
 862     tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
 863
 864   if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
 865     tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
 866
 867   if (!TapeAddAction(action))
 868     TapeStopRecording();
 869 }
 870
 871 void TapeTogglePause(boolean toggle_mode)
 872 {
 873   if (tape.playing && tape.pausing && (toggle_mode & TAPE_TOGGLE_PLAY_PAUSE))
 874   {
 875     // continue playing in normal mode
 876     tape.fast_forward = FALSE;
 877     tape.warp_forward = FALSE;
 878     tape.deactivate_display = FALSE;
 879
 880     tape.pause_before_end = FALSE;
 881   }
 882
 883   tape.pausing = !tape.pausing;
 884
 885   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
 886     tape.single_step = FALSE;
 887
 888   if (tape.single_step)
 889     tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
 890
 891   if (tape.pausing)
 892     tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
 893
 894   DrawVideoDisplayCurrentState();
 895
 896   if (tape.deactivate_display)
 897   {
 898     if (tape.pausing)
 899       TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
 900     else
 901       TapeDeactivateDisplayOn();
 902   }
 903
 904   if (tape.quick_resume)
 905   {
 906     tape.quick_resume = FALSE;
 907
 908     TapeStopWarpForward();
 909     TapeAppendRecording();
 910
 911     if (!CheckEngineSnapshotSingle())
 912       SaveEngineSnapshotSingle();
 913
 914     // restart step/move snapshots after quick loading tape
 915     SaveEngineSnapshotToListInitial();
 916
 917     // do not map undo/redo buttons after quick loading tape
 918     return;
 919   }
 920
 921   if (game_status == GAME_MODE_PLAYING)
 922   {
 923     if (setup.show_load_save_buttons &&
 924         setup.show_undo_redo_buttons &&
 925         CheckEngineSnapshotList())
 926     {
 927       if (tape.pausing)
 928         MapUndoRedoButtons();
 929       else if (!tape.single_step)
 930         MapLoadSaveButtons();
 931     }
 932
 933     ModifyPauseButtons();
 934   }
 935 }
 936
 937 void TapeStartPlaying(void)
 938 {
 939   if (TAPE_IS_EMPTY(tape))
 940     return;
 941
 942   if (!TAPE_IS_STOPPED(tape))
 943     TapeStop();
 944
 945   TapeRewind();
 946
 947   tape.playing = TRUE;
 948
 949   DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
 950   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 951   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
 952   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
 953
 954   MapTapeWarpButton();
 955
 956   SetDrawDeactivationMask(REDRAW_NONE);
 957   audio.sound_deactivated = FALSE;
 958 }
 959
 960 static void TapeStartGamePlaying(void)
 961 {
 962   TapeStartPlaying();
 963
 964   InitGame();
 965 }
 966
 967 void TapeStopPlaying(void)
 968 {
 969   tape.playing = FALSE;
 970   tape.pausing = FALSE;
 971
 972   if (tape.warp_forward)
 973     TapeStopWarpForward();
 974
 975   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF, 0);
 976   MapTapeEjectButton();
 977 }
 978
 979 byte *TapePlayAction(void)
 980 {
 981   int update_delay = FRAMES_PER_SECOND / 2;
 982   boolean update_video_display = (FrameCounter % update_delay == 0);
 983   boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
 984   static byte action[MAX_TAPE_ACTIONS];
 985   int i;
 986
 987   if (!tape.playing || tape.pausing)
 988     return NULL;
 989
 990   if (tape.pause_before_end)  // stop some seconds before end of tape
 991   {
 992     if (TapeTime > (int)tape.length_seconds - TAPE_PAUSE_SECONDS_BEFORE_DEATH)
 993     {
 994       TapeStopWarpForward();
 995       TapeTogglePause(TAPE_TOGGLE_MANUAL);
 996
 997       if (setup.autorecord_after_replay)
 998         TapeAppendRecording();
 999
1000       return NULL;
1001     }
1002   }
1003
1004   if (tape.counter >= tape.length)      // end of tape reached
1005   {
1006     if (!tape.auto_play)
1007     {
1008       TapeStopWarpForward();
1009       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1010
1011       if (setup.autorecord_after_replay)
1012         TapeAppendRecording();
1013     }
1014     else
1015     {
1016       TapeStop();
1017     }
1018
1019     return NULL;
1020   }
1021
1022   if (update_video_display && !tape.deactivate_display)
1023   {
1024     int state = 0;
1025
1026     if (tape.warp_forward)
1027       state |= VIDEO_STATE_WARP(update_draw_label_on);
1028     else if (tape.fast_forward)
1029       state |= VIDEO_STATE_FFWD(update_draw_label_on);
1030
1031     if (tape.pause_before_end)
1032       state |= VIDEO_STATE_PBEND(update_draw_label_on);
1033
1034     // draw labels and symbols separately to prevent labels overlapping symbols
1035     DrawVideoDisplayLabel(state);
1036     DrawVideoDisplaySymbol(state);
1037   }
1038
1039   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1040     action[i] = tape.pos[tape.counter].action[i];
1041
1042 #if DEBUG_TAPE_WHEN_PLAYING
1043   DebugContinued("", "%05d", FrameCounter);
1044   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1045     DebugContinued("", "   %08x", action[i]);
1046   DebugContinued("tape:play", "\n");
1047 #endif
1048
1049   tape.set_centered_player = FALSE;
1050   tape.centered_player_nr_next = -999;
1051
1052   if (tape.use_key_actions)
1053   {
1054     for (i = 0; i < MAX_PLAYERS; i++)
1055     {
1056       if (action[i] & KEY_SET_FOCUS)
1057       {
1058         tape.set_centered_player = TRUE;
1059         tape.centered_player_nr_next =
1060           (tape.centered_player_nr_next == -999 ? i : -1);
1061       }
1062
1063       action[i] &= ~KEY_SET_FOCUS;
1064     }
1065   }
1066
1067   tape.delay_played++;
1068   if (tape.delay_played >= tape.pos[tape.counter].delay)
1069   {
1070     tape.counter++;
1071     tape.delay_played = 0;
1072   }
1073
1074   if (tape.auto_play)
1075     PrintTapeReplayProgress(FALSE);
1076
1077   if (options.tape_log_filename != NULL)
1078     WriteTapeLogfile(action);
1079
1080   return action;
1081 }
1082
1083 void TapeStop(void)
1084 {
1085   if (tape.pausing)
1086     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1087
1088   TapeStopRecording();
1089   TapeStopPlaying();
1090
1091   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
1092
1093   if (tape.date && tape.length)
1094   {
1095     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
1096     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
1097     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
1098   }
1099 }
1100
1101 static void TapeStopGameOrTape(boolean stop_game)
1102 {
1103   if (score_info_tape_play || (!tape.playing && stop_game))
1104     RequestQuitGame(FALSE);
1105   else
1106     TapeStop();
1107 }
1108
1109 void TapeStopGame(void)
1110 {
1111   if (game_status == GAME_MODE_MAIN)
1112     return;
1113
1114   TapeStopGameOrTape(TRUE);
1115 }
1116
1117 void TapeStopTape(void)
1118 {
1119   TapeStopGameOrTape(FALSE);
1120 }
1121
1122 unsigned int GetTapeLengthFrames(void)
1123 {
1124   unsigned int tape_length_frames = 0;
1125   int i;
1126
1127   if (TAPE_IS_EMPTY(tape))
1128     return 0;
1129
1130   for (i = 0; i < tape.length; i++)
1131     tape_length_frames += tape.pos[i].delay;
1132
1133   return tape_length_frames;
1134 }
1135
1136 unsigned int GetTapeLengthSeconds(void)
1137 {
1138   return (GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1139 }
1140
1141 static float GetTapeLengthSecondsFloat(void)
1142 {
1143   return ((float)GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1144 }
1145
1146 static void TapeStartWarpForward(int mode)
1147 {
1148   tape.fast_forward = (mode & AUTOPLAY_FFWD);
1149   tape.warp_forward = (mode & AUTOPLAY_WARP);
1150   tape.deactivate_display = (mode & AUTOPLAY_WARP_NO_DISPLAY);
1151
1152   tape.pausing = FALSE;
1153
1154   if (tape.deactivate_display)
1155     TapeDeactivateDisplayOn();
1156
1157   DrawVideoDisplayCurrentState();
1158 }
1159
1160 static void TapeStopWarpForward(void)
1161 {
1162   tape.fast_forward = FALSE;
1163   tape.warp_forward = FALSE;
1164   tape.deactivate_display = FALSE;
1165
1166   tape.pause_before_end = FALSE;
1167
1168   TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
1169
1170   DrawVideoDisplayCurrentState();
1171 }
1172
1173 static void TapeSingleStep(void)
1174 {
1175   if (network.enabled)
1176     return;
1177
1178   if (!tape.pausing)
1179     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1180
1181   tape.single_step = !tape.single_step;
1182
1183   DrawVideoDisplay(VIDEO_STATE_1STEP(tape.single_step), 0);
1184 }
1185
1186 void TapeQuickSave(void)
1187 {
1188   if (game_status != GAME_MODE_PLAYING)
1189   {
1190     Request("No game that could be saved!", REQ_CONFIRM);
1191
1192     return;
1193   }
1194
1195   if (!tape.recording)
1196   {
1197     Request("No recording that could be saved!", REQ_CONFIRM);
1198
1199     return;
1200   }
1201
1202   if (tape.recording)
1203     TapeHaltRecording();        // prepare tape for saving on-the-fly
1204
1205   if (TAPE_IS_EMPTY(tape))
1206   {
1207     Request("No tape that could be saved!", REQ_CONFIRM);
1208
1209     return;
1210   }
1211
1212   tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1213
1214   if (SaveTapeChecked(tape.level_nr))
1215     SaveEngineSnapshotSingle();
1216 }
1217
1218 void TapeQuickLoad(void)
1219 {
1220   char *filename = getTapeFilename(level_nr);
1221
1222   if (!fileExists(filename))
1223   {
1224     Request("No tape for this level!", REQ_CONFIRM);
1225
1226     return;
1227   }
1228
1229   if (tape.recording && !Request("Stop recording and load tape?",
1230                                  REQ_ASK | REQ_STAY_CLOSED))
1231   {
1232     OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1233
1234     return;
1235   }
1236
1237   if (game_status != GAME_MODE_PLAYING && game_status != GAME_MODE_MAIN)
1238     return;
1239
1240   if (CheckEngineSnapshotSingle())
1241   {
1242     TapeStartGamePlaying();
1243
1244     LoadEngineSnapshotSingle();
1245
1246     DrawCompleteVideoDisplay();
1247
1248     tape.playing = TRUE;
1249     tape.pausing = TRUE;
1250
1251     TapeStopWarpForward();
1252     TapeAppendRecording();
1253
1254     // restart step/move snapshots after quick loading tape
1255     SaveEngineSnapshotToListInitial();
1256
1257     if (FrameCounter > 0)
1258       return;
1259   }
1260
1261   TapeStop();
1262   TapeErase();
1263
1264   LoadTape(level_nr);
1265
1266   if (!TAPE_IS_EMPTY(tape))
1267   {
1268     TapeStartGamePlaying();
1269     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1270
1271     tape.quick_resume = TRUE;
1272     tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1273   }
1274   else  // this should not happen (basically checked above)
1275   {
1276     int reopen_door = (game_status == GAME_MODE_PLAYING ? REQ_REOPEN : 0);
1277
1278     Request("No tape for this level!", REQ_CONFIRM | reopen_door);
1279   }
1280 }
1281
1282 static boolean checkRestartGame(char *message)
1283 {
1284   if (game_status == GAME_MODE_MAIN)
1285     return TRUE;
1286
1287   if (!hasStartedNetworkGame())
1288     return FALSE;
1289
1290   if (level_editor_test_game)
1291     return TRUE;
1292
1293   if (game.all_players_gone)
1294     return TRUE;
1295
1296   if (!setup.ask_on_quit_game)
1297     return TRUE;
1298
1299   if (Request(message, REQ_ASK | REQ_STAY_CLOSED))
1300     return TRUE;
1301
1302   OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1303
1304   return FALSE;
1305 }
1306
1307 void TapeRestartGame(void)
1308 {
1309   if (score_info_tape_play)
1310   {
1311     TapeStartGamePlaying();
1312
1313     return;
1314   }
1315
1316   if (!checkRestartGame("Restart game?"))
1317     return;
1318
1319   StartGameActions(network.enabled, setup.autorecord, level.random_seed);
1320 }
1321
1322 void TapeReplayAndPauseBeforeEnd(void)
1323 {
1324   if (score_info_tape_play)
1325     return;
1326
1327   if (TAPE_IS_EMPTY(tape) && !tape.recording)
1328   {
1329     Request("No tape for this level!", REQ_CONFIRM);
1330
1331     return;
1332   }
1333
1334   if (!checkRestartGame("Replay game and pause before end?"))
1335     return;
1336
1337   TapeStop();
1338   TapeStartGamePlaying();
1339   TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1340
1341   tape.pause_before_end = TRUE;
1342   tape.quick_resume = TRUE;
1343 }
1344
1345 boolean hasSolutionTape(void)
1346 {
1347   boolean tape_file_exists = fileExists(getSolutionTapeFilename(level_nr));
1348   boolean level_has_tape = (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
1349                             level.native_sp_level->demo.is_available);
1350
1351   return (tape_file_exists || level_has_tape);
1352 }
1353
1354 boolean InsertSolutionTape(void)
1355 {
1356   if (!hasSolutionTape())
1357   {
1358     Request("No solution tape for this level!", REQ_CONFIRM);
1359
1360     return FALSE;
1361   }
1362
1363   if (!TAPE_IS_STOPPED(tape))
1364     TapeStop();
1365
1366   // if tape recorder already contains a tape, remove it without asking
1367   TapeErase();
1368
1369   LoadSolutionTape(level_nr);
1370
1371   DrawCompleteVideoDisplay();
1372
1373   if (TAPE_IS_EMPTY(tape))
1374   {
1375     Request("Loading solution tape for this level failed!", REQ_CONFIRM);
1376
1377     return FALSE;
1378   }
1379
1380   return TRUE;
1381 }
1382
1383 boolean PlaySolutionTape(void)
1384 {
1385   if (!InsertSolutionTape())
1386     return FALSE;
1387
1388   TapeStartGamePlaying();
1389
1390   return TRUE;
1391 }
1392
1393 static boolean PlayScoreTape_WaitForDownload(void)
1394 {
1395   DelayCounter download_delay = { 10000 };
1396
1397   ResetDelayCounter(&download_delay);
1398
1399   // wait for score tape to be successfully downloaded (and fail on timeout)
1400   while (!server_scores.tape_downloaded)
1401   {
1402     if (DelayReached(&download_delay))
1403       return FALSE;
1404
1405     UPDATE_BUSY_STATE_NOT_LOADING();
1406
1407     Delay(20);
1408   }
1409
1410   return TRUE;
1411 }
1412
1413 boolean PlayScoreTape(int entry_nr)
1414 {
1415   struct ScoreEntry *entry = &scores.entry[entry_nr];
1416   char *tape_filename =
1417     (entry->id == -1 ?
1418      getScoreTapeFilename(entry->tape_basename, level_nr) :
1419      getScoreCacheTapeFilename(entry->tape_basename, level_nr));
1420   boolean download_tape = (!fileExists(tape_filename));
1421
1422   if (download_tape && entry->id == -1)
1423   {
1424     FadeSkipNextFadeIn();
1425
1426     Request("Cannot find score tape!", REQ_CONFIRM);
1427
1428     return FALSE;
1429   }
1430
1431   server_scores.tape_downloaded = FALSE;
1432
1433   if (download_tape)
1434     ApiGetScoreTapeAsThread(level_nr, entry->id, entry->tape_basename);
1435
1436   SetGameStatus(GAME_MODE_PLAYING);
1437
1438   FadeOut(REDRAW_FIELD);
1439
1440   if (download_tape && !PlayScoreTape_WaitForDownload())
1441   {
1442     SetGameStatus(GAME_MODE_SCOREINFO);
1443     ClearField();
1444
1445     Request("Cannot download score tape from score server!", REQ_CONFIRM);
1446
1447     return FALSE;
1448   }
1449
1450   if (!TAPE_IS_STOPPED(tape))
1451     TapeStop();
1452
1453   // if tape recorder already contains a tape, remove it without asking
1454   TapeErase();
1455
1456   if (entry->id == -1)
1457     LoadScoreTape(entry->tape_basename, level_nr);
1458   else
1459     LoadScoreCacheTape(entry->tape_basename, level_nr);
1460
1461   if (TAPE_IS_EMPTY(tape))
1462   {
1463     SetGameStatus(GAME_MODE_SCOREINFO);
1464     ClearField();
1465
1466     Request("Cannot load score tape for this level!", REQ_CONFIRM);
1467
1468     return FALSE;
1469   }
1470
1471   FadeSkipNextFadeOut();
1472
1473   TapeStartGamePlaying();
1474
1475   score_info_tape_play = TRUE;
1476
1477   return TRUE;
1478 }
1479
1480 static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
1481 {
1482   return (strEqual(t1->level_identifier, t2->level_identifier) &&
1483           t1->level_nr == t2->level_nr);
1484 }
1485
1486 static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
1487 {
1488   *tape_to = *tape_from;
1489 }
1490
1491 static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
1492 {
1493   struct TapeInfo tmp = *t1;
1494
1495   *t1 = *t2;
1496   *t2 = tmp;
1497 }
1498
1499 static void CopyTapeToUndoBuffer(void)
1500 {
1501   // copy tapes to undo buffer if large enough (or larger than last undo tape)
1502   // or if the last undo tape is from a different level set or level number
1503   if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
1504       tape.length_seconds >= tape_undo_buffer.length_seconds ||
1505       !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1506   {
1507     CopyTape(&tape, &tape_undo_buffer);
1508   }
1509 }
1510
1511 void UndoTape(void)
1512 {
1513   // only undo tapes from same level set and with same level number
1514   if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1515     return;
1516
1517   if (!TAPE_IS_STOPPED(tape))
1518     TapeStop();
1519
1520   // swap last recorded tape with undo buffer, so undo can be reversed
1521   SwapTapes(&tape, &tape_undo_buffer);
1522
1523   DrawCompleteVideoDisplay();
1524 }
1525
1526 void FixTape_ForceSinglePlayer(void)
1527 {
1528   int i;
1529
1530   /* fix single-player tapes that contain player input for more than one
1531      player (due to a bug in 3.3.1.2 and earlier versions), which results
1532      in playing levels with more than one player in multi-player mode,
1533      even though the tape was originally recorded in single-player mode */
1534
1535   // remove player input actions for all players but the first one
1536   for (i = 1; i < MAX_PLAYERS; i++)
1537     tape.player_participates[i] = FALSE;
1538
1539   tape.changed = TRUE;
1540 }
1541
1542
1543 // ----------------------------------------------------------------------------
1544 // tape autoplay functions
1545 // ----------------------------------------------------------------------------
1546
1547 static TreeInfo *getNextValidAutoPlayEntry(TreeInfo *node)
1548 {
1549   node = getNextValidTreeInfoEntry(node);
1550
1551   while (node && node->is_copy)
1552     node = getNextValidTreeInfoEntry(node);
1553
1554   return node;
1555 }
1556
1557 static TreeInfo *getFirstValidAutoPlayEntry(TreeInfo *node)
1558 {
1559   node = getFirstValidTreeInfoEntry(node);
1560
1561   if (node && node->is_copy)
1562     return getNextValidAutoPlayEntry(node);
1563
1564   return node;
1565 }
1566
1567 static void AutoPlayTapes_SetScoreEntry(int score, int time)
1568 {
1569   char *name = (options.mytapes ? setup.player_name : options.player_name);
1570
1571   // set unique basename for score tape (for uploading to score server)
1572   strcpy(tape.score_tape_basename, getScoreTapeBasename(name));
1573
1574   // store score in first score entry
1575   scores.last_added = 0;
1576
1577   struct ScoreEntry *entry = &scores.entry[scores.last_added];
1578
1579   strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
1580   strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
1581
1582   entry->score = score;
1583   entry->time = time;
1584
1585   PrintNoLog("- uploading score tape to score server ... ");
1586
1587   server_scores.uploaded = FALSE;
1588 }
1589
1590 static boolean AutoPlayTapes_WaitForUpload(void)
1591 {
1592   DelayCounter upload_delay = { 10000 };
1593
1594   ResetDelayCounter(&upload_delay);
1595
1596   // wait for score tape to be successfully uploaded (and fail on timeout)
1597   while (!server_scores.uploaded)
1598   {
1599     if (DelayReached(&upload_delay))
1600     {
1601       PrintNoLog("\r");
1602       Print("- uploading score tape to score server - TIMEOUT.\n");
1603
1604       if (program.headless)
1605         Fail("cannot upload score tape to score server");
1606
1607       return FALSE;
1608     }
1609
1610     UPDATE_BUSY_STATE();
1611
1612     Delay(20);
1613   }
1614
1615   PrintNoLog("\r");
1616   Print("- uploading score tape to score server - uploaded.\n");
1617
1618   return TRUE;
1619 }
1620
1621 static int AutoPlayTapesExt(boolean initialize)
1622 {
1623   static struct AutoPlayInfo autoplay;
1624   static int num_tapes = 0;
1625   static int patch_nr = 0;
1626   static char *patch_name[] =
1627   {
1628     "original tape",
1629     "em_random_bug",
1630     "screen_34x34",
1631
1632     NULL
1633   };
1634   static int patch_version_first[] =
1635   {
1636     VERSION_IDENT(0,0,0,0),
1637     VERSION_IDENT(3,3,1,0),
1638     VERSION_IDENT(0,0,0,0),
1639
1640     -1
1641   };
1642   static int patch_version_last[] =
1643   {
1644     VERSION_IDENT(9,9,9,9),
1645     VERSION_IDENT(4,0,1,1),
1646     VERSION_IDENT(4,2,2,0),
1647
1648     -1
1649   };
1650   static byte patch_property_bit[] =
1651   {
1652     TAPE_PROPERTY_NONE,
1653     TAPE_PROPERTY_EM_RANDOM_BUG,
1654     TAPE_PROPERTY_NONE,
1655
1656     -1
1657   };
1658   LevelDirTree *leveldir_current_last = leveldir_current;
1659   boolean init_level_set = FALSE;
1660   int level_nr_last = level_nr;
1661   int i;
1662
1663   if (!initialize)
1664   {
1665     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1666     {
1667       if (tape.auto_play_level_solved)
1668       {
1669         if (patch_nr > 0)
1670         {
1671           // level solved by patched tape -- save fixed tape
1672           char *filename = getTapeFilename(level_nr);
1673           char *filename_orig = getStringCat2(filename, ".orig");
1674
1675           // create backup from old tape, if not yet existing
1676           if (!fileExists(filename_orig))
1677             rename(filename, filename_orig);
1678
1679           SaveTapeToFilename(filename);
1680
1681           tape.auto_play_level_fixed = TRUE;
1682           autoplay.num_tapes_patched++;
1683         }
1684
1685         // continue with next tape
1686         patch_nr = 0;
1687       }
1688       else if (patch_name[patch_nr + 1] != NULL)
1689       {
1690         // level not solved by patched tape -- continue with next patch
1691         patch_nr++;
1692       }
1693       else
1694       {
1695         // level not solved by any patched tape -- continue with next tape
1696         tape.auto_play_level_not_fixable = TRUE;
1697         patch_nr = 0;
1698       }
1699     }
1700
1701     // just finished auto-playing tape
1702     PrintTapeReplayProgress(TRUE);
1703
1704     if (options.tape_log_filename != NULL)
1705       CloseTapeLogfile();
1706
1707     if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
1708         tape.auto_play_level_solved)
1709     {
1710       AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
1711
1712       if (leveldir_current)
1713       {
1714         // the tape's level set identifier may differ from current level set
1715         strncpy(tape.level_identifier, leveldir_current->identifier,
1716                 MAX_FILENAME_LEN);
1717         tape.level_identifier[MAX_FILENAME_LEN] = '\0';
1718
1719         // the tape's level number may differ from current level number
1720         tape.level_nr = level_nr;
1721       }
1722
1723       // save score tape to upload to server; may be required for some reasons:
1724       // * level set identifier in solution tapes may differ from level set
1725       // * level set identifier is missing (old-style tape without INFO chunk)
1726       // * solution tape may have native format (like Supaplex solution files)
1727
1728       SaveScoreTape(level_nr);
1729       SaveServerScore(level_nr, TRUE);
1730
1731       AutoPlayTapes_WaitForUpload();
1732     }
1733
1734     if (patch_nr == 0)
1735       autoplay.num_levels_played++;
1736
1737     if (tape.auto_play_level_solved)
1738       autoplay.num_levels_solved++;
1739
1740     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1741       autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
1742   }
1743   else
1744   {
1745     if (strEqual(global.autoplay_leveldir, "ALL"))
1746     {
1747       autoplay.all_levelsets = TRUE;
1748
1749       // tape mass-uploading only allowed for private tapes
1750       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1751         options.mytapes = TRUE;
1752     }
1753
1754     if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
1755          global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
1756         !options.mytapes &&
1757         options.player_name == NULL)
1758     {
1759       Fail("specify player name when uploading solution tapes");
1760     }
1761
1762     if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1763       DrawCompleteVideoDisplay();
1764
1765     if (program.headless)
1766     {
1767       audio.sound_enabled = FALSE;
1768       setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1769     }
1770
1771     if (strSuffix(global.autoplay_leveldir, ".tape"))
1772     {
1773       autoplay.tape_filename = global.autoplay_leveldir;
1774
1775       if (!fileExists(autoplay.tape_filename))
1776         Fail("tape file '%s' does not exist", autoplay.tape_filename);
1777
1778       LoadTapeFromFilename(autoplay.tape_filename);
1779
1780       if (tape.no_valid_file)
1781         Fail("cannot load tape file '%s'", autoplay.tape_filename);
1782
1783       if (tape.no_info_chunk && !options.identifier)
1784         Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
1785
1786       if (tape.no_info_chunk && !options.level_nr)
1787         Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
1788
1789       global.autoplay_leveldir = tape.level_identifier;
1790
1791       if (options.identifier != NULL)
1792         global.autoplay_leveldir = options.identifier;
1793
1794       if (options.level_nr != NULL)
1795         tape.level_nr = atoi(options.level_nr);
1796
1797       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1798         global.autoplay_level[tape.level_nr] = TRUE;
1799
1800       global.autoplay_all = FALSE;
1801       options.mytapes = FALSE;
1802     }
1803
1804     if (autoplay.all_levelsets)
1805     {
1806       // start auto-playing first level set
1807       autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
1808     }
1809     else
1810     {
1811       // auto-play selected level set
1812       autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
1813                                                     global.autoplay_leveldir);
1814     }
1815
1816     if (autoplay.leveldir == NULL)
1817       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1818
1819     // only private tapes may be modified
1820     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1821       options.mytapes = TRUE;
1822
1823     // set timestamp for batch tape upload
1824     global.autoplay_time = time(NULL);
1825
1826     num_tapes = 0;
1827
1828     init_level_set = TRUE;
1829   }
1830
1831   while (1)
1832   {
1833     if (init_level_set)
1834     {
1835       leveldir_current = autoplay.leveldir;
1836
1837       if (autoplay.leveldir->first_level < 0)
1838         autoplay.leveldir->first_level = 0;
1839       if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
1840         autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
1841
1842       autoplay.level_nr = autoplay.leveldir->first_level;
1843
1844       autoplay.num_levels_played = 0;
1845       autoplay.num_levels_solved = 0;
1846       autoplay.num_tapes_patched = 0;
1847       autoplay.num_tape_missing = 0;
1848
1849       for (i = 0; i < MAX_TAPES_PER_SET; i++)
1850         autoplay.level_failed[i] = FALSE;
1851
1852       PrintTapeReplayHeader(&autoplay);
1853
1854       init_level_set = FALSE;
1855     }
1856
1857     if (autoplay.all_levelsets && global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1858     {
1859       boolean skip_levelset = FALSE;
1860
1861       if (!directoryExists(getTapeDir(autoplay.leveldir->subdir)))
1862       {
1863         Print("No tape directory for this level set found -- skipping.\n");
1864
1865         skip_levelset = TRUE;
1866       }
1867
1868       if (CheckTapeDirectoryUploadsComplete(autoplay.leveldir->subdir))
1869       {
1870         Print("All tapes for this level set already uploaded -- skipping.\n");
1871
1872         skip_levelset = TRUE;
1873       }
1874
1875       if (skip_levelset)
1876       {
1877         PrintTapeReplaySummary(&autoplay);
1878
1879         // continue with next level set
1880         autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1881
1882         // all level sets processed
1883         if (autoplay.leveldir == NULL)
1884           break;
1885
1886         init_level_set = TRUE;
1887
1888         continue;
1889       }
1890     }
1891
1892     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1893       level_nr = autoplay.level_nr++;
1894
1895     UPDATE_BUSY_STATE();
1896
1897     // check if all tapes for this level set have been processed
1898     if (level_nr > autoplay.leveldir->last_level)
1899     {
1900       PrintTapeReplaySummary(&autoplay);
1901
1902       if (!autoplay.all_levelsets)
1903         break;
1904
1905       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1906         MarkTapeDirectoryUploadsAsComplete(autoplay.leveldir->subdir);
1907
1908       // continue with next level set
1909       autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1910
1911       // all level sets processed
1912       if (autoplay.leveldir == NULL)
1913         break;
1914
1915       init_level_set = TRUE;
1916
1917       continue;
1918     }
1919
1920     // set patch info (required for progress output)
1921     strcpy(tape_patch_info, "");
1922     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1923       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1924                patch_name[patch_nr]);
1925
1926     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1927       continue;
1928
1929     // speed things up in case of missing private tapes (skip loading level)
1930     if (options.mytapes && !fileExists(getTapeFilename(level_nr)))
1931     {
1932       autoplay.num_tape_missing++;
1933
1934       Print("Tape %03d: (no tape found)\n", level_nr);
1935
1936       continue;
1937     }
1938
1939     TapeErase();
1940     TapeRewind();       // needed to reset "tape.auto_play_level_solved"
1941
1942     LoadLevel(level_nr);
1943
1944     if (level.no_level_file || level.no_valid_file)
1945     {
1946       Print("Tape %03d: (no level found)\n", level_nr);
1947
1948       continue;
1949     }
1950
1951 #if 0
1952     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1953     Print("Tape %03d: (only testing level)\n", level_nr);
1954     continue;
1955 #endif
1956
1957     if (autoplay.tape_filename)
1958       LoadTapeFromFilename(autoplay.tape_filename);
1959     else if (options.mytapes)
1960       LoadTape(level_nr);
1961     else
1962       LoadSolutionTape(level_nr);
1963
1964     if (tape.no_valid_file)
1965     {
1966       autoplay.num_tape_missing++;
1967
1968       Print("Tape %03d: (no tape found)\n", level_nr);
1969
1970       continue;
1971     }
1972
1973     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1974     {
1975       boolean skip_patch = FALSE;
1976
1977       if (tape.engine_version < patch_version_first[patch_nr] ||
1978           tape.engine_version > patch_version_last[patch_nr])
1979       {
1980         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
1981               level_nr,  tape_patch_info,
1982               tape.length_seconds / 60, tape.length_seconds % 60,
1983               "not suitable for version",
1984               (tape.engine_version / 1000000) % 100,
1985               (tape.engine_version / 10000  ) % 100,
1986               (tape.engine_version / 100    ) % 100,
1987               (tape.engine_version          ) % 100);
1988
1989         skip_patch = TRUE;
1990       }
1991
1992       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
1993           tape.num_participating_players == 1)
1994       {
1995         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
1996               level_nr,  tape_patch_info,
1997               tape.length_seconds / 60, tape.length_seconds % 60,
1998               "not suitable for single player tapes");
1999
2000         skip_patch = TRUE;
2001       }
2002
2003       if (skip_patch)
2004       {
2005         if (patch_name[patch_nr + 1] != NULL)
2006         {
2007           // continue with next patch
2008           patch_nr++;
2009         }
2010         else
2011         {
2012           // continue with next tape
2013           patch_nr = 0;
2014         }
2015
2016         continue;
2017       }
2018
2019       if (strEqual(patch_name[patch_nr], "screen_34x34"))
2020       {
2021         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
2022         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
2023       }
2024       else
2025       {
2026         tape.property_bits |= patch_property_bit[patch_nr];
2027       }
2028     }
2029
2030     num_tapes++;
2031
2032     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2033     {
2034       boolean use_temporary_tape_file = FALSE;
2035
2036       Print("Tape %03d:\n", level_nr);
2037
2038       AutoPlayTapes_SetScoreEntry(0, 0);
2039
2040       if (autoplay.tape_filename == NULL)
2041       {
2042         autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
2043                                   getDefaultSolutionTapeFilename(level_nr));
2044
2045         if (!fileExists(autoplay.tape_filename))
2046         {
2047           // non-standard or incorrect solution tape -- save to temporary file
2048           autoplay.tape_filename = getTemporaryTapeFilename();
2049
2050           SaveTapeToFilename(autoplay.tape_filename);
2051
2052           use_temporary_tape_file = TRUE;
2053         }
2054       }
2055
2056       SaveServerScoreFromFile(level_nr, TRUE, autoplay.tape_filename);
2057
2058       boolean success = AutoPlayTapes_WaitForUpload();
2059
2060       if (use_temporary_tape_file)
2061         unlink(autoplay.tape_filename);
2062
2063       // required for uploading multiple tapes
2064       autoplay.tape_filename = NULL;
2065
2066       if (!success)
2067       {
2068         num_tapes = -num_tapes;
2069
2070         break;
2071       }
2072
2073       continue;
2074     }
2075
2076     InitCounter();
2077
2078     if (options.tape_log_filename != NULL)
2079       OpenTapeLogfile();
2080
2081     TapeStartGamePlaying();
2082     TapeStartWarpForward(global.autoplay_mode);
2083
2084     autoplay.last_level_nr = level_nr;
2085
2086     return num_tapes;
2087   }
2088
2089   if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2090   {
2091     Print("\n");
2092     PrintLine("=", 79);
2093
2094     if (num_tapes >= 0)
2095       Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
2096     else
2097       Print("SUMMARY: Uploading tapes failed.\n");
2098
2099     PrintLine("=", 79);
2100   }
2101
2102   // clear timestamp for batch tape upload (required after interactive upload)
2103   global.autoplay_time = 0;
2104
2105   // exit if running headless or if visually auto-playing tapes
2106   if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
2107     CloseAllAndExit(0);
2108
2109   // when running interactively, restore last selected level set and number
2110   leveldir_current = leveldir_current_last;
2111   level_nr = level_nr_last;
2112
2113   return num_tapes;
2114 }
2115
2116 int AutoPlayTapes(void)
2117 {
2118   return AutoPlayTapesExt(TRUE);
2119 }
2120
2121 int AutoPlayTapesContinue(void)
2122 {
2123   return AutoPlayTapesExt(FALSE);
2124 }
2125
2126
2127 // ----------------------------------------------------------------------------
2128 // tape patch functions
2129 // ----------------------------------------------------------------------------
2130
2131 static boolean PatchTape(struct TapeInfo *tape, char *mode)
2132 {
2133   Print("[%d.%d.%d.%d]: ",
2134         (tape->engine_version / 1000000) % 100,
2135         (tape->engine_version / 10000  ) % 100,
2136         (tape->engine_version / 100    ) % 100,
2137         (tape->engine_version          ) % 100);
2138
2139   if (strEqual(mode, "info"))
2140   {
2141     Print("property bits == 0x%02x\n", tape->property_bits);
2142
2143     return FALSE;
2144   }
2145
2146   boolean unpatch_tape = FALSE;
2147   boolean use_property_bit = FALSE;
2148   byte property_bitmask = 0;
2149
2150   if (strSuffix(mode, ":0") ||
2151       strSuffix(mode, ":off") ||
2152       strSuffix(mode, ":clear"))
2153     unpatch_tape = TRUE;
2154
2155   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
2156   {
2157     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
2158     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
2159         tape->engine_version >= VERSION_IDENT(4,0,1,2))
2160     {
2161       Print("This tape version cannot be patched against EM random bug!\n");
2162
2163       return FALSE;
2164     }
2165
2166     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
2167
2168     use_property_bit = TRUE;
2169   }
2170   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
2171   {
2172     // this bug only affects team mode tapes
2173     if (tape->num_participating_players == 1)
2174     {
2175       Print("Only team mode tapes can be patched against screen size bug!\n");
2176
2177       return FALSE;
2178     }
2179
2180     // this bug (that always existed before) was fixed in version 4.2.2.1
2181     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
2182     {
2183       Print("This tape version cannot be patched against screen size bug!\n");
2184
2185       return FALSE;
2186     }
2187
2188     int factor = (unpatch_tape ? 1 : 2);
2189     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
2190     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
2191
2192     if (scr_fieldx_new == tape->scr_fieldx &&
2193         scr_fieldy_new == tape->scr_fieldy)
2194     {
2195       Print("Tape already patched for '%s'!\n", mode);
2196
2197       return FALSE;
2198     }
2199
2200     tape->scr_fieldx = scr_fieldx_new;
2201     tape->scr_fieldy = scr_fieldy_new;
2202   }
2203   else
2204   {
2205     Print("Unknown patch mode '%s'!\n", mode);
2206
2207     return FALSE;
2208   }
2209
2210   // patching tapes using property bits may be used for several patch modes
2211   if (use_property_bit)
2212   {
2213     byte property_bits = tape->property_bits;
2214     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
2215
2216     if (set_property_bit)
2217       property_bits |= property_bitmask;
2218     else
2219       property_bits &= ~property_bitmask;
2220
2221     if (property_bits == tape->property_bits)
2222     {
2223       Print("Tape already patched for '%s'!\n", mode);
2224
2225       return FALSE;
2226     }
2227
2228     tape->property_bits = property_bits;
2229   }
2230
2231   Print("Patching for '%s' ... ", mode);
2232
2233   return TRUE;
2234 }
2235
2236 void PatchTapes(void)
2237 {
2238   static LevelDirTree *patchtapes_leveldir = NULL;
2239   static int num_tapes_found = 0;
2240   static int num_tapes_patched = 0;
2241   char *mode = global.patchtapes_mode;
2242   int i;
2243
2244   if (strEqual(mode, "help"))
2245   {
2246     PrintLine("=", 79);
2247     Print("Supported patch modes:\n");
2248     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
2249     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
2250     PrintLine("-", 79);
2251     Print("Supported modifiers:\n");
2252     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
2253     PrintLine("=", 79);
2254
2255     CloseAllAndExit(0);
2256   }
2257
2258   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
2259                                                   global.patchtapes_leveldir);
2260
2261   if (patchtapes_leveldir == NULL)
2262     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
2263
2264   leveldir_current = patchtapes_leveldir;
2265
2266   if (patchtapes_leveldir->first_level < 0)
2267     patchtapes_leveldir->first_level = 0;
2268   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
2269     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
2270
2271   PrintLine("=", 79);
2272   Print("Patching level tapes for patch mode '%s'\n", mode);
2273   PrintLine("-", 79);
2274   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
2275   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
2276   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
2277   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
2278   PrintLine("=", 79);
2279   Print("\n");
2280
2281   int first_level = patchtapes_leveldir->first_level;
2282   int last_level = patchtapes_leveldir->last_level;
2283
2284   for (i = first_level; i <= last_level; i++)
2285   {
2286     if (!global.patchtapes_all && !global.patchtapes_level[i])
2287       continue;
2288
2289     Print("Tape %03d: ", i);
2290
2291     TapeErase();
2292     LoadTape(i);
2293
2294     if (tape.no_valid_file)
2295     {
2296       Print("(no tape found)\n");
2297
2298       continue;
2299     }
2300
2301     num_tapes_found++;
2302
2303     if (PatchTape(&tape, mode))
2304     {
2305       char *filename = getTapeFilename(i);
2306       char *filename_orig = getStringCat2(filename, ".orig");
2307
2308       if (!fileExists(filename_orig))
2309         rename(filename, filename_orig);
2310
2311       SaveTapeToFilename(filename);
2312
2313       Print("patched tape saved.\n");
2314
2315       num_tapes_patched++;
2316     }
2317   }
2318
2319   Print("\n");
2320   PrintLine("=", 79);
2321   Print("Number of tapes found: %d\n", num_tapes_found);
2322   Print("Number of tapes patched: %d\n", num_tapes_patched);
2323   PrintLine("=", 79);
2324
2325   CloseAllAndExit(0);
2326 }
2327
2328
2329 // ---------- new tape button stuff -------------------------------------------
2330
2331 static struct
2332 {
2333   int graphic;
2334   struct XY *pos;
2335   int gadget_id;
2336   char *infotext;
2337 } tapebutton_info[NUM_TAPE_BUTTONS] =
2338 {
2339   {
2340     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
2341     TAPE_CTRL_ID_EJECT,                 "eject tape"
2342   },
2343   {
2344     // (same position as "eject" button)
2345     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
2346     TAPE_CTRL_ID_EXTRA,                 "extra functions"
2347   },
2348   {
2349     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
2350     TAPE_CTRL_ID_STOP,                  "stop tape"
2351   },
2352   {
2353     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
2354     TAPE_CTRL_ID_PAUSE,                 "pause tape"
2355   },
2356   {
2357     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
2358     TAPE_CTRL_ID_RECORD,                "record tape"
2359   },
2360   {
2361     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
2362     TAPE_CTRL_ID_PLAY,                  "play tape"
2363   },
2364   {
2365     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
2366     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
2367   },
2368   {
2369     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
2370     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
2371   }
2372 };
2373
2374 void CreateTapeButtons(void)
2375 {
2376   int i;
2377
2378   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2379   {
2380     int graphic = tapebutton_info[i].graphic;
2381     struct GraphicInfo *gfx = &graphic_info[graphic];
2382     struct XY *pos = tapebutton_info[i].pos;
2383     struct GadgetInfo *gi;
2384     int gd_x = gfx->src_x;
2385     int gd_y = gfx->src_y;
2386     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
2387     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
2388     int id = i;
2389
2390     gi = CreateGadget(GDI_CUSTOM_ID, id,
2391                       GDI_IMAGE_ID, graphic,
2392                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
2393                       GDI_X, VX + pos->x,
2394                       GDI_Y, VY + pos->y,
2395                       GDI_WIDTH, gfx->width,
2396                       GDI_HEIGHT, gfx->height,
2397                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
2398                       GDI_STATE, GD_BUTTON_UNPRESSED,
2399                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
2400                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
2401                       GDI_DIRECT_DRAW, FALSE,
2402                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
2403                       GDI_CALLBACK_ACTION, HandleTapeButtons,
2404                       GDI_END);
2405
2406     if (gi == NULL)
2407       Fail("cannot create gadget");
2408
2409     tape_gadget[id] = gi;
2410   }
2411 }
2412
2413 void FreeTapeButtons(void)
2414 {
2415   int i;
2416
2417   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2418     FreeGadget(tape_gadget[i]);
2419 }
2420
2421 void MapTapeEjectButton(void)
2422 {
2423   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2424   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2425 }
2426
2427 void MapTapeWarpButton(void)
2428 {
2429   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2430   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2431 }
2432
2433 void MapTapeButtons(void)
2434 {
2435   int i;
2436
2437   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2438     if (i != TAPE_CTRL_ID_EXTRA)
2439       MapGadget(tape_gadget[i]);
2440
2441   if (tape.recording || tape.playing)
2442     MapTapeWarpButton();
2443
2444   if (tape.show_game_buttons)
2445     MapGameButtonsOnTape();
2446 }
2447
2448 void UnmapTapeButtons(void)
2449 {
2450   int i;
2451
2452   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2453     UnmapGadget(tape_gadget[i]);
2454
2455   if (tape.show_game_buttons)
2456     UnmapGameButtonsOnTape();
2457 }
2458
2459 void RedrawTapeButtons(void)
2460 {
2461   int i;
2462
2463   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2464     RedrawGadget(tape_gadget[i]);
2465
2466   if (tape.show_game_buttons)
2467     RedrawGameButtonsOnTape();
2468 }
2469
2470 void RedrawOrRemapTapeButtons(void)
2471 {
2472   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
2473   {
2474     // tape buttons already mapped
2475     RedrawTapeButtons();
2476   }
2477   else
2478   {
2479     UnmapTapeButtons();
2480     MapTapeButtons();
2481   }
2482 }
2483
2484 static void HandleTapeButtonsExt(int id)
2485 {
2486   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
2487     return;
2488
2489   switch (id)
2490   {
2491     case TAPE_CTRL_ID_EJECT:
2492       TapeStop();
2493
2494       if (TAPE_IS_EMPTY(tape))
2495       {
2496         LoadTape(level_nr);
2497
2498         if (TAPE_IS_EMPTY(tape))
2499           Request("No tape for this level!", REQ_CONFIRM);
2500       }
2501       else
2502       {
2503         if (tape.changed)
2504           SaveTapeChecked(level_nr);
2505
2506         TapeErase();
2507       }
2508
2509       DrawCompleteVideoDisplay();
2510       break;
2511
2512     case TAPE_CTRL_ID_EXTRA:
2513       if (tape.playing)
2514       {
2515         tape.pause_before_end = !tape.pause_before_end;
2516
2517         DrawVideoDisplayCurrentState();
2518       }
2519       else if (tape.recording)
2520       {
2521         TapeSingleStep();
2522       }
2523
2524       break;
2525
2526     case TAPE_CTRL_ID_STOP:
2527       TapeStopTape();
2528
2529       break;
2530
2531     case TAPE_CTRL_ID_PAUSE:
2532       TapeTogglePause(TAPE_TOGGLE_MANUAL);
2533
2534       break;
2535
2536     case TAPE_CTRL_ID_RECORD:
2537       if (TAPE_IS_STOPPED(tape))
2538       {
2539         TapeStartGameRecording();
2540       }
2541       else if (tape.pausing)
2542       {
2543         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
2544           TapeAppendRecording();
2545         else
2546           TapeTogglePause(TAPE_TOGGLE_MANUAL);
2547       }
2548
2549       break;
2550
2551     case TAPE_CTRL_ID_PLAY:
2552       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
2553       {
2554         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
2555
2556         TapeTogglePause(TAPE_TOGGLE_MANUAL);
2557       }
2558
2559       if (TAPE_IS_EMPTY(tape))
2560         break;
2561
2562       if (TAPE_IS_STOPPED(tape))
2563       {
2564         TapeStartGamePlaying();
2565       }
2566       else if (tape.playing)
2567       {
2568         if (tape.pausing)                       // PAUSE -> PLAY
2569         {
2570           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
2571         }
2572         else if (!tape.fast_forward)            // PLAY -> FFWD
2573         {
2574           tape.fast_forward = TRUE;
2575         }
2576         else if (!tape.warp_forward)            // FFWD -> WARP
2577         {
2578           tape.warp_forward = TRUE;
2579         }
2580         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
2581         {
2582           tape.deactivate_display = TRUE;
2583
2584           TapeDeactivateDisplayOn();
2585         }
2586         else                                    // WARP BLIND -> PLAY
2587         {
2588           tape.fast_forward = FALSE;
2589           tape.warp_forward = FALSE;
2590           tape.deactivate_display = FALSE;
2591
2592           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2593         }
2594
2595         DrawVideoDisplayCurrentState();
2596       }
2597
2598       break;
2599
2600     case TAPE_CTRL_ID_INSERT_SOLUTION:
2601       InsertSolutionTape();
2602
2603       break;
2604
2605     case TAPE_CTRL_ID_PLAY_SOLUTION:
2606       PlaySolutionTape();
2607
2608       break;
2609
2610     default:
2611       break;
2612   }
2613 }
2614
2615 static void HandleTapeButtons(struct GadgetInfo *gi)
2616 {
2617   HandleTapeButtonsExt(gi->custom_id);
2618 }
2619
2620 void HandleTapeButtonKeys(Key key)
2621 {
2622   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2623   boolean extra_button_is_active = !eject_button_is_active;
2624
2625   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2626     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2627   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2628     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2629   else if (key == setup.shortcut.tape_stop)
2630     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2631   else if (key == setup.shortcut.tape_pause)
2632     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2633   else if (key == setup.shortcut.tape_record)
2634     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2635   else if (key == setup.shortcut.tape_play)
2636     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2637 }