Projects/Vocaluxe
2
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Introduce SongLoader class as some fields are only required while loading

Browse Source 
Change relative to be a bool
This commit is contained in:
Flamefire committed 2013-10-11 14:50:30 +02:00
1 parent 31976ed498
commit 3c2d7dcafd
4 files changed
+118 -101
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Vocaluxe/Base/CSongs.cs
+1 -1
View File
@@ -312,7 +312,7 @@ namespace Vocaluxe.Base
if (song == null) if (song == null)
continue; continue;
song.ID = _Songs.Count; song.ID = _Songs.Count;
if (song.ReadNotes()) if (song.LoadNotes())
_Songs.Add(song); _Songs.Add(song);
} }
CLog.StopBenchmark(2, "Read TXTs"); CLog.StopBenchmark(2, "Read TXTs");
VocaluxeLib/Songs/CSong.cs
+14 -7
View File
@@ -82,7 +82,7 @@ namespace VocaluxeLib.Songs
public string Folder = String.Empty; public string Folder = String.Empty;
public string FolderName = String.Empty; public string FolderName = String.Empty;
public string FileName = String.Empty; public string FileName = String.Empty;
public EOffOn Relative = EOffOn.TR_CONFIG_OFF; public bool Relative;
public string MP3FileName = String.Empty; public string MP3FileName = String.Empty;
public string CoverFileName = String.Empty; public string CoverFileName = String.Empty;
@@ -165,12 +165,6 @@ namespace VocaluxeLib.Songs
//No point creating a song without a text file --> Use factory method LoadSong //No point creating a song without a text file --> Use factory method LoadSong
private CSong() {} private CSong() {}
public static CSong LoadSong(string filePath)
{
var song = new CSong();
return song._InitPaths(filePath) && song._ReadHeader() ? song : null;
}
public CSong(CSong song) public CSong(CSong song)
{ {
_CoverTextureSmall = song._CoverTextureSmall; _CoverTextureSmall = song._CoverTextureSmall;
@@ -236,6 +230,19 @@ namespace VocaluxeLib.Songs
Notes = new CNotes(song.Notes); Notes = new CNotes(song.Notes);
} }
public static CSong LoadSong(string filePath)
{
var song = new CSong();
var loader = new CSongLoader(song);
return loader.InitPaths(filePath) && loader.ReadHeader() ? song : null;
}
public bool LoadNotes()
{
var loader = new CSongLoader(this);
return loader.ReadNotes();
}
public string GetMP3() public string GetMP3()
{ {
return Path.Combine(Folder, MP3FileName); return Path.Combine(Folder, MP3FileName);
VocaluxeLib/Songs/CVoice.cs
+1 -1
View File
@@ -133,7 +133,7 @@ namespace VocaluxeLib.Songs
//Maybe we have to split the previous line //Maybe we have to split the previous line
while (prevLine.NoteCount > 0 && prevLine.LastNote.StartBeat >= startBeat) while (prevLine.NoteCount > 0 && prevLine.LastNote.StartBeat >= startBeat)
{ {
throw new Exception("This should not happen on song loading!"); //throw new Exception("This should not happen on song loading!");
line.AddNote(prevLine.LastNote); line.AddNote(prevLine.LastNote);
prevLine.DeleteNote(prevLine.NoteCount - 1); prevLine.DeleteNote(prevLine.NoteCount - 1);
} }
VocaluxeLib/Songs/SongNotesLoader.cs
+102 -92
View File
@@ -11,49 +11,58 @@ namespace VocaluxeLib.Songs
/// </summary> /// </summary>
public partial class CSong public partial class CSong
{ {
private bool _InitPaths(string filePath) private class CSongLoader
{
private readonly CSong _Song;
public CSongLoader(CSong song)
{
_Song = song;
}
public bool InitPaths(string filePath)
{ {
if (!File.Exists(filePath)) if (!File.Exists(filePath))
return false; return false;
Folder = Path.GetDirectoryName(filePath); _Song.Folder = Path.GetDirectoryName(filePath);
if (Folder == null) if (_Song.Folder == null)
return false; return false;
foreach (string folder in CBase.Config.GetSongFolders().Where(folder => Folder.StartsWith(folder))) foreach (string folder in CBase.Config.GetSongFolders().Where(folder => _Song.Folder.StartsWith(folder)))
{ {
if (Folder.Length == folder.Length) if (_Song.Folder.Length == folder.Length)
FolderName = "Songs"; _Song.FolderName = "Songs";
else else
{ {
FolderName = Folder.Substring(folder.Length + 1); _Song.FolderName = _Song.Folder.Substring(folder.Length + 1);
int pos = FolderName.IndexOf("\\", StringComparison.Ordinal); int pos = _Song.FolderName.IndexOf("\\", StringComparison.Ordinal);
if (pos >= 0) if (pos >= 0)
FolderName = FolderName.Substring(0, pos); _Song.FolderName = _Song.FolderName.Substring(0, pos);
} }
break; break;
} }
FileName = Path.GetFileName(filePath); _Song.FileName = Path.GetFileName(filePath);
return true; return true;
} }
private void _LogReadError(string error, int lineNr) private void _LogReadError(string error, int lineNr)
{ {
CBase.Log.LogError(error + " in line #" + lineNr + "(" + Path.Combine(Folder, FileName) + ")"); CBase.Log.LogError(error + " in line #" + lineNr + "(" + Path.Combine(_Song.Folder, _Song.FileName) + ")");
} }
private bool _ReadHeader(Encoding encoding = null) public bool ReadHeader(Encoding encoding = null)
{ {
string filePath = Path.Combine(Folder, FileName); string filePath = Path.Combine(_Song.Folder, _Song.FileName);
if (!File.Exists(filePath)) if (!File.Exists(filePath))
return false; return false;
Language.Clear(); _Song.Language.Clear();
Genre.Clear(); _Song.Genre.Clear();
_Comment.Clear(); _Song._Comment.Clear();
var headerFlags = new EHeaderFlags(); var headerFlags = new EHeaderFlags();
StreamReader sr = null; StreamReader sr = null;
@@ -96,47 +105,47 @@ namespace VocaluxeLib.Songs
{ {
sr.Dispose(); sr.Dispose();
sr = null; sr = null;
return _ReadHeader(Encoding); return ReadHeader(_Song.Encoding);
} }
break; break;
case "TITLE": case "TITLE":
Title = value; _Song.Title = value;
headerFlags |= EHeaderFlags.Title; headerFlags |= EHeaderFlags.Title;
break; break;
case "ARTIST": case "ARTIST":
Artist = value; _Song.Artist = value;
headerFlags |= EHeaderFlags.Artist; headerFlags |= EHeaderFlags.Artist;
break; break;
case "TITLE-ON-SORTING": case "TITLE-ON-SORTING":
TitleSorting = value; _Song.TitleSorting = value;
break; break;
case "ARTIST-ON-SORTING": case "ARTIST-ON-SORTING":
ArtistSorting = value; _Song.ArtistSorting = value;
break; break;
case "DUETSINGERP1": case "DUETSINGERP1":
case "P1": case "P1":
Notes.VoiceNames[0] = value; _Song.Notes.VoiceNames[0] = value;
break; break;
case "DUETSINGERP2": case "DUETSINGERP2":
case "P2": case "P2":
Notes.VoiceNames[1] = value; _Song.Notes.VoiceNames[1] = value;
break; break;
case "MP3": case "MP3":
if (File.Exists(Path.Combine(Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
{ {
MP3FileName = value; _Song.MP3FileName = value;
headerFlags |= EHeaderFlags.MP3; headerFlags |= EHeaderFlags.MP3;
} }
else else
{ {
_LogReadError("Error: Can't find audio file: " + Path.Combine(Folder, value), lineNr); _LogReadError("Error: Can't find audio file: " + Path.Combine(_Song.Folder, value), lineNr);
return false; return false;
} }
break; break;
case "BPM": case "BPM":
if (CHelper.TryParse(value, out BPM)) if (CHelper.TryParse(value, out _Song.BPM))
{ {
BPM *= 4; _Song.BPM *= 4;
headerFlags |= EHeaderFlags.BPM; headerFlags |= EHeaderFlags.BPM;
} }
else else
@@ -144,102 +153,102 @@ namespace VocaluxeLib.Songs
break; break;
case "EDITION": case "EDITION":
if (value.Length > 1) if (value.Length > 1)
Edition.Add(value); _Song.Edition.Add(value);
else else
_LogReadError("Warning: Invalid edition", lineNr); _LogReadError("Warning: Invalid edition", lineNr);
break; break;
case "GENRE": case "GENRE":
if (value.Length > 1) if (value.Length > 1)
Genre.Add(value); _Song.Genre.Add(value);
else else
_LogReadError("Warning: Invalid genre", lineNr); _LogReadError("Warning: Invalid genre", lineNr);
break; break;
case "YEAR": case "YEAR":
int num; int num;
if (value.Length == 4 && int.TryParse(value, out num) && num > 0) if (value.Length == 4 && int.TryParse(value, out num) && num > 0)
Year = value; _Song.Year = value;
else else
_LogReadError("Warning: Invalid year", lineNr); _LogReadError("Warning: Invalid year", lineNr);
break; break;
case "LANGUAGE": case "LANGUAGE":
if (value.Length > 1) if (value.Length > 1)
Language.Add(value); _Song.Language.Add(value);
else else
_LogReadError("Warning: Invalid language", lineNr); _LogReadError("Warning: Invalid language", lineNr);
break; break;
case "COMMENT": case "COMMENT":
if (value.Length > 1) if (value.Length > 1)
_Comment.Add(value); _Song._Comment.Add(value);
else else
_LogReadError("Warning: Invalid comment", lineNr); _LogReadError("Warning: Invalid comment", lineNr);
break; break;
case "GAP": case "GAP":
if (CHelper.TryParse(value, out Gap)) if (CHelper.TryParse(value, out _Song.Gap))
Gap /= 1000f; _Song.Gap /= 1000f;
else else
_LogReadError("Warning: Invalid gap", lineNr); _LogReadError("Warning: Invalid gap", lineNr);
break; break;
case "COVER": case "COVER":
if (File.Exists(Path.Combine(Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
CoverFileName = value; _Song.CoverFileName = value;
else else
_LogReadError("Warning: Can't find cover file: " + Path.Combine(Folder, value), lineNr); _LogReadError("Warning: Can't find cover file: " + Path.Combine(_Song.Folder, value), lineNr);
break; break;
case "BACKGROUND": case "BACKGROUND":
if (File.Exists(Path.Combine(Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
BackgroundFileName = value; _Song.BackgroundFileName = value;
else else
_LogReadError("Warning: Can't find background file: " + Path.Combine(Folder, value), lineNr); _LogReadError("Warning: Can't find background file: " + Path.Combine(_Song.Folder, value), lineNr);
break; break;
case "VIDEO": case "VIDEO":
if (File.Exists(Path.Combine(Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
VideoFileName = value; _Song.VideoFileName = value;
else else
CBase.Log.LogError("Warning: Can't find video file: " + Path.Combine(Folder, value)); CBase.Log.LogError("Warning: Can't find video file: " + Path.Combine(_Song.Folder, value));
break; break;
case "VIDEOGAP": case "VIDEOGAP":
if (!CHelper.TryParse(value, out VideoGap)) if (!CHelper.TryParse(value, out _Song.VideoGap))
_LogReadError("Warning: Invalid videogap", lineNr); _LogReadError("Warning: Invalid videogap", lineNr);
break; break;
case "VIDEOASPECT": case "VIDEOASPECT":
if (!CHelper.TryParse(value, out VideoAspect, true)) if (!CHelper.TryParse(value, out _Song.VideoAspect, true))
_LogReadError("Warning: Invalid videoaspect", lineNr); _LogReadError("Warning: Invalid videoaspect", lineNr);
break; break;
case "START": case "START":
if (!CHelper.TryParse(value, out Start)) if (!CHelper.TryParse(value, out _Song.Start))
_LogReadError("Warning: Invalid start", lineNr); _LogReadError("Warning: Invalid start", lineNr);
break; break;
case "END": case "END":
if (CHelper.TryParse(value, out Finish)) if (CHelper.TryParse(value, out _Song.Finish))
Finish /= 1000f; _Song.Finish /= 1000f;
else else
_LogReadError("Warning: Invalid end", lineNr); _LogReadError("Warning: Invalid end", lineNr);
break; break;
case "PREVIEWSTART": case "PREVIEWSTART":
if (CHelper.TryParse(value, out PreviewStart) && PreviewStart >= 0f) if (CHelper.TryParse(value, out _Song.PreviewStart) && _Song.PreviewStart >= 0f)
headerFlags |= EHeaderFlags.PreviewStart; headerFlags |= EHeaderFlags.PreviewStart;
else else
_LogReadError("Warning: Invalid previewstart", lineNr); _LogReadError("Warning: Invalid previewstart", lineNr);
break; break;
case "MEDLEYSTARTBEAT": case "MEDLEYSTARTBEAT":
if (int.TryParse(value, out Medley.StartBeat)) if (int.TryParse(value, out _Song.Medley.StartBeat))
headerFlags |= EHeaderFlags.MedleyStartBeat; headerFlags |= EHeaderFlags.MedleyStartBeat;
else else
_LogReadError("Warning: Invalid medleystartbeat", lineNr); _LogReadError("Warning: Invalid medleystartbeat", lineNr);
break; break;
case "MEDLEYENDBEAT": case "MEDLEYENDBEAT":
if (int.TryParse(value, out Medley.EndBeat)) if (int.TryParse(value, out _Song.Medley.EndBeat))
headerFlags |= EHeaderFlags.MedleyEndBeat; headerFlags |= EHeaderFlags.MedleyEndBeat;
else else
_LogReadError("Warning: Invalid medleyendbeat", lineNr); _LogReadError("Warning: Invalid medleyendbeat", lineNr);
break; break;
case "CALCMEDLEY": case "CALCMEDLEY":
if (value.ToUpper() == "OFF") if (value.ToUpper() == "OFF")
CalculateMedley = false; _Song.CalculateMedley = false;
break; break;
case "RELATIVE": case "RELATIVE":
if (value.ToUpper() == "YES") if (value.ToUpper() == "YES")
Relative = EOffOn.TR_CONFIG_ON; _Song.Relative = true;
break; break;
} }
} //end of while } //end of while
@@ -278,28 +287,28 @@ namespace VocaluxeLib.Songs
#region check medley tags #region check medley tags
if ((headerFlags & EHeaderFlags.MedleyStartBeat) != 0 && (headerFlags & EHeaderFlags.MedleyEndBeat) != 0) if ((headerFlags & EHeaderFlags.MedleyStartBeat) != 0 && (headerFlags & EHeaderFlags.MedleyEndBeat) != 0)
{ {
if (Medley.StartBeat > Medley.EndBeat) if (_Song.Medley.StartBeat > _Song.Medley.EndBeat)
{ {
CBase.Log.LogError("MedleyStartBeat is bigger than MedleyEndBeat in file: " + filePath); CBase.Log.LogError("MedleyStartBeat is bigger than MedleyEndBeat in file: " + filePath);
headerFlags = headerFlags - EHeaderFlags.MedleyStartBeat - EHeaderFlags.MedleyEndBeat; headerFlags = headerFlags - EHeaderFlags.MedleyStartBeat - EHeaderFlags.MedleyEndBeat;
} }
} }
if ((headerFlags & EHeaderFlags.PreviewStart) == 0 || PreviewStart < 0) if ((headerFlags & EHeaderFlags.PreviewStart) == 0 || _Song.PreviewStart < 0)
{ {
//PreviewStart is not set or <=0 //PreviewStart is not set or <=0
PreviewStart = (headerFlags & EHeaderFlags.MedleyStartBeat) != 0 ? CBase.Game.GetTimeFromBeats(Medley.StartBeat, BPM) : 0f; _Song.PreviewStart = (headerFlags & EHeaderFlags.MedleyStartBeat) != 0 ? CBase.Game.GetTimeFromBeats(_Song.Medley.StartBeat, _Song.BPM) : 0f;
} }
if ((headerFlags & EHeaderFlags.MedleyStartBeat) != 0 && (headerFlags & EHeaderFlags.MedleyEndBeat) != 0) if ((headerFlags & EHeaderFlags.MedleyStartBeat) != 0 && (headerFlags & EHeaderFlags.MedleyEndBeat) != 0)
{ {
Medley.Source = EMedleySource.Tag; _Song.Medley.Source = EMedleySource.Tag;
Medley.FadeInTime = CBase.Settings.GetDefaultMedleyFadeInTime(); _Song.Medley.FadeInTime = CBase.Settings.GetDefaultMedleyFadeInTime();
Medley.FadeOutTime = CBase.Settings.GetDefaultMedleyFadeOutTime(); _Song.Medley.FadeOutTime = CBase.Settings.GetDefaultMedleyFadeOutTime();
} }
#endregion check medley tags #endregion check medley tags
Encoding = sr.CurrentEncoding; _Song.Encoding = sr.CurrentEncoding;
} }
catch (Exception e) catch (Exception e)
{ {
@@ -309,31 +318,33 @@ namespace VocaluxeLib.Songs
return false; return false;
} }
sr.Dispose(); sr.Dispose();
_CheckFiles(); _Song._CheckFiles();
CBase.DataBase.GetDataBaseSongInfos(Artist, Title, out NumPlayed, out DateAdded, out DataBaseSongID); CBase.DataBase.GetDataBaseSongInfos(_Song.Artist, _Song.Title, out _Song.NumPlayed, out _Song.DateAdded, out _Song.DataBaseSongID);
//Before saving this tags to .txt: Check, if ArtistSorting and Artist are equal, then don't save this tag. //Before saving this tags to .txt: Check, if ArtistSorting and Artist are equal, then don't save this tag.
if (ArtistSorting == "") if (_Song.ArtistSorting == "")
ArtistSorting = Artist; _Song.ArtistSorting = _Song.Artist;
if (TitleSorting == "") if (_Song.TitleSorting == "")
TitleSorting = Title; _Song.TitleSorting = _Song.Title;
return true; return true;
} }
public bool ReadNotes() public bool ReadNotes()
{ {
return _ReadNotes(Path.Combine(Folder, FileName)); return _ReadNotes();
} }
private bool _ReadNotes(string filePath, bool forceReload = false) private bool _ReadNotes(bool forceReload = false)
{ {
//Skip loading if already done and no reload is forced //Skip loading if already done and no reload is forced
if (NotesLoaded && !forceReload) if (_Song.NotesLoaded && !forceReload)
return true; return true;
string filePath = Path.Combine(_Song.Folder, _Song.FileName);
if (!File.Exists(filePath)) if (!File.Exists(filePath))
{ {
CBase.Log.LogError("Error loading song. The file does not exist: " + filePath); CBase.Log.LogError("Error loading song. The file does not exist: " + filePath);
@@ -341,7 +352,7 @@ namespace VocaluxeLib.Songs
} }
int currentBeat = 0; //Used for relative songs int currentBeat = 0; //Used for relative songs
bool isNewSentence = false; int lastNoteEnd = 0;
bool endFound = false; bool endFound = false;
int player = 1; int player = 1;
@@ -353,9 +364,9 @@ namespace VocaluxeLib.Songs
StreamReader sr = null; StreamReader sr = null;
try try
{ {
sr = new StreamReader(filePath, Encoding); sr = new StreamReader(filePath, _Song.Encoding);
Notes.Reset(); _Song.Notes.Reset();
//Search for Note Beginning //Search for Note Beginning
while (!sr.EndOfStream && !endFound) while (!sr.EndOfStream && !endFound)
@@ -429,7 +440,7 @@ namespace VocaluxeLib.Songs
else else
noteType = ENoteType.Normal; noteType = ENoteType.Normal;
if (Relative == EOffOn.TR_CONFIG_ON) if (_Song.Relative)
beat += currentBeat; beat += currentBeat;
int curPlayer = 0; int curPlayer = 0;
@@ -446,15 +457,9 @@ namespace VocaluxeLib.Songs
curPlayer++; curPlayer++;
} }
} }
isNewSentence = false; lastNoteEnd = beat + length;
break; break;
case '-': case '-':
if (isNewSentence)
{
_LogReadError("Error: Double sentence break", lineNr);
sr.Dispose();
return false;
}
string[] lineBreakData = line.Split(splitChars); string[] lineBreakData = line.Split(splitChars);
if (lineBreakData.Length < 1) if (lineBreakData.Length < 1)
{ {
@@ -469,7 +474,7 @@ namespace VocaluxeLib.Songs
return false; return false;
} }
if (Relative == EOffOn.TR_CONFIG_ON) if (_Song.Relative)
{ {
beat += currentBeat; beat += currentBeat;
if (lineBreakData.Length < 2 || !int.TryParse(lineBreakData[1], out length)) if (lineBreakData.Length < 2 || !int.TryParse(lineBreakData[1], out length))
@@ -478,6 +483,12 @@ namespace VocaluxeLib.Songs
currentBeat += length; currentBeat += length;
} }
if (beat < lastNoteEnd)
{
_LogReadError("Warning: Line break is before previous note end. Adjusted it (might not work for relative songs)", lineNr);
beat = lastNoteEnd;
}
if (beat < 1) if (beat < 1)
_LogReadError("Warning: Ignored line break because position is < 1", lineNr); _LogReadError("Warning: Ignored line break because position is < 1", lineNr);
else else
@@ -495,8 +506,6 @@ namespace VocaluxeLib.Songs
tmpPlayer >>= 1; tmpPlayer >>= 1;
curPlayer++; curPlayer++;
} }
isNewSentence = true;
} }
break; break;
default: default:
@@ -505,7 +514,7 @@ namespace VocaluxeLib.Songs
} }
} }
foreach (CVoice voice in Notes.Voices) foreach (CVoice voice in _Song.Notes.Voices)
voice.UpdateTimings(); voice.UpdateTimings();
} }
catch (Exception e) catch (Exception e)
@@ -518,11 +527,11 @@ namespace VocaluxeLib.Songs
sr.Dispose(); sr.Dispose();
try try
{ {
_FindRefrain(); _Song._FindRefrain();
_FindShortEnd(); _Song._FindShortEnd();
NotesLoaded = true; _Song.NotesLoaded = true;
if (IsDuet) if (_Song.IsDuet)
_CheckDuet(); _Song._CheckDuet();
} }
catch (Exception e) catch (Exception e)
{ {
@@ -535,14 +544,15 @@ namespace VocaluxeLib.Songs
private bool _ParseNote(int player, ENoteType noteType, int start, int length, int tone, string text) private bool _ParseNote(int player, ENoteType noteType, int start, int length, int tone, string text)
{ {
var note = new CSongNote(start, length, tone, text, noteType); var note = new CSongNote(start, length, tone, text, noteType);
CVoice voice = Notes.GetVoice(player); CVoice voice = _Song.Notes.GetVoice(player);
return voice.AddNote(note, false); return voice.AddNote(note, false);
} }
private bool _NewSentence(int player, int start) private bool _NewSentence(int player, int start)
{ {
CVoice voice = Notes.GetVoice(player); CVoice voice = _Song.Notes.GetVoice(player);
return voice.AddLine(start); return voice.AddLine(start);
} }
} }
}
} }