better reliability and working save/load game in box-emu menu

Author: finger563

components/doom/include/doom.hpp

@@ -10,8 +10,8 @@ void init_doom(const std::string& rom_filename, uint8_t *romdata, size_t rom_dat
 void doom_init_shared_memory();
 void pause_doom_tasks();
 void resume_doom_tasks();
-void load_doom(int save_slot);
-void save_doom(int save_slot);
+void load_doom(std::string_view save_path, int save_slot);
+void save_doom(std::string_view save_path, int save_slot);
 void run_doom_rom();
 void deinit_doom();
 std::span<uint8_t> get_doom_video_buffer();

components/doom/prboom/doomstat.c

@@ -49,7 +49,8 @@ boolean modifiedgame;
 // CPhipps - compatibility vars
 complevel_t compatibility_level, default_compatibility_level;
 
-int comp[COMP_TOTAL], default_comp[COMP_TOTAL];    // killough 10/98
+int comp[COMP_TOTAL];
+const int default_comp[COMP_TOTAL];    // killough 10/98
 
 // v1.1-like pitched sounds
 int pitched_sounds;        // killough

components/doom/prboom/doomstat.h

@@ -114,7 +114,8 @@ enum {
   COMP_TOTAL=32  // Some extra room for additional variables
 };
 
-extern int comp[COMP_TOTAL], default_comp[COMP_TOTAL];
+extern int comp[COMP_TOTAL];
+extern const int default_comp[COMP_TOTAL];
 
 // -------------------------------------------
 // Selected skill type, map etc.

components/doom/prboom/g_game.c

@@ -1500,6 +1500,10 @@ static const struct {
 
 static const size_t num_version_headers = sizeof(version_headers) / sizeof(version_headers[0]);
 
+// used for the cart to be able to explicitly set its own save/load game paths
+char *save_game_name = NULL;
+int save_game_name_len = 0;
+
 void G_DoLoadGame(void)
 {
   lprintf(LO_INFO, "G_DoLoadGame... \n");
@@ -1508,7 +1512,15 @@ void G_DoLoadGame(void)
   char name[PATH_MAX+1];     // killough 3/22/98
   int savegame_compatibility = -1;
 
-  G_SaveGameName(name,sizeof(name),savegameslot, demoplayback);
+  if (save_game_name_len) {
+    strncpy(name, save_game_name, save_game_name_len);
+    name[save_game_name_len] = '\0'; // ensure null termination
+    // now unset the name so that we don't use it again
+    save_game_name_len = 0;
+  } else {
+    G_SaveGameName(name,sizeof(name),savegameslot);
+  }
+
   gameaction = ga_nothing;
 
   length = M_ReadFile(name, &savebuffer);
@@ -1682,7 +1694,14 @@ void (CheckSaveGame)(size_t size, const char* file, int line)
  * cph - Avoid possible buffer overflow problems by passing
  * size to this function and using snprintf */
 
-void G_SaveGameName(char *name, size_t size, int slot, boolean demoplayback)
+void G_SetSaveGameFileName(char *name, size_t size)
+{
+  strncpy(save_game_name, name, size);
+  save_game_name[size] = '\0'; // ensure null termination
+  save_game_name_len = strlen(save_game_name);
+}
+
+void G_SaveGameName(char *name, size_t size, int slot)
 {
   snprintf(name, size, "%s/sav%d-%d.dsg", basesavegame, gamemission, slot);
 }
@@ -1699,7 +1718,16 @@ static void G_DoSaveGame (boolean menu)
   gameaction = ga_nothing; // cph - cancel savegame at top of this function,
     // in case later problems cause a premature exit
 
-  G_SaveGameName(name,sizeof(name),savegameslot, demoplayback && !menu);
+  // if the cart has set the name, use it instead
+  if (save_game_name_len) {
+    strncpy(name, save_game_name, save_game_name_len);
+    name[save_game_name_len] = '\0'; // ensure null termination
+    // now unset the name so that we don't use it again
+    save_game_name_len = 0;
+  } else {
+    // fall back on original name / use (used by game's menu)
+    G_SaveGameName(name,sizeof(name),savegameslot);
+  }
 
   description = savedescription;
 

components/doom/prboom/g_game.h

@@ -66,7 +66,8 @@ void G_WorldDone(void);
 void G_EndGame(void); /* cph - make m_menu.c call a G_* function for this */
 void G_Ticker(void);
 void G_ReloadDefaults(void);     // killough 3/1/98: loads game defaults
-void G_SaveGameName(char *, size_t, int, boolean); /* killough 3/22/98: sets savegame filename */
+void G_SetSaveGameFileName(char *name, size_t size);
+void G_SaveGameName(char *, size_t, int slot); /* killough 3/22/98: sets savegame filename */
 void G_SetFastParms(int);        // killough 4/10/98: sets -fast parameters
 void G_DoNewGame(void);
 void G_DoReborn(int playernum);

components/doom/prboom/m_menu.c

@@ -462,7 +462,8 @@ static const menu_t SetupDef =
   0
 };
 
-static const setup_menu_t gen_settings3[] =  // General Settings
+setup_menu_t *gen_settings3 = NULL;
+const setup_menu_t gen_settings3_init[] =  // General Settings
 {
   {"GENERAL",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"Enable Translucency", S_YESNO, m_null, G_X, G_Y + 1*G_H, {"translucency"}, M_Trans},
@@ -484,8 +485,10 @@ static const setup_menu_t gen_settings3[] =  // General Settings
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_gen_settings3 = sizeof(gen_settings3_init) / sizeof(gen_settings3_init[0]);
 
-static const setup_menu_t weap_settings1[] =  // Weapons Settings screen
+setup_menu_t *weap_settings1 = NULL;
+const setup_menu_t weap_settings1_init[] =  // Weapons Settings screen
 {
   {"WEAPONS",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"ENABLE RECOIL", S_YESNO,m_null,G_X, G_Y+1*G_H, {"weapon_recoil"}},
@@ -505,8 +508,10 @@ static const setup_menu_t weap_settings1[] =  // Weapons Settings screen
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_weap_settings1 = sizeof(weap_settings1_init) / sizeof(weap_settings1_init[0]);
 
-static const setup_menu_t stat_settings1[] =  // Status Bar and HUD Settings screen
+setup_menu_t *stat_settings1 = NULL;
+const setup_menu_t stat_settings1_init[] =  // Status Bar and HUD Settings screen
 {
   {"STATUS BAR"        ,S_SKIP|S_TITLE,m_null,200,G_Y},
   {"Use Red Numbers"   ,S_YESNO, m_null,G_X,G_Y+ 1*G_H, {"sts_always_red"}},
@@ -523,8 +528,10 @@ static const setup_menu_t stat_settings1[] =  // Status Bar and HUD Settings scr
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_stat_settings1 = sizeof(stat_settings1_init) / sizeof(stat_settings1_init[0]);
 
-static const setup_menu_t enem_settings1[] =  // Enemy Settings screen
+setup_menu_t *enem_settings1 = NULL;
+const setup_menu_t enem_settings1_init[] =  // Enemy Settings screen
 {
   {"ENEMIES" ,S_SKIP|S_TITLE,m_null,200,G_Y},
   {"Monster Infighting When Provoked",S_YESNO,m_null,G_X,G_Y+ 1*G_H, {"monster_infighting"}},
@@ -542,8 +549,10 @@ static const setup_menu_t enem_settings1[] =  // Enemy Settings screen
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_enem_settings1 = sizeof(enem_settings1_init) / sizeof(enem_settings1_init[0]);
 
-static const setup_menu_t comp_settings1[] =  // Compatibility Settings screen #1
+setup_menu_t *comp_settings1 = NULL;
+const setup_menu_t comp_settings1_init[] =  // Compatibility Settings screen #1
 {
   {"COMPAT 1/1",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"Any monster can telefrag on MAP30", S_YESNO, m_null, G_X, G_Y + 1*G_H, {"comp_telefrag"}},
@@ -560,8 +569,10 @@ static const setup_menu_t comp_settings1[] =  // Compatibility Settings screen #
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_comp_settings1 = sizeof(comp_settings1_init) / sizeof(comp_settings1_init[0]);
 
-static const setup_menu_t comp_settings2[] =  // Compatibility Settings screen #2
+setup_menu_t *comp_settings2 = NULL;
+const setup_menu_t comp_settings2_init[] =  // Compatibility Settings screen #2
 {
   {"COMPAT 2/2",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"Lost souls don't bounce off flat surfaces", S_YESNO, m_null, G_X, G_Y + 1*G_H, {"comp_soul"}},
@@ -578,8 +589,10 @@ static const setup_menu_t comp_settings2[] =  // Compatibility Settings screen #
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_comp_settings2 = sizeof(comp_settings2_init) / sizeof(comp_settings2_init[0]);
 
-static const setup_menu_t keys_settings1[] =  // Key Binding screen strings
+setup_menu_t *keys_settings1 = NULL;
+const setup_menu_t keys_settings1_init[] =  // Key Binding screen strings
 {
   {"KEYBOARD 1/2",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"MOVEMENT"    ,S_SKIP|S_TITLE,m_null,G_X,G_Y+1*G_H},
@@ -601,8 +614,10 @@ static const setup_menu_t keys_settings1[] =  // Key Binding screen strings
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_keys_settings1 = sizeof(keys_settings1_init) / sizeof(keys_settings1_init[0]);
 
-static const setup_menu_t keys_settings2[] =  // Key Binding screen strings
+setup_menu_t *keys_settings2 = NULL;
+const setup_menu_t keys_settings2_init[] =  // Key Binding screen strings
 {
   {"KEYBOARD 2/2",S_SKIP|S_TITLE,m_null,200,G_Y},
   {"SCREEN"      ,S_SKIP|S_TITLE,m_null,G_X,G_Y+1*G_H},
@@ -625,6 +640,7 @@ static const setup_menu_t keys_settings2[] =  // Key Binding screen strings
 
   {0,S_SKIP|S_END,m_null}
 };
+const int num_keys_settings2 = sizeof(keys_settings2_init) / sizeof(keys_settings2_init[0]);
 
 static const setup_menu_t helpstrings[] =  // HELP screen strings
 {
@@ -713,19 +729,20 @@ static const setup_menu_t cred_settings[] =
   {0,S_SKIP|S_END,m_null},
 };
 
-static setup_menu_t *setup_screens[] =
-{
-  gen_settings3,
-  weap_settings1,
-  stat_settings1,
-  enem_settings1,
-  comp_settings1,
-  comp_settings2,
-  keys_settings1,
-  keys_settings2,
+setup_menu_t **setup_screens = NULL;
+const setup_menu_t *setup_screens_init[] =
+{
+  NULL, // gen_settings3,
+  NULL, // weap_settings1,
+  NULL, // stat_settings1,
+  NULL, // enem_settings1,
+  NULL, // comp_settings1,
+  NULL, // comp_settings2,
+  NULL, // keys_settings1,
+  NULL, // keys_settings2,
   NULL
 };
-
+const int num_setup_screens = sizeof(setup_screens_init) / sizeof(setup_menu_t*);
 
 static void M_SetupNextMenu(menu_t *menudef)
 {
@@ -1244,6 +1261,7 @@ static void M_InitDefaults(void)
         if (!(dp = M_LookupDefault(t->var.name))) {
           I_Error("M_InitDefaults: Couldn't find config variable '%s'\n", t->var.name);
         } else {
+          // I_Error("M_InitDefaults: found config variable '%s'\n", t->var.name);
           t->var.def = dp;
         }
       }
@@ -1379,7 +1397,7 @@ static void M_ReadSaveStrings(void)
     char name[PATH_MAX+1];
     FILE *fp;
 
-    G_SaveGameName(name,sizeof(name),i,false);
+    G_SaveGameName(name,sizeof(name),i);
 
     if ((fp = fopen(name, "rb"))) {
       fread(&savegamestrings[i], SAVESTRINGSIZE, 1, fp);

components/doom/prboom/m_misc.c

@@ -155,7 +155,9 @@ extern const char* chat_macros[];
 
 extern int map_point_coordinates;
 
-static const default_t defaults[] =
+default_t *defaults = NULL;
+
+const default_t defaults_init[] =
 {
   {"Misc settings",{NULL},{0},UL,UL,def_none,ss_none},
   {"default_compatibility_level",{(int*)&default_compatibility_level},
@@ -631,7 +633,8 @@ static const default_t defaults[] =
 
 };
 
-static const int numdefaults = sizeof(defaults)/sizeof(defaults[0]);
+const int numdefaults_bytes = sizeof(defaults_init);
+const int numdefaults = sizeof(defaults_init)/sizeof(defaults_init[0]);
 static const char* configfile;
 
 //

components/doom/src/doom.cpp

@@ -15,6 +15,7 @@ static bool unlock = false;
 
 static uint16_t doom_palette[256];
 
+static constexpr int DEFAULT_AUDIO_VOLUME = 15;
 static std::unique_ptr<espp::Task> audio_task;
 
 static const char *doom_argv[10];
@@ -405,8 +406,8 @@ extern "C" {
     void I_Init(void) {
         snd_channels = NUM_MIX_CHANNELS;
         snd_samplerate = AUDIO_SAMPLE_RATE;
-        snd_MusicVolume = 50;
-        snd_SfxVolume = 50;
+        snd_MusicVolume = DEFAULT_AUDIO_VOLUME;
+        snd_SfxVolume = DEFAULT_AUDIO_VOLUME;
         usegamma = 0;
     }
 } // extern "C"
@@ -439,7 +440,7 @@ void init_doom(const std::string& wad_filename, uint8_t *wad_data, size_t wad_da
     myargc = 5;
     doom_argv[0] = "doom";
     doom_argv[1] = "-save";
-    doom_argv[2] = "/sdcard/doom";
+    doom_argv[2] = "/sdcard/saves";
     doom_argv[3] = "-iwad";
     doom_argv[4] = wad_filename.c_str();
     // doom_argv[5] = "-file";
@@ -510,19 +511,25 @@ void pause_doom_tasks() {
 }
 
 void resume_doom_tasks() {
-    snd_MusicVolume = 50;
-    snd_SfxVolume = 50;
+    snd_MusicVolume = DEFAULT_AUDIO_VOLUME;
+    snd_SfxVolume = DEFAULT_AUDIO_VOLUME;
 }
 
-void load_doom(int save_slot) {
+void load_doom(std::string_view save_path, int save_slot) {
     if (save_slot >= 0) {
-        bool command = false; // TODO: what does this do?
+        // set the save game file name
+        G_SetSaveGameFileName(const_cast<char*>(save_path.data()), save_path.size());
+        // load the game
+        bool command = false;
         G_LoadGame(save_slot, command);
     }
 }
 
-void save_doom(int save_slot) {
+void save_doom(std::string_view save_path, int save_slot) {
     if (save_slot >= 0) {
+        // set the save game file name
+        G_SetSaveGameFileName(const_cast<char*>(save_path.data()), save_path.size());
+        // save the game
         auto description = fmt::format("Save Slot {}", save_slot);
         G_SaveGame(save_slot, const_cast<char*>(description.c_str()));
     }