X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle_asset.cc;h=22781196ac5c485ca042ba8813895e06a85db7f1;hb=refs%2Ftags%2Fv1.8.4;hp=9d46cb5ce3fddc3355d8571b2bd71a4e2b211bb9;hpb=9691fc54fa6a3409520a1a42e6eeb8e6a235f5f6;p=libdcp.git diff --git a/src/subtitle_asset.cc b/src/subtitle_asset.cc index 9d46cb5c..22781196 100644 --- a/src/subtitle_asset.cc +++ b/src/subtitle_asset.cc @@ -31,6 +31,12 @@ 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" @@ -48,7 +54,7 @@ #include #include #include -#include + using std::dynamic_pointer_cast; using std::string; @@ -58,58 +64,63 @@ using std::map; using std::shared_ptr; using std::vector; using std::make_shared; -using boost::shared_array; using boost::optional; 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 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(); + return {}; } return string (a->get_value ()); } + optional optional_bool_attribute (xmlpp::Element const * node, string name) { - optional s = optional_string_attribute (node, name); + auto s = optional_string_attribute (node, name); if (!s) { - return optional (); + return {}; } return (s.get() == "1" || s.get() == "yes"); } + template optional optional_number_attribute (xmlpp::Element const * node, string name) { - boost::optional s = optional_string_attribute (node, name); + auto s = optional_string_attribute (node, name); if (!s) { return boost::optional (); } @@ -119,6 +130,7 @@ optional_number_attribute (xmlpp::Element const * node, string name) return raw_convert (t); } + SubtitleAsset::ParseState SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) const { @@ -138,11 +150,11 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) } else { ps.underline = optional_bool_attribute (node, "Underline"); } - optional c = optional_string_attribute (node, "Color"); + auto c = optional_string_attribute (node, "Color"); if (c) { ps.colour = Colour (c.get ()); } - optional const e = optional_string_attribute (node, "Effect"); + auto const e = optional_string_attribute (node, "Effect"); if (e) { ps.effect = string_to_effect (e.get ()); } @@ -157,7 +169,7 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) void SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element const * node) const { - optional hp = optional_number_attribute (node, "HPosition"); + auto hp = optional_number_attribute (node, "HPosition"); if (!hp) { hp = optional_number_attribute (node, "Hposition"); } @@ -165,7 +177,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con ps.h_position = hp.get () / 100; } - optional ha = optional_string_attribute (node, "HAlign"); + auto ha = optional_string_attribute (node, "HAlign"); if (!ha) { ha = optional_string_attribute (node, "Halign"); } @@ -173,7 +185,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con ps.h_align = string_to_halign (ha.get ()); } - optional vp = optional_number_attribute (node, "VPosition"); + auto vp = optional_number_attribute (node, "VPosition"); if (!vp) { vp = optional_number_attribute (node, "Vposition"); } @@ -181,7 +193,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con ps.v_position = vp.get () / 100; } - optional va = optional_string_attribute (node, "VAlign"); + auto va = optional_string_attribute (node, "VAlign"); if (!va) { va = optional_string_attribute (node, "Valign"); } @@ -191,6 +203,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con } + SubtitleAsset::ParseState SubtitleAsset::text_node_state (xmlpp::Element const * node) const { @@ -198,7 +211,7 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const position_align (ps, node); - optional d = optional_string_attribute (node, "Direction"); + auto d = optional_string_attribute (node, "Direction"); if (d) { ps.direction = string_to_direction (d.get ()); } @@ -208,6 +221,7 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const return ps; } + SubtitleAsset::ParseState SubtitleAsset::image_node_state (xmlpp::Element const * node) const { @@ -220,6 +234,7 @@ SubtitleAsset::image_node_state (xmlpp::Element const * node) const return ps; } + SubtitleAsset::ParseState SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional tcr) const { @@ -231,10 +246,11 @@ SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional t return ps; } + Time SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional 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 ()) { @@ -252,6 +268,7 @@ SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional& state, optional tcr, Standard standard) { @@ -269,30 +286,44 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector& 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 (*i); + float space_before = 0; + + for (auto i: node->get_children()) { + auto const v = dynamic_cast(i); if (v) { - maybe_add_subtitle (v->get_content(), state, standard); + maybe_add_subtitle (v->get_content(), state, space_before, standard); + space_before = 0; } - xmlpp::Element const * e = dynamic_cast (*i); + auto const e = dynamic_cast(i); if (e) { - parse_subtitles (e, state, tcr, standard); + 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 { + parse_subtitles (e, state, tcr, standard); + } } } state.pop_back (); } + void -SubtitleAsset::maybe_add_subtitle (string text, vector const & parse_state, Standard standard) +SubtitleAsset::maybe_add_subtitle (string text, vector const & parse_state, float space_before, 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(); } @@ -362,51 +393,69 @@ SubtitleAsset::maybe_add_subtitle (string text, vector const & parse switch (ps.type.get()) { case ParseState::Type::TEXT: _subtitles.push_back ( - shared_ptr ( - 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 (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()) - ) + 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.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 ) ); 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 ( - shared_ptr ( - new 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()) - ) + 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.fade_up_time.get_value_or(Time()), + ps.fade_down_time.get_value_or(Time()) ) ); break; } + } } @@ -461,6 +510,7 @@ SubtitleAsset::add (shared_ptr s) _subtitles.push_back (s); } + Time SubtitleAsset::latest_subtitle_out () const { @@ -474,6 +524,7 @@ SubtitleAsset::latest_subtitle_out () const return t; } + bool SubtitleAsset::equals (shared_ptr other_asset, EqualityOptions options, NoteHandler note) const { @@ -495,10 +546,10 @@ SubtitleAsset::equals (shared_ptr other_asset, EqualityOptions opti auto j = other->_subtitles.begin(); while (i != _subtitles.end()) { - shared_ptr string_i = dynamic_pointer_cast (*i); - shared_ptr string_j = dynamic_pointer_cast (*j); - shared_ptr image_i = dynamic_pointer_cast (*i); - shared_ptr image_j = dynamic_pointer_cast (*j); + 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"); @@ -521,16 +572,21 @@ SubtitleAsset::equals (shared_ptr other_asset, EqualityOptions opti return true; } + 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(); } }; + void SubtitleAsset::pull_fonts (shared_ptr part) { @@ -548,12 +604,12 @@ SubtitleAsset::pull_fonts (shared_ptr part) these features go into part's font. */ part->font = part->children.front()->font; - BOOST_FOREACH (shared_ptr i, part->children) { + for (auto i: part->children) { part->font.take_intersection (i->font); } /* Remove common values from part's children's fonts */ - BOOST_FOREACH (shared_ptr i, part->children) { + for (auto i: part->children) { i->font.take_difference (part->font); } } @@ -591,6 +647,7 @@ SubtitleAsset::pull_fonts (shared_ptr part) 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. */ @@ -645,7 +702,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S 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())); + text = make_shared(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 (); @@ -655,14 +712,14 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S last_direction = is->direction (); } - text->children.push_back (shared_ptr (new order::String (text, order::Font (is, standard), is->text()))); + text->children.push_back (make_shared(text, order::Font (is, standard), is->text(), is->space_before())); } - shared_ptr ii = dynamic_pointer_cast(i); + auto ii = dynamic_pointer_cast(i); if (ii) { text.reset (); subtitle->children.push_back ( - shared_ptr (new order::Image (subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position())) + make_shared(subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position()) ); } } @@ -681,11 +738,12 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S root->write_xml (xml_root, context); } + map SubtitleAsset::font_data () const { map out; - BOOST_FOREACH (Font const & i, _fonts) { + for (auto const& i: _fonts) { out[i.load_id] = i.data; } return out; @@ -696,7 +754,7 @@ map SubtitleAsset::font_filenames () const { map out; - BOOST_FOREACH (Font const& i, _fonts) { + for (auto const& i: _fonts) { if (i.file) { out[i.load_id] = *i.file; } @@ -714,7 +772,7 @@ SubtitleAsset::fix_empty_font_ids () { bool have_empty = false; vector ids; - BOOST_FOREACH (shared_ptr i, load_font_nodes()) { + for (auto i: load_font_nodes()) { if (i->id == "") { have_empty = true; } else { @@ -728,14 +786,14 @@ SubtitleAsset::fix_empty_font_ids () string const empty_id = unique_string (ids, "font"); - BOOST_FOREACH (shared_ptr i, load_font_nodes()) { + for (auto i: load_font_nodes()) { if (i->id == "") { i->id = empty_id; } } - BOOST_FOREACH (shared_ptr i, _subtitles) { - shared_ptr j = dynamic_pointer_cast (i); + for (auto i: _subtitles) { + auto j = dynamic_pointer_cast (i); if (j && j->font() && j->font().get() == "") { j->set_font (empty_id); }