added song loading stubs with different strategies chosen by file extension

9 files changed, 436 insertions, 2 deletions

diff --git a/src/base/song.hpp b/src/base/song.hpp
new file mode 100644
index 00000000..90226932
--- /dev/null
+++ b/src/base/song.hpp
@@ -0,0 +1,74 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef SONG_HPP
+#define SONG_HPP
+
+#include <string>
+
+namespace usdx
+{
+	class Song
+	{
+	private:
+		std::string title;
+		std::string artist;
+
+		// filenames
+		std::string mp3;
+
+		std::string background;
+
+		std::string video;
+		float video_gap;
+
+		std::string cover;
+		// texture cover_tex;
+
+		std::string genre;
+		std::string edition;
+		std::string language;
+		std::string year;
+		std::string creator;
+
+		int notes_gap;
+		float gap; // in miliseconds
+
+		float start; // in seconds
+		int finish; // in miliseconds
+		bool relative;
+		int resolution;
+		// TODO: bpm: array of TBPM
+
+		// TODO: list of LyricLines
+
+		// TODO: Encoding:   TEncoding;
+		// TODO: CustomTags: array of TCustomHeaderTag;
+	public:
+	};
+};
+
+#endif
diff --git a/src/base/songloading/songloader.cpp b/src/base/songloading/songloader.cpp
new file mode 100644
index 00000000..c4d1054d
--- /dev/null
+++ b/src/base/songloading/songloader.cpp
@@ -0,0 +1,76 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#include "songloader.hpp"
+#include "songloading_strategy_txt.hpp"
+#include "songloading_strategy_xml.hpp"
+
+namespace usdx
+{
+	log4cxx::LoggerPtr Songloader::log =
+		log4cxx::Logger::getLogger("usdx.base.songloading.Songloader");
+
+	Songloader *Songloader::instance = NULL;
+
+	Songloader::Songloader(void)
+	{
+		// add different strategies to map
+		strategies[".txt"] = new SongloadingStrategyTxt();
+		strategies[".xml"] = new SongloadingStrategyXml();
+	}
+
+	Songloader::~Songloader(void)
+	{
+		strategies.clear();
+	}
+
+	Songloader *Songloader::get_instance(void)
+	{
+		if (instance == NULL) {
+			instance = new Songloader();
+		}
+
+		return instance;
+	}
+
+	Song *Songloader::load(std::string filename)
+	{
+		std::string extension = "";
+
+		size_t found = filename.rfind('.');
+		if (found != std::string::npos) {
+			extension = filename.substr(found);
+		}
+
+		std::map<std::string, SongloadingStrategy*>::iterator it = strategies.find(extension);
+		if (it == strategies.end()) {
+			LOG4CXX_WARN(log, "No SongloadingStrategy found for file extension: '" << extension << "'");
+			throw "Unknown file format.";
+		}
+
+		return it->second->loadSong(filename);
+	}
+};
diff --git a/src/base/songloading/songloader.hpp b/src/base/songloading/songloader.hpp
new file mode 100644
index 00000000..3c0b8e6f
--- /dev/null
+++ b/src/base/songloading/songloader.hpp
@@ -0,0 +1,60 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef SONGLOADER_HPP
+#define SONGLOADER_HPP
+
+#include <map>
+#include <log4cxx/logger.h>
+#include "songloading_strategy.hpp"
+#include "song.hpp"
+
+namespace usdx
+{
+	class Songloader
+	{
+	private:
+		static log4cxx::LoggerPtr log;
+
+		Songloader(void);
+
+		std::map<std::string, SongloadingStrategy*> strategies;
+
+		/**
+		 * Singleton
+		 */
+		static Songloader *instance;
+
+	public:
+		Songloader *get_instance(void);
+
+		virtual ~Songloader(void);
+
+		Song *load(std::string filename);
+	};
+};
+
+#endif
diff --git a/src/base/songloading/songloading_strategy.hpp b/src/base/songloading/songloading_strategy.hpp
new file mode 100644
index 00000000..4f5edd0f
--- /dev/null
+++ b/src/base/songloading/songloading_strategy.hpp
@@ -0,0 +1,47 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef SONGLOADING_STRATEGY_HPP
+#define SONGLOADING_STRATEGY_HPP
+
+#include <string>
+#include "song.hpp"
+
+namespace usdx
+{
+	class SongloadingStrategy
+	{
+	protected:
+		SongloadingStrategy() {};
+
+	public:
+		virtual ~SongloadingStrategy() {};
+
+		virtual Song* loadSong(std::string filename) = 0;
+	};
+};
+
+#endif
diff --git a/src/base/songloading/songloading_strategy_txt.cpp b/src/base/songloading/songloading_strategy_txt.cpp
new file mode 100644
index 00000000..e8238f4a
--- /dev/null
+++ b/src/base/songloading/songloading_strategy_txt.cpp
@@ -0,0 +1,44 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#include "songloading_strategy_txt.hpp"
+
+namespace usdx
+{
+	SongloadingStrategyTxt::SongloadingStrategyTxt(void)
+	{
+	}
+
+	SongloadingStrategyTxt::~SongloadingStrategyTxt(void)
+	{
+	}
+
+	Song* SongloadingStrategyTxt::loadSong(std::string filename)
+	{
+		// TODO
+		return NULL;
+	}
+};
diff --git a/src/base/songloading/songloading_strategy_txt.hpp b/src/base/songloading/songloading_strategy_txt.hpp
new file mode 100644
index 00000000..7a298e41
--- /dev/null
+++ b/src/base/songloading/songloading_strategy_txt.hpp
@@ -0,0 +1,45 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef SONGLOADING_STRATEGY_TXT_HPP
+#define SONGLOADING_STRATEGY_TXT_HPP
+
+#include <string>
+#include "songloading_strategy.hpp"
+
+namespace usdx
+{
+	class SongloadingStrategyTxt : public SongloadingStrategy
+	{
+	public:
+		SongloadingStrategyTxt();
+		virtual ~SongloadingStrategyTxt();
+
+		virtual Song* loadSong(std::string filename);
+	};
+};
+
+#endif
diff --git a/src/base/songloading/songloading_strategy_xml.cpp b/src/base/songloading/songloading_strategy_xml.cpp
new file mode 100644
index 00000000..52d1f7cf
--- /dev/null
+++ b/src/base/songloading/songloading_strategy_xml.cpp
@@ -0,0 +1,44 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#include "songloading_strategy_xml.hpp"
+
+namespace usdx
+{
+	SongloadingStrategyXml::SongloadingStrategyXml(void)
+	{
+	}
+
+	SongloadingStrategyXml::~SongloadingStrategyXml(void)
+	{
+	}
+
+	Song* SongloadingStrategyXml::loadSong(std::string filename)
+	{
+		// TODO
+		return NULL;
+	}
+};
diff --git a/src/base/songloading/songloading_strategy_xml.hpp b/src/base/songloading/songloading_strategy_xml.hpp
new file mode 100644
index 00000000..b656fe9a
--- /dev/null
+++ b/src/base/songloading/songloading_strategy_xml.hpp
@@ -0,0 +1,44 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef SONGLOADING_STRATEGY_XML_HPP
+#define SONGLOADING_STRATEGY_XML_HPP
+
+#include "songloading_strategy.hpp"
+
+namespace usdx
+{
+	class SongloadingStrategyXml : public SongloadingStrategy
+	{
+	public:
+		SongloadingStrategyXml(void);
+		virtual ~SongloadingStrategyXml(void);
+
+		virtual Song* loadSong(std::string filename);
+	};
+};
+
+#endif
diff --git a/test/Makefile b/test/Makefile
index 523371a0..25223d6b 100644
--- a/test/Makefile
+++ b/test/Makefile
@@ -5,8 +5,8 @@ PROJECT:=usdx-tests
 TARGET:=$(PROJECT)
 
 zip:=$(PROJECT).rar
-headers:=$(wildcard *.hpp) $(wildcard */*.hpp) $(wildcard ../src/*/*.hpp) $(wildcard ../src/*.hpp)
-sources:=$(wildcard *.cpp) $(wildcard */*.cpp) $(wildcard ../src/*/*.cpp) $(wildcard ../src/*.cpp)
+headers:=$(wildcard *.hpp) $(wildcard */*.hpp) $(wildcard ../src/*/*/*.hpp) $(wildcard ../src/*/*.hpp) $(wildcard ../src/*.hpp)
+sources:=$(wildcard *.cpp) $(wildcard */*.cpp) $(wildcard ../src/*/*/*.cpp) $(wildcard ../src/*/*.cpp) $(wildcard ../src/*.cpp)
 objects:=$(sources:.cpp=.o)
 deps:=$(sources:.cpp=.d)