CCAP doc tweaks.
[dcpomatic.git] / src / lib / subtitle_decoder.cc
index 09f7a67004884fa4a006d3b44b037b6b4dd8bf19..32cae6accc0e40318ad495944bcb3ce2aedd6beb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #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;
@@ -37,116 +40,68 @@ using boost::function;
 SubtitleDecoder::SubtitleDecoder (
        Decoder* parent,
        shared_ptr<const SubtitleContent> c,
-       function<list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
-       function<list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
+       shared_ptr<Log> log,
+       ContentTime first
        )
-       : _parent (parent)
+       : DecoderPart (parent, log)
        , _content (c)
-       , _image_during (image_during)
-       , _text_during (text_during)
+       , _position (first)
 {
 
 }
 
-/** Called by subclasses when an image subtitle is ready.
- *  @param period Period of the 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::give_image (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
+SubtitleDecoder::emit_image_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
 {
-       _decoded_image.push_back (ContentImageSubtitle (period, image, rect));
+       ImageStart (ContentImageSubtitle (from, image, rect));
+       _position = from;
 }
 
 void
-SubtitleDecoder::give_text (ContentTimePeriod period, list<dcp::SubtitleString> s)
+SubtitleDecoder::emit_text_start (ContentTime from, list<dcp::SubtitleString> s)
 {
-       _decoded_text.push_back (ContentTextSubtitle (period, s));
-}
-
-/** @param sp Full periods of subtitles that are showing or starting during the specified period */
-template <class T>
-list<T>
-SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, 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);
-       }
-
-       /* Now enough pass() calls will either:
-        *  (a) give us what we want, or
-        *  (b) hit the end of the decoder.
-        */
-       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<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 (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, "<", "&lt;");
+               boost::algorithm::replace_all (t, ">", "&gt;");
+               i.set_text (t);
+
+               /* Set any forced appearance */
+               if (content()->colour()) {
+                       i.set_colour (*content()->colour());
                }
-       }
-
-       /* Discard anything in _decoded_image_subtitles that is outside 5 seconds either side of period */
-
-       list<ContentImageSubtitle>::iterator i = _decoded_image.begin();
-       while (i != _decoded_image.end()) {
-               list<ContentImageSubtitle>::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);
+               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));
                }
-
-               i = tmp;
        }
 
-       return out;
-}
-
-list<ContentTextSubtitle>
-SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate)
-{
-       return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, starting, accurate);
-}
-
-list<ContentImageSubtitle>
-SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate)
-{
-       return get<ContentImageSubtitle> (_decoded_image, _image_during (period, starting), period, starting, accurate);
-}
-
-void
-SubtitleDecoder::seek (ContentTime, bool)
-{
-       reset ();
+       TextStart (ContentTextSubtitle (from, s));
+       _position = from;
 }
 
 void
-SubtitleDecoder::reset ()
+SubtitleDecoder::emit_text_start (ContentTime from, sub::Subtitle const & subtitle)
 {
-       _decoded_text.clear ();
-       _decoded_image.clear ();
-}
-
-void
-SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subtitle)
-{
-       /* See if our next subtitle needs to be placed on screen by us */
+       /* See if our next subtitle needs to be vertically placed on screen by us */
        bool needs_placement = false;
        optional<int> bottom_line;
        BOOST_FOREACH (sub::Line i, subtitle.lines) {
@@ -159,7 +114,7 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
                }
        }
 
-       /* Find the lowest proportional postion */
+       /* Find the lowest proportional position */
        optional<float> lowest_proportional;
        BOOST_FOREACH (sub::Line i, subtitle.lines) {
                if (i.vertical_position.proportional) {
@@ -176,7 +131,7 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
                BOOST_FOREACH (sub::Block j, i.blocks) {
 
                        if (!j.font_size.specified()) {
-                               /* Fallback default font size if none other has been specified */
+                               /* Fallback default font size if no other has been specified */
                                j.font_size.set_points (48);
                        }
 
@@ -206,7 +161,7 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
                                case sub::TOP_OF_SCREEN:
                                        v_align = dcp::VALIGN_TOP;
                                        break;
-                               case sub::CENTRE_OF_SCREEN:
+                               case sub::VERTICAL_CENTRE_OF_SCREEN:
                                        v_align = dcp::VALIGN_CENTER;
                                        break;
                                case sub::BOTTOM_OF_SCREEN:
@@ -218,32 +173,85 @@ SubtitleDecoder::give_text (ContentTimePeriod period, sub::Subtitle const & subt
                                }
                        }
 
+                       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,
-                                       /* force the colour to whatever is configured */
-                                       content()->colour(),
+                                       j.colour.dcp(),
                                        j.font_size.points (72 * 11),
                                        1.0,
-                                       dcp::Time (period.from.seconds(), 1000),
-                                       dcp::Time (period.to.seconds(), 1000),
-                                       0,
-                                       dcp::HALIGN_CENTER,
+                                       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,
-                                       content()->outline() ? dcp::BORDER : dcp::NONE,
-                                       content()->outline_colour(),
-                                       dcp::Time (0, 1000),
-                                       dcp::Time (0, 1000)
+                                       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 ()
                                        )
                                );
                }
        }
 
-       give_text (period, out);
+       emit_text_start (from, out);
+}
+
+void
+SubtitleDecoder::emit_stop (ContentTime to)
+{
+       Stop (to);
+}
+
+void
+SubtitleDecoder::emit_text (ContentTimePeriod period, list<dcp::SubtitleString> s)
+{
+       emit_text_start (period.from, s);
+       emit_stop (period.to);
+}
+
+void
+SubtitleDecoder::emit_text (ContentTimePeriod period, sub::Subtitle const & s)
+{
+       emit_text_start (period.from, s);
+       emit_stop (period.to);
+}
+
+void
+SubtitleDecoder::seek ()
+{
+       _position = ContentTime ();
 }