2 Copyright (C) 2020-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 #include "lib/audio_content.h"
23 #include "lib/content.h"
24 #include "lib/content_factory.h"
25 #include "lib/cross.h"
28 #include "lib/hints.h"
29 #include "lib/text_content.h"
32 #include <boost/test/unit_test.hpp>
35 using std::make_shared;
36 using std::shared_ptr;
39 using boost::optional;
42 vector<string> current_hints;
47 collect_hint (string hint)
49 current_hints.push_back (hint);
55 get_hints (shared_ptr<Film> film)
57 current_hints.clear ();
59 hints.Hint.connect (collect_hint);
62 while (signal_manager->ui_idle()) {}
69 check (TextType type, string name, optional<string> expected_hint = optional<string>())
71 auto film = new_test_film2 (name);
72 auto content = content_factory("test/data/" + name + ".srt").front();
73 content->text.front()->set_type (type);
74 content->text.front()->set_language (dcp::LanguageTag("en-US"));
75 film->examine_and_add_content (content);
76 BOOST_REQUIRE (!wait_for_jobs());
77 auto hints = get_hints (film);
80 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
81 BOOST_CHECK_EQUAL (hints[0], *expected_hint);
83 BOOST_CHECK (hints.empty());
88 BOOST_AUTO_TEST_CASE (hint_closed_caption_too_long)
91 TextType::CLOSED_CAPTION,
92 "hint_closed_caption_too_long",
93 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)
98 BOOST_AUTO_TEST_CASE (hint_many_closed_caption_lines)
101 TextType::CLOSED_CAPTION,
102 "hint_many_closed_caption_lines",
103 String::compose("Some of your closed captions span more than %1 lines, so they will be truncated.", MAX_CLOSED_CAPTION_LINES)
108 BOOST_AUTO_TEST_CASE (hint_subtitle_too_early)
111 TextType::OPEN_SUBTITLE,
112 "hint_subtitle_too_early",
113 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.")
118 BOOST_AUTO_TEST_CASE (hint_short_subtitles)
121 TextType::OPEN_SUBTITLE,
122 "hint_short_subtitles",
123 string("At least one of your subtitles lasts less than 15 frames. It is advisable to make each subtitle at least 15 frames long.")
128 BOOST_AUTO_TEST_CASE (hint_subtitles_too_close)
131 TextType::OPEN_SUBTITLE,
132 "hint_subtitles_too_close",
133 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.")
138 BOOST_AUTO_TEST_CASE (hint_many_subtitle_lines)
141 TextType::OPEN_SUBTITLE,
142 "hint_many_subtitle_lines",
143 string("At least one of your subtitles has more than 3 lines. It is advisable to use no more than 3 lines.")
148 BOOST_AUTO_TEST_CASE (hint_subtitle_too_long)
151 TextType::OPEN_SUBTITLE,
152 "hint_subtitle_too_long",
153 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.")
158 BOOST_AUTO_TEST_CASE (hint_subtitle_much_too_long)
161 TextType::OPEN_SUBTITLE,
162 "hint_subtitle_much_too_long",
163 string("At least one of your subtitle lines has more than 79 characters. You should make each line 79 characters at most in length.")
168 BOOST_AUTO_TEST_CASE (hint_subtitle_mxf_too_big)
170 string const name = "hint_subtitle_mxf_too_big";
172 auto film = new_test_film2 (name);
173 auto content = content_factory("test/data/" + name + ".srt").front();
174 content->text.front()->set_type (TextType::OPEN_SUBTITLE);
175 content->text.front()->set_language (dcp::LanguageTag("en-US"));
176 for (int i = 1; i < 512; ++i) {
177 auto font = make_shared<dcpomatic::Font>(String::compose("font_%1", i));
178 font->set_file ("test/data/LiberationSans-Regular.ttf");
179 content->text.front()->add_font(font);
181 film->examine_and_add_content (content);
182 BOOST_REQUIRE (!wait_for_jobs());
183 auto hints = get_hints (film);
185 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
188 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total. "
189 "You should divide the DCP into shorter reels."
194 BOOST_AUTO_TEST_CASE (hint_closed_caption_xml_too_big)
196 string const name = "hint_closed_caption_xml_too_big";
198 auto film = new_test_film2 (name);
200 auto ccap = fopen_boost (String::compose("build/test/%1.srt", name), "w");
201 BOOST_REQUIRE (ccap);
202 for (int i = 0; i < 2048; ++i) {
203 fprintf(ccap, "%d\n", i + 1);
205 int minute = second % 60;
206 fprintf(ccap, "00:%02d:%02d,000 --> 00:%02d:%02d,000\n", minute, second, minute, second + 1);
207 fprintf(ccap, "Here are some closed captions.\n\n");
211 auto content = content_factory("build/test/" + name + ".srt").front();
212 content->text.front()->set_type (TextType::CLOSED_CAPTION);
213 content->text.front()->set_language (dcp::LanguageTag("en-US"));
214 film->examine_and_add_content (content);
215 BOOST_REQUIRE (!wait_for_jobs());
216 auto hints = get_hints (film);
218 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
221 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT ". "
222 "You should divide the DCP into shorter reels."
227 BOOST_AUTO_TEST_CASE (hints_destroyed_while_running)
229 auto film = new_test_film2 ("hints_destroyed_while_running");
230 auto content = content_factory(TestPaths::private_data() / "boon_telly.mkv").front();
231 film->examine_and_add_content (content);
232 BOOST_REQUIRE (!wait_for_jobs());
234 auto hints = make_shared<Hints>(film);
236 dcpomatic_sleep_seconds (1);
238 dcpomatic_sleep_seconds (1);
242 BOOST_AUTO_TEST_CASE (hints_audio_with_no_language)
244 auto content = content_factory("test/data/sine_440.wav").front();
245 auto film = new_test_film2 ("hints_audio_with_no_language", { content });
246 content->audio->set_gain (-6);
248 auto hints = get_hints (film);
249 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
252 "Some of your content has audio but you have not set the audio language. It is advisable to set the audio language "
253 "in the \"DCP\" tab unless your audio has no spoken parts."