added saving non-standard solution tape to temporary file before uploading
[rocksndiamonds.git] / src / tape.c
index ac96ef96aa09e4721dc7c6f3e181b2356bdb951f..21a5945bc92b0519016e7029547ca96f8d5187d2 100644 (file)
@@ -312,7 +312,8 @@ static void DrawVideoDisplay_DateTime(unsigned int state, unsigned int value)
       char s[MAX_DATETIME_STRING_SIZE];
       int year2 = value / 10000;
       int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
-      int month_index = (value / 100) % 100;
+      int month_index_raw = (value / 100) % 100;
+      int month_index = month_index_raw % 12;  // prevent invalid index
       int month = month_index + 1;
       int day = value % 100;
 
@@ -459,6 +460,8 @@ void TapeDeactivateDisplayOff(boolean redraw_display)
   if (redraw_display)
   {
     RedrawPlayfield();
+
+    UpdateGameDoorValues();
     DrawGameDoorValues();
   }
 }
@@ -510,6 +513,27 @@ static void PrintTapeReplayProgress(boolean replay_finished)
   }
 }
 
+static FILE *tape_log_file;
+
+static void OpenTapeLogfile(void)
+{
+  if (!(tape_log_file = fopen(options.tape_log_filename, MODE_WRITE)))
+    Warn("cannot write tape logfile '%s'", options.tape_log_filename);
+}
+
+static void WriteTapeLogfile(byte action[MAX_TAPE_ACTIONS])
+{
+  int i;
+
+  for (i = 0; i < MAX_TAPE_ACTIONS; i++)
+    putFile8Bit(tape_log_file, action[i]);
+}
+
+static void CloseTapeLogfile(void)
+{
+  fclose(tape_log_file);
+}
+
 
 // ============================================================================
 // tape control functions
@@ -538,8 +562,14 @@ void TapeErase(void)
   tape.length_frames = 0;
   tape.length_seconds = 0;
 
+  tape.score_tape_basename[0] = '\0';
+
   if (leveldir_current)
-    setString(&tape.level_identifier, leveldir_current->identifier);
+  {
+    strncpy(tape.level_identifier, leveldir_current->identifier,
+           MAX_FILENAME_LEN);
+    tape.level_identifier[MAX_FILENAME_LEN] = '\0';
+  }
 
   tape.level_nr = level_nr;
   tape.pos[tape.counter].delay = 0;
@@ -551,6 +581,8 @@ void TapeErase(void)
   tape.game_version = GAME_VERSION_ACTUAL;
   tape.engine_version = level.game_version;
 
+  tape.property_bits = TAPE_PROPERTY_NONE;
+
   TapeSetDateFromNow();
 
   for (i = 0; i < MAX_PLAYERS; i++)
@@ -642,6 +674,8 @@ static void TapeAppendRecording(void)
   // set current delay (for last played move)
   tape.pos[tape.counter].delay = tape.delay_played;
 
+  tape.property_bits |= TAPE_PROPERTY_REPLAYED;
+
   // set current date
   TapeSetDateFromNow();
 
@@ -732,6 +766,12 @@ void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
     tape.set_centered_player = FALSE;
   }
 
+  if (GameFrameDelay != GAME_FRAME_DELAY)
+    tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
+
+  if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
+    tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
+
   if (!TapeAddAction(action))
     TapeStopRecording();
 }
@@ -753,6 +793,12 @@ void TapeTogglePause(boolean toggle_mode)
   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
     tape.single_step = FALSE;
 
+  if (tape.single_step)
+    tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
+
+  if (tape.pausing)
+    tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
+
   DrawVideoDisplayCurrentState();
 
   if (tape.deactivate_display)
@@ -782,12 +828,14 @@ void TapeTogglePause(boolean toggle_mode)
 
   if (game_status == GAME_MODE_PLAYING)
   {
-    if (setup.show_snapshot_buttons && CheckEngineSnapshotList())
+    if (setup.show_load_save_buttons &&
+       setup.show_undo_redo_buttons &&
+       CheckEngineSnapshotList())
     {
       if (tape.pausing)
        MapUndoRedoButtons();
       else if (!tape.single_step)
-       UnmapUndoRedoButtons();
+       MapLoadSaveButtons();
     }
 
     ModifyPauseButtons();
@@ -894,10 +942,10 @@ byte *TapePlayAction(void)
     action[i] = tape.pos[tape.counter].action[i];
 
 #if DEBUG_TAPE_WHEN_PLAYING
-  Print("%05d", FrameCounter);
+  DebugContinued("", "%05d", FrameCounter);
   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
-    Print("   %08x", action[i]);
-  Print("\n");
+    DebugContinued("", "   %08x", action[i]);
+  DebugContinued("tape:play", "\n");
 #endif
 
   tape.set_centered_player = FALSE;
@@ -928,6 +976,9 @@ byte *TapePlayAction(void)
   if (tape.auto_play)
     PrintTapeReplayProgress(FALSE);
 
+  if (options.tape_log_filename != NULL)
+    WriteTapeLogfile(action);
+
   return action;
 }
 
