test/dcp_subtitle_test.cc

   1 /*
   2     Copyright (C) 2014-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/dcp_subtitle_test.cc
  23  *  @brief Test DCP subtitle content in various ways.
  24  *  @ingroup feature
  25  */
  26
  27
  28 #include "lib/content_text.h"
  29 #include "lib/dcp_content.h"
  30 #include "lib/dcp_content_type.h"
  31 #include "lib/dcp_decoder.h"
  32 #include "lib/dcp_subtitle_content.h"
  33 #include "lib/dcp_subtitle_decoder.h"
  34 #include "lib/film.h"
  35 #include "lib/font.h"
  36 #include "lib/ratio.h"
  37 #include "lib/text_content.h"
  38 #include "lib/text_decoder.h"
  39 #include "test.h"
  40 #include <dcp/mono_j2k_picture_asset.h>
  41 #include <dcp/openjpeg_image.h>
  42 #include <dcp/smpte_subtitle_asset.h>
  43 #include <boost/test/unit_test.hpp>
  44 #include <iostream>
  45
  46
  47 using std::cout;
  48 using std::list;
  49 using std::make_shared;
  50 using std::shared_ptr;
  51 using std::vector;
  52 using boost::optional;
  53 #if BOOST_VERSION >= 106100
  54 using namespace boost::placeholders;
  55 #endif
  56 using namespace dcpomatic;
  57
  58
  59 optional<ContentStringText> stored;
  60
  61
  62 static void
  63 store (ContentStringText sub)
  64 {
  65         if (!stored) {
  66                 stored = sub;
  67         } else {
  68                 for (auto i: sub.subs) {
  69                         stored->subs.push_back (i);
  70                 }
  71         }
  72 }
  73
  74
  75 /** Test pass-through of a very simple DCP subtitle file */
  76 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
  77 {
  78         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub.xml");
  79         auto film = new_test_film("dcp_subtitle_test", { content });
  80         film->set_dcp_content_type(DCPContentType::from_isdcf_name("TLR"));
  81         film->set_name("frobozz");
  82
  83         BOOST_CHECK_EQUAL (content->full_length(film).get(), DCPTime::from_seconds(2).get());
  84
  85         content->only_text()->set_use (true);
  86         content->only_text()->set_burn (false);
  87         make_and_verify_dcp (
  88                 film,
  89                 {
  90                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
  91                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
  92                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
  93                 });
  94
  95         /* This test is concerned with the subtitles, so we'll ignore any
  96          * differences in sound between the DCP and the reference to avoid test
  97          * failures for unrelated reasons.
  98          */
  99         check_dcp("test/data/dcp_subtitle_test", film->dir(film->dcp_name()), true);
 100 }
 101
 102
 103 /** Test parsing of a subtitle within an existing DCP */
 104 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
 105 {
 106         auto content = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
 107         auto film = new_test_film("dcp_subtitle_within_dcp_test", { content });
 108
 109         auto decoder = make_shared<DCPDecoder>(film, content, false, false, shared_ptr<DCPDecoder>());
 110         decoder->only_text()->PlainStart.connect (bind (store, _1));
 111
 112         stored = optional<ContentStringText> ();
 113         while (!decoder->pass() && !stored) {}
 114
 115         BOOST_REQUIRE (stored);
 116         BOOST_REQUIRE_EQUAL (stored->subs.size(), 2U);
 117         BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
 118         BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
 119 }
 120
 121 /** Test subtitles whose text includes things like &lt;b&gt; */
 122 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
 123 {
 124         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub2.xml");
 125         auto film = new_test_film("dcp_subtitle_test2", { content });
 126
 127         auto decoder = make_shared<DCPSubtitleDecoder>(film, content);
 128         decoder->only_text()->PlainStart.connect (bind (store, _1));
 129
 130         stored = optional<ContentStringText> ();
 131         while (!decoder->pass()) {
 132                 if (stored && stored->from() == ContentTime(0)) {
 133                         /* Text passed around by the player should be unescaped */
 134                         BOOST_CHECK_EQUAL(stored->subs.front().text(), "<b>Hello world!</b>");
 135                 }
 136         }
 137 }
 138
 139
 140 /** Test a failure case */
 141 BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
 142 {
 143         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
 144         auto film = new_test_film("dcp_subtitle_test3", { content });
 145         film->set_interop (true);
 146         content->only_text()->set_language(dcp::LanguageTag("de"));
 147
 148         make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
 149
 150         auto decoder = make_shared<DCPSubtitleDecoder>(film, content);
 151         stored = optional<ContentStringText> ();
 152         while (!decoder->pass ()) {
 153                 decoder->only_text()->PlainStart.connect (bind (store, _1));
 154                 if (stored && stored->from() == ContentTime::from_seconds(0.08)) {
 155                         auto s = stored->subs;
 156                         auto i = s.begin ();
 157                         BOOST_CHECK_EQUAL (i->text(), "This");
 158                         ++i;
 159                         BOOST_REQUIRE (i != s.end ());
 160                         BOOST_CHECK_EQUAL (i->text(), " is ");
 161                         ++i;
 162                         BOOST_REQUIRE (i != s.end ());
 163                         BOOST_CHECK_EQUAL (i->text(), "wrong.");
 164                         ++i;
 165                         BOOST_REQUIRE (i == s.end ());
 166                 }
 167         }
 168 }
 169
 170
 171 /** Check that Interop DCPs aren't made with more than one <LoadFont> (#1273) */
 172 BOOST_AUTO_TEST_CASE (dcp_subtitle_test4)
 173 {
 174         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
 175         auto content2 = make_shared<DCPSubtitleContent>("test/data/dcp_sub3.xml");
 176         auto film = new_test_film("dcp_subtitle_test4", {content, content2});
 177         film->set_interop (true);
 178
 179         content->only_text()->add_font(make_shared<Font>("font1"));
 180         content2->only_text()->add_font(make_shared<Font>("font2"));
 181         content->only_text()->set_language(dcp::LanguageTag("de"));
 182         content2->only_text()->set_language(dcp::LanguageTag("de"));
 183
 184         make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
 185
 186         cxml::Document doc ("DCSubtitle");
 187         doc.read_file (subtitle_file (film));
 188         BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U);
 189 }
 190
 191
 192 static
 193 void
 194 check_font_tags (vector<cxml::NodePtr> nodes)
 195 {
 196         for (auto i: nodes) {
 197                 if (i->name() == "Font") {
 198                         BOOST_CHECK (!i->optional_string_attribute("Id") || i->string_attribute("Id") != "");
 199                 }
 200                 check_font_tags (i->node_children());
 201         }
 202 }
 203
 204
 205 /** Check that imported <LoadFont> tags with empty IDs (or corresponding Font tags with empty IDs)
 206  *  are not passed through into the DCP.
 207  */
 208 BOOST_AUTO_TEST_CASE (dcp_subtitle_test5)
 209 {
 210         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub6.xml");
 211         auto film = new_test_film("dcp_subtitle_test5", {content});
 212         film->set_interop (true);
 213         content->only_text()->set_language(dcp::LanguageTag("de"));
 214
 215         make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
 216
 217         cxml::Document doc ("DCSubtitle");
 218         doc.read_file (subtitle_file(film));
 219         BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1U);
 220         BOOST_CHECK (doc.node_children("LoadFont").front()->string_attribute("Id") != "");
 221
 222         check_font_tags (doc.node_children());
 223 }
 224
 225
 226 /** Check that fonts specified in the DoM content are used in the output and not ignored (#2074) */
 227 BOOST_AUTO_TEST_CASE (test_font_override)
 228 {
 229         auto content = make_shared<DCPSubtitleContent>("test/data/dcp_sub4.xml");
 230         auto film = new_test_film("test_font_override", {content});
 231         film->set_interop(true);
 232         content->only_text()->set_language(dcp::LanguageTag("de"));
 233
 234         BOOST_REQUIRE_EQUAL(content->text.size(), 1U);
 235         auto font = content->text.front()->get_font("0_theFontId");
 236         BOOST_REQUIRE(font);
 237         font->set_file("test/data/Inconsolata-VF.ttf");
 238
 239         make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
 240         check_file (subtitle_file(film).parent_path() / "font_0.ttf", "test/data/Inconsolata-VF.ttf");
 241 }
 242
 243
 244 BOOST_AUTO_TEST_CASE(entity_from_dcp_source)
 245 {
 246         std::ofstream source_xml("build/test/entity_from_dcp_source.xml");
 247         source_xml
 248                 << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 249                 << "<SubtitleReel xmlns=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
 250                 << "<Id>urn:uuid:9c0a0a67-ffd8-4c65-8b5a-c6be3ef182c5</Id>\n"
 251                 << "<ContentTitleText>DCP</ContentTitleText>\n"
 252                 << "<IssueDate>2022-11-30T18:13:56.000+01:00</IssueDate>\n"
 253                 << "<ReelNumber>1</ReelNumber>\n"
 254                 << "<EditRate>24 1</EditRate>\n"
 255                 << "<TimeCodeRate>24</TimeCodeRate>\n"
 256                 << "<StartTime>00:00:00:00</StartTime>\n"
 257                 << "<LoadFont ID=\"font\">urn:uuid:899e5c59-50f6-467b-985b-8282c020e1ee</LoadFont>\n"
 258                 << "<SubtitleList>\n"
 259                 << "<Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"font\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">\n"
 260                 << "<Subtitle SpotNumber=\"1\" TimeIn=\"00:00:00:00\" TimeOut=\"00:00:10:00\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">\n"
 261                 << "<Text Valign=\"top\" Vposition=\"82.7273\">Hello &amp; world</Text>\n"
 262                 << "</Subtitle>\n"
 263                 << "</Font>\n"
 264                 << "</SubtitleList>\n"
 265                 << "</SubtitleReel>\n";
 266         source_xml.close();
 267
 268         auto content = make_shared<DCPSubtitleContent>("build/test/entity_from_dcp_source.xml");
 269         auto film = new_test_film("entity_from_dcp_source", { content });
 270         film->set_interop(false);
 271         content->only_text()->set_use(true);
 272         content->only_text()->set_burn(false);
 273         make_and_verify_dcp (
 274                 film,
 275                 {
 276                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 277                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 278                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 279                         dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
 280                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
 281                 });
 282
 283         dcp::SMPTESubtitleAsset check(dcp_file(film, "sub_"));
 284         auto subs = check.subtitles();
 285         BOOST_REQUIRE_EQUAL(subs.size(), 1U);
 286         auto sub = std::dynamic_pointer_cast<const dcp::SubtitleString>(subs[0]);
 287         BOOST_REQUIRE(sub);
 288         /* libdcp::SubtitleAsset gets the text from the XML with get_content(), which
 289          * resolves the 5 predefined entities & " < > ' so we shouldn't see any
 290          * entity here.
 291          */
 292         BOOST_CHECK_EQUAL(sub->text(), "Hello & world");
 293
 294         /* It should be escaped in the raw XML though */
 295         BOOST_REQUIRE(static_cast<bool>(check.raw_xml()));
 296         BOOST_CHECK(check.raw_xml()->find("Hello &amp; world") != std::string::npos);
 297
 298         /* Remake with burn */
 299         content->only_text()->set_burn(true);
 300         boost::filesystem::remove_all(film->dir(film->dcp_name()));
 301         make_and_verify_dcp (
 302                 film,
 303                 {
 304                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 305                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 306                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 307                         dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
 308                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
 309                 });
 310
 311         dcp::MonoJ2KPictureAsset burnt(dcp_file(film, "j2c_"));
 312         auto frame = burnt.start_read()->get_frame(12)->xyz_image();
 313         auto const size = frame->size();
 314         int max_X = 0;
 315         for (auto y = 0; y < size.height; ++y) {
 316                 for (auto x = 0; x < size.width; ++x) {
 317                         max_X = std::max(frame->data(0)[x + y * size.width], max_X);
 318                 }
 319         }
 320
 321         /* Check that the subtitle got rendered to the image; if the escaping of the & is wrong Pango
 322          * will throw errors and nothing will be rendered.
 323          */
 324         BOOST_CHECK(max_X > 100);
 325 }
 326