src/lib/subtitle_content.cc

   1 /*
   2     Copyright (C) 2013-2016 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 "subtitle_content.h"
  22 #include "util.h"
  23 #include "exceptions.h"
  24 #include "safe_stringstream.h"
  25 #include "font.h"
  26 #include "raw_convert.h"
  27 #include "content.h"
  28 #include <libcxml/cxml.h>
  29 #include <libxml++/libxml++.h>
  30 #include <boost/foreach.hpp>
  31 #include <iostream>
  32
  33 #include "i18n.h"
  34
  35 using std::string;
  36 using std::vector;
  37 using std::cout;
  38 using std::list;
  39 using boost::shared_ptr;
  40 using boost::dynamic_pointer_cast;
  41
  42 int const SubtitleContentProperty::X_OFFSET = 500;
  43 int const SubtitleContentProperty::Y_OFFSET = 501;
  44 int const SubtitleContentProperty::X_SCALE = 502;
  45 int const SubtitleContentProperty::Y_SCALE = 503;
  46 int const SubtitleContentProperty::USE = 504;
  47 int const SubtitleContentProperty::BURN = 505;
  48 int const SubtitleContentProperty::LANGUAGE = 506;
  49 int const SubtitleContentProperty::FONTS = 507;
  50 int const SubtitleContentProperty::COLOUR = 508;
  51 int const SubtitleContentProperty::OUTLINE = 509;
  52 int const SubtitleContentProperty::OUTLINE_COLOUR = 510;
  53
  54 SubtitleContent::SubtitleContent (Content* parent)
  55         : ContentPart (parent)
  56         , _use (false)
  57         , _burn (false)
  58         , _x_offset (0)
  59         , _y_offset (0)
  60         , _x_scale (1)
  61         , _y_scale (1)
  62         , _colour (255, 255, 255)
  63         , _outline (false)
  64         , _outline_colour (0, 0, 0)
  65 {
  66
  67 }
  68
  69 shared_ptr<SubtitleContent>
  70 SubtitleContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
  71 {
  72         if (version < 34) {
  73                 /* With old metadata FFmpeg content has the subtitle-related tags even with no
  74                    subtitle streams, so check for that.
  75                 */
  76                 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
  77                         return shared_ptr<SubtitleContent> ();
  78                 }
  79
  80                 /* Otherwise we can drop through to the newer logic */
  81         }
  82
  83         if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
  84                 return shared_ptr<SubtitleContent> ();
  85         }
  86
  87         return shared_ptr<SubtitleContent> (new SubtitleContent (parent, node, version));
  88 }
  89
  90 SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int version)
  91         : ContentPart (parent)
  92         , _use (false)
  93         , _burn (false)
  94         , _x_offset (0)
  95         , _y_offset (0)
  96         , _x_scale (1)
  97         , _y_scale (1)
  98         , _colour (
  99                 node->optional_number_child<int>("Red").get_value_or(255),
 100                 node->optional_number_child<int>("Green").get_value_or(255),
 101                 node->optional_number_child<int>("Blue").get_value_or(255)
 102                 )
 103         , _outline (node->optional_bool_child("Outline").get_value_or(false))
 104         , _outline_colour (
 105                 node->optional_number_child<int>("OutlineRed").get_value_or(255),
 106                 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
 107                 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
 108                 )
 109 {
 110         if (version >= 32) {
 111                 _use = node->bool_child ("UseSubtitles");
 112                 _burn = node->bool_child ("BurnSubtitles");
 113         }
 114
 115         if (version >= 7) {
 116                 _x_offset = node->number_child<double> ("SubtitleXOffset");
 117                 _y_offset = node->number_child<double> ("SubtitleYOffset");
 118         } else {
 119                 _y_offset = node->number_child<double> ("SubtitleOffset");
 120         }
 121
 122         if (version >= 10) {
 123                 _x_scale = node->number_child<double> ("SubtitleXScale");
 124                 _y_scale = node->number_child<double> ("SubtitleYScale");
 125         } else {
 126                 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
 127         }
 128
 129         _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
 130
 131         list<cxml::NodePtr> fonts = node->node_children ("Font");
 132         for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
 133                 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
 134         }
 135
 136         connect_to_fonts ();
 137 }
 138
 139 SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> > c)
 140         : ContentPart (parent)
 141 {
 142         shared_ptr<SubtitleContent> ref = c[0]->subtitle;
 143         DCPOMATIC_ASSERT (ref);
 144         list<shared_ptr<Font> > ref_fonts = ref->fonts ();
 145
 146         for (size_t i = 1; i < c.size(); ++i) {
 147
 148                 if (c[i]->subtitle->use() != ref->use()) {
 149                         throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
 150                 }
 151
 152                 if (c[i]->subtitle->burn() != ref->burn()) {
 153                         throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
 154                 }
 155
 156                 if (c[i]->subtitle->x_offset() != ref->x_offset()) {
 157                         throw JoinError (_("Content to be joined must have the same subtitle X offset."));
 158                 }
 159
 160                 if (c[i]->subtitle->y_offset() != ref->y_offset()) {
 161                         throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
 162                 }
 163
 164                 if (c[i]->subtitle->x_scale() != ref->x_scale()) {
 165                         throw JoinError (_("Content to be joined must have the same subtitle X scale."));
 166                 }
 167
 168                 if (c[i]->subtitle->y_scale() != ref->y_scale()) {
 169                         throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
 170                 }
 171
 172                 list<shared_ptr<Font> > fonts = c[i]->subtitle->fonts ();
 173                 if (fonts.size() != ref_fonts.size()) {
 174                         throw JoinError (_("Content to be joined must use the same fonts."));
 175                 }
 176
 177                 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
 178                 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
 179
 180                 while (j != ref_fonts.end ()) {
 181                         if (**j != **k) {
 182                                 throw JoinError (_("Content to be joined must use the same fonts."));
 183                         }
 184                         ++j;
 185                         ++k;
 186                 }
 187         }
 188
 189         _use = ref->use ();
 190         _burn = ref->burn ();
 191         _x_offset = ref->x_offset ();
 192         _y_offset = ref->y_offset ();
 193         _x_scale = ref->x_scale ();
 194         _y_scale = ref->y_scale ();
 195         _language = ref->language ();
 196         _fonts = ref_fonts;
 197
 198         connect_to_fonts ();
 199 }
 200
 201 /** _mutex must not be held on entry */
 202 void
 203 SubtitleContent::as_xml (xmlpp::Node* root) const
 204 {
 205         boost::mutex::scoped_lock lm (_mutex);
 206
 207         root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use));
 208         root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn));
 209         root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_x_offset));
 210         root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_y_offset));
 211         root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_x_scale));
 212         root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_y_scale));
 213         root->add_child("SubtitleLanguage")->add_child_text (_language);
 214         root->add_child("Red")->add_child_text (raw_convert<string> (_colour.r));
 215         root->add_child("Green")->add_child_text (raw_convert<string> (_colour.g));
 216         root->add_child("Blue")->add_child_text (raw_convert<string> (_colour.b));
 217         root->add_child("Outline")->add_child_text (raw_convert<string> (_outline));
 218         root->add_child("OutlineRed")->add_child_text (raw_convert<string> (_outline_colour.r));
 219         root->add_child("OutlineGreen")->add_child_text (raw_convert<string> (_outline_colour.g));
 220         root->add_child("OutlineBlue")->add_child_text (raw_convert<string> (_outline_colour.b));
 221
 222         for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
 223                 (*i)->as_xml (root->add_child("Font"));
 224         }
 225 }
 226
 227 string
 228 SubtitleContent::identifier () const
 229 {
 230         SafeStringStream s;
 231         s << raw_convert<string> (x_scale())
 232           << "_" << raw_convert<string> (y_scale())
 233           << "_" << raw_convert<string> (x_offset())
 234           << "_" << raw_convert<string> (y_offset());
 235
 236         /* XXX: I suppose really _fonts shouldn't be in here, since not all
 237            types of subtitle content involve fonts.
 238         */
 239         BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
 240                 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
 241                         s << "_" << f->file(static_cast<FontFiles::Variant>(i)).get_value_or ("Default");
 242                 }
 243         }
 244
 245         /* The language is for metadata only, and doesn't affect
 246            how this content looks.
 247         */
 248
 249         return s.str ();
 250 }
 251
 252 void
 253 SubtitleContent::add_font (shared_ptr<Font> font)
 254 {
 255         _fonts.push_back (font);
 256         connect_to_fonts ();
 257 }
 258
 259 void
 260 SubtitleContent::connect_to_fonts ()
 261 {
 262         BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
 263                 i.disconnect ();
 264         }
 265
 266         _font_connections.clear ();
 267
 268         BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
 269                 _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this)));
 270         }
 271 }
 272
 273 void
 274 SubtitleContent::font_changed ()
 275 {
 276         _parent->signal_changed (SubtitleContentProperty::FONTS);
 277 }
 278
 279 void
 280 SubtitleContent::set_colour (dcp::Colour colour)
 281 {
 282         maybe_set (_colour, colour, SubtitleContentProperty::COLOUR);
 283 }
 284
 285 void
 286 SubtitleContent::set_outline (bool o)
 287 {
 288         maybe_set (_outline, o, SubtitleContentProperty::OUTLINE);
 289 }
 290
 291 void
 292 SubtitleContent::set_outline_colour (dcp::Colour colour)
 293 {
 294         maybe_set (_outline_colour, colour, SubtitleContentProperty::OUTLINE_COLOUR);
 295 }
 296
 297 void
 298 SubtitleContent::set_use (bool u)
 299 {
 300         maybe_set (_use, u, SubtitleContentProperty::USE);
 301 }
 302
 303 void
 304 SubtitleContent::set_burn (bool b)
 305 {
 306         maybe_set (_burn, b, SubtitleContentProperty::BURN);
 307 }
 308
 309 void
 310 SubtitleContent::set_x_offset (double o)
 311 {
 312         maybe_set (_x_offset, o, SubtitleContentProperty::X_OFFSET);
 313 }
 314
 315 void
 316 SubtitleContent::set_y_offset (double o)
 317 {
 318         maybe_set (_y_offset, o, SubtitleContentProperty::Y_OFFSET);
 319 }
 320
 321 void
 322 SubtitleContent::set_x_scale (double s)
 323 {
 324         maybe_set (_x_scale, s, SubtitleContentProperty::X_SCALE);
 325 }
 326
 327 void
 328 SubtitleContent::set_y_scale (double s)
 329 {
 330         maybe_set (_y_scale, s, SubtitleContentProperty::Y_SCALE);
 331 }
 332
 333 void
 334 SubtitleContent::set_language (string language)
 335 {
 336         maybe_set (_language, language, SubtitleContentProperty::LANGUAGE);
 337 }