moved code for tape replay header and summary to separate functions
[rocksndiamonds.git] / src / tape.c
index 08ea8f8036b046ee3e28ff8ddd13ce0f95845c77..63b9e402962925224d05a1f51f91f57cde8d647f 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;
 
@@ -470,8 +471,42 @@ void TapeDeactivateDisplayOff(boolean redraw_display)
 // tape logging functions
 // ============================================================================
 
+struct AutoPlayInfo
+{
+  LevelDirTree *leveldir;
+  boolean initialized;
+  int last_level_nr;
+  int level_nr;
+  int num_levels_played;
+  int num_levels_solved;
+  int num_tapes_patched;
+  int num_tape_missing;
+  boolean level_failed[MAX_TAPES_PER_SET];
+  char *tape_filename;
+};
+
 static char tape_patch_info[MAX_OUTPUT_LINESIZE];
 
+static void PrintTapeReplayHeader(struct AutoPlayInfo *autoplay)
+{
+  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);
+  Print("Level series identifier: '%s'\n", autoplay->leveldir->identifier);
+  Print("Level series name:       '%s'\n", autoplay->leveldir->name);
+  Print("Level series author:     '%s'\n", autoplay->leveldir->author);
+  Print("Number of levels:        %d\n",   autoplay->leveldir->levels);
+  PrintLine("=", 79);
+  Print("\n");
+}
+
 static void PrintTapeReplayProgress(boolean replay_finished)
 {
   static unsigned int counter_last = -1;
@@ -512,6 +547,79 @@ static void PrintTapeReplayProgress(boolean replay_finished)
   }
 }
 
+static void PrintTapeReplaySummary(struct AutoPlayInfo *autoplay)
+{
+  char *autoplay_status =
+    (autoplay->num_levels_played == autoplay->num_levels_solved &&
+     autoplay->num_levels_played > 0 ? " OK " : "WARN");
+  int autoplay_percent =
+    (autoplay->num_levels_played ?
+     autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0);
+  int i;
+
+  Print("\n");
+  PrintLine("=", 79);
+  Print("Number of levels played: %d\n", autoplay->num_levels_played);
+  Print("Number of levels solved: %d (%d%%)\n", autoplay->num_levels_solved,
+       (autoplay->num_levels_played ?
+        autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0));
+  if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    Print("Number of tapes fixed: %d\n", autoplay->num_tapes_patched);
+  PrintLine("-", 79);
+  Print("Summary (for automatic parsing by scripts):\n");
+
+  if (autoplay->tape_filename)
+  {
+    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,
+         autoplay->num_levels_solved,
+         autoplay->num_levels_played,
+         autoplay_percent);
+
+    if (autoplay->num_levels_played != autoplay->num_levels_solved)
+    {
+      Print(", FAILED:");
+      for (i = 0; i < MAX_TAPES_PER_SET; i++)
+       if (autoplay->level_failed[i])
+         Print(" %03d", i);
+    }
+  }
+
+  Print("\n");
+  PrintLine("=", 79);
+}
+
+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
@@ -559,6 +667,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++)
@@ -650,6 +760,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();
 
@@ -740,6 +852,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();
 }
@@ -761,6 +879,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)
@@ -790,12 +914,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();
@@ -936,6 +1062,9 @@ byte *TapePlayAction(void)
   if (tape.auto_play)
     PrintTapeReplayProgress(FALSE);
 
+  if (options.tape_log_filename != NULL)
+    WriteTapeLogfile(action);
+
   return action;
 }
 
@@ -1043,6 +1172,8 @@ void TapeQuickSave(void)
     return;
   }
 
+  tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
+
   if (SaveTapeChecked(tape.level_nr))
     SaveEngineSnapshotSingle();
 }
