X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.h;h=bcc1f06bd9ebb81bc4acc420ca7b2bac9c6c345f;hb=9f75a44df591954519ac828a1b50b6d5ebd2a3a1;hp=abfb92f617fdf582a2df4710482b728b2bb4ce93;hpb=0703842433013ac1d5f79c09d7a8361dc2e565c8;p=libdcp.git diff --git a/src/cpl.h b/src/cpl.h index abfb92f6..bcc1f06b 100644 --- a/src/cpl.h +++ b/src/cpl.h @@ -1,65 +1,107 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2014 Carl Hetherington - 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 . + + 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 +#include "types.h" +#include "certificate.h" +#include "key.h" +#include "asset.h" +#include "metadata.h" #include #include -#include #include #include -#include -#include "types.h" -#include "certificates.h" -#include "key.h" -#include "asset.h" +#include namespace dcp { -namespace parse { - class AssetMap; - class AssetMapAsset; -} - -class Content; +class ReelAsset; class Reel; class XMLMetadata; class MXFMetadata; -class Signer; -class KDM; - +class CertificateChain; +class DecryptedKDM; + /** @class CPL * @brief A Composition Playlist. */ class CPL : public Asset { public: - CPL (boost::filesystem::path directory, std::string name, ContentKind content_kind, int length, int frames_per_second); - CPL (boost::filesystem::path, 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); + explicit 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 _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 @@ -69,53 +111,54 @@ 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; - } + std::list > 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 > assets () const; + void write_xml ( + boost::filesystem::path file, + Standard standard, + boost::shared_ptr + ) const; - bool encrypted () const; + void resolve_refs (std::list >); - void set_mxf_keys (Key); + int64_t duration () const; - 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; + boost::optional 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; - void add_kdm (KDM const &); - private: - std::pair > asset_from_id (std::list, std::string id) const; - - boost::filesystem::path _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 > _reels; - /** a SHA1 digest of our XML */ - mutable std::string _digest; + /** Standard of CPL that was read in */ + boost::optional _standard; }; }