Test churn from adding make_uuid() into CPL.

[libdcp.git] / src / asset.h

diff --git a/src/asset.h b/src/asset.h
index 1871b7ee399120be05e7476b3477e3dc64907368..88c7d1d1312582bdd67a5f5cfb2be3366c6e042c 100644 (file)
--- a/src/asset.h
+++ b/src/asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,30 +31,37 @@
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/asset.h
- *  @brief Asset class.
+ *  @brief Asset class
  */
 
+
 #ifndef LIBDCP_ASSET_H
 #define LIBDCP_ASSET_H
 
+
 #include "object.h"
 #include "types.h"
+#include "pkl.h"
 #include <boost/filesystem.hpp>
 #include <boost/function.hpp>
-#include <boost/bind.hpp>
 #include <boost/optional.hpp>
 
+
 namespace xmlpp {
        class Node;
 }
 
+
 struct asset_test;
 
+
 namespace dcp {
 
+
 /** @class Asset
- *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, CPLs, fonts.
+ *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs, fonts
  *
  *  Note that this class is not used for ReelAssets; those are just for the metadata
  *  that gets put into &lt;Reel&gt;s.
@@ -62,53 +69,72 @@ namespace dcp {
 class Asset : public Object
 {
 public:
+       /** Create an Asset with a randomly-generated ID */
        Asset ();
+
+       /** Create an Asset from a given file with a randomly-generated ID
+        *  @param file File name
+        */
        explicit Asset (boost::filesystem::path file);
+
+       /** Create an Asset from a given file with a given ID
+        *  @param id ID
+        *  @param file File name
+        */
        Asset (std::string id, boost::filesystem::path file);
 
        virtual bool equals (
-               boost::shared_ptr<const Asset> other,
+               std::shared_ptr<const Asset> other,
                EqualityOptions opt,
                NoteHandler note
                ) const;
 
-       /** Write details of the asset to a ASSETMAP.
-        *  @param node Parent node.
-        */
-       void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
+       virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
 
-       /** Write details of the asset to a PKL AssetList node.
-        *  @param node Parent node.
-        *  @param standard Standard to use.
-        */
-       void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const;
+       virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
 
-       /** @return the most recent disk file used to read or write this asset; may be empty */
-       boost::filesystem::path file () const {
+       /** @return the most recent disk file used to read or write this asset, if there is one */
+       boost::optional<boost::filesystem::path> file () const {
                return _file;
        }
 
+       /** Set the file that holds this asset on disk.  Calling this function
+       *  clears this object's store of its hash, so you should call ::hash
+       *  after this.
+       *
+       *  @param file New file's path.
+       */
        void set_file (boost::filesystem::path file) const;
 
-       /** @return the hash of this asset's file */
-       std::string hash (boost::function<void (float)> progress = 0) const;
+       /** Calculate the hash of this asset's file, if it has not already been calculated,
+        *  then return it
+        *  @param progress Function that will be called with a parameter between 0 and 1 to indicate
+        *  progress in the calculation
+        *  @return the hash
+        */
+       std::string hash (boost::function<void (float)> progress = {}) const;
 
        void set_hash (std::string hash);
 
 protected:
 
-       /** The most recent disk file used to read or write this asset; may be empty */
-       mutable boost::filesystem::path _file;
+       /** The most recent disk file used to read or write this asset */
+       mutable boost::optional<boost::filesystem::path> _file;
+
+       static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
 
 private:
        friend struct ::asset_test;
 
+       /** @return type string for PKLs for this asset */
        virtual std::string pkl_type (Standard standard) const = 0;
 
        /** Hash of _file if it has been computed */
        mutable boost::optional<std::string> _hash;
 };
 
+
 }
 
+
 #endif