src/subtitle_asset.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "raw_convert.h"
  21 #include "subtitle_asset.h"
  22 #include "util.h"
  23 #include "xml.h"
  24 #include "font_node.h"
  25 #include "text_node.h"
  26 #include "subtitle_string.h"
  27 #include "dcp_assert.h"
  28 #include "AS_DCP.h"
  29 #include "KM_util.h"
  30 #include <libxml++/nodes/element.h>
  31 #include <boost/algorithm/string.hpp>
  32 #include <boost/shared_array.hpp>
  33 #include <boost/foreach.hpp>
  34 #include <fstream>
  35
  36 using std::string;
  37 using std::list;
  38 using std::ostream;
  39 using std::ofstream;
  40 using std::stringstream;
  41 using std::cout;
  42 using std::cerr;
  43 using std::map;
  44 using boost::shared_ptr;
  45 using boost::shared_array;
  46 using boost::optional;
  47 using boost::dynamic_pointer_cast;
  48 using namespace dcp;
  49
  50 SubtitleAsset::SubtitleAsset ()
  51 {
  52
  53 }
  54
  55 SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
  56         : Asset (file)
  57 {
  58
  59 }
  60
  61 void
  62 SubtitleAsset::parse_subtitles (
  63         shared_ptr<cxml::Document> xml,
  64         list<shared_ptr<dcp::FontNode> > font_nodes,
  65         list<shared_ptr<dcp::SubtitleNode> > subtitle_nodes
  66         )
  67 {
  68         /* Make Subtitle objects to represent the raw XML nodes in a sane way */
  69         ParseState parse_state;
  70         examine_nodes (xml, font_nodes, parse_state);
  71         examine_nodes (xml, subtitle_nodes, parse_state);
  72 }
  73
  74 void
  75 SubtitleAsset::examine_nodes (
  76         shared_ptr<const cxml::Node> xml,
  77         list<shared_ptr<dcp::SubtitleNode> > const & subtitle_nodes,
  78         ParseState& parse_state
  79         )
  80 {
  81         BOOST_FOREACH (shared_ptr<dcp::SubtitleNode> i, subtitle_nodes) {
  82                 parse_state.subtitle_nodes.push_back (i);
  83                 examine_nodes (xml, i->text_nodes, parse_state);
  84                 examine_nodes (xml, i->font_nodes, parse_state);
  85                 parse_state.subtitle_nodes.pop_back ();
  86         }
  87 }
  88
  89 void
  90 SubtitleAsset::examine_nodes (
  91         shared_ptr<const cxml::Node> xml,
  92         list<shared_ptr<dcp::FontNode> > const & font_nodes,
  93         ParseState& parse_state
  94         )
  95 {
  96         BOOST_FOREACH (shared_ptr<dcp::FontNode> i, font_nodes) {
  97
  98                 parse_state.font_nodes.push_back (i);
  99                 maybe_add_subtitle (i->text, parse_state);
 100
 101                 examine_nodes (xml, i->subtitle_nodes, parse_state);
 102                 examine_nodes (xml, i->font_nodes, parse_state);
 103                 examine_nodes (xml, i->text_nodes, parse_state);
 104
 105                 parse_state.font_nodes.pop_back ();
 106         }
 107 }
 108
 109 void
 110 SubtitleAsset::examine_nodes (
 111         shared_ptr<const cxml::Node> xml,
 112         list<shared_ptr<dcp::TextNode> > const & text_nodes,
 113         ParseState& parse_state
 114         )
 115 {
 116         BOOST_FOREACH (shared_ptr<dcp::TextNode> i, text_nodes) {
 117                 parse_state.text_nodes.push_back (i);
 118                 maybe_add_subtitle (i->text, parse_state);
 119                 examine_nodes (xml, i->font_nodes, parse_state);
 120                 parse_state.text_nodes.pop_back ();
 121         }
 122 }
 123
 124 void
 125 SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
 126 {
 127         if (empty_or_white_space (text)) {
 128                 return;
 129         }
 130
 131         if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) {
 132                 return;
 133         }
 134
 135         DCP_ASSERT (!parse_state.text_nodes.empty ());
 136         DCP_ASSERT (!parse_state.subtitle_nodes.empty ());
 137
 138         dcp::FontNode effective_font (parse_state.font_nodes);
 139         dcp::TextNode effective_text (*parse_state.text_nodes.back ());
 140         dcp::SubtitleNode effective_subtitle (*parse_state.subtitle_nodes.back ());
 141
 142         _subtitles.push_back (
 143                 SubtitleString (
 144                         effective_font.id,
 145                         effective_font.italic.get_value_or (false),
 146                         effective_font.bold.get_value_or (false),
 147                         effective_font.colour.get_value_or (dcp::Colour (255, 255, 255)),
 148                         effective_font.size,
 149                         effective_font.aspect_adjust.get_value_or (1.0),
 150                         effective_subtitle.in,
 151                         effective_subtitle.out,
 152                         effective_text.h_position,
 153                         effective_text.h_align,
 154                         effective_text.v_position,
 155                         effective_text.v_align,
 156                         effective_text.direction,
 157                         text,
 158                         effective_font.effect.get_value_or (NONE),
 159                         effective_font.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
 160                         effective_subtitle.fade_up_time,
 161                         effective_subtitle.fade_down_time
 162                         )
 163                 );
 164 }
 165
 166 list<SubtitleString>
 167 SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const
 168 {
 169         list<SubtitleString> s;
 170         BOOST_FOREACH (SubtitleString const & i, _subtitles) {
 171                 if ((starting && from <= i.in() && i.in() < to) || (!starting && i.out() >= from && i.in() <= to)) {
 172                         s.push_back (i);
 173                 }
 174         }
 175
 176         return s;
 177 }
 178
 179 void
 180 SubtitleAsset::add (SubtitleString s)
 181 {
 182         _subtitles.push_back (s);
 183 }
 184
 185 Time
 186 SubtitleAsset::latest_subtitle_out () const
 187 {
 188         Time t;
 189         BOOST_FOREACH (SubtitleString const & i, _subtitles) {
 190                 if (i.out() > t) {
 191                         t = i.out ();
 192                 }
 193         }
 194
 195         return t;
 196 }
 197
 198 bool
 199 SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 200 {
 201         if (!Asset::equals (other_asset, options, note)) {
 202                 return false;
 203         }
 204
 205         shared_ptr<const SubtitleAsset> other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
 206         if (!other) {
 207                 return false;
 208         }
 209
 210         if (_subtitles != other->_subtitles) {
 211                 note (DCP_ERROR, "subtitles differ");
 212                 return false;
 213         }
 214
 215         return true;
 216 }
 217
 218 struct SubtitleSorter {
 219         bool operator() (SubtitleString const & a, SubtitleString const & b) {
 220                 if (a.in() != b.in()) {
 221                         return a.in() < b.in();
 222                 }
 223                 return a.v_position() < b.v_position();
 224         }
 225 };
 226
 227 /** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
 228  *  class because the differences between the two are fairly subtle.
 229  */
 230 void
 231 SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const
 232 {
 233         list<SubtitleString> sorted = _subtitles;
 234         sorted.sort (SubtitleSorter ());
 235
 236         string const xmlns = standard == SMPTE ? "dcst" : "";
 237
 238         /* XXX: script, underlined not supported */
 239
 240         optional<string> font;
 241         bool italic = false;
 242         bool bold = false;
 243         Colour colour;
 244         int size = 0;
 245         float aspect_adjust = 1.0;
 246         Effect effect = NONE;
 247         Colour effect_colour;
 248         int spot_number = 1;
 249         Time last_in;
 250         Time last_out;
 251         Time last_fade_up_time;
 252         Time last_fade_down_time;
 253
 254         xmlpp::Element* font_element = 0;
 255         xmlpp::Element* subtitle_element = 0;
 256
 257         BOOST_FOREACH (SubtitleString const & i, sorted) {
 258
 259                 /* We will start a new <Font>...</Font> whenever some font property changes.
 260                    I suppose we should really make an optimal hierarchy of <Font> tags, but
 261                    that seems hard.
 262                 */
 263
 264                 bool const font_changed =
 265                         font          != i.font()          ||
 266                         italic        != i.italic()        ||
 267                         bold          != i.bold()          ||
 268                         colour        != i.colour()        ||
 269                         size          != i.size()          ||
 270                         fabs (aspect_adjust - i.aspect_adjust()) > ASPECT_ADJUST_EPSILON ||
 271                         effect        != i.effect()        ||
 272                         effect_colour != i.effect_colour();
 273
 274                 if (font_changed) {
 275                         font = i.font ();
 276                         italic = i.italic ();
 277                         bold = i.bold ();
 278                         colour = i.colour ();
 279                         size = i.size ();
 280                         aspect_adjust = i.aspect_adjust ();
 281                         effect = i.effect ();
 282                         effect_colour = i.effect_colour ();
 283                 }
 284
 285                 if (!font_element || font_changed) {
 286                         font_element = root->add_child ("Font", xmlns);
 287                         if (font) {
 288                                 if (standard == SMPTE) {
 289                                         font_element->set_attribute ("ID", font.get ());
 290                                 } else {
 291                                         font_element->set_attribute ("Id", font.get ());
 292                                 }
 293                         }
 294                         font_element->set_attribute ("Italic", italic ? "yes" : "no");
 295                         font_element->set_attribute ("Color", colour.to_argb_string());
 296                         font_element->set_attribute ("Size", raw_convert<string> (size));
 297                         if (fabs (aspect_adjust - 1.0) > ASPECT_ADJUST_EPSILON) {
 298                                 font_element->set_attribute ("AspectAdjust", raw_convert<string> (aspect_adjust));
 299                         }
 300                         font_element->set_attribute ("Effect", effect_to_string (effect));
 301                         font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
 302                         font_element->set_attribute ("Script", "normal");
 303                         if (standard == SMPTE) {
 304                                 font_element->set_attribute ("Underline", "no");
 305                         } else {
 306                                 font_element->set_attribute ("Underlined", "no");
 307                         }
 308                         font_element->set_attribute ("Weight", bold ? "bold" : "normal");
 309                 }
 310
 311                 if (!subtitle_element || font_changed ||
 312                     (last_in != i.in() ||
 313                      last_out != i.out() ||
 314                      last_fade_up_time != i.fade_up_time() ||
 315                      last_fade_down_time != i.fade_down_time()
 316                             )) {
 317
 318                         subtitle_element = font_element->add_child ("Subtitle", xmlns);
 319                         subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
 320                         subtitle_element->set_attribute ("TimeIn", i.in().rebase(time_code_rate).as_string(standard));
 321                         subtitle_element->set_attribute ("TimeOut", i.out().rebase(time_code_rate).as_string(standard));
 322                         if (standard == SMPTE) {
 323                                 subtitle_element->set_attribute ("FadeUpTime", i.fade_up_time().rebase(time_code_rate).as_string(standard));
 324                                 subtitle_element->set_attribute ("FadeDownTime", i.fade_down_time().rebase(time_code_rate).as_string(standard));
 325                         } else {
 326                                 subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i.fade_up_time().as_editable_units(time_code_rate)));
 327                                 subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i.fade_down_time().as_editable_units(time_code_rate)));
 328                         }
 329
 330                         last_in = i.in ();
 331                         last_out = i.out ();
 332                         last_fade_up_time = i.fade_up_time ();
 333                         last_fade_down_time = i.fade_down_time ();
 334                 }
 335
 336                 xmlpp::Element* text = subtitle_element->add_child ("Text", xmlns);
 337
 338                 if (i.h_align() != HALIGN_CENTER) {
 339                         if (standard == SMPTE) {
 340                                 text->set_attribute ("Halign", halign_to_string (i.h_align ()));
 341                         } else {
 342                                 text->set_attribute ("HAlign", halign_to_string (i.h_align ()));
 343                         }
 344                 }
 345
 346                 if (i.h_position() > ALIGN_EPSILON) {
 347                         if (standard == SMPTE) {
 348                                 text->set_attribute ("Hposition", raw_convert<string> (i.h_position() * 100, 6));
 349                         } else {
 350                                 text->set_attribute ("HPosition", raw_convert<string> (i.h_position() * 100, 6));
 351                         }
 352                 }
 353
 354                 if (standard == SMPTE) {
 355                         text->set_attribute ("Valign", valign_to_string (i.v_align()));
 356                 } else {
 357                         text->set_attribute ("VAlign", valign_to_string (i.v_align()));
 358                 }
 359
 360                 if (i.v_position() > ALIGN_EPSILON) {
 361                         if (standard == SMPTE) {
 362                                 text->set_attribute ("Vposition", raw_convert<string> (i.v_position() * 100, 6));
 363                         } else {
 364                                 text->set_attribute ("VPosition", raw_convert<string> (i.v_position() * 100, 6));
 365                         }
 366                 } else {
 367                         if (standard == SMPTE) {
 368                                 text->set_attribute ("Vposition", "0");
 369                         } else {
 370                                 text->set_attribute ("VPosition", "0");
 371                         }
 372                 }
 373
 374                 /* Interop only supports "horizontal" or "vertical" for direction, so only write this
 375                    for SMPTE.
 376                 */
 377                 if (i.direction() != DIRECTION_LTR && standard == SMPTE) {
 378                         text->set_attribute ("Direction", direction_to_string (i.direction ()));
 379                 }
 380
 381                 text->add_child_text (i.text());
 382         }
 383 }
 384
 385 map<string, Data>
 386 SubtitleAsset::fonts_with_load_ids () const
 387 {
 388         map<string, Data> out;
 389         BOOST_FOREACH (Font const & i, _fonts) {
 390                 out[i.load_id] = i.data;
 391         }
 392         return out;
 393 }