Emit no audio from DCPs if none is mapped
[dcpomatic.git] / test / srt_subtitle_test.cc
index cd4ce3a05079184c60b8ad95d9a6f1704fd621ff..bac0bedeccb7b31cd72054c21508f9d703458e30 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;
 
 
@@ -53,6 +55,7 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test)
        film->set_name ("frobozz");
        film->set_audio_channels (6);
        film->set_interop (false);
+       film->set_audio_channels(16);
        auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
        film->examine_and_add_content (content);
        BOOST_REQUIRE (!wait_for_jobs());
@@ -97,10 +100,14 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
                        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);
 }
 
 
@@ -126,6 +133,7 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
 
        content->only_text()->set_use (true);
        content->only_text()->set_burn (false);
+       content->only_text()->set_language(dcp::LanguageTag("de"));
 
        make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
 
@@ -156,8 +164,8 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
                        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);
 }
 
 
@@ -170,13 +178,16 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
        film->set_name ("frobozz");
        film->set_interop (true);
        film->set_sequence (false);
-       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);
-       film->examine_and_add_content (content);
-       BOOST_REQUIRE (!wait_for_jobs());
-       content->set_position (film, DCPTime());
+       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 ()));
@@ -200,7 +211,76 @@ BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
                        dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
                });
 
-       check_dcp ("test/data/srt_subtitle_test6", film->dir(film->dcp_name()));
+       /* 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);
+}
+
+
+/** 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,
+               });
 }