Custom Audio Support

.github/workflows/apt-deps.txt

@@ -1 +1 @@
-libusb-dev libusb-1.0-0-dev libsdl2-dev libsdl2-net-dev libpng-dev libglew-dev nlohmann-json3-dev libtinyxml2-dev libspdlog-dev ninja-build
+libusb-dev libusb-1.0-0-dev libsdl2-dev libsdl2-net-dev libpng-dev libglew-dev nlohmann-json3-dev libtinyxml2-dev libspdlog-dev ninja-build libogg-dev libvorbis-dev

.github/workflows/macports-deps.txt

@@ -1 +1 @@
-libsdl2 +universal libsdl2_net +universal libpng +universal glew +universal libzip +universal nlohmann-json +universal tinyxml2 +universal
+libsdl2 +universal libsdl2_net +universal libpng +universal glew +universal libzip +universal nlohmann-json +universal tinyxml2 +universal libogg +universal libvorbis +universal

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "ZAPDTR"]
 	path = ZAPDTR
 	url = https://github.com/louist103/ZAPDTR.git
+[submodule "mm/2s2h/Enhancements/Audio/dr_libs"]
+	path = mm/2s2h/Enhancements/Audio/dr_libs
+	url = https://github.com/mackron/dr_libs.git

CMakeLists.txt

@@ -64,7 +64,7 @@ elseif ("${CMAKE_VS_PLATFORM_NAME}" STREQUAL "x64")
 endif()
 
 vcpkg_bootstrap()
-vcpkg_install_packages(zlib bzip2 libzip libpng sdl2 sdl2-net glew glfw3 nlohmann-json tinyxml2 spdlog)
+vcpkg_install_packages(zlib bzip2 libzip libpng sdl2 sdl2-net glew glfw3 nlohmann-json tinyxml2 spdlog libogg libvorbis)
 endif()
 
 ################################################################################

docs/CUSTOM_SEQUENCED_MUSIC.md

