Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.
[dcpomatic.git] / src / lib / subtitle_decoder.cc
index e1485e221d70807109e3803b0493c9d8524fe974..b31b4873ff1a5ef756d26edb0121f38db03d9b09 100644 (file)
@@ -1,77 +1,96 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
 
 */
 
-#include <boost/shared_ptr.hpp>
 #include "subtitle_decoder.h"
 #include "subtitle_content.h"
+#include "util.h"
+#include <sub/subtitle.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/foreach.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;
 
-SubtitleDecoder::SubtitleDecoder (shared_ptr<const SubtitleContent> c)
-       : _subtitle_content (c)
+SubtitleDecoder::SubtitleDecoder (
+       Decoder* parent,
+       shared_ptr<const SubtitleContent> c,
+       function<list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
+       function<list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
+       )
+       : _parent (parent)
+       , _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> image, dcpomatic::Rect<double> rect)
+SubtitleDecoder::give_image (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
 {
-       _decoded_image_subtitles.push_back (ContentImageSubtitle (period, image, rect));
+       _decoded_image.push_back (ContentImageSubtitle (period, image, rect));
 }
 
 void
-SubtitleDecoder::text_subtitle (list<dcp::SubtitleString> s)
+SubtitleDecoder::give_text (ContentTimePeriod period, list<dcp::SubtitleString> s)
 {
-       _decoded_text_subtitles.push_back (ContentTextSubtitle (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, ContentTimePeriod period, bool starting)
+SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate)
 {
-       /* Get the full periods of the subtitles that are showing or starting during the specified period */
-       list<ContentTimePeriod> sp = subtitles_during (period, starting);
        if (sp.empty ()) {
                /* Nothing in this period */
                return list<T> ();
        }
 
-       /* 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);
+       /* 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 (!pass() && (subs.empty() || (subs.back().period().to < sp.back().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<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 ()))) {
@@ -79,24 +98,159 @@ SubtitleDecoder::get (list<T> const & subs, ContentTimePeriod period, bool start
                }
        }
 
+       /* 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);
+               }
+
+               i = tmp;
+       }
+
        return out;
 }
 
 list<ContentTextSubtitle>
-SubtitleDecoder::get_text_subtitles (ContentTimePeriod period, bool starting)
+SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentTextSubtitle> (_decoded_text_subtitles, period, starting);
+       return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, starting, accurate);
 }
 
 list<ContentImageSubtitle>
-SubtitleDecoder::get_image_subtitles (ContentTimePeriod period, bool starting)
+SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentImageSubtitle> (_decoded_image_subtitles, period, starting);
+       return get<ContentImageSubtitle> (_decoded_image, _image_during (period, starting), period, starting, accurate);
 }
 
 void
 SubtitleDecoder::seek (ContentTime, bool)
 {
-       _decoded_text_subtitles.clear ();
-       _decoded_image_subtitles.clear ();
+       reset ();
+}
+
+void
+SubtitleDecoder::reset ()
+{
+       _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 */
+       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) {
+                       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 postion */
+       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());
+                       }
+               }
+       }
+
+       list<dcp::SubtitleString> 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 none 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 (0, 1000),
+                                       dcp::Time (0, 1000)
+                                       )
+                               );
+               }
+       }
+
+       give_text (period, out);
 }