X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fsubtitle_decoder.cc;h=32cae6accc0e40318ad495944bcb3ce2aedd6beb;hp=e1485e221d70807109e3803b0493c9d8524fe974;hb=00ae2c28501bb757a6a45ba47ad4ecbe32412933;hpb=b56bc3c45953fe113a9934b0d2ec2c1134de07ab diff --git a/src/lib/subtitle_decoder.cc b/src/lib/subtitle_decoder.cc index e1485e221..32cae6acc 100644 --- a/src/lib/subtitle_decoder.cc +++ b/src/lib/subtitle_decoder.cc @@ -1,102 +1,257 @@ /* - Copyright (C) 2013-2014 Carl Hetherington + Copyright (C) 2013-2017 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -#include #include "subtitle_decoder.h" #include "subtitle_content.h" +#include "util.h" +#include "log.h" +#include "compose.hpp" +#include +#include +#include +#include +#include using std::list; using std::cout; +using std::string; +using std::min; using boost::shared_ptr; using boost::optional; +using boost::function; -SubtitleDecoder::SubtitleDecoder (shared_ptr c) - : _subtitle_content (c) +SubtitleDecoder::SubtitleDecoder ( + Decoder* parent, + shared_ptr c, + shared_ptr log, + ContentTime first + ) + : DecoderPart (parent, log) + , _content (c) + , _position (first) { } -/** Called by subclasses when an image subtitle is ready. - * Image may be 0 to say that there is no current subtitle. +/** Called by subclasses when an image subtitle is starting. + * @param from From time of the subtitle. + * @param image Subtitle image. + * @param rect Area expressed as a fraction of the video frame that this subtitle + * is for (e.g. a width of 0.5 means the width of the subtitle is half the width + * of the video frame) */ void -SubtitleDecoder::image_subtitle (ContentTimePeriod period, shared_ptr image, dcpomatic::Rect rect) +SubtitleDecoder::emit_image_start (ContentTime from, shared_ptr image, dcpomatic::Rect rect) { - _decoded_image_subtitles.push_back (ContentImageSubtitle (period, image, rect)); + ImageStart (ContentImageSubtitle (from, image, rect)); + _position = from; } void -SubtitleDecoder::text_subtitle (list s) +SubtitleDecoder::emit_text_start (ContentTime from, list s) { - _decoded_text_subtitles.push_back (ContentTextSubtitle (s)); + BOOST_FOREACH (dcp::SubtitleString& i, s) { + /* We must escape < and > in strings, otherwise they might confuse our subtitle + renderer (which uses some HTML-esque markup to do bold/italic etc.) + */ + string t = i.text (); + boost::algorithm::replace_all (t, "<", "<"); + boost::algorithm::replace_all (t, ">", ">"); + i.set_text (t); + + /* Set any forced appearance */ + if (content()->colour()) { + i.set_colour (*content()->colour()); + } + if (content()->effect_colour()) { + i.set_effect_colour (*content()->effect_colour()); + } + if (content()->effect()) { + i.set_effect (*content()->effect()); + } + if (content()->fade_in()) { + i.set_fade_up_time (dcp::Time(content()->fade_in()->seconds(), 1000)); + } + if (content()->fade_out()) { + i.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000)); + } + } + + TextStart (ContentTextSubtitle (from, s)); + _position = from; } -template -list -SubtitleDecoder::get (list const & subs, ContentTimePeriod period, bool starting) +void +SubtitleDecoder::emit_text_start (ContentTime from, sub::Subtitle const & subtitle) { - /* Get the full periods of the subtitles that are showing or starting during the specified period */ - list sp = subtitles_during (period, starting); - if (sp.empty ()) { - /* Nothing in this period */ - return list (); + /* See if our next subtitle needs to be vertically placed on screen by us */ + bool needs_placement = false; + optional bottom_line; + BOOST_FOREACH (sub::Line i, subtitle.lines) { + if (!i.vertical_position.reference || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) { + needs_placement = true; + DCPOMATIC_ASSERT (i.vertical_position.line); + if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) { + bottom_line = i.vertical_position.line.get(); + } + } } - /* Seek if what we want is before what we have, or more than a reasonable amount after */ - if (subs.empty() || sp.back().to < subs.front().period().from || sp.front().from > (subs.back().period().to + ContentTime::from_seconds (5))) { - seek (sp.front().from, true); + /* Find the lowest proportional position */ + optional lowest_proportional; + BOOST_FOREACH (sub::Line i, subtitle.lines) { + if (i.vertical_position.proportional) { + if (!lowest_proportional) { + lowest_proportional = i.vertical_position.proportional; + } else { + lowest_proportional = min (lowest_proportional.get(), i.vertical_position.proportional.get()); + } + } } - /* Now enough pass() calls will either: - * (a) give us what we want, or - * (b) hit the end of the decoder. - */ - while (!pass() && (subs.empty() || (subs.back().period().to < sp.back().to))) {} - - /* Now look for what we wanted in the data we have collected */ - /* XXX: inefficient */ - - list out; - for (typename list::const_iterator i = subs.begin(); i != subs.end(); ++i) { - if ((starting && period.contains (i->period().from)) || (!starting && period.overlaps (i->period ()))) { - out.push_back (*i); + list out; + BOOST_FOREACH (sub::Line i, subtitle.lines) { + BOOST_FOREACH (sub::Block j, i.blocks) { + + if (!j.font_size.specified()) { + /* Fallback default font size if no other has been specified */ + j.font_size.set_points (48); + } + + float v_position; + dcp::VAlign v_align; + if (needs_placement) { + DCPOMATIC_ASSERT (i.vertical_position.line); + /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom + of the screen a bit to a pleasing degree. + */ + v_position = 1.015 - + (1 + bottom_line.get() - i.vertical_position.line.get()) + * 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11); + + v_align = dcp::VALIGN_TOP; + } else { + DCPOMATIC_ASSERT (i.vertical_position.proportional); + DCPOMATIC_ASSERT (i.vertical_position.reference); + v_position = i.vertical_position.proportional.get(); + + if (lowest_proportional) { + /* Adjust line spacing */ + v_position = ((v_position - lowest_proportional.get()) * content()->line_spacing()) + lowest_proportional.get(); + } + + switch (i.vertical_position.reference.get()) { + case sub::TOP_OF_SCREEN: + v_align = dcp::VALIGN_TOP; + break; + case sub::VERTICAL_CENTRE_OF_SCREEN: + v_align = dcp::VALIGN_CENTER; + break; + case sub::BOTTOM_OF_SCREEN: + v_align = dcp::VALIGN_BOTTOM; + break; + default: + v_align = dcp::VALIGN_TOP; + break; + } + } + + dcp::HAlign h_align; + switch (i.horizontal_position.reference) { + case sub::LEFT_OF_SCREEN: + h_align = dcp::HALIGN_LEFT; + break; + case sub::HORIZONTAL_CENTRE_OF_SCREEN: + h_align = dcp::HALIGN_CENTER; + break; + case sub::RIGHT_OF_SCREEN: + h_align = dcp::HALIGN_RIGHT; + break; + default: + h_align = dcp::HALIGN_CENTER; + break; + } + + /* The idea here (rightly or wrongly) is that we set the appearance based on the + values in the libsub objects, and these are overridden with values from the + content by the other emit_text_start() above. + */ + + out.push_back ( + dcp::SubtitleString ( + string(TEXT_FONT_ID), + j.italic, + j.bold, + j.underline, + j.colour.dcp(), + j.font_size.points (72 * 11), + 1.0, + dcp::Time (from.seconds(), 1000), + /* XXX: hmm; this is a bit ugly (we don't know the to time yet) */ + dcp::Time (), + i.horizontal_position.proportional, + h_align, + v_position, + v_align, + dcp::DIRECTION_LTR, + j.text, + dcp::NONE, + j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(), + /* Hack: we should use subtitle.fade_up and subtitle.fade_down here + but the times of these often don't have a frame rate associated + with them so the sub::Time won't convert them to milliseconds without + throwing an exception. Since only DCP subs fill those in (and we don't + use libsub for DCP subs) we can cheat by just putting 0 in here. + */ + dcp::Time (), + dcp::Time () + ) + ); } } - return out; + emit_text_start (from, out); } -list -SubtitleDecoder::get_text_subtitles (ContentTimePeriod period, bool starting) +void +SubtitleDecoder::emit_stop (ContentTime to) { - return get (_decoded_text_subtitles, period, starting); + Stop (to); } -list -SubtitleDecoder::get_image_subtitles (ContentTimePeriod period, bool starting) +void +SubtitleDecoder::emit_text (ContentTimePeriod period, list s) +{ + emit_text_start (period.from, s); + emit_stop (period.to); +} + +void +SubtitleDecoder::emit_text (ContentTimePeriod period, sub::Subtitle const & s) { - return get (_decoded_image_subtitles, period, starting); + emit_text_start (period.from, s); + emit_stop (period.to); } void -SubtitleDecoder::seek (ContentTime, bool) +SubtitleDecoder::seek () { - _decoded_text_subtitles.clear (); - _decoded_image_subtitles.clear (); + _position = ContentTime (); }