2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "compose.hpp"
24 #include "text_content.h"
25 #include "text_decoder.h"
27 #include <sub/subtitle.h>
28 #include <boost/algorithm/string.hpp>
35 using std::shared_ptr;
38 using boost::optional;
39 using namespace dcpomatic;
42 TextDecoder::TextDecoder (
44 shared_ptr<const TextContent> content,
47 : DecoderPart (parent)
55 /** Called by subclasses when an image subtitle is starting.
56 * @param from From time of the subtitle.
57 * @param image Subtitle image.
58 * @param rect Area expressed as a fraction of the video frame that this subtitle
59 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
63 TextDecoder::emit_bitmap_start (ContentBitmapText const& bitmap)
66 _position = bitmap.from();
72 escape_text (string text)
74 /* We must escape some things, otherwise they might confuse our subtitle
75 renderer (which uses entities and some HTML-esque markup to do bold/italic etc.)
77 boost::algorithm::replace_all(text, "&", "&");
78 boost::algorithm::replace_all(text, "<", "<");
79 boost::algorithm::replace_all(text, ">", ">");
85 TextDecoder::emit_plain_start (ContentTime from, vector<dcp::SubtitleString> subtitles)
87 for (auto& subtitle: subtitles) {
88 subtitle.set_text(escape_text(subtitle.text()));
90 /* Set any forced appearance */
91 if (content()->colour()) {
92 subtitle.set_colour(*content()->colour());
94 if (content()->effect_colour()) {
95 subtitle.set_effect_colour(*content()->effect_colour());
97 if (content()->effect()) {
98 subtitle.set_effect(*content()->effect());
100 if (content()->fade_in()) {
101 subtitle.set_fade_up_time(dcp::Time(content()->fade_in()->seconds(), 1000));
103 if (content()->fade_out()) {
104 subtitle.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000));
108 PlainStart(ContentStringText(from, subtitles));
114 TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
116 /* See if our next subtitle needs to be vertically placed on screen by us */
117 bool needs_placement = false;
118 optional<int> bottom_line;
119 for (auto line: subtitle.lines) {
120 if (!line.vertical_position.reference || (line.vertical_position.line && !line.vertical_position.lines) || line.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
121 needs_placement = true;
122 if (!bottom_line || bottom_line.get() < line.vertical_position.line.get()) {
123 bottom_line = line.vertical_position.line.get();
128 /* Find the lowest proportional position */
129 optional<float> lowest_proportional;
130 for (auto line: subtitle.lines) {
131 if (line.vertical_position.proportional) {
132 if (!lowest_proportional) {
133 lowest_proportional = line.vertical_position.proportional;
135 lowest_proportional = min(lowest_proportional.get(), line.vertical_position.proportional.get());
140 vector<dcp::SubtitleString> out;
141 for (auto line: subtitle.lines) {
142 for (auto block: line.blocks) {
144 if (!block.font_size.specified()) {
145 /* Fallback default font size if no other has been specified */
146 block.font_size.set_points (48);
151 if (needs_placement) {
152 DCPOMATIC_ASSERT (line.vertical_position.line);
153 double const multiplier = 1.2 * content()->line_spacing() * content()->y_scale() * block.font_size.proportional (72 * 11);
154 switch (line.vertical_position.reference.get_value_or(sub::BOTTOM_OF_SCREEN)) {
155 case sub::BOTTOM_OF_SCREEN:
156 case sub::TOP_OF_SUBTITLE:
157 /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
158 of the screen a bit to a pleasing degree.
161 (1 + bottom_line.get() - line.vertical_position.line.get()) * multiplier;
163 v_align = dcp::VAlign::TOP;
165 case sub::TOP_OF_SCREEN:
166 /* This 0.1 is another fudge factor to bring the top line away from the top of the screen a little */
167 v_position = 0.12 + line.vertical_position.line.get() * multiplier;
168 v_align = dcp::VAlign::TOP;
170 case sub::VERTICAL_CENTRE_OF_SCREEN:
171 v_position = line.vertical_position.line.get() * multiplier;
172 v_align = dcp::VAlign::CENTER;
176 DCPOMATIC_ASSERT (line.vertical_position.reference);
177 if (line.vertical_position.proportional) {
178 v_position = line.vertical_position.proportional.get();
180 DCPOMATIC_ASSERT (line.vertical_position.line);
181 DCPOMATIC_ASSERT (line.vertical_position.lines);
182 v_position = float(*line.vertical_position.line) / *line.vertical_position.lines;
185 if (lowest_proportional) {
186 /* Adjust line spacing */
187 v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get();
190 switch (line.vertical_position.reference.get()) {
191 case sub::TOP_OF_SCREEN:
192 v_align = dcp::VAlign::TOP;
194 case sub::VERTICAL_CENTRE_OF_SCREEN:
195 v_align = dcp::VAlign::CENTER;
197 case sub::BOTTOM_OF_SCREEN:
198 v_align = dcp::VAlign::BOTTOM;
201 v_align = dcp::VAlign::TOP;
207 float h_position = line.horizontal_position.proportional;
208 switch (line.horizontal_position.reference) {
209 case sub::LEFT_OF_SCREEN:
210 h_align = dcp::HAlign::LEFT;
211 h_position = max(h_position, 0.05f);
213 case sub::HORIZONTAL_CENTRE_OF_SCREEN:
214 h_align = dcp::HAlign::CENTER;
216 case sub::RIGHT_OF_SCREEN:
217 h_align = dcp::HAlign::RIGHT;
218 h_position = max(h_position, 0.05f);
221 h_align = dcp::HAlign::CENTER;
225 /* The idea here (rightly or wrongly) is that we set the appearance based on the
226 values in the libsub objects, and these are overridden with values from the
227 content by the other emit_plain_start() above.
231 dcp::SubtitleString (
232 string(TEXT_FONT_ID),
237 block.font_size.points (72 * 11),
239 dcp::Time (from.seconds(), 1000),
240 /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
249 block.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
250 /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
251 but the times of these often don't have a frame rate associated
252 with them so the sub::Time won't convert them to milliseconds without
253 throwing an exception. Since only DCP subs fill those in (and we don't
254 use libsub for DCP subs) we can cheat by just putting 0 in here.
264 /* Pass these subs through the other emit_plain_start so that they get their forced settings applied */
265 emit_plain_start (from, out);
270 TextDecoder::emit_stop (ContentTime to)
277 TextDecoder::emit_plain (ContentTimePeriod period, vector<dcp::SubtitleString> subtitles)
279 emit_plain_start (period.from, subtitles);
280 emit_stop (period.to);
285 TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const& subtitles)
287 emit_plain_start (period.from, subtitles);
288 emit_stop (period.to);
292 /* @param rect Area expressed as a fraction of the video frame that this subtitle
293 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
294 * of the video frame)
297 TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<const Image> image, dcpomatic::Rect<double> rect)
299 emit_bitmap_start ({ period.from, image, rect });
300 emit_stop (period.to);
307 _position = ContentTime ();