added creating engine snapshots when using mouse click events
[rocksndiamonds.git] / src / tape.c
index 6ff1aa5c929dd5ca911ac2aa3f207cf30526fe63..9f815143eddb3c67a6430f6f603d6db9a35e0ad6 100644 (file)
 
 // values for tape handling
 #define TAPE_PAUSE_SECONDS_BEFORE_DEATH                5
+#define TAPE_MIN_SECONDS_FOR_UNDO_BUFFER       20
 
 // forward declaration for internal use
 static void HandleTapeButtons(struct GadgetInfo *);
 static void TapeStopWarpForward(void);
 static float GetTapeLengthSecondsFloat(void);
+static void CopyTapeToUndoBuffer(void);
 
 static struct GadgetInfo *tape_gadget[NUM_TAPE_BUTTONS];
+static struct TapeInfo tape_undo_buffer;
 
 
 // ============================================================================
@@ -465,6 +468,8 @@ void TapeDeactivateDisplayOff(boolean redraw_display)
 // tape logging functions
 // ============================================================================
 
+static char tape_patch_info[MAX_OUTPUT_LINESIZE];
+
 static void PrintTapeReplayProgress(boolean replay_finished)
 {
   static unsigned int counter_last = -1;
@@ -478,8 +483,9 @@ static void PrintTapeReplayProgress(boolean replay_finished)
     if (counter > counter_last + counter_delay)
     {
       PrintNoLog("\r");
-      PrintNoLog("Tape %03d [%02d:%02d]: [%02d:%02d] - playing tape ... ",
-                level_nr, tape.length_seconds / 60, tape.length_seconds % 60,
+      PrintNoLog("Tape %03d %s[%02d:%02d]: [%02d:%02d] - playing tape ... ",
+                level_nr,  tape_patch_info,
+                tape.length_seconds / 60, tape.length_seconds % 60,
                 TapeTime / 60, TapeTime % 60);
 
       counter_last = counter;
@@ -490,11 +496,15 @@ static void PrintTapeReplayProgress(boolean replay_finished)
     float tape_length_seconds = GetTapeLengthSecondsFloat();
 
     PrintNoLog("\r");
-    Print("Tape %03d [%02d:%02d]: (%02d:%02d.%03d / %.2f %%) - %s.\n",
-         level_nr, tape.length_seconds / 60, tape.length_seconds % 60,
+    Print("Tape %03d %s[%02d:%02d]: (%02d:%02d.%03d / %.2f %%) - %s.\n",
+         level_nr, tape_patch_info,
+         tape.length_seconds / 60, tape.length_seconds % 60,
          counter_seconds / 60, counter_seconds % 60, counter % 1000,
          (float)counter / tape_length_seconds / 10,
-         tape.auto_play_level_solved ? "solved" : "NOT SOLVED");
+         tape.auto_play_level_fixed ? "solved and fixed" :
+         tape.auto_play_level_solved ? "solved" :
+         tape.auto_play_level_not_fixable ? "NOT SOLVED, NOT FIXED" :
+         "NOT SOLVED");
 
     counter_last = -1;
   }
@@ -521,6 +531,8 @@ void TapeErase(void)
 {
   int i;
 
+  CopyTapeToUndoBuffer();
+
   tape.counter = 0;
   tape.length = 0;
   tape.length_frames = 0;
@@ -564,6 +576,8 @@ static void TapeRewind(void)
   tape.deactivate_display = FALSE;
   tape.auto_play = (global.autoplay_leveldir != NULL);
   tape.auto_play_level_solved = FALSE;
+  tape.auto_play_level_fixed = FALSE;
+  tape.auto_play_level_not_fixable = FALSE;
   tape.quick_resume = FALSE;
   tape.single_step = FALSE;
 
@@ -880,10 +894,10 @@ byte *TapePlayAction(void)
     action[i] = tape.pos[tape.counter].action[i];
 
 #if DEBUG_TAPE_WHEN_PLAYING
-  printf("%05d", FrameCounter);
+  DebugContinued("", "%05d", FrameCounter);
   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
-    printf("   %08x", action[i]);
-  printf("\n");
+    DebugContinued("", "   %08x", action[i]);
+  DebugContinued("tape:play", "\n");
 #endif
 
   tape.set_centered_player = FALSE;
@@ -1136,6 +1150,73 @@ boolean PlaySolutionTape(void)
   return TRUE;
 }
 
+static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
+{
+  return (strEqual(t1->level_identifier, t2->level_identifier) &&
+         t1->level_nr == t2->level_nr);
+}
+
+static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
+{
+  if (tape_to->level_identifier != NULL)
+    checked_free(tape_to->level_identifier);
+
+  *tape_to = *tape_from;
+
+  tape_to->level_identifier = getStringCopy(tape_from->level_identifier);
+}
+
+static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
+{
+  struct TapeInfo tmp = *t1;
+
+  *t1 = *t2;
+  *t2 = tmp;
+}
+
+static void CopyTapeToUndoBuffer(void)
+{
+  // copy tapes to undo buffer if large enough (or larger than last undo tape)
+  // or if the last undo tape is from a different level set or level number
+  if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
+      tape.length_seconds >= tape_undo_buffer.length_seconds ||
+      !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
+  {
+    CopyTape(&tape, &tape_undo_buffer);
+  }
+}
+
+void UndoTape(void)
+{
+  // only undo tapes from same level set and with same level number
+  if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
+    return;
+
+  if (!TAPE_IS_STOPPED(tape))
+    TapeStop();
+
+  // swap last recorded tape with undo buffer, so undo can be reversed
+  SwapTapes(&tape, &tape_undo_buffer);
+
+  DrawCompleteVideoDisplay();
+}
+
+void FixTape_ForceSinglePlayer(void)
+{
+  int i;
+
+  /* fix single-player tapes that contain player input for more than one
+     player (due to a bug in 3.3.1.2 and earlier versions), which results
+     in playing levels with more than one player in multi-player mode,
+     even though the tape was originally recorded in single-player mode */
+
+  // remove player input actions for all players but the first one
+  for (i = 1; i < MAX_PLAYERS; i++)
+    tape.player_participates[i] = FALSE;
+
+  tape.changed = TRUE;
+}
+
 
 // ----------------------------------------------------------------------------
 // tape autoplay functions
@@ -1148,21 +1229,89 @@ void AutoPlayTapes(void)
   static int autoplay_level_nr = -1;
   static int num_levels_played = 0;
   static int num_levels_solved = 0;
+  static int num_tapes_patched = 0;
   static int num_tape_missing = 0;
   static boolean level_failed[MAX_TAPES_PER_SET];
+  static int patch_nr = 0;
+  static char *patch_name[] =
+  {
+    "original tape",
+    "em_random_bug",
+
+    NULL
+  };
+  static int patch_version_first[] =
+  {
+    VERSION_IDENT(0,0,0,0),
+    VERSION_IDENT(3,3,1,0),
+
+    -1
+  };
+  static int patch_version_last[] =
+  {
+    VERSION_IDENT(9,9,9,9),
+    VERSION_IDENT(4,0,1,1),
+
+    -1
+  };
+  static byte patch_property_bit[] =
+  {
+    TAPE_PROPERTY_NONE,
+    TAPE_PROPERTY_EM_RANDOM_BUG,
+
+    -1
+  };
   int i;
 
   if (autoplay_initialized)
   {
+    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    {
+      if (tape.auto_play_level_solved)
+      {
+       if (patch_nr > 0)
+       {
+         // level solved by patched tape -- save fixed tape
+         char *filename = getTapeFilename(level_nr);
+         char *filename_orig = getStringCat2(filename, ".orig");
+
+         // create backup from old tape, if not yet existing
+         if (!fileExists(filename_orig))
+           rename(filename, filename_orig);
+
+         SaveTapeToFilename(filename);
+
+         tape.auto_play_level_fixed = TRUE;
+         num_tapes_patched++;
+       }
+
+       // continue with next tape
+       patch_nr = 0;
+      }
+      else if (patch_name[patch_nr + 1] != NULL)
+      {
+       // level not solved by patched tape -- continue with next patch
+       patch_nr++;
+      }
+      else
+      {
+       // level not solved by any patched tape -- continue with next tape
+       tape.auto_play_level_not_fixable = TRUE;
+       patch_nr = 0;
+      }
+    }
+
     // just finished auto-playing tape
     PrintTapeReplayProgress(TRUE);
 
-    num_levels_played++;
+    if (patch_nr == 0)
+      num_levels_played++;
 
     if (tape.auto_play_level_solved)
       num_levels_solved++;
-    else if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
-      level_failed[level_nr] = TRUE;
+
+    if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
+      level_failed[level_nr] = !tape.auto_play_level_solved;
   }
   else
   {
@@ -1175,8 +1324,7 @@ void AutoPlayTapes(void)
                                                  global.autoplay_leveldir);
 
     if (autoplay_leveldir == NULL)
-      Error(ERR_EXIT, "no such level identifier: '%s'",
-           global.autoplay_leveldir);
+      Fail("no such level identifier: '%s'", global.autoplay_leveldir);
 
     leveldir_current = autoplay_leveldir;
 
@@ -1188,7 +1336,10 @@ void AutoPlayTapes(void)
     autoplay_level_nr = autoplay_leveldir->first_level;
 
     PrintLine("=", 79);
-    Print("Automatically playing level tapes\n");
+    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+      Print("Automatically fixing level tapes\n");
+    else
+      Print("Automatically playing level tapes\n");
     PrintLine("-", 79);
     Print("Level series identifier: '%s'\n", autoplay_leveldir->identifier);
     Print("Level series name:       '%s'\n", autoplay_leveldir->name);
@@ -1200,32 +1351,44 @@ void AutoPlayTapes(void)
     for (i = 0; i < MAX_TAPES_PER_SET; i++)
       level_failed[i] = FALSE;
 
+    // only private tapes may be modified
+    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+      options.mytapes = TRUE;
+
     autoplay_initialized = TRUE;
   }
 
-  while (autoplay_level_nr <= autoplay_leveldir->last_level)
+  while (1)
   {
-    level_nr = autoplay_level_nr++;
+    if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
+      level_nr = autoplay_level_nr++;
+
+    if (level_nr > autoplay_leveldir->last_level)
+      break;
+
+    // set patch info (required for progress output)
+    strcpy(tape_patch_info, "");
+    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+      snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
+              patch_name[patch_nr]);
 
     if (!global.autoplay_all && !global.autoplay_level[level_nr])
       continue;
 
-    Print("Tape %03d: ", level_nr);
-
     TapeErase();
 
     LoadLevel(level_nr);
 
     if (level.no_level_file || level.no_valid_file)
     {
-      Print("(no level)\n");
+      Print("Tape %03d: (no level found)\n", level_nr);
 
       continue;
     }
 
 #if 0
     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
-    Print("(only testing level)\n");
+    Print("Tape %03d: (only testing level)\n", level_nr);
     continue;
 #endif
 
@@ -1238,11 +1401,42 @@ void AutoPlayTapes(void)
     {
       num_tape_missing++;
 
-      Print("(not found)\n");
+      Print("Tape %03d: (no tape found)\n", level_nr);
 
       continue;
     }
 
+    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    {
+      if (tape.engine_version < patch_version_first[patch_nr] ||
+         tape.engine_version > patch_version_last[patch_nr])
+      {
+       Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
+             level_nr,  tape_patch_info,
+             tape.length_seconds / 60, tape.length_seconds % 60,
+             "not suitable for version",
+             (tape.engine_version / 1000000) % 100,
+             (tape.engine_version / 10000  ) % 100,
+             (tape.engine_version / 100    ) % 100,
+             (tape.engine_version          ) % 100);
+
+       if (patch_name[patch_nr + 1] != NULL)
+       {
+         // continue with next patch
+         patch_nr++;
+       }
+       else
+       {
+         // continue with next tape
+         patch_nr = 0;
+       }
+
+       continue;
+      }
+
+      tape.property_bits |= patch_property_bit[patch_nr];
+    }
+
     InitCounter();
 
     TapeStartGamePlaying();