@@ -955,7 +1006,7 @@ unsigned int GetTapeLengthFrames(void)
   int i;
 
   if (TAPE_IS_EMPTY(tape))
-    return(0);
+    return 0;
 
   for (i = 0; i < tape.length; i++)
     tape_length_frames += tape.pos[i].delay;
@@ -1035,6 +1086,8 @@ void TapeQuickSave(void)
     return;
   }
 
+  tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
+
   if (SaveTapeChecked(tape.level_nr))
     SaveEngineSnapshotSingle();
 }
@@ -1093,6 +1146,7 @@ void TapeQuickLoad(void)
     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
 
     tape.quick_resume = TRUE;
+    tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
   }
   else // this should not happen (basically checked above)
   {
@@ -1158,12 +1212,7 @@ static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
 
 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)
@@ -1222,21 +1271,70 @@ void FixTape_ForceSinglePlayer(void)
 // tape autoplay functions
 // ----------------------------------------------------------------------------
 
+static void AutoPlayTapes_SetScoreEntry(int score, int time)
+{
+  // set unique basename for score tape (for uploading to score server)
+  strcpy(tape.score_tape_basename, getScoreTapeBasename(setup.player_name));
+
+  // store score in first score entry
+  scores.last_added = 0;
+
+  struct ScoreEntry *entry = &scores.entry[scores.last_added];
+
+  strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
+  strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
+
+  entry->score = score;
+  entry->time = time;
+
+  PrintNoLog("- uploading score tape to score server ... ");
+
+  server_scores.uploaded = FALSE;
+}
+
+static void AutoPlayTapes_WaitForUpload(void)
+{
+  unsigned int upload_delay = 0;
+  unsigned int upload_delay_value = 10000;
+
+  ResetDelayCounter(&upload_delay);
+
+  // wait for score tape to be successfully uploaded (and fail on timeout)
+  while (!server_scores.uploaded)
+  {
+    if (DelayReached(&upload_delay, upload_delay_value))
+    {
+      PrintNoLog("\r");
+      Print("- uploading score tape to score server - TIMEOUT.\n");
+
+      Fail("cannot upload score tape to score server");
+    }
+
+    Delay(20);
+  }
+
+  PrintNoLog("\r");
+  Print("- uploading score tape to score server - uploaded.\n");
+}
+
 void AutoPlayTapes(void)
 {
   static LevelDirTree *autoplay_leveldir = NULL;
   static boolean autoplay_initialized = FALSE;
+  static int autoplay_last_level_nr = -1;
   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 char *tape_filename = NULL;
   static int patch_nr = 0;
   static char *patch_name[] =
   {
     "original tape",
     "em_random_bug",
+    "screen_34x34",
 
     NULL
   };
@@ -1244,6 +1342,7 @@ void AutoPlayTapes(void)
   {
     VERSION_IDENT(0,0,0,0),
     VERSION_IDENT(3,3,1,0),
+    VERSION_IDENT(0,0,0,0),
 
     -1
   };
@@ -1251,6 +1350,7 @@ void AutoPlayTapes(void)
   {
     VERSION_IDENT(9,9,9,9),
     VERSION_IDENT(4,0,1,1),
+    VERSION_IDENT(4,2,2,0),
 
     -1
   };
@@ -1258,6 +1358,7 @@ void AutoPlayTapes(void)
   {
     TAPE_PROPERTY_NONE,
     TAPE_PROPERTY_EM_RANDOM_BUG,
+    TAPE_PROPERTY_NONE,
 
     -1
   };
@@ -1304,6 +1405,35 @@ void AutoPlayTapes(void)
     // just finished auto-playing tape
     PrintTapeReplayProgress(TRUE);
 
+    if (options.tape_log_filename != NULL)
+      CloseTapeLogfile();
+
+    if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
+       tape.auto_play_level_solved)
+    {
+      AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
+
+      if (leveldir_current)
+      {
+       // the tape's level set identifier may differ from current level set
+       strncpy(tape.level_identifier, leveldir_current->identifier,
+               MAX_FILENAME_LEN);
+       tape.level_identifier[MAX_FILENAME_LEN] = '\0';
+
+       // the tape's level number may differ from current level number
+       tape.level_nr = level_nr;
+      }
+
+      // save score tape to upload to server; may be required for some reasons:
+      // * level set identifier in solution tapes may differ from level set
+      // * solution tape may have native format (like Supaplex solution files)
+
+      SaveScoreTape(level_nr);
+      SaveServerScore(level_nr);
+
+      AutoPlayTapes_WaitForUpload();
+    }
+
     if (patch_nr == 0)
       num_levels_played++;
 
