2 Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 /** @file test/dcp_subtitle_test.cc
23 * @brief Test DCP subtitle content in various ways.
28 #include "lib/content_text.h"
29 #include "lib/dcp_content.h"
30 #include "lib/dcp_content_type.h"
31 #include "lib/dcp_decoder.h"
32 #include "lib/dcp_subtitle_content.h"
33 #include "lib/dcp_subtitle_decoder.h"
36 #include "lib/ratio.h"
37 #include "lib/text_content.h"
38 #include "lib/text_decoder.h"
40 #include <dcp/mono_picture_asset.h>
41 #include <dcp/openjpeg_image.h>
42 #include <dcp/smpte_subtitle_asset.h>
43 #include <boost/test/unit_test.hpp>
49 using std::make_shared;
50 using std::shared_ptr;
52 using boost::optional;
53 #if BOOST_VERSION >= 106100
54 using namespace boost::placeholders;
56 using namespace dcpomatic;
59 optional<ContentStringText> stored;
63 store (ContentStringText sub)
68 for (auto i: sub.subs) {
69 stored->subs.push_back (i);
75 /** Test pass-through of a very simple DCP subtitle file */
76 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
78 auto film = new_test_film ("dcp_subtitle_test");
79 film->set_container (Ratio::from_id ("185"));
80 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
81 film->set_name ("frobozz");
82 film->set_interop (false);
83 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub.xml");
84 film->examine_and_add_content (content);
85 BOOST_REQUIRE (!wait_for_jobs ());
87 BOOST_CHECK_EQUAL (content->full_length(film).get(), DCPTime::from_seconds(2).get());
89 content->only_text()->set_use (true);
90 content->only_text()->set_burn (false);
94 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
95 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
96 dcp::VerificationNote::Code::MISSING_CPL_METADATA
99 /* This test is concerned with the subtitles, so we'll ignore any
100 * differences in sound between the DCP and the reference to avoid test
101 * failures for unrelated reasons.
103 check_dcp("test/data/dcp_subtitle_test", film->dir(film->dcp_name()), true);
107 /** Test parsing of a subtitle within an existing DCP */
108 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
110 auto film = new_test_film ("dcp_subtitle_within_dcp_test");
111 film->set_container (Ratio::from_id ("185"));
112 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
113 film->set_name ("frobozz");
114 auto content = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
115 film->examine_and_add_content (content);
116 BOOST_REQUIRE (!wait_for_jobs ());
118 auto decoder = make_shared<DCPDecoder>(film, content, false, false, shared_ptr<DCPDecoder>());
119 decoder->only_text()->PlainStart.connect (bind (store, _1));
121 stored = optional<ContentStringText> ();
122 while (!decoder->pass() && !stored) {}
124 BOOST_REQUIRE (stored);
125 BOOST_REQUIRE_EQUAL (stored->subs.size(), 2U);
126 BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
127 BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
130 /** Test subtitles whose text includes things like <b> */
131 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
133 auto film = new_test_film ("dcp_subtitle_test2");
134 film->set_container (Ratio::from_id ("185"));
135 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
136 film->set_name ("frobozz");
137 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub2.xml");
138 film->examine_and_add_content (content);
139 BOOST_REQUIRE (!wait_for_jobs ());
141 auto decoder = make_shared<DCPSubtitleDecoder>(film, content);
142 decoder->only_text()->PlainStart.connect (bind (store, _1));
144 stored = optional<ContentStringText> ();
145 while (!decoder->pass()) {
146 if (stored && stored->from() == ContentTime(0)) {
147 /* Text passed around by the player should be unescaped */
148 BOOST_CHECK_EQUAL(stored->subs.front().text(), "<b>Hello world!</b>");
154 /** Test a failure case */
155 BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
157 auto film = new_test_film ("dcp_subtitle_test3");
158 film->set_container (Ratio::from_id ("185"));
159 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
160 film->set_name ("frobozz");
161 film->set_interop (true);
162 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
163 film->examine_and_add_content (content);
164 BOOST_REQUIRE (!wait_for_jobs ());
166 make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
168 auto decoder = make_shared<DCPSubtitleDecoder>(film, content);
169 stored = optional<ContentStringText> ();
170 while (!decoder->pass ()) {
171 decoder->only_text()->PlainStart.connect (bind (store, _1));
172 if (stored && stored->from() == ContentTime::from_seconds(0.08)) {
173 auto s = stored->subs;
175 BOOST_CHECK_EQUAL (i->text(), "This");
177 BOOST_REQUIRE (i != s.end ());
178 BOOST_CHECK_EQUAL (i->text(), " is ");
180 BOOST_REQUIRE (i != s.end ());
181 BOOST_CHECK_EQUAL (i->text(), "wrong.");
183 BOOST_REQUIRE (i == s.end ());
189 /** Check that Interop DCPs aren't made with more than one <LoadFont> (#1273) */
190 BOOST_AUTO_TEST_CASE (dcp_subtitle_test4)
192 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
193 auto content2 = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
194 auto film = new_test_film2 ("dcp_subtitle_test4", {content, content2});
195 film->set_interop (true);
197 content->only_text()->add_font(make_shared<Font>("font1"));
198 content2->only_text()->add_font(make_shared<Font>("font2"));
200 make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
202 cxml::Document doc ("DCSubtitle");
203 doc.read_file (subtitle_file (film));
204 BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U);
210 check_font_tags (vector<cxml::NodePtr> nodes)
212 for (auto i: nodes) {
213 if (i->name() == "Font") {
214 BOOST_CHECK (!i->optional_string_attribute("Id") || i->string_attribute("Id") != "");
216 check_font_tags (i->node_children());
221 /** Check that imported <LoadFont> tags with empty IDs (or corresponding Font tags with empty IDs)
222 * are not passed through into the DCP.
224 BOOST_AUTO_TEST_CASE (dcp_subtitle_test5)
226 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub6.xml");
227 auto film = new_test_film2 ("dcp_subtitle_test5", {content});
228 film->set_interop (true);
230 make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
232 cxml::Document doc ("DCSubtitle");
233 doc.read_file (subtitle_file(film));
234 BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U);
235 BOOST_CHECK (doc.node_children("LoadFont").front()->string_attribute("Id") != "");
237 check_font_tags (doc.node_children());
241 /** Check that fonts specified in the DoM content are used in the output and not ignored (#2074) */
242 BOOST_AUTO_TEST_CASE (test_font_override)
244 auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub4.xml");
245 auto film = new_test_film2("test_font_override", {content});
246 film->set_interop(true);
248 BOOST_REQUIRE_EQUAL(content->text.size(), 1U);
249 content->text.front()->get_font("theFontId")->set_file("test/data/Inconsolata-VF.ttf");
251 make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
252 check_file (subtitle_file(film).parent_path() / "font_0.ttf", "test/data/Inconsolata-VF.ttf");
256 BOOST_AUTO_TEST_CASE(entity_from_dcp_source)
258 std::ofstream source_xml("build/test/entity_from_dcp_source.xml");
260 << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
261 << "<SubtitleReel xmlns=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
262 << "<Id>urn:uuid:9c0a0a67-ffd8-4c65-8b5a-c6be3ef182c5</Id>\n"
263 << "<ContentTitleText>DCP</ContentTitleText>\n"
264 << "<IssueDate>2022-11-30T18:13:56.000+01:00</IssueDate>\n"
265 << "<ReelNumber>1</ReelNumber>\n"
266 << "<EditRate>24 1</EditRate>\n"
267 << "<TimeCodeRate>24</TimeCodeRate>\n"
268 << "<StartTime>00:00:00:00</StartTime>\n"
269 << "<LoadFont ID=\"font\">urn:uuid:899e5c59-50f6-467b-985b-8282c020e1ee</LoadFont>\n"
270 << "<SubtitleList>\n"
271 << "<Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"font\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">\n"
272 << "<Subtitle SpotNumber=\"1\" TimeIn=\"00:00:00:00\" TimeOut=\"00:00:10:00\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">\n"
273 << "<Text Valign=\"top\" Vposition=\"82.7273\">Hello & world</Text>\n"
276 << "</SubtitleList>\n"
277 << "</SubtitleReel>\n";
280 auto content = make_shared<DCPSubtitleContent>("build/test/entity_from_dcp_source.xml");
281 auto film = new_test_film2("entity_from_dcp_source", { content });
282 film->set_interop(false);
283 content->only_text()->set_use(true);
284 content->only_text()->set_burn(false);
285 make_and_verify_dcp (
288 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
289 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
290 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
291 dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
292 dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
295 dcp::SMPTESubtitleAsset check(dcp_file(film, "sub_"));
296 auto subs = check.subtitles();
297 BOOST_REQUIRE_EQUAL(subs.size(), 1U);
298 auto sub = std::dynamic_pointer_cast<const dcp::SubtitleString>(subs[0]);
300 /* libdcp::SubtitleAsset gets the text from the XML with get_content(), which
301 * resolves the 5 predefined entities & " < > ' so we shouldn't see any
304 BOOST_CHECK_EQUAL(sub->text(), "Hello & world");
306 /* It should be escaped in the raw XML though */
307 BOOST_REQUIRE(static_cast<bool>(check.raw_xml()));
308 BOOST_CHECK(check.raw_xml()->find("Hello & world") != std::string::npos);
310 /* Remake with burn */
311 content->only_text()->set_burn(true);
312 boost::filesystem::remove_all(film->dir(film->dcp_name()));
313 make_and_verify_dcp (
316 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
317 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
318 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
319 dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
320 dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
323 dcp::MonoPictureAsset burnt(dcp_file(film, "j2c_"));
324 auto frame = burnt.start_read()->get_frame(12)->xyz_image();
325 auto const size = frame->size();
327 for (auto y = 0; y < size.height; ++y) {
328 for (auto x = 0; x < size.width; ++x) {
329 max_X = std::max(frame->data(0)[x + y * size.width], max_X);
333 /* Check that the subtitle got rendered to the image; if the escaping of the & is wrong Pango
334 * will throw errors and nothing will be rendered.
336 BOOST_CHECK(max_X > 100);