2 Copyright (C) 2012-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 "interop_subtitle_content.h"
21 #include "interop_load_font.h"
23 #include "raw_convert.h"
28 using boost::shared_ptr;
29 using boost::optional;
30 using boost::dynamic_pointer_cast;
33 InteropSubtitleContent::InteropSubtitleContent (boost::filesystem::path file)
34 : SubtitleContent (file)
36 shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));
37 xml->read_file (file);
38 _id = xml->string_child ("SubtitleID");
40 _movie_title = xml->string_child ("MovieTitle");
42 _load_font_nodes = type_children<dcp::InteropLoadFont> (xml, "LoadFont");
43 list<shared_ptr<dcp::Font> > font_nodes = type_children<dcp::Font> (xml, "Font");
45 parse_common (xml, font_nodes);
48 InteropSubtitleContent::InteropSubtitleContent (string movie_title, string language)
49 : _movie_title (movie_title)
54 struct SubtitleSorter {
55 bool operator() (SubtitleString const & a, SubtitleString const & b) {
56 if (a.in() != b.in()) {
57 return a.in() < b.in();
59 return a.v_position() < b.v_position();
64 InteropSubtitleContent::xml_as_string () const
67 xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
68 root->set_attribute ("Version", "1.0");
70 root->add_child("SubtitleID")->add_child_text (_id);
71 root->add_child("MovieTitle")->add_child_text (_movie_title);
72 root->add_child("ReelNumber")->add_child_text (raw_convert<string> (_reel_number));
73 root->add_child("Language")->add_child_text (_language);
75 for (list<shared_ptr<InteropLoadFont> >::const_iterator i = _load_font_nodes.begin(); i != _load_font_nodes.end(); ++i) {
76 xmlpp::Element* load_font = root->add_child("LoadFont");
77 load_font->set_attribute ("Id", (*i)->id);
78 load_font->set_attribute ("URI", (*i)->uri);
81 list<SubtitleString> sorted = _subtitles;
82 sorted.sort (SubtitleSorter ());
84 /* XXX: script, underlined, weight not supported */
86 optional<string> font;
95 Time last_fade_up_time;
96 Time last_fade_down_time;
98 xmlpp::Element* font_element = 0;
99 xmlpp::Element* subtitle_element = 0;
101 for (list<SubtitleString>::iterator i = sorted.begin(); i != sorted.end(); ++i) {
103 /* We will start a new <Font>...</Font> whenever some font property changes.
104 I suppose we should really make an optimal hierarchy of <Font> tags, but
108 bool const font_changed =
110 italic != i->italic() ||
111 colour != i->colour() ||
113 effect != i->effect() ||
114 effect_colour != i->effect_colour();
118 italic = i->italic ();
119 colour = i->colour ();
121 effect = i->effect ();
122 effect_colour = i->effect_colour ();
125 if (!font_element || font_changed) {
126 font_element = root->add_child ("Font");
128 font_element->set_attribute ("Id", font.get ());
130 font_element->set_attribute ("Italic", italic ? "yes" : "no");
131 font_element->set_attribute ("Color", colour.to_argb_string());
132 font_element->set_attribute ("Size", raw_convert<string> (size));
133 font_element->set_attribute ("Effect", effect_to_string (effect));
134 font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
135 font_element->set_attribute ("Script", "normal");
136 font_element->set_attribute ("Underlined", "no");
137 font_element->set_attribute ("Weight", "normal");
140 if (!subtitle_element || font_changed ||
141 (last_in != i->in() ||
142 last_out != i->out() ||
143 last_fade_up_time != i->fade_up_time() ||
144 last_fade_down_time != i->fade_down_time()
147 subtitle_element = font_element->add_child ("Subtitle");
148 subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
149 subtitle_element->set_attribute ("TimeIn", i->in().to_string());
150 subtitle_element->set_attribute ("TimeOut", i->out().to_string());
151 subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i->fade_up_time().to_ticks()));
152 subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i->fade_down_time().to_ticks()));
155 last_out = i->out ();
156 last_fade_up_time = i->fade_up_time ();
157 last_fade_down_time = i->fade_down_time ();
160 xmlpp::Element* text = subtitle_element->add_child ("Text");
161 text->set_attribute ("VAlign", valign_to_string (i->v_align()));
162 text->set_attribute ("VPosition", raw_convert<string> (i->v_position()));
163 text->add_child_text (i->text());
166 return doc.write_to_string_formatted ("UTF-8");
170 InteropSubtitleContent::add_font (string id, string uri)
172 _load_font_nodes.push_back (shared_ptr<InteropLoadFont> (new InteropLoadFont (id, uri)));
176 InteropSubtitleContent::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
178 if (!SubtitleContent::equals (other_asset, options, note)) {
182 shared_ptr<const InteropSubtitleContent> other = dynamic_pointer_cast<const InteropSubtitleContent> (other_asset);
187 list<shared_ptr<InteropLoadFont> >::const_iterator i = _load_font_nodes.begin ();
188 list<shared_ptr<InteropLoadFont> >::const_iterator j = other->_load_font_nodes.begin ();
190 while (i != _load_font_nodes.end ()) {
191 if (j == _load_font_nodes.end ()) {
192 note (DCP_ERROR, "<LoadFont> nodes differ");
197 note (DCP_ERROR, "<LoadFont> nodes differ");
205 if (_movie_title != other->_movie_title) {
206 note (DCP_ERROR, "Subtitle movie titles differ");
213 list<shared_ptr<LoadFont> >
214 InteropSubtitleContent::load_font_nodes () const
216 list<shared_ptr<LoadFont> > lf;
217 copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));