2 Copyright (C) 2015-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 /** @file test/srt_subtitle_test.cc
23 * @brief Test writing DCPs with subtitles from .srt.
28 #include "lib/dcp_content_type.h"
31 #include "lib/ratio.h"
32 #include "lib/string_text_file_content.h"
33 #include "lib/text_content.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>
43 using std::make_shared;
44 using std::shared_ptr;
46 using namespace dcpomatic;
49 /** Make a very short DCP with a single subtitle from .srt with no specified fonts */
50 BOOST_AUTO_TEST_CASE (srt_subtitle_test)
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());
63 content->only_text()->set_use (true);
64 content->only_text()->set_burn (false);
68 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
69 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
70 dcp::VerificationNote::Code::MISSING_CPL_METADATA
74 /* Should be blank video with a subtitle MXF */
75 check_dcp ("test/data/srt_subtitle_test", film->dir (film->dcp_name ()));
79 /** Same again but with a `font' specified */
80 BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
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());
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");
100 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
101 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
102 dcp::VerificationNote::Code::MISSING_CPL_METADATA
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);
111 check_subtitle_file (shared_ptr<Film> film, boost::filesystem::path ref)
113 /* Find the subtitle file and check it */
114 check_xml (subtitle_file(film), ref, {"SubtitleID"});
118 /** Make another DCP with a longer .srt file */
119 BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
123 auto content = make_shared<StringTextFileContent>(TestPaths::private_data() / "Ankoemmling_short.srt");
124 auto film = new_test_film2 ("srt_subtitle_test3", { content }, &cl);
126 film->set_name ("frobozz");
127 film->set_interop (true);
128 film->set_audio_channels (6);
130 content->only_text()->set_use (true);
131 content->only_text()->set_burn (false);
133 make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
135 check_subtitle_file (film, TestPaths::private_data() / "Ankoemmling_short.xml");
141 /** Build a small DCP with no picture and a single subtitle overlaid onto it */
142 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
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 (
157 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
158 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
159 dcp::VerificationNote::Code::MISSING_CPL_METADATA
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);
167 /** Check the subtitle XML when there are two subtitle files in the project */
168 BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
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 film->set_audio_channels(6);
177 for (auto i = 0; i < 2; ++i) {
178 auto content = make_shared<StringTextFileContent>("test/data/subrip2.srt");
179 content->only_text()->set_use (true);
180 content->only_text()->set_burn (false);
181 film->examine_and_add_content (content);
182 BOOST_REQUIRE (!wait_for_jobs());
183 content->set_position (film, DCPTime());
185 make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
187 check_dcp ("test/data/xml_subtitle_test2", film->dir (film->dcp_name ()));
191 BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
193 auto content = make_shared<StringTextFileContent>("test/data/frames.srt");
194 auto film = new_test_film2 ("srt_subtitle_test6", {content});
195 film->set_interop (false);
196 content->only_text()->set_use (true);
197 content->only_text()->set_burn (false);
198 make_and_verify_dcp (
201 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
202 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
203 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
204 dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
205 dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
208 /* This test is concerned with the subtitles, so we'll ignore any
209 * differences in sound between the DCP and the reference to avoid test
210 * failures for unrelated reasons.
212 check_dcp("test/data/srt_subtitle_test6", film->dir(film->dcp_name()), true);
216 /** Test a case where a & in srt ended up in the SMPTE subtitle as &amp */
217 BOOST_AUTO_TEST_CASE(srt_subtitle_entity)
219 std::ofstream srt("build/test/srt_subtitle_entity.srt");
221 srt << "00:00:01,000 -> 00:00:10,000\n";
222 srt << "Hello & world\n";
225 auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_entity.srt");
226 auto film = new_test_film2("srt_subtitle_entity", { content });
227 film->set_interop(false);
228 content->only_text()->set_use(true);
229 content->only_text()->set_burn(false);
230 make_and_verify_dcp (
233 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
234 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
235 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
236 dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
237 dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING,
240 dcp::SMPTESubtitleAsset check(dcp_file(film, "sub_"));
241 auto subs = check.subtitles();
242 BOOST_REQUIRE_EQUAL(subs.size(), 1U);
243 auto sub = std::dynamic_pointer_cast<const dcp::SubtitleString>(subs[0]);
245 /* libdcp::SubtitleAsset gets the text from the XML with get_content(), which
246 * resolves the 5 predefined entities & " < > ' so we shouldn't see any
249 BOOST_CHECK_EQUAL(sub->text(), "Hello & world");
251 /* It should be escaped in the raw XML though */
252 BOOST_REQUIRE(static_cast<bool>(check.raw_xml()));
253 BOOST_CHECK(check.raw_xml()->find("Hello & world") != string::npos);
257 /** A control code in a .srt file should not make it into the XML */
258 BOOST_AUTO_TEST_CASE(srt_subtitle_control_code)
260 std::ofstream srt("build/test/srt_subtitle_control_code.srt");
262 srt << "00:00:01,000 -> 00:00:10,000\n";
263 srt << "Hello \x0c world\n";
266 auto content = make_shared<StringTextFileContent>("build/test/srt_subtitle_control_code.srt");
267 auto film = new_test_film2("srt_subtitle_control_code", { content });
268 film->set_interop(false);
269 content->only_text()->set_use(true);
270 content->only_text()->set_burn(false);
271 make_and_verify_dcp (
274 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
275 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
276 dcp::VerificationNote::Code::MISSING_CPL_METADATA,
282 /* XXX: this is disabled; there is some difference in font rendering
283 between the test machine and others.
286 /** Test rendering of a SubRip subtitle */
287 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
289 shared_ptr<Film> film = new_test_film ("subrip_render_test");
290 shared_ptr<StringTextFile> content (new StringTextFile("test/data/subrip.srt"));
291 content->examine (shared_ptr<Job> (), true);
292 BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds ((3 * 60) + 56.471));
294 shared_ptr<SubRipDecoder> decoder (new SubRipDecoder (content));
295 list<ContentStringText> cts = decoder->get_plain_texts (
297 ContentTime::from_seconds (109), ContentTime::from_seconds (110)
300 BOOST_CHECK_EQUAL (cts.size(), 1);
302 PositionImage image = render_text (cts.front().subs, dcp::Size (1998, 1080));
303 write_image (image.image, "build/test/subrip_render_test.png");
304 check_file ("build/test/subrip_render_test.png", "test/data/subrip_render_test.png");