Rewrote MinecraftDefinitions#applyExtendedNotesResourcePack

The old method has been moved to MinecraftDefinitions#applyExtendedNotesResourcePackOld

Author: RaphiMC

src/main/java/net/raphimc/noteblocklib/format/minecraft/MinecraftDefinitions.java

@@ -81,7 +81,7 @@ public static void transposeNoteKey(final Note note) {
      * Transposes the key of the note to fall within minecraft octave range.<br>
      * Any key below 33 (NBS) will be transposed up by transposeAmount, and any key above 57 (NBS) will be transposed down by transposeAmount.
      *
-     * @param note The note to transpose
+     * @param note            The note to transpose
      * @param transposeAmount The amount of keys to transpose by
      */
     public static void transposeNoteKey(final Note note, final int transposeAmount) {
@@ -104,8 +104,8 @@ public static void transposeNoteKey(final Note note, final int transposeAmount)
      */
     public static void instrumentShiftNote(final Note note) {
         Instrument instrument = note.getInstrument();
-        if (!(instrument instanceof MinecraftInstrument)) { // Custom instrument
-            return;
+        if (!(instrument instanceof MinecraftInstrument)) {
+            return; // Custom instrument
         }
 
         final MinecraftInstrument[][] shifts = INSTRUMENT_SHIFTS.get(instrument);
@@ -130,15 +130,44 @@ public static void instrumentShiftNote(final Note note) {
         note.setMidiKey(key);
     }
 
+    /**
+     * Modifies the note to be compatible with the Extended Octave Range Notes resource pack.<br>
+     * This includes shifting the note key to be within the Minecraft octave range and changing its instrument to a {@link ShiftedMinecraftInstrument} with the correct octaves shift.<br>
+     * The octaves shift value has to be appended to the sound name to play the note at the correct pitch. (For example: "block.note_block.harp_" + octavesShift)<br>
+     * {@link ShiftedMinecraftInstrument#mcSoundName()} can be used to get the correct sound name with the suffix already appended.<br>
+     * Link to the resource pack: <a href="https://github.com/RaphiMC/NoteBlockLib/raw/main/Extended%20Octave%20Range%20Notes%20Pack.zip">Extended Notes</a>
+     *
+     * @param note The note to modify
+     */
+    public static void applyExtendedNotesResourcePack(final Note note) {
+        if (!(note.getInstrument() instanceof MinecraftInstrument)) {
+            return; // Custom instrument
+        }
+        int octavesShift = 0;
+        while (note.getMidiKey() < LOWEST_MIDI_KEY) {
+            note.setMidiKey(note.getMidiKey() + KEY_COUNT);
+            octavesShift--;
+        }
+        while (note.getMidiKey() > HIGHEST_MIDI_KEY) {
+            note.setMidiKey(note.getMidiKey() - KEY_COUNT);
+            octavesShift++;
+        }
+        if (octavesShift != 0) {
+            note.setInstrument(new ShiftedMinecraftInstrument((MinecraftInstrument) note.getInstrument(), octavesShift));
+        }
+    }
+
     /**
      * Returns the octave delta to use as a suffix for the sound name and modifies the note key to be within the Minecraft octave range.<br>
      * The octave delta value has to be appended to the sound name to play the note at the correct pitch. (For example: "block.note_block.harp_" + octaveDelta)<br>
      * Link to the resource pack: <a href="https://github.com/RaphiMC/NoteBlockLib/raw/main/Extended%20Octave%20Range%20Notes%20Pack.zip">Extended Notes</a>
      *
      * @param note The note to modify
      * @return The octave delta to use as a suffix for the sound name
+     * @deprecated Replaced by {@link #applyExtendedNotesResourcePack(Note)} which also sets the correct instrument automatically.
      */
-    public static int applyExtendedNotesResourcePack(final Note note) {
+    @Deprecated
+    public static int applyExtendedNotesResourcePackOld(final Note note) {
         int octavesDelta = 0;
         while (note.getMidiKey() < LOWEST_MIDI_KEY) {
             note.setMidiKey(note.getMidiKey() + KEY_COUNT);

src/main/java/net/raphimc/noteblocklib/format/minecraft/ShiftedMinecraftInstrument.java

@@ -0,0 +1,70 @@
+/*
+ * This file is part of NoteBlockLib - https://github.com/RaphiMC/NoteBlockLib
+ * Copyright (C) 2022-2025 RK_01/RaphiMC and contributors
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package net.raphimc.noteblocklib.format.minecraft;
+
+import net.raphimc.noteblocklib.model.note.Instrument;
+
+import java.util.Objects;
+
+public class ShiftedMinecraftInstrument implements Instrument {
+
+    private final MinecraftInstrument instrument;
+    private final int octavesShift;
+
+    public ShiftedMinecraftInstrument(final MinecraftInstrument instrument, final int octavesShift) {
+        if (instrument == null) {
+            throw new IllegalArgumentException("Instrument cannot be null");
+        }
+        this.instrument = instrument;
+        this.octavesShift = octavesShift;
+    }
+
+    public String mcSoundName() {
+        if (this.octavesShift == 0) {
+            return this.instrument.mcSoundName();
+        } else {
+            return this.instrument.mcSoundName() + '_' + this.octavesShift;
+        }
+    }
+
+    public MinecraftInstrument getInstrument() {
+        return this.instrument;
+    }
+
+    public int getOctavesShift() {
+        return this.octavesShift;
+    }
+
+    @Override
+    public ShiftedMinecraftInstrument copy() {
+        return new ShiftedMinecraftInstrument(this.instrument, this.octavesShift);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        ShiftedMinecraftInstrument that = (ShiftedMinecraftInstrument) o;
+        return octavesShift == that.octavesShift && instrument == that.instrument;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(instrument, octavesShift);
+    }
+
+}