X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.h;h=586beb818336e4b2810518cd16003d16747e428e;hb=093525165f6397ba9eaffd19833dc978bcb32d55;hp=b7055e5d7beebc94219f51205196cc8620626ace;hpb=a0e7285ae99ca4630a8096884f05ad4e1b3fc204;p=libdcp.git diff --git a/src/cpl.h b/src/cpl.h index b7055e5d..586beb81 100644 --- a/src/cpl.h +++ b/src/cpl.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2014-2020 Carl Hetherington + Copyright (C) 2014-2021 Carl Hetherington This file is part of libdcp. @@ -33,7 +33,7 @@ /** @file src/cpl.h - * @brief CPL class. + * @brief CPL class */ @@ -44,18 +44,22 @@ #include "asset.h" #include "certificate.h" #include "key.h" +#include "language_tag.h" #include "types.h" #include #include #include -#include -#include +#include +#include + + +struct verify_invalid_language3; namespace dcp { -class ReelMXF; +class ReelEncryptableAsset; class Reel; class MXFMetadata; class CertificateChain; @@ -63,41 +67,61 @@ 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 ( - boost::shared_ptr other, + std::shared_ptr other, EqualityOptions options, NoteHandler note ) const; - void add (boost::shared_ptr reel); + /** Add a reel to this CPL + * @param reel Reel to add + */ + void add (std::shared_ptr 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 > reels () const { + std::vector> reels () const { return _reels; } - /** @return the ReelMXFs in this CPL in all reels */ - std::list > reel_mxfs () const; - std::list > reel_mxfs (); + /** @return the ReelEncryptableAssets in this CPL in all reels */ + std::vector> reel_file_assets () const; + std::vector> 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, - boost::shared_ptr + std::shared_ptr ) const; - void resolve_refs (std::list >); + void resolve_refs (std::vector>); int64_t duration () const; @@ -113,8 +137,8 @@ public: _issue_date = issue_date; } - /** @return contents of the <AnnotationText> node */ - std::string annotation_text () const { + /** @return contents of the <AnnotationText> node, if present */ + boost::optional annotation_text () const { return _annotation_text; } @@ -131,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.) */ @@ -138,23 +166,141 @@ public: return _content_kind; } - ContentVersion content_version () const { - return _content_version; + boost::optional content_version () const; + + std::vector content_versions () const { + return _content_versions; } - /** Set the contents of the ContentVersion tag */ void set_content_version (ContentVersion v) { - _content_version = v; + _content_versions.clear (); + _content_versions.push_back (v); } - std::list ratings () const { + void set_content_versions (std::vector v); + + std::vector ratings () const { return _ratings; } - void set_ratings (std::list r) { + void set_ratings (std::vector r) { _ratings = r; } + boost::optional full_content_title_text () const { + return _full_content_title_text; + } + + void set_full_content_title_text (std::string t) { + _full_content_title_text = t; + } + + boost::optional full_content_title_text_language () const { + return _full_content_title_text_language; + } + + void set_full_content_title_text_language (dcp::LanguageTag l) { + _full_content_title_text_language = l.to_string(); + } + + boost::optional release_territory () const { + return _release_territory; + } + + void set_release_territory (dcp::LanguageTag::RegionSubtag t) { + _release_territory = t.subtag(); + } + + boost::optional release_territory_scope () const { + return _release_territory_scope; + } + + boost::optional version_number () const { + return _version_number; + } + + void set_version_number (int v); + + void unset_version_number (); + + boost::optional status () const { + return _status; + } + + void set_status (Status s) { + _status = s; + } + + boost::optional chain () const { + return _chain; + } + + void set_chain (std::string c) { + _chain = c; + } + + boost::optional distributor () const { + return _distributor; + } + + void set_distributor (std::string d) { + _distributor = d; + } + + boost::optional facility () const { + return _facility; + } + + void set_facility (std::string f) { + _facility = f; + } + + boost::optional luminance () const { + return _luminance; + } + + void set_luminance (Luminance l) { + _luminance = l; + } + + boost::optional main_sound_configuration () const { + return _main_sound_configuration; + } + + void set_main_sound_configuration (std::string c) { + _main_sound_configuration = c; + } + + boost::optional main_sound_sample_rate () const { + return _main_sound_sample_rate; + } + + void set_main_sound_sample_rate (int r) { + _main_sound_sample_rate = r; + } + + boost::optional main_picture_stored_area () const { + return _main_picture_stored_area; + } + + void set_main_picture_stored_area (dcp::Size s) { + _main_picture_stored_area = s; + } + + boost::optional main_picture_active_area () const { + return _main_picture_active_area; + } + + void set_main_picture_active_area (dcp::Size s) { + _main_picture_active_area = s; + } + + std::vector additional_subtitle_languages () const { + return _additional_subtitle_languages; + } + + void set_additional_subtitle_languages (std::vector const& lang); + boost::optional standard () const { return _standard; } @@ -166,16 +312,41 @@ 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 _annotation_text; std::string _content_title_text; ///< <ContentTitleText> ContentKind _content_kind; ///< <ContentKind> - ContentVersion _content_version; ///< <ContentVersion> - std::list _ratings; - - std::list > _reels; + std::vector _content_versions; + std::vector _ratings; + /** Human-readable name of the composition, without any metadata (i.e. no -FTR-EN-XX- etc.) */ + boost::optional _full_content_title_text; + boost::optional _full_content_title_text_language; + /** This is stored and returned as a string so that we can tolerate non-RFC-5646 strings, + * but must be set as a dcp::LanguageTag to try to ensure that we create compliant output. + */ + boost::optional _release_territory; + boost::optional _release_territory_scope; + boost::optional _version_number; + boost::optional _status; + boost::optional _chain; + boost::optional _distributor; + boost::optional _facility; + boost::optional _luminance; + boost::optional _main_sound_configuration; + boost::optional _main_sound_sample_rate; + boost::optional _main_picture_stored_area; + boost::optional _main_picture_active_area; + /* See note for _release_territory above */ + std::vector _additional_subtitle_languages; + + std::vector> _reels; /** Standard of CPL that was read in */ boost::optional _standard;