Tidying.
[libdcp.git] / src / subtitle_asset.cc
index ac87148dc4cf1e4db7b25ce2a6884b107d183619..99673da991c5c57cb64e283d97857265587a74f2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
     files in the program, then also delete it here.
 */
 
+
+/** @file  src/subtitle_asset.cc
+ *  @brief SubtitleAsset class
+ */
+
+
 #include "raw_convert.h"
 #include "compose.hpp"
 #include "subtitle_asset.h"
+#include "subtitle_asset_internal.h"
 #include "util.h"
 #include "xml.h"
 #include "subtitle_string.h"
+#include "subtitle_image.h"
 #include "dcp_assert.h"
+#include "load_font_node.h"
+#include "reel_asset.h"
 #include <asdcp/AS_DCP.h>
 #include <asdcp/KM_util.h>
 #include <libxml++/nodes/element.h>
 #include <boost/algorithm/string.hpp>
 #include <boost/lexical_cast.hpp>
 #include <boost/shared_array.hpp>
-#include <boost/foreach.hpp>
 
+
+using std::dynamic_pointer_cast;
 using std::string;
-using std::list;
 using std::cout;
 using std::cerr;
 using std::map;
-using boost::shared_ptr;
+using std::shared_ptr;
+using std::vector;
+using std::make_shared;
 using boost::shared_array;
 using boost::optional;
-using boost::dynamic_pointer_cast;
 using boost::lexical_cast;
 using namespace dcp;
 
+
 SubtitleAsset::SubtitleAsset ()
 {
 
 }
 
+
 SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
        : Asset (file)
 {
 
 }
 
+
 string
 string_attribute (xmlpp::Element const * node, string name)
 {
-       xmlpp::Attribute* a = node->get_attribute (name);
+       auto a = node->get_attribute (name);
        if (!a) {
                throw XMLError (String::compose ("missing attribute %1", name));
        }
        return string (a->get_value ());
 }
 
+
 optional<string>
 optional_string_attribute (xmlpp::Element const * node, string name)
 {
-       xmlpp::Attribute* a = node->get_attribute (name);
+       auto a = node->get_attribute (name);
        if (!a) {
-               return optional<string>();
+               return {};
        }
        return string (a->get_value ());
 }
 
+
 optional<bool>
 optional_bool_attribute (xmlpp::Element const * node, string name)
 {
-       optional<string> s = optional_string_attribute (node, name);
+       auto s = optional_string_attribute (node, name);
        if (!s) {
-               return optional<bool> ();
+               return {};
        }
 
        return (s.get() == "1" || s.get() == "yes");
 }
 
+
 template <class T>
 optional<T>
 optional_number_attribute (xmlpp::Element const * node, string name)
 {
-       boost::optional<std::string> s = optional_string_attribute (node, name);
+       auto s = optional_string_attribute (node, name);
        if (!s) {
                return boost::optional<T> ();
        }
@@ -114,12 +131,13 @@ optional_number_attribute (xmlpp::Element const * node, string name)
        return raw_convert<T> (t);
 }
 
+
 SubtitleAsset::ParseState
 SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) const
 {
        ParseState ps;
 
-       if (standard == INTEROP) {
+       if (standard == Standard::INTEROP) {
                ps.font_id = optional_string_attribute (node, "Id");
        } else {
                ps.font_id = optional_string_attribute (node, "ID");
@@ -128,16 +146,16 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard)
        ps.aspect_adjust = optional_number_attribute<float> (node, "AspectAdjust");
        ps.italic = optional_bool_attribute (node, "Italic");
        ps.bold = optional_string_attribute(node, "Weight").get_value_or("normal") == "bold";
-       if (standard == INTEROP) {
+       if (standard == Standard::INTEROP) {
                ps.underline = optional_bool_attribute (node, "Underlined");
        } else {
                ps.underline = optional_bool_attribute (node, "Underline");
        }
-       optional<string> c = optional_string_attribute (node, "Color");
+       auto c = optional_string_attribute (node, "Color");
        if (c) {
                ps.colour = Colour (c.get ());
        }
-       optional<string> const e = optional_string_attribute (node, "Effect");
+       auto const e = optional_string_attribute (node, "Effect");
        if (e) {
                ps.effect = string_to_effect (e.get ());
        }
@@ -149,12 +167,10 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard)
        return ps;
 }
 
-SubtitleAsset::ParseState
-SubtitleAsset::text_node_state (xmlpp::Element const * node) const
+void
+SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element const * node) const
 {
-       ParseState ps;
-
-       optional<float> hp = optional_number_attribute<float> (node, "HPosition");
+       auto hp = optional_number_attribute<float> (node, "HPosition");
        if (!hp) {
                hp = optional_number_attribute<float> (node, "Hposition");
        }
@@ -162,7 +178,7 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
                ps.h_position = hp.get () / 100;
        }
 
