Some OS X build fixes.
[libdcp.git] / src / asset.h
index 86d4734e97dfa0d417f304447144dcb20a2d1b41..2712dcb889d08538b7b1cfbff9c910961a8c38aa 100644 (file)
 
 */
 
+/** @file  src/asset.h
+ *  @brief Asset class.
+ */ 
+
+#ifndef LIBDCP_ASSET_H
+#define LIBDCP_ASSET_H
+
 #include "object.h"
+#include "types.h"
+#include <boost/filesystem.hpp>
+#include <boost/function.hpp>
+#include <boost/bind.hpp>
+
+namespace xmlpp {
+       class Node;
+}
 
 namespace dcp {
 
 /** @class Asset
- *  @brief Parent class for DCP assets, i.e. picture/sound/subtitles, CPLs and PKLs.
+ *  @brief Parent class for DCP assets, i.e. picture/sound/subtitles and CPLs.
+ *
+ *  Note that this class is not used for ReelAssets; those are just for the metadata
+ *  that gets put into &lt;Reel&gt;s.
  */
-       
 class Asset : public Object
 {
 public:
        Asset ();
-       Asset (std::string id);
+       Asset (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_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, Standard standard) const;
+
+       boost::filesystem::path file () const {
+               return _file;
+       }
+
+       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:
+       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;
 };
 
 }
+
+#endif