@@ -1101,6 +1232,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)
   {
@@ -1225,17 +1357,55 @@ 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_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 struct AutoPlayInfo autoplay;
   static int patch_nr = 0;
   static char *patch_name[] =
   {
@@ -1271,7 +1441,7 @@ void AutoPlayTapes(void)
   };
   int i;
 
-  if (autoplay_initialized)
+  if (autoplay.initialized)
   {
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
     {
@@ -1290,7 +1460,7 @@ void AutoPlayTapes(void)
          SaveTapeToFilename(filename);
 
          tape.auto_play_level_fixed = TRUE;
-         num_tapes_patched++;
+         autoplay.num_tapes_patched++;
        }
 
        // continue with next tape
@@ -1312,17 +1482,54 @@ 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++;
+      autoplay.num_levels_played++;
 
     if (tape.auto_play_level_solved)
-      num_levels_solved++;
+      autoplay.num_levels_solved++;
 
     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
-      level_failed[level_nr] = !tape.auto_play_level_solved;
+      autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
   }
   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;
@@ -1330,9 +1537,17 @@ void AutoPlayTapes(void)
 
     if (strSuffix(global.autoplay_leveldir, ".tape"))
     {
-      tape_filename = global.autoplay_leveldir;
+      autoplay.tape_filename = global.autoplay_leveldir;
 
-      LoadTapeFromFilename(tape_filename);
+      LoadTapeFromFilename(autoplay.tape_filename);
+
+      if (tape.no_valid_file)
+      {
+       if (!fileExists(autoplay.tape_filename))
+         Fail("tape file '%s' does not exist", autoplay.tape_filename);
+       else
+         Fail("cannot load tape file '%s'", autoplay.tape_filename);
+      }
 
       global.autoplay_leveldir = tape.level_identifier;
 
@@ -1342,50 +1557,39 @@ void AutoPlayTapes(void)
       global.autoplay_all = FALSE;
     }
 
-    autoplay_leveldir = getTreeInfoFromIdentifier(leveldir_first,
+    autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
                                                  global.autoplay_leveldir);
 
-    if (autoplay_leveldir == NULL)
+    if (autoplay.leveldir == NULL)
       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
 
-    leveldir_current = autoplay_leveldir;
+    leveldir_current = autoplay.leveldir;
 
-    if (autoplay_leveldir->first_level < 0)
-      autoplay_leveldir->first_level = 0;
-    if (autoplay_leveldir->last_level >= MAX_TAPES_PER_SET)
-      autoplay_leveldir->last_level = MAX_TAPES_PER_SET - 1;
+    if (autoplay.leveldir->first_level < 0)
+      autoplay.leveldir->first_level = 0;
+    if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
+      autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
 
-    autoplay_level_nr = autoplay_leveldir->first_level;
+    autoplay.level_nr = autoplay.leveldir->first_level;
 
-    PrintLine("=", 79);
-    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);
-    Print("Level series author:     '%s'\n", autoplay_leveldir->author);
-    Print("Number of levels:        %d\n",   autoplay_leveldir->levels);
-    PrintLine("=", 79);
-    Print("\n");
+    PrintTapeReplayHeader(&autoplay);
 
     for (i = 0; i < MAX_TAPES_PER_SET; i++)
-      level_failed[i] = FALSE;
+      autoplay.level_failed[i] = FALSE;
 
     // only private tapes may be modified
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
       options.mytapes = TRUE;
 
-    autoplay_initialized = TRUE;
+    autoplay.initialized = TRUE;
   }
 
   while (1)
   {
     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
-      level_nr = autoplay_level_nr++;
+      level_nr = autoplay.level_nr++;
 
-    if (level_nr > autoplay_leveldir->last_level)
+    if (level_nr > autoplay.leveldir->last_level)
       break;
 
     // set patch info (required for progress output)
@@ -1414,8 +1618,8 @@ void AutoPlayTapes(void)
     continue;
 #endif
 
-    if (tape_filename)
-      LoadTapeFromFilename(tape_filename);
+    if (autoplay.tape_filename)
+      LoadTapeFromFilename(autoplay.tape_filename);
     else if (options.mytapes)
       LoadTape(level_nr);
     else
@@ -1423,7 +1627,7 @@ void AutoPlayTapes(void)
 
     if (tape.no_valid_file)
     {
-      num_tape_missing++;
+      autoplay.num_tape_missing++;
 
       Print("Tape %03d: (no tape found)\n", level_nr);
 
@@ -1487,38 +1691,57 @@ void AutoPlayTapes(void)
       }
     }
 
+    if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+    {
+      boolean use_temporary_tape_file = FALSE;
+
+      Print("Tape %03d:\n", level_nr);
+
+      AutoPlayTapes_SetScoreEntry(0, 0);
+
+      if (autoplay.tape_filename == NULL)
+      {
+       autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
+                                 getDefaultSolutionTapeFilename(level_nr));
+
+       if (!fileExists(autoplay.tape_filename))
+       {
+         // non-standard solution tape -- save to temporary file
+         autoplay.tape_filename = getTemporaryTapeFilename();
+
+         SaveTapeToFilename(autoplay.tape_filename);
+
+         use_temporary_tape_file = TRUE;
+       }
+      }
+
+      SaveServerScoreFromFile(level_nr, autoplay.tape_filename);
+
+      AutoPlayTapes_WaitForUpload();
+
+      if (use_temporary_tape_file)
+        unlink(autoplay.tape_filename);
+
+      // required for uploading multiple tapes
+      autoplay.tape_filename = NULL;
+
+      continue;
+    }
+
     InitCounter();
 
+    if (options.tape_log_filename != NULL)
+      OpenTapeLogfile();
+
     TapeStartGamePlaying();
     TapeStartWarpForward(global.autoplay_mode);
 
-    return;
-  }
+    autoplay.last_level_nr = level_nr;
 
-  Print("\n");
-  PrintLine("=", 79);
-  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%%)",
-       (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)
-  {
-    Print(", FAILED:");
-    for (i = 0; i < MAX_TAPES_PER_SET; i++)
-      if (level_failed[i])
-       Print(" %03d", i);
+    return;
   }
 
-  Print("\n");
-  PrintLine("=", 79);
+  PrintTapeReplaySummary(&autoplay);
 
   CloseAllAndExit(0);
 }