X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fsubtitle_asset.cc;h=1cd4fc07db7d2ecba9f577d7043614574e128298;hb=a8d2013b99626ed08e7c80e6e58cf234b53b0c4d;hp=8d492727c720b3dc6bd788c177d3cae8834cf4b2;hpb=2ae92dcc97765deb2845dd07a338858aeb375cb3;p=libdcp.git diff --git a/src/subtitle_asset.cc b/src/subtitle_asset.cc index 8d492727..1cd4fc07 100644 --- a/src/subtitle_asset.cc +++ b/src/subtitle_asset.cc @@ -1,175 +1,594 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ + +/** @file src/subtitle_asset.cc + * @brief SubtitleAsset class + */ + + +#include "compose.hpp" +#include "dcp_assert.h" +#include "load_font_node.h" #include "raw_convert.h" +#include "reel_asset.h" #include "subtitle_asset.h" +#include "subtitle_asset_internal.h" +#include "subtitle_image.h" +#include "subtitle_string.h" #include "util.h" #include "xml.h" -#include "font_node.h" -#include "text_node.h" -#include "subtitle_string.h" -#include "dcp_assert.h" -#include "AS_DCP.h" -#include "KM_util.h" +#include +#include #include #include +#include #include -#include +#include + -using std::string; -using std::list; -using std::ostream; -using std::ofstream; -using std::stringstream; -using std::cout; using std::cerr; +using std::cout; +using std::dynamic_pointer_cast; +using std::make_shared; using std::map; -using boost::shared_ptr; -using boost::shared_array; +using std::pair; +using std::shared_ptr; +using std::string; +using std::vector; +using boost::lexical_cast; using boost::optional; -using boost::dynamic_pointer_cast; using namespace dcp; + SubtitleAsset::SubtitleAsset () { } + SubtitleAsset::SubtitleAsset (boost::filesystem::path file) : Asset (file) { } -void -SubtitleAsset::parse_subtitles (shared_ptr xml, list > font_nodes) + +string +string_attribute (xmlpp::Element const * node, string name) +{ + auto a = node->get_attribute (name); + if (!a) { + throw XMLError (String::compose ("missing attribute %1", name)); + } + return string (a->get_value ()); +} + + +optional +optional_string_attribute (xmlpp::Element const * node, string name) +{ + auto a = node->get_attribute (name); + if (!a) { + return {}; + } + return string (a->get_value ()); +} + + +optional +optional_bool_attribute (xmlpp::Element const * node, string name) +{ + auto s = optional_string_attribute (node, name); + if (!s) { + return {}; + } + + return (s.get() == "1" || s.get() == "yes"); +} + + +template +optional +optional_number_attribute (xmlpp::Element const * node, string name) { - /* Make Subtitle objects to represent the raw XML nodes in a sane way */ - ParseState parse_state; - examine_font_nodes (xml, font_nodes, parse_state); + auto s = optional_string_attribute (node, name); + if (!s) { + return boost::optional (); + } + + std::string t = s.get (); + boost::erase_all (t, " "); + return raw_convert (t); +} + + +SubtitleAsset::ParseState +SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) const +{ + ParseState ps; + + if (standard == Standard::INTEROP) { + ps.font_id = optional_string_attribute (node, "Id"); + } else { + ps.font_id = optional_string_attribute (node, "ID"); + } + ps.size = optional_number_attribute (node, "Size"); + ps.aspect_adjust = optional_number_attribute (node, "AspectAdjust"); + ps.italic = optional_bool_attribute (node, "Italic"); + ps.bold = optional_string_attribute(node, "Weight").get_value_or("normal") == "bold"; + if (standard == Standard::INTEROP) { + ps.underline = optional_bool_attribute (node, "Underlined"); + } else { + ps.underline = optional_bool_attribute (node, "Underline"); + } + auto c = optional_string_attribute (node, "Color"); + if (c) { + ps.colour = Colour (c.get ()); + } + auto const e = optional_string_attribute (node, "Effect"); + if (e) { + ps.effect = string_to_effect (e.get ()); + } + c = optional_string_attribute (node, "EffectColor"); + if (c) { + ps.effect_colour = Colour (c.get ()); + } + + return ps; } void -SubtitleAsset::examine_font_nodes ( - shared_ptr xml, - list > const & font_nodes, - ParseState& parse_state - ) +SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element const * node) const { - for (list >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) { + auto hp = optional_number_attribute (node, "HPosition"); + if (!hp) { + hp = optional_number_attribute (node, "Hposition"); + } + if (hp) { + ps.h_position = hp.get () / 100; + } + + auto ha = optional_string_attribute (node, "HAlign"); + if (!ha) { + ha = optional_string_attribute (node, "Halign"); + } + if (ha) { + ps.h_align = string_to_halign (ha.get ()); + } - parse_state.font_nodes.push_back (*i); - maybe_add_subtitle ((*i)->text, parse_state); + auto vp = optional_number_attribute (node, "VPosition"); + if (!vp) { + vp = optional_number_attribute (node, "Vposition"); + } + if (vp) { + ps.v_position = vp.get () / 100; + } - for (list >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) { - 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 (); - } + auto va = optional_string_attribute (node, "VAlign"); + if (!va) { + va = optional_string_attribute (node, "Valign"); + } + if (va) { + ps.v_align = string_to_valign (va.get ()); + } - examine_font_nodes (xml, (*i)->font_nodes, parse_state); - examine_text_nodes (xml, (*i)->text_nodes, parse_state); + auto zp = optional_number_attribute(node, "Zposition"); + if (zp) { + ps.z_position = zp.get() / 100; + } +} - parse_state.font_nodes.pop_back (); + +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 tcr) const +{ + ParseState ps; + ps.in = Time (string_attribute(node, "TimeIn"), tcr); + ps.out = Time (string_attribute(node, "TimeOut"), tcr); + ps.fade_up_time = fade_time (node, "FadeUpTime", tcr); + ps.fade_down_time = fade_time (node, "FadeDownTime", tcr); + return ps; +} + + +Time +SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional tcr) const +{ + auto const u = optional_string_attribute(node, name).get_value_or (""); + Time t; + + if (u.empty ()) { + t = Time (0, 0, 0, 20, 250); + } else if (u.find (":") != string::npos) { + t = Time (u, tcr); + } else { + t = Time (0, 0, 0, lexical_cast (u), tcr.get_value_or(250)); + } + + if (t > Time (0, 0, 8, 0, 250)) { + t = Time (0, 0, 8, 0, 250); + } + + return t; +} + + void -SubtitleAsset::examine_text_nodes ( - shared_ptr xml, - list > const & text_nodes, - ParseState& parse_state - ) +SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector& state, optional tcr, Standard standard) { - for (list >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) { - 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 (); + if (node->get_name() == "Font") { + state.push_back (font_node_state (node, standard)); + } else if (node->get_name() == "Subtitle") { + state.push_back (subtitle_node_state (node, tcr)); + } else if (node->get_name() == "Text") { + 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()); } + + float space_before = 0; + + /* Collect s first */ + auto get_text_content = [](xmlpp::Element const* element) { + string all_content; + for (auto child: element->get_children()) { + auto content = dynamic_cast(child); + if (content) { + all_content += content->get_content(); + } + } + return all_content; + }; + + vector rubies; + for (auto child: node->get_children()) { + auto element = dynamic_cast(child); + if (element && element->get_name() == "Ruby") { + optional base; + optional annotation; + optional size; + optional position; + optional offset; + optional spacing; + optional aspect_adjust; + for (auto ruby_child: element->get_children()) { + if (auto ruby_element = dynamic_cast(ruby_child)) { + if (ruby_element->get_name() == "Rb") { + base = get_text_content(ruby_element); + } else if (ruby_element->get_name() == "Rt") { + annotation = get_text_content(ruby_element); + size = optional_number_attribute(ruby_element, "Size"); + if (auto position_string = optional_string_attribute(ruby_element, "Position")) { + if (*position_string == "before") { + position = RubyPosition::BEFORE; + } else if (*position_string == "after") { + position = RubyPosition::AFTER; + } else { + DCP_ASSERT(false); + } + } + offset = optional_number_attribute(ruby_element, "Offset"); + spacing = optional_number_attribute(ruby_element, "Spacing"); + aspect_adjust = optional_number_attribute(ruby_element, "AspectAdjust"); + } + } + } + DCP_ASSERT(base); + DCP_ASSERT(annotation); + auto ruby = Ruby{*base, *annotation}; + if (size) { + ruby.size = *size; + } + if (position) { + ruby.position = *position; + } + if (offset) { + ruby.offset = *offset; + } + if (spacing) { + ruby.spacing = *spacing; + } + if (aspect_adjust) { + ruby.aspect_adjust = *aspect_adjust; + } + rubies.push_back(ruby); + } + } + + for (auto i: node->get_children()) { + + /* Handle actual content e.g. text */ + auto const v = dynamic_cast(i); + if (v) { + maybe_add_subtitle (v->get_content(), state, space_before, standard, rubies); + space_before = 0; + } + + /* Handle other nodes */ + auto const e = dynamic_cast(i); + if (e) { + if (e->get_name() == "Space") { + if (node->get_name() != "Text") { + throw XMLError ("Space node found outside Text"); + } + auto size = optional_string_attribute(e, "Size").get_value_or("0.5"); + if (standard == dcp::Standard::INTEROP) { + boost::replace_all(size, "em", ""); + } + space_before += raw_convert(size); + } else if (e->get_name() != "Ruby") { + parse_subtitles (e, state, tcr, standard); + } + } + } + + state.pop_back (); } + void -SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state) +SubtitleAsset::maybe_add_subtitle( + string text, + vector const & parse_state, + float space_before, + Standard standard, + vector const& rubies + ) { - if (empty_or_white_space (text)) { + auto wanted = [](ParseState const& ps) { + return ps.type && (ps.type.get() == ParseState::Type::TEXT || ps.type.get() == ParseState::Type::IMAGE); + }; + + if (find_if(parse_state.begin(), parse_state.end(), wanted) == parse_state.end()) { return; } - if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) { + ParseState ps; + for (auto const& i: parse_state) { + if (i.font_id) { + ps.font_id = i.font_id.get(); + } + if (i.size) { + ps.size = i.size.get(); + } + if (i.aspect_adjust) { + ps.aspect_adjust = i.aspect_adjust.get(); + } + if (i.italic) { + ps.italic = i.italic.get(); + } + if (i.bold) { + ps.bold = i.bold.get(); + } + if (i.underline) { + ps.underline = i.underline.get(); + } + if (i.colour) { + ps.colour = i.colour.get(); + } + if (i.effect) { + ps.effect = i.effect.get(); + } + if (i.effect_colour) { + ps.effect_colour = i.effect_colour.get(); + } + if (i.h_position) { + ps.h_position = i.h_position.get(); + } + if (i.h_align) { + ps.h_align = i.h_align.get(); + } + if (i.v_position) { + ps.v_position = i.v_position.get(); + } + if (i.v_align) { + ps.v_align = i.v_align.get(); + } + if (i.z_position) { + ps.z_position = i.z_position.get(); + } + if (i.direction) { + ps.direction = i.direction.get(); + } + if (i.in) { + ps.in = i.in.get(); + } + if (i.out) { + ps.out = i.out.get(); + } + if (i.fade_up_time) { + ps.fade_up_time = i.fade_up_time.get(); + } + 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 node; just ignore this content */ return; } - DCP_ASSERT (!parse_state.text_nodes.empty ()); - DCP_ASSERT (!parse_state.subtitle_nodes.empty ()); - - dcp::FontNode effective_font (parse_state.font_nodes); - dcp::TextNode effective_text (*parse_state.text_nodes.back ()); - dcp::SubtitleNode effective_subtitle (*parse_state.subtitle_nodes.back ()); - - _subtitles.push_back ( - SubtitleString ( - effective_font.id, - effective_font.italic.get_value_or (false), - effective_font.colour.get_value_or (dcp::Colour (255, 255, 255)), - effective_font.size, - effective_font.aspect_adjust.get_value_or (1.0), - effective_subtitle.in, - effective_subtitle.out, - effective_text.h_position, - effective_text.h_align, - effective_text.v_position, - effective_text.v_align, - text, - effective_font.effect.get_value_or (NONE), - effective_font.effect_colour.get_value_or (dcp::Colour (0, 0, 0)), - effective_subtitle.fade_up_time, - effective_subtitle.fade_down_time - ) - ); + DCP_ASSERT (ps.type); + + switch (ps.type.get()) { + case ParseState::Type::TEXT: + _subtitles.push_back ( + make_shared( + 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.z_position.get_value_or(0), + 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()), + space_before, + rubies + ) + ); + break; + case ParseState::Type::IMAGE: + { + switch (standard) { + case Standard::INTEROP: + if (text.size() >= 4) { + /* Remove file extension */ + text = text.substr(0, text.size() - 4); + } + break; + case Standard::SMPTE: + /* It looks like this urn:uuid: is required, but DoM wasn't expecting it (and not writing it) + * until around 2.15.140 so I guess either: + * a) it is not (always) used in the field, or + * b) nobody noticed / complained. + */ + if (text.substr(0, 9) == "urn:uuid:") { + text = text.substr(9); + } + break; + } + + /* Add a subtitle with no image data and we'll fill that in later */ + _subtitles.push_back ( + make_shared( + ArrayData(), + 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.z_position.get_value_or(0), + ps.fade_up_time.get_value_or(Time()), + ps.fade_down_time.get_value_or(Time()) + ) + ); + break; + } + } } -list -SubtitleAsset::subtitles_during (Time from, Time to) const + +vector> +SubtitleAsset::subtitles () const { - list s; - for (list::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) { - if (i->out() >= from && i->in() <= to) { - s.push_back (*i); + vector> s; + for (auto i: _subtitles) { + s.push_back (i); + } + return s; +} + + +vector> +SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const +{ + vector> s; + for (auto i: _subtitles) { + if ((starting && from <= i->in() && i->in() < to) || (!starting && i->out() >= from && i->in() <= to)) { + s.push_back (i); } } return s; } + void -SubtitleAsset::add (SubtitleString s) +SubtitleAsset::add (shared_ptr s) { _subtitles.push_back (s); } + Time SubtitleAsset::latest_subtitle_out () const { Time t; - for (list::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) { + for (auto i: _subtitles) { if (i->out() > t) { t = i->out (); } @@ -178,162 +597,410 @@ SubtitleAsset::latest_subtitle_out () const return t; } + bool -SubtitleAsset::equals (shared_ptr other_asset, EqualityOptions options, NoteHandler note) const +SubtitleAsset::equals(shared_ptr other_asset, EqualityOptions const& options, NoteHandler note) const { if (!Asset::equals (other_asset, options, note)) { return false; } - shared_ptr other = dynamic_pointer_cast (other_asset); + auto other = dynamic_pointer_cast (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 (*i); + auto string_j = dynamic_pointer_cast (*j); + auto image_i = dynamic_pointer_cast (*i); + auto image_j = dynamic_pointer_cast (*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->equals(string_j, options, note)) { + 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 a, shared_ptr b) { + if (a->in() != b->in()) { + return a->in() < b->in(); + } + if (a->v_align() == VAlign::BOTTOM) { + return a->v_position() > b->v_position(); } - return a.v_position() < b.v_position(); + return a->v_position() < b->v_position(); } }; + void -SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, string xmlns) const +SubtitleAsset::pull_fonts (shared_ptr part) { - list sorted = _subtitles; - sorted.sort (SubtitleSorter ()); - - /* XXX: script, underlined, weight not supported */ - - optional font; - bool italic = 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; + } - for (list::iterator i = sorted.begin(); i != sorted.end(); ++i) { + /* Pull up from children */ + for (auto i: part->children) { + pull_fonts (i); + } - /* We will start a new ... whenever some font property changes. - I suppose we should really make an optimal hierarchy of 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); + } + + /* Remove common values from part's children's fonts */ + for (auto i: part->children) { + i->font.take_difference (part->font); + } + } - bool const font_changed = - font != i->font() || - italic != i->italic() || - 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 (); - 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) { - font_element->set_attribute ("Id", font.get ()); + /* Merge adjacent children with the same font */ + auto i = part->children.begin(); + vector> merged; + + while (i != part->children.end()) { + + if ((*i)->font.empty ()) { + merged.push_back (*i); + ++i; + } else { + auto j = i; + ++j; + while (j != part->children.end() && (*i)->font == (*j)->font) { + ++j; } - font_element->set_attribute ("Italic", italic ? "yes" : "no"); - font_element->set_attribute ("Color", colour.to_argb_string()); - font_element->set_attribute ("Size", raw_convert (size)); - if (fabs (aspect_adjust - 1.0) > ASPECT_ADJUST_EPSILON) { - font_element->set_attribute ("AspectAdjust", raw_convert (aspect_adjust)); + if (std::distance (i, j) == 1) { + merged.push_back (*i); + ++i; + } else { + shared_ptr 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; } - 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"); - font_element->set_attribute ("Underlined", "no"); - font_element->set_attribute ("Weight", "normal"); } + } + + 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(shared_ptr()); + shared_ptr subtitle; + shared_ptr text; - if (!subtitle_element || font_changed || + 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; + float last_z_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() - )) { + last_fade_down_time != i->fade_down_time()) + ) { - subtitle_element = font_element->add_child ("Subtitle", xmlns); - subtitle_element->set_attribute ("SpotNumber", raw_convert (spot_number++)); - subtitle_element->set_attribute ("TimeIn", i->in().rebase(time_code_rate).as_string()); - subtitle_element->set_attribute ("TimeOut", i->out().rebase(time_code_rate).as_string()); - subtitle_element->set_attribute ("FadeUpTime", raw_convert (i->fade_up_time().as_editable_units(time_code_rate))); - subtitle_element->set_attribute ("FadeDownTime", raw_convert (i->fade_down_time().as_editable_units(time_code_rate))); + subtitle = make_shared(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 (); } - xmlpp::Element* text = subtitle_element->add_child ("Text", xmlns); - if (i->h_align() != HALIGN_CENTER) { - text->set_attribute ("HAlign", halign_to_string (i->h_align ())); + auto is = dynamic_pointer_cast(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 || + fabs(last_z_position - is->z_position()) > ALIGN_EPSILON || + last_direction != is->direction() + ) { + text = make_shared( + subtitle, + is->h_align(), + is->h_position(), + is->v_align(), + is->v_position(), + is->z_position(), + is->direction(), + is->rubies() + ); + 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_z_position = is->z_position(); + last_direction = is->direction (); + } + + text->children.push_back (make_shared(text, order::Font (is, standard), is->text(), is->space_before())); } - if (i->h_position() > ALIGN_EPSILON) { - text->set_attribute ("HPosition", raw_convert (i->h_position() * 100, 6)); + + auto ii = dynamic_pointer_cast(i); + if (ii) { + text.reset (); + subtitle->children.push_back ( + make_shared(subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position(), ii->z_position()) + ); } - text->set_attribute ("VAlign", valign_to_string (i->v_align())); - text->set_attribute ("VPosition", raw_convert (i->v_position() * 100, 6)); - text->add_child_text (i->text()); } + + /* 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 +SubtitleAsset::font_data () const +{ + map out; + for (auto const& i: _fonts) { + out[i.load_id] = i.data; + } + return out; +} + + +map +SubtitleAsset::font_filenames () const +{ + map out; + for (auto const& i: _fonts) { + if (i.file) { + out[i.load_id] = *i.file; + } + } + return out; +} + + +/** Replace empty IDs in any and tags with + * a dummy string. Some systems give errors with empty font IDs + * (see DCP-o-matic bug #1689). + */ void -SubtitleAsset::add_font_data (string id, boost::filesystem::path file) +SubtitleAsset::fix_empty_font_ids () { - boost::uintmax_t size = boost::filesystem::file_size (file); - FILE* f = fopen_boost (file, "rb"); - if (!f) { - throw FileError ("could not open font file for reading", file, errno); + bool have_empty = false; + vector ids; + for (auto i: load_font_nodes()) { + if (i->id == "") { + have_empty = true; + } else { + ids.push_back (i->id); + } } - shared_array data (new uint8_t[size]); - size_t const read = fread (data.get(), 1, size, f); - fclose (f); + 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; + } + } - if (read != size) { - throw FileError ("could not read font file", file, -1); + for (auto i: _subtitles) { + auto j = dynamic_pointer_cast (i); + if (j && j->font() && j->font().get() == "") { + j->set_font (empty_id); + } } +} + + +namespace { + +struct State +{ + int indent; + string xml; + int disable_formatting; +}; - _fonts[id] = FileData (data, size); } -map -SubtitleAsset::fonts () const + +static +void +format_xml_node (xmlpp::Node const* node, State& state) { - map out; - for (map::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) { - out[i->first] = i->second; + if (auto text_node = dynamic_cast(node)) { + string content = text_node->get_content(); + boost::replace_all(content, "&", "&"); + boost::replace_all(content, "<", "<"); + boost::replace_all(content, ">", ">"); + state.xml += content; + } else if (auto element = dynamic_cast(node)) { + ++state.indent; + + auto children = element->get_children(); + auto const should_disable_formatting = + std::any_of( + children.begin(), children.end(), + [](xmlpp::Node const* node) { return static_cast(dynamic_cast(node)); } + ) || element->get_name() == "Text"; + + if (!state.disable_formatting) { + state.xml += "\n" + string(state.indent * 2, ' '); + } + + state.xml += "<" + element->get_name(); + + for (auto attribute: element->get_attributes()) { + state.xml += String::compose(" %1=\"%2\"", attribute->get_name().raw(), attribute->get_value().raw()); + } + + if (children.empty()) { + state.xml += "/>"; + } else { + state.xml += ">"; + + if (should_disable_formatting) { + ++state.disable_formatting; + } + + for (auto child: children) { + format_xml_node(child, state); + } + + if (!state.disable_formatting) { + state.xml += "\n" + string(state.indent * 2, ' '); + } + + state.xml += String::compose("", element->get_name().raw()); + + if (should_disable_formatting) { + --state.disable_formatting; + } + } + + --state.indent; } - return out; } + + +/** Format XML much as write_to_string_formatted() would do, except without adding any white space + * to nodes. This is an attempt to avoid changing what is actually displayed as subtitles + * while also formatting the XML in such a way as to avoid DoM bug 2205. + * + * xml_namespace is an optional namespace for the root node; it would be nicer to set this up with + * set_namespace_declaration in the caller and then to extract it here but I couldn't find a way + * to get all namespaces with the libxml++ API. + */ +string +SubtitleAsset::format_xml(xmlpp::Document const& document, optional> xml_namespace) +{ + auto root = document.get_root_node(); + + State state = {}; + state.xml = "\n<" + root->get_name(); + + if (xml_namespace) { + if (xml_namespace->first.empty()) { + state.xml += String::compose(" xmlns=\"%1\"", xml_namespace->second); + } else { + state.xml += String::compose(" xmlns:%1=\"%2\"", xml_namespace->first, xml_namespace->second); + } + } + + for (auto attribute: root->get_attributes()) { + state.xml += String::compose(" %1=\"%2\"", attribute->get_name().raw(), attribute->get_value().raw()); + } + + state.xml += ">"; + + for (auto child: document.get_root_node()->get_children()) { + format_xml_node(child, state); + } + + state.xml += String::compose("\n\n", root->get_name().raw()); + + return state.xml; +} + + +void +SubtitleAsset::ensure_font(string load_id, dcp::ArrayData data) +{ + if (std::find_if(_fonts.begin(), _fonts.end(), [load_id](Font const& font) { return font.load_id == load_id; }) == _fonts.end()) { + add_font(load_id, data); + } +} +