src/interop_subtitle_asset.cc

   1 /*
   2     Copyright (C) 2012-2015 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_asset.h"
  21 #include "interop_load_font_node.h"
  22 #include "xml.h"
  23 #include "raw_convert.h"
  24 #include "font_node.h"
  25 #include "util.h"
  26 #include "font_asset.h"
  27 #include "dcp_assert.h"
  28 #include <libxml++/libxml++.h>
  29 #include <boost/foreach.hpp>
  30 #include <cmath>
  31 #include <cstdio>
  32
  33 using std::list;
  34 using std::string;
  35 using std::cout;
  36 using std::cerr;
  37 using std::map;
  38 using boost::shared_ptr;
  39 using boost::shared_array;
  40 using boost::optional;
  41 using boost::dynamic_pointer_cast;
  42 using namespace dcp;
  43
  44 InteropSubtitleAsset::InteropSubtitleAsset (boost::filesystem::path file)
  45         : SubtitleAsset (file)
  46 {
  47         shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));
  48         xml->read_file (file);
  49         _id = xml->string_child ("SubtitleID");
  50         _reel_number = xml->string_child ("ReelNumber");
  51         _language = xml->string_child ("Language");
  52         _movie_title = xml->string_child ("MovieTitle");
  53         _load_font_nodes = type_children<dcp::InteropLoadFontNode> (xml, "LoadFont");
  54
  55         list<cxml::NodePtr> f = xml->node_children ("Font");
  56         list<shared_ptr<dcp::FontNode> > font_nodes;
  57         BOOST_FOREACH (cxml::NodePtr& i, f) {
  58                 font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, 250, "Id")));
  59         }
  60
  61         f = xml->node_children ("Subtitle");
  62         list<shared_ptr<dcp::SubtitleNode> > subtitle_nodes;
  63         BOOST_FOREACH (cxml::NodePtr& i, f) {
  64                 subtitle_nodes.push_back (shared_ptr<SubtitleNode> (new SubtitleNode (i, 250, "Id")));
  65         }
  66
  67         parse_subtitles (xml, font_nodes, subtitle_nodes);
  68 }
  69
  70 InteropSubtitleAsset::InteropSubtitleAsset ()
  71 {
  72
  73 }
  74
  75 string
  76 InteropSubtitleAsset::xml_as_string () const
  77 {
  78         xmlpp::Document doc;
  79         xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
  80         root->set_attribute ("Version", "1.0");
  81
  82         root->add_child("SubtitleID")->add_child_text (_id);
  83         root->add_child("MovieTitle")->add_child_text (_movie_title);
  84         root->add_child("ReelNumber")->add_child_text (raw_convert<string> (_reel_number));
  85         root->add_child("Language")->add_child_text (_language);
  86
  87         for (list<shared_ptr<InteropLoadFontNode> >::const_iterator i = _load_font_nodes.begin(); i != _load_font_nodes.end(); ++i) {
  88                 xmlpp::Element* load_font = root->add_child("LoadFont");
  89                 load_font->set_attribute ("Id", (*i)->id);
  90                 load_font->set_attribute ("URI", (*i)->uri);
  91         }
  92
  93         subtitles_as_xml (root, 250, INTEROP);
  94
  95         return doc.write_to_string_formatted ("UTF-8");
  96 }
  97
  98 void
  99 InteropSubtitleAsset::add_font (string load_id, boost::filesystem::path file)
 100 {
 101         _fonts.push_back (Font (load_id, make_uuid(), file));
 102         _load_font_nodes.push_back (shared_ptr<InteropLoadFontNode> (new InteropLoadFontNode (load_id, file.leaf().string ())));
 103 }
 104
 105 bool
 106 InteropSubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 107 {
 108         if (!SubtitleAsset::equals (other_asset, options, note)) {
 109                 return false;
 110         }
 111
 112         shared_ptr<const InteropSubtitleAsset> other = dynamic_pointer_cast<const InteropSubtitleAsset> (other_asset);
 113         if (!other) {
 114                 return false;
 115         }
 116
 117         list<shared_ptr<InteropLoadFontNode> >::const_iterator i = _load_font_nodes.begin ();
 118         list<shared_ptr<InteropLoadFontNode> >::const_iterator j = other->_load_font_nodes.begin ();
 119
 120         while (i != _load_font_nodes.end ()) {
 121                 if (j == other->_load_font_nodes.end ()) {
 122                         note (DCP_ERROR, "<LoadFont> nodes differ");
 123                         return false;
 124                 }
 125
 126                 if (**i != **j) {
 127                         note (DCP_ERROR, "<LoadFont> nodes differ");
 128                         return false;
 129                 }
 130
 131                 ++i;
 132                 ++j;
 133         }
 134
 135         if (_movie_title != other->_movie_title) {
 136                 note (DCP_ERROR, "Subtitle movie titles differ");
 137                 return false;
 138         }
 139
 140         return true;
 141 }
 142
 143 list<shared_ptr<LoadFontNode> >
 144 InteropSubtitleAsset::load_font_nodes () const
 145 {
 146         list<shared_ptr<LoadFontNode> > lf;
 147         copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
 148         return lf;
 149 }
 150
 151 /** Write this content to an XML file with its fonts alongside */
 152 void
 153 InteropSubtitleAsset::write (boost::filesystem::path p) const
 154 {
 155         FILE* f = fopen_boost (p, "w");
 156         if (!f) {
 157                 throw FileError ("Could not open file for writing", p, -1);
 158         }
 159
 160         string const s = xml_as_string ();
 161         /* length() here gives bytes not characters */
 162         fwrite (s.c_str(), 1, s.length(), f);
 163         fclose (f);
 164
 165         _file = p;
 166
 167         BOOST_FOREACH (shared_ptr<InteropLoadFontNode> i, _load_font_nodes) {
 168                 boost::filesystem::path file = p.parent_path() / i->uri;
 169                 FILE* f = fopen_boost (file, "wb");
 170                 if (!f) {
 171                         throw FileError ("could not open font file for writing", file, errno);
 172                 }
 173                 list<Font>::const_iterator j = _fonts.begin ();
 174                 while (j != _fonts.end() && j->load_id != i->id) {
 175                         ++j;
 176                 }
 177                 if (j != _fonts.end ()) {
 178                         fwrite (j->data.data.get(), 1, j->data.size, f);
 179                         j->file = file;
 180                 }
 181                 fclose (f);
 182         }
 183 }
 184
 185 void
 186 InteropSubtitleAsset::resolve_fonts (list<shared_ptr<Object> > objects)
 187 {
 188         BOOST_FOREACH (shared_ptr<Object> i, objects) {
 189                 shared_ptr<FontAsset> font = dynamic_pointer_cast<FontAsset> (i);
 190                 if (!font) {
 191                         continue;
 192                 }
 193
 194                 BOOST_FOREACH (shared_ptr<InteropLoadFontNode> j, _load_font_nodes) {
 195                         if (j->uri == font->file().leaf().string ()) {
 196                                 _fonts.push_back (Font (j->id, i->id(), font->file ()));
 197                         }
 198                 }
 199         }
 200 }
 201
 202 void
 203 InteropSubtitleAsset::add_font_assets (list<shared_ptr<Asset> >& assets)
 204 {
 205         BOOST_FOREACH (Font const & i, _fonts) {
 206                 DCP_ASSERT (i.file);
 207                 assets.push_back (shared_ptr<FontAsset> (new FontAsset (i.uuid, i.file.get ())));
 208         }
 209 }