Some more decode logging.
[dcpomatic.git] / src / lib / subtitle_decoder.cc
index c0f402e2009688b2b6192fc60c7bd970b20ecb49..a7cf8110f5fc3bd56baa5eff95d62263f8d3f11e 100644 (file)
 #include "subtitle_decoder.h"
 #include "subtitle_content.h"
 #include "util.h"
+#include "log.h"
+#include "compose.hpp"
 #include <sub/subtitle.h>
 #include <boost/shared_ptr.hpp>
 #include <boost/foreach.hpp>
+#include <boost/algorithm/string.hpp>
 #include <iostream>
 
 using std::list;
 using std::cout;
 using std::string;
+using std::min;
 using boost::shared_ptr;
 using boost::optional;
 using boost::function;
@@ -36,10 +40,11 @@ using boost::function;
 SubtitleDecoder::SubtitleDecoder (
        Decoder* parent,
        shared_ptr<const SubtitleContent> c,
+       shared_ptr<Log> log,
        function<list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
        function<list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
        )
-       : _parent (parent)
+       : DecoderPart (parent, log)
        , _content (c)
        , _image_during (image_during)
        , _text_during (text_during)
@@ -63,22 +68,47 @@ SubtitleDecoder::give_image (ContentTimePeriod period, shared_ptr<Image> image,
 void
 SubtitleDecoder::give_text (ContentTimePeriod period, list<dcp::SubtitleString> 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, "<", "&lt;");
+               boost::algorithm::replace_all (t, ">", "&gt;");
+               i.set_text (t);
+       }
+
        _decoded_text.push_back (ContentTextSubtitle (period, s));
 }
 
-/** @param sp Full periods of subtitles that are showing or starting during the specified period */
+/** 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 <class T>
 list<T>
-SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate)
+SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool accurate)
 {
        if (sp.empty ()) {
-               /* Nothing in this period */
                return list<T> ();
        }
 
-       /* Seek if what we want is before what we have, or a more than a little bit after */
-       if (subs.empty() || sp.back().to < subs.front().period().from || sp.front().from > (subs.back().period().to + ContentTime::from_seconds (1))) {
-               _parent->seek (sp.front().from, true);
+       /* Find the time of the first subtitle we don't have in subs */
+       optional<ContentTime> missing;
+       BOOST_FOREACH (ContentTimePeriod i, sp) {
+               typename list<T>::const_iterator j = subs.begin();
+               while (j != subs.end() && j->period() != i) {
+                       ++j;
+               }
+               if (j == subs.end ()) {
+                       missing = i.from;
+               }
+       }
+
+       /* 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", to_string (*missing)), LogEntry::TYPE_DEBUG_DECODE);
+               maybe_seek (*missing, true);
        }
 
        /* Now enough pass() calls will either:
@@ -91,9 +121,13 @@ SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp,
        /* XXX: inefficient */
 
        list<T> out;
-       for (typename list<T>::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);
+       BOOST_FOREACH (ContentTimePeriod i, sp) {
+               typename list<T>::const_iterator j = subs.begin();
+               while (j != subs.end() && j->period() != i) {
+                       ++j;
+               }
+               if (j != subs.end()) {
+                       out.push_back (*j);
                }
        }
 
@@ -120,17 +154,23 @@ SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp,
 list<ContentTextSubtitle>
 SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, starting, accurate);
+       return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, accurate);
 }
 
 list<ContentImageSubtitle>
 SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentImageSubtitle> (_decoded_image, _image_during (period, starting), period, starting, accurate);
+       return get<ContentImageSubtitle> (_decoded_image, _image_during (period, starting), period, accurate);
 }
 
 void
 SubtitleDecoder::seek (ContentTime, bool)
+{
+       reset ();
+}
+
+void
+SubtitleDecoder::reset ()
 {
        _decoded_text.clear ();
        _decoded_image.clear ();
@@ -141,9 +181,26 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
 {
        /* See if our next subtitle needs to be placed on screen by us */
        bool needs_placement = false;
+       optional<int> bottom_line;
        BOOST_FOREACH (sub::Line i, subtitle.lines) {
-               if (!i.vertical_position.reference && i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
+               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<float> 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());
+                       }
                }
        }
 
@@ -151,19 +208,33 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
        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 0.878 is an arbitrary value to lift the bottom sub off the bottom
+                               /* 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 = 0.878 + i.vertical_position.line.get() * 1.5 / 22;
-                               v_align = dcp::VALIGN_BOTTOM;
+                               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;
@@ -180,27 +251,35 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
                                }
                        }
 
+                       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 (subtitle.from.all_as_seconds(), 1000),
-                                       dcp::Time (subtitle.to.all_as_seconds(), 1000),
+                                       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,
-                                       content()->outline() ? dcp::BORDER : dcp::NONE,
-                                       content()->outline_colour(),
-                                       dcp::Time (0, 1000),
-                                       dcp::Time (0, 1000)
+                                       effect,
+                                       content()->effect_colour(),
+                                       dcp::Time (content()->fade_in().seconds(), 1000),
+                                       dcp::Time (content()->fade_out().seconds(), 1000)
                                        )
                                );
                }