Add basics for progressive sound asset writing.
[libdcp.git] / src / dcp.cc
index 27ae9636da7ee3a4cff317acc929f1a29518fa51..4f1732da3ca2149dec2e5fe2bb637ba9c1e5d7ae 100644 (file)
 #include <fstream>
 #include <iomanip>
 #include <cassert>
+#include <iostream>
 #include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
+#include <libxml++/libxml++.h>
 #include "dcp.h"
 #include "asset.h"
 #include "sound_asset.h"
 #include "picture_asset.h"
+#include "subtitle_asset.h"
 #include "util.h"
 #include "metadata.h"
-
-using namespace std;
-using namespace boost;
+#include "exceptions.h"
+#include "cpl_file.h"
+#include "pkl_file.h"
+#include "asset_map.h"
+#include "reel.h"
+
+using std::string;
+using std::list;
+using std::stringstream;
+using std::ofstream;
+using std::ostream;
+using boost::shared_ptr;
 using namespace libdcp;
 
-DCP::DCP (string directory, string name, ContentType content_type, int fps, int length)
+DCP::DCP (string directory)
        : _directory (directory)
-       , _name (name)
-       , _content_type (content_type)
-       , _fps (fps)
-       , _length (length)
-{
-       
-}
-
-void
-DCP::add_sound_asset (vector<string> const & files)
-{
-       filesystem::path p;
-       p /= _directory;
-       p /= "audio.mxf";
-       _assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (files, p.string(), &Progress, _fps, _length)));
-}
-
-void
-DCP::add_sound_asset (sigc::slot<string, Channel> get_path, int channels)
-{
-       filesystem::path p;
-       p /= _directory;
-       p /= "audio.mxf";
-       _assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (get_path, p.string(), &Progress, _fps, _length, channels)));
-}
-
-void
-DCP::add_picture_asset (vector<string> const & files, int width, int height)
-{
-       filesystem::path p;
-       p /= _directory;
-       p /= "video.mxf";
-       _assets.push_back (shared_ptr<PictureAsset> (new PictureAsset (files, p.string(), &Progress, _fps, _length, width, height)));
-}
-
-void
-DCP::add_picture_asset (sigc::slot<string, int> get_path, int width, int height)
 {
-       filesystem::path p;
-       p /= _directory;
-       p /= "video.mxf";
-       _assets.push_back (shared_ptr<PictureAsset> (new PictureAsset (get_path, p.string(), &Progress, _fps, _length, width, height)));
+       boost::filesystem::create_directories (directory);
 }
 
 void
 DCP::write_xml () const
 {
-       string cpl_uuid = make_uuid ();
-       string cpl_path = write_cpl (cpl_uuid);
-       int cpl_length = filesystem::file_size (cpl_path);
-       string cpl_digest = make_digest (cpl_path, 0);
+       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_xml ();
+       }
 
        string pkl_uuid = make_uuid ();
-       string pkl_path = write_pkl (pkl_uuid, cpl_uuid, cpl_digest, cpl_length);
+       string pkl_path = write_pkl (pkl_uuid);
        
        write_volindex ();
-       write_assetmap (cpl_uuid, cpl_length, pkl_uuid, filesystem::file_size (pkl_path));
-}
-
-string
-DCP::write_cpl (string cpl_uuid) const
-{
-       filesystem::path p;
-       p /= _directory;
-       stringstream s;
-       s << cpl_uuid << "_cpl.xml";
-       p /= s.str();
-       ofstream cpl (p.string().c_str());
-       
-       cpl << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-           << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
-           << "  <Id>urn:uuid:" << cpl_uuid << "</Id>\n"
-           << "  <AnnotationText>" << _name << "</AnnotationText>\n"
-           << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
-           << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
-           << "  <ContentTitleText>" << _name << "</ContentTitleText>\n"
-           << "  <ContentKind>" << content_type_string (_content_type) << "</ContentKind>\n"
-           << "  <ContentVersion>\n"
-           << "    <Id>urn:uri:" << cpl_uuid << "_" << Metadata::instance()->issue_date << "</Id>\n"
-           << "    <LabelText>" << cpl_uuid << "_" << Metadata::instance()->issue_date << "</LabelText>\n"
-           << "  </ContentVersion>\n"
-           << "  <RatingList/>\n"
-           << "  <ReelList>\n";
-
-       cpl << "    <Reel>\n"
-           << "      <Id>urn:uuid:" << make_uuid() << "</Id>\n"
-           << "      <AssetList>\n";
-
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               (*i)->write_to_cpl (cpl);
-       }
-
-       cpl << "      </AssetList>\n"
-           << "    </Reel>\n"
-           << "  </ReelList>\n"
-           << "</CompositionPlaylist>\n";
-
-       return p.string ();
+       write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path));
 }
 
 std::string
