src/lib/caption_content.cc

   1 /*
   2     Copyright (C) 2013-2018 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 #include "caption_content.h"
  22 #include "util.h"
  23 #include "exceptions.h"
  24 #include "font.h"
  25 #include "content.h"
  26 #include <dcp/raw_convert.h>
  27 #include <libcxml/cxml.h>
  28 #include <libxml++/libxml++.h>
  29 #include <boost/foreach.hpp>
  30 #include <iostream>
  31
  32 #include "i18n.h"
  33
  34 using std::string;
  35 using std::vector;
  36 using std::cout;
  37 using std::list;
  38 using boost::shared_ptr;
  39 using boost::dynamic_pointer_cast;
  40 using boost::optional;
  41 using dcp::raw_convert;
  42
  43 int const CaptionContentProperty::X_OFFSET = 500;
  44 int const CaptionContentProperty::Y_OFFSET = 501;
  45 int const CaptionContentProperty::X_SCALE = 502;
  46 int const CaptionContentProperty::Y_SCALE = 503;
  47 int const CaptionContentProperty::USE = 504;
  48 int const CaptionContentProperty::BURN = 505;
  49 int const CaptionContentProperty::LANGUAGE = 506;
  50 int const CaptionContentProperty::FONTS = 507;
  51 int const CaptionContentProperty::COLOUR = 508;
  52 int const CaptionContentProperty::EFFECT = 509;
  53 int const CaptionContentProperty::EFFECT_COLOUR = 510;
  54 int const CaptionContentProperty::LINE_SPACING = 511;
  55 int const CaptionContentProperty::FADE_IN = 512;
  56 int const CaptionContentProperty::FADE_OUT = 513;
  57 int const CaptionContentProperty::OUTLINE_WIDTH = 514;
  58 int const CaptionContentProperty::TYPE = 515;
  59
  60 CaptionContent::CaptionContent (Content* parent)
  61         : ContentPart (parent)
  62         , _use (false)
  63         , _burn (false)
  64         , _x_offset (0)
  65         , _y_offset (0)
  66         , _x_scale (1)
  67         , _y_scale (1)
  68         , _line_spacing (1)
  69         , _outline_width (2)
  70         , _type (CAPTION_OPEN)
  71         , _original_type (CAPTION_OPEN)
  72 {
  73
  74 }
  75
  76 /** @return CaptionContents from node or <Caption> nodes under node (according to version).
  77  *  The list could be empty if no CaptionContents are found.
  78  */
  79 list<shared_ptr<CaptionContent> >
  80 CaptionContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
  81 {
  82         if (version < 34) {
  83                 /* With old metadata FFmpeg content has the subtitle-related tags even with no
  84                    subtitle streams, so check for that.
  85                 */
  86                 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
  87                         return list<shared_ptr<CaptionContent> >();
  88                 }
  89
  90                 /* Otherwise we can drop through to the newer logic */
  91         }
  92
  93         if (version < 37) {
  94                 if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
  95                         return list<shared_ptr<CaptionContent> >();
  96                 }
  97                 list<shared_ptr<CaptionContent> > c;
  98                 c.push_back (shared_ptr<CaptionContent> (new CaptionContent (parent, node, version)));
  99                 return c;
 100         }
 101
 102         if (!node->node_child("Caption")) {
 103                 return list<shared_ptr<CaptionContent> >();
 104         }
 105
 106         list<shared_ptr<CaptionContent> > c;
 107         BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Caption")) {
 108                 c.push_back (shared_ptr<CaptionContent> (new CaptionContent (parent, i, version)));
 109         }
 110         return c;
 111 }
 112
 113 CaptionContent::CaptionContent (Content* parent, cxml::ConstNodePtr node, int version)
 114         : ContentPart (parent)
 115         , _use (false)
 116         , _burn (false)
 117         , _x_offset (0)
 118         , _y_offset (0)
 119         , _x_scale (1)
 120         , _y_scale (1)
 121         , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
 122         , _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (2))
 123         , _type (CAPTION_OPEN)
 124 {
 125         if (version >= 37) {
 126                 _use = node->bool_child ("Use");
 127                 _burn = node->bool_child ("Burn");
 128         } else if (version >= 32) {
 129                 _use = node->bool_child ("UseSubtitles");
 130                 _burn = node->bool_child ("BurnSubtitles");
 131         }
 132
 133         if (version >= 37) {
 134                 _x_offset = node->number_child<double> ("XOffset");
 135                 _y_offset = node->number_child<double> ("YOffset");
 136         } else if (version >= 7) {
 137                 _x_offset = node->number_child<double> ("SubtitleXOffset");
 138                 _y_offset = node->number_child<double> ("SubtitleYOffset");
 139         } else {
 140                 _y_offset = node->number_child<double> ("SubtitleOffset");
 141         }
 142
 143         if (node->optional_bool_child("Outline").get_value_or(false)) {
 144                 _effect = dcp::BORDER;
 145         } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
 146                 _effect = dcp::SHADOW;
 147         } else {
 148                 _effect = dcp::NONE;
 149         }
 150
 151         optional<string> effect = node->optional_string_child("Effect");
 152         if (effect) {
 153                 if (*effect == "none") {
 154                         _effect = dcp::NONE;
 155                 } else if (*effect == "outline") {
 156                         _effect = dcp::BORDER;
 157                 } else if (*effect == "shadow") {
 158                         _effect = dcp::SHADOW;
 159                 }
 160         }
 161
 162         if (version >= 37) {
 163                 _x_scale = node->number_child<double> ("XScale");
 164                 _y_scale = node->number_child<double> ("YScale");
 165         } else if (version >= 10) {
 166                 _x_scale = node->number_child<double> ("SubtitleXScale");
 167                 _y_scale = node->number_child<double> ("SubtitleYScale");
 168         } else {
 169                 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
 170         }
 171
 172         optional<int> r = node->optional_number_child<int>("Red");
 173         optional<int> g = node->optional_number_child<int>("Green");
 174         optional<int> b = node->optional_number_child<int>("Blue");
 175         if (r && g && b) {
 176                 _colour = dcp::Colour (*r, *g, *b);
 177         }
 178
 179         if (version >= 36) {
 180                 optional<int> er = node->optional_number_child<int>("EffectRed");
 181                 optional<int> eg = node->optional_number_child<int>("EffectGreen");
 182                 optional<int> eb = node->optional_number_child<int>("EffectBlue");
 183                 if (er && eg && eb) {
 184                         _effect_colour = dcp::Colour (*er, *eg, *eb);
 185                 }
 186         } else {
 187                 _effect_colour = dcp::Colour (
 188                         node->optional_number_child<int>("OutlineRed").get_value_or(255),
 189                         node->optional_number_child<int>("OutlineGreen").get_value_or(255),
 190                         node->optional_number_child<int>("OutlineBlue").get_value_or(255)
 191                         );
 192         }
 193
 194         optional<Frame> fi;
 195         if (version >= 37) {
 196                 fi = node->optional_number_child<Frame>("FadeIn");
 197         } else {
 198                 fi = node->optional_number_child<Frame>("SubtitleFadeIn");
 199         }
 200         if (fi) {
 201                 _fade_in = ContentTime (*fi);
 202         }
 203
 204         optional<Frame> fo;
 205         if (version >= 37) {
 206                 fo = node->optional_number_child<Frame>("FadeOut");
 207         } else {
 208                 fo = node->optional_number_child<Frame>("SubtitleFadeOut");
 209         }
 210         if (fo) {
 211                 _fade_out = ContentTime (*fo);
 212         }
 213
 214         if (version >= 37) {
 215                 _language = node->optional_string_child ("Language").get_value_or ("");
 216         } else {
 217                 _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
 218         }
 219
 220         list<cxml::NodePtr> fonts = node->node_children ("Font");
 221         for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
 222                 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
 223         }
 224
 225         connect_to_fonts ();
 226
 227         _type = string_to_caption_type (node->optional_string_child("Type").get_value_or("open"));
 228         _original_type = string_to_caption_type (node->optional_string_child("Type").get_value_or("open"));
 229 }
 230
 231
 232 /** _mutex must not be held on entry */
 233 void
 234 CaptionContent::as_xml (xmlpp::Node* root) const
 235 {
 236         boost::mutex::scoped_lock lm (_mutex);
 237
 238         xmlpp::Element* caption = root->add_child ("Caption");
 239
 240         caption->add_child("Use")->add_child_text (_use ? "1" : "0");
 241         caption->add_child("Burn")->add_child_text (_burn ? "1" : "0");
 242         caption->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
 243         caption->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
 244         caption->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
 245         caption->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
 246         caption->add_child("Language")->add_child_text (_language);
 247         if (_colour) {
 248                 caption->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
 249                 caption->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
 250                 caption->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
 251         }
 252         if (_effect) {
 253                 switch (*_effect) {
 254                 case dcp::NONE:
 255                         caption->add_child("Effect")->add_child_text("none");
 256                         break;
 257                 case dcp::BORDER:
 258                         caption->add_child("Effect")->add_child_text("outline");
 259                         break;
 260                 case dcp::SHADOW:
 261                         caption->add_child("Effect")->add_child_text("shadow");
 262                         break;
 263                 }
 264         }
 265         if (_effect_colour) {
 266                 caption->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
 267                 caption->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
 268                 caption->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
 269         }
 270         caption->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
 271         if (_fade_in) {
 272                 caption->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
 273         }
 274         if (_fade_out) {
 275                 caption->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
 276         }
 277         caption->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
 278
 279         for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
 280                 (*i)->as_xml (caption->add_child("Font"));
 281         }
 282
 283         caption->add_child("Type")->add_child_text (caption_type_to_string(_type));
 284         caption->add_child("OriginalType")->add_child_text (caption_type_to_string(_original_type));
 285 }
 286
 287 string
 288 CaptionContent::identifier () const
 289 {
 290         string s = raw_convert<string> (x_scale())
 291                 + "_" + raw_convert<string> (y_scale())
 292                 + "_" + raw_convert<string> (x_offset())
 293                 + "_" + raw_convert<string> (y_offset())
 294                 + "_" + raw_convert<string> (line_spacing())
 295                 + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
 296                 + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
 297                 + "_" + raw_convert<string> (outline_width())
 298                 + "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
 299                 + "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
 300                 + "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string());
 301
 302         /* XXX: I suppose really _fonts shouldn't be in here, since not all
 303            types of subtitle content involve fonts.
 304         */
 305         BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
 306                 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
 307                         s += "_" + f->file(static_cast<FontFiles::Variant>(i)).get_value_or("Default").string();
 308                 }
 309         }
 310
 311         /* The language is for metadata only, and doesn't affect
 312            how this content looks.
 313         */
 314
 315         return s;
 316 }
 317
 318 void
 319 CaptionContent::add_font (shared_ptr<Font> font)
 320 {
 321         _fonts.push_back (font);
 322         connect_to_fonts ();
 323 }
 324
 325 void
 326 CaptionContent::connect_to_fonts ()
 327 {
 328         BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
 329                 i.disconnect ();
 330         }
 331
 332         _font_connections.clear ();
 333
 334         BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
 335                 _font_connections.push_back (i->Changed.connect (boost::bind (&CaptionContent::font_changed, this)));
 336         }
 337 }
 338
 339 void
 340 CaptionContent::font_changed ()
 341 {
 342         _parent->signal_changed (CaptionContentProperty::FONTS);
 343 }
 344
 345 void
 346 CaptionContent::set_colour (dcp::Colour colour)
 347 {
 348         maybe_set (_colour, colour, CaptionContentProperty::COLOUR);
 349 }
 350
 351 void
 352 CaptionContent::unset_colour ()
 353 {
 354         maybe_set (_colour, optional<dcp::Colour>(), CaptionContentProperty::COLOUR);
 355 }
 356
 357 void
 358 CaptionContent::set_effect (dcp::Effect e)
 359 {
 360         maybe_set (_effect, e, CaptionContentProperty::EFFECT);
 361 }
 362
 363 void
 364 CaptionContent::unset_effect ()
 365 {
 366         maybe_set (_effect, optional<dcp::Effect>(), CaptionContentProperty::EFFECT);
 367 }
 368
 369 void
 370 CaptionContent::set_effect_colour (dcp::Colour colour)
 371 {
 372         maybe_set (_effect_colour, colour, CaptionContentProperty::EFFECT_COLOUR);
 373 }
 374
 375 void
 376 CaptionContent::unset_effect_colour ()
 377 {
 378         maybe_set (_effect_colour, optional<dcp::Colour>(), CaptionContentProperty::EFFECT_COLOUR);
 379 }
 380
 381 void
 382 CaptionContent::set_use (bool u)
 383 {
 384         maybe_set (_use, u, CaptionContentProperty::USE);
 385 }
 386
 387 void
 388 CaptionContent::set_burn (bool b)
 389 {
 390         maybe_set (_burn, b, CaptionContentProperty::BURN);
 391 }
 392
 393 void
 394 CaptionContent::set_x_offset (double o)
 395 {
 396         maybe_set (_x_offset, o, CaptionContentProperty::X_OFFSET);
 397 }
 398
 399 void
 400 CaptionContent::set_y_offset (double o)
 401 {
 402         maybe_set (_y_offset, o, CaptionContentProperty::Y_OFFSET);
 403 }
 404
 405 void
 406 CaptionContent::set_x_scale (double s)
 407 {
 408         maybe_set (_x_scale, s, CaptionContentProperty::X_SCALE);
 409 }
 410
 411 void
 412 CaptionContent::set_y_scale (double s)
 413 {
 414         maybe_set (_y_scale, s, CaptionContentProperty::Y_SCALE);
 415 }
 416
 417 void
 418 CaptionContent::set_language (string language)
 419 {
 420         maybe_set (_language, language, CaptionContentProperty::LANGUAGE);
 421 }
 422
 423 void
 424 CaptionContent::set_line_spacing (double s)
 425 {
 426         maybe_set (_line_spacing, s, CaptionContentProperty::LINE_SPACING);
 427 }
 428
 429 void
 430 CaptionContent::set_fade_in (ContentTime t)
 431 {
 432         maybe_set (_fade_in, t, CaptionContentProperty::FADE_IN);
 433 }
 434
 435 void
 436 CaptionContent::unset_fade_in ()
 437 {
 438         maybe_set (_fade_in, optional<ContentTime>(), CaptionContentProperty::FADE_IN);
 439 }
 440
 441 void
 442 CaptionContent::set_fade_out (ContentTime t)
 443 {
 444         maybe_set (_fade_out, t, CaptionContentProperty::FADE_OUT);
 445 }
 446
 447 void
 448 CaptionContent::unset_fade_out ()
 449 {
 450         maybe_set (_fade_out, optional<ContentTime>(), CaptionContentProperty::FADE_OUT);
 451 }
 452
 453 void
 454 CaptionContent::set_type (CaptionType type)
 455 {
 456         maybe_set (_type, type, CaptionContentProperty::TYPE);
 457 }
 458
 459 void
 460 CaptionContent::set_outline_width (int w)
 461 {
 462         maybe_set (_outline_width, w, CaptionContentProperty::OUTLINE_WIDTH);
 463 }
 464
 465 void
 466 CaptionContent::take_settings_from (shared_ptr<const CaptionContent> c)
 467 {
 468         set_use (c->_use);
 469         set_burn (c->_burn);
 470         set_x_offset (c->_x_offset);
 471         set_y_offset (c->_y_offset);
 472         set_x_scale (c->_x_scale);
 473         set_y_scale (c->_y_scale);
 474         maybe_set (_fonts, c->_fonts, CaptionContentProperty::FONTS);
 475         if (c->_colour) {
 476                 set_colour (*c->_colour);
 477         } else {
 478                 unset_colour ();
 479         }
 480         if (c->_effect) {
 481                 set_effect (*c->_effect);
 482         }
 483         if (c->_effect_colour) {
 484                 set_effect_colour (*c->_effect_colour);
 485         } else {
 486                 unset_effect_colour ();
 487         }
 488         set_line_spacing (c->_line_spacing);
 489         if (c->_fade_in) {
 490                 set_fade_in (*c->_fade_in);
 491         }
 492         if (c->_fade_out) {
 493                 set_fade_out (*c->_fade_out);
 494         }
 495         set_outline_width (c->_outline_width);
 496 }