2 Copyright (C) 2012-2015 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 "raw_convert.h"
21 #include "subtitle_asset.h"
24 #include "font_node.h"
25 #include "text_node.h"
26 #include "subtitle_string.h"
27 #include "dcp_assert.h"
30 #include <libxml++/nodes/element.h>
31 #include <boost/algorithm/string.hpp>
32 #include <boost/shared_array.hpp>
33 #include <boost/foreach.hpp>
40 using std::stringstream;
44 using boost::shared_ptr;
45 using boost::shared_array;
46 using boost::optional;
47 using boost::dynamic_pointer_cast;
50 SubtitleAsset::SubtitleAsset ()
55 SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
62 SubtitleAsset::parse_subtitles (shared_ptr<cxml::Document> xml, list<shared_ptr<dcp::FontNode> > font_nodes)
64 /* Make Subtitle objects to represent the raw XML nodes in a sane way */
65 ParseState parse_state;
66 examine_font_nodes (xml, font_nodes, parse_state);
70 SubtitleAsset::examine_font_nodes (
71 shared_ptr<const cxml::Node> xml,
72 list<shared_ptr<dcp::FontNode> > const & font_nodes,
73 ParseState& parse_state
76 for (list<shared_ptr<dcp::FontNode> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
78 parse_state.font_nodes.push_back (*i);
79 maybe_add_subtitle ((*i)->text, parse_state);
81 for (list<shared_ptr<dcp::SubtitleNode> >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) {
82 parse_state.subtitle_nodes.push_back (*j);
83 examine_text_nodes (xml, (*j)->text_nodes, parse_state);
84 examine_font_nodes (xml, (*j)->font_nodes, parse_state);
85 parse_state.subtitle_nodes.pop_back ();
88 examine_font_nodes (xml, (*i)->font_nodes, parse_state);
89 examine_text_nodes (xml, (*i)->text_nodes, parse_state);
91 parse_state.font_nodes.pop_back ();
96 SubtitleAsset::examine_text_nodes (
97 shared_ptr<const cxml::Node> xml,
98 list<shared_ptr<dcp::TextNode> > const & text_nodes,
99 ParseState& parse_state
102 for (list<shared_ptr<dcp::TextNode> >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) {
103 parse_state.text_nodes.push_back (*i);
104 maybe_add_subtitle ((*i)->text, parse_state);
105 examine_font_nodes (xml, (*i)->font_nodes, parse_state);
106 parse_state.text_nodes.pop_back ();
111 SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
113 if (empty_or_white_space (text)) {
117 if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) {
121 DCP_ASSERT (!parse_state.text_nodes.empty ());
122 DCP_ASSERT (!parse_state.subtitle_nodes.empty ());
124 dcp::FontNode effective_font (parse_state.font_nodes);
125 dcp::TextNode effective_text (*parse_state.text_nodes.back ());
126 dcp::SubtitleNode effective_subtitle (*parse_state.subtitle_nodes.back ());
128 _subtitles.push_back (
131 effective_font.italic.get_value_or (false),
132 effective_font.colour.get_value_or (dcp::Colour (255, 255, 255)),
134 effective_font.aspect_adjust.get_value_or (1.0),
135 effective_subtitle.in,
136 effective_subtitle.out,
137 effective_text.h_position,
138 effective_text.h_align,
139 effective_text.v_position,
140 effective_text.v_align,
142 effective_font.effect.get_value_or (NONE),
143 effective_font.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
144 effective_subtitle.fade_up_time,
145 effective_subtitle.fade_down_time
151 SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const
153 list<SubtitleString> s;
154 for (list<SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
155 if ((starting && from <= i->in() && i->in() < to) || (!starting && i->out() >= from && i->in() <= to)) {
164 SubtitleAsset::add (SubtitleString s)
166 _subtitles.push_back (s);
170 SubtitleAsset::latest_subtitle_out () const
173 for (list<SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
183 SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
185 if (!Asset::equals (other_asset, options, note)) {
189 shared_ptr<const SubtitleAsset> other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
194 if (_subtitles != other->_subtitles) {
195 note (DCP_ERROR, "subtitles differ");
202 struct SubtitleSorter {
203 bool operator() (SubtitleString const & a, SubtitleString const & b) {
204 if (a.in() != b.in()) {
205 return a.in() < b.in();
207 return a.v_position() < b.v_position();
211 /** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
212 * class because the differences between the two are fairly subtle.
215 SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const
217 list<SubtitleString> sorted = _subtitles;
218 sorted.sort (SubtitleSorter ());
220 string const xmlns = standard == SMPTE ? "dcst" : "";
222 /* XXX: script, underlined, weight not supported */
224 optional<string> font;
228 float aspect_adjust = 1.0;
229 Effect effect = NONE;
230 Colour effect_colour;
234 Time last_fade_up_time;
235 Time last_fade_down_time;
237 xmlpp::Element* font_element = 0;
238 xmlpp::Element* subtitle_element = 0;
240 for (list<SubtitleString>::iterator i = sorted.begin(); i != sorted.end(); ++i) {
242 /* We will start a new <Font>...</Font> whenever some font property changes.
243 I suppose we should really make an optimal hierarchy of <Font> tags, but
247 bool const font_changed =
249 italic != i->italic() ||
250 colour != i->colour() ||
252 fabs (aspect_adjust - i->aspect_adjust()) > ASPECT_ADJUST_EPSILON ||
253 effect != i->effect() ||
254 effect_colour != i->effect_colour();
258 italic = i->italic ();
259 colour = i->colour ();
261 aspect_adjust = i->aspect_adjust ();
262 effect = i->effect ();
263 effect_colour = i->effect_colour ();
266 if (!font_element || font_changed) {
267 font_element = root->add_child ("Font", xmlns);
269 if (standard == SMPTE) {
270 font_element->set_attribute ("ID", font.get ());
272 font_element->set_attribute ("Id", font.get ());
275 font_element->set_attribute ("Italic", italic ? "yes" : "no");
276 font_element->set_attribute ("Color", colour.to_argb_string());
277 font_element->set_attribute ("Size", raw_convert<string> (size));
278 if (fabs (aspect_adjust - 1.0) > ASPECT_ADJUST_EPSILON) {
279 font_element->set_attribute ("AspectAdjust", raw_convert<string> (aspect_adjust));
281 font_element->set_attribute ("Effect", effect_to_string (effect));
282 font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
283 font_element->set_attribute ("Script", "normal");
284 if (standard == SMPTE) {
285 font_element->set_attribute ("Underline", "no");
287 font_element->set_attribute ("Underlined", "no");
289 font_element->set_attribute ("Weight", "normal");
292 if (!subtitle_element || font_changed ||
293 (last_in != i->in() ||
294 last_out != i->out() ||
295 last_fade_up_time != i->fade_up_time() ||
296 last_fade_down_time != i->fade_down_time()
299 subtitle_element = font_element->add_child ("Subtitle", xmlns);
300 subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
301 subtitle_element->set_attribute ("TimeIn", i->in().rebase(time_code_rate).as_string(standard));
302 subtitle_element->set_attribute ("TimeOut", i->out().rebase(time_code_rate).as_string(standard));
303 if (standard == SMPTE) {
304 subtitle_element->set_attribute ("FadeUpTime", i->fade_up_time().rebase(time_code_rate).as_string(standard));
305 subtitle_element->set_attribute ("FadeDownTime", i->fade_down_time().rebase(time_code_rate).as_string(standard));
307 subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i->fade_up_time().as_editable_units(time_code_rate)));
308 subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i->fade_down_time().as_editable_units(time_code_rate)));
312 last_out = i->out ();
313 last_fade_up_time = i->fade_up_time ();
314 last_fade_down_time = i->fade_down_time ();
317 xmlpp::Element* text = subtitle_element->add_child ("Text", xmlns);
318 if (i->h_align() != HALIGN_CENTER) {
319 if (standard == SMPTE) {
320 text->set_attribute ("Halign", halign_to_string (i->h_align ()));
322 text->set_attribute ("HAlign", halign_to_string (i->h_align ()));
325 if (i->h_position() > ALIGN_EPSILON) {
326 if (standard == SMPTE) {
327 text->set_attribute ("Hposition", raw_convert<string> (i->h_position() * 100, 6));
329 text->set_attribute ("HPosition", raw_convert<string> (i->h_position() * 100, 6));
332 if (standard == SMPTE) {
333 text->set_attribute ("Valign", valign_to_string (i->v_align()));
335 text->set_attribute ("VAlign", valign_to_string (i->v_align()));
337 if (i->v_position() > ALIGN_EPSILON) {
338 if (standard == SMPTE) {
339 text->set_attribute ("Vposition", raw_convert<string> (i->v_position() * 100, 6));
341 text->set_attribute ("VPosition", raw_convert<string> (i->v_position() * 100, 6));
344 if (standard == SMPTE) {
345 text->set_attribute ("Vposition", "0");
347 text->set_attribute ("VPosition", "0");
350 text->add_child_text (i->text());
355 SubtitleAsset::fonts_with_load_ids () const
357 map<string, Data> out;
358 BOOST_FOREACH (Font const & i, _fonts) {
359 out[i.load_id] = i.data;