Various attempts to clean up DCP comparison code.
[libdcp.git] / src / cpl.cc
index fd7056809009efb30ab5c9265f09ed336f49b046..3599231daad1420b1acb201568667f6237514623 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    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
 
 */
 
-#include <fstream>
+#include "raw_convert.h"
 #include "cpl.h"
-#include "parse/cpl.h"
 #include "util.h"
-#include "picture_asset.h"
-#include "sound_asset.h"
-#include "subtitle_asset.h"
-#include "parse/asset_map.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 std::string;
 using std::stringstream;
-using std::ofstream;
 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 namespace libdcp;
-
-CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
-       : _directory (directory)
-       , _name (name)
+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 (length)
-       , _fps (frames_per_second)
+       , _content_version_id ("urn:uuid:" + make_uuid ())
 {
-       _uuid = make_uuid ();
+       /* 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;
 }
 
-/** Construct a CPL object from a XML file.
- *  @param directory The directory containing this CPL's DCP.
- *  @param file The CPL XML filename.
- *  @param asset_map The corresponding asset map.
- *  @param require_mxfs true to throw an exception if a required MXF file does not exist.
- */
-CPL::CPL (string directory, string file, shared_ptr<const libdcp::parse::AssetMap> asset_map, bool require_mxfs)
-       : _directory (directory)
+/** Construct a CPL object from a XML file */
+CPL::CPL (boost::filesystem::path file)
+       : Asset (file)
        , _content_kind (FEATURE)
-       , _length (0)
-       , _fps (0)
 {
-       /* Read the XML */
-       shared_ptr<parse::CPL> cpl;
-       try {
-               cpl.reset (new parse::CPL (file));
-       } catch (FileError& e) {
-               boost::throw_exception (FileError ("could not load CPL file", file));
-       }
-       
-       /* Now cherry-pick the required bits into our own data structure */
-       
-       _name = cpl->annotation_text;
-       _content_kind = cpl->content_kind;
-
-       for (list<shared_ptr<libdcp::parse::Reel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
-
-               shared_ptr<parse::Picture> p;
-
-               if ((*i)->asset_list->main_picture) {
-                       p = (*i)->asset_list->main_picture;
-               } else {
-                       p = (*i)->asset_list->main_stereoscopic_picture;
-               }
-               
-               _fps = p->edit_rate.numerator;
-               _length += p->duration;
+       cxml::Document f ("CompositionPlaylist");
+       f.read_file (file);
 
-               shared_ptr<PictureAsset> picture;
-               shared_ptr<SoundAsset> sound;
-               shared_ptr<SubtitleAsset> subtitle;
-
-               /* Some rather twisted logic to decide if we are 3D or not;
-                  some DCPs give a MainStereoscopicPicture to indicate 3D, others
-                  just have a FrameRate twice the EditRate and apparently
-                  expect you to divine the fact that they are hence 3D.
-               */
-
-               if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
-
-                       try {
-                               picture.reset (new MonoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id (p->id)->chunks.front()->path
-                                                      )
-                                       );
-
-                               picture->set_entry_point (p->entry_point);
-                               picture->set_duration (p->duration);
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-                       
-               } else {
-                       try {
-                               picture.reset (new StereoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id (p->id)->chunks.front()->path,
-                                                      _fps,
-                                                      p->duration
-                                                      )
-                                       );
-
-                               picture->set_entry_point (p->entry_point);
-                               picture->set_duration (p->duration);
-                               
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-                       
-               }
-               
-               if ((*i)->asset_list->main_sound) {
-                       
-                       try {
-                               sound.reset (new SoundAsset (
-                                                    _directory,
-                                                    asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path
-                                                    )
-                                       );
-
-                               sound->set_entry_point ((*i)->asset_list->main_sound->entry_point);
-                               sound->set_duration ((*i)->asset_list->main_sound->duration);
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-               }
+       _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");
 
-               if ((*i)->asset_list->main_subtitle) {
-                       
-                       subtitle.reset (new SubtitleAsset (
-                                               _directory,
-                                               asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path
-                                               )
-                               );
+       f.ignore_child ("Issuer");
+       f.ignore_child ("Signer");
+       f.ignore_child ("Signature");
 
-                       subtitle->set_entry_point ((*i)->asset_list->main_subtitle->entry_point);
-                       subtitle->set_duration ((*i)->asset_list->main_subtitle->duration);
-               }
-                       
-               _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
-       }
+       f.done ();
 }
 
+/** Add a reel to this CPL.
+ *  @param reel Reel to add.
+ */
 void
-CPL::add_reel (shared_ptr<const 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 (XMLMetadata const & metadata) const
+CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const Signer> signer) const
 {
-       boost::filesystem::path p;
-       p /= _directory;
-       stringstream s;
-       s << _uuid << "_cpl.xml";
-       p /= s.str();
-
        xmlpp::Document doc;
-       xmlpp::Element* root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
-       root->add_child("Id")->add_child_text ("urn:uuid:" + _uuid);
-       root->add_child("AnnotationText")->add_child_text (_name);
-       root->add_child("IssueDate")->add_child_text (metadata.issue_date);
-       root->add_child("Creator")->add_child_text (metadata.creator);
-       root->add_child("ContentTitleText")->add_child_text (_name);
+       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 ("urn:uri:" + _uuid + "_" + metadata.issue_date);
-               cv->add_child ("LabelText")->add_child_text (_uuid + "_" + metadata.issue_date);
+               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::Node* reel_list = root->add_child ("ReelList");
+       xmlpp::Element* reel_list = root->add_child ("ReelList");
        
-       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->write_to_cpl (reel_list);
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               (*i)->write_to_cpl (reel_list, standard);
        }
 
-       doc.write_to_file_formatted (p.string (), "UTF-8");
+       if (signer) {
+               signer->sign (root, standard);
+       }
 
-       _digest = make_digest (p.string ());
-       _length = boost::filesystem::file_size (p.string ());
-}
+       /* This must not be the _formatted version otherwise signature digests will be wrong */
+       doc.write_to_file (file.string (), "UTF-8");
 
