Custom Sequences by leggettc18 · Pull Request #2066 · HarbourMasters/Shipwright

leggettc18 · 2022-12-01T02:20:27Z

Adds support for existing Custom Audio Sequences into the game, specifically any Sequences useable in N64 OoT Rando should be useable here. To create your custom sequence patch OTR, I have also written a small CLI utility that can be used until something more robust is made. Download the version built for your operating system here and follow the instructions on this page to create your patch OTR. You should end up with a file called custom-music.otr in the mods folder of your SoH installation. This tool is intended to parse pairs of .seq and .meta files, like N64 OoT Rando does (more details).

Once you have your patch OTR in your mods folder, you can select your custom sequences in the Sfx Editor, and they will be included in the randomization when you click the "Randomize All" button. They are also separated into BGM and Fanfare categories according to the .meta file contents, currently the custom BGM sequences are available for all BGM categories in the editor.

Additionally, this PR adds a few new things to the Sfx Editor.

Each individual track has their own Randomize button now. So if you click Randomize All and get a couple of tracks you don't like, you can just click Randomize on those tracks without having to change all of them again or scroll through the entire list to find a specific one you want.
Hyrule Field Morning is removed from the list, it will now play normally if Hyrule Field has not been swapped, or it will swap to the same sequence as Hyrule Field does. This way you will get the same track whether you enter Hyrule Field during the day, or enter at night and the music plays after transitioning to morning.
Added an Options Tab to the SfxEditor with two new options. Personally I recommend enabling both of them, but your mileage may vary:
- Disable Enemy Proximity Music: This disables the switch to the enemy bgm that normally happens when you approach an enemy. This allows you to prevent your custom sequences being interrupted by getting close to an enemy, or you can even use it with no custom sequences if you just don't like the Battle BGM.
- EXPERIMENTAL: Lower Octaves of Unplayable Notes: Certain sequences from well-known sources that I've tested have an issue where they will attempt to play a note with too high of a frequency. When this happens, the game will instead play the highest possible frequency, which usually sounds pretty bad. This isn't an SoH exclusive issue either, this happens on n64 emulators as well, but the resulting note is lower (presumably due to hardware quirks) so it isn't quite as noticeable there. Checking this box will cause it to halve the frequency instead of clamping it, causing it to play the right note at a lower octave, which usually sounds better. It seems to work pretty well in every sequence I've tested, but I've marked this feature as experimental because it may be possible for this to have undesired effects in some sequences.

I would like to thank the entire SoH Development team for helping me make this a reality. Additionally, I would like to give a Special Thanks to two specific people:

