X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=test%2Fdcp_subtitle_test.cc;h=a7ec34514876ba3075afdbda9cca6a45a6d0486f;hp=95fa7d1ec7eaf2d6844892ac9b9d1ddf1d8ed258;hb=4e460664ee6f1cc34ac566fb9f0b3655fd329de6;hpb=e491397c0028a80ac4a48a92007f783746553c1a diff --git a/test/dcp_subtitle_test.cc b/test/dcp_subtitle_test.cc index 95fa7d1ec..a7ec34514 100644 --- a/test/dcp_subtitle_test.cc +++ b/test/dcp_subtitle_test.cc @@ -1,46 +1,334 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ + /** @file test/dcp_subtitle_test.cc * @brief Test DCP subtitle content in various ways. + * @ingroup feature */ -#include -#include "lib/film.h" + +#include "lib/content_text.h" +#include "lib/dcp_content.h" +#include "lib/dcp_content_type.h" +#include "lib/dcp_decoder.h" #include "lib/dcp_subtitle_content.h" +#include "lib/dcp_subtitle_decoder.h" +#include "lib/film.h" +#include "lib/font.h" #include "lib/ratio.h" -#include "lib/dcp_content_type.h" +#include "lib/text_content.h" +#include "lib/text_decoder.h" #include "test.h" +#include +#include +#include +#include +#include + using std::cout; -using boost::shared_ptr; +using std::list; +using std::make_shared; +using std::shared_ptr; +using std::vector; +using boost::optional; +#if BOOST_VERSION >= 106100 +using namespace boost::placeholders; +#endif +using namespace dcpomatic; + -/** Test load of very simple DCP subtitle file */ +optional stored; + + +static void +store (ContentStringText sub) +{ + if (!stored) { + stored = sub; + } else { + for (auto i: sub.subs) { + stored->subs.push_back (i); + } + } +} + + +/** Test pass-through of a very simple DCP subtitle file */ BOOST_AUTO_TEST_CASE (dcp_subtitle_test) { - shared_ptr film = new_test_film ("dcp_subtitle_test"); + auto film = new_test_film ("dcp_subtitle_test"); film->set_container (Ratio::from_id ("185")); film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR")); film->set_name ("frobozz"); - shared_ptr content (new DCPSubtitleContent (film, "test/data/dcp_sub.xml")); + film->set_interop (false); + auto content = make_shared("test/data/dcp_sub.xml"); film->examine_and_add_content (content); - wait_for_jobs (); + BOOST_REQUIRE (!wait_for_jobs ()); - BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds (2)); + BOOST_CHECK_EQUAL (content->full_length(film).get(), DCPTime::from_seconds(2).get()); + + 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 + }); + + check_dcp ("test/data/dcp_subtitle_test", film->dir(film->dcp_name())); } + + +/** Test parsing of a subtitle within an existing DCP */ +BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test) +{ + auto film = new_test_film ("dcp_subtitle_within_dcp_test"); + film->set_container (Ratio::from_id ("185")); + film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR")); + film->set_name ("frobozz"); + auto content = make_shared(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"); + film->examine_and_add_content (content); + BOOST_REQUIRE (!wait_for_jobs ()); + + shared_ptr decoder (new DCPDecoder (film, content, false, false, shared_ptr())); + decoder->only_text()->PlainStart.connect (bind (store, _1)); + + stored = optional (); + while (!decoder->pass() && !stored) {} + + BOOST_REQUIRE (stored); + BOOST_REQUIRE_EQUAL (stored->subs.size(), 2U); + BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal."); + BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois."); +} + +/** Test subtitles whose text includes things like <b> */ +BOOST_AUTO_TEST_CASE (dcp_subtitle_test2) +{ + auto film = new_test_film ("dcp_subtitle_test2"); + film->set_container (Ratio::from_id ("185")); + film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR")); + film->set_name ("frobozz"); + auto content = make_shared("test/data/dcp_sub2.xml"); + film->examine_and_add_content (content); + BOOST_REQUIRE (!wait_for_jobs ()); + + auto decoder = make_shared(film, content); + decoder->only_text()->PlainStart.connect (bind (store, _1)); + + stored = optional (); + while (!decoder->pass()) { + if (stored && stored->from() == ContentTime(0)) { + /* Text passed around by the player should be unescaped */ + BOOST_CHECK_EQUAL(stored->subs.front().text(), "Hello world!"); + } + } +} + + +/** Test a failure case */ +BOOST_AUTO_TEST_CASE (dcp_subtitle_test3) +{ + auto film = new_test_film ("dcp_subtitle_test3"); + 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); + auto content = make_shared("test/data/dcp_sub3.xml"); + film->examine_and_add_content (content); + BOOST_REQUIRE (!wait_for_jobs ()); + + make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD }); + + auto decoder = make_shared(film, content); + stored = optional (); + while (!decoder->pass ()) { + decoder->only_text()->PlainStart.connect (bind (store, _1)); + if (stored && stored->from() == ContentTime::from_seconds(0.08)) { + auto s = stored->subs; + auto i = s.begin (); + BOOST_CHECK_EQUAL (i->text(), "This"); + ++i; + BOOST_REQUIRE (i != s.end ()); + BOOST_CHECK_EQUAL (i->text(), " is "); + ++i; + BOOST_REQUIRE (i != s.end ()); + BOOST_CHECK_EQUAL (i->text(), "wrong."); + ++i; + BOOST_REQUIRE (i == s.end ()); + } + } +} + + +/** Check that Interop DCPs aren't made with more than one (#1273) */ +BOOST_AUTO_TEST_CASE (dcp_subtitle_test4) +{ + auto content = make_shared("test/data/dcp_sub3.xml"); + auto content2 = make_shared("test/data/dcp_sub3.xml"); + auto film = new_test_film2 ("dcp_subtitle_test4", {content, content2}); + film->set_interop (true); + + content->only_text()->add_font(make_shared("font1")); + content2->only_text()->add_font(make_shared("font2")); + + make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD }); + + cxml::Document doc ("DCSubtitle"); + doc.read_file (subtitle_file (film)); + BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U); +} + + +static +void +check_font_tags (vector nodes) +{ + for (auto i: nodes) { + if (i->name() == "Font") { + BOOST_CHECK (!i->optional_string_attribute("Id") || i->string_attribute("Id") != ""); + } + check_font_tags (i->node_children()); + } +} + + +/** Check that imported tags with empty IDs (or corresponding Font tags with empty IDs) + * are not passed through into the DCP. + */ +BOOST_AUTO_TEST_CASE (dcp_subtitle_test5) +{ + auto content = make_shared("test/data/dcp_sub6.xml"); + auto film = new_test_film2 ("dcp_subtitle_test5", {content}); + film->set_interop (true); + + make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD }); + + cxml::Document doc ("DCSubtitle"); + doc.read_file (subtitle_file(film)); + BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U); + BOOST_CHECK (doc.node_children("LoadFont").front()->string_attribute("Id") != ""); + + check_font_tags (doc.node_children()); +} + + +/** Check that fonts specified in the DoM content are used in the output and not ignored (#2074) */ +BOOST_AUTO_TEST_CASE (test_font_override) +{ + auto content = make_shared("test/data/dcp_sub4.xml"); + auto film = new_test_film2("test_font_override", {content}); + film->set_interop(true); + + BOOST_REQUIRE_EQUAL(content->text.size(), 1U); + content->text.front()->get_font("theFontId")->set_file("test/data/Inconsolata-VF.ttf"); + + make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD }); + check_file (subtitle_file(film).parent_path() / "font_0.ttf", "test/data/Inconsolata-VF.ttf"); +} + + +BOOST_AUTO_TEST_CASE(entity_from_dcp_source) +{ + std::ofstream source_xml("build/test/entity_from_dcp_source.xml"); + source_xml + << "\n" + << "\n" + << "urn:uuid:9c0a0a67-ffd8-4c65-8b5a-c6be3ef182c5\n" + << "DCP\n" + << "2022-11-30T18:13:56.000+01:00\n" + << "1\n" + << "24 1\n" + << "24\n" + << "00:00:00:00\n" + << "urn:uuid:899e5c59-50f6-467b-985b-8282c020e1ee\n" + << "\n" + << "\n" + << "\n" + << "Hello & world\n" + << "\n" + << "\n" + << "\n" + << "\n"; + source_xml.close(); + + auto content = make_shared("build/test/entity_from_dcp_source.xml"); + auto film = new_test_film2("entity_from_dcp_source", { 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(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(check.raw_xml())); + BOOST_CHECK(check.raw_xml()->find("Hello & world") != std::string::npos); + + /* Remake with burn */ + content->only_text()->set_burn(true); + boost::filesystem::remove_all(film->dir(film->dcp_name())); + 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::MonoPictureAsset burnt(dcp_file(film, "j2c_")); + auto frame = burnt.start_read()->get_frame(12)->xyz_image(); + auto const size = frame->size(); + int max_X = 0; + for (auto y = 0; y < size.height; ++y) { + for (auto x = 0; x < size.width; ++x) { + max_X = std::max(frame->data(0)[x + y * size.width], max_X); + } + } + + /* Check that the subtitle got rendered to the image; if the escaping of the & is wrong Pango + * will throw errors and nothing will be rendered. + */ + BOOST_CHECK(max_X > 100); +} +