Remove _finalized check from picture writer too.
[libdcp.git] / src / subtitle_asset.cc
index 8e15ba1acffb1681a89a913af105b245e7fcec85..ba91cf9028932117953a9137099434ff36821fa5 100644 (file)
 
 #include <fstream>
 #include <boost/lexical_cast.hpp>
+#include <boost/algorithm/string.hpp>
 #include "subtitle_asset.h"
 #include "util.h"
 
-using namespace std;
-using namespace boost;
+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_file)
        : Asset (directory, xml_file)
+       , _need_sort (false)
 {
-       shared_ptr<XMLFile> xml (new XMLFile (path().string(), "DCSubtitle"));
+       read_xml (path().string());
+}
+
+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");
@@ -49,15 +72,6 @@ SubtitleAsset::SubtitleAsset (string directory, string xml_file)
        examine_font_nodes (xml, font_nodes, parse_state);
 }
 
-SubtitleAsset::SubtitleAsset (string directory, string movie_title, string language)
-       : Asset (directory)
-       , _movie_title (movie_title)
-       , _reel_number ("1")
-       , _language (language)
-{
-
-}
-
 void
 SubtitleAsset::examine_font_nodes (
        shared_ptr<XMLFile> xml,
@@ -129,7 +143,7 @@ SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
                                effective_text.v_position,
                                effective_text.v_align,
                                text,
-                               effective_font.effect.get(),
+                               effective_font.effect ? effective_font.effect.get() : NONE,
                                effective_font.effect_color.get(),
                                effective_subtitle.fade_up_time,
                                effective_subtitle.fade_down_time
@@ -357,6 +371,7 @@ void
 SubtitleAsset::add (shared_ptr<Subtitle> s)
 {
        _subtitles.push_back (s);
+       _need_sort = true;
 }
 
 void
@@ -373,30 +388,48 @@ SubtitleAsset::write_to_cpl (ostream& s) const
 
 struct SubtitleSorter {
        bool operator() (shared_ptr<Subtitle> a, shared_ptr<Subtitle> b) {
-               return a->in() < b->in();
+               if (a->in() != b->in()) {
+                       return a->in() < b->in();
+               }
+               return a->v_position() < b->v_position();
        }
 };
 
 void
-SubtitleAsset::write_xml ()
+SubtitleAsset::write_xml () const
 {
        ofstream f (path().string().c_str());
+       write_xml (f);
+}
 
-       f << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+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"
-         << "  <LoadFont Id=\"theFontId\" URI=\"arial.ttf\"/>";
+         << "  <Language>" << _language << "</Language>\n";
 
-       _subtitles.sort (SubtitleSorter ());
+       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;
+       bool italic = false;
        Color color;
        int size = 0;
        Effect effect = NONE;
@@ -407,47 +440,36 @@ SubtitleAsset::write_xml ()
        Time last_fade_up_time;
        Time last_fade_down_time;
 
-       for (list<shared_ptr<Subtitle> >::iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
+       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 (first || italic != (*i)->italic()) {
+               if (font_changed) {
                        italic = (*i)->italic ();
                        a << "Italic=\"" << (italic ? "yes" : "no") << "\" ";
-               }
-
-               if (first || color != (*i)->color()) {
                        color = (*i)->color ();
                        a << "Color=\"" << color.to_argb_string() << "\" ";
-               }
-
-               if (size || size != (*i)->size()) {
                        size = (*i)->size ();
                        a << "Size=\"" << size << "\" ";
-               }
-
-               if (first || effect != (*i)->effect()) {
                        effect = (*i)->effect ();
                        a << "Effect=\"" << effect_to_string(effect) << "\" ";
-               }
-
-               if (first || effect_color != (*i)->effect_color()) {
                        effect_color = (*i)->effect_color ();
                        a << "EffectColor=\"" << effect_color.to_argb_string() << "\" ";
+                       a << "Script=\"normal\" Underlined=\"no\" Weight=\"normal\"";
                }
 
-               if (first) {
-                       a << "Script=\"normal\" Underlined=\"no\" Weight=\"normal\">";
-               }
-
-               if (!a.str().empty()) {
-                       if (!first) {
-                               f << "  </Font>\n";
-                       } else {
-                               f << "  <Font Id=\"theFontId\" " << a << ">\n";
-                       }
-               }
-
-               if (first ||
+               if (first || font_changed ||
                    (last_in != (*i)->in() ||
                     last_out != (*i)->out() ||
                     last_fade_up_time != (*i)->fade_up_time() ||
@@ -455,15 +477,28 @@ SubtitleAsset::write_xml ()
                            )) {
 
                        if (!first) {
-                               f << "  </Subtitle>\n";
+                               s << "  </Subtitle>\n";
                        }
 
-                       f << "  <Subtitle "
+                       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() << "\" "
+                         << "TimeIn=\"" << (*i)->in().to_string() << "\" "
                          << "TimeOut=\"" << (*i)->out().to_string() << "\" "
                          << "FadeUpTime=\"" << (*i)->fade_up_time().to_ticks() << "\" "
-                         << "FadeDownTime=\"" << (*i)->fade_down_time().to_ticks() << "\" "
+                         << "FadeDownTime=\"" << (*i)->fade_down_time().to_ticks() << "\""
                          << ">\n";
 
                        last_in = (*i)->in ();
@@ -472,14 +507,23 @@ SubtitleAsset::write_xml ()
                        last_fade_down_time = (*i)->fade_down_time ();
                }
 
-               f << "      <Text "
+               s << "      <Text "
                  << "VAlign=\"" << valign_to_string ((*i)->v_align()) << "\" "
-                 << "VPosition=\"" << (*i)->v_position() << "\" "
-                 << ">" << (*i)->text() << "</Text>\n";
+                 << "VPosition=\"" << (*i)->v_position() << "\""
+                 << ">" << escape ((*i)->text()) << "</Text>\n";
 
                first = false;
        }
 
-       f << "  </Subtitle>\n";
-       f << "</Font>\n";
+       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, "&", "&amp;");
+       return s;
 }