Subtitle "to" times used to be stored against their "from" times.
[dcpomatic.git] / src / lib / ffmpeg_subtitle_stream.cc
1 /*
2     Copyright (C) 2013-2016 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 "ffmpeg_subtitle_stream.h"
21 #include "raw_convert.h"
22 #include <libxml++/libxml++.h>
23 #include <boost/foreach.hpp>
24 #include <iostream>
25
26 using std::string;
27 using std::map;
28 using std::list;
29 using std::cout;
30
31 /** Construct a SubtitleStream from a value returned from to_string().
32  *  @param t String returned from to_string().
33  *  @param v State file version.
34  */
35 FFmpegSubtitleStream::FFmpegSubtitleStream (cxml::ConstNodePtr node, int version)
36         : FFmpegStream (node)
37 {
38         if (version == 32) {
39                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Period")) {
40                         /* In version 32 we assumed that from times were unique, so they weer
41                            used as identifiers.
42                         */
43                         add_subtitle (
44                                 raw_convert<string> (i->string_child ("From")),
45                                 ContentTimePeriod (
46                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
47                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
48                                         )
49                                 );
50                 }
51         } else {
52                 /* In version 33 we use a hash of various parts of the subtitle as the id */
53                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Subtitle")) {
54                         add_subtitle (
55                                 raw_convert<string> (i->string_child ("Id")),
56                                 ContentTimePeriod (
57                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
58                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
59                                         )
60                                 );
61                 }
62         }
63 }
64
65 void
66 FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
67 {
68         FFmpegStream::as_xml (root);
69
70         for (map<string, ContentTimePeriod>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
71                 xmlpp::Node* node = root->add_child ("Subtitle");
72                 node->add_child("Id")->add_child_text (i->first);
73                 node->add_child("From")->add_child_text (raw_convert<string> (i->second.from.get ()));
74                 node->add_child("To")->add_child_text (raw_convert<string> (i->second.to.get ()));
75         }
76 }
77
78 void
79 FFmpegSubtitleStream::add_subtitle (string id, ContentTimePeriod period)
80 {
81         DCPOMATIC_ASSERT (_subtitles.find (id) == _subtitles.end ());
82         _subtitles[id] = period;
83 }
84
85 list<ContentTimePeriod>
86 FFmpegSubtitleStream::subtitles_during (ContentTimePeriod period, bool starting) const
87 {
88         list<ContentTimePeriod> d;
89
90         /* XXX: inefficient */
91         for (map<string, ContentTimePeriod>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
92                 if ((starting && period.contains (i->second.from)) || (!starting && period.overlaps (i->second))) {
93                         d.push_back (i->second);
94                 }
95         }
96
97         return d;
98 }
99
100 ContentTime
101 FFmpegSubtitleStream::find_subtitle_to (string id) const
102 {
103         map<string, ContentTimePeriod>::const_iterator i = _subtitles.find (id);
104         DCPOMATIC_ASSERT (i != _subtitles.end ());
105         return i->second.to;
106 }
107
108 /** Add some offset to all the times in the stream */
109 void
110 FFmpegSubtitleStream::add_offset (ContentTime offset)
111 {
112         for (map<string, ContentTimePeriod>::iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
113                 i->second.from += offset;
114                 i->second.to += offset;
115         }
116 }