b4c28e53ef685be0127567f7a6a110df772dd25d
[dcpomatic.git] / 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(), "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-US"));
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         make_and_verify_dcp(
120                 film,
121                 {
122                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
123                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
124                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
125                 });
126
127         auto check_file = subtitle_file(film);
128         dcp::SMPTESubtitleAsset check_asset(check_file);
129         BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
130         auto check_font_data = check_asset.font_data();
131         BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
132         BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
133 }
134
135
136 BOOST_AUTO_TEST_CASE(make_dcp_with_subs_in_dcp_without_font_tag)
137 {
138         /* Make a DCP with some subs in */
139         auto source_subs = content_factory("test/data/short.srt");
140         auto source = new_test_film2("make_dcp_with_subs_in_dcp_without_font_tag_source", { source_subs });
141         source->set_interop(true);
142         make_and_verify_dcp(
143                 source,
144                 {
145                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
146                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
147                         dcp::VerificationNote::Code::MISSING_CPL_METADATA,
148                         dcp::VerificationNote::Code::INVALID_STANDARD
149                 });
150
151         /* Find the ID of the subs */
152         dcp::DCP source_dcp(source->dir(source->dcp_name()));
153         source_dcp.read();
154         BOOST_REQUIRE(!source_dcp.cpls().empty());
155         BOOST_REQUIRE(!source_dcp.cpls()[0]->reels().empty());
156         BOOST_REQUIRE(source_dcp.cpls()[0]->reels()[0]->main_subtitle());
157         auto const id = source_dcp.cpls()[0]->reels()[0]->main_subtitle()->asset()->id();
158
159         /* Graft in some bad subs with no <Font> tag */
160         auto source_subtitle_file = subtitle_file(source);
161 #if BOOST_VERSION >= 107400
162         boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_options::overwrite_existing);
163 #else
164         boost::filesystem::copy_file("test/data/no_font.xml", source_subtitle_file, boost::filesystem::copy_option::overwrite_if_exists);
165 #endif
166
167         /* Fix the <Id> tag */
168         {
169                 Editor editor(source_subtitle_file);
170                 editor.replace("4dd8ee05-5986-4c67-a6f8-bbeac62e21db", id);
171         }
172
173         /* Now make a project which imports that DCP and makes another DCP from it */
174         auto dcp_content = make_shared<DCPContent>(source->dir(source->dcp_name()));
175         auto film = new_test_film2("make_dcp_with_subs_without_font_tag", { dcp_content });
176         BOOST_REQUIRE(!dcp_content->text.empty());
177         dcp_content->text.front()->set_use(true);
178         make_and_verify_dcp(
179                 film,
180                 {
181                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
182                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
183                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
184                 });
185
186         auto check_file = subtitle_file(film);
187         dcp::SMPTESubtitleAsset check_asset(check_file);
188         BOOST_CHECK_EQUAL(check_asset.load_font_nodes().size(), 1U);
189         auto check_font_data = check_asset.font_data();
190         BOOST_CHECK_EQUAL(check_font_data.size(), 1U);
191         BOOST_CHECK(check_font_data.begin()->second == dcp::ArrayData(default_font_file()));
192 }
193
194
195 BOOST_AUTO_TEST_CASE(filler_subtitle_reels_have_load_font_tags)
196 {
197         auto const name = boost::unit_test::framework::current_test_case().full_name();
198
199         auto subs = content_factory("test/data/short.srt")[0];
200         auto video1 = content_factory("test/data/flat_red.png")[0];
201         auto video2 = content_factory("test/data/flat_red.png")[0];
202
203         auto film = new_test_film2(name, { video1, video2, subs });
204         film->set_reel_type(ReelType::BY_VIDEO_CONTENT);
205
206         make_and_verify_dcp(
207                 film,
208                 {
209                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
210                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
211                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
212                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
213                 });
214 }
215