2 Copyright (C) 2013-2018 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/>.
21 #include "caption_content.h"
23 #include "exceptions.h"
26 #include <dcp/raw_convert.h>
27 #include <libcxml/cxml.h>
28 #include <libxml++/libxml++.h>
29 #include <boost/foreach.hpp>
38 using boost::shared_ptr;
39 using boost::dynamic_pointer_cast;
40 using boost::optional;
41 using dcp::raw_convert;
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;
60 CaptionContent::CaptionContent (Content* parent)
61 : ContentPart (parent)
70 , _type (CAPTION_OPEN)
71 , _original_type (CAPTION_OPEN)
76 /** @return CaptionContents from node or <Caption> nodes under node (according to version).
77 * The list could be empty if no CaptionContents are found.
79 list<shared_ptr<CaptionContent> >
80 CaptionContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
83 /* With old metadata FFmpeg content has the subtitle-related tags even with no
84 subtitle streams, so check for that.
86 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
87 return list<shared_ptr<CaptionContent> >();
90 /* Otherwise we can drop through to the newer logic */
94 if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
95 return list<shared_ptr<CaptionContent> >();
97 list<shared_ptr<CaptionContent> > c;
98 c.push_back (shared_ptr<CaptionContent> (new CaptionContent (parent, node, version)));
102 if (!node->optional_node_child("Caption")) {
103 return list<shared_ptr<CaptionContent> >();
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)));
113 CaptionContent::CaptionContent (Content* parent, cxml::ConstNodePtr node, int version)
114 : ContentPart (parent)
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)
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");
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");
140 _y_offset = node->number_child<double> ("SubtitleOffset");
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;
151 optional<string> effect = node->optional_string_child("Effect");
153 if (*effect == "none") {
155 } else if (*effect == "outline") {
156 _effect = dcp::BORDER;
157 } else if (*effect == "shadow") {
158 _effect = dcp::SHADOW;
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");
169 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
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");
176 _colour = dcp::Colour (*r, *g, *b);
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);
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)
196 fi = node->optional_number_child<Frame>("FadeIn");
198 fi = node->optional_number_child<Frame>("SubtitleFadeIn");
201 _fade_in = ContentTime (*fi);
206 fo = node->optional_number_child<Frame>("FadeOut");
208 fo = node->optional_number_child<Frame>("SubtitleFadeOut");
211 _fade_out = ContentTime (*fo);
215 _language = node->optional_string_child ("Language").get_value_or ("");
217 _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
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)));
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"));
231 CaptionContent::CaptionContent (Content* parent, vector<shared_ptr<Content> > c)
232 : ContentPart (parent)
234 /* This constructor is for join which is only supported for content types
235 that have a single caption, so we can use only_caption() here.
237 shared_ptr<CaptionContent> ref = c[0]->only_caption();
238 DCPOMATIC_ASSERT (ref);
239 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
241 for (size_t i = 1; i < c.size(); ++i) {
243 if (c[i]->only_caption()->use() != ref->use()) {
244 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
247 if (c[i]->only_caption()->burn() != ref->burn()) {
248 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
251 if (c[i]->only_caption()->x_offset() != ref->x_offset()) {
252 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
255 if (c[i]->only_caption()->y_offset() != ref->y_offset()) {
256 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
259 if (c[i]->only_caption()->x_scale() != ref->x_scale()) {
260 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
263 if (c[i]->only_caption()->y_scale() != ref->y_scale()) {
264 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
267 if (c[i]->only_caption()->line_spacing() != ref->line_spacing()) {
268 throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
271 if ((c[i]->only_caption()->fade_in() != ref->fade_in()) || (c[i]->only_caption()->fade_out() != ref->fade_out())) {
272 throw JoinError (_("Content to be joined must have the same subtitle fades."));
275 if ((c[i]->only_caption()->outline_width() != ref->outline_width())) {
276 throw JoinError (_("Content to be joined must have the same outline width."));
279 list<shared_ptr<Font> > fonts = c[i]->only_caption()->fonts ();
280 if (fonts.size() != ref_fonts.size()) {
281 throw JoinError (_("Content to be joined must use the same fonts."));
284 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
285 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
287 while (j != ref_fonts.end ()) {
289 throw JoinError (_("Content to be joined must use the same fonts."));
297 _burn = ref->burn ();
298 _x_offset = ref->x_offset ();
299 _y_offset = ref->y_offset ();
300 _x_scale = ref->x_scale ();
301 _y_scale = ref->y_scale ();
302 _language = ref->language ();
304 _line_spacing = ref->line_spacing ();
305 _fade_in = ref->fade_in ();
306 _fade_out = ref->fade_out ();
307 _outline_width = ref->outline_width ();
312 /** _mutex must not be held on entry */
314 CaptionContent::as_xml (xmlpp::Node* root) const
316 boost::mutex::scoped_lock lm (_mutex);
318 xmlpp::Element* caption = root->add_child ("Caption");
320 caption->add_child("Use")->add_child_text (_use ? "1" : "0");
321 caption->add_child("Burn")->add_child_text (_burn ? "1" : "0");
322 caption->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
323 caption->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
324 caption->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
325 caption->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
326 caption->add_child("Language")->add_child_text (_language);
328 caption->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
329 caption->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
330 caption->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
335 caption->add_child("Effect")->add_child_text("none");
338 caption->add_child("Effect")->add_child_text("outline");
341 caption->add_child("Effect")->add_child_text("shadow");
345 if (_effect_colour) {
346 caption->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
347 caption->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
348 caption->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
350 caption->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
352 caption->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
355 caption->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
357 caption->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
359 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
360 (*i)->as_xml (caption->add_child("Font"));
363 caption->add_child("Type")->add_child_text (caption_type_to_string(_type));
364 caption->add_child("OriginalType")->add_child_text (caption_type_to_string(_original_type));
368 CaptionContent::identifier () const
370 string s = raw_convert<string> (x_scale())
371 + "_" + raw_convert<string> (y_scale())
372 + "_" + raw_convert<string> (x_offset())
373 + "_" + raw_convert<string> (y_offset())
374 + "_" + raw_convert<string> (line_spacing())
375 + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
376 + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
377 + "_" + raw_convert<string> (outline_width())
378 + "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
379 + "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
380 + "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string());
382 /* XXX: I suppose really _fonts shouldn't be in here, since not all
383 types of subtitle content involve fonts.
385 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
386 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
387 s += "_" + f->file(static_cast<FontFiles::Variant>(i)).get_value_or("Default").string();
391 /* The language is for metadata only, and doesn't affect
392 how this content looks.
399 CaptionContent::add_font (shared_ptr<Font> font)
401 _fonts.push_back (font);
406 CaptionContent::connect_to_fonts ()
408 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
412 _font_connections.clear ();
414 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
415 _font_connections.push_back (i->Changed.connect (boost::bind (&CaptionContent::font_changed, this)));
420 CaptionContent::font_changed ()
422 _parent->signal_changed (CaptionContentProperty::FONTS);
426 CaptionContent::set_colour (dcp::Colour colour)
428 maybe_set (_colour, colour, CaptionContentProperty::COLOUR);
432 CaptionContent::unset_colour ()
434 maybe_set (_colour, optional<dcp::Colour>(), CaptionContentProperty::COLOUR);
438 CaptionContent::set_effect (dcp::Effect e)
440 maybe_set (_effect, e, CaptionContentProperty::EFFECT);
444 CaptionContent::unset_effect ()
446 maybe_set (_effect, optional<dcp::Effect>(), CaptionContentProperty::EFFECT);
450 CaptionContent::set_effect_colour (dcp::Colour colour)
452 maybe_set (_effect_colour, colour, CaptionContentProperty::EFFECT_COLOUR);
456 CaptionContent::unset_effect_colour ()
458 maybe_set (_effect_colour, optional<dcp::Colour>(), CaptionContentProperty::EFFECT_COLOUR);
462 CaptionContent::set_use (bool u)
464 maybe_set (_use, u, CaptionContentProperty::USE);
468 CaptionContent::set_burn (bool b)
470 maybe_set (_burn, b, CaptionContentProperty::BURN);
474 CaptionContent::set_x_offset (double o)
476 maybe_set (_x_offset, o, CaptionContentProperty::X_OFFSET);
480 CaptionContent::set_y_offset (double o)
482 maybe_set (_y_offset, o, CaptionContentProperty::Y_OFFSET);
486 CaptionContent::set_x_scale (double s)
488 maybe_set (_x_scale, s, CaptionContentProperty::X_SCALE);
492 CaptionContent::set_y_scale (double s)
494 maybe_set (_y_scale, s, CaptionContentProperty::Y_SCALE);
498 CaptionContent::set_language (string language)
500 maybe_set (_language, language, CaptionContentProperty::LANGUAGE);
504 CaptionContent::set_line_spacing (double s)
506 maybe_set (_line_spacing, s, CaptionContentProperty::LINE_SPACING);
510 CaptionContent::set_fade_in (ContentTime t)
512 maybe_set (_fade_in, t, CaptionContentProperty::FADE_IN);
516 CaptionContent::unset_fade_in ()
518 maybe_set (_fade_in, optional<ContentTime>(), CaptionContentProperty::FADE_IN);
522 CaptionContent::set_fade_out (ContentTime t)
524 maybe_set (_fade_out, t, CaptionContentProperty::FADE_OUT);
528 CaptionContent::unset_fade_out ()
530 maybe_set (_fade_out, optional<ContentTime>(), CaptionContentProperty::FADE_OUT);
534 CaptionContent::set_type (CaptionType type)
536 maybe_set (_type, type, CaptionContentProperty::TYPE);
540 CaptionContent::set_outline_width (int w)
542 maybe_set (_outline_width, w, CaptionContentProperty::OUTLINE_WIDTH);
546 CaptionContent::take_settings_from (shared_ptr<const CaptionContent> c)
550 set_x_offset (c->_x_offset);
551 set_y_offset (c->_y_offset);
552 set_x_scale (c->_x_scale);
553 set_y_scale (c->_y_scale);
554 maybe_set (_fonts, c->_fonts, CaptionContentProperty::FONTS);
556 set_colour (*c->_colour);
561 set_effect (*c->_effect);
563 if (c->_effect_colour) {
564 set_effect_colour (*c->_effect_colour);
566 unset_effect_colour ();
568 set_line_spacing (c->_line_spacing);
570 set_fade_in (*c->_fade_in);
573 set_fade_out (*c->_fade_out);
575 set_outline_width (c->_outline_width);