/*
- 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
*/
/** @file src/asset.h
- * @brief Parent class for assets of DCPs.
+ * @brief Asset class.
*/
#ifndef LIBDCP_ASSET_H
#define LIBDCP_ASSET_H
-#include <string>
-#include <list>
-#include <boost/filesystem.hpp>
+#include "object.h"
#include "types.h"
+#include <boost/filesystem.hpp>
+#include <boost/function.hpp>
+#include <boost/bind.hpp>
-namespace ASDCP {
- class WriterInfo;
+namespace xmlpp {
+ class Node;
}
-namespace libdcp
-{
+struct asset_test;
-/** @brief Parent class for assets of DCPs
+namespace dcp {
+
+/** @class Asset
+ * @brief Parent class for DCP assets, i.e. picture, sound, subtitles, CPLs, fonts.
*
- * These are collections of pictures or sound.
+ * Note that this class is not used for ReelAssets; those are just for the metadata
+ * that gets put into <Reel>s.
*/
-class Asset
+class Asset : public Object
{
public:
- /** Construct an Asset.
- * @param directory Directory where our XML or MXF file is.
- * @param file_name Name of our file within directory, or empty to make one up based on UUID.
- */
- Asset (std::string directory, std::string file_name = "");
-
- virtual ~Asset() {}
-
- /** Write details of the asset to a CPL stream.
- * @param s Stream.
- */
- virtual void write_to_cpl (std::ostream& s) const = 0;
-
- /** Write details of the asset to a PKL stream.
- * @param s Stream.
+ Asset ();
+ Asset (boost::filesystem::path file);
+ Asset (std::string id, boost::filesystem::path file);
+
+ virtual bool equals (
+ boost::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_pkl (std::ostream& s) const;
+ void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
- /** Write details of the asset to a ASSETMAP stream.
- * @param s Stream.
+ /** Write details of the asset to a PKL AssetList node.
+ * @param node Parent node.
+ * @param standard Standard to use.
*/
- void write_to_assetmap (std::ostream& s) const;
+ void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const;
- std::string uuid () const {
- return _uuid;
+ /** @return the most recent disk file used to read or write this asset; may be empty */
+ boost::filesystem::path file () const {
+ return _file;
}
- virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const = 0;
+ 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;
protected:
- friend class PictureAsset;
- friend class SoundAsset;
-
- std::string digest () const;
- boost::filesystem::path path () const;
-
- /** Directory that our MXF or XML file is in */
- std::string _directory;
- /** Name of our MXF or XML file */
- std::string _file_name;
- /** Our UUID */
- std::string _uuid;
-
-private:
- /** Digest of our MXF or XML file */
- mutable std::string _digest;
+ friend struct ::asset_test;
+
+ virtual std::string pkl_type (Standard standard) const = 0;
+
+ /** The most recent disk file used to read or write this asset; may be empty */
+ mutable boost::filesystem::path _file;
+ /** Hash of _file, or empty if the hash has not yet been computed */
+ mutable std::string _hash;
};
}