X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsmpte_subtitle_asset.cc;h=a55b91ae8477e7242d9248666d59bac10500fc20;hb=89d9ddba959f02b17f1d0e75e2f12c357ce29f2b;hp=8ea68362116243a218b7a23a3ef0b4a8128bfdcb;hpb=9e523d8a4062ad52330dff6c2ba50e54184c9bb2;p=libdcp.git diff --git a/src/smpte_subtitle_asset.cc b/src/smpte_subtitle_asset.cc index 8ea68362..a55b91ae 100644 --- a/src/smpte_subtitle_asset.cc +++ b/src/smpte_subtitle_asset.cc @@ -1,85 +1,164 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ + /** @file src/smpte_subtitle_asset.cc - * @brief SMPTESubtitleAsset class. + * @brief SMPTESubtitleAsset class */ + #include "smpte_subtitle_asset.h" #include "smpte_load_font_node.h" -#include "font_node.h" #include "exceptions.h" #include "xml.h" #include "raw_convert.h" #include "dcp_assert.h" #include "util.h" -#include "AS_DCP.h" -#include "KM_util.h" +#include "compose.hpp" +#include "crypto_context.h" +#include "subtitle_image.h" +#include +#include +#include #include -#include #include + using std::string; using std::list; -using std::stringstream; -using std::cout; using std::vector; using std::map; -using boost::shared_ptr; +using std::shared_ptr; +using std::dynamic_pointer_cast; +using std::make_shared; using boost::split; using boost::is_any_of; using boost::shared_array; -using boost::dynamic_pointer_cast; +using boost::optional; +using boost::starts_with; using namespace dcp; + +static string const subtitle_smpte_ns = "http://www.smpte-ra.org/schemas/428-7/2010/DCST"; + + SMPTESubtitleAsset::SMPTESubtitleAsset () - : _edit_rate (24, 1) + : MXF (Standard::SMPTE) + , _edit_rate (24, 1) , _time_code_rate (24) + , _xml_id (make_uuid()) { } -/** Construct a SMPTESubtitleAsset by reading an MXF file. - * @param file Filename. - */ + SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file) : SubtitleAsset (file) { - ASDCP::TimedText::MXFReader reader; - Kumu::Result_t r = reader.OpenRead (file.string().c_str ()); - if (ASDCP_FAILURE (r)) { - boost::throw_exception (MXFFileError ("could not open MXF file for reading", file, r)); + auto xml = make_shared("SubtitleReel"); + + auto reader = make_shared(); + auto r = Kumu::RESULT_OK; + { + ASDCPErrorSuspender sus; + r = reader->OpenRead (_file->string().c_str ()); } + if (!ASDCP_FAILURE(r)) { + /* MXF-wrapped */ + ASDCP::WriterInfo info; + reader->FillWriterInfo (info); + _id = read_writer_info (info); + if (!_key_id) { + /* Not encrypted; read it in now */ + reader->ReadTimedTextResource (_raw_xml); + xml->read_string (_raw_xml); + parse_xml (xml); + read_mxf_descriptor (reader, make_shared(optional(), Standard::SMPTE)); + } + } else { + /* Plain XML */ + try { + _raw_xml = dcp::file_to_string (file); + xml = make_shared("SubtitleReel"); + xml->read_file (file); + parse_xml (xml); + _id = _xml_id = remove_urn_uuid (xml->string_child ("Id")); + } catch (cxml::Error& e) { + boost::throw_exception ( + ReadError ( + String::compose ( + "Failed to read subtitle file %1; MXF failed with %2, XML failed with %3", + file, static_cast(r), e.what() + ) + ) + ); + } - /* Read the subtitle XML */ + /* Try to read PNG files from the same folder that the XML is in; the wisdom of this is + debatable, at best... + */ + for (auto i: _subtitles) { + auto im = dynamic_pointer_cast(i); + if (im && im->png_image().size() == 0) { + /* Even more dubious; allow .png or urn:uuid:.png */ + auto p = file.parent_path() / String::compose("%1.png", im->id()); + if (boost::filesystem::is_regular_file(p)) { + im->read_png_file (p); + } else if (starts_with (im->id(), "urn:uuid:")) { + p = file.parent_path() / String::compose("%1.png", remove_urn_uuid(im->id())); + if (boost::filesystem::is_regular_file(p)) { + im->read_png_file (p); + } + } + } + } + _standard = Standard::SMPTE; + } - string s; - reader.ReadTimedTextResource (s, 0, 0); - stringstream t; - t << s; - shared_ptr xml (new cxml::Document ("SubtitleReel")); - xml->read_stream (t); + /* Check that all required image data have been found */ + for (auto i: _subtitles) { + auto im = dynamic_pointer_cast(i); + if (im && im->png_image().size() == 0) { + throw MissingSubtitleImageError (im->id()); + } + } +} - ASDCP::WriterInfo info; - reader.FillWriterInfo (info); - _id = read_writer_info (info); +void +SMPTESubtitleAsset::parse_xml (shared_ptr xml) +{ + _xml_id = remove_urn_uuid(xml->string_child("Id")); _load_font_nodes = type_children (xml, "LoadFont"); _content_title_text = xml->string_child ("ContentTitleText"); @@ -89,7 +168,7 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file) _language = xml->optional_string_child ("Language"); /* This is supposed to be two numbers, but a single number has been seen in the wild */ - string const er = xml->string_child ("EditRate"); + auto const er = xml->string_child ("EditRate"); vector er_parts; split (er_parts, er, is_any_of (" ")); if (er_parts.size() == 1) { @@ -102,81 +181,149 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file) _time_code_rate = xml->number_child ("TimeCodeRate"); if (xml->optional_string_child ("StartTime")) { - _start_time = Time (xml->string_child ("StartTime"), _time_code_rate); + _start_time = Time (xml->string_child("StartTime"), _time_code_rate); } - shared_ptr subtitle_list = xml->optional_node_child ("SubtitleList"); + /* Now we need to drop down to xmlpp */ - list f = subtitle_list->node_children ("Font"); - list > font_nodes; - BOOST_FOREACH (cxml::NodePtr& i, f) { - font_nodes.push_back (shared_ptr (new FontNode (i, _time_code_rate))); + vector ps; + for (auto i: xml->node()->get_children()) { + auto const e = dynamic_cast(i); + if (e && e->get_name() == "SubtitleList") { + parse_subtitles (e, ps, _time_code_rate, Standard::SMPTE); + } } - parse_subtitles (xml, font_nodes); + /* Guess intrinsic duration */ + _intrinsic_duration = latest_subtitle_out().as_editable_units_ceil(_edit_rate.numerator / _edit_rate.denominator); +} + - /* Read fonts */ +void +SMPTESubtitleAsset::read_mxf_descriptor (shared_ptr reader, shared_ptr dec) +{ + ASDCP::TimedText::TimedTextDescriptor descriptor; + reader->FillTimedTextDescriptor (descriptor); + + /* Load fonts and images */ - ASDCP::TimedText::TimedTextDescriptor text_descriptor; - reader.FillTimedTextDescriptor (text_descriptor); for ( - ASDCP::TimedText::ResourceList_t::const_iterator i = text_descriptor.ResourceList.begin(); - i != text_descriptor.ResourceList.end(); + auto i = descriptor.ResourceList.begin(); + i != descriptor.ResourceList.end(); ++i) { - if (i->Type == ASDCP::TimedText::MT_OPENTYPE) { - ASDCP::TimedText::FrameBuffer buffer; - buffer.Capacity (10 * 1024 * 1024); - reader.ReadAncillaryResource (i->ResourceID, buffer); - - char id[64]; - Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof (id)); + ASDCP::TimedText::FrameBuffer buffer; + buffer.Capacity (10 * 1024 * 1024); + reader->ReadAncillaryResource (i->ResourceID, buffer, dec->context(), dec->hmac()); - shared_array data (new uint8_t[buffer.Size()]); - memcpy (data.get(), buffer.RoData(), buffer.Size()); + char id[64]; + Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof(id)); - /* The IDs in the MXF have a 9 character prefix of unknown origin and meaning... */ - string check_id = string (id).substr (9); + shared_array data (new uint8_t[buffer.Size()]); + memcpy (data.get(), buffer.RoData(), buffer.Size()); - list >::const_iterator j = _load_font_nodes.begin (); - while (j != _load_font_nodes.end() && (*j)->urn != check_id) { + switch (i->Type) { + case ASDCP::TimedText::MT_OPENTYPE: + { + auto j = _load_font_nodes.begin(); + while (j != _load_font_nodes.end() && (*j)->urn != id) { ++j; } if (j != _load_font_nodes.end ()) { - _fonts[(*j)->id] = FileData (data, buffer.Size ()); + _fonts.push_back (Font ((*j)->id, (*j)->urn, ArrayData (data, buffer.Size ()))); } + break; + } + case ASDCP::TimedText::MT_PNG: + { + auto j = _subtitles.begin(); + while (j != _subtitles.end() && ((!dynamic_pointer_cast(*j)) || dynamic_pointer_cast(*j)->id() != id)) { + ++j; + } + + if (j != _subtitles.end()) { + dynamic_pointer_cast(*j)->set_png_image (ArrayData(data, buffer.Size())); + } + break; + } + default: + break; } } + _intrinsic_duration = descriptor.ContainerDuration; +} + + +void +SMPTESubtitleAsset::set_key (Key key) +{ + /* See if we already have a key; if we do, and we have a file, we'll already + have read that file. + */ + auto const had_key = static_cast(_key); + + MXF::set_key (key); + + if (!_key_id || !_file || had_key) { + /* Either we don't have any data to read, it wasn't + encrypted, or we've already read it, so we don't + need to do anything else. + */ + return; + } + + /* Our data was encrypted; now we can decrypt it */ + + auto reader = make_shared(); + auto r = reader->OpenRead (_file->string().c_str ()); + if (ASDCP_FAILURE (r)) { + boost::throw_exception ( + ReadError ( + String::compose ("Could not read encrypted subtitle MXF (%1)", static_cast (r)) + ) + ); + } + auto dec = make_shared(key, Standard::SMPTE); + reader->ReadTimedTextResource (_raw_xml, dec->context(), dec->hmac()); + auto xml = make_shared("SubtitleReel"); + xml->read_string (_raw_xml); + parse_xml (xml); + read_mxf_descriptor (reader, dec); } -list > + +vector> SMPTESubtitleAsset::load_font_nodes () const { - list > lf; - copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf)); + vector> lf; + copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter(lf)); return lf; } + bool SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file) { ASDCP::TimedText::MXFReader reader; - Kumu::Result_t r = reader.OpenRead (file.string().c_str ()); + Kumu::DefaultLogSink().UnsetFilterFlag(Kumu::LOG_ALLOW_ALL); + auto r = reader.OpenRead (file.string().c_str ()); + Kumu::DefaultLogSink().SetFilterFlag(Kumu::LOG_ALLOW_ALL); return !ASDCP_FAILURE (r); } -Glib::ustring + +string SMPTESubtitleAsset::xml_as_string () const { xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("dcst:SubtitleReel"); - root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/428-7/2010/DCST", "dcst"); + auto root = doc.create_root_node ("dcst:SubtitleReel"); + root->set_namespace_declaration (subtitle_smpte_ns, "dcst"); root->set_namespace_declaration ("http://www.w3.org/2001/XMLSchema", "xs"); - root->add_child("ID", "dcst")->add_child_text (_id); + root->add_child("Id", "dcst")->add_child_text ("urn:uuid:" + _xml_id); root->add_child("ContentTitleText", "dcst")->add_child_text (_content_title_text); if (_annotation_text) { root->add_child("AnnotationText", "dcst")->add_child_text (_annotation_text.get ()); @@ -191,33 +338,40 @@ SMPTESubtitleAsset::xml_as_string () const root->add_child("EditRate", "dcst")->add_child_text (_edit_rate.as_string ()); root->add_child("TimeCodeRate", "dcst")->add_child_text (raw_convert (_time_code_rate)); if (_start_time) { - root->add_child("StartTime", "dcst")->add_child_text (_start_time.get().as_string ()); + root->add_child("StartTime", "dcst")->add_child_text(_start_time.get().as_string(Standard::SMPTE)); } - BOOST_FOREACH (shared_ptr i, _load_font_nodes) { - xmlpp::Element* load_font = root->add_child("LoadFont", "dcst"); - load_font->add_child_text (i->urn); + for (auto i: _load_font_nodes) { + auto load_font = root->add_child("LoadFont", "dcst"); + load_font->add_child_text ("urn:uuid:" + i->urn); load_font->set_attribute ("ID", i->id); } - subtitles_as_xml (root->add_child ("SubtitleList", "dcst"), _time_code_rate, "dcst"); + subtitles_as_xml (root->add_child("SubtitleList", "dcst"), _time_code_rate, Standard::SMPTE); - return doc.write_to_string_formatted ("UTF-8"); + return doc.write_to_string ("UTF-8"); } -/** Write this content to a MXF file */ + void SMPTESubtitleAsset::write (boost::filesystem::path p) const { + EncryptionContext enc (key(), Standard::SMPTE); + ASDCP::WriterInfo writer_info; - fill_writer_info (&writer_info, _id, SMPTE); + fill_writer_info (&writer_info, _id); ASDCP::TimedText::TimedTextDescriptor descriptor; descriptor.EditRate = ASDCP::Rational (_edit_rate.numerator, _edit_rate.denominator); descriptor.EncodingName = "UTF-8"; - BOOST_FOREACH (shared_ptr i, _load_font_nodes) { - map::const_iterator j = _fonts.find (i->id); + /* Font references */ + + for (auto i: _load_font_nodes) { + auto j = _fonts.begin(); + while (j != _fonts.end() && j->load_id != i->id) { + ++j; + } if (j != _fonts.end ()) { ASDCP::TimedText::TimedTextResourceDescriptor res; unsigned int c; @@ -228,35 +382,74 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const } } - descriptor.NamespaceName = "dcst"; - memcpy (descriptor.AssetID, writer_info.AssetUUID, ASDCP::UUIDlen); - descriptor.ContainerDuration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator); + /* Image subtitle references */ + + for (auto i: _subtitles) { + auto si = dynamic_pointer_cast(i); + if (si) { + ASDCP::TimedText::TimedTextResourceDescriptor res; + unsigned int c; + Kumu::hex2bin (si->id().c_str(), res.ResourceID, Kumu::UUID_Length, &c); + DCP_ASSERT (c == Kumu::UUID_Length); + res.Type = ASDCP::TimedText::MT_PNG; + descriptor.ResourceList.push_back (res); + } + } + + descriptor.NamespaceName = subtitle_smpte_ns; + unsigned int c; + Kumu::hex2bin (_xml_id.c_str(), descriptor.AssetID, ASDCP::UUIDlen, &c); + DCP_ASSERT (c == Kumu::UUID_Length); + descriptor.ContainerDuration = _intrinsic_duration; ASDCP::TimedText::MXFWriter writer; - ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor); + /* This header size is a guess. Empirically it seems that each subtitle reference is 90 bytes, and we need some extra. + The default size is not enough for some feature-length PNG sub projects (see DCP-o-matic #1561). + */ + ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor, _subtitles.size() * 90 + 16384); if (ASDCP_FAILURE (r)) { boost::throw_exception (FileError ("could not open subtitle MXF for writing", p.string(), r)); } - /* XXX: no encryption */ - r = writer.WriteTimedTextResource (xml_as_string ()); + r = writer.WriteTimedTextResource (xml_as_string (), enc.context(), enc.hmac()); if (ASDCP_FAILURE (r)) { boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r)); } - BOOST_FOREACH (shared_ptr i, _load_font_nodes) { - map::const_iterator j = _fonts.find (i->id); + /* Font payload */ + + for (auto i: _load_font_nodes) { + auto j = _fonts.begin(); + while (j != _fonts.end() && j->load_id != i->id) { + ++j; + } if (j != _fonts.end ()) { ASDCP::TimedText::FrameBuffer buffer; - buffer.SetData (j->second.data.get(), j->second.size); - buffer.Size (j->second.size); - r = writer.WriteAncillaryResource (buffer); - if (ASDCP_FAILURE (r)) { + ArrayData data_copy(j->data); + buffer.SetData (data_copy.data(), data_copy.size()); + buffer.Size (j->data.size()); + r = writer.WriteAncillaryResource (buffer, enc.context(), enc.hmac()); + if (ASDCP_FAILURE(r)) { boost::throw_exception (MXFFileError ("could not write font to timed text resource", p.string(), r)); } } } + /* Image subtitle payload */ + + for (auto i: _subtitles) { + auto si = dynamic_pointer_cast(i); + if (si) { + ASDCP::TimedText::FrameBuffer buffer; + buffer.SetData (si->png_image().data(), si->png_image().size()); + buffer.Size (si->png_image().size()); + r = writer.WriteAncillaryResource (buffer, enc.context(), enc.hmac()); + if (ASDCP_FAILURE(r)) { + boost::throw_exception (MXFFileError ("could not write PNG data to timed text resource", p.string(), r)); + } + } + } + writer.Finalize (); _file = p; @@ -269,23 +462,23 @@ SMPTESubtitleAsset::equals (shared_ptr other_asset, EqualityOptions return false; } - shared_ptr other = dynamic_pointer_cast (other_asset); + auto other = dynamic_pointer_cast(other_asset); if (!other) { - note (DCP_ERROR, "Subtitles are in different standards"); + note (NoteType::ERROR, "Subtitles are in different standards"); return false; } - list >::const_iterator i = _load_font_nodes.begin (); - list >::const_iterator j = other->_load_font_nodes.begin (); + auto i = _load_font_nodes.begin(); + auto j = other->_load_font_nodes.begin(); while (i != _load_font_nodes.end ()) { if (j == other->_load_font_nodes.end ()) { - note (DCP_ERROR, " nodes differ"); + note (NoteType::ERROR, " nodes differ"); return false; } if ((*i)->id != (*j)->id) { - note (DCP_ERROR, " nodes differ"); + note (NoteType::ERROR, " nodes differ"); return false; } @@ -294,55 +487,65 @@ SMPTESubtitleAsset::equals (shared_ptr other_asset, EqualityOptions } if (_content_title_text != other->_content_title_text) { - note (DCP_ERROR, "Subtitle content title texts differ"); + note (NoteType::ERROR, "Subtitle content title texts differ"); return false; } if (_language != other->_language) { - note (DCP_ERROR, "Subtitle languages differ"); + note (NoteType::ERROR, String::compose("Subtitle languages differ (`%1' vs `%2')", _language.get_value_or("[none]"), other->_language.get_value_or("[none]"))); return false; } if (_annotation_text != other->_annotation_text) { - note (DCP_ERROR, "Subtitle annotation texts differ"); + note (NoteType::ERROR, "Subtitle annotation texts differ"); return false; } if (_issue_date != other->_issue_date) { if (options.issue_dates_can_differ) { - note (DCP_NOTE, "Subtitle issue dates differ"); + note (NoteType::NOTE, "Subtitle issue dates differ"); } else { - note (DCP_ERROR, "Subtitle issue dates differ"); + note (NoteType::ERROR, "Subtitle issue dates differ"); return false; } } if (_reel_number != other->_reel_number) { - note (DCP_ERROR, "Subtitle reel numbers differ"); + note (NoteType::ERROR, "Subtitle reel numbers differ"); return false; } if (_edit_rate != other->_edit_rate) { - note (DCP_ERROR, "Subtitle edit rates differ"); + note (NoteType::ERROR, "Subtitle edit rates differ"); return false; } if (_time_code_rate != other->_time_code_rate) { - note (DCP_ERROR, "Subtitle time code rates differ"); + note (NoteType::ERROR, "Subtitle time code rates differ"); return false; } if (_start_time != other->_start_time) { - note (DCP_ERROR, "Subtitle start times differ"); + note (NoteType::ERROR, "Subtitle start times differ"); return false; } return true; } + +void +SMPTESubtitleAsset::add_font (string load_id, dcp::ArrayData data) +{ + string const uuid = make_uuid (); + _fonts.push_back (Font(load_id, uuid, data)); + _load_font_nodes.push_back (make_shared(load_id, uuid)); +} + + void -SMPTESubtitleAsset::add_font (string id, boost::filesystem::path file) +SMPTESubtitleAsset::add (shared_ptr s) { - add_font_data (id, file); - _load_font_nodes.push_back (shared_ptr (new SMPTELoadFontNode (id, make_uuid ()))); + SubtitleAsset::add (s); + _intrinsic_duration = latest_subtitle_out().as_editable_units_ceil(_edit_rate.numerator / _edit_rate.denominator); }