2 Copyright (C) 2013-2017 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/>.
21 #include "text_decoder.h"
22 #include "text_content.h"
25 #include "compose.hpp"
26 #include <sub/subtitle.h>
27 #include <boost/algorithm/string.hpp>
35 using std::shared_ptr;
36 using boost::optional;
37 using boost::function;
38 using namespace dcpomatic;
40 TextDecoder::TextDecoder (
42 shared_ptr<const TextContent> c,
45 : DecoderPart (parent)
52 /** Called by subclasses when an image subtitle is starting.
53 * @param from From time of the subtitle.
54 * @param image Subtitle image.
55 * @param rect Area expressed as a fraction of the video frame that this subtitle
56 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
60 TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
62 BitmapStart (ContentBitmapText (from, image, rect));
67 TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
70 /* We must escape < and > in strings, otherwise they might confuse our subtitle
71 renderer (which uses some HTML-esque markup to do bold/italic etc.)
74 boost::algorithm::replace_all (t, "<", "<");
75 boost::algorithm::replace_all (t, ">", ">");
78 /* Set any forced appearance */
79 if (content()->colour()) {
80 i.set_colour (*content()->colour());
82 if (content()->effect_colour()) {
83 i.set_effect_colour (*content()->effect_colour());
85 if (content()->effect()) {
86 i.set_effect (*content()->effect());
88 if (content()->fade_in()) {
89 i.set_fade_up_time (dcp::Time(content()->fade_in()->seconds(), 1000));
91 if (content()->fade_out()) {
92 i.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000));
96 PlainStart (ContentStringText (from, s));
101 TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
103 /* See if our next subtitle needs to be vertically placed on screen by us */
104 bool needs_placement = false;
105 optional<int> bottom_line;
106 for (auto i: subtitle.lines) {
107 if (!i.vertical_position.reference || (i.vertical_position.line && !i.vertical_position.lines) || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
108 needs_placement = true;
109 if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) {
110 bottom_line = i.vertical_position.line.get();
115 /* Find the lowest proportional position */
116 optional<float> lowest_proportional;
117 for (auto i: subtitle.lines) {
118 if (i.vertical_position.proportional) {
119 if (!lowest_proportional) {
120 lowest_proportional = i.vertical_position.proportional;
122 lowest_proportional = min (lowest_proportional.get(), i.vertical_position.proportional.get());
127 list<dcp::SubtitleString> out;
128 for (auto i: subtitle.lines) {
129 for (auto j: i.blocks) {
131 if (!j.font_size.specified()) {
132 /* Fallback default font size if no other has been specified */
133 j.font_size.set_points (48);
138 if (needs_placement) {
139 DCPOMATIC_ASSERT (i.vertical_position.line);
140 double const multiplier = 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
141 switch (i.vertical_position.reference.get_value_or(sub::BOTTOM_OF_SCREEN)) {
142 case sub::BOTTOM_OF_SCREEN:
143 case sub::TOP_OF_SUBTITLE:
144 /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
145 of the screen a bit to a pleasing degree.
148 (1 + bottom_line.get() - i.vertical_position.line.get()) * multiplier;
150 v_align = dcp::VAlign::TOP;
152 case sub::TOP_OF_SCREEN:
153 /* This 0.1 is another fudge factor to bring the top line away from the top of the screen a little */
154 v_position = 0.12 + i.vertical_position.line.get() * multiplier;
155 v_align = dcp::VAlign::TOP;
157 case sub::VERTICAL_CENTRE_OF_SCREEN:
158 v_position = i.vertical_position.line.get() * multiplier;
159 v_align = dcp::VAlign::CENTER;
163 DCPOMATIC_ASSERT (i.vertical_position.reference);
164 if (i.vertical_position.proportional) {
165 v_position = i.vertical_position.proportional.get();
167 DCPOMATIC_ASSERT (i.vertical_position.line);
168 DCPOMATIC_ASSERT (i.vertical_position.lines);
169 v_position = float(*i.vertical_position.line) / *i.vertical_position.lines;
172 if (lowest_proportional) {
173 /* Adjust line spacing */
174 v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get();
177 switch (i.vertical_position.reference.get()) {
178 case sub::TOP_OF_SCREEN:
179 v_align = dcp::VAlign::TOP;
181 case sub::VERTICAL_CENTRE_OF_SCREEN:
182 v_align = dcp::VAlign::CENTER;
184 case sub::BOTTOM_OF_SCREEN:
185 v_align = dcp::VAlign::BOTTOM;
188 v_align = dcp::VAlign::TOP;
194 float h_position = i.horizontal_position.proportional;
195 switch (i.horizontal_position.reference) {
196 case sub::LEFT_OF_SCREEN:
197 h_align = dcp::HAlign::LEFT;
198 h_position = max(h_position, 0.05f);
200 case sub::HORIZONTAL_CENTRE_OF_SCREEN:
201 h_align = dcp::HAlign::CENTER;
203 case sub::RIGHT_OF_SCREEN:
204 h_align = dcp::HAlign::RIGHT;
205 h_position = max(h_position, 0.05f);
208 h_align = dcp::HAlign::CENTER;
212 /* The idea here (rightly or wrongly) is that we set the appearance based on the
213 values in the libsub objects, and these are overridden with values from the
214 content by the other emit_plain_start() above.
218 dcp::SubtitleString (
219 string(TEXT_FONT_ID),
224 j.font_size.points (72 * 11),
226 dcp::Time (from.seconds(), 1000),
227 /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
236 j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
237 /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
238 but the times of these often don't have a frame rate associated
239 with them so the sub::Time won't convert them to milliseconds without
240 throwing an exception. Since only DCP subs fill those in (and we don't
241 use libsub for DCP subs) we can cheat by just putting 0 in here.
250 emit_plain_start (from, out);
254 TextDecoder::emit_stop (ContentTime to)
260 TextDecoder::emit_plain (ContentTimePeriod period, list<dcp::SubtitleString> s)
262 emit_plain_start (period.from, s);
263 emit_stop (period.to);
267 TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const & s)
269 emit_plain_start (period.from, s);
270 emit_stop (period.to);
273 /* @param rect Area expressed as a fraction of the video frame that this subtitle
274 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
275 * of the video frame)
278 TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
280 emit_bitmap_start (period.from, image, rect);
281 emit_stop (period.to);
287 _position = ContentTime ();