A possibly-better approach to seeking.
[dcpomatic.git] / src / lib / text_subtitle_decoder.cc
1 /*
2     Copyright (C) 2014-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 "text_subtitle_decoder.h"
22 #include "text_subtitle_content.h"
23 #include "subtitle_content.h"
24 #include <dcp/subtitle_string.h>
25 #include <boost/foreach.hpp>
26 #include <iostream>
27
28 using std::list;
29 using std::vector;
30 using std::string;
31 using std::cout;
32 using std::max;
33 using boost::shared_ptr;
34 using boost::optional;
35 using boost::dynamic_pointer_cast;
36
37 TextSubtitleDecoder::TextSubtitleDecoder (shared_ptr<const TextSubtitleContent> content)
38         : TextSubtitle (content)
39         , _next (0)
40 {
41         subtitle.reset (
42                 new SubtitleDecoder (
43                         this,
44                         content->subtitle,
45                         bind (&TextSubtitleDecoder::image_subtitles_during, this, _1, _2),
46                         bind (&TextSubtitleDecoder::text_subtitles_during, this, _1, _2)
47                         )
48                 );
49 }
50
51 void
52 TextSubtitleDecoder::seek (ContentTime time, bool accurate)
53 {
54         subtitle->seek (time, accurate);
55
56         _next = 0;
57         while (_next < _subtitles.size() && ContentTime::from_seconds (_subtitles[_next].from.all_as_seconds ()) < time) {
58                 ++_next;
59         }
60 }
61
62 bool
63 TextSubtitleDecoder::pass (PassReason, bool)
64 {
65         if (_next >= _subtitles.size ()) {
66                 return true;
67         }
68
69         ContentTimePeriod const p = content_time_period (_subtitles[_next]);
70         subtitle->give_text (p, _subtitles[_next]);
71         _position = p.from;
72
73         ++_next;
74         return false;
75 }
76
77 list<ContentTimePeriod>
78 TextSubtitleDecoder::image_subtitles_during (ContentTimePeriod, bool) const
79 {
80         return list<ContentTimePeriod> ();
81 }
82
83 list<ContentTimePeriod>
84 TextSubtitleDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
85 {
86         /* XXX: inefficient */
87
88         list<ContentTimePeriod> d;
89
90         /* Only take `during' (not starting) subs if they overlap more than half the requested period;
91            here's the threshold for being significant.
92         */
93         ContentTime const significant (p.duration().get() / 2);
94
95         for (vector<sub::Subtitle>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
96                 ContentTimePeriod t = content_time_period (*i);
97                 if (starting && p.contains(t.from)) {
98                         d.push_back (t);
99                 } else if (!starting) {
100                         optional<ContentTimePeriod> const o = p.overlap (t);
101                         if (o && o->duration() > significant) {
102                                 d.push_back (t);
103                         }
104                 }
105         }
106
107         return d;
108 }
109
110 ContentTimePeriod
111 TextSubtitleDecoder::content_time_period (sub::Subtitle s) const
112 {
113         return ContentTimePeriod (
114                 ContentTime::from_seconds (s.from.all_as_seconds()),
115                 ContentTime::from_seconds (s.to.all_as_seconds())
116                 );
117 }
118
119 void
120 TextSubtitleDecoder::reset ()
121 {
122         subtitle->reset ();
123 }