@@ -0,0 +1,26 @@
+### Custom Music
+
+We support importing custom [Seq64](https://github.com/sauraen/seq64) files to replace the in game music and fanfares (Sound effect and instrument replacement is currently not supported).
+
+First you will need to prepare a folder with the desired sequences. Every sequence requires two files with the same name and different extensions - a `.seq` Seq64 file and a `.meta` plaintext file.
+
+The `.meta` file requires two lines - the first line is the name that will be displayed in the SFX editor, the second line is the instrument set number in `base16` format, and the third line optionally contains 'bgm' or 'fanfare'. For example, if there is a sequence file `Foo.seq` then you need a meta file `Foo.meta` that could contain:
+```
+Awesome Name
+C
+```
+
+Once you have prepared your sequences folder:
+1. Download and open [Future] (https://github.com/louist103/future/). 
+1. Choose the "Create OTR/O2R" option. 
+1. Choose the "Custom Audio" option.
+1. Choose the "Sequenced" option
+1. Using the file selection screen, choose the sequences folder you prepared in the previous instructions.
+1. Click the slider to pack an archive instead.
+1. Select either OTR or O2R.
+1. Click the 'Set Save Path' button to set the save location of the archive, if in create archive mode.
+    (*NOTE:* 2Ship can handle 1024 custom sequence in total. This includes the original music. Keep that in mind!)
+1. Click the "Pack Archive" button..
+1. An archive will be created in the location selected with the 'Set Save Path' step. If that location wasn't the 'mods' folder, move the archive there. The mods folder must be in the same location as the game executable and mm.o2r.
+
+Assuming you have done everything correctly, boot up 2Ship and select the SFX Editor from the enhancements dropdown menu. You should now be able to swap out any of the in game sequences/fanfares for the sequences added in your newly generated OTR file. If you have any trouble with this process, please reach out in the support section of the Discord.

docs/CUSTOM_STREAMED_MUSIC.md

@@ -0,0 +1,30 @@
+
+### Custom Audio
+We support importing streamed (MP3, WAV, OGG, etc.) files to replace in game music, fanfares, sound effects, and instruments.
+
+First you will need to prepare a folder with the desired songs. These can be `.wav`, `.ogg`, `.mp3`, and `.flac`. Place these files in an empty folder and change their name to what you want to appear in game. No `.meta` files are required for streamed songs.
+
+
+Once you have prepared your sequences folder:
+1. Download and open [Future] (https://github.com/louist103/future/). 
+1. Choose the "Create OTR/O2R" option. 
+1. Choose the "Custom Audio" option.
+1. Choose the "Streamed" option
+1. Using the file selection screen, choose the sequences folder you prepared in the previous instructions.
+1. Click the slider to pack an archive instead.
+1. Select either OTR or O2R.
+1. Click the 'Set Save Path' button to set the save location of the archive, if in create archive mode.
+    (*NOTE:* 2Ship can handle 1024 custom sequence in total. This includes the original music. Keep that in mind!)
+1. Click the "Pack Archive" button..
+1. An archive will be created in the location selected with the 'Set Save Path' step. If that location wasn't the 'mods' folder, move the archive there. The mods folder must be in the same location as the game executable and mm.o2r.
+
+Replacing sound effects and instruments it a little more complicated.
+Both of these store extra data in the first sound font, currently named `Soundfont_0`.
+1. First open Soundfont_0. This file is an XML document.
+2. Next find the sample or sound effect you want to replace.
+3. Replace the `SampleRef` field with the path of the new audio file. 
+4. Set the `Tuning` value using this calculation: $\dfrac{sample rate}{32000} * channels$. This is handled by future for songs.
+5. Save the Soundfont XML and replace the one in the original archive.
+6. Save the sample file in the archive, giving it the same path as the `SampleRef`
+
+Assuming you have done everything correctly, boot up 2Ship and select the Audio Editor from the enhancements dropdown menu. You should now be able to swap out any of the in game sequences/fanfares for the sequences added in your newly generated OTR/O2R file. If you have any trouble with this process, please reach out in the support section of the Discord.

mm/2s2h/BenGui/BenGui.cpp

@@ -8,6 +8,7 @@
 #include <Fast3D/gfx_pc.h>
 #include "UIWidgets.hpp"
 #include "HudEditor.h"
+#include "2s2h/Enhancements/Audio/AudioEditor.h"
 #include "Notification.h"
 
 #ifdef __APPLE__
@@ -35,6 +36,7 @@ std::shared_ptr<HudEditorWindow> mHudEditorWindow;
 std::shared_ptr<ActorViewerWindow> mActorViewerWindow;
 std::shared_ptr<CollisionViewerWindow> mCollisionViewerWindow;
 std::shared_ptr<EventLogWindow> mEventLogWindow;
+std::shared_ptr<AudioEditor> mAudioEditorWindow;
 std::shared_ptr<BenMenu> mBenMenu;
 std::shared_ptr<BenInputEditorWindow> mBenInputEditorWindow;
 std::shared_ptr<Notification::Window> mNotificationWindow;
@@ -94,6 +96,10 @@ void SetupGuiElements() {
 
     mEventLogWindow = std::make_shared<EventLogWindow>("gWindows.EventLog", "Event Log", ImVec2(520, 600));
     gui->AddGuiWindow(mEventLogWindow);
+
+    mAudioEditorWindow = std::make_shared<AudioEditor>("gWindows.AudioEditor", "Audio Editor");
+    gui->AddGuiWindow(mAudioEditorWindow);
+
     gui->SetPadBtnTogglesMenu();
 
     mNotificationWindow = std::make_shared<Notification::Window>("gWindows.Notifications", "Notifications Window");
@@ -115,5 +121,7 @@ void Destroy() {
     mSaveEditorWindow = nullptr;
     mHudEditorWindow = nullptr;
     mActorViewerWindow = nullptr;
+
+    mAudioEditorWindow = nullptr;
 }
 } // namespace BenGui

mm/2s2h/BenGui/BenMenuBar.cpp

@@ -10,6 +10,9 @@
 #include "2s2h/Enhancements/Enhancements.h"
 #include "2s2h/Enhancements/GfxPatcher/AuthenticGfxPatches.h"
 #include "2s2h/DeveloperTools/DeveloperTools.h"
+#include "2s2h/Enhancements/Cheats/Cheats.h"
+#include "2s2h/Enhancements/Player/Player.h"
+#include "2s2h/Enhancements/Audio/AudioEditor.h"
 #include "HudEditor.h"
 
 extern "C" {
@@ -838,6 +841,8 @@ extern std::shared_ptr<ActorViewerWindow> mActorViewerWindow;
 extern std::shared_ptr<CollisionViewerWindow> mCollisionViewerWindow;
 extern std::shared_ptr<EventLogWindow> mEventLogWindow;
 
+extern std::shared_ptr<AudioEditor> mAudioEditorWindow;
+
 const char* logLevels[] = {
     "trace", "debug", "info", "warn", "error", "critical", "off",
 };
@@ -963,6 +968,11 @@ void DrawDeveloperToolsMenu() {
         if (mEventLogWindow) {
             UIWidgets::WindowButton("Event Log", "gWindows.EventLog", mEventLogWindow);
         }
+
+        if (mAudioEditorWindow) {
+            UIWidgets::WindowButton("Audio Editor", "gWindows.AudioEditor", mAudioEditorWindow);
+        }
+
         ImGui::EndMenu();
     }
 }

mm/2s2h/BenGui/SearchableMenuItems.h

@@ -1654,6 +1654,13 @@ void AddDevTools() {
                                       "Enables the event log window",
                                       WIDGET_WINDOW_BUTTON,
                                       { .size = UIWidgets::Sizes::Inline, .windowName = "Event Log" } } } } });
