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