2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "subtitle_content.h"
22 #include "exceptions.h"
23 #include "safe_stringstream.h"
25 #include "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;
41 int const SubtitleContentProperty::SUBTITLE_X_OFFSET = 500;
42 int const SubtitleContentProperty::SUBTITLE_Y_OFFSET = 501;
43 int const SubtitleContentProperty::SUBTITLE_X_SCALE = 502;
44 int const SubtitleContentProperty::SUBTITLE_Y_SCALE = 503;
45 int const SubtitleContentProperty::USE_SUBTITLES = 504;
46 int const SubtitleContentProperty::BURN_SUBTITLES = 505;
47 int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 506;
48 int const SubtitleContentProperty::FONTS = 507;
49 int const SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE = 508;
50 int const SubtitleContentProperty::SUBTITLE_COLOUR = 509;
51 int const SubtitleContentProperty::SUBTITLE_OUTLINE = 510;
52 int const SubtitleContentProperty::SUBTITLE_OUTLINE_COLOUR = 511;
54 SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film)
55 : ContentPart (parent, film)
56 , _use_subtitles (false)
57 , _burn_subtitles (false)
58 , _subtitle_x_offset (0)
59 , _subtitle_y_offset (0)
60 , _subtitle_x_scale (1)
61 , _subtitle_y_scale (1)
62 , _colour (255, 255, 255)
64 , _outline_colour (0, 0, 0)
69 SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
70 : ContentPart (parent, film)
71 , _use_subtitles (false)
72 , _burn_subtitles (false)
73 , _subtitle_x_offset (0)
74 , _subtitle_y_offset (0)
75 , _subtitle_x_scale (1)
76 , _subtitle_y_scale (1)
78 node->optional_number_child<int>("Red").get_value_or(255),
79 node->optional_number_child<int>("Green").get_value_or(255),
80 node->optional_number_child<int>("Blue").get_value_or(255)
82 , _outline (node->optional_bool_child("Outline").get_value_or(false))
84 node->optional_number_child<int>("OutlineRed").get_value_or(255),
85 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
86 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
90 _use_subtitles = node->bool_child ("UseSubtitles");
91 _burn_subtitles = node->bool_child ("BurnSubtitles");
95 _subtitle_x_offset = node->number_child<double> ("SubtitleXOffset");
96 _subtitle_y_offset = node->number_child<double> ("SubtitleYOffset");
98 _subtitle_y_offset = node->number_child<double> ("SubtitleOffset");
102 _subtitle_x_scale = node->number_child<double> ("SubtitleXScale");
103 _subtitle_y_scale = node->number_child<double> ("SubtitleYScale");
105 _subtitle_x_scale = _subtitle_y_scale = node->number_child<double> ("SubtitleScale");
108 _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
110 list<cxml::NodePtr> fonts = node->node_children ("Font");
111 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
112 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
118 SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
119 : ContentPart (parent, film)
121 shared_ptr<SubtitleContent> ref = dynamic_pointer_cast<SubtitleContent> (c[0]);
122 DCPOMATIC_ASSERT (ref);
123 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
125 for (size_t i = 0; i < c.size(); ++i) {
126 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c[i]);
128 if (sc->use_subtitles() != ref->use_subtitles()) {
129 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
132 if (sc->burn_subtitles() != ref->burn_subtitles()) {
133 throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
136 if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) {
137 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
140 if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) {
141 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
144 if (sc->subtitle_x_scale() != ref->subtitle_x_scale()) {
145 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
148 if (sc->subtitle_y_scale() != ref->subtitle_y_scale()) {
149 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
152 list<shared_ptr<Font> > fonts = sc->fonts ();
153 if (fonts.size() != ref_fonts.size()) {
154 throw JoinError (_("Content to be joined must use the same fonts."));
157 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
158 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
160 while (j != ref_fonts.end ()) {
162 throw JoinError (_("Content to be joined must use the same fonts."));
169 _use_subtitles = ref->use_subtitles ();
170 _burn_subtitles = ref->burn_subtitles ();
171 _subtitle_x_offset = ref->subtitle_x_offset ();
172 _subtitle_y_offset = ref->subtitle_y_offset ();
173 _subtitle_x_scale = ref->subtitle_x_scale ();
174 _subtitle_y_scale = ref->subtitle_y_scale ();
175 _subtitle_language = ref->subtitle_language ();
181 /** _mutex must not be held on entry */
183 SubtitleContent::as_xml (xmlpp::Node* root) const
185 boost::mutex::scoped_lock lm (_mutex);
187 root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use_subtitles));
188 root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn_subtitles));
189 root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_subtitle_x_offset));
190 root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_subtitle_y_offset));
191 root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_subtitle_x_scale));
192 root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_subtitle_y_scale));
193 root->add_child("SubtitleLanguage")->add_child_text (_subtitle_language);
194 root->add_child("Red")->add_child_text (raw_convert<string> (_colour.r));
195 root->add_child("Green")->add_child_text (raw_convert<string> (_colour.g));
196 root->add_child("Blue")->add_child_text (raw_convert<string> (_colour.b));
197 root->add_child("Outline")->add_child_text (raw_convert<string> (_outline));
198 root->add_child("OutlineRed")->add_child_text (raw_convert<string> (_outline_colour.r));
199 root->add_child("OutlineGreen")->add_child_text (raw_convert<string> (_outline_colour.g));
200 root->add_child("OutlineBlue")->add_child_text (raw_convert<string> (_outline_colour.b));
202 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
203 (*i)->as_xml (root->add_child("Font"));
208 SubtitleContent::identifier () const
211 s << raw_convert<string> (subtitle_x_scale())
212 << "_" << raw_convert<string> (subtitle_y_scale())
213 << "_" << raw_convert<string> (subtitle_x_offset())
214 << "_" << raw_convert<string> (subtitle_y_offset());
216 /* XXX: I suppose really _fonts shouldn't be in here, since not all
217 types of subtitle content involve fonts.
219 BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
220 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
221 s << "_" << f->file(static_cast<FontFiles::Variant>(i)).get_value_or ("Default");
225 /* The language is for metadata only, and doesn't affect
226 how this content looks.
233 SubtitleContent::add_font (shared_ptr<Font> font)
235 _fonts.push_back (font);
240 SubtitleContent::connect_to_fonts ()
242 BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
246 _font_connections.clear ();
248 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
249 _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this)));
254 SubtitleContent::font_changed ()
256 _parent->signal_changed (SubtitleContentProperty::FONTS);
260 SubtitleContent::set_colour (dcp::Colour colour)
262 maybe_set (_colour, colour, SubtitleContentProperty::SUBTITLE_COLOUR);
266 SubtitleContent::set_outline (bool o)
268 maybe_set (_outline, o, SubtitleContentProperty::SUBTITLE_OUTLINE);
272 SubtitleContent::set_outline_colour (dcp::Colour colour)
274 maybe_set (_outline_colour, colour, SubtitleContentProperty::SUBTITLE_OUTLINE_COLOUR);
278 SubtitleContent::set_use_subtitles (bool u)
280 maybe_set (_use_subtitles, u, SubtitleContentProperty::USE_SUBTITLES);
284 SubtitleContent::set_burn_subtitles (bool b)
286 maybe_set (_burn_subtitles, b, SubtitleContentProperty::BURN_SUBTITLES);
290 SubtitleContent::set_subtitle_x_offset (double o)
292 maybe_set (_subtitle_x_offset, o, SubtitleContentProperty::SUBTITLE_X_OFFSET);
296 SubtitleContent::set_subtitle_y_offset (double o)
298 maybe_set (_subtitle_y_offset, o, SubtitleContentProperty::SUBTITLE_Y_OFFSET);
302 SubtitleContent::set_subtitle_x_scale (double s)
304 maybe_set (_subtitle_x_scale, s, SubtitleContentProperty::SUBTITLE_X_SCALE);
308 SubtitleContent::set_subtitle_y_scale (double s)
310 maybe_set (_subtitle_y_scale, s, SubtitleContentProperty::SUBTITLE_Y_SCALE);
314 SubtitleContent::set_subtitle_language (string language)
316 maybe_set (_subtitle_language, language, SubtitleContentProperty::SUBTITLE_LANGUAGE);