Merge pull request #122 from Project-Funk-Engine/BoredDuringBreak

System Overhaul

Author: LifeHckr

Audio/midi/Song1.mid

@@ -4,24 +4,29 @@
 using Godot;
 using Melanchall.DryWetMidi.Core;
 using Melanchall.DryWetMidi.Interaction;
-using Melanchall.DryWetMidi.Multimedia;
 
+/**
+ <summary> MidiMaestro: Manages reading midi file into lane note information.</summary>
+
+ */
 public partial class MidiMaestro : Resource
 {
     private MidiFile _midiFile;
 
-    public static TempoMap TempoMap;
-    public static TimeSignature TimeSignature;
+    public static TempoMap TempoMap { get; private set; }
+    public static TimeSignature TimeSignature { get; private set; }
 
     //The four note rows that we care about
-    private midiNoteInfo[] _upNotes;
-    private midiNoteInfo[] _downNotes;
-    private midiNoteInfo[] _leftNotes;
-    private midiNoteInfo[] _rightNotes;
+    private readonly MidiNoteInfo[] _upNotes;
+    private readonly MidiNoteInfo[] _downNotes;
+    private readonly MidiNoteInfo[] _leftNotes;
+    private readonly MidiNoteInfo[] _rightNotes;
 
     //private MidiFile strippedSong;
-
-    //The path relative to the Audio folder. Will change later
+    /**
+     * <summary>Constructor loads midi file and populates lane note arrays with midiNoteInfo</summary>
+     * <param name="filePath">A string file path to a valid midi file</param>
+     */
     public MidiMaestro(string filePath)
     {
         if (!OS.HasFeature("editor"))
@@ -42,9 +47,9 @@ public MidiMaestro(string filePath)
         foreach (var track in _midiFile.GetTrackChunks())
         {
             string trackName = track.Events.OfType<SequenceTrackNameEvent>().FirstOrDefault()?.Text;
-            midiNoteInfo[] noteEvents = track
+            MidiNoteInfo[] noteEvents = track
                 .GetNotes()
-                .Select(note => new midiNoteInfo(note))
+                .Select(note => new MidiNoteInfo(note))
                 .ToArray();
 
             switch (trackName)
@@ -65,7 +70,10 @@ public MidiMaestro(string filePath)
         }
     }
 
-    public midiNoteInfo[] GetNotes(ArrowType arrowType)
+    /**
+     * <summary>Gets midiNoteInfo by lane. </summary>
+     */
+    public MidiNoteInfo[] GetNotes(ArrowType arrowType)
     {
         return arrowType switch
         {
@@ -79,11 +87,11 @@ public midiNoteInfo[] GetNotes(ArrowType arrowType)
 }
 
 //A facade to wrap the midi notes. This is a simple class that wraps a Note object from the DryWetMidi library.
-public class midiNoteInfo
+public class MidiNoteInfo
 {
     private readonly Melanchall.DryWetMidi.Interaction.Note _note;
 
-    public midiNoteInfo(Melanchall.DryWetMidi.Interaction.Note note)
+    public MidiNoteInfo(Melanchall.DryWetMidi.Interaction.Note note)
     {
         _note = note;
     }
@@ -100,7 +108,16 @@ public float GetStartTimeSeconds() =>
         _note.TimeAs<MetricTimeSpan>(MidiMaestro.TempoMap).Milliseconds / 1000f
         + _note.TimeAs<MetricTimeSpan>(MidiMaestro.TempoMap).Seconds;
 
-    public long GetEndTime() => _note.EndTime;
+    public long GetEndTime() => _note.EndTime; //ticks
+
+    public long GetDuration() => _note.Length; //ticks
 
-    public long GetDuration() => _note.Length;
+    public long GetDurationBeats()
+    {
+        var beatsBar = TimeConverter.ConvertTo<BarBeatTicksTimeSpan>(
+            _note.Length,
+            MidiMaestro.TempoMap
+        );
+        return beatsBar.Bars * MidiMaestro.TimeSignature.Numerator + beatsBar.Beats;
+    }
 }

Audio/midi/Song2.mid

@@ -1,11 +1,14 @@
 namespace FunkEngine.Classes.MidiMaestro;
 
-public partial class SongTemplate
+/**
+ * <summary>SongTemplate: Generic class to represent a rhythm battle.</summary>
+ */
+public struct SongTemplate
 {
     public string Name;
-    public string AudioLocation;
+    public readonly string AudioLocation;
     public string MIDILocation;
-    public string EnemyScenePath;
+    public readonly string EnemyScenePath;
     public SongData SongData;
 
     public SongTemplate(

Audio/midi/Song3.mid

@@ -3,15 +3,15 @@
 importer="texture"
 type="CompressedTexture2D"
 uid="uid://c3chrsxrulapd"
-path="res://.godot/imported/single_note.png-edadc3d6779f4cc26ac823d186717719.ctex"
+path="res://.godot/imported/Note_PlayerBasic.png-8e39c4aa6664f4092d3fb2ac9f14cce6.ctex"
 metadata={
 "vram_texture": false
 }
 
 [deps]
 
-source_file="res://Classes/Notes/assets/single_note.png"
-dest_files=["res://.godot/imported/single_note.png-edadc3d6779f4cc26ac823d186717719.ctex"]
+source_file="res://Classes/Notes/Assets/Note_PlayerBasic.png"
+dest_files=["res://.godot/imported/Note_PlayerBasic.png-8e39c4aa6664f4092d3fb2ac9f14cce6.ctex"]
 
 [params]
 

Classes/MidiMaestro/MidiMaestro.cs

@@ -3,15 +3,15 @@
 importer="texture"
 type="CompressedTexture2D"
 uid="uid://caw70lr5e1yiq"
-path="res://.godot/imported/double_note.png-1b788aee0b7f76d502303d178d821d3b.ctex"
+path="res://.godot/imported/Note_PlayerDouble.png-9f112bc39494bd9420dfe4ce034039fa.ctex"
 metadata={
 "vram_texture": false
 }
 
 [deps]
 
-source_file="res://Classes/Notes/assets/double_note.png"
-dest_files=["res://.godot/imported/double_note.png-1b788aee0b7f76d502303d178d821d3b.ctex"]
+source_file="res://Classes/Notes/Assets/Note_PlayerDouble.png"
+dest_files=["res://.godot/imported/Note_PlayerDouble.png-9f112bc39494bd9420dfe4ce034039fa.ctex"]
 
 [params]