Bump version
[libdcp.git] / src / dcp.h
index 9e2e8a027df4e2f6bd60fe298f5c436c5d2f3759..635a972d65a07c3e961abaacd21741effb043a02 100644 (file)
--- a/src/dcp.h
+++ b/src/dcp.h
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
 #include "types.h"
+#include "certificates.h"
 
 namespace xmlpp {
-       class Node;
+       class Document;
+       class Element;
 }
 
 /** @brief Namespace for everything in libdcp */
@@ -43,77 +45,20 @@ class PictureAsset;
 class SoundAsset;
 class SubtitleAsset;
 class Reel;
-class AssetMap;
+class CPL;
+class XMLMetadata;
+class Signer;
+class KDM;
 
-/** @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;
-};
+namespace parse {
+       class AssetMap;
+}
 
-/** @class DCP dcp.h libdcp/dcp.h
+/** @class DCP
  *  @brief A class to create or read a DCP.
  */
        
-class DCP
+class DCP : public boost::noncopyable
 {
 public:
        /** Construct a DCP.  You can pass an existing DCP's directory
@@ -122,22 +67,23 @@ public:
         *
         *  @param directory Directory containing the DCP's files.
         */
-       DCP (std::string directory);
+       DCP (boost::filesystem::path directory);
 
-       /** Read an existing DCP's data.
+       void read (bool require_mxfs = true);
+
+       /** Read an existing DCP's assets.
         *
         *  The DCP's XML metadata will be examined, and you can then look at the contents
         *  of the DCP.
-        *
-        *  @param require_mxfs true to throw an exception if MXF files are missing; setting to false
-        *  can be useful for testing, but normally it should be set to true.
         */
-       void read (bool require_mxfs = true);
+       void read_assets ();
+
+       void read_cpls (bool require_mxfs = true);
 
        /** Write the required XML files to the directory that was
         *  passed into the constructor.
         */
-       void write_xml () const;
+       void write_xml (bool interop, XMLMetadata const &, boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()) const;
 
        /** Compare this DCP with another, according to various options.
         *  @param other DCP to compare this one to.
@@ -152,10 +98,24 @@ public:
        void add_cpl (boost::shared_ptr<CPL> cpl);
 
        /** @return The list of CPLs in this DCP */
-       std::list<boost::shared_ptr<const CPL> > cpls () const {
+       std::list<boost::shared_ptr<CPL> > cpls () const {
                return _cpls;
        }
 
+       /** Add another DCP as a source of assets for this DCP.  This should be called before
+        *  ::read() on the DCP that needs the extra assets.  For example
+        *
+        *  DCP original_version ("my_dcp_OV");
+        *  DCP supplemental ("my_dcp_VF");
+        *  supplemental.add_assets_from (original_version);
+        *  supplemental.read ();
+        */
+       void add_assets_from (libdcp::DCP const &);
+
+       bool encrypted () const;
+
+       void add_kdm (KDM const &);
+
        /** Emitted with a parameter between 0 and 1 to indicate progress
         *  for long jobs.
         */
@@ -166,7 +126,7 @@ private:
        /** Write the PKL file.
         *  @param pkl_uuid UUID to use.
         */
-       std::string write_pkl (std::string pkl_uuid) const;
+       std::string write_pkl (std::string pkl_uuid, bool, XMLMetadata const &, boost::shared_ptr<const Signer>) const;
        
        /** Write the VOLINDEX file */
        void write_volindex () const;
@@ -175,9 +135,9 @@ private:
         *  @param pkl_uuid UUID of our PKL.
         *  @param pkl_length Length of our PKL in bytes.
         */
-       void write_assetmap (std::string pkl_uuid, int pkl_length) const;
+       void write_assetmap (std::string pkl_uuid, int pkl_length, bool, XMLMetadata const &) const;
 
-       /** @return Assets in all this CPLs in this DCP */
+       /** @return Assets in all the CPLs in this DCP */
        std::list<boost::shared_ptr<const Asset> > assets () const;
 
        struct Files {
@@ -186,10 +146,14 @@ private:
                std::string asset_map;
        };
 
+       Files _files;
+
        /** the directory that we are writing to */
-       std::string _directory;
+       boost::filesystem::path _directory;
        /** our CPLs */
-       std::list<boost::shared_ptr<const CPL> > _cpls;
+       std::list<boost::shared_ptr<CPL> > _cpls;
+
+       std::list<PathAssetMap> _asset_maps;
 };
 
 }