2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/smpte_subtitle_asset.cc
21 * @brief SMPTESubtitleAsset class.
24 #include "smpte_subtitle_asset.h"
25 #include "smpte_load_font_node.h"
26 #include "font_node.h"
27 #include "exceptions.h"
29 #include "raw_convert.h"
30 #include "dcp_assert.h"
34 #include <libxml++/libxml++.h>
35 #include <boost/foreach.hpp>
36 #include <boost/algorithm/string.hpp>
40 using std::stringstream;
44 using boost::shared_ptr;
46 using boost::is_any_of;
47 using boost::shared_array;
48 using boost::dynamic_pointer_cast;
51 SMPTESubtitleAsset::SMPTESubtitleAsset ()
53 , _time_code_rate (24)
58 /** Construct a SMPTESubtitleAsset by reading an MXF file.
59 * @param file Filename.
61 SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
62 : SubtitleAsset (file)
64 ASDCP::TimedText::MXFReader reader;
65 Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
66 if (ASDCP_FAILURE (r)) {
67 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file, r));
70 /* Read the subtitle XML */
73 reader.ReadTimedTextResource (s, 0, 0);
76 shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
79 ASDCP::WriterInfo info;
80 reader.FillWriterInfo (info);
81 _id = read_writer_info (info);
83 _load_font_nodes = type_children<dcp::SMPTELoadFontNode> (xml, "LoadFont");
85 _content_title_text = xml->string_child ("ContentTitleText");
86 _annotation_text = xml->optional_string_child ("AnnotationText");
87 _issue_date = LocalTime (xml->string_child ("IssueDate"));
88 _reel_number = xml->optional_number_child<int> ("ReelNumber");
89 _language = xml->optional_string_child ("Language");
91 /* This is supposed to be two numbers, but a single number has been seen in the wild */
92 string const er = xml->string_child ("EditRate");
93 vector<string> er_parts;
94 split (er_parts, er, is_any_of (" "));
95 if (er_parts.size() == 1) {
96 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), 1);
97 } else if (er_parts.size() == 2) {
98 _edit_rate = Fraction (raw_convert<int> (er_parts[0]), raw_convert<int> (er_parts[1]));
100 throw XMLError ("malformed EditRate " + er);
103 _time_code_rate = xml->number_child<int> ("TimeCodeRate");
104 if (xml->optional_string_child ("StartTime")) {
105 _start_time = Time (xml->string_child ("StartTime"), _time_code_rate);
108 shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
110 list<cxml::NodePtr> f = subtitle_list->node_children ("Font");
111 list<shared_ptr<dcp::FontNode> > font_nodes;
112 BOOST_FOREACH (cxml::NodePtr& i, f) {
113 font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, _time_code_rate)));
116 parse_subtitles (xml, font_nodes);
120 ASDCP::TimedText::TimedTextDescriptor text_descriptor;
121 reader.FillTimedTextDescriptor (text_descriptor);
123 ASDCP::TimedText::ResourceList_t::const_iterator i = text_descriptor.ResourceList.begin();
124 i != text_descriptor.ResourceList.end();
127 if (i->Type == ASDCP::TimedText::MT_OPENTYPE) {
128 ASDCP::TimedText::FrameBuffer buffer;
129 buffer.Capacity (10 * 1024 * 1024);
130 reader.ReadAncillaryResource (i->ResourceID, buffer);
133 Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof (id));
135 shared_array<uint8_t> data (new uint8_t[buffer.Size()]);
136 memcpy (data.get(), buffer.RoData(), buffer.Size());
138 /* The IDs in the MXF have a 9 character prefix of unknown origin and meaning... */
139 string check_id = string (id).substr (9);
141 list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = _load_font_nodes.begin ();
142 while (j != _load_font_nodes.end() && (*j)->urn != check_id) {
146 if (j != _load_font_nodes.end ()) {
147 _fonts.push_back (Font ((*j)->id, (*j)->urn, Data (data, buffer.Size ())));
155 list<shared_ptr<LoadFontNode> >
156 SMPTESubtitleAsset::load_font_nodes () const
158 list<shared_ptr<LoadFontNode> > lf;
159 copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
164 SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
166 ASDCP::TimedText::MXFReader reader;
167 Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
168 return !ASDCP_FAILURE (r);
172 SMPTESubtitleAsset::xml_as_string () const
175 xmlpp::Element* root = doc.create_root_node ("dcst:SubtitleReel");
176 root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/428-7/2010/DCST", "dcst");
177 root->set_namespace_declaration ("http://www.w3.org/2001/XMLSchema", "xs");
179 root->add_child("ID", "dcst")->add_child_text (_id);
180 root->add_child("ContentTitleText", "dcst")->add_child_text (_content_title_text);
181 if (_annotation_text) {
182 root->add_child("AnnotationText", "dcst")->add_child_text (_annotation_text.get ());
184 root->add_child("IssueDate", "dcst")->add_child_text (_issue_date.as_string (true));
186 root->add_child("ReelNumber", "dcst")->add_child_text (raw_convert<string> (_reel_number.get ()));
189 root->add_child("Language", "dcst")->add_child_text (_language.get ());
191 root->add_child("EditRate", "dcst")->add_child_text (_edit_rate.as_string ());
192 root->add_child("TimeCodeRate", "dcst")->add_child_text (raw_convert<string> (_time_code_rate));
194 root->add_child("StartTime", "dcst")->add_child_text (_start_time.get().as_string ());
197 BOOST_FOREACH (shared_ptr<SMPTELoadFontNode> i, _load_font_nodes) {
198 xmlpp::Element* load_font = root->add_child("LoadFont", "dcst");
199 load_font->add_child_text (i->urn);
200 load_font->set_attribute ("ID", i->id);
203 subtitles_as_xml (root->add_child ("SubtitleList", "dcst"), _time_code_rate, "dcst");
205 return doc.write_to_string_formatted ("UTF-8");
208 /** Write this content to a MXF file */
210 SMPTESubtitleAsset::write (boost::filesystem::path p) const
212 ASDCP::WriterInfo writer_info;
213 fill_writer_info (&writer_info, _id, SMPTE);
215 ASDCP::TimedText::TimedTextDescriptor descriptor;
216 descriptor.EditRate = ASDCP::Rational (_edit_rate.numerator, _edit_rate.denominator);
217 descriptor.EncodingName = "UTF-8";
219 BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
220 list<Font>::const_iterator j = _fonts.begin ();
221 while (j != _fonts.end() && j->load_id != i->id) {
224 if (j != _fonts.end ()) {
225 ASDCP::TimedText::TimedTextResourceDescriptor res;
227 Kumu::hex2bin (i->urn.c_str(), res.ResourceID, Kumu::UUID_Length, &c);
228 DCP_ASSERT (c == Kumu::UUID_Length);
229 res.Type = ASDCP::TimedText::MT_OPENTYPE;
230 descriptor.ResourceList.push_back (res);
234 descriptor.NamespaceName = "dcst";
235 memcpy (descriptor.AssetID, writer_info.AssetUUID, ASDCP::UUIDlen);
236 descriptor.ContainerDuration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
238 ASDCP::TimedText::MXFWriter writer;
239 ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor);
240 if (ASDCP_FAILURE (r)) {
241 boost::throw_exception (FileError ("could not open subtitle MXF for writing", p.string(), r));
244 /* XXX: no encryption */
245 r = writer.WriteTimedTextResource (xml_as_string ());
246 if (ASDCP_FAILURE (r)) {
247 boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r));
250 BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
251 list<Font>::const_iterator j = _fonts.begin ();
252 while (j != _fonts.end() && j->load_id != i->id) {
255 if (j != _fonts.end ()) {
256 ASDCP::TimedText::FrameBuffer buffer;
257 buffer.SetData (j->data.data.get(), j->data.size);
258 buffer.Size (j->data.size);
259 r = writer.WriteAncillaryResource (buffer);
260 if (ASDCP_FAILURE (r)) {
261 boost::throw_exception (MXFFileError ("could not write font to timed text resource", p.string(), r));
272 SMPTESubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
274 if (!SubtitleAsset::equals (other_asset, options, note)) {
278 shared_ptr<const SMPTESubtitleAsset> other = dynamic_pointer_cast<const SMPTESubtitleAsset> (other_asset);
280 note (DCP_ERROR, "Subtitles are in different standards");
284 list<shared_ptr<SMPTELoadFontNode> >::const_iterator i = _load_font_nodes.begin ();
285 list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = other->_load_font_nodes.begin ();
287 while (i != _load_font_nodes.end ()) {
288 if (j == other->_load_font_nodes.end ()) {
289 note (DCP_ERROR, "<LoadFont> nodes differ");
293 if ((*i)->id != (*j)->id) {
294 note (DCP_ERROR, "<LoadFont> nodes differ");
302 if (_content_title_text != other->_content_title_text) {
303 note (DCP_ERROR, "Subtitle content title texts differ");
307 if (_language != other->_language) {
308 note (DCP_ERROR, "Subtitle languages differ");
312 if (_annotation_text != other->_annotation_text) {
313 note (DCP_ERROR, "Subtitle annotation texts differ");
317 if (_issue_date != other->_issue_date) {
318 if (options.issue_dates_can_differ) {
319 note (DCP_NOTE, "Subtitle issue dates differ");
321 note (DCP_ERROR, "Subtitle issue dates differ");
326 if (_reel_number != other->_reel_number) {
327 note (DCP_ERROR, "Subtitle reel numbers differ");
331 if (_edit_rate != other->_edit_rate) {
332 note (DCP_ERROR, "Subtitle edit rates differ");
336 if (_time_code_rate != other->_time_code_rate) {
337 note (DCP_ERROR, "Subtitle time code rates differ");
341 if (_start_time != other->_start_time) {
342 note (DCP_ERROR, "Subtitle start times differ");
350 SMPTESubtitleAsset::add_font (string load_id, boost::filesystem::path file)
352 string const uuid = make_uuid ();
353 _fonts.push_back (Font (load_id, uuid, file));
354 _load_font_nodes.push_back (shared_ptr<SMPTELoadFontNode> (new SMPTELoadFontNode (load_id, uuid)));