/*
- Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
#include "util.h"
#include "xml.h"
#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>
using std::cout;
using std::cerr;
using std::map;
-using std::distance;
using boost::shared_ptr;
using boost::shared_array;
using boost::optional;
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;
}
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, list<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 (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<SubtitleString>
+list<shared_ptr<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)) {
+ list<shared_ptr<Subtitle> > s;
+ BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+ if ((starting && from <= i->in() && i->in() < to) || (!starting && i->out() >= from && i->in() <= to)) {
s.push_back (i);
}
}
}
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) {
+ if (_subtitles.size() != other->_subtitles.size()) {
note (DCP_ERROR, "subtitles differ");
return false;
}
+ list<shared_ptr<Subtitle> >::const_iterator i = _subtitles.begin ();
+ list<shared_ptr<Subtitle> >::const_iterator 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");
+ return false;
+ }
+
+ if (string_i && *string_i != *string_j) {
+ note (DCP_ERROR, "subtitles differ");
+ return false;
+ }
+
+ if (image_i && *image_i != *image_j) {
+ note (DCP_ERROR, "subtitles differ");
+ 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();
+ 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();
}
};
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 {
void
SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, Standard standard) const
{
- list<SubtitleString> sorted = _subtitles;
+ list<shared_ptr<Subtitle> > sorted = _subtitles;
sorted.sort (SubtitleSorter ());
/* Gather our subtitles into a hierarchy of Subtitle/Text/String objects, writing
float last_v_position;
Direction last_direction;
- BOOST_FOREACH (SubtitleString const & i, sorted) {
+ 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())
+ (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()));
+ 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 ();
+ 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 (!text ||
- last_h_align != i.h_align() ||
- fabs(last_h_position - i.h_position()) > ALIGN_EPSILON ||
- last_v_align != i.v_align() ||
- fabs(last_v_position - i.v_position()) > ALIGN_EPSILON ||
- last_direction != i.direction()
- ) {
-
- text.reset (new order::Text (subtitle, i.h_align(), i.h_position(), i.v_align(), i.v_position(), i.direction()));
- subtitle->children.push_back (text);
+ 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 ();
+ }
- last_h_align = i.h_align ();
- last_h_position = i.h_position ();
- last_v_align = i.v_align ();
- last_v_position = i.v_position ();
- last_direction = i.direction ();
+ text->children.push_back (shared_ptr<order::String> (new order::String (text, order::Font (is, standard), is->text())));
}
- text->children.push_back (shared_ptr<order::String> (new order::String (text, order::Font (i, standard), 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 */
}
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);
+ }
+ }
+}