Ignore missing asset errors.

[libdcp.git] / src / cpl.h

diff --git a/src/cpl.h b/src/cpl.h
index 0abff749bdc0ef8966feb2136c7182460838e31c..75b9d701c7ee5ae6cf14bf238cf3c2a520cca274 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -1,5 +1,5 @@
 /*
-    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
     it under the terms of the GNU General Public License as published by
@@ -17,32 +17,68 @@
 
 */
 
-#include <list>
+#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 "types.h"
-
-namespace libdcp {
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <list>
 
-class AssetMap;
-class Asset;
+namespace dcp {
+       
+class Content;
 class Reel;
 class XMLMetadata;
-
-/** @brief A CPL within a DCP */
-class CPL
+class MXFMetadata;
+class Signer;
+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, boost::shared_ptr<const 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_reel (boost::shared_ptr<const Reel> reel);
+       void add (boost::shared_ptr<Reel> reel);
+       void add (DecryptedKDM const &);
+
+       /** @return contents of the &lt;AnnotationText&gt; node */
+       std::string annotation_text () const {
+               return _annotation_text;
+       }
        
-       /** @return the length in frames */
-       int length () const {
-               return _length;
+       /** @return contents of the &lt;ContentTitleText&gt; node */
+       std::string content_title_text () const {
+               return _content_title_text;
+       }
+
+       /** @return contents of the &lt;Id&gt; node within &lt;ContentVersion&gt; */
+       void set_content_version_id (std::string id) {
+               _content_version_id = id;
        }
 
+       /** @return contents of the &lt;LabelText&gt; node within &lt;ContentVersion&gt; */
+       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.)
         */
@@ -50,47 +86,48 @@ public:
                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 Content in this CPL across all its reels
+        *  (Content is picture, sound and subtitles)
         */
-       std::string name () const {
-               return _name;
-       }
+       std::list<boost::shared_ptr<const Content> > content () const;
 
-       /** @return the number of frames per second */
-       int frames_per_second () const {
-               return _fps;
+       bool encrypted () const;
+
+       void set_mxf_keys (Key);
+       void set_metadata (XMLMetadata m) {
+               _metadata = m;
        }
 
-       std::list<boost::shared_ptr<const Asset> > assets () const;
-       
-       bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
-       
-       void write_xml (XMLMetadata const &) const;
-       void write_to_assetmap (std::ostream& s) const;
-       void write_to_pkl (std::ostream& s) 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;               ///< &lt;AnnotationText&gt;
+       /** &lt;Issuer&gt;, &lt;Creator&gt; and &lt;IssueDate&gt;.  These are grouped
+        *  because they occur together in a few places.
+        */
+       XMLMetadata _metadata;
+       std::string _content_title_text;            ///< &lt;ContentTitleText&gt;
+       ContentKind _content_kind;                  ///< &lt;ContentKind&gt;
+       std::string _content_version_id;            ///< &lt;Id&gt; in &lt;ContentVersion&gt;
+       std::string _content_version_label_text;    ///< &lt;LabelText&gt; in &lt;ContentVersion&gt;
+       std::list<boost::shared_ptr<Reel> > _reels;
 };
 
 }
+
+#endif