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 /* None of our tests need the audio analysis, and it is quite time-consuming */
60 hints.disable_audio_analysis ();
61 hints.Hint.connect (collect_hint);
64 while (signal_manager->ui_idle()) {}
71 check (TextType type, string name, optional<string> expected_hint = optional<string>())
73 auto film = new_test_film2 (name);
74 auto content = content_factory("test/data/" + name + ".srt").front();
75 content->text.front()->set_type (type);
76 content->text.front()->set_language (dcp::LanguageTag("en-US"));
77 film->examine_and_add_content (content);
78 BOOST_REQUIRE (!wait_for_jobs());
79 auto hints = get_hints (film);
82 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
83 BOOST_CHECK_EQUAL (hints[0], *expected_hint);
85 BOOST_CHECK (hints.empty());
90 BOOST_AUTO_TEST_CASE (hint_closed_caption_too_long)
93 TextType::CLOSED_CAPTION,
94 "hint_closed_caption_too_long",
95 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)
100 BOOST_AUTO_TEST_CASE (hint_many_closed_caption_lines)
103 TextType::CLOSED_CAPTION,
104 "hint_many_closed_caption_lines",
105 String::compose("Some of your closed captions span more than %1 lines, so they will be truncated.", MAX_CLOSED_CAPTION_LINES)
110 BOOST_AUTO_TEST_CASE (hint_subtitle_too_early)
113 TextType::OPEN_SUBTITLE,
114 "hint_subtitle_too_early",
115 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.")
120 BOOST_AUTO_TEST_CASE (hint_short_subtitles)
123 TextType::OPEN_SUBTITLE,
124 "hint_short_subtitles",
125 string("At least one of your subtitles lasts less than 15 frames. It is advisable to make each subtitle at least 15 frames long.")
130 BOOST_AUTO_TEST_CASE (hint_subtitles_too_close)
133 TextType::OPEN_SUBTITLE,
134 "hint_subtitles_too_close",
135 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.")
140 BOOST_AUTO_TEST_CASE (hint_many_subtitle_lines)
143 TextType::OPEN_SUBTITLE,
144 "hint_many_subtitle_lines",
145 string("At least one of your subtitles has more than 3 lines. It is advisable to use no more than 3 lines.")
150 BOOST_AUTO_TEST_CASE (hint_subtitle_too_long)
153 TextType::OPEN_SUBTITLE,
154 "hint_subtitle_too_long",
155 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.")
160 BOOST_AUTO_TEST_CASE (hint_subtitle_much_too_long)
163 TextType::OPEN_SUBTITLE,
164 "hint_subtitle_much_too_long",
165 string("At least one of your subtitle lines has more than 79 characters. You should make each line 79 characters at most in length.")
170 BOOST_AUTO_TEST_CASE (hint_subtitle_mxf_too_big)
172 string const name = "hint_subtitle_mxf_too_big";
174 auto film = new_test_film2 (name);
175 auto content = content_factory("test/data/" + name + ".srt").front();
176 content->text.front()->set_type (TextType::OPEN_SUBTITLE);
177 content->text.front()->set_language (dcp::LanguageTag("en-US"));
178 for (int i = 1; i < 512; ++i) {
179 auto font = make_shared<dcpomatic::Font>(String::compose("font_%1", i));
180 font->set_file ("test/data/LiberationSans-Regular.ttf");
181 content->text.front()->add_font(font);
183 film->examine_and_add_content (content);
184 BOOST_REQUIRE (!wait_for_jobs());
185 auto hints = get_hints (film);
187 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
190 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total. "
191 "You should divide the DCP into shorter reels."
196 BOOST_AUTO_TEST_CASE (hint_closed_caption_xml_too_big)
198 string const name = "hint_closed_caption_xml_too_big";
200 auto film = new_test_film2 (name);
202 auto ccap = fopen_boost (String::compose("build/test/%1.srt", name), "w");
203 BOOST_REQUIRE (ccap);
204 for (int i = 0; i < 2048; ++i) {
205 fprintf(ccap, "%d\n", i + 1);
207 int minute = second % 60;
208 fprintf(ccap, "00:%02d:%02d,000 --> 00:%02d:%02d,000\n", minute, second, minute, second + 1);
209 fprintf(ccap, "Here are some closed captions.\n\n");
213 auto content = content_factory("build/test/" + name + ".srt").front();
214 content->text.front()->set_type (TextType::CLOSED_CAPTION);
215 content->text.front()->set_language (dcp::LanguageTag("en-US"));
216 film->examine_and_add_content (content);
217 BOOST_REQUIRE (!wait_for_jobs());
218 auto hints = get_hints (film);
220 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
223 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT ". "
224 "You should divide the DCP into shorter reels."
229 BOOST_AUTO_TEST_CASE (hints_destroyed_while_running)
231 auto film = new_test_film2 ("hints_destroyed_while_running");
232 auto content = content_factory(TestPaths::private_data() / "boon_telly.mkv").front();
233 film->examine_and_add_content (content);
234 BOOST_REQUIRE (!wait_for_jobs());
236 auto hints = make_shared<Hints>(film);
238 dcpomatic_sleep_seconds (1);
240 dcpomatic_sleep_seconds (1);
244 BOOST_AUTO_TEST_CASE (hints_audio_with_no_language)
246 auto content = content_factory("test/data/sine_440.wav").front();
247 auto film = new_test_film2 ("hints_audio_with_no_language", { content });
248 content->audio->set_gain (-6);
250 auto hints = get_hints (film);
251 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
254 "Some of your content has audio but you have not set the audio language. It is advisable to set the audio language "
255 "in the \"DCP\" tab unless your audio has no spoken parts."