-DCP::write_pkl (string pkl_uuid, string cpl_uuid, string cpl_digest, int cpl_length) const
+DCP::write_pkl (string pkl_uuid) const
 {
-       filesystem::path p;
+       assert (!_cpls.empty ());
+       
+       boost::filesystem::path p;
        p /= _directory;
        stringstream s;
        s << pkl_uuid << "_pkl.xml";
@@ -152,22 +85,21 @@ DCP::write_pkl (string pkl_uuid, string cpl_uuid, string cpl_digest, int cpl_len
        pkl << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
            << "<PackingList xmlns=\"http://www.smpte-ra.org/schemas/429-8/2007/PKL\">\n"
            << "  <Id>urn:uuid:" << pkl_uuid << "</Id>\n"
-           << "  <AnnotationText>" << _name << "</AnnotationText>\n"
+               /* XXX: this is a bit of a hack */
+           << "  <AnnotationText>" << _cpls.front()->name() << "</AnnotationText>\n"
            << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
            << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
            << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
            << "  <AssetList>\n";
 
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
+       list<shared_ptr<const Asset> > a = assets ();
+       for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
                (*i)->write_to_pkl (pkl);
        }
 
-       pkl << "    <Asset>\n"
-           << "      <Id>urn:uuid:" << cpl_uuid << "</Id>\n"
-           << "      <Hash>" << cpl_digest << "</Hash>\n"
-           << "      <Size>" << cpl_length << "</Size>\n"
-           << "      <Type>text/xml</Type>\n"
-           << "    </Asset>\n";
+       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_to_pkl (pkl);
+       }
 
        pkl << "  </AssetList>\n"
            << "</PackingList>\n";
