Merge branch 'master' of ssh://carlh.dnsalias.org/home/carl/git/libdcp

[libdcp.git] / src / cpl.h

diff --git a/src/cpl.h b/src/cpl.h
index a0426b96d29a2bddfb7a19772e19c37d25fde740..c91e256a6edf7d24a9e104e53539f535a08bf638 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -1,83 +1,123 @@
-#include <stdint.h>
+/*
+    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 "xml.h"
+#include <boost/function.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
+#include <libxml++/libxml++.h>
+#include "types.h"
+#include "certificates.h"
 
 namespace libdcp {
 
-class MainPicture : public XMLNode
+namespace parse {
+       class AssetMap;
+}
+       
+class Asset;
+class Reel;
+class XMLMetadata;
+class MXFMetadata;
+class Encryption;
+class KDM;
+       
+/** @brief A CPL within a DCP */
+class CPL
 {
 public:
-       MainPicture () {}
-       MainPicture (xmlpp::Node const * node);
-
-       std::string id;
-       std::string annotation_text;
-       Fraction edit_rate;
-       int64_t intrinsic_duration;
-       int64_t entry_point;
-       int64_t duration;
-       Fraction frame_rate;
-       Fraction screen_aspect_ratio;
-};
+       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 parse::AssetMap> asset_map, bool require_mxfs = true);
 
-class MainSound : public XMLNode
-{
-public:
-       MainSound () {}
-       MainSound (xmlpp::Node const * node);
-
-       std::string id;
-       std::string annotation_text;
-       Fraction edit_rate;
-       int64_t intrinsic_duration;
-       int64_t entry_point;
-       int64_t duration;
-};
+       void add_reel (boost::shared_ptr<Reel> reel);
+       
+       /** @return the length in frames */
+       int length () const {
+               return _length;
+       }
 
-class CPLAssetList : public XMLNode
-{
-public:
-       CPLAssetList () {}
-       CPLAssetList (xmlpp::Node const * node);
+       /** @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;
+       }
 
-       boost::shared_ptr<MainPicture> main_picture;
-       boost::shared_ptr<MainSound> main_sound;
-};
+       std::list<boost::shared_ptr<Reel> > reels () const {
+               return _reels;
+       }
 
-class Reel : public XMLNode
-{
-public:
-       Reel () {}
-       Reel (xmlpp::Node const * node);
+       /** @return the CPL's name, as will be presented on projector
+        *  media servers and theatre management systems.
+        */
+       std::string name () const {
+               return _name;
+       }
 
-       std::string id;
-       boost::shared_ptr<CPLAssetList> asset_list;
-};
+       /** @return the number of frames per second */
+       int frames_per_second () const {
+               return _fps;
+       }
 
-class ContentVersion : public XMLNode
-{
-public:
-       ContentVersion () {}
-       ContentVersion (xmlpp::Node const * node);
+       std::list<boost::shared_ptr<const Asset> > assets () const;
 
-       std::string id;
-       std::string label_text;
-};
+       bool encrypted () const;
 
-class CPL : public XMLFile
-{
-public:
-       CPL (std::string file);
-
-       std::string id;
-       std::string annotation_text;
-       std::string issue_date;
-       std::string creator;
-       std::string content_title_text;
-       ContentKind content_kind;
-       boost::shared_ptr<ContentVersion> content_version;
-       std::list<boost::shared_ptr<Reel> > reels;
+       std::string id () const {
+               return _id;
+       }
+       
+       bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
+       
+       void write_xml (XMLMetadata const &, boost::shared_ptr<Encryption>) const;
+       void write_to_assetmap (xmlpp::Node *) const;
+       void write_to_pkl (xmlpp::Node *) const;
+
+       boost::shared_ptr<xmlpp::Document> make_kdm (
+               CertificateChain const &,
+               std::string const &,
+               boost::shared_ptr<const Certificate>,
+               boost::posix_time::ptime from,
+               boost::posix_time::ptime until,
+               MXFMetadata const &,
+               XMLMetadata const &
+               ) const;
+
+       void add_kdm (KDM 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<Reel> > _reels;
+
+       /** our UUID */
+       std::string _id;
+       /** a SHA1 digest of our XML */
+       mutable std::string _digest;
 };
 
 }
-