src/lib/subtitle_decoder.cc

   1 /*
   2     Copyright (C) 2013-2015 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 <boost/shared_ptr.hpp>
  21 #include "subtitle_decoder.h"
  22 #include "subtitle_content.h"
  23
  24 using std::list;
  25 using std::cout;
  26 using boost::shared_ptr;
  27 using boost::optional;
  28
  29 SubtitleDecoder::SubtitleDecoder (shared_ptr<const SubtitleContent> c)
  30         : _subtitle_content (c)
  31 {
  32
  33 }
  34
  35 /** Called by subclasses when an image subtitle is ready.
  36  *  @param period Period of the subtitle.
  37  *  @param image Subtitle image.
  38  *  @param rect Area expressed as a fraction of the video frame that this subtitle
  39  *  is for (e.g. a width of 0.5 means the width of the subtitle is half the width
  40  *  of the video frame)
  41  */
  42 void
  43 SubtitleDecoder::image_subtitle (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
  44 {
  45         _decoded_image_subtitles.push_back (ContentImageSubtitle (period, image, rect));
  46 }
  47
  48 void
  49 SubtitleDecoder::text_subtitle (list<dcp::SubtitleString> s)
  50 {
  51         _decoded_text_subtitles.push_back (ContentTextSubtitle (s));
  52 }
  53
  54 /** @param sp Full periods of subtitles that are showing or starting during the specified period */
  55 template <class T>
  56 list<T>
  57 SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting)
  58 {
  59         if (sp.empty ()) {
  60                 /* Nothing in this period */
  61                 return list<T> ();
  62         }
  63
  64         /* Seek if what we want is before what we have, or more than a reasonable amount after */
  65         if (subs.empty() || sp.back().to < subs.front().period().from || sp.front().from > (subs.back().period().to + ContentTime::from_seconds (5))) {
  66                 seek (sp.front().from, true);
  67         }
  68
  69         /* Now enough pass() calls will either:
  70          *  (a) give us what we want, or
  71          *  (b) hit the end of the decoder.
  72          */
  73         while (!pass () && (subs.empty() || (subs.back().period().to < sp.back().to))) {}
  74
  75         /* Now look for what we wanted in the data we have collected */
  76         /* XXX: inefficient */
  77
  78         list<T> out;
  79         for (typename list<T>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
  80                 if ((starting && period.contains (i->period().from)) || (!starting && period.overlaps (i->period ()))) {
  81                         out.push_back (*i);
  82                 }
  83         }
  84
  85         /* Discard anything in _decoded_image_subtitles that is outside 5 seconds either side of period */
  86
  87         list<ContentImageSubtitle>::iterator i = _decoded_image_subtitles.begin();
  88         while (i != _decoded_image_subtitles.end()) {
  89                 list<ContentImageSubtitle>::iterator tmp = i;
  90                 ++tmp;
  91
  92                 if (
  93                         i->period().to < (period.from - ContentTime::from_seconds (5)) ||
  94                         i->period().from > (period.to + ContentTime::from_seconds (5))
  95                         ) {
  96                         _decoded_image_subtitles.erase (i);
  97                 }
  98
  99                 i = tmp;
 100         }
 101
 102         return out;
 103 }
 104
 105 list<ContentTextSubtitle>
 106 SubtitleDecoder::get_text_subtitles (ContentTimePeriod period, bool starting)
 107 {
 108         return get<ContentTextSubtitle> (_decoded_text_subtitles, text_subtitles_during (period, starting), period, starting);
 109 }
 110
 111 list<ContentImageSubtitle>
 112 SubtitleDecoder::get_image_subtitles (ContentTimePeriod period, bool starting)
 113 {
 114         return get<ContentImageSubtitle> (_decoded_image_subtitles, image_subtitles_during (period, starting), period, starting);
 115 }
 116
 117 void
 118 SubtitleDecoder::seek (ContentTime, bool)
 119 {
 120         _decoded_text_subtitles.clear ();
 121         _decoded_image_subtitles.clear ();
 122 }