-       optional<string> ha = optional_string_attribute (node, "HAlign");
+       auto ha = optional_string_attribute (node, "HAlign");
        if (!ha) {
                ha = optional_string_attribute (node, "Halign");
        }
@@ -170,7 +186,7 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
                ps.h_align = string_to_halign (ha.get ());
        }
 
-       optional<float> vp = optional_number_attribute<float> (node, "VPosition");
+       auto vp = optional_number_attribute<float> (node, "VPosition");
        if (!vp) {
                vp = optional_number_attribute<float> (node, "Vposition");
        }
@@ -178,7 +194,7 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
                ps.v_position = vp.get () / 100;
        }
 
-       optional<string> va = optional_string_attribute (node, "VAlign");
+       auto va = optional_string_attribute (node, "VAlign");
        if (!va) {
                va = optional_string_attribute (node, "Valign");
        }
@@ -186,14 +202,40 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
                ps.v_align = string_to_valign (va.get ());
        }
 
-       optional<string> d = optional_string_attribute (node, "Direction");
+}
+
+
+SubtitleAsset::ParseState
+SubtitleAsset::text_node_state (xmlpp::Element const * node) const
+{
+       ParseState ps;
+
+       position_align (ps, node);
+
+       auto d = optional_string_attribute (node, "Direction");
        if (d) {
                ps.direction = string_to_direction (d.get ());
        }
 
+       ps.type = ParseState::Type::TEXT;
+
        return ps;
 }
 
+
+SubtitleAsset::ParseState
+SubtitleAsset::image_node_state (xmlpp::Element const * node) const
+{
+       ParseState ps;
+
+       position_align (ps, node);
+
+       ps.type = ParseState::Type::IMAGE;
+
+       return ps;
+}
+
+
 SubtitleAsset::ParseState
 SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional<int> tcr) const
 {
@@ -205,10 +247,11 @@ SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional<int> t
        return ps;
 }
 
