[Fix] IT compatibility: When triggering an empty instrument note slot…

…, completely ignore the pattern cell - do not reset the currently playing instrument's envelopes (fixes wayfinder's Jet Rider), and also don't process any effects - including global ones. git-svn-id: https://source.openmpt.org/svn/openmpt/trunk/OpenMPT@20790 56274372-70c3-4bfc-bfc3-4c3a0b034d27
OpenMPT · May 11, 2024 · afd9a20 · afd9a20
1 parent a659078
commit afd9a20
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/mptrack/dlg_misc.cpp b/mptrack/dlg_misc.cpp
@@ -710,6 +710,7 @@ void CLegacyPlaybackSettingsDlg::OnFilterStringChanged()
 		case kITInitialNoteMemory: desc = _T("Initial Last Note Memory of each channel is C-0 instead of No Note"); break;
 		case kPluginDefaultProgramAndBank1: desc = _T("Assume initial plugin MIDI program and bank number is 1"); break;
 		case kITNoSustainOnPortamento: desc = _T("Portamento after note-off does not re-enable sample sustain loop"); break;
+		case kITEmptyNoteMapSlotIgnoreCell: desc = _T("Ignore pattern cell completely when trying to play unmapped instrument note"); break;
 
 		default: MPT_ASSERT_NOTREACHED();
 		}

diff --git a/soundlib/Snd_defs.h b/soundlib/Snd_defs.h
@@ -566,6 +566,7 @@ enum PlayBehaviour
 	kITInitialNoteMemory,           // Initial "last note memory" for each channel is C-0 and not "no note"
 	kPluginDefaultProgramAndBank1,  // Default program and bank is set to 1 for plugins, so if an instrument is set to either of those, the program / bank change event is not sent to the plugin
 	kITNoSustainOnPortamento,       // Do not re-enable sustain loop on portamento, even when switching between samples
+	kITEmptyNoteMapSlotIgnoreCell,  // IT ignores the entire pattern cell when trying to play an unmapped note of an instrument
 
 	// Add new play behaviours here.
 

diff --git a/soundlib/Snd_fx.cpp b/soundlib/Snd_fx.cpp
@@ -2889,7 +2889,25 @@ bool CSoundFile::ProcessEffects()
 			if(ModCommand::IsNote(note))
 			{
 				chn.nNewNote = chn.nLastNote = note;
+			}
+
+			// IT compatibility: Empty sample mapping
+			// This is probably the single biggest WTF replayer bug in Impulse Tracker.
+			// In instrument mode, when an note + instrument is triggered that does not map to any sample, the entire cell (including potentially present global effects!)
+			// is ignored. Even better, if on a following row another instrument number (this time without a note) is encountered, we end up in the same situation!
+			// Test cases: NoMap.it, NoMapEffects.it
+			if(m_playBehaviour[kITEmptyNoteMapSlotIgnoreCell] && instr > 0 && instr <= GetNumInstruments()
+			   && Instruments[instr] != nullptr
+			   && ModCommand::IsNote(chn.nNewNote) && Instruments[instr]->Keyboard[chn.nNewNote - NOTE_MIN] == 0
+			   && !Instruments[instr]->HasValidMIDIChannel())
+			{
+				chn.nNewIns = static_cast<ModCommand::INSTR>(instr);
+				chn.ClearRowCmd();
+				continue;
+			}
 
+			if(ModCommand::IsNote(note))
+			{
 				// New Note Action ?
 				if(!bPorta)
 				{

diff --git a/soundlib/Sndfile.cpp b/soundlib/Sndfile.cpp
@@ -1183,6 +1183,7 @@ PlayBehaviourSet CSoundFile::GetSupportedPlaybackBehaviour(MODTYPE type)
 		playBehaviour.set(kITResetFilterOnPortaSmpChange);
 		playBehaviour.set(kITInitialNoteMemory);
 		playBehaviour.set(kITNoSustainOnPortamento);
+		playBehaviour.set(kITEmptyNoteMapSlotIgnoreCell);
 		break;
 
 	case MOD_TYPE_XM:

diff --git a/soundlib/UpgradeModule.cpp b/soundlib/UpgradeModule.cpp
@@ -597,6 +597,7 @@ void CSoundFile::UpgradeModule()
 			{ kITResetFilterOnPortaSmpChange, MPT_V("1.30.08.02") },
 			{ kITInitialNoteMemory,           MPT_V("1.31.00.25") },
 			{ kITNoSustainOnPortamento,       MPT_V("1.32.00.13") },
+			{ kITEmptyNoteMapSlotIgnoreCell,  MPT_V("1.32.00.13") },
 		};
 
 		for(const auto &b : behaviours)