2 Copyright (C) 2013-2020 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::FONTS = 506;
51 int const TextContentProperty::COLOUR = 507;
52 int const TextContentProperty::EFFECT = 508;
53 int const TextContentProperty::EFFECT_COLOUR = 509;
54 int const TextContentProperty::LINE_SPACING = 510;
55 int const TextContentProperty::FADE_IN = 511;
56 int const TextContentProperty::FADE_OUT = 512;
57 int const TextContentProperty::OUTLINE_WIDTH = 513;
58 int const TextContentProperty::TYPE = 514;
59 int const TextContentProperty::DCP_TRACK = 515;
61 TextContent::TextContent (Content* parent, TextType type, TextType original_type)
62 : ContentPart (parent)
72 , _original_type (original_type)
77 /** @return TextContents from node or <Text> nodes under node (according to version).
78 * The list could be empty if no TextContents are found.
80 list<shared_ptr<TextContent> >
81 TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
84 /* With old metadata FFmpeg content has the subtitle-related tags even with no
85 subtitle streams, so check for that.
87 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
88 return list<shared_ptr<TextContent> >();
91 /* Otherwise we can drop through to the newer logic */
95 if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
96 return list<shared_ptr<TextContent> >();
98 list<shared_ptr<TextContent> > c;
99 c.push_back (shared_ptr<TextContent> (new TextContent (parent, node, version)));
103 if (!node->optional_node_child("Text")) {
104 return list<shared_ptr<TextContent> >();
107 list<shared_ptr<TextContent> > c;
108 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Text")) {
109 c.push_back (shared_ptr<TextContent> (new TextContent (parent, i, version)));
115 TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
116 : ContentPart (parent)
123 , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
124 , _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (4))
125 , _type (TEXT_OPEN_SUBTITLE)
126 , _original_type (TEXT_OPEN_SUBTITLE)
129 _use = node->bool_child ("Use");
130 _burn = node->bool_child ("Burn");
131 } else if (version >= 32) {
132 _use = node->bool_child ("UseSubtitles");
133 _burn = node->bool_child ("BurnSubtitles");
137 _x_offset = node->number_child<double> ("XOffset");
138 _y_offset = node->number_child<double> ("YOffset");
139 } else if (version >= 7) {
140 _x_offset = node->number_child<double> ("SubtitleXOffset");
141 _y_offset = node->number_child<double> ("SubtitleYOffset");
143 _y_offset = node->number_child<double> ("SubtitleOffset");
146 if (node->optional_bool_child("Outline").get_value_or(false)) {
147 _effect = dcp::BORDER;
148 } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
149 _effect = dcp::SHADOW;
154 optional<string> effect = node->optional_string_child("Effect");
156 if (*effect == "none") {
158 } else if (*effect == "outline") {
159 _effect = dcp::BORDER;
160 } else if (*effect == "shadow") {
161 _effect = dcp::SHADOW;
166 _x_scale = node->number_child<double> ("XScale");
167 _y_scale = node->number_child<double> ("YScale");
168 } else if (version >= 10) {
169 _x_scale = node->number_child<double> ("SubtitleXScale");
170 _y_scale = node->number_child<double> ("SubtitleYScale");
172 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
175 optional<int> r = node->optional_number_child<int>("Red");
176 optional<int> g = node->optional_number_child<int>("Green");
177 optional<int> b = node->optional_number_child<int>("Blue");
179 _colour = dcp::Colour (*r, *g, *b);
183 optional<int> er = node->optional_number_child<int>("EffectRed");
184 optional<int> eg = node->optional_number_child<int>("EffectGreen");
185 optional<int> eb = node->optional_number_child<int>("EffectBlue");
186 if (er && eg && eb) {
187 _effect_colour = dcp::Colour (*er, *eg, *eb);
190 _effect_colour = dcp::Colour (
191 node->optional_number_child<int>("OutlineRed").get_value_or(255),
192 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
193 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
199 fi = node->optional_number_child<Frame>("FadeIn");
201 fi = node->optional_number_child<Frame>("SubtitleFadeIn");
204 _fade_in = ContentTime (*fi);
209 fo = node->optional_number_child<Frame>("FadeOut");
211 fo = node->optional_number_child<Frame>("SubtitleFadeOut");
214 _fade_out = ContentTime (*fo);
217 list<cxml::NodePtr> fonts = node->node_children ("Font");
218 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
219 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
225 _type = string_to_text_type (node->optional_string_child("Type").get_value_or("open"));
226 if (node->optional_string_child("OriginalType")) {
227 _original_type = string_to_text_type (node->optional_string_child("OriginalType").get());
231 cxml::ConstNodePtr dt = node->optional_node_child("DCPTrack");
233 _dcp_track = DCPTextTrack (dt);
237 TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
238 : ContentPart (parent)
240 /* This constructor is for join which is only supported for content types
241 that have a single text, so we can use only_text() here.
243 shared_ptr<TextContent> ref = c[0]->only_text();
244 DCPOMATIC_ASSERT (ref);
245 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
247 for (size_t i = 1; i < c.size(); ++i) {
249 if (c[i]->only_text()->use() != ref->use()) {
250 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
253 if (c[i]->only_text()->burn() != ref->burn()) {
254 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
257 if (c[i]->only_text()->x_offset() != ref->x_offset()) {
258 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
261 if (c[i]->only_text()->y_offset() != ref->y_offset()) {
262 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
265 if (c[i]->only_text()->x_scale() != ref->x_scale()) {
266 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
269 if (c[i]->only_text()->y_scale() != ref->y_scale()) {
270 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
273 if (c[i]->only_text()->line_spacing() != ref->line_spacing()) {
274 throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
277 if ((c[i]->only_text()->fade_in() != ref->fade_in()) || (c[i]->only_text()->fade_out() != ref->fade_out())) {
278 throw JoinError (_("Content to be joined must have the same subtitle fades."));
281 if ((c[i]->only_text()->outline_width() != ref->outline_width())) {
282 throw JoinError (_("Content to be joined must have the same outline width."));
285 list<shared_ptr<Font> > fonts = c[i]->only_text()->fonts ();
286 if (fonts.size() != ref_fonts.size()) {
287 throw JoinError (_("Content to be joined must use the same fonts."));
290 if (c[i]->only_text()->dcp_track() != ref->dcp_track()) {
291 throw JoinError (_("Content to be joined must use the same DCP track."));
294 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
295 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
297 while (j != ref_fonts.end ()) {
299 throw JoinError (_("Content to be joined must use the same fonts."));
307 _burn = ref->burn ();
308 _x_offset = ref->x_offset ();
309 _y_offset = ref->y_offset ();
310 _x_scale = ref->x_scale ();
311 _y_scale = ref->y_scale ();
313 _line_spacing = ref->line_spacing ();
314 _fade_in = ref->fade_in ();
315 _fade_out = ref->fade_out ();
316 _outline_width = ref->outline_width ();
317 _type = ref->type ();
318 _original_type = ref->original_type ();
319 _dcp_track = ref->dcp_track ();
324 /** _mutex must not be held on entry */
326 TextContent::as_xml (xmlpp::Node* root) const
328 boost::mutex::scoped_lock lm (_mutex);
330 xmlpp::Element* text = root->add_child ("Text");
332 text->add_child("Use")->add_child_text (_use ? "1" : "0");
333 text->add_child("Burn")->add_child_text (_burn ? "1" : "0");
334 text->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
335 text->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
336 text->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
337 text->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
339 text->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
340 text->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
341 text->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
346 text->add_child("Effect")->add_child_text("none");
349 text->add_child("Effect")->add_child_text("outline");
352 text->add_child("Effect")->add_child_text("shadow");
356 if (_effect_colour) {
357 text->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
358 text->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
359 text->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
361 text->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
363 text->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
366 text->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
368 text->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
370 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
371 (*i)->as_xml (text->add_child("Font"));
374 text->add_child("Type")->add_child_text (text_type_to_string(_type));
375 text->add_child("OriginalType")->add_child_text (text_type_to_string(_original_type));
377 _dcp_track->as_xml(text->add_child("DCPTrack"));
382 TextContent::identifier () const
384 string s = raw_convert<string> (x_scale())
385 + "_" + raw_convert<string> (y_scale())
386 + "_" + raw_convert<string> (x_offset())
387 + "_" + raw_convert<string> (y_offset())
388 + "_" + raw_convert<string> (line_spacing())
389 + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
390 + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
391 + "_" + raw_convert<string> (outline_width())
392 + "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
393 + "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
394 + "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string())
395 + "_" + raw_convert<string> (_parent->video_frame_rate().get_value_or(0));
397 /* XXX: I suppose really _fonts shouldn't be in here, since not all
398 types of subtitle content involve fonts.
400 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
401 s += "_" + f->file().get_value_or("Default").string();
404 /* The DCP track is for metadata only, and doesn't affect how this content looks */
410 TextContent::add_font (shared_ptr<Font> font)
412 _fonts.push_back (font);
417 TextContent::connect_to_fonts ()
419 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
423 _font_connections.clear ();
425 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
426 _font_connections.push_back (i->Changed.connect (boost::bind (&TextContent::font_changed, this)));
431 TextContent::font_changed ()
434 ChangeSignaller<Content> cc (_parent, TextContentProperty::FONTS);
438 TextContent::set_colour (dcp::Colour colour)
440 maybe_set (_colour, colour, TextContentProperty::COLOUR);
444 TextContent::unset_colour ()
446 maybe_set (_colour, optional<dcp::Colour>(), TextContentProperty::COLOUR);
450 TextContent::set_effect (dcp::Effect e)
452 maybe_set (_effect, e, TextContentProperty::EFFECT);
456 TextContent::unset_effect ()
458 maybe_set (_effect, optional<dcp::Effect>(), TextContentProperty::EFFECT);
462 TextContent::set_effect_colour (dcp::Colour colour)
464 maybe_set (_effect_colour, colour, TextContentProperty::EFFECT_COLOUR);
468 TextContent::unset_effect_colour ()
470 maybe_set (_effect_colour, optional<dcp::Colour>(), TextContentProperty::EFFECT_COLOUR);
474 TextContent::set_use (bool u)
476 maybe_set (_use, u, TextContentProperty::USE);
480 TextContent::set_burn (bool b)
482 maybe_set (_burn, b, TextContentProperty::BURN);
486 TextContent::set_x_offset (double o)
488 maybe_set (_x_offset, o, TextContentProperty::X_OFFSET);
492 TextContent::set_y_offset (double o)
494 maybe_set (_y_offset, o, TextContentProperty::Y_OFFSET);
498 TextContent::set_x_scale (double s)
500 maybe_set (_x_scale, s, TextContentProperty::X_SCALE);
504 TextContent::set_y_scale (double s)
506 maybe_set (_y_scale, s, TextContentProperty::Y_SCALE);
510 TextContent::set_line_spacing (double s)
512 maybe_set (_line_spacing, s, TextContentProperty::LINE_SPACING);
516 TextContent::set_fade_in (ContentTime t)
518 maybe_set (_fade_in, t, TextContentProperty::FADE_IN);
522 TextContent::unset_fade_in ()
524 maybe_set (_fade_in, optional<ContentTime>(), TextContentProperty::FADE_IN);
528 TextContent::set_fade_out (ContentTime t)
530 maybe_set (_fade_out, t, TextContentProperty::FADE_OUT);
534 TextContent::unset_fade_out ()
536 maybe_set (_fade_out, optional<ContentTime>(), TextContentProperty::FADE_OUT);
540 TextContent::set_type (TextType type)
542 maybe_set (_type, type, TextContentProperty::TYPE);
546 TextContent::set_outline_width (int w)
548 maybe_set (_outline_width, w, TextContentProperty::OUTLINE_WIDTH);
552 TextContent::set_dcp_track (DCPTextTrack t)
554 maybe_set (_dcp_track, t, TextContentProperty::DCP_TRACK);
558 TextContent::unset_dcp_track ()
560 maybe_set (_dcp_track, optional<DCPTextTrack>(), TextContentProperty::DCP_TRACK);
564 TextContent::take_settings_from (shared_ptr<const TextContent> c)
568 set_x_offset (c->_x_offset);
569 set_y_offset (c->_y_offset);
570 set_x_scale (c->_x_scale);
571 set_y_scale (c->_y_scale);
572 maybe_set (_fonts, c->_fonts, TextContentProperty::FONTS);
574 set_colour (*c->_colour);
579 set_effect (*c->_effect);
581 if (c->_effect_colour) {
582 set_effect_colour (*c->_effect_colour);
584 unset_effect_colour ();
586 set_line_spacing (c->_line_spacing);
588 set_fade_in (*c->_fade_in);
591 set_fade_out (*c->_fade_out);
593 set_outline_width (c->_outline_width);
595 set_dcp_track (c->_dcp_track.get());