/*
- Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
*/
-#include "text_decoder.h"
+
+#include "compose.hpp"
+#include "log.h"
#include "text_content.h"
+#include "text_decoder.h"
#include "util.h"
-#include "log.h"
-#include "compose.hpp"
#include <sub/subtitle.h>
-#include <boost/shared_ptr.hpp>
-#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <iostream>
-using std::list;
+
using std::cout;
-using std::string;
+using std::max;
using std::min;
-using boost::shared_ptr;
+using std::shared_ptr;
+using std::string;
+using std::vector;
using boost::optional;
-using boost::function;
+using namespace dcpomatic;
+
TextDecoder::TextDecoder (
Decoder* parent,
- shared_ptr<const TextContent> c,
- shared_ptr<Log> log,
- ContentTime first
+ shared_ptr<const TextContent> content
)
- : DecoderPart (parent, log)
- , _content (c)
- , _position (first)
+ : DecoderPart (parent)
+ , _content (content)
{
}
+
/** Called by subclasses when an image subtitle is starting.
* @param from From time of the subtitle.
* @param image Subtitle image.
* of the video frame)
*/
void
-TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
+TextDecoder::emit_bitmap_start (ContentBitmapText const& bitmap)
{
- BitmapStart (ContentBitmapCaption (from, _content->type(), image, rect));
- _position = from;
+ BitmapStart (bitmap);
+ maybe_set_position(bitmap.from());
}
+
+static
void
-TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
+set_forced_appearance(shared_ptr<const TextContent> content, StringText& subtitle)
{
- BOOST_FOREACH (dcp::SubtitleString& i, s) {
- /* We must escape < and > in strings, otherwise they might confuse our subtitle
- renderer (which uses some HTML-esque markup to do bold/italic etc.)
- */
- string t = i.text ();
- boost::algorithm::replace_all (t, "<", "<");
- boost::algorithm::replace_all (t, ">", ">");
- i.set_text (t);
-
- /* Set any forced appearance */
- if (content()->colour()) {
- i.set_colour (*content()->colour());
- }
- if (content()->effect_colour()) {
- i.set_effect_colour (*content()->effect_colour());
- }
- if (content()->effect()) {
- i.set_effect (*content()->effect());
- }
- if (content()->fade_in()) {
- i.set_fade_up_time (dcp::Time(content()->fade_in()->seconds(), 1000));
- }
- if (content()->fade_out()) {
- i.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000));
+ if (content->colour()) {
+ subtitle.set_colour(*content->colour());
+ }
+ if (content->effect_colour()) {
+ subtitle.set_effect_colour(*content->effect_colour());
+ }
+ if (content->effect()) {
+ subtitle.set_effect(*content->effect());
+ }
+ if (content->fade_in()) {
+ subtitle.set_fade_up_time(dcp::Time(content->fade_in()->seconds(), 1000));
+ }
+ if (content->fade_out()) {
+ subtitle.set_fade_down_time (dcp::Time(content->fade_out()->seconds(), 1000));
+ }
+}
+
+
+string
+TextDecoder::remove_invalid_characters_for_xml(string text)
+{
+ string output;
+
+ /* https://www.w3.org/TR/REC-xml/#charsets says that XML may only contain 0x9, 0xa, 0xd below 0x32.
+ * Not sure if we should be doing direct UTF-8 manipulation here.
+ */
+ for (size_t i = 0; i < text.length(); ++i) {
+ auto const c = text[i];
+ if ((c & 0xe0) == 0xc0) {
+ // start of 2-byte code point
+ output += c;
+ output += text[i + 1];
+ ++i;
+ } else if ((c & 0xf0) == 0xe0) {
+ // start of 3-byte code point
+ output += c;
+ output += text[i + 1];
+ output += text[i + 2];
+ i += 2;
+ } else if ((c & 0xf8) == 0xf0) {
+ // start of 4-byte code point
+ output += c;
+ output += text[i + 1];
+ output += text[i + 2];
+ output += text[i + 3];
+ i += 3;
+ } else {
+ if (c >= 0x20 || c == 0x9 || c == 0xa || c == 0xd) {
+ output += c;
+ }
}
}
- PlainStart (ContentTextCaption (from, _content->type(), s));
- _position = from;
+ return output;
}
+
void
-TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
+TextDecoder::emit_plain_start(ContentTime from, vector<dcp::SubtitleString> subtitles, dcp::SubtitleStandard valign_standard)
+{
+ vector<StringText> string_texts;
+
+ for (auto& subtitle: subtitles) {
+ auto font = content()->get_font(subtitle.font().get_value_or(""));
+ DCPOMATIC_ASSERT(font);
+ auto string_text = StringText(subtitle, content()->outline_width(), font, valign_standard);
+ string_text.set_text(remove_invalid_characters_for_xml(string_text.text()));
+ set_forced_appearance(content(), string_text);
+ string_texts.push_back(string_text);
+ }
+
+ PlainStart(ContentStringText(from, string_texts));
+ maybe_set_position(from);
+}
+
+
+void
+TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & sub_subtitle)
{
/* See if our next subtitle needs to be vertically placed on screen by us */
bool needs_placement = false;
optional<int> bottom_line;
- BOOST_FOREACH (sub::Line i, subtitle.lines) {
- if (!i.vertical_position.reference || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
+ for (auto line: sub_subtitle.lines) {
+ if (!line.vertical_position.reference || (line.vertical_position.line && !line.vertical_position.lines) || line.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
needs_placement = true;
- DCPOMATIC_ASSERT (i.vertical_position.line);
- if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) {
- bottom_line = i.vertical_position.line.get();
+ if (!bottom_line || bottom_line.get() < line.vertical_position.line.get()) {
+ bottom_line = line.vertical_position.line.get();
}
}
}
/* Find the lowest proportional position */
optional<float> lowest_proportional;
- BOOST_FOREACH (sub::Line i, subtitle.lines) {
- if (i.vertical_position.proportional) {
+ for (auto line: sub_subtitle.lines) {
+ if (line.vertical_position.proportional) {
if (!lowest_proportional) {
- lowest_proportional = i.vertical_position.proportional;
+ lowest_proportional = line.vertical_position.proportional;
} else {
- lowest_proportional = min (lowest_proportional.get(), i.vertical_position.proportional.get());
+ lowest_proportional = min(lowest_proportional.get(), line.vertical_position.proportional.get());
}
}
}
- list<dcp::SubtitleString> out;
- BOOST_FOREACH (sub::Line i, subtitle.lines) {
- BOOST_FOREACH (sub::Block j, i.blocks) {
+ vector<StringText> string_texts;
+ for (auto line: sub_subtitle.lines) {
+ for (auto block: line.blocks) {
- if (!j.font_size.specified()) {
+ if (!block.font_size.specified()) {
/* Fallback default font size if no other has been specified */
- j.font_size.set_points (48);
+ block.font_size.set_points (48);
}
float v_position;
dcp::VAlign v_align;
if (needs_placement) {
- DCPOMATIC_ASSERT (i.vertical_position.line);
- /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
- of the screen a bit to a pleasing degree.
- */
- v_position = 1.015 -
- (1 + bottom_line.get() - i.vertical_position.line.get())
- * 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
+ DCPOMATIC_ASSERT (line.vertical_position.line);
+ double const multiplier = 1.2 * content()->line_spacing() * content()->y_scale() * block.font_size.proportional (72 * 11);
+ switch (line.vertical_position.reference.get_value_or(sub::BOTTOM_OF_SCREEN)) {
+ case sub::BOTTOM_OF_SCREEN:
+ case sub::TOP_OF_SUBTITLE:
+ /* This 0.1 is an arbitrary value to lift the bottom sub off the bottom
+ of the screen a bit to a pleasing degree.
+ */
+ v_position = 0.1 +
+ (1 + bottom_line.get() - line.vertical_position.line.get()) * multiplier;
- v_align = dcp::VALIGN_TOP;
+ /* Align our subtitles to the bottom of the screen, because if we are making a SMPTE
+ * DCP and the projection system uses the wrong standard to interpret vertical position,
+ * a bottom-aligned subtitle will be less wrong than a top-aligned one. This is because
+ * in the top-aligned case the difference will be the distance between bbox top an
+ * baseline, but in the bottom-aligned case the difference will be between bbox bottom
+ * and baseline (which is shorter).
+ */
+ v_align = dcp::VAlign::BOTTOM;
+ break;
+ case sub::TOP_OF_SCREEN:
+ /* This 0.1 is another fudge factor to bring the top line away from the top of the screen a little */
+ v_position = 0.12 + line.vertical_position.line.get() * multiplier;
+ v_align = dcp::VAlign::TOP;
+ break;
+ case sub::VERTICAL_CENTRE_OF_SCREEN:
+ v_position = line.vertical_position.line.get() * multiplier;
+ v_align = dcp::VAlign::CENTER;
+ break;
+ }
} else {
- DCPOMATIC_ASSERT (i.vertical_position.proportional);
- DCPOMATIC_ASSERT (i.vertical_position.reference);
- v_position = i.vertical_position.proportional.get();
+ DCPOMATIC_ASSERT (line.vertical_position.reference);
+ if (line.vertical_position.proportional) {
+ v_position = line.vertical_position.proportional.get();
+ } else {
+ DCPOMATIC_ASSERT (line.vertical_position.line);
+ DCPOMATIC_ASSERT (line.vertical_position.lines);
+ v_position = float(*line.vertical_position.line) / *line.vertical_position.lines;
+ }
if (lowest_proportional) {
/* Adjust line spacing */
v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get();
}
- switch (i.vertical_position.reference.get()) {
+ switch (line.vertical_position.reference.get()) {
case sub::TOP_OF_SCREEN:
- v_align = dcp::VALIGN_TOP;
+ v_align = dcp::VAlign::TOP;
break;
case sub::VERTICAL_CENTRE_OF_SCREEN:
- v_align = dcp::VALIGN_CENTER;
+ v_align = dcp::VAlign::CENTER;
break;
case sub::BOTTOM_OF_SCREEN:
- v_align = dcp::VALIGN_BOTTOM;
+ v_align = dcp::VAlign::BOTTOM;
break;
default:
- v_align = dcp::VALIGN_TOP;
+ v_align = dcp::VAlign::TOP;
break;
}
}
dcp::HAlign h_align;
- switch (i.horizontal_position.reference) {
+ float h_position = line.horizontal_position.proportional;
+ switch (line.horizontal_position.reference) {
case sub::LEFT_OF_SCREEN:
- h_align = dcp::HALIGN_LEFT;
+ h_align = dcp::HAlign::LEFT;
+ h_position = max(h_position, 0.05f);
break;
case sub::HORIZONTAL_CENTRE_OF_SCREEN:
- h_align = dcp::HALIGN_CENTER;
+ h_align = dcp::HAlign::CENTER;
break;
case sub::RIGHT_OF_SCREEN:
- h_align = dcp::HALIGN_RIGHT;
+ h_align = dcp::HAlign::RIGHT;
+ h_position = max(h_position, 0.05f);
break;
default:
- h_align = dcp::HALIGN_CENTER;
+ h_align = dcp::HAlign::CENTER;
break;
}
content by the other emit_plain_start() above.
*/
- out.push_back (
- dcp::SubtitleString (
- string(TEXT_FONT_ID),
- j.italic,
- j.bold,
- j.underline,
- j.colour.dcp(),
- j.font_size.points (72 * 11),
- 1.0,
- dcp::Time (from.seconds(), 1000),
- /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
- dcp::Time (),
- i.horizontal_position.proportional,
- h_align,
- v_position,
- v_align,
- dcp::DIRECTION_LTR,
- j.text,
- dcp::NONE,
- j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
- /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
- but the times of these often don't have a frame rate associated
- with them so the sub::Time won't convert them to milliseconds without
- throwing an exception. Since only DCP subs fill those in (and we don't
- use libsub for DCP subs) we can cheat by just putting 0 in here.
- */
- dcp::Time (),
- dcp::Time ()
- )
+ auto dcp_colour = [](sub::Colour const& c) {
+ return dcp::Colour(lrintf(c.r * 255), lrintf(c.g * 255), lrintf(c.b * 255));
+ };
+
+ auto dcp_subtitle = dcp::SubtitleString(
+ optional<string>(),
+ block.italic,
+ block.bold,
+ block.underline,
+ dcp_colour(block.colour),
+ block.font_size.points (72 * 11),
+ 1.0,
+ dcp::Time (from.seconds(), 1000),
+ /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
+ dcp::Time (),
+ h_position,
+ h_align,
+ v_position,
+ v_align,
+ 0,
+ dcp::Direction::LTR,
+ remove_invalid_characters_for_xml(block.text),
+ dcp::Effect::NONE,
+ dcp_colour(block.effect_colour.get_value_or(sub::Colour(0, 0, 0))),
+ /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
+ but the times of these often don't have a frame rate associated
+ with them so the sub::Time won't convert them to milliseconds without
+ throwing an exception. Since only DCP subs fill those in (and we don't
+ use libsub for DCP subs) we can cheat by just putting 0 in here.
+ */
+ dcp::Time (),
+ dcp::Time (),
+ 0,
+ std::vector<dcp::Ruby>()
);
+
+ auto font = content()->get_font(block.font.get_value_or(""));
+ DCPOMATIC_ASSERT(font);
+
+ auto string_text = StringText(
+ dcp_subtitle,
+ content()->outline_width(),
+ font,
+ dcp::SubtitleStandard::SMPTE_2014
+ );
+ set_forced_appearance(content(), string_text);
+ string_texts.push_back(string_text);
}
}
- emit_plain_start (from, out);
+ PlainStart(ContentStringText(from, string_texts));
+ maybe_set_position(from);
}
+
void
TextDecoder::emit_stop (ContentTime to)
{
- Stop (to, _content->type());
+ Stop (to);
}
+
void
-TextDecoder::emit_plain (ContentTimePeriod period, list<dcp::SubtitleString> s)
+TextDecoder::emit_plain(ContentTimePeriod period, vector<dcp::SubtitleString> subtitles, dcp::SubtitleStandard valign_standard)
{
- emit_plain_start (period.from, s);
+ emit_plain_start (period.from, subtitles, valign_standard);
emit_stop (period.to);
}
+
void
-TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const & s)
+TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const& subtitles)
{
- emit_plain_start (period.from, s);
+ emit_plain_start (period.from, subtitles);
emit_stop (period.to);
}
+
+/* @param rect Area expressed as a fraction of the video frame that this subtitle
+ * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
+ * of the video frame)
+ */
+void
+TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<const Image> image, dcpomatic::Rect<double> rect)
+{
+ emit_bitmap_start ({ period.from, image, rect });
+ emit_stop (period.to);
+}
+
+
void
TextDecoder::seek ()
{
_position = ContentTime ();
}
+
+
+void
+TextDecoder::maybe_set_position (dcpomatic::ContentTime position)
+{
+ if (!_position || position > *_position) {
+ _position = position;
+ }
+}
+