Implemented achievements I/O, overlay and error handling

Author: hyperbx

MarathonRecomp/gpu/video.cpp

@@ -1577,7 +1577,6 @@ static void CreateImGuiBackend()
 
     InitImGuiUtils();
     AchievementMenu::Init();
-    AchievementOverlay::Init();
     OptionsMenu::Init();
     InstallerWizard::Init();
 
@@ -2311,17 +2310,17 @@ static uint32_t getSetAddress(uint32_t base, int index) {
 static uint32_t CreateDevice(uint32_t a1, uint32_t a2, uint32_t a3, uint32_t a4, uint32_t a5, be<uint32_t>* a6)
 {
     LOGF_WARNING("{:p} {:p} {:p} {:p} {:p} {:p}\n", reinterpret_cast<void*>(a1), reinterpret_cast<void*>(a2), reinterpret_cast<void*>(a3), reinterpret_cast<void*>(a4), reinterpret_cast<void*>(a5), reinterpret_cast<void*>(a6));
-    g_xdbfTextureCache = std::unordered_map<uint16_t, GuestTexture *>();
+    
+    g_xdbfTextureCache = std::unordered_map<uint16_t, GuestTexture*>();
 
-    // for (auto &achievement : g_xdbfWrapper.GetAchievements(XDBF_LANGUAGE_ENGLISH))
-    // {
-    //     // huh?
-    //     if (!achievement.pImageBuffer || !achievement.ImageBufferSize)
-    //         continue;
+    for (auto &achievement : g_xdbfWrapper.GetAchievements(XDBF_LANGUAGE_ENGLISH))
+    {
+        if (!achievement.pImageBuffer || !achievement.ImageBufferSize)
+            continue;
 
-    //     g_xdbfTextureCache[achievement.ID] =
-    //         LoadTexture((uint8_t *)achievement.pImageBuffer, achievement.ImageBufferSize).release();
-    // }
+        g_xdbfTextureCache[achievement.ID] =
+            LoadTexture((uint8_t *)achievement.pImageBuffer, achievement.ImageBufferSize).release();
+    }
 
     // Move backbuffer to guest memory.
     assert(!g_memory.IsInMemoryRange(g_backBuffer) && g_backBufferHolder != nullptr);
@@ -4458,10 +4457,13 @@ static void SanitizePipelineState(PipelineState& pipelineState)
         pipelineState.blendOpAlpha = RenderBlendOperation::ADD;
     }
 
-    for (size_t i = 0; i < 16; i++)
+    if (pipelineState.vertexDeclaration)
     {
-        if (!pipelineState.vertexDeclaration->vertexStreams[i])
-            pipelineState.vertexStrides[i] = 0;
+        for (size_t i = 0; i < 16; i++)
+        {
+            if (!pipelineState.vertexDeclaration->vertexStreams[i])
+                pipelineState.vertexStrides[i] = 0;
+        }
     }
 
     uint32_t specConstantsMask = 0;

MarathonRecomp/locale/locale.cpp

@@ -635,29 +635,42 @@ std::unordered_map<std::string_view, std::unordered_map<ELanguage, std::string>>
         }
     },
     {
-        // Notes: message appears when ACH-DATA is corrupted (mismatching file size, bad signature, incorrect version or invalid checksum) upon pressing start at the title screen.
+        // Notes: message appears when SonicNextAchievementData.bin is corrupted (mismatching file size, bad signature, incorrect version or invalid checksum) upon loading save data.
         // To make this occur, open the file in any editor and just remove a large chunk of data.
-        "Title_Message_AchievementDataCorrupt",
+        "Title_Message_LoadAchievementDataCorrupt",
         {
-            { ELanguage::English,  "The achievement data appears to be\ncorrupted and cannot be loaded.\n\nProceeding from this point will\nclear your achievement data." },
-            { ELanguage::Japanese, "実績データが破損しているため\n読み込むことができません\n\nこの先に進むと実績データが\n消去されます" },
-            { ELanguage::German,   "Die Erfolgsdaten sind möglicherweise\nfehlerhaft und können nicht\ngeladen werden.\n\nDurch das Fortfahren werden\ndeine bisherigen Erfolgsdaten gelöscht." },
-            { ELanguage::French,   "Les données des succès semblent être\nendommagées et ne peuvent être\nchargées.\n\nSi vous continuez, vos données\nseront écrasées." },
-            { ELanguage::Spanish,  "Los datos de logros parecen estar\ncorruptos y no pueden cargarse.\n\nContinuar a partir de este punto\neliminará los datos de logros." },
-            { ELanguage::Italian,  "I file degli obiettivi sembrano danneggiati\ne non possono essere caricati.\n\nSe prosegui da questo punto\ni tuoi obiettivi verranno cancellati." }
+            { ELanguage::English,  "Load failed. Achievement data is corrupted.\nIf you continue your achievement progress will\nbe lost." },
+            { ELanguage::Japanese, "DUMMY" },
+            { ELanguage::German,   "DUMMY" },
+            { ELanguage::French,   "DUMMY" },
+            { ELanguage::Spanish,  "DUMMY" },
+            { ELanguage::Italian,  "DUMMY" }
         }
     },
     {
-        // Notes: message appears when ACH-DATA cannot be loaded upon pressing start at the title screen.
-        // To make this occur, lock the ACH-DATA file using an external program so that it cannot be accessed by the game.
-        "Title_Message_AchievementDataIOError",
+        // Notes: message appears when SonicNextAchievementData.bin cannot be loaded upon loading save data.
+        // To make this occur, lock the SonicNextAchievementData.bin file using an external program so that it cannot be accessed by the game.
+        "Title_Message_LoadAchievementDataIOError",
         {
-            { ELanguage::English,  "The achievement data could not be loaded.\nYour achievements will not be saved." },
-            { ELanguage::Japanese, "実績データを読み込めませんでした\n実績は保存されません" },
-            { ELanguage::German,   "Die Erfolgsdaten konnten nicht geladen werden.\nDeine Erfolge werden nicht gespeichert." },
-            { ELanguage::French,   "Les données des succès ne\npeuvent être chargées.\nVos succès ne seront pas\nsauvegardés." },
-            { ELanguage::Spanish,  "Los datos de logros no pueden cargarse.\nTus logros no serán guardados." },
-            { ELanguage::Italian,  "I file degli obiettivi non possono essere caricati.\nI tuoi obiettivi non verranno salvati." }
+            { ELanguage::English,  "Load failed. Achievement data cannot be loaded.\nIf you continue you will not be able to save\nyour achievement progress." },
+            { ELanguage::Japanese, "DUMMY" },
+            { ELanguage::German,   "DUMMY" },
+            { ELanguage::French,   "DUMMY" },
+            { ELanguage::Spanish,  "DUMMY" },
+            { ELanguage::Italian,  "DUMMY" }
+        }
+    },
+    {
+        // Notes: message appears when SonicNextAchievementData.bin cannot be saved upon saving save data.
+        // To make this occur, lock the SonicNextAchievementData.bin file using an external program so that it cannot be accessed by the game.
+        "Title_Message_SaveAchievementDataIOError",
+        {
+            { ELanguage::English,  "Save failed. Achievement data cannot be saved.\nIf you continue you will not be able to save\nyour achievement progress." },
+            { ELanguage::Japanese, "DUMMY" },
+            { ELanguage::German,   "DUMMY" },
+            { ELanguage::French,   "DUMMY" },
+            { ELanguage::Spanish,  "DUMMY" },
+            { ELanguage::Italian,  "DUMMY" }
         }
     },
     {
@@ -858,6 +871,28 @@ std::unordered_map<std::string_view, std::unordered_map<ELanguage, std::string>>
             { ELanguage::Italian,  "Cambia" }
         }
     },