-void
-CPL::write_to_pkl (xmlpp::Node* node) const
-{
-       xmlpp::Node* asset = node->add_child ("Asset");
-       asset->add_child("Id")->add_child_text ("urn:uuid:" + _uuid);
-       asset->add_child("Hash")->add_child_text (_digest);
-       asset->add_child("Size")->add_child_text (lexical_cast<string> (_length));
-       asset->add_child("Type")->add_child_text ("text/xml");
+       set_file (file);
 }
 
-list<shared_ptr<const Asset> >
-CPL::assets () const
+list<shared_ptr<const ReelAsset> >
+CPL::reel_assets () const
 {
-       list<shared_ptr<const Asset> > a;
-       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+       list<shared_ptr<const ReelAsset> > c;
+
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
                if ((*i)->main_picture ()) {
-                       a.push_back ((*i)->main_picture ());
+                       c.push_back ((*i)->main_picture());
                }
                if ((*i)->main_sound ()) {
-                       a.push_back ((*i)->main_sound ());
+                       c.push_back ((*i)->main_sound());
                }
                if ((*i)->main_subtitle ()) {
-                       a.push_back ((*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:" + _uuid);
-       xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
-       xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
-       chunk->add_child("Path")->add_child_text (_uuid + "_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, boost::function<void (NoteType, string)> note) const
 {
-       if (_name != other._name && !opt.cpl_names_can_differ) {
-               stringstream s;
-               s << "names differ: " << _name << " vs " << other._name << "\n";
-               note (ERROR, s.str ());
+       shared_ptr<const CPL> other_cpl = dynamic_pointer_cast<const CPL> (other);
+       if (!other_cpl) {
                return false;
        }
-
-       if (_content_kind != other._content_kind) {
-               note (ERROR, "content kinds differ");
-               return false;
-       }
-
-       if (_fps != other._fps) {
-               note (ERROR, "frames per second differ");
+       
+       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 (_length != other._length) {
-               note (ERROR, "lengths 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, "reel counts differ");
+       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<const Reel> >::const_iterator a = _reels.begin ();
-       list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
+       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)) {
@@ -296,3 +213,50 @@ CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteT
 
        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);
+       }
+}
+
+void
+CPL::resolve_refs (list<shared_ptr<Object> > objects)
+{
+       for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               (*i)->resolve_refs (objects);
+       }
+}
+
+string
+CPL::pkl_type (Standard standard) const
+{
+       switch (standard) {
+       case INTEROP:
+               return "text/xml;asdcpKind=CPL";
+       case SMPTE:
+               return "text/xml";
+       default:
+               assert (false);
+       }
+}
+