@@ -1315,11 +1445,41 @@ void AutoPlayTapes(void)
   }
   else
   {
+    if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
+        global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
+       !options.mytapes &&
+       options.player_name == NULL)
+    {
+      Fail("specify player name when uploading solution tapes");
+    }
+
     DrawCompleteVideoDisplay();
 
     audio.sound_enabled = FALSE;
     setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
 
+    if (strSuffix(global.autoplay_leveldir, ".tape"))
+    {
+      tape_filename = global.autoplay_leveldir;
+
+      LoadTapeFromFilename(tape_filename);
+
+      if (tape.no_valid_file)
+      {
+       if (!fileExists(tape_filename))
+         Fail("tape file '%s' does not exist", tape_filename);
+       else
+         Fail("cannot load tape file '%s'", tape_filename);
+      }
+
+      global.autoplay_leveldir = tape.level_identifier;
+
+      if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
+        global.autoplay_level[tape.level_nr] = TRUE;
+
+      global.autoplay_all = FALSE;
+    }
+
     autoplay_leveldir = getTreeInfoFromIdentifier(leveldir_first,
                                                  global.autoplay_leveldir);
 
@@ -1338,6 +1498,8 @@ void AutoPlayTapes(void)
     PrintLine("=", 79);
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
       Print("Automatically fixing level tapes\n");
+    else if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+      Print("Automatically uploading level tapes\n");
     else
       Print("Automatically playing level tapes\n");
     PrintLine("-", 79);
@@ -1392,7 +1554,9 @@ void AutoPlayTapes(void)
     continue;
 #endif
 
-    if (options.mytapes)
+    if (tape_filename)
+      LoadTapeFromFilename(tape_filename);
+    else if (options.mytapes)
       LoadTape(level_nr);
     else
       LoadSolutionTape(level_nr);
@@ -1408,6 +1572,8 @@ void AutoPlayTapes(void)
 
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
     {
+      boolean skip_patch = FALSE;
+
       if (tape.engine_version < patch_version_first[patch_nr] ||
          tape.engine_version > patch_version_last[patch_nr])
       {
@@ -1420,6 +1586,22 @@ void AutoPlayTapes(void)
              (tape.engine_version / 100    ) % 100,
              (tape.engine_version          ) % 100);
 
+       skip_patch = TRUE;
+      }
+
+      if (strEqual(patch_name[patch_nr], "screen_34x34") &&
+         tape.num_participating_players == 1)
+      {
+       Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
+             level_nr,  tape_patch_info,
+             tape.length_seconds / 60, tape.length_seconds % 60,
+             "not suitable for single player tapes");
+
+       skip_patch = TRUE;
+      }
+
+      if (skip_patch)
+      {
        if (patch_name[patch_nr + 1] != NULL)
        {
          // continue with next patch
@@ -1434,17 +1616,72 @@ void AutoPlayTapes(void)
        continue;
       }
 
-      tape.property_bits |= patch_property_bit[patch_nr];
+      if (strEqual(patch_name[patch_nr], "screen_34x34"))
+      {
+       tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
+       tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
+      }
+      else
+      {
+       tape.property_bits |= patch_property_bit[patch_nr];
+      }
+    }
+
+    if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+    {
+      boolean use_temporary_tape_file = FALSE;
+
+      Print("Tape %03d:\n", level_nr);
+
+      AutoPlayTapes_SetScoreEntry(0, 0);
+
+      if (tape_filename == NULL)
+      {
+       tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
+                        getDefaultSolutionTapeFilename(level_nr));
+
+       if (!fileExists(tape_filename))
+       {
+         // non-standard solution tape -- save to temporary file
+         tape_filename = getTemporaryTapeFilename();
+
+         SaveTapeToFilename(tape_filename);
+
+         use_temporary_tape_file = TRUE;
+       }
+      }
+
+      SaveServerScoreFromFile(level_nr, tape_filename);
+
+      AutoPlayTapes_WaitForUpload();
+
+      if (use_temporary_tape_file)
+        unlink(tape_filename);
+
+      // required for uploading multiple tapes
+      tape_filename = NULL;
+
+      continue;
     }
 
     InitCounter();
 
+    if (options.tape_log_filename != NULL)
+      OpenTapeLogfile();
+
     TapeStartGamePlaying();
     TapeStartWarpForward(global.autoplay_mode);
 
+    autoplay_last_level_nr = level_nr;
+
     return;
   }
 
