Take DCP-o-matic's version of Data class.
[libdcp.git] / src / smpte_subtitle_asset.cc
index 69e2712f1c9e3fcee08f660b491696725f6e11cb..00a9299aacf7957cff023375267dac1ba83a84da 100644 (file)
 #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 "raw_convert.h"
+#include "compose.hpp"
 #include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
@@ -38,47 +41,56 @@ using std::list;
 using std::stringstream;
 using std::cout;
 using std::vector;
+using std::map;
 using boost::shared_ptr;
 using boost::split;
 using boost::is_any_of;
+using boost::shared_array;
+using boost::dynamic_pointer_cast;
 using namespace dcp;
 
 SMPTESubtitleAsset::SMPTESubtitleAsset ()
-       : _time_code_rate (0)
+       : _intrinsic_duration (0)
+       , _edit_rate (24, 1)
+       , _time_code_rate (24)
 {
-       
+
 }
 
-/** Construct a SMPTESubtitleAsset by reading an XML or MXF file.
+/** Construct a SMPTESubtitleAsset by reading an MXF or XML file.
  *  @param file Filename.
- *  @param mxf true if file is an MXF, false if it is XML.
  */
-SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file, bool mxf)
+SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
        : SubtitleAsset (file)
 {
        shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
-       
-       if (mxf) {
-               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));
-               }
-       
+
+       shared_ptr<ASDCP::TimedText::MXFReader> reader (new ASDCP::TimedText::MXFReader ());
+       Kumu::Result_t r = reader->OpenRead (file.string().c_str ());
+
+       if (!ASDCP_FAILURE (r)) {
                string s;
-               reader.ReadTimedTextResource (s, 0, 0);
+               reader->ReadTimedTextResource (s, 0, 0);
                stringstream t;
                t << s;
                xml->read_stream (t);
-
                ASDCP::WriterInfo info;
-               reader.FillWriterInfo (info);
+               reader->FillWriterInfo (info);
                _id = read_writer_info (info);
        } else {
-               xml->read_file (file);
-               _id = xml->string_child("Id").substr (9);
+               reader.reset ();
+               try {
+                       xml->read_file (file);
+                       _id = xml->string_child ("Id").substr (9);
+               } catch (cxml::Error& e) {
+                       boost::throw_exception (
+                               DCPReadError (
+                                       String::compose ("could not read subtitles from %1; MXF failed with %2, XML failed with %3", file, static_cast<int> (r), e.what ())
+                                       )
+                               );
+               }
        }
-       
+
        _load_font_nodes = type_children<dcp::SMPTELoadFontNode> (xml, "LoadFont");
 
        _content_title_text = xml->string_child ("ContentTitleText");
@@ -106,13 +118,57 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file, bool mxf)
 
        shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
 
-       list<cxml::NodePtr> f = subtitle_list->node_children ("Font");
        list<shared_ptr<dcp::FontNode> > font_nodes;
-       BOOST_FOREACH (cxml::NodePtr& i, f) {
-               font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, _time_code_rate)));
+       BOOST_FOREACH (cxml::NodePtr const & i, subtitle_list->node_children ("Font")) {
+               font_nodes.push_back (shared_ptr<FontNode> (new FontNode (i, _time_code_rate, "ID")));
+       }
+
+       list<shared_ptr<dcp::SubtitleNode> > subtitle_nodes;
+       BOOST_FOREACH (cxml::NodePtr const & i, subtitle_list->node_children ("Subtitle")) {
+               subtitle_nodes.push_back (shared_ptr<SubtitleNode> (new SubtitleNode (i, _time_code_rate, "ID")));
+       }
+
+       parse_subtitles (xml, font_nodes, subtitle_nodes);
+
+       if (reader) {
+               ASDCP::TimedText::TimedTextDescriptor descriptor;
+               reader->FillTimedTextDescriptor (descriptor);
+
+               /* Load fonts */
+
+               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);
+
+                               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());
+
+                               list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = _load_font_nodes.begin ();
+                               while (j != _load_font_nodes.end() && (*j)->urn != id) {
+                                       ++j;
+                               }
+
+                               if (j != _load_font_nodes.end ()) {
+                                       _fonts.push_back (Font ((*j)->id, (*j)->urn, Data (data, buffer.Size ())));
+                               }
+                       }
+               }
+
+               /* Get intrinsic duration */
+               _intrinsic_duration = descriptor.ContainerDuration;
+       } else {
+               /* Guess intrinsic duration */
+               _intrinsic_duration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
        }
-       
-       parse_subtitles (xml, font_nodes);
 }
 
 list<shared_ptr<LoadFontNode> >
@@ -131,7 +187,7 @@ SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
        return !ASDCP_FAILURE (r);
 }
 
-Glib::ustring
+string
 SMPTESubtitleAsset::xml_as_string () const
 {
        xmlpp::Document doc;
@@ -139,7 +195,7 @@ SMPTESubtitleAsset::xml_as_string () const
        root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/428-7/2010/DCST", "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:" + _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 ());
@@ -154,17 +210,17 @@ 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<string> (_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 (SMPTE));
        }
 
        BOOST_FOREACH (shared_ptr<SMPTELoadFontNode> i, _load_font_nodes) {
                xmlpp::Element* load_font = root->add_child("LoadFont", "dcst");
-               load_font->add_child_text (i->urn);
+               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, SMPTE);
+
        return doc.write_to_string_formatted ("UTF-8");
 }
 
