Audio Editor UI Improvements and Scene Init Randomization (#3388)

* Audio Editor UI Improvements and Scene Init Randomization

* Update soh/soh/Enhancements/audio/AudioEditor.cpp

Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

* Update soh/soh/Enhancements/audio/AudioEditor.cpp

Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

---------

Co-authored-by: Garrett Cox <garrettjcox@gmail.com>
Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

soh/soh/Enhancements/audio/AudioEditor.cpp

@@ -12,6 +12,7 @@
 #include <Utils/StringHelper.h>
 #include "../../UIWidgets.hpp"
 #include "AudioCollection.h"
+#include "soh/Enhancements/game-interactor/GameInteractor.h"
 
 Vec3f pos = { 0.0f, 0.0f, 0.0f };
 f32 freqScale = 1.0f;
@@ -79,6 +80,11 @@ void UpdateCurrentBGM(u16 seqKey, SeqType seqType) {
 void RandomizeGroup(SeqType type) {
     std::vector<u16> values;
 
+    // An empty IncludedSequences set means that the AudioEditor window has never been drawn
+    if (AudioCollection::Instance->GetIncludedSequences().empty()) {
+        AudioCollection::Instance->InitializeShufflePool();
+    }
+
     // use a while loop to add duplicates if we don't have enough included sequences
     while (values.size() < AuthenticCountBySequenceType(type)) {
         for (const auto& seqData : AudioCollection::Instance->GetIncludedSequences()) {
@@ -123,6 +129,34 @@ void ResetGroup(const std::map<u16, SequenceInfo>& map, SeqType type) {
     }
 }
 
+void LockGroup(const std::map<u16, SequenceInfo>& map, SeqType type) {
+    for (const auto& [defaultValue, seqData] : map) {
+        if (seqData.category == type) {
+            // Only save authentic sequence CVars
+            if (seqData.category == SEQ_FANFARE && defaultValue >= MAX_AUTHENTIC_SEQID) {
+                continue;
+            }
+            const std::string cvarKey = AudioCollection::Instance->GetCvarKey(seqData.sfxKey);
+            const std::string cvarLockKey = AudioCollection::Instance->GetCvarLockKey(seqData.sfxKey);
+            CVarSetInteger(cvarLockKey.c_str(), 1);
+        }
+    }
+}
+
+void UnlockGroup(const std::map<u16, SequenceInfo>& map, SeqType type) {
+    for (const auto& [defaultValue, seqData] : map) {
+        if (seqData.category == type) {
+            // Only save authentic sequence CVars
+            if (seqData.category == SEQ_FANFARE && defaultValue >= MAX_AUTHENTIC_SEQID) {
+                continue;
+            }
+            const std::string cvarKey = AudioCollection::Instance->GetCvarKey(seqData.sfxKey);
+            const std::string cvarLockKey = AudioCollection::Instance->GetCvarLockKey(seqData.sfxKey);
+            CVarSetInteger(cvarLockKey.c_str(), 0);
+        }
+    }
+}
+
 void DrawPreviewButton(uint16_t sequenceId, std::string sfxKey, SeqType sequenceType) {
     const std::string cvarKey = AudioCollection::Instance->GetCvarKey(sfxKey);
     const std::string hiddenKey = "##" + cvarKey;
@@ -163,6 +197,8 @@ void Draw_SfxTab(const std::string& tabId, SeqType type) {
     const std::string hiddenTabId = "##" + tabId;
     const std::string resetAllButton = "Reset All" + hiddenTabId;
     const std::string randomizeAllButton = "Randomize All" + hiddenTabId;
+    const std::string lockAllButton = "Lock All" + hiddenTabId;
+    const std::string unlockAllButton = "Unlock All" + hiddenTabId;
     if (ImGui::Button(resetAllButton.c_str())) {
         auto currentBGM = func_800FA0B4(SEQ_PLAYER_BGM_MAIN);
         auto prevReplacement = AudioCollection::Instance->GetReplacementSequence(currentBGM);
@@ -184,6 +220,28 @@ void Draw_SfxTab(const std::string& tabId, SeqType type) {
             ReplayCurrentBGM();
         }
     }
+    ImGui::SameLine();
+    if (ImGui::Button(lockAllButton.c_str())) {
+        auto currentBGM = func_800FA0B4(SEQ_PLAYER_BGM_MAIN);
+        auto prevReplacement = AudioCollection::Instance->GetReplacementSequence(currentBGM);
+        LockGroup(map, type);
+        LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
+        auto curReplacement = AudioCollection::Instance->GetReplacementSequence(currentBGM);
+        if (type == SEQ_BGM_WORLD && prevReplacement != curReplacement) {
+            ReplayCurrentBGM();
+        }
+    }
+    ImGui::SameLine();
+    if (ImGui::Button(unlockAllButton.c_str())) {
+        auto currentBGM = func_800FA0B4(SEQ_PLAYER_BGM_MAIN);
+        auto prevReplacement = AudioCollection::Instance->GetReplacementSequence(currentBGM);
+        UnlockGroup(map, type);
+        LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
+        auto curReplacement = AudioCollection::Instance->GetReplacementSequence(currentBGM);
+        if (type == SEQ_BGM_WORLD && prevReplacement != curReplacement) {
+            ReplayCurrentBGM();
+        }
+    }
 
     ImGui::BeginTable(tabId.c_str(), 3, ImGuiTableFlags_SizingFixedFit);
     ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch);
@@ -350,6 +408,19 @@ void DrawTypeChip(SeqType type) {
     ImGui::EndDisabled();
 }
 
+
+void AudioEditorRegisterOnSceneInitHook() {
+    GameInteractor::Instance->RegisterGameHook<GameInteractor::OnSceneInit>([](int16_t sceneNum) {
+        if (CVarGetInteger("gAudioEditor.RandomizeAllOnNewScene", 0)) {
+            AudioEditor_RandomizeAll();
+        }
+    });
+}
+
+void AudioEditor::InitElement() {
+    AudioEditorRegisterOnSceneInitHook();
+}
+
 void AudioEditor::DrawElement() {
     AudioCollection::Instance->InitializeShufflePool();
 
@@ -359,6 +430,28 @@ void AudioEditor::DrawElement() {
         return;
     }
 
+    float buttonSegments = ImGui::GetContentRegionAvail().x / 4;
+    if (ImGui::Button("Randomize All Groups", ImVec2(buttonSegments, 30.0f))) {
+        AudioEditor_RandomizeAll();
+    }
+    UIWidgets::Tooltip("Randomizes all unlocked music and sound effects across tab groups");
+    ImGui::SameLine();
+    if (ImGui::Button("Reset All Groups", ImVec2(buttonSegments, 30.0f))) {
+        AudioEditor_ResetAll();
+    }
+    UIWidgets::Tooltip("Resets all unlocked music and sound effects across tab groups");
+    ImGui::SameLine();
+    if (ImGui::Button("Lock All Groups", ImVec2(buttonSegments, 30.0f))) {
+        AudioEditor_LockAll();
+    }
+    UIWidgets::Tooltip("Locks all music and sound effects across tab groups");
+    ImGui::SameLine();
+    if (ImGui::Button("Unlock All Groups", ImVec2(buttonSegments, 30.0f))) {
+        AudioEditor_UnlockAll();
+    }
+    UIWidgets::Tooltip("Unlocks all music and sound effects across tab groups");
+
+
     if (ImGui::BeginTabBar("SfxContextTabBar", ImGuiTabBarFlags_NoCloseWithMiddleMouseButton)) {
         if (ImGui::BeginTabItem("Background Music")) {
             Draw_SfxTab("backgroundMusic", SEQ_BGM_WORLD);
@@ -431,6 +524,10 @@ void AudioEditor::DrawElement() {
                     LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
                 }
 
+                ImGui::NewLine();
+                UIWidgets::EnhancementCheckbox("Randomize All Music and Sound Effects on New Scene", "gAudioEditor.RandomizeAllOnNewScene");
+                UIWidgets::Tooltip("Enables randomizing all unlocked music and sound effects when you enter a new scene.");
+
                 ImGui::NewLine();
                 ImGui::PushItemWidth(-FLT_MIN);
                 UIWidgets::PaddedSeparator();
@@ -625,3 +722,19 @@ void AudioEditor_ResetAll() {
     LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
     ReplayCurrentBGM();
 }
+
+void AudioEditor_LockAll() {
+    for (auto type : allTypes) {
+        LockGroup(AudioCollection::Instance->GetAllSequences(), type);
+    }
+
+    LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
+}
+
+void AudioEditor_UnlockAll() {
+    for (auto type : allTypes) {
+        UnlockGroup(AudioCollection::Instance->GetAllSequences(), type);
+    }
+
+    LUS::Context::GetInstance()->GetWindow()->GetGui()->SaveConsoleVariablesOnNextTick();
+}

soh/soh/Enhancements/audio/AudioEditor.h

@@ -14,13 +14,15 @@ class AudioEditor : public LUS::GuiWindow {
         using LUS::GuiWindow::GuiWindow;
 
         void DrawElement() override;
-        void InitElement() override {};
+        void InitElement() override;
         void UpdateElement() override {};
         ~AudioEditor() {};
 };
 
 void AudioEditor_RandomizeAll();
 void AudioEditor_ResetAll();
+void AudioEditor_LockAll();
+void AudioEditor_UnlockAll();
 
 extern "C" {
 #endif