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, CaptionType original_type)
61 : ContentPart (parent)
70 , _type (original_type)
71 , _original_type (original_type)
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)
124 , _original_type (CAPTION_OPEN)
127 _use = node->bool_child ("Use");
128 _burn = node->bool_child ("Burn");
129 } else if (version >= 32) {
130 _use = node->bool_child ("UseSubtitles");
131 _burn = node->bool_child ("BurnSubtitles");
135 _x_offset = node->number_child<double> ("XOffset");
136 _y_offset = node->number_child<double> ("YOffset");
137 } else if (version >= 7) {
138 _x_offset = node->number_child<double> ("SubtitleXOffset");
139 _y_offset = node->number_child<double> ("SubtitleYOffset");
141 _y_offset = node->number_child<double> ("SubtitleOffset");
144 if (node->optional_bool_child("Outline").get_value_or(false)) {
145 _effect = dcp::BORDER;
146 } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
147 _effect = dcp::SHADOW;
152 optional<string> effect = node->optional_string_child("Effect");
154 if (*effect == "none") {
156 } else if (*effect == "outline") {
157 _effect = dcp::BORDER;
158 } else if (*effect == "shadow") {
159 _effect = dcp::SHADOW;
164 _x_scale = node->number_child<double> ("XScale");
165 _y_scale = node->number_child<double> ("YScale");
166 } else if (version >= 10) {
167 _x_scale = node->number_child<double> ("SubtitleXScale");
168 _y_scale = node->number_child<double> ("SubtitleYScale");
170 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
173 optional<int> r = node->optional_number_child<int>("Red");
174 optional<int> g = node->optional_number_child<int>("Green");
175 optional<int> b = node->optional_number_child<int>("Blue");
177 _colour = dcp::Colour (*r, *g, *b);
181 optional<int> er = node->optional_number_child<int>("EffectRed");
182 optional<int> eg = node->optional_number_child<int>("EffectGreen");
183 optional<int> eb = node->optional_number_child<int>("EffectBlue");
184 if (er && eg && eb) {
185 _effect_colour = dcp::Colour (*er, *eg, *eb);
188 _effect_colour = dcp::Colour (
189 node->optional_number_child<int>("OutlineRed").get_value_or(255),
190 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
191 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
197 fi = node->optional_number_child<Frame>("FadeIn");
199 fi = node->optional_number_child<Frame>("SubtitleFadeIn");
202 _fade_in = ContentTime (*fi);
207 fo = node->optional_number_child<Frame>("FadeOut");
209 fo = node->optional_number_child<Frame>("SubtitleFadeOut");
212 _fade_out = ContentTime (*fo);
216 _language = node->optional_string_child ("Language").get_value_or ("");
218 _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
221 list<cxml::NodePtr> fonts = node->node_children ("Font");
222 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
223 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
228 _type = string_to_caption_type (node->optional_string_child("Type").get_value_or("open"));
229 _original_type = string_to_caption_type (node->optional_string_child("OriginalType").get_value_or("open"));
232 CaptionContent::CaptionContent (Content* parent, vector<shared_ptr<Content> > c)
233 : ContentPart (parent)
235 /* This constructor is for join which is only supported for content types
236 that have a single caption, so we can use only_caption() here.
238 shared_ptr<CaptionContent> ref = c[0]->only_caption();
239 DCPOMATIC_ASSERT (ref);
240 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
242 for (size_t i = 1; i < c.size(); ++i) {
244 if (c[i]->only_caption()->use() != ref->use()) {
245 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
248 if (c[i]->only_caption()->burn() != ref->burn()) {
249 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
252 if (c[i]->only_caption()->x_offset() != ref->x_offset()) {
253 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
256 if (c[i]->only_caption()->y_offset() != ref->y_offset()) {
257 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
260 if (c[i]->only_caption()->x_scale() != ref->x_scale()) {
261 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
264 if (c[i]->only_caption()->y_scale() != ref->y_scale()) {
265 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
268 if (c[i]->only_caption()->line_spacing() != ref->line_spacing()) {
269 throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
272 if ((c[i]->only_caption()->fade_in() != ref->fade_in()) || (c[i]->only_caption()->fade_out() != ref->fade_out())) {
273 throw JoinError (_("Content to be joined must have the same subtitle fades."));
276 if ((c[i]->only_caption()->outline_width() != ref->outline_width())) {
277 throw JoinError (_("Content to be joined must have the same outline width."));
280 list<shared_ptr<Font> > fonts = c[i]->only_caption()->fonts ();
281 if (fonts.size() != ref_fonts.size()) {
282 throw JoinError (_("Content to be joined must use the same fonts."));
285 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
286 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
288 while (j != ref_fonts.end ()) {
290 throw JoinError (_("Content to be joined must use the same fonts."));
298 _burn = ref->burn ();
299 _x_offset = ref->x_offset ();
300 _y_offset = ref->y_offset ();
301 _x_scale = ref->x_scale ();
302 _y_scale = ref->y_scale ();
303 _language = ref->language ();
305 _line_spacing = ref->line_spacing ();
306 _fade_in = ref->fade_in ();
307 _fade_out = ref->fade_out ();
308 _outline_width = ref->outline_width ();
309 _type = ref->type ();
310 _original_type = ref->original_type ();
315 /** _mutex must not be held on entry */
317 CaptionContent::as_xml (xmlpp::Node* root) const
319 boost::mutex::scoped_lock lm (_mutex);
321 xmlpp::Element* caption = root->add_child ("Caption");
323 caption->add_child("Use")->add_child_text (_use ? "1" : "0");
324 caption->add_child("Burn")->add_child_text (_burn ? "1" : "0");
325 caption->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
326 caption->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
327 caption->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
328 caption->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
329 caption->add_child("Language")->add_child_text (_language);
331 caption->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
332 caption->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
333 caption->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
338 caption->add_child("Effect")->add_child_text("none");
341 caption->add_child("Effect")->add_child_text("outline");
344 caption->add_child("Effect")->add_child_text("shadow");
348 if (_effect_colour) {
349 caption->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
350 caption->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
351 caption->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
353 caption->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
355 caption->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
358 caption->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
360 caption->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
362 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
363 (*i)->as_xml (caption->add_child("Font"));
366 caption->add_child("Type")->add_child_text (caption_type_to_string(_type));
367 caption->add_child("OriginalType")->add_child_text (caption_type_to_string(_original_type));
371 CaptionContent::identifier () const
373 string s = raw_convert<string> (x_scale())
374 + "_" + raw_convert<string> (y_scale())
375 + "_" + raw_convert<string> (x_offset())
376 + "_" + raw_convert<string> (y_offset())
377 + "_" + raw_convert<string> (line_spacing())
378 + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
379 + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
380 + "_" + raw_convert<string> (outline_width())
381 + "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
382 + "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
383 + "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string());
385 /* XXX: I suppose really _fonts shouldn't be in here, since not all
386 types of subtitle content involve fonts.
388 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
389 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
390 s += "_" + f->file(static_cast<FontFiles::Variant>(i)).get_value_or("Default").string();
394 /* The language is for metadata only, and doesn't affect
395 how this content looks.
402 CaptionContent::add_font (shared_ptr<Font> font)
404 _fonts.push_back (font);
409 CaptionContent::connect_to_fonts ()
411 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
415 _font_connections.clear ();
417 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
418 _font_connections.push_back (i->Changed.connect (boost::bind (&CaptionContent::font_changed, this)));
423 CaptionContent::font_changed ()
425 _parent->signal_changed (CaptionContentProperty::FONTS);
429 CaptionContent::set_colour (dcp::Colour colour)
431 maybe_set (_colour, colour, CaptionContentProperty::COLOUR);
435 CaptionContent::unset_colour ()
437 maybe_set (_colour, optional<dcp::Colour>(), CaptionContentProperty::COLOUR);
441 CaptionContent::set_effect (dcp::Effect e)
443 maybe_set (_effect, e, CaptionContentProperty::EFFECT);
447 CaptionContent::unset_effect ()
449 maybe_set (_effect, optional<dcp::Effect>(), CaptionContentProperty::EFFECT);
453 CaptionContent::set_effect_colour (dcp::Colour colour)
455 maybe_set (_effect_colour, colour, CaptionContentProperty::EFFECT_COLOUR);
459 CaptionContent::unset_effect_colour ()
461 maybe_set (_effect_colour, optional<dcp::Colour>(), CaptionContentProperty::EFFECT_COLOUR);
465 CaptionContent::set_use (bool u)
467 maybe_set (_use, u, CaptionContentProperty::USE);
471 CaptionContent::set_burn (bool b)
473 maybe_set (_burn, b, CaptionContentProperty::BURN);
477 CaptionContent::set_x_offset (double o)
479 maybe_set (_x_offset, o, CaptionContentProperty::X_OFFSET);
483 CaptionContent::set_y_offset (double o)
485 maybe_set (_y_offset, o, CaptionContentProperty::Y_OFFSET);
489 CaptionContent::set_x_scale (double s)
491 maybe_set (_x_scale, s, CaptionContentProperty::X_SCALE);
495 CaptionContent::set_y_scale (double s)
497 maybe_set (_y_scale, s, CaptionContentProperty::Y_SCALE);
501 CaptionContent::set_language (string language)
503 maybe_set (_language, language, CaptionContentProperty::LANGUAGE);
507 CaptionContent::set_line_spacing (double s)
509 maybe_set (_line_spacing, s, CaptionContentProperty::LINE_SPACING);
513 CaptionContent::set_fade_in (ContentTime t)
515 maybe_set (_fade_in, t, CaptionContentProperty::FADE_IN);
519 CaptionContent::unset_fade_in ()
521 maybe_set (_fade_in, optional<ContentTime>(), CaptionContentProperty::FADE_IN);
525 CaptionContent::set_fade_out (ContentTime t)
527 maybe_set (_fade_out, t, CaptionContentProperty::FADE_OUT);
531 CaptionContent::unset_fade_out ()
533 maybe_set (_fade_out, optional<ContentTime>(), CaptionContentProperty::FADE_OUT);
537 CaptionContent::set_type (CaptionType type)
539 maybe_set (_type, type, CaptionContentProperty::TYPE);
543 CaptionContent::set_outline_width (int w)
545 maybe_set (_outline_width, w, CaptionContentProperty::OUTLINE_WIDTH);
549 CaptionContent::take_settings_from (shared_ptr<const CaptionContent> c)
553 set_x_offset (c->_x_offset);
554 set_y_offset (c->_y_offset);
555 set_x_scale (c->_x_scale);
556 set_y_scale (c->_y_scale);
557 maybe_set (_fonts, c->_fonts, CaptionContentProperty::FONTS);
559 set_colour (*c->_colour);
564 set_effect (*c->_effect);
566 if (c->_effect_colour) {
567 set_effect_colour (*c->_effect_colour);
569 unset_effect_colour ();
571 set_line_spacing (c->_line_spacing);
573 set_fade_in (*c->_fade_in);
576 set_fade_out (*c->_fade_out);
578 set_outline_width (c->_outline_width);