Rework subtitle writing to fix incorrect output with

in-line font changes (#952).

2 files changed, 306 insertions, 6 deletions

diff --git a/test/test.cc b/test/test.cc
index 44f519c0..0b99b4b7 100644
--- a/test/test.cc
+++ b/test/test.cc
@@ -24,6 +24,7 @@
 #include <libxml++/libxml++.h>
 #include <boost/test/unit_test.hpp>
 #include <cstdio>
+#include <iostream>
 
 using std::string;
 using std::min;
@@ -54,7 +55,7 @@ check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 
 	xmlpp::Element::NodeList ref_children = ref->get_children ();
 	xmlpp::Element::NodeList test_children = test->get_children ();
-	BOOST_REQUIRE_EQUAL (ref_children.size (), test_children.size ());
+	BOOST_REQUIRE_MESSAGE (ref_children.size () == test_children.size (), "child counts of " << ref->get_name() << " differ");
 
 	xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 	xmlpp::Element::NodeList::iterator l = test_children.begin ();
diff --git a/test/write_subtitle_test.cc b/test/write_subtitle_test.cc
index 14d19d8b..292a00d5 100644
--- a/test/write_subtitle_test.cc
+++ b/test/write_subtitle_test.cc
@@ -20,6 +20,7 @@
 #include "interop_subtitle_asset.h"
 #include "smpte_subtitle_asset.h"
 #include "subtitle_string.h"
+#include "subtitle_asset_internal.h"
 #include "test.h"
 #include <boost/test/unit_test.hpp>
 
@@ -27,7 +28,116 @@ using std::list;
 using std::string;
 using boost::shared_ptr;
 
-/* Write some subtitle content as Interop XML and check that it is right */
+/** Test dcp::order::Font::take_intersection */
+BOOST_AUTO_TEST_CASE (take_intersection_test)
+{
+	dcp::order::Font A;
+	A._values["foo"] = "bar";
+	A._values["fred"] = "jim";
+
+	dcp::order::Font B;
+	B._values["foo"] = "bar";
+	B._values["sheila"] = "baz";
+
+	A.take_intersection (B);
+	BOOST_REQUIRE_EQUAL (A._values.size(), 1);
+	BOOST_CHECK_EQUAL (A._values["foo"], "bar");
+
+	A._values.clear ();
+	B._values.clear ();
+
+	A._values["foo"] = "bar";
+	A._values["fred"] = "jim";
+
+	B._values["foo"] = "hello";
+	B._values["sheila"] = "baz";
+
+	A.take_intersection (B);
+	BOOST_CHECK_EQUAL (A._values.size(), 0);
+}
+
+/** Test dcp::order::Font::take_difference */
+BOOST_AUTO_TEST_CASE (take_difference_test)
+{
+	dcp::order::Font A;
+	A._values["foo"] = "bar";
+	A._values["fred"] = "jim";
+
+	dcp::order::Font B;
+	B._values["foo"] = "bar";
+	B._values["sheila"] = "baz";
+
+	A.take_difference (B);
+	BOOST_REQUIRE_EQUAL (A._values.size(), 1);
+	BOOST_CHECK_EQUAL (A._values["fred"], "jim");
+}
+
+/** Test dcp::order::Subtitle::pull_fonts */
+BOOST_AUTO_TEST_CASE (pull_fonts_test1)
+{
+	shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
+	shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
+	root->children.push_back (sub1);
+	shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
+	sub1->children.push_back (text1);
+	text1->font._values["font"] = "Inconsolata";
+	text1->font._values["size"] = "42";
+
+	dcp::SubtitleAsset::pull_fonts (root);
+
+	BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
+	BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
+	BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
+	BOOST_CHECK_EQUAL (text1->font._values.size(), 0);
+}
+
+/** Test dcp::order::Subtitle::pull_fonts */
+BOOST_AUTO_TEST_CASE (pull_fonts_test2)
+{
+	shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
+	shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
+	root->children.push_back (sub1);
+	shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
+	sub1->children.push_back (text1);
+	text1->font._values["font"] = "Inconsolata";
+	text1->font._values["size"] = "42";
+	shared_ptr<dcp::order::Text> text2 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
+	sub1->children.push_back (text2);
+	text2->font._values["font"] = "Inconsolata";
+	text2->font._values["size"] = "48";
+
+	dcp::SubtitleAsset::pull_fonts (root);
+
+	BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 1);
+	BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
+	BOOST_REQUIRE_EQUAL (text1->font._values.size(), 1);
+	BOOST_CHECK_EQUAL (text1->font._values["size"], "42");
+	BOOST_REQUIRE_EQUAL (text2->font._values.size(), 1);
+	BOOST_CHECK_EQUAL (text2->font._values["size"], "48");
+}
+
+/** Test dcp::order::Subtitle::pull_fonts */
+BOOST_AUTO_TEST_CASE (pull_fonts_test3)
+{
+	shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
+	shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
+	root->children.push_back (sub1);
+	shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
+	sub1->children.push_back (text1);
+	dcp::order::Font font;
+	font._values["font"] = "Inconsolata";
+	font._values["size"] = "42";
+	shared_ptr<dcp::order::String> string1 (new dcp::order::String (text1, font, "Hello world"));
+	text1->children.push_back (string1);
+
+	dcp::SubtitleAsset::pull_fonts (root);
+
+	BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
+	BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
+	BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
+}
+
+/** Write some subtitle content as Interop XML and check that it is right */
 BOOST_AUTO_TEST_CASE (write_interop_subtitle_test)
 {
 	dcp::InteropSubtitleAsset c;
@@ -92,12 +202,12 @@ BOOST_AUTO_TEST_CASE (write_interop_subtitle_test)
 		"  <MovieTitle>Test</MovieTitle>\n"
 		"  <ReelNumber>1</ReelNumber>\n"
 		"  <Language>EN</Language>\n"
-		"  <Font Id=\"Frutiger\" Italic=\"no\" Color=\"FFFFFFFF\" Size=\"48\" Effect=\"none\" EffectColor=\"FF000000\" Script=\"normal\" Underlined=\"no\" Weight=\"normal\">\n"
+		"  <Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" Id=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underlined=\"no\" Weight=\"normal\">\n"
 		"    <Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:229\" TimeOut=\"00:04:11:229\" FadeUpTime=\"0\" FadeDownTime=\"0\">\n"
 		"      <Text VAlign=\"top\" VPosition=\"80\">Hello world</Text>\n"
 		"    </Subtitle>\n"
 		"  </Font>\n"
-		"  <Font Italic=\"yes\" Color=\"FF800040\" Size=\"91\" Effect=\"border\" EffectColor=\"FF010203\" Script=\"normal\" Underlined=\"yes\" Weight=\"bold\">\n"
+		"  <Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underlined=\"yes\" Weight=\"bold\">\n"
 		"    <Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:218\" TimeOut=\"06:12:15:218\" FadeUpTime=\"930792\" FadeDownTime=\"4591834\">\n"
 		"      <Text VAlign=\"bottom\" VPosition=\"40\">What's going on</Text>\n"
 		"    </Subtitle>\n"
@@ -178,12 +288,12 @@ BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test)
 		"  <dcst:EditRate>24 1</dcst:EditRate>\n"
 		"  <dcst:TimeCodeRate>24</dcst:TimeCodeRate>\n"
 		"  <dcst:SubtitleList>\n"
