Add metadata support to xml parser and dom model. RE-add unit-tests for version 1 instruments.

1 files changed, 149 insertions, 5 deletions

diff --git a/test/dgxmlparsertest.cc b/test/dgxmlparsertest.cc
index 30bcfa7..a1f7bd3 100644
--- a/test/dgxmlparsertest.cc
+++ b/test/dgxmlparsertest.cc
@@ -35,11 +35,121 @@ class DGXmlParserTest
 public:
 	DGXmlParserTest()
 	{
-		DGUNIT_TEST(DGXmlParserTest::instrumentParserTest);
+		DGUNIT_TEST(DGXmlParserTest::instrumentParserTest_v1);
+		DGUNIT_TEST(DGXmlParserTest::instrumentParserTest_v2);
 		DGUNIT_TEST(DGXmlParserTest::drumkitParserTest);
 	}
 
-	void instrumentParserTest()
+	void instrumentParserTest_v1()
+	{
+		ScopedFile scoped_file(
+			"<?xml version='1.0' encoding='UTF-8'?>\n" \
+			"<instrument name=\"Snare\" description=\"A nice snare\">\n" \
+			" <samples>\n" \
+			"  <sample name=\"Snare-1\">\n" \
+			"   <audiofile channel=\"AmbLeft\" file=\"1-Snare-1.wav\"/>\n" \
+			"   <audiofile channel=\"AmbRight\" file=\"1-Snare-2.wav\"/>\n" \
+			"   <audiofile channel=\"SnareBottom\" file=\"1-Snare-3.wav\"/>\n" \
+			"   <audiofile channel=\"SnareTop\" file=\"1-Snare-4.wav\"/>\n" \
+			"  </sample>\n" \
+			"  <sample name=\"Snare-2\">\n" \
+			"   <audiofile channel=\"AmbLeft\" file=\"2-Snare-1.wav\"/>\n" \
+			"   <audiofile channel=\"AmbRight\" file=\"2-Snare-2.wav\"/>\n" \
+			"   <audiofile channel=\"SnareBottom\" file=\"2-Snare-3.wav\"/>\n" \
+			"   <audiofile channel=\"SnareTop\" file=\"2-Snare-4.wav\"/>\n" \
+			"  </sample>\n" \
+			" </samples>\n" \
+			" <velocities>\n" \
+			"  <velocity lower=\"0\" upper=\"0.6\">\n" \
+			"   <sampleref probability=\"0.6\" name=\"Snare-1\"/>\n" \
+			"   <sampleref probability=\"0.4\" name=\"Snare-2\"/>\n" \
+			"  </velocity>" \
+			"  <velocity lower=\"0.6\" upper=\"1.0\">" \
+			"   <sampleref probability=\"0.4\" name=\"Snare-2\"/>" \
+			"   <sampleref probability=\"0.6\" name=\"Snare-1\"/>" \
+			"  </velocity>" \
+			" </velocities>" \
+			"</instrument>");
+
+		InstrumentDOM dom;
+		DGUNIT_ASSERT(probeInstrumentFile(scoped_file.filename()));
+		DGUNIT_ASSERT(parseInstrumentFile(scoped_file.filename(), dom));
+
+		DGUNIT_ASSERT_EQUAL(std::string("Snare"), dom.name);
+		DGUNIT_ASSERT_EQUAL(std::string("1.0"), dom.version);
+		DGUNIT_ASSERT_EQUAL(std::string("A nice snare"), dom.description);
+		DGUNIT_ASSERT_EQUAL(std::size_t(2), dom.samples.size());
+
+		{
+			const auto& s = dom.samples[0];
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-1"), s.name);
+			DGUNIT_ASSERT_EQUAL(std::size_t(4), s.audiofiles.size());
+
+			DGUNIT_ASSERT_EQUAL(std::string("AmbLeft"), s.audiofiles[0].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("1-Snare-1.wav"), s.audiofiles[0].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[0].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("AmbRight"), s.audiofiles[1].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("1-Snare-2.wav"), s.audiofiles[1].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[1].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("SnareBottom"), s.audiofiles[2].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("1-Snare-3.wav"), s.audiofiles[2].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[2].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("SnareTop"), s.audiofiles[3].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("1-Snare-4.wav"), s.audiofiles[3].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[3].filechannel);
+		}
+
+		{
+			const auto& s = dom.samples[1];
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-2"), s.name);
+			DGUNIT_ASSERT_EQUAL(std::size_t(4), s.audiofiles.size());
+			DGUNIT_ASSERT_EQUAL(std::string("AmbLeft"), s.audiofiles[0].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("2-Snare-1.wav"), s.audiofiles[0].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[0].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("AmbRight"), s.audiofiles[1].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("2-Snare-2.wav"), s.audiofiles[1].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[1].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("SnareBottom"), s.audiofiles[2].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("2-Snare-3.wav"), s.audiofiles[2].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[2].filechannel);
+
+			DGUNIT_ASSERT_EQUAL(std::string("SnareTop"), s.audiofiles[3].instrument_channel);
+			DGUNIT_ASSERT_EQUAL(std::string("2-Snare-4.wav"), s.audiofiles[3].file);
+			DGUNIT_ASSERT_EQUAL(std::size_t(1), s.audiofiles[3].filechannel);
+		}
+
+		DGUNIT_ASSERT_EQUAL(std::size_t(0), dom.instrument_channels.size());
+
+		DGUNIT_ASSERT_EQUAL(std::size_t(2), dom.velocities.size());
+		{
+			const auto& velocity = dom.velocities[0];
+			DGUNIT_ASSERT_EQUAL(0.0, velocity.lower);
+			DGUNIT_ASSERT_EQUAL(0.6, velocity.upper);
+			DGUNIT_ASSERT_EQUAL(std::size_t(2), velocity.samplerefs.size());
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-1"), velocity.samplerefs[0].name);
+			DGUNIT_ASSERT_EQUAL(0.6, velocity.samplerefs[0].probability);
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-2"), velocity.samplerefs[1].name);
+			DGUNIT_ASSERT_EQUAL(0.4, velocity.samplerefs[1].probability);
+		}
+
+		{
+			const auto& velocity = dom.velocities[1];
+			DGUNIT_ASSERT_EQUAL(0.6, velocity.lower);
+			DGUNIT_ASSERT_EQUAL(1.0, velocity.upper);
+			DGUNIT_ASSERT_EQUAL(std::size_t(2), velocity.samplerefs.size());
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-2"), velocity.samplerefs[0].name);
+			DGUNIT_ASSERT_EQUAL(0.4, velocity.samplerefs[0].probability);
+			DGUNIT_ASSERT_EQUAL(std::string("Snare-1"), velocity.samplerefs[1].name);
+			DGUNIT_ASSERT_EQUAL(0.6, velocity.samplerefs[1].probability);
+		}
+}
+
+	void instrumentParserTest_v2()
 	{
 		ScopedFile scoped_file(
 			"<?xml version='1.0' encoding='UTF-8'?>\n" \
@@ -126,13 +236,30 @@ public:
 		DGUNIT_ASSERT(main_state_t::is_not_main == dom.instrument_channels[1].main);
 		DGUNIT_ASSERT_EQUAL(std::string("SnareBottom"), dom.instrument_channels[2].name);
 		DGUNIT_ASSERT(main_state_t::unset == dom.instrument_channels[2].main);
+
+		DGUNIT_ASSERT_EQUAL(std::size_t(0), dom.velocities.size());
 	}
 
 	void drumkitParserTest()
 	{
 		ScopedFile scoped_file(
 			"<?xml version='1.0' encoding='UTF-8'?>\n" \
-			"<drumkit name=\"CrocellKit\" description=\"my description\" samplerate=\"48000\" version=\"2.0\">\n" \
+			"<drumkit samplerate=\"48000\" version=\"2.0\">\n" \
+			"  <metadata>\n" \
+			"    <version>1.2.3</version>\n" \
+			"    <title>Test Kit</title>\n" \
+			"    <logo src=\"LogoFile.png\"/>\n" \
+			"    <description>This is the description of the drumkit</description>\n" \
+			"    <license>Creative Commons</license>\n" \
+			"    <notes>These are general notes</notes>\n" \
+			"    <author>Author of the drumkit</author>\n" \
+			"    <email>author@email.org</email>\n" \
+			"    <website>http://www.drumgizmo.org</website>\n" \
+			"    <image src=\"DrumkitImage.png\" map=\"DrumkitImageClickMap.png\">\n" \
+			"      <clickmap colour=\"ff08a2\" instrument=\"China\"/>\n" \
+			"      <clickmap colour=\"a218d7\" instrument=\"HihatClosed\"/>\n" \
+			"    </image>\n" \
+			"  </metadata>\n" \
 			"  <channels>\n" \
 			"   <channel name=\"AmbLeft\"/>\n" \
 			"   <channel name=\"AmbRight\"/>\n" \
@@ -159,10 +286,27 @@ public:
 		DGUNIT_ASSERT(probeDrumkitFile(scoped_file.filename()));
 		DGUNIT_ASSERT(parseDrumkitFile(scoped_file.filename(), dom));
 
-		DGUNIT_ASSERT_EQUAL(std::string("CrocellKit"), dom.name);
 		DGUNIT_ASSERT_EQUAL(std::string("2.0"), dom.version);
-		DGUNIT_ASSERT_EQUAL(std::string("my description"), dom.description);
 		DGUNIT_ASSERT_EQUAL(48000.0, dom.samplerate);
+
+		DGUNIT_ASSERT_EQUAL(std::string("1.2.3"), dom.metadata.version);
+		DGUNIT_ASSERT_EQUAL(std::string("Test Kit"), dom.metadata.title);
+		DGUNIT_ASSERT_EQUAL(std::string("LogoFile.png"), dom.metadata.logo);
+		DGUNIT_ASSERT_EQUAL(std::string("This is the description of the drumkit"), dom.metadata.description);
+		DGUNIT_ASSERT_EQUAL(std::string("Creative Commons"), dom.metadata.license);
+		DGUNIT_ASSERT_EQUAL(std::string("These are general notes"), dom.metadata.notes);
+		DGUNIT_ASSERT_EQUAL(std::string("Author of the drumkit"), dom.metadata.author);
+		DGUNIT_ASSERT_EQUAL(std::string("author@email.org"), dom.metadata.email);
+		DGUNIT_ASSERT_EQUAL(std::string("http://www.drumgizmo.org"), dom.metadata.website);
+		DGUNIT_ASSERT_EQUAL(std::string("DrumkitImage.png"), dom.metadata.image);
+		DGUNIT_ASSERT_EQUAL(std::string("DrumkitImageClickMap.png"), dom.metadata.image_map);
+
+		DGUNIT_ASSERT_EQUAL(std::size_t(2), dom.metadata.clickmaps.size());
+		DGUNIT_ASSERT_EQUAL(std::string("ff08a2"), dom.metadata.clickmaps[0].colour);
+		DGUNIT_ASSERT_EQUAL(std::string("China"), dom.metadata.clickmaps[0].instrument);
+		DGUNIT_ASSERT_EQUAL(std::string("a218d7"), dom.metadata.clickmaps[1].colour);
+		DGUNIT_ASSERT_EQUAL(std::string("HihatClosed"), dom.metadata.clickmaps[1].instrument);
+
 		DGUNIT_ASSERT_EQUAL(std::size_t(2), dom.instruments.size());
 		{
 			const auto& instr = dom.instruments[0];