+  char *autoplay_status = (num_levels_played == num_levels_solved &&
+                          num_levels_played > 0 ? " OK " : "WARN");
+  int autoplay_percent = (num_levels_played ?
+                         num_levels_solved * 100 / num_levels_played : 0);
+
   Print("\n");
   PrintLine("=", 79);
   Print("Number of levels played: %d\n", num_levels_played);
@@ -1454,17 +1691,32 @@ void AutoPlayTapes(void)
     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%%)",
-       (num_levels_played == num_levels_solved ? " OK " : "WARN"),
-       autoplay_leveldir->identifier, num_levels_solved, num_levels_played,
-       (num_levels_played ? num_levels_solved * 100 / num_levels_played : 0));
 
-  if (num_levels_played != num_levels_solved)
+  if (tape_filename)
   {
-    Print(", FAILED:");
-    for (i = 0; i < MAX_TAPES_PER_SET; i++)
-      if (level_failed[i])
-       Print(" %03d", i);
+    Print("TAPEFILE [%s] '%s', %d, %d, %d",
+         autoplay_status,
+         autoplay_leveldir->identifier,
+         autoplay_last_level_nr,
+         game.score_final,
+         game.score_time_final);
+  }
+  else
+  {
+    Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
+         autoplay_status,
+         autoplay_leveldir->identifier,
+         num_levels_solved,
+         num_levels_played,
+         autoplay_percent);
+
+    if (num_levels_played != num_levels_solved)
+    {
+      Print(", FAILED:");
+      for (i = 0; i < MAX_TAPES_PER_SET; i++)
+       if (level_failed[i])
+         Print(" %03d", i);
+    }
   }
 
   Print("\n");
@@ -1493,14 +1745,14 @@ static boolean PatchTape(struct TapeInfo *tape, char *mode)
     return FALSE;
   }
 
-  byte property_bits = tape->property_bits;
+  boolean unpatch_tape = FALSE;
+  boolean use_property_bit = FALSE;
   byte property_bitmask = 0;
-  boolean set_property_bit = TRUE;
 
   if (strSuffix(mode, ":0") ||
       strSuffix(mode, ":off") ||
       strSuffix(mode, ":clear"))
-    set_property_bit = FALSE;
+    unpatch_tape = TRUE;
 
   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
   {
@@ -1514,6 +1766,41 @@ static boolean PatchTape(struct TapeInfo *tape, char *mode)
     }
 
     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
+
+    use_property_bit = TRUE;
+  }
+  else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
+  {
+    // this bug only affects team mode tapes
+    if (tape->num_participating_players == 1)
+    {
+      Print("Only team mode tapes can be patched against screen size bug!\n");
+
+      return FALSE;
+    }
+
+    // this bug (that always existed before) was fixed in version 4.2.2.1
+    if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
+    {
+      Print("This tape version cannot be patched against screen size bug!\n");
+
+      return FALSE;
+    }
+
+    int factor = (unpatch_tape ? 1 : 2);
+    int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
+    int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
+
+    if (scr_fieldx_new == tape->scr_fieldx &&
+       scr_fieldy_new == tape->scr_fieldy)
+    {
+      Print("Tape already patched for '%s'!\n", mode);
+
+      return FALSE;
+    }
+
+    tape->scr_fieldx = scr_fieldx_new;
+    tape->scr_fieldy = scr_fieldy_new;
   }
   else
   {
@@ -1522,22 +1809,29 @@ static boolean PatchTape(struct TapeInfo *tape, char *mode)
     return FALSE;
   }
 
-  if (set_property_bit)
-    property_bits |= property_bitmask;
-  else
-    property_bits &= ~property_bitmask;
-
-  if (property_bits == tape->property_bits)
+  // patching tapes using property bits may be used for several patch modes
+  if (use_property_bit)
   {
-    Print("Tape already patched for '%s'!\n", mode);
+    byte property_bits = tape->property_bits;
+    boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
 
-    return FALSE;
+    if (set_property_bit)
+      property_bits |= property_bitmask;
+    else
+      property_bits &= ~property_bitmask;
+
+    if (property_bits == tape->property_bits)
+    {
+      Print("Tape already patched for '%s'!\n", mode);
+
+      return FALSE;
+    }
+
+    tape->property_bits = property_bits;
   }
 
   Print("Patching for '%s' ... ", mode);
 
-  tape->property_bits = property_bits;
-
   return TRUE;
 }
 
@@ -1554,6 +1848,7 @@ void PatchTapes(void)
     PrintLine("=", 79);
     Print("Supported patch modes:\n");
     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
+    Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
     PrintLine("-", 79);
     Print("Supported modifiers:\n");
     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");