@@ -1256,6 +1450,8 @@ void AutoPlayTapes(void)
   Print("Number of levels played: %d\n", num_levels_played);
   Print("Number of levels solved: %d (%d%%)\n", num_levels_solved,
        (num_levels_played ? num_levels_solved * 100 / num_levels_played : 0));
+  if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    Print("Number of tapes fixed: %d\n", num_tapes_patched);
   PrintLine("-", 79);
   Print("Summary (for automatic parsing by scripts):\n");
   Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
@@ -1370,8 +1566,7 @@ void PatchTapes(void)
                                                  global.patchtapes_leveldir);
 
   if (patchtapes_leveldir == NULL)
-    Error(ERR_EXIT, "no such level identifier: '%s'",
-         global.patchtapes_leveldir);
+    Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
 
   leveldir_current = patchtapes_leveldir;
 
@@ -1405,7 +1600,7 @@ void PatchTapes(void)
 
     if (tape.no_valid_file)
     {
-      Print("(not found)\n");
+      Print("(no tape found)\n");
 
       continue;
     }
@@ -1516,7 +1711,7 @@ void CreateTapeButtons(void)
                      GDI_END);
 
     if (gi == NULL)
-      Error(ERR_EXIT, "cannot create gadget");
+      Fail("cannot create gadget");
 
     tape_gadget[id] = gi;
   }