Adapt for changes in parent branch, and test churn.
[libdcp.git] / src / smpte_subtitle_asset.cc
index 91afec143840dfd617aef7aa522a67e72ec54aa8..cf0ed6c0c38616f8f0ad16c733f6358b795d3dad 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -47,6 +47,7 @@
 #include "subtitle_image.h"
 #include <asdcp/AS_DCP.h>
 #include <asdcp/KM_util.h>
+#include <asdcp/KM_log.h>
 #include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
@@ -61,8 +62,11 @@ 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 ()
        : MXF (SMPTE)
        , _intrinsic_duration (0)
@@ -82,7 +86,11 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
        shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
 
        shared_ptr<ASDCP::TimedText::MXFReader> reader (new ASDCP::TimedText::MXFReader ());
-       Kumu::Result_t r = reader->OpenRead (_file->string().c_str ());
+       Kumu::Result_t r = Kumu::RESULT_OK;
+       {
+               ASDCPErrorSuspender sus;
+               r = reader->OpenRead (_file->string().c_str ());
+       }
        if (!ASDCP_FAILURE (r)) {
                /* MXF-wrapped */
                ASDCP::WriterInfo info;
@@ -90,22 +98,22 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
                _id = read_writer_info (info);
                if (!_key_id) {
                        /* Not encrypted; read it in now */
-                       string s;
-                       reader->ReadTimedTextResource (s);
-                       xml->read_string (s);
+                       reader->ReadTimedTextResource (_raw_xml);
+                       xml->read_string (_raw_xml);
                        parse_xml (xml);
                        read_mxf_descriptor (reader, shared_ptr<DecryptionContext> (new DecryptionContext (optional<Key>(), SMPTE)));
                }
        } else {
                /* Plain XML */
                try {
+                       _raw_xml = dcp::file_to_string (file);
                        xml.reset (new cxml::Document ("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 (
-                               DCPReadError (
+                               ReadError (
                                        String::compose (
                                                "Failed to read subtitle file %1; MXF failed with %2, XML failed with %3",
                                                file, static_cast<int> (r), e.what ()
@@ -113,6 +121,33 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
                                        )
                                );
                }
+
+               /* Try to read PNG files from the same folder that the XML is in; the wisdom of this is
+                  debatable, at best...
+               */
+               BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+                       shared_ptr<SubtitleImage> im = dynamic_pointer_cast<SubtitleImage>(i);
+                       if (im && im->png_image().size() == 0) {
+                               /* Even more dubious; allow <id>.png or urn:uuid:<id>.png */
+                               boost::filesystem::path 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);
+                                       }
+                               }
+                       }
+               }
+       }
+
+       /* Check that all required image data have been found */
+       BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+               shared_ptr<SubtitleImage> im = dynamic_pointer_cast<SubtitleImage>(i);
+               if (im && im->png_image().size() == 0) {
+                       throw MissingSubtitleImageError (im->id());
+               }
        }
 }
 
@@ -166,24 +201,26 @@ SMPTESubtitleAsset::read_mxf_descriptor (shared_ptr<ASDCP::TimedText::MXFReader>
        ASDCP::TimedText::TimedTextDescriptor descriptor;
        reader->FillTimedTextDescriptor (descriptor);
 
-       /* Load fonts */
+       /* Load fonts and images */
 
        for (
                ASDCP::TimedText::ResourceList_t::const_iterator 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, dec->context(), dec->hmac());
+               ASDCP::TimedText::FrameBuffer buffer;
+               buffer.Capacity (10 * 1024 * 1024);
+               reader->ReadAncillaryResource (i->ResourceID, buffer, dec->context(), dec->hmac());
 
-                       char id[64];
-                       Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof (id));
+               char id[64];
+               Kumu::bin2UUIDhex (i->ResourceID, ASDCP::UUIDlen, id, sizeof (id));
 
-                       shared_array<uint8_t> data (new uint8_t[buffer.Size()]);
-                       memcpy (data.get(), buffer.RoData(), buffer.Size());
+               shared_array<uint8_t> data (new uint8_t[buffer.Size()]);
+               memcpy (data.get(), buffer.RoData(), buffer.Size());
 
+               switch (i->Type) {
+               case ASDCP::TimedText::MT_OPENTYPE:
+               {
                        list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = _load_font_nodes.begin ();
                        while (j != _load_font_nodes.end() && (*j)->urn != id) {
                                ++j;
@@ -192,10 +229,24 @@ SMPTESubtitleAsset::read_mxf_descriptor (shared_ptr<ASDCP::TimedText::MXFReader>
                        if (j != _load_font_nodes.end ()) {
                                _fonts.push_back (Font ((*j)->id, (*j)->urn, Data (data, buffer.Size ())));
                        }
+                       break;
                }
-       }
+               case ASDCP::TimedText::MT_PNG:
+               {
+                       list<shared_ptr<Subtitle> >::const_iterator j = _subtitles.begin ();
+                       while (j != _subtitles.end() && ((!dynamic_pointer_cast<SubtitleImage>(*j)) || dynamic_pointer_cast<SubtitleImage>(*j)->id() != id)) {
+                               ++j;
+                       }
 
-       /* XXX: load PNG and attach them to _subtitles */
+                       if (j != _subtitles.end()) {
+                               dynamic_pointer_cast<SubtitleImage>(*j)->set_png_image (Data(data, buffer.Size()));
+                       }
+                       break;
+               }
+               default:
+                       break;
+               }
+       }
 
        /* Get intrinsic duration */
        _intrinsic_duration = descriptor.ContainerDuration;
@@ -225,17 +276,16 @@ SMPTESubtitleAsset::set_key (Key key)
        Kumu::Result_t r = reader->OpenRead (_file->string().c_str ());
        if (ASDCP_FAILURE (r)) {
                boost::throw_exception (
-                       DCPReadError (
+                       ReadError (
                                String::compose ("Could not read encrypted subtitle MXF (%1)", static_cast<int> (r))
                                )
                        );
        }
 
-       string s;
        shared_ptr<DecryptionContext> dec (new DecryptionContext (key, SMPTE));
-       reader->ReadTimedTextResource (s, dec->context(), dec->hmac());
+       reader->ReadTimedTextResource (_raw_xml, dec->context(), dec->hmac());
        shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
-       xml->read_string (s);
+       xml->read_string (_raw_xml);
        parse_xml (xml);
        read_mxf_descriptor (reader, dec);
 }
@@ -252,7 +302,9 @@ bool
 SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
 {
        ASDCP::TimedText::MXFReader reader;
+       Kumu::DefaultLogSink().UnsetFilterFlag(Kumu::LOG_ALLOW_ALL);
        Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
+       Kumu::DefaultLogSink().SetFilterFlag(Kumu::LOG_ALLOW_ALL);
        return !ASDCP_FAILURE (r);
 }
 
@@ -261,7 +313,7 @@ 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");
+       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 ("urn:uuid:" + _xml_id);
@@ -337,12 +389,17 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
                }
        }
 
-       descriptor.NamespaceName = "dcst";
-       memcpy (descriptor.AssetID, writer_info.AssetUUID, ASDCP::UUIDlen);
+       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));
        }