Merge branch 'master' of /home/carl/git/libdcp
[libdcp.git] / src / mxf_asset.h
index 7f36b30a0b9476902ea4856b3038f8ea3f4b41fc..5815fd9055c1f26fc85d520e8e7bc7fb9ebcb330 100644 (file)
 #ifndef LIBDCP_MXF_ASSET_H
 #define LIBDCP_MXF_ASSET_H
 
+#include <boost/signals2.hpp>
 #include "asset.h"
 
 namespace libdcp
 {
 
+/** @brief Parent class for assets which have MXF files */     
 class MXFAsset : public Asset
 {
 public:
        /** Construct an MXFAsset.
+        *  This class will not write anything to disk in this constructor, but subclasses may.
+        *
         *  @param directory Directory where MXF file is.
         *  @param file_name Name of MXF file.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param entry_point The entry point of this MXF; ie the first frame that should be used.
-        *  @param length Length in frames.
         */
-       MXFAsset (std::string directory, std::string file_name, sigc::signal1<void, float>* progress, int fps, int entry_point, int length);
-
-       virtual std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
+       MXFAsset (std::string directory, std::string file_name);
        
-       int length () const;
+       /** Construct an MXFAsset.
+        *  This class will not write anything to disk in this constructor, but subclasses may.
+        *
+        *  @param directory Directory where MXF file is.
+        *  @param file_name Name of MXF file.
+        *  @param progress Signal to use to inform of progress, or 0.
+        *  @param edit_rate Edit rate in frames per second (usually equal to the video frame rate).
+        *  @param intrinsic_duration Duration of the whole asset in frames.
+        */
+       MXFAsset (std::string directory, std::string file_name, boost::signals2::signal<void (float)>* progress, int edit_rate, int intrinsic_duration);
+
+       virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
 
-protected:
        /** Fill in a ADSCP::WriteInfo struct.
         *  @param w struct to fill in.
+        *  @param uuid uuid to use.
         */
-       void fill_writer_info (ASDCP::WriterInfo* w) const;
-
-       /** Signal to emit to report progress */
-       sigc::signal1<void, float>* _progress;
-       /** Frames per second */
-       int _fps;
-       int _entry_point;
-       /** Length in frames */
-       int _length;
+       static void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid);
+
+protected:
+
+       /** Signal to emit to report progress, or 0 */
+       boost::signals2::signal<void (float)>* _progress;
 };
 
 }