/*
- Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
files in the program, then also delete it here.
*/
+
/** @file src/cpl.h
- * @brief CPL class.
+ * @brief CPL class
*/
+
#ifndef LIBDCP_CPL_H
#define LIBDCP_CPL_H
-#include "types.h"
+
+#include "asset.h"
#include "certificate.h"
#include "key.h"
-#include "asset.h"
-#include "metadata.h"
-#include <boost/shared_ptr.hpp>
+#include "language_tag.h"
+#include "types.h"
+#include <boost/filesystem.hpp>
#include <boost/function.hpp>
#include <boost/optional.hpp>
-#include <boost/filesystem.hpp>
-#include <list>
+#include <memory>
+#include <vector>
+
+
+struct verify_invalid_language3;
+
namespace dcp {
-class ReelAsset;
+
+class ReelFileAsset;
class Reel;
-class XMLMetadata;
class MXFMetadata;
class CertificateChain;
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<const Asset> other,
+ std::shared_ptr<const Asset> other,
EqualityOptions options,
NoteHandler note
) const;
- void add (boost::shared_ptr<Reel> reel);
+ /** 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 contents of the <AnnotationText> node */
- std::string annotation_text () const {
- return _metadata.annotation_text;
+ /** @return the reels in this CPL */
+ std::vector<std::shared_ptr<Reel>> reels () const {
+ return _reels;
+ }
+
+ /** @return the ReelFileAssets in this CPL in all reels */
+ std::vector<std::shared_ptr<const ReelFileAsset>> reel_file_assets () const;
+ std::vector<std::shared_ptr<ReelFileAsset>> reel_file_assets ();
+
+ /** @return true if we have any encrypted content */
+ bool any_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::vector<std::shared_ptr<Asset>>);
+
+ int64_t duration () const;
+
+ void set_issuer (std::string issuer) {
+ _issuer = issuer;
+ }
+
+ void set_creator (std::string creator) {
+ _creator = creator;
+ }
+
+ void set_issue_date (std::string issue_date) {
+ _issue_date = issue_date;
+ }
+
+ /** @return contents of the <AnnotationText> node, if present */
+ boost::optional<std::string> annotation_text () const {
+ return _annotation_text;
}
void set_annotation_text (std::string at) {
- _metadata.annotation_text = at;
+ _annotation_text = at;
}
/** @return contents of the <ContentTitleText> node */
_content_title_text = ct;
}
- /** @return contents of the <Id> node within <ContentVersion> */
- void set_content_version_id (std::string id) {
- _content_version_id = id;
- }
-
- /** @return contents of the <LabelText> node within <ContentVersion> */
- void set_content_version_label_text (std::string text) {
- _content_version_label_text = text;
+ void set_content_kind (dcp::ContentKind k) {
+ _content_kind = k;
}
/** @return the type of the content, used by media servers
return _content_kind;
}
- /** @return the reels in this CPL */
- std::list<boost::shared_ptr<Reel> > reels () const {
- return _reels;
+ boost::optional<ContentVersion> content_version () const;
+
+ std::vector<ContentVersion> content_versions () const {
+ return _content_versions;
}
- /** @return the ReelAssets in this CPL in all reels.
- */
- std::list<boost::shared_ptr<const ReelAsset> > reel_assets () const;
+ void set_content_version (ContentVersion v) {
+ _content_versions.clear ();
+ _content_versions.push_back (v);
+ }
- bool encrypted () const;
+ void set_content_versions (std::vector<ContentVersion> v);
- void set_metadata (XMLMetadata m) {
- _metadata = m;
+ std::vector<Rating> ratings () const {
+ return _ratings;
}
- void write_xml (
- boost::filesystem::path file,
- Standard standard,
- boost::shared_ptr<const CertificateChain>
- ) const;
+ void set_ratings (std::vector<Rating> r) {
+ _ratings = r;
+ }
- void resolve_refs (std::list<boost::shared_ptr<Asset> >);
+ boost::optional<std::string> full_content_title_text () const {
+ return _full_content_title_text;
+ }
- int64_t duration () const;
+ void set_full_content_title_text (std::string t) {
+ _full_content_title_text = t;
+ }
+
+ boost::optional<std::string> 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<std::string> release_territory () const {
+ return _release_territory;
+ }
+
+ void set_release_territory (dcp::LanguageTag::RegionSubtag t) {
+ _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;
+ }
+
+ void set_status (Status s) {
+ _status = s;
+ }
+
+ boost::optional<std::string> chain () const {
+ return _chain;
+ }
+
+ void set_chain (std::string c) {
+ _chain = c;
+ }
+
+ boost::optional<std::string> distributor () const {
+ return _distributor;
+ }
+
+ void set_distributor (std::string d) {
+ _distributor = d;
+ }
+
+ boost::optional<std::string> facility () const {
+ return _facility;
+ }
+
+ void set_facility (std::string f) {
+ _facility = f;
+ }
+
+ boost::optional<Luminance> luminance () const {
+ return _luminance;
+ }
+
+ void set_luminance (Luminance l) {
+ _luminance = l;
+ }
+
+ boost::optional<std::string> main_sound_configuration () const {
+ return _main_sound_configuration;
+ }
+
+ void set_main_sound_configuration (std::string c) {
+ _main_sound_configuration = c;
+ }
+
+ boost::optional<int> 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<dcp::Size> 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<dcp::Size> 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<std::string> additional_subtitle_languages () const {
+ return _additional_subtitle_languages;
+ }
+
+ void set_additional_subtitle_languages (std::vector<dcp::LanguageTag> const& lang);
boost::optional<Standard> standard () const {
return _standard;
}
+ static std::string static_pkl_type (Standard standard);
+
protected:
/** @return type string for PKLs for this asset */
std::string pkl_type (Standard standard) const;
private:
- /** <Issuer>, <Creator>, <IssueDate> and <AnnotationText>.
- * These are grouped because they occur together in a few places.
- */
- XMLMetadata _metadata;
+ 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;
+ boost::optional<std::string> _annotation_text;
std::string _content_title_text; ///< <ContentTitleText>
ContentKind _content_kind; ///< <ContentKind>
- std::string _content_version_id; ///< <Id> in <ContentVersion>
- std::string _content_version_label_text; ///< <LabelText> in <ContentVersion>
- std::list<boost::shared_ptr<Reel> > _reels;
+ std::vector<ContentVersion> _content_versions;
+ std::vector<Rating> _ratings;
+ /** Human-readable name of the composition, without any metadata (i.e. no -FTR-EN-XX- etc.) */
+ boost::optional<std::string> _full_content_title_text;
+ boost::optional<std::string> _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<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;
+ boost::optional<std::string> _distributor;
+ boost::optional<std::string> _facility;
+ boost::optional<Luminance> _luminance;
+ boost::optional<std::string> _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;
+
+ std::vector<std::shared_ptr<Reel>> _reels;
/** Standard of CPL that was read in */
boost::optional<Standard> _standard;
};
+
}
+
#endif
projects / libdcp.git / blobdiff