test/srt_subtitle_test.cc

   1 /*
   2     Copyright (C) 2015-2021 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 /** @file  test/srt_subtitle_test.cc
  23  *  @brief Test writing DCPs with subtitles from .srt.
  24  *  @ingroup feature
  25  */
  26
  27
  28 #include "lib/dcp_content_type.h"
  29 #include "lib/film.h"
  30 #include "lib/font.h"
  31 #include "lib/ratio.h"
  32 #include "lib/string_text_file_content.h"
  33 #include "lib/text_content.h"
  34 #include "test.h"
  35 #include <dcp/smpte_subtitle_asset.h>
  36 #include <dcp/subtitle_string.h>
  37 #include <boost/algorithm/string.hpp>
  38 #include <boost/test/unit_test.hpp>
  39 #include <list>
  40
  41
  42 using std::list;
  43 using std::make_shared;
  44 using std::shared_ptr;
  45 using std::string;
  46 using namespace dcpomatic;
  47
  48
  49 /** Make a very short DCP with a single subtitle from .srt with no specified fonts */
  50 BOOST_AUTO_TEST_CASE (srt_subtitle_test)
  51 {
  52         auto film = new_test_film ("srt_subtitle_test");
  53         film->set_container (Ratio::from_id ("185"));
  54         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  55         film->set_name ("frobozz");
  56         film->set_audio_channels (6);
  57         film->set_interop (false);
  58         film->set_audio_channels(16);
  59         auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
  60         film->examine_and_add_content (content);
  61         BOOST_REQUIRE (!wait_for_jobs());
  62
  63         content->only_text()->set_use (true);
  64         content->only_text()->set_burn (false);
  65         make_and_verify_dcp (
  66                 film,
  67                 {
  68                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
  69                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
  70                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
  71                 });
  72
  73
  74         /* Should be blank video with a subtitle MXF */
  75         check_dcp ("test/data/srt_subtitle_test", film->dir (film->dcp_name ()));
  76 }
  77
  78
  79 /** Same again but with a `font' specified */
  80 BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
  81 {
  82         auto film = new_test_film ("srt_subtitle_test2");
  83         film->set_container (Ratio::from_id ("185"));
  84         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  85         film->set_name ("frobozz");
  86         film->set_audio_channels (6);
  87         film->set_interop (false);
  88         auto content = make_shared<StringTextFileContent> ("test/data/subrip2.srt");
  89         film->examine_and_add_content (content);
  90         BOOST_REQUIRE (!wait_for_jobs());
  91
  92         content->only_text()->set_use (true);
  93         content->only_text()->set_burn (false);
  94         /* Use test/data/subrip2.srt as if it were a font file  */
  95         content->only_text()->fonts().front()->set_file("test/data/subrip2.srt");
  96
  97         make_and_verify_dcp (
  98                 film,
  99                 {
 100                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 101                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 102                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
 103                 });
 104
 105         /* Should be blank video with a subtitle MXF; sound is irrelevant */
 106         check_dcp("test/data/srt_subtitle_test2", film->dir(film->dcp_name()), true);
 107 }
 108
 109
 110 static void
 111 check_subtitle_file (shared_ptr<Film> film, boost::filesystem::path ref)
 112 {
 113         /* Find the subtitle file and check it */
 114         check_xml (subtitle_file(film), ref, {"SubtitleID"});
 115 }
 116
 117
 118 /** Make another DCP with a longer .srt file */
 119 BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
 120 {
 121         Cleanup cl;
 122
 123         auto content = make_shared<StringTextFileContent>(TestPaths::private_data() / "Ankoemmling_short.srt");
 124         auto film = new_test_film2 ("srt_subtitle_test3", { content }, &cl);
 125
 126         film->set_name ("frobozz");
 127         film->set_interop (true);
 128         film->set_audio_channels (6);
 129
 130         content->only_text()->set_use (true);
 131         content->only_text()->set_burn (false);
 132
 133         make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
 134
 135         check_subtitle_file (film, TestPaths::private_data() / "Ankoemmling_short.xml");
 136
 137         cl.run ();
 138 }
 139
 140
 141 /** Build a small DCP with no picture and a single subtitle overlaid onto it */
 142 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
 143 {
 144         auto film = new_test_film ("srt_subtitle_test4");
 145         film->set_container (Ratio::from_id ("185"));
 146         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 147         film->set_name ("frobozz");
 148         film->set_interop (false);
 149         auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
 150         content->only_text()->set_use (true);
 151         content->only_text()->set_burn (false);
 152         film->examine_and_add_content (content);
 153         BOOST_REQUIRE (!wait_for_jobs());
 154         make_and_verify_dcp (
 155                 film,
 156                 {
 157                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 158                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 159                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
 160                 });
 161
 162         /* Should be blank video with MXF subtitles; sound is irrelevant */
 163         check_dcp("test/data/xml_subtitle_test", film->dir(film->dcp_name()), true);
 164 }
 165
 166
 167 /** Check the subtitle XML when there are two subtitle files in the project */
 168 BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
 169 {
 170         auto film = new_test_film ("srt_subtitle_test5");
 171         film->set_container (Ratio::from_id ("185"));
 172         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 173         film->set_name ("frobozz");
 174         film->set_interop (true);
 175         film->set_sequence (false);
 176         for (auto i = 0; i < 2; ++i) {
 177                 auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
 178                 content->only_text()->set_use (true);
 179                 content->only_text()->set_burn (false);
 180                 film->examine_and_add_content (content);
 181                 BOOST_REQUIRE (!wait_for_jobs());
 182                 content->set_position (film, DCPTime());
 183         }
 184         make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
 185
 186         check_dcp ("test/data/xml_subtitle_test2", film->dir (film->dcp_name ()));
 187 }
 188
 189
 190 BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
 191 {
 192         auto content = make_shared<StringTextFileContent>("test/data/frames.srt");
 193         auto film = new_test_film2 ("srt_subtitle_test6", {content});
 194         film->set_interop (false);
 195         content->only_text()->set_use (true);
 196         content->only_text()->set_burn (false);
 197         make_and_verify_dcp (
 198                 film,
 199                 {
 200                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 201                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 202                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 203                         dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
 204                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
 205                 });
 206
 207         /* This test is concerned with the subtitles, so we'll ignore any
 208          * differences in sound between the DCP and the reference to avoid test
 209          * failures for unrelated reasons.
 210          */
 211         check_dcp("test/data/srt_subtitle_test6", film->dir(film->dcp_name()), true);
 212 }
 213
 214
 215 /** Test a case where a & in srt ended up in the SMPTE subtitle as &amp;amp */
 216 BOOST_AUTO_TEST_CASE(srt_subtitle_entity)
 217 {
 218         std::ofstream srt("build/test/srt_subtitle_entity.srt");
 219         srt << "1\n";
 220         srt << "00:00:01,000 -> 00:00:10,000\n";
 221         srt << "Hello & world\n";
 222         srt.close();
 223
 224         auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_entity.srt");
 225         auto film = new_test_film2("srt_subtitle_entity", { content });
 226         film->set_interop(false);
 227         content->only_text()->set_use(true);
 228         content->only_text()->set_burn(false);
 229         make_and_verify_dcp (
 230                 film,
 231                 {
 232                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 233                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 234                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 235                         dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
 236                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
 237                 });
 238
 239         dcp::SMPTESubtitleAsset check(dcp_file(film, "sub_"));
 240         auto subs = check.subtitles();
 241         BOOST_REQUIRE_EQUAL(subs.size(), 1U);
 242         auto sub = std::dynamic_pointer_cast<const dcp::SubtitleString>(subs[0]);
 243         BOOST_REQUIRE(sub);
 244         /* libdcp::SubtitleAsset gets the text from the XML with get_content(), which
 245          * resolves the 5 predefined entities & " < > ' so we shouldn't see any
 246          * entity here.
 247          */
 248         BOOST_CHECK_EQUAL(sub->text(), "Hello & world");
 249
 250         /* It should be escaped in the raw XML though */
 251         BOOST_REQUIRE(static_cast<bool>(check.raw_xml()));
 252         BOOST_CHECK(check.raw_xml()->find("Hello &amp; world") != string::npos);
 253 }
 254
 255
 256 /** A control code in a .srt file should not make it into the XML */
 257 BOOST_AUTO_TEST_CASE(srt_subtitle_control_code)
 258 {
 259         std::ofstream srt("build/test/srt_subtitle_control_code.srt");
 260         srt << "1\n";
 261         srt << "00:00:01,000 -> 00:00:10,000\n";
 262         srt << "Hello \x0c world\n";
 263         srt.close();
 264
 265         auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_control_code.srt");
 266         auto film = new_test_film2("srt_subtitle_control_code", { content });
 267         film->set_interop(false);
 268         content->only_text()->set_use(true);
 269         content->only_text()->set_burn(false);
 270         make_and_verify_dcp (
 271                 film,
 272                 {
 273                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 274                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 275                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 276                 });
 277 }
 278
 279
 280 #if 0
 281 /* XXX: this is disabled; there is some difference in font rendering
 282    between the test machine and others.
 283 */
 284
 285 /** Test rendering of a SubRip subtitle */
 286 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
 287 {
 288         shared_ptr<Film> film = new_test_film ("subrip_render_test");
 289         shared_ptr<StringTextFile> content (new StringTextFile("test/data/subrip.srt"));
 290         content->examine (shared_ptr<Job> (), true);
 291         BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds ((3 * 60) + 56.471));
 292
 293         shared_ptr<SubRipDecoder> decoder (new SubRipDecoder (content));
 294         list<ContentStringText> cts = decoder->get_plain_texts (
 295                 ContentTimePeriod (
 296                         ContentTime::from_seconds (109), ContentTime::from_seconds (110)
 297                         ), false
 298                 );
 299         BOOST_CHECK_EQUAL (cts.size(), 1);
 300
 301         PositionImage image = render_text (cts.front().subs, dcp::Size (1998, 1080));
 302         write_image (image.image, "build/test/subrip_render_test.png");
 303         check_file ("build/test/subrip_render_test.png", "test/data/subrip_render_test.png");
 304 }
 305 #endif