Easier logging in SongLoader

This commit is contained in:
Flamefire committed 2013-10-11 14:50:31 +02:00
1 parent 05e170e91a
commit 2ec094e734
5 files changed
+112 -87

No files matched your search

+20
View File
@@ -48,5 +48,25 @@ namespace VocaluxeLib
if (size > list.Count) if (size > list.Count)
list.Add(new T()); list.Add(new T());
} }
/// <summary>
/// Gets all set bits starting from lowest (Bit 0)
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
public static List<int> GetSetBits(this int value)
{
var result = new List<int>();
int curBit = 0;
//Evaluate as bitset
while (value > 0)
{
if ((value & 1) != 0)
result.Add(curBit);
value >>= 1;
curBit++;
}
return result;
}
} }
} }
-8
View File
@@ -23,14 +23,6 @@ using VocaluxeLib.Songs;
namespace VocaluxeLib.Menu namespace VocaluxeLib.Menu
{ {
struct SNote
{
public string Text;
public int StartBeat;
public int EndBeat;
public ENoteType Type;
}
struct SThemeLyrics struct SThemeLyrics
{ {
public string Name; public string Name;
+4 -4
View File
@@ -137,10 +137,10 @@ namespace VocaluxeLib.Songs
} }
public readonly List<string> Edition = new List<string>(); public readonly List<string> Edition = new List<string>();
public readonly List<string> Genre = new List<string>(); public readonly List<string> Genres = new List<string>();
public string Year = ""; public string Year = "";
public readonly List<string> Language = new List<string>(); public readonly List<string> Languages = new List<string>();
public int DataBaseSongID = -1; public int DataBaseSongID = -1;
public string DateAdded = ""; public string DateAdded = "";
@@ -217,11 +217,11 @@ namespace VocaluxeLib.Songs
Edition = new List<string>(song.Edition); Edition = new List<string>(song.Edition);
Genre = new List<string>(song.Genre); Genres = new List<string>(song.Genres);
Year = song.Year; Year = song.Year;
Language = new List<string>(song.Language); Languages = new List<string>(song.Languages);
DataBaseSongID = song.DataBaseSongID; DataBaseSongID = song.DataBaseSongID;
DateAdded = song.DateAdded; DateAdded = song.DateAdded;
+87 -74
View File
@@ -14,6 +14,7 @@ namespace VocaluxeLib.Songs
private class CSongLoader private class CSongLoader
{ {
private readonly CSong _Song; private readonly CSong _Song;
private int _LineNr;
public CSongLoader(CSong song) public CSongLoader(CSong song)
{ {
@@ -48,9 +49,27 @@ namespace VocaluxeLib.Songs
return true; return true;
} }
private void _LogReadError(string error, int lineNr) /// <summary>
/// Logs a given message with file name and line#
/// </summary>
/// <param name="msg">Message</param>
/// <param name="error">True prepends "Error: "; False prepends "Warning: "</param>
private void _LogMsg(string msg, bool error, bool withLineNr)
{ {
CBase.Log.LogError(error + " in line #" + lineNr + "(" + Path.Combine(_Song.Folder, _Song.FileName) + ")"); msg = (error ? "Error: " : "Warning: ") + msg;
if (withLineNr)
msg += " in line #" + _LineNr;
CBase.Log.LogError(msg + " (" + Path.Combine(_Song.Folder, _Song.FileName) + ")");
}
private void _LogError(string msg, bool withLineNr = true)
{
_LogMsg(msg, true, withLineNr);
}
private void _LogWarning(string msg, bool withLineNr = true)
{
_LogMsg(msg, false, withLineNr);
} }
public bool ReadHeader(Encoding encoding = null) public bool ReadHeader(Encoding encoding = null)
@@ -60,20 +79,20 @@ namespace VocaluxeLib.Songs
if (!File.Exists(filePath)) if (!File.Exists(filePath))
return false; return false;
_Song.Language.Clear(); _Song.Languages.Clear();
_Song.Genre.Clear(); _Song.Genres.Clear();
_Song._Comment.Clear(); _Song._Comment.Clear();
var headerFlags = new EHeaderFlags(); var headerFlags = new EHeaderFlags();
StreamReader sr = null; StreamReader sr = null;
int lineNr = 0; _LineNr = 0;
try try
{ {
sr = new StreamReader(filePath, Encoding.Default, true); sr = new StreamReader(filePath, Encoding.Default, true);
while (!sr.EndOfStream) while (!sr.EndOfStream)
{ {
string line = sr.ReadLine(); string line = sr.ReadLine();
lineNr++; _LineNr++;
if (line == "") if (line == "")
continue; continue;
if (!line[0].Equals('#')) if (!line[0].Equals('#'))
@@ -88,7 +107,7 @@ namespace VocaluxeLib.Songs
if (value == "") if (value == "")
{ {
_LogReadError("Warning: Empty value skipped", lineNr); _LogWarning("Empty value skipped");
continue; continue;
} }
@@ -97,7 +116,7 @@ namespace VocaluxeLib.Songs
case "ENCODING": case "ENCODING":
if (encoding != null) if (encoding != null)
{ {
_LogReadError("Warning: Duplicate encoding ignored", lineNr); _LogWarning("Duplicate encoding ignored");
continue; continue;
} }
Encoding newEncoding = CEncoding.GetEncoding(value); Encoding newEncoding = CEncoding.GetEncoding(value);
@@ -138,7 +157,7 @@ namespace VocaluxeLib.Songs
} }
else else
{ {
_LogReadError("Error: Can't find audio file: " + Path.Combine(_Song.Folder, value), lineNr); _LogError("Can't find audio file: " + Path.Combine(_Song.Folder, value));
return false; return false;
} }
break; break;
@@ -149,98 +168,98 @@ namespace VocaluxeLib.Songs
headerFlags |= EHeaderFlags.BPM; headerFlags |= EHeaderFlags.BPM;
} }
else else
_LogReadError("Warning: Invalid BPM value", lineNr); _LogWarning("Invalid BPM value");
break; break;
case "EDITION": case "EDITION":
if (value.Length > 1) if (value.Length > 1)
_Song.Edition.Add(value); _Song.Edition.Add(value);
else else
_LogReadError("Warning: Invalid edition", lineNr); _LogWarning("Invalid edition");
break; break;
case "GENRE": case "GENRE":
if (value.Length > 1) if (value.Length > 1)
_Song.Genre.Add(value); _Song.Genres.Add(value);
else else
_LogReadError("Warning: Invalid genre", lineNr); _LogWarning("Invalid genre");
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)
_Song.Year = value; _Song.Year = value;
else else
_LogReadError("Warning: Invalid year", lineNr); _LogWarning("Invalid year");
break; break;
case "LANGUAGE": case "LANGUAGE":
if (value.Length > 1) if (value.Length > 1)
_Song.Language.Add(value); _Song.Languages.Add(value);
else else
_LogReadError("Warning: Invalid language", lineNr); _LogWarning("Invalid language");
break; break;
case "COMMENT": case "COMMENT":
if (value.Length > 1) if (value.Length > 1)
_Song._Comment.Add(value); _Song._Comment.Add(value);
else else
_LogReadError("Warning: Invalid comment", lineNr); _LogWarning("Invalid comment");
break; break;
case "GAP": case "GAP":
if (CHelper.TryParse(value, out _Song.Gap)) if (CHelper.TryParse(value, out _Song.Gap))
_Song.Gap /= 1000f; _Song.Gap /= 1000f;
else else
_LogReadError("Warning: Invalid gap", lineNr); _LogWarning("Invalid gap");
break; break;
case "COVER": case "COVER":
if (File.Exists(Path.Combine(_Song.Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.CoverFileName = value; _Song.CoverFileName = value;
else else
_LogReadError("Warning: Can't find cover file: " + Path.Combine(_Song.Folder, value), lineNr); _LogWarning("Can't find cover file: " + Path.Combine(_Song.Folder, value));
break; break;
case "BACKGROUND": case "BACKGROUND":
if (File.Exists(Path.Combine(_Song.Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.BackgroundFileName = value; _Song.BackgroundFileName = value;
else else
_LogReadError("Warning: Can't find background file: " + Path.Combine(_Song.Folder, value), lineNr); _LogWarning("Can't find background file: " + Path.Combine(_Song.Folder, value));
break; break;
case "VIDEO": case "VIDEO":
if (File.Exists(Path.Combine(_Song.Folder, value))) if (File.Exists(Path.Combine(_Song.Folder, value)))
_Song.VideoFileName = value; _Song.VideoFileName = value;
else else
CBase.Log.LogError("Warning: Can't find video file: " + Path.Combine(_Song.Folder, value)); _LogWarning("Can't find video file: " + Path.Combine(_Song.Folder, value));
break; break;
case "VIDEOGAP": case "VIDEOGAP":
if (!CHelper.TryParse(value, out _Song.VideoGap)) if (!CHelper.TryParse(value, out _Song.VideoGap))
_LogReadError("Warning: Invalid videogap", lineNr); _LogWarning("Invalid videogap");
break; break;
case "VIDEOASPECT": case "VIDEOASPECT":
if (!CHelper.TryParse(value, out _Song.VideoAspect, true)) if (!CHelper.TryParse(value, out _Song.VideoAspect, true))
_LogReadError("Warning: Invalid videoaspect", lineNr); _LogWarning("Invalid videoaspect");
break; break;
case "START": case "START":
if (!CHelper.TryParse(value, out _Song.Start)) if (!CHelper.TryParse(value, out _Song.Start))
_LogReadError("Warning: Invalid start", lineNr); _LogWarning("Invalid start");
break; break;
case "END": case "END":
if (CHelper.TryParse(value, out _Song.Finish)) if (CHelper.TryParse(value, out _Song.Finish))
_Song.Finish /= 1000f; _Song.Finish /= 1000f;
else else
_LogReadError("Warning: Invalid end", lineNr); _LogWarning("Invalid end");
break; break;
case "PREVIEWSTART": case "PREVIEWSTART":
if (CHelper.TryParse(value, out _Song.PreviewStart) && _Song.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); _LogWarning("Invalid previewstart");
break; break;
case "MEDLEYSTARTBEAT": case "MEDLEYSTARTBEAT":
if (int.TryParse(value, out _Song.Medley.StartBeat)) if (int.TryParse(value, out _Song.Medley.StartBeat))
headerFlags |= EHeaderFlags.MedleyStartBeat; headerFlags |= EHeaderFlags.MedleyStartBeat;
else else
_LogReadError("Warning: Invalid medleystartbeat", lineNr); _LogWarning("Invalid medleystartbeat");
break; break;
case "MEDLEYENDBEAT": case "MEDLEYENDBEAT":
if (int.TryParse(value, out _Song.Medley.EndBeat)) if (int.TryParse(value, out _Song.Medley.EndBeat))
headerFlags |= EHeaderFlags.MedleyEndBeat; headerFlags |= EHeaderFlags.MedleyEndBeat;
else else
_LogReadError("Warning: Invalid medleyendbeat", lineNr); _LogWarning("Invalid medleyendbeat");
break; break;
case "CALCMEDLEY": case "CALCMEDLEY":
if (value.ToUpper() == "OFF") if (value.ToUpper() == "OFF")
@@ -250,37 +269,47 @@ namespace VocaluxeLib.Songs
if (value.ToUpper() == "YES") if (value.ToUpper() == "YES")
_Song.Relative = true; _Song.Relative = true;
break; break;
default:
if (identifier.StartsWith("DUETSINGER"))
identifier = identifier.Substring(10);
if (identifier.StartsWith("P"))
{
int player;
if (int.TryParse(identifier.Substring(1).Trim(), out player))
foreach (int curPlayer in player.GetSetBits()) {}
}
break;
} }
} //end of while } //end of while
if (sr.EndOfStream) if (sr.EndOfStream)
{ {
//No other data then header //No other data then header
CBase.Log.LogError("Lyrics/Notes missing: " + filePath); _LogError("Lyrics/Notes missing", false);
return false; return false;
} }
if ((headerFlags & EHeaderFlags.Title) == 0) if ((headerFlags & EHeaderFlags.Title) == 0)
{ {
CBase.Log.LogError("Title tag missing: " + filePath); _LogError("Title tag missing", false);
return false; return false;
} }
if ((headerFlags & EHeaderFlags.Artist) == 0) if ((headerFlags & EHeaderFlags.Artist) == 0)
{ {
CBase.Log.LogError("Artist tag missing: " + filePath); _LogError("Artist tag missing", false);
return false; return false;
} }
if ((headerFlags & EHeaderFlags.MP3) == 0) if ((headerFlags & EHeaderFlags.MP3) == 0)
{ {
CBase.Log.LogError("MP3 tag missing: " + filePath); _LogError("MP3 tag missing", false);
return false; return false;
} }
if ((headerFlags & EHeaderFlags.BPM) == 0) if ((headerFlags & EHeaderFlags.BPM) == 0)
{ {
CBase.Log.LogError("BPM tag missing: " + filePath); _LogError("BPM tag missing", false);
return false; return false;
} }
@@ -289,7 +318,7 @@ namespace VocaluxeLib.Songs
{ {
if (_Song.Medley.StartBeat > _Song.Medley.EndBeat) if (_Song.Medley.StartBeat > _Song.Medley.EndBeat)
{ {
CBase.Log.LogError("MedleyStartBeat is bigger than MedleyEndBeat in file: " + filePath); _LogError("MedleyStartBeat is bigger than MedleyEndBeat in file", false);
headerFlags = headerFlags - EHeaderFlags.MedleyStartBeat - EHeaderFlags.MedleyEndBeat; headerFlags = headerFlags - EHeaderFlags.MedleyStartBeat - EHeaderFlags.MedleyEndBeat;
} }
} }
@@ -314,7 +343,7 @@ namespace VocaluxeLib.Songs
{ {
if (sr != null) if (sr != null)
sr.Dispose(); sr.Dispose();
_LogReadError("Error reading txt header" + e.Message, lineNr); _LogError("Error reading txt header" + e.Message, false);
return false; return false;
} }
sr.Dispose(); sr.Dispose();
@@ -347,7 +376,7 @@ namespace VocaluxeLib.Songs
if (!File.Exists(filePath)) if (!File.Exists(filePath))
{ {
CBase.Log.LogError("Error loading song. The file does not exist: " + filePath); _LogError("The file does not exist", false);
return false; return false;
} }
@@ -356,7 +385,7 @@ namespace VocaluxeLib.Songs
bool endFound = false; bool endFound = false;
int player = 1; int player = 1;
int lineNr = 0; _LineNr = 0;
char[] trimChars = {' ', ':'}; char[] trimChars = {' ', ':'};
char[] splitChars = {' '}; char[] splitChars = {' '};
@@ -372,7 +401,7 @@ namespace VocaluxeLib.Songs
while (!sr.EndOfStream && !endFound) while (!sr.EndOfStream && !endFound)
{ {
string line = sr.ReadLine(); string line = sr.ReadLine();
lineNr++; _LineNr++;
if (String.IsNullOrEmpty(line)) if (String.IsNullOrEmpty(line))
continue; continue;
@@ -394,7 +423,7 @@ namespace VocaluxeLib.Songs
if (!int.TryParse(line, out player)) if (!int.TryParse(line, out player))
{ {
_LogReadError("Error: Wrong or missing number after \"P\"", lineNr); _LogError("Wrong or missing number after \"P\"");
return false; return false;
} }
sr.ReadLine(); sr.ReadLine();
@@ -407,28 +436,28 @@ namespace VocaluxeLib.Songs
{ {
if (noteData.Length == 3) if (noteData.Length == 3)
{ {
_LogReadError("Warning: Ignored note without text", lineNr); _LogWarning("Ignored note without text");
continue; continue;
} }
_LogReadError("Error: Invalid note found", lineNr); _LogError("Invalid note found");
sr.Dispose(); sr.Dispose();
return false; return false;
} }
int tone; int tone;
if (!int.TryParse(noteData[0], out beat) || !int.TryParse(noteData[1], out length) || !int.TryParse(noteData[2], out tone)) if (!int.TryParse(noteData[0], out beat) || !int.TryParse(noteData[1], out length) || !int.TryParse(noteData[2], out tone))
{ {
_LogReadError("Error: Invalid note found (non-numeric values)", lineNr); _LogError("Invalid note found (non-numeric values)");
sr.Dispose(); sr.Dispose();
return false; return false;
} }
string text = noteData[3]; string text = noteData[3];
if (text.Trim() == "") if (text.Trim() == "")
{ {
_LogReadError("Warning: Ignored note without text", lineNr); _LogWarning("Ignored note without text");
continue; continue;
} }
if (length < 1) if (length < 1)
_LogReadError("Warning: Ignored note with length < 1", lineNr); _LogWarning("Ignored note with length < 1");
else else
{ {
ENoteType noteType; ENoteType noteType;
@@ -443,18 +472,10 @@ namespace VocaluxeLib.Songs
if (_Song.Relative) if (_Song.Relative)
beat += currentBeat; beat += currentBeat;
int curPlayer = 0; foreach (int curPlayer in player.GetSetBits())
int tmpPlayer = player;
//Evaluate as bitset
while (tmpPlayer > 0)
{ {
if ((tmpPlayer & 1) != 0) if (!_ParseNote(curPlayer, noteType, beat, length, tone, text))
{ _LogWarning("Ignored note for player " + (curPlayer + 1) + " because it overlaps with other note");
if (!_ParseNote(curPlayer, noteType, beat, length, tone, text))
_LogReadError("Warning: Ignored note for player " + (curPlayer + 1) + " because it overlaps with other note", lineNr);
}
tmpPlayer >>= 1;
curPlayer++;
} }
} }
lastNoteEnd = beat + length; lastNoteEnd = beat + length;
@@ -463,13 +484,13 @@ namespace VocaluxeLib.Songs
string[] lineBreakData = line.Split(splitChars); string[] lineBreakData = line.Split(splitChars);
if (lineBreakData.Length < 1) if (lineBreakData.Length < 1)
{ {
_LogReadError("Error: Invalid line break found (No beat)", lineNr); _LogError("Invalid line break found (No beat)");
sr.Dispose(); sr.Dispose();
return false; return false;
} }
if (!int.TryParse(lineBreakData[0], out beat)) if (!int.TryParse(lineBreakData[0], out beat))
{ {
_LogReadError("Error: Invalid line break found (Non-numeric value)", lineNr); _LogError("Invalid line break found (Non-numeric value)");
sr.Dispose(); sr.Dispose();
return false; return false;
} }
@@ -478,38 +499,30 @@ namespace VocaluxeLib.Songs
{ {
beat += currentBeat; beat += currentBeat;
if (lineBreakData.Length < 2 || !int.TryParse(lineBreakData[1], out length)) if (lineBreakData.Length < 2 || !int.TryParse(lineBreakData[1], out length))
_LogReadError("Warning: Missing line break length", lineNr); _LogWarning("Missing line break length");
else else
currentBeat += length; currentBeat += length;
} }
if (beat < lastNoteEnd) if (beat < lastNoteEnd)
{ {
_LogReadError("Warning: Line break is before previous note end. Adjusted it (might not work for relative songs)", lineNr); _LogWarning("Line break is before previous note end. Adjusted it (might not work for relative songs)");
beat = lastNoteEnd; beat = lastNoteEnd;
} }
if (beat < 1) if (beat < 1)
_LogReadError("Warning: Ignored line break because position is < 1", lineNr); _LogWarning("Ignored line break because position is < 1");
else else
{ {
int curPlayer = 0; foreach (int curPlayer in player.GetSetBits())
int tmpPlayer = player;
//Evaluate as bitset
while (tmpPlayer > 0)
{ {
if ((tmpPlayer & 1) != 0) if (_NewSentence(curPlayer, beat))
{ _LogWarning("Ignored line break for player " + (curPlayer + 1) + " (Overlapping or duplicate)");
if (_NewSentence(curPlayer, beat))
_LogReadError("Warning: Ignored line break for player " + (curPlayer + 1) + " (Overlapping or duplicate)", lineNr);
}
tmpPlayer >>= 1;
curPlayer++;
} }
} }
break; break;
default: default:
_LogReadError("Error loading song. Unexpected or missing character (" + tag + ")", lineNr); _LogError("Error loading song. Unexpected or missing character (" + tag + ")");
return false; return false;
} }
} }
@@ -519,7 +532,7 @@ namespace VocaluxeLib.Songs
} }
catch (Exception e) catch (Exception e)
{ {
_LogReadError("Error: An unhandled exception occured (" + e.Message + ")", lineNr); _LogError("An unhandled exception occured (" + e.Message + ")");
if (sr != null) if (sr != null)
sr.Dispose(); sr.Dispose();
return false; return false;
@@ -535,7 +548,7 @@ namespace VocaluxeLib.Songs
} }
catch (Exception e) catch (Exception e)
{ {
CBase.Log.LogError("Error loading song. An unhandled exception occured (" + e.Message + "): " + filePath); _LogError("An unhandled exception occured (" + e.Message + ")", false);
return false; return false;
} }
return true; return true;
+1 -1
View File
@@ -48,7 +48,7 @@ namespace VocaluxeLib.Songs
} }
#region Properties #region Properties
public double Points; public new double Points;
// for drawing player notes // for drawing player notes
public bool Hit public bool Hit
{ {