Various attempts to clean up DCP comparison code.
[libdcp.git] / src / cpl.cc
index 99d5b411d901fb3477e093af22db2e3c98f75a46..3599231daad1420b1acb201568667f6237514623 100644 (file)
+/*
+    Copyright (C) 2012-2014 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
+    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,
+    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.
+
+*/
+
+#include "raw_convert.h"
 #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 "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 <libxml/parser.h>
 
-using namespace std;
-using namespace libdcp;
+using std::string;
+using std::stringstream;
+using std::ostream;
+using std::list;
+using std::pair;
+using std::make_pair;
+using std::cout;
+using boost::shared_ptr;
+using boost::optional;
+using boost::dynamic_pointer_cast;
+using namespace dcp;
 
-CPL::CPL (string file)
-       : XMLFile (file, "CompositionPlaylist")
+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)
+       , _content_version_id ("urn:uuid:" + make_uuid ())
 {
-       id = string_node ("Id");
-       annotation_text = string_node ("AnnotationText");
-       issue_date = string_node ("IssueDate");
-       creator = string_node ("Creator");
-       content_title_text = string_node ("ContentTitleText");
-       content_kind = kind_node ("ContentKind");
-       content_version = sub_node<ContentVersion> ("ContentVersion");
-       ignore_node ("RatingList");
-       reel_list = sub_node<ReelList> ("ReelList");
-
-       done ();
+       /* default _content_version_id to 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;
 }
 
-ContentVersion::ContentVersion (xmlpp::Node const * node)
-       : XMLNode (node)
+/** Construct a CPL object from a XML file */
+CPL::CPL (boost::filesystem::path file)
+       : Asset (file)
+       , _content_kind (FEATURE)
 {
-       id = string_node ("Id");
-       label_text = string_node ("LabelText");
-       done ();
+       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 ("");
+       _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.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");
+               content_version->done ();
+       }
+       f.ignore_child ("RatingList");
+       _reels = type_grand_children<Reel> (f, "ReelList", "Reel");
+
+       f.ignore_child ("Issuer");
+       f.ignore_child ("Signer");
+       f.ignore_child ("Signature");
+
+       f.done ();
 }
 
-ReelList::ReelList (xmlpp::Node const * node)
-       : XMLNode (node)
+/** Add a reel to this CPL.
+ *  @param reel Reel to add.
+ */
+void
+CPL::add (boost::shared_ptr<Reel> reel)
 {
-       reels = sub_nodes<Reel> ("Reel");
-       done ();
+       _reels.push_back (reel);
 }
 
-Reel::Reel (xmlpp::Node const * node)
-       : XMLNode (node)
+/** 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, shared_ptr<const Signer> signer) const
 {
-       id = string_node ("Id");
-       asset_list = sub_node<CPLAssetList> ("AssetList");
+       xmlpp::Document doc;
+       xmlpp::Element* root;
+       if (standard == INTEROP) {
+               root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
+       } 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->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_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);
+       }
+       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);
+       }
 
-       done ();
+       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");
+
+       set_file (file);
 }
 
-CPLAssetList::CPLAssetList (xmlpp::Node const * node)
-       : XMLNode (node)
+list<shared_ptr<const ReelAsset> >
+CPL::reel_assets () const
 {
-       main_picture = sub_node<MainPicture> ("MainPicture");
-       main_sound = optional_sub_node<MainSound> ("MainSound");
+       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());
+               }
+               if ((*i)->main_sound ()) {
+                       c.push_back ((*i)->main_sound());
+               }
+               if ((*i)->main_subtitle ()) {
+                       c.push_back ((*i)->main_subtitle());
+               }
+       }
 
-       done ();
+       return c;
+}
+       
+bool
+CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> 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";
+               note (DCP_ERROR, s.str ());
+               return false;
+       }
+
+       if (_content_kind != other_cpl->_content_kind) {
+               note (DCP_ERROR, "CPL: content kinds differ");
+               return false;
+       }
+
+       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_cpl->_reels.begin ();
+       
+       while (a != _reels.end ()) {
+               if (!(*a)->equals (*b, opt, note)) {
+                       return false;
+               }
+               ++a;
+               ++b;
+       }
+
+       return true;
+}
+
+/** @return true if we have any encrypted content */
+bool
+CPL::encrypted () const
+{
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               if ((*i)->encrypted ()) {
+                       return true;
+               }
+       }
+
+       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 (DecryptedKDM const & kdm)
+{
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               (*i)->add (kdm);
+       }
 }
 
-MainPicture::MainPicture (xmlpp::Node const * node)
-       : XMLNode (node)
+void
+CPL::resolve_refs (list<shared_ptr<Object> > objects)
 {
-       id = string_node ("Id");
-       annotation_text = string_node ("AnnotationText");
-       edit_rate = fraction_node ("EditRate");
-       intrinsic_duration = int_node ("IntrinsicDuration");
-       entry_point = int_node ("EntryPoint");
-       duration = int_node ("Duration");
-       frame_rate = fraction_node ("FrameRate");
-       screen_aspect_ratio = fraction_node ("ScreenAspectRatio");
-
-       done ();
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               (*i)->resolve_refs (objects);
+       }
 }
 
-MainSound::MainSound (xmlpp::Node const * node)
-       : XMLNode (node)
+string
+CPL::pkl_type (Standard standard) const
 {
-       id = string_node ("Id");
-       annotation_text = string_node ("AnnotationText");
-       edit_rate = fraction_node ("EditRate");
-       intrinsic_duration = int_node ("IntrinsicDuration");
-       entry_point = int_node ("EntryPoint");
-       duration = int_node ("Duration");
-
-       done ();
+       switch (standard) {
+       case INTEROP:
+               return "text/xml;asdcpKind=CPL";
+       case SMPTE:
+               return "text/xml";
+       default:
+               assert (false);
+       }
 }
+