X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=test%2Fsrt_subtitle_test.cc;h=bac0bedeccb7b31cd72054c21508f9d703458e30;hb=HEAD;hp=31a082015e0d9f4de66d78034cebd81d9fcbda1e;hpb=254b3044d72de6b033d7c584f5abd2b9aa70aad5;p=dcpomatic.git

diff --git a/test/srt_subtitle_test.cc b/test/srt_subtitle_test.cc
index 31a082015..bac0bedec 100644
--- a/test/srt_subtitle_test.cc
+++ b/test/srt_subtitle_test.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2015-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,164 +18,272 @@
 
 */
 
+
 /** @file  test/srt_subtitle_test.cc
  *  @brief Test writing DCPs with subtitles from .srt.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
-#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 boost::shared_ptr;
+using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using namespace dcpomatic;
+
 
 /** Make a very short DCP with a single subtitle from .srt with no specified fonts */
 BOOST_AUTO_TEST_CASE (srt_subtitle_test)
 {
-	shared_ptr<Film> film = new_test_film ("srt_subtitle_test");
+	auto film = new_test_film ("srt_subtitle_test");
 	film->set_container (Ratio::from_id ("185"));
 	film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 	film->set_name ("frobozz");
 	film->set_audio_channels (6);
 	film->set_interop (false);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent("test/data/subrip2.srt"));
+	film->set_audio_channels(16);
+	auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
 	film->examine_and_add_content (content);
-	wait_for_jobs ();
+	BOOST_REQUIRE (!wait_for_jobs());
 
 	content->only_text()->set_use (true);
 	content->only_text()->set_burn (false);
-	film->make_dcp ();
-	wait_for_jobs ();
+	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
+		});
+
 
 	/* Should be blank video with a subtitle MXF */
 	check_dcp ("test/data/srt_subtitle_test", film->dir (film->dcp_name ()));
 }
 
+
 /** Same again but with a `font' specified */
 BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
 {
-	shared_ptr<Film> film = new_test_film ("srt_subtitle_test2");
+	auto film = new_test_film ("srt_subtitle_test2");
 	film->set_container (Ratio::from_id ("185"));
 	film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 	film->set_name ("frobozz");
 	film->set_audio_channels (6);
 	film->set_interop (false);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent ("test/data/subrip2.srt"));
+	auto content = make_shared<StringTextFileContent> ("test/data/subrip2.srt");
 	film->examine_and_add_content (content);
-	wait_for_jobs ();
+	BOOST_REQUIRE (!wait_for_jobs());
 
 	content->only_text()->set_use (true);
 	content->only_text()->set_burn (false);
 	/* Use test/data/subrip2.srt as if it were a font file  */
-	content->only_text()->fonts().front()->set_file (FontFiles::NORMAL, "test/data/subrip2.srt");
+	content->only_text()->fonts().front()->set_file("test/data/subrip2.srt");
 
-	film->make_dcp ();
-	wait_for_jobs ();
+	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
+		},
+		true,
+		/* ClairMeta tries to inspect the font file and fails because it isn't one */
+		false
+		);
 
-	/* Should be blank video with a subtitle MXF */
-	check_dcp ("test/data/srt_subtitle_test2", film->dir (film->dcp_name ()));
+	/* Should be blank video with a subtitle MXF; sound is irrelevant */
+	check_dcp("test/data/srt_subtitle_test2", film->dir(film->dcp_name()), true);
 }
 
+
 static void
 check_subtitle_file (shared_ptr<Film> film, boost::filesystem::path ref)
 {
 	/* Find the subtitle file and check it */
-	list<string> ignore;
-	ignore.push_back ("SubtitleID");
-	check_xml (subtitle_file(film), ref, ignore);
+	check_xml (subtitle_file(film), ref, {"SubtitleID"});
 }
 
+
 /** Make another DCP with a longer .srt file */
 BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
 {
-	shared_ptr<Film> film = new_test_film ("srt_subtitle_test3");
+	Cleanup cl;
+
+	auto content = make_shared<StringTextFileContent>(TestPaths::private_data() / "Ankoemmling_short.srt");
+	auto film = new_test_film2 ("srt_subtitle_test3", { content }, &cl);
 
-	film->set_container (Ratio::from_id ("185"));
-	film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 	film->set_name ("frobozz");
 	film->set_interop (true);
 	film->set_audio_channels (6);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent(private_data / "Ankoemmling_short.srt"));
