2 Copyright (C) 2012 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.
21 #include <boost/lexical_cast.hpp>
22 #include <boost/algorithm/string.hpp>
23 #include <libxml++/nodes/element.h>
24 #include "subtitle_asset.h"
25 #include "parse/subtitle.h"
33 using std::stringstream;
34 using boost::shared_ptr;
35 using boost::lexical_cast;
36 using boost::optional;
39 SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
43 shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));
44 xml->read_file (file);
46 _id = xml->string_child ("SubtitleID");
47 _movie_title = xml->string_child ("MovieTitle");
48 _reel_number = xml->string_child ("ReelNumber");
49 _language = xml->string_child ("Language");
51 xml->ignore_child ("LoadFont");
53 list<shared_ptr<dcp::parse::Font> > font_nodes = type_children<dcp::parse::Font> (xml, "Font");
54 _load_font_nodes = type_children<dcp::parse::LoadFont> (xml, "LoadFont");
56 /* Now make Subtitle objects to represent the raw XML nodes
60 ParseState parse_state;
61 examine_font_nodes (xml, font_nodes, parse_state);
64 SubtitleAsset::SubtitleAsset (string directory, string movie_title, string language)
66 , _movie_title (movie_title)
68 , _language (language)
75 SubtitleAsset::examine_font_nodes (
76 shared_ptr<const cxml::Node> xml,
77 list<shared_ptr<dcp::parse::Font> > const & font_nodes,
78 ParseState& parse_state
81 for (list<shared_ptr<dcp::parse::Font> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
83 parse_state.font_nodes.push_back (*i);
84 maybe_add_subtitle ((*i)->text, parse_state);
86 for (list<shared_ptr<dcp::parse::Subtitle> >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) {
87 parse_state.subtitle_nodes.push_back (*j);
88 examine_text_nodes (xml, (*j)->text_nodes, parse_state);
89 examine_font_nodes (xml, (*j)->font_nodes, parse_state);
90 parse_state.subtitle_nodes.pop_back ();
93 examine_font_nodes (xml, (*i)->font_nodes, parse_state);
94 examine_text_nodes (xml, (*i)->text_nodes, parse_state);
96 parse_state.font_nodes.pop_back ();
101 SubtitleAsset::examine_text_nodes (
102 shared_ptr<const cxml::Node> xml,
103 list<shared_ptr<dcp::parse::Text> > const & text_nodes,
104 ParseState& parse_state
107 for (list<shared_ptr<dcp::parse::Text> >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) {
108 parse_state.text_nodes.push_back (*i);
109 maybe_add_subtitle ((*i)->text, parse_state);
110 examine_font_nodes (xml, (*i)->font_nodes, parse_state);
111 parse_state.text_nodes.pop_back ();
116 SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
118 if (empty_or_white_space (text)) {
122 if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) {
126 assert (!parse_state.text_nodes.empty ());
127 assert (!parse_state.subtitle_nodes.empty ());
129 dcp::parse::Font effective_font (parse_state.font_nodes);
130 dcp::parse::Text effective_text (*parse_state.text_nodes.back ());
131 dcp::parse::Subtitle effective_subtitle (*parse_state.subtitle_nodes.back ());
133 _subtitles.push_back (
134 shared_ptr<Subtitle> (
136 font_id_to_name (effective_font.id),
137 effective_font.italic.get(),
138 effective_font.color.get(),
140 effective_subtitle.in,
141 effective_subtitle.out,
142 effective_text.v_position,
143 effective_text.v_align,
145 effective_font.effect ? effective_font.effect.get() : NONE,
146 effective_font.effect_color.get(),
147 effective_subtitle.fade_up_time,
148 effective_subtitle.fade_down_time
154 list<shared_ptr<Subtitle> >
155 SubtitleAsset::subtitles_at (Time t) const
157 list<shared_ptr<Subtitle> > s;
158 for (list<shared_ptr<Subtitle> >::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
159 if ((*i)->in() <= t && t <= (*i)->out ()) {
168 SubtitleAsset::font_id_to_name (string id) const
170 list<shared_ptr<dcp::parse::LoadFont> >::const_iterator i = _load_font_nodes.begin();
171 while (i != _load_font_nodes.end() && (*i)->id != id) {
175 if (i == _load_font_nodes.end ()) {
179 if ((*i)->uri == "arial.ttf") {
207 , _v_position (v_position)
211 , _effect_color (effect_color)
212 , _fade_up_time (fade_up_time)
213 , _fade_down_time (fade_down_time)
219 Subtitle::size_in_pixels (int screen_height) const
221 /* Size in the subtitle file is given in points as if the screen
222 height is 11 inches, so a 72pt font would be 1/11th of the screen
226 return _size * screen_height / (11 * 72);
230 dcp::operator== (Subtitle const & a, Subtitle const & b)
233 a.font() == b.font() &&
234 a.italic() == b.italic() &&
235 a.color() == b.color() &&
236 a.size() == b.size() &&
238 a.out() == b.out() &&
239 a.v_position() == b.v_position() &&
240 a.v_align() == b.v_align() &&
241 a.text() == b.text() &&
242 a.effect() == b.effect() &&
243 a.effect_color() == b.effect_color() &&
244 a.fade_up_time() == b.fade_up_time() &&
245 a.fade_down_time() == b.fade_down_time()
250 dcp::operator<< (ostream& s, Subtitle const & sub)
252 s << "\n`" << sub.text() << "' from " << sub.in() << " to " << sub.out() << ";\n"
253 << "fade up " << sub.fade_up_time() << ", fade down " << sub.fade_down_time() << ";\n"
254 << "font " << sub.font() << ", ";
262 s << ", size " << sub.size() << ", color " << sub.color() << ", vpos " << sub.v_position() << ", valign " << ((int) sub.v_align()) << ";\n"
263 << "effect " << ((int) sub.effect()) << ", effect color " << sub.effect_color();
269 SubtitleAsset::add (shared_ptr<Subtitle> s)
271 _subtitles.push_back (s);
276 SubtitleAsset::write_to_cpl (xmlpp::Element* node) const
278 /* XXX: should EditRate, Duration and IntrinsicDuration be in here? */
280 xmlpp::Node* ms = node->add_child ("MainSubtitle");
281 ms->add_child("Id")->add_child_text("urn:uuid:" + _id);
282 ms->add_child("AnnotationText")->add_child_text (_file.string ());
284 ms->add_child("EntryPoint")->add_child_text ("0");
287 struct SubtitleSorter {
288 bool operator() (shared_ptr<Subtitle> a, shared_ptr<Subtitle> b) {
289 if (a->in() != b->in()) {
290 return a->in() < b->in();
292 return a->v_position() < b->v_position();
297 SubtitleAsset::write_xml () const
299 FILE* f = fopen_boost (file (), "r");
300 Glib::ustring const s = xml_as_string ();
301 fwrite (s.c_str(), 1, s.length(), f);
306 SubtitleAsset::xml_as_string () const
309 xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
310 root->set_attribute ("Version", "1.0");
312 root->add_child("SubtitleID")->add_child_text (_id);
313 root->add_child("MovieTitle")->add_child_text (_movie_title);
314 root->add_child("ReelNumber")->add_child_text (lexical_cast<string> (_reel_number));
315 root->add_child("Language")->add_child_text (_language);
317 if (_load_font_nodes.size() > 1) {
318 boost::throw_exception (MiscError ("multiple LoadFont nodes not supported"));
321 if (!_load_font_nodes.empty ()) {
322 xmlpp::Element* load_font = root->add_child("LoadFont");
323 load_font->set_attribute("Id", _load_font_nodes.front()->id);
324 load_font->set_attribute("URI", _load_font_nodes.front()->uri);
327 list<shared_ptr<Subtitle> > sorted = _subtitles;
329 sorted.sort (SubtitleSorter ());
332 /* XXX: multiple fonts not supported */
333 /* XXX: script, underlined, weight not supported */
338 Effect effect = NONE;
343 Time last_fade_up_time;
344 Time last_fade_down_time;
346 xmlpp::Element* font = 0;
347 xmlpp::Element* subtitle = 0;
349 for (list<shared_ptr<Subtitle> >::iterator i = sorted.begin(); i != sorted.end(); ++i) {
351 /* We will start a new <Font>...</Font> whenever some font property changes.
352 I suppose we should really make an optimal hierarchy of <Font> tags, but
356 bool const font_changed =
357 italic != (*i)->italic() ||
358 color != (*i)->color() ||
359 size != (*i)->size() ||
360 effect != (*i)->effect() ||
361 effect_color != (*i)->effect_color();
364 italic = (*i)->italic ();
365 color = (*i)->color ();
366 size = (*i)->size ();
367 effect = (*i)->effect ();
368 effect_color = (*i)->effect_color ();
371 if (!font || font_changed) {
372 font = root->add_child ("Font");
373 string id = "theFontId";
374 if (!_load_font_nodes.empty()) {
375 id = _load_font_nodes.front()->id;
377 font->set_attribute ("Id", id);
378 font->set_attribute ("Italic", italic ? "yes" : "no");
379 font->set_attribute ("Color", color.to_argb_string());
380 font->set_attribute ("Size", lexical_cast<string> (size));
381 font->set_attribute ("Effect", effect_to_string (effect));
382 font->set_attribute ("EffectColor", effect_color.to_argb_string());
383 font->set_attribute ("Script", "normal");
384 font->set_attribute ("Underlined", "no");
385 font->set_attribute ("Weight", "normal");
388 if (!subtitle || font_changed ||
389 (last_in != (*i)->in() ||
390 last_out != (*i)->out() ||
391 last_fade_up_time != (*i)->fade_up_time() ||
392 last_fade_down_time != (*i)->fade_down_time()
395 subtitle = font->add_child ("Subtitle");
396 subtitle->set_attribute ("SpotNumber", lexical_cast<string> (spot_number++));
397 subtitle->set_attribute ("TimeIn", (*i)->in().to_string());
398 subtitle->set_attribute ("TimeOut", (*i)->out().to_string());
399 subtitle->set_attribute ("FadeUpTime", lexical_cast<string> ((*i)->fade_up_time().to_ticks()));
400 subtitle->set_attribute ("FadeDownTime", lexical_cast<string> ((*i)->fade_down_time().to_ticks()));
402 last_in = (*i)->in ();
403 last_out = (*i)->out ();
404 last_fade_up_time = (*i)->fade_up_time ();
405 last_fade_down_time = (*i)->fade_down_time ();
408 xmlpp::Element* text = subtitle->add_child ("Text");
409 text->set_attribute ("VAlign", valign_to_string ((*i)->v_align()));
410 text->set_attribute ("VPosition", lexical_cast<string> ((*i)->v_position()));
411 text->add_child_text ((*i)->text());
414 return doc.write_to_string_formatted ("UTF-8");