+    devToolsSidebar.push_back({ "Audio Editor",
+                                1,
+                                { { { "Popout Audio Editor",
+                                      "gWindows.AudioEditor",
+                                      "Enables the audio editor window",
+                                      WIDGET_WINDOW_BUTTON,
+                                      { .size = UIWidgets::Sizes::Inline, .windowName = "Audio Editor" } } } } });
 }
 
 void SearchMenuGetItem(widgetInfo& widget) {

mm/2s2h/BenPort.cpp

@@ -15,6 +15,7 @@
 #include "z64animation.h"
 #include "z64bgcheck.h"
 #include <libultraship/libultra/gbi.h>
+#include "stb_image.h"
 #include <Fonts.h>
 #ifdef _WIN32
 #include <Windows.h>
@@ -55,6 +56,7 @@ CrowdControl* CrowdControl::Instance;
 #include "2s2h/DeveloperTools/DebugConsole.h"
 #include "2s2h/DeveloperTools/DeveloperTools.h"
 #include "2s2h/SaveManager/SaveManager.h"
+#include "2s2h/Enhancements/Audio/AudioCollection.h"
 #include "2s2h/ShipUtils.h"
 
 // Resource Types/Factories
@@ -102,6 +104,7 @@ CrowdControl* CrowdControl::Instance;
 
 OTRGlobals* OTRGlobals::Instance;
 GameInteractor* GameInteractor::Instance;
+AudioCollection* AudioCollection::Instance;
 
 extern "C" char** cameraStrings;
 bool prevAltAssets = false;
@@ -209,14 +212,24 @@ OTRGlobals::OTRGlobals() {
                                     "Cutscene", static_cast<uint32_t>(SOH::ResourceType::SOH_Cutscene), 0);
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryTextMMV0>(), RESOURCE_FORMAT_BINARY,
                                     "TextMM", static_cast<uint32_t>(SOH::ResourceType::TSH_TextMM), 0);
+
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryAudioSampleV2>(), RESOURCE_FORMAT_BINARY,
                                     "AudioSample", static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSample), 2);
+    loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryXMLAudioSampleV0>(), RESOURCE_FORMAT_XML,
+                                    "Sample", static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSample), 0);
+
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryAudioSoundFontV2>(),
                                     RESOURCE_FORMAT_BINARY, "AudioSoundFont",
                                     static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSoundFont), 2);
+    loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryXMLSoundFontV0>(), RESOURCE_FORMAT_XML,
+                                    "SoundFont", static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSoundFont), 0);
+
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryAudioSequenceV2>(),
                                     RESOURCE_FORMAT_BINARY, "AudioSequence",
                                     static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSequence), 2);