-	film->examine_and_add_content (content);
-	wait_for_jobs ();
 
 	content->only_text()->set_use (true);
 	content->only_text()->set_burn (false);
+	content->only_text()->set_language(dcp::LanguageTag("de"));
 
-	film->make_dcp ();
-	wait_for_jobs ();
+	make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
 
-	check_subtitle_file (film, private_data / "Ankoemmling_short.xml");
+	check_subtitle_file (film, TestPaths::private_data() / "Ankoemmling_short.xml");
+
+	cl.run ();
 }
 
+
 /** Build a small DCP with no picture and a single subtitle overlaid onto it */
 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
 {
-	shared_ptr<Film> film = new_test_film ("srt_subtitle_test4");
+	auto film = new_test_film ("srt_subtitle_test4");
 	film->set_container (Ratio::from_id ("185"));
 	film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 	film->set_name ("frobozz");
 	film->set_interop (false);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent("test/data/subrip2.srt"));
+	auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
 	content->only_text()->set_use (true);
 	content->only_text()->set_burn (false);
 	film->examine_and_add_content (content);
-	wait_for_jobs ();
-	film->make_dcp ();
-	wait_for_jobs ();
+	BOOST_REQUIRE (!wait_for_jobs());
+	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
+		});
 
-	/* Should be blank video with MXF subtitles */
-	check_dcp ("test/data/xml_subtitle_test", film->dir (film->dcp_name ()));
+	/* Should be blank video with MXF subtitles; sound is irrelevant */
+	check_dcp("test/data/xml_subtitle_test", film->dir(film->dcp_name()), true);
 }
 
+
 /** Check the subtitle XML when there are two subtitle files in the project */
 BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
 {
-	shared_ptr<Film> film = new_test_film ("srt_subtitle_test5");
+	auto film = new_test_film ("srt_subtitle_test5");
 	film->set_container (Ratio::from_id ("185"));
 	film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 	film->set_name ("frobozz");
 	film->set_interop (true);
 	film->set_sequence (false);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent("test/data/subrip2.srt"));
-	content->only_text()->set_use (true);
-	content->only_text()->set_burn (false);
-	film->examine_and_add_content (content);
-	film->examine_and_add_content (content);
-	wait_for_jobs ();
-	content->set_position (film, DCPTime());
-	film->make_dcp ();
-	wait_for_jobs ();
-	film->write_metadata ();
+	film->set_audio_channels(6);
+	for (auto i = 0; i < 2; ++i) {
+		auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
+		content->only_text()->set_use (true);
+		content->only_text()->set_burn (false);
+		content->only_text()->set_language(dcp::LanguageTag("de"));
+		film->examine_and_add_content (content);
+		BOOST_REQUIRE (!wait_for_jobs());
+		content->set_position (film, DCPTime());
+	}
+	make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
 
 	check_dcp ("test/data/xml_subtitle_test2", film->dir (film->dcp_name ()));
 }
 
+
 BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
 {
-	shared_ptr<Film> film = new_test_film2 ("srt_subtitle_test6");
+	auto content = make_shared<StringTextFileContent>("test/data/frames.srt");
+	auto film = new_test_film2 ("srt_subtitle_test6", {content});
 	film->set_interop (false);
-	shared_ptr<StringTextFileContent> content (new StringTextFileContent("test/data/frames.srt"));
 	content->only_text()->set_use (true);
 	content->only_text()->set_burn (false);
-	film->examine_and_add_content (content);
-	BOOST_REQUIRE (!wait_for_jobs ());
-	film->make_dcp ();
-	BOOST_REQUIRE (!wait_for_jobs ());
-	film->write_metadata ();
+	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,
+		});
+
+	/* This test is concerned with the subtitles, so we'll ignore any
+	 * differences in sound between the DCP and the reference to avoid test
+	 * failures for unrelated reasons.
+	 */
+	check_dcp("test/data/srt_subtitle_test6", film->dir(film->dcp_name()), true);
+}
 
-	check_dcp ("test/data/srt_subtitle_test6", film->dir(film->dcp_name()));
+
+/** 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.