Use vector for the Ratings list.

[libdcp.git] / src / dcp.h

diff --git a/src/dcp.h b/src/dcp.h
index 2f297d822cf098d755dfb6309afab2ef03ec6067..8b5bd746fc991de11ea87853b5298afbe902dfcf 100644 (file)
--- a/src/dcp.h
+++ b/src/dcp.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -38,10 +38,14 @@
 #ifndef LIBDCP_DCP_H
 #define LIBDCP_DCP_H
 
+#include "compose.hpp"
 #include "types.h"
+#include "util.h"
 #include "certificate.h"
 #include "metadata.h"
 #include "name_format.h"
+#include "verify.h"
+#include "version.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
 #include <string>
@@ -56,14 +60,14 @@ namespace xmlpp {
 namespace dcp
 {
 
+class PKL;
 class Content;
 class Reel;
 class CPL;
-class XMLMetadata;
 class CertificateChain;
 class DecryptedKDM;
 class Asset;
-class DCPReadError;
+class ReadError;
 
 /** @class DCP
  *  @brief A class to create or read a DCP.
@@ -81,16 +85,13 @@ public:
         */
        explicit DCP (boost::filesystem::path directory);
 
-       typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
-
        /** Read the DCP's structure into this object.
-        *  @param keep_going true to try to keep going in the face of (some) errors.
-        *  @param errors List of errors that will be added to if keep_going is true.
+        *  @param notes List of notes that will be added to if non-0.
         *  @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
         *  as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
         *  have an incorrect descriptor in their MXF.
         */
-       void read (bool keep_going = false, ReadErrors* errors = 0, bool ignore_incorrect_picture_mxf_type = false);
+       void read (std::list<VerificationNote>* notes = 0, bool ignore_incorrect_picture_mxf_type = false);
 
        /** Compare this DCP with another, according to various options.
         *  @param other DCP to compare this one to.
@@ -103,7 +104,7 @@ public:
        void add (boost::shared_ptr<CPL> cpl);
 
        std::list<boost::shared_ptr<CPL> > cpls () const;
-       std::list<boost::shared_ptr<Asset> > assets () const;
+       std::list<boost::shared_ptr<Asset> > assets (bool ignore_unresolved = false) const;
 
        bool encrypted () const;
 
@@ -111,9 +112,12 @@ public:
 
        void write_xml (
                Standard standard,
-               XMLMetadata metadata = XMLMetadata (),
+               std::string issuer = String::compose("libdcp %1", dcp::version),
+               std::string creator = String::compose("libdcp %1", dcp::version),
+               std::string issue_date = LocalTime().as_string(),
+               std::string annotation_text = String::compose("Created by libdcp %1", dcp::version),
                boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> (),
-               NameFormat name_format = NameFormat("%t_%i")
+               NameFormat name_format = NameFormat("%t")
        );
 
        void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
@@ -123,18 +127,24 @@ public:
                return _standard;
        }
 
-private:
+       boost::filesystem::path directory () const {
+               return _directory;
+       }
 
-       /** Write the PKL file.
-        *  @param pkl_uuid UUID to use.
+       /** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it.
+        *  If neither is true, this method returns an empty list.
         */
-       boost::filesystem::path write_pkl (
-               std::string file,
-               Standard standard,
-               std::string pkl_uuid,
-               XMLMetadata metadata,
-               boost::shared_ptr<const CertificateChain> signer
-               ) const;
+       std::list<boost::shared_ptr<PKL> > pkls () const {
+               return _pkls;
+       }
+
+       boost::optional<boost::filesystem::path> asset_map_path () {
+               return _asset_map;
+       }
+
+       static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
+
+private:
 
        void write_volindex (Standard standard) const;
 
@@ -142,12 +152,19 @@ private:
         *  @param pkl_uuid UUID of our PKL.
         *  @param pkl_path Pathname of our PKL file.
         */
-       void write_assetmap (Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const;
+       void write_assetmap (
+               Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path,
+               std::string issuer, std::string creator, std::string issue_date, std::string annotation_text
+               ) const;
 
-       /** the directory that we are writing to */
+       /** The directory that we are writing to */
        boost::filesystem::path _directory;
-       /** the CPLs that make up this DCP */
+       /** The CPLs that make up this DCP */
        std::list<boost::shared_ptr<CPL> > _cpls;
+       /** The PKLs that make up this DCP */
+       std::list<boost::shared_ptr<PKL> > _pkls;
+       /** File that the ASSETMAP was read from or last written to */
+       mutable boost::optional<boost::filesystem::path> _asset_map;
 
        /** Standard of DCP that was read in */
        boost::optional<Standard> _standard;