test/dcp_subtitle_test.cc

   1 /*
   2     Copyright (C) 2014-2019 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 /** @file  test/dcp_subtitle_test.cc
  22  *  @brief Test DCP subtitle content in various ways.
  23  *  @ingroup specific
  24  */
  25
  26 #include <boost/test/unit_test.hpp>
  27 #include "lib/film.h"
  28 #include "lib/dcp_subtitle_content.h"
  29 #include "lib/dcp_content.h"
  30 #include "lib/ratio.h"
  31 #include "lib/dcp_decoder.h"
  32 #include "lib/dcp_content_type.h"
  33 #include "lib/dcp_subtitle_decoder.h"
  34 #include "lib/text_content.h"
  35 #include "lib/content_text.h"
  36 #include "lib/font.h"
  37 #include "lib/text_decoder.h"
  38 #include "test.h"
  39 #include <iostream>
  40
  41 using std::cout;
  42 using std::list;
  43 using boost::shared_ptr;
  44 using boost::optional;
  45 using namespace dcpomatic;
  46
  47 optional<ContentStringText> stored;
  48
  49 static void
  50 store (ContentStringText sub)
  51 {
  52         if (!stored) {
  53                 stored = sub;
  54         } else {
  55                 BOOST_FOREACH (dcp::SubtitleString i, sub.subs) {
  56                         stored->subs.push_back (i);
  57                 }
  58         }
  59 }
  60
  61 /** Test pass-through of a very simple DCP subtitle file */
  62 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
  63 {
  64         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test");
  65         film->set_container (Ratio::from_id ("185"));
  66         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  67         film->set_name ("frobozz");
  68         film->set_interop (false);
  69         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub.xml"));
  70         film->examine_and_add_content (content);
  71         BOOST_REQUIRE (!wait_for_jobs ());
  72
  73         BOOST_CHECK_EQUAL (content->full_length(film).get(), DCPTime::from_seconds(2).get());
  74
  75         content->only_text()->set_use (true);
  76         content->only_text()->set_burn (false);
  77         film->make_dcp ();
  78         BOOST_REQUIRE (!wait_for_jobs ());
  79
  80         check_dcp ("test/data/dcp_subtitle_test", film->dir (film->dcp_name ()));
  81 }
  82
  83 /** Test parsing of a subtitle within an existing DCP */
  84 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
  85 {
  86         shared_ptr<Film> film = new_test_film ("dcp_subtitle_within_dcp_test");
  87         film->set_container (Ratio::from_id ("185"));
  88         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  89         film->set_name ("frobozz");
  90         shared_ptr<DCPContent> content (new DCPContent(TestPaths::private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
  91         film->examine_and_add_content (content);
  92         BOOST_REQUIRE (!wait_for_jobs ());
  93
  94         shared_ptr<DCPDecoder> decoder (new DCPDecoder (film, content, false, false, shared_ptr<DCPDecoder>()));
  95         decoder->only_text()->PlainStart.connect (bind (store, _1));
  96
  97         stored = optional<ContentStringText> ();
  98         while (!decoder->pass() && !stored) {}
  99
 100         BOOST_REQUIRE (stored);
 101         BOOST_REQUIRE_EQUAL (stored->subs.size(), 2);
 102         BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
 103         BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
 104 }
 105
 106 /** Test subtitles whose text includes things like &lt;b&gt; */
 107 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
 108 {
 109         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test2");
 110         film->set_container (Ratio::from_id ("185"));
 111         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 112         film->set_name ("frobozz");
 113         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent("test/data/dcp_sub2.xml"));
 114         film->examine_and_add_content (content);
 115         BOOST_REQUIRE (!wait_for_jobs ());
 116
 117         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder(film, content));
 118         decoder->only_text()->PlainStart.connect (bind (store, _1));
 119
 120         stored = optional<ContentStringText> ();
 121         while (!decoder->pass()) {
 122                 if (stored && stored->from() == ContentTime(0)) {
 123                         BOOST_CHECK_EQUAL (stored->subs.front().text(), "&lt;b&gt;Hello world!&lt;/b&gt;");
 124                 }
 125         }
 126 }
 127
 128 /** Test a failure case */
 129 BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
 130 {
 131         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test3");
 132         film->set_container (Ratio::from_id ("185"));
 133         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 134         film->set_name ("frobozz");
 135         film->set_interop (true);
 136         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
 137         film->examine_and_add_content (content);
 138         BOOST_REQUIRE (!wait_for_jobs ());
 139
 140         film->make_dcp ();
 141         BOOST_REQUIRE (!wait_for_jobs ());
 142
 143         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (film, content));
 144         stored = optional<ContentStringText> ();
 145         while (!decoder->pass ()) {
 146                 decoder->only_text()->PlainStart.connect (bind (store, _1));
 147                 if (stored && stored->from() == ContentTime::from_seconds(0.08)) {
 148                         list<dcp::SubtitleString> s = stored->subs;
 149                         list<dcp::SubtitleString>::const_iterator i = s.begin ();
 150                         BOOST_CHECK_EQUAL (i->text(), "This");
 151                         ++i;
 152                         BOOST_REQUIRE (i != s.end ());
 153                         BOOST_CHECK_EQUAL (i->text(), " is ");
 154                         ++i;
 155                         BOOST_REQUIRE (i != s.end ());
 156                         BOOST_CHECK_EQUAL (i->text(), "wrong.");
 157                         ++i;
 158                         BOOST_REQUIRE (i == s.end ());
 159                 }
 160         }
 161 }
 162
 163 /** Check that Interop DCPs aren't made with more than one <LoadFont> (#1273) */
 164 BOOST_AUTO_TEST_CASE (dcp_subtitle_test4)
 165 {
 166         shared_ptr<Film> film = new_test_film2 ("dcp_subtitle_test4");
 167         film->set_interop (true);
 168
 169         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
 170         film->examine_and_add_content (content);
 171         shared_ptr<DCPSubtitleContent> content2 (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
 172         film->examine_and_add_content (content2);
 173         BOOST_REQUIRE (!wait_for_jobs ());
 174
 175         content->only_text()->add_font (shared_ptr<Font> (new Font ("font1")));
 176         content2->only_text()->add_font (shared_ptr<Font> (new Font ("font2")));
 177
 178         film->make_dcp ();
 179         BOOST_REQUIRE (!wait_for_jobs ());
 180
 181         cxml::Document doc ("DCSubtitle");
 182         doc.read_file (subtitle_file (film));
 183         BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1);
 184 }
 185
 186 static
 187 void
 188 check_font_tags (list<cxml::NodePtr> nodes)
 189 {
 190         BOOST_FOREACH (cxml::NodePtr i, nodes) {
 191                 if (i->name() == "Font") {
 192                         BOOST_CHECK (!i->optional_string_attribute("Id") || i->string_attribute("Id") != "");
 193                 }
 194                 check_font_tags (i->node_children());
 195         }
 196 }
 197
 198 /** Check that imported <LoadFont> tags with empty IDs (or corresponding Font tags with empty IDs)
 199  *  are not passed through into the DCP.
 200  */
 201 BOOST_AUTO_TEST_CASE (dcp_subtitle_test5)
 202 {
 203         shared_ptr<Film> film = new_test_film2 ("dcp_subtitle_test5");
 204         film->set_interop (true);
 205
 206         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent("test/data/dcp_sub6.xml"));
 207         film->examine_and_add_content (content);
 208         BOOST_REQUIRE (!wait_for_jobs());
 209
 210         film->make_dcp ();
 211         BOOST_REQUIRE (!wait_for_jobs());
 212         film->write_metadata ();
 213
 214         cxml::Document doc ("DCSubtitle");
 215         doc.read_file (subtitle_file(film));
 216         BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1);
 217         BOOST_CHECK (doc.node_children("LoadFont").front()->string_attribute("Id") != "");
 218
 219         check_font_tags (doc.node_children());
 220 }