src/interop_subtitle_content.cc

   1 /*
   2     Copyright (C) 2012-2014 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 "interop_subtitle_content.h"
  21 #include "interop_load_font.h"
  22 #include "xml.h"
  23 #include "raw_convert.h"
  24 #include "font.h"
  25
  26 using std::list;
  27 using std::string;
  28 using boost::shared_ptr;
  29 using boost::function;
  30 using boost::optional;
  31 using boost::dynamic_pointer_cast;
  32 using namespace dcp;
  33
  34 InteropSubtitleContent::InteropSubtitleContent (boost::filesystem::path file)
  35         : SubtitleContent (file)
  36 {
  37         shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));
  38         xml->read_file (file);
  39         _id = xml->string_child ("SubtitleID");
  40
  41         _movie_title = xml->string_child ("MovieTitle");
  42
  43         _load_font_nodes = type_children<dcp::InteropLoadFont> (xml, "LoadFont");
  44         list<shared_ptr<dcp::Font> > font_nodes = type_children<dcp::Font> (xml, "Font");
  45
  46         parse_common (xml, font_nodes);
  47 }
  48
  49 InteropSubtitleContent::InteropSubtitleContent (string movie_title, string language)
  50         : _movie_title (movie_title)
  51 {
  52         _language = language;
  53 }
  54
  55 struct SubtitleSorter {
  56         bool operator() (SubtitleString const & a, SubtitleString const & b) {
  57                 if (a.in() != b.in()) {
  58                         return a.in() < b.in();
  59                 }
  60                 return a.v_position() < b.v_position();
  61         }
  62 };
  63
  64 Glib::ustring
  65 InteropSubtitleContent::xml_as_string () const
  66 {
  67         xmlpp::Document doc;
  68         xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
  69         root->set_attribute ("Version", "1.0");
  70
  71         root->add_child("SubtitleID")->add_child_text (_id);
  72         root->add_child("MovieTitle")->add_child_text (_movie_title);
  73         root->add_child("ReelNumber")->add_child_text (raw_convert<string> (_reel_number));
  74         root->add_child("Language")->add_child_text (_language);
  75
  76         for (list<shared_ptr<InteropLoadFont> >::const_iterator i = _load_font_nodes.begin(); i != _load_font_nodes.end(); ++i) {
  77                 xmlpp::Element* load_font = root->add_child("LoadFont");
  78                 load_font->set_attribute ("Id", (*i)->id);
  79                 load_font->set_attribute ("URI", (*i)->uri);
  80         }
  81
  82         list<SubtitleString> sorted = _subtitles;
  83         sorted.sort (SubtitleSorter ());
  84
  85         /* XXX: script, underlined, weight not supported */
  86
  87         optional<string> font;
  88         bool italic = false;
  89         Colour colour;
  90         int size = 0;
  91         Effect effect = NONE;
  92         Colour effect_colour;
  93         int spot_number = 1;
  94         Time last_in;
  95         Time last_out;
  96         Time last_fade_up_time;
  97         Time last_fade_down_time;
  98
  99         xmlpp::Element* font_element = 0;
 100         xmlpp::Element* subtitle_element = 0;
 101
 102         for (list<SubtitleString>::iterator i = sorted.begin(); i != sorted.end(); ++i) {
 103
 104                 /* We will start a new <Font>...</Font> whenever some font property changes.
 105                    I suppose we should really make an optimal hierarchy of <Font> tags, but
 106                    that seems hard.
 107                 */
 108
 109                 bool const font_changed =
 110                         font         != i->font()         ||
 111                         italic       != i->italic()       ||
 112                         colour        != i->colour()        ||
 113                         size         != i->size()         ||
 114                         effect       != i->effect()       ||
 115                         effect_colour != i->effect_colour();
 116
 117                 if (font_changed) {
 118                         font = i->font ();
 119                         italic = i->italic ();
 120                         colour = i->colour ();
 121                         size = i->size ();
 122                         effect = i->effect ();
 123                         effect_colour = i->effect_colour ();
 124                 }
 125
 126                 if (!font_element || font_changed) {
 127                         font_element = root->add_child ("Font");
 128                         if (font) {
 129                                 font_element->set_attribute ("Id", font.get ());
 130                         }
 131                         font_element->set_attribute ("Italic", italic ? "yes" : "no");
 132                         font_element->set_attribute ("Color", colour.to_argb_string());
 133                         font_element->set_attribute ("Size", raw_convert<string> (size));
 134                         font_element->set_attribute ("Effect", effect_to_string (effect));
 135                         font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
 136                         font_element->set_attribute ("Script", "normal");
 137                         font_element->set_attribute ("Underlined", "no");
 138                         font_element->set_attribute ("Weight", "normal");
 139                 }
 140
 141                 if (!subtitle_element || font_changed ||
 142                     (last_in != i->in() ||
 143                      last_out != i->out() ||
 144                      last_fade_up_time != i->fade_up_time() ||
 145                      last_fade_down_time != i->fade_down_time()
 146                             )) {
 147
 148                         subtitle_element = font_element->add_child ("Subtitle");
 149                         subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
 150                         subtitle_element->set_attribute ("TimeIn", i->in().to_string());
 151                         subtitle_element->set_attribute ("TimeOut", i->out().to_string());
 152                         subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i->fade_up_time().to_ticks()));
 153                         subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i->fade_down_time().to_ticks()));
 154
 155                         last_in = i->in ();
 156                         last_out = i->out ();
 157                         last_fade_up_time = i->fade_up_time ();
 158                         last_fade_down_time = i->fade_down_time ();
 159                 }
 160
 161                 xmlpp::Element* text = subtitle_element->add_child ("Text");
 162                 text->set_attribute ("VAlign", valign_to_string (i->v_align()));
 163                 text->set_attribute ("VPosition", raw_convert<string> (i->v_position()));
 164                 text->add_child_text (i->text());
 165         }
 166
 167         return doc.write_to_string_formatted ("UTF-8");
 168 }
 169
 170 void
 171 InteropSubtitleContent::add_font (string id, string uri)
 172 {
 173         _load_font_nodes.push_back (shared_ptr<InteropLoadFont> (new InteropLoadFont (id, uri)));
 174 }
 175
 176 bool
 177 InteropSubtitleContent::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, function<void (NoteType, std::string)> note) const
 178 {
 179         if (!SubtitleContent::equals (other_asset, options, note)) {
 180                 return false;
 181         }
 182
 183         shared_ptr<const InteropSubtitleContent> other = dynamic_pointer_cast<const InteropSubtitleContent> (other_asset);
 184         if (!other) {
 185                 return false;
 186         }
 187
 188         list<shared_ptr<InteropLoadFont> >::const_iterator i = _load_font_nodes.begin ();
 189         list<shared_ptr<InteropLoadFont> >::const_iterator j = other->_load_font_nodes.begin ();
 190
 191         while (i != _load_font_nodes.end ()) {
 192                 if (j == _load_font_nodes.end ()) {
 193                         note (DCP_ERROR, "<LoadFont> nodes differ");
 194                         return false;
 195                 }
 196
 197                 if (**i != **j) {
 198                         note (DCP_ERROR, "<LoadFont> nodes differ");
 199                         return false;
 200                 }
 201
 202                 ++i;
 203                 ++j;
 204         }
 205
 206         if (_movie_title != other->_movie_title) {
 207                 note (DCP_ERROR, "Subtitle movie titles differ");
 208                 return false;
 209         }
 210
 211         return true;
 212 }
 213
 214 list<shared_ptr<LoadFont> >
 215 InteropSubtitleContent::load_font_nodes () const
 216 {
 217         list<shared_ptr<LoadFont> > lf;
 218         copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
 219         return lf;
 220 }