2 Copyright (C) 2013-2016 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 "subtitle_content.h"
23 #include "exceptions.h"
24 #include "safe_stringstream.h"
26 #include "raw_convert.h"
28 #include <libcxml/cxml.h>
29 #include <libxml++/libxml++.h>
30 #include <boost/foreach.hpp>
39 using boost::shared_ptr;
40 using boost::dynamic_pointer_cast;
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 int const SubtitleContentProperty::LINE_SPACING = 511;
55 SubtitleContent::SubtitleContent (Content* parent)
56 : ContentPart (parent)
63 , _colour (255, 255, 255)
65 , _outline_colour (0, 0, 0)
71 shared_ptr<SubtitleContent>
72 SubtitleContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
75 /* With old metadata FFmpeg content has the subtitle-related tags even with no
76 subtitle streams, so check for that.
78 if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
79 return shared_ptr<SubtitleContent> ();
82 /* Otherwise we can drop through to the newer logic */
85 if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
86 return shared_ptr<SubtitleContent> ();
89 return shared_ptr<SubtitleContent> (new SubtitleContent (parent, node, version));
92 SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int version)
93 : ContentPart (parent)
101 node->optional_number_child<int>("Red").get_value_or(255),
102 node->optional_number_child<int>("Green").get_value_or(255),
103 node->optional_number_child<int>("Blue").get_value_or(255)
105 , _outline (node->optional_bool_child("Outline").get_value_or(false))
107 node->optional_number_child<int>("OutlineRed").get_value_or(255),
108 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
109 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
111 , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
114 _use = node->bool_child ("UseSubtitles");
115 _burn = node->bool_child ("BurnSubtitles");
119 _x_offset = node->number_child<double> ("SubtitleXOffset");
120 _y_offset = node->number_child<double> ("SubtitleYOffset");
122 _y_offset = node->number_child<double> ("SubtitleOffset");
126 _x_scale = node->number_child<double> ("SubtitleXScale");
127 _y_scale = node->number_child<double> ("SubtitleYScale");
129 _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
132 _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
134 list<cxml::NodePtr> fonts = node->node_children ("Font");
135 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
136 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
142 SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> > c)
143 : ContentPart (parent)
145 shared_ptr<SubtitleContent> ref = c[0]->subtitle;
146 DCPOMATIC_ASSERT (ref);
147 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
149 for (size_t i = 1; i < c.size(); ++i) {
151 if (c[i]->subtitle->use() != ref->use()) {
152 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
155 if (c[i]->subtitle->burn() != ref->burn()) {
156 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
159 if (c[i]->subtitle->x_offset() != ref->x_offset()) {
160 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
163 if (c[i]->subtitle->y_offset() != ref->y_offset()) {
164 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
167 if (c[i]->subtitle->x_scale() != ref->x_scale()) {
168 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
171 if (c[i]->subtitle->y_scale() != ref->y_scale()) {
172 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
175 if (c[i]->subtitle->line_spacing() != ref->line_spacing()) {
176 throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
179 list<shared_ptr<Font> > fonts = c[i]->subtitle->fonts ();
180 if (fonts.size() != ref_fonts.size()) {
181 throw JoinError (_("Content to be joined must use the same fonts."));
184 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
185 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
187 while (j != ref_fonts.end ()) {
189 throw JoinError (_("Content to be joined must use the same fonts."));
197 _burn = ref->burn ();
198 _x_offset = ref->x_offset ();
199 _y_offset = ref->y_offset ();
200 _x_scale = ref->x_scale ();
201 _y_scale = ref->y_scale ();
202 _language = ref->language ();
204 _line_spacing = ref->line_spacing ();
209 /** _mutex must not be held on entry */
211 SubtitleContent::as_xml (xmlpp::Node* root) const
213 boost::mutex::scoped_lock lm (_mutex);
215 root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use));
216 root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn));
217 root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_x_offset));
218 root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_y_offset));
219 root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_x_scale));
220 root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_y_scale));
221 root->add_child("SubtitleLanguage")->add_child_text (_language);
222 root->add_child("Red")->add_child_text (raw_convert<string> (_colour.r));
223 root->add_child("Green")->add_child_text (raw_convert<string> (_colour.g));
224 root->add_child("Blue")->add_child_text (raw_convert<string> (_colour.b));
225 root->add_child("Outline")->add_child_text (raw_convert<string> (_outline));
226 root->add_child("OutlineRed")->add_child_text (raw_convert<string> (_outline_colour.r));
227 root->add_child("OutlineGreen")->add_child_text (raw_convert<string> (_outline_colour.g));
228 root->add_child("OutlineBlue")->add_child_text (raw_convert<string> (_outline_colour.b));
229 root->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
231 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
232 (*i)->as_xml (root->add_child("Font"));
237 SubtitleContent::identifier () const
240 s << raw_convert<string> (x_scale())
241 << "_" << raw_convert<string> (y_scale())
242 << "_" << raw_convert<string> (x_offset())
243 << "_" << raw_convert<string> (y_offset())
244 << "_" << raw_convert<string> (line_spacing());
246 /* XXX: I suppose really _fonts shouldn't be in here, since not all
247 types of subtitle content involve fonts.
249 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
250 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
251 s << "_" << f->file(static_cast<FontFiles::Variant>(i)).get_value_or ("Default");
255 /* The language is for metadata only, and doesn't affect
256 how this content looks.
263 SubtitleContent::add_font (shared_ptr<Font> font)
265 _fonts.push_back (font);
270 SubtitleContent::connect_to_fonts ()
272 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
276 _font_connections.clear ();
278 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
279 _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this)));
284 SubtitleContent::font_changed ()
286 _parent->signal_changed (SubtitleContentProperty::FONTS);
290 SubtitleContent::set_colour (dcp::Colour colour)
292 maybe_set (_colour, colour, SubtitleContentProperty::COLOUR);
296 SubtitleContent::set_outline (bool o)
298 maybe_set (_outline, o, SubtitleContentProperty::OUTLINE);
302 SubtitleContent::set_outline_colour (dcp::Colour colour)
304 maybe_set (_outline_colour, colour, SubtitleContentProperty::OUTLINE_COLOUR);
308 SubtitleContent::set_use (bool u)
310 maybe_set (_use, u, SubtitleContentProperty::USE);
314 SubtitleContent::set_burn (bool b)
316 maybe_set (_burn, b, SubtitleContentProperty::BURN);
320 SubtitleContent::set_x_offset (double o)
322 maybe_set (_x_offset, o, SubtitleContentProperty::X_OFFSET);
326 SubtitleContent::set_y_offset (double o)
328 maybe_set (_y_offset, o, SubtitleContentProperty::Y_OFFSET);
332 SubtitleContent::set_x_scale (double s)
334 maybe_set (_x_scale, s, SubtitleContentProperty::X_SCALE);
338 SubtitleContent::set_y_scale (double s)
340 maybe_set (_y_scale, s, SubtitleContentProperty::Y_SCALE);
344 SubtitleContent::set_language (string language)
346 maybe_set (_language, language, SubtitleContentProperty::LANGUAGE);
350 SubtitleContent::set_line_spacing (double s)
352 maybe_set (_line_spacing, s, SubtitleContentProperty::LINE_SPACING);