Fix repeated subtitles when reading SMPTE encrypted DCPs.
[libdcp.git] / src / smpte_subtitle_asset.cc
index 43fa3026dc5f0a07f412a885a07b3ec359e28c65..e52cd2effa684f20ca08a620d691d2ddeea117b2 100644 (file)
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
+
+    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
 
 #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 "encryption_context.h"
+#include "decryption_context.h"
+#include <asdcp/AS_DCP.h>
+#include <asdcp/KM_util.h>
 #include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
 
 using std::string;
 using std::list;
-using std::stringstream;
-using std::cout;
 using std::vector;
 using std::map;
 using boost::shared_ptr;
@@ -66,31 +79,43 @@ 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 = reader->OpenRead (_file->string().c_str ());
        if (!ASDCP_FAILURE (r)) {
-               string s;
-               reader->ReadTimedTextResource (s, 0, 0);
-               stringstream t;
-               t << s;
-               xml->read_stream (t);
+               /* MXF-wrapped */
                ASDCP::WriterInfo info;
                reader->FillWriterInfo (info);
                _id = read_writer_info (info);
+               if (!_key_id) {
+                       /* Not encrypted; read it in now */
+                       string s;
+                       reader->ReadTimedTextResource (s);
+                       xml->read_string (s);
+                       parse_xml (xml);
+                       read_mxf_descriptor (reader, shared_ptr<DecryptionContext> (new DecryptionContext ()));
+               }
        } else {
-               reader.reset ();
+               /* Plain XML */
                try {
+                       xml.reset (new cxml::Document ("SubtitleReel"));
                        xml->read_file (file);
-                       _id = xml->string_child ("Id").substr (9);
+                       parse_xml (xml);
+                       _id = remove_urn_uuid (xml->string_child ("Id"));
                } 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 ())
+                                       String::compose (
+                                               "Failed to read subtitle file %1; MXF failed with %2, XML failed with %3",
+                                               file, static_cast<int> (r), e.what ()
+                                               )
                                        )
                                );
                }
        }
+}
 
+void
+SMPTESubtitleAsset::parse_xml (shared_ptr<cxml::Document> xml)
+{
        _load_font_nodes = type_children<dcp::SMPTELoadFontNode> (xml, "LoadFont");
 
        _content_title_text = xml->string_child ("ContentTitleText");
@@ -116,55 +141,97 @@ SMPTESubtitleAsset::SMPTESubtitleAsset (boost::filesystem::path file)
                _start_time = Time (xml->string_child ("StartTime"), _time_code_rate);
        }
 
-       shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
+       /* Now we need to drop down to xmlpp */
 
-       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)));
+       list<ParseState> ps;
+       xmlpp::Node::NodeList c = xml->node()->get_children ();
+       for (xmlpp::Node::NodeList::const_iterator i = c.begin(); i != c.end(); ++i) {
+               xmlpp::Element const * e = dynamic_cast<xmlpp::Element const *> (*i);
+               if (e && e->get_name() == "SubtitleList") {
+                       parse_subtitles (e, ps, _time_code_rate, SMPTE);
+               }
        }
 
-       parse_subtitles (xml, font_nodes);
+       /* Guess intrinsic duration */
+       _intrinsic_duration = latest_subtitle_out().as_editable_units (_edit_rate.numerator / _edit_rate.denominator);
+}
 
-       if (reader) {
-               ASDCP::TimedText::TimedTextDescriptor descriptor;
-               reader->FillTimedTextDescriptor (descriptor);
+void
+SMPTESubtitleAsset::read_mxf_descriptor (shared_ptr<ASDCP::TimedText::MXFReader> reader, shared_ptr<DecryptionContext> dec)
+{
+       ASDCP::TimedText::TimedTextDescriptor descriptor;
+       reader->FillTimedTextDescriptor (descriptor);
 
-               /* Load fonts */
+       /* Load fonts */
 
-               for (
-                       ASDCP::TimedText::ResourceList_t::const_iterator i = descriptor.ResourceList.begin();
-                       i != descriptor.ResourceList.end();
-                       ++i) {
+       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);
+               if (i->Type == ASDCP::TimedText::MT_OPENTYPE) {
+                       ASDCP::TimedText::FrameBuffer buffer;
+                       buffer.Capacity (10 * 1024 * 1024);
+                       reader->ReadAncillaryResource (i->ResourceID, buffer, dec->decryption());
 
-                               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());
 
-                               list<shared_ptr<SMPTELoadFontNode> >::const_iterator j = _load_font_nodes.begin ();
-                               while (j != _load_font_nodes.end() && (*j)->urn != id) {
-                                       ++j;
-                               }
+                       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 ())));
-                               }
+                       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);
+       /* Get intrinsic duration */
+       _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.
+       */
+       bool const had_key = static_cast<bool> (_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 */
+
+       shared_ptr<ASDCP::TimedText::MXFReader> reader (new ASDCP::TimedText::MXFReader ());
+       Kumu::Result_t r = reader->OpenRead (_file->string().c_str ());
+       if (ASDCP_FAILURE (r)) {
+               boost::throw_exception (
+                       DCPReadError (
+                               String::compose ("Could not read encrypted subtitle MXF (%1)", static_cast<int> (r))
+                               )
+                       );
        }
+
+       string s;
+       shared_ptr<DecryptionContext> dec (new DecryptionContext (key));
+       reader->ReadTimedTextResource (s, dec->decryption());
+       shared_ptr<cxml::Document> xml (new cxml::Document ("SubtitleReel"));
+       xml->read_string (s);
+       parse_xml (xml);
+       read_mxf_descriptor (reader, dec);
 }
 
 list<shared_ptr<LoadFontNode> >
@@ -183,7 +250,7 @@ SMPTESubtitleAsset::valid_mxf (boost::filesystem::path file)
        return !ASDCP_FAILURE (r);
 }
 
-Glib::ustring
+string
 SMPTESubtitleAsset::xml_as_string () const
 {
        xmlpp::Document doc;
@@ -217,13 +284,15 @@ SMPTESubtitleAsset::xml_as_string () const
 
        subtitles_as_xml (root->add_child ("SubtitleList", "dcst"), _time_code_rate, 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 (), SMPTE);
+
        ASDCP::WriterInfo writer_info;
        fill_writer_info (&writer_info, _id, SMPTE);
 
@@ -257,7 +326,7 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
        }
 
        /* XXX: no encryption */
-       r = writer.WriteTimedTextResource (xml_as_string ());
+       r = writer.WriteTimedTextResource (xml_as_string (), enc.encryption(), enc.hmac());
        if (ASDCP_FAILURE (r)) {
                boost::throw_exception (MXFFileError ("could not write XML to timed text resource", p.string(), r));
        }
@@ -269,9 +338,9 @@ SMPTESubtitleAsset::write (boost::filesystem::path p) const
                }
                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);
+                       buffer.SetData (j->data.data().get(), j->data.size());
+                       buffer.Size (j->data.size());
+                       r = writer.WriteAncillaryResource (buffer, enc.encryption(), enc.hmac());
                        if (ASDCP_FAILURE (r)) {
                                boost::throw_exception (MXFFileError ("could not write font to timed text resource", p.string(), r));
                        }