Use a vector<ContentVersion> instead of just one, to support the
[libdcp.git] / src / cpl.cc
index 9633abc45293245b79857926812e605c589c91b1..6c5610d8e5a45f6bd7cdd2f09e7f39e757e721b3 100644 (file)
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 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.
 */
 
 #include "cpl.h"
 #include "reel_picture_asset.h"
 #include "reel_sound_asset.h"
 #include "reel_subtitle_asset.h"
+#include "reel_closed_caption_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;
-using std::ostream;
 using std::list;
 using std::pair;
 using std::make_pair;
 using std::cout;
+using std::vector;
 using boost::shared_ptr;
 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 */
+       /* default _content_title_text to annotation_text */
+       : _issuer ("libdcp" LIBDCP_VERSION)
+       , _creator ("libdcp" LIBDCP_VERSION)
+       , _issue_date (LocalTime().as_string())
+       , _annotation_text (annotation_text)
        , _content_title_text (annotation_text)
        , _content_kind (content_kind)
-       , _content_version_id ("urn:uuid:" + make_uuid ())
 {
-       /* 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();
-       _content_version_label_text = _content_version_id + LocalTime().as_string ();
+       ContentVersion cv;
+       cv.label_text = cv.id + LocalTime().as_string();
+       _content_versions.push_back (cv);
 }
 
 /** Construct a CPL object from a XML file */
@@ -66,23 +85,41 @@ 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()));
        }
-       _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 ("");
-       _metadata.issue_date = f.string_child ("IssueDate");
+
+       _id = remove_urn_uuid (f.string_child ("Id"));
+       _annotation_text = f.optional_string_child("AnnotationText").get_value_or("");
+       _issuer = f.optional_string_child("Issuer").get_value_or("");
+       _creator = f.optional_string_child("Creator").get_value_or("");
+       _issue_date = f.string_child ("IssueDate");
        _content_title_text = f.string_child ("ContentTitleText");
        _content_kind = content_kind_from_string (f.string_child ("ContentKind"));
        shared_ptr<cxml::Node> content_version = f.optional_node_child ("ContentVersion");
        if (content_version) {
-               _content_version_id = content_version->optional_string_child ("Id").get_value_or ("");
-               _content_version_label_text = content_version->string_child ("LabelText");
+               /* XXX: SMPTE should insist that Id is present */
+               _content_versions.push_back (
+                       ContentVersion (
+                               content_version->optional_string_child("Id").get_value_or(""),
+                               content_version->string_child("LabelText")
+                               )
+                       );
                content_version->done ();
+       } else if (_standard == SMPTE) {
+               /* ContentVersion is required in SMPTE */
+               throw XMLError ("Missing ContentVersion tag in CPL");
+       }
+       cxml::ConstNodePtr rating_list = f.node_child ("RatingList");
+       if (rating_list) {
+               BOOST_FOREACH (cxml::ConstNodePtr i, rating_list->node_children("Rating")) {
+                       _ratings.push_back (Rating(i));
+               }
        }
-       f.ignore_child ("RatingList");
        _reels = type_grand_children<Reel> (f, "ReelList", "Reel");
 
        f.ignore_child ("Issuer");
@@ -112,28 +149,25 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<cons
        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");
-       }
-
-       if (signer) {
-               root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
+               root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns);
        }
 
        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);
-       root->add_child("Issuer")->add_child_text (_metadata.issuer);
-       root->add_child("Creator")->add_child_text (_metadata.creator);
+       root->add_child("IssueDate")->add_child_text (_issue_date);
+       root->add_child("Issuer")->add_child_text (_issuer);
+       root->add_child("Creator")->add_child_text (_creator);
        root->add_child("ContentTitleText")->add_child_text (_content_title_text);
        root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
-       {
-               xmlpp::Node* cv = root->add_child ("ContentVersion");
-               cv->add_child ("Id")->add_child_text (_content_version_id);
-               cv->add_child ("LabelText")->add_child_text (_content_version_label_text);
+       DCP_ASSERT (!_content_versions.empty());
+       _content_versions[0].as_xml (root);
+
+       xmlpp::Element* rating_list = root->add_child("RatingList");
+       BOOST_FOREACH (Rating i, _ratings) {
+               i.as_xml (rating_list->add_child("Rating"));
        }
-       root->add_child("RatingList");
 
        xmlpp::Element* reel_list = root->add_child ("ReelList");
 
@@ -141,20 +175,21 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<cons
                i->write_to_cpl (reel_list, standard);
        }
 
+       indent (root, 0);
+
        if (signer) {
                signer->sign (root, standard);
        }
 
-       /* This must not be the _formatted version otherwise signature digests will be wrong */
-       doc.write_to_file (file.string (), "UTF-8");
+       doc.write_to_file_formatted (file.string(), "UTF-8");
 
        set_file (file);
 }
 
-list<shared_ptr<const ReelAsset> >
-CPL::reel_assets () const
+list<shared_ptr<ReelMXF> >
+CPL::reel_mxfs ()
 {
-       list<shared_ptr<const ReelAsset> > c;
+       list<shared_ptr<ReelMXF> > c;
 
        BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
                if (i->main_picture ()) {
@@ -166,6 +201,38 @@ CPL::reel_assets () const
                if (i->main_subtitle ()) {
                        c.push_back (i->main_subtitle());
                }
+               BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> j, i->closed_captions()) {
+                       c.push_back (j);
+               }
+               if (i->atmos ()) {
+                       c.push_back (i->atmos());
+               }
+       }
+
+       return c;
+}
+
+list<shared_ptr<const ReelMXF> >
+CPL::reel_mxfs () const
+{
+       list<shared_ptr<const ReelMXF> > c;
+
+       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_subtitle ()) {
+                       c.push_back (i->main_subtitle());
+               }
+               BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> j, i->closed_captions()) {
+                       c.push_back (j);
+               }
+               if (i->atmos ()) {
+                       c.push_back (i->atmos());
+               }
        }
 
        return c;
@@ -180,9 +247,8 @@ CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler not
        }
 
        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";
-               note (DCP_ERROR, s.str ());
+               string const s = "CPL: annotation texts differ: " + _annotation_text + " vs " + other_cpl->_annotation_text + "\n";
+               note (DCP_ERROR, s);
                return false;
        }
 
@@ -245,6 +311,12 @@ CPL::resolve_refs (list<shared_ptr<Asset> > assets)
 
 string
 CPL::pkl_type (Standard standard) const
+{
+       return static_pkl_type (standard);
+}
+
+string
+CPL::static_pkl_type (Standard standard)
 {
        switch (standard) {
        case INTEROP:
@@ -265,3 +337,23 @@ CPL::duration () const
        }
        return d;
 }
+void
+CPL::set_content_versions (vector<ContentVersion> v)
+{
+       set<string> ids;
+       BOOST_FOREACH (ContentVersion i, v) {
+               if (!ids.insert(i.id).second) {
+                       throw DuplicateIdError ("Duplicate ID in ContentVersion list");
+               }
+       }
+
+       _content_versions = v;
+}
+
+
+ContentVersion
+CPL::content_version () const
+{
+       DCP_ASSERT (!_content_versions.empty());
+       return _content_versions[0];
+}