X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fsubtitle_decoder.cc;h=3e6ee92f1f0e6b33c89e919db8785dff2d62dc64;hb=1460bda6f80b6529e31a1a63029dc0ec5f7d0ae8;hp=786199e31a681d47db0f3b27cd9efad00de13208;hpb=f0edd6ab35c3c2b7800a26ec8206adab75e5f633;p=dcpomatic.git diff --git a/src/lib/subtitle_decoder.cc b/src/lib/subtitle_decoder.cc index 786199e31..3e6ee92f1 100644 --- a/src/lib/subtitle_decoder.cc +++ b/src/lib/subtitle_decoder.cc @@ -1,99 +1,299 @@ /* - Copyright (C) 2013-2014 Carl Hetherington + Copyright (C) 2013-2016 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, + function (ContentTimePeriod, bool)> image_during, + function (ContentTimePeriod, bool)> text_during + ) + : DecoderPart (parent, log) + , _content (c) + , _image_during (image_during) + , _text_during (text_during) { } /** Called by subclasses when an image subtitle is ready. - * Image may be 0 to say that there is no current subtitle. + * @param period Period 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::give_image (ContentTimePeriod period, shared_ptr image, dcpomatic::Rect rect) { - _decoded_image_subtitles.push_back (shared_ptr (new ContentImageSubtitle (period, image, rect))); + _decoded_image.push_back (ContentImageSubtitle (period, image, rect)); + _position = period.from; } void -SubtitleDecoder::text_subtitle (list s) +SubtitleDecoder::give_text (ContentTimePeriod period, list s) { - _decoded_text_subtitles.push_back (shared_ptr (new ContentTextSubtitle (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.) + */ + BOOST_FOREACH (dcp::SubtitleString& i, s) { + string t = i.text (); + boost::algorithm::replace_all (t, "<", "<"); + boost::algorithm::replace_all (t, ">", ">"); + i.set_text (t); + } + + _decoded_text.push_back (ContentTextSubtitle (period, s)); + _position = period.to; } +/** Get the subtitles that correspond to a given list of periods. + * @param subs Subtitles. + * @param sp Periods for which to extract subtitles from subs. + */ template -list > -SubtitleDecoder::get (list > const & subs, ContentTimePeriod period) +list +SubtitleDecoder::get (list const & subs, list const & sp, ContentTimePeriod period, bool accurate) { - if (!has_subtitle_during (period)) { - return list > (); + if (sp.empty ()) { + return list (); } - if (subs.empty() || period.from < subs.front()->period().from || period.to > (subs.back()->period().to + ContentTime::from_seconds (10))) { - /* Either we have no decoded data, or what we do have is a long way from what we want: seek */ - seek (period.from, true); + /* Find the time of the first subtitle we don't have in subs */ + optional missing; + BOOST_FOREACH (ContentTimePeriod i, sp) { + typename list::const_iterator j = subs.begin(); + while (j != subs.end() && j->period() != i) { + ++j; + } + if (j == subs.end ()) { + missing = i.from; + break; + } + } + + /* Suggest to our parent decoder that it might want to seek if we haven't got what we're being asked for */ + if (missing) { + _log->log ( + String::compose ( + "SD suggests seek to %1 from %2", + to_string (*missing), + position() ? to_string(*position()) : "nowhere"), + LogEntry::TYPE_DEBUG_DECODE); + maybe_seek (*missing, true); } /* 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.front()->period().from > period.from || period.to < subs.back()->period().to))) {} + while (!_parent->pass(Decoder::PASS_REASON_SUBTITLE, accurate) && (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 ((*i)->period().overlaps (period)) { - out.push_back (*i); + + list out; + BOOST_FOREACH (ContentTimePeriod i, sp) { + typename list::const_iterator j = subs.begin(); + while (j != subs.end() && j->period() != i) { + ++j; } + if (j != subs.end()) { + out.push_back (*j); + } + } + + /* Discard anything in _decoded_image_subtitles that is outside 5 seconds either side of period */ + + list::iterator i = _decoded_image.begin(); + while (i != _decoded_image.end()) { + list::iterator tmp = i; + ++tmp; + + if ( + i->period().to < (period.from - ContentTime::from_seconds (5)) || + i->period().from > (period.to + ContentTime::from_seconds (5)) + ) { + _decoded_image.erase (i); + } + + i = tmp; } return out; } -list > -SubtitleDecoder::get_text_subtitles (ContentTimePeriod period) +list +SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate) +{ + return get (_decoded_text, _text_during (period, starting), period, accurate); +} + +list +SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate) { - return get (_decoded_text_subtitles, period); + return get (_decoded_image, _image_during (period, starting), period, accurate); } -list > -SubtitleDecoder::get_image_subtitles (ContentTimePeriod period) +void +SubtitleDecoder::seek (ContentTime t, bool) +{ + _log->log (String::compose ("SD seek to %1", to_string(t)), LogEntry::TYPE_DEBUG_DECODE); + reset (); + _position.reset (); +} + +void +SubtitleDecoder::reset () { - return get (_decoded_image_subtitles, period); + _decoded_text.clear (); + _decoded_image.clear (); } void -SubtitleDecoder::seek (ContentTime, bool) +SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subtitle) { - _decoded_text_subtitles.clear (); - _decoded_image_subtitles.clear (); + /* See if our next subtitle needs to be 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(); + } + } + } + + /* 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()); + } + } + } + + 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::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::Effect effect = dcp::NONE; + if (content()->outline()) { + effect = dcp::BORDER; + } else if (content()->shadow()) { + effect = dcp::SHADOW; + } + + out.push_back ( + dcp::SubtitleString ( + string(TEXT_FONT_ID), + j.italic, + j.bold, + j.underline, + /* force the colour to whatever is configured */ + content()->colour(), + j.font_size.points (72 * 11), + 1.0, + dcp::Time (period.from.seconds(), 1000), + dcp::Time (period.to.seconds(), 1000), + 0, + dcp::HALIGN_CENTER, + v_position, + v_align, + dcp::DIRECTION_LTR, + j.text, + effect, + content()->effect_colour(), + dcp::Time (content()->fade_in().seconds(), 1000), + dcp::Time (content()->fade_out().seconds(), 1000) + ) + ); + } + } + + give_text (period, out); }