+
 Time
 SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional<int> tcr) const
 {
-       string const u = optional_string_attribute(node, name).get_value_or ("");
+       auto const u = optional_string_attribute(node, name).get_value_or ("");
        Time t;
 
        if (u.empty ()) {
@@ -226,8 +269,9 @@ SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional<int
        return t;
 }
 
+
 void
-SubtitleAsset::parse_subtitles (xmlpp::Element const * node, list<ParseState>& state, optional<int> tcr, Standard standard)
+SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector<ParseState>& state, optional<int> tcr, Standard standard)
 {
        if (node->get_name() == "Font") {
                state.push_back (font_node_state (node, standard));
@@ -237,17 +281,18 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, list<ParseState>& s
                state.push_back (text_node_state (node));
        } else if (node->get_name() == "SubtitleList") {
                state.push_back (ParseState ());
+       } else if (node->get_name() == "Image") {
+               state.push_back (image_node_state (node));
        } else {
                throw XMLError ("unexpected node " + node->get_name());
        }
 
-       xmlpp::Node::NodeList c = node->get_children ();
-       for (xmlpp::Node::NodeList::const_iterator i = c.begin(); i != c.end(); ++i) {
-               xmlpp::ContentNode const * v = dynamic_cast<xmlpp::ContentNode const *> (*i);
+       for (auto i: node->get_children()) {
+               auto const v = dynamic_cast<xmlpp::ContentNode const *>(i);
                if (v) {
-                       maybe_add_subtitle (v->get_content(), state);
+                       maybe_add_subtitle (v->get_content(), state, standard);
                }
-               xmlpp::Element const * e = dynamic_cast<xmlpp::Element const *> (*i);
+               auto const e = dynamic_cast<xmlpp::Element const *>(i);
                if (e) {
                        parse_subtitles (e, state, tcr, standard);
                }
@@ -256,15 +301,16 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, list<ParseState>& s
        state.pop_back ();
 }
 
+
 void
-SubtitleAsset::maybe_add_subtitle (string text, list<ParseState> const & parse_state)
+SubtitleAsset::maybe_add_subtitle (string text, vector<ParseState> const & parse_state, Standard standard)
 {
        if (empty_or_white_space (text)) {
                return;
        }
 
        ParseState ps;
-       BOOST_FOREACH (ParseState const & i, parse_state) {
+       for (auto const& i: parse_state) {
                if (i.font_id) {
                        ps.font_id = i.font_id.get();
                }
@@ -319,44 +365,82 @@ SubtitleAsset::maybe_add_subtitle (string text, list<ParseState> const & parse_s
                if (i.fade_down_time) {
                        ps.fade_down_time = i.fade_down_time.get();
                }
+               if (i.type) {
+                       ps.type = i.type.get();
+               }
        }
 
        if (!ps.in || !ps.out) {
-               /* We're not in a <Text> node; just ignore this content */
+               /* We're not in a <Subtitle> node; just ignore this content */
                return;
        }
 
-       _subtitles.push_back (
-               SubtitleString (
-                       ps.font_id,
-                       ps.italic.get_value_or (false),
-                       ps.bold.get_value_or (false),
-                       ps.underline.get_value_or (false),
-                       ps.colour.get_value_or (dcp::Colour (255, 255, 255)),
-                       ps.size.get_value_or (42),
-                       ps.aspect_adjust.get_value_or (1.0),
-                       ps.in.get(),
-                       ps.out.get(),
-                       ps.h_position.get_value_or(0),
-                       ps.h_align.get_value_or(HALIGN_CENTER),
-                       ps.v_position.get_value_or(0),
-                       ps.v_align.get_value_or(VALIGN_CENTER),
-                       ps.direction.get_value_or (DIRECTION_LTR),
-                       text,
-                       ps.effect.get_value_or (NONE),
-                       ps.effect_colour.get_value_or (dcp::Colour (255, 255, 255)),
-                       ps.fade_up_time.get_value_or(Time()),
-                       ps.fade_down_time.get_value_or(Time())
-                       )
-               );
+       DCP_ASSERT (ps.type);
+
+       switch (ps.type.get()) {
+       case ParseState::Type::TEXT:
+               _subtitles.push_back (
+                       make_shared<SubtitleString>(
+                               ps.font_id,
+                               ps.italic.get_value_or (false),
+                               ps.bold.get_value_or (false),
+                               ps.underline.get_value_or (false),
+                               ps.colour.get_value_or (dcp::Colour (255, 255, 255)),
+                               ps.size.get_value_or (42),
+                               ps.aspect_adjust.get_value_or (1.0),
+                               ps.in.get(),
+                               ps.out.get(),
+                               ps.h_position.get_value_or(0),
+                               ps.h_align.get_value_or(HAlign::CENTER),
+                               ps.v_position.get_value_or(0),
+                               ps.v_align.get_value_or(VAlign::CENTER),
+                               ps.direction.get_value_or (Direction::LTR),
+                               text,
+                               ps.effect.get_value_or (Effect::NONE),
+                               ps.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
+                               ps.fade_up_time.get_value_or(Time()),
+                               ps.fade_down_time.get_value_or(Time())
+                               )
+                       );
+               break;
+       case ParseState::Type::IMAGE:
+               /* Add a subtitle with no image data and we'll fill that in later */
+               _subtitles.push_back (
+                       make_shared<SubtitleImage>(
+                               ArrayData(),
+                               standard == Standard::INTEROP ? text.substr(0, text.size() - 4) : text,
+                               ps.in.get(),
+                               ps.out.get(),
+                               ps.h_position.get_value_or(0),
+                               ps.h_align.get_value_or(HAlign::CENTER),
+                               ps.v_position.get_value_or(0),
+                               ps.v_align.get_value_or(VAlign::CENTER),
+                               ps.fade_up_time.get_value_or(Time()),
+                               ps.fade_down_time.get_value_or(Time())
+                               )
+                       );
+               break;
+       }
+}
+
+
+vector<shared_ptr<const Subtitle>>
+SubtitleAsset::subtitles () const
+{
+       vector<shared_ptr<const Subtitle>> s;
+       for (auto i: _subtitles) {
+               s.push_back (i);
+       }
+       return s;
 }
 
-list<SubtitleString>
+
+vector<shared_ptr<const Subtitle>>
 SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const
 {
-       list<SubtitleString> s;
-       BOOST_FOREACH (SubtitleString const & i, _subtitles) {
-               if ((starting && from <= i.in() && i.in() < to) || (!starting && i.out() >= from && i.in() <= to)) {
+       vector<shared_ptr<const Subtitle>> s;
+       for (auto i: _subtitles) {
+               if ((starting && from <= i->in() && i->in() < to) || (!starting && i->out() >= from && i->in() <= to)) {
                        s.push_back (i);
                }
        }
@@ -364,25 +448,48 @@ SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const
        return s;
 }
 
+
+/* XXX: this needs a test */
+vector<shared_ptr<const Subtitle>>
+SubtitleAsset::subtitles_in_reel (shared_ptr<const dcp::ReelAsset> asset) const
+{
+       auto frame_rate = asset->edit_rate().as_float();
+       auto start = dcp::Time(asset->entry_point().get_value_or(0), frame_rate, time_code_rate());
+       auto during = subtitles_during (start, start + dcp::Time(asset->intrinsic_duration(), frame_rate, time_code_rate()), false);
+
+       vector<shared_ptr<const dcp::Subtitle>> corrected;
+       for (auto i: during) {
+               auto c = make_shared<dcp::Subtitle>(*i);
+               c->set_in (c->in() - start);
+               c->set_out (c->out() - start);
+               corrected.push_back (c);
+       }
+
+       return corrected;
+}
+
+
 void
-SubtitleAsset::add (SubtitleString s)
+SubtitleAsset::add (shared_ptr<Subtitle> s)
 {
        _subtitles.push_back (s);
 }
 
+
 Time
 SubtitleAsset::latest_subtitle_out () const
 {
        Time t;
-       BOOST_FOREACH (SubtitleString const & i, _subtitles) {
-               if (i.out() > t) {
-                       t = i.out ();
+       for (auto i: _subtitles) {
+               if (i->out() > t) {
+                       t = i->out ();
                }
        }
 
        return t;
 }
 
+
 bool
 SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 {
@@ -390,195 +497,267 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
                return false;
        }
 
-       shared_ptr<const SubtitleAsset> other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
+       auto other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
        if (!other) {
                return false;
        }
 
-       if (_subtitles != other->_subtitles) {
-               note (DCP_ERROR, "subtitles differ");
+       if (_subtitles.size() != other->_subtitles.size()) {
+               note (NoteType::ERROR, String::compose("different number of subtitles: %1 vs %2", _subtitles.size(), other->_subtitles.size()));
                return false;
        }
 
+       auto i = _subtitles.begin();
+       auto j = other->_subtitles.begin();
+
+       while (i != _subtitles.end()) {
+               auto string_i = dynamic_pointer_cast<SubtitleString> (*i);
+               auto string_j = dynamic_pointer_cast<SubtitleString> (*j);
+               auto image_i = dynamic_pointer_cast<SubtitleImage> (*i);
+               auto image_j = dynamic_pointer_cast<SubtitleImage> (*j);
+
+               if ((string_i && !string_j) || (image_i && !image_j)) {
+                       note (NoteType::ERROR, "subtitles differ: string vs. image");
+                       return false;
+               }
+
+               if (string_i && *string_i != *string_j) {
+                       note (NoteType::ERROR, String::compose("subtitles differ in text or metadata: %1 vs %2", string_i->text(), string_j->text()));
+                       return false;
+               }
+
+               if (image_i && !image_i->equals(image_j, options, note)) {
+                       return false;
+               }
+
+               ++i;
+               ++j;
+       }
+
        return true;
 }
 
-struct SubtitleSorter {
-       bool operator() (SubtitleString const & a, SubtitleString const & b) {
-               if (a.in() != b.in()) {
-                       return a.in() < b.in();
+
+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();
+               return a->v_position() < b->v_position();
        }
 };
 
-/** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
- *  class because the differences between the two are fairly subtle.
- */
+
 void
-SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const
+SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
 {
-       list<SubtitleString> sorted = _subtitles;
-       sorted.sort (SubtitleSorter ());
-
-       string const xmlns = standard == SMPTE ? "dcst" : "";
-
-       /* XXX: script not supported */
-
-       optional<string> font;
-       bool italic = false;
-       bool bold = false;
-       bool underline = false;
-       Colour colour;
-       int size = 0;
-       float aspect_adjust = 1.0;
-       Effect effect = NONE;
-       Colour effect_colour;
-       int spot_number = 1;
-       Time last_in;
-       Time last_out;
-       Time last_fade_up_time;
-       Time last_fade_down_time;
-
-       xmlpp::Element* font_element = 0;
-       xmlpp::Element* subtitle_element = 0;
+       if (part->children.empty ()) {
+               return;
+       }
 
-       BOOST_FOREACH (SubtitleString const & i, sorted) {
+       /* Pull up from children */
+       for (auto i: part->children) {
+               pull_fonts (i);
+       }
 
-               /* We will start a new <Font>...</Font> whenever some font property changes.
-                  I suppose we should really make an optimal hierarchy of <Font> tags, but
-                  that seems hard.
+       if (part->parent) {
+               /* Establish the common font features that each of part's children have;
+                  these features go into part's font.
                */
+               part->font = part->children.front()->font;
+               for (auto i: part->children) {
+                       part->font.take_intersection (i->font);
+               }
 
-               bool const font_changed =
-                       font          != i.font()          ||
-                       italic        != i.italic()        ||
-                       bold          != i.bold()          ||
-                       underline     != i.underline()     ||
-                       colour        != i.colour()        ||
-                       size          != i.size()          ||
-                       fabs (aspect_adjust - i.aspect_adjust()) > ASPECT_ADJUST_EPSILON ||
-                       effect        != i.effect()        ||
-                       effect_colour != i.effect_colour();
-
-               if (font_changed) {
-                       font = i.font ();
-                       italic = i.italic ();
-                       bold = i.bold ();
-                       underline = i.underline ();
-                       colour = i.colour ();
-                       size = i.size ();
-                       aspect_adjust = i.aspect_adjust ();
-                       effect = i.effect ();
-                       effect_colour = i.effect_colour ();
-               }
-
-               if (!font_element || font_changed) {
-                       font_element = root->add_child ("Font", xmlns);
-                       if (font) {
-                               if (standard == SMPTE) {
-                                       font_element->set_attribute ("ID", font.get ());
-                               } else {
-                                       font_element->set_attribute ("Id", font.get ());
-                               }
-                       }
-                       font_element->set_attribute ("Italic", italic ? "yes" : "no");
-                       font_element->set_attribute ("Color", colour.to_argb_string());
-                       font_element->set_attribute ("Size", raw_convert<string> (size));
-                       if (fabs (aspect_adjust - 1.0) > ASPECT_ADJUST_EPSILON) {
-                               font_element->set_attribute ("AspectAdjust", raw_convert<string> (aspect_adjust));
-                       }
-                       font_element->set_attribute ("Effect", effect_to_string (effect));
-                       font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
-                       font_element->set_attribute ("Script", "normal");
-                       if (standard == SMPTE) {
-                               font_element->set_attribute ("Underline", underline ? "yes" : "no");
-                       } else {
-                               font_element->set_attribute ("Underlined", underline ? "yes" : "no");
-                       }
-                       font_element->set_attribute ("Weight", bold ? "bold" : "normal");
-               }
-
-               if (!subtitle_element || 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()
-                           )) {
-
-                       subtitle_element = font_element->add_child ("Subtitle", xmlns);
-                       subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
-                       subtitle_element->set_attribute ("TimeIn", i.in().rebase(time_code_rate).as_string(standard));
-                       subtitle_element->set_attribute ("TimeOut", i.out().rebase(time_code_rate).as_string(standard));
-                       if (standard == SMPTE) {
-                               subtitle_element->set_attribute ("FadeUpTime", i.fade_up_time().rebase(time_code_rate).as_string(standard));
-                               subtitle_element->set_attribute ("FadeDownTime", i.fade_down_time().rebase(time_code_rate).as_string(standard));
-                       } else {
-                               subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i.fade_up_time().as_editable_units(time_code_rate)));
-                               subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i.fade_down_time().as_editable_units(time_code_rate)));
-                       }
-
-                       last_in = i.in ();
-                       last_out = i.out ();
-                       last_fade_up_time = i.fade_up_time ();
-                       last_fade_down_time = i.fade_down_time ();
+               /* Remove common values from part's children's fonts */
+               for (auto i: part->children) {
+                       i->font.take_difference (part->font);
                }
+       }
 
-               xmlpp::Element* text = subtitle_element->add_child ("Text", xmlns);
+       /* Merge adjacent children with the same font */
+       auto i = part->children.begin();
+       vector<shared_ptr<order::Part>> merged;
 
-               if (i.h_align() != HALIGN_CENTER) {
-                       if (standard == SMPTE) {
-                               text->set_attribute ("Halign", halign_to_string (i.h_align ()));
-                       } else {
-                               text->set_attribute ("HAlign", halign_to_string (i.h_align ()));
-                       }
-               }
+       while (i != part->children.end()) {
 
-               if (i.h_position() > ALIGN_EPSILON) {
-                       if (standard == SMPTE) {
-                               text->set_attribute ("Hposition", raw_convert<string> (i.h_position() * 100, 6));
+               if ((*i)->font.empty ()) {
+                       merged.push_back (*i);
+                       ++i;
+               } else {
+                       auto j = i;
+                       ++j;
+                       while (j != part->children.end() && (*i)->font == (*j)->font) {
+                               ++j;
+                       }
+                       if (std::distance (i, j) == 1) {
+                               merged.push_back (*i);
+                               ++i;
                        } else {
-                               text->set_attribute ("HPosition", raw_convert<string> (i.h_position() * 100, 6));
+                               shared_ptr<order::Part> group (new order::Part (part, (*i)->font));
+                               for (auto k = i; k != j; ++k) {
+                                       (*k)->font.clear ();
+                                       group->children.push_back (*k);
+                               }
+                               merged.push_back (group);
+                               i = j;
                        }
                }
+       }
 
-               if (standard == SMPTE) {
-                       text->set_attribute ("Valign", valign_to_string (i.v_align()));
-               } else {
-                       text->set_attribute ("VAlign", valign_to_string (i.v_align()));
+       part->children = merged;
+}
+
+
+/** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
+ *  class because the differences between the two are fairly subtle.
+ */
+void
+SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, Standard standard) const
+{
+       auto sorted = _subtitles;
+       std::stable_sort(sorted.begin(), sorted.end(), SubtitleSorter());
+
+       /* Gather our subtitles into a hierarchy of Subtitle/Text/String objects, writing
+          font information into the bottom level (String) objects.
+       */
+
+       auto root = make_shared<order::Part>(shared_ptr<order::Part>());
+       shared_ptr<order::Subtitle> subtitle;
+       shared_ptr<order::Text> text;
+
+       Time last_in;
+       Time last_out;
+       Time last_fade_up_time;
+       Time last_fade_down_time;
+       HAlign last_h_align;
+       float last_h_position;
+       VAlign last_v_align;
+       float last_v_position;
+       Direction last_direction;
+
+       for (auto i: sorted) {
+               if (!subtitle ||
+                   (last_in != i->in() ||
+                    last_out != i->out() ||
+                    last_fade_up_time != i->fade_up_time() ||
+                    last_fade_down_time != i->fade_down_time())
+                       ) {
+
+                       subtitle = make_shared<order::Subtitle>(root, i->in(), i->out(), i->fade_up_time(), i->fade_down_time());
+                       root->children.push_back (subtitle);
+
+                       last_in = i->in ();
+                       last_out = i->out ();
+                       last_fade_up_time = i->fade_up_time ();
+                       last_fade_down_time = i->fade_down_time ();
+                       text.reset ();
                }
 
-               if (i.v_position() > ALIGN_EPSILON) {
-                       if (standard == SMPTE) {
-                               text->set_attribute ("Vposition", raw_convert<string> (i.v_position() * 100, 6));
-                       } else {
-                               text->set_attribute ("VPosition", raw_convert<string> (i.v_position() * 100, 6));
+               auto is = dynamic_pointer_cast<SubtitleString>(i);
+               if (is) {
+                       if (!text ||
+                           last_h_align != is->h_align() ||
+                           fabs(last_h_position - is->h_position()) > ALIGN_EPSILON ||
+                           last_v_align != is->v_align() ||
+                           fabs(last_v_position - is->v_position()) > ALIGN_EPSILON ||
+                           last_direction != is->direction()
+                               ) {
+                               text.reset (new order::Text (subtitle, is->h_align(), is->h_position(), is->v_align(), is->v_position(), is->direction()));
+                               subtitle->children.push_back (text);
+
+                               last_h_align = is->h_align ();
+                               last_h_position = is->h_position ();
+                               last_v_align = is->v_align ();
+                               last_v_position = is->v_position ();
+                               last_direction = is->direction ();
                        }
-               } else {
-                       if (standard == SMPTE) {
-                               text->set_attribute ("Vposition", "0");
-                       } else {
-                               text->set_attribute ("VPosition", "0");
-                       }
-               }
 
-               /* Interop only supports "horizontal" or "vertical" for direction, so only write this
-                  for SMPTE.
-               */
-               if (i.direction() != DIRECTION_LTR && standard == SMPTE) {
-                       text->set_attribute ("Direction", direction_to_string (i.direction ()));
+                       text->children.push_back (shared_ptr<order::String> (new order::String (text, order::Font (is, standard), is->text())));
                }
 
-               text->add_child_text (i.text());
+               auto ii = dynamic_pointer_cast<SubtitleImage>(i);
+               if (ii) {
+                       text.reset ();
+                       subtitle->children.push_back (
+                               shared_ptr<order::Image> (new order::Image (subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position()))
+                               );
+               }
        }
+
+       /* Pull font changes as high up the hierarchy as we can */
+
+       pull_fonts (root);
+
+       /* Write XML */
+
+       order::Context context;
+       context.time_code_rate = time_code_rate;
+       context.standard = standard;
+       context.spot_number = 1;
+
+       root->write_xml (xml_root, context);
 }
 
-map<string, Data>
-SubtitleAsset::fonts_with_load_ids () const
+
+map<string, ArrayData>
+SubtitleAsset::font_data () const
 {
-       map<string, Data> out;
-       BOOST_FOREACH (Font const & i, _fonts) {
+       map<string, ArrayData> out;
+       for (auto const& i: _fonts) {
                out[i.load_id] = i.data;
        }
        return out;
 }
+
+
+map<string, boost::filesystem::path>
+SubtitleAsset::font_filenames () const
+{
+       map<string, boost::filesystem::path> out;
+       for (auto const& i: _fonts) {
+               if (i.file) {
+                       out[i.load_id] = *i.file;
+               }
+       }
+       return out;
+}
+
+
+/** Replace empty IDs in any <LoadFontId> and <Font> tags with
+ *  a dummy string.  Some systems give errors with empty font IDs
+ *  (see DCP-o-matic bug #1689).
+ */
+void
+SubtitleAsset::fix_empty_font_ids ()
+{
+       bool have_empty = false;
+       vector<string> ids;
+       for (auto i: load_font_nodes()) {
+               if (i->id == "") {
+                       have_empty = true;
+               } else {
+                       ids.push_back (i->id);
+               }
+       }
+
+       if (!have_empty) {
+               return;
+       }
+
+       string const empty_id = unique_string (ids, "font");
+
+       for (auto i: load_font_nodes()) {
+               if (i->id == "") {
+                       i->id = empty_id;
+               }
+       }
+
+       for (auto i: _subtitles) {
+               auto j = dynamic_pointer_cast<SubtitleString> (i);
+               if (j && j->font() && j->font().get() == "") {
+                       j->set_font (empty_id);
+               }
+       }
+}