test/write_subtitle_test.cc

   1 /*
   2     Copyright (C) 2015-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "interop_subtitle_asset.h"
  21 #include "smpte_subtitle_asset.h"
  22 #include "subtitle_string.h"
  23 #include "subtitle_asset_internal.h"
  24 #include "test.h"
  25 #include <boost/test/unit_test.hpp>
  26
  27 using std::list;
  28 using std::string;
  29 using boost::shared_ptr;
  30
  31 /** Test dcp::order::Font::take_intersection */
  32 BOOST_AUTO_TEST_CASE (take_intersection_test)
  33 {
  34         dcp::order::Font A;
  35         A._values["foo"] = "bar";
  36         A._values["fred"] = "jim";
  37
  38         dcp::order::Font B;
  39         B._values["foo"] = "bar";
  40         B._values["sheila"] = "baz";
  41
  42         A.take_intersection (B);
  43         BOOST_REQUIRE_EQUAL (A._values.size(), 1);
  44         BOOST_CHECK_EQUAL (A._values["foo"], "bar");
  45
  46         A._values.clear ();
  47         B._values.clear ();
  48
  49         A._values["foo"] = "bar";
  50         A._values["fred"] = "jim";
  51
  52         B._values["foo"] = "hello";
  53         B._values["sheila"] = "baz";
  54
  55         A.take_intersection (B);
  56         BOOST_CHECK_EQUAL (A._values.size(), 0);
  57 }
  58
  59 /** Test dcp::order::Font::take_difference */
  60 BOOST_AUTO_TEST_CASE (take_difference_test)
  61 {
  62         dcp::order::Font A;
  63         A._values["foo"] = "bar";
  64         A._values["fred"] = "jim";
  65
  66         dcp::order::Font B;
  67         B._values["foo"] = "bar";
  68         B._values["sheila"] = "baz";
  69
  70         A.take_difference (B);
  71         BOOST_REQUIRE_EQUAL (A._values.size(), 1);
  72         BOOST_CHECK_EQUAL (A._values["fred"], "jim");
  73 }
  74
  75 /** Test dcp::order::Subtitle::pull_fonts */
  76 BOOST_AUTO_TEST_CASE (pull_fonts_test1)
  77 {
  78         shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
  79         shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
  80         root->children.push_back (sub1);
  81         shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
  82         sub1->children.push_back (text1);
  83         text1->font._values["font"] = "Inconsolata";
  84         text1->font._values["size"] = "42";
  85
  86         dcp::SubtitleAsset::pull_fonts (root);
  87
  88         BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
  89         BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
  90         BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
  91         BOOST_CHECK_EQUAL (text1->font._values.size(), 0);
  92 }
  93
  94 /** Test dcp::order::Subtitle::pull_fonts */
  95 BOOST_AUTO_TEST_CASE (pull_fonts_test2)
  96 {
  97         shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
  98         shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
  99         root->children.push_back (sub1);
 100         shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
 101         sub1->children.push_back (text1);
 102         text1->font._values["font"] = "Inconsolata";
 103         text1->font._values["size"] = "42";
 104         shared_ptr<dcp::order::Text> text2 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
 105         sub1->children.push_back (text2);
 106         text2->font._values["font"] = "Inconsolata";
 107         text2->font._values["size"] = "48";
 108
 109         dcp::SubtitleAsset::pull_fonts (root);
 110
 111         BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 1);
 112         BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
 113         BOOST_REQUIRE_EQUAL (text1->font._values.size(), 1);
 114         BOOST_CHECK_EQUAL (text1->font._values["size"], "42");
 115         BOOST_REQUIRE_EQUAL (text2->font._values.size(), 1);
 116         BOOST_CHECK_EQUAL (text2->font._values["size"], "48");
 117 }
 118
 119 /** Test dcp::order::Subtitle::pull_fonts */
 120 BOOST_AUTO_TEST_CASE (pull_fonts_test3)
 121 {
 122         shared_ptr<dcp::order::Part> root (new dcp::order::Part (shared_ptr<dcp::order::Part> ()));
 123         shared_ptr<dcp::order::Subtitle> sub1 (new dcp::order::Subtitle (root, dcp::Time(), dcp::Time(), dcp::Time(), dcp::Time()));
 124         root->children.push_back (sub1);
 125         shared_ptr<dcp::order::Text> text1 (new dcp::order::Text (sub1, dcp::HALIGN_CENTER, 0, dcp::VALIGN_TOP, 0, dcp::DIRECTION_LTR));
 126         sub1->children.push_back (text1);
 127         dcp::order::Font font;
 128         font._values["font"] = "Inconsolata";
 129         font._values["size"] = "42";
 130         shared_ptr<dcp::order::String> string1 (new dcp::order::String (text1, font, "Hello world"));
 131         text1->children.push_back (string1);
 132
 133         dcp::SubtitleAsset::pull_fonts (root);
 134
 135         BOOST_REQUIRE_EQUAL (sub1->font._values.size(), 2);
 136         BOOST_CHECK_EQUAL (sub1->font._values["font"], "Inconsolata");
 137         BOOST_CHECK_EQUAL (sub1->font._values["size"], "42");
 138 }
 139
 140 /** Write some subtitle content as Interop XML and check that it is right */
 141 BOOST_AUTO_TEST_CASE (write_interop_subtitle_test)
 142 {
 143         dcp::InteropSubtitleAsset c;
 144         c.set_reel_number ("1");
 145         c.set_language ("EN");
 146         c.set_movie_title ("Test");
 147
 148         c.add (
 149                 dcp::SubtitleString (
 150                         string ("Frutiger"),
 151                         false,
 152                         false,
 153                         false,
 154                         dcp::Colour (255, 255, 255),
 155                         48,
 156                         1.0,
 157                         dcp::Time (0, 4,  9, 22, 24),
 158                         dcp::Time (0, 4, 11, 22, 24),
 159                         0,
 160                         dcp::HALIGN_CENTER,
 161                         0.8,
 162                         dcp::VALIGN_TOP,
 163                         dcp::DIRECTION_LTR,
 164                         "Hello world",
 165                         dcp::NONE,
 166                         dcp::Colour (0, 0, 0),
 167                         dcp::Time (0, 0, 0, 0, 24),
 168                         dcp::Time (0, 0, 0, 0, 24)
 169                         )
 170                 );
 171
 172         c.add (
 173                 dcp::SubtitleString (
 174                         boost::optional<string> (),
 175                         true,
 176                         true,
 177                         true,
 178                         dcp::Colour (128, 0, 64),
 179                         91,
 180                         1.0,
 181                         dcp::Time (5, 41,  0, 21, 24),
 182                         dcp::Time (6, 12, 15, 21, 24),
 183                         0,
 184                         dcp::HALIGN_CENTER,
 185                         0.4,
 186                         dcp::VALIGN_BOTTOM,
 187                         dcp::DIRECTION_LTR,
 188                         "What's going on",
 189                         dcp::BORDER,
 190                         dcp::Colour (1, 2, 3),
 191                         dcp::Time (1, 2, 3, 4, 24),
 192                         dcp::Time (5, 6, 7, 8, 24)
 193                         )
 194                 );
 195
 196         c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
 197
 198         check_xml (
 199                 c.xml_as_string (),
 200                 "<DCSubtitle Version=\"1.0\">"
 201                   "<SubtitleID>a6c58cff-3e1e-4b38-acec-a42224475ef6</SubtitleID>"
 202                   "<MovieTitle>Test</MovieTitle>"
 203                   "<ReelNumber>1</ReelNumber>"
 204                   "<Language>EN</Language>"
 205                   "<Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" Id=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underlined=\"no\" Weight=\"normal\">"
 206                     "<Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:229\" TimeOut=\"00:04:11:229\" FadeUpTime=\"0\" FadeDownTime=\"0\">"
 207                       "<Text VAlign=\"top\" VPosition=\"80\">Hello world</Text>"
 208                     "</Subtitle>"
 209                   "</Font>"
 210                   "<Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underlined=\"yes\" Weight=\"bold\">"
 211                     "<Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:218\" TimeOut=\"06:12:15:218\" FadeUpTime=\"930792\" FadeDownTime=\"4591834\">"
 212                       "<Text VAlign=\"bottom\" VPosition=\"40\">What's going on</Text>"
 213                     "</Subtitle>"
 214                   "</Font>"
 215                 "</DCSubtitle>",
 216                 list<string> ()
 217                 );
 218 }
 219
 220 /* Write some subtitle content as SMPTE XML and check that it is right */
 221 BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test)
 222 {
 223         dcp::SMPTESubtitleAsset c;
 224         c.set_reel_number (1);
 225         c.set_language ("EN");
 226         c.set_content_title_text ("Test");
 227         c.set_issue_date (dcp::LocalTime ("2016-04-01T03:52:00+00:00"));
 228
 229         c.add (
 230                 dcp::SubtitleString (
 231                         string ("Frutiger"),
 232                         false,
 233                         false,
 234                         false,
 235                         dcp::Colour (255, 255, 255),
 236                         48,
 237                         1.0,
 238                         dcp::Time (0, 4,  9, 22, 24),
 239                         dcp::Time (0, 4, 11, 22, 24),
 240                         0,
 241                         dcp::HALIGN_CENTER,
 242                         0.8,
 243                         dcp::VALIGN_TOP,
 244                         dcp::DIRECTION_LTR,
 245                         "Hello world",
 246                         dcp::NONE,
 247                         dcp::Colour (0, 0, 0),
 248                         dcp::Time (0, 0, 0, 0, 24),
 249                         dcp::Time (0, 0, 0, 0, 24)
 250                         )
 251                 );
 252
 253         c.add (
 254                 dcp::SubtitleString (
 255                         boost::optional<string> (),
 256                         true,
 257                         true,
 258                         true,
 259                         dcp::Colour (128, 0, 64),
 260                         91,
 261                         1.0,
 262                         dcp::Time (5, 41,  0, 21, 24),
 263                         dcp::Time (6, 12, 15, 21, 24),
 264                         0,
 265                         dcp::HALIGN_CENTER,
 266                         0.4,
 267                         dcp::VALIGN_BOTTOM,
 268                         dcp::DIRECTION_RTL,
 269                         "What's going on",
 270                         dcp::BORDER,
 271                         dcp::Colour (1, 2, 3),
 272                         dcp::Time (1, 2, 3, 4, 24),
 273                         dcp::Time (5, 6, 7, 8, 24)
 274                         )
 275                 );
 276
 277         c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
 278
 279         check_xml (
 280                 c.xml_as_string (),
 281                 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
 282                 "<dcst:SubtitleReel xmlns:dcst=\"http://www.smpte-ra.org/schemas/428-7/2010/DCST\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">"
 283                   "<dcst:Id>urn:uuid:a6c58cff-3e1e-4b38-acec-a42224475ef6</dcst:Id>"
 284                   "<dcst:ContentTitleText>Test</dcst:ContentTitleText>"
 285                   "<dcst:IssueDate>2016-04-01T03:52:00.000+00:00</dcst:IssueDate>"
 286                   "<dcst:ReelNumber>1</dcst:ReelNumber>"
 287                   "<dcst:Language>EN</dcst:Language>"
 288                   "<dcst:EditRate>24 1</dcst:EditRate>"
 289                   "<dcst:TimeCodeRate>24</dcst:TimeCodeRate>"
 290                   "<dcst:SubtitleList>"
 291                     "<dcst:Font AspectAdjust=\"1.0\" Color=\"FFFFFFFF\" Effect=\"none\" EffectColor=\"FF000000\" ID=\"Frutiger\" Italic=\"no\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">"
 292                       "<dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:04:09:22\" TimeOut=\"00:04:11:22\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">"
 293                         "<dcst:Text Valign=\"top\" Vposition=\"80\">Hello world</dcst:Text>"
 294                       "</dcst:Subtitle>"
 295                     "</dcst:Font>"
 296                     "<dcst:Font AspectAdjust=\"1.0\" Color=\"FF800040\" Effect=\"border\" EffectColor=\"FF010203\" Italic=\"yes\" Script=\"normal\" Size=\"91\" Underline=\"yes\" Weight=\"bold\">"
 297                       "<dcst:Subtitle SpotNumber=\"2\" TimeIn=\"05:41:00:21\" TimeOut=\"06:12:15:21\" FadeUpTime=\"01:02:03:04\" FadeDownTime=\"05:06:07:08\">"
 298                         "<dcst:Text Valign=\"bottom\" Vposition=\"40\" Direction=\"rtl\">What's going on</dcst:Text>"
 299                       "</dcst:Subtitle>"
 300                     "</dcst:Font>"
 301                   "</dcst:SubtitleList>"
 302                 "</dcst:SubtitleReel>",
 303                 list<string> ()
 304                 );
 305 }
 306
 307 /* Write some subtitle content as SMPTE XML and check that it is right.
 308    This includes in-line font changes.
 309 */
 310 BOOST_AUTO_TEST_CASE (write_smpte_subtitle_test2)
 311 {
 312         dcp::SMPTESubtitleAsset c;
 313         c.set_reel_number (1);
 314         c.set_language ("EN");
 315         c.set_content_title_text ("Test");
 316         c.set_issue_date (dcp::LocalTime ("2016-04-01T03:52:00+00:00"));
 317
 318         c.add (
 319                 dcp::SubtitleString (
 320                         string ("Arial"),
 321                         false,
 322                         false,
 323                         false,
 324                         dcp::Colour (255, 255, 255),
 325                         48,
 326                         1.0,
 327                         dcp::Time (0, 0, 1, 0, 24),
 328                         dcp::Time (0, 0, 9, 0, 24),
 329                         0,
 330                         dcp::HALIGN_CENTER,
 331                         0.8,
 332                         dcp::VALIGN_TOP,
 333                         dcp::DIRECTION_LTR,
 334                         "Testing is ",
 335                         dcp::NONE,
 336                         dcp::Colour (0, 0, 0),
 337                         dcp::Time (0, 0, 0, 0, 24),
 338                         dcp::Time (0, 0, 0, 0, 24)
 339                         )
 340                 );
 341
 342         c.add (
 343                 dcp::SubtitleString (
 344                         string ("Arial"),
 345                         true,
 346                         false,
 347                         false,
 348                         dcp::Colour (255, 255, 255),
 349                         48,
 350                         1.0,
 351                         dcp::Time (0, 0, 1, 0, 24),
 352                         dcp::Time (0, 0, 9, 0, 24),
 353                         0,
 354                         dcp::HALIGN_CENTER,
 355                         0.8,
 356                         dcp::VALIGN_TOP,
 357                         dcp::DIRECTION_LTR,
 358                         "really",
 359                         dcp::NONE,
 360                         dcp::Colour (0, 0, 0),
 361                         dcp::Time (0, 0, 0, 0, 24),
 362                         dcp::Time (0, 0, 0, 0, 24)
 363                         )
 364                 );
 365
 366         c.add (
 367                 dcp::SubtitleString (
 368                         string ("Arial"),
 369                         false,
 370                         false,
 371                         false,
 372                         dcp::Colour (255, 255, 255),
 373                         48,
 374                         1.0,
 375                         dcp::Time (0, 0, 1, 0, 24),
 376                         dcp::Time (0, 0, 9, 0, 24),
 377                         0,
 378                         dcp::HALIGN_CENTER,
 379                         0.8,
 380                         dcp::VALIGN_TOP,
 381                         dcp::DIRECTION_LTR,
 382                         " fun",
 383                         dcp::NONE,
 384                         dcp::Colour (0, 0, 0),
 385                         dcp::Time (0, 0, 0, 0, 24),
 386                         dcp::Time (0, 0, 0, 0, 24)
 387                         )
 388                 );
 389
 390         c.add (
 391                 dcp::SubtitleString (
 392                         string ("Arial"),
 393                         false,
 394                         false,
 395                         false,
 396                         dcp::Colour (255, 255, 255),
 397                         48,
 398                         1.0,
 399                         dcp::Time (0, 0, 1, 0, 24),
 400                         dcp::Time (0, 0, 9, 0, 24),
 401                         0,
 402                         dcp::HALIGN_CENTER,
 403                         0.9,
 404                         dcp::VALIGN_TOP,
 405                         dcp::DIRECTION_LTR,
 406                         "This is the ",
 407                         dcp::NONE,
 408                         dcp::Colour (0, 0, 0),
 409                         dcp::Time (0, 0, 0, 0, 24),
 410                         dcp::Time (0, 0, 0, 0, 24)
 411                         )
 412                 );
 413
 414         c.add (
 415                 dcp::SubtitleString (
 416                         string ("Arial"),
 417                         true,
 418                         false,
 419                         false,
 420                         dcp::Colour (255, 255, 255),
 421                         48,
 422                         1.0,
 423                         dcp::Time (0, 0, 1, 0, 24),
 424                         dcp::Time (0, 0, 9, 0, 24),
 425                         0,
 426                         dcp::HALIGN_CENTER,
 427                         0.9,
 428                         dcp::VALIGN_TOP,
 429                         dcp::DIRECTION_LTR,
 430                         "second",
 431                         dcp::NONE,
 432                         dcp::Colour (0, 0, 0),
 433                         dcp::Time (0, 0, 0, 0, 24),
 434                         dcp::Time (0, 0, 0, 0, 24)
 435                         )
 436                 );
 437
 438         c.add (
 439                 dcp::SubtitleString (
 440                         string ("Arial"),
 441                         false,
 442                         false,
 443                         false,
 444                         dcp::Colour (255, 255, 255),
 445                         48,
 446                         1.0,
 447                         dcp::Time (0, 0, 1, 0, 24),
 448                         dcp::Time (0, 0, 9, 0, 24),
 449                         0,
 450                         dcp::HALIGN_CENTER,
 451                         0.9,
 452                         dcp::VALIGN_TOP,
 453                         dcp::DIRECTION_LTR,
 454                         " line",
 455                         dcp::NONE,
 456                         dcp::Colour (0, 0, 0),
 457                         dcp::Time (0, 0, 0, 0, 24),
 458                         dcp::Time (0, 0, 0, 0, 24)
 459                         )
 460                 );
 461
 462         c._id = "a6c58cff-3e1e-4b38-acec-a42224475ef6";
 463
 464         check_xml (
 465                 c.xml_as_string (),
 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=\"Arial\" Script=\"normal\" Size=\"48\" Underline=\"no\" Weight=\"normal\">"
 477                       "<dcst:Subtitle SpotNumber=\"1\" TimeIn=\"00:00:01:00\" TimeOut=\"00:00:09:00\" FadeUpTime=\"00:00:00:00\" FadeDownTime=\"00:00:00:00\">"
 478                         "<dcst:Text Valign=\"top\" Vposition=\"80\">"
 479                           "<dcst:Font Italic=\"no\">Testing is </dcst:Font>"
 480                           "<dcst:Font Italic=\"yes\">really</dcst:Font>"
 481                           "<dcst:Font Italic=\"no\"> fun</dcst:Font>"
 482                         "</dcst:Text>"
 483                         "<dcst:Text Valign=\"top\" Vposition=\"90\">"
 484                           "<dcst:Font Italic=\"no\">This is the </dcst:Font>"
 485                           "<dcst:Font Italic=\"yes\">second</dcst:Font>"
 486                           "<dcst:Font Italic=\"no\"> line</dcst:Font>"
 487                         "</dcst:Text>"
 488                       "</dcst:Subtitle>"
 489                     "</dcst:Font>"
 490                   "</dcst:SubtitleList>"
 491                 "</dcst:SubtitleReel>",
 492                 list<string> ()
 493                 );
 494 }