@@ -174,17 +230,30 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
 {
        ASDCP::WriterInfo writer_info;
        fill_writer_info (&writer_info, _id, SMPTE);
-       
+
        ASDCP::TimedText::TimedTextDescriptor descriptor;
        descriptor.EditRate = ASDCP::Rational (_edit_rate.numerator, _edit_rate.denominator);
        descriptor.EncodingName = "UTF-8";
-       descriptor.ResourceList.clear ();
+
+       BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
+               list<Font>::const_iterator j = _fonts.begin ();
+               while (j != _fonts.end() && j->load_id != i->id) {
+                       ++j;
+               }
+               if (j != _fonts.end ()) {
+                       ASDCP::TimedText::TimedTextResourceDescriptor res;
+                       unsigned int c;
+                       Kumu::hex2bin (i->urn.c_str(), res.ResourceID, Kumu::UUID_Length, &c);
+                       DCP_ASSERT (c == Kumu::UUID_Length);
+                       res.Type = ASDCP::TimedText::MT_OPENTYPE;
+                       descriptor.ResourceList.push_back (res);
+               }
+       }
+
        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);
+       descriptor.ContainerDuration = _intrinsic_duration;
 
-       /* XXX: should write fonts into the file somehow */
-       
        ASDCP::TimedText::MXFWriter writer;
        ASDCP::Result_t r = writer.OpenWrite (p.string().c_str(), writer_info, descriptor);
        if (ASDCP_FAILURE (r)) {
@@ -197,6 +266,22 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
                boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r));
        }
 
+       BOOST_FOREACH (shared_ptr<dcp::SMPTELoadFontNode> i, _load_font_nodes) {
+               list<Font>::const_iterator j = _fonts.begin ();
+               while (j != _fonts.end() && j->load_id != i->id) {
+                       ++j;
+               }
+               if (j != _fonts.end ()) {
+                       ASDCP::TimedText::FrameBuffer buffer;
+                       buffer.SetData (j->data.data().get(), j->data.size());
+                       buffer.Size (j->data.size());
+                       r = writer.WriteAncillaryResource (buffer);
+                       if (ASDCP_FAILURE (r)) {
+                               boost::throw_exception (MXFFileError ("could not write font to timed text resource", p.string(), r));
+                       }
+               }
+       }
+
        writer.Finalize ();
 
        _file = p;
@@ -205,7 +290,92 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
 bool
 SMPTESubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 {
-       /* XXX */
-       return false;
+       if (!SubtitleAsset::equals (other_asset, options, note)) {
+               return false;
+       }
+
+       shared_ptr<const SMPTESubtitleAsset> other = dynamic_pointer_cast<const SMPTESubtitleAsset> (other_asset);
+       if (!other) {
+               note (DCP_ERROR, "Subtitles are in different standards");
+               return false;
+       }
+
+       list<shared_ptr<SMPTELoadFontNode> >::const_iterator i = _load_font_nodes.begin ();
+       list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = other->_load_font_nodes.begin ();
+
+       while (i != _load_font_nodes.end ()) {
+               if (j == other->_load_font_nodes.end ()) {
+                       note (DCP_ERROR, "<LoadFont> nodes differ");
+                       return false;
+               }
+
+               if ((*i)->id != (*j)->id) {
+                       note (DCP_ERROR, "<LoadFont> nodes differ");
+                       return false;
+               }
+
+               ++i;
+               ++j;
+       }
+
+       if (_content_title_text != other->_content_title_text) {
+               note (DCP_ERROR, "Subtitle content title texts differ");
+               return false;
+       }
+
+       if (_language != other->_language) {
+               note (DCP_ERROR, "Subtitle languages differ");
+               return false;
+       }
+
+       if (_annotation_text != other->_annotation_text) {
+               note (DCP_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");
+               } else {
+                       note (DCP_ERROR, "Subtitle issue dates differ");
+                       return false;
+               }
+       }
+
+       if (_reel_number != other->_reel_number) {
+               note (DCP_ERROR, "Subtitle reel numbers differ");
+               return false;
+       }
+
+       if (_edit_rate != other->_edit_rate) {
+               note (DCP_ERROR, "Subtitle edit rates differ");
+               return false;
+       }
+
+       if (_time_code_rate != other->_time_code_rate) {
+               note (DCP_ERROR, "Subtitle time code rates differ");
+               return false;
+       }
+
+       if (_start_time != other->_start_time) {
+               note (DCP_ERROR, "Subtitle start times differ");
+               return false;
+       }
+
+       return true;
+}
+
+void
+SMPTESubtitleAsset::add_font (string load_id, boost::filesystem::path file)
+{
+       string const uuid = make_uuid ();
+       _fonts.push_back (Font (load_id, uuid, file));
+       _load_font_nodes.push_back (shared_ptr<SMPTELoadFontNode> (new SMPTELoadFontNode (load_id, uuid)));
 }
 
+void
+SMPTESubtitleAsset::add (dcp::SubtitleString s)
+{
+       SubtitleAsset::add (s);
+       _intrinsic_duration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
+}