/*
- 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 file is part of libdcp.
+
+ libdcp 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.
- This program is distributed in the hope that it will be useful,
+ libdcp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+ along with libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
*/
+/** @file src/cpl.h
+ * @brief CPL class.
+ */
+
#ifndef LIBDCP_CPL_H
#define LIBDCP_CPL_H
-#include <list>
+#include "types.h"
+#include "certificate.h"
+#include "key.h"
+#include "asset.h"
+#include "metadata.h"
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
-#include <boost/date_time/posix_time/posix_time.hpp>
-#include <libxml++/libxml++.h>
-#include "types.h"
-#include "certificates.h"
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <list>
-namespace libdcp {
+namespace dcp {
-namespace parse {
- class AssetMap;
- class AssetMapAsset;
-}
-
-class Asset;
+class ReelAsset;
class Reel;
class XMLMetadata;
class MXFMetadata;
-class Encryption;
-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<boost::shared_ptr<const parse::AssetMap> > asset_maps, bool require_mxfs = true);
-
- void add_reel (boost::shared_ptr<Reel> reel);
-
- /** @return the length in frames */
- int length () const {
- return _length;
+ CPL (std::string annotation_text, ContentKind content_kind);
+ explicit CPL (boost::filesystem::path file);
+
+ bool equals (
+ boost::shared_ptr<const Asset> other,
+ EqualityOptions options,
+ NoteHandler note
+ ) const;
+
+ void add (boost::shared_ptr<Reel> reel);
+ void add (DecryptedKDM const &);
+
+ /** @return contents of the <AnnotationText> node */
+ std::string annotation_text () const {
+ return _metadata.annotation_text;
+ }
+
+ void set_annotation_text (std::string at) {
+ _metadata.annotation_text = at;
+ }
+
+ /** @return contents of the <ContentTitleText> node */
+ std::string content_title_text () const {
+ return _content_title_text;
+ }
+
+ void set_content_title_text (std::string ct) {
+ _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;
}
/** @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;
}
- /** @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;
+
+ bool encrypted () const;
- /** @return the number of frames per second */
- int frames_per_second () const {
- return _fps;
+ void set_metadata (XMLMetadata m) {
+ _metadata = m;
}
- std::list<boost::shared_ptr<const Asset> > assets () const;
+ void write_xml (
+ boost::filesystem::path file,
+ Standard standard,
+ boost::shared_ptr<const CertificateChain>
+ ) const;
+
+ void resolve_refs (std::list<boost::shared_ptr<Asset> >);
- bool encrypted () const;
+ int64_t duration () const;
- std::string id () const {
- return _id;
+ boost::optional<Standard> standard () const {
+ return _standard;
}
-
- bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
-
- void write_xml (bool, 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,
- bool,
- MXFMetadata const &,
- XMLMetadata const &
- ) const;
- void add_kdm (KDM const &);
-
+ 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:
- boost::shared_ptr<parse::AssetMapAsset> asset_from_id (std::list<boost::shared_ptr<const parse::AssetMap> > asset_maps, 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 */
+ /** <Issuer>, <Creator>, <IssueDate> and <AnnotationText>.
+ * 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;
- /** our UUID */
- std::string _id;
- /** a SHA1 digest of our XML */
- mutable std::string _digest;
+ /** Standard of CPL that was read in */
+ boost::optional<Standard> _standard;
};
}
projects / libdcp.git / blobdiff