test/hints_test.cc

   1 /*
   2     Copyright (C) 2020 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/content.h"
  23 #include "lib/content_factory.h"
  24 #include "lib/cross.h"
  25 #include "lib/film.h"
  26 #include "lib/font.h"
  27 #include "lib/hints.h"
  28 #include "lib/text_content.h"
  29 #include "lib/util.h"
  30 #include "test.h"
  31 #include <boost/shared_ptr.hpp>
  32 #include <boost/test/unit_test.hpp>
  33
  34
  35 using std::string;
  36 using std::vector;
  37 using boost::optional;
  38 using boost::shared_ptr;
  39
  40
  41 vector<string> current_hints;
  42
  43
  44 static
  45 void
  46 collect_hint (string hint)
  47 {
  48         current_hints.push_back (hint);
  49 }
  50
  51
  52 static
  53 vector<string>
  54 get_hints (shared_ptr<Film> film)
  55 {
  56         current_hints.clear ();
  57         Hints hints (film);
  58         hints.Hint.connect (collect_hint);
  59         hints.start ();
  60         hints.join ();
  61         while (signal_manager->ui_idle()) {}
  62         return current_hints;
  63 }
  64
  65
  66 static
  67 void
  68 check (TextType type, string name, optional<string> expected_hint = optional<string>())
  69 {
  70         shared_ptr<Film> film = new_test_film2 (name);
  71         shared_ptr<Content> content = content_factory("test/data/" + name + ".srt").front();
  72         content->text.front()->set_type (type);
  73         film->examine_and_add_content (content);
  74         BOOST_REQUIRE (!wait_for_jobs());
  75         vector<string> hints = get_hints (film);
  76
  77         if (expected_hint) {
  78                 BOOST_REQUIRE_EQUAL (hints.size(), 1);
  79                 BOOST_CHECK_EQUAL (hints[0], *expected_hint);
  80         } else {
  81                 BOOST_CHECK (hints.empty());
  82         }
  83 }
  84
  85
  86 BOOST_AUTO_TEST_CASE (hint_closed_caption_too_long)
  87 {
  88         check (
  89                 TEXT_CLOSED_CAPTION,
  90                 "hint_closed_caption_too_long",
  91                 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)
  92               );
  93 }
  94
  95
  96 BOOST_AUTO_TEST_CASE (hint_many_closed_caption_lines)
  97 {
  98         check (
  99                 TEXT_CLOSED_CAPTION,
 100                 "hint_many_closed_caption_lines",
 101                 String::compose("Some of your closed captions span more than %1 lines, so they will be truncated.", MAX_CLOSED_CAPTION_LINES)
 102               );
 103 }
 104
 105
 106 BOOST_AUTO_TEST_CASE (hint_subtitle_too_early)
 107 {
 108         check (
 109                 TEXT_OPEN_SUBTITLE,
 110                 "hint_subtitle_too_early",
 111                 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.")
 112                 );
 113 }
 114
 115
 116 BOOST_AUTO_TEST_CASE (hint_short_subtitles)
 117 {
 118         check (
 119                 TEXT_OPEN_SUBTITLE,
 120                 "hint_short_subtitles",
 121                 string("At least one of your subtitles lasts less than 15 frames.  It is advisable to make each subtitle at least 15 frames long.")
 122                 );
 123 }
 124
 125
 126 BOOST_AUTO_TEST_CASE (hint_subtitles_too_close)
 127 {
 128         check (
 129                 TEXT_OPEN_SUBTITLE,
 130                 "hint_subtitles_too_close",
 131                 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.")
 132               );
 133 }
 134
 135
 136 BOOST_AUTO_TEST_CASE (hint_many_subtitle_lines)
 137 {
 138         check (
 139                 TEXT_OPEN_SUBTITLE,
 140                 "hint_many_subtitle_lines",
 141                 string("At least one of your subtitles has more than 3 lines.  It is advisable to use no more than 3 lines.")
 142               );
 143 }
 144
 145
 146 BOOST_AUTO_TEST_CASE (hint_subtitle_too_long)
 147 {
 148         check (
 149                 TEXT_OPEN_SUBTITLE,
 150                 "hint_subtitle_too_long",
 151                 string("At least one of your subtitle lines has more than 52 characters.  It is advisable to make each line 52 characters at most in length.")
 152               );
 153 }
 154
 155
 156 BOOST_AUTO_TEST_CASE (hint_subtitle_mxf_too_big)
 157 {
 158         string const name = "hint_subtitle_mxf_too_big";
 159
 160         shared_ptr<Film> film = new_test_film2 (name);
 161         shared_ptr<Content> content = content_factory("test/data/" + name + ".srt").front();
 162         content->text.front()->set_type (TEXT_OPEN_SUBTITLE);
 163         for (int i = 1; i < 512; ++i) {
 164                 shared_ptr<dcpomatic::Font> font(new dcpomatic::Font(String::compose("font_%1", i)));
 165                 font->set_file ("test/data/LiberationSans-Regular.ttf");
 166                 content->text.front()->add_font(font);
 167         }
 168         film->examine_and_add_content (content);
 169         BOOST_REQUIRE (!wait_for_jobs());
 170         vector<string> hints = get_hints (film);
 171
 172         BOOST_REQUIRE_EQUAL (hints.size(), 1);
 173         BOOST_CHECK_EQUAL (
 174                 hints[0],
 175                 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total.  "
 176                 "You should divide the DCP into shorter reels."
 177                 );
 178 }
 179
 180
 181 BOOST_AUTO_TEST_CASE (hint_closed_caption_xml_too_big)
 182 {
 183         string const name = "hint_closed_caption_xml_too_big";
 184
 185         shared_ptr<Film> film = new_test_film2 (name);
 186
 187         FILE* ccap = fopen_boost (String::compose("build/test/%1.srt", name), "w");
 188         BOOST_REQUIRE (ccap);
 189         for (int i = 0; i < 2048; ++i) {
 190                 fprintf(ccap, "%d\n", i + 1);
 191                 int second = i * 2;
 192                 int minute = second % 60;
 193                 fprintf(ccap, "00:%02d:%02d,000 --> 00:%02d:%02d,000\n", minute, second, minute, second + 1);
 194                 fprintf(ccap, "Here are some closed captions.\n\n");
 195         }
 196         fclose (ccap);
 197
 198         shared_ptr<Content> content = content_factory("build/test/" + name + ".srt").front();
 199         content->text.front()->set_type (TEXT_CLOSED_CAPTION);
 200         film->examine_and_add_content (content);
 201         BOOST_REQUIRE (!wait_for_jobs());
 202         vector<string> hints = get_hints (film);
 203
 204         BOOST_REQUIRE_EQUAL (hints.size(), 1);
 205         BOOST_CHECK_EQUAL (
 206                 hints[0],
 207                 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT ".  "
 208                 "You should divide the DCP into shorter reels."
 209                 );
 210 }
 211