Introduce SongLoader class as some fields are only required while loading

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

No files matched your search

+1 -1
View File
@@ -312,7 +312,7 @@ namespace Vocaluxe.Base
if (song == null)
continue;
song.ID = _Songs.Count;
if (song.ReadNotes())
if (song.LoadNotes())
_Songs.Add(song);
}
CLog.StopBenchmark(2, "Read TXTs");
+14 -7
View File
@@ -82,7 +82,7 @@ namespace VocaluxeLib.Songs
public string Folder = String.Empty;
public string FolderName = String.Empty;
public string FileName = String.Empty;
public EOffOn Relative = EOffOn.TR_CONFIG_OFF;
public bool Relative;
public string MP3FileName = 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
private CSong() {}
public static CSong LoadSong(string filePath)
{
var song = new CSong();
return song._InitPaths(filePath) && song._ReadHeader() ? song : null;
}
public CSong(CSong song)
{
_CoverTextureSmall = song._CoverTextureSmall;
@@ -236,6 +230,19 @@ namespace VocaluxeLib.Songs
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()
{
return Path.Combine(Folder, MP3FileName);
+1 -1
View File
@@ -133,7 +133,7 @@ namespace VocaluxeLib.Songs
//Maybe we have to split the previous line
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);
prevLine.DeleteNote(prevLine.NoteCount - 1);
}
+102 -92
View File
@@ -11,49 +11,58 @@ namespace VocaluxeLib.Songs
/// </summary>
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))
return false;
Folder = Path.GetDirectoryName(filePath);
if (Folder == null)
_Song.Folder = Path.GetDirectoryName(filePath);
if (_Song.Folder == null)
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)
FolderName = "Songs";
if (_Song.Folder.Length == folder.Length)
_Song.FolderName = "Songs";
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)
FolderName = FolderName.Substring(0, pos);
_Song.FolderName = _Song.FolderName.Substring(0, pos);
}
break;
}
FileName = Path.GetFileName(filePath);
_Song.FileName = Path.GetFileName(filePath);
return true;
}
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))
return false;
Language.Clear();
Genre.Clear();
_Comment.Clear();
_Song.Language.Clear();
_Song.Genre.Clear();
_Song._Comment.Clear();
var headerFlags = new EHeaderFlags();
StreamReader sr = null;
@@ -96,47 +105,47 @@ namespace VocaluxeLib.Songs
{
sr.Dispose();
sr = null;
return _ReadHeader(Encoding);
return ReadHeader(_Song.Encoding);
}
break;
case "TITLE":
Title = value;
_Song.Title = value;
headerFlags |= EHeaderFlags.Title;
break;
case "ARTIST":
Artist = value;
_Song.Artist = value;
headerFlags |= EHeaderFlags.Artist;
break;
case "TITLE-ON-SORTING":
TitleSorting = value;
_Song.TitleSorting = value;
break;
case "ARTIST-ON-SORTING":
ArtistSorting = value;
_Song.ArtistSorting = value;
break;
case "DUETSINGERP1":
case "P1":
Notes.VoiceNames[0] = value;
_Song.Notes.VoiceNames[0] = value;
break;
case "DUETSINGERP2":
case "P2":
Notes.VoiceNames[1] = value;
_Song.Notes.VoiceNames[1] = value;
break;
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;
}
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;
}
break;
case "BPM":
if (CHelper.TryParse(value, out BPM))
if (CHelper.TryParse(value, out _Song.BPM))
{
BPM *= 4;
_Song.BPM *= 4;
headerFlags |= EHeaderFlags.BPM;
}
else
@@ -144,102 +153,102 @@ namespace VocaluxeLib.Songs
break;
case "EDITION":
if (value.Length > 1)
Edition.Add(value);
_Song.Edition.Add(value);
else
_LogReadError("Warning: Invalid edition", lineNr);
break;
case "GENRE":
if (value.Length > 1)
Genre.Add(value);
_Song.Genre.Add(value);
else
_LogReadError("Warning: Invalid genre", lineNr);
break;
case "YEAR":
int num;
if (value.Length == 4 && int.TryParse(value, out num) && num > 0)
Year = value;
_Song.Year = value;
else
_LogReadError("Warning: Invalid year", lineNr);
break;
case "LANGUAGE":
if (value.Length > 1)
Language.Add(value);
_Song.Language.Add(value);
else
_LogReadError("Warning: Invalid language", lineNr);
break;
case "COMMENT":
if (value.Length > 1)
_Comment.Add(value);
_Song._Comment.Add(value);
else
_LogReadError("Warning: Invalid comment", lineNr);
break;
case "GAP":
if (CHelper.TryParse(value, out Gap))
Gap /= 1000f;
if (CHelper.TryParse(value, out _Song.Gap))
_Song.Gap /= 1000f;
else
_LogReadError("Warning: Invalid gap", lineNr);
break;
case "COVER":
if (File.Exists(Path.Combine(Folder, value)))
CoverFileName = value;
if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.CoverFileName = value;
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;
case "BACKGROUND":
if (File.Exists(Path.Combine(Folder, value)))
BackgroundFileName = value;
if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.BackgroundFileName = value;
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;
case "VIDEO":
if (File.Exists(Path.Combine(Folder, value)))
VideoFileName = value;
if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.VideoFileName = value;
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;
case "VIDEOGAP":
if (!CHelper.TryParse(value, out VideoGap))
if (!CHelper.TryParse(value, out _Song.VideoGap))
_LogReadError("Warning: Invalid videogap", lineNr);
break;
case "VIDEOASPECT":
if (!CHelper.TryParse(value, out VideoAspect, true))
if (!CHelper.TryParse(value, out _Song.VideoAspect, true))
_LogReadError("Warning: Invalid videoaspect", lineNr);
break;
case "START":
if (!CHelper.TryParse(value, out Start))
if (!CHelper.TryParse(value, out _Song.Start))
_LogReadError("Warning: Invalid start", lineNr);
break;
case "END":
if (CHelper.TryParse(value, out Finish))
Finish /= 1000f;
if (CHelper.TryParse(value, out _Song.Finish))
_Song.Finish /= 1000f;
else
_LogReadError("Warning: Invalid end", lineNr);
break;
case "PREVIEWSTART":
if (CHelper.TryParse(value, out PreviewStart) && PreviewStart >= 0f)
if (CHelper.TryParse(value, out _Song.PreviewStart) && _Song.PreviewStart >= 0f)
headerFlags |= EHeaderFlags.PreviewStart;
else
_LogReadError("Warning: Invalid previewstart", lineNr);
break;
case "MEDLEYSTARTBEAT":
if (int.TryParse(value, out Medley.StartBeat))
if (int.TryParse(value, out _Song.Medley.StartBeat))
headerFlags |= EHeaderFlags.MedleyStartBeat;
else
_LogReadError("Warning: Invalid medleystartbeat", lineNr);
break;
case "MEDLEYENDBEAT":
if (int.TryParse(value, out Medley.EndBeat))
if (int.TryParse(value, out _Song.Medley.EndBeat))
headerFlags |= EHeaderFlags.MedleyEndBeat;
else
_LogReadError("Warning: Invalid medleyendbeat", lineNr);
break;
case "CALCMEDLEY":
if (value.ToUpper() == "OFF")
CalculateMedley = false;
_Song.CalculateMedley = false;
break;
case "RELATIVE":
if (value.ToUpper() == "YES")
Relative = EOffOn.TR_CONFIG_ON;
_Song.Relative = true;
break;
}
} //end of while
@@ -278,28 +287,28 @@ namespace VocaluxeLib.Songs
#region check medley tags
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);
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 = (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)
{
Medley.Source = EMedleySource.Tag;
Medley.FadeInTime = CBase.Settings.GetDefaultMedleyFadeInTime();
Medley.FadeOutTime = CBase.Settings.GetDefaultMedleyFadeOutTime();
_Song.Medley.Source = EMedleySource.Tag;
_Song.Medley.FadeInTime = CBase.Settings.GetDefaultMedleyFadeInTime();
_Song.Medley.FadeOutTime = CBase.Settings.GetDefaultMedleyFadeOutTime();
}
#endregion check medley tags
Encoding = sr.CurrentEncoding;
_Song.Encoding = sr.CurrentEncoding;
}
catch (Exception e)
{
@@ -309,31 +318,33 @@ namespace VocaluxeLib.Songs
return false;
}
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.
if (ArtistSorting == "")
ArtistSorting = Artist;
if (_Song.ArtistSorting == "")
_Song.ArtistSorting = _Song.Artist;
if (TitleSorting == "")
TitleSorting = Title;
if (_Song.TitleSorting == "")
_Song.TitleSorting = _Song.Title;
return true;
}
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
if (NotesLoaded && !forceReload)
if (_Song.NotesLoaded && !forceReload)
return true;
string filePath = Path.Combine(_Song.Folder, _Song.FileName);
if (!File.Exists(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
bool isNewSentence = false;
int lastNoteEnd = 0;
bool endFound = false;
int player = 1;
@@ -353,9 +364,9 @@ namespace VocaluxeLib.Songs
StreamReader sr = null;
try
{
sr = new StreamReader(filePath, Encoding);
sr = new StreamReader(filePath, _Song.Encoding);
Notes.Reset();
_Song.Notes.Reset();
//Search for Note Beginning
while (!sr.EndOfStream && !endFound)
@@ -429,7 +440,7 @@ namespace VocaluxeLib.Songs
else
noteType = ENoteType.Normal;
if (Relative == EOffOn.TR_CONFIG_ON)
if (_Song.Relative)
beat += currentBeat;
int curPlayer = 0;
@@ -446,15 +457,9 @@ namespace VocaluxeLib.Songs
curPlayer++;
}
}
isNewSentence = false;
lastNoteEnd = beat + length;
break;
case '-':
if (isNewSentence)
{
_LogReadError("Error: Double sentence break", lineNr);
sr.Dispose();
return false;
}
string[] lineBreakData = line.Split(splitChars);
if (lineBreakData.Length < 1)
{
@@ -469,7 +474,7 @@ namespace VocaluxeLib.Songs
return false;
}
if (Relative == EOffOn.TR_CONFIG_ON)
if (_Song.Relative)
{
beat += currentBeat;
if (lineBreakData.Length < 2 || !int.TryParse(lineBreakData[1], out length))
@@ -478,6 +483,12 @@ namespace VocaluxeLib.Songs
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)
_LogReadError("Warning: Ignored line break because position is < 1", lineNr);
else
@@ -495,8 +506,6 @@ namespace VocaluxeLib.Songs
tmpPlayer >>= 1;
curPlayer++;
}
isNewSentence = true;
}
break;
default:
@@ -505,7 +514,7 @@ namespace VocaluxeLib.Songs
}
}
foreach (CVoice voice in Notes.Voices)
foreach (CVoice voice in _Song.Notes.Voices)
voice.UpdateTimings();
}
catch (Exception e)
@@ -518,11 +527,11 @@ namespace VocaluxeLib.Songs
sr.Dispose();
try
{
_FindRefrain();
_FindShortEnd();
NotesLoaded = true;
if (IsDuet)
_CheckDuet();
_Song._FindRefrain();
_Song._FindShortEnd();
_Song.NotesLoaded = true;
if (_Song.IsDuet)
_Song._CheckDuet();
}
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)
{
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);
}
private bool _NewSentence(int player, int start)
{
CVoice voice = Notes.GetVoice(player);
CVoice voice = _Song.Notes.GetVoice(player);
return voice.AddLine(start);
}
}
}
}