X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.h;h=fe123fd3d3cc5dc38281f89d49cf4da3c8e7918a;hb=273fd9a4f1b43ae0de0071e5efd3b6347b166ff1;hp=91756d3a81abf573b75795a8f1c172f41aed2ded;hpb=452144160eb864984121d3fa883a12d40fbf7e47;p=libdcp.git diff --git a/src/cpl.h b/src/cpl.h index 91756d3a..fe123fd3 100644 --- a/src/cpl.h +++ b/src/cpl.h @@ -1,7 +1,7 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This program is free software; you -can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. @@ -17,45 +17,70 @@ */ +/** @file src/cpl.h + * @brief CPL class. + */ + #ifndef LIBDCP_CPL_H #define LIBDCP_CPL_H -#include +#include "types.h" +#include "certificate.h" +#include "key.h" +#include "asset.h" +#include "metadata.h" +#include #include #include -#include #include #include -#include -#include "types.h" -#include "certificates.h" +#include -namespace libdcp { +namespace dcp { -namespace parse { - class AssetMap; - class AssetMapAsset; -} - -class Asset; +class ReelAsset; class Reel; class XMLMetadata; class MXFMetadata; -class Signer; -class KDM; - -/** @brief A CPL within a DCP */ -class CPL +class CertificateChain; +class DecryptedKDM; + +/** @class CPL + * @brief A Composition Playlist. + */ +class CPL : public Asset { public: - CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second); - CPL (std::string directory, std::string file, std::list asset_maps, bool require_mxfs = true); - - void add_reel (boost::shared_ptr reel); - - /** @return the length in frames */ - int length () const { - return _length; + CPL (std::string annotation_text, ContentKind content_kind); + CPL (boost::filesystem::path file); + + bool equals ( + boost::shared_ptr other, + EqualityOptions options, + NoteHandler note + ) const; + + void add (boost::shared_ptr reel); + void add (DecryptedKDM const &); + + /** @return contents of the <AnnotationText> node */ + std::string annotation_text () const { + return _annotation_text; + } + + /** @return contents of the <ContentTitleText> node */ + std::string content_title_text () const { + return _content_title_text; + } + + /** @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; } /** @return the type of the content, used by media servers @@ -65,75 +90,44 @@ public: return _content_kind; } + /** @return the reels in this CPL */ std::list > reels () const { return _reels; } - /** @return the CPL's name, as will be presented on projector - * media servers and theatre management systems. + /** @return the ReelAssets in this CPL in all reels. */ - std::string name () const { - return _name; - } - - /** @return the number of frames per second */ - int frames_per_second () const { - return _fps; - } - - std::list > assets () const; + std::list > reel_assets () const; bool encrypted () const; - std::string id () const { - return _id; + void set_metadata (XMLMetadata m) { + _metadata = m; } - - bool equals (CPL const & other, EqualityOptions options, boost::function note) const; - - void write_xml (bool, XMLMetadata const &, boost::shared_ptr) const; - void write_to_assetmap (xmlpp::Node *) const; - void write_to_pkl (xmlpp::Node *) const; - - /** Make a KDM for this CPL. - * @param signer Details of the certificates and private key to sign the KDM with. - * @param recipient_cert The certificate of the projector that this KDM is targeted at. This will contain the - * projector's public key which is used to encrypt the content keys. - * @param from Time that the KDM should be valid from. - * @param until Time that the KDM should be valid until. - * @param interop true to generate an interop KDM, false for SMPTE. - */ - boost::shared_ptr make_kdm ( - boost::shared_ptr signer, - boost::shared_ptr recipient_cert, - boost::posix_time::ptime from, - boost::posix_time::ptime until, - bool interop, - MXFMetadata const &, - XMLMetadata const & + + void write_xml ( + boost::filesystem::path file, + Standard standard, + boost::shared_ptr ) const; - void add_kdm (KDM const &); - + void resolve_refs (std::list >); + +protected: + /** @return type string for PKLs for this asset */ + std::string pkl_type (Standard standard) const; + private: - std::pair > asset_from_id (std::list, std::string id) const; - - std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content kind of the CPL */ - ContentKind _content_kind; - /** length in frames */ - mutable int _length; - /** frames per second */ - int _fps; - /** reels */ + std::string _annotation_text; ///< <AnnotationText> + /** <Issuer>, <Creator> and <IssueDate>. These are grouped + * because they occur together in a few places. + */ + XMLMetadata _metadata; + 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 > _reels; - - /** our UUID */ - std::string _id; - /** a SHA1 digest of our XML */ - mutable std::string _digest; }; }