-		"    <dcst:Font ID=\"Frutiger\" Italic=\"no\" Color=\"FFFFFFFF\" Size=\"48\" Effect=\"none\" EffectColor=\"FF000000\" Script=\"normal\" Underline=\"no\" Weight=\"normal\">\n"
+		"    <dcst:Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">\n"
 		"      <dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:22\" TimeOut=\"00:04:11:22\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">\n"
 		"        <dcst:Text Valign=\"top\" Vposition=\"80\">Hello world</dcst:Text>\n"
 		"      </dcst:Subtitle>\n"
 		"    </dcst:Font>\n"
-		"    <dcst:Font Italic=\"yes\" Color=\"FF800040\" Size=\"91\" Effect=\"border\" EffectColor=\"FF010203\" Script=\"normal\" Underline=\"yes\" Weight=\"bold\">\n"
+		"    <dcst:Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underline=\"yes\" Weight=\"bold\">\n"
 		"      <dcst:Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:21\" TimeOut=\"06:12:15:21\" FadeUpTime=\"01:02:03:04\" FadeDownTime=\"05:06:07:08\">\n"
 		"        <dcst:Text Valign=\"bottom\" Vposition=\"40\" Direction=\"rtl\">What's going on</dcst:Text>\n"
 		"      </dcst:Subtitle>\n"
