src/lib/ffmpeg_subtitle_stream.cc

   1 /*
   2     Copyright (C) 2013-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 "ffmpeg_subtitle_stream.h"
  22 #include <dcp/raw_convert.h>
  23 #include <libxml++/libxml++.h>
  24 #include <boost/foreach.hpp>
  25 #include <iostream>
  26
  27 using std::string;
  28 using std::map;
  29 using std::list;
  30 using std::cout;
  31 using std::make_pair;
  32 using dcp::raw_convert;
  33
  34 /** Construct a SubtitleStream from a value returned from to_string().
  35  *  @param t String returned from to_string().
  36  *  @param v State file version.
  37  */
  38 FFmpegSubtitleStream::FFmpegSubtitleStream (cxml::ConstNodePtr node, int version)
  39         : FFmpegStream (node)
  40 {
  41         if (version == 32) {
  42                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Period")) {
  43                         /* In version 32 we assumed that from times were unique, so they were
  44                            used as identifiers.  All subtitles were image subtitles.
  45                         */
  46                         add_image_subtitle (
  47                                 raw_convert<string> (i->string_child ("From")),
  48                                 ContentTimePeriod (
  49                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
  50                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
  51                                         )
  52                                 );
  53                 }
  54         } else {
  55                 /* In version 33 we use a hash of various parts of the subtitle as the id.
  56                    <Subtitle> was initially used for image subtitles; later we have
  57                    <ImageSubtitle> and <TextSubtitle>
  58                 */
  59                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Subtitle")) {
  60                         add_image_subtitle (
  61                                 raw_convert<string> (i->string_child ("Id")),
  62                                 ContentTimePeriod (
  63                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
  64                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
  65                                         )
  66                                 );
  67                 }
  68
  69                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("ImageSubtitle")) {
  70                         add_image_subtitle (
  71                                 raw_convert<string> (i->string_child ("Id")),
  72                                 ContentTimePeriod (
  73                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
  74                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
  75                                         )
  76                                 );
  77                 }
  78
  79                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("TextSubtitle")) {
  80                         add_text_subtitle (
  81                                 raw_convert<string> (i->string_child ("Id")),
  82                                 ContentTimePeriod (
  83                                         ContentTime (i->number_child<ContentTime::Type> ("From")),
  84                                         ContentTime (i->number_child<ContentTime::Type> ("To"))
  85                                         )
  86                                 );
  87                 }
  88
  89                 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Colour")) {
  90                         _colours[RGBA(i->node_child("From"))] = RGBA (i->node_child("To"));
  91                 }
  92         }
  93 }
  94
  95 void
  96 FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
  97 {
  98         FFmpegStream::as_xml (root);
  99
 100         as_xml (root, _image_subtitles, "ImageSubtitle");
 101         as_xml (root, _text_subtitles, "TextSubtitle");
 102
 103         for (map<RGBA, RGBA>::const_iterator i = _colours.begin(); i != _colours.end(); ++i) {
 104                 xmlpp::Node* node = root->add_child("Colour");
 105                 i->first.as_xml (node->add_child("From"));
 106                 i->second.as_xml (node->add_child("To"));
 107         }
 108 }
 109
 110 void
 111 FFmpegSubtitleStream::as_xml (xmlpp::Node* root, PeriodMap const & subs, string node_name) const
 112 {
 113         for (PeriodMap::const_iterator i = subs.begin(); i != subs.end(); ++i) {
 114                 xmlpp::Node* node = root->add_child (node_name);
 115                 node->add_child("Id")->add_child_text (i->first);
 116                 node->add_child("From")->add_child_text (raw_convert<string> (i->second.from.get ()));
 117                 node->add_child("To")->add_child_text (raw_convert<string> (i->second.to.get ()));
 118         }
 119 }
 120
 121 void
 122 FFmpegSubtitleStream::add_image_subtitle (string id, ContentTimePeriod period)
 123 {
 124         DCPOMATIC_ASSERT (_image_subtitles.find (id) == _image_subtitles.end ());
 125         _image_subtitles[id] = period;
 126 }
 127
 128 void
 129 FFmpegSubtitleStream::add_text_subtitle (string id, ContentTimePeriod period)
 130 {
 131         DCPOMATIC_ASSERT (_text_subtitles.find (id) == _text_subtitles.end ());
 132         _text_subtitles[id] = period;
 133 }
 134
 135 ContentTime
 136 FFmpegSubtitleStream::find_subtitle_to (string id) const
 137 {
 138         PeriodMap::const_iterator i = _image_subtitles.find (id);
 139         if (i != _image_subtitles.end ()) {
 140                 return i->second.to;
 141         }
 142
 143         i = _text_subtitles.find (id);
 144         DCPOMATIC_ASSERT (i != _text_subtitles.end ());
 145         return i->second.to;
 146 }
 147
 148 /** @param id Subtitle id.
 149  *  @return true if the `from' and `to' times for this id are equal, which indicates
 150  *  that the `to' time is unknown.
 151  */
 152 bool
 153 FFmpegSubtitleStream::unknown_to (string id) const
 154 {
 155         PeriodMap::const_iterator i = _image_subtitles.find (id);
 156         if (i != _image_subtitles.end ()) {
 157                 return i->second.from == i->second.to;
 158         }
 159
 160         i = _text_subtitles.find (id);
 161         DCPOMATIC_ASSERT (i != _text_subtitles.end ());
 162         return i->second.from == i->second.to;
 163 }
 164
 165 /** Add some offset to all the times in the stream */
 166 void
 167 FFmpegSubtitleStream::add_offset (ContentTime offset)
 168 {
 169         for (PeriodMap::iterator i = _image_subtitles.begin(); i != _image_subtitles.end(); ++i) {
 170                 i->second.from += offset;
 171                 i->second.to += offset;
 172         }
 173
 174         for (PeriodMap::iterator i = _text_subtitles.begin(); i != _text_subtitles.end(); ++i) {
 175                 i->second.from += offset;
 176                 i->second.to += offset;
 177         }
 178 }
 179
 180 map<RGBA, RGBA>
 181 FFmpegSubtitleStream::colours () const
 182 {
 183         return _colours;
 184 }
 185
 186 void
 187 FFmpegSubtitleStream::set_colour (RGBA from, RGBA to)
 188 {
 189         _colours[from] = to;
 190 }
 191
 192 bool
 193 FFmpegSubtitleStream::has_text () const
 194 {
 195         return !_text_subtitles.empty ();
 196 }
 197
 198 bool
 199 FFmpegSubtitleStream::has_image () const
 200 {
 201         return !_image_subtitles.empty ();
 202 }
 203
 204 void
 205 FFmpegSubtitleStream::set_subtitle_to (string id, ContentTime to)
 206 {
 207         PeriodMap::iterator i = _image_subtitles.find (id);
 208         if (i != _image_subtitles.end ()) {
 209                 i->second.to = to;
 210         } else {
 211                 i = _text_subtitles.find (id);
 212                 if (i != _text_subtitles.end ()) {
 213                         i->second.to = to;
 214                 } else {
 215                         DCPOMATIC_ASSERT (false);
 216                 }
 217         }
 218 }