@@ -178,7 +110,7 @@ DCP::write_pkl (string pkl_uuid, string cpl_uuid, string cpl_digest, int cpl_len
 void
 DCP::write_volindex () const
 {
-       filesystem::path p;
+       boost::filesystem::path p;
        p /= _directory;
        p /= "VOLINDEX.xml";
        ofstream vi (p.string().c_str());
@@ -190,9 +122,9 @@ DCP::write_volindex () const
 }
 
 void
-DCP::write_assetmap (string cpl_uuid, int cpl_length, string pkl_uuid, int pkl_length) const
+DCP::write_assetmap (string pkl_uuid, int pkl_length) const
 {
-       filesystem::path p;
+       boost::filesystem::path p;
        p /= _directory;
        p /= "ASSETMAP.xml";
        ofstream am (p.string().c_str());
@@ -218,20 +150,13 @@ DCP::write_assetmap (string cpl_uuid, int cpl_length, string pkl_uuid, int pkl_l
           << "        </Chunk>\n"
           << "      </ChunkList>\n"
           << "    </Asset>\n";
-
-       am << "    <Asset>\n"
-          << "      <Id>urn:uuid:" << cpl_uuid << "</Id>\n"
-          << "      <ChunkList>\n"
-          << "        <Chunk>\n"
-          << "          <Path>" << cpl_uuid << "_cpl.xml</Path>\n"
-          << "          <VolumeIndex>1</VolumeIndex>\n"
-          << "          <Offset>0</Offset>\n"
-          << "          <Length>" << cpl_length << "</Length>\n"
-          << "        </Chunk>\n"
-          << "      </ChunkList>\n"
-          << "    </Asset>\n";
        
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
+       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_to_assetmap (am);
+       }
+
+       list<shared_ptr<const Asset> > a = assets ();
+       for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
                (*i)->write_to_assetmap (am);
        }
 
@@ -239,32 +164,395 @@ DCP::write_assetmap (string cpl_uuid, int cpl_length, string pkl_uuid, int pkl_l
           << "</AssetMap>\n";
 }
 
-string
-DCP::content_type_string (ContentType type)
+
+void
+DCP::read (bool require_mxfs)
+{
+       Files files;
+
+       shared_ptr<AssetMap> asset_map;
+       try {
+               boost::filesystem::path p = _directory;
+               p /= "ASSETMAP";
+               if (boost::filesystem::exists (p)) {
+                       asset_map.reset (new AssetMap (p.string ()));
+               } else {
+                       p = _directory;
+                       p /= "ASSETMAP.xml";
+                       if (boost::filesystem::exists (p)) {
+                               asset_map.reset (new AssetMap (p.string ()));
+                       } else {
+                               throw DCPReadError ("could not find AssetMap file");
+                       }
+               }
+               
+       } catch (FileError& e) {
+               throw FileError ("could not load AssetMap file", files.asset_map);
+       }
+
+       for (list<shared_ptr<AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
+               if ((*i)->chunks.size() != 1) {
+                       throw XMLError ("unsupported asset chunk count");
+               }
+
+               boost::filesystem::path t = _directory;
+               t /= (*i)->chunks.front()->path;
+               
+               if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
+                       continue;
+               }
+
+               xmlpp::DomParser* p = new xmlpp::DomParser;
+               try {
+                       p->parse_file (t.string());
+               } catch (std::exception& e) {
+                       delete p;
+                       continue;
+               }
+
+               string const root = p->get_document()->get_root_node()->get_name ();
+               delete p;
+
+               if (root == "CompositionPlaylist") {
+                       files.cpls.push_back (t.string());
+               } else if (root == "PackingList") {
+                       if (files.pkl.empty ()) {
+                               files.pkl = t.string();
+                       } else {
+                               throw DCPReadError ("duplicate PKLs found");
+                       }
+               }
+       }
+       
+       if (files.cpls.empty ()) {
+               throw FileError ("no CPL files found", "");
+       }
+
+       if (files.pkl.empty ()) {
+               throw FileError ("no PKL file found", "");
+       }
+
+       shared_ptr<PKLFile> pkl;
+       try {
+               pkl.reset (new PKLFile (files.pkl));
+       } catch (FileError& e) {
+               throw FileError ("could not load PKL file", files.pkl);
+       }
+
+       /* Cross-check */
+       /* XXX */
+
+       for (list<string>::iterator i = files.cpls.begin(); i != files.cpls.end(); ++i) {
+               _cpls.push_back (shared_ptr<CPL> (new CPL (_directory, *i, asset_map, require_mxfs)));
+       }
+}
+
+bool
+DCP::equals (DCP const & other, EqualityOptions opt, list<string>& notes) const
+{
+       if (_cpls.size() != other._cpls.size()) {
+               notes.push_back ("CPL counts differ");
+               return false;
+       }
+
+       list<shared_ptr<const CPL> >::const_iterator a = _cpls.begin ();
+       list<shared_ptr<const CPL> >::const_iterator b = other._cpls.begin ();
+
+       while (a != _cpls.end ()) {
+               if (!(*a)->equals (*b->get(), opt, notes)) {
+                       return false;
+               }
+               ++a;
+               ++b;
+       }
+
+       return true;
+}
+
+
+void
+DCP::add_cpl (shared_ptr<CPL> cpl)
+{
+       _cpls.push_back (cpl);
+}
+
+class AssetComparator
+{
+public:
+       bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
+               return a->uuid() < b->uuid();
+       }
+};
+
+list<shared_ptr<const Asset> >
+DCP::assets () const
 {
-       switch (type) {
-       case FEATURE:
-               return "feature";
-       case SHORT:
-               return "short";
-       case TRAILER:
-               return "trailer";
-       case TEST:
-               return "test";
-       case TRANSITIONAL:
-               return "transitional";
-       case RATING:
-               return "rating";
-       case TEASER:
-               return "teaser";
-       case POLICY:
-               return "policy";
-       case PUBLIC_SERVICE_ANNOUNCEMENT:
-               return "psa";
-       case ADVERTISEMENT:
-               return "advertisement";
+       list<shared_ptr<const Asset> > a;
+       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               list<shared_ptr<const Asset> > t = (*i)->assets ();
+               a.merge (t);
        }
 
-       assert (false);
+       a.sort ();
+       a.unique ();
+       return a;
 }
