Fix a couple of errors in Interop XML
[libdcp.git] / src / asset.h
index 06c6635636141882b35dc11fab5895ce1e16e2c5..773e3d48ae2fb9c2b060519b2620693db36107e9 100644 (file)
 #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
 {
 
@@ -48,24 +53,32 @@ public:
         *  @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 = "", int edit_rate = 0, int intrinsic_duration = 0);
+       Asset (boost::filesystem::path directory, boost::filesystem::path file_name = "");
 
        virtual ~Asset() {}
 
-       /** Write details of the asset to a CPL stream.
-        *  @param s Stream.
+       /** Write details of the asset to a CPL AssetList node.
+        *  @param p Parent element.
         */
-       virtual void write_to_cpl (std::ostream& s) const = 0;
+       virtual void write_to_cpl (xmlpp::Element* p) 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 *, bool interop) 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;
@@ -73,11 +86,11 @@ public:
 
        boost::filesystem::path path () const;
 
-       void set_directory (std::string d) {
+       void set_directory (boost::filesystem::path d) {
                _directory = d;
        }
 
-       void set_file_name (std::string f) {
+       void set_file_name (boost::filesystem::path f) {
                _file_name = f;
        }
 
@@ -109,16 +122,23 @@ public:
                _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:
+
+       /** @return Interop PKL asdcpKind for the &lt;Type&gt; tag e.g. Picture, Sound etc. */
+       virtual std::string asdcp_kind () const = 0;
        
        std::string digest () const;
 
        /** Directory that our MXF or XML file is in */
-       std::string _directory;
+       boost::filesystem::path _directory;
        /** Name of our MXF or XML file */
-       std::string _file_name;
+       boost::filesystem::path _file_name;
        /** Our UUID */
        std::string _uuid;
        /** The edit rate; this is normally equal to the number of video frames per second */