In-line run of subs_in_out so that it gets the environment more easily.

[libdcp.git] / src / cpl.h

diff --git a/src/cpl.h b/src/cpl.h
index 43c8a56ebb3f9f19e6e5b120fe01959316a74705..824faaa132217756054a8d5fad66aefe76b985c1 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -43,10 +43,11 @@
 
 #include "asset.h"
 #include "certificate.h"
+#include "content_kind.h"
 #include "key.h"
 #include "language_tag.h"
 #include "rating.h"
-#include "types.h"
+#include "verify.h"
 #include <boost/filesystem.hpp>
 #include <boost/function.hpp>
 #include <boost/optional.hpp>
@@ -60,11 +61,12 @@ struct verify_invalid_language3;
 namespace dcp {
 
 
-class ReelFileAsset;
-class Reel;
-class MXFMetadata;
 class CertificateChain;
 class DecryptedKDM;
+class MXFMetadata;
+class Reel;
+class ReelFileAsset;
+class SoundAsset;
 
 
 /** @class CPL
@@ -81,12 +83,15 @@ class CPL : public Asset
 public:
        CPL (std::string annotation_text, ContentKind content_kind, Standard standard);
 
-       /** Construct a CPL object from a XML file */
-       explicit CPL (boost::filesystem::path file);
+       /** Construct a CPL object from a XML file.
+        *  If notes is not null, non-fatal errors will be added.
+        *  Exceptions will be thrown on non-recoverable errors.
+        */
+       explicit CPL(boost::filesystem::path file, std::vector<dcp::VerificationNote>* notes = nullptr);
 
        bool equals (
                std::shared_ptr<const Asset> other,
-               EqualityOptions options,
+               EqualityOptions const& options,
                NoteHandler note
                ) const override;
 
@@ -95,6 +100,8 @@ public:
         */
        void add (std::shared_ptr<Reel> reel);
 
+       void set (std::vector<std::shared_ptr<Reel>> reels);
+
        /** 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.
@@ -116,14 +123,17 @@ public:
        /** @return true if we have all our encryptable content is encrypted */
        bool all_encrypted () const;
 
-       /** Write an CompositonPlaylist XML file
+       /** Write a CompositionPlaylist XML file
         *
         *  @param file Filename to write
         *  @param signer Signer to sign the CPL, or 0 to add no signature
+        *  @param include_mca_subdescriptors true to add a MCASubDescriptors tag to metadata,
+        *  false to omit it.
         */
        void write_xml (
                boost::filesystem::path file,
-               std::shared_ptr<const CertificateChain>
+               std::shared_ptr<const CertificateChain>,
+               bool include_mca_subdescriptors = true
                ) const;
 
        void resolve_refs (std::vector<std::shared_ptr<Asset>>);
@@ -276,11 +286,11 @@ public:
                _luminance = l;
        }
 
-       boost::optional<std::string> main_sound_configuration () const {
+       boost::optional<dcp::MainSoundConfiguration> main_sound_configuration () const {
                return _main_sound_configuration;
        }
 
-       void set_main_sound_configuration (std::string c) {
+       void set_main_sound_configuration(dcp::MainSoundConfiguration c) {
                _main_sound_configuration = c;
        }
 
@@ -304,9 +314,7 @@ public:
                return _main_picture_active_area;
        }
 
-       void set_main_picture_active_area (dcp::Size s) {
-               _main_picture_active_area = s;
-       }
+       void set_main_picture_active_area(dcp::Size area);
 
        std::vector<std::string> additional_subtitle_languages () const {
                return _additional_subtitle_languages;
@@ -322,10 +330,25 @@ public:
                return _sign_language_video_language;
        }
 
+       void set_dolby_edr_image_transfer_function(std::string function) {
+               _dolby_edr_image_transfer_function = function;
+       }
+
+       boost::optional<std::string> dolby_edr_image_transfer_function() const {
+               return _dolby_edr_image_transfer_function;
+       }
+
        Standard standard () const {
                return _standard;
        }
 
+       /** @return true iff this CPL was read from a file and it contained
+        *  a CompositionMetadataAsset node.
+        */
+       bool read_composition_metadata() const {
+               return _read_composition_metadata;
+       }
+
        static std::string static_pkl_type (Standard standard);
 
 protected:
@@ -335,8 +358,9 @@ protected:
 private:
        friend struct ::verify_invalid_language3;
 
-       void maybe_write_composition_metadata_asset (xmlpp::Element* node) const;
+       void maybe_write_composition_metadata_asset(xmlpp::Element* node, bool include_mca_subdescriptors) const;
        void read_composition_metadata_asset (cxml::ConstNodePtr node);
+       void write_mca_subdescriptors(xmlpp::Element* parent, std::shared_ptr<const SoundAsset> asset) const;
 
        std::string _issuer;
        std::string _creator;
@@ -364,13 +388,15 @@ private:
        boost::optional<std::string> _distributor;
        boost::optional<std::string> _facility;
        boost::optional<Luminance> _luminance;
-       boost::optional<std::string> _main_sound_configuration;
+       boost::optional<MainSoundConfiguration> _main_sound_configuration;
        boost::optional<int> _main_sound_sample_rate;
        boost::optional<dcp::Size> _main_picture_stored_area;
        boost::optional<dcp::Size> _main_picture_active_area;
        /* See note for _release_territory above */
        std::vector<std::string> _additional_subtitle_languages;
        boost::optional<std::string> _sign_language_video_language;
+       boost::optional<std::string> _dolby_edr_image_transfer_function;
+       bool _read_composition_metadata = false;
 
        std::vector<std::shared_ptr<Reel>> _reels;