Add edit_rate accessor.
[libdcp.git] / src / cpl.cc
index 813eb0ed0bebde250de339e5755e609ee4b45f9d..5f3d0291482861d9d82886669f827d21853fec58 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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 "cpl.h"
 #include "util.h"
-#include "mono_picture_mxf.h"
-#include "stereo_picture_mxf.h"
-#include "sound_mxf.h"
-#include "subtitle_content.h"
 #include "reel.h"
 #include "metadata.h"
-#include "signer.h"
-#include "exceptions.h"
+#include "certificate_chain.h"
 #include "xml.h"
-#include "compose.hpp"
 #include "reel_picture_asset.h"
 #include "reel_sound_asset.h"
 #include "reel_subtitle_asset.h"
+#include "local_time.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
 #include <libxml/parser.h>
+#include <boost/foreach.hpp>
 
 using std::string;
 using std::stringstream;
@@ -40,34 +38,45 @@ using std::ostream;
 using std::list;
 using std::pair;
 using std::make_pair;
+using std::cout;
 using boost::shared_ptr;
-using boost::lexical_cast;
 using boost::optional;
+using boost::dynamic_pointer_cast;
 using namespace dcp;
 
 CPL::CPL (string annotation_text, ContentKind content_kind)
        : _annotation_text (annotation_text)
+       /* default _content_title_text to _annotation_text */
+       , _content_title_text (annotation_text)
        , _content_kind (content_kind)
-       , _length (0)
+       , _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 ();
 }
 
 /** Construct a CPL object from a XML file */
 CPL::CPL (boost::filesystem::path file)
-       : _content_kind (FEATURE)
-       , _length (0)
+       : Asset (file)
+       , _content_kind (FEATURE)
 {
        cxml::Document f ("CompositionPlaylist");
        f.read_file (file);
 
        _id = f.string_child ("Id");
+       if (_id.length() > 9) {
+               _id = _id.substr (9);
+       }
        _annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
-       _issue_date = f.string_child ("IssueDate");
-       _creator = f.optional_string_child ("Creator").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");
        _content_title_text = f.string_child ("ContentTitleText");
        _content_kind = content_kind_from_string (f.string_child ("ContentKind"));
-       shared_ptr<cxml::Node> content_version = f.node_child ("ContentVersion");
+       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");
@@ -87,13 +96,18 @@ CPL::CPL (boost::filesystem::path file)
  *  @param reel Reel to add.
  */
 void
-CPL::add (shared_ptr<Reel> reel)
+CPL::add (boost::shared_ptr<Reel> reel)
 {
        _reels.push_back (reel);
 }
 
+/** Write an CompositonPlaylist XML file.
+ *  @param file Filename to write.
+ *  @param standard INTEROP or SMPTE.
+ *  @param signer Signer to sign the CPL, or 0 to add no signature.
+ */
 void
-CPL::write_xml (boost::filesystem::path file, Standard standard, XMLMetadata metadata, 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;
@@ -106,13 +120,13 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, XMLMetadata met
        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);
-       root->add_child("Issuer")->add_child_text (metadata.issuer);
-       root->add_child("Creator")->add_child_text (metadata.creator);
-       root->add_child("ContentTitleText")->add_child_text (_content_version_label_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("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");
@@ -122,9 +136,9 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, XMLMetadata met
        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) {
@@ -134,65 +148,57 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, XMLMetadata met
        /* This must not be the _formatted version otherwise signature digests will be wrong */
        doc.write_to_file (file.string (), "UTF-8");
 
-       _digest = make_digest (file.string (), 0);
-       _length = boost::filesystem::file_size (file.string ());
+       set_file (file);
 }
 
-list<shared_ptr<const Content> >
-CPL::assets () const
+list<shared_ptr<const ReelAsset> >
+CPL::reel_assets () const
 {
-       list<shared_ptr<const Content> > a;
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               if ((*i)->main_picture ()) {
-                       a.push_back ((*i)->main_picture()->mxf ());
+       list<shared_ptr<const ReelAsset> > c;
+
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               if (i->main_picture ()) {
+                       c.push_back (i->main_picture());
                }
-               if ((*i)->main_sound ()) {
-                       a.push_back ((*i)->main_sound()->mxf ());
+               if (i->main_sound ()) {
+                       c.push_back (i->main_sound());
                }
-               if ((*i)->main_subtitle ()) {
-                       a.push_back ((*i)->main_subtitle()->subtitle_content ());
+               if (i->main_subtitle ()) {
+                       c.push_back (i->main_subtitle());
                }
        }
 
-       return a;
+       return c;
 }
 
-void
-CPL::write_to_assetmap (xmlpp::Node* node) const
-{
-       xmlpp::Node* asset = node->add_child ("Asset");
-       asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
-       xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
-       xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
-       chunk->add_child("Path")->add_child_text (_id + "_cpl.xml");
-       chunk->add_child("VolumeIndex")->add_child_text ("1");
-       chunk->add_child("Offset")->add_child_text("0");
-       chunk->add_child("Length")->add_child_text(lexical_cast<string> (_length));
-}
-       
 bool
-CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
-       if (_annotation_text != other._annotation_text && !opt.cpl_annotation_texts_can_differ) {
+       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 << "annotation texts differ: " << _annotation_text << " vs " << other._annotation_text << "\n";
-               note (ERROR, s.str ());
+               s << "CPL: annotation texts differ: " << _annotation_text << " vs " << other_cpl->_annotation_text << "\n";
+               note (DCP_ERROR, s.str ());
                return false;
        }
 
-       if (_content_kind != other._content_kind) {
-               note (ERROR, "content kinds differ");
+       if (_content_kind != other_cpl->_content_kind) {
+               note (DCP_ERROR, "CPL: content kinds differ");
                return false;
        }
 
-       if (_reels.size() != other._reels.size()) {
-               note (ERROR, String::compose ("reel counts differ (%1 vs %2)", _reels.size(), other._reels.size()));
+       if (_reels.size() != other_cpl->_reels.size()) {
+               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._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;
@@ -208,8 +214,8 @@ CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteT
 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;
                }
        }
@@ -217,18 +223,35 @@ CPL::encrypted () const
        return false;
 }
 
+/** Add a KDM to this CPL.  If the KDM is for any of this CPLs assets it will be used
+ *  to decrypt those assets.
+ *  @param kdm KDM.
+ */
 void
-CPL::add (KDM const & kdm)
+CPL::add (DecryptedKDM const & kdm)
 {
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->add_kdm (kdm);
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               i->add (kdm);
        }
 }
 
 void
-CPL::set_mxf_keys (Key key)
+CPL::resolve_refs (list<shared_ptr<Object> > objects)
+{
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               i->resolve_refs (objects);
+       }
+}
+
+string
+CPL::pkl_type (Standard standard) const
 {
-       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->set_mxf_keys (key);
+       switch (standard) {
+       case INTEROP:
+               return "text/xml;asdcpKind=CPL";
+       case SMPTE:
+               return "text/xml";
+       default:
+               DCP_ASSERT (false);
        }
 }