2 Copyright (C) 2015-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp 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 libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
34 #include "interop_subtitle_asset.h"
35 #include "smpte_subtitle_asset.h"
36 #include "subtitle_string.h"
37 #include "subtitle_image.h"
38 #include "subtitle_asset_internal.h"
39 #include "reel_subtitle_asset.h"
45 #include <boost/test/unit_test.hpp>
48 using std::shared_ptr;
50 using std::make_shared;
51 using boost::optional;
53 /** Test dcp::order::Font::take_intersection */
54 BOOST_AUTO_TEST_CASE (take_intersection_test)
57 A._values["foo"] = "bar";
58 A._values["fred"] = "jim";
61 B._values["foo"] = "bar";
62 B._values["sheila"] = "baz";
64 A.take_intersection (B);
65 BOOST_REQUIRE_EQUAL (A._values.size(), 1);
66 BOOST_CHECK_EQUAL (A._values["foo"], "bar");
71 A._values["foo"] = "bar";
72 A._values["fred"] = "jim";
74 B._values["foo"] = "hello";
75 B._values["sheila"] = "baz";
77 A.take_intersection (B);
78 BOOST_CHECK_EQUAL (A._values.size(), 0);
81 /** Test dcp::order::Font::take_difference */
82 BOOST_AUTO_TEST_CASE (take_difference_test)
85 A._values["foo"] = "bar";
86 A._values["fred"] = "jim";
89 B._values["foo"] = "bar";
90 B._values["sheila"] = "baz";
92 A.take_difference (B);
93 BOOST_REQUIRE_EQUAL (A._values.size(), 1);
94 BOOST_CHECK_EQUAL (A._values["fred"], "jim");
97 /** Test dcp::order::Subtitle::pull_fonts */
98 BOOST_AUTO_TEST_CASE (pull_fonts_test1)
100 auto root = make_shared<dcp::order::Part>(shared_ptr<dcp::order::Part>());
101 auto sub1 = make_shared<dcp::order::Subtitle>(root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time());
102 root->children.push_back (sub1);
103 auto text1 = make_shared<dcp::order::Text>(sub1, dcp::HAlign::CENTER, 0, dcp::VAlign::TOP, 0, dcp::Direction::LTR);
104 sub1->children.push_back (text1);
105 text1->font._values["font"] = "Inconsolata";
106 text1->font._values["size"] = "42";
108 dcp::SubtitleAsset::pull_fonts (root);
110 BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
111 BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
112 BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
113 BOOST_CHECK_EQUAL (text1->font._values.size(), 0);
116 /** Test dcp::order::Subtitle::pull_fonts */
117 BOOST_AUTO_TEST_CASE (pull_fonts_test2)
119 shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
120 shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
121 root->children.push_back (sub1);
122 shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HAlign::CENTER, 0, dcp::VAlign::TOP, 0, dcp::Direction::LTR));
123 sub1->children.push_back (text1);
124 text1->font._values["font"] = "Inconsolata";
125 text1->font._values["size"] = "42";
126 shared_ptr<dcp::order::Text> text2 (new dcp::order::Text (sub1, dcp::HAlign::CENTER, 0, dcp::VAlign::TOP, 0, dcp::Direction::LTR));
127 sub1->children.push_back (text2);
128 text2->font._values["font"] = "Inconsolata";
129 text2->font._values["size"] = "48";
131 dcp::SubtitleAsset::pull_fonts (root);
133 BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 1);
134 BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
135 BOOST_REQUIRE_EQUAL (text1->font._values.size(), 1);
136 BOOST_CHECK_EQUAL (text1->font._values["size"], "42");
137 BOOST_REQUIRE_EQUAL (text2->font._values.size(), 1);
138 BOOST_CHECK_EQUAL (text2->font._values["size"], "48");
141 /** Test dcp::order::Subtitle::pull_fonts */
142 BOOST_AUTO_TEST_CASE (pull_fonts_test3)
144 shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
145 shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
146 root->children.push_back (sub1);
147 shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HAlign::CENTER, 0, dcp::VAlign::TOP, 0, dcp::Direction::LTR));
148 sub1->children.push_back (text1);
149 dcp::order::Font font;
150 font._values["font"] = "Inconsolata";
151 font._values["size"] = "42";
152 shared_ptr<dcp::order::String> string1 (new dcp::order::String (text1, font, "Hello world"));
153 text1->children.push_back (string1);
155 dcp::SubtitleAsset::pull_fonts (root);
157 BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
158 BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
159 BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
162 /** Write some subtitle content as Interop XML and check that it is right */
163 BOOST_AUTO_TEST_CASE (write_interop_subtitle_test)
165 dcp::InteropSubtitleAsset c;
166 c.set_reel_number ("1");
167 c.set_language ("EN");
168 c.set_movie_title ("Test");
171 shared_ptr<dcp::Subtitle> (
172 new dcp::SubtitleString (
177 dcp::Colour (255, 255, 255),
180 dcp::Time (0, 4, 9, 22, 24),
181 dcp::Time (0, 4, 11, 22, 24),
189 dcp::Colour (0, 0, 0),
190 dcp::Time (0, 0, 0, 0, 24),
191 dcp::Time (0, 0, 0, 0, 24)
197 shared_ptr<dcp::Subtitle> (
198 new dcp::SubtitleString (
199 boost::optional<string> (),
203 dcp::Colour (128, 0, 64),
206 dcp::Time (5, 41, 0, 21, 24),
207 dcp::Time (6, 12, 15, 21, 24),
215 dcp::Colour (1, 2, 3),
216 dcp::Time (1, 2, 3, 4, 24),
217 dcp::Time (5, 6, 7, 8, 24)
222 c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
225 "<DCSubtitle Version=\"1.0\">"
226 "<SubtitleID>a6c58cff-3e1e-4b38-acec-a42224475ef6</SubtitleID>"
227 "<MovieTitle>Test</MovieTitle>"
228 "<ReelNumber>1</ReelNumber>"
229 "<Language>EN</Language>"
230 "<Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" Id=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underlined=\"no\" Weight=\"normal\">"
231 "<Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:229\" TimeOut=\"00:04:11:229\" FadeUpTime=\"0\" FadeDownTime=\"0\">"
232 "<Text VAlign=\"top\" VPosition=\"80\">Hello world</Text>"
235 "<Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underlined=\"yes\" Weight=\"bold\">"
236 "<Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:219\" TimeOut=\"06:12:15:219\" FadeUpTime=\"930792\" FadeDownTime=\"4591834\">"
237 "<Text VAlign=\"bottom\" VPosition=\"40\">What's going on</Text>"
246 /** Write some subtitle content as Interop XML and check that it is right.
247 * This test includes some horizontal alignment.
249 BOOST_AUTO_TEST_CASE (write_interop_subtitle_test2)
251 dcp::InteropSubtitleAsset c;
252 c.set_reel_number ("1");
253 c.set_language ("EN");
254 c.set_movie_title ("Test");
257 shared_ptr<dcp::Subtitle> (
258 new dcp::SubtitleString (
263 dcp::Colour (255, 255, 255),
266 dcp::Time (0, 4, 9, 22, 24),
267 dcp::Time (0, 4, 11, 22, 24),
275 dcp::Colour (0, 0, 0),
276 dcp::Time (0, 0, 0, 0, 24),
277 dcp::Time (0, 0, 0, 0, 24)
283 shared_ptr<dcp::Subtitle> (
284 new dcp::SubtitleString (
285 boost::optional<string> (),
289 dcp::Colour (128, 0, 64),
292 dcp::Time (5, 41, 0, 21, 24),
293 dcp::Time (6, 12, 15, 21, 24),
301 dcp::Colour (1, 2, 3),
302 dcp::Time (1, 2, 3, 4, 24),
303 dcp::Time (5, 6, 7, 8, 24)
308 c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
311 "<DCSubtitle Version=\"1.0\">"
312 "<SubtitleID>a6c58cff-3e1e-4b38-acec-a42224475ef6</SubtitleID>"
313 "<MovieTitle>Test</MovieTitle>"
314 "<ReelNumber>1</ReelNumber>"
315 "<Language>EN</Language>"
316 "<Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" Id=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underlined=\"no\" Weight=\"normal\">"
317 "<Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:229\" TimeOut=\"00:04:11:229\" FadeUpTime=\"0\" FadeDownTime=\"0\">"
318 "<Text HPosition=\"-20\" VAlign=\"top\" VPosition=\"80\">Hello world</Text>"
321 "<Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underlined=\"yes\" Weight=\"bold\">"
322 "<Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:219\" TimeOut=\"06:12:15:219\" FadeUpTime=\"930792\" FadeDownTime=\"4591834\">"
323 "<Text HPosition=\"-20\" VAlign=\"bottom\" VPosition=\"40\">What's going on</Text>"
332 /* Write some subtitle content as Interop XML using bitmaps and check that it is right */
333 BOOST_AUTO_TEST_CASE (write_interop_subtitle_test3)
337 shared_ptr<dcp::InteropSubtitleAsset> c (new dcp::InteropSubtitleAsset());
338 c->set_reel_number ("1");
339 c->set_language ("EN");
340 c->set_movie_title ("Test");
343 shared_ptr<dcp::Subtitle> (
344 new dcp::SubtitleImage (
345 dcp::ArrayData ("test/data/sub.png"),
346 dcp::Time (0, 4, 9, 22, 24),
347 dcp::Time (0, 4, 11, 22, 24),
352 dcp::Time (0, 0, 0, 0, 24),
353 dcp::Time (0, 0, 0, 0, 24)
358 c->_id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
359 boost::filesystem::remove_all ("build/test/write_interop_subtitle_test3");
360 boost::filesystem::create_directories ("build/test/write_interop_subtitle_test3");
361 c->write ("build/test/write_interop_subtitle_test3/subs.xml");
363 shared_ptr<dcp::Reel> reel (new dcp::Reel());
364 reel->add(shared_ptr<dcp::ReelSubtitleAsset>(new dcp::ReelSubtitleAsset(c, dcp::Fraction(24, 1), 6046, 0)));
366 string const issue_date = "2018-09-02T04:45:18+00:00";
367 string const issuer = "libdcp";
368 string const creator = "libdcp";
369 string const annotation_text = "Created by libdcp";
371 auto cpl = make_shared<dcp::CPL>("My film", dcp::ContentKind::FEATURE);
373 cpl->set_issuer (issuer);
374 cpl->set_creator (creator);
375 cpl->set_issue_date (issue_date);
376 cpl->set_annotation_text (annotation_text);
377 auto cv = cpl->content_version();
379 cv->label_text = "foo";
380 cpl->set_content_version (*cv);
382 dcp::DCP dcp ("build/test/write_interop_subtitle_test3");
384 dcp.write_xml (dcp::Standard::INTEROP, issuer, creator, issue_date, annotation_text);
387 dcp::file_to_string("test/ref/write_interop_subtitle_test3/subs.xml"),
388 dcp::file_to_string("build/test/write_interop_subtitle_test3/subs.xml"),
391 check_file ("build/test/write_interop_subtitle_test3/d36f4bb3-c4fa-4a95-9915-6fec3110cd71.png", "test/data/sub.png");
394 dcp::file_to_string("test/ref/write_interop_subtitle_test3/ASSETMAP"),
395 dcp::file_to_string("build/test/write_interop_subtitle_test3/ASSETMAP"),
400 dcp::file_to_string("test/ref/write_interop_subtitle_test3/pkl.xml"),
401 dcp::file_to_string("build/test/write_interop_subtitle_test3/pkl_6a9e31a6-50a4-4ecb-8683-fa667848470a.xml"),
406 /* Write some subtitle content as SMPTE XML and check that it is right */
407 BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test)
409 dcp::SMPTESubtitleAsset c;
410 c.set_reel_number (1);
411 c.set_language (dcp::LanguageTag("en"));
412 c.set_content_title_text ("Test");
413 c.set_issue_date (dcp::LocalTime ("2016-04-01T03:52:00+00:00"));
416 make_shared<dcp::SubtitleString> (
421 dcp::Colour (255, 255, 255),
424 dcp::Time (0, 4, 9, 22, 24),
425 dcp::Time (0, 4, 11, 22, 24),
433 dcp::Colour (0, 0, 0),
434 dcp::Time (0, 0, 0, 0, 24),
435 dcp::Time (0, 0, 0, 0, 24)
440 make_shared<dcp::SubtitleString>(
441 boost::optional<string> (),
445 dcp::Colour (128, 0, 64),
448 dcp::Time (5, 41, 0, 21, 24),
449 dcp::Time (6, 12, 15, 21, 24),
457 dcp::Colour (1, 2, 3),
458 dcp::Time (1, 2, 3, 4, 24),
459 dcp::Time (5, 6, 7, 8, 24)
463 c._xml_id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
466 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
467 "<dcst:SubtitleReel xmlns:dcst=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">"
468 "<dcst:Id>urn:uuid:a6c58cff-3e1e-4b38-acec-a42224475ef6</dcst:Id>"
469 "<dcst:ContentTitleText>Test</dcst:ContentTitleText>"
470 "<dcst:IssueDate>2016-04-01T03:52:00.000+00:00</dcst:IssueDate>"
471 "<dcst:ReelNumber>1</dcst:ReelNumber>"
472 "<dcst:Language>en</dcst:Language>"
473 "<dcst:EditRate>24 1</dcst:EditRate>"
474 "<dcst:TimeCodeRate>24</dcst:TimeCodeRate>"
475 "<dcst:SubtitleList>"
476 "<dcst:Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">"
477 "<dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:22\" TimeOut=\"00:04:11:22\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">"
478 "<dcst:Text Valign=\"top\" Vposition=\"80\">Hello world</dcst:Text>"
481 "<dcst:Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underline=\"yes\" Weight=\"bold\">"
482 "<dcst:Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:21\" TimeOut=\"06:12:15:21\" FadeUpTime=\"01:02:03:04\" FadeDownTime=\"05:06:07:08\">"
483 "<dcst:Text Valign=\"bottom\" Vposition=\"40\" Direction=\"rtl\">What's going on</dcst:Text>"
486 "</dcst:SubtitleList>"
487 "</dcst:SubtitleReel>",
493 /* Write some subtitle content as SMPTE XML and check that it is right.
494 This includes in-line font changes.
496 BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test2)
498 dcp::SMPTESubtitleAsset c;
499 c.set_reel_number (1);
500 c.set_language (dcp::LanguageTag("en"));
501 c.set_content_title_text ("Test");
502 c.set_issue_date (dcp::LocalTime ("2016-04-01T03:52:00+00:00"));
505 make_shared<dcp::SubtitleString>(
510 dcp::Colour (255, 255, 255),
513 dcp::Time (0, 0, 1, 0, 24),
514 dcp::Time (0, 0, 9, 0, 24),
522 dcp::Colour (0, 0, 0),
523 dcp::Time (0, 0, 0, 0, 24),
524 dcp::Time (0, 0, 0, 0, 24)
529 make_shared<dcp::SubtitleString>(
534 dcp::Colour (255, 255, 255),
537 dcp::Time (0, 0, 1, 0, 24),
538 dcp::Time (0, 0, 9, 0, 24),
546 dcp::Colour (0, 0, 0),
547 dcp::Time (0, 0, 0, 0, 24),
548 dcp::Time (0, 0, 0, 0, 24)
553 make_shared<dcp::SubtitleString>(
558 dcp::Colour (255, 255, 255),
561 dcp::Time (0, 0, 1, 0, 24),
562 dcp::Time (0, 0, 9, 0, 24),
570 dcp::Colour (0, 0, 0),
571 dcp::Time (0, 0, 0, 0, 24),
572 dcp::Time (0, 0, 0, 0, 24)
577 make_shared<dcp::SubtitleString>(
582 dcp::Colour (255, 255, 255),
585 dcp::Time (0, 0, 1, 0, 24),
586 dcp::Time (0, 0, 9, 0, 24),
594 dcp::Colour (0, 0, 0),
595 dcp::Time (0, 0, 0, 0, 24),
596 dcp::Time (0, 0, 0, 0, 24)
601 make_shared<dcp::SubtitleString>(
606 dcp::Colour (255, 255, 255),
609 dcp::Time (0, 0, 1, 0, 24),
610 dcp::Time (0, 0, 9, 0, 24),
618 dcp::Colour (0, 0, 0),
619 dcp::Time (0, 0, 0, 0, 24),
620 dcp::Time (0, 0, 0, 0, 24)
625 make_shared<dcp::SubtitleString>(
630 dcp::Colour (255, 255, 255),
633 dcp::Time (0, 0, 1, 0, 24),
634 dcp::Time (0, 0, 9, 0, 24),
642 dcp::Colour (0, 0, 0),
643 dcp::Time (0, 0, 0, 0, 24),
644 dcp::Time (0, 0, 0, 0, 24)
648 c._xml_id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
652 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
653 "<dcst:SubtitleReel xmlns:dcst=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">"
654 "<dcst:Id>urn:uuid:a6c58cff-3e1e-4b38-acec-a42224475ef6</dcst:Id>"
655 "<dcst:ContentTitleText>Test</dcst:ContentTitleText>"
656 "<dcst:IssueDate>2016-04-01T03:52:00.000+00:00</dcst:IssueDate>"
657 "<dcst:ReelNumber>1</dcst:ReelNumber>"
658 "<dcst:Language>en</dcst:Language>"
659 "<dcst:EditRate>24 1</dcst:EditRate>"
660 "<dcst:TimeCodeRate>24</dcst:TimeCodeRate>"
661 "<dcst:SubtitleList>"
662 "<dcst:Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"Arial\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">"
663 "<dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:00:01:00\" TimeOut=\"00:00:09:00\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">"
664 "<dcst:Text Valign=\"top\" Vposition=\"80\">"
665 "<dcst:Font Italic=\"no\">Testing is </dcst:Font>"
666 "<dcst:Font Italic=\"yes\">really</dcst:Font>"
667 "<dcst:Font Italic=\"no\"> fun</dcst:Font>"
669 "<dcst:Text Valign=\"top\" Vposition=\"90\">"
670 "<dcst:Font Italic=\"no\">This is the </dcst:Font>"
671 "<dcst:Font Italic=\"yes\">second</dcst:Font>"
672 "<dcst:Font Italic=\"no\"> line</dcst:Font>"
676 "</dcst:SubtitleList>"
677 "</dcst:SubtitleReel>",
682 /* Write some subtitle content as SMPTE using bitmaps and check that it is right */
683 BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test3)
685 dcp::SMPTESubtitleAsset c;
686 c.set_reel_number (1);
687 c.set_language (dcp::LanguageTag("en"));
688 c.set_content_title_text ("Test");
691 make_shared<dcp::SubtitleImage>(
692 dcp::ArrayData ("test/data/sub.png"),
693 dcp::Time (0, 4, 9, 22, 24),
694 dcp::Time (0, 4, 11, 22, 24),
699 dcp::Time (0, 0, 0, 0, 24),
700 dcp::Time (0, 0, 0, 0, 24)
704 c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
706 boost::filesystem::create_directories ("build/test/write_smpte_subtitle_test3");
707 c.write ("build/test/write_smpte_subtitle_test3/subs.mxf");
709 /* XXX: check this result when we can read them back in again */