Various tinkerings.

[libdcp.git] / src / dcp.h

diff --git a/src/dcp.h b/src/dcp.h
index decac4f2c4895dca0055e46ff246779d08eea6fe..9d8a5415cb167fbe0f8a1422620fbd60abe1a419 100644 (file)
--- a/src/dcp.h
+++ b/src/dcp.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 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
@@ -18,39 +18,46 @@
 */
 
 /** @file  src/dcp.h
- *  @brief A class to create a DCP.
+ *  @brief DCP class.
  */
 
 #ifndef LIBDCP_DCP_H
 #define LIBDCP_DCP_H
 
-#include <string>
-#include <vector>
+#include "types.h"
+#include "certificates.h"
+#include "metadata.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
-#include "types.h"
+#include <string>
+#include <vector>
 
 namespace xmlpp {
-       class Node;
+       class Document;
+       class Element;
 }
 
 /** @brief Namespace for everything in libdcp */
-namespace libdcp
+namespace dcp
 {
 
-class Asset;   
-class PictureAsset;
-class SoundAsset;
-class SubtitleAsset;
+class Content; 
 class Reel;
-class AssetMap;
 class CPL;
+class XMLMetadata;
+class Signer;
+class KDM;
+class Asset;
+
+namespace parse {
+       class AssetMap;
+}
 
 /** @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
@@ -59,40 +66,37 @@ public:
         *
         *  @param directory Directory containing the DCP's files.
         */
-       DCP (std::string directory);
-
-       /** Read an existing DCP's data.
-        *
-        *  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);
+       DCP (boost::filesystem::path directory);
 
-       /** Write the required XML files to the directory that was
-        *  passed into the constructor.
-        */
-       void write_xml () const;
+       void read ();
 
        /** Compare this DCP with another, according to various options.
         *  @param other DCP to compare this one to.
         *  @param options Options to define what "equality" means.
+        *  @param note Functor to handle notes made by the equality operation.
         *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
         */
        bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
 
-       /** Add a CPL to this DCP.
-        *  @param cpl CPL to add.
-        */
-       void add_cpl (boost::shared_ptr<CPL> cpl);
+       void add (boost::shared_ptr<Asset> asset);
+
+       std::list<boost::shared_ptr<CPL> > cpls () const;
 
-       /** @return The list of CPLs in this DCP */
-       std::list<boost::shared_ptr<const CPL> > cpls () const {
-               return _cpls;
+       /** @return All this DCP's assets (note that CPLs are assets) */
+       std::list<boost::shared_ptr<Asset> > assets () const {
+               return _assets;
        }
 
+       bool encrypted () const;
+
+       void add (KDM const &);
+
+       void write_xml (
+               Standard standard,
+               XMLMetadata metadata = XMLMetadata (),
+               boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
+       );
+
        /** Emitted with a parameter between 0 and 1 to indicate progress
         *  for long jobs.
         */
@@ -103,30 +107,25 @@ private:
        /** Write the PKL file.
         *  @param pkl_uuid UUID to use.
         */
-       std::string write_pkl (std::string pkl_uuid) const;
+       boost::filesystem::path write_pkl (
+               Standard standard,
+               std::string pkl_uuid,
+               XMLMetadata metadata,
+               boost::shared_ptr<const Signer> signer
+               ) const;
        
-       /** Write the VOLINDEX file */
-       void write_volindex () const;
+       void write_volindex (Standard standard) const;
 
        /** Write the ASSETMAP file.
         *  @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;
-
-       /** @return Assets in all this CPLs in this DCP */
-       std::list<boost::shared_ptr<const Asset> > assets () const;
-
-       struct Files {
-               std::list<std::string> cpls;
-               std::string pkl;
-               std::string asset_map;
-       };
+       void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
 
        /** the directory that we are writing to */
-       std::string _directory;
-       /** our CPLs */
-       std::list<boost::shared_ptr<const CPL> > _cpls;
+       boost::filesystem::path _directory;
+       /** the assets that make up this DCP */
+       std::list<boost::shared_ptr<Asset> > _assets;
 };
 
 }