Rename ReelFileAsset -> ReelEncryptableAsset

[libdcp.git] / src / cpl.h

diff --git a/src/cpl.h b/src/cpl.h
index 316a550458eed8ed6e11ff2b172ec9e8e184976e..586beb818336e4b2810518cd16003d16747e428e 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -33,7 +33,7 @@
 
 
 /** @file  src/cpl.h
- *  @brief CPL class.
+ *  @brief CPL class
  */
 
 
@@ -50,14 +50,16 @@
 #include <boost/function.hpp>
 #include <boost/optional.hpp>
 #include <memory>
-#include <list>
 #include <vector>
 
 
+struct verify_invalid_language3;
+
+
 namespace dcp {
 
 
-class ReelMXF;
+class ReelEncryptableAsset;
 class Reel;
 class MXFMetadata;
 class CertificateChain;
@@ -65,12 +67,14 @@ class DecryptedKDM;
 
 
 /** @class CPL
- *  @brief A Composition Playlist.
+ *  @brief A Composition Playlist
  */
 class CPL : public Asset
 {
 public:
        CPL (std::string annotation_text, ContentKind content_kind);
+
+       /** Construct a CPL object from a XML file */
        explicit CPL (boost::filesystem::path file);
 
        bool equals (
@@ -79,27 +83,45 @@ public:
                NoteHandler note
                ) const;
 
+       /** Add a reel to this CPL
+        *  @param reel Reel to add
+        */
        void add (std::shared_ptr<Reel> reel);
+
+       /** Add a KDM to this CPL.  If the KDM is for any of this CPLs assets it will be used
+        *  to decrypt those assets.
+        *  @param kdm KDM.
+        */
        void add (DecryptedKDM const &);
 
        /** @return the reels in this CPL */
-       std::list<std::shared_ptr<Reel> > reels () const {
+       std::vector<std::shared_ptr<Reel>> reels () const {
                return _reels;
        }
 
-       /** @return the ReelMXFs in this CPL in all reels */
-       std::list<std::shared_ptr<const ReelMXF> > reel_mxfs () const;
-       std::list<std::shared_ptr<ReelMXF> > reel_mxfs ();
+       /** @return the ReelEncryptableAssets in this CPL in all reels */
+       std::vector<std::shared_ptr<const ReelEncryptableAsset>> reel_file_assets () const;
+       std::vector<std::shared_ptr<ReelEncryptableAsset>> reel_file_assets ();
+
+       /** @return true if we have any encrypted content */
+       bool any_encrypted () const;
 
-       bool encrypted () const;
+       /** @return true if we have all our encryptable content is encrypted */
+       bool all_encrypted () const;
 
+       /** Write an CompositonPlaylist XML file
+        *
+        *  @param file Filename to write
+        *  @param standard INTEROP or SMPTE
+        *  @param signer Signer to sign the CPL, or 0 to add no signature
+        */
        void write_xml (
                boost::filesystem::path file,
                Standard standard,
                std::shared_ptr<const CertificateChain>
                ) const;
 
-       void resolve_refs (std::list<std::shared_ptr<Asset> >);
+       void resolve_refs (std::vector<std::shared_ptr<Asset>>);
 
        int64_t duration () const;
 
@@ -115,8 +137,8 @@ public:
                _issue_date = issue_date;
        }
 
-       /** @return contents of the &lt;AnnotationText&gt; node */
-       std::string annotation_text () const {
+       /** @return contents of the &lt;AnnotationText&gt; node, if present */
+       boost::optional<std::string> annotation_text () const {
                return _annotation_text;
        }
 
@@ -133,6 +155,10 @@ public:
                _content_title_text = ct;
        }
 
+       void set_content_kind (dcp::ContentKind k) {
+               _content_kind = k;
+       }
+
        /** @return the type of the content, used by media servers
         *  to categorise things (e.g. feature, trailer, etc.)
         */
@@ -185,12 +211,18 @@ public:
                _release_territory = t.subtag();
        }
 
+       boost::optional<std::string> release_territory_scope () const {
+               return _release_territory_scope;
+       }
+
        boost::optional<int> version_number () const {
                return _version_number;
        }
 
        void set_version_number (int v);
 
+       void unset_version_number ();
+
        boost::optional<Status> status () const {
                return _status;
        }
@@ -280,13 +312,15 @@ protected:
        std::string pkl_type (Standard standard) const;
 
 private:
+       friend struct ::verify_invalid_language3;
+
        void maybe_write_composition_metadata_asset (xmlpp::Element* node) const;
        void read_composition_metadata_asset (cxml::ConstNodePtr node);
 
        std::string _issuer;
        std::string _creator;
        std::string _issue_date;
-       std::string _annotation_text;
+       boost::optional<std::string> _annotation_text;
        std::string _content_title_text;            ///< &lt;ContentTitleText&gt;
        ContentKind _content_kind;                  ///< &lt;ContentKind&gt;
        std::vector<ContentVersion> _content_versions;
@@ -298,6 +332,7 @@ private:
         *  but must be set as a dcp::LanguageTag to try to ensure that we create compliant output.
         */
        boost::optional<std::string> _release_territory;
+       boost::optional<std::string> _release_territory_scope;
        boost::optional<int> _version_number;
        boost::optional<Status> _status;
        boost::optional<std::string> _chain;
@@ -311,7 +346,7 @@ private:
        /* See note for _release_territory above */
        std::vector<std::string> _additional_subtitle_languages;
 
-       std::list<std::shared_ptr<Reel> > _reels;
+       std::vector<std::shared_ptr<Reel>> _reels;
 
        /** Standard of CPL that was read in */
        boost::optional<Standard> _standard;