Fixes for writing 3D CPLs.
[libdcp.git] / src / asset.h
index 2d33e0699c1bb381baa79f3a5ec1b24b3ab7ec47..3dffa9abc3becc84b126d7ddeaf1dcfe64873711 100644 (file)
 
 */
 
+/** @file  src/asset.h
+ *  @brief Parent class for assets of DCPs.
+ */
+
 #ifndef LIBDCP_ASSET_H
 #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
 {
 
-/** Parent class for assets (picture / sound collections) */   
+/** @brief Parent class for assets of DCPs
+ *
+ *  These are collections of pictures or sound.
+ */
 class Asset
 {
 public:
-       Asset (std::string, sigc::signal1<void, float>*, int, int);
+       /** 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 = "", int edit_rate = 0, int intrinsic_duration = 0);
+
+       virtual ~Asset() {}
+
+       /** Write details of the asset to a CPL AssetList node.
+        *  @param p Parent node.
+        */
+       virtual void write_to_cpl (xmlpp::Node *) const = 0;
+
+       /** Write details of the asset to a PKL AssetList node.
+        *  @param p Parent node.
+        */
+       void write_to_pkl (xmlpp::Node *) const;
+
+       /** Write details of the asset to a ASSETMAP stream.
+        *  @param s Stream.
+        */
+       void write_to_assetmap (xmlpp::Node *) const;
+
+       std::string uuid () const {
+               return _uuid;
+       }
+
+       boost::filesystem::path path () const;
 
-       virtual void write_to_cpl (std::ostream &) const = 0;
-       void write_to_pkl (std::ostream &) const;
-       void write_to_assetmap (std::ostream &) const;
+       void set_directory (std::string d) {
+               _directory = d;
+       }
+
+       void set_file_name (std::string f) {
+               _file_name = f;
+       }
+
+       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;
+       }
+
+       virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)>) const;
 
 protected:
-       void fill_writer_info (ASDCP::WriterInfo *) 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;
+       
+       std::string digest () 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;
-       /** 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;
 };
 
 }