Header guard.
[libdcp.git] / src / asset.h
index f6d1725650d512fe1f181c2679a4a2d3a4fb0237..ec1385e673bda2a5123982c8ba3bf1ad1b2ad3f3 100644 (file)
 #define LIBDCP_ASSET_H
 
 #include <string>
-#include <sigc++/sigc++.h>
+#include <list>
+#include <boost/filesystem.hpp>
+#include <boost/function.hpp>
+#include <libxml++/libxml++.h>
 #include "types.h"
 
 namespace ASDCP {
        class WriterInfo;
 }
 
+namespace xmlpp {
+       class Element;
+}
+
 namespace libdcp
 {
 
@@ -43,56 +50,107 @@ class Asset
 {
 public:
        /** Construct an Asset.
-        *  @param directory Directory where MXF file is.
-        *  @param mxf_name Name of MXF file.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
+        *  @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 mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
+       Asset (boost::filesystem::path directory, std::string file_name = "");
 
-       /** Write details of the asset to a CPL stream.
-        *  @param s Stream.
+       virtual ~Asset() {}
+
+       /** Write details of the asset to a CPL AssetList node.
+        *  @param p Parent element.
+        *  @param i true to use the Interop standard, false for SMPTE.
         */
-       virtual void write_to_cpl (std::ostream& s) const = 0;
+       virtual void write_to_cpl (xmlpp::Element* p, bool i) const = 0;
 
-       /** Write details of the asset to a PKL stream.
-        *  @param s Stream.
+       /** Write details of the asset to a PKL AssetList node.
+        *  @param p Parent node.
         */
-       void write_to_pkl (std::ostream& s) const;
+       void write_to_pkl (xmlpp::Node *) const;
 
        /** Write details of the asset to a ASSETMAP stream.
         *  @param s Stream.
         */
-       void write_to_assetmap (std::ostream& s) const;
+       void write_to_assetmap (xmlpp::Node *) const;
+
+       /** Compute the digest for this asset.  Calling this is optional: if
+        *  it is not called, the digest will be computed when required.  However,
+        *  calling this method allows the caller to see the progress of the
+        *  computation, which can be long for large assets.
+        *  @param Called with progress between 0 and 1.
+        */
+       void compute_digest (boost::function<void (float)> progress);
+
+       std::string uuid () const {
+               return _uuid;
+       }
+
+       boost::filesystem::path path () const;
+
+       void set_directory (std::string d) {
+               _directory = d;
+       }
+
+       void set_file_name (std::string f) {
+               _file_name = f;
+       }
 
-       virtual std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityFlags flags) const;
+       int entry_point () const {
+               return _entry_point;
+       }
+
+       int duration () const {
+               return _duration;
+       }
+       
+       int intrinsic_duration () const {
+               return _intrinsic_duration;
+       }
+       
+       int edit_rate () const {
+               return _edit_rate;
+       }
+
+       void set_entry_point (int e) {
+               _entry_point = e;
+       }
+       
+       void set_duration (int d) {
+               _duration = d;
+       }
+
+       void set_intrinsic_duration (int d) {
+               _intrinsic_duration = d;
+       }
+
+       void set_edit_rate (int r) {
+               _edit_rate = r;
+       }
+
+       virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)>) const;
 
 protected:
-       friend class PictureAsset;
-       friend class SoundAsset;
        
-       /** Fill in a ADSCP::WriteInfo struct.
-        *  @param w struct to fill in.
-        */
-       void fill_writer_info (ASDCP::WriterInfo* w) const;
-
-       boost::filesystem::path mxf_path () const;
-
-       /** Directory that our MXF file is in */
-       std::string _directory;
-       /** Name of our MXF file */
-       std::string _mxf_name;
-       /** Signal to emit to report progress */
-       sigc::signal1<void, float>* _progress;
-       /** Frames per second */
-       int _fps;
-       /** Length in frames */
-       int _length;
+       std::string digest () const;
+
+       /** Directory that our MXF or XML file is in */
+       boost::filesystem::path _directory;
+       /** Name of our MXF or XML file */
+       std::string _file_name;
        /** Our UUID */
        std::string _uuid;
-       /** Digest of our MXF */
-       std::string _digest;
+       /** The edit rate; this is normally equal to the number of video frames per second */
+       int _edit_rate;
+       /** Start point to present in frames */
+       int _entry_point;
+       /** Total length in frames */
+       int _intrinsic_duration;
+       /** Length to present in frames */
+       int _duration;
+
+private:       
+       /** Digest of our MXF or XML file */
+       mutable std::string _digest;
 };
 
 }