X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fasset.h;h=b88b1167d3c110f1087424805d972d2225667164;hb=a1e7f77e8fcfd71cc8bf94d13ceb2decbacc3b50;hp=7adf009087d0870abd5ef33d03c14837fabff4cc;hpb=51919d468831a876f31d5a6e2b25f8913314770d;p=libdcp.git

diff --git a/src/asset.h b/src/asset.h
index 7adf0090..b88b1167 100644
--- 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.
 
@@ -15,32 +15,56 @@
 
     You should have received a copy of the GNU General Public License
     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    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/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 AssetMap;
+
+
 /** @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.
@@ -48,51 +72,90 @@ namespace dcp {
 class Asset : public Object
 {
 public:
+	/** Create an Asset with a randomly-generated ID */
 	Asset ();
-	Asset (boost::filesystem::path file);
+
+	/** 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,
-		EqualityOptions opt,
+		std::shared_ptr<const Asset> other,
+		EqualityOptions const& 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 add_to_assetmap (AssetMap& asset_map, 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;
+	/** Set the file that holds this asset on disk.  Calling this function
+	 *  preserves the object's store of its hash, so if the object already
+	 *  has a hash it is up to the caller to ensure that the new file has
+	 *  the same hash.
+	 *
+	 *  @param file New file's path.
+	 */
+	void set_file_preserving_hash(boost::filesystem::path file) const;
+
+	/** Set the file that holds this asset on disk.  The new file must
+	 *  be exactly the same as the old one, as this function assumes
+	 *  that the object's hash does not change.
+	 *
+	 *  @param file New file's path.
+	 */
+	void rename_file(boost::filesystem::path file);
+
+	/** 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);
+	void unset_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 add_file_to_assetmap (AssetMap& asset_map, 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