src/lib/subtitle_decoder.cc

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "subtitle_decoder.h"
  21 #include "subtitle_content.h"
  22 #include <boost/shared_ptr.hpp>
  23 #include <boost/foreach.hpp>
  24 #include <iostream>
  25
  26 using std::list;
  27 using std::cout;
  28 using boost::shared_ptr;
  29 using boost::optional;
  30 using boost::function;
  31
  32 SubtitleDecoder::SubtitleDecoder (
  33         Decoder* parent,
  34         shared_ptr<const SubtitleContent> c,
  35         function<list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
  36         function<list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
  37         )
  38         : _parent (parent)
  39         , _content (c)
  40         , _image_during (image_during)
  41         , _text_during (text_during)
  42 {
  43
  44 }
  45
  46 /** Called by subclasses when an image subtitle is ready.
  47  *  @param period Period of the subtitle.
  48  *  @param image Subtitle image.
  49  *  @param rect Area expressed as a fraction of the video frame that this subtitle
  50  *  is for (e.g. a width of 0.5 means the width of the subtitle is half the width
  51  *  of the video frame)
  52  */
  53 void
  54 SubtitleDecoder::give_image (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
  55 {
  56         _decoded_image.push_back (ContentImageSubtitle (period, image, rect));
  57 }
  58
  59 void
  60 SubtitleDecoder::give_text (ContentTimePeriod period, list<dcp::SubtitleString> s)
  61 {
  62         _decoded_text.push_back (ContentTextSubtitle (period, s));
  63 }
  64
  65 /** @param sp Full periods of subtitles that are showing or starting during the specified period */
  66 template <class T>
  67 list<T>
  68 SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate)
  69 {
  70         if (sp.empty ()) {
  71                 /* Nothing in this period */
  72                 return list<T> ();
  73         }
  74
  75         /* Seek if what we want is before what we have, or a more than a little bit after */
  76         if (subs.empty() || sp.back().to < subs.front().period().from || sp.front().from > (subs.back().period().to + ContentTime::from_seconds (1))) {
  77                 seek (sp.front().from, true);
  78         }
  79
  80         /* Now enough pass() calls will either:
  81          *  (a) give us what we want, or
  82          *  (b) hit the end of the decoder.
  83          */
  84         while (!_parent->pass(Decoder::PASS_REASON_SUBTITLE, accurate) && (subs.empty() || (subs.back().period().to < sp.back().to))) {}
  85
  86         /* Now look for what we wanted in the data we have collected */
  87         /* XXX: inefficient */
  88
  89         list<T> out;
  90         for (typename list<T>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
  91                 if ((starting && period.contains (i->period().from)) || (!starting && period.overlaps (i->period ()))) {
  92                         out.push_back (*i);
  93                 }
  94         }
  95
  96         /* Discard anything in _decoded_image_subtitles that is outside 5 seconds either side of period */
  97
  98         list<ContentImageSubtitle>::iterator i = _decoded_image.begin();
  99         while (i != _decoded_image.end()) {
 100                 list<ContentImageSubtitle>::iterator tmp = i;
 101                 ++tmp;
 102
 103                 if (
 104                         i->period().to < (period.from - ContentTime::from_seconds (5)) ||
 105                         i->period().from > (period.to + ContentTime::from_seconds (5))
 106                         ) {
 107                         _decoded_image.erase (i);
 108                 }
 109
 110                 i = tmp;
 111         }
 112
 113         return out;
 114 }
 115
 116 list<ContentTextSubtitle>
 117 SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate)
 118 {
 119         return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, starting, accurate);
 120 }
 121
 122 list<ContentImageSubtitle>
 123 SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate)
 124 {
 125         return get<ContentImageSubtitle> (_decoded_image, _image_during (period, starting), period, starting, accurate);
 126 }
 127
 128 void
 129 SubtitleDecoder::seek (ContentTime, bool)
 130 {
 131         _decoded_text.clear ();
 132         _decoded_image.clear ();
 133 }