Split CPL up into its own files.

5 files changed, 395 insertions, 323 deletions

diff --git a/src/cpl.cc b/src/cpl.cc
new file mode 100644
index 00000000..90c48ae9
--- /dev/null
+++ b/src/cpl.cc
@@ -0,0 +1,296 @@
+/*
+    Copyright (C) 2012 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 <fstream>
+#include "cpl.h"
+#include "cpl_file.h"
+#include "util.h"
+#include "picture_asset.h"
+#include "sound_asset.h"
+#include "subtitle_asset.h"
+#include "asset_map.h"
+#include "reel.h"
+#include "metadata.h"
+
+using std::string;
+using std::stringstream;
+using std::ofstream;
+using std::ostream;
+using std::list;
+using boost::shared_ptr;
+using namespace libdcp;
+
+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) {
+		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<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, boost::function<void (NoteType, string)> note) const
+{
+	if (_name != other._name) {
+		note (ERROR, "names differ");
+		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");
+		return false;
+	}
+
+	if (_length != other._length) {
+		note (ERROR, "lengths differ");
+		return false;
+	}
+
+	if (_reels.size() != other._reels.size()) {
+		note (ERROR, "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, note)) {
+			return false;
+		}
+		++a;
+		++b;
+	}
+
+	return true;
+}
diff --git a/src/cpl.h b/src/cpl.h
new file mode 100644
index 00000000..3be10894
--- /dev/null
+++ b/src/cpl.h
@@ -0,0 +1,95 @@
+/*
+    Copyright (C) 2012 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 <list>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include "types.h"
+
+namespace libdcp {
+
+class AssetMap;
+class Asset;
+class Reel;
+
+/** @brief A CPL within a DCP */
+class CPL
+{
+public:
+	CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second);
+	CPL (std::string directory, std::string file, boost::shared_ptr<const AssetMap> asset_map, bool require_mxfs = true);
+
+	void add_reel (boost::shared_ptr<const Reel> reel);
+	
+	/** @return the length in frames */
+	int length () const {
+		return _length;
+	}
+
+	/** @return the type of the content, used by media servers
+	 *  to categorise things (e.g. feature, trailer, etc.)
+	 */
+	ContentKind content_kind () const {
+		return _content_kind;
+	}
+
+	std::list<boost::shared_ptr<const Reel> > reels () const {
+		return _reels;
+	}
+
+	/** @return the CPL's name, as will be presented on projector
+	 *  media servers and theatre management systems.
+	 */
+	std::string name () const {
+		return _name;
+	}
+
+	/** @return the number of frames per second */
+	int frames_per_second () const {
+		return _fps;
+	}
+
+	std::list<boost::shared_ptr<const Asset> > assets () const;
+	
+	bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
+	
+	void write_xml () const;
+	void write_to_assetmap (std::ostream& s) const;
+	void write_to_pkl (std::ostream& s) const;
+	
+private:
+	std::string _directory;
+	/** the name of the DCP */
+	std::string _name;
+	/** the content kind of the CPL */
+	ContentKind _content_kind;
+	/** length in frames */
+	mutable int _length;
+	/** frames per second */
+	int _fps;
+	/** reels */
+	std::list<boost::shared_ptr<const Reel> > _reels;
+
+	/** our UUID */
+	std::string _uuid;
+	/** a SHA1 digest of our XML */
+	mutable std::string _digest;
+};
+
+}
diff --git a/src/dcp.cc b/src/dcp.cc
index bac266ab..e74e0d95 100644
--- a/src/dcp.cc
+++ b/src/dcp.cc
@@ -41,6 +41,7 @@
 #include "pkl_file.h"
 #include "asset_map.h"
 #include "reel.h"
+#include "cpl.h"
 
 using std::string;
 using std::list;
@@ -298,261 +299,3 @@ DCP::assets () const
 	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) {
-		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<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, boost::function<void (NoteType, string)> note) const
-{
-	if (_name != other._name) {
-		note (ERROR, "names differ");
-		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");
-		return false;
-	}
-
-	if (_length != other._length) {
-		note (ERROR, "lengths differ");
-		return false;
-	}
-
-	if (_reels.size() != other._reels.size()) {
-		note (ERROR, "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, note)) {
-			return false;
-		}
-		++a;
-		++b;
-	}
-
-	return true;
-}
diff --git a/src/dcp.h b/src/dcp.h
index 9e2e8a02..decac4f2 100644
--- a/src/dcp.h
+++ b/src/dcp.h
@@ -44,72 +44,9 @@ class SoundAsset;
 class SubtitleAsset;
 class Reel;
 class AssetMap;
+class CPL;
 
-/** @brief A CPL within a DCP */
-class CPL
-{
-public:
-	CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second);
-	CPL (std::string directory, std::string file, boost::shared_ptr<const AssetMap> asset_map, bool require_mxfs = true);
-
-	void add_reel (boost::shared_ptr<const Reel> reel);
-	
-	/** @return the length in frames */
-	int length () const {
-		return _length;
-	}
-
-	/** @return the type of the content, used by media servers
-	 *  to categorise things (e.g. feature, trailer, etc.)
-	 */
-	ContentKind content_kind () const {
-		return _content_kind;
-	}
-
-	std::list<boost::shared_ptr<const Reel> > reels () const {
-		return _reels;
-	}
-
-	/** @return the CPL's name, as will be presented on projector
-	 *  media servers and theatre management systems.
-	 */
-	std::string name () const {
-		return _name;
-	}
-
-	/** @return the number of frames per second */
-	int frames_per_second () const {
-		return _fps;
-	}
-
-	std::list<boost::shared_ptr<const Asset> > assets () const;
-	
-	bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
-	
-	void write_xml () const;
-	void write_to_assetmap (std::ostream& s) const;
-	void write_to_pkl (std::ostream& s) const;
-	
-private:
-	std::string _directory;
-	/** the name of the DCP */
-	std::string _name;
-	/** the content kind of the CPL */
-	ContentKind _content_kind;
-	/** length in frames */
-	mutable int _length;
-	/** frames per second */
-	int _fps;
-	/** reels */
-	std::list<boost::shared_ptr<const Reel> > _reels;
-
-	/** our UUID */
-	std::string _uuid;
-	/** a SHA1 digest of our XML */
-	mutable std::string _digest;
-};
-
-/** @class DCP dcp.h libdcp/dcp.h
+/** @class DCP
  *  @brief A class to create or read a DCP.
  */
 	
diff --git a/src/wscript b/src/wscript
index 3960f2b0..95092173 100644
--- a/src/wscript
+++ b/src/wscript
@@ -14,6 +14,7 @@ def build(bld):
                  asset_map.cc
                  cpl_file.cc
                  dcp.cc        
+                 cpl.cc
                  dcp_time.cc
                  gamma_lut.cc
                  metadata.cc