Tweaks to diffing routines.
[libdcp.git] / src / cpl.cc
index c135db3c07acb3020e21d04bb052b1ef652fc769..fd7056809009efb30ab5c9265f09ed336f49b046 100644 (file)
 
 */
 
-/** @file  src/cpl.cc
- *  @brief Classes used to parse a CPL.
- */
-
-#include <iostream>
+#include <fstream>
 #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 "reel.h"
+#include "metadata.h"
 
-using namespace std;
+using std::string;
+using std::stringstream;
+using std::ofstream;
+using std::ostream;
+using std::list;
+using boost::shared_ptr;
+using boost::lexical_cast;
 using namespace libdcp;
 
-CPL::CPL (string file)
-       : XMLFile (file, "CompositionPlaylist")
+CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
+       : _directory (directory)
+       , _name (name)
+       , _content_kind (content_kind)
+       , _length (length)
+       , _fps (frames_per_second)
 {
-       id = string_node ("Id");
-       annotation_text = optional_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 = optional_sub_node<ContentVersion> ("ContentVersion");
-       ignore_node ("RatingList");
-       reels = sub_nodes<CPLReel> ("ReelList", "Reel");
-
-       ignore_node ("Issuer");
-       ignore_node ("Signer");
-       ignore_node ("Signature");
-
-       done ();
+       _uuid = make_uuid ();
 }
 
-ContentVersion::ContentVersion (xmlpp::Node const * node)
-       : XMLNode (node)
+/** 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)
+       , _content_kind (FEATURE)
+       , _length (0)
+       , _fps (0)
 {
-       id = optional_string_node ("Id");
-       label_text = string_node ("LabelText");
-       done ();
+       /* 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;
+
+               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;
+                               }
+                       }
+               }
+
+               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
+                                               )
+                               );
+
+                       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)));
+       }
 }
 
-CPLReel::CPLReel (xmlpp::Node const * node)
-       : XMLNode (node)
+void
+CPL::add_reel (shared_ptr<const Reel> reel)
 {
-       id = string_node ("Id");
-       asset_list = sub_node<CPLAssetList> ("AssetList");
-
-       ignore_node ("AnnotationText");
-       done ();
+       _reels.push_back (reel);
 }
 
-CPLAssetList::CPLAssetList (xmlpp::Node const * node)
-       : XMLNode (node)
+void
+CPL::write_xml (XMLMetadata const & metadata) const
 {
-       main_picture = optional_sub_node<MainPicture> ("MainPicture");
-       main_stereoscopic_picture = optional_sub_node<MainStereoscopicPicture> ("MainStereoscopicPicture");
-       main_sound = optional_sub_node<MainSound> ("MainSound");
-       main_subtitle = optional_sub_node<MainSubtitle> ("MainSubtitle");
+       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);
+       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);
+       }
+       root->add_child("RatingList");
 
-       done ();
+       xmlpp::Node* 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);
+       }
+
+       doc.write_to_file_formatted (p.string (), "UTF-8");
+
+       _digest = make_digest (p.string ());
+       _length = boost::filesystem::file_size (p.string ());
 }
 
-MainPicture::MainPicture (xmlpp::Node const * node)
-       : Picture (node)
+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");
 }
 
-MainStereoscopicPicture::MainStereoscopicPicture (xmlpp::Node const * node)
-       : Picture (node)
+list<shared_ptr<const Asset> >
+CPL::assets () const
 {
+       list<shared_ptr<const Asset> > a;
+       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               if ((*i)->main_picture ()) {
+                       a.push_back ((*i)->main_picture ());
+               }
+               if ((*i)->main_sound ()) {
+                       a.push_back ((*i)->main_sound ());
+               }
+               if ((*i)->main_subtitle ()) {
+                       a.push_back ((*i)->main_subtitle ());
+               }
+       }
 
+       return a;
 }
 
-Picture::Picture (xmlpp::Node const * node)
-       : XMLNode (node)
+void
+CPL::write_to_assetmap (xmlpp::Node* node) const
 {
-       id = string_node ("Id");
-       annotation_text = optional_string_node ("AnnotationText");
-       edit_rate = fraction_node ("EditRate");
-       intrinsic_duration = int64_node ("IntrinsicDuration");
-       entry_point = int64_node ("EntryPoint");
-       duration = int64_node ("Duration");
-       frame_rate = fraction_node ("FrameRate");
-       try {
-               screen_aspect_ratio = fraction_node ("ScreenAspectRatio");
-       } catch (XMLError& e) {
-               /* Maybe it's not a fraction */
+       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
+{
+       if (_name != other._name && !opt.cpl_names_can_differ) {
+               stringstream s;
+               s << "names differ: " << _name << " vs " << other._name << "\n";
+               note (ERROR, s.str ());
+               return false;
        }
-       try {
-               float f = float_node ("ScreenAspectRatio");
-               screen_aspect_ratio = Fraction (f * 1000, 1000);
-       } catch (bad_cast& e) {
 
+       if (_content_kind != other._content_kind) {
+               note (ERROR, "content kinds differ");
+               return false;
        }
 
-       ignore_node ("Hash");
+       if (_fps != other._fps) {
+               note (ERROR, "frames per second differ");
+               return false;
+       }
 
-       done ();
-}
+       if (_length != other._length) {
+               note (ERROR, "lengths differ");
+               return false;
+       }
 
-MainSound::MainSound (xmlpp::Node const * node)
-       : XMLNode (node)
-{
-       id = string_node ("Id");
-       annotation_text = optional_string_node ("AnnotationText");
-       edit_rate = fraction_node ("EditRate");
-       intrinsic_duration = int64_node ("IntrinsicDuration");
-       entry_point = int64_node ("EntryPoint");
-       duration = int64_node ("Duration");
-
-       ignore_node ("Hash");
-       ignore_node ("Language");
+       if (_reels.size() != other._reels.size()) {
+               note (ERROR, "reel counts differ");
+               return false;
+       }
        
-       done ();
-}
-
-MainSubtitle::MainSubtitle (xmlpp::Node const * node)
-       : XMLNode (node)
-{
-       id = string_node ("Id");
-       annotation_text = optional_string_node ("AnnotationText");
-       edit_rate = fraction_node ("EditRate");
-       intrinsic_duration = int64_node ("IntrinsicDuration");
-       entry_point = int64_node ("EntryPoint");
-       duration = int64_node ("Duration");
-
-       ignore_node ("Hash");
-       ignore_node ("Language");
+       list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
+       list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
        
-       done ();
+       while (a != _reels.end ()) {
+               if (!(*a)->equals (*b, opt, note)) {
+                       return false;
+               }
+               ++a;
+               ++b;
+       }
+
+       return true;
 }