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 "AS_DCP.h"
  30 #include "KM_util.h"
  31 #include "raw_convert.h"
  32 #include <libxml++/libxml++.h>
  33 #include <boost/foreach.hpp>
  34 #include <boost/algorithm/string.hpp>
  35
  36 using std::string;
  37 using std::list;
  38 using std::stringstream;
  39 using std::cout;
  40 using std::vector;
  41 using boost::shared_ptr;
  42 using boost::split;
  43 using boost::is_any_of;
  44 using namespace dcp;
  45
  46 SMPTESubtitleAsset::SMPTESubtitleAsset ()
  47         : _time_code_rate (0)
  48 {
  49
  50 }
  51
  52 /** Construct a SMPTESubtitleAsset by reading an MXF file.
  53  *  @param file Filename.
  54  */
  55 SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
  56         : SubtitleAsset (file)
  57 {
  58         shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
  59
  60         ASDCP::TimedText::MXFReader reader;
  61         Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
  62         if (ASDCP_FAILURE (r)) {
  63                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file, r));
  64         }
  65
  66         string s;
  67         reader.ReadTimedTextResource (s, 0, 0);
  68         stringstream t;
  69         t << s;
  70         xml->read_stream (t);
  71
  72         ASDCP::WriterInfo info;
  73         reader.FillWriterInfo (info);
  74         _id = read_writer_info (info);
  75
  76         _load_font_nodes = type_children<dcp::SMPTELoadFontNode> (xml, "LoadFont");
  77
  78         _content_title_text = xml->string_child ("ContentTitleText");
  79         _annotation_text = xml->optional_string_child ("AnnotationText");
  80         _issue_date = LocalTime (xml->string_child ("IssueDate"));
  81         _reel_number = xml->optional_number_child<int> ("ReelNumber");
  82         _language = xml->optional_string_child ("Language");
  83
  84         /* This is supposed to be two numbers, but a single number has been seen in the wild */
  85         string const er = xml->string_child ("EditRate");
  86         vector<string> er_parts;
  87         split (er_parts, er, is_any_of (" "));
  88         if (er_parts.size() == 1) {
  89                 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), 1);
  90         } else if (er_parts.size() == 2) {
  91                 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), raw_convert<int> (er_parts[1]));
  92         } else {
  93                 throw XMLError ("malformed EditRate " + er);
  94         }
  95
  96         _time_code_rate = xml->number_child<int> ("TimeCodeRate");
  97         if (xml->optional_string_child ("StartTime")) {
  98                 _start_time = Time (xml->string_child ("StartTime"), _time_code_rate);
  99         }
 100
 101         shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
 102
 103         list<cxml::NodePtr> f = subtitle_list->node_children ("Font");
 104         list<shared_ptr<dcp::FontNode> > font_nodes;
 105         BOOST_FOREACH (cxml::NodePtr& i, f) {
 106                 font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, _time_code_rate)));
 107         }
 108
 109         parse_subtitles (xml, font_nodes);
 110 }
 111
 112 list<shared_ptr<LoadFontNode> >
 113 SMPTESubtitleAsset::load_font_nodes () const
 114 {
 115         list<shared_ptr<LoadFontNode> > lf;
 116         copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
 117         return lf;
 118 }
 119
 120 bool
 121 SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
 122 {
 123         ASDCP::TimedText::MXFReader reader;
 124         Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
 125         return !ASDCP_FAILURE (r);
 126 }
 127
 128 Glib::ustring
 129 SMPTESubtitleAsset::xml_as_string () const
 130 {
 131         xmlpp::Document doc;
 132         xmlpp::Element* root = doc.create_root_node ("dcst:SubtitleReel");
 133         root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/428-7/2010/DCST", "dcst");
 134         root->set_namespace_declaration ("http://www.w3.org/2001/XMLSchema", "xs");
 135
 136         root->add_child("ID", "dcst")->add_child_text (_id);
 137         root->add_child("ContentTitleText", "dcst")->add_child_text (_content_title_text);
 138         if (_annotation_text) {
 139                 root->add_child("AnnotationText", "dcst")->add_child_text (_annotation_text.get ());
 140         }
 141         root->add_child("IssueDate", "dcst")->add_child_text (_issue_date.as_string (true));
 142         if (_reel_number) {
 143                 root->add_child("ReelNumber", "dcst")->add_child_text (raw_convert<string> (_reel_number.get ()));
 144         }
 145         if (_language) {
 146                 root->add_child("Language", "dcst")->add_child_text (_language.get ());
 147         }
 148         root->add_child("EditRate", "dcst")->add_child_text (_edit_rate.as_string ());
 149         root->add_child("TimeCodeRate", "dcst")->add_child_text (raw_convert<string> (_time_code_rate));
 150         if (_start_time) {
 151                 root->add_child("StartTime", "dcst")->add_child_text (_start_time.get().as_string ());
 152         }
 153
 154         BOOST_FOREACH (shared_ptr<SMPTELoadFontNode> i, _load_font_nodes) {
 155                 xmlpp::Element* load_font = root->add_child("LoadFont", "dcst");
 156                 load_font->add_child_text (i->urn);
 157                 load_font->set_attribute ("ID", i->id);
 158         }
 159
 160         subtitles_as_xml (root->add_child ("SubtitleList", "dcst"), _time_code_rate, "dcst");
 161
 162         return doc.write_to_string_formatted ("UTF-8");
 163 }
 164
 165 /** Write this content to a MXF file */
 166 void
 167 SMPTESubtitleAsset::write (boost::filesystem::path p) const
 168 {
 169         ASDCP::WriterInfo writer_info;
 170         fill_writer_info (&writer_info, _id, SMPTE);
 171
 172         ASDCP::TimedText::TimedTextDescriptor descriptor;
 173         descriptor.EditRate = ASDCP::Rational (_edit_rate.numerator, _edit_rate.denominator);
 174         descriptor.EncodingName = "UTF-8";
 175         descriptor.ResourceList.clear ();
 176         descriptor.NamespaceName = "dcst";
 177         memcpy (descriptor.AssetID, writer_info.AssetUUID, ASDCP::UUIDlen);
 178         descriptor.ContainerDuration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
 179
 180         /* XXX: should write fonts into the file somehow */
 181
 182         ASDCP::TimedText::MXFWriter writer;
 183         ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor);
 184         if (ASDCP_FAILURE (r)) {
 185                 boost::throw_exception (FileError ("could not open subtitle MXF for writing", p.string(), r));
 186         }
 187
 188         /* XXX: no encryption */
 189         r = writer.WriteTimedTextResource (xml_as_string ());
 190         if (ASDCP_FAILURE (r)) {
 191                 boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r));
 192         }
 193
 194         writer.Finalize ();
 195
 196         _file = p;
 197 }
 198
 199 bool
 200 SMPTESubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 201 {
 202         /* XXX */
 203         return false;
 204 }
 205
 206 void
 207 SMPTESubtitleAsset::add_font (string id, boost::filesystem::path file)
 208 {
 209         /* XXX */
 210 }