test/hints_test.cc

   1 /*
   2     Copyright (C) 2020-2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  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"
  28 #include "lib/film.h"
  29 #include "lib/font.h"
  30 #include "lib/hints.h"
  31 #include "lib/text_content.h"
  32 #include "test.h"
  33 #include <boost/test/unit_test.hpp>
  34
  35
  36 using std::make_shared;
  37 using std::shared_ptr;
  38 using std::string;
  39 using std::vector;
  40 using boost::optional;
  41
  42
  43 vector<string> current_hints;
  44
  45
  46 static
  47 void
  48 collect_hint (string hint)
  49 {
  50         current_hints.push_back (hint);
  51 }
  52
  53
  54 static
  55 vector<string>
  56 get_hints (shared_ptr<Film> film)
  57 {
  58         current_hints.clear ();
  59         Hints hints (film);
  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);
  63         hints.start ();
  64         hints.join ();
  65         while (signal_manager->ui_idle()) {}
  66         hints.rethrow();
  67         return current_hints;
  68 }
  69
  70
  71 static
  72 void
  73 check (TextType type, string name, optional<string> expected_hint = optional<string>())
  74 {
  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);
  82
  83         if (expected_hint) {
  84                 BOOST_REQUIRE_EQUAL (hints.size(), 1U);
  85                 BOOST_CHECK_EQUAL (hints[0], *expected_hint);
  86         } else {
  87                 string message;
  88                 for (auto hint: hints) {
  89                         message += hint + "\n";
  90                 }
  91                 BOOST_CHECK_MESSAGE(hints.empty(), "Found: " << message);
  92         }
  93 }
  94
  95
  96 BOOST_AUTO_TEST_CASE (hint_closed_caption_too_long)
  97 {
  98         check (
  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)
 102               );
 103 }
 104
 105
 106 BOOST_AUTO_TEST_CASE (hint_many_closed_caption_lines)
 107 {
 108         check (
 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)
 112               );
 113 }
 114
 115
 116 BOOST_AUTO_TEST_CASE (hint_subtitle_too_early)
 117 {
 118         check (
 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.")
 122                 );
 123 }
 124
 125
 126 BOOST_AUTO_TEST_CASE (hint_short_subtitles)
 127 {
 128         check (
 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.")
 132                 );
 133 }
 134
 135
 136 BOOST_AUTO_TEST_CASE (hint_subtitles_too_close)
 137 {
 138         check (
 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.")
 142               );
 143 }
 144
 145
 146 BOOST_AUTO_TEST_CASE (hint_many_subtitle_lines)
 147 {
 148         check (
 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.")
 152               );
 153 }
 154
 155
 156 BOOST_AUTO_TEST_CASE (hint_subtitle_too_long)
 157 {
 158         check (
 159                 TextType::OPEN_SUBTITLE,
 160                 "hint_subtitle_too_long",
 161                 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.")
 162               );
 163 }
 164
 165
 166 BOOST_AUTO_TEST_CASE (hint_subtitle_much_too_long)
 167 {
 168         check (
 169                 TextType::OPEN_SUBTITLE,
 170                 "hint_subtitle_much_too_long",
 171                 string("At least one of your subtitle lines has more than 79 characters.  You should make each line 79 characters at most in length.")
 172               );
 173 }
 174
 175
 176 BOOST_AUTO_TEST_CASE (hint_subtitle_mxf_too_big)
 177 {
 178         string const name = "hint_subtitle_mxf_too_big";
 179
 180         dcp::File fake_font("build/test/hint_subtitle_mxf_too_big.ttf", "w");
 181         for (int i = 0; i < 4096; ++i) {
 182                 std::vector<uint8_t> rubbish(65536);
 183                 fake_font.write(rubbish.data(), 1, rubbish.size());
 184         }
 185         fake_font.close();
 186
 187         auto film = new_test_film2 (name);
 188         auto content = content_factory("test/data/" + name + ".srt")[0];
 189         content->text.front()->set_type (TextType::OPEN_SUBTITLE);
 190         content->text.front()->set_language (dcp::LanguageTag("en-US"));
 191         film->examine_and_add_content (content);
 192         BOOST_REQUIRE (!wait_for_jobs());
 193         content->text.front()->get_font("")->set_file("build/test/hint_subtitle_mxf_too_big.ttf");
 194         auto hints = get_hints (film);
 195
 196         BOOST_REQUIRE_EQUAL (hints.size(), 1U);
 197         BOOST_CHECK_EQUAL (
 198                 hints[0],
 199                 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total.  "
 200                 "You should divide the DCP into shorter reels."
 201                 );
 202 }
 203
 204
 205 BOOST_AUTO_TEST_CASE (hint_closed_caption_xml_too_big)
 206 {
 207         string const name = "hint_closed_caption_xml_too_big";
 208
 209         auto film = new_test_film2 (name);
 210
 211         dcp::File ccap(String::compose("build/test/%1.srt", name), "w");
 212         BOOST_REQUIRE (ccap);
 213         for (int i = 0; i < 2048; ++i) {
 214                 fprintf(ccap.get(), "%d\n", i + 1);
 215                 int second = i * 2;
 216                 int minute = second % 60;
 217                 fprintf(ccap.get(), "00:%02d:%02d,000 --> 00:%02d:%02d,000\n", minute, second, minute, second + 1);
 218                 fprintf(ccap.get(), "Here are some closed captions.\n\n");
 219         }
 220         ccap.close();
 221
 222         auto content = content_factory("build/test/" + name + ".srt")[0];
 223         content->text.front()->set_type (TextType::CLOSED_CAPTION);
 224         content->text.front()->set_language (dcp::LanguageTag("en-US"));
 225         film->examine_and_add_content (content);
 226         BOOST_REQUIRE (!wait_for_jobs());
 227         auto hints = get_hints (film);
 228
 229         BOOST_REQUIRE_EQUAL (hints.size(), 1U);
 230         BOOST_CHECK_EQUAL (
 231                 hints[0],
 232                 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT ".  "
 233                 "You should divide the DCP into shorter reels."
 234                 );
 235 }
 236
 237
 238 BOOST_AUTO_TEST_CASE (hints_destroyed_while_running)
 239 {
 240         auto film = new_test_film2 ("hints_destroyed_while_running");
 241         auto content = content_factory(TestPaths::private_data() / "boon_telly.mkv")[0];
 242         film->examine_and_add_content (content);
 243         BOOST_REQUIRE (!wait_for_jobs());
 244
 245         auto hints = make_shared<Hints>(film);
 246         hints->start ();
 247         dcpomatic_sleep_seconds (1);
 248         hints.reset ();
 249         dcpomatic_sleep_seconds (1);
 250 }
 251
 252
 253 BOOST_AUTO_TEST_CASE (hints_audio_with_no_language)
 254 {
 255         auto content = content_factory("test/data/sine_440.wav")[0];
 256         auto film = new_test_film2 ("hints_audio_with_no_language", { content });
 257         content->audio->set_gain (-6);
 258
 259         auto hints = get_hints (film);
 260         BOOST_REQUIRE_EQUAL (hints.size(), 1U);
 261         BOOST_CHECK_EQUAL (
 262                 hints[0],
 263                 "Some of your content has audio but you have not set the audio language.  It is advisable to set the audio language "
 264                 "in the \"DCP\" tab unless your audio has no spoken parts."
 265                 );
 266 }
 267
 268
 269 BOOST_AUTO_TEST_CASE (hints_certificate_validity)
 270 {
 271         ConfigRestorer cr;
 272
 273         Config::instance()->set_signer_chain(make_shared<dcp::CertificateChain>(openssl_path(), 40 * 365));
 274
 275         auto film = new_test_film2 ("hints_certificate_validity");
 276         auto hints = get_hints (film);
 277         BOOST_REQUIRE_EQUAL (hints.size(), 1U);
 278         BOOST_CHECK_EQUAL (
 279                 hints[0],
 280                 "The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period "
 281                 "that is too long.  This will cause problems playing back DCPs on some systems. "
 282                 "You are advised to re-create the signing certificate chain by clicking the "
 283                 "\"Re-make certificates and key...\" button in the Keys page of Preferences."
 284                 );
 285 }
 286