+
+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)
+{
+       _uuid = make_uuid ();
+}
+
+/** 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 AssetMap> asset_map, bool require_mxfs)
+       : _directory (directory)
+       , _content_kind (FEATURE)
+       , _length (0)
+       , _fps (0)
+{
+       /* Read the XML */
+       shared_ptr<CPLFile> cpl;
+       try {
+               cpl.reset (new CPLFile (file));
+       } catch (FileError& e) {
+               throw 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<CPLReel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
+
+               shared_ptr<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 ((*i)->asset_list->main_picture->entry_point);
+                       } 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);
+                               
+                       } 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);
+                       } 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
+                                               )
+                               );
+               }
+                       
+               _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
+       }
+}
+
+void
+CPL::add_reel (shared_ptr<const Reel> reel)
+{
+       _reels.push_back (reel);
+}
+
+void
+CPL::write_xml () const
+{
+       boost::filesystem::path p;
+       p /= _directory;
+       stringstream s;
+       s << _uuid << "_cpl.xml";
+       p /= s.str();
+       ofstream os (p.string().c_str());
+       
+       os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+          << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
+          << "  <Id>urn:uuid:" << _uuid << "</Id>\n"
+          << "  <AnnotationText>" << _name << "</AnnotationText>\n"
+          << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
+          << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
+          << "  <ContentTitleText>" << _name << "</ContentTitleText>\n"
+          << "  <ContentKind>" << content_kind_to_string (_content_kind) << "</ContentKind>\n"
+          << "  <ContentVersion>\n"
+          << "    <Id>urn:uri:" << _uuid << "_" << Metadata::instance()->issue_date << "</Id>\n"
+          << "    <LabelText>" << _uuid << "_" << Metadata::instance()->issue_date << "</LabelText>\n"
+          << "  </ContentVersion>\n"
+          << "  <RatingList/>\n"
+          << "  <ReelList>\n";
+       
+       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
+               (*i)->write_to_cpl (os);
+       }
+
+       os << "  </ReelList>\n"
+          << "</CompositionPlaylist>\n";
+
+       os.close ();
+
+       _digest = make_digest (p.string ());
+       _length = boost::filesystem::file_size (p.string ());
+}
+
+void
+CPL::write_to_pkl (ostream& s) const
+{
+       s << "    <Asset>\n"
+         << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
+         << "      <Hash>" << _digest << "</Hash>\n"
+         << "      <Size>" << _length << "</Size>\n"
+         << "      <Type>text/xml</Type>\n"
+         << "    </Asset>\n";
+}
+
+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;
+}
+
+void
+CPL::write_to_assetmap (ostream& s) const
+{
+       s << "    <Asset>\n"
+         << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
+         << "      <ChunkList>\n"
+         << "        <Chunk>\n"
+         << "          <Path>" << _uuid << "_cpl.xml</Path>\n"
+         << "          <VolumeIndex>1</VolumeIndex>\n"
+         << "          <Offset>0</Offset>\n"
+         << "          <Length>" << _length << "</Length>\n"
+         << "        </Chunk>\n"
+         << "      </ChunkList>\n"
+         << "    </Asset>\n";
+}
+       
+       
+       
+bool
+CPL::equals (CPL const & other, EqualityOptions opt, list<string>& notes) const
+{
+       if (_name != other._name) {
+               notes.push_back ("names differ");
+               return false;
+       }
+
+       if (_content_kind != other._content_kind) {
+               notes.push_back ("content kinds differ");
+               return false;
+       }
+
+       if (_fps != other._fps) {
+               notes.push_back ("frames per second differ");
+               return false;
+       }
+
+       if (_length != other._length) {
+               notes.push_back ("lengths differ");
+               return false;
+       }
+
+       if (_reels.size() != other._reels.size()) {
+               notes.push_back ("reel counts differ");
+               return false;
+       }
+       
+       list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
+       list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
+       
+       while (a != _reels.end ()) {
+               if (!(*a)->equals (*b, opt, notes)) {
+                       return false;
+               }
+               ++a;
+               ++b;
+       }
+
+       return true;
+}