/*
- Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
#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/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;
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");
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;
}
}
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));
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());
}
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) {
}
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;
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::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 (
+ ArrayData (),
+ 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);
}
}
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);
}
SubtitleAsset::latest_subtitle_out () const
{
Time t;
- BOOST_FOREACH (SubtitleString const & i, _subtitles) {
- if (i.out() > t) {
- t = i.out ();
+ BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+ if (i->out() > t) {
+ t = i->out ();
}
}
return false;
}
- if (_subtitles != other->_subtitles) {
- note (DCP_ERROR, "subtitles differ");
+ if (_subtitles.size() != other->_subtitles.size()) {
+ note (DCP_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()) {
+ shared_ptr<SubtitleString> string_i = dynamic_pointer_cast<SubtitleString> (*i);
+ shared_ptr<SubtitleString> string_j = dynamic_pointer_cast<SubtitleString> (*j);
+ shared_ptr<SubtitleImage> image_i = dynamic_pointer_cast<SubtitleImage> (*i);
+ shared_ptr<SubtitleImage> image_j = dynamic_pointer_cast<SubtitleImage> (*j);
+
+ if ((string_i && !string_j) || (image_i && !image_j)) {
+ note (DCP_ERROR, "subtitles differ: string vs. image");
+ return false;
+ }
+
+ if (string_i && *string_i != *string_j) {
+ note (DCP_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 */
+ BOOST_FOREACH (shared_ptr<order::Part> 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;
+ BOOST_FOREACH (shared_ptr<order::Part> 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 */
+ BOOST_FOREACH (shared_ptr<order::Part> 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
+{
+ vector<shared_ptr<Subtitle> > 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.
+ */
+
+ shared_ptr<order::Part> root (new 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;
+
+ BOOST_FOREACH (shared_ptr<Subtitle> 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.reset (new 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));
+ shared_ptr<SubtitleString> 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());
+ shared_ptr<SubtitleImage> 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;
+ map<string, ArrayData> out;
BOOST_FOREACH (Font 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;
+ 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;
+ vector<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);
+ }
+ }
+}