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   tape.changed = TRUE;
 838
 839   return TRUE;
 840 }
 841
 842 void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
 843 {
 844   byte action[MAX_TAPE_ACTIONS];
 845   int i;
 846
 847   if (!tape.recording)          // (record action even when tape is paused)
 848     return;
 849
 850   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
 851     action[i] = action_raw[i];
 852
 853   if (tape.use_key_actions && tape.set_centered_player)
 854   {
 855     for (i = 0; i < MAX_PLAYERS; i++)
 856       if (tape.centered_player_nr_next == i ||
 857           tape.centered_player_nr_next == -1)
 858         action[i] |= KEY_SET_FOCUS;
 859
 860     tape.set_centered_player = FALSE;
 861   }
 862
 863   if (GameFrameDelay != GAME_FRAME_DELAY)
 864     tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
 865
 866   if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
 867     tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
 868
 869   if (!TapeAddAction(action))
 870     TapeStopRecording();
 871 }
 872
 873 void TapeTogglePause(boolean toggle_mode)
 874 {
 875   if (tape.playing && tape.pausing && (toggle_mode & TAPE_TOGGLE_PLAY_PAUSE))
 876   {
 877     // continue playing in normal mode
 878     tape.fast_forward = FALSE;
 879     tape.warp_forward = FALSE;
 880     tape.deactivate_display = FALSE;
 881
 882     tape.pause_before_end = FALSE;
 883   }
 884
 885   tape.pausing = !tape.pausing;
 886
 887   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
 888     tape.single_step = FALSE;
 889
 890   if (tape.single_step)
 891     tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
 892
 893   if (tape.pausing)
 894     tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
 895
 896   DrawVideoDisplayCurrentState();
 897
 898   if (tape.deactivate_display)
 899   {
 900     if (tape.pausing)
 901       TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
 902     else
 903       TapeDeactivateDisplayOn();
 904   }
 905
 906   if (tape.quick_resume)
 907   {
 908     tape.quick_resume = FALSE;
 909
 910     TapeStopWarpForward();
 911     TapeAppendRecording();
 912
 913     if (!CheckEngineSnapshotSingle())
 914       SaveEngineSnapshotSingle();
 915
 916     // restart step/move snapshots after quick loading tape
 917     SaveEngineSnapshotToListInitial();
 918
 919     // do not map undo/redo buttons after quick loading tape
 920     return;
 921   }
 922
 923   if (game_status == GAME_MODE_PLAYING)
 924   {
 925     if (setup.show_load_save_buttons &&
 926         setup.show_undo_redo_buttons &&
 927         CheckEngineSnapshotList())
 928     {
 929       if (tape.pausing)
 930         MapUndoRedoButtons();
 931       else if (!tape.single_step)
 932         MapLoadSaveButtons();
 933     }
 934
 935     ModifyPauseButtons();
 936   }
 937 }
 938
 939 void TapeStartPlaying(void)
 940 {
 941   if (TAPE_IS_EMPTY(tape))
 942     return;
 943
 944   if (!TAPE_IS_STOPPED(tape))
 945     TapeStop();
 946
 947   TapeRewind();
 948
 949   tape.playing = TRUE;
 950
 951   DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
 952   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
 953   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
 954   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
 955
 956   MapTapeWarpButton();
 957
 958   SetDrawDeactivationMask(REDRAW_NONE);
 959   audio.sound_deactivated = FALSE;
 960 }
 961
 962 static void TapeStartGamePlaying(void)
 963 {
 964   TapeStartPlaying();
 965
 966   InitGame();
 967 }
 968
 969 void TapeStopPlaying(void)
 970 {
 971   tape.playing = FALSE;
 972   tape.pausing = FALSE;
 973
 974   if (tape.warp_forward)
 975     TapeStopWarpForward();
 976
 977   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF, 0);
 978   MapTapeEjectButton();
 979 }
 980
 981 byte *TapePlayAction(void)
 982 {
 983   int update_delay = FRAMES_PER_SECOND / 2;
 984   boolean update_video_display = (FrameCounter % update_delay == 0);
 985   boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
 986   static byte action[MAX_TAPE_ACTIONS];
 987   int i;
 988
 989   if (!tape.playing || tape.pausing)
 990     return NULL;
 991
 992   if (tape.pause_before_end)  // stop some seconds before end of tape
 993   {
 994     if (TapeTime > (int)tape.length_seconds - TAPE_PAUSE_SECONDS_BEFORE_DEATH)
 995     {
 996       TapeStopWarpForward();
 997       TapeTogglePause(TAPE_TOGGLE_MANUAL);
 998
 999       if (setup.autorecord_after_replay)
1000         TapeAppendRecording();
1001
1002       return NULL;
1003     }
1004   }
1005
1006   if (tape.counter >= tape.length)      // end of tape reached
1007   {
1008     if (!tape.auto_play)
1009     {
1010       TapeStopWarpForward();
1011       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1012
1013       if (setup.autorecord_after_replay)
1014         TapeAppendRecording();
1015     }
1016     else
1017     {
1018       TapeStop();
1019     }
1020
1021     return NULL;
1022   }
1023
1024   if (update_video_display && !tape.deactivate_display)
1025   {
1026     int state = 0;
1027
1028     if (tape.warp_forward)
1029       state |= VIDEO_STATE_WARP(update_draw_label_on);
1030     else if (tape.fast_forward)
1031       state |= VIDEO_STATE_FFWD(update_draw_label_on);
1032
1033     if (tape.pause_before_end)
1034       state |= VIDEO_STATE_PBEND(update_draw_label_on);
1035
1036     // draw labels and symbols separately to prevent labels overlapping symbols
1037     DrawVideoDisplayLabel(state);
1038     DrawVideoDisplaySymbol(state);
1039   }
1040
1041   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1042     action[i] = tape.pos[tape.counter].action[i];
1043
1044 #if DEBUG_TAPE_WHEN_PLAYING
1045   DebugContinued("", "%05d", FrameCounter);
1046   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1047     DebugContinued("", "   %08x", action[i]);
1048   DebugContinued("tape:play", "\n");
1049 #endif
1050
1051   tape.set_centered_player = FALSE;
1052   tape.centered_player_nr_next = -999;
1053
1054   if (tape.use_key_actions)
1055   {
1056     for (i = 0; i < MAX_PLAYERS; i++)
1057     {
1058       if (action[i] & KEY_SET_FOCUS)
1059       {
1060         tape.set_centered_player = TRUE;
1061         tape.centered_player_nr_next =
1062           (tape.centered_player_nr_next == -999 ? i : -1);
1063       }
1064
1065       action[i] &= ~KEY_SET_FOCUS;
1066     }
1067   }
1068
1069   tape.delay_played++;
1070   if (tape.delay_played >= tape.pos[tape.counter].delay)
1071   {
1072     tape.counter++;
1073     tape.delay_played = 0;
1074   }
1075
1076   if (tape.auto_play)
1077     PrintTapeReplayProgress(FALSE);
1078
1079   if (options.tape_log_filename != NULL)
1080     WriteTapeLogfile(action);
1081
1082   return action;
1083 }
1084
1085 void TapeStop(void)
1086 {
1087   if (tape.pausing)
1088     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1089
1090   TapeStopRecording();
1091   TapeStopPlaying();
1092
1093   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
1094
1095   if (tape.date && tape.length)
1096   {
1097     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
1098     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
1099     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
1100   }
1101 }
1102
1103 static void TapeStopGameOrTape(boolean stop_game)
1104 {
1105   if (score_info_tape_play || (!tape.playing && stop_game))
1106     RequestQuitGame(FALSE);
1107   else
1108     TapeStop();
1109 }
1110
1111 void TapeStopGame(void)
1112 {
1113   if (game_status == GAME_MODE_MAIN)
1114     return;
1115
1116   TapeStopGameOrTape(TRUE);
1117 }
1118
1119 void TapeStopTape(void)
1120 {
1121   TapeStopGameOrTape(FALSE);
1122 }
1123
1124 unsigned int GetTapeLengthFrames(void)
1125 {
1126   unsigned int tape_length_frames = 0;
1127   int i;
1128
1129   if (TAPE_IS_EMPTY(tape))
1130     return 0;
1131
1132   for (i = 0; i < tape.length; i++)
1133     tape_length_frames += tape.pos[i].delay;
1134
1135   return tape_length_frames;
1136 }
1137
1138 unsigned int GetTapeLengthSeconds(void)
1139 {
1140   return (GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1141 }
1142
1143 static float GetTapeLengthSecondsFloat(void)
1144 {
1145   return ((float)GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1146 }
1147
1148 static void TapeStartWarpForward(int mode)
1149 {
1150   tape.fast_forward = (mode & AUTOPLAY_FFWD);
1151   tape.warp_forward = (mode & AUTOPLAY_WARP);
1152   tape.deactivate_display = (mode & AUTOPLAY_WARP_NO_DISPLAY);
1153
1154   tape.pausing = FALSE;
1155
1156   if (tape.deactivate_display)
1157     TapeDeactivateDisplayOn();
1158
1159   DrawVideoDisplayCurrentState();
1160 }
1161
1162 static void TapeStopWarpForward(void)
1163 {
1164   tape.fast_forward = FALSE;
1165   tape.warp_forward = FALSE;
1166   tape.deactivate_display = FALSE;
1167
1168   tape.pause_before_end = FALSE;
1169
1170   TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
1171
1172   DrawVideoDisplayCurrentState();
1173 }
1174
1175 static void TapeSingleStep(void)
1176 {
1177   if (network.enabled)
1178     return;
1179
1180   if (!tape.pausing)
1181     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1182
1183   tape.single_step = !tape.single_step;
1184
1185   DrawVideoDisplay(VIDEO_STATE_1STEP(tape.single_step), 0);
1186 }
1187
1188 void TapeQuickSave(void)
1189 {
1190   if (game_status != GAME_MODE_PLAYING)
1191   {
1192     Request("No game that could be saved!", REQ_CONFIRM);
1193
1194     return;
1195   }
1196
1197   if (!tape.recording)
1198   {
1199     Request("No recording that could be saved!", REQ_CONFIRM);
1200
1201     return;
1202   }
1203
1204   TapeHaltRecording();          // prepare tape for saving on-the-fly
1205
1206   if (TAPE_IS_EMPTY(tape))
1207   {
1208     Request("No tape that could be saved!", REQ_CONFIRM);
1209
1210     return;
1211   }
1212
1213   tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1214
1215   if (SaveTapeChecked(tape.level_nr))
1216     SaveEngineSnapshotSingle();
1217 }
1218
1219 void TapeQuickLoad(void)
1220 {
1221   char *filename = getTapeFilename(level_nr);
1222
1223   if (!fileExists(filename))
1224   {
1225     Request("No tape for this level!", REQ_CONFIRM);
1226
1227     return;
1228   }
1229
1230   if (tape.recording && !Request("Stop recording and load tape?",
1231                                  REQ_ASK | REQ_STAY_CLOSED))
1232   {
1233     OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1234
1235     return;
1236   }
1237
1238   if (game_status != GAME_MODE_PLAYING && game_status != GAME_MODE_MAIN)
1239     return;
1240
1241   if (CheckEngineSnapshotSingle())
1242   {
1243     TapeStartGamePlaying();
1244
1245     LoadEngineSnapshotSingle();
1246
1247     DrawCompleteVideoDisplay();
1248
1249     tape.playing = TRUE;
1250     tape.pausing = TRUE;
1251
1252     TapeStopWarpForward();
1253     TapeAppendRecording();
1254
1255     // restart step/move snapshots after quick loading tape
1256     SaveEngineSnapshotToListInitial();
1257
1258     if (FrameCounter > 0)
1259       return;
1260   }
1261
1262   TapeStop();
1263   TapeErase();
1264
1265   LoadTape(level_nr);
1266
1267   if (!TAPE_IS_EMPTY(tape))
1268   {
1269     TapeStartGamePlaying();
1270     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1271
1272     tape.quick_resume = TRUE;
1273     tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1274   }
1275   else  // this should not happen (basically checked above)
1276   {
1277     int reopen_door = (game_status == GAME_MODE_PLAYING ? REQ_REOPEN : 0);
1278
1279     Request("No tape for this level!", REQ_CONFIRM | reopen_door);
1280   }
1281 }
1282
1283 static boolean checkRestartGame(char *message)
1284 {
1285   if (game_status == GAME_MODE_MAIN)
1286     return TRUE;
1287
1288   if (!hasStartedNetworkGame())
1289     return FALSE;
1290
1291   if (level_editor_test_game)
1292     return TRUE;
1293
1294   if (game.all_players_gone)
1295     return TRUE;
1296
1297   if (!setup.ask_on_quit_game)
1298     return TRUE;
1299
1300   if (Request(message, REQ_ASK | REQ_STAY_CLOSED))
1301     return TRUE;
1302
1303   OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1304
1305   return FALSE;
1306 }
1307
1308 void TapeRestartGame(void)
1309 {
1310   if (score_info_tape_play)
1311   {
1312     TapeStartGamePlaying();
1313
1314     return;
1315   }
1316
1317   if (!checkRestartGame("Restart game?"))
1318     return;
1319
1320   StartGameActions(network.enabled, setup.autorecord, level.random_seed);
1321 }
1322
1323 void TapeReplayAndPauseBeforeEnd(void)
1324 {
1325   if (score_info_tape_play)
1326     return;
1327
1328   if (TAPE_IS_EMPTY(tape) && !tape.recording)
1329   {
1330     Request("No tape for this level!", REQ_CONFIRM);
1331
1332     return;
1333   }
1334
1335   if (!checkRestartGame("Replay game and pause before end?"))
1336     return;
1337
1338   TapeStop();
1339   TapeStartGamePlaying();
1340   TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1341
1342   tape.pause_before_end = TRUE;
1343   tape.quick_resume = TRUE;
1344 }
1345
1346 boolean hasSolutionTape(void)
1347 {
1348   boolean tape_file_exists = fileExists(getSolutionTapeFilename(level_nr));
1349   boolean level_has_tape = (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
1350                             level.native_sp_level->demo.is_available);
1351
1352   return (tape_file_exists || level_has_tape);
1353 }
1354
1355 boolean InsertSolutionTape(void)
1356 {
1357   if (!hasSolutionTape())
1358   {
1359     Request("No solution tape for this level!", REQ_CONFIRM);
1360
1361     return FALSE;
1362   }
1363
1364   if (!TAPE_IS_STOPPED(tape))
1365     TapeStop();
1366
1367   // if tape recorder already contains a tape, remove it without asking
1368   TapeErase();
1369
1370   LoadSolutionTape(level_nr);
1371
1372   DrawCompleteVideoDisplay();
1373
1374   if (TAPE_IS_EMPTY(tape))
1375   {
1376     Request("Loading solution tape for this level failed!", REQ_CONFIRM);
1377
1378     return FALSE;
1379   }
1380
1381   return TRUE;
1382 }
1383
1384 boolean PlaySolutionTape(void)
1385 {
1386   if (!InsertSolutionTape())
1387     return FALSE;
1388
1389   TapeStartGamePlaying();
1390
1391   return TRUE;
1392 }
1393
1394 static boolean PlayScoreTape_WaitForDownload(void)
1395 {
1396   DelayCounter download_delay = { 10000 };
1397
1398   ResetDelayCounter(&download_delay);
1399
1400   // wait for score tape to be successfully downloaded (and fail on timeout)
1401   while (!server_scores.tape_downloaded)
1402   {
1403     if (DelayReached(&download_delay))
1404       return FALSE;
1405
1406     UPDATE_BUSY_STATE_NOT_LOADING();
1407
1408     Delay(20);
1409   }
1410
1411   return TRUE;
1412 }
1413
1414 boolean PlayScoreTape(int entry_nr)
1415 {
1416   struct ScoreEntry *entry = &scores.entry[entry_nr];
1417   char *tape_filename =
1418     (entry->id == -1 ?
1419      getScoreTapeFilename(entry->tape_basename, level_nr) :
1420      getScoreCacheTapeFilename(entry->tape_basename, level_nr));
1421   boolean download_tape = (!fileExists(tape_filename));
1422
1423   if (download_tape && entry->id == -1)
1424   {
1425     FadeSkipNextFadeIn();
1426
1427     Request("Cannot find score tape!", REQ_CONFIRM);
1428
1429     return FALSE;
1430   }
1431
1432   server_scores.tape_downloaded = FALSE;
1433
1434   if (download_tape)
1435     ApiGetScoreTapeAsThread(level_nr, entry->id, entry->tape_basename);
1436
1437   SetGameStatus(GAME_MODE_PLAYING);
1438
1439   FadeOut(REDRAW_FIELD);
1440
1441   if (download_tape && !PlayScoreTape_WaitForDownload())
1442   {
1443     SetGameStatus(GAME_MODE_SCOREINFO);
1444     ClearField();
1445
1446     Request("Cannot download score tape from score server!", REQ_CONFIRM);
1447
1448     return FALSE;
1449   }
1450
1451   if (!TAPE_IS_STOPPED(tape))
1452     TapeStop();
1453
1454   // if tape recorder already contains a tape, remove it without asking
1455   TapeErase();
1456
1457   if (entry->id == -1)
1458     LoadScoreTape(entry->tape_basename, level_nr);
1459   else
1460     LoadScoreCacheTape(entry->tape_basename, level_nr);
1461
1462   if (TAPE_IS_EMPTY(tape))
1463   {
1464     SetGameStatus(GAME_MODE_SCOREINFO);
1465     ClearField();
1466
1467     Request("Cannot load score tape for this level!", REQ_CONFIRM);
1468
1469     return FALSE;
1470   }
1471
1472   FadeSkipNextFadeOut();
1473
1474   TapeStartGamePlaying();
1475
1476   score_info_tape_play = TRUE;
1477
1478   return TRUE;
1479 }
1480
1481 static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
1482 {
1483   return (strEqual(t1->level_identifier, t2->level_identifier) &&
1484           t1->level_nr == t2->level_nr);
1485 }
1486
1487 static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
1488 {
1489   *tape_to = *tape_from;
1490 }
1491
1492 static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
1493 {
1494   struct TapeInfo tmp = *t1;
1495
1496   *t1 = *t2;
1497   *t2 = tmp;
1498 }
1499
1500 static void CopyTapeToUndoBuffer(void)
1501 {
1502   // copy tapes to undo buffer if large enough (or larger than last undo tape)
1503   // or if the last undo tape is from a different level set or level number
1504   if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
1505       tape.length_seconds >= tape_undo_buffer.length_seconds ||
1506       !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1507   {
1508     CopyTape(&tape, &tape_undo_buffer);
1509   }
1510 }
1511
1512 void UndoTape(void)
1513 {
1514   // only undo tapes from same level set and with same level number
1515   if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1516     return;
1517
1518   if (!TAPE_IS_STOPPED(tape))
1519     TapeStop();
1520
1521   // swap last recorded tape with undo buffer, so undo can be reversed
1522   SwapTapes(&tape, &tape_undo_buffer);
1523
1524   DrawCompleteVideoDisplay();
1525 }
1526
1527 void FixTape_ForceSinglePlayer(void)
1528 {
1529   int i;
1530
1531   /* fix single-player tapes that contain player input for more than one
1532      player (due to a bug in 3.3.1.2 and earlier versions), which results
1533      in playing levels with more than one player in multi-player mode,
1534      even though the tape was originally recorded in single-player mode */
1535
1536   // remove player input actions for all players but the first one
1537   for (i = 1; i < MAX_PLAYERS; i++)
1538     tape.player_participates[i] = FALSE;
1539
1540   tape.changed = TRUE;
1541 }
1542
1543
1544 // ----------------------------------------------------------------------------
1545 // tape autoplay functions
1546 // ----------------------------------------------------------------------------
1547
1548 static TreeInfo *getNextValidAutoPlayEntry(TreeInfo *node)
1549 {
1550   node = getNextValidTreeInfoEntry(node);
1551
1552   while (node && node->is_copy)
1553     node = getNextValidTreeInfoEntry(node);
1554
1555   return node;
1556 }
1557
1558 static TreeInfo *getFirstValidAutoPlayEntry(TreeInfo *node)
1559 {
1560   node = getFirstValidTreeInfoEntry(node);
1561
1562   if (node && node->is_copy)
1563     return getNextValidAutoPlayEntry(node);
1564
1565   return node;
1566 }
1567
1568 static void AutoPlayTapes_SetScoreEntry(int score, int time)
1569 {
1570   char *name = (options.mytapes ? setup.player_name : options.player_name);
1571
1572   // set unique basename for score tape (for uploading to score server)
1573   strcpy(tape.score_tape_basename, getScoreTapeBasename(name));
1574
1575   // store score in first score entry
1576   scores.last_added = 0;
1577
1578   struct ScoreEntry *entry = &scores.entry[scores.last_added];
1579
1580   strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
1581   strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
1582
1583   entry->score = score;
1584   entry->time = time;
1585
1586   PrintNoLog("- uploading score tape to score server ... ");
1587
1588   server_scores.uploaded = FALSE;
1589 }
1590
1591 static boolean AutoPlayTapes_WaitForUpload(void)
1592 {
1593   DelayCounter upload_delay = { 10000 };
1594
1595   ResetDelayCounter(&upload_delay);
1596
1597   // wait for score tape to be successfully uploaded (and fail on timeout)
1598   while (!server_scores.uploaded)
1599   {
1600     if (DelayReached(&upload_delay))
1601     {
1602       PrintNoLog("\r");
1603       Print("- uploading score tape to score server - TIMEOUT.\n");
1604
1605       if (program.headless)
1606         Fail("cannot upload score tape to score server");
1607
1608       return FALSE;
1609     }
1610
1611     UPDATE_BUSY_STATE();
1612
1613     Delay(20);
1614   }
1615
1616   PrintNoLog("\r");
1617   Print("- uploading score tape to score server - uploaded.\n");
1618
1619   return TRUE;
1620 }
1621
1622 static int AutoPlayTapesExt(boolean initialize)
1623 {
1624   static struct AutoPlayInfo autoplay;
1625   static int num_tapes = 0;
1626   static int patch_nr = 0;
1627   static char *patch_name[] =
1628   {
1629     "original tape",
1630     "em_random_bug",
1631     "screen_34x34",
1632
1633     NULL
1634   };
1635   static int patch_version_first[] =
1636   {
1637     VERSION_IDENT(0,0,0,0),
1638     VERSION_IDENT(3,3,1,0),
1639     VERSION_IDENT(0,0,0,0),
1640
1641     -1
1642   };
1643   static int patch_version_last[] =
1644   {
1645     VERSION_IDENT(9,9,9,9),
1646     VERSION_IDENT(4,0,1,1),
1647     VERSION_IDENT(4,2,2,0),
1648
1649     -1
1650   };
1651   static byte patch_property_bit[] =
1652   {
1653     TAPE_PROPERTY_NONE,
1654     TAPE_PROPERTY_EM_RANDOM_BUG,
1655     TAPE_PROPERTY_NONE,
1656
1657     -1
1658   };
1659   LevelDirTree *leveldir_current_last = leveldir_current;
1660   boolean init_level_set = FALSE;
1661   int level_nr_last = level_nr;
1662   int i;
1663
1664   if (!initialize)
1665   {
1666     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1667     {
1668       if (tape.auto_play_level_solved)
1669       {
1670         if (patch_nr > 0)
1671         {
1672           // level solved by patched tape -- save fixed tape
1673           char *filename = getTapeFilename(level_nr);
1674           char *filename_orig = getStringCat2(filename, ".orig");
1675
1676           // create backup from old tape, if not yet existing
1677           if (!fileExists(filename_orig))
1678             rename(filename, filename_orig);
1679
1680           SaveTapeToFilename(filename);
1681
1682           tape.auto_play_level_fixed = TRUE;
1683           autoplay.num_tapes_patched++;
1684         }
1685
1686         // continue with next tape
1687         patch_nr = 0;
1688       }
1689       else if (patch_name[patch_nr + 1] != NULL)
1690       {
1691         // level not solved by patched tape -- continue with next patch
1692         patch_nr++;
1693       }
1694       else
1695       {
1696         // level not solved by any patched tape -- continue with next tape
1697         tape.auto_play_level_not_fixable = TRUE;
1698         patch_nr = 0;
1699       }
1700     }
1701
1702     // just finished auto-playing tape
1703     PrintTapeReplayProgress(TRUE);
1704
1705     if (options.tape_log_filename != NULL)
1706       CloseTapeLogfile();
1707
1708     if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
1709         tape.auto_play_level_solved)
1710     {
1711       AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
1712
1713       if (leveldir_current)
1714       {
1715         // the tape's level set identifier may differ from current level set
1716         strncpy(tape.level_identifier, leveldir_current->identifier,
1717                 MAX_FILENAME_LEN);
1718         tape.level_identifier[MAX_FILENAME_LEN] = '\0';
1719
1720         // the tape's level number may differ from current level number
1721         tape.level_nr = level_nr;
1722       }
1723
1724       // save score tape to upload to server; may be required for some reasons:
1725       // * level set identifier in solution tapes may differ from level set
1726       // * level set identifier is missing (old-style tape without INFO chunk)
1727       // * solution tape may have native format (like Supaplex solution files)
1728
1729       SaveScoreTape(level_nr);
1730       SaveServerScore(level_nr, TRUE);
1731
1732       AutoPlayTapes_WaitForUpload();
1733     }
1734
1735     if (patch_nr == 0)
1736       autoplay.num_levels_played++;
1737
1738     if (tape.auto_play_level_solved)
1739       autoplay.num_levels_solved++;
1740
1741     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1742       autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
1743   }
1744   else
1745   {
1746     if (strEqual(global.autoplay_leveldir, "ALL"))
1747     {
1748       autoplay.all_levelsets = TRUE;
1749
1750       // tape mass-uploading only allowed for private tapes
1751       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1752         options.mytapes = TRUE;
1753     }
1754
1755     if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
1756          global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
1757         !options.mytapes &&
1758         options.player_name == NULL)
1759     {
1760       Fail("specify player name when uploading solution tapes");
1761     }
1762
1763     if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1764       DrawCompleteVideoDisplay();
1765
1766     if (program.headless)
1767     {
1768       audio.sound_enabled = FALSE;
1769       setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1770     }
1771
1772     if (strSuffix(global.autoplay_leveldir, ".tape"))
1773     {
1774       autoplay.tape_filename = global.autoplay_leveldir;
1775
1776       if (!fileExists(autoplay.tape_filename))
1777         Fail("tape file '%s' does not exist", autoplay.tape_filename);
1778
1779       LoadTapeFromFilename(autoplay.tape_filename);
1780
1781       if (tape.no_valid_file)
1782         Fail("cannot load tape file '%s'", autoplay.tape_filename);
1783
1784       if (tape.no_info_chunk && !options.identifier)
1785         Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
1786
1787       if (tape.no_info_chunk && !options.level_nr)
1788         Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
1789
1790       global.autoplay_leveldir = tape.level_identifier;
1791
1792       if (options.identifier != NULL)
1793         global.autoplay_leveldir = options.identifier;
1794
1795       if (options.level_nr != NULL)
1796         tape.level_nr = atoi(options.level_nr);
1797
1798       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1799         global.autoplay_level[tape.level_nr] = TRUE;
1800
1801       global.autoplay_all = FALSE;
1802       options.mytapes = FALSE;
1803     }
1804
1805     if (autoplay.all_levelsets)
1806     {
1807       // start auto-playing first level set
1808       autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
1809     }
1810     else
1811     {
1812       // auto-play selected level set
1813       autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
1814                                                     global.autoplay_leveldir);
1815     }
1816
1817     if (autoplay.leveldir == NULL)
1818       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1819
1820     // only private tapes may be modified
1821     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1822       options.mytapes = TRUE;
1823
1824     // set timestamp for batch tape upload
1825     global.autoplay_time = time(NULL);
1826
1827     num_tapes = 0;
1828
1829     init_level_set = TRUE;
1830   }
1831
1832   while (1)
1833   {
1834     if (init_level_set)
1835     {
1836       leveldir_current = autoplay.leveldir;
1837
1838       if (autoplay.leveldir->first_level < 0)
1839         autoplay.leveldir->first_level = 0;
1840       if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
1841         autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
1842
1843       autoplay.level_nr = autoplay.leveldir->first_level;
1844
1845       autoplay.num_levels_played = 0;
1846       autoplay.num_levels_solved = 0;
1847       autoplay.num_tapes_patched = 0;
1848       autoplay.num_tape_missing = 0;
1849
1850       for (i = 0; i < MAX_TAPES_PER_SET; i++)
1851         autoplay.level_failed[i] = FALSE;
1852
1853       PrintTapeReplayHeader(&autoplay);
1854
1855       init_level_set = FALSE;
1856     }
1857
1858     if (autoplay.all_levelsets && global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1859     {
1860       boolean skip_levelset = FALSE;
1861
1862       if (!directoryExists(getTapeDir(autoplay.leveldir->subdir)))
1863       {
1864         Print("No tape directory for this level set found -- skipping.\n");
1865
1866         skip_levelset = TRUE;
1867       }
1868
1869       if (CheckTapeDirectoryUploadsComplete(autoplay.leveldir->subdir))
1870       {
1871         Print("All tapes for this level set already uploaded -- skipping.\n");
1872
1873         skip_levelset = TRUE;
1874       }
1875
1876       if (skip_levelset)
1877       {
1878         PrintTapeReplaySummary(&autoplay);
1879
1880         // continue with next level set
1881         autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1882
1883         // all level sets processed
1884         if (autoplay.leveldir == NULL)
1885           break;
1886
1887         init_level_set = TRUE;
1888
1889         continue;
1890       }
1891     }
1892
1893     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1894       level_nr = autoplay.level_nr++;
1895
1896     UPDATE_BUSY_STATE();
1897
1898     // check if all tapes for this level set have been processed
1899     if (level_nr > autoplay.leveldir->last_level)
1900     {
1901       PrintTapeReplaySummary(&autoplay);
1902
1903       if (!autoplay.all_levelsets)
1904         break;
1905
1906       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1907         MarkTapeDirectoryUploadsAsComplete(autoplay.leveldir->subdir);
1908
1909       // continue with next level set
1910       autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1911
1912       // all level sets processed
1913       if (autoplay.leveldir == NULL)
1914         break;
1915
1916       init_level_set = TRUE;
1917
1918       continue;
1919     }
1920
1921     // set patch info (required for progress output)
1922     strcpy(tape_patch_info, "");
1923     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1924       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1925                patch_name[patch_nr]);
1926
1927     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1928       continue;
1929
1930     // speed things up in case of missing private tapes (skip loading level)
1931     if (options.mytapes && !fileExists(getTapeFilename(level_nr)))
1932     {
1933       autoplay.num_tape_missing++;
1934
1935       Print("Tape %03d: (no tape found)\n", level_nr);
1936
1937       continue;
1938     }
1939
1940     TapeErase();
1941     TapeRewind();       // needed to reset "tape.auto_play_level_solved"
1942
1943     LoadLevel(level_nr);
1944
1945     if (level.no_level_file || level.no_valid_file)
1946     {
1947       Print("Tape %03d: (no level found)\n", level_nr);
1948
1949       continue;
1950     }
1951
1952 #if 0
1953     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1954     Print("Tape %03d: (only testing level)\n", level_nr);
1955     continue;
1956 #endif
1957
1958     if (autoplay.tape_filename)
1959       LoadTapeFromFilename(autoplay.tape_filename);
1960     else if (options.mytapes)
1961       LoadTape(level_nr);
1962     else
1963       LoadSolutionTape(level_nr);
1964
1965     if (tape.no_valid_file)
1966     {
1967       autoplay.num_tape_missing++;
1968
1969       Print("Tape %03d: (no tape found)\n", level_nr);
1970
1971       continue;
1972     }
1973
1974     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1975     {
1976       boolean skip_patch = FALSE;
1977
1978       if (tape.engine_version < patch_version_first[patch_nr] ||
1979           tape.engine_version > patch_version_last[patch_nr])
1980       {
1981         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
1982               level_nr,  tape_patch_info,
1983               tape.length_seconds / 60, tape.length_seconds % 60,
1984               "not suitable for version",
1985               (tape.engine_version / 1000000) % 100,
1986               (tape.engine_version / 10000  ) % 100,
1987               (tape.engine_version / 100    ) % 100,
1988               (tape.engine_version          ) % 100);
1989
1990         skip_patch = TRUE;
1991       }
1992
1993       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
1994           tape.num_participating_players == 1)
1995       {
1996         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
1997               level_nr,  tape_patch_info,
1998               tape.length_seconds / 60, tape.length_seconds % 60,
1999               "not suitable for single player tapes");
2000
2001         skip_patch = TRUE;
2002       }
2003
2004       if (skip_patch)
2005       {
2006         if (patch_name[patch_nr + 1] != NULL)
2007         {
2008           // continue with next patch
2009           patch_nr++;
2010         }
2011         else
2012         {
2013           // continue with next tape
2014           patch_nr = 0;
2015         }
2016
2017         continue;
2018       }
2019
2020       if (strEqual(patch_name[patch_nr], "screen_34x34"))
2021       {
2022         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
2023         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
2024       }
2025       else
2026       {
2027         tape.property_bits |= patch_property_bit[patch_nr];
2028       }
2029     }
2030
2031     num_tapes++;
2032
2033     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2034     {
2035       boolean use_temporary_tape_file = FALSE;
2036
2037       Print("Tape %03d:\n", level_nr);
2038
2039       AutoPlayTapes_SetScoreEntry(0, 0);
2040
2041       if (autoplay.tape_filename == NULL)
2042       {
2043         autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
2044                                   getDefaultSolutionTapeFilename(level_nr));
2045
2046         if (!fileExists(autoplay.tape_filename))
2047         {
2048           // non-standard or incorrect solution tape -- save to temporary file
2049           autoplay.tape_filename = getTemporaryTapeFilename();
2050
2051           SaveTapeToFilename(autoplay.tape_filename);
2052
2053           use_temporary_tape_file = TRUE;
2054         }
2055       }
2056
2057       SaveServerScoreFromFile(level_nr, TRUE, autoplay.tape_filename);
2058
2059       boolean success = AutoPlayTapes_WaitForUpload();
2060
2061       if (use_temporary_tape_file)
2062         unlink(autoplay.tape_filename);
2063
2064       // required for uploading multiple tapes
2065       autoplay.tape_filename = NULL;
2066
2067       if (!success)
2068       {
2069         num_tapes = -num_tapes;
2070
2071         break;
2072       }
2073
2074       continue;
2075     }
2076
2077     InitCounter();
2078
2079     if (options.tape_log_filename != NULL)
2080       OpenTapeLogfile();
2081
2082     TapeStartGamePlaying();
2083     TapeStartWarpForward(global.autoplay_mode);
2084
2085     autoplay.last_level_nr = level_nr;
2086
2087     return num_tapes;
2088   }
2089
2090   if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2091   {
2092     Print("\n");
2093     PrintLine("=", 79);
2094
2095     if (num_tapes >= 0)
2096       Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
2097     else
2098       Print("SUMMARY: Uploading tapes failed.\n");
2099
2100     PrintLine("=", 79);
2101   }
2102
2103   // clear timestamp for batch tape upload (required after interactive upload)
2104   global.autoplay_time = 0;
2105
2106   // exit if running headless or if visually auto-playing tapes
2107   if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
2108     CloseAllAndExit(0);
2109
2110   // when running interactively, restore last selected level set and number
2111   leveldir_current = leveldir_current_last;
2112   level_nr = level_nr_last;
2113
2114   return num_tapes;
2115 }
2116
2117 int AutoPlayTapes(void)
2118 {
2119   return AutoPlayTapesExt(TRUE);
2120 }
2121
2122 int AutoPlayTapesContinue(void)
2123 {
2124   return AutoPlayTapesExt(FALSE);
2125 }
2126
2127
2128 // ----------------------------------------------------------------------------
2129 // tape patch functions
2130 // ----------------------------------------------------------------------------
2131
2132 static boolean PatchTape(struct TapeInfo *tape, char *mode)
2133 {
2134   Print("[%d.%d.%d.%d]: ",
2135         (tape->engine_version / 1000000) % 100,
2136         (tape->engine_version / 10000  ) % 100,
2137         (tape->engine_version / 100    ) % 100,
2138         (tape->engine_version          ) % 100);
2139
2140   if (strEqual(mode, "info"))
2141   {
2142     Print("property bits == 0x%02x\n", tape->property_bits);
2143
2144     return FALSE;
2145   }
2146
2147   boolean unpatch_tape = FALSE;
2148   boolean use_property_bit = FALSE;
2149   byte property_bitmask = 0;
2150
2151   if (strSuffix(mode, ":0") ||
2152       strSuffix(mode, ":off") ||
2153       strSuffix(mode, ":clear"))
2154     unpatch_tape = TRUE;
2155
2156   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
2157   {
2158     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
2159     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
2160         tape->engine_version >= VERSION_IDENT(4,0,1,2))
2161     {
2162       Print("This tape version cannot be patched against EM random bug!\n");
2163
2164       return FALSE;
2165     }
2166
2167     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
2168
2169     use_property_bit = TRUE;
2170   }
2171   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
2172   {
2173     // this bug only affects team mode tapes
2174     if (tape->num_participating_players == 1)
2175     {
2176       Print("Only team mode tapes can be patched against screen size bug!\n");
2177
2178       return FALSE;
2179     }
2180
2181     // this bug (that always existed before) was fixed in version 4.2.2.1
2182     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
2183     {
2184       Print("This tape version cannot be patched against screen size bug!\n");
2185
2186       return FALSE;
2187     }
2188
2189     int factor = (unpatch_tape ? 1 : 2);
2190     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
2191     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
2192
2193     if (scr_fieldx_new == tape->scr_fieldx &&
2194         scr_fieldy_new == tape->scr_fieldy)
2195     {
2196       Print("Tape already patched for '%s'!\n", mode);
2197
2198       return FALSE;
2199     }
2200
2201     tape->scr_fieldx = scr_fieldx_new;
2202     tape->scr_fieldy = scr_fieldy_new;
2203   }
2204   else
2205   {
2206     Print("Unknown patch mode '%s'!\n", mode);
2207
2208     return FALSE;
2209   }
2210
2211   // patching tapes using property bits may be used for several patch modes
2212   if (use_property_bit)
2213   {
2214     byte property_bits = tape->property_bits;
2215     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
2216
2217     if (set_property_bit)
2218       property_bits |= property_bitmask;
2219     else
2220       property_bits &= ~property_bitmask;
2221
2222     if (property_bits == tape->property_bits)
2223     {
2224       Print("Tape already patched for '%s'!\n", mode);
2225
2226       return FALSE;
2227     }
2228
2229     tape->property_bits = property_bits;
2230   }
2231
2232   Print("Patching for '%s' ... ", mode);
2233
2234   return TRUE;
2235 }
2236
2237 void PatchTapes(void)
2238 {
2239   static LevelDirTree *patchtapes_leveldir = NULL;
2240   static int num_tapes_found = 0;
2241   static int num_tapes_patched = 0;
2242   char *mode = global.patchtapes_mode;
2243   int i;
2244
2245   if (strEqual(mode, "help"))
2246   {
2247     PrintLine("=", 79);
2248     Print("Supported patch modes:\n");
2249     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
2250     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
2251     PrintLine("-", 79);
2252     Print("Supported modifiers:\n");
2253     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
2254     PrintLine("=", 79);
2255
2256     CloseAllAndExit(0);
2257   }
2258
2259   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
2260                                                   global.patchtapes_leveldir);
2261
2262   if (patchtapes_leveldir == NULL)
2263     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
2264
2265   leveldir_current = patchtapes_leveldir;
2266
2267   if (patchtapes_leveldir->first_level < 0)
2268     patchtapes_leveldir->first_level = 0;
2269   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
2270     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
2271
2272   PrintLine("=", 79);
2273   Print("Patching level tapes for patch mode '%s'\n", mode);
2274   PrintLine("-", 79);
2275   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
2276   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
2277   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
2278   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
2279   PrintLine("=", 79);
2280   Print("\n");
2281
2282   int first_level = patchtapes_leveldir->first_level;
2283   int last_level = patchtapes_leveldir->last_level;
2284
2285   for (i = first_level; i <= last_level; i++)
2286   {
2287     if (!global.patchtapes_all && !global.patchtapes_level[i])
2288       continue;
2289
2290     Print("Tape %03d: ", i);
2291
2292     TapeErase();
2293     LoadTape(i);
2294
2295     if (tape.no_valid_file)
2296     {
2297       Print("(no tape found)\n");
2298
2299       continue;
2300     }
2301
2302     num_tapes_found++;
2303
2304     if (PatchTape(&tape, mode))
2305     {
2306       char *filename = getTapeFilename(i);
2307       char *filename_orig = getStringCat2(filename, ".orig");
2308
2309       if (!fileExists(filename_orig))
2310         rename(filename, filename_orig);
2311
2312       SaveTapeToFilename(filename);
2313
2314       Print("patched tape saved.\n");
2315
2316       num_tapes_patched++;
2317     }
2318   }
2319
2320   Print("\n");
2321   PrintLine("=", 79);
2322   Print("Number of tapes found: %d\n", num_tapes_found);
2323   Print("Number of tapes patched: %d\n", num_tapes_patched);
2324   PrintLine("=", 79);
2325
2326   CloseAllAndExit(0);
2327 }
2328
2329
2330 // ---------- new tape button stuff -------------------------------------------
2331
2332 static struct
2333 {
2334   int graphic;
2335   struct XY *pos;
2336   int gadget_id;
2337   char *infotext;
2338 } tapebutton_info[NUM_TAPE_BUTTONS] =
2339 {
2340   {
2341     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
2342     TAPE_CTRL_ID_EJECT,                 "eject tape"
2343   },
2344   {
2345     // (same position as "eject" button)
2346     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
2347     TAPE_CTRL_ID_EXTRA,                 "extra functions"
2348   },
2349   {
2350     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
2351     TAPE_CTRL_ID_STOP,                  "stop tape"
2352   },
2353   {
2354     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
2355     TAPE_CTRL_ID_PAUSE,                 "pause tape"
2356   },
2357   {
2358     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
2359     TAPE_CTRL_ID_RECORD,                "record tape"
2360   },
2361   {
2362     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
2363     TAPE_CTRL_ID_PLAY,                  "play tape"
2364   },
2365   {
2366     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
2367     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
2368   },
2369   {
2370     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
2371     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
2372   }
2373 };
2374
2375 void CreateTapeButtons(void)
2376 {
2377   int i;
2378
2379   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2380   {
2381     int graphic = tapebutton_info[i].graphic;
2382     struct GraphicInfo *gfx = &graphic_info[graphic];
2383     struct XY *pos = tapebutton_info[i].pos;
2384     struct GadgetInfo *gi;
2385     int gd_x = gfx->src_x;
2386     int gd_y = gfx->src_y;
2387     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
2388     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
2389     int id = i;
2390
2391     gi = CreateGadget(GDI_CUSTOM_ID, id,
2392                       GDI_IMAGE_ID, graphic,
2393                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
2394                       GDI_X, VX + pos->x,
2395                       GDI_Y, VY + pos->y,
2396                       GDI_WIDTH, gfx->width,
2397                       GDI_HEIGHT, gfx->height,
2398                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
2399                       GDI_STATE, GD_BUTTON_UNPRESSED,
2400                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
2401                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
2402                       GDI_DIRECT_DRAW, FALSE,
2403                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
2404                       GDI_CALLBACK_ACTION, HandleTapeButtons,
2405                       GDI_END);
2406
2407     if (gi == NULL)
2408       Fail("cannot create gadget");
2409
2410     tape_gadget[id] = gi;
2411   }
2412 }
2413
2414 void FreeTapeButtons(void)
2415 {
2416   int i;
2417
2418   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2419     FreeGadget(tape_gadget[i]);
2420 }
2421
2422 void MapTapeEjectButton(void)
2423 {
2424   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2425   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2426 }
2427
2428 void MapTapeWarpButton(void)
2429 {
2430   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2431   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2432 }
2433
2434 void MapTapeButtons(void)
2435 {
2436   int i;
2437
2438   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2439     if (i != TAPE_CTRL_ID_EXTRA)
2440       MapGadget(tape_gadget[i]);
2441
2442   if (tape.recording || tape.playing)
2443     MapTapeWarpButton();
2444
2445   if (tape.show_game_buttons)
2446     MapGameButtonsOnTape();
2447 }
2448
2449 void UnmapTapeButtons(void)
2450 {
2451   int i;
2452
2453   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2454     UnmapGadget(tape_gadget[i]);
2455
2456   if (tape.show_game_buttons)
2457     UnmapGameButtonsOnTape();
2458 }
2459
2460 void RedrawTapeButtons(void)
2461 {
2462   int i;
2463
2464   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2465     RedrawGadget(tape_gadget[i]);
2466
2467   if (tape.show_game_buttons)
2468     RedrawGameButtonsOnTape();
2469 }
2470
2471 void RedrawOrRemapTapeButtons(void)
2472 {
2473   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
2474   {
2475     // tape buttons already mapped
2476     RedrawTapeButtons();
2477   }
2478   else
2479   {
2480     UnmapTapeButtons();
2481     MapTapeButtons();
2482   }
2483 }
2484
2485 static void HandleTapeButtonsExt(int id)
2486 {
2487   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
2488     return;
2489
2490   switch (id)
2491   {
2492     case TAPE_CTRL_ID_EJECT:
2493       TapeStop();
2494
2495       if (TAPE_IS_EMPTY(tape))
2496       {
2497         LoadTape(level_nr);
2498
2499         if (TAPE_IS_EMPTY(tape))
2500           Request("No tape for this level!", REQ_CONFIRM);
2501       }
2502       else
2503       {
2504         if (tape.changed)
2505           SaveTapeChecked(level_nr);
2506
2507         TapeErase();
2508       }
2509
2510       DrawCompleteVideoDisplay();
2511       break;
2512
2513     case TAPE_CTRL_ID_EXTRA:
2514       if (tape.playing)
2515       {
2516         tape.pause_before_end = !tape.pause_before_end;
2517
2518         DrawVideoDisplayCurrentState();
2519       }
2520       else if (tape.recording)
2521       {
2522         TapeSingleStep();
2523       }
2524
2525       break;
2526
2527     case TAPE_CTRL_ID_STOP:
2528       TapeStopTape();
2529
2530       break;
2531
2532     case TAPE_CTRL_ID_PAUSE:
2533       TapeTogglePause(TAPE_TOGGLE_MANUAL);
2534
2535       break;
2536
2537     case TAPE_CTRL_ID_RECORD:
2538       if (TAPE_IS_STOPPED(tape))
2539       {
2540         TapeStartGameRecording();
2541       }
2542       else if (tape.pausing)
2543       {
2544         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
2545           TapeAppendRecording();
2546         else
2547           TapeTogglePause(TAPE_TOGGLE_MANUAL);
2548       }
2549
2550       break;
2551
2552     case TAPE_CTRL_ID_PLAY:
2553       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
2554       {
2555         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
2556
2557         TapeTogglePause(TAPE_TOGGLE_MANUAL);
2558       }
2559
2560       if (TAPE_IS_EMPTY(tape))
2561         break;
2562
2563       if (TAPE_IS_STOPPED(tape))
2564       {
2565         TapeStartGamePlaying();
2566       }
2567       else if (tape.playing)
2568       {
2569         if (tape.pausing)                       // PAUSE -> PLAY
2570         {
2571           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
2572         }
2573         else if (!tape.fast_forward)            // PLAY -> FFWD
2574         {
2575           tape.fast_forward = TRUE;
2576         }
2577         else if (!tape.warp_forward)            // FFWD -> WARP
2578         {
2579           tape.warp_forward = TRUE;
2580         }
2581         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
2582         {
2583           tape.deactivate_display = TRUE;
2584
2585           TapeDeactivateDisplayOn();
2586         }
2587         else                                    // WARP BLIND -> PLAY
2588         {
2589           tape.fast_forward = FALSE;
2590           tape.warp_forward = FALSE;
2591           tape.deactivate_display = FALSE;
2592
2593           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2594         }
2595
2596         DrawVideoDisplayCurrentState();
2597       }
2598
2599       break;
2600
2601     case TAPE_CTRL_ID_INSERT_SOLUTION:
2602       InsertSolutionTape();
2603
2604       break;
2605
2606     case TAPE_CTRL_ID_PLAY_SOLUTION:
2607       PlaySolutionTape();
2608
2609       break;
2610
2611     default:
2612       break;
2613   }
2614 }
2615
2616 static void HandleTapeButtons(struct GadgetInfo *gi)
2617 {
2618   HandleTapeButtonsExt(gi->custom_id);
2619 }
2620
2621 void HandleTapeButtonKeys(Key key)
2622 {
2623   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2624   boolean extra_button_is_active = !eject_button_is_active;
2625
2626   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2627     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2628   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2629     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2630   else if (key == setup.shortcut.tape_stop)
2631     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2632   else if (key == setup.shortcut.tape_pause)
2633     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2634   else if (key == setup.shortcut.tape_record)
2635     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2636   else if (key == setup.shortcut.tape_play)
2637     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2638 }