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 "subtitle_decoder.h"
22 #include "subtitle_content.h"
25 #include "compose.hpp"
26 #include <sub/subtitle.h>
27 #include <boost/shared_ptr.hpp>
28 #include <boost/foreach.hpp>
29 #include <boost/algorithm/string.hpp>
36 using boost::shared_ptr;
37 using boost::optional;
38 using boost::function;
40 SubtitleDecoder::SubtitleDecoder (
42 shared_ptr<const SubtitleContent> c,
46 : DecoderPart (parent, log)
53 /** Called by subclasses when an image subtitle is starting.
54 * @param from From time of the subtitle.
55 * @param image Subtitle image.
56 * @param rect Area expressed as a fraction of the video frame that this subtitle
57 * is for (e.g. a width of 0.5 means the width of the subtitle is half the width
61 SubtitleDecoder::emit_image_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
63 ImageStart (ContentImageSubtitle (from, image, rect));
67 SubtitleDecoder::emit_text_start (ContentTime from, list<dcp::SubtitleString> s)
69 BOOST_FOREACH (dcp::SubtitleString& i, 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 TextStart (ContentTextSubtitle (from, s));
101 SubtitleDecoder::emit_text_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 BOOST_FOREACH (sub::Line i, subtitle.lines) {
107 if (!i.vertical_position.reference || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
108 needs_placement = true;
109 DCPOMATIC_ASSERT (i.vertical_position.line);
110 if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) {
111 bottom_line = i.vertical_position.line.get();
116 /* Find the lowest proportional position */
117 optional<float> lowest_proportional;
118 BOOST_FOREACH (sub::Line i, subtitle.lines) {
119 if (i.vertical_position.proportional) {
120 if (!lowest_proportional) {
121 lowest_proportional = i.vertical_position.proportional;
123 lowest_proportional = min (lowest_proportional.get(), i.vertical_position.proportional.get());
128 list<dcp::SubtitleString> out;
129 BOOST_FOREACH (sub::Line i, subtitle.lines) {
130 BOOST_FOREACH (sub::Block j, i.blocks) {
132 if (!j.font_size.specified()) {
133 /* Fallback default font size if no other has been specified */
134 j.font_size.set_points (48);
139 if (needs_placement) {
140 DCPOMATIC_ASSERT (i.vertical_position.line);
141 /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
142 of the screen a bit to a pleasing degree.
145 (1 + bottom_line.get() - i.vertical_position.line.get())
146 * 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
148 v_align = dcp::VALIGN_TOP;
150 DCPOMATIC_ASSERT (i.vertical_position.proportional);
151 DCPOMATIC_ASSERT (i.vertical_position.reference);
152 v_position = i.vertical_position.proportional.get();
154 if (lowest_proportional) {
155 /* Adjust line spacing */
156 v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get();
159 switch (i.vertical_position.reference.get()) {
160 case sub::TOP_OF_SCREEN:
161 v_align = dcp::VALIGN_TOP;
163 case sub::VERTICAL_CENTRE_OF_SCREEN:
164 v_align = dcp::VALIGN_CENTER;
166 case sub::BOTTOM_OF_SCREEN:
167 v_align = dcp::VALIGN_BOTTOM;
170 v_align = dcp::VALIGN_TOP;
176 switch (i.horizontal_position.reference) {
177 case sub::LEFT_OF_SCREEN:
178 h_align = dcp::HALIGN_LEFT;
180 case sub::HORIZONTAL_CENTRE_OF_SCREEN:
181 h_align = dcp::HALIGN_CENTER;
183 case sub::RIGHT_OF_SCREEN:
184 h_align = dcp::HALIGN_RIGHT;
187 h_align = dcp::HALIGN_CENTER;
191 /* The idea here (rightly or wrongly) is that we set the appearance based on the
192 values in the libsub objects, and these are overridden with values from the
193 content by the other emit_text_start() above.
197 dcp::SubtitleString (
198 string(TEXT_FONT_ID),
203 j.font_size.points (72 * 11),
205 dcp::Time (from.seconds(), 1000),
206 /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */
208 i.horizontal_position.proportional,
215 j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
216 /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
217 but the times of these often don't have a frame rate associated
218 with them so the sub::Time won't convert them to milliseconds without
219 throwing an exception. Since only DCP subs fill those in (and we don't
220 use libsub for DCP subs) we can cheat by just putting 0 in here.
229 emit_text_start (from, out);
233 SubtitleDecoder::emit_stop (ContentTime to)
239 SubtitleDecoder::emit_text (ContentTimePeriod period, list<dcp::SubtitleString> s)
241 emit_text_start (period.from, s);
242 emit_stop (period.to);
246 SubtitleDecoder::emit_text (ContentTimePeriod period, sub::Subtitle const & s)
248 emit_text_start (period.from, s);
249 emit_stop (period.to);
253 SubtitleDecoder::seek ()
255 _position = ContentTime ();