src/lib/subtitle_decoder.cc

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