src/smpte_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 /** @file  src/smpte_subtitle_asset.cc
  21  *  @brief SMPTESubtitleAsset class.
  22  */
  23
  24 #include "smpte_subtitle_asset.h"
  25 #include "smpte_load_font_node.h"
  26 #include "font_node.h"
  27 #include "exceptions.h"
  28 #include "xml.h"
  29 #include "raw_convert.h"
  30 #include "dcp_assert.h"
  31 #include "util.h"
  32 #include "AS_DCP.h"
  33 #include "KM_util.h"
  34 #include "compose.hpp"
  35 #include <libxml++/libxml++.h>
  36 #include <boost/foreach.hpp>
  37 #include <boost/algorithm/string.hpp>
  38
  39 using std::string;
  40 using std::list;
  41 using std::stringstream;
  42 using std::cout;
  43 using std::vector;
  44 using std::map;
  45 using boost::shared_ptr;
  46 using boost::split;
  47 using boost::is_any_of;
  48 using boost::shared_array;
  49 using boost::dynamic_pointer_cast;
  50 using namespace dcp;
  51
  52 SMPTESubtitleAsset::SMPTESubtitleAsset ()
  53         : _intrinsic_duration (0)
  54         , _edit_rate (24, 1)
  55         , _time_code_rate (24)
  56 {
  57
  58 }
  59
  60 /** Construct a SMPTESubtitleAsset by reading an MXF or XML file.
  61  *  @param file Filename.
  62  */
  63 SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
  64         : SubtitleAsset (file)
  65 {
  66         shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
  67
  68         shared_ptr<ASDCP::TimedText::MXFReader> reader (new ASDCP::TimedText::MXFReader ());
  69         Kumu::Result_t r = reader->OpenRead (file.string().c_str ());
  70
  71         if (!ASDCP_FAILURE (r)) {
  72                 string s;
  73                 reader->ReadTimedTextResource (s, 0, 0);
  74                 stringstream t;
  75                 t << s;
  76                 xml->read_stream (t);
  77                 ASDCP::WriterInfo info;
  78                 reader->FillWriterInfo (info);
  79                 _id = read_writer_info (info);
  80         } else {
  81                 reader.reset ();
  82                 try {
  83                         xml->read_file (file);
  84                         _id = xml->string_child ("Id").substr (9);
  85                 } catch (cxml::Error& e) {
  86                         boost::throw_exception (
  87                                 DCPReadError (
  88                                         String::compose ("could not read subtitles from %1; MXF failed with %2, XML failed with %3", file, static_cast<int> (r), e.what ())
  89                                         )
  90                                 );
  91                 }
  92         }
  93
  94         _load_font_nodes = type_children<dcp::SMPTELoadFontNode> (xml, "LoadFont");
  95
  96         _content_title_text = xml->string_child ("ContentTitleText");
  97         _annotation_text = xml->optional_string_child ("AnnotationText");
  98         _issue_date = LocalTime (xml->string_child ("IssueDate"));
  99         _reel_number = xml->optional_number_child<int> ("ReelNumber");
 100         _language = xml->optional_string_child ("Language");
 101
 102         /* This is supposed to be two numbers, but a single number has been seen in the wild */
 103         string const er = xml->string_child ("EditRate");
 104         vector<string> er_parts;
 105         split (er_parts, er, is_any_of (" "));
 106         if (er_parts.size() == 1) {
 107                 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), 1);
 108         } else if (er_parts.size() == 2) {
 109                 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), raw_convert<int> (er_parts[1]));
 110         } else {
 111                 throw XMLError ("malformed EditRate " + er);
 112         }
 113
 114         _time_code_rate = xml->number_child<int> ("TimeCodeRate");
 115         if (xml->optional_string_child ("StartTime")) {
 116                 _start_time = Time (xml->string_child ("StartTime"), _time_code_rate);
 117         }
 118
 119         shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
 120
 121         list<cxml::NodePtr> f = subtitle_list->node_children ("Font");
 122         list<shared_ptr<dcp::FontNode> > font_nodes;
 123         BOOST_FOREACH (cxml::NodePtr& i, f) {
 124                 font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, _time_code_rate)));
 125         }
 126
 127         parse_subtitles (xml, font_nodes);
 128
 129         if (reader) {
 130                 ASDCP::TimedText::TimedTextDescriptor descriptor;
 131                 reader->FillTimedTextDescriptor (descriptor);
 132
 133                 /* Load fonts */
 134
 135                 for (
 136                         ASDCP::TimedText::ResourceList_t::const_iterator i = descriptor.ResourceList.begin();
 137                         i != descriptor.ResourceList.end();
 138                         ++i) {
 139
 140                         if (i->Type == ASDCP::TimedText::MT_OPENTYPE) {
 141                                 ASDCP::TimedText::FrameBuffer buffer;
 142                                 buffer.Capacity (10 * 1024 * 1024);
 143                                 reader->ReadAncillaryResource (i->ResourceID, buffer);
 144
 145                                 char id[64];
 146                                 Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof (id));
 147
 148                                 shared_array<uint8_t> data (new uint8_t[buffer.Size()]);
 149                                 memcpy (data.get(), buffer.RoData(), buffer.Size());
 150
 151                                 list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = _load_font_nodes.begin ();
 152                                 while (j != _load_font_nodes.end() && (*j)->urn != id) {
 153                                         ++j;
 154                                 }
 155
 156                                 if (j != _load_font_nodes.end ()) {
 157                                         _fonts.push_back (Font ((*j)->id, (*j)->urn, Data (data, buffer.Size ())));
 158                                 }
 159                         }
 160                 }
 161
 162                 /* Get intrinsic duration */
 163                 _intrinsic_duration = descriptor.ContainerDuration;
 164         } else {
 165                 /* Guess intrinsic duration */
 166                 _intrinsic_duration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
 167         }
 168 }
 169
 170 list<shared_ptr<LoadFontNode> >
 171 SMPTESubtitleAsset::load_font_nodes () const
 172 {
 173         list<shared_ptr<LoadFontNode> > lf;
 174         copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
 175         return lf;
 176 }
 177
 178 bool
 179 SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
 180 {
 181         ASDCP::TimedText::MXFReader reader;
 182         Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
 183         return !ASDCP_FAILURE (r);
 184 }
 185
 186 Glib::ustring
 187 SMPTESubtitleAsset::xml_as_string () const
 188 {
 189         xmlpp::Document doc;
 190         xmlpp::Element* root = doc.create_root_node ("dcst:SubtitleReel");
 191         root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/428-7/2010/DCST", "dcst");
 192         root->set_namespace_declaration ("http://www.w3.org/2001/XMLSchema", "xs");
 193
 194         root->add_child("Id", "dcst")->add_child_text ("urn:uuid:" + _id);
 195         root->add_child("ContentTitleText", "dcst")->add_child_text (_content_title_text);
 196         if (_annotation_text) {
 197                 root->add_child("AnnotationText", "dcst")->add_child_text (_annotation_text.get ());
 198         }
 199         root->add_child("IssueDate", "dcst")->add_child_text (_issue_date.as_string (true));
 200         if (_reel_number) {
 201                 root->add_child("ReelNumber", "dcst")->add_child_text (raw_convert<string> (_reel_number.get ()));
 202         }
 203         if (_language) {
 204                 root->add_child("Language", "dcst")->add_child_text (_language.get ());
 205         }
 206         root->add_child("EditRate", "dcst")->add_child_text (_edit_rate.as_string ());
 207         root->add_child("TimeCodeRate", "dcst")->add_child_text (raw_convert<string> (_time_code_rate));
 208         if (_start_time) {
 209                 root->add_child("StartTime", "dcst")->add_child_text (_start_time.get().as_string (SMPTE));
 210         }
 211
 212         BOOST_FOREACH (shared_ptr<SMPTELoadFontNode> i, _load_font_nodes) {
 213                 xmlpp::Element* load_font = root->add_child("LoadFont", "dcst");
 214                 load_font->add_child_text ("urn:uuid:" + i->urn);
 215                 load_font->set_attribute ("ID", i->id);
 216         }
 217
 218         subtitles_as_xml (root->add_child ("SubtitleList", "dcst"), _time_code_rate, SMPTE);
 219
 220         return doc.write_to_string_formatted ("UTF-8");
 221 }
 222
 223 /** Write this content to a MXF file */
 224 void
 225 SMPTESubtitleAsset::write (boost::filesystem::path p) const
 226 {
 227         ASDCP::WriterInfo writer_info;
 228         fill_writer_info (&writer_info, _id, SMPTE);
 229
 230         ASDCP::TimedText::TimedTextDescriptor descriptor;
 231         descriptor.EditRate = ASDCP::Rational (_edit_rate.numerator, _edit_rate.denominator);
 232         descriptor.EncodingName = "UTF-8";
 233
 234         BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
 235                 list<Font>::const_iterator j = _fonts.begin ();
 236                 while (j != _fonts.end() && j->load_id != i->id) {
 237                         ++j;
 238                 }
 239                 if (j != _fonts.end ()) {
 240                         ASDCP::TimedText::TimedTextResourceDescriptor res;
 241                         unsigned int c;
 242                         Kumu::hex2bin (i->urn.c_str(), res.ResourceID, Kumu::UUID_Length, &c);
 243                         DCP_ASSERT (c == Kumu::UUID_Length);
 244                         res.Type = ASDCP::TimedText::MT_OPENTYPE;
 245                         descriptor.ResourceList.push_back (res);
 246                 }
 247         }
 248
 249         descriptor.NamespaceName = "dcst";
 250         memcpy (descriptor.AssetID, writer_info.AssetUUID, ASDCP::UUIDlen);
 251         descriptor.ContainerDuration = _intrinsic_duration;
 252
 253         ASDCP::TimedText::MXFWriter writer;
 254         ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor);
 255         if (ASDCP_FAILURE (r)) {
 256                 boost::throw_exception (FileError ("could not open subtitle MXF for writing", p.string(), r));
 257         }
 258
 259         /* XXX: no encryption */
 260         r = writer.WriteTimedTextResource (xml_as_string ());
 261         if (ASDCP_FAILURE (r)) {
 262                 boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r));
 263         }
 264
 265         BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
 266                 list<Font>::const_iterator j = _fonts.begin ();
 267                 while (j != _fonts.end() && j->load_id != i->id) {
 268                         ++j;
 269                 }
 270                 if (j != _fonts.end ()) {
 271                         ASDCP::TimedText::FrameBuffer buffer;
 272                         buffer.SetData (j->data.data.get(), j->data.size);
 273                         buffer.Size (j->data.size);
 274                         r = writer.WriteAncillaryResource (buffer);
 275                         if (ASDCP_FAILURE (r)) {
 276                                 boost::throw_exception (MXFFileError ("could not write font to timed text resource", p.string(), r));
 277                         }
 278                 }
 279         }
 280
 281         writer.Finalize ();
 282
 283         _file = p;
 284 }
 285
 286 bool
 287 SMPTESubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 288 {
 289         if (!SubtitleAsset::equals (other_asset, options, note)) {
 290                 return false;
 291         }
 292
 293         shared_ptr<const SMPTESubtitleAsset> other = dynamic_pointer_cast<const SMPTESubtitleAsset> (other_asset);
 294         if (!other) {
 295                 note (DCP_ERROR, "Subtitles are in different standards");
 296                 return false;
 297         }
 298
 299         list<shared_ptr<SMPTELoadFontNode> >::const_iterator i = _load_font_nodes.begin ();
 300         list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = other->_load_font_nodes.begin ();
 301
 302         while (i != _load_font_nodes.end ()) {
 303                 if (j == other->_load_font_nodes.end ()) {
 304                         note (DCP_ERROR, "<LoadFont> nodes differ");
 305                         return false;
 306                 }
 307
 308                 if ((*i)->id != (*j)->id) {
 309                         note (DCP_ERROR, "<LoadFont> nodes differ");
 310                         return false;
 311                 }
 312
 313                 ++i;
 314                 ++j;
 315         }
 316
 317         if (_content_title_text != other->_content_title_text) {
 318                 note (DCP_ERROR, "Subtitle content title texts differ");
 319                 return false;
 320         }
 321
 322         if (_language != other->_language) {
 323                 note (DCP_ERROR, "Subtitle languages differ");
 324                 return false;
 325         }
 326
 327         if (_annotation_text != other->_annotation_text) {
 328                 note (DCP_ERROR, "Subtitle annotation texts differ");
 329                 return false;
 330         }
 331
 332         if (_issue_date != other->_issue_date) {
 333                 if (options.issue_dates_can_differ) {
 334                         note (DCP_NOTE, "Subtitle issue dates differ");
 335                 } else {
 336                         note (DCP_ERROR, "Subtitle issue dates differ");
 337                         return false;
 338                 }
 339         }
 340
 341         if (_reel_number != other->_reel_number) {
 342                 note (DCP_ERROR, "Subtitle reel numbers differ");
 343                 return false;
 344         }
 345
 346         if (_edit_rate != other->_edit_rate) {
 347                 note (DCP_ERROR, "Subtitle edit rates differ");
 348                 return false;
 349         }
 350
 351         if (_time_code_rate != other->_time_code_rate) {
 352                 note (DCP_ERROR, "Subtitle time code rates differ");
 353                 return false;
 354         }
 355
 356         if (_start_time != other->_start_time) {
 357                 note (DCP_ERROR, "Subtitle start times differ");
 358                 return false;
 359         }
 360
 361         return true;
 362 }
 363
 364 void
 365 SMPTESubtitleAsset::add_font (string load_id, boost::filesystem::path file)
 366 {
 367         string const uuid = make_uuid ();
 368         _fonts.push_back (Font (load_id, uuid, file));
 369         _load_font_nodes.push_back (shared_ptr<SMPTELoadFontNode> (new SMPTELoadFontNode (load_id, uuid)));
 370 }
 371
 372 void
 373 SMPTESubtitleAsset::add (dcp::SubtitleString s)
 374 {
 375         SubtitleAsset::add (s);
 376         _intrinsic_duration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
 377 }