No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / subtitle_decoder.cc
index 13cf481c8027f70e0b468235ef0736cf47278570..766c7ed87738814c3185202142c987252fb2ace4 100644 (file)
 /*
-    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 <boost/shared_ptr.hpp>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 using std::list;
 using std::cout;
 using boost::shared_ptr;
 using boost::optional;
-
-SubtitleDecoder::SubtitleDecoder (shared_ptr<const SubtitleContent> c)
-       : _subtitle_content (c)
+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
+       )
+       : _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 (shared_ptr<ContentImageSubtitle> (new 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 (shared_ptr<ContentTextSubtitle> (new 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<shared_ptr<T> >
-SubtitleDecoder::get (list<shared_ptr<T> > const & subs, ContentTimePeriod period)
+list<T>
+SubtitleDecoder::get (list<T> const & subs, list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate)
 {
-       if (!_subtitle_content->has_subtitle_during (period)) {
-               return list<shared_ptr<T> > ();
+       if (sp.empty ()) {
+               /* Nothing in this period */
+               return list<T> ();
        }
 
-       if (subs.empty() || period.from < subs.front()->period().from || period.to > (subs.back()->period().to + ContentTime::from_seconds (10))) {
-               /* Either we have no decoded data, or what we do have is a long way from what we want: seek */
-               seek (period.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.front()->period().from > period.from || period.to < subs.back()->period().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<shared_ptr<T> > out;
-       for (typename list<shared_ptr<T> >::const_iterator i = subs.begin(); i != subs.end(); ++i) {
-               if ((*i)->period().from <= period.to && (*i)->period().to >= period.from) {
+
+       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);
                }
        }
 
+       /* 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<shared_ptr<ContentTextSubtitle> >
-SubtitleDecoder::get_text_subtitles (ContentTimePeriod period)
+list<ContentTextSubtitle>
+SubtitleDecoder::get_text (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentTextSubtitle> (_decoded_text_subtitles, period);
+       return get<ContentTextSubtitle> (_decoded_text, _text_during (period, starting), period, starting, accurate);
 }
 
-list<shared_ptr<ContentImageSubtitle> >
-SubtitleDecoder::get_image_subtitles (ContentTimePeriod period)
+list<ContentImageSubtitle>
+SubtitleDecoder::get_image (ContentTimePeriod period, bool starting, bool accurate)
 {
-       return get<ContentImageSubtitle> (_decoded_image_subtitles, period);
+       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 ();
+       _decoded_text.clear ();
+       _decoded_image.clear ();
 }