@@ -193,3 +303,192 @@ BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test)
 		list<string> ()
 		);
 }
+
+/* Write some subtitle content as SMPTE XML and check that it is right.
+   This includes in-line font changes.
+*/
+BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test2)
+{
+	dcp::SMPTESubtitleAsset c;
+	c.set_reel_number (1);
+	c.set_language ("EN");
+	c.set_content_title_text ("Test");
+	c.set_issue_date (dcp::LocalTime ("2016-04-01T03:52:00+00:00"));
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			false,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.8,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			"Testing is ",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			true,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.8,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			"really",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			false,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.8,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			" fun",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			false,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.9,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			"This is the ",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			true,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.9,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			"second",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c.add (
+		dcp::SubtitleString (
+			string ("Arial"),
+			false,
+			false,
+			false,
+			dcp::Colour (255, 255, 255),
+			48,
+			1.0,
+			dcp::Time (0, 0, 1, 0, 24),
+			dcp::Time (0, 0, 9, 0, 24),
+			0,
+			dcp::HALIGN_CENTER,
+			0.9,
+			dcp::VALIGN_TOP,
+			dcp::DIRECTION_LTR,
+			" line",
+			dcp::NONE,
+			dcp::Colour (0, 0, 0),
+			dcp::Time (0, 0, 0, 0, 24),
+			dcp::Time (0, 0, 0, 0, 24)
+			)
+		);
+
+	c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
+
+	check_xml (
+		c.xml_as_string (),
+		"<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+		"<dcst:SubtitleReel xmlns:dcst=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
+		"  <dcst:Id>urn:uuid:a6c58cff-3e1e-4b38-acec-a42224475ef6</dcst:Id>\n"
+		"  <dcst:ContentTitleText>Test</dcst:ContentTitleText>\n"
+		"  <dcst:IssueDate>2016-04-01T03:52:00.000+00:00</dcst:IssueDate>\n"
+		"  <dcst:ReelNumber>1</dcst:ReelNumber>\n"
+		"  <dcst:Language>EN</dcst:Language>\n"
+		"  <dcst:EditRate>24 1</dcst:EditRate>\n"
+		"  <dcst:TimeCodeRate>24</dcst:TimeCodeRate>\n"
+		"  <dcst:SubtitleList>\n"
+		"    <dcst:Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"Arial\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">\n"
+		"      <dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:00:01:00\" TimeOut=\"00:00:09:00\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">\n"
+		"        <dcst:Text Valign=\"top\" Vposition=\"80\">\n"
+		"          <dcst:Font Italic=\"no\">Testing is </dcst:Font>\n"
+		"          <dcst:Font Italic=\"yes\">really</dcst:Font>\n"
+		"          <dcst:Font Italic=\"no\"> fun</dcst:Font>\n"
+		"        </dcst:Text>\n"
+		"        <dcst:Text Valign=\"top\" Vposition=\"90\">\n"
+		"          <dcst:Font Italic=\"no\">This is the </dcst:Font>\n"
+		"          <dcst:Font Italic=\"yes\">second</dcst:Font>\n"
+		"          <dcst:Font Italic=\"no\"> line</dcst:Font>\n"
+		"        </dcst:Text>\n"
+		"      </dcst:Subtitle>\n"
+		"    </dcst:Font>\n"
+		"  </dcst:SubtitleList>\n"
+		"</dcst:SubtitleReel>\n",
+		list<string> ()
+		);
+}