2 Copyright (C) 2022 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 #include "lib/content_factory.h"
23 #include "lib/dcp_content.h"
26 #include "lib/text_content.h"
31 #include <dcp/reel_subtitle_asset.h>
32 #include <dcp/smpte_subtitle_asset.h>
34 #include <boost/test/unit_test.hpp>
37 using std::make_shared;
40 BOOST_AUTO_TEST_CASE(full_dcp_subtitle_font_id_test)
42 auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
43 auto film = new_test_film2("full_dcp_subtitle_font_id_test", { dcp });
45 auto content = film->content();
46 BOOST_REQUIRE_EQUAL(content.size(), 1U);
47 auto text = content[0]->only_text();
50 BOOST_REQUIRE_EQUAL(text->fonts().size(), 1U);
51 auto font = text->fonts().front();
52 BOOST_CHECK_EQUAL(font->id(), "0_theFontId");
53 BOOST_REQUIRE(font->data());
54 BOOST_CHECK_EQUAL(font->data()->size(), 367112);
58 BOOST_AUTO_TEST_CASE(dcp_subtitle_font_id_test)
60 auto subs = content_factory(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV" / "8b48f6ae-c74b-4b80-b994-a8236bbbad74_sub.mxf");
61 auto film = new_test_film2("dcp_subtitle_font_id_test", subs);
63 auto content = film->content();
64 BOOST_REQUIRE_EQUAL(content.size(), 1U);
65 auto text = content[0]->only_text();
68 BOOST_REQUIRE_EQUAL(text->fonts().size(), 1U);
69 auto font = text->fonts().front();
70 BOOST_CHECK_EQUAL(font->id(), "0_theFontId");
71 BOOST_REQUIRE(font->data());
72 BOOST_CHECK_EQUAL(font->data()->size(), 367112);
76 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_interop_dcp)
78 auto dcp = make_shared<DCPContent>("test/data/Iopsubs_FTR-1_F_XX-XX_MOS_2K_20220710_IOP_OV");
79 auto film = new_test_film2("make_dcp_with_subs_from_interop_dcp", { dcp });
80 dcp->text.front()->set_use(true);
84 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
85 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
91 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_smpte_dcp)
95 auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
96 auto film = new_test_film2("make_dcp_with_subs_from_smpte_dcp", { dcp }, &cl);
97 dcp->text.front()->set_use(true);
98 make_and_verify_dcp(film);
104 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_mkv)
106 auto subs = content_factory(TestPaths::private_data() / "clapperboard_with_subs.mkv");
107 auto film = new_test_film2("make_dcp_with_subs_from_mkv", subs);
108 subs[0]->text.front()->set_use(true);
109 subs[0]->text.front()->set_language(dcp::LanguageTag("en-US"));
110 make_and_verify_dcp(film, { dcp::VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K });
114 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_without_font_tag)
116 auto subs = content_factory("test/data/no_font.xml");
117 auto film = new_test_film2("make_dcp_with_subs_without_font_tag", { subs });
118 subs[0]->text.front()->set_use(true);
122 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
123 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
124 dcp::VerificationNote::Code::MISSING_CPL_METADATA
127 auto check_file = subtitle_file(film);
128 dcp::SMPTESubtitleAsset check_asset(check_file);
129 BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
130 auto check_font_data = check_asset.font_data();
131 BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
132 BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
136 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_in_dcp_without_font_tag)
138 /* Make a DCP with some subs in */
139 auto source_subs = content_factory("test/data/short.srt");
140 auto source = new_test_film2("make_dcp_with_subs_in_dcp_without_font_tag_source", { source_subs });
141 source->set_interop(true);
145 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
146 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
147 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
148 dcp::VerificationNote::Code::INVALID_STANDARD
151 /* Find the ID of the subs */
152 dcp::DCP source_dcp(source->dir(source->dcp_name()));
154 BOOST_REQUIRE(!source_dcp.cpls().empty());
155 BOOST_REQUIRE(!source_dcp.cpls()[0]->reels().empty());
156 BOOST_REQUIRE(source_dcp.cpls()[0]->reels()[0]->main_subtitle());
157 auto const id = source_dcp.cpls()[0]->reels()[0]->main_subtitle()->asset()->id();
159 /* Graft in some bad subs with no <Font> tag */
160 auto source_subtitle_file = subtitle_file(source);
161 #if BOOST_VERSION >= 107400
162 boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_options::overwrite_existing);
164 boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_option::overwrite_if_exists);
167 /* Fix the <Id> tag */
169 Editor editor(source_subtitle_file);
170 editor.replace("4dd8ee05-5986-4c67-a6f8-bbeac62e21db", id);
173 /* Now make a project which imports that DCP and makes another DCP from it */
174 auto dcp_content = make_shared<DCPContent>(source->dir(source->dcp_name()));
175 auto film = new_test_film2("make_dcp_with_subs_without_font_tag", { dcp_content });
176 BOOST_REQUIRE(!dcp_content->text.empty());
177 dcp_content->text.front()->set_use(true);
181 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
182 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
183 dcp::VerificationNote::Code::MISSING_CPL_METADATA
186 auto check_file = subtitle_file(film);
187 dcp::SMPTESubtitleAsset check_asset(check_file);
188 BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
189 auto check_font_data = check_asset.font_data();
190 BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
191 BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
195 BOOST_AUTO_TEST_CASE(filler_subtitle_reels_have_load_font_tags)
197 auto const name = boost::unit_test::framework::current_test_case().full_name();
199 auto subs = content_factory("test/data/short.srt")[0];
200 auto video1 = content_factory("test/data/flat_red.png")[0];
201 auto video2 = content_factory("test/data/flat_red.png")[0];
203 auto film = new_test_film2(name, { video1, video2, subs });
204 film->set_reel_type(ReelType::BY_VIDEO_CONTENT);
209 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
210 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
211 dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
212 dcp::VerificationNote::Code::MISSING_CPL_METADATA
217 BOOST_AUTO_TEST_CASE(subtitle_with_no_font_test)
219 auto const name_base = boost::unit_test::framework::current_test_case().full_name();
221 auto video1 = content_factory("test/data/flat_red.png")[0];
222 auto video2 = content_factory("test/data/flat_red.png")[0];
223 auto subs = content_factory("test/data/short.srt")[0];
225 auto bad_film = new_test_film2(name_base + "_bad", { video1, video2, subs });
226 bad_film->set_reel_type(ReelType::BY_VIDEO_CONTENT);
227 video2->set_position(bad_film, video1->end(bad_film));
228 subs->set_position(bad_film, video1->end(bad_film));
229 subs->text[0]->add_font(make_shared<dcpomatic::Font>("foo", "test/data/LiberationSans-Regular.ttf"));
234 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
235 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
238 /* When this test was written, this DCP would have one reel whose subtitles had <LoadFont>s
239 * but the subtitles specified no particular font. This triggers bug #2649, which this test
240 * is intended to trigger. First, make sure that the DCP has the required characteristics,
241 * to guard against a case where for some reason the DCP here is different enough that it
242 * doesn't trigger the bug.
244 dcp::DCP check(bad_film->dir(bad_film->dcp_name()));
246 BOOST_REQUIRE_EQUAL(check.cpls().size(), 1U);
247 auto cpl = check.cpls()[0];
248 BOOST_REQUIRE_EQUAL(cpl->reels().size(), 2U);
249 auto check_subs_reel = cpl->reels()[0]->main_subtitle();
250 BOOST_REQUIRE(check_subs_reel);
251 auto check_subs = check_subs_reel->asset();
252 BOOST_REQUIRE(check_subs);
254 BOOST_CHECK_EQUAL(check_subs->font_data().size(), 1U);
255 BOOST_REQUIRE_EQUAL(check_subs->subtitles().size(), 1U);
256 BOOST_CHECK(!std::dynamic_pointer_cast<const dcp::SubtitleString>(check_subs->subtitles()[0])->font().has_value());
258 auto check_film = new_test_film2(name_base + "_check", { make_shared<DCPContent>(bad_film->dir(bad_film->dcp_name())) });
259 make_and_verify_dcp(check_film);
263 BOOST_AUTO_TEST_CASE(load_dcp_with_empty_font_id_test)
265 auto dcp = std::make_shared<DCPContent>(TestPaths::private_data() / "kr_vf");
266 auto film = new_test_film2("load_dcp_with_empty_font_id_test", { dcp });
270 BOOST_AUTO_TEST_CASE(use_first_loadfont_as_default)
272 auto dcp = std::make_shared<DCPContent>("test/data/use_default_font");
273 auto film = new_test_film2("use_first_loadfont_as_default", { dcp });
274 dcp->only_text()->set_use(true);
275 dcp->only_text()->set_language(dcp::LanguageTag("de"));
278 { dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME }
281 dcp::DCP test(film->dir(film->dcp_name()));
283 BOOST_REQUIRE(!test.cpls().empty());
284 auto cpl = test.cpls()[0];
285 BOOST_REQUIRE(!cpl->reels().empty());
286 auto reel = cpl->reels()[0];
287 BOOST_REQUIRE(reel->main_subtitle()->asset());
288 auto subtitle = std::dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(reel->main_subtitle()->asset());
289 BOOST_REQUIRE_EQUAL(subtitle->font_data().size(), 1U);
290 BOOST_CHECK(subtitle->font_data().begin()->second == dcp::ArrayData("test/data/Inconsolata-VF.ttf"));