// (c) 1995-2014 by Artsoft Entertainment
// Holger Schemel
// info@artsoft.org
-// http://www.artsoft.org/
+// https://www.artsoft.org/
// ----------------------------------------------------------------------------
// tape.c
// ============================================================================
// 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;
// ============================================================================
if (redraw_display)
{
RedrawPlayfield();
+
+ UpdateGameDoorValues();
DrawGameDoorValues();
}
}
// tape logging functions
// ============================================================================
+static char tape_patch_info[MAX_OUTPUT_LINESIZE];
+
static void PrintTapeReplayProgress(boolean replay_finished)
{
static unsigned int counter_last = -1;
if (counter > counter_last + counter_delay)
{
PrintNoLog("\r");
- PrintNoLog("Level %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;
float tape_length_seconds = GetTapeLengthSecondsFloat();
PrintNoLog("\r");
- Print("Level %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;
}
{
int i;
+ CopyTapeToUndoBuffer();
+
tape.counter = 0;
tape.length = 0;
tape.length_frames = 0;
tape.centered_player_nr_next = -1;
tape.set_centered_player = FALSE;
- tape.use_mouse = (level.game_engine_type == GAME_ENGINE_TYPE_MM);
+ // set flags for game actions to default values (may be overwritten later)
+ tape.use_key_actions = TRUE;
+ tape.use_mouse_actions = FALSE;
}
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;
MapTapeEjectButton();
}
-boolean TapeAddAction(byte action[MAX_PLAYERS])
+boolean TapeAddAction(byte action[MAX_TAPE_ACTIONS])
{
int i;
{
boolean changed_events = FALSE;
- for (i = 0; i < MAX_PLAYERS; i++)
+ for (i = 0; i < MAX_TAPE_ACTIONS; i++)
if (tape.pos[tape.counter].action[i] != action[i])
changed_events = TRUE;
if (tape.pos[tape.counter].delay == 0) // store new action
{
- for (i = 0; i < MAX_PLAYERS; i++)
+ for (i = 0; i < MAX_TAPE_ACTIONS; i++)
tape.pos[tape.counter].action[i] = action[i];
tape.pos[tape.counter].delay++;
return TRUE;
}
-void TapeRecordAction(byte action_raw[MAX_PLAYERS])
+void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
{
- byte action[MAX_PLAYERS];
+ byte action[MAX_TAPE_ACTIONS];
int i;
if (!tape.recording) // (record action even when tape is paused)
return;
- for (i = 0; i < MAX_PLAYERS; i++)
+ for (i = 0; i < MAX_TAPE_ACTIONS; i++)
action[i] = action_raw[i];
- if (!tape.use_mouse && tape.set_centered_player)
+ if (tape.use_key_actions && tape.set_centered_player)
{
for (i = 0; i < MAX_PLAYERS; i++)
if (tape.centered_player_nr_next == i ||
return;
}
- if (setup.show_snapshot_buttons &&
- game_status == GAME_MODE_PLAYING &&
- CheckEngineSnapshotList())
+ if (game_status == GAME_MODE_PLAYING)
{
- if (tape.pausing)
- MapUndoRedoButtons();
- else if (!tape.single_step)
- UnmapUndoRedoButtons();
+ if (setup.show_snapshot_buttons && CheckEngineSnapshotList())
+ {
+ if (tape.pausing)
+ MapUndoRedoButtons();
+ else if (!tape.single_step)
+ UnmapUndoRedoButtons();
+ }
+
+ ModifyPauseButtons();
}
}
int update_delay = FRAMES_PER_SECOND / 2;
boolean update_video_display = (FrameCounter % update_delay == 0);
boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
- static byte action[MAX_PLAYERS];
+ static byte action[MAX_TAPE_ACTIONS];
int i;
if (!tape.playing || tape.pausing)
DrawVideoDisplaySymbol(state);
}
- for (i = 0; i < MAX_PLAYERS; i++)
+ for (i = 0; i < MAX_TAPE_ACTIONS; i++)
action[i] = tape.pos[tape.counter].action[i];
#if DEBUG_TAPE_WHEN_PLAYING
- printf("%05d", FrameCounter);
- for (i = 0; i < MAX_PLAYERS; i++)
- printf(" %08x", action[i]);
- printf("\n");
+ DebugContinued("", "%05d", FrameCounter);
+ for (i = 0; i < MAX_TAPE_ACTIONS; i++)
+ DebugContinued("", " %08x", action[i]);
+ DebugContinued("tape:play", "\n");
#endif
tape.set_centered_player = FALSE;
tape.centered_player_nr_next = -999;
- if (!tape.use_mouse)
+ if (tape.use_key_actions)
{
for (i = 0; i < MAX_PLAYERS; i++)
{
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;
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
// ----------------------------------------------------------------------------
-void AutoPlayTape(void)
+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 int patch_nr = 0;
+ static char *patch_name[] =
+ {
+ "original tape",
+ "em_random_bug",
+ "screen_34x34",
+
+ NULL
+ };
+ static int patch_version_first[] =
+ {
+ VERSION_IDENT(0,0,0,0),
+ VERSION_IDENT(3,3,1,0),
+ VERSION_IDENT(0,0,0,0),
+
+ -1
+ };
+ static int patch_version_last[] =
+ {
+ VERSION_IDENT(9,9,9,9),
+ VERSION_IDENT(4,0,1,1),
+ VERSION_IDENT(4,2,2,0),
+
+ -1
+ };
+ static byte patch_property_bit[] =
+ {
+ TAPE_PROPERTY_NONE,
+ TAPE_PROPERTY_EM_RANDOM_BUG,
+ TAPE_PROPERTY_NONE,
+
+ -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
{
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;
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);
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;
if (level.no_level_file || level.no_valid_file)
{
- Print("Level %03d: (no level)\n", level_nr);
+ Print("Tape %03d: (no level found)\n", level_nr);
continue;
}
#if 0
// ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
- Print("Level %03d: (only testing level)\n", level_nr);
+ Print("Tape %03d: (only testing level)\n", level_nr);
continue;
#endif
{
num_tape_missing++;
- Print("Level %03d: (no tape)\n", level_nr);
+ Print("Tape %03d: (no tape found)\n", level_nr);
continue;
}
+ 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])
+ {
+ 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);
+
+ 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
+ patch_nr++;
+ }
+ else
+ {
+ // continue with next tape
+ patch_nr = 0;
+ }
+
+ continue;
+ }
+
+ 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];
+ }
+ }
+
InitCounter();
TapeStartGamePlaying();
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));
+ (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', SOLVED %d/%d (%d%%)",
- autoplay_leveldir->identifier, num_levels_solved, num_levels_played,
- (num_levels_played ? num_levels_solved * 100 / num_levels_played :0));
+ 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)
{
}
+// ----------------------------------------------------------------------------
+// tape patch functions
+// ----------------------------------------------------------------------------
+
+static boolean PatchTape(struct TapeInfo *tape, char *mode)
+{
+ Print("[%d.%d.%d.%d]: ",
+ (tape->engine_version / 1000000) % 100,
+ (tape->engine_version / 10000 ) % 100,
+ (tape->engine_version / 100 ) % 100,
+ (tape->engine_version ) % 100);
+
+ if (strEqual(mode, "info"))
+ {
+ Print("property bits == 0x%02x\n", tape->property_bits);
+
+ return FALSE;
+ }
+
+ boolean unpatch_tape = FALSE;
+ boolean use_property_bit = FALSE;
+ byte property_bitmask = 0;
+
+ if (strSuffix(mode, ":0") ||
+ strSuffix(mode, ":off") ||
+ strSuffix(mode, ":clear"))
+ unpatch_tape = TRUE;
+
+ if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
+ {
+ // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
+ if (tape->engine_version < VERSION_IDENT(3,3,1,0) ||
+ tape->engine_version >= VERSION_IDENT(4,0,1,2))
+ {
+ Print("This tape version cannot be patched against EM random bug!\n");
+
+ return FALSE;
+ }
+
+ 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
+ {
+ Print("Unknown patch mode '%s'!\n", mode);
+
+ return FALSE;
+ }
+
+ // patching tapes using property bits may be used for several patch modes
+ if (use_property_bit)
+ {
+ byte property_bits = tape->property_bits;
+ boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
+
+ 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);
+
+ return TRUE;
+}
+
+void PatchTapes(void)
+{
+ static LevelDirTree *patchtapes_leveldir = NULL;
+ static int num_tapes_found = 0;
+ static int num_tapes_patched = 0;
+ char *mode = global.patchtapes_mode;
+ int i;
+
+ if (strEqual(mode, "help"))
+ {
+ 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");
+ PrintLine("=", 79);
+
+ CloseAllAndExit(0);
+ }
+
+ patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
+ global.patchtapes_leveldir);
+
+ if (patchtapes_leveldir == NULL)
+ Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
+
+ leveldir_current = patchtapes_leveldir;
+
+ if (patchtapes_leveldir->first_level < 0)
+ patchtapes_leveldir->first_level = 0;
+ if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
+ patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
+
+ PrintLine("=", 79);
+ Print("Patching level tapes for patch mode '%s'\n", mode);
+ PrintLine("-", 79);
+ Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
+ Print("Level series name: '%s'\n", patchtapes_leveldir->name);
+ Print("Level series author: '%s'\n", patchtapes_leveldir->author);
+ Print("Number of levels: %d\n", patchtapes_leveldir->levels);
+ PrintLine("=", 79);
+ Print("\n");
+
+ int first_level = patchtapes_leveldir->first_level;
+ int last_level = patchtapes_leveldir->last_level;
+
+ for (i = first_level; i <= last_level; i++)
+ {
+ if (!global.patchtapes_all && !global.patchtapes_level[i])
+ continue;
+
+ Print("Tape %03d: ", i);
+
+ TapeErase();
+ LoadTape(i);
+
+ if (tape.no_valid_file)
+ {
+ Print("(no tape found)\n");
+
+ continue;
+ }
+
+ num_tapes_found++;
+
+ if (PatchTape(&tape, mode))
+ {
+ char *filename = getTapeFilename(i);
+ char *filename_orig = getStringCat2(filename, ".orig");
+
+ if (!fileExists(filename_orig))
+ rename(filename, filename_orig);
+
+ SaveTapeToFilename(filename);
+
+ Print("patched tape saved.\n");
+
+ num_tapes_patched++;
+ }
+ }
+
+ Print("\n");
+ PrintLine("=", 79);
+ Print("Number of tapes found: %d\n", num_tapes_found);
+ Print("Number of tapes patched: %d\n", num_tapes_patched);
+ PrintLine("=", 79);
+
+ CloseAllAndExit(0);
+}
+
+
// ---------- new tape button stuff -------------------------------------------
static struct
GDI_END);
if (gi == NULL)
- Error(ERR_EXIT, "cannot create gadget");
+ Fail("cannot create gadget");
tape_gadget[id] = gi;
}