Merge pull request #576 from Tuupertunut/fix/extra-end-of-phrase

Fix extra end of phrase after the last note

Author: achimmihca

UltraStar Play/Assets/Editor/Tests/UltraStarSongFormatTest.cs

@@ -38,6 +38,15 @@ public void ShouldNotAddPhraseEndBeatIfSameAsMaxBeat()
         Assert.IsTrue(txt.Contains("-"));
     }
 
+    [Test]
+    public void ShouldNotAddLastEndOfPhrase()
+    {
+        SongMeta songMeta = UltraStarSongParser.ParseFile($"{folderPath}/Duet.txt").SongMeta;
+        string txt = UltraStarFormatWriter.ToUltraStarSongFormat(songMeta).Replace("\r\n", "\n");
+        Assert.IsTrue(txt.Contains("First Vocals!\nP2"));
+        Assert.IsTrue(txt.Contains("Second Vocals!\nE"));
+    }
+
     [Test]
     public void ShouldNotContainP1InSoloSong()
     {

UltraStar Play/Packages/playshared/Runtime/Songs/UltraStarSongFormat/UltraStarSongWriter/UltraStarSongWriter.cs

@@ -57,37 +57,40 @@ private static void AppendVoice(StringBuilder sb, Voice voice, bool appendVoiceI
             // P1 is optional when only having one voice
             sb.AppendLine(voice.Id.ToString());
         }
-        List<Sentence> sortedSentences = new(voice.Sentences);
-        sortedSentences.Sort(Sentence.comparerByStartBeat);
-        foreach (Sentence sentence in sortedSentences)
+        List<Sentence> sortedSentences = SongMetaUtils.GetSortedSentences(voice);
+        for (int i = 0; i < sortedSentences.Count; i++)
         {
-            AppendSentence(sb, sentence);
+            Sentence sentence = sortedSentences[i];
+            // A linebreak should not be appended after the last sentence.
+            bool appendLinebreak = i < sortedSentences.Count - 1;
+            AppendSentence(sb, sentence, appendLinebreak);
         }
     }
 
-    private static void AppendSentence(StringBuilder sb, Sentence sentence)
+    private static void AppendSentence(StringBuilder sb, Sentence sentence, bool appendLinebreak)
     {
         bool isEmpty = sentence.Notes.Count == 0;
         if (isEmpty)
         {
             return;
         }
 
-        List<Note> sortedNotes = new(sentence.Notes);
-        sortedNotes.Sort(Note.comparerByStartBeat);
+        List<Note> sortedNotes = SongMetaUtils.GetSortedNotes(sentence);
         foreach (Note note in sortedNotes)
         {
             AppendNote(sb, note);
         }
-
-        // TODO: Linebreak timing could be optional but is required by some other tools, https://github.com/UltraStar-Deluxe/format/issues/64
-        sb.AppendLine($"- {sentence.ExtendedMaxBeat}");
-        // if (sentence.ExtendedMaxBeat > sentence.MaxBeat)
-        // {
-        //     sb.AppendLine($"- {sentence.ExtendedMaxBeat}");
-        // } else {
-        //     sb.AppendLine($"-");
-        // }
+        if (appendLinebreak)
+        {
+            // TODO: Linebreak timing could be optional but is required by some other tools, https://github.com/UltraStar-Deluxe/format/issues/64
+            sb.AppendLine($"- {sentence.ExtendedMaxBeat}");
+            // if (sentence.ExtendedMaxBeat > sentence.MaxBeat)
+            // {
+            //     sb.AppendLine($"- {sentence.ExtendedMaxBeat}");
+            // } else {
+            //     sb.AppendLine($"-");
+            // }
+        }
     }
 
     private static bool IsNotEmpty(Voice voice)