Basic writing of DCPs containing Atmos MXFs; untested.
[libdcp.git] / src / cpl.cc
index b5b4d7152601de2ed84591507abfdc81e4323903..1b7801a0753d197052066061b8ed17413b36f4f1 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 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
     it under the terms of the GNU General Public License as published by
 #include "util.h"
 #include "reel.h"
 #include "metadata.h"
-#include "signer.h"
+#include "certificate_chain.h"
 #include "xml.h"
 #include "reel_picture_asset.h"
 #include "reel_sound_asset.h"
 #include "reel_subtitle_asset.h"
+#include "reel_atmos_asset.h"
 #include "local_time.h"
 #include "dcp_assert.h"
 #include "compose.hpp"
 #include <libxml/parser.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
 
 using std::string;
 using std::stringstream;
@@ -43,6 +46,9 @@ using boost::optional;
 using boost::dynamic_pointer_cast;
 using namespace dcp;
 
+static string const cpl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#";
+static string const cpl_smpte_ns   = "http://www.smpte-ra.org/schemas/429-7/2006/CPL";
+
 CPL::CPL (string annotation_text, ContentKind content_kind)
        : _annotation_text (annotation_text)
        /* default _content_title_text to _annotation_text */
@@ -50,11 +56,11 @@ CPL::CPL (string annotation_text, ContentKind content_kind)
        , _content_kind (content_kind)
        , _content_version_id ("urn:uuid:" + make_uuid ())
 {
-       /* default _content_version_id to and _content_version_label to
+       /* default _content_version_id to a random ID and _content_version_label to
           a random ID and the current time.
        */
-       _content_version_id = "urn:uuid:" + make_uuid() + LocalTime().as_string ();
-       _content_version_label_text = _content_version_id;
+       _content_version_id = "urn:uuid:" + make_uuid();
+       _content_version_label_text = _content_version_id + LocalTime().as_string ();
 }
 
 /** Construct a CPL object from a XML file */
@@ -65,10 +71,15 @@ CPL::CPL (boost::filesystem::path file)
        cxml::Document f ("CompositionPlaylist");
        f.read_file (file);
 
-       _id = f.string_child ("Id");
-       if (_id.length() > 9) {
-               _id = _id.substr (9);
+       if (f.namespace_uri() == cpl_interop_ns) {
+               _standard = INTEROP;
+       } else if (f.namespace_uri() == cpl_smpte_ns) {
+               _standard = SMPTE;
+       } else {
+               boost::throw_exception (XMLError ("Unrecognised CPL namespace " + f.namespace_uri()));
        }
+
+       _id = remove_urn_uuid (f.string_child ("Id"));
        _annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
        _metadata.issuer = f.optional_string_child ("Issuer").get_value_or ("");
        _metadata.creator = f.optional_string_child ("Creator").get_value_or ("");
@@ -106,20 +117,20 @@ CPL::add (boost::shared_ptr<Reel> reel)
  *  @param signer Signer to sign the CPL, or 0 to add no signature.
  */
 void
-CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const Signer> signer) const
+CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const CertificateChain> signer) const
 {
        xmlpp::Document doc;
        xmlpp::Element* root;
        if (standard == INTEROP) {
-               root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
+               root = doc.create_root_node ("CompositionPlaylist", cpl_interop_ns);
        } else {
-               root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
+               root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns);
        }
 
        if (signer) {
                root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
        }
-       
+
        root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
        root->add_child("AnnotationText")->add_child_text (_annotation_text);
        root->add_child("IssueDate")->add_child_text (_metadata.issue_date);
@@ -135,9 +146,9 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<cons
        root->add_child("RatingList");
 
        xmlpp::Element* reel_list = root->add_child ("ReelList");
-       
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->write_to_cpl (reel_list, standard);
+
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               i->write_to_cpl (reel_list, standard);
        }
 
        if (signer) {
@@ -155,29 +166,32 @@ CPL::reel_assets () const
 {
        list<shared_ptr<const ReelAsset> > c;
 
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               if ((*i)->main_picture ()) {
-                       c.push_back ((*i)->main_picture());
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               if (i->main_picture ()) {
+                       c.push_back (i->main_picture());
+               }
+               if (i->main_sound ()) {
+                       c.push_back (i->main_sound());
                }
-               if ((*i)->main_sound ()) {
-                       c.push_back ((*i)->main_sound());
+               if (i->main_subtitle ()) {
+                       c.push_back (i->main_subtitle());
                }
-               if ((*i)->main_subtitle ()) {
-                       c.push_back ((*i)->main_subtitle());
+               if (i->atmos ()) {
+                       c.push_back (i->atmos());
                }
        }
 
        return c;
 }
-       
+
 bool
-CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
        shared_ptr<const CPL> other_cpl = dynamic_pointer_cast<const CPL> (other);
        if (!other_cpl) {
                return false;
        }
-       
+
        if (_annotation_text != other_cpl->_annotation_text && !opt.cpl_annotation_texts_can_differ) {
                stringstream s;
                s << "CPL: annotation texts differ: " << _annotation_text << " vs " << other_cpl->_annotation_text << "\n";
@@ -194,10 +208,10 @@ CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function
                note (DCP_ERROR, String::compose ("CPL: reel counts differ (%1 vs %2)", _reels.size(), other_cpl->_reels.size()));
                return false;
        }
-       
+
        list<shared_ptr<Reel> >::const_iterator a = _reels.begin ();
        list<shared_ptr<Reel> >::const_iterator b = other_cpl->_reels.begin ();
-       
+
        while (a != _reels.end ()) {
                if (!(*a)->equals (*b, opt, note)) {
                        return false;
@@ -213,8 +227,8 @@ CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function
 bool
 CPL::encrypted () const
 {
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               if ((*i)->encrypted ()) {
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               if (i->encrypted ()) {
                        return true;
                }
        }
@@ -229,16 +243,16 @@ CPL::encrypted () const
 void
 CPL::add (DecryptedKDM const & kdm)
 {
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->add (kdm);
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               i->add (kdm);
        }
 }
 
 void
-CPL::resolve_refs (list<shared_ptr<Object> > objects)
+CPL::resolve_refs (list<shared_ptr<Asset> > assets)
 {
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->resolve_refs (objects);
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               i->resolve_refs (assets);
        }
 }
 
@@ -254,4 +268,13 @@ CPL::pkl_type (Standard standard) const
                DCP_ASSERT (false);
        }
 }
-       
+
+int64_t
+CPL::duration () const
+{
+       int64_t d = 0;
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               d += i->duration ();
+       }
+       return d;
+}