2 Copyright (C) 2013-2014 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 <libcxml/cxml.h>
21 #include <dcp/raw_convert.h>
22 #include "subtitle_content.h"
24 #include "exceptions.h"
25 #include "safe_stringstream.h"
34 using boost::shared_ptr;
35 using boost::dynamic_pointer_cast;
36 using dcp::raw_convert;
38 int const SubtitleContentProperty::SUBTITLE_X_OFFSET = 500;
39 int const SubtitleContentProperty::SUBTITLE_Y_OFFSET = 501;
40 int const SubtitleContentProperty::SUBTITLE_X_SCALE = 502;
41 int const SubtitleContentProperty::SUBTITLE_Y_SCALE = 503;
42 int const SubtitleContentProperty::USE_SUBTITLES = 504;
43 int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 505;
44 int const SubtitleContentProperty::FONTS = 506;
46 SubtitleContent::SubtitleContent (shared_ptr<const Film> f)
48 , _use_subtitles (false)
49 , _subtitle_x_offset (0)
50 , _subtitle_y_offset (0)
51 , _subtitle_x_scale (1)
52 , _subtitle_y_scale (1)
57 SubtitleContent::SubtitleContent (shared_ptr<const Film> f, boost::filesystem::path p)
59 , _use_subtitles (false)
60 , _subtitle_x_offset (0)
61 , _subtitle_y_offset (0)
62 , _subtitle_x_scale (1)
63 , _subtitle_y_scale (1)
68 SubtitleContent::SubtitleContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
70 , _use_subtitles (false)
71 , _subtitle_x_offset (0)
72 , _subtitle_y_offset (0)
73 , _subtitle_x_scale (1)
74 , _subtitle_y_scale (1)
77 _use_subtitles = node->bool_child ("UseSubtitles");
79 _use_subtitles = false;
83 _subtitle_x_offset = node->number_child<float> ("SubtitleXOffset");
84 _subtitle_y_offset = node->number_child<float> ("SubtitleYOffset");
86 _subtitle_y_offset = node->number_child<float> ("SubtitleOffset");
90 _subtitle_x_scale = node->number_child<float> ("SubtitleXScale");
91 _subtitle_y_scale = node->number_child<float> ("SubtitleYScale");
93 _subtitle_x_scale = _subtitle_y_scale = node->number_child<float> ("SubtitleScale");
96 _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
98 list<cxml::NodePtr> fonts = node->node_children ("Font");
99 for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
100 _fonts.push_back (shared_ptr<Font> (new Font (*i)));
104 SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
107 shared_ptr<SubtitleContent> ref = dynamic_pointer_cast<SubtitleContent> (c[0]);
109 list<shared_ptr<Font> > ref_fonts = ref->fonts ();
111 for (size_t i = 0; i < c.size(); ++i) {
112 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c[i]);
114 if (sc->use_subtitles() != ref->use_subtitles()) {
115 throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
118 if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) {
119 throw JoinError (_("Content to be joined must have the same subtitle X offset."));
122 if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) {
123 throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
126 if (sc->subtitle_x_scale() != ref->subtitle_x_scale()) {
127 throw JoinError (_("Content to be joined must have the same subtitle X scale."));
130 if (sc->subtitle_y_scale() != ref->subtitle_y_scale()) {
131 throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
134 list<shared_ptr<Font> > fonts = sc->fonts ();
135 if (fonts.size() != ref_fonts.size()) {
136 throw JoinError (_("Content to be joined must use the same fonts."));
139 list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
140 list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
142 while (j != ref_fonts.end ()) {
144 throw JoinError (_("Content to be joined must use the same fonts."));
151 _use_subtitles = ref->use_subtitles ();
152 _subtitle_x_offset = ref->subtitle_x_offset ();
153 _subtitle_y_offset = ref->subtitle_y_offset ();
154 _subtitle_x_scale = ref->subtitle_x_scale ();
155 _subtitle_y_scale = ref->subtitle_y_scale ();
156 _subtitle_language = ref->subtitle_language ();
160 /** _mutex must not be held on entry */
162 SubtitleContent::as_xml (xmlpp::Node* root) const
164 boost::mutex::scoped_lock lm (_mutex);
166 root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use_subtitles));
167 root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_subtitle_x_offset));
168 root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_subtitle_y_offset));
169 root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_subtitle_x_scale));
170 root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_subtitle_y_scale));
171 root->add_child("SubtitleLanguage")->add_child_text (_subtitle_language);
173 for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
174 (*i)->as_xml (root->add_child("Font"));
179 SubtitleContent::set_use_subtitles (bool u)
182 boost::mutex::scoped_lock lm (_mutex);
185 signal_changed (SubtitleContentProperty::USE_SUBTITLES);
189 SubtitleContent::set_subtitle_x_offset (double o)
192 boost::mutex::scoped_lock lm (_mutex);
193 _subtitle_x_offset = o;
195 signal_changed (SubtitleContentProperty::SUBTITLE_X_OFFSET);
199 SubtitleContent::set_subtitle_y_offset (double o)
202 boost::mutex::scoped_lock lm (_mutex);
203 _subtitle_y_offset = o;
205 signal_changed (SubtitleContentProperty::SUBTITLE_Y_OFFSET);
209 SubtitleContent::set_subtitle_x_scale (double s)
212 boost::mutex::scoped_lock lm (_mutex);
213 _subtitle_x_scale = s;
215 signal_changed (SubtitleContentProperty::SUBTITLE_X_SCALE);
219 SubtitleContent::set_subtitle_y_scale (double s)
222 boost::mutex::scoped_lock lm (_mutex);
223 _subtitle_y_scale = s;
225 signal_changed (SubtitleContentProperty::SUBTITLE_Y_SCALE);
229 SubtitleContent::set_subtitle_language (string language)
232 boost::mutex::scoped_lock lm (_mutex);
233 _subtitle_language = language;
235 signal_changed (SubtitleContentProperty::SUBTITLE_LANGUAGE);
239 SubtitleContent::identifier () const
242 s << Content::identifier()
243 << "_" << raw_convert<string> (subtitle_x_scale())
244 << "_" << raw_convert<string> (subtitle_y_scale())
245 << "_" << raw_convert<string> (subtitle_x_offset())
246 << "_" << raw_convert<string> (subtitle_y_offset());
248 /* The language is for metadata only, and doesn't affect
249 how this content looks.