*/
+#include <fstream>
#include <boost/lexical_cast.hpp>
+#include <boost/algorithm/string.hpp>
#include "subtitle_asset.h"
-
-using namespace std;
-using namespace boost;
+#include "util.h"
+
+using std::string;
+using std::list;
+using std::ostream;
+using std::ofstream;
+using std::stringstream;
+using boost::shared_ptr;
+using boost::lexical_cast;
using namespace libdcp;
-SubtitleAsset::SubtitleAsset (string directory, string xml)
- : Asset (directory, xml)
- , XMLFile (path().string(), "DCSubtitle")
+SubtitleAsset::SubtitleAsset (string directory, string xml_file)
+ : Asset (directory, xml_file)
+ , _need_sort (false)
{
- _subtitle_id = string_node ("SubtitleID");
- _movie_title = string_node ("MovieTitle");
- _reel_number = int64_node ("ReelNumber");
- _language = string_node ("Language");
+ read_xml (path().string());
+}
- ignore_node ("LoadFont");
+SubtitleAsset::SubtitleAsset (string directory, string movie_title, string language)
+ : Asset (directory)
+ , _movie_title (movie_title)
+ , _reel_number ("1")
+ , _language (language)
+ , _need_sort (false)
+{
+
+}
+
+void
+SubtitleAsset::read_xml (string xml_file)
+{
+ shared_ptr<XMLFile> xml (new XMLFile (xml_file, "DCSubtitle"));
+
+ _uuid = xml->string_child ("SubtitleID");
+ _movie_title = xml->string_child ("MovieTitle");
+ _reel_number = xml->string_child ("ReelNumber");
+ _language = xml->string_child ("Language");
- list<shared_ptr<FontNode> > font_nodes = sub_nodes<FontNode> ("Font");
- _load_font_nodes = sub_nodes<LoadFontNode> ("LoadFont");
+ xml->ignore_child ("LoadFont");
+
+ list<shared_ptr<FontNode> > font_nodes = xml->type_children<FontNode> ("Font");
+ _load_font_nodes = xml->type_children<LoadFontNode> ("LoadFont");
/* Now make Subtitle objects to represent the raw XML nodes
in a sane way.
*/
- list<shared_ptr<FontNode> > current_font_nodes;
- list<shared_ptr<SubtitleNode> > current_subtitle_nodes;
- current_subtitle_nodes.push_back (shared_ptr<SubtitleNode> ());
- examine_font_nodes (font_nodes, current_font_nodes, current_subtitle_nodes);
+ ParseState parse_state;
+ examine_font_nodes (xml, font_nodes, parse_state);
}
void
SubtitleAsset::examine_font_nodes (
+ shared_ptr<XMLFile> xml,
list<shared_ptr<FontNode> > const & font_nodes,
- list<shared_ptr<FontNode> >& current_font_nodes,
- list<shared_ptr<SubtitleNode> >& current_subtitle_nodes
+ ParseState& parse_state
)
{
for (list<shared_ptr<FontNode> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
-
- current_font_nodes.push_back (*i);
+
+ parse_state.font_nodes.push_back (*i);
+ maybe_add_subtitle ((*i)->text, parse_state);
for (list<shared_ptr<SubtitleNode> >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) {
- current_subtitle_nodes.push_back (*j);
- examine_text_nodes (*j, (*j)->text_nodes, current_font_nodes);
- examine_font_nodes ((*j)->font_nodes, current_font_nodes, current_subtitle_nodes);
- current_subtitle_nodes.pop_back ();
+ parse_state.subtitle_nodes.push_back (*j);
+ examine_text_nodes (xml, (*j)->text_nodes, parse_state);
+ examine_font_nodes (xml, (*j)->font_nodes, parse_state);
+ parse_state.subtitle_nodes.pop_back ();
}
- examine_font_nodes ((*i)->font_nodes, current_font_nodes, current_subtitle_nodes);
- examine_text_nodes (current_subtitle_nodes.back (), (*i)->text_nodes, current_font_nodes);
+ examine_font_nodes (xml, (*i)->font_nodes, parse_state);
+ examine_text_nodes (xml, (*i)->text_nodes, parse_state);
- current_font_nodes.pop_back ();
+ parse_state.font_nodes.pop_back ();
}
}
void
SubtitleAsset::examine_text_nodes (
- shared_ptr<SubtitleNode> subtitle_node,
+ shared_ptr<XMLFile> xml,
list<shared_ptr<TextNode> > const & text_nodes,
- list<shared_ptr<FontNode> >& current_font_nodes
+ ParseState& parse_state
)
{
for (list<shared_ptr<TextNode> >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) {
- FontNode effective (current_font_nodes);
- _subtitles.push_back (
- shared_ptr<Subtitle> (
- new Subtitle (
- font_id_to_name (effective.id),
- effective.italic.get(),
- effective.color.get(),
- effective.size,
- subtitle_node->in,
- subtitle_node->out,
- (*i)->v_position,
- (*i)->v_align,
- (*i)->text,
- effective.effect.get(),
- effective.effect_color.get(),
- subtitle_node->fade_up_time,
- subtitle_node->fade_down_time
- )
- )
- );
+ parse_state.text_nodes.push_back (*i);
+ maybe_add_subtitle ((*i)->text, parse_state);
+ examine_font_nodes (xml, (*i)->font_nodes, parse_state);
+ parse_state.text_nodes.pop_back ();
}
}
+void
+SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
+{
+ if (empty_or_white_space (text)) {
+ return;
+ }
+
+ if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) {
+ return;
+ }
+
+ assert (!parse_state.text_nodes.empty ());
+ assert (!parse_state.subtitle_nodes.empty ());
+
+ FontNode effective_font (parse_state.font_nodes);
+ TextNode effective_text (*parse_state.text_nodes.back ());
+ SubtitleNode effective_subtitle (*parse_state.subtitle_nodes.back ());
+
+ _subtitles.push_back (
+ shared_ptr<Subtitle> (
+ new Subtitle (
+ font_id_to_name (effective_font.id),
+ effective_font.italic.get(),
+ effective_font.color.get(),
+ effective_font.size,
+ effective_subtitle.in,
+ effective_subtitle.out,
+ effective_text.v_position,
+ effective_text.v_align,
+ text,
+ effective_font.effect ? effective_font.effect.get() : NONE,
+ effective_font.effect_color.get(),
+ effective_subtitle.fade_up_time,
+ effective_subtitle.fade_down_time
+ )
+ )
+ );
+}
+
FontNode::FontNode (xmlpp::Node const * node)
: XMLNode (node)
{
+ text = content ();
+
id = optional_string_attribute ("Id");
size = optional_int64_attribute ("Size");
italic = optional_bool_attribute ("Italic");
color = optional_color_attribute ("Color");
string const e = optional_string_attribute ("Effect");
- if (e == "none") {
- effect = NONE;
- } else if (e == "border") {
- effect = BORDER;
- } else if (e == "shadow") {
- effect = SHADOW;
- } else if (!e.empty ()) {
- throw DCPReadError ("unknown subtitle effect type");
+ if (!e.empty ()) {
+ effect = string_to_effect (e);
}
effect_color = optional_color_attribute ("EffectColor");
- subtitle_nodes = sub_nodes<SubtitleNode> ("Subtitle");
- font_nodes = sub_nodes<FontNode> ("Font");
- text_nodes = sub_nodes<TextNode> ("Text");
+ subtitle_nodes = type_children<SubtitleNode> ("Subtitle");
+ font_nodes = type_children<FontNode> ("Font");
+ text_nodes = type_children<TextNode> ("Text");
}
FontNode::FontNode (list<shared_ptr<FontNode> > const & font_nodes)
{
in = time_attribute ("TimeIn");
out = time_attribute ("TimeOut");
- font_nodes = sub_nodes<FontNode> ("Font");
- text_nodes = sub_nodes<TextNode> ("Text");
+ font_nodes = type_children<FontNode> ("Font");
+ text_nodes = type_children<TextNode> ("Text");
fade_up_time = fade_time ("FadeUpTime");
fade_down_time = fade_time ("FadeDownTime");
}
text = content ();
v_position = float_attribute ("VPosition");
string const v = optional_string_attribute ("VAlign");
- if (v == "top") {
- v_align = TOP;
- } else if (v == "center") {
- v_align = CENTER;
- } else if (v == "bottom") {
- v_align = BOTTOM;
+ if (!v.empty ()) {
+ v_align = string_to_valign (v);
}
-}
+ font_nodes = type_children<FontNode> ("Font");
+}
list<shared_ptr<Subtitle> >
SubtitleAsset::subtitles_at (Time t) const
return s;
}
+
+void
+SubtitleAsset::add (shared_ptr<Subtitle> s)
+{
+ _subtitles.push_back (s);
+ _need_sort = true;
+}
+
+void
+SubtitleAsset::write_to_cpl (ostream& s) const
+{
+ /* XXX: should EditRate, Duration and IntrinsicDuration be in here? */
+
+ s << " <MainSubtitle>\n"
+ << " <Id>urn:uuid:" << _uuid << "</Id>\n"
+ << " <AnnotationText>" << _file_name << "</AnnotationText>\n"
+ << " <EntryPoint>0</EntryPoint>\n"
+ << " </MainSubtitle>\n";
+}
+
+struct SubtitleSorter {
+ bool operator() (shared_ptr<Subtitle> a, shared_ptr<Subtitle> b) {
+ if (a->in() != b->in()) {
+ return a->in() < b->in();
+ }
+ return a->v_position() < b->v_position();
+ }
+};
+
+void
+SubtitleAsset::write_xml () const
+{
+ ofstream f (path().string().c_str());
+ write_xml (f);
+}
+
+void
+SubtitleAsset::write_xml (ostream& s) const
+{
+ s << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+ << "<DCSubtitle Version=\"1.0\">\n"
+ << " <SubtitleID>" << _uuid << "</SubtitleID>\n"
+ << " <MovieTitle>" << _movie_title << "</MovieTitle>\n"
+ << " <ReelNumber>" << _reel_number << "</ReelNumber>\n"
+ << " <Language>" << _language << "</Language>\n";
+
+ if (_load_font_nodes.size() > 1) {
+ boost::throw_exception (MiscError ("multiple LoadFont nodes not supported"));
+ }
+
+ if (!_load_font_nodes.empty ()) {
+ s << " <LoadFont Id=\"" << _load_font_nodes.front()->id << "\" URI=\"" << _load_font_nodes.front()->uri << "\"/>\n";
+ }
+
+ list<shared_ptr<Subtitle> > sorted = _subtitles;
+ if (_need_sort) {
+ sorted.sort (SubtitleSorter ());
+ }
+
+ /* XXX: multiple fonts not supported */
+ /* XXX: script, underlined, weight not supported */
+
+ bool first = true;
+ bool italic = false;
+ Color color;
+ int size = 0;
+ Effect effect = NONE;
+ Color effect_color;
+ int spot_number = 1;
+ Time last_in;
+ Time last_out;
+ Time last_fade_up_time;
+ Time last_fade_down_time;
+
+ for (list<shared_ptr<Subtitle> >::iterator i = sorted.begin(); i != sorted.end(); ++i) {
+
+ /* We will start a new <Font>...</Font> whenever some font property changes.
+ I suppose should really make an optimal hierarchy of <Font> tags, but
+ that seems hard.
+ */
+
+ bool const font_changed = first ||
+ italic != (*i)->italic() ||
+ color != (*i)->color() ||
+ size != (*i)->size() ||
+ effect != (*i)->effect() ||
+ effect_color != (*i)->effect_color();
+
+ stringstream a;
+ if (font_changed) {
+ italic = (*i)->italic ();
+ a << "Italic=\"" << (italic ? "yes" : "no") << "\" ";
+ color = (*i)->color ();
+ a << "Color=\"" << color.to_argb_string() << "\" ";
+ size = (*i)->size ();
+ a << "Size=\"" << size << "\" ";
+ effect = (*i)->effect ();
+ a << "Effect=\"" << effect_to_string(effect) << "\" ";
+ effect_color = (*i)->effect_color ();
+ a << "EffectColor=\"" << effect_color.to_argb_string() << "\" ";
+ a << "Script=\"normal\" Underlined=\"no\" Weight=\"normal\"";
+ }
+
+ if (first || font_changed ||
+ (last_in != (*i)->in() ||
+ last_out != (*i)->out() ||
+ last_fade_up_time != (*i)->fade_up_time() ||
+ last_fade_down_time != (*i)->fade_down_time()
+ )) {
+
+ if (!first) {
+ s << " </Subtitle>\n";
+ }
+
+ if (font_changed) {
+ if (!first) {
+ s << " </Font>\n";
+ }
+
+ string id = "theFontId";
+ if (!_load_font_nodes.empty()) {
+ id = _load_font_nodes.front()->id;
+ }
+
+ s << " <Font Id=\"" << id << "\" " << a.str() << ">\n";
+ }
+
+ s << " <Subtitle "
+ << "SpotNumber=\"" << spot_number++ << "\" "
+ << "TimeIn=\"" << (*i)->in().to_string() << "\" "
+ << "TimeOut=\"" << (*i)->out().to_string() << "\" "
+ << "FadeUpTime=\"" << (*i)->fade_up_time().to_ticks() << "\" "
+ << "FadeDownTime=\"" << (*i)->fade_down_time().to_ticks() << "\""
+ << ">\n";
+
+ last_in = (*i)->in ();
+ last_out = (*i)->out ();
+ last_fade_up_time = (*i)->fade_up_time ();
+ last_fade_down_time = (*i)->fade_down_time ();
+ }
+
+ s << " <Text "
+ << "VAlign=\"" << valign_to_string ((*i)->v_align()) << "\" "
+ << "VPosition=\"" << (*i)->v_position() << "\""
+ << ">" << escape ((*i)->text()) << "</Text>\n";
+
+ first = false;
+ }
+
+ s << " </Subtitle>\n";
+ s << " </Font>\n";
+ s << "</DCSubtitle>\n";
+}
+
+/** XXX: Another reason why we should be writing with libxml++ */
+string
+SubtitleAsset::escape (string s) const
+{
+ boost::replace_all (s, "&", "&");
+ return s;
+}
projects / libdcp.git / blobdiff