Merge master; MXF subtitle stuff not included.

[libdcp.git] / src / asset.h

diff --git a/src/asset.h b/src/asset.h
index b0cc450c999865e2f77dddd99c98a08fee961e92..bad982f1878b2584741ef0955a65253c022ff19f 100644 (file)
--- a/src/asset.h
+++ b/src/asset.h
@@ -1,5 +1,5 @@
 /*
-    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
@@ -18,70 +18,70 @@
 */
 
 /** @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 <sigc++/sigc++.h>
+#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
-{
+namespace dcp {
 
-/** @brief Parent class for assets of DCPs
+/** @class Asset
+ *  @brief Parent class for DCP assets, i.e. picture/sound/subtitles and CPLs.
  *
- *  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 &lt;Reel&gt;s.
  */
-class Asset
+class Asset : public Object
 {
 public:
-       /** Construct an Asset.
-        *  @param mxf_path Pathname of MXF file.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
+       Asset ();
+       Asset (boost::filesystem::path file);
+       Asset (std::string id);
+
+       virtual bool equals (
+               boost::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               boost::function<void (NoteType, std::string)> note
+               ) const;
+
+       /** Write details of the asset to a ASSETMAP.
+        *  @param node Parent node.
         */
-       Asset (std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
+       void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
 
-       /** Write details of the asset to a CPL stream.
-        *  @param s Stream.
+       /** Write details of the asset to a PKL AssetList node.
+        *  @param node Parent node.
+        *  @param standard Standard to use.
         */
-       virtual void write_to_cpl (std::ostream& s) const = 0;
+       void write_to_pkl (xmlpp::Node* node, Standard standard) const;
 
-       /** Write details of the asset to a PKL stream.
-        *  @param s Stream.
-        */
-       void write_to_pkl (std::ostream& s) const;
+       boost::filesystem::path file () const {
+               return _file;
+       }
 
-       /** Write details of the asset to a ASSETMAP stream.
-        *  @param s Stream.
-        */
-       void write_to_assetmap (std::ostream& s) const;
+       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:
-       /** Fill in a ADSCP::WriteInfo struct.
-        *  @param w struct to fill in.
-        */
-       void fill_writer_info (ASDCP::WriterInfo* w) const;
-
-       /** Path to our MXF file */
-       std::string _mxf_path;
-       /** Signal to emit to report progress */
-       sigc::signal1<void, float>* _progress;
-       /** Frames per second */
-       int _fps;
-       /** Length in frames */
-       int _length;
-       /** Our UUID */
-       std::string _uuid;
-       /** Digest of our MXF */
-       std::string _digest;
+       virtual std::string pkl_type (Standard standard) const = 0;
+
+       /** The disk file that represents this asset, if one exists */
+       mutable boost::filesystem::path _file;
+       /** Hash of _file, or empty if the hash has not yet been computed */
+       mutable std::string _hash;
 };
 
 }