+    {
+        "Common_Retry",
+        {
+            { ELanguage::English,  "Retry" },
+            { ELanguage::Japanese, "DUMMY" },
+            { ELanguage::German,   "DUMMY" },
+            { ELanguage::French,   "DUMMY" },
+            { ELanguage::Spanish,  "DUMMY" },
+            { ELanguage::Italian,  "DUMMY" }
+        }
+    },
+    {
+        "Common_ContinueWithoutSaving",
+        {
+            { ELanguage::English,  "Continue without saving." },
+            { ELanguage::Japanese, "DUMMY" },
+            { ELanguage::German,   "DUMMY" },
+            { ELanguage::French,   "DUMMY" },
+            { ELanguage::Spanish,  "DUMMY" },
+            { ELanguage::Italian,  "DUMMY" }
+        }
+    },
     {
         "Button_Cancel",
         {

MarathonRecomp/patches/SaveDataTask_patches.cpp

@@ -1,7 +1,20 @@
 #include <api/Marathon.h>
+#include <ui/message_window.h>
+#include <user/achievement_manager.h>
 #include <user/config.h>
 
+#include <os/logger.h>
+
+enum
+{
+    ACH_ERROR_SUCCESS,
+    ACH_ERROR_READ,
+    ACH_ERROR_WRITE
+};
+
 static Sonicteam::SaveDataTaskXENON::SaveDataOperation g_currentAlert{};
+static int g_achError{ ACH_ERROR_SUCCESS };
+static int g_achErrorIgnored{ ACH_ERROR_SUCCESS };
 
 // Sonicteam::SaveDataTaskXENON::RunOperation (speculatory)
 PPC_FUNC_IMPL(__imp__sub_8238CB18);
@@ -35,9 +48,106 @@ PPC_FUNC(sub_8238CB18)
         }
     }
 
