Remove ReelEncryptableAsset and tidy up a bit.
[libdcp.git] / src / reel_asset.h
index 06db76d584892b90a0c4788d32ab762f290b3247..ab06434ebe5f2f14774def1dc267e4afad623128 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/reel_asset.h
- *  @brief ReelAsset class.
+ *  @brief ReelAsset class
  */
 
+
 #ifndef LIBDCP_REEL_ASSET_H
 #define LIBDCP_REEL_ASSET_H
 
+
 #include "object.h"
 #include "util.h"
 #include "ref.h"
-#include <boost/shared_ptr.hpp>
+#include <memory>
+
 
 namespace cxml {
        class Node;
 }
 
+
 namespace xmlpp {
        class Node;
 }
 
+
 namespace dcp {
 
+
 class Asset;
 
+
 /** @class ReelAsset
  *  @brief An entry in a &lt;Reel&gt; which refers to a use of a piece of content.
  *
@@ -65,21 +73,20 @@ class Asset;
 class ReelAsset : public Object
 {
 public:
-       ReelAsset ();
-       ReelAsset (boost::shared_ptr<Asset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
-       explicit ReelAsset (boost::shared_ptr<const cxml::Node>);
+       /** Construct a ReelAsset
+        *  @param id ID of this ReelAsset (which is that of the MXF, if there is one)
+        *  @param edit_rate Edit rate for the asset
+        *  @param intrinsic_duration Intrinsic duration of this asset
+        *  @param entry_point Entry point to use in that asset
+        */
+       ReelAsset (std::string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
 
-       virtual void write_to_cpl (xmlpp::Node* node, Standard standard) const;
-       virtual bool equals (boost::shared_ptr<const ReelAsset>, EqualityOptions, NoteHandler) const;
+       explicit ReelAsset (std::shared_ptr<const cxml::Node>);
 
-       /** @return a Ref to our actual asset */
-       Ref const & asset_ref () const {
-               return _asset_ref;
-       }
+       virtual xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const;
 
-       /** @return a Ref to our actual asset */
-       Ref & asset_ref () {
-               return _asset_ref;
+       virtual bool encryptable () const {
+               return false;
        }
 
        Fraction edit_rate () const {
@@ -94,7 +101,11 @@ public:
                _entry_point = e;
        }
 
-       int64_t entry_point () const {
+       void unset_entry_point () {
+               _entry_point = boost::none;
+       }
+
+       boost::optional<int64_t> entry_point () const {
                return _entry_point;
        }
 
@@ -102,33 +113,29 @@ public:
                _duration = d;
        }
 
-       int64_t duration () const {
+       boost::optional<int64_t> duration () const {
                return _duration;
        }
 
-       /** @return the asset's hash, if this ReelAsset has been created from one,
-        *  otherwise the hash written to the CPL for this asset (if present).
-        */
-       boost::optional<std::string> hash () const {
-               return _hash;
-       }
-
-protected:
+       /** @return <Duration>, or <IntrinsicDuration> - <EntryPoint> if <Duration> is not present */
+       int64_t actual_duration () const;
 
-       template <class T>
-       boost::shared_ptr<T> asset_of_type () const {
-               return boost::dynamic_pointer_cast<T> (_asset_ref.asset ());
+       std::string annotation_text () const {
+               return _annotation_text;
        }
 
-       template <class T>
-       boost::shared_ptr<T> asset_of_type () {
-               return boost::dynamic_pointer_cast<T> (_asset_ref.asset ());
+       void set_annotation_text (std::string at) {
+               _annotation_text = at;
        }
 
+       bool asset_equals (std::shared_ptr<const ReelAsset>, EqualityOptions, NoteHandler) const;
+
+protected:
+
        /** @return the node name that this asset uses in the CPL's &lt;Reel&gt; node
         *  e.g. MainPicture, MainSound etc.
         */
-       virtual std::string cpl_node_name () const = 0;
+       virtual std::string cpl_node_name (Standard) const = 0;
 
        /** @return Any attribute that should be used on the asset's node in the CPL */
        virtual std::pair<std::string, std::string> cpl_node_attribute (Standard) const;
@@ -136,21 +143,17 @@ protected:
        /** @return Any namespace that should be used on the asset's node in the CPL */
        virtual std::pair<std::string, std::string> cpl_node_namespace () const;
 
-       /** Reference to the asset (MXF or XML file) that this reel entry
-        *  applies to.
-        */
-       Ref _asset_ref;
+       int64_t _intrinsic_duration = 0;       ///< The &lt;IntrinsicDuration&gt; from the reel's entry for this asset
+       boost::optional<int64_t> _duration;    ///< The &lt;Duration&gt; from the reel's entry for this asset, if present
 
 private:
-       std::string _annotation_text; ///< The &lt;AnnotationText&gt; from the reel's entry for this asset
-       Fraction _edit_rate;          ///< The &lt;EditRate&gt; from the reel's entry for this asset
-       int64_t _intrinsic_duration;  ///< The &lt;IntrinsicDuration&gt; from the reel's entry for this asset
-       int64_t _entry_point;         ///< The &lt;EntryPoint&gt; from the reel's entry for this asset
-       int64_t _duration;            ///< The &lt;Duration&gt; from the reel's entry for this asset
-       /** Either our asset's computed hash or the hash read in from the CPL, if it's present */
-       boost::optional<std::string> _hash;
+       std::string _annotation_text;          ///< The &lt;AnnotationText&gt; from the reel's entry for this asset
+       Fraction _edit_rate;                   ///< The &lt;EditRate&gt; from the reel's entry for this asset
+       boost::optional<int64_t> _entry_point; ///< The &lt;EntryPoint&gt; from the reel's entry for this asset
 };
 
+
 }
 
+
 #endif