Cleaned up code, Added parameter validation, Corrected various data types

Author: RaphiMC

README.md

@@ -115,9 +115,9 @@ NoteBlockLib.writeSong(newSong, new File("output.nbs"));
 Song mySong = new GenericSong();
 mySong.setTitle("My song");
 mySong.getTempoEvents().set(0, 10F); // set the tempo to 10 ticks per second
-mySong.getNotes().add(0, new Note().setInstrument(MinecraftInstrument.HARP).setNbsKey((byte) 46));
-mySong.getNotes().add(5, new Note().setInstrument(MinecraftInstrument.BASS).setNbsKey((byte) 60));
-mySong.getNotes().add(8, new Note().setInstrument(MinecraftInstrument.BIT).setNbsKey((byte) 84));
+mySong.getNotes().add(0, new Note().setInstrument(MinecraftInstrument.HARP).setNbsKey(46));
+mySong.getNotes().add(5, new Note().setInstrument(MinecraftInstrument.BASS).setNbsKey(60));
+mySong.getNotes().add(8, new Note().setInstrument(MinecraftInstrument.BIT).setNbsKey(84));
 Song nbsSong = NoteBlockLib.convertSong(mySong, SongFormat.NBS);
 NoteBlockLib.writeSong(nbsSong, new File("output.nbs"));
 ```

gradle.properties

@@ -5,4 +5,4 @@ org.gradle.configuration-cache=true
 java_version=8
 maven_group=net.raphimc
 maven_name=NoteBlockLib
-maven_version=3.1.2-SNAPSHOT
+maven_version=3.2.0-SNAPSHOT

src/main/java/net/raphimc/noteblocklib/NoteBlockLib.java

@@ -39,8 +39,6 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import static com.google.common.io.Files.getFileExtension;
-
 public class NoteBlockLib {
 
     public static Song readSong(final File file) throws Exception {
@@ -128,7 +126,7 @@ public static Song convertSong(final Song song, final SongFormat targetFormat) {
     }
 
     public static SongFormat getFormat(final Path path) {
-        return SongFormat.getByExtension(getFileExtension(path.getFileName().toString()));
+        return SongFormat.getByExtension(com.google.common.io.Files.getFileExtension(path.getFileName().toString()));
     }
 
 }

src/main/java/net/raphimc/noteblocklib/data/MinecraftDefinitions.java

@@ -17,8 +17,10 @@
  */
 package net.raphimc.noteblocklib.data;
 
+import net.raphimc.noteblocklib.format.midi.MidiDefinitions;
 import net.raphimc.noteblocklib.model.Note;
 import net.raphimc.noteblocklib.model.instrument.Instrument;
+import net.raphimc.noteblocklib.util.MathUtil;
 
 import java.util.EnumMap;
 import java.util.Map;
@@ -27,11 +29,11 @@
 
 public class MinecraftDefinitions {
 
-    public static final int MC_LOWEST_MIDI_KEY = 54;
-    public static final int MC_HIGHEST_MIDI_KEY = 78;
-    public static final int MC_LOWEST_KEY = 0;
-    public static final int MC_HIGHEST_KEY = 24;
-    public static final int MC_KEYS = Constants.KEYS_PER_OCTAVE * 2;
+    public static final int LOWEST_MIDI_KEY = 54;
+    public static final int HIGHEST_MIDI_KEY = 78;
+    public static final int LOWEST_KEY = 0;
+    public static final int HIGHEST_KEY = 24;
+    public static final int KEY_COUNT = MidiDefinitions.KEYS_PER_OCTAVE * 2;
 
     // Instrument -> [lower shifts, upper shifts]
     private static final Map<MinecraftInstrument, MinecraftInstrument[][]> INSTRUMENT_SHIFTS = new EnumMap<>(MinecraftInstrument.class);
@@ -62,7 +64,7 @@ public class MinecraftDefinitions {
      * @param note The note to clamp
      */
     public static void clampNoteKey(final Note note) {
-        note.setMidiKey(Math.max(MC_LOWEST_MIDI_KEY, Math.min(MC_HIGHEST_MIDI_KEY, note.getMidiKey())));
+        note.setMidiKey(MathUtil.clamp(note.getMidiKey(), LOWEST_MIDI_KEY, HIGHEST_MIDI_KEY));
     }
 
     /**
@@ -72,7 +74,7 @@ public static void clampNoteKey(final Note note) {
      * @param note The note to transpose
      */
     public static void transposeNoteKey(final Note note) {
-        transposeNoteKey(note, Constants.KEYS_PER_OCTAVE);
+        transposeNoteKey(note, MidiDefinitions.KEYS_PER_OCTAVE);
     }
 
     /**
@@ -84,10 +86,10 @@ public static void transposeNoteKey(final Note note) {
      */
     public static void transposeNoteKey(final Note note, final int transposeAmount) {
         float key = note.getMidiKey();
-        while (key < MC_LOWEST_MIDI_KEY) {
+        while (key < LOWEST_MIDI_KEY) {
             key += transposeAmount;
         }
-        while (key > MC_HIGHEST_MIDI_KEY) {
+        while (key > HIGHEST_MIDI_KEY) {
             key -= transposeAmount;
         }
         note.setMidiKey(key);
@@ -113,15 +115,15 @@ public static void instrumentShiftNote(final Note note) {
 
         float key = note.getMidiKey();
         int downShifts = 0;
-        while (key < MC_LOWEST_MIDI_KEY && downShifts < shifts[0].length) {
+        while (key < LOWEST_MIDI_KEY && downShifts < shifts[0].length) {
             instrument = shifts[0][downShifts++];
-            key += MinecraftDefinitions.MC_KEYS;
+            key += KEY_COUNT;
         }
 
         int upShifts = 0;
-        while (key > MC_HIGHEST_MIDI_KEY && upShifts < shifts[1].length) {
+        while (key > HIGHEST_MIDI_KEY && upShifts < shifts[1].length) {
             instrument = shifts[1][upShifts++];
-            key -= MinecraftDefinitions.MC_KEYS;
+            key -= KEY_COUNT;
         }
 
         note.setInstrument(instrument);
@@ -138,12 +140,12 @@ public static void instrumentShiftNote(final Note note) {
      */
     public static int applyExtendedNotesResourcePack(final Note note) {
         int octavesDelta = 0;
-        while (note.getMidiKey() < MC_LOWEST_MIDI_KEY) {
-            note.setMidiKey(note.getMidiKey() + MC_KEYS);
+        while (note.getMidiKey() < LOWEST_MIDI_KEY) {
+            note.setMidiKey(note.getMidiKey() + KEY_COUNT);
             octavesDelta--;
         }
-        while (note.getMidiKey() > MC_HIGHEST_MIDI_KEY) {
-            note.setMidiKey(note.getMidiKey() - MC_KEYS);
+        while (note.getMidiKey() > HIGHEST_MIDI_KEY) {
+            note.setMidiKey(note.getMidiKey() - KEY_COUNT);
             octavesDelta++;
         }
         return octavesDelta;

src/main/java/net/raphimc/noteblocklib/data/MinecraftInstrument.java

@@ -38,17 +38,17 @@ public enum MinecraftInstrument implements Instrument {
     BANJO(14, 14, "block.note_block.banjo"),
     PLING(15, 15, "block.note_block.pling");
 
-    private final byte nbsId;
-    private final byte mcId;
+    private final int nbsId;
+    private final int mcId;
     private final String mcSoundName;
 
     MinecraftInstrument(final int nbsId, final int mcId, final String mcSoundName) {
-        this.nbsId = (byte) nbsId;
-        this.mcId = (byte) mcId;
+        this.nbsId = nbsId;
+        this.mcId = mcId;
         this.mcSoundName = mcSoundName;
     }
 
-    public static MinecraftInstrument fromNbsId(final byte nbsId) {
+    public static MinecraftInstrument fromNbsId(final int nbsId) {
         for (final MinecraftInstrument instrument : MinecraftInstrument.values()) {
             if (instrument.nbsId == nbsId) {
                 return instrument;
@@ -57,7 +57,7 @@ public static MinecraftInstrument fromNbsId(final byte nbsId) {
         return null;
     }
 
-    public static MinecraftInstrument fromMcId(final byte mcId) {
+    public static MinecraftInstrument fromMcId(final int mcId) {
         for (final MinecraftInstrument instrument : MinecraftInstrument.values()) {
             if (instrument.mcId == mcId) {
                 return instrument;
@@ -75,11 +75,11 @@ public static MinecraftInstrument fromMcSoundName(final String mcSoundName) {
         return null;
     }
 
-    public byte nbsId() {
+    public int nbsId() {
         return this.nbsId;
     }
 
-    public byte mcId() {
+    public int mcId() {
         return this.mcId;
     }
 

…raphimc/noteblocklib/data/Constants.java …utureclient/FutureClientDefinitions.javasrc/main/java/net/raphimc/noteblocklib/data/Constants.java renamed to src/main/java/net/raphimc/noteblocklib/format/futureclient/FutureClientDefinitions.java src/main/java/net/raphimc/noteblocklib/data/Constants.java renamed to src/main/java/net/raphimc/noteblocklib/format/futureclient/FutureClientDefinitions.java

@@ -15,12 +15,10 @@
  * 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.data;
+package net.raphimc.noteblocklib.format.futureclient;
 
-public class Constants {
+public class FutureClientDefinitions {
 
-    public static final int F_SHARP_4_MIDI_KEY = 66;
-
-    public static final int KEYS_PER_OCTAVE = 12;
+    public static final int TEMPO = 20;
 
 }

src/main/java/net/raphimc/noteblocklib/format/futureclient/FutureClientIo.java

@@ -38,7 +38,6 @@ public class FutureClientIo {
     public static FutureClientSong readSong(final InputStream is, final String fileName) throws IOException {
         final LittleEndianDataInputStream dis = new LittleEndianDataInputStream(new BufferedInputStream(is, BUFFER_SIZE));
         final FutureClientSong song = new FutureClientSong(fileName);
-
         final Map<Integer, List<FutureClientNote>> notes = song.getFutureClientNotes();
 
         boolean use64 = false;
@@ -66,7 +65,7 @@ public static FutureClientSong readSong(final InputStream is, final String fileN
         }
 
         { // Fill generalized song structure with data
-            song.getTempoEvents().set(0, 20);
+            song.getTempoEvents().set(0, FutureClientDefinitions.TEMPO);
             for (Map.Entry<Integer, List<FutureClientNote>> entry : notes.entrySet()) {
                 for (FutureClientNote futureClientNote : entry.getValue()) {
                     final Note note = new Note();

src/main/java/net/raphimc/noteblocklib/format/futureclient/model/FutureClientNote.java

@@ -33,6 +33,13 @@ public FutureClientNote setInstrument(final byte instrument) {
         return this;
     }
 
+    public FutureClientNote setInstrument(final int instrument) {
+        if (instrument < Byte.MIN_VALUE || instrument > Byte.MAX_VALUE) {
+            throw new IllegalArgumentException("Instrument must be between " + Byte.MIN_VALUE + " and " + Byte.MAX_VALUE);
+        }
+        return this.setInstrument((byte) instrument);
+    }
+
     public byte getKey() {
         return this.key;
     }
@@ -42,6 +49,13 @@ public FutureClientNote setKey(final byte key) {
         return this;
     }
 
+    public FutureClientNote setKey(final int key) {
+        if (key < Byte.MIN_VALUE || key > Byte.MAX_VALUE) {
+            throw new IllegalArgumentException("Key must be between " + Byte.MIN_VALUE + " and " + Byte.MAX_VALUE);
+        }
+        return this.setKey((byte) key);
+    }
+
     public FutureClientNote copy() {
         final FutureClientNote copyNote = new FutureClientNote();
         copyNote.setInstrument(this.getInstrument());

src/main/java/net/raphimc/noteblocklib/format/mcsp/McSpDefinitions.java

@@ -19,6 +19,7 @@
 
 public class McSpDefinitions {
 
+    public static final int TEMPO = 10;
     public static final int NOTE_COUNT = 7;
 
 }

src/main/java/net/raphimc/noteblocklib/format/mcsp/McSpIo.java

@@ -35,11 +35,10 @@ public class McSpIo {
     public static McSpSong readSong(final InputStream is, final String fileName) {
         final Scanner scanner = new Scanner(new BufferedInputStream(is, BUFFER_SIZE), StandardCharsets.ISO_8859_1.name()).useDelimiter("\\|");
         final McSpSong song = new McSpSong(fileName);
+        final Map<Integer, McSpNote[]> notes = song.getMcSpNotes();
 
         scanner.nextInt(); // version? Is ignored by Minecraft Song Planner v2.5
 
-        final Map<Integer, McSpNote[]> notes = song.getMcSpNotes();
-
         int tick = 0;
         while (scanner.hasNext()) {
             tick += scanner.nextInt();
@@ -54,18 +53,20 @@ public static McSpSong readSong(final InputStream is, final String fileName) {
                 if (instrument == 0) continue;
 
                 final McSpNote note = new McSpNote();
-                note.setInstrument((byte) (instrument - 1));
-                note.setKey((byte) key);
+                note.setInstrument(instrument - 1);
+                note.setKey(key);
                 noteArray[i] = note;
             }
             notes.put(tick, noteArray);
         }
 
         { // Fill generalized song structure with data
-            song.getTempoEvents().set(0, 10);
+            song.getTempoEvents().set(0, McSpDefinitions.TEMPO);
             for (Map.Entry<Integer, McSpNote[]> entry : notes.entrySet()) {
                 for (McSpNote mcSpNote : entry.getValue()) {
-                    if (mcSpNote == null) continue;
+                    if (mcSpNote == null) {
+                        continue;
+                    }
 
                     final Note note = new Note();
                     note.setInstrument(MinecraftInstrument.fromNbsId(mcSpNote.getInstrument()));