2 Copyright (C) 2014-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/>.
23 #include "dcpomatic_assert.h"
26 #include "render_text.h"
30 #include <dcp/raw_convert.h>
31 #include <fontconfig/fontconfig.h>
32 #include <cairomm/cairomm.h>
33 DCPOMATIC_DISABLE_WARNINGS
35 DCPOMATIC_ENABLE_WARNINGS
36 #include <pango/pangocairo.h>
37 #include <boost/algorithm/string.hpp>
45 using std::make_shared;
49 using std::shared_ptr;
51 using boost::optional;
52 using boost::algorithm::replace_all;
53 using namespace dcpomatic;
56 static FcConfig* fc_config = nullptr;
57 static list<pair<boost::filesystem::path, string>> fc_config_fonts;
61 marked_up (list<StringText> subtitles, int target_height, float fade_factor)
65 for (auto const& i: subtitles) {
68 out += "style=\"italic\" ";
71 out += "weight=\"bold\" ";
74 out += "underline=\"single\" ";
76 out += "size=\"" + dcp::raw_convert<string>(i.size_in_pixels(target_height) * 72 * 1024 / 96) + "\" ";
77 /* Between 1-65535 inclusive, apparently... */
78 out += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
79 out += "color=\"#" + i.colour().to_rgb_string() + "\">";
89 set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
91 context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
95 static shared_ptr<Image>
96 create_image (dcp::Size size)
98 /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha */
99 auto image = make_shared<Image>(AV_PIX_FMT_BGRA, size, false);
100 image->make_black ();
105 static Cairo::RefPtr<Cairo::ImageSurface>
106 create_surface (shared_ptr<Image> image)
108 return Cairo::ImageSurface::create (
110 Cairo::FORMAT_ARGB32,
112 image->size().height,
113 /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
114 Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
120 setup_font (StringText const& subtitle, list<shared_ptr<Font>> const& fonts)
123 fc_config = FcInitLoadConfig ();
126 auto font_file = default_font_file ();
128 for (auto i: fonts) {
129 if (i->id() == subtitle.font() && i->file()) {
130 font_file = i->file().get();
134 auto existing = fc_config_fonts.cbegin ();
135 while (existing != fc_config_fonts.end() && existing->first != font_file) {
140 if (existing != fc_config_fonts.end ()) {
141 font_name = existing->second;
143 /* Make this font available to DCP-o-matic */
144 FcConfigAppFontAddFile (fc_config, reinterpret_cast<FcChar8 const *>(font_file.string().c_str()));
145 auto pattern = FcPatternBuild (
146 0, FC_FILE, FcTypeString, font_file.string().c_str(), static_cast<char *>(0)
148 auto object_set = FcObjectSetBuild (FC_FAMILY, FC_STYLE, FC_LANG, FC_FILE, static_cast<char *> (0));
149 auto font_set = FcFontList (fc_config, pattern, object_set);
151 for (int i = 0; i < font_set->nfont; ++i) {
152 FcPattern* font = font_set->fonts[i];
157 FcPatternGetString (font, FC_FILE, 0, &file) == FcResultMatch &&
158 FcPatternGetString (font, FC_FAMILY, 0, &family) == FcResultMatch &&
159 FcPatternGetString (font, FC_STYLE, 0, &style) == FcResultMatch
161 font_name = reinterpret_cast<char const *> (family);
165 FcFontSetDestroy (font_set);
168 FcObjectSetDestroy (object_set);
169 FcPatternDestroy (pattern);
171 fc_config_fonts.push_back (make_pair(font_file, font_name));
174 FcConfigSetCurrent (fc_config);
180 calculate_fade_factor (StringText const& first, DCPTime time, int frame_rate)
182 float fade_factor = 1;
184 /* Round the fade start/end to the nearest frame start. Otherwise if a subtitle starts just after
185 the start of a frame it will be faded out.
187 auto const fade_in_start = DCPTime::from_seconds(first.in().as_seconds()).round(frame_rate);
188 auto const fade_in_end = fade_in_start + DCPTime::from_seconds (first.fade_up_time().as_seconds ());
189 auto const fade_out_end = DCPTime::from_seconds (first.out().as_seconds()).round(frame_rate);
190 auto const fade_out_start = fade_out_end - DCPTime::from_seconds (first.fade_down_time().as_seconds ());
192 if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
193 fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
195 if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
196 fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
198 if (time < fade_in_start || time > fade_out_end) {
207 x_position (StringText const& first, int target_width, int layout_width)
210 switch (first.h_align()) {
211 case dcp::HAlign::LEFT:
212 /* h_position is distance between left of frame and left of subtitle */
213 x = first.h_position() * target_width;
215 case dcp::HAlign::CENTER:
216 /* h_position is distance between centre of frame and centre of subtitle */
217 x = (0.5 + first.h_position()) * target_width - layout_width / 2;
219 case dcp::HAlign::RIGHT:
220 /* h_position is distance between right of frame and right of subtitle */
221 x = (1.0 - first.h_position()) * target_width - layout_width;
230 y_position (StringText const& first, int target_height, int layout_height)
233 switch (first.v_align()) {
234 case dcp::VAlign::TOP:
235 /* SMPTE says that v_position is the distance between top
236 of frame and top of subtitle, but this doesn't always seem to be
237 the case in practice; Gunnar Ásgeirsson's Dolby server appears
238 to put VAlign::TOP subs with v_position as the distance between top
239 of frame and bottom of subtitle.
241 y = first.v_position() * target_height - layout_height;
243 case dcp::VAlign::CENTER:
244 /* v_position is distance between centre of frame and centre of subtitle */
245 y = (0.5 + first.v_position()) * target_height - layout_height / 2;
247 case dcp::VAlign::BOTTOM:
248 /* v_position is distance between bottom of frame and bottom of subtitle */
249 y = (1.0 - first.v_position()) * target_height - layout_height;
258 setup_layout (Glib::RefPtr<Pango::Layout> layout, string font_name, string markup)
260 layout->set_alignment (Pango::ALIGN_LEFT);
261 Pango::FontDescription font (font_name);
262 layout->set_font_description (font);
263 layout->set_markup (markup);
267 /** Create a Pango layout using a dummy context which we can use to calculate the size
268 * of the text we will render. Then we can transfer the layout over to the real context
269 * for the actual render.
271 static Glib::RefPtr<Pango::Layout>
274 auto c_font_map = pango_cairo_font_map_new ();
275 DCPOMATIC_ASSERT (c_font_map);
276 auto font_map = Glib::wrap (c_font_map);
277 auto c_context = pango_font_map_create_context (c_font_map);
278 DCPOMATIC_ASSERT (c_context);
279 auto context = Glib::wrap (c_context);
280 return Pango::Layout::create (context);
284 /** @param subtitles A list of subtitles that are all on the same line,
285 * at the same time and with the same fade in/out.
288 render_line (list<StringText> subtitles, list<shared_ptr<Font>> fonts, dcp::Size target, DCPTime time, int frame_rate)
290 /* XXX: this method can only handle italic / bold changes mid-line,
294 DCPOMATIC_ASSERT (!subtitles.empty ());
295 auto const& first = subtitles.front ();
297 auto const font_name = setup_font (first, fonts);
298 auto const fade_factor = calculate_fade_factor (first, time, frame_rate);
299 auto const markup = marked_up (subtitles, target.height, fade_factor);
300 auto layout = create_layout ();
301 setup_layout (layout, font_name, markup);
303 layout->get_pixel_size (size.width, size.height);
305 /* Calculate x and y scale factors. These are only used to stretch
306 the font away from its normal aspect ratio.
310 if (fabs (first.aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
311 if (first.aspect_adjust() < 1) {
312 x_scale = max (0.25f, first.aspect_adjust ());
316 y_scale = 1 / min (4.0f, first.aspect_adjust ());
320 auto const border_width = first.effect() == dcp::Effect::BORDER ? (first.outline_width * target.width / 2048.0) : 0;
321 size.width += 2 * ceil (border_width);
322 size.height += 2 * ceil (border_width);
324 size.width *= x_scale;
325 size.height *= y_scale;
327 /* Shuffle the subtitle over by the border width (if we have any) so it's not cut off */
328 int const x_offset = ceil (border_width);
329 /* Move down a bit so that accents on capital letters can be seen */
330 int const y_offset = target.height / 100.0;
332 size.width += x_offset;
333 size.height += y_offset;
335 auto image = create_image (size);
336 auto surface = create_surface (image);
337 auto context = Cairo::Context::create (surface);
339 context->set_line_width (1);
340 context->scale (x_scale, y_scale);
341 layout->update_from_cairo_context (context);
343 if (first.effect() == dcp::Effect::SHADOW) {
344 /* Drop-shadow effect */
345 set_source_rgba (context, first.effect_colour(), fade_factor);
346 context->move_to (x_offset + 4, y_offset + 4);
347 layout->add_to_cairo_context (context);
351 if (first.effect() == dcp::Effect::BORDER) {
353 set_source_rgba (context, first.effect_colour(), fade_factor);
354 context->set_line_width (border_width);
355 context->set_line_join (Cairo::LINE_JOIN_ROUND);
356 context->move_to (x_offset, y_offset);
357 layout->add_to_cairo_context (context);
361 /* The actual subtitle */
363 set_source_rgba (context, first.colour(), fade_factor);
365 context->move_to (x_offset, y_offset);
366 layout->add_to_cairo_context (context);
369 context->set_line_width (0.5);
370 context->move_to (x_offset, y_offset);
371 layout->add_to_cairo_context (context);
374 int const x = x_position (first, target.width, size.width);
375 int const y = y_position (first, target.height, size.height);
376 return PositionImage (image, Position<int>(max (0, x), max(0, y)));
380 /** @param time Time of the frame that these subtitles are going on.
381 * @param target Size of the container that this subtitle will end up in.
382 * @param frame_rate DCP frame rate.
385 render_text (list<StringText> subtitles, list<shared_ptr<Font>> fonts, dcp::Size target, DCPTime time, int frame_rate)
387 list<StringText> pending;
388 list<PositionImage> images;
390 for (auto const& i: subtitles) {
391 if (!pending.empty() && (i.v_align() != pending.back().v_align() || fabs(i.v_position() - pending.back().v_position()) > 1e-4)) {
392 images.push_back (render_line (pending, fonts, target, time, frame_rate));
395 pending.push_back (i);
398 if (!pending.empty()) {
399 images.push_back (render_line (pending, fonts, target, time, frame_rate));