test/subtitle_font_id_test.cc

   1 /*
   2     Copyright (C) 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/content_factory.h"
  23 #include "lib/dcp_content.h"
  24 #include "lib/film.h"
  25 #include "lib/font.h"
  26 #include "lib/text_content.h"
  27 #include "lib/util.h"
  28 #include <dcp/cpl.h>
  29 #include <dcp/dcp.h>
  30 #include <dcp/reel.h>
  31 #include <dcp/reel_subtitle_asset.h>
  32 #include <dcp/smpte_subtitle_asset.h>
  33 #include "test.h"
  34 #include <boost/test/unit_test.hpp>
  35
  36
  37 using std::make_shared;
  38
  39
  40 BOOST_AUTO_TEST_CASE(full_dcp_subtitle_font_id_test)
  41 {
  42         auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
  43         auto film = new_test_film2("full_dcp_subtitle_font_id_test", { dcp });
  44
  45         auto content = film->content();
  46         BOOST_REQUIRE_EQUAL(content.size(), 1U);
  47         auto text = content[0]->only_text();
  48         BOOST_REQUIRE(text);
  49
  50         BOOST_REQUIRE_EQUAL(text->fonts().size(), 1U);
  51         auto font = text->fonts().front();
  52         BOOST_CHECK_EQUAL(font->id(), "0_theFontId");
  53         BOOST_REQUIRE(font->data());
  54         BOOST_CHECK_EQUAL(font->data()->size(), 367112);
  55 }
  56
  57
  58 BOOST_AUTO_TEST_CASE(dcp_subtitle_font_id_test)
  59 {
  60         auto subs = content_factory(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV" / "8b48f6ae-c74b-4b80-b994-a8236bbbad74_sub.mxf");
  61         auto film = new_test_film2("dcp_subtitle_font_id_test", subs);
  62
  63         auto content = film->content();
  64         BOOST_REQUIRE_EQUAL(content.size(), 1U);
  65         auto text = content[0]->only_text();
  66         BOOST_REQUIRE(text);
  67
  68         BOOST_REQUIRE_EQUAL(text->fonts().size(), 1U);
  69         auto font = text->fonts().front();
  70         BOOST_CHECK_EQUAL(font->id(), "0_theFontId");
  71         BOOST_REQUIRE(font->data());
  72         BOOST_CHECK_EQUAL(font->data()->size(), 367112);
  73 }
  74
  75
  76 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_interop_dcp)
  77 {
  78         auto dcp = make_shared<DCPContent>("test/data/Iopsubs_FTR-1_F_XX-XX_MOS_2K_20220710_IOP_OV");
  79         auto film = new_test_film2("make_dcp_with_subs_from_interop_dcp", { dcp });
  80         dcp->text.front()->set_use(true);
  81         make_and_verify_dcp(
  82                 film,
  83                 {
  84                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
  85                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
  86                 }
  87         );
  88 }
  89
  90
  91 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_smpte_dcp)
  92 {
  93         Cleanup cl;
  94
  95         auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
  96         auto film = new_test_film2("make_dcp_with_subs_from_smpte_dcp", { dcp }, &cl);
  97         dcp->text.front()->set_use(true);
  98         make_and_verify_dcp(film);
  99
 100         cl.run();
 101 }
 102
 103
 104 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_from_mkv)
 105 {
 106         auto subs = content_factory(TestPaths::private_data() / "clapperboard_with_subs.mkv");
 107         auto film = new_test_film2("make_dcp_with_subs_from_mkv", subs);
 108         subs[0]->text.front()->set_use(true);
 109         subs[0]->text.front()->set_language(dcp::LanguageTag("en"));
 110         make_and_verify_dcp(film, { dcp::VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K });
 111 }
 112
 113
 114 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_without_font_tag)
 115 {
 116         auto subs = content_factory("test/data/no_font.xml");
 117         auto film = new_test_film2("make_dcp_with_subs_without_font_tag", { subs });
 118         subs[0]->text.front()->set_use(true);
 119         subs[0]->text.front()->set_language(dcp::LanguageTag("de"));
 120         make_and_verify_dcp(
 121                 film,
 122                 {
 123                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 124                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 125                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
 126                 });
 127
 128         auto check_file = subtitle_file(film);
 129         dcp::SMPTESubtitleAsset check_asset(check_file);
 130         BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
 131         auto check_font_data = check_asset.font_data();
 132         BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
 133         BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
 134 }
 135
 136
 137 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_in_dcp_without_font_tag)
 138 {
 139         /* Make a DCP with some subs in */
 140         auto source_subs = content_factory("test/data/short.srt");
 141         auto source = new_test_film2("make_dcp_with_subs_in_dcp_without_font_tag_source", { source_subs });
 142         source->set_interop(true);
 143         source_subs[0]->only_text()->set_language(dcp::LanguageTag("de"));
 144         make_and_verify_dcp(
 145                 source,
 146                 {
 147                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 148                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 149                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
 150                         dcp::VerificationNote::Code::INVALID_STANDARD
 151                 });
 152
 153         /* Find the ID of the subs */
 154         dcp::DCP source_dcp(source->dir(source->dcp_name()));
 155         source_dcp.read();
 156         BOOST_REQUIRE(!source_dcp.cpls().empty());
 157         BOOST_REQUIRE(!source_dcp.cpls()[0]->reels().empty());
 158         BOOST_REQUIRE(source_dcp.cpls()[0]->reels()[0]->main_subtitle());
 159         auto const id = source_dcp.cpls()[0]->reels()[0]->main_subtitle()->asset()->id();
 160
 161         /* Graft in some bad subs with no <Font> tag */
 162         auto source_subtitle_file = subtitle_file(source);
 163 #if BOOST_VERSION >= 107400
 164         boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_options::overwrite_existing);
 165 #else
 166         boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_option::overwrite_if_exists);
 167 #endif
 168
 169         /* Fix the <Id> tag */
 170         {
 171                 Editor editor(source_subtitle_file);
 172                 editor.replace("4dd8ee05-5986-4c67-a6f8-bbeac62e21db", id);
 173         }
 174
 175         /* Now make a project which imports that DCP and makes another DCP from it */
 176         auto dcp_content = make_shared<DCPContent>(source->dir(source->dcp_name()));
 177         auto film = new_test_film2("make_dcp_with_subs_without_font_tag", { dcp_content });
 178         BOOST_REQUIRE(!dcp_content->text.empty());
 179         dcp_content->text.front()->set_use(true);
 180         make_and_verify_dcp(
 181                 film,
 182                 {
 183                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 184                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 185                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
 186                 });
 187
 188         auto check_file = subtitle_file(film);
 189         dcp::SMPTESubtitleAsset check_asset(check_file);
 190         BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
 191         auto check_font_data = check_asset.font_data();
 192         BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
 193         BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
 194 }
 195
 196
 197 BOOST_AUTO_TEST_CASE(filler_subtitle_reels_have_load_font_tags)
 198 {
 199         auto const name = boost::unit_test::framework::current_test_case().full_name();
 200
 201         auto subs = content_factory("test/data/short.srt")[0];
 202         auto video1 = content_factory("test/data/flat_red.png")[0];
 203         auto video2 = content_factory("test/data/flat_red.png")[0];
 204
 205         auto film = new_test_film2(name, { video1, video2, subs });
 206         film->set_reel_type(ReelType::BY_VIDEO_CONTENT);
 207
 208         make_and_verify_dcp(
 209                 film,
 210                 {
 211                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 212                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 213                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
 214                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
 215                 });
 216 }
 217
 218
 219 BOOST_AUTO_TEST_CASE(subtitle_with_no_font_test)
 220 {
 221         auto const name_base = boost::unit_test::framework::current_test_case().full_name();
 222
 223         auto video1 = content_factory("test/data/flat_red.png")[0];
 224         auto video2 = content_factory("test/data/flat_red.png")[0];
 225         auto subs = content_factory("test/data/short.srt")[0];
 226
 227         auto bad_film = new_test_film2(name_base + "_bad", { video1, video2, subs });
 228         bad_film->set_reel_type(ReelType::BY_VIDEO_CONTENT);
 229         video2->set_position(bad_film, video1->end(bad_film));
 230         subs->set_position(bad_film, video1->end(bad_film));
 231         subs->text[0]->add_font(make_shared<dcpomatic::Font>("foo", "test/data/LiberationSans-Regular.ttf"));
 232
 233         make_and_verify_dcp(
 234                 bad_film,
 235                 {
 236                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 237                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
 238                 });
 239
 240         /* When this test was written, this DCP would have one reel whose subtitles had <LoadFont>s
 241          * but the subtitles specified no particular font.  This triggers bug #2649, which this test
 242          * is intended to trigger.  First, make sure that the DCP has the required characteristics,
 243          * to guard against a case where for some reason the DCP here is different enough that it
 244          * doesn't trigger the bug.
 245          */
 246         dcp::DCP check(bad_film->dir(bad_film->dcp_name()));
 247         check.read();
 248         BOOST_REQUIRE_EQUAL(check.cpls().size(), 1U);
 249         auto cpl = check.cpls()[0];
 250         BOOST_REQUIRE_EQUAL(cpl->reels().size(), 2U);
 251         auto check_subs_reel = cpl->reels()[0]->main_subtitle();
 252         BOOST_REQUIRE(check_subs_reel);
 253         auto check_subs = check_subs_reel->asset();
 254         BOOST_REQUIRE(check_subs);
 255
 256         BOOST_CHECK_EQUAL(check_subs->font_data().size(), 1U);
 257         BOOST_REQUIRE_EQUAL(check_subs->subtitles().size(), 1U);
 258         BOOST_CHECK(!std::dynamic_pointer_cast<const dcp::SubtitleString>(check_subs->subtitles()[0])->font().has_value());
 259
 260         auto check_film = new_test_film2(name_base + "_check", { make_shared<DCPContent>(bad_film->dir(bad_film->dcp_name())) });
 261         make_and_verify_dcp(check_film);
 262 }
 263
 264
 265 BOOST_AUTO_TEST_CASE(load_dcp_with_empty_font_id_test)
 266 {
 267         auto dcp = std::make_shared<DCPContent>(TestPaths::private_data() / "kr_vf");
 268         auto film = new_test_film2("load_dcp_with_empty_font_id_test", { dcp });
 269 }
 270
 271
 272 BOOST_AUTO_TEST_CASE(use_first_loadfont_as_default)
 273 {
 274         auto dcp = std::make_shared<DCPContent>("test/data/use_default_font");
 275         auto film = new_test_film2("use_first_loadfont_as_default", { dcp });
 276         dcp->only_text()->set_use(true);
 277         dcp->only_text()->set_language(dcp::LanguageTag("de"));
 278         make_and_verify_dcp(
 279                 film,
 280                 { dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME }
 281                 );
 282
 283         dcp::DCP test(film->dir(film->dcp_name()));
 284         test.read();
 285         BOOST_REQUIRE(!test.cpls().empty());
 286         auto cpl = test.cpls()[0];
 287         BOOST_REQUIRE(!cpl->reels().empty());
 288         auto reel = cpl->reels()[0];
 289         BOOST_REQUIRE(reel->main_subtitle()->asset());
 290         auto subtitle = std::dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(reel->main_subtitle()->asset());
 291         BOOST_REQUIRE_EQUAL(subtitle->font_data().size(), 1U);
 292         BOOST_CHECK(subtitle->font_data().begin()->second == dcp::ArrayData("test/data/Inconsolata-VF.ttf"));
 293 }