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 "text_decoder.h"
23 #include "text_content.h"
26 #include "compose.hpp"
27 #include <sub/subtitle.h>
28 #include <boost/algorithm/string.hpp>
37 using std::shared_ptr;
38 using boost::optional;
40 using namespace dcpomatic;
43 TextDecoder::TextDecoder (
45 shared_ptr<const TextContent> c,
48 : DecoderPart (parent)
56 /** Called by subclasses when an image subtitle is starting.
57 * @param from From time of the subtitle.
58 * @param image Subtitle image.
59 * @param rect Area expressed as a fraction of the video frame that this subtitle
60 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
64 TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
66 BitmapStart (ContentBitmapText (from, image, rect));
72 TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
75 /* We must escape some things, otherwise they might confuse our subtitle
76 renderer (which uses entities and some HTML-esque markup to do bold/italic etc.)
79 boost::algorithm::replace_all (t, "&", "&");
80 boost::algorithm::replace_all (t, "<", "<");
81 boost::algorithm::replace_all (t, ">", ">");
84 /* Set any forced appearance */
85 if (content()->colour()) {
86 i.set_colour (*content()->colour());
88 if (content()->effect_colour()) {
89 i.set_effect_colour (*content()->effect_colour());
91 if (content()->effect()) {
92 i.set_effect (*content()->effect());
94 if (content()->fade_in()) {
95 i.set_fade_up_time (dcp::Time(content()->fade_in()->seconds(), 1000));
97 if (content()->fade_out()) {
98 i.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000));
102 PlainStart (ContentStringText (from, s));
108 TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
110 /* See if our next subtitle needs to be vertically placed on screen by us */
111 bool needs_placement = false;
112 optional<int> bottom_line;
113 for (auto i: subtitle.lines) {
114 if (!i.vertical_position.reference || (i.vertical_position.line && !i.vertical_position.lines) || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
115 needs_placement = true;
116 if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) {
117 bottom_line = i.vertical_position.line.get();
122 /* Find the lowest proportional position */
123 optional<float> lowest_proportional;
124 for (auto i: subtitle.lines) {
125 if (i.vertical_position.proportional) {
126 if (!lowest_proportional) {
127 lowest_proportional = i.vertical_position.proportional;
129 lowest_proportional = min (lowest_proportional.get(), i.vertical_position.proportional.get());
134 list<dcp::SubtitleString> out;
135 for (auto i: subtitle.lines) {
136 for (auto j: i.blocks) {
138 if (!j.font_size.specified()) {
139 /* Fallback default font size if no other has been specified */
140 j.font_size.set_points (48);
145 if (needs_placement) {
146 DCPOMATIC_ASSERT (i.vertical_position.line);
147 double const multiplier = 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
148 switch (i.vertical_position.reference.get_value_or(sub::BOTTOM_OF_SCREEN)) {
149 case sub::BOTTOM_OF_SCREEN:
150 case sub::TOP_OF_SUBTITLE:
151 /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
152 of the screen a bit to a pleasing degree.
155 (1 + bottom_line.get() - i.vertical_position.line.get()) * multiplier;
157 v_align = dcp::VAlign::TOP;
159 case sub::TOP_OF_SCREEN:
160 /* This 0.1 is another fudge factor to bring the top line away from the top of the screen a little */
161 v_position = 0.12 + i.vertical_position.line.get() * multiplier;
162 v_align = dcp::VAlign::TOP;
164 case sub::VERTICAL_CENTRE_OF_SCREEN:
165 v_position = i.vertical_position.line.get() * multiplier;
166 v_align = dcp::VAlign::CENTER;
170 DCPOMATIC_ASSERT (i.vertical_position.reference);
171 if (i.vertical_position.proportional) {
172 v_position = i.vertical_position.proportional.get();
174 DCPOMATIC_ASSERT (i.vertical_position.line);
175 DCPOMATIC_ASSERT (i.vertical_position.lines);
176 v_position = float(*i.vertical_position.line) / *i.vertical_position.lines;
179 if (lowest_proportional) {
180 /* Adjust line spacing */
181 v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get();
184 switch (i.vertical_position.reference.get()) {
185 case sub::TOP_OF_SCREEN:
186 v_align = dcp::VAlign::TOP;
188 case sub::VERTICAL_CENTRE_OF_SCREEN:
189 v_align = dcp::VAlign::CENTER;
191 case sub::BOTTOM_OF_SCREEN:
192 v_align = dcp::VAlign::BOTTOM;
195 v_align = dcp::VAlign::TOP;
201 float h_position = i.horizontal_position.proportional;
202 switch (i.horizontal_position.reference) {
203 case sub::LEFT_OF_SCREEN:
204 h_align = dcp::HAlign::LEFT;
205 h_position = max(h_position, 0.05f);
207 case sub::HORIZONTAL_CENTRE_OF_SCREEN:
208 h_align = dcp::HAlign::CENTER;
210 case sub::RIGHT_OF_SCREEN:
211 h_align = dcp::HAlign::RIGHT;
212 h_position = max(h_position, 0.05f);
215 h_align = dcp::HAlign::CENTER;
219 /* The idea here (rightly or wrongly) is that we set the appearance based on the
220 values in the libsub objects, and these are overridden with values from the
221 content by the other emit_plain_start() above.
225 dcp::SubtitleString (
226 string(TEXT_FONT_ID),
231 j.font_size.points (72 * 11),
233 dcp::Time (from.seconds(), 1000),
234 /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
243 j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
244 /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
245 but the times of these often don't have a frame rate associated
246 with them so the sub::Time won't convert them to milliseconds without
247 throwing an exception. Since only DCP subs fill those in (and we don't
248 use libsub for DCP subs) we can cheat by just putting 0 in here.
257 emit_plain_start (from, out);
262 TextDecoder::emit_stop (ContentTime to)
269 TextDecoder::emit_plain (ContentTimePeriod period, list<dcp::SubtitleString> s)
271 emit_plain_start (period.from, s);
272 emit_stop (period.to);
277 TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const & s)
279 emit_plain_start (period.from, s);
280 emit_stop (period.to);
284 /* @param rect Area expressed as a fraction of the video frame that this subtitle
285 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
286 * of the video frame)
289 TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
291 emit_bitmap_start (period.from, image, rect);
292 emit_stop (period.to);
299 _position = ContentTime ();