2 Copyright (C) 2014-2016 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 "render_text.h"
26 #include "dcpomatic_assert.h"
27 #include <dcp/raw_convert.h>
28 #include <fontconfig/fontconfig.h>
29 #include <cairomm/cairomm.h>
31 #ifndef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
32 #include <pango/pangocairo.h>
34 #include <boost/foreach.hpp>
35 #include <boost/algorithm/string.hpp>
46 using boost::shared_ptr;
47 using boost::optional;
48 using boost::algorithm::replace_all;
49 using namespace dcpomatic;
51 static FcConfig* fc_config = 0;
52 static list<pair<boost::filesystem::path, string> > fc_config_fonts;
55 marked_up (list<StringText> subtitles, int target_height, float fade_factor)
59 BOOST_FOREACH (StringText const & i, subtitles) {
62 out += "style=\"italic\" ";
65 out += "weight=\"bold\" ";
68 out += "underline=\"single\" ";
70 out += "size=\"" + dcp::raw_convert<string>(i.size_in_pixels(target_height) * 72 * 1024 / 96) + "\" ";
71 /* Between 1-65535 inclusive, apparently... */
72 out += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
73 out += "color=\"#" + i.colour().to_rgb_string() + "\">";
76 replace_all(t, "&", "&");
86 set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
88 context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
92 static shared_ptr<Image>
93 create_image (int width, int height)
95 /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha */
96 shared_ptr<Image> image (new Image (AV_PIX_FMT_BGRA, dcp::Size (width, height), false));
102 static Cairo::RefPtr<Cairo::ImageSurface>
103 create_surface (shared_ptr<Image> image)
105 #ifdef DCPOMATIC_HAVE_FORMAT_STRIDE_FOR_WIDTH
106 Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
108 Cairo::FORMAT_ARGB32,
110 image->size().height,
111 /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
112 Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
115 /* Centos 5 does not have Cairo::ImageSurface::format_stride_for_width, so just use width * 4
116 which I hope is safe (if slow)
118 Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
120 Cairo::FORMAT_ARGB32,
122 image->size().height,
123 image->size().width * 4
132 setup_font (StringText const& subtitle, list<shared_ptr<Font> > const& fonts)
135 fc_config = FcInitLoadConfig ();
138 optional<boost::filesystem::path> font_file;
141 font_file = shared_path () / "LiberationSans-Regular.ttf";
142 } catch (boost::filesystem::filesystem_error& e) {
146 /* Hack: try the debian/ubuntu locations if getting the shared path failed */
148 if (!font_file || !boost::filesystem::exists(*font_file)) {
149 font_file = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
152 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
153 if (i->id() == subtitle.font() && i->file()) {
154 font_file = i->file ();
158 list<pair<boost::filesystem::path, string> >::const_iterator existing = fc_config_fonts.begin ();
159 while (existing != fc_config_fonts.end() && existing->first != *font_file) {
164 if (existing != fc_config_fonts.end ()) {
165 font_name = existing->second;
167 /* Make this font available to DCP-o-matic */
168 FcConfigAppFontAddFile (fc_config, reinterpret_cast<FcChar8 const *>(font_file->string().c_str()));
169 FcPattern* pattern = FcPatternBuild (
170 0, FC_FILE, FcTypeString, font_file->string().c_str(), static_cast<char *> (0)
172 FcObjectSet* object_set = FcObjectSetBuild (FC_FAMILY, FC_STYLE, FC_LANG, FC_FILE, static_cast<char *> (0));
173 FcFontSet* font_set = FcFontList (fc_config, pattern, object_set);
175 for (int i = 0; i < font_set->nfont; ++i) {
176 FcPattern* font = font_set->fonts[i];
181 FcPatternGetString (font, FC_FILE, 0, &file) == FcResultMatch &&
182 FcPatternGetString (font, FC_FAMILY, 0, &family) == FcResultMatch &&
183 FcPatternGetString (font, FC_STYLE, 0, &style) == FcResultMatch
185 font_name = reinterpret_cast<char const *> (family);
189 FcFontSetDestroy (font_set);
192 FcObjectSetDestroy (object_set);
193 FcPatternDestroy (pattern);
195 fc_config_fonts.push_back (make_pair(*font_file, font_name));
198 FcConfigSetCurrent (fc_config);
203 /** @param subtitles A list of subtitles that are all on the same line,
204 * at the same time and with the same fade in/out.
207 render_line (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
209 /* XXX: this method can only handle italic / bold changes mid-line,
213 DCPOMATIC_ASSERT (!subtitles.empty ());
215 StringText const& first = subtitles.front ();
217 /* Calculate x and y scale factors. These are only used to stretch
218 the font away from its normal aspect ratio.
222 if (fabs (first.aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
223 if (first.aspect_adjust() < 1) {
224 xscale = max (0.25f, first.aspect_adjust ());
228 yscale = 1 / min (4.0f, first.aspect_adjust ());
232 /* Make an empty bitmap as wide as target and at
233 least tall enough for this subtitle.
237 BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
238 largest = max (largest, i.size());
240 /* Basic guess on height... */
241 int height = largest * target.height / (11 * 72);
244 /* ...and add a bit more for luck */
245 height += target.height / 11;
247 shared_ptr<Image> image = create_image (target.width, height);
248 Cairo::RefPtr<Cairo::Surface> surface = create_surface (image);
249 Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
250 string const font_name = setup_font (first, fonts);
251 Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (context);
253 layout->set_alignment (Pango::ALIGN_LEFT);
255 context->set_line_width (1);
257 /* Compute fade factor */
258 float fade_factor = 1;
260 /* Round the fade start/end to the nearest frame start. Otherwise if a subtitle starts just after
261 the start of a frame it will be faded out.
263 DCPTime const fade_in_start = DCPTime::from_seconds(first.in().as_seconds()).round(frame_rate);
264 DCPTime const fade_in_end = fade_in_start + DCPTime::from_seconds (first.fade_up_time().as_seconds ());
265 DCPTime const fade_out_end = DCPTime::from_seconds (first.out().as_seconds()).round(frame_rate);
266 DCPTime const fade_out_start = fade_out_end - DCPTime::from_seconds (first.fade_down_time().as_seconds ());
268 if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
269 fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
271 if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
272 fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
274 if (time < fade_in_start || time > fade_out_end) {
278 /* Render the subtitle at the top left-hand corner of image */
280 Pango::FontDescription font (font_name);
281 layout->set_font_description (font);
282 layout->set_markup (marked_up (subtitles, target.height, fade_factor));
284 context->scale (xscale, yscale);
285 layout->update_from_cairo_context (context);
287 /* Shuffle the subtitle over very slightly if it has a border so that the left-hand
288 side of the first character's border is not cut off.
290 int const x_offset = first.effect() == dcp::BORDER ? (target.width / 600.0) : 0;
291 /* Move down a bit so that accents on capital letters can be seen */
292 int const y_offset = target.height / 100.0;
294 if (first.effect() == dcp::SHADOW) {
295 /* Drop-shadow effect */
296 set_source_rgba (context, first.effect_colour(), fade_factor);
297 context->move_to (x_offset + 4, y_offset + 4);
298 layout->add_to_cairo_context (context);
302 if (first.effect() == dcp::BORDER) {
303 /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
304 set_source_rgba (context, first.effect_colour(), fade_factor);
305 context->set_line_width (first.outline_width * target.width / 2048.0);
306 context->set_line_join (Cairo::LINE_JOIN_ROUND);
307 context->move_to (x_offset, y_offset);
308 layout->add_to_cairo_context (context);
312 /* The actual subtitle */
314 context->set_line_width (0);
315 context->move_to (x_offset, y_offset);
316 #ifdef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
317 layout->show_in_cairo_context (context);
319 pango_cairo_show_layout (context->cobj(), layout->gobj());
324 layout->get_pixel_size (layout_width, layout_height);
325 layout_width *= xscale;
326 layout_height *= yscale;
329 switch (first.h_align ()) {
330 case dcp::HALIGN_LEFT:
331 /* h_position is distance between left of frame and left of subtitle */
332 x = first.h_position() * target.width;
334 case dcp::HALIGN_CENTER:
335 /* h_position is distance between centre of frame and centre of subtitle */
336 x = (0.5 + first.h_position()) * target.width - layout_width / 2;
338 case dcp::HALIGN_RIGHT:
339 /* h_position is distance between right of frame and right of subtitle */
340 x = (1.0 - first.h_position()) * target.width - layout_width;
345 switch (first.v_align ()) {
346 case dcp::VALIGN_TOP:
347 /* SMPTE says that v_position is the distance between top
348 of frame and top of subtitle, but this doesn't always seem to be
349 the case in practice; Gunnar Ásgeirsson's Dolby server appears
350 to put VALIGN_TOP subs with v_position as the distance between top
351 of frame and bottom of subtitle.
353 y = first.v_position() * target.height - layout_height;
355 case dcp::VALIGN_CENTER:
356 /* v_position is distance between centre of frame and centre of subtitle */
357 y = (0.5 + first.v_position()) * target.height - layout_height / 2;
359 case dcp::VALIGN_BOTTOM:
360 /* v_position is distance between bottom of frame and bottom of subtitle */
361 y = (1.0 - first.v_position()) * target.height - layout_height;
365 return PositionImage (image, Position<int> (max (0, x), max (0, y)));
368 /** @param time Time of the frame that these subtitles are going on.
369 * @param frame_rate DCP frame rate.
372 render_text (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
374 list<StringText> pending;
375 list<PositionImage> images;
377 BOOST_FOREACH (StringText const & i, subtitles) {
378 if (!pending.empty() && (i.v_align() != pending.back().v_align() || fabs(i.v_position() - pending.back().v_position()) > 1e-4)) {
379 images.push_back (render_line (pending, fonts, target, time, frame_rate));
382 pending.push_back (i);
385 if (!pending.empty ()) {
386 images.push_back (render_line (pending, fonts, target, time, frame_rate));