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 "text_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;
42 using namespace dcpomatic;
44 int const TextContentProperty::X_OFFSET = 500;
45 int const TextContentProperty::Y_OFFSET = 501;
46 int const TextContentProperty::X_SCALE = 502;
47 int const TextContentProperty::Y_SCALE = 503;
48 int const TextContentProperty::USE = 504;
49 int const TextContentProperty::BURN = 505;
50 int const TextContentProperty::LANGUAGE = 506;
51 int const TextContentProperty::FONTS = 507;
52 int const TextContentProperty::COLOUR = 508;
53 int const TextContentProperty::EFFECT = 509;
54 int const TextContentProperty::EFFECT_COLOUR = 510;
55 int const TextContentProperty::LINE_SPACING = 511;
56 int const TextContentProperty::FADE_IN = 512;
57 int const TextContentProperty::FADE_OUT = 513;
58 int const TextContentProperty::OUTLINE_WIDTH = 514;
59 int const TextContentProperty::TYPE = 515;
60 int const TextContentProperty::DCP_TRACK = 516;
62 TextContent::TextContent (Content* parent, TextType type, TextType original_type)
63 : ContentPart (parent)
73 , _original_type (original_type)
78 /** @return TextContents from node or <Text> nodes under node (according to version).
79 * The list could be empty if no TextContents are found.
81 list<shared_ptr<TextContent> >
82 TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
85 /* With old metadata FFmpeg content has the subtitle-related tags even with no
86 subtitle streams, so check for that.
88 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
89 return list<shared_ptr<TextContent> >();
92 /* Otherwise we can drop through to the newer logic */
96 if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
97 return list<shared_ptr<TextContent> >();
99 list<shared_ptr<TextContent> > c;
100 c.push_back (shared_ptr<TextContent> (new TextContent (parent, node, version)));
104 if (!node->optional_node_child("Text")) {
105 return list<shared_ptr<TextContent> >();
108 list<shared_ptr<TextContent> > c;
109 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Text")) {
110 c.push_back (shared_ptr<TextContent> (new TextContent (parent, i, version)));
116 TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
117 : ContentPart (parent)
124 , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
125 , _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (4))
126 , _type (TEXT_OPEN_SUBTITLE)
127 , _original_type (TEXT_OPEN_SUBTITLE)
130 _use = node->bool_child ("Use");
131 _burn = node->bool_child ("Burn");
132 } else if (version >= 32) {
133 _use = node->bool_child ("UseSubtitles");
134 _burn = node->bool_child ("BurnSubtitles");
138 _x_offset = node->number_child<double> ("XOffset");
139 _y_offset = node->number_child<double> ("YOffset");
140 } else if (version >= 7) {
141 _x_offset = node->number_child<double> ("SubtitleXOffset");
142 _y_offset = node->number_child<double> ("SubtitleYOffset");
144 _y_offset = node->number_child<double> ("SubtitleOffset");
147 if (node->optional_bool_child("Outline").get_value_or(false)) {
148 _effect = dcp::BORDER;
149 } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
150 _effect = dcp::SHADOW;
155 optional<string> effect = node->optional_string_child("Effect");
157 if (*effect == "none") {
159 } else if (*effect == "outline") {
160 _effect = dcp::BORDER;
161 } else if (*effect == "shadow") {
162 _effect = dcp::SHADOW;
167 _x_scale = node->number_child<double> ("XScale");
168 _y_scale = node->number_child<double> ("YScale");
169 } else if (version >= 10) {
170 _x_scale = node->number_child<double> ("SubtitleXScale");
171 _y_scale = node->number_child<double> ("SubtitleYScale");
173 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
176 optional<int> r = node->optional_number_child<int>("Red");
177 optional<int> g = node->optional_number_child<int>("Green");
178 optional<int> b = node->optional_number_child<int>("Blue");
180 _colour = dcp::Colour (*r, *g, *b);
184 optional<int> er = node->optional_number_child<int>("EffectRed");
185 optional<int> eg = node->optional_number_child<int>("EffectGreen");
186 optional<int> eb = node->optional_number_child<int>("EffectBlue");
187 if (er && eg && eb) {
188 _effect_colour = dcp::Colour (*er, *eg, *eb);
191 _effect_colour = dcp::Colour (
192 node->optional_number_child<int>("OutlineRed").get_value_or(255),
193 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
194 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
200 fi = node->optional_number_child<Frame>("FadeIn");
202 fi = node->optional_number_child<Frame>("SubtitleFadeIn");
205 _fade_in = ContentTime (*fi);
210 fo = node->optional_number_child<Frame>("FadeOut");
212 fo = node->optional_number_child<Frame>("SubtitleFadeOut");
215 _fade_out = ContentTime (*fo);
219 _language = node->optional_string_child ("Language").get_value_or ("");
221 _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
224 list<cxml::NodePtr> fonts = node->node_children ("Font");
225 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
226 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
232 _type = string_to_text_type (node->optional_string_child("Type").get_value_or("open"));
233 if (node->optional_string_child("OriginalType")) {
234 _original_type = string_to_text_type (node->optional_string_child("OriginalType").get());
238 cxml::ConstNodePtr dt = node->optional_node_child("DCPTrack");
240 _dcp_track = DCPTextTrack (dt);
244 TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
245 : ContentPart (parent)
247 /* This constructor is for join which is only supported for content types
248 that have a single text, so we can use only_text() here.
250 shared_ptr<TextContent> ref = c[0]->only_text();
251 DCPOMATIC_ASSERT (ref);
252 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
254 for (size_t i = 1; i < c.size(); ++i) {
256 if (c[i]->only_text()->use() != ref->use()) {
257 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
260 if (c[i]->only_text()->burn() != ref->burn()) {
261 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
264 if (c[i]->only_text()->x_offset() != ref->x_offset()) {
265 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
268 if (c[i]->only_text()->y_offset() != ref->y_offset()) {
269 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
272 if (c[i]->only_text()->x_scale() != ref->x_scale()) {
273 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
276 if (c[i]->only_text()->y_scale() != ref->y_scale()) {
277 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
280 if (c[i]->only_text()->line_spacing() != ref->line_spacing()) {
281 throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
284 if ((c[i]->only_text()->fade_in() != ref->fade_in()) || (c[i]->only_text()->fade_out() != ref->fade_out())) {
285 throw JoinError (_("Content to be joined must have the same subtitle fades."));
288 if ((c[i]->only_text()->outline_width() != ref->outline_width())) {
289 throw JoinError (_("Content to be joined must have the same outline width."));
292 list<shared_ptr<Font> > fonts = c[i]->only_text()->fonts ();
293 if (fonts.size() != ref_fonts.size()) {
294 throw JoinError (_("Content to be joined must use the same fonts."));
297 if (c[i]->only_text()->dcp_track() != ref->dcp_track()) {
298 throw JoinError (_("Content to be joined must use the same DCP track."));
301 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
302 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
304 while (j != ref_fonts.end ()) {
306 throw JoinError (_("Content to be joined must use the same fonts."));
314 _burn = ref->burn ();
315 _x_offset = ref->x_offset ();
316 _y_offset = ref->y_offset ();
317 _x_scale = ref->x_scale ();
318 _y_scale = ref->y_scale ();
319 _language = ref->language ();
321 _line_spacing = ref->line_spacing ();
322 _fade_in = ref->fade_in ();
323 _fade_out = ref->fade_out ();
324 _outline_width = ref->outline_width ();
325 _type = ref->type ();
326 _original_type = ref->original_type ();
327 _dcp_track = ref->dcp_track ();
332 /** _mutex must not be held on entry */
334 TextContent::as_xml (xmlpp::Node* root) const
336 boost::mutex::scoped_lock lm (_mutex);
338 xmlpp::Element* text = root->add_child ("Text");
340 text->add_child("Use")->add_child_text (_use ? "1" : "0");
341 text->add_child("Burn")->add_child_text (_burn ? "1" : "0");
342 text->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
343 text->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
344 text->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
345 text->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
346 text->add_child("Language")->add_child_text (_language);
348 text->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
349 text->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
350 text->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
355 text->add_child("Effect")->add_child_text("none");
358 text->add_child("Effect")->add_child_text("outline");
361 text->add_child("Effect")->add_child_text("shadow");
365 if (_effect_colour) {
366 text->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
367 text->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
368 text->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
370 text->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
372 text->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
375 text->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
377 text->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
379 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
380 (*i)->as_xml (text->add_child("Font"));
383 text->add_child("Type")->add_child_text (text_type_to_string(_type));
384 text->add_child("OriginalType")->add_child_text (text_type_to_string(_original_type));
386 _dcp_track->as_xml(text->add_child("DCPTrack"));
391 TextContent::identifier () const
393 string s = raw_convert<string> (x_scale())
394 + "_" + raw_convert<string> (y_scale())
395 + "_" + raw_convert<string> (x_offset())
396 + "_" + raw_convert<string> (y_offset())
397 + "_" + raw_convert<string> (line_spacing())
398 + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
399 + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
400 + "_" + raw_convert<string> (outline_width())
401 + "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
402 + "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
403 + "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string())
404 + "_" + raw_convert<string> (_parent->video_frame_rate().get_value_or(0));
406 /* XXX: I suppose really _fonts shouldn't be in here, since not all
407 types of subtitle content involve fonts.
409 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
410 s += "_" + f->file().get_value_or("Default").string();
413 /* The DCP track and language are for metadata only, and don't affect
414 how this content looks.
421 TextContent::add_font (shared_ptr<Font> font)
423 _fonts.push_back (font);
428 TextContent::connect_to_fonts ()
430 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
434 _font_connections.clear ();
436 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
437 _font_connections.push_back (i->Changed.connect (boost::bind (&TextContent::font_changed, this)));
442 TextContent::font_changed ()
445 ChangeSignaller<Content> cc (_parent, TextContentProperty::FONTS);
449 TextContent::set_colour (dcp::Colour colour)
451 maybe_set (_colour, colour, TextContentProperty::COLOUR);
455 TextContent::unset_colour ()
457 maybe_set (_colour, optional<dcp::Colour>(), TextContentProperty::COLOUR);
461 TextContent::set_effect (dcp::Effect e)
463 maybe_set (_effect, e, TextContentProperty::EFFECT);
467 TextContent::unset_effect ()
469 maybe_set (_effect, optional<dcp::Effect>(), TextContentProperty::EFFECT);
473 TextContent::set_effect_colour (dcp::Colour colour)
475 maybe_set (_effect_colour, colour, TextContentProperty::EFFECT_COLOUR);
479 TextContent::unset_effect_colour ()
481 maybe_set (_effect_colour, optional<dcp::Colour>(), TextContentProperty::EFFECT_COLOUR);
485 TextContent::set_use (bool u)
487 maybe_set (_use, u, TextContentProperty::USE);
491 TextContent::set_burn (bool b)
493 maybe_set (_burn, b, TextContentProperty::BURN);
497 TextContent::set_x_offset (double o)
499 maybe_set (_x_offset, o, TextContentProperty::X_OFFSET);
503 TextContent::set_y_offset (double o)
505 maybe_set (_y_offset, o, TextContentProperty::Y_OFFSET);
509 TextContent::set_x_scale (double s)
511 maybe_set (_x_scale, s, TextContentProperty::X_SCALE);
515 TextContent::set_y_scale (double s)
517 maybe_set (_y_scale, s, TextContentProperty::Y_SCALE);
521 TextContent::set_language (string language)
523 maybe_set (_language, language, TextContentProperty::LANGUAGE);
527 TextContent::set_line_spacing (double s)
529 maybe_set (_line_spacing, s, TextContentProperty::LINE_SPACING);
533 TextContent::set_fade_in (ContentTime t)
535 maybe_set (_fade_in, t, TextContentProperty::FADE_IN);
539 TextContent::unset_fade_in ()
541 maybe_set (_fade_in, optional<ContentTime>(), TextContentProperty::FADE_IN);
545 TextContent::set_fade_out (ContentTime t)
547 maybe_set (_fade_out, t, TextContentProperty::FADE_OUT);
551 TextContent::unset_fade_out ()
553 maybe_set (_fade_out, optional<ContentTime>(), TextContentProperty::FADE_OUT);
557 TextContent::set_type (TextType type)
559 maybe_set (_type, type, TextContentProperty::TYPE);
563 TextContent::set_outline_width (int w)
565 maybe_set (_outline_width, w, TextContentProperty::OUTLINE_WIDTH);
569 TextContent::set_dcp_track (DCPTextTrack t)
571 maybe_set (_dcp_track, t, TextContentProperty::DCP_TRACK);
575 TextContent::unset_dcp_track ()
577 maybe_set (_dcp_track, optional<DCPTextTrack>(), TextContentProperty::DCP_TRACK);
581 TextContent::take_settings_from (shared_ptr<const TextContent> c)
585 set_x_offset (c->_x_offset);
586 set_y_offset (c->_y_offset);
587 set_x_scale (c->_x_scale);
588 set_y_scale (c->_y_scale);
589 maybe_set (_fonts, c->_fonts, TextContentProperty::FONTS);
591 set_colour (*c->_colour);
596 set_effect (*c->_effect);
598 if (c->_effect_colour) {
599 set_effect_colour (*c->_effect_colour);
601 unset_effect_colour ();
603 set_line_spacing (c->_line_spacing);
605 set_fade_in (*c->_fade_in);
608 set_fade_out (*c->_fade_out);
610 set_outline_width (c->_outline_width);
612 set_dcp_track (c->_dcp_track.get());