+    // Attempt to load achievement data on save read.
+    if (ctx.r4.u32 == Sonicteam::SaveDataTaskXENON::SaveDataOperation_ReadSaveData)
+    {
+        if (!AchievementManager::LoadBinary())
+        {
+            // This condition will always be met if the achievement data is corrupted (!= IOError),
+            // or as long as "Continue without saving." has not been chosen on load in this session.
+            if (AchievementManager::BinStatus != EAchBinStatus::IOError || g_achErrorIgnored != ACH_ERROR_READ)
+            {
+                g_achError = ACH_ERROR_READ;
+                return;
+            }
+        }
+    }
+
+    // Attempt to save achievement data on save write.
+    if (ctx.r4.u32 == Sonicteam::SaveDataTaskXENON::SaveDataOperation_WriteSaveData)
+    {
+        // This condition will be met if the achievement data failed to save (any error status),
+        // and as long as "Continue without saving." has not been chosen on save in this session.
+        if (!AchievementManager::SaveBinary() && g_achErrorIgnored != ACH_ERROR_WRITE)
+        {
+            g_achError = ACH_ERROR_WRITE;
+            return;
+        }
+    }
+
     __imp__sub_8238CB18(ctx, base);
 }
 
+// Sonicteam::SaveDataTaskXENON::Update
+PPC_FUNC_IMPL(__imp__sub_8238D5C8);
+PPC_FUNC(sub_8238D5C8)
+{
+    auto pSaveDataTaskXENON = (Sonicteam::SaveDataTaskXENON*)(base + ctx.r3.u32);
+
+    if (g_achError != ACH_ERROR_SUCCESS)
+    {
+        static auto s_achErrorMessageResult = -1;
+
+        auto& message = Localise("Title_Message_LoadAchievementDataIOError");
+        std::vector<std::string> options = { Localise("Common_Retry"), Localise("Common_ContinueWithoutSaving") };
+
+        switch (g_achError)
+        {
+            case ACH_ERROR_READ:
+            {
+                // Achievement data is unrecoverable, force user to overwrite it.
+                if (AchievementManager::BinStatus != EAchBinStatus::IOError)
+                {
+                    message = Localise("Title_Message_LoadAchievementDataCorrupt");
+                    options[0] = Localise("Common_OK");
+                    options.pop_back();
+                }
+
+                break;
+            }
+
+            case ACH_ERROR_WRITE:
+                message = Localise("Title_Message_SaveAchievementDataIOError");
+                break;
+        }
+
+        if (MessageWindow::Open(message, &s_achErrorMessageResult, options, 0) == MSG_CLOSED)
+        {
+            auto operation = g_achError == ACH_ERROR_READ
+                ? Sonicteam::SaveDataTaskXENON::SaveDataOperation_ReadSaveData
+                : Sonicteam::SaveDataTaskXENON::SaveDataOperation_WriteSaveData;
+
+            switch (s_achErrorMessageResult)
+            {
+                // Retry / OK
+                case 0:
+                {
+                    // Create new achievement data file.
+                    AchievementManager::SaveBinary(true);
+
+                    // Display any future errors for new files.
+                    g_achErrorIgnored = ACH_ERROR_SUCCESS;
+
+                    break;
+                }
+
+                // Continue without saving.
+                // Ignore any future errors unrelated to corruption for this file.
+                case 1:
+                    g_achErrorIgnored = g_achError;
+                    break;
+            }
+
+            g_achError = ACH_ERROR_SUCCESS;
+            s_achErrorMessageResult = -1;
+
+            GuestToHostFunction<int>(sub_8238CB18, pSaveDataTaskXENON, operation);
+        }
+    }
+
+    __imp__sub_8238D5C8(ctx, base);
+}
+
 void SaveAlertThreeOptionRemoveDeviceSelect(PPCRegister& r5)
 {
     auto options = (uint64_t*)g_memory.Translate(r5.u32 + 8);

MarathonRecomp/patches/TitleTask_patches.cpp

@@ -32,7 +32,7 @@ enum
 
 bool ProcessQuitMessage(Sonicteam::TitleTask* pTitleTask)
 {
-    static int s_quitMessageResult = -1;
+    static auto s_quitMessageResult = -1;
     static std::atomic<bool> s_faderBegun = false;
 
     if (!g_quitMessageOpen)

MarathonRecomp/patches/misc_patches.cpp

@@ -5,8 +5,7 @@
 #include <user/achievement_manager.h>
 #include <app.h>
 
-// TODO (Hyper): implement achievements menu.
-void AchievementManagerUnlockMidAsmHook(PPCRegister& id)
+void UnlockAchievement(PPCRegister& id)
 {
     AchievementManager::Unlock(id.u32);
 }