Fix crashes when using templates in some cases (#2491).
[dcpomatic.git] / test / srt_subtitle_test.cc
index 11b6b28b99cbe6875cfcea5fc597c36f10c8281d..63d508b7654ba4093c6492261dd1bada2b98ebae 100644 (file)
  */
 
 
-#include "lib/film.h"
-#include "lib/string_text_file_content.h"
 #include "lib/dcp_content_type.h"
+#include "lib/film.h"
 #include "lib/font.h"
 #include "lib/ratio.h"
+#include "lib/string_text_file_content.h"
 #include "lib/text_content.h"
 #include "test.h"
-#include <boost/test/unit_test.hpp>
+#include <dcp/smpte_subtitle_asset.h>
+#include <dcp/subtitle_string.h>
 #include <boost/algorithm/string.hpp>
+#include <boost/test/unit_test.hpp>
 #include <list>
 
 
-using std::string;
 using std::list;
-using std::shared_ptr;
 using std::make_shared;
+using std::shared_ptr;
+using std::string;
 using namespace dcpomatic;
 
 
@@ -205,6 +207,71 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
 }
 
 
+/** Test a case where a & in srt ended up in the SMPTE subtitle as &amp;amp */
+BOOST_AUTO_TEST_CASE(srt_subtitle_entity)
+{
+       std::ofstream srt("build/test/srt_subtitle_entity.srt");
+       srt << "1\n";
+       srt << "00:00:01,000 -> 00:00:10,000\n";
+       srt << "Hello & world\n";
+       srt.close();
+
+       auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_entity.srt");
+       auto film = new_test_film2("srt_subtitle_entity", { content });
+       film->set_interop(false);
+       content->only_text()->set_use(true);
+       content->only_text()->set_burn(false);
+       make_and_verify_dcp (
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
+                       dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
+                       dcp::VerificationNote::Code::MISSING_CPL_METADATA,
+                       dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
+                       dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
+               });
+
+       dcp::SMPTESubtitleAsset check(dcp_file(film, "sub_"));
+       auto subs = check.subtitles();
+       BOOST_REQUIRE_EQUAL(subs.size(), 1U);
+       auto sub = std::dynamic_pointer_cast<const dcp::SubtitleString>(subs[0]);
+       BOOST_REQUIRE(sub);
+       /* libdcp::SubtitleAsset gets the text from the XML with get_content(), which
+        * resolves the 5 predefined entities & " < > ' so we shouldn't see any
+        * entity here.
+        */
+       BOOST_CHECK_EQUAL(sub->text(), "Hello & world");
+
+       /* It should be escaped in the raw XML though */
+       BOOST_REQUIRE(static_cast<bool>(check.raw_xml()));
+       BOOST_CHECK(check.raw_xml()->find("Hello &amp; world") != string::npos);
+}
+
+
+/** A control code in a .srt file should not make it into the XML */
+BOOST_AUTO_TEST_CASE(srt_subtitle_control_code)
+{
+       std::ofstream srt("build/test/srt_subtitle_control_code.srt");
+       srt << "1\n";
+       srt << "00:00:01,000 -> 00:00:10,000\n";
+       srt << "Hello \x0c world\n";
+       srt.close();
+
+       auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_control_code.srt");
+       auto film = new_test_film2("srt_subtitle_control_code", { content });
+       film->set_interop(false);
+       content->only_text()->set_use(true);
+       content->only_text()->set_burn(false);
+       make_and_verify_dcp (
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
+                       dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
+                       dcp::VerificationNote::Code::MISSING_CPL_METADATA,
+               });
+}
+
+
 #if 0
 /* XXX: this is disabled; there is some difference in font rendering
    between the test machine and others.