/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
- 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.
*/
-#include <list>
-#include <boost/shared_ptr.hpp>
-#include <boost/function.hpp>
-#include <boost/date_time/posix_time/posix_time.hpp>
-#include <libxml++/libxml++.h>
+/** @file src/cpl.h
+ * @brief CPL class.
+ */
+
+#ifndef LIBDCP_CPL_H
+#define LIBDCP_CPL_H
+
#include "types.h"
#include "certificates.h"
+#include "key.h"
+#include "asset.h"
+#include "metadata.h"
+#include <libxml++/libxml++.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <list>
-namespace libdcp {
-
-namespace parse {
- class AssetMap;
-}
+namespace dcp {
-class Asset;
+class ReelAsset;
class Reel;
class XMLMetadata;
class MXFMetadata;
-class Encryption;
+class Signer;
+class DecryptedKDM;
-/** @brief A CPL within a DCP */
-class CPL
+/** @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, boost::shared_ptr<const parse::AssetMap> asset_map, bool require_mxfs = true);
+ CPL (std::string annotation_text, ContentKind content_kind);
+ CPL (boost::filesystem::path file);
+
+ bool equals (
+ CPL const & other,
+ EqualityOptions options,
+ boost::function<void (NoteType, std::string)> note
+ ) const;
+
+ void add (boost::shared_ptr<Reel> reel);
+ void add (DecryptedKDM const &);
- void add_reel (boost::shared_ptr<const Reel> reel);
+ /** @return contents of the <AnnotationText> node */
+ std::string annotation_text () const {
+ return _annotation_text;
+ }
- /** @return the length in frames */
- int length () const {
- return _length;
+ /** @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
* to categorise things (e.g. feature, trailer, etc.)
*/
return _content_kind;
}
- std::list<boost::shared_ptr<const Reel> > reels () const {
+ /** @return the reels in this CPL */
+ std::list<boost::shared_ptr<Reel> > 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;
- }
+ std::list<boost::shared_ptr<const ReelAsset> > reel_assets () const;
- /** @return the number of frames per second */
- int frames_per_second () const {
- return _fps;
- }
+ bool encrypted () const;
- std::list<boost::shared_ptr<const Asset> > assets () const;
+ void set_metadata (XMLMetadata m) {
+ _metadata = m;
+ }
- bool encrypted () const;
-
- bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
-
- void write_xml (XMLMetadata const &, boost::shared_ptr<Encryption>) const;
- void write_to_assetmap (xmlpp::Node *) const;
- void write_to_pkl (xmlpp::Node *) const;
-
- boost::shared_ptr<xmlpp::Document> make_kdm (
- CertificateChain const &,
- std::string const &,
- boost::shared_ptr<const Certificate>,
- boost::posix_time::ptime from,
- boost::posix_time::ptime until,
- MXFMetadata const &,
- XMLMetadata const &
+ void write_xml (
+ boost::filesystem::path file,
+ Standard standard,
+ boost::shared_ptr<const Signer>
) const;
-
+
+ void resolve_refs (std::list<boost::shared_ptr<Object> >);
+
+protected:
+ /** @return type string for PKLs for this asset */
+ std::string pkl_type (Standard standard) const;
+
private:
- 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::list<boost::shared_ptr<const Reel> > _reels;
-
- /** our UUID */
- std::string _uuid;
- /** a SHA1 digest of our XML */
- mutable std::string _digest;
+ 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<boost::shared_ptr<Reel> > _reels;
};
}
+
+#endif