X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.h;h=70f306bfba4987f415ddb1d57cca5f25f6d3d4b7;hb=4c1a8e66f754d26e3db9c4c651e19ff4b6a94bb9;hp=8458a028c022be17ab2e663b922b1afcfee53b93;hpb=ac265d3d008328b9bdaf00c39ebcd86f263605c7;p=libdcp.git diff --git a/src/cpl.h b/src/cpl.h index 8458a028..70f306bf 100644 --- a/src/cpl.h +++ b/src/cpl.h @@ -1,47 +1,63 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2019 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 "types.h" -#include "certificates.h" +#include "certificate.h" #include "key.h" #include "asset.h" #include "metadata.h" -#include #include #include -#include #include #include #include namespace dcp { - -class Content; + +class ReelMXF; class Reel; class XMLMetadata; class MXFMetadata; -class Signer; -class KDM; - +class CertificateChain; +class DecryptedKDM; + /** @class CPL * @brief A Composition Playlist. */ @@ -49,27 +65,35 @@ class CPL : public Asset { public: CPL (std::string annotation_text, ContentKind content_kind); - CPL (boost::filesystem::path file); + explicit CPL (boost::filesystem::path file); bool equals ( - CPL const & other, + boost::shared_ptr other, EqualityOptions options, - boost::function note + NoteHandler note ) const; void add (boost::shared_ptr reel); - void add (KDM const &); + void add (DecryptedKDM const &); /** @return contents of the <AnnotationText> node */ std::string annotation_text () const { - return _annotation_text; + 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; @@ -79,7 +103,7 @@ public: 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.) */ @@ -92,31 +116,48 @@ public: return _reels; } - /** @return the Content in this CPL across all its reels - * (Content is picture, sound and subtitles) + /** @return the ReelMXFs in this CPL in all reels. */ - std::list > content () const; + std::list > reel_mxfs () const; + std::list > reel_mxfs (); bool encrypted () const; - void set_mxf_keys (Key); + void set_metadata (XMLMetadata m) { + _metadata = m; + } void write_xml ( boost::filesystem::path file, Standard standard, - boost::shared_ptr + boost::shared_ptr ) const; - void resolve_refs (std::list >); + void resolve_refs (std::list >); + + int64_t duration () const; + + boost::optional standard () const { + return _standard; + } + + std::list ratings () const { + return _ratings; + } + + void set_ratings (std::list r) { + _ratings = r; + } + + 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: - std::string _annotation_text; ///< <AnnotationText> - /** <Issuer>, <Creator> and <IssueDate>. These are grouped - * because they occur together in a few places. + /** <Issuer>, <Creator>, <IssueDate> and <AnnotationText>. + * These are grouped because they occur together in a few places. */ XMLMetadata _metadata; std::string _content_title_text; ///< <ContentTitleText> @@ -124,6 +165,10 @@ private: std::string _content_version_id; ///< <Id> in <ContentVersion> std::string _content_version_label_text; ///< <LabelText> in <ContentVersion> std::list > _reels; + std::list _ratings; + + /** Standard of CPL that was read in */ + boost::optional _standard; }; }