@MNGoldenEagle for sharing his extensive knowledge to help me debug issues related to OoT's audio engine.
@darkangel93x (of Darunia's Joy fame) for answering questions and helping me debug a few issues with specific custom sequences I was having.

EDIT: v0.2 of SequenceOTRizer has been released

Build Artifacts

Certain sequences wouldn't play on the file select and title screen because they were too large to be cached.

…music.

Added octave drop to experimental features, which drops the octave of a note that is too high for the audio engine to actually play. Without this, some custom sequences have notes which cap at a specific value and sound terrible. At least with this they will still harmonize with the other notes. Experimental tab added to the SfxEditor to house the checkbox for the octave drop feature.

…arunias-joy

To be clear, fixes the more rampant portable ocarina bug present in my earlier builds, not the authentic one.

For miniboss fights and SfxEditor previews.

…arunias-joy

briaguya0

overall this is looking really great! (and from what i can tell testing is going quite well too!) left a few comments in there (nothing major, mostly just places where a comment or two would help clear up what's going on)

looking forward to getting this merged!

briaguya0 · 2022-12-05T00:47:41Z

+#include "../../OTRGlobals.h"
+#include <Utils/StringHelper.h>
+#include "../../UIWidgets.hpp"


probably not something that needs to be fixed in this PR (mostly because it's kind of an all over the place thing in the codebase at the moment), but it seems like we shouldn't need these relative paths with our cmake include dir config

briaguya0 · 2022-12-05T00:59:19Z

    //index = ((u16*)gAudioContext.sequenceFontTable)[seqId];
    //numFonts = gAudioContext.sequenceFontTable[index++];


i know this isn't part of the change but might as well delete these lines instead of just having them commented out

briaguya0 · 2022-12-05T01:09:11Z

    slowLoad->sample.sampleAddr = NULL;
    slowLoad->isDone = isDone;
-
+ 


nitpick, extra space

Fixes audioseq crash when under 255 seqs

dcvz

Some minor comments but looking great!

dcvz · 2022-12-07T08:06:48Z

+    std::vector<std::string> splitFileName = StringHelper::Split(fileName, "_");
+    std::string sequenceName = splitFileName[0];
+    SeqType type = SEQ_BGM_CUSTOM;
+    if (splitFileName[splitFileName.size() - 1] == "fanfare" || splitFileName[splitFileName.size() - 1] == "Fanfare") {


Does tolower() not work here? then you can simplify this check

I actually call tolower() in SequenceOTRizer now when actually writing the filename so technically I could get rid of the capital letter check here. Does retro lowercase the _tag at the end? If not I can refactor this to use tolower().

Yup, we lower case it here: https://github.com/HarbourMasters/retro/blob/main/lib/otr/types/sequence.dart#L26

dcvz · 2022-12-07T08:11:50Z

+        if (seqId != newSeqId) {
+            gAudioContext.seqReplaced[playerIdx] = 1;
+        } else {
+            gAudioContext.seqReplaced[playerIdx] = 0;
+        }


Suggested change

if (seqId != newSeqId) {

gAudioContext.seqReplaced[playerIdx] = 1;

} else {

gAudioContext.seqReplaced[playerIdx] = 0;

}

gAudioContext.seqReplaced[playerIdx] = seqId != newSeqId;

Huh, definitely should've noticed this. Thanks for pointing it out.

Sort custom seqs by meta name

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

briaguya0

This is wonderful! Let's (assuming you're ready to call it good @leggettc18)

…ustom-audioseq

leggettc18 · 2022-12-09T00:18:39Z

One or two more formatting fixes from the review that I haven't applied yet but then I'd say it's good.

leggettc18 · 2022-12-09T00:30:09Z

OK, if CI is happy after this point it should be good enough.

leggettc18 · 2022-12-09T00:53:33Z

Whoops, one more tiny bug found fix already uploaded.

leggettc18 added 30 commits November 3, 2022 23:38

Allows OTRExporter to parse pairs of .seq and .meta files

1c6ce83

Gets added sequences available to SfxEditor and playing in game.

627d290

Some cleanup of the names appearing in the SfxEditor.

5e63597

Moves sequence swap lower in the audio command stack.

551d256

Increases temp cache memory available on title/file-select screen.

c1498c2

Certain sequences wouldn't play on the file select and title screen because they were too large to be cached.

Introduces workaround for 255 sequence limit.

8591c6d

Bug fixes and cleanup.

3f50c01

Fixes bug where fanfares would sometimes disable the sequence player.

d909650

Fixes bug causing certain areas to discard caches when loading enemy …

7c0baba

…music.

Fixes potential config-related crash by replacing invalid characters.

ce57223

Allows custom bgm to play in all BGM categories.

23c1891

Properly randomizes the custom tracks.

b42f03a

Moves custom sequences to a patch OTR.

dfeab25

If custom music was not loaded, fall back to default values.

c040e83

Adds more pool memory for a few tracks that couldn't fit.

272b827

Some cleanup on the generated music archive process.

90dcbc7

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

fce7584

…arunias-joy

Fixes missed memory boost from earlier.

3630a62

Adds ability to remove enemy proximity music.

64e75bc

Applies correct cache policy to fanfares to prevent unloading sequences.

5e1c68b

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

6031644

…arunias-joy

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

602e9f2

…arunias-joy

Removes case-sensitiveness of the sequence type.

ce82db1

Fixes not reverting to sequence after miniboss.

cc3e9d1

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

9d5d085

…arunias-joy

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

3676980

…arunias-joy

Fixes transition to/from miniboss (again) and ocarina bug.

062b248

To be clear, fixes the more rampant portable ocarina bug present in my earlier builds, not the authentic one.

Finally properly fixes transitions between sequences

3c3ad92

For miniboss fights and SfxEditor previews.

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

efafdc1

…arunias-joy

leggettc18 and others added 9 commits November 28, 2022 19:50

Updates custom sequence OTRPath to match SequenceOTRizer.

1aa2d31

Reverts changes to OTRExporter in favor of external tool

8149edd

Fixes formatting issues.

4727c3b

Attempts to fix formatting issue in git diff.

af0fbb8

Should actually fix formatting issues.

0a7f0e1

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into d…

253b72a

…arunias-joy

Should fix mac/linux exclusive build error.

afd07ad

Fixes segfault on macos.

92fff88

sort custom seqs

6d7fdcf

lilacLunatic mentioned this pull request Dec 1, 2022

[Do not Merge] An experimental branch with multiple mods and WIP PRs #1853

Closed

briaguya0 reviewed Dec 5, 2022

View reviewed changes

lilacLunatic and others added 4 commits December 6, 2022 13:04

Fixes audioseq crash when under 255 seqs

87a082f

Merge pull request #9 from RaelCappra/fix-invalid-seq

93407fd

Fixes audioseq crash when under 255 seqs

Removes magic numbers.

3247e73

Removes commented out code.

0347422

dcvz approved these changes Dec 7, 2022

View reviewed changes

briaguya0 reviewed Dec 7, 2022

View reviewed changes

Comment thread soh/soh/Enhancements/sfx-editor/SfxEditor.h Outdated

leggettc18 and others added 3 commits December 8, 2022 13:51

Merge pull request #7 from RaelCappra/pr-2066

e34a3d2

Sort custom seqs by meta name

fixes formatting in SfxEditor.h

c62e93e

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

Cleans up the one hardcoded QueueSeqCmd call.

efd3108

briaguya0 approved these changes Dec 8, 2022

View reviewed changes

Merge branch 'develop' of github.com:HarbourMasters/Shipwright into c…

c45cc9d

…ustom-audioseq

leggettc18 added 2 commits December 8, 2022 19:20

Fixes unneeded erroneous memory boost applied earlier.

201fd2b

Applies additional formatting/cleanliness suggestions from review

2d5e92e

briaguya0 added the merge ready label Dec 9, 2022

Fixes small logic bug

37da584

briaguya0 merged commit 8c8c761 into HarbourMasters:develop Dec 9, 2022

		//index = ((u16*)gAudioContext.sequenceFontTable)[seqId];
		//numFonts = gAudioContext.sequenceFontTable[index++];

		slowLoad->sample.sampleAddr = NULL;
		slowLoad->isDone = isDone;

Conversation

leggettc18 commented Dec 1, 2022 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Build Artifacts

Uh oh!

briaguya0 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dcvz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

briaguya0 left a comment

Choose a reason for hiding this comment

Uh oh!

leggettc18 commented Dec 9, 2022

Uh oh!

leggettc18 commented Dec 9, 2022

Uh oh!

leggettc18 commented Dec 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

leggettc18 commented Dec 1, 2022 •

edited by github-actions Bot

Loading