No-op; fix GPL address and use the explicit-program-name version.
[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         /* XXX: we are ignoring positioning specified in the file */
70
71         list<dcp::SubtitleString> out;
72
73         /* Highest line index in this subtitle */
74         int highest = 0;
75         BOOST_FOREACH (sub::Line i, _subtitles[_next].lines) {
76                 DCPOMATIC_ASSERT (i.vertical_position.reference && i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE);
77                 DCPOMATIC_ASSERT (i.vertical_position.line);
78                 highest = max (highest, i.vertical_position.line.get());
79         }
80
81         BOOST_FOREACH (sub::Line i, _subtitles[_next].lines) {
82                 BOOST_FOREACH (sub::Block j, i.blocks) {
83                         out.push_back (
84                                 dcp::SubtitleString (
85                                         TextSubtitleContent::font_id,
86                                         j.italic,
87                                         j.bold,
88                                         /* force the colour to whatever is configured */
89                                         subtitle->content()->colour(),
90                                         j.font_size.points (72 * 11),
91                                         1.0,
92                                         dcp::Time (_subtitles[_next].from.all_as_seconds(), 1000),
93                                         dcp::Time (_subtitles[_next].to.all_as_seconds(), 1000),
94                                         0,
95                                         dcp::HALIGN_CENTER,
96                                         /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
97                                            of the screen a bit to a pleasing degree.
98                                         */
99                                         1.015 - ((1 + highest - i.vertical_position.line.get()) * 1.5 / 22),
100                                         dcp::VALIGN_TOP,
101                                         dcp::DIRECTION_LTR,
102                                         j.text,
103                                         subtitle->content()->outline() ? dcp::BORDER : dcp::NONE,
104                                         subtitle->content()->outline_colour(),
105                                         dcp::Time (0, 1000),
106                                         dcp::Time (0, 1000)
107                                         )
108                                 );
109                 }
110         }
111
112         subtitle->give_text (content_time_period (_subtitles[_next]), out);
113
114         ++_next;
115         return false;
116 }
117
118 list<ContentTimePeriod>
119 TextSubtitleDecoder::image_subtitles_during (ContentTimePeriod, bool) const
120 {
121         return list<ContentTimePeriod> ();
122 }
123
124 list<ContentTimePeriod>
125 TextSubtitleDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
126 {
127         /* XXX: inefficient */
128
129         list<ContentTimePeriod> d;
130
131         for (vector<sub::Subtitle>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
132                 ContentTimePeriod t = content_time_period (*i);
133                 if ((starting && p.contains (t.from)) || (!starting && p.overlaps (t))) {
134                         d.push_back (t);
135                 }
136         }
137
138         return d;
139 }
140
141 ContentTimePeriod
142 TextSubtitleDecoder::content_time_period (sub::Subtitle s) const
143 {
144         return ContentTimePeriod (
145                 ContentTime::from_seconds (s.from.all_as_seconds()),
146                 ContentTime::from_seconds (s.to.all_as_seconds())
147                 );
148 }