2 Copyright (C) 2020-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/audio_content.h"
23 #include "lib/config.h"
24 #include "lib/constants.h"
25 #include "lib/content.h"
26 #include "lib/content_factory.h"
27 #include "lib/cross.h"
30 #include "lib/hints.h"
31 #include "lib/text_content.h"
33 #include <boost/test/unit_test.hpp>
36 using std::make_shared;
37 using std::shared_ptr;
40 using boost::optional;
43 vector<string> current_hints;
48 collect_hint (string hint)
50 current_hints.push_back (hint);
56 get_hints (shared_ptr<Film> film)
58 current_hints.clear ();
60 /* None of our tests need the audio analysis, and it is quite time-consuming */
61 hints.disable_audio_analysis ();
62 hints.Hint.connect (collect_hint);
65 while (signal_manager->ui_idle()) {}
73 check (TextType type, string name, optional<string> expected_hint = optional<string>())
75 auto film = new_test_film2 (name);
76 auto content = content_factory("test/data/" + name + ".srt")[0];
77 content->text.front()->set_type (type);
78 content->text.front()->set_language (dcp::LanguageTag("en-US"));
79 film->examine_and_add_content (content);
80 BOOST_REQUIRE (!wait_for_jobs());
81 auto hints = get_hints (film);
84 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
85 BOOST_CHECK_EQUAL (hints[0], *expected_hint);
88 for (auto hint: hints) {
89 message += hint + "\n";
91 BOOST_CHECK_MESSAGE(hints.empty(), "Found: " << message);
96 BOOST_AUTO_TEST_CASE (hint_closed_caption_too_long)
99 TextType::CLOSED_CAPTION,
100 "hint_closed_caption_too_long",
101 String::compose("At least one of your closed caption lines has more than %1 characters. It is advisable to make each line %1 characters at most in length.", MAX_CLOSED_CAPTION_LENGTH, MAX_CLOSED_CAPTION_LENGTH)
106 BOOST_AUTO_TEST_CASE (hint_many_closed_caption_lines)
109 TextType::CLOSED_CAPTION,
110 "hint_many_closed_caption_lines",
111 String::compose("Some of your closed captions span more than %1 lines, so they will be truncated.", MAX_CLOSED_CAPTION_LINES)
116 BOOST_AUTO_TEST_CASE (hint_subtitle_too_early)
119 TextType::OPEN_SUBTITLE,
120 "hint_subtitle_too_early",
121 string("It is advisable to put your first subtitle at least 4 seconds after the start of the DCP to make sure it is seen.")
126 BOOST_AUTO_TEST_CASE (hint_short_subtitles)
129 TextType::OPEN_SUBTITLE,
130 "hint_short_subtitles",
131 string("At least one of your subtitles lasts less than 15 frames. It is advisable to make each subtitle at least 15 frames long.")
136 BOOST_AUTO_TEST_CASE (hint_subtitles_too_close)
139 TextType::OPEN_SUBTITLE,
140 "hint_subtitles_too_close",
141 string("At least one of your subtitles starts less than 2 frames after the previous one. It is advisable to make the gap between subtitles at least 2 frames.")
146 BOOST_AUTO_TEST_CASE (hint_many_subtitle_lines)
149 TextType::OPEN_SUBTITLE,
150 "hint_many_subtitle_lines",
151 string("At least one of your subtitles has more than 3 lines. It is advisable to use no more than 3 lines.")
156 BOOST_AUTO_TEST_CASE(hint_many_subtitle_lines2)
158 check(TextType::OPEN_SUBTITLE, "hint_many_subtitle_lines2");
162 BOOST_AUTO_TEST_CASE (hint_subtitle_too_long)
165 TextType::OPEN_SUBTITLE,
166 "hint_subtitle_too_long",
167 string("At least one of your subtitle lines has more than 52 characters. It is recommended to make each line 52 characters at most in length.")
172 BOOST_AUTO_TEST_CASE (hint_subtitle_much_too_long)
175 TextType::OPEN_SUBTITLE,
176 "hint_subtitle_much_too_long",
177 string("At least one of your subtitle lines has more than 79 characters. You should make each line 79 characters at most in length.")
182 BOOST_AUTO_TEST_CASE (hint_subtitle_mxf_too_big)
184 string const name = "hint_subtitle_mxf_too_big";
186 dcp::File fake_font("build/test/hint_subtitle_mxf_too_big.ttf", "w");
187 for (int i = 0; i < 4096; ++i) {
188 std::vector<uint8_t> rubbish(65536);
189 fake_font.write(rubbish.data(), 1, rubbish.size());
193 auto film = new_test_film2 (name);
194 auto content = content_factory("test/data/" + name + ".srt")[0];
195 content->text.front()->set_type (TextType::OPEN_SUBTITLE);
196 content->text.front()->set_language (dcp::LanguageTag("en-US"));
197 film->examine_and_add_content (content);
198 BOOST_REQUIRE (!wait_for_jobs());
199 content->text.front()->get_font("")->set_file("build/test/hint_subtitle_mxf_too_big.ttf");
200 auto hints = get_hints (film);
202 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
205 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total. "
206 "You should divide the DCP into shorter reels."
211 BOOST_AUTO_TEST_CASE (hint_closed_caption_xml_too_big)
213 string const name = "hint_closed_caption_xml_too_big";
215 auto film = new_test_film2 (name);
217 dcp::File ccap(String::compose("build/test/%1.srt", name), "w");
218 BOOST_REQUIRE (ccap);
219 for (int i = 0; i < 2048; ++i) {
220 fprintf(ccap.get(), "%d\n", i + 1);
222 int minute = second % 60;
223 fprintf(ccap.get(), "00:%02d:%02d,000 --> 00:%02d:%02d,000\n", minute, second, minute, second + 1);
224 fprintf(ccap.get(), "Here are some closed captions.\n\n");
228 auto content = content_factory("build/test/" + name + ".srt")[0];
229 content->text.front()->set_type (TextType::CLOSED_CAPTION);
230 content->text.front()->set_language (dcp::LanguageTag("en-US"));
231 film->examine_and_add_content (content);
232 BOOST_REQUIRE (!wait_for_jobs());
233 auto hints = get_hints (film);
235 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
238 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT ". "
239 "You should divide the DCP into shorter reels."
244 BOOST_AUTO_TEST_CASE (hints_destroyed_while_running)
246 auto film = new_test_film2 ("hints_destroyed_while_running");
247 auto content = content_factory(TestPaths::private_data() / "boon_telly.mkv")[0];
248 film->examine_and_add_content (content);
249 BOOST_REQUIRE (!wait_for_jobs());
251 auto hints = make_shared<Hints>(film);
253 dcpomatic_sleep_seconds (1);
255 dcpomatic_sleep_seconds (1);
259 BOOST_AUTO_TEST_CASE (hints_audio_with_no_language)
261 auto content = content_factory("test/data/sine_440.wav")[0];
262 auto film = new_test_film2 ("hints_audio_with_no_language", { content });
263 content->audio->set_gain (-6);
265 auto hints = get_hints (film);
266 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
269 "Some of your content has audio but you have not set the audio language. It is advisable to set the audio language "
270 "in the \"DCP\" tab unless your audio has no spoken parts."
275 BOOST_AUTO_TEST_CASE (hints_certificate_validity)
279 Config::instance()->set_signer_chain(make_shared<dcp::CertificateChain>(openssl_path(), 40 * 365));
281 auto film = new_test_film2 ("hints_certificate_validity");
282 auto hints = get_hints (film);
283 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
286 "The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period "
287 "that is too long. This will cause problems playing back DCPs on some systems. "
288 "You are advised to re-create the signing certificate chain by clicking the "
289 "\"Re-make certificates and key...\" button in the Keys page of Preferences."