Merge master.
[dcpomatic.git] / src / lib / subtitle_decoder.cc
1 /*
2     Copyright (C) 2013-2014 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  *  Image may be 0 to say that there is no current subtitle.
37  */
38 void
39 SubtitleDecoder::image_subtitle (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
40 {
41         _decoded_image_subtitles.push_back (ContentImageSubtitle (period, image, rect));
42 }
43
44 void
45 SubtitleDecoder::text_subtitle (list<dcp::SubtitleString> s)
46 {
47         _decoded_text_subtitles.push_back (ContentTextSubtitle (s));
48 }
49
50 template <class T>
51 list<T>
52 SubtitleDecoder::get (list<T> const & subs, ContentTimePeriod period, bool starting)
53 {
54         /* Get the full periods of the subtitles that are showing or starting during the specified period */
55         list<ContentTimePeriod> sp = subtitles_during (period, starting);
56         if (sp.empty ()) {
57                 /* Nothing in this period */
58                 return list<T> ();
59         }
60
61         /* Seek if what we want is before what we have, or more than a reasonable amount after */
62         if (subs.empty() || sp.back().to < subs.front().period().from || sp.front().from > (subs.back().period().to + ContentTime::from_seconds (5))) {
63                 seek (sp.front().from, true);
64         }
65
66         /* Now enough pass() calls will either:
67          *  (a) give us what we want, or
68          *  (b) hit the end of the decoder.
69          */
70         while (!pass() && (subs.empty() || (subs.back().period().to < sp.back().to))) {}
71
72         /* Now look for what we wanted in the data we have collected */
73         /* XXX: inefficient */
74         
75         list<T> out;
76         for (typename list<T>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
77                 if ((starting && period.contains (i->period().from)) || (!starting && period.overlaps (i->period ()))) {
78                         out.push_back (*i);
79                 }
80         }
81
82         return out;
83 }
84
85 list<ContentTextSubtitle>
86 SubtitleDecoder::get_text_subtitles (ContentTimePeriod period, bool starting)
87 {
88         return get<ContentTextSubtitle> (_decoded_text_subtitles, period, starting);
89 }
90
91 list<ContentImageSubtitle>
92 SubtitleDecoder::get_image_subtitles (ContentTimePeriod period, bool starting)
93 {
94         return get<ContentImageSubtitle> (_decoded_image_subtitles, period, starting);
95 }
96
97 void
98 SubtitleDecoder::seek (ContentTime, bool)
99 {
100         _decoded_text_subtitles.clear ();
101         _decoded_image_subtitles.clear ();
102 }