+    loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryXMLAudioSequenceV0>(), RESOURCE_FORMAT_XML,
+                                    "Sequence", static_cast<uint32_t>(SOH::ResourceType::SOH_AudioSequence), 0);
+
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryBackgroundV0>(), RESOURCE_FORMAT_BINARY,
                                     "Background", static_cast<uint32_t>(SOH::ResourceType::SOH_Background), 0);
     loader->RegisterResourceFactory(std::make_shared<SOH::ResourceFactoryBinaryTextureAnimationV0>(),
@@ -513,6 +526,7 @@ extern "C" void InitOTR() {
 
     OTRGlobals::Instance = new OTRGlobals();
     GameInteractor::Instance = new GameInteractor();
+    AudioCollection::Instance = new AudioCollection();
     LoadGuiTextures();
     BenGui::SetupGuiElements();
     InitEnhancements();
@@ -565,6 +579,7 @@ extern "C" void DeinitOTR() {
     BenGui::Destroy();
 
     OTRGlobals::Instance->context = nullptr;
+    delete AudioCollection::Instance;
 }
 
 #ifdef _WIN32
@@ -1186,6 +1201,10 @@ extern "C" SequenceData ResourceMgr_LoadSeqByName(const char* path) {
     SequenceData* sequence = (SequenceData*)ResourceGetDataByName(path);
     return *sequence;
 }
+extern "C" SequenceData* ResourceMgr_LoadSeqPtrByName(const char* path) {
+    SequenceData* sequence = (SequenceData*)ResourceGetDataByName(path);
+    return sequence;
+}
 extern "C" KeyFrameSkeleton* ResourceMgr_LoadKeyFrameSkelByName(const char* path) {
     return (KeyFrameSkeleton*)ResourceGetDataByName(path);
 }
@@ -1256,9 +1275,14 @@ extern "C" SoundFontSample* ResourceMgr_LoadAudioSample(const char* path) {
 }
 #endif
 
-extern "C" SoundFont* ResourceMgr_LoadAudioSoundFont(const char* path) {
+extern "C" SoundFont* ResourceMgr_LoadAudioSoundFontByName(const char* path) {
     return (SoundFont*)ResourceGetDataByName(path);
 }
+
+extern "C" SoundFont* ResourceMgr_LoadAudioSoundFontByCRC(uint64_t crc) {
+    return (SoundFont*)ResourceGetDataByCrc(crc);
+}
+
 extern "C" int ResourceMgr_OTRSigCheck(char* imgData) {
     uintptr_t i = (uintptr_t)(imgData);
 
@@ -1657,3 +1681,7 @@ extern "C" int Controller_ShouldRumble(size_t slot) {
 
     return 0;
 }
+
+extern "C" void Messagebox_ShowErrorBox(char* title, char* body) {
+    Extractor::ShowErrorBox(title, body);
+}

mm/2s2h/BenPort.h

@@ -103,8 +103,8 @@ Vtx* ResourceMgr_LoadVtxByCRC(uint64_t crc);
 char* ResourceMgr_LoadVtxArrayByName(const char* path);
 size_t ResourceMgr_GetVtxArraySizeByName(const char* path);
 Vtx* ResourceMgr_LoadVtxByName(char* path);
+SequenceData* ResourceMgr_LoadSeqPtrByName(const char* path);
 Mtx* ResourceMgr_LoadMtxByName(char* path);
-
 KeyFrameSkeleton* ResourceMgr_LoadKeyFrameSkelByName(const char* path);
 KeyFrameAnimation* ResourceMgr_LoadKeyFrameAnimByName(const char* path);
 
@@ -146,6 +146,8 @@ void Gfx_UnregisterBlendedTexture(const char* name);
 void Gfx_TextureCacheDelete(const uint8_t* texAddr);
 void CheckTracker_OnMessageClose();
 
+void Messagebox_ShowErrorBox(char* title, char* body);
+
 int32_t GetGIID(uint32_t itemID);
 #endif
 

mm/2s2h/DeveloperTools/DebugConsole.cpp

@@ -86,7 +86,7 @@ static bool ActorSpawnHandler(std::shared_ptr<Ship::Console> Console, const std:
 static bool LoadSceneHandler(std::shared_ptr<Ship::Console> Console, const std::vector<std::string>&,
                              std::string* output) {
     gSaveContext.respawnFlag = 0;
-    gSaveContext.seqId = 0xFF;
+    gSaveContext.seqId = NA_BGM_DISABLED;
     gSaveContext.gameMode = 0;
 
     return 0;

mm/2s2h/DeveloperTools/SaveEditor.cpp

@@ -184,7 +184,7 @@ void UpdateGameTime(u16 gameTime) {
         if (gPlayState->sequenceCtx.ambienceId != AMBIENCE_ID_13) {
             SEQCMD_STOP_SEQUENCE(SEQ_PLAYER_AMBIENCE, 0);
             SEQCMD_STOP_SEQUENCE(SEQ_PLAYER_BGM_MAIN, 240);
-            gSaveContext.seqId = (u8)NA_BGM_DISABLED;
+            gSaveContext.seqId = NA_BGM_DISABLED;
             gSaveContext.ambienceId = AMBIENCE_ID_DISABLED;
             Environment_PlaySceneSequence(gPlayState);
         }

mm/2s2h/DeveloperTools/WarpPoint.cpp

@@ -70,7 +70,7 @@ void RegisterWarpPoint() {
         if (!CVarGetInteger("gEnhancements.Cutscenes.SkipToFileSelect", 0) &&
             CVarGetInteger(WARP_POINT_CVAR "BootToWarpPoint", 0) && CVarGetInteger(WARP_POINT_CVAR "Saved", 0)) {
             // Normally called on console logo screen
-            gSaveContext.seqId = (u8)NA_BGM_DISABLED;
+            gSaveContext.seqId = NA_BGM_DISABLED;
             gSaveContext.ambienceId = AMBIENCE_ID_DISABLED;
             gSaveContext.gameMode = GAMEMODE_TITLE_SCREEN;
             Warp();