Add set_font_file()
[libdcp.git] / src / subtitle_asset.cc
index 5a096f204e55419b46bf13c001e2387ee4edac1f..02350f00d681d18edf9e9c2afd9985048feb17d3 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -40,6 +40,7 @@
 #include "subtitle_string.h"
 #include "subtitle_image.h"
 #include "dcp_assert.h"
+#include "load_font_node.h"
 #include <asdcp/AS_DCP.h>
 #include <asdcp/KM_util.h>
 #include <libxml++/nodes/element.h>
@@ -53,7 +54,6 @@ using std::list;
 using std::cout;
 using std::cerr;
 using std::map;
-using std::distance;
 using boost::shared_ptr;
 using boost::shared_array;
 using boost::optional;
@@ -152,11 +152,9 @@ 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");
        if (!hp) {
                hp = optional_number_attribute<float> (node, "Hposition");
@@ -189,11 +187,34 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
                ps.v_align = string_to_valign (va.get ());
        }
 
+}
+
+SubtitleAsset::ParseState
+SubtitleAsset::text_node_state (xmlpp::Element const * node) const
+{
+       ParseState ps;
+
+       position_align (ps, node);
+
        optional<string> d = optional_string_attribute (node, "Direction");
        if (d) {
                ps.direction = string_to_direction (d.get ());
        }
 
+       ps.type = ParseState::TEXT;
+
+       return ps;
+}
+
+SubtitleAsset::ParseState
+SubtitleAsset::image_node_state (xmlpp::Element const * node) const
+{
+       ParseState ps;
+
+       position_align (ps, node);
+
+       ps.type = ParseState::IMAGE;
+
        return ps;
 }
 
@@ -240,6 +261,8 @@ 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());
        }
@@ -248,7 +271,7 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, list<ParseState>& s
        for (xmlpp::Node::NodeList::const_iterator i = c.begin(); i != c.end(); ++i) {
                xmlpp::ContentNode 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);
                if (e) {
@@ -260,7 +283,7 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, list<ParseState>& s
 }
 
 void
-SubtitleAsset::maybe_add_subtitle (string text, list<ParseState> const & parse_state)
+SubtitleAsset::maybe_add_subtitle (string text, list<ParseState> const & parse_state, Standard standard)
 {
        if (empty_or_white_space (text)) {
                return;
@@ -322,38 +345,66 @@ 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 (
-               shared_ptr<Subtitle> (
-                       new 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 (0, 0, 0)),
-                               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::TEXT:
+               _subtitles.push_back (
+                       shared_ptr<Subtitle> (
+                               new 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 (0, 0, 0)),
+                                       ps.fade_up_time.get_value_or(Time()),
+                                       ps.fade_down_time.get_value_or(Time())
+                                       )
+                               )
+                       );
+               break;
+       case ParseState::IMAGE:
+               /* Add a subtitle with no image data and we'll fill that in later */
+               _subtitles.push_back (
+                       shared_ptr<Subtitle> (
+                               new SubtitleImage (
+                                       Data (),
+                                       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;
+       }
 }
 
 list<shared_ptr<Subtitle> >
@@ -373,11 +424,6 @@ void
 SubtitleAsset::add (shared_ptr<Subtitle> s)
 {
        _subtitles.push_back (s);
-
-       shared_ptr<SubtitleImage> si = dynamic_pointer_cast<SubtitleImage> (s);
-       if (si) {
-               _image_subtitle_uuid[si] = make_uuid ();
-       }
 }
 
 Time
@@ -433,6 +479,9 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
                        note (DCP_ERROR, "subtitles differ");
                        return false;
                }
+
+               ++i;
+               ++j;
        }
 
        return true;
@@ -490,7 +539,7 @@ SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
                        while (j != part->children.end() && (*i)->font == (*j)->font) {
                                ++j;
                        }
-                       if (distance (i, j) == 1) {
+                       if (std::distance (i, j) == 1) {
                                merged.push_back (*i);
                                ++i;
                        } else {
@@ -578,10 +627,8 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
                shared_ptr<SubtitleImage> ii = dynamic_pointer_cast<SubtitleImage>(i);
                if (ii) {
                        text.reset ();
-                       ImageUUIDMap::const_iterator uuid = _image_subtitle_uuid.find(ii);
-                       DCP_ASSERT (uuid != _image_subtitle_uuid.end());
                        subtitle->children.push_back (
-                               shared_ptr<order::Image> (new order::Image (subtitle, uuid->second, ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position()))
+                               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()))
                                );
                }
        }
@@ -601,7 +648,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
 }
 
 map<string, Data>
-SubtitleAsset::fonts_with_load_ids () const
+SubtitleAsset::font_data () const
 {
        map<string, Data> out;
        BOOST_FOREACH (Font const & i, _fonts) {
@@ -609,3 +656,54 @@ SubtitleAsset::fonts_with_load_ids () const
        }
        return out;
 }
+
+
+map<string, boost::filesystem::path>
+SubtitleAsset::font_filenames () const
+{
+       map<string, boost::filesystem::path> out;
+       BOOST_FOREACH (Font 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;
+       list<string> ids;
+       BOOST_FOREACH (shared_ptr<LoadFontNode> 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");
+
+       BOOST_FOREACH (shared_ptr<LoadFontNode> i, load_font_nodes()) {
+               if (i->id == "") {
+                       i->id = empty_id;
+               }
+       }
+
+       BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+               shared_ptr<SubtitleString> j = dynamic_pointer_cast<SubtitleString> (i);
+               if (j && j->font() && j->font().get() == "") {
+                       j->set_font (empty_id);
+               }
+       }
+}